CoreRMO::Add Consumer Group To Candidates

Adds a consumer group to a candidate set and optionally assigns the 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>
  </consumerGroup>
  <candidates>1..1
	<targetSet>1..1</targetSet>
	<rank>0..1</rank>
  </candidates>
</executeData>

XML Output Schema

Add Consumer Group To Candidates 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
consumerGroup Description:
Encapsulates data for a consumer group. The consumer group will not be re-added if it already exists in the candidate set.

Parent:
executeData

Child:
groupName (minOccurs="1" maxOccurs="1")
candidates Description:
Encapsulates data needed to interact with a candidate set. 

Parent:
executeData  

Children:
rank (minOccurs="0" maxOccurs="1")
targetSet (minOccurs="1" maxOccurs="1")
executeData Description:
 Encapsulates the procedure's input data.

Children:
candidates (minOccurs="1" maxOccurs="1")
consumerGroup (minOccurs="1" maxOccurs="1")
groupName Description:
Name of the consumer group that will be added to the candidate set.

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 To Candidates" namespace="CoreRMO"> 
	<executeData>
		<candidates>
		<targetSet>premiumSitesGroupSet</targetSet>
		<rank>1</rank>
		</candidates>
		<consumerGroup>
		<groupName>PremiumWebsites</groupName>
		</consumerGroup>
	</executeData>
	</execute>
  </procedure>
</request>

See Also

Add Candidates to Candidates, Add Consumer To Candidates, Add Consumer Group to Candidates, Add Consumer Instance, CoreRMO Provider, Find Candidates By Mapping, Find Consumers, Resource Manager

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