Storage Accounts

Check Name Availability

Checks that the storage account name is valid and is not already in use.

POST /subscriptions/{subscriptionId}/providers/Microsoft.Storage/checkNameAvailability?api-version=2016-12-01

Properties

accountName

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

inbody
requiredTrue
typeStorageAccountCheckNameAvailabilityParameters
name
requiredTrue
typestring
type
requiredTrue
typeMicrosoft.Storage/storageAccounts
api-version

Client Api Version.

inquery
requiredTrue
typestring
subscriptionId

Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

inpath
requiredTrue
typestring

Returns (HTTP Response Codes)

200 response

OK -- Operation to check the storage account name availability was successful.

typeCheckNameAvailabilityResult
nameAvailable

Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or is invalid and cannot be used.

read onlyTrue
typeboolean
reason

Gets the reason that a storage account name could not be used. The Reason element is only returned if NameAvailable is false.

read onlyTrue
typeReason { AccountNameInvalid, AlreadyExists }
message

Gets an error message explaining the Reason value in more detail.

read onlyTrue
typestring

Create

Asynchronously creates a new storage account with the specified parameters. If an account is already created and a subsequent create request is issued with different properties, the account properties will be updated. If an account is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed.

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}?api-version=2016-12-01

Properties

accountName

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

inpath
requiredTrue
typestring
api-version

Client Api Version.

inquery
requiredTrue
typestring
parameters

The parameters to provide for the created account.

inbody
requiredTrue
typeStorageAccountCreateParameters
sku

Required. Gets or sets the sku name.

typeSku
name

Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType.

typeSkuName { Standard_LRS, Standard_GRS, Standard_RAGRS, Standard_ZRS, Premium_LRS }
tier

Gets the sku tier. This is based on the SKU name.

read onlyTrue
typeSkuTier { Standard, Premium }
kind

Required. Indicates the type of storage account.

requiredTrue
typeKind { Storage, BlobStorage }
location

Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.

requiredTrue
typestring
tags

Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.

typeobject
properties

The parameters used to create the storage account.

typeStorageAccountPropertiesCreateParameters
customDomain

User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property.

typeCustomDomain
name

Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source.

requiredTrue
typestring
useSubDomain

Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates.

typeboolean
encryption

Provides the encryption settings on the account. If left unspecified the account encryption settings will remain the same. The default setting is unencrypted.

typeEncryption
services

List of services which support encryption.

typeEncryptionServices
blob

The encryption function of the blob storage service.

typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
file

The encryption function of the file storage service.

typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
table

The encryption function of the table storage service.

read onlyTrue
typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
queue

The encryption function of the queue storage service.

read onlyTrue
typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
keySource

The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage

requiredTrue
typeMicrosoft.Storage
accessTier

Required for storage accounts where kind = BlobStorage. The access tier used for billing.

typeAccessTier { Hot, Cool }
supportsHttpsTrafficOnly

Allows https traffic only to storage service if sets to true.

typeboolean
resourceGroupName

The name of the resource group within the user's subscription. The name is case insensitive.

inpath
requiredTrue
typestring
subscriptionId

Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

inpath
requiredTrue
typestring

Returns (HTTP Response Codes)

200 response

OK -- returned when the storage account was already created from a previous request with the same properties specified in the request body.

typeStorageAccount
sku

Gets the SKU.

read onlyTrue
typeSku
name

Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType.

requiredTrue
typeSkuName { Standard_LRS, Standard_GRS, Standard_RAGRS, Standard_ZRS, Premium_LRS }
tier

Gets the sku tier. This is based on the SKU name.

read onlyTrue
typeSkuTier { Standard, Premium }
kind

Gets the Kind.

read onlyTrue
typeKind { Storage, BlobStorage }
properties

Properties of the storage account.

typeStorageAccountProperties
provisioningState

Gets the status of the storage account at the time the operation was called.

read onlyTrue
typeProvisioningState { Creating, ResolvingDNS, Succeeded }
primaryEndpoints

Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object. Note that Standard_ZRS and Premium_LRS accounts only return the blob endpoint.

read onlyTrue
typeEndpoints
blob

Gets the blob endpoint.

read onlyTrue
typestring
queue

Gets the queue endpoint.

read onlyTrue
typestring
table

Gets the table endpoint.

read onlyTrue
typestring
file

Gets the file endpoint.

read onlyTrue
typestring
primaryLocation

Gets the location of the primary data center for the storage account.

read onlyTrue
typestring
statusOfPrimary

Gets the status indicating whether the primary location of the storage account is available or unavailable.

read onlyTrue
typeAccountStatus { available, unavailable }
lastGeoFailoverTime

Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS.

read onlyTrue
typedate-time
secondaryLocation

Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS.

read onlyTrue
typestring
statusOfSecondary

Gets the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the SKU name is Standard_GRS or Standard_RAGRS.

read onlyTrue
typeAccountStatus { available, unavailable }
creationTime

Gets the creation date and time of the storage account in UTC.

read onlyTrue
typedate-time
customDomain

Gets the custom domain the user assigned to this storage account.

read onlyTrue
typeCustomDomain
name

Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source.

requiredTrue
typestring
useSubDomain

Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates.

typeboolean
secondaryEndpoints

Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object from the secondary location of the storage account. Only available if the SKU name is Standard_RAGRS.

read onlyTrue
typeEndpoints
blob

Gets the blob endpoint.

read onlyTrue
typestring
queue

Gets the queue endpoint.

read onlyTrue
typestring
table

Gets the table endpoint.

read onlyTrue
typestring
file

Gets the file endpoint.

read onlyTrue
typestring
encryption

Gets the encryption settings on the account. If unspecified, the account is unencrypted.

read onlyTrue
typeEncryption
services

List of services which support encryption.

typeEncryptionServices
blob

The encryption function of the blob storage service.

typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
file

The encryption function of the file storage service.

typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
table

The encryption function of the table storage service.

read onlyTrue
typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
queue

The encryption function of the queue storage service.

read onlyTrue
typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
keySource

The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage

requiredTrue
typeMicrosoft.Storage
accessTier

Required for storage accounts where kind = BlobStorage. The access tier used for billing.

read onlyTrue
typeAccessTier { Hot, Cool }
supportsHttpsTrafficOnly

Allows https traffic only to storage service if sets to true.

typeboolean
id

Resource Id

read onlyTrue
typestring
name

Resource name

read onlyTrue
typestring
type

Resource type

read onlyTrue
typestring
location

Resource location

typestring
tags

Tags assigned to a resource; can be used for viewing and grouping a resource (across resource groups).

typeobject
202 response

Accepted -- Create or update request accepted; operation will complete asynchronously.

Delete

Deletes a storage account in Microsoft Azure.

DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}?api-version=2016-12-01

Properties

accountName

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

inpath
requiredTrue
typestring
api-version

Client Api Version.

inquery
requiredTrue
typestring
resourceGroupName

The name of the resource group within the user's subscription. The name is case insensitive.

inpath
requiredTrue
typestring
subscriptionId

Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

inpath
requiredTrue
typestring

Returns (HTTP Response Codes)

200 response

OK -- storage account deleted successfully.

204 response

NoContent -- account does not exist in the subscription.

Get Properties

Returns the properties for the specified storage account including but not limited to name, SKU name, location, and account status. The ListKeys operation should be used to retrieve storage keys.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}?api-version=2016-12-01

Properties

accountName

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

inpath
requiredTrue
typestring
api-version

Client Api Version.

inquery
requiredTrue
typestring
resourceGroupName

The name of the resource group within the user's subscription. The name is case insensitive.

inpath
requiredTrue
typestring
subscriptionId

Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

inpath
requiredTrue
typestring

Returns (HTTP Response Codes)

200 response

OK -- properties retrieved successfully for the storage account.

typeStorageAccount
sku

Gets the SKU.

read onlyTrue
typeSku
name

Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType.

requiredTrue
typeSkuName { Standard_LRS, Standard_GRS, Standard_RAGRS, Standard_ZRS, Premium_LRS }
tier

Gets the sku tier. This is based on the SKU name.

read onlyTrue
typeSkuTier { Standard, Premium }
kind

Gets the Kind.

read onlyTrue
typeKind { Storage, BlobStorage }
properties

Properties of the storage account.

typeStorageAccountProperties
provisioningState

Gets the status of the storage account at the time the operation was called.

read onlyTrue
typeProvisioningState { Creating, ResolvingDNS, Succeeded }
primaryEndpoints

Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object. Note that Standard_ZRS and Premium_LRS accounts only return the blob endpoint.

read onlyTrue
typeEndpoints
blob

Gets the blob endpoint.

read onlyTrue
typestring
queue

Gets the queue endpoint.

read onlyTrue
typestring
table

Gets the table endpoint.

read onlyTrue
typestring
file

Gets the file endpoint.

read onlyTrue
typestring
primaryLocation

Gets the location of the primary data center for the storage account.

read onlyTrue
typestring
statusOfPrimary

Gets the status indicating whether the primary location of the storage account is available or unavailable.

read onlyTrue
typeAccountStatus { available, unavailable }
lastGeoFailoverTime

Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS.

read onlyTrue
typedate-time
secondaryLocation

Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS.

read onlyTrue
typestring
statusOfSecondary

Gets the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the SKU name is Standard_GRS or Standard_RAGRS.

read onlyTrue
typeAccountStatus { available, unavailable }
creationTime

Gets the creation date and time of the storage account in UTC.

read onlyTrue
typedate-time
customDomain

Gets the custom domain the user assigned to this storage account.

read onlyTrue
typeCustomDomain
name

Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source.

requiredTrue
typestring
useSubDomain

Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates.

typeboolean
secondaryEndpoints

Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object from the secondary location of the storage account. Only available if the SKU name is Standard_RAGRS.

read onlyTrue
typeEndpoints
blob

Gets the blob endpoint.

read onlyTrue
typestring
queue

Gets the queue endpoint.

read onlyTrue
typestring
table

Gets the table endpoint.

read onlyTrue
typestring
file

Gets the file endpoint.

read onlyTrue
typestring
encryption

Gets the encryption settings on the account. If unspecified, the account is unencrypted.

read onlyTrue
typeEncryption
services

List of services which support encryption.

typeEncryptionServices
blob

The encryption function of the blob storage service.

typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
file

The encryption function of the file storage service.

typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
table

The encryption function of the table storage service.

read onlyTrue
typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
queue

The encryption function of the queue storage service.

read onlyTrue
typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
keySource

The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage

requiredTrue
typeMicrosoft.Storage
accessTier

Required for storage accounts where kind = BlobStorage. The access tier used for billing.

read onlyTrue
typeAccessTier { Hot, Cool }
supportsHttpsTrafficOnly

Allows https traffic only to storage service if sets to true.

typeboolean
id

Resource Id

read onlyTrue
typestring
name

Resource name

read onlyTrue
typestring
type

Resource type

read onlyTrue
typestring
location

Resource location

typestring
tags

Tags assigned to a resource; can be used for viewing and grouping a resource (across resource groups).

typeobject

List

Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.

GET /subscriptions/{subscriptionId}/providers/Microsoft.Storage/storageAccounts?api-version=2016-12-01

Properties

api-version

Client Api Version.

inquery
requiredTrue
typestring
subscriptionId

Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

inpath
requiredTrue
typestring

Returns (HTTP Response Codes)

200 response

OK -- List of storage accounts was retrieved and returned successfully.

typeStorageAccountListResult
value

Gets the list of storage accounts and their properties.

read onlyTrue
sku

Gets the SKU.

read onlyTrue
typeSku
name

Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType.

requiredTrue
typeSkuName { Standard_LRS, Standard_GRS, Standard_RAGRS, Standard_ZRS, Premium_LRS }
tier

Gets the sku tier. This is based on the SKU name.

read onlyTrue
typeSkuTier { Standard, Premium }
kind

Gets the Kind.

read onlyTrue
typeKind { Storage, BlobStorage }
properties

Properties of the storage account.

typeStorageAccountProperties
provisioningState

Gets the status of the storage account at the time the operation was called.

read onlyTrue
typeProvisioningState { Creating, ResolvingDNS, Succeeded }
primaryEndpoints

Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object. Note that Standard_ZRS and Premium_LRS accounts only return the blob endpoint.

read onlyTrue
typeEndpoints
blob

Gets the blob endpoint.

read onlyTrue
typestring
queue

Gets the queue endpoint.

read onlyTrue
typestring
table

Gets the table endpoint.

read onlyTrue
typestring
file

Gets the file endpoint.

read onlyTrue
typestring
primaryLocation

Gets the location of the primary data center for the storage account.

read onlyTrue
typestring
statusOfPrimary

Gets the status indicating whether the primary location of the storage account is available or unavailable.

read onlyTrue
typeAccountStatus { available, unavailable }
lastGeoFailoverTime

Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS.

read onlyTrue
typedate-time
secondaryLocation

Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS.

read onlyTrue
typestring
statusOfSecondary

Gets the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the SKU name is Standard_GRS or Standard_RAGRS.

read onlyTrue
typeAccountStatus { available, unavailable }
creationTime

Gets the creation date and time of the storage account in UTC.

read onlyTrue
typedate-time
customDomain

Gets the custom domain the user assigned to this storage account.

read onlyTrue
typeCustomDomain
name

Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source.

requiredTrue
typestring
useSubDomain

Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates.

typeboolean
secondaryEndpoints

Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object from the secondary location of the storage account. Only available if the SKU name is Standard_RAGRS.

read onlyTrue
typeEndpoints
blob

Gets the blob endpoint.

read onlyTrue
typestring
queue

Gets the queue endpoint.

read onlyTrue
typestring
table

Gets the table endpoint.

read onlyTrue
typestring
file

Gets the file endpoint.

read onlyTrue
typestring
encryption

Gets the encryption settings on the account. If unspecified, the account is unencrypted.

read onlyTrue
typeEncryption
services

List of services which support encryption.

typeEncryptionServices
blob

The encryption function of the blob storage service.

typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
file

The encryption function of the file storage service.

typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
table

The encryption function of the table storage service.

read onlyTrue
typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
queue

The encryption function of the queue storage service.

read onlyTrue
typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
keySource

The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage

requiredTrue
typeMicrosoft.Storage
accessTier

Required for storage accounts where kind = BlobStorage. The access tier used for billing.

read onlyTrue
typeAccessTier { Hot, Cool }
supportsHttpsTrafficOnly

Allows https traffic only to storage service if sets to true.

typeboolean
id

Resource Id

read onlyTrue
typestring
name

Resource name

read onlyTrue
typestring
type

Resource type

read onlyTrue
typestring
location

Resource location

typestring
tags

Tags assigned to a resource; can be used for viewing and grouping a resource (across resource groups).

typeobject

List Account SAS

List SAS credentials of a storage account.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListAccountSas?api-version=2016-12-01

Properties

accountName

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

inpath
requiredTrue
typestring
api-version

Client Api Version.

inquery
requiredTrue
typestring
parameters

The parameters to provide to list SAS credentials for the storage account.

inbody
requiredTrue
typeAccountSasParameters
signedServices

The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f).

requiredTrue
typeb, q, t, f
signedResourceTypes

The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files.

requiredTrue
types, c, o
signedPermission

The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p).

requiredTrue
typer, d, w, l, a, c, u, p
signedIp

An IP address or a range of IP addresses from which to accept requests.

typestring
signedProtocol

The protocol permitted for a request made with the account SAS.

typeHttpProtocol { https,http, https }
signedStart

The time at which the SAS becomes valid.

typedate-time
signedExpiry

The time at which the shared access signature becomes invalid.

requiredTrue
typedate-time
keyToSign

The key to sign the account SAS token with.

typestring
resourceGroupName

The name of the resource group within the user's subscription. The name is case insensitive.

inpath
requiredTrue
typestring
subscriptionId

Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

inpath
requiredTrue
typestring

Returns (HTTP Response Codes)

200 response

OK -- returned the account SAS created for the storage account requested.

typeListAccountSasResponse
accountSasToken

List SAS credentials of storage account.

read onlyTrue
typestring

List By Resource Group

Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts?api-version=2016-12-01

Properties

api-version

Client Api Version.

inquery
requiredTrue
typestring
resourceGroupName

The name of the resource group within the user's subscription. The name is case insensitive.

inpath
requiredTrue
typestring
subscriptionId

Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

inpath
requiredTrue
typestring

Returns (HTTP Response Codes)

200 response

OK -- List of storage accounts in the given resource group retrieved and returned successfully.

typeStorageAccountListResult
value

Gets the list of storage accounts and their properties.

read onlyTrue
sku

Gets the SKU.

read onlyTrue
typeSku
name

Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType.

requiredTrue
typeSkuName { Standard_LRS, Standard_GRS, Standard_RAGRS, Standard_ZRS, Premium_LRS }
tier

Gets the sku tier. This is based on the SKU name.

read onlyTrue
typeSkuTier { Standard, Premium }
kind

Gets the Kind.

read onlyTrue
typeKind { Storage, BlobStorage }
properties

Properties of the storage account.

typeStorageAccountProperties
provisioningState

Gets the status of the storage account at the time the operation was called.

read onlyTrue
typeProvisioningState { Creating, ResolvingDNS, Succeeded }
primaryEndpoints

Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object. Note that Standard_ZRS and Premium_LRS accounts only return the blob endpoint.

read onlyTrue
typeEndpoints
blob

Gets the blob endpoint.

read onlyTrue
typestring
queue

Gets the queue endpoint.

read onlyTrue
typestring
table

Gets the table endpoint.

read onlyTrue
typestring
file

Gets the file endpoint.

read onlyTrue
typestring
primaryLocation

Gets the location of the primary data center for the storage account.

read onlyTrue
typestring
statusOfPrimary

Gets the status indicating whether the primary location of the storage account is available or unavailable.

read onlyTrue
typeAccountStatus { available, unavailable }
lastGeoFailoverTime

Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS.

read onlyTrue
typedate-time
secondaryLocation

Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS.

read onlyTrue
typestring
statusOfSecondary

Gets the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the SKU name is Standard_GRS or Standard_RAGRS.

read onlyTrue
typeAccountStatus { available, unavailable }
creationTime

Gets the creation date and time of the storage account in UTC.

read onlyTrue
typedate-time
customDomain

Gets the custom domain the user assigned to this storage account.

read onlyTrue
typeCustomDomain
name

Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source.

requiredTrue
typestring
useSubDomain

Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates.

typeboolean
secondaryEndpoints

Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object from the secondary location of the storage account. Only available if the SKU name is Standard_RAGRS.

read onlyTrue
typeEndpoints
blob

Gets the blob endpoint.

read onlyTrue
typestring
queue

Gets the queue endpoint.

read onlyTrue
typestring
table

Gets the table endpoint.

read onlyTrue
typestring
file

Gets the file endpoint.

read onlyTrue
typestring
encryption

Gets the encryption settings on the account. If unspecified, the account is unencrypted.

read onlyTrue
typeEncryption
services

List of services which support encryption.

typeEncryptionServices
blob

The encryption function of the blob storage service.

typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
file

The encryption function of the file storage service.

typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
table

The encryption function of the table storage service.

read onlyTrue
typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
queue

The encryption function of the queue storage service.

read onlyTrue
typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
keySource

The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage

requiredTrue
typeMicrosoft.Storage
accessTier

Required for storage accounts where kind = BlobStorage. The access tier used for billing.

read onlyTrue
typeAccessTier { Hot, Cool }
supportsHttpsTrafficOnly

Allows https traffic only to storage service if sets to true.

typeboolean
id

Resource Id

read onlyTrue
typestring
name

Resource name

read onlyTrue
typestring
type

Resource type

read onlyTrue
typestring
location

Resource location

typestring
tags

Tags assigned to a resource; can be used for viewing and grouping a resource (across resource groups).

typeobject

List Keys

Lists the access keys for the specified storage account.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/listKeys?api-version=2016-12-01

Properties

accountName

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

inpath
requiredTrue
typestring
api-version

Client Api Version.

inquery
requiredTrue
typestring
resourceGroupName

The name of the resource group within the user's subscription. The name is case insensitive.

inpath
requiredTrue
typestring
subscriptionId

Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

inpath
requiredTrue
typestring

Returns (HTTP Response Codes)

200 response

OK -- list of keys retrieved and returned successfully.

typeStorageAccountListKeysResult
keys

Gets the list of storage account keys and their properties for the specified storage account.

read onlyTrue
keyName

Name of the key.

read onlyTrue
typestring
value

Base 64-encoded value of the key.

read onlyTrue
typestring
permissions

Permissions for the key -- read-only or full permissions.

read onlyTrue
typeKeyPermission { Read, Full }

List Service SAS

List service SAS credentials of a specific resource.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListServiceSas?api-version=2016-12-01

Properties

accountName

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

inpath
requiredTrue
typestring
api-version

Client Api Version.

inquery
requiredTrue
typestring
parameters

The parameters to provide to list service SAS credentials.

inbody
requiredTrue
typeServiceSasParameters
canonicalizedResource

The canonical path to the signed resource.

requiredTrue
typestring
signedResource

The signed services accessible with the service SAS. Possible values include: Blob (b), Container (c), File (f), Share (s).

requiredTrue
typeb, c, f, s
signedPermission

The signed permissions for the service SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p).

typer, d, w, l, a, c, u, p
signedIp

An IP address or a range of IP addresses from which to accept requests.

typestring
signedProtocol

The protocol permitted for a request made with the account SAS.

typeHttpProtocol { https,http, https }
signedStart

The time at which the SAS becomes valid.

typedate-time
signedExpiry

The time at which the shared access signature becomes invalid.

typedate-time
signedIdentifier

A unique value up to 64 characters in length that correlates to an access policy specified for the container, queue, or table.

typestring
startPk

The start of partition key.

typestring
endPk

The end of partition key.

typestring
startRk

The start of row key.

typestring
endRk

The end of row key.

typestring
keyToSign

The key to sign the account SAS token with.

typestring
rscc

The response header override for cache control.

typestring
rscd

The response header override for content disposition.

typestring
rsce

The response header override for content encoding.

typestring
rscl

The response header override for content language.

typestring
rsct

The response header override for content type.

typestring
resourceGroupName

The name of the resource group within the user's subscription. The name is case insensitive.

inpath
requiredTrue
typestring
subscriptionId

Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

inpath
requiredTrue
typestring

Returns (HTTP Response Codes)

200 response

OK -- returned the service SAS created for the storage service requested.

typeListServiceSasResponse
serviceSasToken

List service SAS credentials of speicific resource.

read onlyTrue
typestring

Regenerate Key

Regenerates one of the access keys for the specified storage account.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey?api-version=2016-12-01

Properties

accountName

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

inpath
requiredTrue
typestring
api-version

Client Api Version.

inquery
requiredTrue
typestring
regenerateKey

Specifies name of the key which should be regenerated -- key1 or key2.

inbody
requiredTrue
typeStorageAccountRegenerateKeyParameters
keyName
requiredTrue
typestring
resourceGroupName

The name of the resource group within the user's subscription. The name is case insensitive.

inpath
requiredTrue
typestring
subscriptionId

Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

inpath
requiredTrue
typestring

Returns (HTTP Response Codes)

200 response

OK -- specified key regenerated successfully.

typeStorageAccountListKeysResult
keys

Gets the list of storage account keys and their properties for the specified storage account.

read onlyTrue
keyName

Name of the key.

read onlyTrue
typestring
value

Base 64-encoded value of the key.

read onlyTrue
typestring
permissions

Permissions for the key -- read-only or full permissions.

read onlyTrue
typeKeyPermission { Read, Full }

Update

The update operation can be used to update the SKU, encryption, access tier, or tags for a storage account. It can also be used to map the account to a custom domain. Only one custom domain is supported per storage account; the replacement/change of custom domain is not supported. In order to replace an old custom domain, the old value must be cleared/unregistered before a new value can be set. The update of multiple properties is supported. This call does not change the storage keys for the account. If you want to change the storage account keys, use the regenerate keys operation. The location and name of the storage account cannot be changed after creation.

PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}?api-version=2016-12-01

Properties

accountName

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

inpath
requiredTrue
typestring
api-version

Client Api Version.

inquery
requiredTrue
typestring
parameters

The parameters to provide for the updated account.

inbody
requiredTrue
typeStorageAccountUpdateParameters
sku

Gets or sets the SKU name. Note that the SKU name cannot be updated to Standard_ZRS or Premium_LRS, nor can accounts of those sku names be updated to any other value.

typeSku
name

Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType.

requiredTrue
typeSkuName { Standard_LRS, Standard_GRS, Standard_RAGRS, Standard_ZRS, Premium_LRS }
tier

Gets the sku tier. This is based on the SKU name.

read onlyTrue
typeSkuTier { Standard, Premium }
tags

Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater in length than 128 characters and a value no greater in length than 256 characters.

typeobject
properties

The parameters used when updating a storage account.

typeStorageAccountPropertiesUpdateParameters
customDomain

Custom domain assigned to the storage account by the user. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property.

typeCustomDomain
name

Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source.

requiredTrue
typestring
useSubDomain

Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates.

typeboolean
encryption

Provides the encryption settings on the account. The default setting is unencrypted.

typeEncryption
services

List of services which support encryption.

typeEncryptionServices
blob

The encryption function of the blob storage service.

typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
file

The encryption function of the file storage service.

typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
table

The encryption function of the table storage service.

read onlyTrue
typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
queue

The encryption function of the queue storage service.

read onlyTrue
typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
keySource

The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage

requiredTrue
typeMicrosoft.Storage
accessTier

Required for storage accounts where kind = BlobStorage. The access tier used for billing.

typeAccessTier { Hot, Cool }
supportsHttpsTrafficOnly

Allows https traffic only to storage service if sets to true.

typeboolean
resourceGroupName

The name of the resource group within the user's subscription. The name is case insensitive.

inpath
requiredTrue
typestring
subscriptionId

Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

inpath
requiredTrue
typestring

Returns (HTTP Response Codes)

200 response

OK -- storage account properties updated successfully.

typeStorageAccount
sku

Gets the SKU.

read onlyTrue
typeSku
name

Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType.

requiredTrue
typeSkuName { Standard_LRS, Standard_GRS, Standard_RAGRS, Standard_ZRS, Premium_LRS }
tier

Gets the sku tier. This is based on the SKU name.

read onlyTrue
typeSkuTier { Standard, Premium }
kind

Gets the Kind.

read onlyTrue
typeKind { Storage, BlobStorage }
properties

Properties of the storage account.

typeStorageAccountProperties
provisioningState

Gets the status of the storage account at the time the operation was called.

read onlyTrue
typeProvisioningState { Creating, ResolvingDNS, Succeeded }
primaryEndpoints

Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object. Note that Standard_ZRS and Premium_LRS accounts only return the blob endpoint.

read onlyTrue
typeEndpoints
blob

Gets the blob endpoint.

read onlyTrue
typestring
queue

Gets the queue endpoint.

read onlyTrue
typestring
table

Gets the table endpoint.

read onlyTrue
typestring
file

Gets the file endpoint.

read onlyTrue
typestring
primaryLocation

Gets the location of the primary data center for the storage account.

read onlyTrue
typestring
statusOfPrimary

Gets the status indicating whether the primary location of the storage account is available or unavailable.

read onlyTrue
typeAccountStatus { available, unavailable }
lastGeoFailoverTime

Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS.

read onlyTrue
typedate-time
secondaryLocation

Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS.

read onlyTrue
typestring
statusOfSecondary

Gets the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the SKU name is Standard_GRS or Standard_RAGRS.

read onlyTrue
typeAccountStatus { available, unavailable }
creationTime

Gets the creation date and time of the storage account in UTC.

read onlyTrue
typedate-time
customDomain

Gets the custom domain the user assigned to this storage account.

read onlyTrue
typeCustomDomain
name

Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source.

requiredTrue
typestring
useSubDomain

Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates.

typeboolean
secondaryEndpoints

Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object from the secondary location of the storage account. Only available if the SKU name is Standard_RAGRS.

read onlyTrue
typeEndpoints
blob

Gets the blob endpoint.

read onlyTrue
typestring
queue

Gets the queue endpoint.

read onlyTrue
typestring
table

Gets the table endpoint.

read onlyTrue
typestring
file

Gets the file endpoint.

read onlyTrue
typestring
encryption

Gets the encryption settings on the account. If unspecified, the account is unencrypted.

read onlyTrue
typeEncryption
services

List of services which support encryption.

typeEncryptionServices
blob

The encryption function of the blob storage service.

typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
file

The encryption function of the file storage service.

typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
table

The encryption function of the table storage service.

read onlyTrue
typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
queue

The encryption function of the queue storage service.

read onlyTrue
typeEncryptionService
enabled

A boolean indicating whether or not the service encrypts the data as it is stored.

typeboolean
lastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

read onlyTrue
typedate-time
keySource

The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage

requiredTrue
typeMicrosoft.Storage
accessTier

Required for storage accounts where kind = BlobStorage. The access tier used for billing.

read onlyTrue
typeAccessTier { Hot, Cool }
supportsHttpsTrafficOnly

Allows https traffic only to storage service if sets to true.

typeboolean
id

Resource Id

read onlyTrue
typestring
name

Resource name

read onlyTrue
typestring
type

Resource type

read onlyTrue
typestring
location

Resource location

typestring
tags

Tags assigned to a resource; can be used for viewing and grouping a resource (across resource groups).

typeobject