Exchange Resource Manager Namespace API

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

Overview

The Exchange Resource Manager 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 which integrates functionality from Exchange Resource Manager Ex, and also adds the ability to allocate more than one mail store to an organization.

This document describes the 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 namespace component is to manage Exchange resources so that the following can occur:

Resource Tracking

The Exchange Resource Manager tracks the following resources:

Upgrade Issues

This section describes issues related to the deprecation of the ExchOwningOrgResource type, which should be addressed to upgrade existing installations that have earlier versions of the Exchange Resource Manager.

The ExchOwningOrgResource type from earlier versions contained organization resource information for both the single public folder available storage and the single mail store available storage. The mail storage was contained in the resource's actual values, and the public folder storage was contained in the resource's virtual values.

Because the new version of the Exchange Resource Manager supports multiple mail stores per organization, the ExchOwningOrgResource type has been split into two new resource types: ExchOwningOrgMailResource, and ExchOwningOrgPublicResource.

Upgrades to existing installations must have the old resource types converted to the new resource types, and the ExchPublicFolder and ExchMailbox consumer types allocated from the old resource types must have their allocations updated to point to the new types.

For more information, see the procedure topic Exchange Resource Manager Ex::MigrateVersion1Data_.

Dependencies

You install the Exchange Resource Manager 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:

Public Method Description
Exchange Resource Manager::AddExchangeResources Adds public stores and mailbox stores to the pool of resources managed by Exchange Resource Manager.
Exchange Resource Manager::ModifyExchangeResources Changes the disk storage available for public stores and private stores (mailbox stores).
Exchange Resource Manager::RemoveExchangeResources Removes public and private stores from the pool of resources managed by Exchange Resource Manager.
Exchange Resource Manager::AllocateOrganization Finds and allocates the resources that an organization is permitted to use.
Exchange Resource Manager::DeallocateOrganization Frees all resources owned by the organization.
Exchange Resource Manager::ReallocateOrganizationMailNoMove Changes the amount of mail storage that an organization is permitted to use.
Exchange Resource Manager::AllocatePublicFolder Allocates storage for a public folder.
Exchange Resource Manager::ReallocatePublicFolder Frees all resources owned by the organization. All of the mailboxes and public folders allocated from the organization must be deallocated before this call will succeed.
Exchange Resource Manager::ReallocatePublicFolder Changes the storage allocation for a public folder.
Exchange Resource Manager::AllocateMailbox Allocates storage for a mailbox.
Exchange Resource Manager::DeallocateMailbox Deletes the storage allocation for a mailbox.
Exchange Resource Manager::ReallocateMailbox Changes the storage allocation for a mailbox.
Exchange Resource Manager::QueryAllStores Returns all Exchange resources that have been added to the system including the total storage megabytes and the free storage megabytes.
Exchange Resource Manager::QueryResourcesByOrganization Returns all Exchange resources in use by a particular owning organization.
Exchange Resource Manager::QueryConsumersByOrganization Returns all of the organizations that have had Exchange resources allocated to them.
Exchange Resource Manager::QueryAllOrganizations Returns all of the organizations that have had Exchange resources allocated to them.
Exchange Resource Manager::QueryOrganizationsByMailStore Returns all of the organizations that have had Exchange resources allocated to them on a specified mail store.
Exchange Resource Manager::QueryOrganizationsByPublicStore Returns all of the organizations that have had Exchange resources allocated to them on a specified public store.
Exchange Resource Manager::InitializeExchRM Initializes Exchange Resource Manager at install time. Adds new types used by the Exchange Resource Manager.
Exchange Resource Manager::UninitializeExchRM Uninitializes Exchange Resource Manager at uninstall time. Also removes types that were added by Exchange Resource Manager.
Exchange Resource Manager::MigrateVersion1Data Migrates Resource Manager data created by version one of the Exchange Resource Manager namespace.
 Applies To