This section describes the functions and methods of managed namespaces provided with Microsoft hosting solutions, in addition to several previously existing managed namespaces. You should assess the functionality of these namespaces with respect to the business logic you will require to implement provisioning actions in your system. If the namespaces discussed in this section do not provide the functionality you require in your system, you will need to create your own custom namespaces that call the appropriate procedures of MPS providers.
See the MPS Operations Guide "Developing and Implementing Custom Namespaces" topic for guidance on how to create your own namespaces. You can locate the MPS Operations Guide on the solution distribution CD at: \Service Provisioning\MPS\MPF\help\opsguide.chm.
Note: |
---|
The Managed Windows SharePoint, Managed Data Hosting, and Managed Web Hosting namespaces do not implement any service plans or resource management logic. This enables use of these namespaces in scenarios where built-in plans and resource management are not desired by the service provider. |
Hosted Exchange Namespace
Provides a set of MPF named procedures for provisioning Hosted Exchange services, which includes the following:
- AddAvailablePlans - Adds service plans to the list of available
plans for an organization.
- ChangeUserPassword - Changes the password of an Active
Directory user object.
- CreateBusinessOrganization - Creates a business organization
and enables an organization for Exchange.
- CreateBusinessUser - Creates a business user.
- CreateConsumerUser - Creates a consumer user with attributes
based on a specified service plan.
- CreateConsumerVanityDomain - Adds a Simple Mail Transfer
Protocol (SMTP) domain name to recipient policies and sets it as
the primary domain for a consumer user.
- CreateMailboxPlan - Creates a new mailbox service plan in the
customer plan database, and also assigns features and categorizes
the plan.
- CreateMailbox - Creates an Exchange mailbox for a specified
user.
- CreatePlanFeatureTypes - Creates new feature types in the
customer plan database.
- CreateOrganizationAddressLists - Creates a Global Address,
Address, and Offline Address lists for a specified
organization.
- CreatePublicFolder - Creates the top level public folder for an
organization.
- CreateResellerOrganization - Create a reseller organization in
the specified container.
- ChangeUserMailboxPlan - Modifies a customer's mailbox plan to a
new specified mailbox plan.
- CreateDistributionList - Creates a distribution list.
- DeleteBusinessOrganization - Deletes a business organization,
de-allocates mailbox resources, marks the organization deleted in
the plan database, and records a billing event.
- DeleteBusinessUser - Deletes a business user, de-allocates
mailbox resources, marks the user deleted in the plan database, and
records a billing event.
- DeleteConsumerUser - Deletes a consumer user, de-allocates
mailbox resources, marks the user deleted in the plan database, and
records a billing event.
- DisableUser - Disables a User object in Active Directory and
records a billing event.
- DeletePublicFolder - Deletes the top level public folder for an
organization.
- DeleteDistributionList - Deletes a distribution list.
- EnableUser - Enables a user object in Active Directory and
records a billing event.
- EnsureExchangeVirtualDirectories - Attempts to create a virtual
directory on every Exchange server. Procedure does not fail if a
virtual directory already exists.
- ExchangeEnableOrganization - Enable an organization for
Exchange mailboxes.
- GetModifiedOrganizations - Retrieves a list of organizations
that have had membership changes in a given time frame.
- RebuildOfflineAddressList - Rebuilds an organization's offline
address book.
- GetOrganizationAvailablePlans - Retrieves the plans that are
defined as available for a specified organization.
- CreateSMTPDomain - Adds a SMTP domain to a specified
organization.
- DeleteSMTPDomain - Deletes an SMTP domain from a specified
organization.
- CreateSMTPProxyAddress - Adds an SMTP proxy address to a
specified user's list of proxy addresses.
- DeleteSMTPProxyAddress - Deletes an SMTP proxy addresses from a
specified user's list of proxy addresses.
- GetOrganizationDomains - Retrieves a listing of SMTP domains
assigned to an organization.
- GetPlanDetail - Retrieves the details of a specified service
plan.
- GetPlans - Returns a listing of service plans based on optional
filters, such as statusTypeName, categoryName, and planTypeName,
which restrict the returned service plan records to those that
match the criteria.
- GetProperties - Gets properties for a specified object using an
Lightweight Directory Access Protocol (LDAP) path.
- InitializeCustomerPlanDatabase - Adds customer, asset, plan,
status, feature, and event types to the Customer Plan and Events
database that is utilized by the Hosted Exchange
Namespace.
- InitializeHostedExchange - Initializes the Hosted Exchange
Namespace. This procedure is called once when you are setting up
the Hosted Exchange provisioning system.
- InitializeNamespaceSecurity - Initializes security settings for
the Hosted Exchange Namespace procedures.
- MakeUserAdmin - Adds or removes a customer user from the admin
group in the users organization.
- ModifyUser - Modifies the attributes of a user's Active
Directory object.
- ModifyDistributionList - Modifies a distribution list.
- RemoveAvailablePlans - Removes service plans from the list of
available plans for an organization.
- SetCustomerDatabaseLocation - Sets the location of the Customer
Plan database in the system registry.
- SetUserPassword - Sets the password of a customer Active
Directory user object.
For more details on method calls, required parameters, and sample XML requests, see .
Exchange Resource Manager Namespace
The Exchange Resource Manager Namespace exposes a set of public named procedures for tracking Exchange resources, which includes those resources that are available and those that are already allocated. The purpose of the Exchange Resource Manager Namespace is to manage Exchange resources so that the resources do not leak and can be deallocated when customers leave the service provider's service entirely or when they discontinue the Web site portion of the service provider's service. In addition, the namespace enables you to recycle deallocated resources to new customers.
The following resources are tracked by the Exchange Resource Manager Namespace:
- Exchange mailbox stores.
- Exchange public folder stores.
- Mailbox stores allocated to an organization.
- Mailbox store memory available to and owned by an organization.
This value is enforced as the sum of mailbox sizes for all mailbox
stores for the users in an organization.
- Public store memory available to an organization.
- Default mail store size for users in an organization.
The Exchange Resource Manager Namespace provides the following methods that perform the indicated provisioning tasks:
- AddExchangeResources - Adds public and mailbox stores to the
pool of resources managed by Exchange Resource Manager.
- ModifyExchangeResources - Changes the disk storage available
for public and private stores.
- RemoveExchangeResources - Removes public and private stores
from the pool of resources managed by Exchange Resource
Manager.
- AllocateOrganization - Finds and allocates the resources that
an organization is permitted to use, including the resources used
for private mailboxes and public folders owned by the
organization.
- DeallocateOrganization - Frees all resources owned by the
organization.
- ReallocateOrganizationPublic - Changes the amount of public
folder storage that an organization is permitted to use.
- ReallocateOrganizationMailNoMove - Changes the amount of mail
storage that an organization is permitted to use.
- AllocatePublicFolder - Allocates storage for a public folder;
allocated from the pool owned by the owning organization.
- DeallocatePublicFolder - Deletes the storage allocation for a
public folder.
- ReallocatePublicFolder - Changes the storage allocation for a
public folder; allocated from the pool owned by the owning
organization.
- AllocateMailbox - Allocates storage for a mailbox; allocated
from the pool owned by the owning organization.
- DeallocateMailbox - Deletes the storage allocation for a
mailbox.
- ReallocateMailbox - Changes the storage allocation for a
mailbox.
- QueryAllStores - Returns all Exchange resources that have been
added to the system including the total storage megabytes and the
free storage megabytes.
- QueryResourcesByOrganization - Returns all Exchange resources
in use by a particular owning organization.
- QueryConsumersByOrganization - Returns all of the consumers of
the Exchange resources of a particular owning
organization.
- QueryAllOrganizations - Returns all of the organizations that
have had Exchange resources allocated to them.
- QueryOrganizationsByMailStore - Returns all of the
organizations that have had Exchange resources allocated to them on
a specified mail store.
- QueryOrganizationsByPublicStore - Returns all of the
organizations that have had Exchange resources allocated to them on
a specified public store.
- InitializeExchRM - Initializes Exchange Resource Manager at
install time and adds new types used by the Exchange Resource
Manager.
- UninitializeExchRM - Uninitializes Exchange Resource Manager at
uninstall time. Also removes types that were added by Exchange
Resource Manager.
- MigrateVersion1Data - Migrates Resource Manager data created by
version one of the Exchange Resource Manager namespace.
For more details on method calls, required parameters, and sample XML requests, see .
Exchange Resource Manager Ex Namespace
The Exchange Resource Manager Ex Namespace exposes a set of public named procedures for tracking Exchange resources. The purpose of the Exchange Resource Manager Ex Namespace is to manage Exchange resources so that the resources do not leak and can be deallocated when customers leave the service provider's service entirely or discontinue the Web site portion of the service provider's service. In addition, the namespace enables you to recycle deallocated resources to new customers.
The following resources are tracked by the Exchange Resource Manager Ex Namespace:
- Exchange mailbox stores dedicated to "consumer"
mailboxes.
- Exchange front-end servers.
The Exchange Resource Manager Ex Namespace provides the following methods that perform the indicated provisioning tasks:
- AddExchangeResources - Adds public and mailbox stores to the
pool of resources managed by Exchange Resource Manager.
- RemoveExchangeResources - Removes public and private stores
from the pool of resources managed by Exchange Resource
Manager.
- ReallocateBusinessMailstoreResource - Modifies the properties
of existing mail stores which have been added to resource
management for business organizations.
- ReallocateConsumerMailstoreResource - Modifies the properties
of existing mail stores which have been added to resource
management for e-mail consumers.
- ReallocateOrganizationMailNoMove - Changes the amount of mail
storage that an organization is permitted to use.
- ReallocateMailbox - Changes the storage allocation for a
mailbox.
- AllocateConsumerUserMailbox - Allocates a new consumer user's
mailbox and decrement the size of the mailbox from the MailStore
specified by the procedure.
- DeAllocateConsumerUserMailbox - De-allocates a consumer user's
mailbox and add the size of the mailbox to the MailStore where the
user was provisioned.
- ReAllocateConsumerMailbox - Changes the storage allocation for
a mailbox provisioned for a consumer user.
- QueryAllFrontEndServers - Returns a listing of all front-end
Exchange servers that have been added with
AddExchangeResources.
- QueryAllMailServers - Returns a listing of all mail
servers.
- QueryAllExchangeResources - Returns a listing of all mail
stores, public stores, front-end servers, and consumer mail
stores.
- QueryConsumerMailboxAllocation - Queries the properties of an
existing mailbox resource allocation.
- QueryConsumerMailboxesByMailstore - Returns all of the consumer
mailboxes allocated to a specified mail store.
- QueryMailboxAllocation - Queries the properties of an existing
mailbox resource allocation.
- InitializeExchRMEx - Initializes Exchange Resource Manager Ex
Namespace at install time. It also adds new types that Exchange
Resource Manager Ex uses.
- UninitializeExchRMEx - Uninitializes Exchange Resource Manager
Ex Namespace at uninstall time. It also removes types that were
added by the Exchange Resource Manager Ex Namespace.
- MigrateVersion1Data - Migrates resource manager data created by
version 1 of the Exchange Resource Manager Ex namespace.
For more details on method calls, required parameters, and sample XML requests, see .
Hosted Exchange Mobility Namespace
The Hosted Exchange Mobility Namespace coordinates calls between various providers and other namespaces to implement mobility provisioning tasks. This namespace encapsulates provisioning functionality to enable the following:
- Setting device configuration over-the-air (OTA).
- Configuring mobile device policies.
- Remotely wiping a mobile device.
The Hosted Exchange Mobility Namespace provides the following methods that perform the indicated provisioning tasks:
- Initialize - Initializes types for the mobility provisioning
system.
- CreateDevicePolicy - Creates a mobile device policy for a
specified organization.
- ClearPolicyExemption - Clears user settings for device policy
check exemption.
- ClearUserDevicePolicy - Clears a specified user's mobile device
policy.
- DeleteDevicePolicy - Deletes a mobile device policy for a
specified organization.
- GetDevicePolicyDetail - Retrieves the details of a specified
device policy.
- GetDevicePolicies - Retrieves a listing of device polices for a
specified organization.
- GetUserDevicePolicy - Gets a specified user device
policy.
- ModifyDevicePolicy - Modifies a device policy definition for a
specified device policy within a specified organization.
- SetUserPolicyExemption - Exempts a user from any device policy
checks.
- SetUserDevicePolicy - Sets the mobile device policy for a
specified user.
- QueryDevicePolicyUsageByOrganization - Retrieves a report of
device policy usage for a specified organization.
- QueryDevicePolicyEventsByUser - Retrieves a report of device
policy event history for a specified user.
- AddUserDevice - Provisions a mobile device for a specified
user.
- DeleteUserDevice - Deletes a mobile device for a specified
user.
- GetUserDevices - Gets a listing of devices for a specified
user.
- ModifyUserDevice - Modifies the phone number of a specific
device.
- CancelDeviceWipe - Cancels an in-progress mobile device wipe if
it is not yet complete.
- WipeDevice - Sends a remote wipe command to a specified Active
Sync device (mobile device).
- QueryWipeEventsByUser - Retrieves a listing of mobile device
wipe events for a specified user.
For more details on method calls, required parameters, and sample XML requests, see .
Managed CDI Namespace
The Managed CDI Namespace sets up a customer organization and users for the password synchronization and unification features of the Customer Directory Integration (CDI) Service, which is implemented through Microsoft Identity Integration Server (MIIS). This namespace also enables you to manage CDI settings for customer users and organizations and to disable the CDI Service for these entities.
The Managed CDI Namespace provides the following methods that perform the indicated provisioning tasks:
- EnableOrganization - Enables a customer organization for the
CDI Service.
- DisableOrganization - Disables a customer organization for the
CDI Service. CDI settings are also removed from all users in the
organization.
- GetOrganizationSettings - Retrieves the CDI settings for a
specified organization.
- ModifyOrganization - Modifies the CDI settings for a customer
organization.
- EnableUser - Enables a customer user for the CDI
Service.
- DisableUser - Disables a customer user for the CDI
Service.
- GetUserSettings - Gets the current CDI settings for a specified
customer user.
- ModifyUser - Modifies the CDI settings for a customer
user.
For more details on method calls, required parameters, and sample XML requests, see .
Hosted CDI Namespace
The Hosted CDI Namespace sets up a customer organization and users for the password synchronization and unification features of the Customer Directory Integration (CDI) Service, which is implemented through Microsoft Identity Integration Server (MIIS). This namespace also enables you to manage CDI settings for customer users and organizations and to disable the CDI Service for these entities.
The namespace also creates a CDI Service Plan type in the Customer Plans database (HeCustomerPlansDb) when the namespace is initialized during installation with the MPS Deployment Tool. This makes the CDI Service Plan type available in the environment. In addition, this namespace provides some additional checking of the security context in which its procedures are run.
The Hosted CDI Namespace provides the following methods that perform the indicated provisioning tasks:
- Initialize - Creates new Customer Plan Database types to
support CDI plans, events, and assets.
- EnableOrganization - Enables a customer organization for the
CDI Service.
- DisableOrganization - Disables a customer organization for the
CDI Service. CDI settings are also removed from all users in the
organization.
- GetOrganizationSettings - Retrieves the CDI settings for a
specified organization.
- ModifyOrganization - Modifies the CDI settings for a customer
organization.
- EnableUser - Enables a customer user for the CDI
Service.
- DisableUser - Disables a customer user for the CDI
Service.
- GetUserSettings - Gets the current CDI settings for a specified
customer user.
- ModifyUser - Modifies the CDI settings for a customer
user.
For more details on method calls, required parameters, and sample XML requests, see .
Hosted Live Communications Namespace
The Hosted Live Communications Namespace provides a set of public named procedures for the provisioning of Live Communications Server services. This namespace interacts with the Managed Active Directory Namespace, the Managed Helpers Namespace, and the Managed Live Communications Namespace to enable you to provision Live Communications Server services.
The Hosted Live Communications Namespace provides the following methods that perform the indicated provisioning tasks:
- EnableUser - Enables a user object for Live Communications
Server services.
- DisableUser - Disables a user object for Live Communications
Server services.
- ChangeUserPlan - Changes a user plan for Live Communications
Server services.
- GetUserProperties - Returns the Live Communications Server
properties for a specified user.
- EnableOrganizationUsers - Enables all user objects in an
organization for Live Communications Server services.
- DisableOrganizationUsers - Disables all user objects in an
organization for Live Communications Server services.
- InitializeHostedLiveCommunications - Initializes hosted Live
Communications Server. You should run this procedure once after
installing the namespace with the MPS Deployment Tool to create an
Live Communications Server plan type in the Customer Plans
database.
For more details on method calls, required parameters, and sample XML requests, see .
Managed Live Communications Namespace
The Managed Live Communications Namespace provides a set of public named procedures for the provisioning of Live Communication Server services. This namespace interacts with the Managed Active Directory Namespace, the Managed Helpers Namespace, and the Managed Live Communications Namespace to enable you to provision Live Communications Server services.
The Managed Live Communications Namespace provides the following methods that perform the indicated provisioning tasks:
- EnableUser - Enables a user object for Live Communications
Server services.
- DisableUser - Disables a user object for Live Communications
Server services.
- ModifyUser - Modifies the user's Live Communications Server
properties.
- GetUserProperties - Returns the Live Communications Server
properties for a specified user.
- EnableOrganizationUsers - Enables all user objects in an
organization for Live Communications Server services.
- DisableOrganizationUsers - Disables all user objects in an
organization for Live Communications Server services.
- ModifyOrganizationUsers - Modifies all user objects in an
organization for Live Communications Server services.
For more details on method calls, required parameters, and sample XML requests, see .
Live Communications Resource Manager Namespace
The Live Communications Resource Manager Namespace is used by the Managed Live Communications Namespace to allocate and deallocate users from a home server pool. This namespace also facilitates management of a pool of Live Communications Server home server pool resources which includes adding, modifying, removing, and querying capabilities.
The Live Communications Resource Manager Namespace provides the following methods that perform the indicated provisioning tasks:
- AddResources - Adds Live Communications Server home server
pools to the resource manager.
- RemoveResources - Removes resources from the Live
Communications Server home server resource pool.
- ModifyResources - Modifies the capacity or provisionable status
of the specified resources.
- QueryAllServerPools - Returns a listing of all Live
Communications Server home server pools in the resource pool with
capacity data.
- QueryServerPoolByUser - Returns the Live Communications Server
home server to which a specified user is allocated.
- InitializeRM - Initializes Live Communications Server Resource
Manager resource and consumer types.
For more details on method calls, required parameters, and sample XML requests, see .
MPS Import Namespace
The MPS Import Namespace exposes a set of public named procedures for importing users and organizations into an existing MPS hosting Active Directory structure.
The current state of provisioning Hosted Exchange users relies on the Hosted Exchange Namespace and several underlying namespaces and providers. It is assumed that users are created through this namespace to ensure synchronization with the various system entities that track users and organizations, such as Active Directory, MPS Resource Manager, and the MPS Customer Plans database.
However, there are certain scenarios where the dependency on these systems causes problems in real-world deployments, as follows:
- A user or an organization was created by MPS code, but not by
Hosted Exchange code, for example with previous versions of the
Exchange solution, Web hosting solution, or data hosting
solution.
- Users and organizations already exist prior to the deployment
of Hosted Exchange and these entities need to be "migrated" into
the Hosted Exchange system.
There are currently no standard migration tool sets provided to customers for migrating users in a prescribed fashion, since the requirements for migration vary considerably from service provider to service provider. The purpose of the MPS Import Namespace is to provide a set of APIs that will enable migration of users and organizations into the MPS system. Moreover, the MPS Import Namespace solves a small, well-defined chunk of the migration problem by requiring that organizations and users (and their mailboxes) already be physically migrated into an MPS hosting Active Directory structure using tools such as the Active Directory Migration Tool and the Exchange Mailbox Migration Wizard. Then, the procedures of the MPS Import Namespace can solve the problem of configuring these objects for hosting, importing these objects into the Resource Manager, and importing these objects into the Plans database.
The MPS Import Namespace provides the following methods that perform the indicated provisioning tasks:
- ImportOrganization - Imports a customer or reseller
organization into the Hosted Exchange system.
- ImportUser - Imports a consumer or business user into MPS
system.
- EnableOrganizationForHosting - Ensures that a specified
organization contains all the necessary child objects, security
groups, and security settings to be recognized as a hosted
organization by the MPS system.
- EnableUserForHosting - Ensures that the user is secured and
configured for hosting.
- EnableCustomerForPlans - Adds an organization or user to the
Customer Plans database.
- AllocateExistingMailbox - Allocates an existing mailbox to the
Exchange Resource Manager based on its current mail store and quota
settings.
- CreateMailbox - Creates a mailbox and applies plan
settings.
- ApplyMailboxPlan - Applies a valid Exchange Mailbox plan to an
existing mailbox.
For more details on method calls, required parameters, and sample XML requests, see .
Managed Windows-based Hosting Namespace
A high-level namespace that provides a set of MPF Named Procedures for provisioning customer service plans, Active Directory, Web sites, databases, Windows SharePoint Services, and DNS services. Enhances underlying managed namespaces by integrating them with service plan and resource management logic.
The Windows-based Hosting Namespace provides the following methods for the provisioning of Customer Service Plans, Active Directory, DNS, SQL database, Web site, and Windows SharePoint Services.
General
- CreateResellerOrganization - Creates a reseller
organization.
- CreateCustomerOrganization - Creates a customer
organization.
- CreateUser - Creates a user.
- DeleteOrganization - Deletes an organization.
- DeleteUser - Deletes a user.
- AddPlansToCustomer - Adds valid service plans to a
customer.
- RemovePlansFromCustomer - Removes service plans from a
customer.
- QueryPlans - Returns a list of plans.
- QueryCustomerPlans - Returns a list of plans for a specified
customer.
- QueryServicesByCustomer - Queries all service plan, resource,
and provisioned service details for a customer.
Web Hosting
- CreateCustomerWebSite - Creates a customer Web site.
- DeleteCustomerWebSite -Deletes a customer Web site.
- ModifyCustomerWebSite - Modifies a customer Web site.
- ControlCustomerWebSite - Starts, stops, or pauses a customer
Web site.
Windows SharePoint Services Hosting
- CreateCustomerSharePointSite - Creates a SharePoint site
collection for a customer.
- DeleteCustomerSharePointSite - Deletes a SharePoint site
collection for a customer.
- AddUserToSharePointSite - Adds a user to a SharePoint
site.
- RemoveUserFromSharePointSite - Deletes a user from a SharePoint
site.
Data Hosting
- CreateCustomerDatabase - Creates a customer database.
- DeleteCustomerDatabase - Deletes a customer database.
- ModifyCustomerDatabaseFile - Modifies a customer
database.
DNS
- CreateDNSZone - Creates a zone on a specified DNS
server.
- DeleteDNSZone - Deletes a zone on a specified DNS
server.
- CreateResourceRecord - Creates a resource record for a
specified zone on a specified DNS server.
- DeleteResourceRecord - Deletes a resource record for a
specified zone on a specified DNS server.
For details on method calls, required parameters, and sample XML requests, see .
Managed Windows SharePoint Namespace
Provides a set of MPF Named Procedures for provisioning SharePoint sites and accounts for customers in both shared hosting solution scenarios. Enhances the low-level Windows SharePoint Provider by integrating Active Directory and SharePoint site collection services for the provisioning of SharePoint sites.
The Managed Windows SharePoint Namespace provides the following methods that perform the indicated provisioning tasks:
- CreateSiteCollection - Creates a site collection for a customer
organization and adds an administrator account to the
collection.
- DeleteSiteCollection - Deletes a specified site collection.
Note: By default, only Domain Administrators can create or delete a site collection. To enable other groups to perform these tasks, you must add the group either to the local Administrators group of the Windows SharePoint Services front-end server or to the SharePoint Administrators Role on the virtual server. See SharePoint Team Services Administrator's Guide for further information. - AddUsersToRole - Adds one or more Active Directory accounts as
users to a site group.
- RemoveUsersFromRole - Removes the users with specified user
names from a site group.
- GetCustomerSite - Retrieves metadata for a specified SharePoint
site.
- QuerySitesByCustomer - Queries all sites for an
organization.
For details on method calls, required parameters, and sample XML requests, see .
Managed Data Hosting Namespace
Provides a set of MPF Named Procedures for provisioning hosted databases for customers in shared hosting solution scenarios, which includes business logic for creating databases and directories and for configuring permissions. Enhances the low-level SQL Admin Provider by integrating SQL database, file system, and Active Directory aspects of database provisioning.
The Managed Data Hosting Namespace provides the following methods that perform the indicated provisioning tasks:
- CreateCustomerDatabase - Creates a database on a computer
running SQL Server for a specified customer, adds a login for the
database administrator, and creates and secures the files structure
on a share for data files.
- DeleteCustomerDatabase - Deletes a database on a computer
running SQL Server for a specified customer, including the data
file structure.
- ModifyCustomerDatabaseFile - Modifies the size of an existing
database.
- BackupCustomerDbToDisk - Performs a full backup of a specified
database to disk.
- RestoreCustomerDbToDisk - Performs a full restore of a
specified database from disk.
- QueryDatabaseByCustomer - Retrieves a listing of databases for
a customer organizational unit.
For details on method calls, required parameters, and sample XML requests, see .
Data Hosting Resource Manager Namespace
Provides a set of public procedures that enable the definition and management of SQL Server resources based on maximum number of databases and maximum number of megabytes allocation. Functionality incorporated into this namespace includes the following:
- Adding and removing computers running SQL Server.
- Classification of shared computers running SQL Server, such as
premium class (two CPUs) or standard class (one CPU).
- Allocation of databases to servers and leveling of these
databases across available systems.
This namespace provides the following methods that perform the indicated provisioning tasks:
- AddServers - Adds computers running SQL Server to the Resource
Manager SQL Server resource pool and includes definitions of
capacity and server class.
- RemoveServers - Removes computers running SQL Server from the
Resource Manager SQL Server resource pool.
- ModifyServers - Modifies capacity, classification, or
provisioning-enabled status of computers running SQL Server in the
Resource Manager SQL Server resource pool.
- CreateServerClasses - Creates a server class resource group
that allows for grouping server resources by capability. For
example, you could have a premium server class that contains only
dual-processor servers with drive arrays.
- DeleteServerClasses - Deletes a server class from the Resource
Manager. All computers running SQL Server must first be removed
from the server class group before this procedure can
succeed.
- AllocateOrganization - Allocates an organization's maximum
allowed databases (reserve) and storage space (MB).
- ModifyOrganizationAllocation - Modifies the current allocation
of an organization.
- DeallocateOrganization - Deallocates an organization's reserve
database and storage space. All organization databases must first
be deallocated before this procedure can succeed.
- AllocateDatabase - Allocates a database from the Resource
Manager SQL Server resource pool.
- ModifyDatabaseAllocation - Modifies a databases allocation size
or changes a database name.
- DeallocateDatabase - Deallocates a database from the resource
pool.
- QueryAllServers - Queries all computers running SQL Server in
the resource pool and returns capacity data for each.
- QueryDatabaseByOrganization - Queries all databases allocated
to an organization in the resource pool and returns a listing of
all the databases.
- QueryOrganizationResources - Queries the resources assigned to
a specified organization and returns capacity data for that
organization.
- GetDatabaseAllocation - Returns the allocation for a given
database.
- InitializeSQLRM - Initializes SQL Resource Management,
including all resource, consumer, and group types.
- UninitializeSQLRM - Uninitializes SQL Resource Management,
including all resource, consumer, and group types. This procedure
will fail if there are any existing resource types, consumer types,
or mappings.
- RemoveAllSQLRMData - Removes all SQL Resource Management data
from the MPS Resource Manager. Use when you need to clear SQL
Resource Management from the system.
For details on method calls and required parameters, see .
Managed Web Hosting Namespace
Provides a set of named procedures for provisioning Web sites for customers in both shared and dedicated hosting solution scenarios, which includes business logic for creating Web sites, directories, FTP virtual directories, and applying permissions. Enhances the low-level IIS Provider by integrating several aspects of the provisioning of hosted Web sites to include:
- File directories for Web content and log files.
- FTP virtual directory for content management and access to log
files.
- FrontPage extensions.
- Anonymous user creation.
- Application pool creation (IIS 6.0).
- File and directory permissions.
The Managed Web Hosting Namespace provides the following methods that perform the indicated provisioning tasks:
- CreateCustomerWebSite - Creates and secures a Web site with
associated file directories and FTP virtual directory, for use in
shared and dedicated services.
- DeleteCustomerWebSite - Deletes a specified customer Web site
and associated directories. Optionally removes FTP virtual
directory and archives content.
- ModifyCustomerWebSite - Enables the modification of a limited
set of Web site properties.
- ControlCustomerWebSite - Enables you to start, stop, or pause a
specified Web site.
- CreateAppPool - Creates an application pool.
- DeleteAppPool - Deletes an application pool.
- GetCustomerWebSiteProperties - Retrieves a customer's Web site
properties.
- QueryWebSitesByCustomer - Enumerates a customer's Web sites in
Active Directory.
For more details on method calls, required parameters, and sample XML requests, see .
Web Hosting Resource Manager Namespace
Provides a set of public procedures that enable the definition and management of IIS server resources, based on maximum number of Web sites and maximum number of megabytes allocation. Functionality incorporated into this namespace includes the following:
- Adding and removing IIS servers.
- Classification of shared IIS servers, such as premium class
(two CPUs) or standard class (one CPU).
- Allocation of Web sites to servers and leveling of these Web
sites across available systems.
This namespace provides the following methods that perform the indicated provisioning tasks:
- AddServers - Adds IIS servers to the Resource Manager IIS
server resource pool and includes definitions of capacity and
server class.
- RemoveServers - Removes IIS servers from the Resource Manager
IIS server resource pool.
- ModifyServers - Modifies capacity, classification, or
provisioning-enabled status of IIS servers in the Resource Manager
IIS Server resource pool.
- CreateServerClasses - Creates a server class resource group
that allows for grouping server resources by capability. For
example, you could have a premium server class that contains only
dual-processor servers.
- DeleteServerClasses - Deletes a server class from the Resource
Manager. You must first remove all IIS servers from the server
class group before this procedure can succeed.
- AllocateOrganization - Allocates an organization's maximum
allowed Web sites (reserve) and storage space (MB).
- ModifyOrganizationAllocation - Modifies the current allocation
of an organization.
- DeallocateOrganization - Deallocates an organization's reserve
Web sites and storage space. You must first deallocate all
organization Web sites before this procedure can succeed.
- AllocateWebsite - Allocates a Web site from the Resource
Manager SQL Server resource pool.
- ModifyWebSiteAllocation - Modifies a Web site allocation size
or changes a Web site name.
- DeallocateWebSite - Deallocates a Web site from the resource
pool.
- QueryAllServers - Queries all IIS servers in the resource pool
and returns capacity data for each.
- QueryWebSiteByServer - Returns a listing of all Web sites
allocated to a particular server in the resource pool.
- QueryWebSiteByOrganization - Queries all Web sites allocated to
an organization in the resource pool and returns a listing of all
the Web sites.
- QueryOrganizationResources - Queries the resources assigned to
a specified organization and returns capacity data for that
organization.
- QueryServerClasses - Returns a listing of all server
classes.
- GetWebSiteAllocation - Returns the allocation for a given Web
site.
- InitializeIISRM - Initializes IIS Resource Management,
including all resource, consumer, and group types.
- UninitializeIISRM - Uninitializes IIS Resource Management,
including all resource, consumer, and group types. This procedure
will fail if there are any existing resource types, consumer types,
or mappings.
- RemoveAllIISRMData - Removes all IIS Resource Management data
from the MPS Resource Manager. Use when you need to clear IIS
Resource Management from the system.
For details on method calls and required parameters, see .
Managed Active Directory Namespace
Builds upon the Active Directory Provider namespace and the Preferred Domain Controller Active Directory namespaces. The Managed Active Directory namespace implements aggregate business logic for Active Directory by performing tasks such as the following:
- Creating, renaming, modifying, and deleting
organizations.
- Creating, renaming, enabling, disabling, modifying, and
deleting users.
- Changing and setting user passwords.
- Creating, renaming, modifying, adding, and deleting
groups.
- Removing members from a group.
- Creating, renaming, modifying, and deleting contacts.
- Moving Active Directory objects from one location to
another.
- Returning the owning organization of an object.
- Returning a reseller's hosting organization or a customer's
reseller.
- Returning the Users container for the current RootDSE.
- Manipulating Windows 2003 Server group capacity.
- Redistributing group membership for the next group
pending.
Managed Hosting Namespace
Provides procedures for initializing Active Directory for hosting, querying roles and organizations, and performing initial management tasks. The procedures in the Managed Hosting namespace have been specifically created for use in the hosting structure implemented by MPS.
Specific tasks that are performed by the Managed Hosting Namespace include the following:
- Initializing Active Directory for the hosting environment.
Note: The functionality that performs this task is now included in the MPS Deployment Tool. - Returning a list of the UI roles that a caller may
perform.
- Returning the type (hosting, reseller, customer, or private) of
a supplied organization.
Managed IIS Namespace
Builds upon the IIS Provider namespace and the FrontPage Provider namespace. The Managed IIS Namespace procedures implement collected functions for IIS version 5.0, which includes support for FrontPage 2002 Server Extensions from Microsoft. FrontPage extensions enable a client to update Web content on an IIS server using FrontPage client software.
Tasks that are performed by the Managed IIS Namespace include the following:
- Creating, modifying, and deleting Web sites.
- Creating FTP sites.
- Deleting all the Web or FTP sites owned by an
organization.
- Creating and deleting virtual directories in a Web
site.
- Enumerating properties available in a provided IIS metabase
Config path.
- Returning the requested properties of a Web or FTP
site.
- Starting or stopping a specified Web or FTP site.
- Installing and removing the server extensions root.
- Setting the Execute As security identity for procedures in the
FrontPage Provider namespace.
For more information, see to review the functions of additional namespaces included with MPS.