Class StorageAccountUpdateParameters
- java.lang.Object
-
- com.azure.resourcemanager.storage.models.StorageAccountUpdateParameters
-
public final class StorageAccountUpdateParameters extends Object
The parameters that can be provided when updating the storage account properties.
-
-
Constructor Summary
Constructors Constructor Description StorageAccountUpdateParameters()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AccessTieraccessTier()Get the accessTier property: Required for storage accounts where kind = BlobStorage.BooleanallowBlobPublicAccess()Get the allowBlobPublicAccess property: Allow or disallow public access to all blobs or containers in the storage account.BooleanallowCrossTenantReplication()Get the allowCrossTenantReplication property: Allow or disallow cross AAD tenant object replication.AllowedCopyScopeallowedCopyScope()Get the allowedCopyScope property: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet.BooleanallowSharedKeyAccess()Get the allowSharedKeyAccess property: Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key.AzureFilesIdentityBasedAuthenticationazureFilesIdentityBasedAuthentication()Get the azureFilesIdentityBasedAuthentication property: Provides the identity based authentication settings for Azure Files.CustomDomaincustomDomain()Get the customDomain property: Custom domain assigned to the storage account by the user.BooleandefaultToOAuthAuthentication()Get the defaultToOAuthAuthentication property: A boolean flag which indicates whether the default authentication is OAuth or not.DnsEndpointTypednsEndpointType()Get the dnsEndpointType property: Allows you to specify the type of endpoint.BooleanenableHttpsTrafficOnly()Get the enableHttpsTrafficOnly property: Allows https traffic only to storage service if sets to true.Encryptionencryption()Get the encryption property: Not applicable.Identityidentity()Get the identity property: The identity of the resource.ImmutableStorageAccountimmutableStorageWithVersioning()Get the immutableStorageWithVersioning property: The property is immutable and can only be set to true at the account creation time.BooleanisLocalUserEnabled()Get the isLocalUserEnabled property: Enables local users feature, if set to true.BooleanisSftpEnabled()Get the isSftpEnabled property: Enables Secure File Transfer Protocol, if set to true.KeyPolicykeyPolicy()Get the keyPolicy property: KeyPolicy assigned to the storage account.Kindkind()Get the kind property: Optional.LargeFileSharesStatelargeFileSharesState()Get the largeFileSharesState property: Allow large file shares if sets to Enabled.MinimumTlsVersionminimumTlsVersion()Get the minimumTlsVersion property: Set the minimum TLS version to be permitted on requests to storage.NetworkRuleSetnetworkRuleSet()Get the networkRuleSet property: Network rule set.PublicNetworkAccesspublicNetworkAccess()Get the publicNetworkAccess property: Allow or disallow public network access to Storage Account.RoutingPreferenceroutingPreference()Get the routingPreference property: Maintains information about the network routing choice opted by the user for data transfer.SasPolicysasPolicy()Get the sasPolicy property: SasPolicy assigned to the storage account.Skusku()Get the sku property: Gets or sets the SKU name.Map<String,String>tags()Get the tags property: Gets or sets a list of key value pairs that describe the resource.voidvalidate()Validates the instance.StorageAccountUpdateParameterswithAccessTier(AccessTier accessTier)Set the accessTier property: Required for storage accounts where kind = BlobStorage.StorageAccountUpdateParameterswithAllowBlobPublicAccess(Boolean allowBlobPublicAccess)Set the allowBlobPublicAccess property: Allow or disallow public access to all blobs or containers in the storage account.StorageAccountUpdateParameterswithAllowCrossTenantReplication(Boolean allowCrossTenantReplication)Set the allowCrossTenantReplication property: Allow or disallow cross AAD tenant object replication.StorageAccountUpdateParameterswithAllowedCopyScope(AllowedCopyScope allowedCopyScope)Set the allowedCopyScope property: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet.StorageAccountUpdateParameterswithAllowSharedKeyAccess(Boolean allowSharedKeyAccess)Set the allowSharedKeyAccess property: Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key.StorageAccountUpdateParameterswithAzureFilesIdentityBasedAuthentication(AzureFilesIdentityBasedAuthentication azureFilesIdentityBasedAuthentication)Set the azureFilesIdentityBasedAuthentication property: Provides the identity based authentication settings for Azure Files.StorageAccountUpdateParameterswithCustomDomain(CustomDomain customDomain)Set the customDomain property: Custom domain assigned to the storage account by the user.StorageAccountUpdateParameterswithDefaultToOAuthAuthentication(Boolean defaultToOAuthAuthentication)Set the defaultToOAuthAuthentication property: A boolean flag which indicates whether the default authentication is OAuth or not.StorageAccountUpdateParameterswithDnsEndpointType(DnsEndpointType dnsEndpointType)Set the dnsEndpointType property: Allows you to specify the type of endpoint.StorageAccountUpdateParameterswithEnableHttpsTrafficOnly(Boolean enableHttpsTrafficOnly)Set the enableHttpsTrafficOnly property: Allows https traffic only to storage service if sets to true.StorageAccountUpdateParameterswithEncryption(Encryption encryption)Set the encryption property: Not applicable.StorageAccountUpdateParameterswithIdentity(Identity identity)Set the identity property: The identity of the resource.StorageAccountUpdateParameterswithImmutableStorageWithVersioning(ImmutableStorageAccount immutableStorageWithVersioning)Set the immutableStorageWithVersioning property: The property is immutable and can only be set to true at the account creation time.StorageAccountUpdateParameterswithIsLocalUserEnabled(Boolean isLocalUserEnabled)Set the isLocalUserEnabled property: Enables local users feature, if set to true.StorageAccountUpdateParameterswithIsSftpEnabled(Boolean isSftpEnabled)Set the isSftpEnabled property: Enables Secure File Transfer Protocol, if set to true.StorageAccountUpdateParameterswithKeyPolicy(KeyPolicy keyPolicy)Set the keyPolicy property: KeyPolicy assigned to the storage account.StorageAccountUpdateParameterswithKind(Kind kind)Set the kind property: Optional.StorageAccountUpdateParameterswithLargeFileSharesState(LargeFileSharesState largeFileSharesState)Set the largeFileSharesState property: Allow large file shares if sets to Enabled.StorageAccountUpdateParameterswithMinimumTlsVersion(MinimumTlsVersion minimumTlsVersion)Set the minimumTlsVersion property: Set the minimum TLS version to be permitted on requests to storage.StorageAccountUpdateParameterswithNetworkRuleSet(NetworkRuleSet networkRuleSet)Set the networkRuleSet property: Network rule set.StorageAccountUpdateParameterswithPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)Set the publicNetworkAccess property: Allow or disallow public network access to Storage Account.StorageAccountUpdateParameterswithRoutingPreference(RoutingPreference routingPreference)Set the routingPreference property: Maintains information about the network routing choice opted by the user for data transfer.StorageAccountUpdateParameterswithSasPolicy(SasPolicy sasPolicy)Set the sasPolicy property: SasPolicy assigned to the storage account.StorageAccountUpdateParameterswithSku(Sku sku)Set the sku property: Gets or sets the SKU name.StorageAccountUpdateParameterswithTags(Map<String,String> tags)Set the tags property: Gets or sets a list of key value pairs that describe the resource.
-
-
-
Method Detail
-
sku
public Sku sku()
Get the sku property: 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.- Returns:
- the sku value.
-
withSku
public StorageAccountUpdateParameters withSku(Sku sku)
Set the sku property: 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.- Parameters:
sku- the sku value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
tags
public Map<String,String> tags()
Get the tags property: 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.- Returns:
- the tags value.
-
withTags
public StorageAccountUpdateParameters withTags(Map<String,String> tags)
Set the tags property: 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.- Parameters:
tags- the tags value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
identity
public Identity identity()
Get the identity property: The identity of the resource.- Returns:
- the identity value.
-
withIdentity
public StorageAccountUpdateParameters withIdentity(Identity identity)
Set the identity property: The identity of the resource.- Parameters:
identity- the identity value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
kind
public Kind kind()
Get the kind property: Optional. Indicates the type of storage account. Currently only StorageV2 value supported by server.- Returns:
- the kind value.
-
withKind
public StorageAccountUpdateParameters withKind(Kind kind)
Set the kind property: Optional. Indicates the type of storage account. Currently only StorageV2 value supported by server.- Parameters:
kind- the kind value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
customDomain
public CustomDomain customDomain()
Get the customDomain property: 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.- Returns:
- the customDomain value.
-
withCustomDomain
public StorageAccountUpdateParameters withCustomDomain(CustomDomain customDomain)
Set the customDomain property: 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.- Parameters:
customDomain- the customDomain value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
encryption
public Encryption encryption()
Get the encryption property: Not applicable. Azure Storage encryption at rest is enabled by default for all storage accounts and cannot be disabled.- Returns:
- the encryption value.
-
withEncryption
public StorageAccountUpdateParameters withEncryption(Encryption encryption)
Set the encryption property: Not applicable. Azure Storage encryption at rest is enabled by default for all storage accounts and cannot be disabled.- Parameters:
encryption- the encryption value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
sasPolicy
public SasPolicy sasPolicy()
Get the sasPolicy property: SasPolicy assigned to the storage account.- Returns:
- the sasPolicy value.
-
withSasPolicy
public StorageAccountUpdateParameters withSasPolicy(SasPolicy sasPolicy)
Set the sasPolicy property: SasPolicy assigned to the storage account.- Parameters:
sasPolicy- the sasPolicy value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
keyPolicy
public KeyPolicy keyPolicy()
Get the keyPolicy property: KeyPolicy assigned to the storage account.- Returns:
- the keyPolicy value.
-
withKeyPolicy
public StorageAccountUpdateParameters withKeyPolicy(KeyPolicy keyPolicy)
Set the keyPolicy property: KeyPolicy assigned to the storage account.- Parameters:
keyPolicy- the keyPolicy value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
accessTier
public AccessTier accessTier()
Get the accessTier property: 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.- Returns:
- the accessTier value.
-
withAccessTier
public StorageAccountUpdateParameters withAccessTier(AccessTier accessTier)
Set the accessTier property: 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.- Parameters:
accessTier- the accessTier value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
azureFilesIdentityBasedAuthentication
public AzureFilesIdentityBasedAuthentication azureFilesIdentityBasedAuthentication()
Get the azureFilesIdentityBasedAuthentication property: Provides the identity based authentication settings for Azure Files.- Returns:
- the azureFilesIdentityBasedAuthentication value.
-
withAzureFilesIdentityBasedAuthentication
public StorageAccountUpdateParameters withAzureFilesIdentityBasedAuthentication(AzureFilesIdentityBasedAuthentication azureFilesIdentityBasedAuthentication)
Set the azureFilesIdentityBasedAuthentication property: Provides the identity based authentication settings for Azure Files.- Parameters:
azureFilesIdentityBasedAuthentication- the azureFilesIdentityBasedAuthentication value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
enableHttpsTrafficOnly
public Boolean enableHttpsTrafficOnly()
Get the enableHttpsTrafficOnly property: Allows https traffic only to storage service if sets to true.- Returns:
- the enableHttpsTrafficOnly value.
-
withEnableHttpsTrafficOnly
public StorageAccountUpdateParameters withEnableHttpsTrafficOnly(Boolean enableHttpsTrafficOnly)
Set the enableHttpsTrafficOnly property: Allows https traffic only to storage service if sets to true.- Parameters:
enableHttpsTrafficOnly- the enableHttpsTrafficOnly value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
isSftpEnabled
public Boolean isSftpEnabled()
Get the isSftpEnabled property: Enables Secure File Transfer Protocol, if set to true.- Returns:
- the isSftpEnabled value.
-
withIsSftpEnabled
public StorageAccountUpdateParameters withIsSftpEnabled(Boolean isSftpEnabled)
Set the isSftpEnabled property: Enables Secure File Transfer Protocol, if set to true.- Parameters:
isSftpEnabled- the isSftpEnabled value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
isLocalUserEnabled
public Boolean isLocalUserEnabled()
Get the isLocalUserEnabled property: Enables local users feature, if set to true.- Returns:
- the isLocalUserEnabled value.
-
withIsLocalUserEnabled
public StorageAccountUpdateParameters withIsLocalUserEnabled(Boolean isLocalUserEnabled)
Set the isLocalUserEnabled property: Enables local users feature, if set to true.- Parameters:
isLocalUserEnabled- the isLocalUserEnabled value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
networkRuleSet
public NetworkRuleSet networkRuleSet()
Get the networkRuleSet property: Network rule set.- Returns:
- the networkRuleSet value.
-
withNetworkRuleSet
public StorageAccountUpdateParameters withNetworkRuleSet(NetworkRuleSet networkRuleSet)
Set the networkRuleSet property: Network rule set.- Parameters:
networkRuleSet- the networkRuleSet value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
largeFileSharesState
public LargeFileSharesState largeFileSharesState()
Get the largeFileSharesState property: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled.- Returns:
- the largeFileSharesState value.
-
withLargeFileSharesState
public StorageAccountUpdateParameters withLargeFileSharesState(LargeFileSharesState largeFileSharesState)
Set the largeFileSharesState property: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled.- Parameters:
largeFileSharesState- the largeFileSharesState value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
routingPreference
public RoutingPreference routingPreference()
Get the routingPreference property: Maintains information about the network routing choice opted by the user for data transfer.- Returns:
- the routingPreference value.
-
withRoutingPreference
public StorageAccountUpdateParameters withRoutingPreference(RoutingPreference routingPreference)
Set the routingPreference property: Maintains information about the network routing choice opted by the user for data transfer.- Parameters:
routingPreference- the routingPreference value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
allowBlobPublicAccess
public Boolean allowBlobPublicAccess()
Get the allowBlobPublicAccess property: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property.- Returns:
- the allowBlobPublicAccess value.
-
withAllowBlobPublicAccess
public StorageAccountUpdateParameters withAllowBlobPublicAccess(Boolean allowBlobPublicAccess)
Set the allowBlobPublicAccess property: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property.- Parameters:
allowBlobPublicAccess- the allowBlobPublicAccess value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
minimumTlsVersion
public MinimumTlsVersion minimumTlsVersion()
Get the minimumTlsVersion property: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property.- Returns:
- the minimumTlsVersion value.
-
withMinimumTlsVersion
public StorageAccountUpdateParameters withMinimumTlsVersion(MinimumTlsVersion minimumTlsVersion)
Set the minimumTlsVersion property: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property.- Parameters:
minimumTlsVersion- the minimumTlsVersion value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
allowSharedKeyAccess
public Boolean allowSharedKeyAccess()
Get the allowSharedKeyAccess property: 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.- Returns:
- the allowSharedKeyAccess value.
-
withAllowSharedKeyAccess
public StorageAccountUpdateParameters withAllowSharedKeyAccess(Boolean allowSharedKeyAccess)
Set the allowSharedKeyAccess property: 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.- Parameters:
allowSharedKeyAccess- the allowSharedKeyAccess value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
allowCrossTenantReplication
public Boolean allowCrossTenantReplication()
Get the allowCrossTenantReplication property: Allow or disallow cross AAD tenant object replication. The default interpretation is true for this property.- Returns:
- the allowCrossTenantReplication value.
-
withAllowCrossTenantReplication
public StorageAccountUpdateParameters withAllowCrossTenantReplication(Boolean allowCrossTenantReplication)
Set the allowCrossTenantReplication property: Allow or disallow cross AAD tenant object replication. The default interpretation is true for this property.- Parameters:
allowCrossTenantReplication- the allowCrossTenantReplication value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
defaultToOAuthAuthentication
public Boolean defaultToOAuthAuthentication()
Get the defaultToOAuthAuthentication property: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property.- Returns:
- the defaultToOAuthAuthentication value.
-
withDefaultToOAuthAuthentication
public StorageAccountUpdateParameters withDefaultToOAuthAuthentication(Boolean defaultToOAuthAuthentication)
Set the defaultToOAuthAuthentication property: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property.- Parameters:
defaultToOAuthAuthentication- the defaultToOAuthAuthentication value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
publicNetworkAccess
public PublicNetworkAccess publicNetworkAccess()
Get the publicNetworkAccess property: Allow or disallow public network access to Storage Account. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.- Returns:
- the publicNetworkAccess value.
-
withPublicNetworkAccess
public StorageAccountUpdateParameters withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)
Set the publicNetworkAccess property: Allow or disallow public network access to Storage Account. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.- Parameters:
publicNetworkAccess- the publicNetworkAccess value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
immutableStorageWithVersioning
public ImmutableStorageAccount immutableStorageWithVersioning()
Get the immutableStorageWithVersioning property: 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.- Returns:
- the immutableStorageWithVersioning value.
-
withImmutableStorageWithVersioning
public StorageAccountUpdateParameters withImmutableStorageWithVersioning(ImmutableStorageAccount immutableStorageWithVersioning)
Set the immutableStorageWithVersioning property: 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.- Parameters:
immutableStorageWithVersioning- the immutableStorageWithVersioning value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
allowedCopyScope
public AllowedCopyScope allowedCopyScope()
Get the allowedCopyScope property: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet.- Returns:
- the allowedCopyScope value.
-
withAllowedCopyScope
public StorageAccountUpdateParameters withAllowedCopyScope(AllowedCopyScope allowedCopyScope)
Set the allowedCopyScope property: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet.- Parameters:
allowedCopyScope- the allowedCopyScope value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
dnsEndpointType
public DnsEndpointType dnsEndpointType()
Get the dnsEndpointType property: 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.- Returns:
- the dnsEndpointType value.
-
withDnsEndpointType
public StorageAccountUpdateParameters withDnsEndpointType(DnsEndpointType dnsEndpointType)
Set the dnsEndpointType property: 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.- Parameters:
dnsEndpointType- the dnsEndpointType value to set.- Returns:
- the StorageAccountUpdateParameters object itself.
-
validate
public void validate()
Validates the instance.- Throws:
IllegalArgumentException- thrown if the instance is not valid.
-
-