CoreRMO::Find Resources

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

XML Output Schema

Find Resources 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")
sourceSet (minOccurs="0" maxOccurs="1")
targetSet (minOccurs="1" maxOccurs="1")
executeData Description:
 Encapsulates the procedure's input data.

Children:
candidates(minOccurs="1" maxOccurs="1")
resourceInstance(minOccurs="1" maxOccurs="1")
instanceLocation Description:
Location of the resource instance.

Parent:
resourceInstance

instanceName Description:
Name of the resource instance.

Parent:
resourceInstance

instanceOnline Description:
Indicates whether this instance is currently online.

Parent:
resourceInstance

instanceProvisionable Description:
Indicates whether this instance is used to provision new users.

Parent:
resourceInstance

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

Parent:
candidates

resourceInstance Description:
Encapsulates data needed to describe a resource instance.

Parent:
executeData

Children:
instanceLocation (minOccurs="0" maxOccurs="1")
instanceName (minOccurs="0" maxOccurs="1")
instanceOnline (minOccurs="0" maxOccurs="1")
instanceProvisionable (minOccurs="0" maxOccurs="1")
typeName (minOccurs="0" maxOccurs="1")
sourceSet Description:
Name of the candidate set to select resource instances from. If provided, only resources from this set are considered

Parent:
candidates

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

Parent:
candidates

typeName Description:
Name of the resource type.

Parent:
resourceInstance

Example

<request>
  <data/>
  <procedure>  
	<execute procedure="Find Resources" namespace="CoreRMO"> 
	<executeData>
		<resourceInstance>
		<instanceLocation>Lab A, Building B</instanceLocation>
		</resourceInstance>
		<candidates>
		<targetSet>serverSet</targetSet>
		</candidates>
	</executeData>
	</execute>
	<execute procedure="List Candidates" namespace="CoreRMO"> 
	<executeData>
		<candidates>
		<targetSet>serverSet</targetSet>
		<category>resourceInstance</category>
		</candidates>
	</executeData>
	<after source="executeData" sourcePath="resourceInstances" destination="data" />
	</execute>
  </procedure>
</request>

See Also

CoreRMO Provider, Find Consumers, Resource Manager

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