Package version:

Interface StorageAccountUpdateParameters

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

interface StorageAccountUpdateParameters {
    accessTier?: AccessTier;
    allowBlobPublicAccess?: boolean;
    allowCrossTenantReplication?: boolean;
    allowedCopyScope?: string;
    allowSharedKeyAccess?: boolean;
    azureFilesIdentityBasedAuthentication?: AzureFilesIdentityBasedAuthentication;
    customDomain?: CustomDomain;
    defaultToOAuthAuthentication?: boolean;
    dnsEndpointType?: string;
    enableExtendedGroups?: boolean;
    enableHttpsTrafficOnly?: boolean;
    encryption?: Encryption;
    identity?: Identity;
    immutableStorageWithVersioning?: ImmutableStorageAccount;
    isLocalUserEnabled?: boolean;
    isSftpEnabled?: boolean;
    keyPolicy?: KeyPolicy;
    kind?: string;
    largeFileSharesState?: string;
    minimumTlsVersion?: string;
    networkRuleSet?: NetworkRuleSet;
    publicNetworkAccess?: string;
    routingPreference?: RoutingPreference;
    sasPolicy?: SasPolicy;
    sku?: Sku;
    tags?: {
        [propertyName: string]: string;
    };
}

Properties

accessTier? allowBlobPublicAccess? allowCrossTenantReplication? allowedCopyScope? allowSharedKeyAccess? azureFilesIdentityBasedAuthentication? customDomain? defaultToOAuthAuthentication? dnsEndpointType? enableExtendedGroups? enableHttpsTrafficOnly? encryption? identity? immutableStorageWithVersioning? isLocalUserEnabled? isSftpEnabled? keyPolicy? kind? largeFileSharesState? minimumTlsVersion? networkRuleSet? publicNetworkAccess? routingPreference? sasPolicy? sku? tags?

Properties

OptionalaccessTier

accessTier?: 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.

OptionalallowBlobPublicAccess

allowBlobPublicAccess?: boolean

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

OptionalallowCrossTenantReplication

allowCrossTenantReplication?: boolean

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.

OptionalallowedCopyScope

allowedCopyScope?: string

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

OptionalallowSharedKeyAccess

allowSharedKeyAccess?: boolean

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.

OptionalazureFilesIdentityBasedAuthentication

azureFilesIdentityBasedAuthentication?: AzureFilesIdentityBasedAuthentication

Provides the identity based authentication settings for Azure Files.

OptionalcustomDomain

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

OptionaldefaultToOAuthAuthentication

defaultToOAuthAuthentication?: boolean

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

OptionaldnsEndpointType

dnsEndpointType?: string

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.

OptionalenableExtendedGroups

enableExtendedGroups?: boolean

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

OptionalenableHttpsTrafficOnly

enableHttpsTrafficOnly?: boolean

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

Optionalencryption

encryption?: Encryption

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

Optionalidentity

identity?: Identity

The identity of the resource.

OptionalimmutableStorageWithVersioning

immutableStorageWithVersioning?: 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.

OptionalisLocalUserEnabled

isLocalUserEnabled?: boolean

Enables local users feature, if set to true

OptionalisSftpEnabled

isSftpEnabled?: boolean

Enables Secure File Transfer Protocol, if set to true

OptionalkeyPolicy

keyPolicy?: KeyPolicy

KeyPolicy assigned to the storage account.

Optionalkind

kind?: string

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

OptionallargeFileSharesState

largeFileSharesState?: string

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

OptionalminimumTlsVersion

minimumTlsVersion?: string

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

OptionalnetworkRuleSet

networkRuleSet?: NetworkRuleSet

Network rule set

OptionalpublicNetworkAccess

publicNetworkAccess?: string

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

OptionalroutingPreference

routingPreference?: RoutingPreference

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

OptionalsasPolicy

sasPolicy?: SasPolicy

SasPolicy assigned to the storage account.

Optionalsku

sku?: 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.

Optionaltags

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

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.

Settings

Member Visibility