Export (0) Print
Expand All
1 out of 1 rated this helpful - Rate this topic

Service Management Versioning

Updated: April 3, 2014

Operations provided by the Service Management API may have multiple versions. You must specify the version of an operation that 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 additions and changes to the Service Management APIs:

 

Version Change Description

2014-04-01

The following operations were updated:

 

Operation Description

Get Deployment

Added the GuestAgentStatus element, which specifies information about the agent that is installed on an instance. Added the ResourceExtensionStatusList element, which specifies information about the extensions that are installed on an instance.

Create Virtual Machine Deployment

Added information to support using a JSON object for an extension parameter.

Add Role

Added information to support using a JSON object for an extension parameter.

Update Role

Added information to support using a JSON object for an extension parameter.

List Resource Extensions

Added the ReplicationCompleted element, which indicates whether the version of the extension has been replicated to all regions. Added the Eula element, which specifies a URI that points to the End User License Agreement (EULA) for the version of the extension. Added the PrivacyUri element, which specifies a URI that points to the privacy statement for the version of extension. Added the HomepageUri element, which specifies the URI that points to the homepage for the version of extension. Added the IsJsonExtension element which, indicates whether the version of the extension accepts a JSON based configuration.

List Resource Extension Versions

Added the ReplicationCompleted element, which indicates whether the version of the extension has been replicated to all regions. Added the Eula element, which specifies a URI that points to the End User License Agreement (EULA) for the version of the extension. Added the PrivacyUri element, which specifies a URI that points to the privacy statement for the version of extension. Added the HomepageUri element, which specifies the URI that points to the homepage for the version of extension. Added the IsJsonExtension element which, indicates whether the version of the extension accepts a JSON based configuration.

List Available Extensions

Added the ReplicationCompleted element, which indicates whether the version of the extension has been replicated to all regions. Added the Eula element, which specifies a URI that points to the End User License Agreement (EULA) for the version of the extension. Added the PrivacyUri element, which specifies a URI that points to the privacy statement for the version of extension. Added the HomepageUri element, which specifies the URI that points to the homepage for the version of extension. Added the IsJsonExtension element which, indicates whether the version of the extension accepts a JSON based configuration.

List Extension Versions

Added the ReplicationCompleted element, which indicates whether the version of the extension has been replicated to all regions. Added the Eula element, which specifies a URI that points to the End User License Agreement (EULA) for the version of the extension. Added the PrivacyUri element, which specifies a URI that points to the privacy statement for the version of extension. Added the HomepageUri element, which specifies the URI that points to the homepage for the version of extension. Added the IsJsonExtension element which, indicates whether the version of the extension accepts a JSON based configuration.

The following operations were added:

 

Operation Description

Register Extension

Enables you to register a new extension that can be added to cloud services in your subscription.

Update Extension

Enables you to create a new version of an extension that has been registered in your subscription.

2014-02-01

The following operations were updated:

 

Operation Description

List Cloud Services

Added the x-ms-continuation-token response header.

Create Virtual Machine Deployment

Updated the EnableDirectServerReturn element with limitation information. Added the VMImage element. Added information to support using a specialized disk. Added information to support using a JSON object for an extension parameter.

Add Role

Updated the EnableDirectServerReturn element with limitation information. Added the VMImage element. Added information to support using a specialized disk. Added information to support using a JSON object for an extension parameter.

Update Load-Balanced Endpoint Set

Updated the EnableDirectServerReturn element with limitation information.

Shutdown Role

Added information about retaining the static IP address for the StoppedDeallocated action.

Shutdown Roles

Added information about retaining the static IP address for the StoppedDeallocated action.

2014-01-01

The following operations were updated:

 

Operation Description

List Disks

Added the CreatedTime element, which specifies in UTC format when the disk was created.

List Affinity Groups

Added the CreatedTime element, which specifies in UTC format when the disk was created.

Get Affinity Group Properties

Added the CreatedTime element, which specifies in UTC format when the disk was created.

2013-11-01

The following operations were added:

 

Operation Description

List Extension Versions

Lists the versions of an extension that are available to add to a cloud service.

List Resource Extensions

Lists the resource extensions that are available to add to a Virtual Machine.

List Resource Extension Versions

Lists the versions of a resource extension that are available to add to a Virtual Machine.

Check Virtual Network IP Address Availability

Checks for the availability of an IP address in the specified Virtual Network.

The following operations were updated:

 

Operation Description

Create Storage Account

Added the SecondaryReadEnabled element, which indicates that secondary read is enabled for the storage account.

Get Storage Account Properties

Added the SecondaryReadEnabled element, which indicates that secondary read is enabled for the storage account.

List Storage Accounts

Added the SecondaryReadEnabled element, which indicates that secondary read is enabled for the storage account.

Update Storage Account

Added the SecondaryReadEnabled element, which indicates that secondary read is enabled for the storage account.

List Available Extensions

Added the SampleConfig element, which specifies a sample configuration file for the resource extension.

List Extensions

Added the SampleConfig element, which specifies a sample configuration file for the resource extension.

Get Deployment

Added the ProvisionGuestAgent element, which indicates whether the VM Agent service is installed on the Virtual Machine. Added the Added the ResourceExtensionReferences element, which contains a collection of resource extensions that are to be installed on the Virtual Machine. Added the StaticVirtualNetworkIPAddress element, which specifies the internal IP address for the Virtual Machine in a Virtual Network. Added the InternalDnsSuffix element, which specifies the domain name suffix for internal name resolution of instances in a deployment.

Add Role

Added the ProvisionGuestAgent element, which indicates whether the WindowsAzureGuestAgent service is installed on the Virtual Machine. Added the ResourceExtensionReferences element, which contains a collection of resource extensions that are to be installed on the Virtual Machine. Added the StaticVirtualNetworkIPAddress element, which specifies the internal IP address for the Virtual Machine in a Virtual Network.

Create Virtual Machine Deployment

Added the ProvisionGuestAgent element, which indicates whether the WindowsAzureGuestAgent service is installed on the Virtual Machine. Added the ResourceExtensionReferences element, which contains a collection of resource extensions that are to be installed on the Virtual Machine. Added the StaticVirtualNetworkIPAddress element, which specifies the internal IP address for the Virtual Machine in a Virtual Network.

Get Role

Added the ProvisionGuestAgent element, which indicates whether the WindowsAzureGuestAgent service is installed on the Virtual Machine. Added the ResourceExtensionReferences element, which contains a collection of resource extensions that are to be installed on the Virtual Machine. Added the StaticVirtualNetworkIPAddress element, which specifies the internal IP address for the Virtual Machine in a Virtual Network.

Update Role

Added the ProvisionGuestAgent element, which indicates whether the WindowsAzureGuestAgent service is installed on the Virtual Machine. Added the ResourceExtensionReferences element, which contains a collection of resource extensions that are to be installed on the Virtual Machine. Added the StaticVirtualNetworkIPAddress element, which specifies the internal IP address for the Virtual Machine in a Virtual Network.

2013-10-01

The following operations were added:

 

Operation Description

Create Alert Rule

Creates a new alert rule.

Delete Alert Rule

Deletes the specified alert rule.

Get Alert Rule

Retrieves information about the specified alert rule.

Get Alert Rule Incident

Retrieves information about an incident of an alert rule.

List Alert Rules

Retrieves information about all of the alert rules in a subscription.

List Alert Rule Incidents

Retrieves information about active and resolved alert rules.

Update Alert Rule

Updates the specified alert rule.

Add Autoscale Settings

Adds automatic scaling settings to deployments of Cloud Services, Virtual Machines, Web Sites, and Mobile Services.

Delete Autoscale Settings

Removes automatic scaling settings from deployments of Cloud Services, Virtual Machines, Web Sites, and Mobile Services.

Get Autoscale Settings

Retrieves automatic scaling settings from deployments of Cloud Services, Virtual Machines, Web Sites, and Mobile Services.

Update Autoscale Settings

Updates automatic scaling settings for deployments of Cloud Services, Virtual Machines, Web Sites, and Mobile Services.

The following operations were updated:

 

Operation Description

Create Virtual Machine Deployment

Added the CustomData element, which enables you to save a base-64 encoded string of data as a file on the Virtual Machine.

Add Role

Added the CustomData element, which enables you to save a base-64 encoded string of data as a file on the Virtual Machine.

Capture Role

Added the CustomData element, which enables you to save a base-64 encoded string of data as a file on the Virtual Machine.

List OS Images

Added the Public, Private, and MSDN values for the Category element.

Create Definition

Multiple definition versions per profile are not supported.

Get Definition

The version of the definition is always 1.

Get Profile

Only one definition version exists for a profile.

List Definitions

Only one definition version exists for a profile.

List Profiles

Only one definition version exists for a profile.

Update Profile

EnabledVersion element is ignored. If a profile has a definition, it is always enabled.

2013-08-01

The following operations were added:

 

Operation Description

Delete Role Instances

Deletes multiple role instances from a deployment in a cloud service.

List Subscription User Accounts

Lists the user accounts that can access resources in the subscription.

The following operations were updated:

 

Operation Description

Delete Cloud Service

Added the comp=media parameter, which delete all disks and source blobs when the cloud service is deleted.

Delete Deployment

Added the comp=media parameter, which delete all disks and source blobs when the deployment is deleted.

Delete Role

Added the comp=media parameter, which delete all disks and source blobs when the Virtual Machine is deleted.

Delete Data Disk

Added the comp=media parameter, which delete the source blob when the data disk is deleted.

2013-06-01

The following operations were added:

 

Operation Description

Shutdown Roles

Shuts down multiple Virtual Machines.

Start Roles

Starts multiple Virtual Machines.

The following operations were updated:

 

Operation Description

Get Cloud Service Properties

Added the StoppedDeallocated status to the InstanceStatus element.

Get Deployment

Added the StoppedDeallocated status to the InstanceStatus element.

Create Virtual Machine Deployment

Added the EndpointACL element and child elements, which defines access control rules for endpoints.

Add Role

Added the EndpointACL element and child elements, which defines access control rules for endpoints.

Update Role

Added the EndpointACL element and child elements, which defines access control rules for endpoints.

Shutdown Role

Added the PostShutdownAction element, which specifies how a Virtual machine should be shut down.

Get Storage Account Properties

Added the CustomDomains element, which specifies the custom domains that are associated with a storage account.

List Storage Accounts

Added the CustomDomains element, which specifies the custom domains that are associated with a storage account.

Update Storage Account

Added the CustomDomains element, which specifies the custom domains that are associated with a storage account.

2013-03-01

The following operations were added:

 

Operation Description

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.

The following operations were updated:

 

Operation Description

Update Cloud Service

Added the GuestAgentType element to the request body to specify the type of guest agent that is installed on deployments of web roles and worker roles.

Get Cloud Service Properties

Added the GuestAgentType element to the request body to specify the type of guest agent that is installed on deployments of web roles and worker roles. Added the DefaultWinRmCertificateThumbprint, which specifies the SSL certificate thumbprint that was generated when WinRM was defined with an HTTPS listener and a certificate was not included in the definition.

Create Deployment

Added the ExtensionConfiguration element, which represents an extension that is added to the cloud service.

Change Deployment Configuration

Added the ExtensionConfiguration element, which represents an extension that is added to the cloud service.

Get Deployment

Added the ExtensionConfiguration element, which represents an extension that is added to the cloud service.

Upgrade Deployment

Added the ExtensionConfiguration element, which represents an extension that is added to the cloud service.

Create Virtual Machine Deployment

Added the WinRM element, which contains configuration settings for the Windows Remote Management service on the Virtual Machine. The AdminUsername element is now required.

Add Role

Added the WinRM element, which contains configuration settings for the Windows Remote Management service on the Virtual Machine. The AdminUsername element is now required.

Capture Role

Added the WinRM element, which contains configuration settings for the Windows Remote Management service on the Virtual Machine. The AdminUsername element is now required.

Add OS Image

Added the SmallIconUri element, which specifies the URI to the small icon that is displayed when the image is presented in the Windows Azure Management Portal. Added the Language element which specifies the language of the image.

Update OS Image

Added the SmallIconUri element, which specifies the URI to the small icon that is displayed when the image is presented in the Windows Azure Management Portal. Added the Language element which specifies the language of the image.

List OS Images

Added the SmallIconUri element, which specifies the URI to the small icon that is displayed when the image is presented in the Windows Azure Management Portal. Added the Language element which specifies the language of the image.

Check Storage Account Name Availability

Added the Reason element, which provides a reason for why a storage account name cannot be used.

2012-08-01

The following operations were updated:

 

Operation Description

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 following operations were added:

 

Operation Description

Get Virtual Network Gateway

Gets information about the virtual network gateway’s state and properties, such as its IP address and provisioning status.

Create Virtual Network Gateway

Creates a virtual network gateway for a specified virtual network.

Delete Virtual Network Gateway

Deletes the specified virtual network gateway.

Cause Virtual Network Gateway Failover

Forces a gateway failover, deactivating the primary virtual network gateway and switching over to a secondary.

Get Virtual Network Gateway Shared Key

Returns the shared key used to authenticate connections with individual sites on a virtual network.

Reset Virtual Network Gateway Shared Key

Generates a new shared key with a specified character length.

List Virtual Network Gateway Supported Devices

Lists the supported, on-premise network devices that can connect to the gateway.

Get Device Configuration Script

Returns a script that you can use to configure local VPN devices to connect to the gateway.

List Connections

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, tests the connection, or disconnects your gateway from a specified local network site.

Get Virtual Network Gateway Operation Status

Returns the current status of the specified gateway operation.

Get Network Configuration

Retrieves the network configuration file.

List Virtual Network Sites

Retrieves the virtual networks configured for the subscription.

Set Network Configuration

Asynchronously configures the virtual network.

Add Management Certificate

Adds a certificate to the list of management certificates.

Get Management Certificate

Gets information about the management certificate with the specified thumbprint.

List Management Certificates

Lists and returns basic information about all of the management certificates associated with the specified subscription.

Delete Management Certificate

Deletes a certificate from the list of management certificates.

Get Package

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

Check Cloud Service Name Availability

Determines whether the specified cloud service name is available, or if it has already been taken.

Check Storage Account Name Availability

Determines whether the specified storage account name is available, or if it has already been taken.

The following operations were updated:

 

Operation Description

Create Cloud Service

Supports elements for adding extended properties as name and value pairs. Additionally, the Anywhere US, Anywhere Europe, or Anywhere Asia regions are no longer supported for this operation.

Update Cloud Service

Supports elements for adding extended properties as name and value pairs. Additionally, the Anywhere US, Anywhere Europe, or Anywhere Asia regions are no longer supported for this operation.

List Cloud Services

Now returns addition information on the cloud service, including the status of the service, the date when it was created and last modified, and any extended properties.

Get Cloud Service Properties

Now returns addition information on the cloud 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 and value pairs.

Upgrade Deployment

Supports elements for adding extended properties as name and 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.

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 and value pairs.

Update Storage Account

Supports elements for adding extended properties as name and value pairs.

2011-10-01

The following operations were added:

 

Operation Description

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.

Check DNS Prefix Availability

Checks whether the specified DNS prefix is available for creating a profile.

Create Definition

Creates a new definition for a specified profile.

Create Profile

Creates a new profile for a domain name, owned by the specified subscription.

Delete Profile

Deletes a profile and all of its definitions.

Get Definition

Returns a profile definition.

Get Profile

Returns the profile details, including all definition versions and their statuses.

List Definitions

Returns all definitions of a profile.

List Profiles

Returns all profiles owned by a subscription.

Update Profile

Enables or disables a profile.

The following operations were updated:

 

Operation Description

Get Cloud Service Properties

Added the Locked and RollbackAllowed elements.

Get Deployment

Added the InstanceStatus, Locked, and RollbackAllowed elements.

2011-08-01

The following operations were added:

 

Operation Description

Change Deployment Configuration

Adds the Mode property that specifies whether the upgrade is applied to the hosted service automatically or manually.

2011-06-01

The following operations were added:

 

Operation Description

Create Storage Account

Creates a new storage account in the specified subscription.

Delete Storage Account

Deletes a storage account in the specified subscription.

Update Storage Account

Updates the label and/or the description for a storage account in the specified subscription.

The following operations were updated:

 

Operation Description

List Subscription Operations

Added the OperationStartedTime element, which specifies the time that the operation started to execute. Added the OperationCompletedTime element, which specifies the time that the operation finished executing.

Get Storage Account Properties

Added the Status element, which specifies the status of the storage account at the time the operation was called. Added the Endpoints element, which specifies the URLs that are used to perform a retrieval of a public blob, queue, or table object.

Get Deployment

Added the following elements

  • 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.

Get Cloud Service Properties

Added the following elements:

  • 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 following operations were added:

 

Operation Description

Create Affinity Group

Creates a new affinity group for the specified subscription.

Delete Affinity Group

Deletes an affinity group for the specified subscription.

Update Affinity Group

Updates the label and/or the description for an affinity group in the specified subscription.

List Subscription Operations

Lists the create, update, and delete operations performed on a subscription during a specified timeframe.

2010-10-28

The following operations were added:

 

Operation Description

Delete Cloud Service

Deletes the specified cloud service from Windows Azure.

Update Cloud Service

Updates the label and the description for a cloud service in Windows Azure.

Create Cloud Service

Creates a new cloud service in Windows Azure.

Reboot Role Instance

Requests a reboot of a role instance that is running in a deployment.

Reimage Role Instance

Requests a reimage of a role instance that is running in a deployment.

List Locations

Lists all of the data center locations that are valid for your subscription.

The following operations were updated:

 

Operation Description

List Operating Systems

The response body now indicates the operating system family for each guest operating system.

2010-04-01

The following operations were updated:

 

Operation Description

Get Cloud Service Properties

When the embed-detail parameter is set to true, the response body now indicates the operating system version for each deployed role.

Change Deployment Configuration

Adds a new property that, if set to true, blocks the update when warnings are encountered.

The following operations were added:

 

Operation Description

List Operating Systems

Lists the versions of the guest operating system that are currently available in Windows Azure.

2009-10-01

The first version of the Service Management API. It included the following operations:

 

Operation Description

List Storage Accounts

Lists the storage accounts available under the current subscription.

Get Storage Account Properties

Returns the system properties for the specified storage account.

Get Storage Account Keys

Returns the primary and secondary access keys for the specified storage account.

Regenerate Storage Account Keys

Regenerates the primary or secondary access key for the specified storage account.

List Cloud Services

Lists the cloud services available under the current subscription.

Get Cloud Service Properties

Retrieves system properties for the specified cloud service.

Create Deployment

Uploads a new service package and creates a new deployment on staging or production.

Get Deployment

Returns configuration information, status, and system properties for the specified deployment.

Swap Deployment

Initiates a virtual IP swap between the staging and production deployment environments for a service.

Delete Deployment

Deletes the specified deployment.

Change Deployment Configuration

Initiates a change to the deployment configuration.

Update Deployment Status

Initiates a change in deployment status.

Upgrade Deployment

Initiates an upgrade.

Walk Upgrade Domain

Specifies the next upgrade domain to be walked during an in-place upgrade.

List Service Certificates

Lists all certificates associated with the specified hosted service.

Get Service Certificate

Returns the public data for the specified certificate.

Add Service Certificate

Adds a certificate to the subscription.

Delete Service Certificate

Deletes a certificate from the subscription's certificate store.

List Affinity Groups

Lists the affinity groups associated with the specified subscription.

Get Affinity Group Properties

Returns the system properties associated with the specified affinity group.

Get Operation Status

Returns the status of the specified operation.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.