Hosted Exchange Namespace API
This document provides the details of the application programming interface (API) for the Hosted Exchange namespace included with the Microsoft Provisioning System (MPS) in Microsoft Solution for Hosted Messaging and Collaboration version 3.5 and 3.0. Contained herein are descriptions of the procedures of this namespace along with method input parameters and return values. In addition, example XML requests are provided along with typical Extensible Markup Language (XML) responses 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 Hosted Exchange services or as a basis for review of the Hosted Exchange named procedures that are implemented in the Web Service.
Overview
The Hosted Exchange namespace exposes a set of Microsoft Provisioning Framework (MPF) public named procedures for the provisioning of Hosted Exchange services. This document contains procedures from previously existing Hosted Exchange versions in addition to new procedures for Hosted Exchange in Microsoft Solution for Hosted Messaging and Collaboration version 3.5 and 3.0.
Changes to LDAP Parameters
The Lightweight Directory Access Protocol (LDAP) parameter, used to specify the distinguished name (DN) including the preferred domain controller in some of the procedures that follow will be removed in a future release of the solution. To prepare for this change, use the LDAP path with no domain controller in those procedures and use the <preferreddomaincontroller> parameter to specify the preferred domain controller.
Dependencies
You install the Hosted Exchange namespace with the MPS Deployment Tool. The functionality of this namespace depends on interaction with other namespaces that are installed with MPS core components, as follows:
CoreRMO Provider
BlockModelRMO Provider
Registry Provider
Preferred DC Active Directory Provider
Managed Active Directory
Managed Hosting Namespace
MPF Config Namespace
In addition, the Hosted Exchange namespace is also dependent on other namespaces. Therefore, you must ensure that you queue the following additional components for installation with the MPS Deployment Tool at deployment design time.
Exchange Provider
Active Directory Provider
Exchange Resource Manager Namespace
Exchange Resource Manager Ex Namespace
Managed Exchange Namespace
SQL Admin Provider
| Public Method | Description |
|---|---|
Adds service plans to the list of available plans for an organization. |
|
Modifies a customer's mailbox plan to a new specified mailbox plan. |
|
Changes the password of an Active Directory user object. |
|
Creates a business organization and Exchange enables the organization. |
|
Creates a business user. |
|
Creates a consumer user with attributes based on a specified service plan. |
|
Adds an SMTP Domain name to recipient policies and sets it as the primary domain for a consumer user. |
|
Creates a distribution list. |
|
Creates an Exchange mailbox for a specified user. |
|
Creates a new mailbox service plan in the customer plan database. |
|
Creates new feature types in the customer plan database. |
|
Creates a Global Address, Address, and Offline Address lists for a specified organization. |
|
Creates new feature types in the customer plan database. |
|
Creates the top level public folder for an organization. |
|
Creates a reseller organization in the specified container. |
|
Adds an SMTP Domain to a specified organization. |
|
Adds an SMTP proxy address to a specified user's list of proxy addresses. |
|
Deletes a business organization, de-allocates mailbox resources, marks the organization deleted in the plan database, and records a billing event. |
|
Deletes a business user, de-allocates mailbox resources, marks the user deleted in the plan database, and records a billing event. |
|
Deletes a consumer user, de-allocates mailbox resources, marks the user deleted in the plan database, and records a billing event. |
|
Deletes a distribution list. |
|
Deletes the top level public folder for an organization. |
|
Deletes an SMTP Domain to a specified organization. |
|
Deletes an SMTP proxy address to a specified user's list of proxy addresses. |
|
Disables a User object in Active Directory directory service and records a billing event. |
|
Enables a user object in Active Directory and records a billing event. |
|
Attempts to create a virtual directory on every Exchange server. |
|
Enables an organization for Exchange Mailboxes. Procedure is called by CreateBusinessOrganization. |
|
Retrieves a list of organizations that have had membership changes in a given timeframe. |
|
Rebuilds an organization's Offline Address Book. |
|
Retrieves the plans that are defined as available for a specified organization. |
|
Adds a SMTP Domain to a specified organization. |
|
Deletes a SMTP Domain from a specified organization. |
|
Adds an SMTP proxy address to a specified user's list of proxy addresses. |
|
Deletes an SMTP proxy addresses from a specified user's list of proxy addresses. |
|
Retrieves a listing of SMTP domains assigned to an organization. |
|
Retrieves the details of a specified service plan. |
|
Returns a listing of service plans based on optional filters. |
|
Get properties for a specified object using an LDAP path. |
|
Adds customer, asset, plan, status, feature, and event types to the Customer Plan and Events database that are utilized by the Hosted Exchange Namespace. |
|
Initializes the Hosted Exchange Namespace. |
|
Initializes security settings for the Hosted Exchange Namespace procedures. |
|
Adds or removes a customer user from the admin group in the users organization. |
|
Modifies the attributes of a user's Active Directory object. |
|
Modifies a distribution list. |
|
Rebuilds an organization's Offline Address Book. |
|
Removes service plans from the list of available plans for an organization. |
|
Sets the location of the Customer Plan database in the system registry. |
|
Set the password of a customer Active Directory directory service user object. |
Applies To
Hosted Messaging and Collaboration version 3.5
Hosted Messaging and Collaboration version 3.0