Get Storage Account Properties
The Get Storage Account Properties operation returns system properties for the specified storage account.
Request
The Get Storage Account Properties request may be specified as follows. Replace <subscription-id> with your subscription ID, and <storage-account-name> with the name of the storage account.
Method |
Request URI |
|---|---|
GET |
https://management.core.windows.net/<subscription-id>/services/storageservices/<storage-account-name> |
URI Parameters
None.
Request Headers
The following table describes the request headers.
Request Header |
Description |
|---|---|
x-ms-version |
Required. Specifies the version of the operation to use for this request. This header should be set to 2009-10-01 or higher. |
Request Body
None.
Response
The response includes an HTTP status code, a set of response headers, and a response body.
Status Code
A successful operation returns status code 200 (OK).
Response Headers
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. |
Response Body
<?xml version="1.0" encoding="utf-8"?>
<StorageService xmlns="https://schemas.microsoft.com/windowsazure">
<Url>storage-account-request-uri</Url>
<ServiceName>storage-account-name</ServiceName>
<StorageServiceProperties>
<Description>description</Description>
<AffinityGroup>affinity-group</AffinityGroup>
<Location>location</Location>
<Label>base64-encoded-label</Label>
<Status>status</Status>
<Endpoints>
<Endpoint>storage-service-blob-endpoint</Endpoint>
<Endpoint>storage-service-queue-endpoint</Endpoint>
<Endpoint>storage-service-table-endpoint</Endpoint>
<Endpoint>storage-service-file-endpoint</Endpoint>
</Endpoints>
<GeoReplicationEnabled>geo-replication-indicator</GeoReplicationEnabled>
<GeoPrimaryRegion>primary-region</GeoPrimaryRegion>
<StatusOfPrimary>primary-status</StatusOfPrimary>
<LastGeoFailoverTime>DateTime</LastGeoFailoverTime>
<GeoSecondaryRegion>secondary-region</GeoSecondaryRegion>
<StatusOfSecondary>secondary-status</StatusOfSecondary>
<CreationTime>time-of-creation</CreationTime>
<CustomDomains>
<CustomDomain>
<Name>name-of-custom-domain</Name>
</CustomDomain>
</CustomDomains>
<SecondaryReadEnabled>secondary-read-indicator</SecondaryReadEnabled>
<SecondaryEndpoints>
<Endpoint>storage-secondary-service-blob-endpoint</Endpoint>
<Endpoint>storage-secondary-service-queue-endpoint</Endpoint>
<Endpoint>storage-secondary-service-table-endpoint</Endpoint>
</SecondaryEndpoints>
<AccountType>type-of-storage-account</AccountType>
</StorageServiceProperties>
<ExtendedProperties>
<ExtendedProperty>
<Name>property-name</Name>
<Value>property-value</Value>
</ExtendedProperty>
</ExtendedProperties>
<Capabilities>
<Capability>storage-account-capability</Capability>
</Capabilities>
</StorageService>
The following table describes the elements of the response body.
Element name |
Description |
|---|---|
Url |
Specifies the URI of the storage account. |
ServiceName |
Specifies the name of the storage account. This name is the DNS prefix name and can be used to access blobs, queues, and tables in the storage account. For example, if the service name is MyStorageAccount you could access the blob containers by calling: http://MyStorageAccount.blob.core.windows.net/mycontainer/ |
StorageServiceProperties |
Specifies the properties of the storage account. |
ExtendedProperties |
Specifies the name and value of an extended property that was added to the storage account. |
Capability |
Indicates whether the storage account is able to perform virtual machine related operations. If so, this element returns a string containing PersistentVMRole. Otherwise, this element will not be present. The Capability element is only available using version 2012-03-01 or higher. |
StorageServiceProperties
Specifies the properties of the storage account.
Element name |
Description |
|---|---|
Description |
Optional. A description for the storage account. The description can be up to 1024 characters in length. The Description element is only available using version 2012-03-01 or higher. |
AffinityGroup |
Required if Location is not specified. The name of an existing affinity group associated with this subscription. This name is a GUID and can be retrieved by examining the name element of the response body returned by the List Affinity Groups operation. The AffinityGroup element is only available using version 2012-03-01 or higher. |
Location |
Required if AffinityGroup is not specified. The location where the storage account will be created. The Location element is only available using version 2012-03-01 or higher. |
Label |
Required. A name for the hosted service that is base-64 encoded. The name can be up to 100 characters in length. The name can be used identify the storage account for your tracking purposes. The Label element is only available using version 2012-03-01 or higher. |
Status |
The status of the storage account. Possible values are:
The Status element is only available using version 2012-03-01 or higher. |
Endpoints |
The blob, table, queue, and file endpoints. Note1: The file endpoint is in preview mode and will only be returned for preview-enabled subscriptions. Note 2: For the Standard_ZRS account type, only the blob endpoint is returned. ZRS also only supports block blobs, not page blobs, and is therefore not compatible with IaaS VMs. Note 3: For the Premium_LRS account type, only the blob endpoint is returned. |
GeoReplicationEnabled |
Indicates whether the data in the storage account is replicated across more than one geographic location so as to enable resilience in the face of catastrophic service loss. The value is true if geo-replication is enabled; otherwise false. The GeoReplicationEnabled element is only available using version 2012-03-01 or higher and is replaced by the AccountType element with version 2014-06-01 or higher. |
GeoPrimaryRegion |
Indicates the primary geographical region in which the storage account exists at this time. The GeoPrimaryRegion element is only available using version 2012-03-01 or higher. |
StatusOfPrimary |
Indicates whether the primary storage region is available. Possible values are:
The StatusOfPrimary element is only available using version 2013-11-01 or higher. |
LastGeoFailoverTime |
A timestamp that indicates the most recent instance of a failover to the secondary region. In case of multiple failovers only the latest failover date and time maintained. The format of the returned timestamp is: [4DigitYear]-[2DigitMonth]-[2DigitDay]T[2DigitMinute]:[2DigitSecond]:[7DigitsOfPrecision]Z For example: <LastGeoFailoverTime>2010-01-18T13:15:30.0000000Z</LastGeoFailoverTime> LastGeoFailoverTime is not returned if there has not been an instance of a failover. The LastGeoFailoverTime element is only available using version 2012-03-01 or higher. |
GeoSecondaryRegion |
Indicates the geographical region in which the storage account is being replicated. The GeoSecondaryRegion element is not returned if geo-replication is “off” for this account. The GeoSecondaryRegion element is only available using version 2012-03-01 or higher. |
StatusOfSecondary |
Indicates whether the secondary storage region is available. Possible values are:
The StatusOfSecondary element is only available using version 2013-11-01 or higher. |
CreationTime |
Specifies the time that the storage account was created. |
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. |
SecondaryReadEnabled |
Indicates that secondary read is enabled for the storage account. Possible values are:
The SecondaryReadEnabled element is only available using version 2013-11-01 or higher and is replaced by the AccountType element with version 2014-06-01 or higher. |
SecondaryEndpoints |
Specifies the secondary endpoints of the storage account. The SecondaryEndpoints element is only available using version 2013-11-01 or higher. |
AccountType |
Specifies whether the account supports locally-redundant storage, geo-redundant storage, zone-redundant storage, or read access geo-redundant storage. Possible values are:
The AccountType element is only available using version 2014-06-01 or higher and it replaces the SecondaryReadEnabled and GeoReplicationEnabled elements. The Premium_LRS element is only available using version 2014-10-01 or higher. |
Endpoints
Specifies the endpoints of the storage account.
Element name |
Description |
|---|---|
Endpoint |
Contains the blob service endpoint in the following format: https:// <storage-service-name>.blob.core.windows.net The Endpoint element is only available using version 2012-03-01 or higher. Http endpoints, are returned with version 2014-04-01 or lower. |
Endpoint |
Contains the queue service endpoint in the following format: https:// <storage-service-name>.queue.core.windows.net The Endpoint element is only available using version 2012-03-01 or higher. Http endpoints, are returned with version 2014-04-01 or lower. |
Endpoint |
Contains the table service endpoint in the following format: https://<storage-service-name>.table.core.windows.net The Endpoint element is only available using version 2012-03-01 or higher. Http endpoints, are returned with version 2014-04-01 or lower. |
Endpoint |
Contains the file service endpoint in the following format: https://<storage-service-name>.file.core.windows.net The Endpoint element is only available using version 2012-03-01 or higher. Http endpoints, are returned with version 2014-04-01 or lower. |
CustomDomains
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. |
SecondaryEndpoints
Specifies the secondary endpoints of the storage account.
Element name |
Description |
|---|---|
Endpoint |
Contains the blob secondary service endpoint in the following format: https://<storage-secondary-service-name>.blob.core.windows.net Http endpoints, are returned with version 2014-04-01 or lower. |
Endpoint |
Contains the queue service endpoint in the following format: https://<storage-secondary-service-name>.queue.core.windows.net Http endpoints, are returned with version 2014-04-01 or lower. |
Endpoint |
Contains the table service endpoint in the following format: https://<storage-secondary-service-name>.table.core.windows.net Http endpoints, are returned with version 2014-04-01 or lower. |
ExtendedProperties
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. |
Remarks
Geo-replication can be enabled when you create or update a storage account.
If the x-ms-version is 2012-03-01 or higher and the affinity group was created in one of the deprecated Anywhere US, Anywhere Europe, Anywhere Asia regions, the Location element will return the location where this affinity group is allocated.