StorageAccountCreateParameters interface

Package:

@azure/arm-storage-profile-2020-09-01-hybrid

The parameters used when creating a storage account.

Properties

accessTier	Required for storage accounts where kind = BlobStorage. The access tier used for billing.
allowBlobPublicAccess	Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property.
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.
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.
enableHttpsTrafficOnly	Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01.
encryption	Not applicable. Azure Storage encryption is enabled for all storage accounts and cannot be disabled.
identity	The identity of the resource.
isHnsEnabled	Account HierarchicalNamespace enabled if sets to true.
kind	Required. Indicates the type of storage account.
largeFileSharesState	Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled.
location	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.
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
routingPreference	Maintains information about the network routing choice opted by the user for data transfer
sku	Required. Gets or sets the SKU name.
tags	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.

Property Details

accessTier

Required for storage accounts where kind = BlobStorage. The access tier used for billing.

accessTier?: AccessTier

Property Value

AccessTier

allowBlobPublicAccess

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

allowBlobPublicAccess?: boolean

Property Value

boolean

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

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.

customDomain?: CustomDomain

Property Value

CustomDomain

enableHttpsTrafficOnly

Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01.

enableHttpsTrafficOnly?: boolean

Property Value

boolean

encryption

Not applicable. Azure Storage encryption is enabled for all storage accounts and cannot be disabled.

encryption?: Encryption

Property Value

Encryption

identity

The identity of the resource.

identity?: Identity

Property Value

Identity

isHnsEnabled

Account HierarchicalNamespace enabled if sets to true.

isHnsEnabled?: boolean

Property Value

boolean

kind

Required. Indicates the type of storage account.

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

location

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.

location: string

Property Value

string

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

networkRuleSet?: NetworkRuleSet

Property Value

NetworkRuleSet

routingPreference

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

routingPreference?: RoutingPreference

Property Value

RoutingPreference

sku

Required. Gets or sets the SKU name.

sku: Sku

Property Value

Sku

tags

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.

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

Property Value

{[propertyName: string]: string}