Windows-based Hosting::DeleteCustomerDatabase

  • Article

The DeleteCustomerDatabase procedure deletes a database for a specified customer and cleans up the specified file directory.

Arguments

The DeleteCustomerDatabase procedure has the following input parameters.

Input Argument Description

<org>

The Lightweight Directory Access Protocol (LDAP) path of the owning organization.

<databaseName>

The name of the database to be deleted.

<preferredDomainController>

The name of the preferred domain controller.

<sqlUserName>

The user name for connecting to the SQL server via SQL Authentication. If this node is present, the connection will be made via SQL Authentication rather than Windows Authentication. The existence of this node also requires that the <sqlUserPass/> node exist.

<sqlUserPass>

The password for connecting to the SQL server via SQL Authentication, using the username indicated by <sqlUserName/>. If the <sqlUserName/> node is not present, this node is ignored.

Output Arguments

The DeleteCustomerDatabase procedure has no return values.

Remarks

Security

The DeleteCustomerDatabase procedure has the following security requirements:

  • The caller is impersonated.

  • The caller is tested for OrgCreator permissions.

Process Steps

The following steps occur when deleting a customer database with the DeleteCustomerDatabase procedure of the Managed Windows-based Hosting Namespace:

  • Delete the database by calling Managed Data Hosting::DeleteCustomerDatabase.

  • Remove the customer's root share if empty.

  • De-allocate resources from the resource pool.

  • Update Resource Manager allocations.

Sample Code

Example XML Request

The following is an example of an XML request for the DeleteCustomerDatabase procedure of the Managed Windows-based Hosting Namespace:

<request> 
        <procedure> 
                <execute namespace="Windows-based Hosting"  
                procedure="DeleteCustomerDatabase" impersonate="1"> 
                        <executeData> 
                        <org>LDAP://OU=northwindtraders,OU=consolidatedmessenger, 
                        OU=Hosting,DC=fabrikam,DC=Com</org> 
                        <databaseName>NorthWindSales</databaseName> 
                        <preferredDomainController>AD01.fabrikam.Com 
                        </preferredDomainController> 
                        </executeData> 
                        <after source="executeData" destination="data" mode="merge"/> 
                </execute>   
        </procedure> 
</request>

Applies To

Managed Windows-based Hosting Namespace API for:

  • 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

Windows-based Hosting::CreateCustomerDatabase
Windows-based Hosting::ModifyCustomerDatabaseFile