CoreRMO::Add Consumer Group

Adds a consumer group to the Resource Manager Database. Optionally adds the group to a candidate set and assigns each consumer group a rank. 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>1..1</groupName>
	<groupDescription>0..1</groupDescription>
  </consumerGroup>
  <candidates>0..1
	<targetSet>1..1</targetSet>
	<rank>0..1</rank>
  </candidates>
</executeData>

XML Output Schema

Add Consumer Group does not return data.

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

Children:
rank (minOccurs="0" maxOccurs="1")
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="1" maxOccurs="1")
executeData Description:
 Element that encapsulates the procedure's input data.

Children:
candidates (minOccurs="0" maxOccurs="1")
consumerGroup (minOccurs="1" maxOccurs="1")
groupDescription Description:
Description of the consumer group.

Parent:
consumerGroup

groupName Description:
Name of the consumer group. Must be unique within the set of consumer groups.

Parent:
consumerGroup

rank Description:
Integer that specifies the rank to assign to the consumer group when it is added to the candidate set. If not specified, the default value is null.

Parent:
candidates

targetSet Description:
Name of the candidate set to add the consumer group to.

Parent:
candidates

Example

<request>
  <data/>
  <procedure>  
	<execute procedure="Add Consumer Group" namespace="CoreRMO"> 
	<executeData>
		<consumerGroup>
		<groupName>PremiumWebsites</groupName>
		<groupDescription>Group of all web sites that have purchased the premium plan</groupDescription>
		</consumerGroup>
	</executeData>
	</execute>
  </procedure>
</request>

See Also

CoreRMO Provider, Delete Consumer Group, Resource Manager, Update Consumer Group

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