SalesBuy
1-855-856-7678
Technical SupportSupport
Addressing Service Management Resources
Updated: November 22, 2010
The Service Management API exposes the following resources for managing your services and deployments:
-
Subscription. A subscription is an account on the Management Portal.
-
Storage Account. An account for accessing the Windows Azure storage services, unique to this subscription. A subscription may have zero or more storage accounts.
-
Hosted Service. A container for service deployments in Windows Azure. A subscription may have zero or more hosted services.
-
Deployment. A service that is running on Windows Azure. A deployment may be running in either the staging or production deployment environment. It may be managed either by referencing its deployment ID, or by referencing the deployment environment in which it's running.
-
Deployment Environment. A named environment to which a deployment can be made. The available deployment environments are staging and production.
-
Certificate. A certificate within the Windows Azure certificate store for a subscription.
-
Location. A geographical region in which a service or storage account will be hosted.
-
Affinity Group. A grouping of services and storage accounts within a subscription according to geo-location, for performance benefits.
-
Operation. A request submitted to the Service Management API. For operations that are asynchronous, this resource can be used to track operation status.
-
Operating Systems. The set of guest operating system versions currently supported in Windows Azure.
-
Subscription. A user account subscription with Windows Azure.
-
Traffic Manager Profile. A profile associated with network traffic management definitions and policies.
-
Virtual Network Gateway. A gateway that you can use to connect local sites to a virtual network.
Service Management Endpoint
The base URI for the management service is:
https://management.core.windows.net
Note that all operations in the Service Management API are made over SSL and so must use the HTTPS protocol.
Every call to the Service Management API must include the subscription ID for your subscription. The subscription ID is appended to the base URI, as follows:
https://management.core.windows.net/<subscriptionId>
 Note |
|---|
| The Service Management API does not include any operations that act on the subscription resource directly. |
Storage Account Resource
The URI for the collection of storage accounts beneath a subscription is:
https://management.core.windows.net/<subscriptionId>/services/storageservices
The URI for a specific storage account is:
https://management.core.windows.net/<subscriptionId>/services/storageservices/<storageservice>
The API operations shown in the following table are performed against a storage account or the collection of storage accounts:
| Operation | Description |
|---|---|
|
Lists the storage accounts available under the current subscription. |
|
|
Returns the system properties for the specified storage account. |
|
|
Returns the primary and secondary access keys for the specified storage account. |
|
|
Regenerates the primary or secondary access key for the specified storage account. |
Hosted Service Resource
The URI for the collection of hosted services beneath a subscription is:
https://management.core.windows.net/<subscriptionId>/services/hostedservices
The URI for a specific hosted service is:
https://management.core.windows.net/<subscriptionId>/services/hostedservices/<serviceName>
The API operations shown in the following table are performed against a hosted service or the collection of hosted services:
| Operation | Description |
|---|---|
|
Lists the hosted services available under the current subscription. |
|
|
Creates a new hosted service within the subscription. |
|
|
Updates the label and/or description for a hosted service. |
|
|
Deletes a hosted service from this subscription. |
|
|
Returns system properties for the specified hosted service. |
|
|
Initiates a virtual IP swap between the staging and production deployment environments for a service. |
Deployment Resource
The URI for a specific deployment is:
https://management.core.windows.net/<subscriptionId>/services/hostedservices/<serviceName>/deployments/<deploymentname>
The API operations shown in the following table may be performed against a deployment resource:
| Operation | Description |
|---|---|
|
Returns configuration information, status, and system properties for the specified deployment. |
|
|
Deletes the specified deployment |
|
|
Initiates a change to the deployment configuration. |
|
|
Initiates a change in deployment status. |
|
|
Initiates an upgrade. |
|
|
Specifies the next upgrade domain to be walked |
|
|
Requests a reboot of a role instance that is running in a deployment. |
|
|
Requests a reimage of a role instance that is running in a deployment. |
Deployment Environment Resources
The URI for the staging deployment environment is:
https://management.core.windows.net/<subscriptionId>/services/hostedservices/<serviceName>/deploymentslots/staging
The URI for the production deployment environment is:
https://management.core.windows.net/<subscriptionId>/services/hostedservices/<serviceName>/deploymentslots/production
The API operations shown in the following table may be performed against a deployment environment resource:
| Operation | Description |
|---|---|
|
Uploads a new service package to staging or to production. |
|
|
Returns configuration information, status, and system properties for the specified deployment. |
|
|
Deletes the specified deployment |
|
|
Initiates a change to the deployment configuration. |
|
|
Initiates a change in deployment status. |
|
|
Initiates an upgrade. |
|
|
Specifies the next upgrade domain to be walked. |
|
|
Requests a reboot of a role instance that is running in a deployment. |
|
|
Requests a reimage of a role instance that is running in a deployment. |
Certificate Resource
The URI for the collection of certificates associated with a subscription is:
https://management.core.windows.net/<subscription-id>/services/hostedservices/<service-name>/certificates
The URI for a specific certificate is:
https://management.core.windows.net/<subscription-id>/services/hostedservices/<service-name>/certificates/<thumbprint-algorithm>-<thumbprint-in-hex>
The API operations shown in the following table are performed against a certificate or the collection of certificates:
| Operation | Description |
|---|---|
|
Lists the certificates associated with the specified subscription. |
|
|
Returns the public data for the specified certificate. |
|
|
Adds a certificate to the subscription. |
|
|
Deletes a certificate from the subscription. |
Affinity Group Resource
The URI for the collection of affinity groups associated with a subscription is:
https://management.core.windows.net/<subscriptionId>/affinitygroups
The URI for a specific affinity group is:
https://management.core.windows.net/<subscriptionId>/affinitygroups/<affinitygroupname>
The API operations shown in the following table are performed against an affinity group or the collection of affinity groups:
| Operation | Description |
|---|---|
|
Lists the affinity groups associated with the specified subscription. |
|
|
Returns the system properties associated with the specified affinity group. |
Location Resource
The URI for the collection of data center locations associated with a subscription is:
https://management.core.windows.net/<subscriptionId>/locations
The API operations shown in the following table are performed against the collection of locations:
| Operation | Description |
|---|---|
|
Lists the data center locations associated with the specified subscription. |
Operation Resource
The URI for referencing a request that has been made against the management service is:
https://management.core.windows.net/<subscriptionId>/operations/<operationId>
The API operation shown in the following table is performed against an operation resource:
| Operation | Description |
|---|---|
|
Returns the status of the specified operation. Use to determine whether an asynchronous operation has succeeded, failed, or is still in progress. |
Operating Systems Resources
The URI for listing the set of guest operating system versions available in Windows Azure is:
https://management.core.windows.net/<subscriptionId>/operatingsystems
The URI for listing the set of operating system families available in Windows Azure is:
https://management.core.windows.net/<subscriptionId>/operatingsystemfamilies
The related API operations are shown in the following table:
| Operation | Description |
|---|---|
|
Returns the set of guest operating system versions currently supported in Windows Azure. |
|
|
Returns the set of operating system families supported in Windows Azure, and the available operating system versions for each family. |
Subscription Resource
The URI for getting account and resource information on a specified subscription is:
https://management.core.windows.net/<subscriptionId>
| Operation | Description |
|---|---|
|
Returns a list of create, update, and delete operations that were performed on a subscription during the specified timeframe. |
|
|
Returns account and resource allocation information on the specified subscription. |
Traffic Manager Profile Resource
The URI for listing the set of traffic manager profiles owned by a subscription:
https://management.core.windows.net/<subscriptionId>/services/WATM/profiles
The related API operations are shown in the following table:
| Operation | Description |
|---|---|
|
Creates a new profile for a domain name, owned by the specified subscription. |
|
|
Creates a new definition for a given profile. |
|
|
Enables or disables a profile. |
|
|
Returns all profiles owned by a subscription. |
|
|
Returns profile details, including all definition versions and their statuses. |
|
|
Returns all definitions of a profile. |
|
|
Returns an existing profile definition. |
|
|
Deletes a profile and all of its definitions. |
Virtual Network Gateway Resource
The URI for the virtual network gateway associated with a particular subscription ID and virtual network is:
https://management.core.windows.net/<subscriptionId>/services/networking/<virtual-network-name>/gateway
The related API operations are shown in the following table:
| Operation | Description |
|---|---|
|
Gets information about the virtual network gateway’s state and properties, such as its IP address and provisioning status. |
|
|
Creates a virtual network gateway for a specified virtual network. |
|
|
Deletes the specified virtual network gateway. |
|
|
Forces a gateway failover, deactivating the primary virtual network gateway and switching over to a secondary. |
|
|
Returns the shared key used to authenticate connections with individual sites on a virtual network. |
|
|
Generates a new shared key with a specified character length. |
|
|
Lists the supported, on-premise network devices that can connect to the gateway. |
|
|
Returns a script that you can use to configure local VPN devices to connect to the gateway |
|
|
Lists all of the local network connections that can be accessed through the gateway. |
|
|
Connect to, Disconnect from, or Test your Connection to a Local Network |
Connects the gateway to the specified local network site. |
|
Disconnects the gateway from the specified local network site. |
|
|
Tests the gateway’s connection to the specified local network site. |
|
|
Returns the current status of the specified gateway operation. |
See Also
