StorageAccount interface

Package:

@azure/arm-storage

The storage account.

Extends

TrackedResource

Properties

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. NOTE: This property will not be serialized. It can only be populated by the server.
accountMigrationInProgress	If customer initiated account migration is in progress, the value will be true else it will be null. NOTE: This property will not be serialized. It can only be populated by the server.
allowBlobPublicAccess	Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property.
allowCrossTenantReplication	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.
allowedCopyScope	Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet.
allowSharedKeyAccess	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.
azureFilesIdentityBasedAuthentication	Provides the identity based authentication settings for Azure Files.
blobRestoreStatus	Blob restore status NOTE: This property will not be serialized. It can only be populated by the server.
creationTime	Gets the creation date and time of the storage account in UTC. NOTE: This property will not be serialized. It can only be populated by the server.
customDomain	Gets the custom domain the user assigned to this storage account. NOTE: This property will not be serialized. It can only be populated by the server.
defaultToOAuthAuthentication	A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property.
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.
enableHttpsTrafficOnly	Allows https traffic only to storage service if sets to true.
enableNfsV3	NFS 3.0 protocol support enabled if set to true.
encryption	Encryption settings to be used for server-side encryption for the storage account. NOTE: This property will not be serialized. It can only be populated by the server.
extendedLocation	The extendedLocation of the resource.
failoverInProgress	If the failover is in progress, the value will be true, otherwise, it will be null. NOTE: This property will not be serialized. It can only be populated by the server.
geoReplicationStats	Geo Replication Stats NOTE: This property will not be serialized. It can only be populated by the server.
identity	The identity of the resource.
immutableStorageWithVersioning	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.
isHnsEnabled	Account HierarchicalNamespace enabled if sets to true.
isLocalUserEnabled	Enables local users feature, if set to true
isSftpEnabled	Enables Secure File Transfer Protocol, if set to true
isSkuConversionBlocked	This property will be set to true or false on an event of ongoing migration. Default value is null. NOTE: This property will not be serialized. It can only be populated by the server.
keyCreationTime	Storage account keys creation time. NOTE: This property will not be serialized. It can only be populated by the server.
keyPolicy	KeyPolicy assigned to the storage account. NOTE: This property will not be serialized. It can only be populated by the server.
kind	Gets the Kind. NOTE: This property will not be serialized. It can only be populated by the server.
largeFileSharesState	Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled.
lastGeoFailoverTime	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. NOTE: This property will not be serialized. It can only be populated by the server.
minimumTlsVersion	Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property.
networkRuleSet	Network rule set NOTE: This property will not be serialized. It can only be populated by the server.
primaryEndpoints	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. NOTE: This property will not be serialized. It can only be populated by the server.
primaryLocation	Gets the location of the primary data center for the storage account. NOTE: This property will not be serialized. It can only be populated by the server.
privateEndpointConnections	List of private endpoint connection associated with the specified storage account NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState	Gets the status of the storage account at the time the operation was called. NOTE: This property will not be serialized. It can only be populated by the server.
publicNetworkAccess	Allow or disallow public network access to Storage Account. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.
routingPreference	Maintains information about the network routing choice opted by the user for data transfer
sasPolicy	SasPolicy assigned to the storage account. NOTE: This property will not be serialized. It can only be populated by the server.
secondaryEndpoints	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. NOTE: This property will not be serialized. It can only be populated by the server.
secondaryLocation	Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. NOTE: This property will not be serialized. It can only be populated by the server.
sku	Gets the SKU. NOTE: This property will not be serialized. It can only be populated by the server.
statusOfPrimary	Gets the status indicating whether the primary location of the storage account is available or unavailable. NOTE: This property will not be serialized. It can only be populated by the server.
statusOfSecondary	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. NOTE: This property will not be serialized. It can only be populated by the server.
storageAccountSkuConversionStatus	This property is readOnly and is set by server during asynchronous storage account sku conversion operations.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
location	The geo-location where the resource lives
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

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. NOTE: This property will not be serialized. It can only be populated by the server.

accessTier?: AccessTier

Property Value

AccessTier

accountMigrationInProgress

If customer initiated account migration is in progress, the value will be true else it will be null. NOTE: This property will not be serialized. It can only be populated by the server.

accountMigrationInProgress?: boolean

Property Value

boolean

allowBlobPublicAccess

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

allowBlobPublicAccess?: boolean

Property Value

boolean

allowCrossTenantReplication

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.

allowCrossTenantReplication?: boolean

Property Value

boolean

allowedCopyScope

Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet.

allowedCopyScope?: string

Property Value

string

allowSharedKeyAccess

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.

allowSharedKeyAccess?: boolean

Property Value

boolean

azureFilesIdentityBasedAuthentication

Provides the identity based authentication settings for Azure Files.

azureFilesIdentityBasedAuthentication?: AzureFilesIdentityBasedAuthentication

Property Value

AzureFilesIdentityBasedAuthentication

blobRestoreStatus

Blob restore status NOTE: This property will not be serialized. It can only be populated by the server.

blobRestoreStatus?: BlobRestoreStatus

Property Value

BlobRestoreStatus

creationTime

Gets the creation date and time of the storage account in UTC. NOTE: This property will not be serialized. It can only be populated by the server.

creationTime?: Date

Property Value

Date

customDomain

Gets the custom domain the user assigned to this storage account. NOTE: This property will not be serialized. It can only be populated by the server.

customDomain?: CustomDomain

Property Value

CustomDomain

defaultToOAuthAuthentication

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

defaultToOAuthAuthentication?: boolean

Property Value

boolean

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.

dnsEndpointType?: string

Property Value

string

enableHttpsTrafficOnly

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

enableHttpsTrafficOnly?: boolean

Property Value

boolean

enableNfsV3

NFS 3.0 protocol support enabled if set to true.

enableNfsV3?: boolean

Property Value

boolean

encryption

Encryption settings to be used for server-side encryption for the storage account. NOTE: This property will not be serialized. It can only be populated by the server.

encryption?: Encryption

Property Value

Encryption

extendedLocation

The extendedLocation of the resource.

extendedLocation?: ExtendedLocation

Property Value

ExtendedLocation

failoverInProgress

If the failover is in progress, the value will be true, otherwise, it will be null. NOTE: This property will not be serialized. It can only be populated by the server.

failoverInProgress?: boolean

Property Value

boolean

geoReplicationStats

Geo Replication Stats NOTE: This property will not be serialized. It can only be populated by the server.

geoReplicationStats?: GeoReplicationStats

Property Value

GeoReplicationStats

identity

The identity of the resource.

identity?: Identity

Property Value

Identity

immutableStorageWithVersioning

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.

immutableStorageWithVersioning?: ImmutableStorageAccount

Property Value

ImmutableStorageAccount

isHnsEnabled

Account HierarchicalNamespace enabled if sets to true.

isHnsEnabled?: boolean

Property Value

boolean

isLocalUserEnabled

Enables local users feature, if set to true

isLocalUserEnabled?: boolean

Property Value

boolean

isSftpEnabled

Enables Secure File Transfer Protocol, if set to true

isSftpEnabled?: boolean

Property Value

boolean

isSkuConversionBlocked

This property will be set to true or false on an event of ongoing migration. Default value is null. NOTE: This property will not be serialized. It can only be populated by the server.

isSkuConversionBlocked?: boolean

Property Value

boolean

keyCreationTime

Storage account keys creation time. NOTE: This property will not be serialized. It can only be populated by the server.

keyCreationTime?: KeyCreationTime

Property Value

KeyCreationTime

keyPolicy

KeyPolicy assigned to the storage account. NOTE: This property will not be serialized. It can only be populated by the server.

keyPolicy?: KeyPolicy

Property Value

KeyPolicy

kind

Gets the Kind. NOTE: This property will not be serialized. It can only be populated by the server.

kind?: string

Property Value

string

largeFileSharesState

Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled.

largeFileSharesState?: string

Property Value

string

lastGeoFailoverTime

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. NOTE: This property will not be serialized. It can only be populated by the server.

lastGeoFailoverTime?: Date

Property Value

Date

minimumTlsVersion

Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property.

minimumTlsVersion?: string

Property Value

string

networkRuleSet

Network rule set NOTE: This property will not be serialized. It can only be populated by the server.

networkRuleSet?: NetworkRuleSet

Property Value

NetworkRuleSet

primaryEndpoints

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. NOTE: This property will not be serialized. It can only be populated by the server.

primaryEndpoints?: Endpoints

Property Value

Endpoints

primaryLocation

Gets the location of the primary data center for the storage account. NOTE: This property will not be serialized. It can only be populated by the server.

primaryLocation?: string

Property Value

string

privateEndpointConnections

List of private endpoint connection associated with the specified storage account NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

provisioningState

Gets the status of the storage account at the time the operation was called. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: ProvisioningState

Property Value

ProvisioningState

publicNetworkAccess

Allow or disallow public network access to Storage Account. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.

publicNetworkAccess?: string

Property Value

string

routingPreference

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

routingPreference?: RoutingPreference

Property Value

RoutingPreference

sasPolicy

SasPolicy assigned to the storage account. NOTE: This property will not be serialized. It can only be populated by the server.

sasPolicy?: SasPolicy

Property Value

SasPolicy

secondaryEndpoints

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. NOTE: This property will not be serialized. It can only be populated by the server.

secondaryEndpoints?: Endpoints

Property Value

Endpoints

secondaryLocation

Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. NOTE: This property will not be serialized. It can only be populated by the server.

secondaryLocation?: string

Property Value

string

sku

Gets the SKU. NOTE: This property will not be serialized. It can only be populated by the server.

sku?: Sku

Property Value

Sku

statusOfPrimary

Gets the status indicating whether the primary location of the storage account is available or unavailable. NOTE: This property will not be serialized. It can only be populated by the server.

statusOfPrimary?: AccountStatus

Property Value

AccountStatus

statusOfSecondary

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. NOTE: This property will not be serialized. It can only be populated by the server.

statusOfSecondary?: AccountStatus

Property Value

AccountStatus

storageAccountSkuConversionStatus

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

storageAccountSkuConversionStatus?: StorageAccountSkuConversionStatus

Property Value

StorageAccountSkuConversionStatus

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type