Microsoft Azure Storage Client Library for C++  7.5.0
The Microsoft Azure Storage Client Library for C++ is a library for working with the Azure Storage Services in C++.
Public Member Functions | Static Public Member Functions | List of all members
azure::storage::cloud_storage_account Class Reference

Represents a Windows Azure storage account. More...

Public Member Functions

 cloud_storage_account ()
 Initializes a new instance of the azure::storage::cloud_storage_account class. More...
 
 cloud_storage_account (const storage_credentials &credentials, const storage_uri &blob_endpoint, const storage_uri &queue_endpoint, const storage_uri &table_endpoint)
 Initializes a new instance of the azure::storage::cloud_storage_account class using the specified credentials and service endpoints. More...
 
 cloud_storage_account (const storage_credentials &credentials, const storage_uri &blob_endpoint, const storage_uri &queue_endpoint, const storage_uri &table_endpoint, const storage_uri &file_endpoint)
 Initializes a new instance of the azure::storage::cloud_storage_account class using the specified credentials and service endpoints. More...
 
 cloud_storage_account (const storage_credentials &credentials, bool use_https)
 Initializes a new instance of the azure::storage::cloud_storage_account class using the specified credentials and the default service endpoints. More...
 
 cloud_storage_account (const storage_credentials &credentials, const utility::string_t &endpoint_suffix, bool use_https)
 Initializes a new instance of the azure::storage::cloud_storage_account class using the specified credentials and the default service endpoints. More...
 
WASTORAGE_API cloud_blob_client create_cloud_blob_client () const
 Creates the Blob service client. More...
 
WASTORAGE_API cloud_blob_client create_cloud_blob_client (const blob_request_options &default_request_options) const
 Creates the Blob service client. More...
 
WASTORAGE_API cloud_queue_client create_cloud_queue_client () const
 Creates the Queue service client. More...
 
WASTORAGE_API cloud_queue_client create_cloud_queue_client (const queue_request_options &default_request_options) const
 Creates the Queue service client. More...
 
WASTORAGE_API cloud_table_client create_cloud_table_client () const
 Creates the Table service client. More...
 
WASTORAGE_API cloud_table_client create_cloud_table_client (const table_request_options &default_request_options) const
 Creates the Table service client. More...
 
WASTORAGE_API cloud_file_client create_cloud_file_client () const
 Creates the File service client. More...
 
WASTORAGE_API cloud_file_client create_cloud_file_client (const file_request_options &default_request_options) const
 Creates the File service client. More...
 
utility::string_t to_string ()
 Returns a connection string for this storage account, without sensitive data. More...
 
WASTORAGE_API utility::string_t to_string (bool export_secrets)
 Returns a connection string for the storage account, optionally with sensitive data. More...
 
const storage_uriblob_endpoint () const
 Gets the endpoint for the Blob service for all location. More...
 
const storage_uriqueue_endpoint () const
 Gets the endpoint for the Queue service for all location. More...
 
const storage_uritable_endpoint () const
 Gets the endpoint for the Table service for all location. More...
 
const storage_urifile_endpoint () const
 Gets the endpoint for the File service for all location. More...
 
const storage_credentialscredentials () const
 Gets the credentials used to create this azure::storage::cloud_storage_account object. More...
 
bool is_initialized () const
 Indicates whether the storage account has been initialized. More...
 
WASTORAGE_API utility::string_t get_shared_access_signature (const account_shared_access_policy &policy) const
 Returns a shared access signature for the account. More...
 

Static Public Member Functions

static WASTORAGE_API cloud_storage_account parse (const utility::string_t &connection_string)
 Parses a connection string and returns an azure::storage::cloud_storage_account created from the connection string. More...
 
static WASTORAGE_API cloud_storage_account development_storage_account ()
 Gets an azure::storage::cloud_storage_account object that references the development storage account. More...
 

Detailed Description

Represents a Windows Azure storage account.

Constructor & Destructor Documentation

◆ cloud_storage_account() [1/5]

azure::storage::cloud_storage_account::cloud_storage_account ( )
inline

Initializes a new instance of the azure::storage::cloud_storage_account class.

◆ cloud_storage_account() [2/5]

azure::storage::cloud_storage_account::cloud_storage_account ( const storage_credentials credentials,
const storage_uri blob_endpoint,
const storage_uri queue_endpoint,
const storage_uri table_endpoint 
)
inline

Initializes a new instance of the azure::storage::cloud_storage_account class using the specified credentials and service endpoints.

Parameters
credentialsThe azure::storage::storage_credentials to use.
blob_endpointThe Blob service endpoint.
queue_endpointThe Queue service endpoint.
table_endpointThe Table service endpoint.

◆ cloud_storage_account() [3/5]

azure::storage::cloud_storage_account::cloud_storage_account ( const storage_credentials credentials,
const storage_uri blob_endpoint,
const storage_uri queue_endpoint,
const storage_uri table_endpoint,
const storage_uri file_endpoint 
)
inline

Initializes a new instance of the azure::storage::cloud_storage_account class using the specified credentials and service endpoints.

Parameters
credentialsThe azure::storage::storage_credentials to use.
blob_endpointThe Blob service endpoint.
queue_endpointThe Queue service endpoint.
table_endpointThe Table service endpoint.
file_endpointThe File service endpoint.

◆ cloud_storage_account() [4/5]

azure::storage::cloud_storage_account::cloud_storage_account ( const storage_credentials credentials,
bool  use_https 
)
inline

Initializes a new instance of the azure::storage::cloud_storage_account class using the specified credentials and the default service endpoints.

Parameters
credentialsThe azure::storage::storage_credentials to use.
use_httpstrue to use HTTPS to connect to storage service endpoints; otherwise, false.

◆ cloud_storage_account() [5/5]

azure::storage::cloud_storage_account::cloud_storage_account ( const storage_credentials credentials,
const utility::string_t &  endpoint_suffix,
bool  use_https 
)
inline

Initializes a new instance of the azure::storage::cloud_storage_account class using the specified credentials and the default service endpoints.

Parameters
credentialsThe azure::storage::storage_credentials to use.
endpoint_suffixThe DNS endpoint suffix for the storage services, e.g., "core.windows.net".
use_httpstrue to use HTTPS to connect to storage service endpoints; otherwise, false.

Member Function Documentation

◆ blob_endpoint()

const storage_uri& azure::storage::cloud_storage_account::blob_endpoint ( ) const
inline

Gets the endpoint for the Blob service for all location.

Returns
An azure::storage::storage_uri object containing the Blob service endpoint for all locations.

◆ create_cloud_blob_client() [1/2]

WASTORAGE_API cloud_blob_client azure::storage::cloud_storage_account::create_cloud_blob_client ( ) const

Creates the Blob service client.

Returns
A client object that specifies the Blob service endpoint.

◆ create_cloud_blob_client() [2/2]

WASTORAGE_API cloud_blob_client azure::storage::cloud_storage_account::create_cloud_blob_client ( const blob_request_options default_request_options) const

Creates the Blob service client.

Returns
A client object that specifies the Blob service endpoint.

◆ create_cloud_file_client() [1/2]

WASTORAGE_API cloud_file_client azure::storage::cloud_storage_account::create_cloud_file_client ( ) const

Creates the File service client.

Returns
A client object that specifies the Blob service endpoint.

◆ create_cloud_file_client() [2/2]

WASTORAGE_API cloud_file_client azure::storage::cloud_storage_account::create_cloud_file_client ( const file_request_options default_request_options) const

Creates the File service client.

Returns
A client object that specifies the Blob service endpoint.

◆ create_cloud_queue_client() [1/2]

WASTORAGE_API cloud_queue_client azure::storage::cloud_storage_account::create_cloud_queue_client ( ) const

Creates the Queue service client.

Returns
A client object that specifies the Queue service endpoint.

◆ create_cloud_queue_client() [2/2]

WASTORAGE_API cloud_queue_client azure::storage::cloud_storage_account::create_cloud_queue_client ( const queue_request_options default_request_options) const

Creates the Queue service client.

Returns
A client object that specifies the Queue service endpoint.

◆ create_cloud_table_client() [1/2]

WASTORAGE_API cloud_table_client azure::storage::cloud_storage_account::create_cloud_table_client ( ) const

Creates the Table service client.

Returns
A client object that specifies the Table service endpoint.

◆ create_cloud_table_client() [2/2]

WASTORAGE_API cloud_table_client azure::storage::cloud_storage_account::create_cloud_table_client ( const table_request_options default_request_options) const

Creates the Table service client.

Returns
A client object that specifies the Table service endpoint.

◆ credentials()

const storage_credentials& azure::storage::cloud_storage_account::credentials ( ) const
inline

Gets the credentials used to create this azure::storage::cloud_storage_account object.

Returns
The credentials used to create the azure::storage::cloud_storage_account object.

◆ development_storage_account()

static WASTORAGE_API cloud_storage_account azure::storage::cloud_storage_account::development_storage_account ( )
static

Gets an azure::storage::cloud_storage_account object that references the development storage account.

Returns
A reference to the development storage account.

◆ file_endpoint()

const storage_uri& azure::storage::cloud_storage_account::file_endpoint ( ) const
inline

Gets the endpoint for the File service for all location.

Returns
An azure::storage::storage_uri object containing the Table service endpoint for all locations.

◆ get_shared_access_signature()

WASTORAGE_API utility::string_t azure::storage::cloud_storage_account::get_shared_access_signature ( const account_shared_access_policy policy) const

Returns a shared access signature for the account.

Parameters
policyThe access policy for the shared access signature.
Returns
A string containing a shared access signature.

◆ is_initialized()

bool azure::storage::cloud_storage_account::is_initialized ( ) const
inline

Indicates whether the storage account has been initialized.

Returns
true if the storage account has been initialized.

◆ parse()

static WASTORAGE_API cloud_storage_account azure::storage::cloud_storage_account::parse ( const utility::string_t &  connection_string)
static

Parses a connection string and returns an azure::storage::cloud_storage_account created from the connection string.

Parameters
connection_stringA valid connection string.
Returns
An azure::storage::cloud_storage_account object constructed from the values provided in the connection string.

◆ queue_endpoint()

const storage_uri& azure::storage::cloud_storage_account::queue_endpoint ( ) const
inline

Gets the endpoint for the Queue service for all location.

Returns
An azure::storage::storage_uri object containing the Queue service endpoint for all locations.

◆ table_endpoint()

const storage_uri& azure::storage::cloud_storage_account::table_endpoint ( ) const
inline

Gets the endpoint for the Table service for all location.

Returns
An azure::storage::storage_uri object containing the Table service endpoint for all locations.

◆ to_string() [1/2]

utility::string_t azure::storage::cloud_storage_account::to_string ( )
inline

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

Returns
A connection string.

◆ to_string() [2/2]

WASTORAGE_API utility::string_t azure::storage::cloud_storage_account::to_string ( bool  export_secrets)

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

Parameters
export_secretstrue to include sensitive data in the string; otherwise, false.
Returns
A connection string.