Microsoft.Storage storageAccounts 2021-04-01

Article
09/24/2024

Bicep resource definition

The storageAccounts resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Storage/storageAccounts resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Storage/storageAccounts@2021-04-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  kind: 'string'
  extendedLocation: {
    name: 'string'
    type: 'EdgeZone'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    accessTier: 'string'
    allowBlobPublicAccess: bool
    allowCrossTenantReplication: bool
    allowSharedKeyAccess: bool
    azureFilesIdentityBasedAuthentication: {
      activeDirectoryProperties: {
        azureStorageSid: 'string'
        domainGuid: 'string'
        domainName: 'string'
        domainSid: 'string'
        forestName: 'string'
        netBiosDomainName: 'string'
      }
      defaultSharePermission: 'string'
      directoryServiceOptions: 'string'
    }
    customDomain: {
      name: 'string'
      useSubDomainName: bool
    }
    encryption: {
      identity: {
        userAssignedIdentity: 'string'
      }
      keySource: 'string'
      keyvaultproperties: {
        keyname: 'string'
        keyvaulturi: 'string'
        keyversion: 'string'
      }
      requireInfrastructureEncryption: bool
      services: {
        blob: {
          enabled: bool
          keyType: 'string'
        }
        file: {
          enabled: bool
          keyType: 'string'
        }
        queue: {
          enabled: bool
          keyType: 'string'
        }
        table: {
          enabled: bool
          keyType: 'string'
        }
      }
    }
    isHnsEnabled: bool
    isNfsV3Enabled: bool
    keyPolicy: {
      keyExpirationPeriodInDays: int
    }
    largeFileSharesState: 'string'
    minimumTlsVersion: 'string'
    networkAcls: {
      bypass: 'string'
      defaultAction: 'string'
      ipRules: [
        {
          action: 'Allow'
          value: 'string'
        }
      ]
      resourceAccessRules: [
        {
          resourceId: 'string'
          tenantId: 'string'
        }
      ]
      virtualNetworkRules: [
        {
          action: 'Allow'
          id: 'string'
          state: 'string'
        }
      ]
    }
    routingPreference: {
      publishInternetEndpoints: bool
      publishMicrosoftEndpoints: bool
      routingChoice: 'string'
    }
    sasPolicy: {
      expirationAction: 'Log'
      sasExpirationPeriod: 'string'
    }
    supportsHttpsTrafficOnly: bool
  }
}

Property values

storageAccounts

Name	Description	Value
name	The resource name	string (required) Character limit: 3-24 Valid characters: Lowercase letters and numbers. Resource name must be unique across Azure.
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.	string (required)
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.	Dictionary of tag names and values. See Tags in templates
sku	Required. Gets or sets the SKU name.	Sku (required)
kind	Required. Indicates the type of storage account.	'BlobStorage' 'BlockBlobStorage' 'FileStorage' 'Storage' 'StorageV2' (required)
extendedLocation	Optional. Set the extended location of the resource. If not set, the storage account will be created in Azure main region. Otherwise it will be created in the specified extended location	ExtendedLocation
identity	The identity of the resource.	Identity
properties	The parameters used to create the storage account.	StorageAccountPropertiesCreateParametersOrStorageAcc...

ExtendedLocation

Name	Description	Value
name	The name of the extended location.	string
type	The type of the extended location.	'EdgeZone'

Identity

Name	Description	Value
type	The identity type.	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage account. The key is the ARM resource identifier of the identity. Only 1 User Assigned identity is permitted here.	IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

Name	Description	Value
{customized property}		UserAssignedIdentity

UserAssignedIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

StorageAccountPropertiesCreateParametersOrStorageAcc...

Name	Description	Value
accessTier	Required for storage accounts where kind = BlobStorage. The access tier used for billing.	'Cool' 'Hot'
allowBlobPublicAccess	Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property.	bool
allowCrossTenantReplication	Allow or disallow cross AAD tenant object replication. The default interpretation is true for this property.	bool
allowSharedKeyAccess	Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true.	bool
azureFilesIdentityBasedAuthentication	Provides the identity based authentication settings for Azure Files.	AzureFilesIdentityBasedAuthentication
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.	CustomDomain
encryption	Not applicable. Azure Storage encryption is enabled for all storage accounts and cannot be disabled.	Encryption
isHnsEnabled	Account HierarchicalNamespace enabled if sets to true.	bool
isNfsV3Enabled	NFS 3.0 protocol support enabled if set to true.	bool
keyPolicy	KeyPolicy assigned to the storage account.	KeyPolicy
largeFileSharesState	Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled.	'Disabled' 'Enabled'
minimumTlsVersion	Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property.	'TLS1_0' 'TLS1_1' 'TLS1_2'
networkAcls	Network rule set	NetworkRuleSet
routingPreference	Maintains information about the network routing choice opted by the user for data transfer	RoutingPreference
sasPolicy	SasPolicy assigned to the storage account.	SasPolicy
supportsHttpsTrafficOnly	Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01.	bool

AzureFilesIdentityBasedAuthentication

Name	Description	Value
activeDirectoryProperties	Required if choose AD.	ActiveDirectoryProperties
defaultSharePermission	Default share permission for users using Kerberos authentication if RBAC role is not assigned.	'None' 'StorageFileDataSmbShareContributor' 'StorageFileDataSmbShareElevatedContributor' 'StorageFileDataSmbShareOwner' 'StorageFileDataSmbShareReader'
directoryServiceOptions	Indicates the directory service used.	'AADDS' 'AD' 'None' (required)

ActiveDirectoryProperties

Name	Description	Value
azureStorageSid	Specifies the security identifier (SID) for Azure Storage.	string (required)
domainGuid	Specifies the domain GUID.	string (required)
domainName	Specifies the primary domain that the AD DNS server is authoritative for.	string (required)
domainSid	Specifies the security identifier (SID).	string (required)
forestName	Specifies the Active Directory forest to get.	string (required)
netBiosDomainName	Specifies the NetBIOS domain name.	string (required)

CustomDomain

Name	Description	Value
name	Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source.	string (required)
useSubDomainName	Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates.	bool

Encryption

Name	Description	Value
identity	The identity to be used with service-side encryption at rest.	EncryptionIdentity
keySource	The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault	'Microsoft.Keyvault' 'Microsoft.Storage' (required)
keyvaultproperties	Properties provided by key vault.	KeyVaultProperties
requireInfrastructureEncryption	A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest.	bool
services	List of services which support encryption.	EncryptionServices

EncryptionIdentity

Name	Description	Value
userAssignedIdentity	Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account.	string

KeyVaultProperties

Name	Description	Value
keyname	The name of KeyVault key.	string
keyvaulturi	The Uri of KeyVault.	string
keyversion	The version of KeyVault key.	string

EncryptionServices

Name	Description	Value
blob	The encryption function of the blob storage service.	EncryptionService
file	The encryption function of the file storage service.	EncryptionService
queue	The encryption function of the queue storage service.	EncryptionService
table	The encryption function of the table storage service.	EncryptionService

EncryptionService

Name	Description	Value
enabled	A boolean indicating whether or not the service encrypts the data as it is stored.	bool
keyType	Encryption key type to be used for the encryption service. 'Account' key type implies that an account-scoped encryption key will be used. 'Service' key type implies that a default service key is used.	'Account' 'Service'

KeyPolicy

Name	Description	Value
keyExpirationPeriodInDays	The key expiration period in days.	int (required)

NetworkRuleSet

Name	Description	Value
bypass	Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging,Metrics,AzureServices (For example, "Logging, Metrics"), or None to bypass none of those traffics.	'AzureServices' 'Logging' 'Metrics' 'None'
defaultAction	Specifies the default action of allow or deny when no other rules match.	'Allow' 'Deny' (required)
ipRules	Sets the IP ACL rules	IPRule[]
resourceAccessRules	Sets the resource access rules	ResourceAccessRule[]
virtualNetworkRules	Sets the virtual network rules	VirtualNetworkRule[]

IPRule

Name	Description	Value
action	The action of IP ACL rule.	'Allow'
value	Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.	string (required)

ResourceAccessRule

Name	Description	Value
resourceId	Resource Id	string
tenantId	Tenant Id	string

VirtualNetworkRule

Name	Description	Value
action	The action of virtual network rule.	'Allow'
id	Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.	string (required)
state	Gets the state of virtual network rule.	'Deprovisioning' 'Failed' 'NetworkSourceDeleted' 'Provisioning' 'Succeeded'

RoutingPreference

Name	Description	Value
publishInternetEndpoints	A boolean flag which indicates whether internet routing storage endpoints are to be published	bool
publishMicrosoftEndpoints	A boolean flag which indicates whether microsoft routing storage endpoints are to be published	bool
routingChoice	Routing Choice defines the kind of network routing opted by the user.	'InternetRouting' 'MicrosoftRouting'

SasPolicy

Name	Description	Value
expirationAction	The SAS expiration action. Can only be Log.	'Log' (required)
sasExpirationPeriod	The SAS expiration period, DD.HH:MM:SS.	string (required)

Sku

Name	Description	Value
name	The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.	'Premium_LRS' 'Premium_ZRS' 'Standard_GRS' 'Standard_GZRS' 'Standard_LRS' 'Standard_RAGRS' 'Standard_RAGZRS' 'Standard_ZRS' (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Connect to a storage account from a VM via private endpoint	This sample shows how to use connect a virtual network to access a blob storage account via private endpoint.
Connect to an Azure File Share via a Private Endpoint	This sample shows how to use configure a virtual network and private DNS zone to access an Azure File Share via a private endpoint.
Create a Standard Storage Account	This template creates a Standard Storage Account
Create a Storage Account with SSE	This template creates a Storage Account with Storage Service Encryption for Data at Rest
Storage account with Advanced Threat Protection	This template allows you to deploy an Azure Storage account with Advanced Threat Protection enabled.
Create an Azure Storage Account and Blob Container on Azure	This template creates an Azure Storage account and a blob container.
Storage Account with SSE and blob deletion retention policy	This template creates a Storage Account with Storage Service Encryption and a blob deletion retention policy
Azure Storage Account Encryption with customer-managed key	This template deploys a Storage Account with a customer-managed key for encryption that's generated and placed inside a Key Vault.
Create a storage account with file share	This template creates an Azure storage account and file share.
Create a storage account with multiple Blob containers	Creates an Azure storage account and multiple blob containers.
Create a storage account with multiple file shares	Creates an Azure storage account and multiple file shares.
Create Storage Account with SFTP enabled	Creates an Azure Storage account and a blob container that can be accessed using SFTP protocol. Access can be password or public-key based.
Deploys a static website	Deploys a static website with a backing storage account

ARM template resource definition

The storageAccounts resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Storage/storageAccounts resource, add the following JSON to your template.

{
  "type": "Microsoft.Storage/storageAccounts",
  "apiVersion": "2021-04-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "kind": "string",
  "extendedLocation": {
    "name": "string",
    "type": "EdgeZone"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "accessTier": "string",
    "allowBlobPublicAccess": "bool",
    "allowCrossTenantReplication": "bool",
    "allowSharedKeyAccess": "bool",
    "azureFilesIdentityBasedAuthentication": {
      "activeDirectoryProperties": {
        "azureStorageSid": "string",
        "domainGuid": "string",
        "domainName": "string",
        "domainSid": "string",
        "forestName": "string",
        "netBiosDomainName": "string"
      },
      "defaultSharePermission": "string",
      "directoryServiceOptions": "string"
    },
    "customDomain": {
      "name": "string",
      "useSubDomainName": "bool"
    },
    "encryption": {
      "identity": {
        "userAssignedIdentity": "string"
      },
      "keySource": "string",
      "keyvaultproperties": {
        "keyname": "string",
        "keyvaulturi": "string",
        "keyversion": "string"
      },
      "requireInfrastructureEncryption": "bool",
      "services": {
        "blob": {
          "enabled": "bool",
          "keyType": "string"
        },
        "file": {
          "enabled": "bool",
          "keyType": "string"
        },
        "queue": {
          "enabled": "bool",
          "keyType": "string"
        },
        "table": {
          "enabled": "bool",
          "keyType": "string"
        }
      }
    },
    "isHnsEnabled": "bool",
    "isNfsV3Enabled": "bool",
    "keyPolicy": {
      "keyExpirationPeriodInDays": "int"
    },
    "largeFileSharesState": "string",
    "minimumTlsVersion": "string",
    "networkAcls": {
      "bypass": "string",
      "defaultAction": "string",
      "ipRules": [
        {
          "action": "Allow",
          "value": "string"
        }
      ],
      "resourceAccessRules": [
        {
          "resourceId": "string",
          "tenantId": "string"
        }
      ],
      "virtualNetworkRules": [
        {
          "action": "Allow",
          "id": "string",
          "state": "string"
        }
      ]
    },
    "routingPreference": {
      "publishInternetEndpoints": "bool",
      "publishMicrosoftEndpoints": "bool",
      "routingChoice": "string"
    },
    "sasPolicy": {
      "expirationAction": "Log",
      "sasExpirationPeriod": "string"
    },
    "supportsHttpsTrafficOnly": "bool"
  }
}

Property values

storageAccounts

Name	Description	Value
type	The resource type	'Microsoft.Storage/storageAccounts'
apiVersion	The resource api version	'2021-04-01'
name	The resource name	string (required) Character limit: 3-24 Valid characters: Lowercase letters and numbers. Resource name must be unique across Azure.
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.	string (required)
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.	Dictionary of tag names and values. See Tags in templates
sku	Required. Gets or sets the SKU name.	Sku (required)
kind	Required. Indicates the type of storage account.	'BlobStorage' 'BlockBlobStorage' 'FileStorage' 'Storage' 'StorageV2' (required)
extendedLocation	Optional. Set the extended location of the resource. If not set, the storage account will be created in Azure main region. Otherwise it will be created in the specified extended location	ExtendedLocation
identity	The identity of the resource.	Identity
properties	The parameters used to create the storage account.	StorageAccountPropertiesCreateParametersOrStorageAcc...

ExtendedLocation

Name	Description	Value
name	The name of the extended location.	string
type	The type of the extended location.	'EdgeZone'

Identity

Name	Description	Value
type	The identity type.	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage account. The key is the ARM resource identifier of the identity. Only 1 User Assigned identity is permitted here.	IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

Name	Description	Value
{customized property}		UserAssignedIdentity

UserAssignedIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

StorageAccountPropertiesCreateParametersOrStorageAcc...

Name	Description	Value
accessTier	Required for storage accounts where kind = BlobStorage. The access tier used for billing.	'Cool' 'Hot'
allowBlobPublicAccess	Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property.	bool
allowCrossTenantReplication	Allow or disallow cross AAD tenant object replication. The default interpretation is true for this property.	bool
allowSharedKeyAccess	Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true.	bool
azureFilesIdentityBasedAuthentication	Provides the identity based authentication settings for Azure Files.	AzureFilesIdentityBasedAuthentication
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.	CustomDomain
encryption	Not applicable. Azure Storage encryption is enabled for all storage accounts and cannot be disabled.	Encryption
isHnsEnabled	Account HierarchicalNamespace enabled if sets to true.	bool
isNfsV3Enabled	NFS 3.0 protocol support enabled if set to true.	bool
keyPolicy	KeyPolicy assigned to the storage account.	KeyPolicy
largeFileSharesState	Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled.	'Disabled' 'Enabled'
minimumTlsVersion	Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property.	'TLS1_0' 'TLS1_1' 'TLS1_2'
networkAcls	Network rule set	NetworkRuleSet
routingPreference	Maintains information about the network routing choice opted by the user for data transfer	RoutingPreference
sasPolicy	SasPolicy assigned to the storage account.	SasPolicy
supportsHttpsTrafficOnly	Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01.	bool

AzureFilesIdentityBasedAuthentication

Name	Description	Value
activeDirectoryProperties	Required if choose AD.	ActiveDirectoryProperties
defaultSharePermission	Default share permission for users using Kerberos authentication if RBAC role is not assigned.	'None' 'StorageFileDataSmbShareContributor' 'StorageFileDataSmbShareElevatedContributor' 'StorageFileDataSmbShareOwner' 'StorageFileDataSmbShareReader'
directoryServiceOptions	Indicates the directory service used.	'AADDS' 'AD' 'None' (required)

ActiveDirectoryProperties

Name	Description	Value
azureStorageSid	Specifies the security identifier (SID) for Azure Storage.	string (required)
domainGuid	Specifies the domain GUID.	string (required)
domainName	Specifies the primary domain that the AD DNS server is authoritative for.	string (required)
domainSid	Specifies the security identifier (SID).	string (required)
forestName	Specifies the Active Directory forest to get.	string (required)
netBiosDomainName	Specifies the NetBIOS domain name.	string (required)

CustomDomain

Name	Description	Value
name	Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source.	string (required)
useSubDomainName	Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates.	bool

Encryption

Name	Description	Value
identity	The identity to be used with service-side encryption at rest.	EncryptionIdentity
keySource	The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault	'Microsoft.Keyvault' 'Microsoft.Storage' (required)
keyvaultproperties	Properties provided by key vault.	KeyVaultProperties
requireInfrastructureEncryption	A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest.	bool
services	List of services which support encryption.	EncryptionServices

EncryptionIdentity

Name	Description	Value
userAssignedIdentity	Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account.	string

KeyVaultProperties

Name	Description	Value
keyname	The name of KeyVault key.	string
keyvaulturi	The Uri of KeyVault.	string
keyversion	The version of KeyVault key.	string

EncryptionServices

Name	Description	Value
blob	The encryption function of the blob storage service.	EncryptionService
file	The encryption function of the file storage service.	EncryptionService
queue	The encryption function of the queue storage service.	EncryptionService
table	The encryption function of the table storage service.	EncryptionService

EncryptionService

Name	Description	Value
enabled	A boolean indicating whether or not the service encrypts the data as it is stored.	bool
keyType	Encryption key type to be used for the encryption service. 'Account' key type implies that an account-scoped encryption key will be used. 'Service' key type implies that a default service key is used.	'Account' 'Service'

KeyPolicy

Name	Description	Value
keyExpirationPeriodInDays	The key expiration period in days.	int (required)

NetworkRuleSet

Name	Description	Value
bypass	Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging,Metrics,AzureServices (For example, "Logging, Metrics"), or None to bypass none of those traffics.	'AzureServices' 'Logging' 'Metrics' 'None'
defaultAction	Specifies the default action of allow or deny when no other rules match.	'Allow' 'Deny' (required)
ipRules	Sets the IP ACL rules	IPRule[]
resourceAccessRules	Sets the resource access rules	ResourceAccessRule[]
virtualNetworkRules	Sets the virtual network rules	VirtualNetworkRule[]

IPRule

Name	Description	Value
action	The action of IP ACL rule.	'Allow'
value	Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.	string (required)

ResourceAccessRule

Name	Description	Value
resourceId	Resource Id	string
tenantId	Tenant Id	string

VirtualNetworkRule

Name	Description	Value
action	The action of virtual network rule.	'Allow'
id	Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.	string (required)
state	Gets the state of virtual network rule.	'Deprovisioning' 'Failed' 'NetworkSourceDeleted' 'Provisioning' 'Succeeded'

RoutingPreference

Name	Description	Value
publishInternetEndpoints	A boolean flag which indicates whether internet routing storage endpoints are to be published	bool
publishMicrosoftEndpoints	A boolean flag which indicates whether microsoft routing storage endpoints are to be published	bool
routingChoice	Routing Choice defines the kind of network routing opted by the user.	'InternetRouting' 'MicrosoftRouting'

SasPolicy

Name	Description	Value
expirationAction	The SAS expiration action. Can only be Log.	'Log' (required)
sasExpirationPeriod	The SAS expiration period, DD.HH:MM:SS.	string (required)

Sku

Name	Description	Value
name	The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.	'Premium_LRS' 'Premium_ZRS' 'Standard_GRS' 'Standard_GZRS' 'Standard_LRS' 'Standard_RAGRS' 'Standard_RAGZRS' 'Standard_ZRS' (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Connect to a storage account from a VM via private endpoint	This sample shows how to use connect a virtual network to access a blob storage account via private endpoint.
Connect to an Azure File Share via a Private Endpoint	This sample shows how to use configure a virtual network and private DNS zone to access an Azure File Share via a private endpoint.
Create a Standard Storage Account	This template creates a Standard Storage Account
Create a Storage Account with SSE	This template creates a Storage Account with Storage Service Encryption for Data at Rest
Storage account with Advanced Threat Protection	This template allows you to deploy an Azure Storage account with Advanced Threat Protection enabled.
Create an Azure Storage Account and Blob Container on Azure	This template creates an Azure Storage account and a blob container.
Storage Account with SSE and blob deletion retention policy	This template creates a Storage Account with Storage Service Encryption and a blob deletion retention policy
Azure Storage Account Encryption with customer-managed key	This template deploys a Storage Account with a customer-managed key for encryption that's generated and placed inside a Key Vault.
Create a storage account with file share	This template creates an Azure storage account and file share.
Create a storage account with multiple Blob containers	Creates an Azure storage account and multiple blob containers.
Create a storage account with multiple file shares	Creates an Azure storage account and multiple file shares.
Create Storage Account with SFTP enabled	Creates an Azure Storage account and a blob container that can be accessed using SFTP protocol. Access can be password or public-key based.
Deploys a static website	Deploys a static website with a backing storage account

Terraform (AzAPI provider) resource definition

The storageAccounts resource type can be deployed with operations that target:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Storage/storageAccounts resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Storage/storageAccounts@2021-04-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      accessTier = "string"
      allowBlobPublicAccess = bool
      allowCrossTenantReplication = bool
      allowSharedKeyAccess = bool
      azureFilesIdentityBasedAuthentication = {
        activeDirectoryProperties = {
          azureStorageSid = "string"
          domainGuid = "string"
          domainName = "string"
          domainSid = "string"
          forestName = "string"
          netBiosDomainName = "string"
        }
        defaultSharePermission = "string"
        directoryServiceOptions = "string"
      }
      customDomain = {
        name = "string"
        useSubDomainName = bool
      }
      encryption = {
        identity = {
          userAssignedIdentity = "string"
        }
        keySource = "string"
        keyvaultproperties = {
          keyname = "string"
          keyvaulturi = "string"
          keyversion = "string"
        }
        requireInfrastructureEncryption = bool
        services = {
          blob = {
            enabled = bool
            keyType = "string"
          }
          file = {
            enabled = bool
            keyType = "string"
          }
          queue = {
            enabled = bool
            keyType = "string"
          }
          table = {
            enabled = bool
            keyType = "string"
          }
        }
      }
      isHnsEnabled = bool
      isNfsV3Enabled = bool
      keyPolicy = {
        keyExpirationPeriodInDays = int
      }
      largeFileSharesState = "string"
      minimumTlsVersion = "string"
      networkAcls = {
        bypass = "string"
        defaultAction = "string"
        ipRules = [
          {
            action = "Allow"
            value = "string"
          }
        ]
        resourceAccessRules = [
          {
            resourceId = "string"
            tenantId = "string"
          }
        ]
        virtualNetworkRules = [
          {
            action = "Allow"
            id = "string"
            state = "string"
          }
        ]
      }
      routingPreference = {
        publishInternetEndpoints = bool
        publishMicrosoftEndpoints = bool
        routingChoice = "string"
      }
      sasPolicy = {
        expirationAction = "Log"
        sasExpirationPeriod = "string"
      }
      supportsHttpsTrafficOnly = bool
    }
    sku = {
      name = "string"
    }
    kind = "string"
    extendedLocation = {
      name = "string"
      type = "EdgeZone"
    }
  })
}

Property values

storageAccounts

Name	Description	Value
type	The resource type	"Microsoft.Storage/storageAccounts@2021-04-01"
name	The resource name	string (required) Character limit: 3-24 Valid characters: Lowercase letters and numbers. Resource name must be unique across Azure.
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.	string (required)
parent_id	To deploy to a resource group, use the ID of that resource group.	string (required)
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.	Dictionary of tag names and values.
sku	Required. Gets or sets the SKU name.	Sku (required)
kind	Required. Indicates the type of storage account.	"BlobStorage" "BlockBlobStorage" "FileStorage" "Storage" "StorageV2" (required)
extendedLocation	Optional. Set the extended location of the resource. If not set, the storage account will be created in Azure main region. Otherwise it will be created in the specified extended location	ExtendedLocation
identity	The identity of the resource.	Identity
properties	The parameters used to create the storage account.	StorageAccountPropertiesCreateParametersOrStorageAcc...

ExtendedLocation

Name	Description	Value
name	The name of the extended location.	string
type	The type of the extended location.	"EdgeZone"

Identity

Name	Description	Value
type	The identity type.	"SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" (required)
identity_ids	Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage account. The key is the ARM resource identifier of the identity. Only 1 User Assigned identity is permitted here.	Array of user identity IDs.

IdentityUserAssignedIdentities

Name	Description	Value
{customized property}		UserAssignedIdentity

UserAssignedIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

StorageAccountPropertiesCreateParametersOrStorageAcc...

Name	Description	Value
accessTier	Required for storage accounts where kind = BlobStorage. The access tier used for billing.	"Cool" "Hot"
allowBlobPublicAccess	Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property.	bool
allowCrossTenantReplication	Allow or disallow cross AAD tenant object replication. The default interpretation is true for this property.	bool
allowSharedKeyAccess	Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true.	bool
azureFilesIdentityBasedAuthentication	Provides the identity based authentication settings for Azure Files.	AzureFilesIdentityBasedAuthentication
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.	CustomDomain
encryption	Not applicable. Azure Storage encryption is enabled for all storage accounts and cannot be disabled.	Encryption
isHnsEnabled	Account HierarchicalNamespace enabled if sets to true.	bool
isNfsV3Enabled	NFS 3.0 protocol support enabled if set to true.	bool
keyPolicy	KeyPolicy assigned to the storage account.	KeyPolicy
largeFileSharesState	Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled.	"Disabled" "Enabled"
minimumTlsVersion	Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property.	"TLS1_0" "TLS1_1" "TLS1_2"
networkAcls	Network rule set	NetworkRuleSet
routingPreference	Maintains information about the network routing choice opted by the user for data transfer	RoutingPreference
sasPolicy	SasPolicy assigned to the storage account.	SasPolicy
supportsHttpsTrafficOnly	Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01.	bool

AzureFilesIdentityBasedAuthentication

Name	Description	Value
activeDirectoryProperties	Required if choose AD.	ActiveDirectoryProperties
defaultSharePermission	Default share permission for users using Kerberos authentication if RBAC role is not assigned.	"None" "StorageFileDataSmbShareContributor" "StorageFileDataSmbShareElevatedContributor" "StorageFileDataSmbShareOwner" "StorageFileDataSmbShareReader"
directoryServiceOptions	Indicates the directory service used.	"AADDS" "AD" "None" (required)

ActiveDirectoryProperties

Name	Description	Value
azureStorageSid	Specifies the security identifier (SID) for Azure Storage.	string (required)
domainGuid	Specifies the domain GUID.	string (required)
domainName	Specifies the primary domain that the AD DNS server is authoritative for.	string (required)
domainSid	Specifies the security identifier (SID).	string (required)
forestName	Specifies the Active Directory forest to get.	string (required)
netBiosDomainName	Specifies the NetBIOS domain name.	string (required)

CustomDomain

Name	Description	Value
name	Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source.	string (required)
useSubDomainName	Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates.	bool

Encryption

Name	Description	Value
identity	The identity to be used with service-side encryption at rest.	EncryptionIdentity
keySource	The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault	"Microsoft.Keyvault" "Microsoft.Storage" (required)
keyvaultproperties	Properties provided by key vault.	KeyVaultProperties
requireInfrastructureEncryption	A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest.	bool
services	List of services which support encryption.	EncryptionServices

EncryptionIdentity

Name	Description	Value
userAssignedIdentity	Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account.	string

KeyVaultProperties

Name	Description	Value
keyname	The name of KeyVault key.	string
keyvaulturi	The Uri of KeyVault.	string
keyversion	The version of KeyVault key.	string

EncryptionServices

Name	Description	Value
blob	The encryption function of the blob storage service.	EncryptionService
file	The encryption function of the file storage service.	EncryptionService
queue	The encryption function of the queue storage service.	EncryptionService
table	The encryption function of the table storage service.	EncryptionService

EncryptionService

Name	Description	Value
enabled	A boolean indicating whether or not the service encrypts the data as it is stored.	bool
keyType	Encryption key type to be used for the encryption service. 'Account' key type implies that an account-scoped encryption key will be used. 'Service' key type implies that a default service key is used.	"Account" "Service"

KeyPolicy

Name	Description	Value
keyExpirationPeriodInDays	The key expiration period in days.	int (required)

NetworkRuleSet

Name	Description	Value
bypass	Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging,Metrics,AzureServices (For example, "Logging, Metrics"), or None to bypass none of those traffics.	"AzureServices" "Logging" "Metrics" "None"
defaultAction	Specifies the default action of allow or deny when no other rules match.	"Allow" "Deny" (required)
ipRules	Sets the IP ACL rules	IPRule[]
resourceAccessRules	Sets the resource access rules	ResourceAccessRule[]
virtualNetworkRules	Sets the virtual network rules	VirtualNetworkRule[]

IPRule

Name	Description	Value
action	The action of IP ACL rule.	"Allow"
value	Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.	string (required)

ResourceAccessRule

Name	Description	Value
resourceId	Resource Id	string
tenantId	Tenant Id	string

VirtualNetworkRule

Name	Description	Value
action	The action of virtual network rule.	"Allow"
id	Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.	string (required)
state	Gets the state of virtual network rule.	"Deprovisioning" "Failed" "NetworkSourceDeleted" "Provisioning" "Succeeded"

RoutingPreference

Name	Description	Value
publishInternetEndpoints	A boolean flag which indicates whether internet routing storage endpoints are to be published	bool
publishMicrosoftEndpoints	A boolean flag which indicates whether microsoft routing storage endpoints are to be published	bool
routingChoice	Routing Choice defines the kind of network routing opted by the user.	"InternetRouting" "MicrosoftRouting"

SasPolicy

Name	Description	Value
expirationAction	The SAS expiration action. Can only be Log.	"Log" (required)
sasExpirationPeriod	The SAS expiration period, DD.HH:MM:SS.	string (required)

Sku

Name	Description	Value
name	The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.	"Premium_LRS" "Premium_ZRS" "Standard_GRS" "Standard_GZRS" "Standard_LRS" "Standard_RAGRS" "Standard_RAGZRS" "Standard_ZRS" (required)

Share via

Microsoft.Storage storageAccounts 2021-04-01

Bicep resource definition

Resource format

Property values

storageAccounts

ExtendedLocation

Identity

IdentityUserAssignedIdentities

UserAssignedIdentity

StorageAccountPropertiesCreateParametersOrStorageAcc...

AzureFilesIdentityBasedAuthentication

ActiveDirectoryProperties

CustomDomain

Encryption

EncryptionIdentity

KeyVaultProperties

EncryptionServices

EncryptionService

KeyPolicy

NetworkRuleSet

IPRule

ResourceAccessRule

VirtualNetworkRule

RoutingPreference

SasPolicy

Sku

Quickstart templates

ARM template resource definition

Resource format

Property values

storageAccounts

ExtendedLocation

Identity

IdentityUserAssignedIdentities

UserAssignedIdentity

StorageAccountPropertiesCreateParametersOrStorageAcc...

AzureFilesIdentityBasedAuthentication

ActiveDirectoryProperties

CustomDomain

Encryption

EncryptionIdentity

KeyVaultProperties

EncryptionServices

EncryptionService

KeyPolicy

NetworkRuleSet

IPRule

ResourceAccessRule

VirtualNetworkRule

RoutingPreference

SasPolicy

Sku

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

storageAccounts

ExtendedLocation

Identity

IdentityUserAssignedIdentities

UserAssignedIdentity

StorageAccountPropertiesCreateParametersOrStorageAcc...

AzureFilesIdentityBasedAuthentication

ActiveDirectoryProperties

CustomDomain

Encryption

EncryptionIdentity

KeyVaultProperties

EncryptionServices

EncryptionService

KeyPolicy

NetworkRuleSet

IPRule

ResourceAccessRule

VirtualNetworkRule

RoutingPreference

SasPolicy

Sku

Feedback