Update Storage Account

 

Updated: February 24, 2016

The Update Storage Account asynchronous operation updates the label, the description, and enables or disables the geo-replication status for the specified storage account.

The Update Storage Account request may be specified as follows. Replace <subscription-id> with your subscription ID, and <service-name> with the name of your storage account.

Method

Request URI

PUT

https://management.core.windows.net/<subscription-id>/services/storageservices/<service-name>

The following table describes the request headers.

Request Header

Description

Content-Type

Required. Set this header to application/xml.

x-ms-version

Required. Specifies the version of the operation to use for this request. The value of this header must be set to 2011-06-01 or higher. The version should be at least "2012-03-01" to use the geo replication functionality.

The version should be at least "2013-06-01" to use the custom domain functionality.

The version should be at least “2013-11-01” to use SecondaryReadEnabled feature.

The version should be at least “2014-06-01” to use the AccountType field. Note that GeoReplicationEnabled and SecondaryReadEnabled are no longer supported moving forward – their functionality is included in AccountType.


<?xml version="1.0" encoding="utf-8"?>
<UpdateStorageServiceInput xmlns="http://schemas.microsoft.com/windowsazure">
  <Description>description-of-storage-account</Description>
  <Label>base64-encoded-label</Label>
  <ExtendedProperties>
    <ExtendedProperty>
      <Name>property-name</Name>
      <Value>property-value</Value>
    </ExtendedProperty>
  </ExtendedProperties>
  <CustomDomains>
    <CustomDomain>
      <Name>name-of-custom-domain</Name>
      <UseSubDomainName>cname-validation-indicator</UseSubDomainName>
    </CustomDomain>
  </CustomDomains>
  <AccountType>type-of-storage-account</AccountType>
</UpdateStorageServiceInput>

The following table describes the elements of the request body.

Element Name

Description

Label

Optional. Specifies a base-64 encoded name for the storage account. The label may be up to 100 characters in length. The label can be used identify the storage account for your tracking purposes. You must specify a value for either Label or Description, or for both.

Description

Optional. A description for the storage account. The description may be up to 1024 characters in length. You must specify a value for either Label or Description, or for both.

ExtendedProperties

Specifies the name and value of an extended property that was added to the storage account.

CustomDomains

Specifies the custom domains that are associated with the storage account.

The CustomDomains element is only available using version 2013-06-01 or higher.

AccountType

Specifies whether the account supports locally-redundant storage, geo-redundant storage, or read access geo-redundant storage. Zone-redundant storage is not an option when you update a storage account.

Possible values are:

  • Standard_LRS

  • Standard_GRS

  • Standard_RAGRS

The AccountType element is only available using version 2014-06-01 or higher and it replaces the SecondaryReadEnabled and GeoReplicationEnabled elements.

The Standard_ZRS and Premium_LRS account types are not an option because those accounts cannot be changed to any other account type. Also, all other account types cannot be changed to Standard_ZRS or Premium_LRS.

Specifies the name and value of an extended property that was added to the storage account.

Element name

Description

Name

Optional. Represents the name of an extended storage account property. Each extended property must have both a defined name and value. You can have a maximum of 50 extended property name/value pairs.

The maximum length of the Name element is 64 characters, only alphanumeric characters and underscores are valid in the Name, and the name must start with a letter. Attempting to use other characters, starting the Name with a non-letter character, or entering a name that is identical to that of another extended property owned by the same storage account, will result in a status code 400 (Bad Request) error.

The Name element is only available using version 2012-03-01 or higher.

Value

Optional. Represents the value of an extended storage account property. Each extended property must have both a defined name and value. You can have a maximum of 50 extended property name/value pairs, and each extended property value has a maximum length of 255 characters.

The Value element is only available using version 2012-03-01 or higher.

Specifies the custom domains that are associated with the storage account.

Element name

Description

CustomDomain

Specifies information about a custom domain that is associated with the storage account.

Name

Specifies the name of the custom domain.

UseSubDomainName

Indicates whether indirect CName validation is enabled.

Possible values are:

  • true

  • false

The response includes an HTTP status code, a set of response headers, and a response body.

A successful operation returns status code 200 (OK).

The response for this operation includes the following headers. The response may also include additional standard HTTP headers.

Response Header

Description

x-ms-request-id

A value that uniquely identifies a request made against the management service. For an asynchronous operation, you can call Get Operation Status with the value of the header to determine whether the operation is complete, has failed, or is still in progress.

Use the Update Storage Account operation to change the description, label, or geo-replication setting value for a storage account. You can use the Get Storage Account Properties operation to review these values.

Show: