Managed Windows-based Hosting Namespace API
This section provides the details of the application programming interface (API) for the Managed Windows-based Hosting Namespace included with the Microsoft Provisioning System (MPS).
It describes the procedures of this namespace along with method input parameters and return values. In addition, example XML requests are provided along with a typical Extensible Markup Language (XML) response that the provisioning system returns after a request is submitted to MPS and tasks are completed. Developers should use this API document as a reference when creating XML requests that initiate the provisioning of Web, Data, Microsoft Windows SharePoint Services, Microsoft Active Directory directory service, and Domain Name System (DNS) services.
Overview
The Managed Windows-based Hosting Namespace is a new high-level namespace that provides a select set of Microsoft Provisioning Framework (MPF) named procedures for the provisioning of customer service plans, Web sites, databases, Windows SharePoint Services, Active Directory, and DNS hosted services with MPS. The namespace comprises the upper level of a three layer namespace architecture that is now implemented in MPS. The Managed Windows-based Hosting Namespace enhances underlying managed namespaces by integrating them with service plan and resource management logic.
Public Methods
| Public Method | Description |
|---|---|
Adds a new plan to the available plans. |
|
Enables a plan. |
|
Disables a plan. |
|
The CreateResellerOrganization procedure creates a reseller organization. |
|
The CreateCustomerOrganization procedure creates a customer organization. |
|
The CreatePlan procedure creates a new plan. |
|
The CreateUser procedure creates a new user within a specified organization according to the policy name passed in as <policyName>. Possible values for this tag are "hosting," "reseller," "customer," and "default." The default policy creates only the requested organization. The exact behaviors of these policies are defined in the GetPolicy procedure in the Managed Active Directory namespace. |
|
The DeleteOrganization procedure deletes an organization, de-allocates resources, and marks the organization as deleted in the Customer Service Plans database. |
|
The DeleteUser procedure deletes a user, de-allocates resources, marks the user deleted in the Customer Service Plans database, and records a billing event. |
|
The AddPlansToCustomer procedure adds valid service plans to a customer organizational unit and reserves any required resources. |
|
The ChangeCustomerPlan procedure changes a customer's service plan to another plan of the same type. |
|
The RemovePlansFromCustomer procedure removes service plans from a customer organizational unit and releases any resources as necessary. |
|
The QueryPlans procedure returns a list of plans. |
|
The QueryCustomerPlans procedure returns a list of plans for a specified customer. |
|
The QueryServicesByCustomer procedure queries all service plan, resource, and provisioned service details for a customer and returns a listing of plans and provisioned services for a customer organizational unit. |
|
The DeleteCustomerWebSite procedure deletes a customer Web site and associated directories. |
|
The ModifyCustomerWebSite procedure modifies an existing hosted Web site. |
|
The ControlCustomerWebSite procedure starts, stops, or pauses a customer Web site. |
|
The CreateCustomerDatabase procedure 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. The size of the database is retrieved from the Customer Service Plans database and is based on customer's plan. The size is then applied to set the dataFile size (total allowed by plan is 1 mg for logFile). |
|
The DeleteCustomerDatabase procedure deletes a database for a specified customer and cleans up the specified file directory. |
|
The ModifyCustomerDatabaseFile procedure modifies settings for a specified database. This procedure is used to modify the size of the database dataFile and customer database's allocation. This procedure should not be used to modify the datalog file. |
|
The CreateCustomerSharePointSite procedure creates a Windows SharePoint site collection for a customer. |
|
The DeleteCustomerSharePointSite procedure deletes a Windows SharePoint site collection for a customer. |
|
The AddUserToSharePointSiteRole procedure adds a user to a Windows SharePoint site role. |
|
The RemoveUserFromSharePointSiteRole procedure deletes a user from a Windows SharePoint site role. |
|
The CreateDNSZone procedure creates a zone on a specified DNS server. |
|
The DeleteDNSZone procedure deletes a zone on a specified DNS server. |
|
The CreateResourceRecord procedure creates a resource record for a specified zone on a specified DNS server. |
|
The DeleteResourceRecord procedure deletes a resource record for a specified zone on a specified DNS server. |
Applies To
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