Active Directory Provider::Get Properties

Returns one or more properties for a Microsoft® Active Directory® object. Used by Microsoft® Provisioning Framework (MPF).

Get Properties is a wrapper for IADS::GetEx.

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
  <path>1..1
  <propertyList>0..1
	<property name="..">0..unbounded</property>
  </propertyList>
</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
  <properties>1..1
	<property name="..">1..unbounded
	<value>0..unbounded</value>
	</property>
  </properties>
</executeData>
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
executeData Description:
Encapsulates the procedure's input and output data.

Children:
path (minOccurs="1" maxOccurs="1", input only)
properties (minOccurs="1" maxOccurs="1", output only)
propertyList (minOccurs="0" maxOccurs="1", input only)
path Description:
Lightweight directory access protocol (LDAP) path of the object to retrieve properties from.

Parent:
executeData

properties Description:
Returned list of properties with their values. Multi-valued properties will return multiple value nodes. Some properties that ADSI does not accept as input in string format will be returned using an XML data type. A similar format must be used when passing values back to the Set Properties action.

If a property type was not implemented to be returned, no property node is returned. Note that IADs::GetEx returns the same thing for an invalid property name as for a valid property name with no value, so in both cases this action will generate an empty property node.

Parent:
executeData

Child:
property (minOccurs="1" maxOccurs="*", output)
property Description:
Name of the property, used for both input and output XML. Output property nodes can be followed by value nodes.

Child:
value (minOccurs="1" maxOccurs="*", output only)

Attributes:

name Name of the property.
propertyList Description:
A list of Active Directory properties to retrieve. Use the LDAP attribute display name for the name attribute of the each property element. If the propertyList element is not provided or is empty, all properties are returned.

Parent:
executeData

Child:
property (minOccurs="0" maxOccurs="*", input)

Attributes:

name Required. Name of the property to retrieve.
value Description:
A value of a property. Example (for a VT_BOOL property type): 
<property name='showInAdvancedViewOnly'>
  <value xmlns:dt='urn:schemas-microsoft-com:datatypes' dt:dt='boolean'>1</value>
</property>

Parent:
Property

Remarks

Active Directory Provider supports the following property types (based on what IADs::GetEx returns).

See Also

Active Directory Provider, Preferred DC Active Directory Provider, Set Properties