Active Directory Provider::Delete Object

  • Article

Deletes the specified Active Directory directory service object. Used by Microsoft Provisioning Framework (MPF).

Delete Object is a wrapper for IADsDeleteOps::DeleteObject.

Arguments

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 data.

Children:
flagIgnoreDoesNotExistError ( minOccurs="0" maxOccurs="1")
path ( minOccurs="1" maxOccurs="1")

flagIgnoreDoesNotExistError

Description:
Specifies whether the delete succeeds if the object does not exist. Ordinarily, the procedure would fail. However, if this element is included in the input XML, the delete succeeds, as does any rollback for the delete.

Parent:
executeData

path

Description:
Lightweight directory access protocol (LDAP) path of the object to delete.

Parent:
executeData

Remarks

To delete subtrees, this procedure must have permission to execute Delete Subtree in the Active Directory Users and Computers (ADUC) console.

Schema Definition

Input

<executeData>1..1
 <path>1..1</path>
 <flagIgnoreDoesNotExistError>0..1</flagIgnoreDoesNotExistError>
</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.

Example XML Response

Delete Object does not return data.

Applies To

Active Directory Provider for:

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0

  • Hosted Messaging and Collaboration version 3.5

  • Hosted Messaging and Collaboration version 3.0

  • Windows-based Hosting version 4.5

  • Windows-based Hosting version 4.0

  • Windows-based Hosting version 3.5

  • Windows-based Hosting for Applications version 1.0

See also

Tasks

Active Directory Provider::Create Object