This document provides the details of the application programming interface (API) for the Exchange Resource Manager Ex namespace included with the Microsoft Provisioning System (MPS) in the . 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 Exchange resource management services or as a basis for review of the Exchange Resource Manager Ex named procedures that are implemented in the Web Service.

The Exchange Resource Manager Ex namespace exposes a set of Microsoft Provisioning Framework (MPF) public named procedures for tracking Exchange resources. This document includes procedures that update the original Exchange Resource Manager Ex namespace that aggregated procedures from previous releases of Microsoft Solution for Hosted Messaging and Collaboration, which included High Volume Exchange 1.0 and 1.1 procedures.

This document describes procedures that sit on top of MPF to enable management of Exchange resources. MPF resource management functionality tracks which resources are available and which are already allocated. This functionality performs bookkeeping, but does not do any active assignment of resources.

The main goal of the Exchange Resource Manager Ex namespace component is to manage Exchange resources so that the following can occur:

• Resources do not leak.
• Resources can be deallocated when customers leave the ISP service entirely or discontinue the Web site portion of the ISP service.
• The deallocated resources can be recycled to new customers.

The Exchange Resource Manager Ex namespace enables tracking of the following resources:

• Exchange mailbox stores dedicated to "consumer" mailboxes.
• Exchange front-end servers.

This section describes issues necessary for upgrade of existing installations that have earlier versions of the Exchange Resource Manager Ex namespace.

• ConsumerType "user" Deprecated-The "user" type from earlier versions designated a consumer type to represent consumer user mailboxes. This type is not strongly named and can be easily mistaken for another consumer type. This type is replaced by a more explanatory type: ExchConsumerMailbox.
• ResourceType "Mailstore" Deprecated-The "Mailstore" type from earlier versions designated a resource type to represent mailstores dedicated to hosting "Consumer Users". This type is not strongly named and can be easily mistaken for another resource type. This type is replaced by a more explanatory type: ExchConsumerMailStore.
• ResourceType "ExchConsumerMailstore" Data Storage Standardized-The previous "Mailstore" resource type stored identifying data as follows:
  • instanceName = Mail Store name (e.g. ConsumerMailStore1)
  • instanceLocation = Mail Store server name (e.g. EXBE01)
  • instanceDescription = Exchange Mail Store
• The new "ExchConsumerMailstore" resource type will identify data as follows:
  • instanceName = The objectGUID of the Exchange Mailstore Object
  • instanceLocation = Mail Store server name (e.g. EXBE01)
  • instanceDescription = Mail Store name (e.g. ConsumerMailStore1)

This is consistent with the ExchMailStore resourceType used by the Exchange Resource Manager. Existing resourceInstances are standardized to this new format by the procedure MigrateVersion1Data_ which is called by InitializeExchRMEx. For information about this procedure, see the "MigrateVersion1Data_" topic.

You install the Exchange Resource Manager Ex 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
• Managed Active Directory Namespace
• Managed Hosting Namespace

The Exchange Resource Manager Ex namespace contains named procedures for the tracking of Exchange resources that fall into the following categories:

• Managing resources
• Allocating and deallocating resources
• Querying resources
• Initialization and migration

The sections that follow describe the procedures in these categories.

Public Method	Description
Exchange Resource Manager Ex::ReallocateConsumerMailstoreResource	Modifies the properties of existing mail stores which have been added to resource management for e-mail consumers. The procedure can change the size of a mail store in resource management, by specifying number of megabytes by which to increase or decrease the allocation.
Exchange Resource Manager Ex::ReallocateBusinessMailstoreResource	Modifies the properties of existing mail stores which have been added to resource management for business organizations. The procedure can change the size of a mail store in resource management, by specifying number of megabytes by which to increase or decrease the allocation.
Exchange Resource Manager Ex::RemoveExchangeResources	Removes Exchange resource from the pool of resources managed by Exchange Resource Manager and Exchange Resource Manager Ex. This call is restricted to Domain Admins.
Exchange Resource Manager Ex::AddExchangeResources	Adds public stores and mailbox stores to the pool of resources managed by Exchange Resource Manager. The stores must actually exist before being added. This call is restricted to Domain Admins. This procedure integrates the task of adding all exchange resources by combining calls from the Exchange Resource Manager and Exchange Resource Manager Ex namespaces.
Exchange Resource Manager Ex::ReallocateOrganizationMailNoMove	ReallocateOrganizationMailNoMove changes the amount of mail storage that an organization is permitted to use. This procedure will fail if there is insufficient room in the system for the requested new storage, or if any explicitly requested mail store is unavailable.
Exchange Resource Manager Ex::ReallocateMailbox	Changes the storage allocation for a mailbox.
Exchange Resource Manager Ex::AllocateConsumerUserMailbox	Allocates a new consumer user's mailbox and decrement the size of the mailbox from the MailStore selected by the procedure.
Exchange Resource Manager Ex::DeAllocateConsumerUserMailbox	De-allocates a consumer user's mailbox and add the size of the mailbox to the MailStore where the user was provisioned.
Exchange Resource Manager Ex::ReAllocateConsumerMailbox	Changes the storage allocation for a mailbox provisioned for a consumer user.
Exchange Resource Manager Ex::QueryAllFrontEndServers	Returns a listing of all front end Exchange servers that have been added with AddExchangeResources.
Exchange Resource Manager Ex::QueryAllMailServers	Returns a listing of all mail servers.
Exchange Resource Manager Ex::QueryAllExchangeResources	Returns a listing of all mail stores, public stores, front end servers, and consumer mail stores.
Exchange Resource Manager Ex::QueryConsumerMailboxAllocation	Queries the properties of an existing mailbox resource allocation. This procedure also returns information on mailboxes that were allocated using AllocateConsumerMailbox which use a type of ExchConsumerMailbox.
Exchange Resource Manager Ex::QueryConsumerMailboxesByMailstore	Returns all of the consumer mailboxes allocated to a specified mail store.
Exchange Resource Manager Ex::QueryMailboxAllocation	Queries the properties of an existing mailbox resource allocation. It returns information on mailboxes that were allocated using AllocateMailbox which use a type of ExchMailbox.
Exchange Resource Manager Ex::InitializeExchRMEx	Initializes Exchange Resource Manager Ex Namespace at install time. It adds new types that Exchange Resource Manager Ex uses.
Exchange Resource Manager Ex::UninitializeExchRMEx	Uninitializes Exchange Resource Manager Ex Namespace at uninstall time. It removes types that were added by the Exchange Resource Manager Ex Namespace.
Exchange Resource Manager Ex::MigrateVersion1Data_	This private named procedure migrates resource manager data created by version 1 of the Exchange Resource Manager Ex namespace. This procedure is called by InitializeExchRMEx. For further details about what this procedure accomplishes, see the earlier topic "Upgrade Issues."

Applies To

Hosted Messaging and Collaboration version 3.5 Hosted Messaging and Collaboration version 3.0