Package com.azure.resourcemanager.storage.models

Class StorageAccountCreateParameters

  • public final class StorageAccountCreateParameters
extends Object
    The parameters used when creating a storage account.

    • Constructor Detail

      • StorageAccountCreateParameters

        public StorageAccountCreateParameters()

    • Method Detail

      • sku

        public Sku sku()
        Get the sku property: Required. Gets or sets the SKU name.
        Returns:
        the sku value.

      • withSku

        public StorageAccountCreateParameters withSku​(Sku sku)
        Set the sku property: Required. Gets or sets the SKU name.
        Parameters:
        sku - the sku value to set.
        Returns:
        the StorageAccountCreateParameters object itself.

      • kind

        public Kind kind()
        Get the kind property: Required. Indicates the type of storage account.
        Returns:
        the kind value.

      • withKind

        public StorageAccountCreateParameters withKind​(Kind kind)
        Set the kind property: Required. Indicates the type of storage account.
        Parameters:
        kind - the kind value to set.
        Returns:
        the StorageAccountCreateParameters object itself.

      • location

        public String location()
        Get the location property: 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.
        Returns:
        the location value.

      • withLocation

        public StorageAccountCreateParameters withLocation​(String location)
        Set the location property: 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.
        Parameters:
        location - the location value to set.
        Returns:
        the StorageAccountCreateParameters object itself.

      • extendedLocation

        public ExtendedLocation extendedLocation()
        Get the extendedLocation property: Optional. Set the extended location of the resource. If not set, the storage account will be created in Azure main region. Otherwise it will be created in the specified extended location.
        Returns:
        the extendedLocation value.

      • withExtendedLocation

        public StorageAccountCreateParameters withExtendedLocation​(ExtendedLocation extendedLocation)
        Set the extendedLocation property: Optional. Set the extended location of the resource. If not set, the storage account will be created in Azure main region. Otherwise it will be created in the specified extended location.
        Parameters:
        extendedLocation - the extendedLocation value to set.
        Returns:
        the StorageAccountCreateParameters 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 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.
        Returns:
        the tags value.

      • withTags

        public StorageAccountCreateParameters 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 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.
        Parameters:
        tags - the tags value to set.
        Returns:
        the StorageAccountCreateParameters object itself.

      • identity

        public Identity identity()
        Get the identity property: The identity of the resource.
        Returns:
        the identity value.

      • withIdentity

        public StorageAccountCreateParameters withIdentity​(Identity identity)
        Set the identity property: The identity of the resource.
        Parameters:
        identity - the identity value to set.
        Returns:
        the StorageAccountCreateParameters 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 StorageAccountCreateParameters 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 StorageAccountCreateParameters 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 StorageAccountCreateParameters 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 StorageAccountCreateParameters object itself.

      • sasPolicy

        public SasPolicy sasPolicy()
        Get the sasPolicy property: SasPolicy assigned to the storage account.
        Returns:
        the sasPolicy value.

      • withSasPolicy

        public StorageAccountCreateParameters withSasPolicy​(SasPolicy sasPolicy)
        Set the sasPolicy property: SasPolicy assigned to the storage account.
        Parameters:
        sasPolicy - the sasPolicy value to set.
        Returns:
        the StorageAccountCreateParameters object itself.

      • keyPolicy

        public KeyPolicy keyPolicy()
        Get the keyPolicy property: KeyPolicy assigned to the storage account.
        Returns:
        the keyPolicy value.

      • withKeyPolicy

        public StorageAccountCreateParameters withKeyPolicy​(KeyPolicy keyPolicy)
        Set the keyPolicy property: KeyPolicy assigned to the storage account.
        Parameters:
        keyPolicy - the keyPolicy value to set.
        Returns:
        the StorageAccountCreateParameters object itself.

      • customDomain

        public CustomDomain customDomain()
        Get the customDomain property: 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.
        Returns:
        the customDomain value.

      • withCustomDomain

        public StorageAccountCreateParameters withCustomDomain​(CustomDomain customDomain)
        Set the customDomain property: 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.
        Parameters:
        customDomain - the customDomain value to set.
        Returns:
        the StorageAccountCreateParameters object itself.

      • encryption

        public Encryption encryption()
        Get the encryption property: Encryption settings to be used for server-side encryption for the storage account.
        Returns:
        the encryption value.

      • withEncryption

        public StorageAccountCreateParameters withEncryption​(Encryption encryption)
        Set the encryption property: Encryption settings to be used for server-side encryption for the storage account.
        Parameters:
        encryption - the encryption value to set.
        Returns:
        the StorageAccountCreateParameters object itself.

      • networkRuleSet

        public NetworkRuleSet networkRuleSet()
        Get the networkRuleSet property: Network rule set.
        Returns:
        the networkRuleSet value.

      • withNetworkRuleSet

        public StorageAccountCreateParameters withNetworkRuleSet​(NetworkRuleSet networkRuleSet)
        Set the networkRuleSet property: Network rule set.
        Parameters:
        networkRuleSet - the networkRuleSet value to set.
        Returns:
        the StorageAccountCreateParameters 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 StorageAccountCreateParameters 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 StorageAccountCreateParameters 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 StorageAccountCreateParameters 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 StorageAccountCreateParameters object itself.

      • enableHttpsTrafficOnly

        public Boolean enableHttpsTrafficOnly()
        Get the enableHttpsTrafficOnly property: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01.
        Returns:
        the enableHttpsTrafficOnly value.

      • withEnableHttpsTrafficOnly

        public StorageAccountCreateParameters withEnableHttpsTrafficOnly​(Boolean enableHttpsTrafficOnly)
        Set the enableHttpsTrafficOnly property: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01.
        Parameters:
        enableHttpsTrafficOnly - the enableHttpsTrafficOnly value to set.
        Returns:
        the StorageAccountCreateParameters 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 StorageAccountCreateParameters 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 StorageAccountCreateParameters object itself.

      • isLocalUserEnabled

        public Boolean isLocalUserEnabled()
        Get the isLocalUserEnabled property: Enables local users feature, if set to true.
        Returns:
        the isLocalUserEnabled value.

      • withIsLocalUserEnabled

        public StorageAccountCreateParameters withIsLocalUserEnabled​(Boolean isLocalUserEnabled)
        Set the isLocalUserEnabled property: Enables local users feature, if set to true.
        Parameters:
        isLocalUserEnabled - the isLocalUserEnabled value to set.
        Returns:
        the StorageAccountCreateParameters object itself.

      • isHnsEnabled

        public Boolean isHnsEnabled()
        Get the isHnsEnabled property: Account HierarchicalNamespace enabled if sets to true.
        Returns:
        the isHnsEnabled value.

      • withIsHnsEnabled

        public StorageAccountCreateParameters withIsHnsEnabled​(Boolean isHnsEnabled)
        Set the isHnsEnabled property: Account HierarchicalNamespace enabled if sets to true.
        Parameters:
        isHnsEnabled - the isHnsEnabled value to set.
        Returns:
        the StorageAccountCreateParameters 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 StorageAccountCreateParameters 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 StorageAccountCreateParameters 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 StorageAccountCreateParameters 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 StorageAccountCreateParameters 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 StorageAccountCreateParameters 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 StorageAccountCreateParameters 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 StorageAccountCreateParameters 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 StorageAccountCreateParameters 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 StorageAccountCreateParameters 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 StorageAccountCreateParameters object itself.

      • enableNfsV3

        public Boolean enableNfsV3()
        Get the enableNfsV3 property: NFS 3.0 protocol support enabled if set to true.
        Returns:
        the enableNfsV3 value.

      • withEnableNfsV3

        public StorageAccountCreateParameters withEnableNfsV3​(Boolean enableNfsV3)
        Set the enableNfsV3 property: NFS 3.0 protocol support enabled if set to true.
        Parameters:
        enableNfsV3 - the enableNfsV3 value to set.
        Returns:
        the StorageAccountCreateParameters 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 StorageAccountCreateParameters 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 StorageAccountCreateParameters 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 StorageAccountCreateParameters 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 StorageAccountCreateParameters 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 new containers in the account by default.
        Returns:
        the immutableStorageWithVersioning value.

      • withImmutableStorageWithVersioning

        public StorageAccountCreateParameters 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 new containers in the account by default.
        Parameters:
        immutableStorageWithVersioning - the immutableStorageWithVersioning value to set.
        Returns:
        the StorageAccountCreateParameters 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 StorageAccountCreateParameters 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 StorageAccountCreateParameters object itself.

      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.