CoreRMO::List Candidates

Queries a candidate set and returns a list of the candidates for a category. The elements returned depend on the category specified. 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
  <candidates>1..1
	<targetSet>1..1</targetSet>
	<category>1..1</category>
  </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
  <resourceInstances>0..1
	<resourceInstance>0..unbounded
	<instanceName>1..1</instanceName>
	<typeName>1..1</typeName>
	<instanceLocation>1..1</instanceLocation>
	<instanceDescription>0..1</instanceDescription>
	<rank>0..1</rank>
	<instanceOnline>0..1</instanceOnline>
	<instanceProvisionable>0..1</instanceProvisionable>
	</resourceInstance>
  </resourceInstances>
  <consumerInstances>0..1
	<consumerInstance>0..unbounded
	<instanceName>1..1</instanceName>
	<typeName>1..1</typeName>
	<instanceDescription>0..1</instanceDescription>
	<rank>0..1</rank>
	</consumerInstance>
  </consumerInstances>
  <resourceGroups>0..1
	<resourceGroup>0..unbounded
	<instanceName>1..1</instanceName>
	<instanceDescription>0..1</instanceDescription>
	<rank>0..1</rank>
	</resourceGroup>
	</resourceGroups>
  <consumerGroups>0..1
	<consumerGroup>0..unbounded
	<instanceName>1..1</instanceName>
	<instanceDescription>0..1</instanceDescription>
	<rank>0..1</rank>
	</consumerGroup>
  </consumerGroups>
</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

Children:
category (minOccurs="1" maxOccurs="1")
targetSet (minOccurs="1" maxOccurs="1")
category Description:
Category of the objects to consider: resourceInstance, resourceGroup, consumerInstance, or consumerGroup.

Parent:
candidates

consumerGroup Description:
Encapsulates data for a consumer group.

Parent:
consumerGroups

Children:
instanceDescription (minOccurs="0" maxOccurs="1")
instanceName (minOccurs="1" maxOccurs="1")
rank (minOccurs="0" maxOccurs="1")
consumerGroups Description:
Encapsulates data for a set of consumer groups.

Parent:
executeData

Child:
consumerGroup (minOccurs="0" maxOccurs="*")
consumerInstance Description:
Encapsulates data for a consumer instance.

Parent:
consumerInstances

Children:
instanceDescription (minOccurs="0" maxOccurs="1")
instanceName (minOccurs="1" maxOccurs="1")
rank (minOccurs="0" maxOccurs="1")
typeName (minOccurs="1" maxOccurs="1")
consumerInstances Description:
Encapsulates data for a set of consumer instances.

Parent:
executeData

Child:
consumerInstance (minOccurs="0" maxOccurs="*")
executeData Description:
Encapsulates the procedure's input and output data.

Children:
candidates (minOccurs="1" maxOccurs="1")
consumerGroups (minOccurs="0" maxOccurs="1")
consumerInstances (minOccurs="0" maxOccurs="1")
resourceGroups (minOccurs="0" maxOccurs="1")
resourceInstances (minOccurs="0" maxOccurs="1")
instanceDescription Description:
Description of the group or instance.

Parents:
consumerGroup, consumerInstance, resourceGroup, resourceInstance
instanceLocation Description:
Location of the resource instance.

Parent:
resourceInstance

instanceName Description:
Name of the group or instance.

Parents:
consumerGroup, consumerInstance, resourceGroup, resourceInstance
instanceOnline Description:
Integer that indicates whether this instance is currently online. Refers to the resource's current status (0 or 1).

Parent:
resourceInstance

instanceProvisionable Description:
Integer (0 or 1) that indicates whether the target resource is accepting new consumer allocations. If specified, new users can be assigned to the resource.

Parent:
resourceInstance

rank Description:
Rank assigned to the object. If the object is not ranked (that is, its rank is null), this node is not displayed.

Parents:
consumerGroup, consumerInstance, resourceGroup, resourceInstance
resourceGroup Description:
Encapsulates data for a resource group.

Parent:
resourceGroups

Children:
 instanceDescription (minOccurs="0" maxOccurs="1")
instanceName (minOccurs="1" maxOccurs="1")
rank (minOccurs="0" maxOccurs="1")
resourceGroups Description:
Encapsulates data for a set of resource groups.

Parent:
executeData

Child:
resourceGroup (minOccurs="0" maxOccurs="*")
resourceInstance Description:
Encapsulates data for a resource instance.

Parent:
resourceInstances

Children:
instanceDescription (minOccurs="0" maxOccurs="1")
instanceLocation (minOccurs="1" maxOccurs="1")
instanceName (minOccurs="1" maxOccurs="1")
rank (minOccurs="0" maxOccurs="1")
typeName (minOccurs="1" maxOccurs="1")
resourceInstances Description:
Encapsulates data for a set of resource instances.

Parent:
executeData

Child:
resourceInstance (minOccurs="0" maxOccurs="*")
targetSet Description:
Set of candidates to list.

Parent:
candidates

typeName Description:
Name of the resource type or consumer type associated with an instance.

Parents:
consumerInstance, resourceInstance

Example

<request>
  <data>
	<candidates>
	<targetSet>allSet</targetSet>
	</candidates>
	<resultRI/>
	<resultCI/>
	<resultRG/>
	<resultCG/>
  </data>
  <procedure>  
	<execute procedure="Find Resources" namespace="CoreRMO"> 
	<executeData>
		<resourceInstance>
		</resourceInstance>
	</executeData>
	<before source="data" sourcePath="candidates" destination="executeData" />
	</execute>
	<execute procedure="Find Consumers" namespace="CoreRMO"> 
	<executeData>
		<consumerInstance>
		</consumerInstance>
	</executeData>
	<before source="data" sourcePath="candidates" destination="executeData" />
	</execute>
	<execute procedure="Add Resource Group To Candidates" namespace="CoreRMO"> 
	<executeData>
		<resourceGroup>
		<groupName>BroadBandServerGroup</groupName>
		</resourceGroup>
	</executeData>
	<before source="data" sourcePath="candidates" destination="executeData" />
	</execute>
	<execute procedure="Add Consumer Group To Candidates" namespace="CoreRMO"> 
	<executeData>
		<consumerGroup>
		<groupName>PremiumWebsites</groupName>
		</consumerGroup>
	</executeData>
	<before source="data" sourcePath="candidates" destination="executeData" />
	</execute>
	<execute procedure="List Candidates***" namespace="CoreRMO"> 
	<executeData>
		<candidates>
		<targetSet>allSet</targetSet>
		<category>resourceInstance</category>
		</candidates>
	</executeData>
	<after source="executeData" sourcePath="resourceInstances" destination="data" destinationPath="resultRI" />
	</execute>
	<execute procedure="List Candidates" namespace="CoreRMO"> 
	<executeData>
		<candidates>
		<targetSet>allSet</targetSet>
		<category>consumerInstance</category>
		</candidates>
	</executeData>
	<after source="executeData" sourcePath="consumerInstances" destination="data" destinationPath="resultCI" />
	</execute>
	<execute procedure="List Candidates" namespace="CoreRMO"> 
	<executeData>
		<candidates>
		<targetSet>allSet</targetSet>
		<category>resourceGroup</category>
		</candidates>
	</executeData>
	<after source="executeData" sourcePath="resourceGroups" destination="data" destinationPath="resultRG" />
	</execute>
	<execute procedure="List Candidates" namespace="CoreRMO"> 
	<executeData>
		<candidates>
		<targetSet>allSet</targetSet>
		<category>consumerGroup</category>
		</candidates>
	</executeData>
	<after source="executeData" sourcePath="consumerGroups" destination="data" destinationPath="resultCG" />
	</execute>
  </procedure>
</request>

See Also

CoreRMO Provider, Resource Manager

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