Managed Data Hosting Namespace

This section provides the details of the application programming interface (API) for the Managed Data Hosting Namespace, included with the Microsoft Provisioning System (MPS) in Microsoft Solution for Hosted Messaging and Collaboration version 4.5 . This document describes the methods of this namespace along with input parameters and return values. In addition, example Extensible Markup Language (XML) requests are provided along with a typical XML response that the provisioning system returns after a request is submitted to MPS and tasks are completed.

Developers can use this API document as a reference when creating XML requests that initiate the provisioning of hosted Data services.

Overview

The Managed Data Hosting Namespace provides a set of Microsoft Provisioning Framework (MPF) named procedures for provisioning databases for customers in shared scenarios. This namespace enhances the low-level SQL Admin Provider API by integrating several aspects of database provisioning to include:

  • File directories for log and data files.

  • File directories for backups.

  • Database Create/Delete/Modify.

  • Auto creation of administrator role for database.

  • Security checks based on the Microsoft Active Directory directory service hosting model.

  • File/directory permissions.

Note

In the method definitions that follow, the sqlUserName and sqlUserPass parameters must be specified only if you enabled SQL authentication on the SQL server. If you are using Windows authentication and you specify these optional parameters, the request will fail.

Public Method Description

Managed Data Hosting::CreateCustomerDatabase

Creates a database for a specified customer and optionally creates a customer directory structure on a specified share for data (.mdf) and log (.ldf) file.

Managed Data Hosting::DeleteCustomerDatabase

Deletes a database for a specified customer and cleans up the specified file directory.

Managed Data Hosting::ModifyCustomerDatabaseFile

Modifies settings for a specified database.

Managed Data Hosting::BackupCustomerDbToDisk

Performs a full backup of a specified database to disk.

Managed Data Hosting::RestoreCustomerDbFromDisk

Performs a full restore of a specified database from disk.

Managed Data Hosting::QueryDatabaseByCustomer

Returns a listing of databases for a customer organizational unit.

Managed Data Hosting::ConfigureSQLServerForDelegation

Allows configuration of a specified SQL server for delegated administration.

Managed Data Hosting::DeconfigureSQLServerForDelegation

Allows configuration of a specified SQL server for delegated administration.

Applies To

  • 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