StorageAccount Interface

Package:

com.microsoft.azure.management.storage

Maven Artifact:

com.microsoft.azure:azure-mgmt-storage:1.41.4

Implements

GroupableResource<com.microsoft.azure.management.storage.implementation.StorageManager,com.microsoft.azure.management.storage.implementation.StorageAccountInner> Refreshable<StorageAccount> Updatable<Update>

public interface StorageAccount
extends GroupableResource<com.microsoft.azure.management.storage.implementation.StorageManager,com.microsoft.azure.management.storage.implementation.StorageAccountInner>, Refreshable<StorageAccount>, Updatable<Update>

An immutable client-side representation of an Azure storage account.

Method Summary

Modifier and Type	Method and Description
abstract AccessTier	accessTier()
abstract com.microsoft.azure.management.storage.implementation.AccountStatuses	accountStatuses()
abstract boolean	canAccessFromAzureServices() Checks storage account can be accessed from applications running on azure.
abstract boolean	canReadLogEntriesFromAnyNetwork() Checks storage log entries can be read from any network.
abstract boolean	canReadMetricsFromAnyNetwork() Checks storage metrics can be read from any network.
abstract org.joda.time.DateTime	creationTime()
abstract CustomDomain	customDomain()
abstract Encryption	encryption() Deprecated use encryptionKeySource(), encryptionStatuses() instead.
abstract StorageAccountEncryptionKeySource	encryptionKeySource()
abstract java.util.Map<StorageService,StorageAccountEncryptionStatus>	encryptionStatuses()
abstract PublicEndpoints	endPoints()
abstract java.util.List<StorageAccountKey>	getKeys() Fetch the up-to-date access keys from Azure for this storage account.
abstract rx.Observable<java.util.List<StorageAccountKey>>	getKeysAsync() Fetch the up-to-date access keys from Azure for this storage account asynchronously.
abstract com.microsoft.rest.ServiceFuture<java.util.List<StorageAccountKey>>	getKeysAsync(ServiceCallback<List<StorageAccountKey>> callback) Fetch the up-to-date access keys from Azure for this storage account asynchronously.
abstract java.util.List<java.lang.String>	ipAddressRangesWithAccess()
abstract java.util.List<java.lang.String>	ipAddressesWithAccess()
abstract boolean	isAccessAllowedFromAllNetworks()
abstract boolean	isAzureFilesAadIntegrationEnabled() Checks whether Aad Integration is enabled for files on this storage account.
abstract boolean	isBlobPublicAccessAllowed() Checks whether blob public access is allowed.
abstract boolean	isHnsEnabled() Checks whether Hns is enabled on this storage account.
abstract boolean	isHttpsTrafficOnly() Checks whether storage account only allow HTTPS traffic.
abstract boolean	isLargeFileSharesEnabled() Checks whether large file shares enabled on this storage account.
abstract Kind	kind()
abstract org.joda.time.DateTime	lastGeoFailoverTime()
abstract MinimumTlsVersion	minimumTlsVersion()
abstract java.util.List<java.lang.String>	networkSubnetsWithAccess()
abstract ProvisioningState	provisioningState()
abstract java.util.List<StorageAccountKey>	regenerateKey(String keyName) Regenerates the access keys for this storage account.
abstract rx.Observable<java.util.List<StorageAccountKey>>	regenerateKeyAsync(String keyName) Regenerates the access keys for this storage account asynchronously.
abstract com.microsoft.rest.ServiceFuture<java.util.List<StorageAccountKey>>	regenerateKeyAsync(String keyName, ServiceCallback<List<StorageAccountKey>> callback) Regenerates the access keys for this storage account asynchronously.
abstract Sku	sku() Deprecated use skuType() instead.
abstract StorageAccountSkuType	skuType()
abstract java.lang.String	systemAssignedManagedServiceIdentityPrincipalId()
abstract java.lang.String	systemAssignedManagedServiceIdentityTenantId()

Method Details

accessTier

public abstract AccessTier accessTier()

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

accountStatuses

public abstract AccountStatuses accountStatuses()

Returns:

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

canAccessFromAzureServices

public abstract 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

canReadLogEntriesFromAnyNetwork

public abstract boolean canReadLogEntriesFromAnyNetwork()

Checks storage log entries can be read from any network.

Returns:

true if storage log entries can be read from any network, false otherwise

canReadMetricsFromAnyNetwork

public abstract boolean canReadMetricsFromAnyNetwork()

Checks storage metrics can be read from any network.

Returns:

true if storage metrics can be read from any network, false otherwise

creationTime

public abstract DateTime creationTime()

Returns:

the creation date and time of the storage account in UTC

customDomain

public abstract CustomDomain customDomain()

Returns:

the user assigned custom domain assigned to this storage account

encryption

public abstract Encryption encryption()

Deprecated

use encryptionKeySource(), encryptionStatuses() instead.

Returns:

the encryption settings on the account.

encryptionKeySource

public abstract StorageAccountEncryptionKeySource encryptionKeySource()

Returns:

the source of the key used for encryption.

encryptionStatuses

public abstract Map encryptionStatuses()

Returns:

the encryption statuses indexed by storage service type.

endPoints

public abstract PublicEndpoints endPoints()

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

getKeys

public abstract List getKeys()

Fetch the up-to-date access keys from Azure for this storage account.

Returns:

the access keys for this storage account

getKeysAsync

public abstract Observable<>> 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

getKeysAsync

public abstract ServiceFuture<>> getKeysAsync(ServiceCallback<>> callback)

Fetch the up-to-date access keys from Azure for this storage account asynchronously.

Parameters:

callback - the callback to call on success or failure, with access keys as parameter.

Returns:

a handle to cancel the request

ipAddressRangesWithAccess

public abstract List ipAddressRangesWithAccess()

Returns:

the list of ip address ranges having access to the storage account.

ipAddressesWithAccess

public abstract List ipAddressesWithAccess()

Returns:

the list of ip addresses having access to the storage account.

isAccessAllowedFromAllNetworks

public abstract boolean isAccessAllowedFromAllNetworks()

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.

isAzureFilesAadIntegrationEnabled

public abstract boolean isAzureFilesAadIntegrationEnabled()

Checks whether Aad Integration is enabled for files on this storage account.

Returns:

true if Aad integration is enabled, false otherwise

isBlobPublicAccessAllowed

public abstract boolean isBlobPublicAccessAllowed()

Checks whether blob public access is allowed.

Returns:

true if blob public access is allowed, false otherwise

isHnsEnabled

public abstract boolean isHnsEnabled()

Checks whether Hns is enabled on this storage account.

Returns:

true if Hns is enabled, false otherwise

isHttpsTrafficOnly

public abstract boolean isHttpsTrafficOnly()

Checks whether storage account only allow HTTPS traffic.

Returns:

true if only allow HTTPS traffic, false otherwise

isLargeFileSharesEnabled

public abstract boolean isLargeFileSharesEnabled()

Checks whether large file shares enabled on this storage account.

Returns:

true if large file shares is enabled, false otherwise

kind

public abstract Kind kind()

Returns:

the kind of the storage account. Possible values are 'Storage', 'BlobStorage'.

lastGeoFailoverTime

public abstract DateTime lastGeoFailoverTime()

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

minimumTlsVersion

public abstract MinimumTlsVersion minimumTlsVersion()

Returns:

the minimum TLS version for HTTPS traffic.

networkSubnetsWithAccess

public abstract List networkSubnetsWithAccess()

Returns:

the list of resource id of virtual network subnet having access to the storage account.

provisioningState

public abstract ProvisioningState provisioningState()

Returns:

the status of the storage account at the time the operation was called. Possible values include: 'Creating', 'ResolvingDNS', 'Succeeded'

regenerateKey

public abstract List 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

public abstract Observable<>> 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

regenerateKeyAsync

public abstract ServiceFuture<>> regenerateKeyAsync(String keyName, ServiceCallback<>> callback)

Regenerates the access keys for this storage account asynchronously.

Parameters:

keyName - if the key name

callback - the callback to call on success or failure, with access keys as parameter.

Returns:

a handle to cancel the request

sku

public abstract Sku sku()

Deprecated

use skuType() instead.

Returns:

the sku of this storage account.

skuType

public abstract StorageAccountSkuType skuType()

Returns:

the sku of this storage account.

systemAssignedManagedServiceIdentityPrincipalId

public abstract String systemAssignedManagedServiceIdentityPrincipalId()

Returns:

the Managed Service Identity specific Active Directory service principal ID assigned to the storage account.

systemAssignedManagedServiceIdentityTenantId

public abstract String systemAssignedManagedServiceIdentityTenantId()

Returns:

the Managed Service Identity specific Active Directory tenant ID assigned to the storage account.