azure.mgmt.storage.v2022_05_01.models.StorageAccountCreateParameters.yml

### YamlMime:PythonClass
uid: azure.mgmt.storage.v2022_05_01.models.StorageAccountCreateParameters
name: StorageAccountCreateParameters
fullName: azure.mgmt.storage.v2022_05_01.models.StorageAccountCreateParameters
module: azure.mgmt.storage.v2022_05_01.models
inheritances:
- azure.mgmt.storage._serialization.Model
summary: 'The parameters used when creating a storage account.


  All required parameters must be populated in order to send to server.'
constructor:
  syntax: 'StorageAccountCreateParameters(*, sku: _models.Sku, kind: str | _models.Kind,
    location: str, extended_location: _models.ExtendedLocation | None = None, tags:
    Dict[str, str] | None = None, identity: _models.Identity | None = None, allowed_copy_scope:
    str | _models.AllowedCopyScope | None = None, public_network_access: str | _models.PublicNetworkAccess
    | None = None, sas_policy: _models.SasPolicy | None = None, key_policy: _models.KeyPolicy
    | None = None, custom_domain: _models.CustomDomain | None = None, encryption:
    _models.Encryption | None = None, network_rule_set: _models.NetworkRuleSet | None
    = None, access_tier: str | _models.AccessTier | None = None, azure_files_identity_based_authentication:
    _models.AzureFilesIdentityBasedAuthentication | None = None, enable_https_traffic_only:
    bool | None = None, is_sftp_enabled: bool | None = None, is_local_user_enabled:
    bool | None = None, is_hns_enabled: bool | None = None, large_file_shares_state:
    str | _models.LargeFileSharesState | None = None, routing_preference: _models.RoutingPreference
    | None = None, allow_blob_public_access: bool | None = None, minimum_tls_version:
    str | _models.MinimumTlsVersion | None = None, allow_shared_key_access: bool |
    None = None, enable_nfs_v3: bool | None = None, allow_cross_tenant_replication:
    bool | None = None, default_to_o_auth_authentication: bool | None = None, immutable_storage_with_versioning:
    _models.ImmutableStorageAccount | None = None, dns_endpoint_type: str | _models.DnsEndpointType
    | None = None, **kwargs: Any)'
  keywordOnlyParameters:
  - name: sku
    description: Required. Gets or sets the SKU name. Required.
    types:
    - <xref:azure.mgmt.storage.v2022_05_01.models.Sku>
  - name: kind
    description: 'Required. Indicates the type of storage account. Required. Known
      values are:

      "Storage", "StorageV2", "BlobStorage", "FileStorage", and "BlockBlobStorage".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.storage.v2022_05_01.models.Kind>
  - name: 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.'
    types:
    - <xref:str>
  - name: extended_location
    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.'
    types:
    - <xref:azure.mgmt.storage.v2022_05_01.models.ExtendedLocation>
  - name: 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.'
    types:
    - <xref:dict>[<xref:str>, <xref:str>]
  - name: identity
    description: The identity of the resource.
    types:
    - <xref:azure.mgmt.storage.v2022_05_01.models.Identity>
  - name: allowed_copy_scope
    description: 'Restrict copy to and from Storage Accounts within an AAD tenant
      or

      with Private Links to the same VNet. Known values are: "PrivateLink" and "AAD".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.storage.v2022_05_01.models.AllowedCopyScope>
  - name: public_network_access
    description: 'Allow or disallow public network access to Storage Account.

      Value is optional but if passed in, must be ''Enabled'' or ''Disabled''. Known
      values are:

      "Enabled" and "Disabled".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.storage.v2022_05_01.models.PublicNetworkAccess>
  - name: sas_policy
    description: SasPolicy assigned to the storage account.
    types:
    - <xref:azure.mgmt.storage.v2022_05_01.models.SasPolicy>
  - name: key_policy
    description: KeyPolicy assigned to the storage account.
    types:
    - <xref:azure.mgmt.storage.v2022_05_01.models.KeyPolicy>
  - name: custom_domain
    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.'
    types:
    - <xref:azure.mgmt.storage.v2022_05_01.models.CustomDomain>
  - name: encryption
    description: 'Encryption settings to be used for server-side encryption for the
      storage

      account.'
    types:
    - <xref:azure.mgmt.storage.v2022_05_01.models.Encryption>
  - name: network_rule_set
    description: Network rule set.
    types:
    - <xref:azure.mgmt.storage.v2022_05_01.models.NetworkRuleSet>
  - name: access_tier
    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.

      Known values are: "Hot", "Cool", and "Premium".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.storage.v2022_05_01.models.AccessTier>
  - name: azure_files_identity_based_authentication
    description: 'Provides the identity based authentication

      settings for Azure Files.'
    types:
    - <xref:azure.mgmt.storage.v2022_05_01.models.AzureFilesIdentityBasedAuthentication>
  - name: enable_https_traffic_only
    description: 'Allows https traffic only to storage service if sets to

      true. The default value is true since API version 2019-04-01.'
    types:
    - <xref:bool>
  - name: is_sftp_enabled
    description: Enables Secure File Transfer Protocol, if set to true.
    types:
    - <xref:bool>
  - name: is_local_user_enabled
    description: Enables local users feature, if set to true.
    types:
    - <xref:bool>
  - name: is_hns_enabled
    description: Account HierarchicalNamespace enabled if sets to true.
    types:
    - <xref:bool>
  - name: large_file_shares_state
    description: 'Allow large file shares if sets to Enabled. It cannot be

      disabled once it is enabled. Known values are: "Disabled" and "Enabled".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.storage.v2022_05_01.models.LargeFileSharesState>
  - name: routing_preference
    description: 'Maintains information about the network routing choice opted by

      the user for data transfer.'
    types:
    - <xref:azure.mgmt.storage.v2022_05_01.models.RoutingPreference>
  - name: allow_blob_public_access
    description: 'Allow or disallow public access to all blobs or containers

      in the storage account. The default interpretation is true for this property.'
    types:
    - <xref:bool>
  - name: minimum_tls_version
    description: 'Set the minimum TLS version to be permitted on requests to

      storage. The default interpretation is TLS 1.0 for this property. Known values
      are: "TLS1_0",

      "TLS1_1", and "TLS1_2".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.storage.v2022_05_01.models.MinimumTlsVersion>
  - name: allow_shared_key_access
    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.'
    types:
    - <xref:bool>
  - name: enable_nfs_v3
    description: NFS 3.0 protocol support enabled if set to true.
    types:
    - <xref:bool>
  - name: allow_cross_tenant_replication
    description: 'Allow or disallow cross AAD tenant object replication.

      The default interpretation is true for this property.'
    types:
    - <xref:bool>
  - name: default_to_o_auth_authentication
    description: 'A boolean flag which indicates whether the default

      authentication is OAuth or not. The default interpretation is false for this
      property.'
    types:
    - <xref:bool>
  - name: immutable_storage_with_versioning
    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.'
    types:
    - <xref:azure.mgmt.storage.v2022_05_01.models.ImmutableStorageAccount>
  - name: dns_endpoint_type
    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. Known values are: "Standard" and "AzureDnsZone".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.storage.v2022_05_01.models.DnsEndpointType>
variables:
- description: Required. Gets or sets the SKU name. Required.
  name: sku
  types:
  - <xref:azure.mgmt.storage.v2022_05_01.models.Sku>
- description: 'Required. Indicates the type of storage account. Required. Known values
    are:

    "Storage", "StorageV2", "BlobStorage", "FileStorage", and "BlockBlobStorage".'
  name: kind
  types:
  - <xref:str>
  - <xref:azure.mgmt.storage.v2022_05_01.models.Kind>
- 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.'
  name: location
  types:
  - <xref:str>
- 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.'
  name: extended_location
  types:
  - <xref:azure.mgmt.storage.v2022_05_01.models.ExtendedLocation>
- 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.'
  name: tags
  types:
  - <xref:dict>[<xref:str>, <xref:str>]
- description: The identity of the resource.
  name: identity
  types:
  - <xref:azure.mgmt.storage.v2022_05_01.models.Identity>
- description: 'Restrict copy to and from Storage Accounts within an AAD tenant or

    with Private Links to the same VNet. Known values are: "PrivateLink" and "AAD".'
  name: allowed_copy_scope
  types:
  - <xref:str>
  - <xref:azure.mgmt.storage.v2022_05_01.models.AllowedCopyScope>
- description: 'Allow or disallow public network access to Storage Account. Value

    is optional but if passed in, must be ''Enabled'' or ''Disabled''. Known values
    are: "Enabled" and

    "Disabled".'
  name: public_network_access
  types:
  - <xref:str>
  - <xref:azure.mgmt.storage.v2022_05_01.models.PublicNetworkAccess>
- description: SasPolicy assigned to the storage account.
  name: sas_policy
  types:
  - <xref:azure.mgmt.storage.v2022_05_01.models.SasPolicy>
- description: KeyPolicy assigned to the storage account.
  name: key_policy
  types:
  - <xref:azure.mgmt.storage.v2022_05_01.models.KeyPolicy>
- 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.'
  name: custom_domain
  types:
  - <xref:azure.mgmt.storage.v2022_05_01.models.CustomDomain>
- description: 'Encryption settings to be used for server-side encryption for the
    storage

    account.'
  name: encryption
  types:
  - <xref:azure.mgmt.storage.v2022_05_01.models.Encryption>
- description: Network rule set.
  name: network_rule_set
  types:
  - <xref:azure.mgmt.storage.v2022_05_01.models.NetworkRuleSet>
- 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.

    Known values are: "Hot", "Cool", and "Premium".'
  name: access_tier
  types:
  - <xref:str>
  - <xref:azure.mgmt.storage.v2022_05_01.models.AccessTier>
- description: 'Provides the identity based authentication

    settings for Azure Files.'
  name: azure_files_identity_based_authentication
  types:
  - <xref:azure.mgmt.storage.v2022_05_01.models.AzureFilesIdentityBasedAuthentication>
- description: 'Allows https traffic only to storage service if sets to true.

    The default value is true since API version 2019-04-01.'
  name: enable_https_traffic_only
  types:
  - <xref:bool>
- description: Enables Secure File Transfer Protocol, if set to true.
  name: is_sftp_enabled
  types:
  - <xref:bool>
- description: Enables local users feature, if set to true.
  name: is_local_user_enabled
  types:
  - <xref:bool>
- description: Account HierarchicalNamespace enabled if sets to true.
  name: is_hns_enabled
  types:
  - <xref:bool>
- description: 'Allow large file shares if sets to Enabled. It cannot be

    disabled once it is enabled. Known values are: "Disabled" and "Enabled".'
  name: large_file_shares_state
  types:
  - <xref:str>
  - <xref:azure.mgmt.storage.v2022_05_01.models.LargeFileSharesState>
- description: 'Maintains information about the network routing choice opted by the

    user for data transfer.'
  name: routing_preference
  types:
  - <xref:azure.mgmt.storage.v2022_05_01.models.RoutingPreference>
- description: 'Allow or disallow public access to all blobs or containers in

    the storage account. The default interpretation is true for this property.'
  name: allow_blob_public_access
  types:
  - <xref:bool>
- description: 'Set the minimum TLS version to be permitted on requests to storage.

    The default interpretation is TLS 1.0 for this property. Known values are: "TLS1_0",
    "TLS1_1",

    and "TLS1_2".'
  name: minimum_tls_version
  types:
  - <xref:str>
  - <xref:azure.mgmt.storage.v2022_05_01.models.MinimumTlsVersion>
- 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.'
  name: allow_shared_key_access
  types:
  - <xref:bool>
- description: NFS 3.0 protocol support enabled if set to true.
  name: enable_nfs_v3
  types:
  - <xref:bool>
- description: 'Allow or disallow cross AAD tenant object replication.

    The default interpretation is true for this property.'
  name: allow_cross_tenant_replication
  types:
  - <xref:bool>
- description: 'A boolean flag which indicates whether the default

    authentication is OAuth or not. The default interpretation is false for this property.'
  name: default_to_o_auth_authentication
  types:
  - <xref:bool>
- 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.'
  name: immutable_storage_with_versioning
  types:
  - <xref:azure.mgmt.storage.v2022_05_01.models.ImmutableStorageAccount>
- 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.
    Known values

    are: "Standard" and "AzureDnsZone".'
  name: dns_endpoint_type
  types:
  - <xref:str>
  - <xref:azure.mgmt.storage.v2022_05_01.models.DnsEndpointType>