Interface StorageAccount

All Superinterfaces:
com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource<StorageManager, StorageAccountInner>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasId, com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel<StorageAccountInner>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager<StorageManager>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasName, com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup, com.azure.resourcemanager.resources.fluentcore.model.Indexable, com.azure.resourcemanager.resources.fluentcore.model.Refreshable<StorageAccount>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource, com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateEndpointConnection, com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource, com.azure.resourcemanager.resources.fluentcore.collection.SupportsUpdatingPrivateEndpointConnection, com.azure.resourcemanager.resources.fluentcore.model.Updatable<StorageAccount.Update>
public interface StorageAccount extends com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource<StorageManager, StorageAccountInner>, com.azure.resourcemanager.resources.fluentcore.model.Refreshable<StorageAccount>, com.azure.resourcemanager.resources.fluentcore.model.Updatable<StorageAccount.Update>, com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource, com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateEndpointConnection, com.azure.resourcemanager.resources.fluentcore.collection.SupportsUpdatingPrivateEndpointConnection
An immutable client-side representation of an Azure storage account.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    StorageAccount.Definition
    Container interface for all the definitions that need to be implemented.
    static interface 
    StorageAccount.DefinitionStages
    Grouping of all the storage account definition stages.
    static interface 
    StorageAccount.Update
    The template for a storage account update operation, containing all the settings that can be modified.
    static interface 
    StorageAccount.UpdateStages
    Grouping of all the storage account update stages.

    Nested classes/interfaces inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithRegion<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithTags<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.UpdateWithTags<T>

  • Field Summary

    Fields inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    DUMMY

  • Method Summary

    Modifier and Type
    Method
    Description
    AccessTier
    accessTier()
    Gets access tier used for billing.
    AccountStatuses
    accountStatuses()
    Gets the status indicating whether the primary and secondary location of the storage account is available or unavailable.
    boolean
    canAccessFromAzureServices()
    Checks storage account can be accessed from applications running on azure.
    boolean
    canReadLogEntriesFromAnyNetwork()
    Checks whether storage log entries can be read from any network.
    boolean
    canReadMetricsFromAnyNetwork()
    Checks storage metrics can be read from any network.
    OffsetDateTime
    creationTime()
    Gets the creation date and time of the storage account in UTC.
    CustomDomain
    customDomain()
    Gets the user assigned custom domain assigned to this storage account.
    StorageAccountEncryptionKeySource
    encryptionKeySource()
    The source of the key used for encryption.
    Map<StorageService, StorageAccountEncryptionStatus>
    encryptionStatuses()
    Gets the encryption statuses indexed by storage service type.
    PublicEndpoints
    endPoints()
    Gets the URLs that are used to perform a retrieval of a public blob, queue or table object.
    List<StorageAccountKey>
    getKeys()
    Fetch the up-to-date access keys from Azure for this storage account.
    Mono<List<StorageAccountKey>>
    getKeysAsync()
    Fetch the up-to-date access keys from Azure for this storage account asynchronously.
    IdentityType
    identityTypeForCustomerEncryptionKey()
    Type of the Managed Service Identity used to access KeyVault for encryption.
    boolean
    infrastructureEncryptionEnabled()
    Checks whether infrastructure encryption for Azure Storage data is enabled.
    List<String>
    ipAddressesWithAccess()
    Gets the list of ip addresses having access to the storage account.
    List<String>
    ipAddressRangesWithAccess()
    Gets the list of ip address ranges having access to the storage account.
    boolean
    isAccessAllowedFromAllNetworks()
    Checks whether authenticated application from any network is allowed to access the storage account.
    boolean
    isAllowCrossTenantReplication()
    Checks whether cross tenant replication is allowed.
    boolean
    isAzureFilesAadIntegrationEnabled()
    Checks whether Aad Integration is enabled for files on this storage account.
    boolean
    isBlobPublicAccessAllowed()
    Checks whether blob public access is allowed.
    boolean
    isDefaultToOAuthAuthentication()
    Checks whether default to oauth authentication is allowed.
    boolean
    isHnsEnabled()
    Checks whether Hns is enabled on this storage account.
    boolean
    isHttpsTrafficOnly()
    Checks whether storage account only allow HTTPS traffic.
    boolean
    isLargeFileSharesEnabled()
    Checks whether large file shares enabled on this storage account.
    boolean
    isSharedKeyAccessAllowed()
    Checks whether shared key access is allowed.
    Kind
    kind()
    Gets the kind of the storage account.
    OffsetDateTime
    lastGeoFailoverTime()
    Gets the timestamp of the most recent instance of a failover to the secondary location.
    MinimumTlsVersion
    minimumTlsVersion()
    Gets the minimum TLS version for HTTPS traffic.
    List<String>
    networkSubnetsWithAccess()
    Gets the list of resource id of virtual network subnet having access to the storage account.
    ProvisioningState
    provisioningState()
    Gets the status of the storage account.
    PublicNetworkAccess
    publicNetworkAccess()
    Whether the storage account can be accessed from public network.
    List<StorageAccountKey>
    regenerateKey(String keyName)
    Regenerates the access keys for this storage account.
    Mono<List<StorageAccountKey>>
    regenerateKeyAsync(String keyName)
    Regenerates the access keys for this storage account asynchronously.
    StorageAccountSkuType
    skuType()
    Gets the sku of this storage account.
    String
    systemAssignedManagedServiceIdentityPrincipalId()
    Gets the Managed Service Identity specific Active Directory service principal ID assigned to the storage account.
    String
    systemAssignedManagedServiceIdentityTenantId()
    Gets the Managed Service Identity specific Active Directory tenant ID assigned to the storage account.
    String
    userAssignedIdentityIdForCustomerEncryptionKey()
    User-assigned Managed Service Identity ID to access the KeyVault for encryption.
    Set<String>
    userAssignedManagedServiceIdentityIds()
    Gets the resource ids of User Assigned Managed Service Identities associated with the storage account.

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasId

    id

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel

    innerModel

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager

    manager

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasName

    name

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup

    resourceGroupName

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Indexable

    key

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Refreshable

    refresh, refreshAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    region, regionName, tags, type

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateEndpointConnection

    listPrivateEndpointConnections, listPrivateEndpointConnectionsAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource

    listPrivateLinkResources, listPrivateLinkResourcesAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsUpdatingPrivateEndpointConnection

    approvePrivateEndpointConnection, approvePrivateEndpointConnectionAsync, rejectPrivateEndpointConnection, rejectPrivateEndpointConnectionAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Updatable

    update

  • Method Details

    • accountStatuses

      AccountStatuses accountStatuses()
      Gets the status indicating whether the primary and secondary location of the storage account is available or unavailable.
      Returns:
      the status indicating whether the primary and secondary location of the storage account is available or unavailable. Possible values include: 'Available', 'Unavailable'

    • skuType

      StorageAccountSkuType skuType()
      Gets the sku of this storage account.
      Returns:
      the sku of this storage account.

    • kind

      Kind kind()
      Gets the kind of the storage account.
      Returns:
      the kind of the storage account. Possible values are 'Storage', 'BlobStorage'.

    • creationTime

      OffsetDateTime creationTime()
      Gets the creation date and time of the storage account in UTC.
      Returns:
      the creation date and time of the storage account in UTC

    • customDomain

      CustomDomain customDomain()
      Gets the user assigned custom domain assigned to this storage account.
      Returns:
      the user assigned custom domain assigned to this storage account

    • lastGeoFailoverTime

      OffsetDateTime lastGeoFailoverTime()
      Gets the timestamp of the most recent instance of a failover to the secondary location.
      Returns:
      the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is StandardGRS or StandardRAGRS

    • provisioningState

      ProvisioningState provisioningState()
      Gets the status of the storage account.
      Returns:
      the status of the storage account at the time the operation was called. Possible values include: 'Creating', 'ResolvingDNS', 'Succeeded'

    • endPoints

      PublicEndpoints endPoints()
      Gets the URLs that are used to perform a retrieval of a public blob, queue or table object.
      Returns:
      the URLs that are used to perform a retrieval of a public blob, queue or table object. Note that StandardZRS and PremiumLRS accounts only return the blob endpoint

    • encryptionKeySource

      StorageAccountEncryptionKeySource encryptionKeySource()
      The source of the key used for encryption.

      StorageAccountEncryptionKeySource.MICROSOFT_STORAGE means that the Storage Account is encrypted using Microsoft-managed Key.

      StorageAccountEncryptionKeySource.MICROSOFT_KEYVAULT means that the Storage Account is encrypted using Customer-managed Key.

      Returns:
      the source of the key used for encryption.

    • encryptionStatuses

      Map<StorageService, StorageAccountEncryptionStatus> encryptionStatuses()
      Gets the encryption statuses indexed by storage service type.
      Returns:
      the encryption statuses indexed by storage service type.

    • infrastructureEncryptionEnabled

      boolean infrastructureEncryptionEnabled()
      Checks whether infrastructure encryption for Azure Storage data is enabled.
      Returns:
      whether infrastructure encryption for Azure Storage data is enabled.

    • accessTier

      AccessTier accessTier()
      Gets access tier used for billing.
      Returns:
      access tier used for billing. Access tier cannot be changed more than once every 7 days (168 hours). Access tier cannot be set for StandardLRS, StandardGRS, StandardRAGRS, or PremiumLRS account types. Possible values include: 'Hot', 'Cool'.

    • systemAssignedManagedServiceIdentityTenantId

      String systemAssignedManagedServiceIdentityTenantId()
      Gets the Managed Service Identity specific Active Directory tenant ID assigned to the storage account.
      Returns:
      the Managed Service Identity specific Active Directory tenant ID assigned to the storage account.

    • systemAssignedManagedServiceIdentityPrincipalId

      String systemAssignedManagedServiceIdentityPrincipalId()
      Gets the Managed Service Identity specific Active Directory service principal ID assigned to the storage account.
      Returns:
      the Managed Service Identity specific Active Directory service principal ID assigned to the storage account.

    • userAssignedManagedServiceIdentityIds

      Set<String> userAssignedManagedServiceIdentityIds()
      Gets the resource ids of User Assigned Managed Service Identities associated with the storage account.
      Returns:
      the resource ids of User Assigned Managed Service Identities associated with the storage account.

    • isAccessAllowedFromAllNetworks

      boolean isAccessAllowedFromAllNetworks()
      Checks whether authenticated application from any network is allowed to access the storage account.
      Returns:
      true if authenticated application from any network is allowed to access the storage account, false if only application from whitelisted network (subnet, ip address, ip address range) can access the storage account.

    • networkSubnetsWithAccess

      List<String> networkSubnetsWithAccess()
      Gets the list of resource id of virtual network subnet having access to the storage account.
      Returns:
      the list of resource id of virtual network subnet having access to the storage account.

    • ipAddressesWithAccess

      List<String> ipAddressesWithAccess()
      Gets the list of ip addresses having access to the storage account.
      Returns:
      the list of ip addresses having access to the storage account.

    • ipAddressRangesWithAccess

      List<String> ipAddressRangesWithAccess()
      Gets the list of ip address ranges having access to the storage account.
      Returns:
      the list of ip address ranges having access to the storage account.

    • canReadLogEntriesFromAnyNetwork

      boolean canReadLogEntriesFromAnyNetwork()
      Checks whether storage log entries can be read from any network.
      Returns:
      true if storage log entries can be read from any network, false otherwise

    • canReadMetricsFromAnyNetwork

      boolean canReadMetricsFromAnyNetwork()
      Checks storage metrics can be read from any network.
      Returns:
      true if storage metrics can be read from any network, false otherwise

    • canAccessFromAzureServices

      boolean canAccessFromAzureServices()
      Checks storage account can be accessed from applications running on azure.
      Returns:
      true if storage can be accessed from application running on azure, false otherwise

    • isAzureFilesAadIntegrationEnabled

      boolean isAzureFilesAadIntegrationEnabled()
      Checks whether Aad Integration is enabled for files on this storage account.
      Returns:
      true if Aad integration is enabled, false otherwise

    • isHnsEnabled

      boolean isHnsEnabled()
      Checks whether Hns is enabled on this storage account.
      Returns:
      true if Hns is enabled, false otherwise

    • isLargeFileSharesEnabled

      boolean isLargeFileSharesEnabled()
      Checks whether large file shares enabled on this storage account.
      Returns:
      true if large file shares is enabled, false otherwise

    • minimumTlsVersion

      MinimumTlsVersion minimumTlsVersion()
      Gets the minimum TLS version for HTTPS traffic.
      Returns:
      the minimum TLS version for HTTPS traffic.

    • isHttpsTrafficOnly

      boolean isHttpsTrafficOnly()
      Checks whether storage account only allow HTTPS traffic.
      Returns:
      true if only allow HTTPS traffic, false otherwise

    • isBlobPublicAccessAllowed

      boolean isBlobPublicAccessAllowed()
      Checks whether blob public access is allowed.
      Returns:
      true if blob public access is allowed, false otherwise

    • isSharedKeyAccessAllowed

      boolean isSharedKeyAccessAllowed()
      Checks whether shared key access is allowed.
      Returns:
      true if shared key access is allowed, false otherwise

    • getKeys

      List<StorageAccountKey> getKeys()
      Fetch the up-to-date access keys from Azure for this storage account.
      Returns:
      the access keys for this storage account

    • getKeysAsync

      Mono<List<StorageAccountKey>> getKeysAsync()
      Fetch the up-to-date access keys from Azure for this storage account asynchronously.
      Returns:
      a representation of the deferred computation of this call, returning the access keys

    • regenerateKey

      List<StorageAccountKey> regenerateKey(String keyName)
      Regenerates the access keys for this storage account.
      Parameters:
      keyName - if the key name
      Returns:
      the generated access keys for this storage account

    • regenerateKeyAsync

      Mono<List<StorageAccountKey>> regenerateKeyAsync(String keyName)
      Regenerates the access keys for this storage account asynchronously.
      Parameters:
      keyName - if the key name
      Returns:
      a representation of the deferred computation of this call, returning the regenerated access key

    • isAllowCrossTenantReplication

      boolean isAllowCrossTenantReplication()
      Checks whether cross tenant replication is allowed.
      Returns:
      true if cross tenant replication is enabled, false otherwise

    • isDefaultToOAuthAuthentication

      boolean isDefaultToOAuthAuthentication()
      Checks whether default to oauth authentication is allowed.
      Returns:
      true if default to oauth authentication is enabled, false otherwise

    • identityTypeForCustomerEncryptionKey

      IdentityType identityTypeForCustomerEncryptionKey()
      Type of the Managed Service Identity used to access KeyVault for encryption.

      This property only makes sense when the storage account is encrypted using Customer-managed keys, meaning encryptionKeySource() is StorageAccountEncryptionKeySource.MICROSOFT_KEYVAULT.

      Returns:
      type of the Managed Service Identity used to access KeyVault for encryption, null if encryptionKeySource() is StorageAccountEncryptionKeySource.MICROSOFT_STORAGE

    • userAssignedIdentityIdForCustomerEncryptionKey

      String userAssignedIdentityIdForCustomerEncryptionKey()
      User-assigned Managed Service Identity ID to access the KeyVault for encryption.

      This property only makes sense when the storage account is encrypted using Customer-managed keys, meaning encryptionKeySource() is StorageAccountEncryptionKeySource.MICROSOFT_KEYVAULT and identityTypeForCustomerEncryptionKey() is IdentityType.USER_ASSIGNED.

      Returns:
      user-assigned identity ID used to access KeyVault for encryption, null if encryptionKeySource() is StorageAccountEncryptionKeySource.MICROSOFT_STORAGE or identityTypeForCustomerEncryptionKey() is not IdentityType.USER_ASSIGNED

    • publicNetworkAccess

      PublicNetworkAccess publicNetworkAccess()
      Whether the storage account can be accessed from public network.
      Returns:
      whether the storage account can be accessed from public network.