The Service Management API provides programmatic access to much of the functionality available through the Administrator Portal and the Tenant Portal. The service management endpoint translates various calls from Administrator Portal and Tenant Portal clients to be transferred to varied resource providers.
The Service Management API is a REST API. All API operations are performed over SSL and mutually authenticated. The service may be accessed from any application that can send an HTTPS request and receive an HTTPS response.
Resource Providers
All resources are backed by a resource provider. Such a provider implements the RESTful contracts responsible for creating resources of a particular type – for example, virtual machines, SQL Server instances, or web sites.
Each resource provider is assigned a unique namespace within the management URI. Resource provider namespaces must be alphanumeric and special characters are not allowed. We suggest using concise names, and once assigned, the namespace cannot be changed. The namespace ID forms part of the URI for every call that you make to the Service Management API.
Once you have a resource provider, you can create Offers and Subscriptions.
Addressing Service Management Resources via the Service Management Endpoint
To take advantage of the service management API, you must communicate via a common exposed proxy URI – a central routing URL for all resource provider calls. The service management API branches out incoming calls – from the tenant portal or the administrator portal – to the appropriate resource provider, in the format that the resource provider expects.
Service Management Endpoint
Imagine that the base URI for the management service’s administrator root is:
 Copy Code |
|
|---|---|
https://management-admin.constoso.net |
|
Note that all operations in the Service Management API are made over SSL and so must use the HTTPS protocol.
Every subscription-level call to the Service Management API includes the subscription ID for the subscription. The subscription ID is appended to the base URI, as follows:
| Copy Code |
|
|---|---|
https://management-admin.contoso.net/<subscriptionId>/services/<resourceProviderID> |
|
| Copy Code |
|
|---|---|
https://management-admin.contoso.net/4e535204-bacf-4ab0-a879-f9d346ea6bd5/services/Z0Q5YB0D |
|