StorageAccountCreateParameters Class

The parameters used when creating a storage account.

All required parameters must be populated in order to send to Azure.

Inheritance

azure.mgmt.storage._serialization.Model

StorageAccountCreateParameters

Constructor

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)

Keyword-Only Parameters

Name	Description
sku	Sku Required. Gets or sets the SKU name. Required.
kind	str or Kind Required. Indicates the type of storage account. Required. Known values are: "Storage", "StorageV2", "BlobStorage", "FileStorage", and "BlockBlobStorage".
location	str 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.
extended_location	ExtendedLocation Optional. Set the extended location of the resource. If not set, the storage account will be created in Azure main region. Otherwise it will be created in the specified extended location.
tags	dict[str, str] 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.
identity	Identity The identity of the resource.
allowed_copy_scope	str or AllowedCopyScope 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".
public_network_access	str or PublicNetworkAccess 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".
sas_policy	SasPolicy SasPolicy assigned to the storage account.
key_policy	KeyPolicy KeyPolicy assigned to the storage account.
custom_domain	CustomDomain User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property.
encryption	Encryption Encryption settings to be used for server-side encryption for the storage account.
network_rule_set	NetworkRuleSet Network rule set.
access_tier	str or AccessTier 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".
azure_files_identity_based_authentication	AzureFilesIdentityBasedAuthentication Provides the identity based authentication settings for Azure Files.
enable_https_traffic_only	bool Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01.
is_sftp_enabled	bool Enables Secure File Transfer Protocol, if set to true.
is_local_user_enabled	bool Enables local users feature, if set to true.
is_hns_enabled	bool Account HierarchicalNamespace enabled if sets to true.
large_file_shares_state	str or LargeFileSharesState Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. Known values are: "Disabled" and "Enabled".
routing_preference	RoutingPreference Maintains information about the network routing choice opted by the user for data transfer.
allow_blob_public_access	bool Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property.
minimum_tls_version	str or MinimumTlsVersion 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".
allow_shared_key_access	bool 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.
enable_nfs_v3	bool NFS 3.0 protocol support enabled if set to true.
allow_cross_tenant_replication	bool 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.
default_to_o_auth_authentication	bool A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property.
immutable_storage_with_versioning	ImmutableStorageAccount 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.
dns_endpoint_type	str or DnsEndpointType 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".

Variables

Name	Description
sku	Sku Required. Gets or sets the SKU name. Required.
kind	str or Kind Required. Indicates the type of storage account. Required. Known values are: "Storage", "StorageV2", "BlobStorage", "FileStorage", and "BlockBlobStorage".
location	str 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.
extended_location	ExtendedLocation Optional. Set the extended location of the resource. If not set, the storage account will be created in Azure main region. Otherwise it will be created in the specified extended location.
tags	dict[str, str] 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.
identity	Identity The identity of the resource.
allowed_copy_scope	str or AllowedCopyScope 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".
public_network_access	str or PublicNetworkAccess 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".
sas_policy	SasPolicy SasPolicy assigned to the storage account.
key_policy	KeyPolicy KeyPolicy assigned to the storage account.
custom_domain	CustomDomain User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property.
encryption	Encryption Encryption settings to be used for server-side encryption for the storage account.
network_rule_set	NetworkRuleSet Network rule set.
access_tier	str or AccessTier 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".
azure_files_identity_based_authentication	AzureFilesIdentityBasedAuthentication Provides the identity based authentication settings for Azure Files.
enable_https_traffic_only	bool Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01.
is_sftp_enabled	bool Enables Secure File Transfer Protocol, if set to true.
is_local_user_enabled	bool Enables local users feature, if set to true.
is_hns_enabled	bool Account HierarchicalNamespace enabled if sets to true.
large_file_shares_state	str or LargeFileSharesState Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. Known values are: "Disabled" and "Enabled".
routing_preference	RoutingPreference Maintains information about the network routing choice opted by the user for data transfer.
allow_blob_public_access	bool Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property.
minimum_tls_version	str or MinimumTlsVersion 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".
allow_shared_key_access	bool 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.
enable_nfs_v3	bool NFS 3.0 protocol support enabled if set to true.
allow_cross_tenant_replication	bool 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.
default_to_o_auth_authentication	bool A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property.
immutable_storage_with_versioning	ImmutableStorageAccount 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.
dns_endpoint_type	str or DnsEndpointType 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".