Azure Storage Accounts StorageAccounts API
The StorageAccounts API from Azure Storage Accounts — 11 operation(s) for storageaccounts.
OpenAPI Specification
swagger: '2.0'
info:
description: The Azure Storage Management API.
title: StorageManagementClient BlobContainers StorageAccounts API
version: '2019-06-01'
x-apisguru-categories:
- cloud
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png
x-origin:
- format: swagger
url: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/blob.json
version: '2.0'
x-preferred: false
x-providerName: azure.com
x-serviceName: storage-blob
x-tags:
- Azure
- Microsoft
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- azure_auth:
- user_impersonation
tags:
- name: StorageAccounts
paths:
/subscriptions/{subscriptionId}/providers/Microsoft.Storage/checkNameAvailability:
post:
description: Checks that the storage account name is valid and is not already in use.
operationId: StorageAccounts_CheckNameAvailability
parameters:
- description: 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.
in: body
name: accountName
required: true
schema:
$ref: '#/definitions/StorageAccountCheckNameAvailabilityParameters'
example: example-value
- description: The API version to use for this operation.
in: query
minLength: 1
name: api-version
required: true
type: string
example: '2019-06-01'
- description: The ID of the target subscription.
in: path
minLength: 1
name: subscriptionId
required: true
type: string
example: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: OK -- Operation to check the storage account name availability was successful.
schema:
$ref: '#/definitions/CheckNameAvailabilityResult'
tags:
- StorageAccounts
x-ms-examples:
StorageAccountCheckNameAvailability:
parameters:
accountName:
name: sto3363
type: Microsoft.Storage/storageAccounts
api-version: '2019-06-01'
subscriptionId: '{subscription-id}'
responses:
'200':
body:
nameAvailable: true
summary: Azure Storage Accounts Storage Accounts_ Check Name Availability
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/subscriptions/{subscriptionId}/providers/Microsoft.Storage/storageAccounts:
get:
description: Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.
operationId: StorageAccounts_List
parameters:
- description: The API version to use for this operation.
in: query
minLength: 1
name: api-version
required: true
type: string
example: '2019-06-01'
- description: The ID of the target subscription.
in: path
minLength: 1
name: subscriptionId
required: true
type: string
example: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: OK -- List of storage accounts was retrieved and returned successfully.
schema:
$ref: '#/definitions/StorageAccountListResult'
tags:
- StorageAccounts
x-ms-examples:
StorageAccountList:
parameters:
api-version: '2019-06-01'
monitor: 'true'
subscriptionId: '{subscription-id}'
responses:
'200':
body:
value:
- id: /subscriptions/{subscription-id}/resourceGroups/res2627/providers/Microsoft.Storage/storageAccounts/sto1125
kind: Storage
location: eastus2euap
name: sto1125
properties:
creationTime: '2017-05-24T13:28:53.4540398Z'
encryption:
keySource: Microsoft.Storage
services:
blob:
enabled: true
keyType: Account
lastEnabledTime: '2019-12-11T20:49:31.7036140Z'
file:
enabled: true
keyType: Account
lastEnabledTime: '2019-12-11T20:49:31.7036140Z'
isHnsEnabled: true
primaryEndpoints:
blob: https://sto1125.blob.core.windows.net/
dfs: https://sto1125.dfs.core.windows.net/
file: https://sto1125.file.core.windows.net/
internetEndpoints:
blob: https://sto1125-internetrouting.blob.core.windows.net/
dfs: https://sto1125-internetrouting.dfs.core.windows.net/
file: https://sto1125-internetrouting.file.core.windows.net/
web: https://sto1125-internetrouting.web.core.windows.net/
microsoftEndpoints:
blob: https://sto1125-microsoftrouting.blob.core.windows.net/
dfs: https://sto1125-microsoftrouting.dfs.core.windows.net/
file: https://sto1125-microsoftrouting.file.core.windows.net/
queue: https://sto1125-microsoftrouting.queue.core.windows.net/
table: https://sto1125-microsoftrouting.table.core.windows.net/
web: https://sto1125-microsoftrouting.web.core.windows.net/
queue: https://sto1125.queue.core.windows.net/
table: https://sto1125.table.core.windows.net/
web: https://sto1125.web.core.windows.net/
primaryLocation: eastus2euap
provisioningState: Succeeded
routingPreference:
publishInternetEndpoints: true
publishMicrosoftEndpoints: true
routingChoice: MicrosoftRouting
secondaryLocation: centraluseuap
statusOfPrimary: available
statusOfSecondary: available
supportsHttpsTrafficOnly: false
sku:
name: Standard_GRS
tier: Standard
tags:
key1: value1
key2: value2
type: Microsoft.Storage/storageAccounts
- id: /subscriptions/{subscription-id}/resourceGroups/testcmk3/providers/Microsoft.Storage/storageAccounts/sto3699
identity:
principalId: 356d057d-cba5-44dd-8a30-b2e547bc416b
tenantId: 72f988bf-86f1-41af-91ab-2d7cd011db47
type: SystemAssigned
kind: Storage
location: eastus2euap
name: sto3699
properties:
creationTime: '2017-05-24T10:06:30.6093014Z'
primaryEndpoints:
blob: https://sto3699.blob.core.windows.net/
file: https://sto3699.file.core.windows.net/
queue: https://sto3699.queue.core.windows.net/
table: https://sto3699.table.core.windows.net/
primaryLocation: eastus2euap
provisioningState: Succeeded
secondaryLocation: centraluseuap
statusOfPrimary: available
statusOfSecondary: available
supportsHttpsTrafficOnly: false
sku:
name: Standard_GRS
tier: Standard
tags:
key1: value1
key2: value2
type: Microsoft.Storage/storageAccounts
- id: /subscriptions/{subscription-id}/resourceGroups/testcmk3/providers/Microsoft.Storage/storageAccounts/sto6637
identity:
principalId: 911871cc-ffd1-4fc4-ac11-7a316433ea66
tenantId: 72f988bf-86f1-41af-91ab-2d7cd011db47
type: SystemAssigned
kind: Storage
location: eastus2euap
name: sto6637
properties:
creationTime: '2017-05-24T10:09:39.5625175Z'
primaryEndpoints:
blob: https://sto6637.blob.core.windows.net/
file: https://sto6637.file.core.windows.net/
queue: https://sto6637.queue.core.windows.net/
table: https://sto6637.table.core.windows.net/
primaryLocation: eastus2euap
provisioningState: Succeeded
secondaryLocation: centraluseuap
statusOfPrimary: available
statusOfSecondary: available
supportsHttpsTrafficOnly: false
sku:
name: Standard_GRS
tier: Standard
tags:
key1: value1
key2: value2
type: Microsoft.Storage/storageAccounts
- id: /subscriptions/{subscription-id}/resourceGroups/res8186/providers/Microsoft.Storage/storageAccounts/sto834
kind: Storage
location: eastus2euap
name: sto834
properties:
creationTime: '2017-05-24T13:28:20.8686541Z'
primaryEndpoints:
blob: https://sto834.blob.core.windows.net/
file: https://sto834.file.core.windows.net/
queue: https://sto834.queue.core.windows.net/
table: https://sto834.table.core.windows.net/
primaryLocation: eastus2euap
provisioningState: Succeeded
secondaryLocation: centraluseuap
statusOfPrimary: available
statusOfSecondary: available
supportsHttpsTrafficOnly: false
sku:
name: Standard_GRS
tier: Standard
tags:
key1: value1
key2: value2
type: Microsoft.Storage/storageAccounts
- id: /subscriptions/{subscription-id}/resourceGroups/testcmk3/providers/Microsoft.Storage/storageAccounts/sto9174
identity:
principalId: 933e3ddf-1802-4a51-9469-18a33b576f88
tenantId: 72f988bf-86f1-41af-91ab-2d7cd011db47
type: SystemAssigned
kind: Storage
location: eastus2euap
name: sto9174
properties:
creationTime: '2017-05-24T09:46:19.6556989Z'
primaryEndpoints:
blob: https://sto9174.blob.core.windows.net/
file: https://sto9174.file.core.windows.net/
queue: https://sto9174.queue.core.windows.net/
table: https://sto9174.table.core.windows.net/
primaryLocation: eastus2euap
provisioningState: Succeeded
secondaryLocation: centraluseuap
statusOfPrimary: available
statusOfSecondary: available
supportsHttpsTrafficOnly: false
sku:
name: Standard_GRS
tier: Standard
tags:
key1: value1
key2: value2
type: Microsoft.Storage/storageAccounts
x-ms-pageable:
nextLinkName: nextLink
summary: Azure Storage Accounts Storage Accounts_ List
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts:
get:
description: Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this.
operationId: StorageAccounts_ListByResourceGroup
parameters:
- $ref: '#/parameters/ResourceGroupName'
- description: The API version to use for this operation.
in: query
minLength: 1
name: api-version
required: true
type: string
example: '2019-06-01'
- description: The ID of the target subscription.
in: path
minLength: 1
name: subscriptionId
required: true
type: string
example: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: OK -- List of storage accounts in the given resource group retrieved and returned successfully.
schema:
$ref: '#/definitions/StorageAccountListResult'
tags:
- StorageAccounts
x-ms-examples:
StorageAccountListByResourceGroup:
parameters:
api-version: '2019-06-01'
resourceGroupName: res6117
subscriptionId: '{subscription-id}'
responses:
'200':
body:
value:
- id: /subscriptions/{subscription-id}/resourceGroups/res6117/providers/Microsoft.Storage/storageAccounts/sto4036
kind: Storage
location: eastus2euap
name: sto4036
properties:
creationTime: '2017-05-24T13:24:47.818801Z'
isHnsEnabled: true
primaryEndpoints:
blob: https://sto4036.blob.core.windows.net/
dfs: https://sto4036.dfs.core.windows.net/
file: https://sto4036.file.core.windows.net/
queue: https://sto4036.queue.core.windows.net/
table: https://sto4036.table.core.windows.net/
web: https://sto4036.web.core.windows.net/
primaryLocation: eastus2euap
provisioningState: Succeeded
secondaryLocation: centraluseuap
statusOfPrimary: available
statusOfSecondary: available
supportsHttpsTrafficOnly: false
sku:
name: Standard_GRS
tier: Standard
tags:
key1: value1
key2: value2
type: Microsoft.Storage/storageAccounts
- id: /subscriptions/{subscription-id}/resourceGroups/res6117/providers/Microsoft.Storage/storageAccounts/sto4452
kind: Storage
location: eastus2euap
name: sto4452
properties:
creationTime: '2017-05-24T13:24:15.7068366Z'
primaryEndpoints:
blob: https://sto4452.blob.core.windows.net/
file: https://sto4452.file.core.windows.net/
queue: https://sto4452.queue.core.windows.net/
table: https://sto4452.table.core.windows.net/
primaryLocation: eastus2euap
provisioningState: Succeeded
secondaryLocation: centraluseuap
statusOfPrimary: available
statusOfSecondary: available
supportsHttpsTrafficOnly: false
sku:
name: Standard_GRS
tier: Standard
tags:
key1: value1
key2: value2
type: Microsoft.Storage/storageAccounts
x-ms-pageable:
nextLinkName: null
summary: Azure Storage Accounts Storage Accounts_ List by Resource Group
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}
: delete:
description: Deletes a storage account in Microsoft Azure.
operationId: StorageAccounts_Delete
parameters:
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/StorageAccountName'
- description: The API version to use for this operation.
in: query
minLength: 1
name: api-version
required: true
type: string
example: '2019-06-01'
- description: The ID of the target subscription.
in: path
minLength: 1
name: subscriptionId
required: true
type: string
example: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: OK -- storage account deleted successfully.
'204':
description: NoContent -- account does not exist in the subscription.
tags:
- StorageAccounts
x-ms-examples:
StorageAccountDelete:
parameters:
accountName: sto2434
api-version: '2019-06-01'
monitor: 'true'
resourceGroupName: res4228
subscriptionId: '{subscription-id}'
responses:
'200': {}
'204': {}
summary: Azure Storage Accounts Storage Accounts_ Delete
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
get:
description: 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.
operationId: StorageAccounts_GetProperties
parameters:
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/StorageAccountName'
- description: The API version to use for this operation.
in: query
minLength: 1
name: api-version
required: true
type: string
example: '2019-06-01'
- description: The ID of the target subscription.
in: path
minLength: 1
name: subscriptionId
required: true
type: string
example: 00000000-0000-0000-0000-000000000000
- description: May be used to expand the properties within account's properties. By default, data is not included when fetching properties. Currently we only support geoReplicationStats and blobRestoreStatus.
enum:
- geoReplicationStats
- blobRestoreStatus
in: query
name: $expand
required: false
type: string
x-ms-enum:
modelAsString: false
name: StorageAccountExpand
example: example-value
responses:
'200':
description: OK -- properties retrieved successfully for the storage account.
schema:
$ref: '#/definitions/StorageAccount'
tags:
- StorageAccounts
x-ms-examples:
StorageAccountGetProperties:
parameters:
accountName: sto8596
api-version: '2019-06-01'
monitor: 'true'
resourceGroupName: res9407
subscriptionId: '{subscription-id}'
responses:
'200':
body:
id: /subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596
kind: Storage
location: eastus2(stage)
name: sto8596
properties:
creationTime: '2017-06-01T02:42:41.7633306Z'
encryption:
keySource: Microsoft.Storage
services:
blob:
enabled: true
keyType: Account
lastEnabledTime: '2019-12-11T20:49:31.7036140Z'
file:
enabled: true
keyType: Account
lastEnabledTime: '2019-12-11T20:49:31.7036140Z'
geoReplicationStats:
canFailover: true
lastSyncTime: '2018-10-30T00:25:34Z'
status: Live
isHnsEnabled: true
networkAcls:
bypass: AzureServices
defaultAction: Allow
ipRules: []
virtualNetworkRules: []
primaryEndpoints:
blob: https://sto8596.blob.core.windows.net/
dfs: https://sto8596.dfs.core.windows.net/
file: https://sto8596.file.core.windows.net/
internetEndpoints:
blob: https://sto8596-internetrouting.blob.core.windows.net/
dfs: https://sto8596-internetrouting.dfs.core.windows.net/
file: https://sto8596-internetrouting.file.core.windows.net/
web: https://sto8596-internetrouting.web.core.windows.net/
microsoftEndpoints:
blob: https://sto8596-microsoftrouting.blob.core.windows.net/
dfs: https://sto8596-microsoftrouting.dfs.core.windows.net/
file: https://sto8596-microsoftrouting.file.core.windows.net/
queue: https://sto8596-microsoftrouting.queue.core.windows.net/
table: https://sto8596-microsoftrouting.table.core.windows.net/
web: https://sto8596-microsoftrouting.web.core.windows.net/
queue: https://sto8596.queue.core.windows.net/
table: https://sto8596.table.core.windows.net/
web: https://sto8596.web.core.windows.net/
primaryLocation: eastus2(stage)
provisioningState: Succeeded
routingPreference:
publishInternetEndpoints: true
publishMicrosoftEndpoints: true
routingChoice: MicrosoftRouting
secondaryLocation: northcentralus(stage)
statusOfPrimary: available
statusOfSecondary: available
supportsHttpsTrafficOnly: false
sku:
name: Standard_GRS
tier: Standard
tags:
key1: value1
key2: value2
type: Microsoft.Storage/storageAccounts
summary: Azure Storage Accounts Storage Accounts_ Get Properties
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
patch:
description: 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.
operationId: StorageAccounts_Update
parameters:
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/StorageAccountName'
- description: The parameters to provide for the updated account.
in: body
name: parameters
required: true
schema:
$ref: '#/definitions/StorageAccountUpdateParameters'
example: example-value
- description: The API version to use for this operation.
in: query
minLength: 1
name: api-version
required: true
type: string
example: '2019-06-01'
- description: The ID of the target subscription.
in: path
minLength: 1
name: subscriptionId
required: true
type: string
example: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: OK -- storage account properties updated successfully.
schema:
$ref: '#/definitions/StorageAccount'
tags:
- StorageAccounts
x-ms-examples:
StorageAccountEnableAD:
parameters:
accountName: sto8596
api-version: '2019-06-01'
monitor: 'true'
parameters:
properties:
azureFilesIdentityBasedAuthentication:
activeDirectoryProperties:
azureStorageSid: S-1-5-21-2400535526-2334094090-2402026252-0012
domainGuid: aebfc118-9fa9-4732-a21f-d98e41a77ae1
domainName: adtest.com
domainSid: S-1-5-21-2400535526-2334094090-2402026252
forestName: adtest.com
netBiosDomainName: adtest.com
directoryServiceOptions: AD
resourceGroupName: res9407
subscriptionId: '{subscription-id}'
responses:
'200':
body:
id: /subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596
kind: Storage
location: eastus2(stage)
name: sto8596
properties:
azureFilesIdentityBasedAuthentication:
activeDirectoryProperties:
azureStorageSid: S-1-5-21-2400535526-2334094090-2402026252-0012
domainGuid: aebfc118-9fa9-4732-a21f-d98e41a77ae1
domainName: adtest.com
domainSid: S-1-5-21-2400535526-2334094090-2402026252
forestName: adtest.com
netBiosDomainName: adtest.com
directoryServiceOptions: AD
creationTime: '2017-06-01T02:42:41.7633306Z'
primaryEndpoints:
blob: https://sto8596.blob.core.windows.net/
dfs: https://sto8596.dfs.core.windows.net/
file: https://sto8596.file.core.windows.net/
queue: https://sto8596.queue.core.windows.net/
table: https://sto8596.table.core.windows.net/
web: https://sto8596.web.core.windows.net/
primaryLocation: eastus2(stage)
provisioningState: Succeeded
secondaryLocation: northcentralus(stage)
statusOfPrimary: available
statusOfSecondary: available
supportsHttpsTrafficOnly: false
sku:
name: Standard_GRS
tier: Standard
tags:
key1: value1
key2: value2
type: Microsoft.Storage/storageAccounts
StorageAccountUpdate:
parameters:
accountName: sto8596
api-version: '2019-06-01'
monitor: 'true'
parameters:
properties:
encryption:
keySource: Microsoft.Storage
services:
blob:
enabled: true
keyType: Account
file:
enabled: true
keyType: Account
networkAcls:
defaultAction: Allow
routingPreference:
publishInternetEndpoints: true
publishMicrosoftEndpoints: true
routingChoice: MicrosoftRouting
resourceGroupName: res9407
subscriptionId: '{subscription-id}'
responses:
'200':
body:
id: /subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596
kind: Storage
location: eastus2(stage)
name: sto8596
properties:
creationTime: '2017-06-01T02:42:41.7633306Z'
encryption:
keySource: Microsoft.Storage
services:
blob:
enabled: true
keyType: Account
lastEnabledTime: '2019-12-11T20:49:31.7036140Z'
file:
enabled: true
keyType: Account
lastEnabledTime: '2019-12-11T20:49:31.7036140Z'
isHnsEnabled: true
networkAcls:
bypass: AzureServices
defaultAction: Allow
ipRules: []
virtualNetworkRules: []
primaryEndpoints:
blob: https://sto8596.blob.core.windows.net/
dfs: https://sto8596.dfs.core.windows.net/
file: https://sto8596.file.core.windows.net/
internetEndpoints:
blob: https://sto8596-internetrouting.blob.core.windows.net/
dfs: https://sto8596-internetrouting.dfs.core.windows.net/
file: https://sto8596-internetrouting.file.core.windows.net/
web: https://sto8596-internetrouting.web.core.windows.net/
microsoftEndpoints:
blob: https://sto8596-microsoftrouting.blob.core.windows.net/
dfs: https://sto8596-microsoftrouting.dfs.core.windows.net/
file: https://sto8596-microsoftrouting.file.core.windows.net/
queue: https://sto8596-microsoftrouting.queue.core.windows.net/
table: https://sto8596-microsoftrouting.table.core.windows.net/
web: https://sto8596-microsoftrouting.web.core.windows.net/
queue: https://sto8596.queue.core.windows.net/
table: https://sto8596.table.core.windows.net/
web: https://sto8596.web.core.windows.net/
primaryLocation: eastus2(stage)
provisioningState: Succeeded
routingPreference:
publishInternetEndpoints: true
publishMicrosoftEndpoints: true
routingChoice: MicrosoftRouting
secondaryLocation: northcentralus(stage)
statusOfPrimary: available
statusOfSecondary: available
supportsHttpsTrafficOnly: false
sku:
name: Standard_GRS
tier: Standard
tags:
key1: value1
key2: value2
type: Microsoft.Storage/storageAccounts
summary: Azure Storage Accounts Storage Accounts_ Update
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
description: 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.
operationId: StorageAccounts_Create
parameters:
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/StorageAccountName'
- description: The parameters to provide for the created account.
in: body
name: parameters
required: true
schema:
$ref: '#/definitions/StorageAccountCreateParameters'
example: example-value
- description: The API version to use for this operation.
in: query
minLength: 1
name: api-version
# --- truncated at 32 KB (96 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/azure-storage-accounts/refs/heads/main/openapi/azure-storage-accounts-storageaccounts-api-openapi.yml