CoreRMO::Find Consumers

Finds consumer instances that match the values provided and adds them to a candidate set. For example, specifying consumer typeName returns all consumers of that type. If a sourceSet is provided, only consumers from that set are considered. If no values are specified, all consumers are found. 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>0..1</instanceName>
	<typeName>0..1</typeName>
  </consumerInstance>
  <candidates>1..1
	<targetSet>1..1</targetSet>
	<sourceSet>0..1</sourceSet>
	<rank>0..1</rank>
  </candidates>
</executeData>

XML Output Schema

Find Consumers 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:
targetSet (minOccurs="1" maxOccurs="1")
sourceSet (minOccurs="0" maxOccurs="1")
rank (minOccurs="0" maxOccurs="1")
consumerInstance Description:
Encapsulates data needed to describe a consumer instance.

Parent:
executeData

Children:
instanceName (minOccurs="0" maxOccurs="1")
typeName (minOccurs="0" 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.

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

sourceSet Description:
Name of the candidate set to select consumer instances from. If provided, only consumers from this set are considered.

Parent:
candidates

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

Parent:
candidates

typeName Description:
Name of the consumer type.

Parent:
consumerInstance

Example

<request>
  <data/>
  <procedure>  
	<execute procedure="Find Consumers" namespace="CoreRMO"> 
	<executeData>
		<consumerInstance>
		<typeName>Website</typeName>
		</consumerInstance>
		<candidates>
		<targetSet>siteSet</targetSet>
		<rank>1</rank>
		</candidates>
	</executeData>
	</execute>
	<execute procedure="List Candidates" namespace="CoreRMO"> 
	<executeData>
		<candidates>
		<targetSet>siteSet</targetSet>
		<category>consumerInstance</category>
		</candidates>
	</executeData>
	<after source="executeData" sourcePath="consumerInstances" destination="data" />
	</execute>
  </procedure>
</request>

See Also

CoreRMO Provider, Find Resources, Resource Manager

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