Microsoft.Storage (stable:2025-01-01)

2025/08/04 • 7 updated methods

StorageAccounts_Create (updated)
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.
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageAccounts_Create",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "networkAcls": [
              {
                "ipRules": {
                  "$properties": [
                    {
                      "#name": "value",
                      "Description": {
                        "new": "Specifies the IP or IP range in CIDR format.",
                        "old": "Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed."
                      }
                    }
                  ]
                }
              },
              {
                "@added_37ffb16739bc4b04a6914b2cf042d8f1": {
                  "#name": "ipv6Rules",
                  "Description": "Sets the IPv6 ACL rules.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Description": "IPv6 rule with specific IP or IP range in CIDR format.",
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "value",
                        "Description": "Specifies the IP or IP range in CIDR format.",
                        "Required": true,
                        "Type": "string"
                      },
                      {
                        "#name": "action",
                        "Description": "The action of IP ACL rule.",
                        "Enum": [
                          [
                            "Allow",
                            ""
                          ]
                        ],
                        "Required": false,
                        "Type": "string"
                      }
                    ]
                  }
                }
              }
            ]
          },
          {
            "@added_31749047ee204ee49e4680acf9474960": {
              "#name": "dualStackEndpointPreference",
              "Description": "Maintains information about the Internet protocol opted by the user.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "publishIpv6Endpoint",
                  "Description": "A boolean flag which indicates whether IPv6 storage endpoints are to be published.",
                  "Required": false,
                  "Type": "boolean"
                }
              ]
            }
          },
          {
            "@removed_632cdc94702e4958943b468694e185be": {
              "#name": "deletedAccountCreationTime",
              "Description": "Creation time of the deleted account. This property should only be provided while requesting deleted storage account recovery.",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "primaryEndpoints": [
              {
                "@added_eacb0037163a448cadc2b53d8869969f": {
                  "#name": "ipv6Endpoints",
                  "Description": "Gets the IPv6 storage endpoints.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "blob",
                      "Description": "Gets the blob endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "queue",
                      "Description": "Gets the queue endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "table",
                      "Description": "Gets the table endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "file",
                      "Description": "Gets the file endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "web",
                      "Description": "Gets the web endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "dfs",
                      "Description": "Gets the dfs endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "microsoftEndpoints",
                      "Description": "Gets the microsoft routing storage endpoints.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "blob",
                          "Description": "Gets the blob endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "queue",
                          "Description": "Gets the queue endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "table",
                          "Description": "Gets the table endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "file",
                          "Description": "Gets the file endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "web",
                          "Description": "Gets the web endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "dfs",
                          "Description": "Gets the dfs endpoint.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    },
                    {
                      "#name": "internetEndpoints",
                      "Description": "Gets the internet routing storage endpoints",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "blob",
                          "Description": "Gets the blob endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "file",
                          "Description": "Gets the file endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "web",
                          "Description": "Gets the web endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "dfs",
                          "Description": "Gets the dfs endpoint.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  ]
                }
              }
            ]
          },
          {
            "secondaryEndpoints": [
              {
                "@added_305f9e3ac15c448593e4423fb6a6c139": {
                  "#name": "ipv6Endpoints",
                  "Description": "Gets the IPv6 storage endpoints.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "blob",
                      "Description": "Gets the blob endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "queue",
                      "Description": "Gets the queue endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "table",
                      "Description": "Gets the table endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "file",
                      "Description": "Gets the file endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "web",
                      "Description": "Gets the web endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "dfs",
                      "Description": "Gets the dfs endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "microsoftEndpoints",
                      "Description": "Gets the microsoft routing storage endpoints.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "blob",
                          "Description": "Gets the blob endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "queue",
                          "Description": "Gets the queue endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "table",
                          "Description": "Gets the table endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "file",
                          "Description": "Gets the file endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "web",
                          "Description": "Gets the web endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "dfs",
                          "Description": "Gets the dfs endpoint.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    },
                    {
                      "#name": "internetEndpoints",
                      "Description": "Gets the internet routing storage endpoints",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "blob",
                          "Description": "Gets the blob endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "file",
                          "Description": "Gets the file endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "web",
                          "Description": "Gets the web endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "dfs",
                          "Description": "Gets the dfs endpoint.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  ]
                }
              }
            ]
          },
          {
            "networkAcls": [
              {
                "ipRules": {
                  "$properties": [
                    {
                      "#name": "value",
                      "Description": {
                        "new": "Specifies the IP or IP range in CIDR format.",
                        "old": "Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed."
                      }
                    }
                  ]
                }
              },
              {
                "@added_0871893f06f949ce9874a0f8de1cdf59": {
                  "#name": "ipv6Rules",
                  "Description": "Sets the IPv6 ACL rules.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Description": "IPv6 rule with specific IP or IP range in CIDR format.",
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "value",
                        "Description": "Specifies the IP or IP range in CIDR format.",
                        "Required": true,
                        "Type": "string"
                      },
                      {
                        "#name": "action",
                        "Description": "The action of IP ACL rule.",
                        "Enum": [
                          [
                            "Allow",
                            ""
                          ]
                        ],
                        "Required": false,
                        "Type": "string"
                      }
                    ]
                  }
                }
              }
            ]
          },
          {
            "@added_bcd3596c39fa4a8f9ffdfc9272302834": {
              "#name": "dualStackEndpointPreference",
              "Description": "Maintains information about the Internet protocol opted by the user.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "publishIpv6Endpoint",
                  "Description": "A boolean flag which indicates whether IPv6 storage endpoints are to be published.",
                  "Required": false,
                  "Type": "boolean"
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
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. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the created account. ,
Required: True ,
}
{
sku:
{
Description: Required. Gets or sets the SKU name. ,
Required: True ,
}
{
name:
{
Description: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Required. Indicates the type of storage account. ,
Enum:
{
Storage: No description available. ,
StorageV2: No description available. ,
BlobStorage: No description available. ,
FileStorage: No description available. ,
BlockBlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
location:
{
Description: 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. ,
Required: True ,
}
string ,
extendedLocation:
{
Description: 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 ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: Optional. Gets or sets the pinned logical availability zone for the storage account. ,
Required: False ,
}
[
string ,
]
,
placement:
{
Description: Optional. Gets or sets the zonal placement details for the storage account. ,
Required: False ,
}
{
zonePlacementPolicy:
{
Description: The availability zone pinning policy for the storage account. ,
Enum:
{
Any: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: 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. ,
Required: False ,
}
object ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The parameters used to create the storage account. ,
Required: False ,
}
{
allowedCopyScope:
{
Description: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. ,
Enum:
{
PrivateLink: No description available. ,
AAD: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. Value is optional but if passed in, must be 'Enabled', 'Disabled' or 'SecuredByPerimeter'. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
sasPolicy:
{
Description: SasPolicy assigned to the storage account. ,
Required: False ,
}
{
sasExpirationPeriod:
{
Description: The SAS expiration period, DD.HH:MM:SS. ,
Required: True ,
}
string ,
expirationAction:
{
Description: The SAS Expiration Action defines the action to be performed when sasPolicy.sasExpirationPeriod is violated. The 'Log' action can be used for audit purposes and the 'Block' action can be used to block and deny the usage of SAS tokens that do not adhere to the sas policy expiration period. ,
Enum:
{
Log: No description available. ,
Block: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
keyPolicy:
{
Description: KeyPolicy assigned to the storage account. ,
Required: False ,
}
{
keyExpirationPeriodInDays:
{
Description: The key expiration period in days. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
customDomain:
{
Description: 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. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. ,
Required: True ,
}
string ,
useSubDomainName:
{
Description: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. ,
Required: False ,
}
boolean ,
}
,
encryption:
{
Description: Encryption settings to be used for server-side encryption for the storage account. ,
Required: False ,
}
{
services:
{
Description: List of services which support encryption. ,
Required: False ,
}
{
blob:
{
Description: The encryption function of the blob storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
file:
{
Description: The encryption function of the file storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
table:
{
Description: The encryption function of the table storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
queue:
{
Description: The encryption function of the queue storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault ,
Enum:
{
Microsoft.Storage: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
boolean ,
keyvaultproperties:
{
Description: Properties provided by key vault. ,
Required: False ,
}
{
keyname:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
currentVersionedKeyExpirationTimestamp:
{
Description: This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity to be used with service-side encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. ,
Required: False ,
}
string ,
federatedIdentityClientId:
{
Description: ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. ,
Required: False ,
}
string ,
}
,
}
,
networkAcls:
{
Description: Network rule set ,
Required: False ,
}
{
bypass:
{
Description: 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. ,
Enum:
{
None: No description available. ,
Logging: No description available. ,
Metrics: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
resourceAccessRules:
{
Description: Sets the resource access rules ,
Required: False ,
}
[
{
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: Sets the virtual network rules ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Gets the state of virtual network rule. ,
Enum:
{
Provisioning: No description available. ,
Deprovisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
NetworkSourceDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipRules:
{
Description: Sets the IP ACL rules ,
Required: False ,
}
[
{
value:
{
Description: Specifies the IP or IP range in CIDR format. ,
Required: True ,
}
string ,
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipv6Rules:
{
Description: Sets the IPv6 ACL rules. ,
Required: False ,
}
[
{
value:
{
Description: Specifies the IP or IP range in CIDR format. ,
Required: True ,
}
string ,
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultAction:
{
Description: Specifies the default action of allow or deny when no other rules match. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
accessTier:
{
Description: Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The 'Premium' access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type. ,
Enum:
{
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
Cold: No description available. ,
}
,
Required: False ,
}
enum ,
azureFilesIdentityBasedAuthentication:
{
Description: Provides the identity based authentication settings for Azure Files. ,
Required: False ,
}
{
directoryServiceOptions:
{
Description: Indicates the directory service used. Note that this enum may be extended in the future. ,
Enum:
{
None: No description available. ,
AADDS: No description available. ,
AD: No description available. ,
AADKERB: No description available. ,
}
,
Required: True ,
}
enum ,
activeDirectoryProperties:
{
Description: Additional information about the directory service. Required if directoryServiceOptions is AD (AD DS authentication). Optional for directoryServiceOptions AADDS (Entra DS authentication) and AADKERB (Entra authentication). ,
Required: False ,
}
{
domainName:
{
Description: Specifies the primary domain that the AD DNS server is authoritative for. This property is required if directoryServiceOptions is set to AD (AD DS authentication). If directoryServiceOptions is set to AADDS (Entra DS authentication), providing this property is optional, as it will be inferred automatically if omitted. If directoryServiceOptions is set to AADKERB (Entra authentication), this property is optional; it is needed to support configuration of directory- and file-level permissions via Windows File Explorer, but is not required for authentication. ,
Required: False ,
}
string ,
netBiosDomainName:
{
Description: Specifies the NetBIOS domain name. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
forestName:
{
Description: Specifies the Active Directory forest to get. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
domainGuid:
{
Description: Specifies the domain GUID. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. If directoryServiceOptions is set to AADDS (Entra DS authentication), this property can be omitted. If directoryServiceOptions is set to AADKERB (Entra authentication), this property is optional; it is needed to support configuration of directory- and file-level permissions via Windows File Explorer, but is not required for authentication. ,
Required: False ,
}
string ,
domainSid:
{
Description: Specifies the security identifier (SID) of the AD domain. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
azureStorageSid:
{
Description: Specifies the security identifier (SID) for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
samAccountName:
{
Description: Specifies the Active Directory SAMAccountName for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is optional. If provided, accountType should also be provided. For directoryServiceOptions AADDS (Entra DS authentication) or AADKERB (Entra authentication), this property can be omitted. ,
Required: False ,
}
string ,
accountType:
{
Description: Specifies the Active Directory account type for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is optional. If provided, samAccountName should also be provided. For directoryServiceOptions AADDS (Entra DS authentication) or AADKERB (Entra authentication), this property can be omitted. ,
Enum:
{
User: No description available. ,
Computer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
defaultSharePermission:
{
Description: Default share permission for users using Kerberos authentication if RBAC role is not assigned. ,
Enum:
{
None: No description available. ,
StorageFileDataSmbShareReader: No description available. ,
StorageFileDataSmbShareContributor: No description available. ,
StorageFileDataSmbShareElevatedContributor: No description available. ,
}
,
Required: False ,
}
enum ,
smbOAuthSettings:
{
Description: Required for Managed Identities access using OAuth over SMB. ,
Required: False ,
}
{
isSmbOAuthEnabled:
{
Description: Specifies if managed identities can access SMB shares using OAuth. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
}
,
}
,
supportsHttpsTrafficOnly:
{
Description: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01. ,
Required: False ,
}
boolean ,
isSftpEnabled:
{
Description: Enables Secure File Transfer Protocol, if set to true ,
Required: False ,
}
boolean ,
isLocalUserEnabled:
{
Description: Enables local users feature, if set to true ,
Required: False ,
}
boolean ,
enableExtendedGroups:
{
Description: Enables extended group support with local users feature, if set to true ,
Required: False ,
}
boolean ,
isHnsEnabled:
{
Description: Account HierarchicalNamespace enabled if sets to true. ,
Required: False ,
}
boolean ,
largeFileSharesState:
{
Description: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
routingPreference:
{
Description: Maintains information about the network routing choice opted by the user for data transfer ,
Required: False ,
}
{
routingChoice:
{
Description: Routing Choice defines the kind of network routing opted by the user. ,
Enum:
{
MicrosoftRouting: No description available. ,
InternetRouting: No description available. ,
}
,
Required: False ,
}
enum ,
publishMicrosoftEndpoints:
{
Description: A boolean flag which indicates whether microsoft routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
publishInternetEndpoints:
{
Description: A boolean flag which indicates whether internet routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
}
,
dualStackEndpointPreference:
{
Description: Maintains information about the Internet protocol opted by the user. ,
Required: False ,
}
{
publishIpv6Endpoint:
{
Description: A boolean flag which indicates whether IPv6 storage endpoints are to be published. ,
Required: False ,
}
boolean ,
}
,
allowBlobPublicAccess:
{
Description: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
minimumTlsVersion:
{
Description: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. ,
Enum:
{
TLS1_0: No description available. ,
TLS1_1: No description available. ,
TLS1_2: No description available. ,
TLS1_3: No description available. ,
}
,
Required: False ,
}
enum ,
allowSharedKeyAccess:
{
Description: 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. ,
Required: False ,
}
boolean ,
isNfsV3Enabled:
{
Description: NFS 3.0 protocol support enabled if set to true. ,
Required: False ,
}
boolean ,
allowCrossTenantReplication:
{
Description: Allow or disallow cross AAD tenant object replication. Set this property to true for new or existing accounts only if object replication policies will involve storage accounts in different AAD tenants. The default interpretation is false for new accounts to follow best security practices by default. ,
Required: False ,
}
boolean ,
defaultToOAuthAuthentication:
{
Description: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
immutableStorageWithVersioning:
{
Description: The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the new containers in the account by default. ,
Required: False ,
}
{
enabled:
{
Description: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. ,
Required: False ,
}
boolean ,
immutabilityPolicy:
{
Description: Specifies the default account-level immutability policy which is inherited and applied to objects that do not possess an explicit immutability policy at the object level. The object-level immutability policy has higher precedence than the container-level immutability policy, which has a higher precedence than the account-level immutability policy. ,
Required: False ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. ,
Enum:
{
Unlocked: No description available. ,
Locked: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: This property can only be changed for disabled and unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
}
,
}
,
dnsEndpointType:
{
Description: Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. ,
Enum:
{
Standard: No description available. ,
AzureDnsZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Gets the SKU. ,
Required: False ,
}
{
name:
{
Description: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Gets the Kind. ,
Enum:
{
Storage: No description available. ,
StorageV2: No description available. ,
BlobStorage: No description available. ,
FileStorage: No description available. ,
BlockBlobStorage: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: Optional. Gets or sets the pinned logical availability zone for the storage account. ,
Required: False ,
}
[
string ,
]
,
placement:
{
Description: Optional. Gets or sets the zonal placement details for the storage account. ,
Required: False ,
}
{
zonePlacementPolicy:
{
Description: The availability zone pinning policy for the storage account. ,
Enum:
{
Any: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the storage account. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the storage account at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
ResolvingDNS: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEndpoints:
{
Description: 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. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
ipv6Endpoints:
{
Description: Gets the IPv6 storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
primaryLocation:
{
Description: Gets the location of the primary data center for the storage account. ,
Required: False ,
}
string ,
statusOfPrimary:
{
Description: Gets the status indicating whether the primary location of the storage account is available or unavailable. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
lastGeoFailoverTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
secondaryLocation:
{
Description: Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. ,
Required: False ,
}
string ,
statusOfSecondary:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Gets the creation date and time of the storage account in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
customDomain:
{
Description: Gets the custom domain the user assigned to this storage account. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. ,
Required: True ,
}
string ,
useSubDomainName:
{
Description: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. ,
Required: False ,
}
boolean ,
}
,
sasPolicy:
{
Description: SasPolicy assigned to the storage account. ,
Required: False ,
}
{
sasExpirationPeriod:
{
Description: The SAS expiration period, DD.HH:MM:SS. ,
Required: True ,
}
string ,
expirationAction:
{
Description: The SAS Expiration Action defines the action to be performed when sasPolicy.sasExpirationPeriod is violated. The 'Log' action can be used for audit purposes and the 'Block' action can be used to block and deny the usage of SAS tokens that do not adhere to the sas policy expiration period. ,
Enum:
{
Log: No description available. ,
Block: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
keyPolicy:
{
Description: KeyPolicy assigned to the storage account. ,
Required: False ,
}
{
keyExpirationPeriodInDays:
{
Description: The key expiration period in days. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
keyCreationTime:
{
Description: Storage account keys creation time. ,
Required: False ,
}
{
key1:
{
Format: date-time ,
Required: False ,
}
string ,
key2:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryEndpoints:
{
Description: 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. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
ipv6Endpoints:
{
Description: Gets the IPv6 storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
encryption:
{
Description: Encryption settings to be used for server-side encryption for the storage account. ,
Required: False ,
}
{
services:
{
Description: List of services which support encryption. ,
Required: False ,
}
{
blob:
{
Description: The encryption function of the blob storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
file:
{
Description: The encryption function of the file storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
table:
{
Description: The encryption function of the table storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
queue:
{
Description: The encryption function of the queue storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault ,
Enum:
{
Microsoft.Storage: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
boolean ,
keyvaultproperties:
{
Description: Properties provided by key vault. ,
Required: False ,
}
{
keyname:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
currentVersionedKeyExpirationTimestamp:
{
Description: This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity to be used with service-side encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. ,
Required: False ,
}
string ,
federatedIdentityClientId:
{
Description: ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. ,
Required: False ,
}
string ,
}
,
}
,
accessTier:
{
Description: Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The 'Premium' access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type. ,
Enum:
{
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
Cold: No description available. ,
}
,
Required: False ,
}
enum ,
azureFilesIdentityBasedAuthentication:
{
Description: Provides the identity based authentication settings for Azure Files. ,
Required: False ,
}
{
directoryServiceOptions:
{
Description: Indicates the directory service used. Note that this enum may be extended in the future. ,
Enum:
{
None: No description available. ,
AADDS: No description available. ,
AD: No description available. ,
AADKERB: No description available. ,
}
,
Required: True ,
}
enum ,
activeDirectoryProperties:
{
Description: Additional information about the directory service. Required if directoryServiceOptions is AD (AD DS authentication). Optional for directoryServiceOptions AADDS (Entra DS authentication) and AADKERB (Entra authentication). ,
Required: False ,
}
{
domainName:
{
Description: Specifies the primary domain that the AD DNS server is authoritative for. This property is required if directoryServiceOptions is set to AD (AD DS authentication). If directoryServiceOptions is set to AADDS (Entra DS authentication), providing this property is optional, as it will be inferred automatically if omitted. If directoryServiceOptions is set to AADKERB (Entra authentication), this property is optional; it is needed to support configuration of directory- and file-level permissions via Windows File Explorer, but is not required for authentication. ,
Required: False ,
}
string ,
netBiosDomainName:
{
Description: Specifies the NetBIOS domain name. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
forestName:
{
Description: Specifies the Active Directory forest to get. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
domainGuid:
{
Description: Specifies the domain GUID. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. If directoryServiceOptions is set to AADDS (Entra DS authentication), this property can be omitted. If directoryServiceOptions is set to AADKERB (Entra authentication), this property is optional; it is needed to support configuration of directory- and file-level permissions via Windows File Explorer, but is not required for authentication. ,
Required: False ,
}
string ,
domainSid:
{
Description: Specifies the security identifier (SID) of the AD domain. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
azureStorageSid:
{
Description: Specifies the security identifier (SID) for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
samAccountName:
{
Description: Specifies the Active Directory SAMAccountName for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is optional. If provided, accountType should also be provided. For directoryServiceOptions AADDS (Entra DS authentication) or AADKERB (Entra authentication), this property can be omitted. ,
Required: False ,
}
string ,
accountType:
{
Description: Specifies the Active Directory account type for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is optional. If provided, samAccountName should also be provided. For directoryServiceOptions AADDS (Entra DS authentication) or AADKERB (Entra authentication), this property can be omitted. ,
Enum:
{
User: No description available. ,
Computer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
defaultSharePermission:
{
Description: Default share permission for users using Kerberos authentication if RBAC role is not assigned. ,
Enum:
{
None: No description available. ,
StorageFileDataSmbShareReader: No description available. ,
StorageFileDataSmbShareContributor: No description available. ,
StorageFileDataSmbShareElevatedContributor: No description available. ,
}
,
Required: False ,
}
enum ,
smbOAuthSettings:
{
Description: Required for Managed Identities access using OAuth over SMB. ,
Required: False ,
}
{
isSmbOAuthEnabled:
{
Description: Specifies if managed identities can access SMB shares using OAuth. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
}
,
}
,
supportsHttpsTrafficOnly:
{
Description: Allows https traffic only to storage service if sets to true. ,
Required: False ,
}
boolean ,
networkAcls:
{
Description: Network rule set ,
Required: False ,
}
{
bypass:
{
Description: 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. ,
Enum:
{
None: No description available. ,
Logging: No description available. ,
Metrics: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
resourceAccessRules:
{
Description: Sets the resource access rules ,
Required: False ,
}
[
{
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: Sets the virtual network rules ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Gets the state of virtual network rule. ,
Enum:
{
Provisioning: No description available. ,
Deprovisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
NetworkSourceDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipRules:
{
Description: Sets the IP ACL rules ,
Required: False ,
}
[
{
value:
{
Description: Specifies the IP or IP range in CIDR format. ,
Required: True ,
}
string ,
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipv6Rules:
{
Description: Sets the IPv6 ACL rules. ,
Required: False ,
}
[
{
value:
{
Description: Specifies the IP or IP range in CIDR format. ,
Required: True ,
}
string ,
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultAction:
{
Description: Specifies the default action of allow or deny when no other rules match. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
isSftpEnabled:
{
Description: Enables Secure File Transfer Protocol, if set to true ,
Required: False ,
}
boolean ,
isLocalUserEnabled:
{
Description: Enables local users feature, if set to true ,
Required: False ,
}
boolean ,
enableExtendedGroups:
{
Description: Enables extended group support with local users feature, if set to true ,
Required: False ,
}
boolean ,
isHnsEnabled:
{
Description: Account HierarchicalNamespace enabled if sets to true. ,
Required: False ,
}
boolean ,
geoReplicationStats:
{
Description: Geo Replication Stats ,
Required: False ,
}
{
status:
{
Description: The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. ,
Enum:
{
Live: No description available. ,
Bootstrap: No description available. ,
Unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
lastSyncTime:
{
Description: All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. ,
Format: date-time ,
Required: False ,
}
string ,
canFailover:
{
Description: A boolean flag which indicates whether or not account failover is supported for the account. ,
Required: False ,
}
boolean ,
canPlannedFailover:
{
Description: A boolean flag which indicates whether or not planned account failover is supported for the account. ,
Required: False ,
}
boolean ,
postFailoverRedundancy:
{
Description: The redundancy type of the account after an account failover is performed. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_ZRS: No description available. ,
}
,
Required: False ,
}
enum ,
postPlannedFailoverRedundancy:
{
Description: The redundancy type of the account after a planned account failover is performed. ,
Enum:
{
Standard_GRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_RAGZRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
failoverInProgress:
{
Description: If the failover is in progress, the value will be true, otherwise, it will be null. ,
Required: False ,
}
boolean ,
largeFileSharesState:
{
Description: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified storage account ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
routingPreference:
{
Description: Maintains information about the network routing choice opted by the user for data transfer ,
Required: False ,
}
{
routingChoice:
{
Description: Routing Choice defines the kind of network routing opted by the user. ,
Enum:
{
MicrosoftRouting: No description available. ,
InternetRouting: No description available. ,
}
,
Required: False ,
}
enum ,
publishMicrosoftEndpoints:
{
Description: A boolean flag which indicates whether microsoft routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
publishInternetEndpoints:
{
Description: A boolean flag which indicates whether internet routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
}
,
dualStackEndpointPreference:
{
Description: Maintains information about the Internet protocol opted by the user. ,
Required: False ,
}
{
publishIpv6Endpoint:
{
Description: A boolean flag which indicates whether IPv6 storage endpoints are to be published. ,
Required: False ,
}
boolean ,
}
,
blobRestoreStatus:
{
Description: Blob restore status ,
Required: False ,
}
{
status:
{
Description: The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. ,
Enum:
{
InProgress: No description available. ,
Complete: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Failure reason when blob restore is failed. ,
Required: False ,
}
string ,
restoreId:
{
Description: Id for tracking blob restore request. ,
Required: False ,
}
string ,
parameters:
{
Description: Blob restore request parameters. ,
Required: False ,
}
{
timeToRestore:
{
Description: Restore blob to the specified time. ,
Format: date-time ,
Required: True ,
}
string ,
blobRanges:
{
Description: Blob ranges to restore. ,
Required: True ,
}
[
{
startRange:
{
Description: Blob start range. This is inclusive. Empty means account start. ,
Required: True ,
}
string ,
endRange:
{
Description: Blob end range. This is exclusive. Empty means account end. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
allowBlobPublicAccess:
{
Description: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
minimumTlsVersion:
{
Description: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. ,
Enum:
{
TLS1_0: No description available. ,
TLS1_1: No description available. ,
TLS1_2: No description available. ,
TLS1_3: No description available. ,
}
,
Required: False ,
}
enum ,
allowSharedKeyAccess:
{
Description: 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. ,
Required: False ,
}
boolean ,
isNfsV3Enabled:
{
Description: NFS 3.0 protocol support enabled if set to true. ,
Required: False ,
}
boolean ,
allowCrossTenantReplication:
{
Description: Allow or disallow cross AAD tenant object replication. Set this property to true for new or existing accounts only if object replication policies will involve storage accounts in different AAD tenants. The default interpretation is false for new accounts to follow best security practices by default. ,
Required: False ,
}
boolean ,
defaultToOAuthAuthentication:
{
Description: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
immutableStorageWithVersioning:
{
Description: The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the containers in the account by default. ,
Required: False ,
}
{
enabled:
{
Description: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. ,
Required: False ,
}
boolean ,
immutabilityPolicy:
{
Description: Specifies the default account-level immutability policy which is inherited and applied to objects that do not possess an explicit immutability policy at the object level. The object-level immutability policy has higher precedence than the container-level immutability policy, which has a higher precedence than the account-level immutability policy. ,
Required: False ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. ,
Enum:
{
Unlocked: No description available. ,
Locked: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: This property can only be changed for disabled and unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
}
,
}
,
allowedCopyScope:
{
Description: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. ,
Enum:
{
PrivateLink: No description available. ,
AAD: No description available. ,
}
,
Required: False ,
}
enum ,
storageAccountSkuConversionStatus:
{
Description: This property is readOnly and is set by server during asynchronous storage account sku conversion operations. ,
Required: False ,
}
{
skuConversionStatus:
{
Description: This property indicates the current sku conversion status. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
targetSkuName:
{
Description: This property represents the target sku name to which the account sku is being converted asynchronously. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: This property represents the sku conversion start time. ,
Required: False ,
}
string ,
endTime:
{
Description: This property represents the sku conversion end time. ,
Required: False ,
}
string ,
}
,
dnsEndpointType:
{
Description: Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. ,
Enum:
{
Standard: No description available. ,
AzureDnsZone: No description available. ,
}
,
Required: False ,
}
enum ,
isSkuConversionBlocked:
{
Description: This property will be set to true or false on an event of ongoing migration. Default value is null. ,
Required: False ,
}
boolean ,
accountMigrationInProgress:
{
Description: If customer initiated account migration is in progress, the value will be true else it will be null. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}
StorageAccounts_GetProperties (updated)
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.
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageAccounts_GetProperties",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "primaryEndpoints": [
              {
                "@added_c0e4ef94394b42e1bcfa4576ef0fb065": {
                  "#name": "ipv6Endpoints",
                  "Description": "Gets the IPv6 storage endpoints.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "blob",
                      "Description": "Gets the blob endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "queue",
                      "Description": "Gets the queue endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "table",
                      "Description": "Gets the table endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "file",
                      "Description": "Gets the file endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "web",
                      "Description": "Gets the web endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "dfs",
                      "Description": "Gets the dfs endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "microsoftEndpoints",
                      "Description": "Gets the microsoft routing storage endpoints.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "blob",
                          "Description": "Gets the blob endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "queue",
                          "Description": "Gets the queue endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "table",
                          "Description": "Gets the table endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "file",
                          "Description": "Gets the file endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "web",
                          "Description": "Gets the web endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "dfs",
                          "Description": "Gets the dfs endpoint.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    },
                    {
                      "#name": "internetEndpoints",
                      "Description": "Gets the internet routing storage endpoints",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "blob",
                          "Description": "Gets the blob endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "file",
                          "Description": "Gets the file endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "web",
                          "Description": "Gets the web endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "dfs",
                          "Description": "Gets the dfs endpoint.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  ]
                }
              }
            ]
          },
          {
            "secondaryEndpoints": [
              {
                "@added_6b9096cf98ee409991158700ef7f6c40": {
                  "#name": "ipv6Endpoints",
                  "Description": "Gets the IPv6 storage endpoints.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "blob",
                      "Description": "Gets the blob endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "queue",
                      "Description": "Gets the queue endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "table",
                      "Description": "Gets the table endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "file",
                      "Description": "Gets the file endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "web",
                      "Description": "Gets the web endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "dfs",
                      "Description": "Gets the dfs endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "microsoftEndpoints",
                      "Description": "Gets the microsoft routing storage endpoints.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "blob",
                          "Description": "Gets the blob endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "queue",
                          "Description": "Gets the queue endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "table",
                          "Description": "Gets the table endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "file",
                          "Description": "Gets the file endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "web",
                          "Description": "Gets the web endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "dfs",
                          "Description": "Gets the dfs endpoint.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    },
                    {
                      "#name": "internetEndpoints",
                      "Description": "Gets the internet routing storage endpoints",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "blob",
                          "Description": "Gets the blob endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "file",
                          "Description": "Gets the file endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "web",
                          "Description": "Gets the web endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "dfs",
                          "Description": "Gets the dfs endpoint.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  ]
                }
              }
            ]
          },
          {
            "networkAcls": [
              {
                "ipRules": {
                  "$properties": [
                    {
                      "#name": "value",
                      "Description": {
                        "new": "Specifies the IP or IP range in CIDR format.",
                        "old": "Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed."
                      }
                    }
                  ]
                }
              },
              {
                "@added_8a3fc6b9519b4387ad67adf13698fe96": {
                  "#name": "ipv6Rules",
                  "Description": "Sets the IPv6 ACL rules.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Description": "IPv6 rule with specific IP or IP range in CIDR format.",
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "value",
                        "Description": "Specifies the IP or IP range in CIDR format.",
                        "Required": true,
                        "Type": "string"
                      },
                      {
                        "#name": "action",
                        "Description": "The action of IP ACL rule.",
                        "Enum": [
                          [
                            "Allow",
                            ""
                          ]
                        ],
                        "Required": false,
                        "Type": "string"
                      }
                    ]
                  }
                }
              }
            ]
          },
          {
            "@added_71761a96108d44a296ec1c120716925d": {
              "#name": "dualStackEndpointPreference",
              "Description": "Maintains information about the Internet protocol opted by the user.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "publishIpv6Endpoint",
                  "Description": "A boolean flag which indicates whether IPv6 storage endpoints are to be published.",
                  "Required": false,
                  "Type": "boolean"
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$expand:
{
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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Gets the SKU. ,
Required: False ,
}
{
name:
{
Description: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Gets the Kind. ,
Enum:
{
Storage: No description available. ,
StorageV2: No description available. ,
BlobStorage: No description available. ,
FileStorage: No description available. ,
BlockBlobStorage: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: Optional. Gets or sets the pinned logical availability zone for the storage account. ,
Required: False ,
}
[
string ,
]
,
placement:
{
Description: Optional. Gets or sets the zonal placement details for the storage account. ,
Required: False ,
}
{
zonePlacementPolicy:
{
Description: The availability zone pinning policy for the storage account. ,
Enum:
{
Any: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the storage account. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the storage account at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
ResolvingDNS: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEndpoints:
{
Description: 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. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
ipv6Endpoints:
{
Description: Gets the IPv6 storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
primaryLocation:
{
Description: Gets the location of the primary data center for the storage account. ,
Required: False ,
}
string ,
statusOfPrimary:
{
Description: Gets the status indicating whether the primary location of the storage account is available or unavailable. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
lastGeoFailoverTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
secondaryLocation:
{
Description: Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. ,
Required: False ,
}
string ,
statusOfSecondary:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Gets the creation date and time of the storage account in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
customDomain:
{
Description: Gets the custom domain the user assigned to this storage account. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. ,
Required: True ,
}
string ,
useSubDomainName:
{
Description: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. ,
Required: False ,
}
boolean ,
}
,
sasPolicy:
{
Description: SasPolicy assigned to the storage account. ,
Required: False ,
}
{
sasExpirationPeriod:
{
Description: The SAS expiration period, DD.HH:MM:SS. ,
Required: True ,
}
string ,
expirationAction:
{
Description: The SAS Expiration Action defines the action to be performed when sasPolicy.sasExpirationPeriod is violated. The 'Log' action can be used for audit purposes and the 'Block' action can be used to block and deny the usage of SAS tokens that do not adhere to the sas policy expiration period. ,
Enum:
{
Log: No description available. ,
Block: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
keyPolicy:
{
Description: KeyPolicy assigned to the storage account. ,
Required: False ,
}
{
keyExpirationPeriodInDays:
{
Description: The key expiration period in days. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
keyCreationTime:
{
Description: Storage account keys creation time. ,
Required: False ,
}
{
key1:
{
Format: date-time ,
Required: False ,
}
string ,
key2:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryEndpoints:
{
Description: 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. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
ipv6Endpoints:
{
Description: Gets the IPv6 storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
encryption:
{
Description: Encryption settings to be used for server-side encryption for the storage account. ,
Required: False ,
}
{
services:
{
Description: List of services which support encryption. ,
Required: False ,
}
{
blob:
{
Description: The encryption function of the blob storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
file:
{
Description: The encryption function of the file storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
table:
{
Description: The encryption function of the table storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
queue:
{
Description: The encryption function of the queue storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault ,
Enum:
{
Microsoft.Storage: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
boolean ,
keyvaultproperties:
{
Description: Properties provided by key vault. ,
Required: False ,
}
{
keyname:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
currentVersionedKeyExpirationTimestamp:
{
Description: This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity to be used with service-side encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. ,
Required: False ,
}
string ,
federatedIdentityClientId:
{
Description: ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. ,
Required: False ,
}
string ,
}
,
}
,
accessTier:
{
Description: Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The 'Premium' access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type. ,
Enum:
{
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
Cold: No description available. ,
}
,
Required: False ,
}
enum ,
azureFilesIdentityBasedAuthentication:
{
Description: Provides the identity based authentication settings for Azure Files. ,
Required: False ,
}
{
directoryServiceOptions:
{
Description: Indicates the directory service used. Note that this enum may be extended in the future. ,
Enum:
{
None: No description available. ,
AADDS: No description available. ,
AD: No description available. ,
AADKERB: No description available. ,
}
,
Required: True ,
}
enum ,
activeDirectoryProperties:
{
Description: Additional information about the directory service. Required if directoryServiceOptions is AD (AD DS authentication). Optional for directoryServiceOptions AADDS (Entra DS authentication) and AADKERB (Entra authentication). ,
Required: False ,
}
{
domainName:
{
Description: Specifies the primary domain that the AD DNS server is authoritative for. This property is required if directoryServiceOptions is set to AD (AD DS authentication). If directoryServiceOptions is set to AADDS (Entra DS authentication), providing this property is optional, as it will be inferred automatically if omitted. If directoryServiceOptions is set to AADKERB (Entra authentication), this property is optional; it is needed to support configuration of directory- and file-level permissions via Windows File Explorer, but is not required for authentication. ,
Required: False ,
}
string ,
netBiosDomainName:
{
Description: Specifies the NetBIOS domain name. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
forestName:
{
Description: Specifies the Active Directory forest to get. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
domainGuid:
{
Description: Specifies the domain GUID. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. If directoryServiceOptions is set to AADDS (Entra DS authentication), this property can be omitted. If directoryServiceOptions is set to AADKERB (Entra authentication), this property is optional; it is needed to support configuration of directory- and file-level permissions via Windows File Explorer, but is not required for authentication. ,
Required: False ,
}
string ,
domainSid:
{
Description: Specifies the security identifier (SID) of the AD domain. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
azureStorageSid:
{
Description: Specifies the security identifier (SID) for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
samAccountName:
{
Description: Specifies the Active Directory SAMAccountName for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is optional. If provided, accountType should also be provided. For directoryServiceOptions AADDS (Entra DS authentication) or AADKERB (Entra authentication), this property can be omitted. ,
Required: False ,
}
string ,
accountType:
{
Description: Specifies the Active Directory account type for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is optional. If provided, samAccountName should also be provided. For directoryServiceOptions AADDS (Entra DS authentication) or AADKERB (Entra authentication), this property can be omitted. ,
Enum:
{
User: No description available. ,
Computer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
defaultSharePermission:
{
Description: Default share permission for users using Kerberos authentication if RBAC role is not assigned. ,
Enum:
{
None: No description available. ,
StorageFileDataSmbShareReader: No description available. ,
StorageFileDataSmbShareContributor: No description available. ,
StorageFileDataSmbShareElevatedContributor: No description available. ,
}
,
Required: False ,
}
enum ,
smbOAuthSettings:
{
Description: Required for Managed Identities access using OAuth over SMB. ,
Required: False ,
}
{
isSmbOAuthEnabled:
{
Description: Specifies if managed identities can access SMB shares using OAuth. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
}
,
}
,
supportsHttpsTrafficOnly:
{
Description: Allows https traffic only to storage service if sets to true. ,
Required: False ,
}
boolean ,
networkAcls:
{
Description: Network rule set ,
Required: False ,
}
{
bypass:
{
Description: 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. ,
Enum:
{
None: No description available. ,
Logging: No description available. ,
Metrics: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
resourceAccessRules:
{
Description: Sets the resource access rules ,
Required: False ,
}
[
{
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: Sets the virtual network rules ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Gets the state of virtual network rule. ,
Enum:
{
Provisioning: No description available. ,
Deprovisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
NetworkSourceDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipRules:
{
Description: Sets the IP ACL rules ,
Required: False ,
}
[
{
value:
{
Description: Specifies the IP or IP range in CIDR format. ,
Required: True ,
}
string ,
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipv6Rules:
{
Description: Sets the IPv6 ACL rules. ,
Required: False ,
}
[
{
value:
{
Description: Specifies the IP or IP range in CIDR format. ,
Required: True ,
}
string ,
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultAction:
{
Description: Specifies the default action of allow or deny when no other rules match. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
isSftpEnabled:
{
Description: Enables Secure File Transfer Protocol, if set to true ,
Required: False ,
}
boolean ,
isLocalUserEnabled:
{
Description: Enables local users feature, if set to true ,
Required: False ,
}
boolean ,
enableExtendedGroups:
{
Description: Enables extended group support with local users feature, if set to true ,
Required: False ,
}
boolean ,
isHnsEnabled:
{
Description: Account HierarchicalNamespace enabled if sets to true. ,
Required: False ,
}
boolean ,
geoReplicationStats:
{
Description: Geo Replication Stats ,
Required: False ,
}
{
status:
{
Description: The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. ,
Enum:
{
Live: No description available. ,
Bootstrap: No description available. ,
Unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
lastSyncTime:
{
Description: All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. ,
Format: date-time ,
Required: False ,
}
string ,
canFailover:
{
Description: A boolean flag which indicates whether or not account failover is supported for the account. ,
Required: False ,
}
boolean ,
canPlannedFailover:
{
Description: A boolean flag which indicates whether or not planned account failover is supported for the account. ,
Required: False ,
}
boolean ,
postFailoverRedundancy:
{
Description: The redundancy type of the account after an account failover is performed. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_ZRS: No description available. ,
}
,
Required: False ,
}
enum ,
postPlannedFailoverRedundancy:
{
Description: The redundancy type of the account after a planned account failover is performed. ,
Enum:
{
Standard_GRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_RAGZRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
failoverInProgress:
{
Description: If the failover is in progress, the value will be true, otherwise, it will be null. ,
Required: False ,
}
boolean ,
largeFileSharesState:
{
Description: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified storage account ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
routingPreference:
{
Description: Maintains information about the network routing choice opted by the user for data transfer ,
Required: False ,
}
{
routingChoice:
{
Description: Routing Choice defines the kind of network routing opted by the user. ,
Enum:
{
MicrosoftRouting: No description available. ,
InternetRouting: No description available. ,
}
,
Required: False ,
}
enum ,
publishMicrosoftEndpoints:
{
Description: A boolean flag which indicates whether microsoft routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
publishInternetEndpoints:
{
Description: A boolean flag which indicates whether internet routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
}
,
dualStackEndpointPreference:
{
Description: Maintains information about the Internet protocol opted by the user. ,
Required: False ,
}
{
publishIpv6Endpoint:
{
Description: A boolean flag which indicates whether IPv6 storage endpoints are to be published. ,
Required: False ,
}
boolean ,
}
,
blobRestoreStatus:
{
Description: Blob restore status ,
Required: False ,
}
{
status:
{
Description: The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. ,
Enum:
{
InProgress: No description available. ,
Complete: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Failure reason when blob restore is failed. ,
Required: False ,
}
string ,
restoreId:
{
Description: Id for tracking blob restore request. ,
Required: False ,
}
string ,
parameters:
{
Description: Blob restore request parameters. ,
Required: False ,
}
{
timeToRestore:
{
Description: Restore blob to the specified time. ,
Format: date-time ,
Required: True ,
}
string ,
blobRanges:
{
Description: Blob ranges to restore. ,
Required: True ,
}
[
{
startRange:
{
Description: Blob start range. This is inclusive. Empty means account start. ,
Required: True ,
}
string ,
endRange:
{
Description: Blob end range. This is exclusive. Empty means account end. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
allowBlobPublicAccess:
{
Description: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
minimumTlsVersion:
{
Description: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. ,
Enum:
{
TLS1_0: No description available. ,
TLS1_1: No description available. ,
TLS1_2: No description available. ,
TLS1_3: No description available. ,
}
,
Required: False ,
}
enum ,
allowSharedKeyAccess:
{
Description: 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. ,
Required: False ,
}
boolean ,
isNfsV3Enabled:
{
Description: NFS 3.0 protocol support enabled if set to true. ,
Required: False ,
}
boolean ,
allowCrossTenantReplication:
{
Description: Allow or disallow cross AAD tenant object replication. Set this property to true for new or existing accounts only if object replication policies will involve storage accounts in different AAD tenants. The default interpretation is false for new accounts to follow best security practices by default. ,
Required: False ,
}
boolean ,
defaultToOAuthAuthentication:
{
Description: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
immutableStorageWithVersioning:
{
Description: The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the containers in the account by default. ,
Required: False ,
}
{
enabled:
{
Description: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. ,
Required: False ,
}
boolean ,
immutabilityPolicy:
{
Description: Specifies the default account-level immutability policy which is inherited and applied to objects that do not possess an explicit immutability policy at the object level. The object-level immutability policy has higher precedence than the container-level immutability policy, which has a higher precedence than the account-level immutability policy. ,
Required: False ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. ,
Enum:
{
Unlocked: No description available. ,
Locked: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: This property can only be changed for disabled and unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
}
,
}
,
allowedCopyScope:
{
Description: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. ,
Enum:
{
PrivateLink: No description available. ,
AAD: No description available. ,
}
,
Required: False ,
}
enum ,
storageAccountSkuConversionStatus:
{
Description: This property is readOnly and is set by server during asynchronous storage account sku conversion operations. ,
Required: False ,
}
{
skuConversionStatus:
{
Description: This property indicates the current sku conversion status. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
targetSkuName:
{
Description: This property represents the target sku name to which the account sku is being converted asynchronously. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: This property represents the sku conversion start time. ,
Required: False ,
}
string ,
endTime:
{
Description: This property represents the sku conversion end time. ,
Required: False ,
}
string ,
}
,
dnsEndpointType:
{
Description: Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. ,
Enum:
{
Standard: No description available. ,
AzureDnsZone: No description available. ,
}
,
Required: False ,
}
enum ,
isSkuConversionBlocked:
{
Description: This property will be set to true or false on an event of ongoing migration. Default value is null. ,
Required: False ,
}
boolean ,
accountMigrationInProgress:
{
Description: If customer initiated account migration is in progress, the value will be true else it will be null. ,
Required: False ,
}
boolean ,
}
,
}
StorageAccounts_Update (updated)
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.
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageAccounts_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "networkAcls": [
              {
                "ipRules": {
                  "$properties": [
                    {
                      "#name": "value",
                      "Description": {
                        "new": "Specifies the IP or IP range in CIDR format.",
                        "old": "Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed."
                      }
                    }
                  ]
                }
              },
              {
                "@added_358285a936574eb1971ff4a9d34dbbfb": {
                  "#name": "ipv6Rules",
                  "Description": "Sets the IPv6 ACL rules.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Description": "IPv6 rule with specific IP or IP range in CIDR format.",
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "value",
                        "Description": "Specifies the IP or IP range in CIDR format.",
                        "Required": true,
                        "Type": "string"
                      },
                      {
                        "#name": "action",
                        "Description": "The action of IP ACL rule.",
                        "Enum": [
                          [
                            "Allow",
                            ""
                          ]
                        ],
                        "Required": false,
                        "Type": "string"
                      }
                    ]
                  }
                }
              }
            ]
          },
          {
            "@added_5be5d2f3532d45c99280d9fde7a79600": {
              "#name": "dualStackEndpointPreference",
              "Description": "Maintains information about the Internet protocol opted by the user.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "publishIpv6Endpoint",
                  "Description": "A boolean flag which indicates whether IPv6 storage endpoints are to be published.",
                  "Required": false,
                  "Type": "boolean"
                }
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "primaryEndpoints": [
              {
                "@added_a4df5478243f4182915cd38e338bd5aa": {
                  "#name": "ipv6Endpoints",
                  "Description": "Gets the IPv6 storage endpoints.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "blob",
                      "Description": "Gets the blob endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "queue",
                      "Description": "Gets the queue endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "table",
                      "Description": "Gets the table endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "file",
                      "Description": "Gets the file endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "web",
                      "Description": "Gets the web endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "dfs",
                      "Description": "Gets the dfs endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "microsoftEndpoints",
                      "Description": "Gets the microsoft routing storage endpoints.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "blob",
                          "Description": "Gets the blob endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "queue",
                          "Description": "Gets the queue endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "table",
                          "Description": "Gets the table endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "file",
                          "Description": "Gets the file endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "web",
                          "Description": "Gets the web endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "dfs",
                          "Description": "Gets the dfs endpoint.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    },
                    {
                      "#name": "internetEndpoints",
                      "Description": "Gets the internet routing storage endpoints",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "blob",
                          "Description": "Gets the blob endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "file",
                          "Description": "Gets the file endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "web",
                          "Description": "Gets the web endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "dfs",
                          "Description": "Gets the dfs endpoint.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  ]
                }
              }
            ]
          },
          {
            "secondaryEndpoints": [
              {
                "@added_0ed8880b1d2e41b1898835801cca768e": {
                  "#name": "ipv6Endpoints",
                  "Description": "Gets the IPv6 storage endpoints.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "blob",
                      "Description": "Gets the blob endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "queue",
                      "Description": "Gets the queue endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "table",
                      "Description": "Gets the table endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "file",
                      "Description": "Gets the file endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "web",
                      "Description": "Gets the web endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "dfs",
                      "Description": "Gets the dfs endpoint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "microsoftEndpoints",
                      "Description": "Gets the microsoft routing storage endpoints.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "blob",
                          "Description": "Gets the blob endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "queue",
                          "Description": "Gets the queue endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "table",
                          "Description": "Gets the table endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "file",
                          "Description": "Gets the file endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "web",
                          "Description": "Gets the web endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "dfs",
                          "Description": "Gets the dfs endpoint.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    },
                    {
                      "#name": "internetEndpoints",
                      "Description": "Gets the internet routing storage endpoints",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "blob",
                          "Description": "Gets the blob endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "file",
                          "Description": "Gets the file endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "web",
                          "Description": "Gets the web endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "dfs",
                          "Description": "Gets the dfs endpoint.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  ]
                }
              }
            ]
          },
          {
            "networkAcls": [
              {
                "ipRules": {
                  "$properties": [
                    {
                      "#name": "value",
                      "Description": {
                        "new": "Specifies the IP or IP range in CIDR format.",
                        "old": "Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed."
                      }
                    }
                  ]
                }
              },
              {
                "@added_79dfb825a7c941f4af6f2c440419449c": {
                  "#name": "ipv6Rules",
                  "Description": "Sets the IPv6 ACL rules.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Description": "IPv6 rule with specific IP or IP range in CIDR format.",
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "value",
                        "Description": "Specifies the IP or IP range in CIDR format.",
                        "Required": true,
                        "Type": "string"
                      },
                      {
                        "#name": "action",
                        "Description": "The action of IP ACL rule.",
                        "Enum": [
                          [
                            "Allow",
                            ""
                          ]
                        ],
                        "Required": false,
                        "Type": "string"
                      }
                    ]
                  }
                }
              }
            ]
          },
          {
            "@added_16c5bd7577464f679074214410aba4fb": {
              "#name": "dualStackEndpointPreference",
              "Description": "Maintains information about the Internet protocol opted by the user.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "publishIpv6Endpoint",
                  "Description": "A boolean flag which indicates whether IPv6 storage endpoints are to be published.",
                  "Required": false,
                  "Type": "boolean"
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
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. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the updated account. ,
Required: True ,
}
{
sku:
{
Description: Gets or sets the SKU name. Note that the SKU name cannot be updated to Standard_ZRS, Premium_LRS or Premium_ZRS, nor can accounts of those SKU names be updated to any other value. ,
Required: False ,
}
{
name:
{
Description: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: 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. ,
Required: False ,
}
object ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The parameters used when updating a storage account. ,
Required: False ,
}
{
customDomain:
{
Description: 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. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. ,
Required: True ,
}
string ,
useSubDomainName:
{
Description: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. ,
Required: False ,
}
boolean ,
}
,
encryption:
{
Description: Not applicable. Azure Storage encryption at rest is enabled by default for all storage accounts and cannot be disabled. ,
Required: False ,
}
{
services:
{
Description: List of services which support encryption. ,
Required: False ,
}
{
blob:
{
Description: The encryption function of the blob storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
file:
{
Description: The encryption function of the file storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
table:
{
Description: The encryption function of the table storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
queue:
{
Description: The encryption function of the queue storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault ,
Enum:
{
Microsoft.Storage: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
boolean ,
keyvaultproperties:
{
Description: Properties provided by key vault. ,
Required: False ,
}
{
keyname:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
currentVersionedKeyExpirationTimestamp:
{
Description: This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity to be used with service-side encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. ,
Required: False ,
}
string ,
federatedIdentityClientId:
{
Description: ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. ,
Required: False ,
}
string ,
}
,
}
,
sasPolicy:
{
Description: SasPolicy assigned to the storage account. ,
Required: False ,
}
{
sasExpirationPeriod:
{
Description: The SAS expiration period, DD.HH:MM:SS. ,
Required: True ,
}
string ,
expirationAction:
{
Description: The SAS Expiration Action defines the action to be performed when sasPolicy.sasExpirationPeriod is violated. The 'Log' action can be used for audit purposes and the 'Block' action can be used to block and deny the usage of SAS tokens that do not adhere to the sas policy expiration period. ,
Enum:
{
Log: No description available. ,
Block: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
keyPolicy:
{
Description: KeyPolicy assigned to the storage account. ,
Required: False ,
}
{
keyExpirationPeriodInDays:
{
Description: The key expiration period in days. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
accessTier:
{
Description: Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The 'Premium' access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type. ,
Enum:
{
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
Cold: No description available. ,
}
,
Required: False ,
}
enum ,
azureFilesIdentityBasedAuthentication:
{
Description: Provides the identity based authentication settings for Azure Files. ,
Required: False ,
}
{
directoryServiceOptions:
{
Description: Indicates the directory service used. Note that this enum may be extended in the future. ,
Enum:
{
None: No description available. ,
AADDS: No description available. ,
AD: No description available. ,
AADKERB: No description available. ,
}
,
Required: True ,
}
enum ,
activeDirectoryProperties:
{
Description: Additional information about the directory service. Required if directoryServiceOptions is AD (AD DS authentication). Optional for directoryServiceOptions AADDS (Entra DS authentication) and AADKERB (Entra authentication). ,
Required: False ,
}
{
domainName:
{
Description: Specifies the primary domain that the AD DNS server is authoritative for. This property is required if directoryServiceOptions is set to AD (AD DS authentication). If directoryServiceOptions is set to AADDS (Entra DS authentication), providing this property is optional, as it will be inferred automatically if omitted. If directoryServiceOptions is set to AADKERB (Entra authentication), this property is optional; it is needed to support configuration of directory- and file-level permissions via Windows File Explorer, but is not required for authentication. ,
Required: False ,
}
string ,
netBiosDomainName:
{
Description: Specifies the NetBIOS domain name. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
forestName:
{
Description: Specifies the Active Directory forest to get. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
domainGuid:
{
Description: Specifies the domain GUID. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. If directoryServiceOptions is set to AADDS (Entra DS authentication), this property can be omitted. If directoryServiceOptions is set to AADKERB (Entra authentication), this property is optional; it is needed to support configuration of directory- and file-level permissions via Windows File Explorer, but is not required for authentication. ,
Required: False ,
}
string ,
domainSid:
{
Description: Specifies the security identifier (SID) of the AD domain. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
azureStorageSid:
{
Description: Specifies the security identifier (SID) for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
samAccountName:
{
Description: Specifies the Active Directory SAMAccountName for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is optional. If provided, accountType should also be provided. For directoryServiceOptions AADDS (Entra DS authentication) or AADKERB (Entra authentication), this property can be omitted. ,
Required: False ,
}
string ,
accountType:
{
Description: Specifies the Active Directory account type for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is optional. If provided, samAccountName should also be provided. For directoryServiceOptions AADDS (Entra DS authentication) or AADKERB (Entra authentication), this property can be omitted. ,
Enum:
{
User: No description available. ,
Computer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
defaultSharePermission:
{
Description: Default share permission for users using Kerberos authentication if RBAC role is not assigned. ,
Enum:
{
None: No description available. ,
StorageFileDataSmbShareReader: No description available. ,
StorageFileDataSmbShareContributor: No description available. ,
StorageFileDataSmbShareElevatedContributor: No description available. ,
}
,
Required: False ,
}
enum ,
smbOAuthSettings:
{
Description: Required for Managed Identities access using OAuth over SMB. ,
Required: False ,
}
{
isSmbOAuthEnabled:
{
Description: Specifies if managed identities can access SMB shares using OAuth. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
}
,
}
,
supportsHttpsTrafficOnly:
{
Description: Allows https traffic only to storage service if sets to true. ,
Required: False ,
}
boolean ,
isSftpEnabled:
{
Description: Enables Secure File Transfer Protocol, if set to true ,
Required: False ,
}
boolean ,
isLocalUserEnabled:
{
Description: Enables local users feature, if set to true ,
Required: False ,
}
boolean ,
enableExtendedGroups:
{
Description: Enables extended group support with local users feature, if set to true ,
Required: False ,
}
boolean ,
networkAcls:
{
Description: Network rule set ,
Required: False ,
}
{
bypass:
{
Description: 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. ,
Enum:
{
None: No description available. ,
Logging: No description available. ,
Metrics: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
resourceAccessRules:
{
Description: Sets the resource access rules ,
Required: False ,
}
[
{
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: Sets the virtual network rules ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Gets the state of virtual network rule. ,
Enum:
{
Provisioning: No description available. ,
Deprovisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
NetworkSourceDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipRules:
{
Description: Sets the IP ACL rules ,
Required: False ,
}
[
{
value:
{
Description: Specifies the IP or IP range in CIDR format. ,
Required: True ,
}
string ,
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipv6Rules:
{
Description: Sets the IPv6 ACL rules. ,
Required: False ,
}
[
{
value:
{
Description: Specifies the IP or IP range in CIDR format. ,
Required: True ,
}
string ,
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultAction:
{
Description: Specifies the default action of allow or deny when no other rules match. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
largeFileSharesState:
{
Description: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
routingPreference:
{
Description: Maintains information about the network routing choice opted by the user for data transfer ,
Required: False ,
}
{
routingChoice:
{
Description: Routing Choice defines the kind of network routing opted by the user. ,
Enum:
{
MicrosoftRouting: No description available. ,
InternetRouting: No description available. ,
}
,
Required: False ,
}
enum ,
publishMicrosoftEndpoints:
{
Description: A boolean flag which indicates whether microsoft routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
publishInternetEndpoints:
{
Description: A boolean flag which indicates whether internet routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
}
,
dualStackEndpointPreference:
{
Description: Maintains information about the Internet protocol opted by the user. ,
Required: False ,
}
{
publishIpv6Endpoint:
{
Description: A boolean flag which indicates whether IPv6 storage endpoints are to be published. ,
Required: False ,
}
boolean ,
}
,
allowBlobPublicAccess:
{
Description: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
minimumTlsVersion:
{
Description: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. ,
Enum:
{
TLS1_0: No description available. ,
TLS1_1: No description available. ,
TLS1_2: No description available. ,
TLS1_3: No description available. ,
}
,
Required: False ,
}
enum ,
allowSharedKeyAccess:
{
Description: 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. ,
Required: False ,
}
boolean ,
allowCrossTenantReplication:
{
Description: Allow or disallow cross AAD tenant object replication. Set this property to true for new or existing accounts only if object replication policies will involve storage accounts in different AAD tenants. The default interpretation is false for new accounts to follow best security practices by default. ,
Required: False ,
}
boolean ,
defaultToOAuthAuthentication:
{
Description: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. Value is optional but if passed in, must be 'Enabled', 'Disabled' or 'SecuredByPerimeter'. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
immutableStorageWithVersioning:
{
Description: The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the containers in the account by default. ,
Required: False ,
}
{
enabled:
{
Description: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. ,
Required: False ,
}
boolean ,
immutabilityPolicy:
{
Description: Specifies the default account-level immutability policy which is inherited and applied to objects that do not possess an explicit immutability policy at the object level. The object-level immutability policy has higher precedence than the container-level immutability policy, which has a higher precedence than the account-level immutability policy. ,
Required: False ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. ,
Enum:
{
Unlocked: No description available. ,
Locked: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: This property can only be changed for disabled and unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
}
,
}
,
allowedCopyScope:
{
Description: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. ,
Enum:
{
PrivateLink: No description available. ,
AAD: No description available. ,
}
,
Required: False ,
}
enum ,
dnsEndpointType:
{
Description: Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. ,
Enum:
{
Standard: No description available. ,
AzureDnsZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Optional. Indicates the type of storage account. Currently only StorageV2 value supported by server. ,
Enum:
{
Storage: No description available. ,
StorageV2: No description available. ,
BlobStorage: No description available. ,
FileStorage: No description available. ,
BlockBlobStorage: No description available. ,
}
,
Required: False ,
}
enum ,
zones:
{
Description: Optional. Gets or sets the pinned logical availability zone for the storage account. ,
Required: False ,
}
[
string ,
]
,
placement:
{
Description: Optional. Gets or sets the zonal placement details for the storage account. ,
Required: False ,
}
{
zonePlacementPolicy:
{
Description: The availability zone pinning policy for the storage account. ,
Enum:
{
Any: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Gets the SKU. ,
Required: False ,
}
{
name:
{
Description: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Gets the Kind. ,
Enum:
{
Storage: No description available. ,
StorageV2: No description available. ,
BlobStorage: No description available. ,
FileStorage: No description available. ,
BlockBlobStorage: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: Optional. Gets or sets the pinned logical availability zone for the storage account. ,
Required: False ,
}
[
string ,
]
,
placement:
{
Description: Optional. Gets or sets the zonal placement details for the storage account. ,
Required: False ,
}
{
zonePlacementPolicy:
{
Description: The availability zone pinning policy for the storage account. ,
Enum:
{
Any: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the storage account. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the storage account at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
ResolvingDNS: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEndpoints:
{
Description: 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. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
ipv6Endpoints:
{
Description: Gets the IPv6 storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
primaryLocation:
{
Description: Gets the location of the primary data center for the storage account. ,
Required: False ,
}
string ,
statusOfPrimary:
{
Description: Gets the status indicating whether the primary location of the storage account is available or unavailable. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
lastGeoFailoverTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
secondaryLocation:
{
Description: Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. ,
Required: False ,
}
string ,
statusOfSecondary:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Gets the creation date and time of the storage account in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
customDomain:
{
Description: Gets the custom domain the user assigned to this storage account. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. ,
Required: True ,
}
string ,
useSubDomainName:
{
Description: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. ,
Required: False ,
}
boolean ,
}
,
sasPolicy:
{
Description: SasPolicy assigned to the storage account. ,
Required: False ,
}
{
sasExpirationPeriod:
{
Description: The SAS expiration period, DD.HH:MM:SS. ,
Required: True ,
}
string ,
expirationAction:
{
Description: The SAS Expiration Action defines the action to be performed when sasPolicy.sasExpirationPeriod is violated. The 'Log' action can be used for audit purposes and the 'Block' action can be used to block and deny the usage of SAS tokens that do not adhere to the sas policy expiration period. ,
Enum:
{
Log: No description available. ,
Block: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
keyPolicy:
{
Description: KeyPolicy assigned to the storage account. ,
Required: False ,
}
{
keyExpirationPeriodInDays:
{
Description: The key expiration period in days. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
keyCreationTime:
{
Description: Storage account keys creation time. ,
Required: False ,
}
{
key1:
{
Format: date-time ,
Required: False ,
}
string ,
key2:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryEndpoints:
{
Description: 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. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
ipv6Endpoints:
{
Description: Gets the IPv6 storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
encryption:
{
Description: Encryption settings to be used for server-side encryption for the storage account. ,
Required: False ,
}
{
services:
{
Description: List of services which support encryption. ,
Required: False ,
}
{
blob:
{
Description: The encryption function of the blob storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
file:
{
Description: The encryption function of the file storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
table:
{
Description: The encryption function of the table storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
queue:
{
Description: The encryption function of the queue storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault ,
Enum:
{
Microsoft.Storage: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
boolean ,
keyvaultproperties:
{
Description: Properties provided by key vault. ,
Required: False ,
}
{
keyname:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
currentVersionedKeyExpirationTimestamp:
{
Description: This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity to be used with service-side encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. ,
Required: False ,
}
string ,
federatedIdentityClientId:
{
Description: ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. ,
Required: False ,
}
string ,
}
,
}
,
accessTier:
{
Description: Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The 'Premium' access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type. ,
Enum:
{
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
Cold: No description available. ,
}
,
Required: False ,
}
enum ,
azureFilesIdentityBasedAuthentication:
{
Description: Provides the identity based authentication settings for Azure Files. ,
Required: False ,
}
{
directoryServiceOptions:
{
Description: Indicates the directory service used. Note that this enum may be extended in the future. ,
Enum:
{
None: No description available. ,
AADDS: No description available. ,
AD: No description available. ,
AADKERB: No description available. ,
}
,
Required: True ,
}
enum ,
activeDirectoryProperties:
{
Description: Additional information about the directory service. Required if directoryServiceOptions is AD (AD DS authentication). Optional for directoryServiceOptions AADDS (Entra DS authentication) and AADKERB (Entra authentication). ,
Required: False ,
}
{
domainName:
{
Description: Specifies the primary domain that the AD DNS server is authoritative for. This property is required if directoryServiceOptions is set to AD (AD DS authentication). If directoryServiceOptions is set to AADDS (Entra DS authentication), providing this property is optional, as it will be inferred automatically if omitted. If directoryServiceOptions is set to AADKERB (Entra authentication), this property is optional; it is needed to support configuration of directory- and file-level permissions via Windows File Explorer, but is not required for authentication. ,
Required: False ,
}
string ,
netBiosDomainName:
{
Description: Specifies the NetBIOS domain name. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
forestName:
{
Description: Specifies the Active Directory forest to get. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
domainGuid:
{
Description: Specifies the domain GUID. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. If directoryServiceOptions is set to AADDS (Entra DS authentication), this property can be omitted. If directoryServiceOptions is set to AADKERB (Entra authentication), this property is optional; it is needed to support configuration of directory- and file-level permissions via Windows File Explorer, but is not required for authentication. ,
Required: False ,
}
string ,
domainSid:
{
Description: Specifies the security identifier (SID) of the AD domain. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
azureStorageSid:
{
Description: Specifies the security identifier (SID) for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
samAccountName:
{
Description: Specifies the Active Directory SAMAccountName for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is optional. If provided, accountType should also be provided. For directoryServiceOptions AADDS (Entra DS authentication) or AADKERB (Entra authentication), this property can be omitted. ,
Required: False ,
}
string ,
accountType:
{
Description: Specifies the Active Directory account type for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is optional. If provided, samAccountName should also be provided. For directoryServiceOptions AADDS (Entra DS authentication) or AADKERB (Entra authentication), this property can be omitted. ,
Enum:
{
User: No description available. ,
Computer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
defaultSharePermission:
{
Description: Default share permission for users using Kerberos authentication if RBAC role is not assigned. ,
Enum:
{
None: No description available. ,
StorageFileDataSmbShareReader: No description available. ,
StorageFileDataSmbShareContributor: No description available. ,
StorageFileDataSmbShareElevatedContributor: No description available. ,
}
,
Required: False ,
}
enum ,
smbOAuthSettings:
{
Description: Required for Managed Identities access using OAuth over SMB. ,
Required: False ,
}
{
isSmbOAuthEnabled:
{
Description: Specifies if managed identities can access SMB shares using OAuth. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
}
,
}
,
supportsHttpsTrafficOnly:
{
Description: Allows https traffic only to storage service if sets to true. ,
Required: False ,
}
boolean ,
networkAcls:
{
Description: Network rule set ,
Required: False ,
}
{
bypass:
{
Description: 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. ,
Enum:
{
None: No description available. ,
Logging: No description available. ,
Metrics: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
resourceAccessRules:
{
Description: Sets the resource access rules ,
Required: False ,
}
[
{
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: Sets the virtual network rules ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Gets the state of virtual network rule. ,
Enum:
{
Provisioning: No description available. ,
Deprovisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
NetworkSourceDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipRules:
{
Description: Sets the IP ACL rules ,
Required: False ,
}
[
{
value:
{
Description: Specifies the IP or IP range in CIDR format. ,
Required: True ,
}
string ,
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipv6Rules:
{
Description: Sets the IPv6 ACL rules. ,
Required: False ,
}
[
{
value:
{
Description: Specifies the IP or IP range in CIDR format. ,
Required: True ,
}
string ,
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultAction:
{
Description: Specifies the default action of allow or deny when no other rules match. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
isSftpEnabled:
{
Description: Enables Secure File Transfer Protocol, if set to true ,
Required: False ,
}
boolean ,
isLocalUserEnabled:
{
Description: Enables local users feature, if set to true ,
Required: False ,
}
boolean ,
enableExtendedGroups:
{
Description: Enables extended group support with local users feature, if set to true ,
Required: False ,
}
boolean ,
isHnsEnabled:
{
Description: Account HierarchicalNamespace enabled if sets to true. ,
Required: False ,
}
boolean ,
geoReplicationStats:
{
Description: Geo Replication Stats ,
Required: False ,
}
{
status:
{
Description: The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. ,
Enum:
{
Live: No description available. ,
Bootstrap: No description available. ,
Unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
lastSyncTime:
{
Description: All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. ,
Format: date-time ,
Required: False ,
}
string ,
canFailover:
{
Description: A boolean flag which indicates whether or not account failover is supported for the account. ,
Required: False ,
}
boolean ,
canPlannedFailover:
{
Description: A boolean flag which indicates whether or not planned account failover is supported for the account. ,
Required: False ,
}
boolean ,
postFailoverRedundancy:
{
Description: The redundancy type of the account after an account failover is performed. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_ZRS: No description available. ,
}
,
Required: False ,
}
enum ,
postPlannedFailoverRedundancy:
{
Description: The redundancy type of the account after a planned account failover is performed. ,
Enum:
{
Standard_GRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_RAGZRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
failoverInProgress:
{
Description: If the failover is in progress, the value will be true, otherwise, it will be null. ,
Required: False ,
}
boolean ,
largeFileSharesState:
{
Description: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified storage account ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
routingPreference:
{
Description: Maintains information about the network routing choice opted by the user for data transfer ,
Required: False ,
}
{
routingChoice:
{
Description: Routing Choice defines the kind of network routing opted by the user. ,
Enum:
{
MicrosoftRouting: No description available. ,
InternetRouting: No description available. ,
}
,
Required: False ,
}
enum ,
publishMicrosoftEndpoints:
{
Description: A boolean flag which indicates whether microsoft routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
publishInternetEndpoints:
{
Description: A boolean flag which indicates whether internet routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
}
,
dualStackEndpointPreference:
{
Description: Maintains information about the Internet protocol opted by the user. ,
Required: False ,
}
{
publishIpv6Endpoint:
{
Description: A boolean flag which indicates whether IPv6 storage endpoints are to be published. ,
Required: False ,
}
boolean ,
}
,
blobRestoreStatus:
{
Description: Blob restore status ,
Required: False ,
}
{
status:
{
Description: The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. ,
Enum:
{
InProgress: No description available. ,
Complete: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Failure reason when blob restore is failed. ,
Required: False ,
}
string ,
restoreId:
{
Description: Id for tracking blob restore request. ,
Required: False ,
}
string ,
parameters:
{
Description: Blob restore request parameters. ,
Required: False ,
}
{
timeToRestore:
{
Description: Restore blob to the specified time. ,
Format: date-time ,
Required: True ,
}
string ,
blobRanges:
{
Description: Blob ranges to restore. ,
Required: True ,
}
[
{
startRange:
{
Description: Blob start range. This is inclusive. Empty means account start. ,
Required: True ,
}
string ,
endRange:
{
Description: Blob end range. This is exclusive. Empty means account end. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
allowBlobPublicAccess:
{
Description: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
minimumTlsVersion:
{
Description: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. ,
Enum:
{
TLS1_0: No description available. ,
TLS1_1: No description available. ,
TLS1_2: No description available. ,
TLS1_3: No description available. ,
}
,
Required: False ,
}
enum ,
allowSharedKeyAccess:
{
Description: 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. ,
Required: False ,
}
boolean ,
isNfsV3Enabled:
{
Description: NFS 3.0 protocol support enabled if set to true. ,
Required: False ,
}
boolean ,
allowCrossTenantReplication:
{
Description: Allow or disallow cross AAD tenant object replication. Set this property to true for new or existing accounts only if object replication policies will involve storage accounts in different AAD tenants. The default interpretation is false for new accounts to follow best security practices by default. ,
Required: False ,
}
boolean ,
defaultToOAuthAuthentication:
{
Description: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
immutableStorageWithVersioning:
{
Description: The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the containers in the account by default. ,
Required: False ,
}
{
enabled:
{
Description: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. ,
Required: False ,
}
boolean ,
immutabilityPolicy:
{
Description: Specifies the default account-level immutability policy which is inherited and applied to objects that do not possess an explicit immutability policy at the object level. The object-level immutability policy has higher precedence than the container-level immutability policy, which has a higher precedence than the account-level immutability policy. ,
Required: False ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. ,
Enum:
{
Unlocked: No description available. ,
Locked: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: This property can only be changed for disabled and unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
}
,
}
,
allowedCopyScope:
{
Description: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. ,
Enum:
{
PrivateLink: No description available. ,
AAD: No description available. ,
}
,
Required: False ,
}
enum ,
storageAccountSkuConversionStatus:
{
Description: This property is readOnly and is set by server during asynchronous storage account sku conversion operations. ,
Required: False ,
}
{
skuConversionStatus:
{
Description: This property indicates the current sku conversion status. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
targetSkuName:
{
Description: This property represents the target sku name to which the account sku is being converted asynchronously. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: This property represents the sku conversion start time. ,
Required: False ,
}
string ,
endTime:
{
Description: This property represents the sku conversion end time. ,
Required: False ,
}
string ,
}
,
dnsEndpointType:
{
Description: Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. ,
Enum:
{
Standard: No description available. ,
AzureDnsZone: No description available. ,
}
,
Required: False ,
}
enum ,
isSkuConversionBlocked:
{
Description: This property will be set to true or false on an event of ongoing migration. Default value is null. ,
Required: False ,
}
boolean ,
accountMigrationInProgress:
{
Description: If customer initiated account migration is in progress, the value will be true else it will be null. ,
Required: False ,
}
boolean ,
}
,
}
StorageAccounts_List (updated)
Description :  Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageAccounts_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "primaryEndpoints": [
                  {
                    "@added_cdcf9a55877d42049620dc490e7acd46": {
                      "#name": "ipv6Endpoints",
                      "Description": "Gets the IPv6 storage endpoints.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "blob",
                          "Description": "Gets the blob endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "queue",
                          "Description": "Gets the queue endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "table",
                          "Description": "Gets the table endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "file",
                          "Description": "Gets the file endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "web",
                          "Description": "Gets the web endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "dfs",
                          "Description": "Gets the dfs endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "microsoftEndpoints",
                          "Description": "Gets the microsoft routing storage endpoints.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "blob",
                              "Description": "Gets the blob endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "queue",
                              "Description": "Gets the queue endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "table",
                              "Description": "Gets the table endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "file",
                              "Description": "Gets the file endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "web",
                              "Description": "Gets the web endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "dfs",
                              "Description": "Gets the dfs endpoint.",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        },
                        {
                          "#name": "internetEndpoints",
                          "Description": "Gets the internet routing storage endpoints",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "blob",
                              "Description": "Gets the blob endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "file",
                              "Description": "Gets the file endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "web",
                              "Description": "Gets the web endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "dfs",
                              "Description": "Gets the dfs endpoint.",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        }
                      ]
                    }
                  }
                ]
              },
              {
                "secondaryEndpoints": [
                  {
                    "@added_a51f79207443469098cd99152f700d29": {
                      "#name": "ipv6Endpoints",
                      "Description": "Gets the IPv6 storage endpoints.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "blob",
                          "Description": "Gets the blob endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "queue",
                          "Description": "Gets the queue endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "table",
                          "Description": "Gets the table endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "file",
                          "Description": "Gets the file endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "web",
                          "Description": "Gets the web endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "dfs",
                          "Description": "Gets the dfs endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "microsoftEndpoints",
                          "Description": "Gets the microsoft routing storage endpoints.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "blob",
                              "Description": "Gets the blob endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "queue",
                              "Description": "Gets the queue endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "table",
                              "Description": "Gets the table endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "file",
                              "Description": "Gets the file endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "web",
                              "Description": "Gets the web endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "dfs",
                              "Description": "Gets the dfs endpoint.",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        },
                        {
                          "#name": "internetEndpoints",
                          "Description": "Gets the internet routing storage endpoints",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "blob",
                              "Description": "Gets the blob endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "file",
                              "Description": "Gets the file endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "web",
                              "Description": "Gets the web endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "dfs",
                              "Description": "Gets the dfs endpoint.",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        }
                      ]
                    }
                  }
                ]
              },
              {
                "networkAcls": [
                  {
                    "ipRules": {
                      "$properties": [
                        {
                          "#name": "value",
                          "Description": {
                            "new": "Specifies the IP or IP range in CIDR format.",
                            "old": "Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed."
                          }
                        }
                      ]
                    }
                  },
                  {
                    "@added_09849642930648f18571fba2b8ff9f8e": {
                      "#name": "ipv6Rules",
                      "Description": "Sets the IPv6 ACL rules.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "IPv6 rule with specific IP or IP range in CIDR format.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "value",
                            "Description": "Specifies the IP or IP range in CIDR format.",
                            "Required": true,
                            "Type": "string"
                          },
                          {
                            "#name": "action",
                            "Description": "The action of IP ACL rule.",
                            "Enum": [
                              [
                                "Allow",
                                ""
                              ]
                            ],
                            "Required": false,
                            "Type": "string"
                          }
                        ]
                      }
                    }
                  }
                ]
              },
              {
                "@added_3e7fe356d2d348a6a0dc8d04e5d88b31": {
                  "#name": "dualStackEndpointPreference",
                  "Description": "Maintains information about the Internet protocol opted by the user.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "publishIpv6Endpoint",
                      "Description": "A boolean flag which indicates whether IPv6 storage endpoints are to be published.",
                      "Required": false,
                      "Type": "boolean"
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Storage/storageAccounts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of storage accounts and their properties. ,
Required: False ,
}
[
{
sku:
{
Description: Gets the SKU. ,
Required: False ,
}
{
name:
{
Description: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Gets the Kind. ,
Enum:
{
Storage: No description available. ,
StorageV2: No description available. ,
BlobStorage: No description available. ,
FileStorage: No description available. ,
BlockBlobStorage: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: Optional. Gets or sets the pinned logical availability zone for the storage account. ,
Required: False ,
}
[
string ,
]
,
placement:
{
Description: Optional. Gets or sets the zonal placement details for the storage account. ,
Required: False ,
}
{
zonePlacementPolicy:
{
Description: The availability zone pinning policy for the storage account. ,
Enum:
{
Any: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the storage account. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the storage account at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
ResolvingDNS: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEndpoints:
{
Description: 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. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
ipv6Endpoints:
{
Description: Gets the IPv6 storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
primaryLocation:
{
Description: Gets the location of the primary data center for the storage account. ,
Required: False ,
}
string ,
statusOfPrimary:
{
Description: Gets the status indicating whether the primary location of the storage account is available or unavailable. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
lastGeoFailoverTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
secondaryLocation:
{
Description: Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. ,
Required: False ,
}
string ,
statusOfSecondary:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Gets the creation date and time of the storage account in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
customDomain:
{
Description: Gets the custom domain the user assigned to this storage account. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. ,
Required: True ,
}
string ,
useSubDomainName:
{
Description: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. ,
Required: False ,
}
boolean ,
}
,
sasPolicy:
{
Description: SasPolicy assigned to the storage account. ,
Required: False ,
}
{
sasExpirationPeriod:
{
Description: The SAS expiration period, DD.HH:MM:SS. ,
Required: True ,
}
string ,
expirationAction:
{
Description: The SAS Expiration Action defines the action to be performed when sasPolicy.sasExpirationPeriod is violated. The 'Log' action can be used for audit purposes and the 'Block' action can be used to block and deny the usage of SAS tokens that do not adhere to the sas policy expiration period. ,
Enum:
{
Log: No description available. ,
Block: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
keyPolicy:
{
Description: KeyPolicy assigned to the storage account. ,
Required: False ,
}
{
keyExpirationPeriodInDays:
{
Description: The key expiration period in days. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
keyCreationTime:
{
Description: Storage account keys creation time. ,
Required: False ,
}
{
key1:
{
Format: date-time ,
Required: False ,
}
string ,
key2:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryEndpoints:
{
Description: 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. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
ipv6Endpoints:
{
Description: Gets the IPv6 storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
encryption:
{
Description: Encryption settings to be used for server-side encryption for the storage account. ,
Required: False ,
}
{
services:
{
Description: List of services which support encryption. ,
Required: False ,
}
{
blob:
{
Description: The encryption function of the blob storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
file:
{
Description: The encryption function of the file storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
table:
{
Description: The encryption function of the table storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
queue:
{
Description: The encryption function of the queue storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault ,
Enum:
{
Microsoft.Storage: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
boolean ,
keyvaultproperties:
{
Description: Properties provided by key vault. ,
Required: False ,
}
{
keyname:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
currentVersionedKeyExpirationTimestamp:
{
Description: This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity to be used with service-side encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. ,
Required: False ,
}
string ,
federatedIdentityClientId:
{
Description: ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. ,
Required: False ,
}
string ,
}
,
}
,
accessTier:
{
Description: Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The 'Premium' access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type. ,
Enum:
{
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
Cold: No description available. ,
}
,
Required: False ,
}
enum ,
azureFilesIdentityBasedAuthentication:
{
Description: Provides the identity based authentication settings for Azure Files. ,
Required: False ,
}
{
directoryServiceOptions:
{
Description: Indicates the directory service used. Note that this enum may be extended in the future. ,
Enum:
{
None: No description available. ,
AADDS: No description available. ,
AD: No description available. ,
AADKERB: No description available. ,
}
,
Required: True ,
}
enum ,
activeDirectoryProperties:
{
Description: Additional information about the directory service. Required if directoryServiceOptions is AD (AD DS authentication). Optional for directoryServiceOptions AADDS (Entra DS authentication) and AADKERB (Entra authentication). ,
Required: False ,
}
{
domainName:
{
Description: Specifies the primary domain that the AD DNS server is authoritative for. This property is required if directoryServiceOptions is set to AD (AD DS authentication). If directoryServiceOptions is set to AADDS (Entra DS authentication), providing this property is optional, as it will be inferred automatically if omitted. If directoryServiceOptions is set to AADKERB (Entra authentication), this property is optional; it is needed to support configuration of directory- and file-level permissions via Windows File Explorer, but is not required for authentication. ,
Required: False ,
}
string ,
netBiosDomainName:
{
Description: Specifies the NetBIOS domain name. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
forestName:
{
Description: Specifies the Active Directory forest to get. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
domainGuid:
{
Description: Specifies the domain GUID. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. If directoryServiceOptions is set to AADDS (Entra DS authentication), this property can be omitted. If directoryServiceOptions is set to AADKERB (Entra authentication), this property is optional; it is needed to support configuration of directory- and file-level permissions via Windows File Explorer, but is not required for authentication. ,
Required: False ,
}
string ,
domainSid:
{
Description: Specifies the security identifier (SID) of the AD domain. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
azureStorageSid:
{
Description: Specifies the security identifier (SID) for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
samAccountName:
{
Description: Specifies the Active Directory SAMAccountName for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is optional. If provided, accountType should also be provided. For directoryServiceOptions AADDS (Entra DS authentication) or AADKERB (Entra authentication), this property can be omitted. ,
Required: False ,
}
string ,
accountType:
{
Description: Specifies the Active Directory account type for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is optional. If provided, samAccountName should also be provided. For directoryServiceOptions AADDS (Entra DS authentication) or AADKERB (Entra authentication), this property can be omitted. ,
Enum:
{
User: No description available. ,
Computer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
defaultSharePermission:
{
Description: Default share permission for users using Kerberos authentication if RBAC role is not assigned. ,
Enum:
{
None: No description available. ,
StorageFileDataSmbShareReader: No description available. ,
StorageFileDataSmbShareContributor: No description available. ,
StorageFileDataSmbShareElevatedContributor: No description available. ,
}
,
Required: False ,
}
enum ,
smbOAuthSettings:
{
Description: Required for Managed Identities access using OAuth over SMB. ,
Required: False ,
}
{
isSmbOAuthEnabled:
{
Description: Specifies if managed identities can access SMB shares using OAuth. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
}
,
}
,
supportsHttpsTrafficOnly:
{
Description: Allows https traffic only to storage service if sets to true. ,
Required: False ,
}
boolean ,
networkAcls:
{
Description: Network rule set ,
Required: False ,
}
{
bypass:
{
Description: 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. ,
Enum:
{
None: No description available. ,
Logging: No description available. ,
Metrics: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
resourceAccessRules:
{
Description: Sets the resource access rules ,
Required: False ,
}
[
{
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: Sets the virtual network rules ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Gets the state of virtual network rule. ,
Enum:
{
Provisioning: No description available. ,
Deprovisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
NetworkSourceDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipRules:
{
Description: Sets the IP ACL rules ,
Required: False ,
}
[
{
value:
{
Description: Specifies the IP or IP range in CIDR format. ,
Required: True ,
}
string ,
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipv6Rules:
{
Description: Sets the IPv6 ACL rules. ,
Required: False ,
}
[
{
value:
{
Description: Specifies the IP or IP range in CIDR format. ,
Required: True ,
}
string ,
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultAction:
{
Description: Specifies the default action of allow or deny when no other rules match. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
isSftpEnabled:
{
Description: Enables Secure File Transfer Protocol, if set to true ,
Required: False ,
}
boolean ,
isLocalUserEnabled:
{
Description: Enables local users feature, if set to true ,
Required: False ,
}
boolean ,
enableExtendedGroups:
{
Description: Enables extended group support with local users feature, if set to true ,
Required: False ,
}
boolean ,
isHnsEnabled:
{
Description: Account HierarchicalNamespace enabled if sets to true. ,
Required: False ,
}
boolean ,
geoReplicationStats:
{
Description: Geo Replication Stats ,
Required: False ,
}
{
status:
{
Description: The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. ,
Enum:
{
Live: No description available. ,
Bootstrap: No description available. ,
Unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
lastSyncTime:
{
Description: All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. ,
Format: date-time ,
Required: False ,
}
string ,
canFailover:
{
Description: A boolean flag which indicates whether or not account failover is supported for the account. ,
Required: False ,
}
boolean ,
canPlannedFailover:
{
Description: A boolean flag which indicates whether or not planned account failover is supported for the account. ,
Required: False ,
}
boolean ,
postFailoverRedundancy:
{
Description: The redundancy type of the account after an account failover is performed. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_ZRS: No description available. ,
}
,
Required: False ,
}
enum ,
postPlannedFailoverRedundancy:
{
Description: The redundancy type of the account after a planned account failover is performed. ,
Enum:
{
Standard_GRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_RAGZRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
failoverInProgress:
{
Description: If the failover is in progress, the value will be true, otherwise, it will be null. ,
Required: False ,
}
boolean ,
largeFileSharesState:
{
Description: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified storage account ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
routingPreference:
{
Description: Maintains information about the network routing choice opted by the user for data transfer ,
Required: False ,
}
{
routingChoice:
{
Description: Routing Choice defines the kind of network routing opted by the user. ,
Enum:
{
MicrosoftRouting: No description available. ,
InternetRouting: No description available. ,
}
,
Required: False ,
}
enum ,
publishMicrosoftEndpoints:
{
Description: A boolean flag which indicates whether microsoft routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
publishInternetEndpoints:
{
Description: A boolean flag which indicates whether internet routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
}
,
dualStackEndpointPreference:
{
Description: Maintains information about the Internet protocol opted by the user. ,
Required: False ,
}
{
publishIpv6Endpoint:
{
Description: A boolean flag which indicates whether IPv6 storage endpoints are to be published. ,
Required: False ,
}
boolean ,
}
,
blobRestoreStatus:
{
Description: Blob restore status ,
Required: False ,
}
{
status:
{
Description: The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. ,
Enum:
{
InProgress: No description available. ,
Complete: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Failure reason when blob restore is failed. ,
Required: False ,
}
string ,
restoreId:
{
Description: Id for tracking blob restore request. ,
Required: False ,
}
string ,
parameters:
{
Description: Blob restore request parameters. ,
Required: False ,
}
{
timeToRestore:
{
Description: Restore blob to the specified time. ,
Format: date-time ,
Required: True ,
}
string ,
blobRanges:
{
Description: Blob ranges to restore. ,
Required: True ,
}
[
{
startRange:
{
Description: Blob start range. This is inclusive. Empty means account start. ,
Required: True ,
}
string ,
endRange:
{
Description: Blob end range. This is exclusive. Empty means account end. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
allowBlobPublicAccess:
{
Description: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
minimumTlsVersion:
{
Description: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. ,
Enum:
{
TLS1_0: No description available. ,
TLS1_1: No description available. ,
TLS1_2: No description available. ,
TLS1_3: No description available. ,
}
,
Required: False ,
}
enum ,
allowSharedKeyAccess:
{
Description: 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. ,
Required: False ,
}
boolean ,
isNfsV3Enabled:
{
Description: NFS 3.0 protocol support enabled if set to true. ,
Required: False ,
}
boolean ,
allowCrossTenantReplication:
{
Description: Allow or disallow cross AAD tenant object replication. Set this property to true for new or existing accounts only if object replication policies will involve storage accounts in different AAD tenants. The default interpretation is false for new accounts to follow best security practices by default. ,
Required: False ,
}
boolean ,
defaultToOAuthAuthentication:
{
Description: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
immutableStorageWithVersioning:
{
Description: The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the containers in the account by default. ,
Required: False ,
}
{
enabled:
{
Description: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. ,
Required: False ,
}
boolean ,
immutabilityPolicy:
{
Description: Specifies the default account-level immutability policy which is inherited and applied to objects that do not possess an explicit immutability policy at the object level. The object-level immutability policy has higher precedence than the container-level immutability policy, which has a higher precedence than the account-level immutability policy. ,
Required: False ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. ,
Enum:
{
Unlocked: No description available. ,
Locked: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: This property can only be changed for disabled and unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
}
,
}
,
allowedCopyScope:
{
Description: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. ,
Enum:
{
PrivateLink: No description available. ,
AAD: No description available. ,
}
,
Required: False ,
}
enum ,
storageAccountSkuConversionStatus:
{
Description: This property is readOnly and is set by server during asynchronous storage account sku conversion operations. ,
Required: False ,
}
{
skuConversionStatus:
{
Description: This property indicates the current sku conversion status. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
targetSkuName:
{
Description: This property represents the target sku name to which the account sku is being converted asynchronously. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: This property represents the sku conversion start time. ,
Required: False ,
}
string ,
endTime:
{
Description: This property represents the sku conversion end time. ,
Required: False ,
}
string ,
}
,
dnsEndpointType:
{
Description: Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. ,
Enum:
{
Standard: No description available. ,
AzureDnsZone: No description available. ,
}
,
Required: False ,
}
enum ,
isSkuConversionBlocked:
{
Description: This property will be set to true or false on an event of ongoing migration. Default value is null. ,
Required: False ,
}
boolean ,
accountMigrationInProgress:
{
Description: If customer initiated account migration is in progress, the value will be true else it will be null. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of storage accounts. Returned when total number of requested storage accounts exceed maximum page size. ,
Required: False ,
}
string ,
}
StorageAccounts_ListByResourceGroup (updated)
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.
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageAccounts_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "primaryEndpoints": [
                  {
                    "@added_f994da22c1f2497289232ab6d1601132": {
                      "#name": "ipv6Endpoints",
                      "Description": "Gets the IPv6 storage endpoints.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "blob",
                          "Description": "Gets the blob endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "queue",
                          "Description": "Gets the queue endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "table",
                          "Description": "Gets the table endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "file",
                          "Description": "Gets the file endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "web",
                          "Description": "Gets the web endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "dfs",
                          "Description": "Gets the dfs endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "microsoftEndpoints",
                          "Description": "Gets the microsoft routing storage endpoints.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "blob",
                              "Description": "Gets the blob endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "queue",
                              "Description": "Gets the queue endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "table",
                              "Description": "Gets the table endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "file",
                              "Description": "Gets the file endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "web",
                              "Description": "Gets the web endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "dfs",
                              "Description": "Gets the dfs endpoint.",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        },
                        {
                          "#name": "internetEndpoints",
                          "Description": "Gets the internet routing storage endpoints",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "blob",
                              "Description": "Gets the blob endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "file",
                              "Description": "Gets the file endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "web",
                              "Description": "Gets the web endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "dfs",
                              "Description": "Gets the dfs endpoint.",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        }
                      ]
                    }
                  }
                ]
              },
              {
                "secondaryEndpoints": [
                  {
                    "@added_086298ef23be4dbdb9c74bffc0c8cb8c": {
                      "#name": "ipv6Endpoints",
                      "Description": "Gets the IPv6 storage endpoints.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "blob",
                          "Description": "Gets the blob endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "queue",
                          "Description": "Gets the queue endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "table",
                          "Description": "Gets the table endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "file",
                          "Description": "Gets the file endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "web",
                          "Description": "Gets the web endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "dfs",
                          "Description": "Gets the dfs endpoint.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "microsoftEndpoints",
                          "Description": "Gets the microsoft routing storage endpoints.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "blob",
                              "Description": "Gets the blob endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "queue",
                              "Description": "Gets the queue endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "table",
                              "Description": "Gets the table endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "file",
                              "Description": "Gets the file endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "web",
                              "Description": "Gets the web endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "dfs",
                              "Description": "Gets the dfs endpoint.",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        },
                        {
                          "#name": "internetEndpoints",
                          "Description": "Gets the internet routing storage endpoints",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "blob",
                              "Description": "Gets the blob endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "file",
                              "Description": "Gets the file endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "web",
                              "Description": "Gets the web endpoint.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "dfs",
                              "Description": "Gets the dfs endpoint.",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        }
                      ]
                    }
                  }
                ]
              },
              {
                "networkAcls": [
                  {
                    "ipRules": {
                      "$properties": [
                        {
                          "#name": "value",
                          "Description": {
                            "new": "Specifies the IP or IP range in CIDR format.",
                            "old": "Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed."
                          }
                        }
                      ]
                    }
                  },
                  {
                    "@added_efdc88e0a3f5461eba391cf8c4a8e88e": {
                      "#name": "ipv6Rules",
                      "Description": "Sets the IPv6 ACL rules.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "IPv6 rule with specific IP or IP range in CIDR format.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "value",
                            "Description": "Specifies the IP or IP range in CIDR format.",
                            "Required": true,
                            "Type": "string"
                          },
                          {
                            "#name": "action",
                            "Description": "The action of IP ACL rule.",
                            "Enum": [
                              [
                                "Allow",
                                ""
                              ]
                            ],
                            "Required": false,
                            "Type": "string"
                          }
                        ]
                      }
                    }
                  }
                ]
              },
              {
                "@added_487336701c754a2d811a1572d903595f": {
                  "#name": "dualStackEndpointPreference",
                  "Description": "Maintains information about the Internet protocol opted by the user.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "publishIpv6Endpoint",
                      "Description": "A boolean flag which indicates whether IPv6 storage endpoints are to be published.",
                      "Required": false,
                      "Type": "boolean"
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of storage accounts and their properties. ,
Required: False ,
}
[
{
sku:
{
Description: Gets the SKU. ,
Required: False ,
}
{
name:
{
Description: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Gets the Kind. ,
Enum:
{
Storage: No description available. ,
StorageV2: No description available. ,
BlobStorage: No description available. ,
FileStorage: No description available. ,
BlockBlobStorage: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: Optional. Gets or sets the pinned logical availability zone for the storage account. ,
Required: False ,
}
[
string ,
]
,
placement:
{
Description: Optional. Gets or sets the zonal placement details for the storage account. ,
Required: False ,
}
{
zonePlacementPolicy:
{
Description: The availability zone pinning policy for the storage account. ,
Enum:
{
Any: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the storage account. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the storage account at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
ResolvingDNS: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEndpoints:
{
Description: 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. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
ipv6Endpoints:
{
Description: Gets the IPv6 storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
primaryLocation:
{
Description: Gets the location of the primary data center for the storage account. ,
Required: False ,
}
string ,
statusOfPrimary:
{
Description: Gets the status indicating whether the primary location of the storage account is available or unavailable. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
lastGeoFailoverTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
secondaryLocation:
{
Description: Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. ,
Required: False ,
}
string ,
statusOfSecondary:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Gets the creation date and time of the storage account in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
customDomain:
{
Description: Gets the custom domain the user assigned to this storage account. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. ,
Required: True ,
}
string ,
useSubDomainName:
{
Description: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. ,
Required: False ,
}
boolean ,
}
,
sasPolicy:
{
Description: SasPolicy assigned to the storage account. ,
Required: False ,
}
{
sasExpirationPeriod:
{
Description: The SAS expiration period, DD.HH:MM:SS. ,
Required: True ,
}
string ,
expirationAction:
{
Description: The SAS Expiration Action defines the action to be performed when sasPolicy.sasExpirationPeriod is violated. The 'Log' action can be used for audit purposes and the 'Block' action can be used to block and deny the usage of SAS tokens that do not adhere to the sas policy expiration period. ,
Enum:
{
Log: No description available. ,
Block: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
keyPolicy:
{
Description: KeyPolicy assigned to the storage account. ,
Required: False ,
}
{
keyExpirationPeriodInDays:
{
Description: The key expiration period in days. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
keyCreationTime:
{
Description: Storage account keys creation time. ,
Required: False ,
}
{
key1:
{
Format: date-time ,
Required: False ,
}
string ,
key2:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryEndpoints:
{
Description: 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. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
ipv6Endpoints:
{
Description: Gets the IPv6 storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
encryption:
{
Description: Encryption settings to be used for server-side encryption for the storage account. ,
Required: False ,
}
{
services:
{
Description: List of services which support encryption. ,
Required: False ,
}
{
blob:
{
Description: The encryption function of the blob storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
file:
{
Description: The encryption function of the file storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
table:
{
Description: The encryption function of the table storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
queue:
{
Description: The encryption function of the queue storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault ,
Enum:
{
Microsoft.Storage: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
boolean ,
keyvaultproperties:
{
Description: Properties provided by key vault. ,
Required: False ,
}
{
keyname:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
currentVersionedKeyExpirationTimestamp:
{
Description: This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity to be used with service-side encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. ,
Required: False ,
}
string ,
federatedIdentityClientId:
{
Description: ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. ,
Required: False ,
}
string ,
}
,
}
,
accessTier:
{
Description: Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The 'Premium' access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type. ,
Enum:
{
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
Cold: No description available. ,
}
,
Required: False ,
}
enum ,
azureFilesIdentityBasedAuthentication:
{
Description: Provides the identity based authentication settings for Azure Files. ,
Required: False ,
}
{
directoryServiceOptions:
{
Description: Indicates the directory service used. Note that this enum may be extended in the future. ,
Enum:
{
None: No description available. ,
AADDS: No description available. ,
AD: No description available. ,
AADKERB: No description available. ,
}
,
Required: True ,
}
enum ,
activeDirectoryProperties:
{
Description: Additional information about the directory service. Required if directoryServiceOptions is AD (AD DS authentication). Optional for directoryServiceOptions AADDS (Entra DS authentication) and AADKERB (Entra authentication). ,
Required: False ,
}
{
domainName:
{
Description: Specifies the primary domain that the AD DNS server is authoritative for. This property is required if directoryServiceOptions is set to AD (AD DS authentication). If directoryServiceOptions is set to AADDS (Entra DS authentication), providing this property is optional, as it will be inferred automatically if omitted. If directoryServiceOptions is set to AADKERB (Entra authentication), this property is optional; it is needed to support configuration of directory- and file-level permissions via Windows File Explorer, but is not required for authentication. ,
Required: False ,
}
string ,
netBiosDomainName:
{
Description: Specifies the NetBIOS domain name. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
forestName:
{
Description: Specifies the Active Directory forest to get. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
domainGuid:
{
Description: Specifies the domain GUID. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. If directoryServiceOptions is set to AADDS (Entra DS authentication), this property can be omitted. If directoryServiceOptions is set to AADKERB (Entra authentication), this property is optional; it is needed to support configuration of directory- and file-level permissions via Windows File Explorer, but is not required for authentication. ,
Required: False ,
}
string ,
domainSid:
{
Description: Specifies the security identifier (SID) of the AD domain. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
azureStorageSid:
{
Description: Specifies the security identifier (SID) for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. ,
Required: False ,
}
string ,
samAccountName:
{
Description: Specifies the Active Directory SAMAccountName for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is optional. If provided, accountType should also be provided. For directoryServiceOptions AADDS (Entra DS authentication) or AADKERB (Entra authentication), this property can be omitted. ,
Required: False ,
}
string ,
accountType:
{
Description: Specifies the Active Directory account type for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is optional. If provided, samAccountName should also be provided. For directoryServiceOptions AADDS (Entra DS authentication) or AADKERB (Entra authentication), this property can be omitted. ,
Enum:
{
User: No description available. ,
Computer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
defaultSharePermission:
{
Description: Default share permission for users using Kerberos authentication if RBAC role is not assigned. ,
Enum:
{
None: No description available. ,
StorageFileDataSmbShareReader: No description available. ,
StorageFileDataSmbShareContributor: No description available. ,
StorageFileDataSmbShareElevatedContributor: No description available. ,
}
,
Required: False ,
}
enum ,
smbOAuthSettings:
{
Description: Required for Managed Identities access using OAuth over SMB. ,
Required: False ,
}
{
isSmbOAuthEnabled:
{
Description: Specifies if managed identities can access SMB shares using OAuth. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
}
,
}
,
supportsHttpsTrafficOnly:
{
Description: Allows https traffic only to storage service if sets to true. ,
Required: False ,
}
boolean ,
networkAcls:
{
Description: Network rule set ,
Required: False ,
}
{
bypass:
{
Description: 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. ,
Enum:
{
None: No description available. ,
Logging: No description available. ,
Metrics: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
resourceAccessRules:
{
Description: Sets the resource access rules ,
Required: False ,
}
[
{
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: Sets the virtual network rules ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Gets the state of virtual network rule. ,
Enum:
{
Provisioning: No description available. ,
Deprovisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
NetworkSourceDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipRules:
{
Description: Sets the IP ACL rules ,
Required: False ,
}
[
{
value:
{
Description: Specifies the IP or IP range in CIDR format. ,
Required: True ,
}
string ,
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipv6Rules:
{
Description: Sets the IPv6 ACL rules. ,
Required: False ,
}
[
{
value:
{
Description: Specifies the IP or IP range in CIDR format. ,
Required: True ,
}
string ,
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultAction:
{
Description: Specifies the default action of allow or deny when no other rules match. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
isSftpEnabled:
{
Description: Enables Secure File Transfer Protocol, if set to true ,
Required: False ,
}
boolean ,
isLocalUserEnabled:
{
Description: Enables local users feature, if set to true ,
Required: False ,
}
boolean ,
enableExtendedGroups:
{
Description: Enables extended group support with local users feature, if set to true ,
Required: False ,
}
boolean ,
isHnsEnabled:
{
Description: Account HierarchicalNamespace enabled if sets to true. ,
Required: False ,
}
boolean ,
geoReplicationStats:
{
Description: Geo Replication Stats ,
Required: False ,
}
{
status:
{
Description: The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. ,
Enum:
{
Live: No description available. ,
Bootstrap: No description available. ,
Unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
lastSyncTime:
{
Description: All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. ,
Format: date-time ,
Required: False ,
}
string ,
canFailover:
{
Description: A boolean flag which indicates whether or not account failover is supported for the account. ,
Required: False ,
}
boolean ,
canPlannedFailover:
{
Description: A boolean flag which indicates whether or not planned account failover is supported for the account. ,
Required: False ,
}
boolean ,
postFailoverRedundancy:
{
Description: The redundancy type of the account after an account failover is performed. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_ZRS: No description available. ,
}
,
Required: False ,
}
enum ,
postPlannedFailoverRedundancy:
{
Description: The redundancy type of the account after a planned account failover is performed. ,
Enum:
{
Standard_GRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_RAGZRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
failoverInProgress:
{
Description: If the failover is in progress, the value will be true, otherwise, it will be null. ,
Required: False ,
}
boolean ,
largeFileSharesState:
{
Description: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified storage account ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
routingPreference:
{
Description: Maintains information about the network routing choice opted by the user for data transfer ,
Required: False ,
}
{
routingChoice:
{
Description: Routing Choice defines the kind of network routing opted by the user. ,
Enum:
{
MicrosoftRouting: No description available. ,
InternetRouting: No description available. ,
}
,
Required: False ,
}
enum ,
publishMicrosoftEndpoints:
{
Description: A boolean flag which indicates whether microsoft routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
publishInternetEndpoints:
{
Description: A boolean flag which indicates whether internet routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
}
,
dualStackEndpointPreference:
{
Description: Maintains information about the Internet protocol opted by the user. ,
Required: False ,
}
{
publishIpv6Endpoint:
{
Description: A boolean flag which indicates whether IPv6 storage endpoints are to be published. ,
Required: False ,
}
boolean ,
}
,
blobRestoreStatus:
{
Description: Blob restore status ,
Required: False ,
}
{
status:
{
Description: The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. ,
Enum:
{
InProgress: No description available. ,
Complete: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Failure reason when blob restore is failed. ,
Required: False ,
}
string ,
restoreId:
{
Description: Id for tracking blob restore request. ,
Required: False ,
}
string ,
parameters:
{
Description: Blob restore request parameters. ,
Required: False ,
}
{
timeToRestore:
{
Description: Restore blob to the specified time. ,
Format: date-time ,
Required: True ,
}
string ,
blobRanges:
{
Description: Blob ranges to restore. ,
Required: True ,
}
[
{
startRange:
{
Description: Blob start range. This is inclusive. Empty means account start. ,
Required: True ,
}
string ,
endRange:
{
Description: Blob end range. This is exclusive. Empty means account end. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
allowBlobPublicAccess:
{
Description: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
minimumTlsVersion:
{
Description: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. ,
Enum:
{
TLS1_0: No description available. ,
TLS1_1: No description available. ,
TLS1_2: No description available. ,
TLS1_3: No description available. ,
}
,
Required: False ,
}
enum ,
allowSharedKeyAccess:
{
Description: 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. ,
Required: False ,
}
boolean ,
isNfsV3Enabled:
{
Description: NFS 3.0 protocol support enabled if set to true. ,
Required: False ,
}
boolean ,
allowCrossTenantReplication:
{
Description: Allow or disallow cross AAD tenant object replication. Set this property to true for new or existing accounts only if object replication policies will involve storage accounts in different AAD tenants. The default interpretation is false for new accounts to follow best security practices by default. ,
Required: False ,
}
boolean ,
defaultToOAuthAuthentication:
{
Description: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
immutableStorageWithVersioning:
{
Description: The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the containers in the account by default. ,
Required: False ,
}
{
enabled:
{
Description: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. ,
Required: False ,
}
boolean ,
immutabilityPolicy:
{
Description: Specifies the default account-level immutability policy which is inherited and applied to objects that do not possess an explicit immutability policy at the object level. The object-level immutability policy has higher precedence than the container-level immutability policy, which has a higher precedence than the account-level immutability policy. ,
Required: False ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. ,
Enum:
{
Unlocked: No description available. ,
Locked: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: This property can only be changed for disabled and unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
}
,
}
,
allowedCopyScope:
{
Description: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. ,
Enum:
{
PrivateLink: No description available. ,
AAD: No description available. ,
}
,
Required: False ,
}
enum ,
storageAccountSkuConversionStatus:
{
Description: This property is readOnly and is set by server during asynchronous storage account sku conversion operations. ,
Required: False ,
}
{
skuConversionStatus:
{
Description: This property indicates the current sku conversion status. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
targetSkuName:
{
Description: This property represents the target sku name to which the account sku is being converted asynchronously. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: This property represents the sku conversion start time. ,
Required: False ,
}
string ,
endTime:
{
Description: This property represents the sku conversion end time. ,
Required: False ,
}
string ,
}
,
dnsEndpointType:
{
Description: Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. ,
Enum:
{
Standard: No description available. ,
AzureDnsZone: No description available. ,
}
,
Required: False ,
}
enum ,
isSkuConversionBlocked:
{
Description: This property will be set to true or false on an event of ongoing migration. Default value is null. ,
Required: False ,
}
boolean ,
accountMigrationInProgress:
{
Description: If customer initiated account migration is in progress, the value will be true else it will be null. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of storage accounts. Returned when total number of requested storage accounts exceed maximum page size. ,
Required: False ,
}
string ,
}
StorageAccounts_CustomerInitiatedMigration (updated)
Description :  Account Migration request can be triggered for a storage account to change its redundancy level. The migration updates the non-zonal redundant storage account to a zonal redundant account or vice-versa in order to have better reliability and availability. Zone-redundant storage (ZRS) replicates your storage account synchronously across three Azure availability zones in the primary region.
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageAccounts_CustomerInitiatedMigration",
  "$parameters": {
    "parameters": {
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "The properties of a storage account's ongoing or enqueued migration.",
            "old": "The properties of a storage account\u2019s ongoing or enqueued migration."
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/startAccountMigration
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters required to perform storage account migration. ,
Required: True ,
}
{
id:
{
Description: Migration Resource Id ,
Required: False ,
}
string ,
name:
{
Description: current value is 'default' for customer initiated migration ,
Required: False ,
}
string ,
type:
{
Description: SrpAccountMigrationType in ARM contract which is 'accountMigrations' ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a storage account's ongoing or enqueued migration. ,
Required: True ,
}
{
targetSkuName:
{
Description: Target sku name for the account ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
migrationStatus:
{
Description: Current status of migration ,
Enum:
{
Invalid: No description available. ,
SubmittedForConversion: No description available. ,
InProgress: No description available. ,
Complete: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
migrationFailedReason:
{
Description: Error code for migration failure ,
Required: False ,
}
string ,
migrationFailedDetailedReason:
{
Description: Reason for migration failure ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageAccounts_GetCustomerInitiatedMigration (updated)
Description :  Gets the status of the ongoing migration for the specified storage account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageAccounts_GetCustomerInitiatedMigration",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "The properties of a storage account's ongoing or enqueued migration.",
            "old": "The properties of a storage account\u2019s ongoing or enqueued migration."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/accountMigrations/{migrationName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
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. ,
Required: True ,
}
string ,
migrationName:
{
Description: The name of the Storage Account Migration. It should always be 'default' ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Migration Resource Id ,
Required: False ,
}
string ,
name:
{
Description: current value is 'default' for customer initiated migration ,
Required: False ,
}
string ,
type:
{
Description: SrpAccountMigrationType in ARM contract which is 'accountMigrations' ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a storage account's ongoing or enqueued migration. ,
Required: True ,
}
{
targetSkuName:
{
Description: Target sku name for the account ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
migrationStatus:
{
Description: Current status of migration ,
Enum:
{
Invalid: No description available. ,
SubmittedForConversion: No description available. ,
InProgress: No description available. ,
Complete: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
migrationFailedReason:
{
Description: Error code for migration failure ,
Required: False ,
}
string ,
migrationFailedDetailedReason:
{
Description: Reason for migration failure ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}