Share via

StorageAccountUpdateParameters interface

  • Reference
Package:
@azure/arm-storage

The parameters that can be provided when updating the storage account properties.

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

Custom domain assigned to the storage account by the user. 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.
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.
enableExtendedGroups

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

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

Not applicable. Azure Storage encryption at rest is enabled by default for all storage accounts and cannot be disabled.
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.
isLocalUserEnabled

Enables local users feature, if set to true
isSftpEnabled

Enables Secure File Transfer Protocol, if set to true
keyPolicy

KeyPolicy assigned to the storage account.
kind

Optional. Indicates the type of storage account. Currently only StorageV2 value supported by server.
largeFileSharesState

Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled.
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
publicNetworkAccess

Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. Value is optional but if passed in, must be 'Enabled', 'Disabled' or 'SecuredByPerimeter'.
routingPreference

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

SasPolicy assigned to the storage account.
sku

Gets or sets the SKU name. Note that the SKU name cannot be updated to Standard_ZRS, Premium_LRS or Premium_ZRS, nor can accounts of those SKU names be updated to any other value.
tags

Gets or sets a list of key value pairs that describe the resource. These tags can be used in 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 no greater in length than 128 characters and a value no greater in length than 256 characters.

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.

accessTier?: AccessTier

Property Value

AccessTier

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

customDomain

Custom domain assigned to the storage account by the user. 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

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

enableExtendedGroups

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

enableExtendedGroups?: boolean

Property Value

boolean

enableHttpsTrafficOnly

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

enableHttpsTrafficOnly?: boolean

Property Value

boolean

encryption

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

encryption?: Encryption

Property Value

Encryption

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

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

keyPolicy

KeyPolicy assigned to the storage account.

keyPolicy?: KeyPolicy

Property Value

KeyPolicy

kind

Optional. Indicates the type of storage account. Currently only StorageV2 value supported by 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

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

publicNetworkAccess

Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. Value is optional but if passed in, must be 'Enabled', 'Disabled' or 'SecuredByPerimeter'.

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.

sasPolicy?: SasPolicy

Property Value

SasPolicy

sku

Gets or sets the SKU name. Note that the SKU name cannot be updated to Standard_ZRS, Premium_LRS or Premium_ZRS, nor can accounts of those SKU names be updated to any other value.

sku?: Sku

Property Value

Sku

tags

Gets or sets a list of key value pairs that describe the resource. These tags can be used in 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 no greater in length than 128 characters and a value no greater in length than 256 characters.

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

Property Value

{[propertyName: string]: string}