CoreRMO::Update Consumer Group

Updates the group name and/or group description attributes for each consumer group in a candidate set. Used by Microsoft. Provisioning Framework (MPF).

XML Input Schema

The following code fragment shows the format for sending data to this procedure. For more information on individual elements and attributes, see the Elements and Attributes table.

<executeData>1..1
  <consumerGroup>1..1
	<groupName>0..1</groupName>
	<groupDescription>0..1</groupDescription>
  </consumerGroup>
  <candidates>1..1
	<targetSet>1..1</targetSet>
  </candidates>
</executeData>

XML Output Schema

The following code fragment shows the format for data this procedure returns. For more information on individual elements and attributes, see the Elements and Attributes table.

<executeData>1..1
  <rowsAffected>1..1</rowsAffected>
</executeData>

Elements and Attributes

The following table describes the XML elements and attributes. Unless otherwise indicated, the data type is string.

Element Description, relationships, and attributes
candidates Description:
Encapsulates data needed to interact with a candidate set.

Parent:
executeData

Child:
targetSet (minOccurs="1" maxOccurs="1")
consumerGroup Description:
Encapsulates data needed to describe a consumer group.

Parent:
executeData

Children:
groupDescription (minOccurs="0" maxOccurs="1")
groupName (minOccurs="0" maxOccurs="1")
executeData Description:
 Encapsulates the procedure's input and output data.

Children:
candidates(minOccurs="1" maxOccurs="1", input only)
consumerGroup(minOccurs="1" maxOccurs="1", input only)
rowsAffected(minOccurs="1" maxOccurs="1", output only)
groupDescription Description:
Description of the consumer group.

Parent:
consumerGroup

groupName Description:
Name of the consumer group. If the group name is to be updated, the candidate set must not already contain the same group name, since group names must be unique.

Parent:
consumerGroup

rowsAffected Description:
Integer that specifies the number of consumer groups updated by this operation.

Parent:
executeData

targetSet Description:
Name of the candidate that contains the set of consumer groups to update.

Parent:
candidates

Example

<request>
  <data/>
  <procedure>  
	<execute procedure="Add Consumer Group To Candidates" namespace="CoreRMO"> 
	<executeData>
		<candidates>
		<targetSet>premiumSitesGroupSet</targetSet>
		</candidates>
		<consumerGroup>
		<groupName>PremiumWebsites</groupName>
		</consumerGroup>
	</executeData>
	</execute>
	<execute procedure="Update Consumer Group" namespace="CoreRMO"> 
	<executeData>
		<candidates>
		<targetSet>premiumSitesGroupSet</targetSet>
		</candidates>
		<consumerGroup>
		<groupDescription>A new description</groupDescription>
		</consumerGroup>
	</executeData>
	</execute>
  </procedure>
</request>

Remarks

If this function succeeds, all consumer groups in the candidate set are updated. Conversely, if it fails, none are updated.

Consumer group names must be unique. If an attempt is made to update multiple groups in the candidate set to the same groupName, the function will fail.

See Also

Add Consumer Group, CoreRMO, Delete Consumer Group, Resource Manager

Up Top of Page
) 1999-2002 Microsoft Corporation. All rights reserved.