CoreRMO::Update Consumer Instance

Updates the instance name, description and the consumer type name for each consumer instance in a candidate set. 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>
	<instanceDescription>0..1</instanceDescription>
   </consumerInstance>
  <candidates>1..1
	<targetSet>1..1</targetSet>
  </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
  <rowsAffected>1..1</rowsAffected>
</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:
targetSet (minOccurs="1" maxOccurs="1")
consumerInstance Description:
Encapsulates data needed to describe a consumer instance.

Parent:
executeData

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

Children:
candidates (minOccurs="1" maxOccurs="1", input only)
consumerInstance (minOccurs="1" maxOccurs="1", input only)
rowsAffected (minOccurs="1" maxOccurs="1", output only)
instanceDescription Description:
New description of the consumer instance that is being updated.

Parent:
consumerInstance

instanceName Description:
New name of the consumer instance that is being updated.

Parent:
consumerInstance

rowsAffected Description:
Integer that specifies the number of consumer instances updated by this operation.

Parent:
executeData

targetSet Description:
Name of the candidate that contains the set of consumer instances to update.

Parent:
candidates

typeName Description:
New type of the consumer instance that is being updated.

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>
	<execute procedure="Update Consumer Instance" namespace="CoreRMO"> 
	<executeData>
		<candidates>
		<targetSet>siteSet</targetSet>
		</candidates>
		<consumerInstance>
		<instanceDescription>A new description</instanceDescription>
		</consumerInstance>
	</executeData>
	</execute>
  </procedure>
</request>

Remarks

If any consumer instances fail to update, none are updated.

When these values are updated, the resulting consumer instances must still be uniquely identified by a combination of instanceName and typeName.

If multiple consumer instances are being updated to the same name and type, the function will fail.

See Also

Add Consumer Instance, CoreRMO, Delete Consumer Instance, Resource Manager

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