This topic has not yet been rated - Rate this topic

Service Management Versioning

Updated: January 19, 2012

Operations provided by the Service Management API may have multiple versions. You must specify which version of an operation you want to use by setting the x-ms-version request header. Requests without an x-ms-version header will be rejected and return a (400) Bad Request response. If your service calls an older version of an operation, you can choose to continue calling the older version, or modify your code to call a newer version. Any differences in functionality between versions are outlined in the documentation for the API call.

The x-ms-version request header value must be specified in the format YYYY-MM-DD. For example:

Request Headers:
x-ms-version: 2011-02-25

The following table shows which versions of the Service Management API that are currently available:

 

Version Description

2011-10-01

The 2011-10-01 version adds the following operations:

  • Rollback Update Or Upgrade - Cancels an in progress upgrade or configuration change to a deployment and returns the deployment to its state before the upgrade or configuration change was started.

  • Get Subscription - Returns account and resource allocation information on the specified subscription.

The 2011-10-01 version adds the following Widows Azure Traffic Manager (WATM) operations:

  • Create Profile - Creates a new WATM profile for a domain name, owned by the specified subscription.

  • Create Definition - Creates a new definition for a given WATM profile.

  • Update Profile - Enables or disables a WATM profile.

  • List Profiles - Returns all WATM profiles owned by a subscription.

  • Get Profile - Returns the WATM profile details, including all definition versions and their statuses.

  • List Definitions - Returns all definitions of a WATM profile.

  • Get Definition - Returns a WATM profile definition

  • Delete Profile - Deletes a WATM profile and all of its definitions.

The 2011-10-01 version updates the following operations.

Get Hosted Service Properties adds the following properties:

  • Locked: Allows you to determine whether new write operations on the deployment are allowed at this time.

  • RollbackAllowed: Allows you to determine whether the Rollback Update Or Upgrade operation is allowed at this time.

Get Deployment adds the following properties:

  • InstanceStatus: Has been updated to return more complete status results.

  • Locked: Allows you to determine whether new write operations on the deployment are allowed at this time.

  • RollbackAllowed: Indicates whether a Rollback Update Or Upgrade operation is allowed at this time.

2011-08-01

The 2011-08-01 version updates the following operation:

2011-06-01

The 2011-06-01 version adds the following operations:

Get Deployment adds the following properties:

  • InstanceUpgradeDomain: The upgrade domain that a specified role instance belongs to.

  • InstanceFaultDomain: The fault domain that a specified role instance belongs to.

  • InstanceSize: The size of a specified role instance.

  • SdkVersion: The version of the Windows Azure SDK that was used to generate the .cspkg.

  • InputEndpointList: A list of input endpoints exposed by the deployment.

  • RoleName: The name of the role that exposes an input endpoint in the list.

  • Vip: The virtual IP address that the input endpoint is exposed on.

  • Port: The port the input endpoint is exposed on.

List Subscription Operations adds the following properties:

  • OperationStartedTime: The time that the operation started to execute.

  • OperationCompletedTime: The time that the operation finished executing.

Get Storage Account Properties adds the following properties:

  • Status: The status of the storage account at the time the operation was called.

  • Endpoints: The URLs that are used to perform a retrieval of a public blob, queue, or table object.

Get Hosted Service Properties adds the following properties:

  • SdkVersion: The version of the Windows Azure SDK that was used to generate the .cspkg.

  • InputEndpointList:

  • RoleName: The name of the role that exposes an input endpoint in the list.

  • Vip: The virtual IP address that the input endpoint is exposed on.

  • Port: The port the input endpoint is exposed on.

2011-02-25

The 2011-02-25 version added the following operations:

2010-10-28

The 2010-10-28 version updated the following operations:

  • List Operating Systems: The response body now indicates the operating system family for each guest operating system.

The 2010-10-28 version added the following operations:

2010-04-01

The 2010-04-01 version updated the following operations:

The 2010-04-01 version added the following operations:

  • List Operating Systems: Lists the versions of the guest operating system that are currently available in Windows Azure.

2009-10-01

The 2009-10-01 version was the first version of the Service Management API. It included the following operations:

See Also

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ