Share via

StorageAccount Class

The storage account.

Variables are only populated by the server, and will be ignored when sending a request.

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

Constructor

StorageAccount(*, ___location: str, tags: Dict[str, str] | None = None, identity: _models.Identity | None = None, extended_location: _models.ExtendedLocation | 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, enable_extended_groups: 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, public_network_access: str | _models.PublicNetworkAccess | None = None, immutable_storage_with_versioning: _models.ImmutableStorageAccount | None = None, allowed_copy_scope: str | _models.AllowedCopyScope | None = None, storage_account_sku_conversion_status: _models.StorageAccountSkuConversionStatus | None = None, dns_endpoint_type: str | _models.DnsEndpointType | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
tags
dict[str, str]

Resource tags.

Default value: None
___location
str

The geo-___location where the resource lives. Required.
identity
Identity

The identity of the resource.

Default value: None
extended_location
ExtendedLocation

The extendedLocation of the resource.

Default value: None
azure_files_identity_based_authentication
AzureFilesIdentityBasedAuthentication

Provides the identity based authentication settings for Azure Files.

Default value: None
enable_https_traffic_only
bool

Allows https traffic only to storage service if sets to true.

Default value: None
is_sftp_enabled
bool

Enables Secure File Transfer Protocol, if set to true.

Default value: None
is_local_user_enabled
bool

Enables local users feature, if set to true.

Default value: None
enable_extended_groups
bool

Enables extended group support with local users feature, if set to true.

Default value: None
is_hns_enabled
bool

Account HierarchicalNamespace enabled if sets to true.

Default value: None
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".

Default value: None
routing_preference
RoutingPreference

Maintains information about the network routing choice opted by the user for data transfer.

Default value: None
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.

Default value: None
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", "TLS1_2", and "TLS1_3".

Default value: None
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.

Default value: None
enable_nfs_v3
bool

NFS 3.0 protocol support enabled if set to true.

Default value: None
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 value: None
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.

Default value: None
public_network_access
str or PublicNetworkAccess

Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. Known values are: "Enabled", "Disabled", and "SecuredByPerimeter".

Default value: None
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 containers in the account by default.

Default value: None
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".

Default value: None
storage_account_sku_conversion_status
StorageAccountSkuConversionStatus

This property is readOnly and is set by server during asynchronous storage account sku conversion operations.

Default value: None
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".

Default value: None

Variables

Name Description
id
str

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name
str

The name of the resource.
type
str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
tags
dict[str, str]

Resource tags.
___location
str

The geo-___location where the resource lives. Required.
sku
Sku

Gets the SKU.
kind
str or Kind

Gets the Kind. Known values are: "Storage", "StorageV2", "BlobStorage", "FileStorage", and "BlockBlobStorage".
identity
Identity

The identity of the resource.
extended_location
ExtendedLocation

The extendedLocation of the resource.
provisioning_state
str or ProvisioningState

Gets the status of the storage account at the time the operation was called. Known values are: "Creating", "ResolvingDNS", "Succeeded", "ValidateSubscriptionQuotaBegin", "ValidateSubscriptionQuotaEnd", "Accepted", "Deleting", "Canceled", and "Failed".
primary_endpoints
Endpoints

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.
primary_location
str

Gets the ___location of the primary data center for the storage account.
status_of_primary
str or AccountStatus

Gets the status indicating whether the primary ___location of the storage account is available or unavailable. Known values are: "available" and "unavailable".
last_geo_failover_time
datetime

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.
secondary_location
str

Gets the ___location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS.
status_of_secondary
str or AccountStatus

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. Known values are: "available" and "unavailable".
creation_time
datetime

Gets the creation date and time of the storage account in UTC.
custom_domain
CustomDomain

Gets the custom ___domain the user assigned to this storage account.
sas_policy
SasPolicy

SasPolicy assigned to the storage account.
key_policy
KeyPolicy

KeyPolicy assigned to the storage account.
key_creation_time
KeyCreationTime

Storage account keys creation time.
secondary_endpoints
Endpoints

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.
encryption
Encryption

Encryption settings to be used for server-side encryption for the storage account.
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", "Premium", and "Cold".
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.
network_rule_set
NetworkRuleSet

Network rule set.
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.
enable_extended_groups
bool

Enables extended group support with local users feature, if set to true.
is_hns_enabled
bool

Account HierarchicalNamespace enabled if sets to true.
geo_replication_stats
GeoReplicationStats

Geo Replication Stats.
failover_in_progress
bool

If the failover is in progress, the value will be true, otherwise, it will be null.
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".
private_endpoint_connections
list[PrivateEndpointConnection]

List of private endpoint connection associated with the specified storage account.
routing_preference
RoutingPreference

Maintains information about the network routing choice opted by the user for data transfer.
blob_restore_status
BlobRestoreStatus

Blob restore status.
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", "TLS1_2", and "TLS1_3".
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.
public_network_access
str or PublicNetworkAccess

Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. Known values are: "Enabled", "Disabled", and "SecuredByPerimeter".
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 containers in the account by default.
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".
storage_account_sku_conversion_status
StorageAccountSkuConversionStatus

This property is readOnly and is set by server during asynchronous storage account sku conversion operations.
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".
is_sku_conversion_blocked
bool

This property will be set to true or false on an event of ongoing migration. Default value is null.
account_migration_in_progress
bool

If customer initiated account migration is in progress, the value will be true else it will be null.