azure.mgmt.storage.models.StorageAccountProperties class

Constructor

StorageAccountProperties(*args: Any, **kwargs: Any)

Variables

Name	Description
provisioning_state	str or ProvisioningState Gets the status of the storage account at the time the operation was called. Known values are: "Creating", "ResolvingDNS", and "Succeeded".
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", "Cold", and "Smart".
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.
dual_stack_endpoint_preference	DualStackEndpointPreference Maintains information about the Internet protocol opted by the user.
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. Minimum TLS version 1.3 version is not supported. 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", "AAD", and "All".
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.
geo_priority_replication_status	GeoPriorityReplicationStatus Status indicating whether Geo Priority Replication is enabled for the account.
allow_shared_key_access_for_services	StorageAccountSharedKeyAccessProperties Indicate shared key access properties at service level.
data_collaboration_policy_properties	StorageDataCollaborationPolicyProperties Data Collaboration policy for the storage account.

access_tier

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", "Cold", and "Smart".

access_tier: str | _models.AccessTier | None

account_migration_in_progress

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

account_migration_in_progress: bool | None

allow_blob_public_access

Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property.

allow_blob_public_access: bool | None

allow_cross_tenant_replication

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.

allow_cross_tenant_replication: bool | None

allow_shared_key_access

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.

allow_shared_key_access: bool | None

allow_shared_key_access_for_services

Indicate shared key access properties at service level.

allow_shared_key_access_for_services: _models.StorageAccountSharedKeyAccessProperties | None

allowed_copy_scope

Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. Known values are: "PrivateLink", "AAD", and "All".

allowed_copy_scope: str | _models.AllowedCopyScope | None

azure_files_identity_based_authentication

Provides the identity based authentication settings for Azure Files.

azure_files_identity_based_authentication: _models.AzureFilesIdentityBasedAuthentication | None

blob_restore_status

Blob restore status.

blob_restore_status: _models.BlobRestoreStatus | None

creation_time

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

creation_time: datetime | None

custom_domain

Gets the custom domain the user assigned to this storage account.

custom_domain: _models.CustomDomain | None

data_collaboration_policy_properties

Data Collaboration policy for the storage account.

data_collaboration_policy_properties: _models.StorageDataCollaborationPolicyProperties | None

default_to_o_auth_authentication

A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property.

default_to_o_auth_authentication: bool | None

dns_endpoint_type

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".

dns_endpoint_type: str | _models.DnsEndpointType | None

dual_stack_endpoint_preference

Maintains information about the Internet protocol opted by the user.

dual_stack_endpoint_preference: _models.DualStackEndpointPreference | None

enable_extended_groups

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

enable_extended_groups: bool | None

enable_https_traffic_only

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

enable_https_traffic_only: bool | None

enable_nfs_v3

NFS 3.0 protocol support enabled if set to true.

enable_nfs_v3: bool | None

encryption

Encryption settings to be used for server-side encryption for the storage account.

encryption: _models.Encryption | None

failover_in_progress

If the failover is in progress, the value will be true, otherwise, it will be null.

failover_in_progress: bool | None

geo_priority_replication_status

Status indicating whether Geo Priority Replication is enabled for the account.

geo_priority_replication_status: _models.GeoPriorityReplicationStatus | None

geo_replication_stats

Geo Replication Stats.

geo_replication_stats: _models.GeoReplicationStats | None

immutable_storage_with_versioning

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.

immutable_storage_with_versioning: _models.ImmutableStorageAccount | None

is_hns_enabled

Account HierarchicalNamespace enabled if sets to true.

is_hns_enabled: bool | None

is_local_user_enabled

Enables local users feature, if set to true.

is_local_user_enabled: bool | None

is_sftp_enabled

Enables Secure File Transfer Protocol, if set to true.

is_sftp_enabled: bool | None

is_sku_conversion_blocked

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

is_sku_conversion_blocked: bool | None

key_creation_time

Storage account keys creation time.

key_creation_time: _models.KeyCreationTime | None

key_policy

KeyPolicy assigned to the storage account.

key_policy: _models.KeyPolicy | None

large_file_shares_state

Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. Known values are: "Disabled" and "Enabled".

large_file_shares_state: str | _models.LargeFileSharesState | None

last_geo_failover_time

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.

last_geo_failover_time: datetime | None

minimum_tls_version

Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. Minimum TLS version 1.3 version is not supported. Known values are: "TLS1_0", "TLS1_1", "TLS1_2", and "TLS1_3".

minimum_tls_version: str | _models.MinimumTlsVersion | None

network_rule_set

Network rule set.

network_rule_set: _models.NetworkRuleSet | None

primary_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_endpoints: _models.Endpoints | None

primary_location

Gets the location of the primary data center for the storage account.

primary_location: str | None

private_endpoint_connections

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

private_endpoint_connections: list['_models.PrivateEndpointConnection'] | None

provisioning_state

Gets the status of the storage account at the time the operation was called. Known values are: "Creating", "ResolvingDNS", and "Succeeded".

provisioning_state: str | _models.ProvisioningState | None

public_network_access

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

public_network_access: str | _models.PublicNetworkAccess | None

routing_preference

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

routing_preference: _models.RoutingPreference | None

sas_policy

SasPolicy assigned to the storage account.

sas_policy: _models.SasPolicy | None

secondary_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.

secondary_endpoints: _models.Endpoints | None

secondary_location

Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS.

secondary_location: str | None

status_of_primary

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

status_of_primary: str | _models.AccountStatus | None

status_of_secondary

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".

status_of_secondary: str | _models.AccountStatus | None

storage_account_sku_conversion_status

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

storage_account_sku_conversion_status: _models.StorageAccountSkuConversionStatus | None