azure::storage::cloud_blob_client Class Reference

Provides a client-side logical representation of the Windows Azure Blob Service. This client is used to configure and execute requests against the Blob Service. More...

Inheritance diagram for azure::storage::cloud_blob_client:

Public Member Functions
	cloud_blob_client ()
	Initializes a new instance of the azure::storage::cloud_blob_client class. More...
	cloud_blob_client (storage_uri base_uri)
	Initializes a new instance of the azure::storage::cloud_blob_client class using the specified Blob service endpoint and anonymous credentials. More...
	cloud_blob_client (storage_uri base_uri, storage_credentials credentials)
	Initializes a new instance of the azure::storage::cloud_blob_client class using the specified Blob service endpoint and account credentials. More...
	cloud_blob_client (storage_uri base_uri, storage_credentials credentials, blob_request_options default_request_options)
	Initializes a new instance of the azure::storage::cloud_blob_client class using the specified Blob service endpoint and account credentials. More...
WASTORAGE_API void	set_authentication_scheme (azure::storage::authentication_scheme value) override
	Sets the authentication scheme to use to sign HTTP requests. More...
container_result_iterator	list_containers () const
	Returns an azure::storage::container_result_iterator that can be used to to lazily enumerate a collection of containers. More...
container_result_iterator	list_containers (const utility::string_t &prefix) const
	Returns an azure::storage::container_result_iterator that can be used to to lazily enumerate a collection of containers. More...
WASTORAGE_API container_result_iterator	list_containers (const utility::string_t &prefix, container_listing_details::values includes, int max_results, const blob_request_options &options, operation_context context) const
	Returns an azure::storage::container_result_iterator that can be used to to lazily enumerate a collection of containers. More...
container_result_segment	list_containers_segmented (const continuation_token &token) const
	Returns a result segment containing a collection of azure::storage::cloud_blob_container objects. More...
container_result_segment	list_containers_segmented (const utility::string_t &prefix, const continuation_token &token) const
	Returns a result segment containing a collection of azure::storage::cloud_blob_container objects. More...
container_result_segment	list_containers_segmented (const utility::string_t &prefix, container_listing_details::values includes, int max_results, const continuation_token &token, const blob_request_options &options, operation_context context) const
	Returns a result segment containing a collection of azure::storage::cloud_blob_container objects. More...
pplx::task< container_result_segment >	list_containers_segmented_async (const continuation_token &token) const
	Initiates an asynchronous operation to return a result segment containing a collection of azure::storage::cloud_blob_container objects. More...
pplx::task< container_result_segment >	list_containers_segmented_async (const utility::string_t &prefix, const continuation_token &token) const
	Initiates an asynchronous operation to return a result segment containing a collection of azure::storage::cloud_blob_container objects. More...
pplx::task< container_result_segment >	list_containers_segmented_async (const utility::string_t &prefix, container_listing_details::values includes, int max_results, const continuation_token &token, const blob_request_options &options, operation_context context) const
	Initiates an asynchronous operation to return a result segment containing a collection of azure::storage::cloud_blob_container objects. More...
WASTORAGE_API pplx::task< container_result_segment >	list_containers_segmented_async (const utility::string_t &prefix, container_listing_details::values includes, int max_results, const continuation_token &token, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token) const
	Initiates an asynchronous operation to return a result segment containing a collection of azure::storage::cloud_blob_container objects. More...
list_blob_item_iterator	list_blobs (const utility::string_t &prefix) const
	Returns an azure::storage::list_blob_item_iterator that can be used to to lazily enumerate a collection of blob items. More...
WASTORAGE_API list_blob_item_iterator	list_blobs (const utility::string_t &prefix, bool use_flat_blob_listing, blob_listing_details::values includes, int max_results, const blob_request_options &options, operation_context context) const
	Returns an azure::storage::list_blob_item_iterator that can be used to to lazily enumerate a collection of blob items. More...
list_blob_item_segment	list_blobs_segmented (const utility::string_t &prefix, const continuation_token &token) const
	Returns an azure::storage::list_blob_item_segment containing a collection of blob items in the container. More...
list_blob_item_segment	list_blobs_segmented (const utility::string_t &prefix, bool use_flat_blob_listing, blob_listing_details::values includes, int max_results, const continuation_token &token, const blob_request_options &options, operation_context context) const
	Returns an azure::storage::list_blob_item_segment containing a collection of blob items in the container. More...
pplx::task< list_blob_item_segment >	list_blobs_segmented_async (const utility::string_t &prefix, const continuation_token &token) const
	Initiates an asynchronous operation to return an azure::storage::list_blob_item_segment containing a collection of blob items in the container. More...
pplx::task< list_blob_item_segment >	list_blobs_segmented_async (const utility::string_t &prefix, bool use_flat_blob_listing, blob_listing_details::values includes, int max_results, const continuation_token &token, const blob_request_options &options, operation_context context) const
	Initiates an asynchronous operation to return an azure::storage::list_blob_item_segment containing a collection of blob items in the container. More...
WASTORAGE_API pplx::task< list_blob_item_segment >	list_blobs_segmented_async (const utility::string_t &prefix, bool use_flat_blob_listing, blob_listing_details::values includes, int max_results, const continuation_token &token, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token) const
	Initiates an asynchronous operation to return an azure::storage::list_blob_item_segment containing a collection of blob items in the container. More...
service_properties	download_service_properties () const
	Gets the service properties for the Blob service client. More...
service_properties	download_service_properties (const blob_request_options &options, operation_context context) const
	Gets the service properties for the Blob service client. More...
pplx::task< service_properties >	download_service_properties_async () const
	Initiates an asynchronous operation to get the properties of the service. More...
pplx::task< service_properties >	download_service_properties_async (const blob_request_options &options, operation_context context) const
	Initiates an asynchronous operation to get the properties of the service. More...
WASTORAGE_API pplx::task< service_properties >	download_service_properties_async (const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token) const
	Initiates an asynchronous operation to get the properties of the service. More...
void	upload_service_properties (const service_properties &properties, const service_properties_includes &includes) const
	Sets the service properties for the Blob service client. More...
void	upload_service_properties (const service_properties &properties, const service_properties_includes &includes, const blob_request_options &options, operation_context context) const
	Sets the service properties for the Blob service client. More...
pplx::task< void >	upload_service_properties_async (const service_properties &properties, const service_properties_includes &includes) const
	Initiates an asynchronous operation to set the service properties for the Blob service client. More...
pplx::task< void >	upload_service_properties_async (const service_properties &properties, const service_properties_includes &includes, const blob_request_options &options, operation_context context) const
	Initiates an asynchronous operation to set the service properties for the Blob service client. More...
WASTORAGE_API pplx::task< void >	upload_service_properties_async (const service_properties &properties, const service_properties_includes &includes, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token) const
	Initiates an asynchronous operation to set the service properties for the Blob service client. More...
service_stats	download_service_stats () const
	Gets the service stats for the Blob service client. More...
service_stats	download_service_stats (const blob_request_options &options, operation_context context) const
	Gets the service stats for the Blob service client. More...
pplx::task< service_stats >	download_service_stats_async () const
	Initiates an asynchronous operation to get the stats of the service. More...
pplx::task< service_stats >	download_service_stats_async (const blob_request_options &options, operation_context context) const
	Initiates an asynchronous operation to get the stats of the service. More...
WASTORAGE_API pplx::task< service_stats >	download_service_stats_async (const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token) const
	Initiates an asynchronous operation to get the stats of the service. More...
account_properties	download_account_properties () const
	Gets the account properties the Blob service client. More...
account_properties	download_account_properties (const blob_request_options &options, operation_context context) const
	Gets the account properties the Blob service client. More...
pplx::task< account_properties >	download_account_properties_async () const
	Initiates an asynchronous operation to get the account properties of the service. More...
pplx::task< account_properties >	download_account_properties_async (const blob_request_options &options, operation_context context) const
	Initiates an asynchronous operation to get the account properties of the service. More...
WASTORAGE_API pplx::task< account_properties >	download_account_properties_async (const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token) const
	Initiates an asynchronous operation to get the account properties of the service. More...
WASTORAGE_API cloud_blob_container	get_root_container_reference () const
	Returns a reference to an azure::storage::cloud_blob_container object. More...
WASTORAGE_API cloud_blob_container	get_container_reference (utility::string_t container_name) const
	Returns a reference to an azure::storage::cloud_blob_container object with the specified name. More...
const blob_request_options &	default_request_options () const
	Returns the default set of request options. More...
const utility::string_t &	directory_delimiter () const
	Gets the default delimiter that may be used to create a virtual directory structure of blobs. More...
void	set_directory_delimiter (utility::string_t value)
	Sets the default delimiter that may be used to create a virtual directory structure of blobs. More...
user_delegation_key	get_user_delegation_key (const utility::datetime &start, const utility::datetime &expiry)
	Gets a key that can be used to sign a user delegation SAS (shared access signature). More...
pplx::task< user_delegation_key >	get_user_delegation_key_async (const utility::datetime &start, const utility::datetime &expiry)
	Initiates an asynchronous operation to get a key that can be used to sign a user delegation SAS (shared access signature). More...
WASTORAGE_API pplx::task< user_delegation_key >	get_user_delegation_key_async (const utility::datetime &start, const utility::datetime &expiry, const request_options &modified_options, operation_context context, const pplx::cancellation_token &cancellation_token)
	Initiates an asynchronous operation to get a key that can be used to sign a user delegation SAS (shared access signature). More...
Public Member Functions inherited from azure::storage::cloud_client
const storage_uri &	base_uri () const
	Gets the base URI for the service client. More...
const azure::storage::storage_credentials &	credentials () const
	Gets the storage account credentials for the service client. More...
azure::storage::authentication_scheme	authentication_scheme () const
	Gets the authentication scheme to use to sign HTTP requests for the service client. More...
std::shared_ptr< protocol::authentication_handler >	authentication_handler () const
	Gets the authentication handler to use to sign HTTP requests. More...

Detailed Description

Provides a client-side logical representation of the Windows Azure Blob Service. This client is used to configure and execute requests against the Blob Service.

The service client encapsulates the base URI for the Blob service. If the service client will be used for authenticated access, it also encapsulates the credentials for accessing the storage account.

Constructor & Destructor Documentation

cloud_blob_client() [1/4]

azure::storage::cloud_blob_client::cloud_blob_client ( )

inline

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

cloud_blob_client() [2/4]

azure::storage::cloud_blob_client::cloud_blob_client ( storage_uri  base_uri )

inlineexplicit

Initializes a new instance of the azure::storage::cloud_blob_client class using the specified Blob service endpoint and anonymous credentials.

Parameters

base_uri

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

cloud_blob_client() [3/4]

azure::storage::cloud_blob_client::cloud_blob_client ( storage_uri  base_uri, storage_credentials  credentials  )

inline

Initializes a new instance of the azure::storage::cloud_blob_client class using the specified Blob service endpoint and account credentials.

Parameters

base_uri	An azure::storage::storage_uri object containing the Blob service endpoint for all locations.
credentials	The azure::storage::storage_credentials to use.

cloud_blob_client() [4/4]

azure::storage::cloud_blob_client::cloud_blob_client ( storage_uri  base_uri, storage_credentials  credentials, blob_request_options  default_request_options  )

inline

Initializes a new instance of the azure::storage::cloud_blob_client class using the specified Blob service endpoint and account credentials.

Parameters

base_uri	An azure::storage::storage_uri object containing the Blob service endpoint for all locations.
credentials	The azure::storage::storage_credentials to use.
default_request_options	The default azure::storage::blob_request_options object to use for all requests made with this client object.

Member Function Documentation

default_request_options()

const blob_request_options& azure::storage::cloud_blob_client::default_request_options ( ) const

inline

Returns the default set of request options.

Returns

An azure::storage::blob_request_options object.

directory_delimiter()

const utility::string_t& azure::storage::cloud_blob_client::directory_delimiter ( ) const

inline

Gets the default delimiter that may be used to create a virtual directory structure of blobs.

Returns

A string containing the default delimiter.

download_account_properties() [1/2]

account_properties azure::storage::cloud_blob_client::download_account_properties ( ) const

inline

Gets the account properties the Blob service client.

Returns

The azure::storage::account_properties for the Blob service client.

download_account_properties() [2/2]

account_properties azure::storage::cloud_blob_client::download_account_properties ( const blob_request_options &  options, operation_context  context  ) const

inline

Gets the account properties the Blob service client.

Parameters

options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

The azure::storage::account_properties for the Blob service client.

download_account_properties_async() [1/3]

pplx::task<account_properties> azure::storage::cloud_blob_client::download_account_properties_async ( ) const

inline

Initiates an asynchronous operation to get the account properties of the service.

Returns

A pplx::task object of type azure::storage::account_properties that represents the current operation.

download_account_properties_async() [2/3]

pplx::task<account_properties> azure::storage::cloud_blob_client::download_account_properties_async ( const blob_request_options &  options, operation_context  context  ) const

inline

Initiates an asynchronous operation to get the account properties of the service.

Parameters

options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object of type azure::storage::account_properties that represents the current operation.

download_account_properties_async() [3/3]

WASTORAGE_API pplx::task<account_properties> azure::storage::cloud_blob_client::download_account_properties_async	(	const blob_request_options &	options,
		operation_context	context,
		const pplx::cancellation_token &	cancellation_token
	)		const

Initiates an asynchronous operation to get the account properties of the service.

Parameters

options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

A pplx::task object of type azure::storage::service_stats that represents the current operation.

download_service_properties() [1/2]

service_properties azure::storage::cloud_blob_client::download_service_properties ( ) const

inline

Gets the service properties for the Blob service client.

Returns

The azure::storage::service_properties for the Blob service client.

download_service_properties() [2/2]

service_properties azure::storage::cloud_blob_client::download_service_properties ( const blob_request_options &  options, operation_context  context  ) const

inline

Gets the service properties for the Blob service client.

Parameters

options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

The azure::storage::service_properties for the Blob service client.

download_service_properties_async() [1/3]

pplx::task<service_properties> azure::storage::cloud_blob_client::download_service_properties_async ( ) const

inline

Initiates an asynchronous operation to get the properties of the service.

Returns

A pplx::task object of type azure::storage::service_properties that represents the current operation.

download_service_properties_async() [2/3]

pplx::task<service_properties> azure::storage::cloud_blob_client::download_service_properties_async ( const blob_request_options &  options, operation_context  context  ) const

inline

Initiates an asynchronous operation to get the properties of the service.

Parameters

options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object of type azure::storage::service_properties that represents the current operation.

download_service_properties_async() [3/3]

WASTORAGE_API pplx::task<service_properties> azure::storage::cloud_blob_client::download_service_properties_async	(	const blob_request_options &	options,
		operation_context	context,
		const pplx::cancellation_token &	cancellation_token
	)		const

Initiates an asynchronous operation to get the properties of the service.

Parameters

options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

A pplx::task object of type azure::storage::service_properties that represents the current operation.

download_service_stats() [1/2]

service_stats azure::storage::cloud_blob_client::download_service_stats ( ) const

inline

Gets the service stats for the Blob service client.

Returns

The azure::storage::service_stats for the Blob service client.

download_service_stats() [2/2]

service_stats azure::storage::cloud_blob_client::download_service_stats ( const blob_request_options &  options, operation_context  context  ) const

inline

Gets the service stats for the Blob service client.

Parameters

options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

The azure::storage::service_stats for the Blob service client.

download_service_stats_async() [1/3]

pplx::task<service_stats> azure::storage::cloud_blob_client::download_service_stats_async ( ) const

inline

Initiates an asynchronous operation to get the stats of the service.

Returns

A pplx::task object of type azure::storage::service_stats that represents the current operation.

download_service_stats_async() [2/3]

pplx::task<service_stats> azure::storage::cloud_blob_client::download_service_stats_async ( const blob_request_options &  options, operation_context  context  ) const

inline

Initiates an asynchronous operation to get the stats of the service.

Parameters

options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object of type azure::storage::service_stats that represents the current operation.

download_service_stats_async() [3/3]

WASTORAGE_API pplx::task<service_stats> azure::storage::cloud_blob_client::download_service_stats_async	(	const blob_request_options &	options,
		operation_context	context,
		const pplx::cancellation_token &	cancellation_token
	)		const

Initiates an asynchronous operation to get the stats of the service.

Parameters

options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

A pplx::task object of type azure::storage::service_stats that represents the current operation.

get_container_reference()

WASTORAGE_API cloud_blob_container azure::storage::cloud_blob_client::get_container_reference

(

utility::string_t

container_name

)

const

Returns a reference to an azure::storage::cloud_blob_container object with the specified name.

Parameters

container_name

The name of the container, or an absolute URI to the container.

Returns

A reference to an azure::storage::cloud_blob_container.

get_root_container_reference()

WASTORAGE_API cloud_blob_container azure::storage::cloud_blob_client::get_root_container_reference

(

)

const

Returns a reference to an azure::storage::cloud_blob_container object.

Returns

A reference to the root container, of type azure::storage::cloud_blob_container.

get_user_delegation_key()

user_delegation_key azure::storage::cloud_blob_client::get_user_delegation_key ( const utility::datetime &  start, const utility::datetime &  expiry  )

inline

Gets a key that can be used to sign a user delegation SAS (shared access signature).

Parameters

start	The start time for the user delegation key.
expiry	The expiry time for the user delegation key.

Returns

A string containing user delegation key.

get_user_delegation_key_async() [1/2]

pplx::task<user_delegation_key> azure::storage::cloud_blob_client::get_user_delegation_key_async ( const utility::datetime &  start, const utility::datetime &  expiry  )

inline

Initiates an asynchronous operation to get a key that can be used to sign a user delegation SAS (shared access signature).

Parameters

start	The start time for the user delegation key.
expiry	The expiry time for the user delegation key.

Returns

A pplx::task object of string that contains user delegation key.

get_user_delegation_key_async() [2/2]

WASTORAGE_API pplx::task<user_delegation_key> azure::storage::cloud_blob_client::get_user_delegation_key_async	(	const utility::datetime &	start,
		const utility::datetime &	expiry,
		const request_options &	modified_options,
		operation_context	context,
		const pplx::cancellation_token &	cancellation_token
	)

Initiates an asynchronous operation to get a key that can be used to sign a user delegation SAS (shared access signature).

Parameters

start	The start time for the user delegation key.
expiry	The expiry time for the user delegation key.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

A pplx::task object of string that contains user delegation key.

list_blobs() [1/2]

list_blob_item_iterator azure::storage::cloud_blob_client::list_blobs ( const utility::string_t &  prefix ) const

inline

Returns an azure::storage::list_blob_item_iterator that can be used to to lazily enumerate a collection of blob items.

Parameters

prefix

The blob name prefix.

Returns

An azure::storage::list_blob_item_iterator that can be used to to lazily enumerate a collection of blob items.

list_blobs() [2/2]

WASTORAGE_API list_blob_item_iterator azure::storage::cloud_blob_client::list_blobs	(	const utility::string_t &	prefix,
		bool	use_flat_blob_listing,
		blob_listing_details::values	includes,
		int	max_results,
		const blob_request_options &	options,
		operation_context	context
	)		const

Returns an azure::storage::list_blob_item_iterator that can be used to to lazily enumerate a collection of blob items.

Parameters

prefix	The blob name prefix.
use_flat_blob_listing	Indicates whether to list blobs in a flat listing, or whether to list blobs hierarchically, by virtual directory.
includes	An azure::storage::blob_listing_details::values enumeration describing which items to include in the listing.
max_results	A non-negative integer value that indicates the maximum number of results to be returned. If this value is zero, the maximum possible number of results will be returned.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

An azure::storage::list_blob_item_iterator that can be used to to lazily enumerate a collection of blob items.

list_blobs_segmented() [1/2]

list_blob_item_segment azure::storage::cloud_blob_client::list_blobs_segmented ( const utility::string_t &  prefix, const continuation_token &  token  ) const

inline

Returns an azure::storage::list_blob_item_segment containing a collection of blob items in the container.

Parameters

prefix	The blob name prefix.
token	An azure::storage::continuation_token returned by a previous listing operation.

Returns

An azure::storage::list_blob_item_segment containing a collection of blob items in the container.

list_blobs_segmented() [2/2]

list_blob_item_segment azure::storage::cloud_blob_client::list_blobs_segmented ( const utility::string_t &  prefix, bool  use_flat_blob_listing, blob_listing_details::values  includes, int  max_results, const continuation_token &  token, const blob_request_options &  options, operation_context  context  ) const

inline

Returns an azure::storage::list_blob_item_segment containing a collection of blob items in the container.

Parameters

prefix	The blob name prefix.
use_flat_blob_listing	Indicates whether to list blobs in a flat listing, or whether to list blobs hierarchically, by virtual directory.
includes	An azure::storage::blob_listing_details::values enumeration describing which items to include in the listing.
max_results	A non-negative integer value that indicates the maximum number of results to be returned at a time, up to the per-operation limit of 5000. If this value is 0, the maximum possible number of results will be returned, up to 5000.
token	An azure::storage::continuation_token returned by a previous listing operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

An azure::storage::list_blob_item_segment containing a collection of blob items in the container.

list_blobs_segmented_async() [1/3]

pplx::task<list_blob_item_segment> azure::storage::cloud_blob_client::list_blobs_segmented_async ( const utility::string_t &  prefix, const continuation_token &  token  ) const

inline

Initiates an asynchronous operation to return an azure::storage::list_blob_item_segment containing a collection of blob items in the container.

Parameters

prefix	The blob name prefix.
token	An azure::storage::continuation_token returned by a previous listing operation.

Returns

A pplx::task object of type azure::storage::list_blob_item_segment that represents the current operation.

list_blobs_segmented_async() [2/3]

pplx::task<list_blob_item_segment> azure::storage::cloud_blob_client::list_blobs_segmented_async ( const utility::string_t &  prefix, bool  use_flat_blob_listing, blob_listing_details::values  includes, int  max_results, const continuation_token &  token, const blob_request_options &  options, operation_context  context  ) const

inline

Initiates an asynchronous operation to return an azure::storage::list_blob_item_segment containing a collection of blob items in the container.

Parameters

prefix	The blob name prefix.
use_flat_blob_listing	Indicates whether to list blobs in a flat listing, or whether to list blobs hierarchically, by virtual directory.
includes	An azure::storage::blob_listing_details::values enumeration describing which items to include in the listing.
max_results	A non-negative integer value that indicates the maximum number of results to be returned at a time, up to the per-operation limit of 5000. If this value is 0, the maximum possible number of results will be returned, up to 5000.
token	An azure::storage::continuation_token returned by a previous listing operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object of type azure::storage::list_blob_item_segment that represents the current operation.

list_blobs_segmented_async() [3/3]

WASTORAGE_API pplx::task<list_blob_item_segment> azure::storage::cloud_blob_client::list_blobs_segmented_async	(	const utility::string_t &	prefix,
		bool	use_flat_blob_listing,
		blob_listing_details::values	includes,
		int	max_results,
		const continuation_token &	token,
		const blob_request_options &	options,
		operation_context	context,
		const pplx::cancellation_token &	cancellation_token
	)		const

Initiates an asynchronous operation to return an azure::storage::list_blob_item_segment containing a collection of blob items in the container.

Parameters

prefix	The blob name prefix.
use_flat_blob_listing	Indicates whether to list blobs in a flat listing, or whether to list blobs hierarchically, by virtual directory.
includes	An azure::storage::blob_listing_details::values enumeration describing which items to include in the listing.
max_results	A non-negative integer value that indicates the maximum number of results to be returned at a time, up to the per-operation limit of 5000. If this value is 0, the maximum possible number of results will be returned, up to 5000.
token	An azure::storage::continuation_token returned by a previous listing operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

A pplx::task object of type azure::storage::list_blob_item_segment that represents the current operation.

list_containers() [1/3]

container_result_iterator azure::storage::cloud_blob_client::list_containers ( ) const

inline

Returns an azure::storage::container_result_iterator that can be used to to lazily enumerate a collection of containers.

Returns

An azure::storage::container_result_iterator that can be used to to lazily enumerate a collection of containers.

list_containers() [2/3]

container_result_iterator azure::storage::cloud_blob_client::list_containers ( const utility::string_t &  prefix ) const

inline

Returns an azure::storage::container_result_iterator that can be used to to lazily enumerate a collection of containers.

Parameters

prefix

The container name prefix.

Returns

An azure::storage::container_result_iterator that can be used to to lazily enumerate a collection of containers.

list_containers() [3/3]

WASTORAGE_API container_result_iterator azure::storage::cloud_blob_client::list_containers	(	const utility::string_t &	prefix,
		container_listing_details::values	includes,
		int	max_results,
		const blob_request_options &	options,
		operation_context	context
	)		const

Returns an azure::storage::container_result_iterator that can be used to to lazily enumerate a collection of containers.

Parameters

prefix	The container name prefix.
includes	An azure::storage::container_listing_details::values enumeration describing which items to include in the listing.
max_results	A non-negative integer value that indicates the maximum number of results to be returned. If this value is zero, the maximum possible number of results will be returned.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

An azure::storage::container_result_iterator that can be used to to lazily enumerate a collection of containers.

list_containers_segmented() [1/3]

container_result_segment azure::storage::cloud_blob_client::list_containers_segmented ( const continuation_token &  token ) const

inline

Returns a result segment containing a collection of azure::storage::cloud_blob_container objects.

Parameters

token

An azure::storage::continuation_token returned by a previous listing operation.

Returns

An azure::storage::container_result_segment containing a collection of containers.

list_containers_segmented() [2/3]

container_result_segment azure::storage::cloud_blob_client::list_containers_segmented ( const utility::string_t &  prefix, const continuation_token &  token  ) const

inline

Returns a result segment containing a collection of azure::storage::cloud_blob_container objects.

Parameters

prefix	The container name prefix.
token	An azure::storage::continuation_token returned by a previous listing operation.

Returns

An azure::storage::container_result_segment containing a collection of containers.

list_containers_segmented() [3/3]

container_result_segment azure::storage::cloud_blob_client::list_containers_segmented ( const utility::string_t &  prefix, container_listing_details::values  includes, int  max_results, const continuation_token &  token, const blob_request_options &  options, operation_context  context  ) const

inline

Returns a result segment containing a collection of azure::storage::cloud_blob_container objects.

Parameters

prefix	The container name prefix.
includes	An azure::storage::container_listing_details::values enumeration describing which items to include in the listing.
max_results	A non-negative integer value that indicates the maximum number of results to be returned in the result segment, up to the per-operation limit of 5000. If this value is 0, the maximum possible number of results will be returned, up to 5000.
token	An azure::storage::continuation_token returned by a previous listing operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

An azure::storage::container_result_segment containing a collection of containers.

list_containers_segmented_async() [1/4]

pplx::task<container_result_segment> azure::storage::cloud_blob_client::list_containers_segmented_async ( const continuation_token &  token ) const

inline

Initiates an asynchronous operation to return a result segment containing a collection of azure::storage::cloud_blob_container objects.

Parameters

token

An azure::storage::continuation_token returned by a previous listing operation.

Returns

A pplx::task object of type azure::storage::container_result_segment that represents the current operation.

list_containers_segmented_async() [2/4]

pplx::task<container_result_segment> azure::storage::cloud_blob_client::list_containers_segmented_async ( const utility::string_t &  prefix, const continuation_token &  token  ) const

inline

Initiates an asynchronous operation to return a result segment containing a collection of azure::storage::cloud_blob_container objects.

Parameters

prefix	The container name prefix.
token	An azure::storage::continuation_token returned by a previous listing operation.

Returns

A pplx::task object of type azure::storage::container_result_segment that represents the current operation.

list_containers_segmented_async() [3/4]

pplx::task<container_result_segment> azure::storage::cloud_blob_client::list_containers_segmented_async ( const utility::string_t &  prefix, container_listing_details::values  includes, int  max_results, const continuation_token &  token, const blob_request_options &  options, operation_context  context  ) const

inline

Initiates an asynchronous operation to return a result segment containing a collection of azure::storage::cloud_blob_container objects.

Parameters

prefix	The container name prefix.
includes	An azure::storage::container_listing_details::values enumeration describing which items to include in the listing.
max_results	A non-negative integer value that indicates the maximum number of results to be returned in the result segment, up to the per-operation limit of 5000. If this value is 0, the maximum possible number of results will be returned, up to 5000.
token	An azure::storage::continuation_token returned by a previous listing operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object of type azure::storage::container_result_segment that represents the current operation.

list_containers_segmented_async() [4/4]

WASTORAGE_API pplx::task<container_result_segment> azure::storage::cloud_blob_client::list_containers_segmented_async	(	const utility::string_t &	prefix,
		container_listing_details::values	includes,
		int	max_results,
		const continuation_token &	token,
		const blob_request_options &	options,
		operation_context	context,
		const pplx::cancellation_token &	cancellation_token
	)		const

Initiates an asynchronous operation to return a result segment containing a collection of azure::storage::cloud_blob_container objects.

Parameters

prefix	The container name prefix.
includes	An azure::storage::container_listing_details::values enumeration describing which items to include in the listing.
max_results	A non-negative integer value that indicates the maximum number of results to be returned in the result segment, up to the per-operation limit of 5000. If this value is 0, the maximum possible number of results will be returned, up to 5000.
token	An azure::storage::continuation_token returned by a previous listing operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

A pplx::task object of type azure::storage::container_result_segment that represents the current operation.

set_authentication_scheme()

WASTORAGE_API void azure::storage::cloud_blob_client::set_authentication_scheme ( azure::storage::authentication_scheme  value )

overridevirtual

Sets the authentication scheme to use to sign HTTP requests.

Parameters

value

The authentication scheme.

Reimplemented from azure::storage::cloud_client.

set_directory_delimiter()

void azure::storage::cloud_blob_client::set_directory_delimiter ( utility::string_t  value )

inline

Sets the default delimiter that may be used to create a virtual directory structure of blobs.

Parameters

value

A string containing the default delimiter.

upload_service_properties() [1/2]

void azure::storage::cloud_blob_client::upload_service_properties ( const service_properties &  properties, const service_properties_includes &  includes  ) const

inline

Sets the service properties for the Blob service client.

Parameters

properties	The azure::storage::service_properties for the Blob service client.
includes	An azure::storage::service_properties_includes enumeration describing which items to include when setting service properties.

upload_service_properties() [2/2]

void azure::storage::cloud_blob_client::upload_service_properties ( const service_properties &  properties, const service_properties_includes &  includes, const blob_request_options &  options, operation_context  context  ) const

inline

Sets the service properties for the Blob service client.

Parameters

properties	The azure::storage::service_properties for the Blob service client.
includes	An azure::storage::service_properties_includes enumeration describing which items to include when setting service properties.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

upload_service_properties_async() [1/3]

pplx::task<void> azure::storage::cloud_blob_client::upload_service_properties_async ( const service_properties &  properties, const service_properties_includes &  includes  ) const

inline

Initiates an asynchronous operation to set the service properties for the Blob service client.

Parameters

properties	The azure::storage::service_properties for the Blob service client.
includes	An azure::storage::service_properties_includes enumeration describing which items to include when setting service properties.

Returns

A pplx::task object that represents the current operation.

upload_service_properties_async() [2/3]

pplx::task<void> azure::storage::cloud_blob_client::upload_service_properties_async ( const service_properties &  properties, const service_properties_includes &  includes, const blob_request_options &  options, operation_context  context  ) const

inline

Initiates an asynchronous operation to set the service properties for the Blob service client.

Parameters

properties	The azure::storage::service_properties for the Blob service client.
includes	An azure::storage::service_properties_includes enumeration describing which items to include when setting service properties.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object that represents the current operation.

upload_service_properties_async() [3/3]

WASTORAGE_API pplx::task<void> azure::storage::cloud_blob_client::upload_service_properties_async	(	const service_properties &	properties,
		const service_properties_includes &	includes,
		const blob_request_options &	options,
		operation_context	context,
		const pplx::cancellation_token &	cancellation_token
	)		const

Initiates an asynchronous operation to set the service properties for the Blob service client.

Parameters

properties	The azure::storage::service_properties for the Blob service client.
includes	An azure::storage::service_properties_includes enumeration describing which items to include when setting service properties.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

A pplx::task object that represents the current operation.