BlockModelRMO::Query Consumer Allocations

Returns all allocations between a consumer instance and a set of resources. Used by Microsoft Provisioning Framework (MPF).

Arguments

Elements and Attributes

The following table describes the XML schema elements and attributes. Unless otherwise indicated, the data type is string.

Element	Description, relationships, and attributes
actualUsed	Description: Actual resource capacity allocated to the consumer. Parent: resourceInstance
allocations	Description: List of allocations. Parent: executeData Child: consumerInstance (minOccurs="0" maxOccurs="unbounded")
candidates	Description: Encapsulates data needed to describe the candidate set of resource instances. If the candidate set is omitted, all allocations associated with the consumer instance are returned. Parent: executeData Child: resourceTargetSet (minOccurs="0" maxOccurs="1")
consumerInstance	Description: Encapsulates data needed to describe a consumer instance. Parent: executeData Children: typeName (minOccurs="1" maxOccurs="1") instanceName (minOccurs="1" maxOccurs="1")
executeData	Description: Encapsulates the procedure's input and output data. Children: allocations (minOccurs="0" maxOccurs="1", output only) consumerInstance (minOccurs="1" maxOccurs="1", input only)
instanceLocation	Description: Location of the resource instance. Parent: resourceInstance
instanceName	Description: Name of the instance. Parents: consumerInstance (input), resourceInstance (output)
resourceInstance	Description: Encapsulates data required to describe a resource instance and its allocations to the consumer instance. Parent: allocations Children: actualUsed (minOccurs="1" maxOccurs="1") instanceLocation (minOccurs="1" maxOccurs="1") instanceName (minOccurs="1" maxOccurs="1") typeName (minOccurs="1" maxOccurs="1") virtualUsed (minOccurs="1" maxOccurs="1")
resourceTargetSet	Description: Set of resources to query. Parent: candidates
typeName	Description: Name of the type associated with this instance. Parents: consumerInstance (input), resourceInstance (output)
virtualUsed	Description: Virtual resource capacity allocated to the consumer. Parent: resourceInstance

Remarks

Schema Definition

Input

<executeData>1..1
 <consumerInstance>1..1
	<instanceName>1..1</instanceName>
	<typeName>1..1</typeName>
  </consumerInstance>
  <candidates>0..1
	<resourceTargetSet>0..1</resourceTargetSet>
  </candidates>
</executeData>

Output

<executeData>1..1
 <allocations>0..1
  <resourceInstance>0..unbounded
	<instanceName>1..1</instanceName>
	<typeName>1..1</typeName>
	<instanceLocation>1..1</instanceLocation>
	<actualUsed>1..1</actualUsed>
	<virtualUsed>1..1</virtualUsed>
  </resourceInstance>
  </allocations>
</executeData>

Sample Code

Example XML Request

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.

<request>
  <data/>
  <procedure>  
	<execute procedure="Query Consumer Allocations" namespace="BlockModelRMO"> 
	<executeData>
		<consumerInstance>
		<instanceName>tailspintoys.com</instanceName>
		<typeName>Website</typeName>
		</consumerInstance>
	</executeData>
	<after source="executeData" sourcePath="allocations" destination="data" />
	</execute>
  </procedure>
</request>

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.

Example XML Response

Query Consumer Allocations does not return data.

Applies To