CoreRMO::Add Consumer To Candidates

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

XML Output Schema

Add Consumer 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
candidates Description:
Encapsulates data needed to interact with a candidate set.

Parent:
executeData

Children:
rank (minOccurs="0" maxOccurs="1")
targetSet (minOccurs="1" maxOccurs="1")
consumerInstance Description:
Encapsulates data needed to describe a consumer instance. Instances are identified by both name and type.

Parent:
executeData

Children:
instanceName (minOccurs="1" maxOccurs="1")
typeName (minOccurs="1" maxOccurs="1")
executeData Description:
 Encapsulates the procedure's input data.

Children:
candidates (minOccurs="1" maxOccurs="1")
consumerInstance (minOccurs="1" maxOccurs="1")
instanceName Description:
Name of the consumer instance. The instance will not be re-added if it already exists in the candidate set.

Parent:
consumerInstance

rank Description:
Integer that specifies the rank to assign to the consumer instance 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 instance to.

Parent:
candidates

typeName Description:
Name of the consumer type associated with this instance.

Parent:
consumerInstance

Example

<request>
  <data/>
  <procedure>  
	<execute procedure="Add Consumer To Candidates" namespace="CoreRMO"> 
	<executeData>
		<consumerInstance>
		<instanceName>tailspintoys.com</instanceName>
		<typeName>Website</typeName>
		</consumerInstance>
		<candidates>
		<targetSet>siteSet</targetSet>
		<rank>1</rank>
		</candidates>
	</executeData>
	</execute>
  </procedure>
</request>

See Also

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

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