1 out of 1 rated this helpful - Rate this topic

Service Management Versioning

Updated: November 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

Supported Versions

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

 

Version Description

2013-03-01

The 2013-03-01 version adds the following operation:

  • List Available Extensions - lists the extensions that are available to add to your cloud service.

  • Add Extension - adds an available extension to your cloud service.

  • Delete Extension - deletes the specified extension from a cloud service.

  • List Extensions - lists all of the extensions that were added to a cloud service.

  • Get Extension - retrieves information about a specified extension that was added to a cloud service.

2012-08-01

The 2012-08-01 version updates the following operations:

  • Add OS Image – Added new elements to the request body to provide metadata for the image being added.

  • Delete OS Image – Added a new parameter to enable the deletion of the source blob for the image. A Request Body is no longer needed.

  • Update OS Image – Added new elements to the request body to update metadata for the image being added.

  • List OS Images – Added new elements to the response body that list the metadata of the image.

  • Delete Disk – Added an optional parameter to delete the associated blob from storage when the disk is deleted.

2012-03-01

The 2012-03-01 version adds the following Virtual Network Gateway operations:

The 2012-03-01 version adds the following Virtual Network operations:

The 2012-03-01 version adds the following Management Certificate operations:

The 2012-03-01 version adds the following hosted service operation:

  • Get Package - Retrieves packages, such as cspkg and cscfg files, for deployments and saves them in the specified container.

The 2012-03-01 version adds the following operations for checking to see if a hosted service or storage account name is available:

The 2012-03-01 version updates the following operations:

  • Create Hosted Service – Supports elements for adding extended properties as name/value pairs. Additionally, the Anywhere US, Anywhere Europe, or Anywhere Asia regions are no longer supported for this operation.

  • Update Hosted Service– Supports elements for adding extended properties as name/value pairs. Additionally, the Anywhere US, Anywhere Europe, or Anywhere Asia regions are no longer supported for this operation.

  • List Hosted Services– Now returns addition information on the hosted service, including the status of the service, the date when it was created and last modified, and any extended properties.

  • Get Hosted Service Properties– Now returns addition information on the hosted service, including the status of the service, the date when it was created and last modified, and any extended properties. Additionally, the Anywhere US, Anywhere Europe, or Anywhere Asia regions are no longer supported for this operation.

  • Create Deployment– Supports elements for adding extended properties as name/value pairs. Additionally, the PackageUrl element may now be set to a Shared Access Signature (SAS) URI from any storage account.

  • Change Deployment Configuration– Supports elements for adding extended properties as name/value pairs.

  • Upgrade Deployment– Supports elements for adding extended properties as name/value pairs.

  • List Storage Accounts– Now returns addition information on the storage service, including the status of the service, the date when it was created and last modified, and any extended properties.

  • Get Storage Account Properties– Now returns addition information on the storage service, including the status of the service, the date when it was created and last modified, and any extended properties. Additionally, the Anywhere US, Anywhere Europe, or Anywhere Asia regions are no longer supported for this operation.

  • Create Storage Account– Supports elements for adding extended properties as name/value pairs.

  • Update Storage Account– Supports elements for adding extended properties as name/value pairs.

  • Get Deployment– Updated the InstanceStatus property to return more complete status results. Added the Locked and RollbackAllowed properties, which allow you to determine whether write operations are allowed on the deployment are allowed and whether a rollback is allowed.

  • List Locations– The Anywhere US, Anywhere Europe, or Anywhere Asia regions are no longer supported for this operation.

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 Windows 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)
© 2013 Microsoft. All rights reserved.
facebook page visit twitter rss feed newsletter