com.microsoft.azure.storage

Class CloudStorageAccount

java.lang.Object

com.microsoft.azure.storage.CloudStorageAccount

public final class CloudStorageAccount
extends Object

Represents a Microsoft Azure storage account.

Constructor Summary

Constructors

Constructor and Description
CloudStorageAccount(StorageCredentials storageCredentials) Creates an instance of the CloudStorageAccount class using the specified account credentials.
CloudStorageAccount(StorageCredentials storageCredentials, boolean useHttps) Creates an instance of the CloudStorageAccount class using the specified account credentials and the default service endpoints, using HTTP or HTTPS as specified.
CloudStorageAccount(StorageCredentials storageCredentials, boolean useHttps, String endpointSuffix) Creates an instance of the CloudStorageAccount class using the specified account credentials.
CloudStorageAccount(StorageCredentials storageCredentials, boolean useHttps, String endpointSuffix, String accountName) Creates an instance of the CloudStorageAccount class using the specified account credentials.
CloudStorageAccount(StorageCredentials storageCredentials, StorageUri blobStorageUri, StorageUri queueStorageUri, StorageUri tableStorageUri) Creates an instance of the CloudStorageAccount class using the specified account credentials and service endpoints.
CloudStorageAccount(StorageCredentials storageCredentials, StorageUri blobStorageUri, StorageUri queueStorageUri, StorageUri tableStorageUri, StorageUri fileStorageUri) Creates an instance of the CloudStorageAccount class using the specified account credentials and service endpoints.
CloudStorageAccount(StorageCredentials storageCredentials, URI blobEndpoint, URI queueEndpoint, URI tableEndpoint) Creates an instance of the CloudStorageAccount class using the specified account credentials and service endpoints.
CloudStorageAccount(StorageCredentials storageCredentials, URI blobEndpoint, URI queueEndpoint, URI tableEndpoint, URI fileEndpoint) Creates an instance of the CloudStorageAccount class using the specified account credentials and service endpoints.

Method Summary

Methods

Modifier and Type	Method and Description
CloudAnalyticsClient	createCloudAnalyticsClient() Creates a new Analytics service client.
CloudBlobClient	createCloudBlobClient() Creates a new Blob service client.
CloudFileClient	createCloudFileClient() Creates a new File service client.
CloudQueueClient	createCloudQueueClient() Creates a new Queue service client.
CloudTableClient	createCloudTableClient() Creates a new Table service client.
String	generateSharedAccessSignature(SharedAccessAccountPolicy policy) Returns a shared access signature for the account.
URI	getBlobEndpoint() Returns the endpoint for the Blob service for the storage account.
StorageUri	getBlobStorageUri() Returns the endpoint for the Blob service for the storage account.
StorageCredentials	getCredentials() Returns the credentials for the storage account.
static CloudStorageAccount	getDevelopmentStorageAccount() Returns a CloudStorageAccount object that represents the development storage credentials.
static CloudStorageAccount	getDevelopmentStorageAccount(URI proxyUri) Returns a CloudStorageAccount object that represents the development storage credentials, using the specified proxy URI.
String	getEndpointSuffix() If an endpoint suffix was specified, return it
URI	getFileEndpoint() Returns the endpoint for the File service for the storage account.
StorageUri	getFileStorageUri() Returns the endpoint for the File service for the storage account.
URI	getQueueEndpoint() Returns the endpoint for the Queue service for the storage account.
StorageUri	getQueueStorageUri() Returns the endpoint for the Queue service for the storage account.
URI	getTableEndpoint() Returns the endpoint for the Table service for the storage account.
StorageUri	getTableStorageUri() Returns the endpoint for the Table service for the storage account.
static CloudStorageAccount	parse(String connectionString) Parses a connection string and returns a cloud storage account created from the connection string.
String	toString() Returns a connection string for this storage account, without sensitive data.
String	toString(boolean exportSecrets) Returns a connection string for this storage account, optionally with sensitive data.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CloudStorageAccount

public CloudStorageAccount(StorageCredentials storageCredentials)
                    throws URISyntaxException

Creates an instance of the CloudStorageAccount class using the specified account credentials.

With this constructor, the CloudStorageAccount object is constructed using the default HTTP storage service endpoints. The default HTTP storage service endpoints are http://myaccount.blob.core.windows.net, http://myaccount.queue.core.windows.net, http://myaccount.table.core.windows.net, and http://myaccount.file.core.windows.net, where myaccount is the name of your storage account.

The credentials provided when constructing the CloudStorageAccount object are used to authenticate all further requests against resources that are accessed via the CloudStorageAccount object or a client object created from it. A client object may be a CloudBlobClient object.

Parameters:

storageCredentials - A StorageCredentials object that represents the storage credentials to use to authenticate this account.

Throws:

URISyntaxException - If storageCredentials specify an invalid account name.

CloudStorageAccount

public CloudStorageAccount(StorageCredentials storageCredentials,
                   boolean useHttps)
                    throws URISyntaxException

Creates an instance of the CloudStorageAccount class using the specified account credentials and the default service endpoints, using HTTP or HTTPS as specified.

With this constructor, the CloudStorageAccount object is constructed using the default storage service endpoints. The default storage service endpoints are: [http|https]://myaccount.blob.core.windows.net; [http|https]://myaccount.queue.core.windows.net; [http|https]://myaccount.table.core.windows.net; and [http|https]://myaccount.file.core.windows.net, where myaccount is the name of your storage account. Access to the cloud storage account may be via HTTP or HTTPS, as specified by the useHttps parameter.

The credentials provided when constructing the CloudStorageAccount object are used to authenticate all further requests against resources that are accessed via the CloudStorageAccount object or a client object created from it. A client object may be a CloudBlobClient object.

Parameters:

storageCredentials - A StorageCredentials object that represents the storage credentials to use to authenticate this account.

useHttps - true to use HTTPS to connect to the storage service endpoints; otherwise, false.

Throws:

URISyntaxException - If storageCredentials specify an invalid account name.

CloudStorageAccount

public CloudStorageAccount(StorageCredentials storageCredentials,
                   boolean useHttps,
                   String endpointSuffix)
                    throws URISyntaxException

Creates an instance of the CloudStorageAccount class using the specified account credentials.

With this constructor, the CloudStorageAccount object is constructed using the given HTTP storage service endpoint suffix (if any, otherwise the default is used). The credentials provided when constructing the CloudStorageAccount object are used to authenticate all further requests against resources that are accessed via the CloudStorageAccount object or a client object created from it. A client object may be a CloudBlobClient object.

Parameters:

storageCredentials - A StorageCredentials object that represents the storage credentials to use to authenticate this account.

useHttps - true to use HTTPS to connect to the storage service endpoints; otherwise, false.

endpointSuffix - A String that represents the endpointSuffix to use, if any.

Throws:

URISyntaxException - If storageCredentials specify an invalid account name.

CloudStorageAccount

public CloudStorageAccount(StorageCredentials storageCredentials,
                   boolean useHttps,
                   String endpointSuffix,
                   String accountName)
                    throws URISyntaxException

Creates an instance of the CloudStorageAccount class using the specified account credentials.

With this constructor, the CloudStorageAccount object is constructed using the given HTTP storage service endpoint suffix (if any, otherwise the default is used). The credentials provided when constructing the CloudStorageAccount object are used to authenticate all further requests against resources that are accessed via the CloudStorageAccount object or a client object created from it. A client object may be a CloudBlobClient object.

Parameters:

storageCredentials - A StorageCredentials object that represents the storage credentials to use to authenticate this account.

useHttps - true to use HTTPS to connect to the storage service endpoints; otherwise, false.

endpointSuffix - A String that represents the endpointSuffix to use, if any.

accountName - A String that contains the account name. This will be used in place of a null StorageCredentials.getAccountName(), but the two must match if both are not null.

Throws:

URISyntaxException - If storageCredentials specify an invalid account name.

CloudStorageAccount

public CloudStorageAccount(StorageCredentials storageCredentials,
                   URI blobEndpoint,
                   URI queueEndpoint,
                   URI tableEndpoint)

Creates an instance of the CloudStorageAccount class using the specified account credentials and service endpoints.

Use this constructor to construct a CloudStorageAccount object using custom endpoints, in the case where you've configured a custom domain name for your storage account.

The credentials provided when constructing the CloudStorageAccount object are used to authenticate all further requests against resources that are accessed via the CloudStorageAccount object or a client object created from it. A client object may be a CloudBlobClient object.

Parameters:

storageCredentials - A StorageCredentials object that represents the storage credentials to use to authenticate this account.

blobEndpoint - A java.net.URI object that represents the Blob service endpoint.

queueEndpoint - A java.net.URI object that represents the Queue service endpoint.

tableEndpoint - A java.net.URI object that represents the Table service endpoint.

CloudStorageAccount

public CloudStorageAccount(StorageCredentials storageCredentials,
                   URI blobEndpoint,
                   URI queueEndpoint,
                   URI tableEndpoint,
                   URI fileEndpoint)

Creates an instance of the CloudStorageAccount class using the specified account credentials and service endpoints.

Use this constructor to construct a CloudStorageAccount object using custom endpoints, in the case where you've configured a custom domain name for your storage account.

The credentials provided when constructing the CloudStorageAccount object are used to authenticate all further requests against resources that are accessed via the CloudStorageAccount object or a client object created from it. A client object may be a CloudBlobClient object.

Parameters:

storageCredentials - A StorageCredentials object that represents the storage credentials to use to authenticate this account.

blobEndpoint - A java.net.URI object that represents the Blob service endpoint.

queueEndpoint - A java.net.URI object that represents the Queue service endpoint.

tableEndpoint - A java.net.URI object that represents the Table service endpoint.

fileEndpoint - A java.net.URI object that represents the File service endpoint.

CloudStorageAccount

public CloudStorageAccount(StorageCredentials storageCredentials,
                   StorageUri blobStorageUri,
                   StorageUri queueStorageUri,
                   StorageUri tableStorageUri)

Creates an instance of the CloudStorageAccount class using the specified account credentials and service endpoints.

Use this constructor to construct a CloudStorageAccount object using custom endpoints, in the case where you've configured a custom domain name for your storage account.

The credentials provided when constructing the CloudStorageAccount object are used to authenticate all further requests against resources that are accessed via the CloudStorageAccount object or a client object created from it. A client object may be a CloudBlobClient object.

Parameters:

storageCredentials - A StorageCredentials object that represents the storage credentials to use to authenticate this account.

blobStorageUri - A StorageUri object that represents the Blob service endpoint.

queueStorageUri - A StorageUri object that represents the Queue service endpoint.

tableStorageUri - A StorageUri object that represents the Table service endpoint.

CloudStorageAccount

public CloudStorageAccount(StorageCredentials storageCredentials,
                   StorageUri blobStorageUri,
                   StorageUri queueStorageUri,
                   StorageUri tableStorageUri,
                   StorageUri fileStorageUri)

Creates an instance of the CloudStorageAccount class using the specified account credentials and service endpoints.

Use this constructor to construct a CloudStorageAccount object using custom endpoints, in the case where you've configured a custom domain name for your storage account.

The credentials provided when constructing the CloudStorageAccount object are used to authenticate all further requests against resources that are accessed via the CloudStorageAccount object or a client object created from it. A client object may be a CloudBlobClient object.

Parameters:

storageCredentials - A StorageCredentials object that represents the storage credentials to use to authenticate this account.

blobStorageUri - A StorageUri object that represents the Blob service endpoint.

queueStorageUri - A StorageUri object that represents the Queue service endpoint.

tableStorageUri - A StorageUri object that represents the Table service endpoint.

fileStorageUri - A StorageUri object that represents the File service endpoint.

Method Detail

getDevelopmentStorageAccount

public static CloudStorageAccount getDevelopmentStorageAccount()

Returns a CloudStorageAccount object that represents the development storage credentials. Secondary endpoints are enabled by default.

Returns:

A CloudStorageAccount object for the development storage credentials.

getDevelopmentStorageAccount

public static CloudStorageAccount getDevelopmentStorageAccount(URI proxyUri)
                                                        throws URISyntaxException

Returns a CloudStorageAccount object that represents the development storage credentials, using the specified proxy URI. Secondary endpoints are enabled by default.

Parameters:

proxyUri - A java.net.URI object that represents the proxy endpoint to use. Specifying null will use the default http://127.0.0.1.

Returns:

A CloudStorageAccount object for the development storage credentials.

Throws:

URISyntaxException - If the resource URI is invalid.

parse

public static CloudStorageAccount parse(String connectionString)
                                 throws URISyntaxException,
                                        InvalidKeyException

Parses a connection string and returns a cloud storage account created from the connection string.

The connection string should be in the Azure connection string format.

Note that while a connection string may include a SAS token, it is often easier to use the CloudBlobContainer.CloudBlobContainer(URI), CloudQueue.CloudQueue(URI), CloudTable.CloudTable(URI) constructors directly. To do this, create a StorageCredentialsSharedAccessSignature.StorageCredentialsSharedAccessSignature(String) object with your SAS token, use the StorageCredentials.transformUri(URI) method on the container, queue, or table URI, and then use that URI to construct the object.

Parameters:

connectionString - A String that represents the connection string to parse.

Returns:

A CloudStorageAccount object that represents the cloud storage account constructed from the values provided in the connection string.

Throws:

InvalidKeyException - If credentials in the connection string contain an invalid key.

URISyntaxException - If the connection string specifies an invalid URI.

createCloudAnalyticsClient

public CloudAnalyticsClient createCloudAnalyticsClient()

Creates a new Analytics service client.

Returns:

An analytics client object that uses the Blob and Table service endpoints.

createCloudBlobClient

public CloudBlobClient createCloudBlobClient()

Creates a new Blob service client.

Returns:

A CloudBlobClient that represents the cloud Blob client.

createCloudFileClient

public CloudFileClient createCloudFileClient()

Creates a new File service client.

Returns:

A CloudFileClient that represents the cloud File client.

createCloudQueueClient

public CloudQueueClient createCloudQueueClient()

Creates a new Queue service client.

Returns:

A client object that uses the Queue service endpoint.

createCloudTableClient

public CloudTableClient createCloudTableClient()

Creates a new Table service client.

Returns:

A client object that uses the Table service endpoint.

getBlobEndpoint

public URI getBlobEndpoint()

Returns the endpoint for the Blob service for the storage account. This method is not supported when using shared access signature credentials.

Returns:

A java.net.URI object that represents the Blob endpoint associated with this account.

getBlobStorageUri

public StorageUri getBlobStorageUri()

Returns the endpoint for the Blob service for the storage account. This method is not supported when using shared access signature credentials.

Returns:

A StorageUri object that represents the Blob endpoint associated with this account.

getCredentials

public StorageCredentials getCredentials()

Returns the credentials for the storage account.

Returns:

A StorageCredentials object that represents the credentials for this storage account.

getEndpointSuffix

public String getEndpointSuffix()

If an endpoint suffix was specified, return it

Returns:

the endpoint suffix

getFileEndpoint

public URI getFileEndpoint()

Returns the endpoint for the File service for the storage account. This method is not supported when using shared access signature credentials.

Returns:

A java.net.URI object that represents the File endpoint associated with this account.

getFileStorageUri

public StorageUri getFileStorageUri()

Returns the endpoint for the File service for the storage account. This method is not supported when using shared access signature credentials.

Returns:

A StorageUri object that represents the File endpoint associated with this account.

getQueueEndpoint

public URI getQueueEndpoint()

Returns the endpoint for the Queue service for the storage account.

Returns:

A java.net.URI object that represents the queue endpoint associated with this account.

getQueueStorageUri

public StorageUri getQueueStorageUri()

Returns the endpoint for the Queue service for the storage account.

Returns:

A StorageUri object that represents the Queue endpoint associated with this account.

getTableEndpoint

public URI getTableEndpoint()

Returns the endpoint for the Table service for the storage account.

Returns:

A StorageUri object that represents the Table endpoint associated with this account.

getTableStorageUri

public StorageUri getTableStorageUri()

Returns the endpoint for the Table service for the storage account.

Returns:

A java.net.URI object that represents the Table endpoint associated with this account.

generateSharedAccessSignature

public String generateSharedAccessSignature(SharedAccessAccountPolicy policy)
                                     throws InvalidKeyException,
                                            StorageException

Returns a shared access signature for the account.

Parameters:

policy - A SharedAccessAccountPolicy specifying the access policy for the shared access signature.

Returns:

The query string returned includes the leading question mark.

Throws:

StorageException - If a storage service error occurred.

InvalidKeyException - If the key is invalid.

toString

public String toString()

Returns a connection string for this storage account, without sensitive data.

Overrides:

toString in class Object

Returns:

A String that represents the connection string for this storage account, without sensitive data.

toString

public String toString(boolean exportSecrets)

Returns a connection string for this storage account, optionally with sensitive data.

Parameters:

exportSecrets - true to include sensitive data in the string; otherwise, false.

Returns:

A String that represents the connection string for this storage account, optionally with sensitive data.