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 | List of all members
azure::storage::cloud_blob_container Class Reference

Represents a container in the Windows Azure Blob service. More...

Public Member Functions

 cloud_blob_container ()
 Initializes a new instance of the azure::storage::cloud_blob_container class. More...
 
WASTORAGE_API cloud_blob_container (storage_uri uri)
 Initializes a new instance of the azure::storage::cloud_blob_container class. More...
 
WASTORAGE_API cloud_blob_container (storage_uri uri, storage_credentials credentials)
 Initializes a new instance of the azure::storage::cloud_blob_container class. More...
 
WASTORAGE_API cloud_blob_container (utility::string_t name, cloud_blob_client client)
 Initializes a new instance of the azure::storage::cloud_blob_container class. More...
 
WASTORAGE_API cloud_blob_container (utility::string_t name, cloud_blob_client client, cloud_blob_container_properties properties, cloud_metadata metadata)
 Initializes a new instance of the azure::storage::cloud_blob_container class. More...
 
utility::string_t get_shared_access_signature (const blob_shared_access_policy &policy) const
 Returns a shared access signature for the container. More...
 
WASTORAGE_API utility::string_t get_shared_access_signature (const blob_shared_access_policy &policy, const utility::string_t &stored_policy_identifier) const
 Returns a shared access signature for the container. More...
 
WASTORAGE_API utility::string_t get_user_delegation_sas (const user_delegation_key &key, const blob_shared_access_policy &policy) const
 Returns a user delegation SAS for the container. More...
 
WASTORAGE_API cloud_blob get_blob_reference (utility::string_t blob_name) const
 Gets a reference to a blob in this container. More...
 
WASTORAGE_API cloud_blob get_blob_reference (utility::string_t blob_name, utility::string_t snapshot_time) const
 Gets a reference to a blob in this container. More...
 
WASTORAGE_API cloud_page_blob get_page_blob_reference (utility::string_t blob_name) const
 Gets a reference to a page blob in this container. More...
 
WASTORAGE_API cloud_page_blob get_page_blob_reference (utility::string_t blob_name, utility::string_t snapshot_time) const
 Gets a reference to a page blob in this container. More...
 
WASTORAGE_API cloud_block_blob get_block_blob_reference (utility::string_t blob_name) const
 Gets a reference to a block blob in this container. More...
 
WASTORAGE_API cloud_block_blob get_block_blob_reference (utility::string_t blob_name, utility::string_t snapshot_time) const
 Gets a reference to a block blob in this container. More...
 
WASTORAGE_API cloud_append_blob get_append_blob_reference (utility::string_t blob_name) const
 Gets a reference to an append blob in this container. More...
 
WASTORAGE_API cloud_append_blob get_append_blob_reference (utility::string_t blob_name, utility::string_t snapshot_time) const
 Gets a reference to an append blob in this container. More...
 
WASTORAGE_API cloud_blob_directory get_directory_reference (utility::string_t directory_name) const
 Gets a reference to a virtual blob directory beneath this container. More...
 
void download_attributes ()
 Retrieves the container's attributes. More...
 
void download_attributes (const access_condition &condition, const blob_request_options &options, operation_context context)
 Retrieves the container's attributes. More...
 
pplx::task< void > download_attributes_async ()
 Initiates an asynchronous operation to retrieve the container's attributes. More...
 
pplx::task< void > download_attributes_async (const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to retrieve the container's attributes. More...
 
WASTORAGE_API pplx::task< void > download_attributes_async (const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to retrieve the container's attributes. More...
 
void upload_metadata ()
 Sets the container's user-defined metadata. More...
 
void upload_metadata (const access_condition &condition, const blob_request_options &options, operation_context context)
 Sets the container's user-defined metadata. More...
 
pplx::task< void > upload_metadata_async ()
 Initiates an asynchronous operation to set the container's user-defined metadata. More...
 
WASTORAGE_API pplx::task< void > upload_metadata_async (const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to set the container's user-defined metadata. More...
 
WASTORAGE_API pplx::task< void > upload_metadata_async (const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to set the container's user-defined metadata. More...
 
account_properties download_account_properties () const
 Gets properties for the account this container resides on. More...
 
account_properties download_account_properties (const blob_request_options &options, operation_context context) const
 Gets properties for the account this container resides on. More...
 
pplx::task< account_propertiesdownload_account_properties_async () const
 Initiates an asynchronous operation to get properties for the account this container resides on. More...
 
pplx::task< account_propertiesdownload_account_properties_async (const blob_request_options &options, operation_context context) const
 Initiates an asynchronous operation to get properties for the account this container resides on. More...
 
WASTORAGE_API pplx::task< account_propertiesdownload_account_properties_async (const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token) const
 Initiates an asynchronous operation to get properties for the account this container resides on. More...
 
utility::string_t acquire_lease (const azure::storage::lease_time &duration, const utility::string_t &proposed_lease_id) const
 Acquires a lease on the container. More...
 
utility::string_t acquire_lease (const azure::storage::lease_time &duration, const utility::string_t &proposed_lease_id, const access_condition &condition, const blob_request_options &options, operation_context context) const
 Acquires a lease on the container. More...
 
pplx::task< utility::string_t > acquire_lease_async (const azure::storage::lease_time &duration, const utility::string_t &proposed_lease_id) const
 Initiates an asynchronous operation to acquire a lease on the container. More...
 
pplx::task< utility::string_t > acquire_lease_async (const azure::storage::lease_time &duration, const utility::string_t &proposed_lease_id, const access_condition &condition, const blob_request_options &options, operation_context context) const
 Initiates an asynchronous operation to acquire a lease on the container. More...
 
WASTORAGE_API pplx::task< utility::string_t > acquire_lease_async (const azure::storage::lease_time &duration, const utility::string_t &proposed_lease_id, const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token) const
 Initiates an asynchronous operation to acquire a lease on the container. More...
 
void renew_lease () const
 Renews a lease on the container. More...
 
void renew_lease (const access_condition &condition, const blob_request_options &options, operation_context context) const
 Renews a lease on the container. More...
 
pplx::task< void > renew_lease_async () const
 Initiates an asynchronous operation to renew a lease on the container. More...
 
pplx::task< void > renew_lease_async (const access_condition &condition, const blob_request_options &options, operation_context context) const
 Initiates an asynchronous operation to renew a lease on the container. More...
 
WASTORAGE_API pplx::task< void > renew_lease_async (const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token) const
 Initiates an asynchronous operation to renew a lease on the container. More...
 
utility::string_t change_lease (const utility::string_t &proposed_lease_id) const
 Changes the lease ID for a lease on the container. More...
 
utility::string_t change_lease (const utility::string_t &proposed_lease_id, const access_condition &condition, const blob_request_options &options, operation_context context) const
 Changes the lease ID for a lease on the container. More...
 
pplx::task< utility::string_t > change_lease_async (const utility::string_t &proposed_lease_id) const
 Initiates an asynchronous operation to change the lease ID for a lease on the container. More...
 
pplx::task< utility::string_t > change_lease_async (const utility::string_t &proposed_lease_id, const access_condition &condition, const blob_request_options &options, operation_context context) const
 Initiates an asynchronous operation to change the lease ID for a lease on the container. More...
 
WASTORAGE_API pplx::task< utility::string_t > change_lease_async (const utility::string_t &proposed_lease_id, const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token) const
 Initiates an asynchronous operation to change the lease ID for a lease on the container. More...
 
void release_lease () const
 Releases a lease on the container. More...
 
void release_lease (const access_condition &condition, const blob_request_options &options, operation_context context) const
 Releases a lease on the container. More...
 
pplx::task< void > release_lease_async () const
 Initiates an asynchronous operation to release a lease on the container. More...
 
pplx::task< void > release_lease_async (const access_condition &condition, const blob_request_options &options, operation_context context) const
 Initiates an asynchronous operation to release a lease on the container. More...
 
WASTORAGE_API pplx::task< void > release_lease_async (const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token) const
 Initiates an asynchronous operation to release a lease on the container. More...
 
std::chrono::seconds break_lease (const azure::storage::lease_break_period &break_period) const
 Breaks the current lease on the container. More...
 
std::chrono::seconds break_lease (const azure::storage::lease_break_period &break_period, const access_condition &condition, const blob_request_options &options, operation_context context) const
 Breaks the current lease on the container. More...
 
pplx::task< std::chrono::seconds > break_lease_async (const azure::storage::lease_break_period &break_period) const
 Initiates an asynchronous operation to break the current lease on the container. More...
 
pplx::task< std::chrono::seconds > break_lease_async (const azure::storage::lease_break_period &break_period, const access_condition &condition, const blob_request_options &options, operation_context context) const
 Initiates an asynchronous operation to break the current lease on the container. More...
 
WASTORAGE_API pplx::task< std::chrono::seconds > break_lease_async (const azure::storage::lease_break_period &break_period, const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token) const
 Initiates an asynchronous operation to break the current lease on the container. More...
 
void create ()
 Creates the container. More...
 
void create (blob_container_public_access_type public_access, const blob_request_options &options, operation_context context)
 Creates the container and specifies the level of access to the container's data. More...
 
pplx::task< void > create_async ()
 Initiates an asynchronous operation to create the container. More...
 
pplx::task< void > create_async (blob_container_public_access_type public_access, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to create the container. More...
 
WASTORAGE_API pplx::task< void > create_async (blob_container_public_access_type public_access, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to create the container. More...
 
bool create_if_not_exists ()
 Creates the container if it does not already exist. More...
 
bool create_if_not_exists (blob_container_public_access_type public_access, const blob_request_options &options, operation_context context)
 Creates the container if it does not already exist and specifies the level of public access to the container's data. More...
 
pplx::task< bool > create_if_not_exists_async ()
 Initiates an asynchronous operation to create the container if it does not already exist. More...
 
pplx::task< bool > create_if_not_exists_async (blob_container_public_access_type public_access, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to create the container if it does not already exist and specify the level of public access to the container's data. More...
 
WASTORAGE_API pplx::task< bool > create_if_not_exists_async (blob_container_public_access_type public_access, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to create the container if it does not already exist and specify the level of public access to the container's data. More...
 
void delete_container ()
 Deletes the container. More...
 
void delete_container (const access_condition &condition, const blob_request_options &options, operation_context context)
 Deletes the container. More...
 
pplx::task< void > delete_container_async ()
 Initiates an asynchronous operation to delete the container. More...
 
pplx::task< void > delete_container_async (const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to delete the container. More...
 
WASTORAGE_API pplx::task< void > delete_container_async (const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to delete the container. More...
 
bool delete_container_if_exists ()
 Deletes the container if it already exists. More...
 
bool delete_container_if_exists (const access_condition &condition, const blob_request_options &options, operation_context context)
 Deletes the container if it already exists. More...
 
pplx::task< bool > delete_container_if_exists_async ()
 Initiates an asynchronous operation to delete the container if it already exists. More...
 
pplx::task< bool > delete_container_if_exists_async (const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to delete the container if it already exists. More...
 
WASTORAGE_API pplx::task< bool > delete_container_if_exists_async (const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to delete the container if it already exists. More...
 
list_blob_item_iterator list_blobs () const
 Returns an azure::storage::list_blob_item_iterator that can be used to to lazily enumerate a collection of blob items in the container. 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 in the the container. More...
 
list_blob_item_segment list_blobs_segmented (const continuation_token &token) const
 Returns a result segment containing a collection of blob items in the container. More...
 
list_blob_item_segment list_blobs_segmented (const utility::string_t &prefix, const continuation_token &token) const
 Returns a result 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 a result segment containing a collection of blob items in the container. More...
 
pplx::task< list_blob_item_segmentlist_blobs_segmented_async (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_segmentlist_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_segmentlist_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_segmentlist_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...
 
void upload_permissions (const blob_container_permissions &permissions)
 Sets permissions for the container. More...
 
void upload_permissions (const blob_container_permissions &permissions, const access_condition &condition, const blob_request_options &options, operation_context context)
 Sets permissions for the container. More...
 
pplx::task< void > upload_permissions_async (const blob_container_permissions &permissions)
 Initiates an asynchronous operation to set permissions for the container. More...
 
pplx::task< void > upload_permissions_async (const blob_container_permissions &permissions, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to set permissions for the container. More...
 
WASTORAGE_API pplx::task< void > upload_permissions_async (const blob_container_permissions &permissions, const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to set permissions for the container. More...
 
blob_container_permissions download_permissions ()
 Gets the permissions settings for the container. More...
 
blob_container_permissions download_permissions (const access_condition &condition, const blob_request_options &options, operation_context context)
 Gets the permissions settings for the container. More...
 
pplx::task< blob_container_permissionsdownload_permissions_async ()
 Initiates an asynchronous operation to get permissions settings for the container. More...
 
pplx::task< blob_container_permissionsdownload_permissions_async (const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to get permissions settings for the container. More...
 
WASTORAGE_API pplx::task< blob_container_permissionsdownload_permissions_async (const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to get permissions settings for the container. More...
 
bool exists ()
 Checks existence of the container. More...
 
bool exists (const blob_request_options &options, operation_context context)
 Checks existence of the container. More...
 
pplx::task< bool > exists_async ()
 Initiates an asynchronous operation to check the existence of the container. More...
 
pplx::task< bool > exists_async (const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to check the existence of the container. More...
 
pplx::task< bool > exists_async (const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to check the existence of the container. More...
 
const cloud_blob_clientservice_client () const
 Gets the Blob service client for the container. More...
 
const utility::string_t & name () const
 Gets the name of the container. More...
 
const storage_uriuri () const
 Gets the container URI for all locations. More...
 
cloud_metadata & metadata ()
 Gets the container's metadata. More...
 
const cloud_metadata & metadata () const
 Gets the container's metadata. More...
 
const cloud_blob_container_propertiesproperties () const
 Gets the container's system properties. More...
 
bool is_valid () const
 Indicates whether the azure::storage::cloud_blob_container object is valid. More...
 

Detailed Description

Represents a container in the Windows Azure Blob service.

Constructor & Destructor Documentation

◆ cloud_blob_container() [1/5]

azure::storage::cloud_blob_container::cloud_blob_container ( )
inline

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

◆ cloud_blob_container() [2/5]

WASTORAGE_API azure::storage::cloud_blob_container::cloud_blob_container ( storage_uri  uri)

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

Parameters
uriAn azure::storage::storage_uri object containing the absolute URI to the container for all locations.

◆ cloud_blob_container() [3/5]

WASTORAGE_API azure::storage::cloud_blob_container::cloud_blob_container ( storage_uri  uri,
storage_credentials  credentials 
)

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

Parameters
uriAn azure::storage::storage_uri object containing the absolute URI to the container for all locations.
credentialsThe azure::storage::storage_credentials to use.

◆ cloud_blob_container() [4/5]

WASTORAGE_API azure::storage::cloud_blob_container::cloud_blob_container ( utility::string_t  name,
cloud_blob_client  client 
)

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

Parameters
nameThe name of the container.
clientThe Blob service client.

◆ cloud_blob_container() [5/5]

WASTORAGE_API azure::storage::cloud_blob_container::cloud_blob_container ( utility::string_t  name,
cloud_blob_client  client,
cloud_blob_container_properties  properties,
cloud_metadata  metadata 
)

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

Parameters
nameThe container name.
clientThe Blob service client.
propertiesThe properties for the container.
metadataThe metadata for the container.

Member Function Documentation

◆ acquire_lease() [1/2]

utility::string_t azure::storage::cloud_blob_container::acquire_lease ( const azure::storage::lease_time duration,
const utility::string_t &  proposed_lease_id 
) const
inline

Acquires a lease on the container.

Parameters
durationAn azure::storage::lease_time representing the span of time for which to acquire the lease.
proposed_lease_idA string representing the proposed lease ID for the new lease. May be an empty string if no lease ID is proposed.
Returns
A string containing the ID of the acquired lease.

◆ acquire_lease() [2/2]

utility::string_t azure::storage::cloud_blob_container::acquire_lease ( const azure::storage::lease_time duration,
const utility::string_t &  proposed_lease_id,
const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Acquires a lease on the container.

Parameters
durationAn azure::storage::lease_time representing the span of time for which to acquire the lease.
proposed_lease_idA string representing the proposed lease ID for the new lease. May be an empty string if no lease ID is proposed.
conditionAn azure::storage::access_condition object that represents the access condition for the operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
Returns
A string containing the ID of the acquired lease.

◆ acquire_lease_async() [1/3]

pplx::task<utility::string_t> azure::storage::cloud_blob_container::acquire_lease_async ( const azure::storage::lease_time duration,
const utility::string_t &  proposed_lease_id 
) const
inline

Initiates an asynchronous operation to acquire a lease on the container.

Parameters
durationAn azure::storage::lease_time object representing the span of time for which to acquire the lease.
proposed_lease_idA string representing the proposed lease ID for the new lease. May be an empty string if no lease ID is proposed..
Returns
A pplx::task object of type utility::string_t that represents the current operation.

◆ acquire_lease_async() [2/3]

pplx::task<utility::string_t> azure::storage::cloud_blob_container::acquire_lease_async ( const azure::storage::lease_time duration,
const utility::string_t &  proposed_lease_id,
const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Initiates an asynchronous operation to acquire a lease on the container.

Parameters
durationAn azure::storage::lease_time representing the span of time for which to acquire the lease.
proposed_lease_idA string representing the proposed lease ID for the new lease. May be an empty string if no lease ID is proposed.
conditionAn azure::storage::access_condition object that represents the access condition for the operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
Returns
A pplx::task object of type utility::string_t that represents the current operation.

◆ acquire_lease_async() [3/3]

WASTORAGE_API pplx::task<utility::string_t> azure::storage::cloud_blob_container::acquire_lease_async ( const azure::storage::lease_time duration,
const utility::string_t &  proposed_lease_id,
const access_condition condition,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
) const

Initiates an asynchronous operation to acquire a lease on the container.

Parameters
durationAn azure::storage::lease_time representing the span of time for which to acquire the lease.
proposed_lease_idA string representing the proposed lease ID for the new lease. May be an empty string if no lease ID is proposed.
conditionAn azure::storage::access_condition object that represents the access condition for the operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
cancellation_tokenAn pplx::cancellation_token object that is used to cancel the current operation.
Returns
A pplx::task object of type utility::string_t that represents the current operation.

◆ break_lease() [1/2]

std::chrono::seconds azure::storage::cloud_blob_container::break_lease ( const azure::storage::lease_break_period break_period) const
inline

Breaks the current lease on the container.

Parameters
break_periodAn azure::storage::lease_break_period representing the amount of time to allow the lease to remain.
Returns
The time until the lease ends, in seconds.

◆ break_lease() [2/2]

std::chrono::seconds azure::storage::cloud_blob_container::break_lease ( const azure::storage::lease_break_period break_period,
const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Breaks the current lease on the container.

Parameters
break_periodAn azure::storage::lease_break_period representing the amount of time to allow the lease to remain.
conditionAn azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
Returns
The time until the lease ends, in seconds.

◆ break_lease_async() [1/3]

pplx::task<std::chrono::seconds> azure::storage::cloud_blob_container::break_lease_async ( const azure::storage::lease_break_period break_period) const
inline

Initiates an asynchronous operation to break the current lease on the container.

Parameters
break_periodAn azure::storage::lease_break_period representing the amount of time to allow the lease to remain.
Returns
A pplx::task object of type std::chrono::seconds that represents the current operation.

◆ break_lease_async() [2/3]

pplx::task<std::chrono::seconds> azure::storage::cloud_blob_container::break_lease_async ( const azure::storage::lease_break_period break_period,
const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Initiates an asynchronous operation to break the current lease on the container.

Parameters
break_periodAn azure::storage::lease_break_period representing the amount of time to allow the lease to remain.
conditionAn azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
Returns
A pplx::task object of type std::chrono::seconds that represents the current operation.

◆ break_lease_async() [3/3]

WASTORAGE_API pplx::task<std::chrono::seconds> azure::storage::cloud_blob_container::break_lease_async ( const azure::storage::lease_break_period break_period,
const access_condition condition,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
) const

Initiates an asynchronous operation to break the current lease on the container.

Parameters
break_periodAn azure::storage::lease_break_period representing the amount of time to allow the lease to remain.
conditionAn azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
cancellation_tokenAn pplx::cancellation_token object that is used to cancel the current operation.
Returns
A pplx::task object of type std::chrono::seconds that represents the current operation.

◆ change_lease() [1/2]

utility::string_t azure::storage::cloud_blob_container::change_lease ( const utility::string_t &  proposed_lease_id) const
inline

Changes the lease ID for a lease on the container.

Parameters
proposed_lease_idA string containing the proposed lease ID for the lease. May not be empty.
Returns
The new lease ID.

◆ change_lease() [2/2]

utility::string_t azure::storage::cloud_blob_container::change_lease ( const utility::string_t &  proposed_lease_id,
const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Changes the lease ID for a lease on the container.

Parameters
proposed_lease_idA string containing the proposed lease ID for the lease. May not be empty.
conditionAn azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
Returns
The new lease ID.

◆ change_lease_async() [1/3]

pplx::task<utility::string_t> azure::storage::cloud_blob_container::change_lease_async ( const utility::string_t &  proposed_lease_id) const
inline

Initiates an asynchronous operation to change the lease ID for a lease on the container.

Parameters
proposed_lease_idA string containing the proposed lease ID for the lease. May not be empty.
Returns
A pplx::task object of type utility::string_t that represents the current operation.

◆ change_lease_async() [2/3]

pplx::task<utility::string_t> azure::storage::cloud_blob_container::change_lease_async ( const utility::string_t &  proposed_lease_id,
const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Initiates an asynchronous operation to change the lease ID for a lease on the container.

Parameters
proposed_lease_idA string containing the proposed lease ID for the lease. May not be empty.
conditionAn azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
Returns
A pplx::task object of type utility::string_t that represents the current operation.

◆ change_lease_async() [3/3]

WASTORAGE_API pplx::task<utility::string_t> azure::storage::cloud_blob_container::change_lease_async ( const utility::string_t &  proposed_lease_id,
const access_condition condition,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
) const

Initiates an asynchronous operation to change the lease ID for a lease on the container.

Parameters
proposed_lease_idA string containing the proposed lease ID for the lease. May not be empty.
conditionAn azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
cancellation_tokenAn pplx::cancellation_token object that is used to cancel the current operation.
Returns
A pplx::task object of type utility::string_t that represents the current operation.

◆ create() [1/2]

void azure::storage::cloud_blob_container::create ( )
inline

Creates the container.

◆ create() [2/2]

void azure::storage::cloud_blob_container::create ( blob_container_public_access_type  public_access,
const blob_request_options options,
operation_context  context 
)
inline

Creates the container and specifies the level of access to the container's data.

Parameters
public_accessAn azure::storage::blob_container_public_access_type value that specifies whether data in the container may be accessed publicly and what level of access is to be allowed.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

◆ create_async() [1/3]

pplx::task<void> azure::storage::cloud_blob_container::create_async ( )
inline

Initiates an asynchronous operation to create the container.

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

◆ create_async() [2/3]

pplx::task<void> azure::storage::cloud_blob_container::create_async ( blob_container_public_access_type  public_access,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to create the container.

Parameters
public_accessAn azure::storage::blob_container_public_access_type value that specifies whether data in the container may be accessed publicly and what level of access is to be allowed.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
Returns
A pplx::task object that represents the current operation.

◆ create_async() [3/3]

WASTORAGE_API pplx::task<void> azure::storage::cloud_blob_container::create_async ( blob_container_public_access_type  public_access,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
)

Initiates an asynchronous operation to create the container.

Parameters
public_accessAn azure::storage::blob_container_public_access_type value that specifies whether data in the container may be accessed publicly and what level of access is to be allowed.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
cancellation_tokenAn pplx::cancellation_token object that is used to cancel the current operation.
Returns
A pplx::task object that represents the current operation.

◆ create_if_not_exists() [1/2]

bool azure::storage::cloud_blob_container::create_if_not_exists ( )
inline

Creates the container if it does not already exist.

Returns
true if the container did not already exist and was created; otherwise false.

◆ create_if_not_exists() [2/2]

bool azure::storage::cloud_blob_container::create_if_not_exists ( blob_container_public_access_type  public_access,
const blob_request_options options,
operation_context  context 
)
inline

Creates the container if it does not already exist and specifies the level of public access to the container's data.

Parameters
public_accessAn azure::storage::blob_container_public_access_type value that specifies whether data in the container may be accessed publicly and what level of access is to be allowed.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
Returns
true if the container did not already exist and was created; otherwise false.

◆ create_if_not_exists_async() [1/3]

pplx::task<bool> azure::storage::cloud_blob_container::create_if_not_exists_async ( )
inline

Initiates an asynchronous operation to create the container if it does not already exist.

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

◆ create_if_not_exists_async() [2/3]

pplx::task<bool> azure::storage::cloud_blob_container::create_if_not_exists_async ( blob_container_public_access_type  public_access,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to create the container if it does not already exist and specify the level of public access to the container's data.

Parameters
public_accessAn azure::storage::blob_container_public_access_type value that specifies whether data in the container may be accessed publicly and what level of access is to be allowed.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
Returns
A pplx::task object that represents the current operation.

◆ create_if_not_exists_async() [3/3]

WASTORAGE_API pplx::task<bool> azure::storage::cloud_blob_container::create_if_not_exists_async ( blob_container_public_access_type  public_access,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
)

Initiates an asynchronous operation to create the container if it does not already exist and specify the level of public access to the container's data.

Parameters
public_accessAn azure::storage::blob_container_public_access_type value that specifies whether data in the container may be accessed publicly and what level of access is to be allowed.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
cancellation_tokenAn pplx::cancellation_token object that is used to cancel the current operation.
Returns
A pplx::task object that represents the current operation.

◆ delete_container() [1/2]

void azure::storage::cloud_blob_container::delete_container ( )
inline

Deletes the container.

◆ delete_container() [2/2]

void azure::storage::cloud_blob_container::delete_container ( const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Deletes the container.

Parameters
conditionAn azure::storage::access_condition object that represents the access condition for the operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.

◆ delete_container_async() [1/3]

pplx::task<void> azure::storage::cloud_blob_container::delete_container_async ( )
inline

Initiates an asynchronous operation to delete the container.

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

◆ delete_container_async() [2/3]

pplx::task<void> azure::storage::cloud_blob_container::delete_container_async ( const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to delete the container.

Parameters
conditionAn azure::storage::access_condition object that represents the access condition for the operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
Returns
A pplx::task object that represents the current operation.

◆ delete_container_async() [3/3]

WASTORAGE_API pplx::task<void> azure::storage::cloud_blob_container::delete_container_async ( const access_condition condition,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
)

Initiates an asynchronous operation to delete the container.

Parameters
conditionAn azure::storage::access_condition object that represents the access condition for the operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
cancellation_tokenAn pplx::cancellation_token object that is used to cancel the current operation.
Returns
A pplx::task object that represents the current operation.

◆ delete_container_if_exists() [1/2]

bool azure::storage::cloud_blob_container::delete_container_if_exists ( )
inline

Deletes the container if it already exists.

Returns
true if the container did not already exist and was created; otherwise false.

◆ delete_container_if_exists() [2/2]

bool azure::storage::cloud_blob_container::delete_container_if_exists ( const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Deletes the container if it already exists.

Parameters
conditionAn azure::storage::access_condition object that represents the access condition for the operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
Returns
true if the container did not already exist and was created; otherwise false.

◆ delete_container_if_exists_async() [1/3]

pplx::task<bool> azure::storage::cloud_blob_container::delete_container_if_exists_async ( )
inline

Initiates an asynchronous operation to delete the container if it already exists.

Returns

true if the container did not already exist and was created; otherwise false.

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

◆ delete_container_if_exists_async() [2/3]

pplx::task<bool> azure::storage::cloud_blob_container::delete_container_if_exists_async ( const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to delete the container if it already exists.

Parameters
conditionAn azure::storage::access_condition object that represents the access condition for the operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
Returns

true if the container did not already exist and was created; otherwise false.

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

◆ delete_container_if_exists_async() [3/3]

WASTORAGE_API pplx::task<bool> azure::storage::cloud_blob_container::delete_container_if_exists_async ( const access_condition condition,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
)

Initiates an asynchronous operation to delete the container if it already exists.

Parameters
conditionAn azure::storage::access_condition object that represents the access condition for the operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
Returns
true if the container did not already exist and was created; otherwise false.
Parameters
cancellation_tokenAn pplx::cancellation_token object that is used to cancel the current operation.
Returns
A pplx::task object that represents the current operation.

◆ download_account_properties() [1/2]

account_properties azure::storage::cloud_blob_container::download_account_properties ( ) const
inline

Gets properties for the account this container resides on.

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

◆ download_account_properties() [2/2]

account_properties azure::storage::cloud_blob_container::download_account_properties ( const blob_request_options options,
operation_context  context 
) const
inline

Gets properties for the account this container resides on.

Parameters
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn 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_container::download_account_properties_async ( ) const
inline

Initiates an asynchronous operation to get properties for the account this container resides on.

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_container::download_account_properties_async ( const blob_request_options options,
operation_context  context 
) const
inline

Initiates an asynchronous operation to get properties for the account this container resides on.

Parameters
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn 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_container::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 properties for the account this container resides on.

Parameters
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
cancellation_tokenAn 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_attributes() [1/2]

void azure::storage::cloud_blob_container::download_attributes ( )
inline

Retrieves the container's attributes.

◆ download_attributes() [2/2]

void azure::storage::cloud_blob_container::download_attributes ( const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Retrieves the container's attributes.

Parameters
conditionAn azure::storage::access_condition object that represents the access condition for the operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.

◆ download_attributes_async() [1/3]

pplx::task<void> azure::storage::cloud_blob_container::download_attributes_async ( )
inline

Initiates an asynchronous operation to retrieve the container's attributes.

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

◆ download_attributes_async() [2/3]

pplx::task<void> azure::storage::cloud_blob_container::download_attributes_async ( const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to retrieve the container's attributes.

Parameters
conditionAn azure::storage::access_condition object that represents the access condition for the operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
Returns
A pplx::task object that represents the current operation.

◆ download_attributes_async() [3/3]

WASTORAGE_API pplx::task<void> azure::storage::cloud_blob_container::download_attributes_async ( const access_condition condition,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
)

Initiates an asynchronous operation to retrieve the container's attributes.

Parameters
conditionAn azure::storage::access_condition object that represents the access condition for the operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
cancellation_tokenAn pplx::cancellation_token object that is used to cancel the current operation.
Returns
A pplx::task object that represents the current operation.

◆ download_permissions() [1/2]

blob_container_permissions azure::storage::cloud_blob_container::download_permissions ( )
inline

Gets the permissions settings for the container.

Returns
The container's permissions.

◆ download_permissions() [2/2]

blob_container_permissions azure::storage::cloud_blob_container::download_permissions ( const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Gets the permissions settings for the container.

Parameters
conditionAn azure::storage::access_condition object that represents the access condition for the operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
Returns
The container's permissions.

◆ download_permissions_async() [1/3]

pplx::task<blob_container_permissions> azure::storage::cloud_blob_container::download_permissions_async ( )
inline

Initiates an asynchronous operation to get permissions settings for the container.

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

◆ download_permissions_async() [2/3]

pplx::task<blob_container_permissions> azure::storage::cloud_blob_container::download_permissions_async ( const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to get permissions settings for the container.

Parameters
conditionAn azure::storage::access_condition object that represents the access condition for the operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
Returns
A pplx::task object of type azure::storage::blob_container_permissions that represents the current operation.

◆ download_permissions_async() [3/3]

WASTORAGE_API pplx::task<blob_container_permissions> azure::storage::cloud_blob_container::download_permissions_async ( const access_condition condition,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
)

Initiates an asynchronous operation to get permissions settings for the container.

Parameters
conditionAn azure::storage::access_condition object that represents the access condition for the operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
cancellation_tokenAn pplx::cancellation_token object that is used to cancel the current operation.
Returns
A pplx::task object of type azure::storage::blob_container_permissions that represents the current operation.

◆ exists() [1/2]

bool azure::storage::cloud_blob_container::exists ( )
inline

Checks existence of the container.

Returns
true if the container exists.

◆ exists() [2/2]

bool azure::storage::cloud_blob_container::exists ( const blob_request_options options,
operation_context  context 
)
inline

Checks existence of the container.

Parameters
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
Returns
true if the container exists.

◆ exists_async() [1/3]

pplx::task<bool> azure::storage::cloud_blob_container::exists_async ( )
inline

Initiates an asynchronous operation to check the existence of the container.

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

◆ exists_async() [2/3]

pplx::task<bool> azure::storage::cloud_blob_container::exists_async ( const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to check the existence of the container.

Parameters
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
Returns
A pplx::task object that that represents the current operation.

◆ exists_async() [3/3]

pplx::task<bool> azure::storage::cloud_blob_container::exists_async ( const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
)
inline

Initiates an asynchronous operation to check the existence of the container.

Parameters
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
cancellation_tokenAn pplx::cancellation_token object that is used to cancel the current operation.
Returns
A pplx::task object that that represents the current operation.

◆ get_append_blob_reference() [1/2]

WASTORAGE_API cloud_append_blob azure::storage::cloud_blob_container::get_append_blob_reference ( utility::string_t  blob_name) const

Gets a reference to an append blob in this container.

Parameters
blob_nameThe name of the blob.
Returns
A reference to a cloud_append_blob.

◆ get_append_blob_reference() [2/2]

WASTORAGE_API cloud_append_blob azure::storage::cloud_blob_container::get_append_blob_reference ( utility::string_t  blob_name,
utility::string_t  snapshot_time 
) const

Gets a reference to an append blob in this container.

Parameters
blob_nameThe name of the blob.
snapshot_timeThe snapshot timestamp, if the blob is a snapshot.
Returns
A reference to a cloud_append_blob.

◆ get_blob_reference() [1/2]

WASTORAGE_API cloud_blob azure::storage::cloud_blob_container::get_blob_reference ( utility::string_t  blob_name) const

Gets a reference to a blob in this container.

Parameters
blob_nameThe name of the blob.
Returns
A reference to an azure::storage::cloud_blob.

◆ get_blob_reference() [2/2]

WASTORAGE_API cloud_blob azure::storage::cloud_blob_container::get_blob_reference ( utility::string_t  blob_name,
utility::string_t  snapshot_time 
) const

Gets a reference to a blob in this container.

Parameters
blob_nameThe name of the blob.
snapshot_timeThe snapshot timestamp, if the blob is a snapshot.
Returns
A reference to an azure::storage::cloud_blob.

◆ get_block_blob_reference() [1/2]

WASTORAGE_API cloud_block_blob azure::storage::cloud_blob_container::get_block_blob_reference ( utility::string_t  blob_name) const

Gets a reference to a block blob in this container.

Parameters
blob_nameThe name of the blob.
Returns
A reference to an azure::storage::cloud_block_blob.

◆ get_block_blob_reference() [2/2]

WASTORAGE_API cloud_block_blob azure::storage::cloud_blob_container::get_block_blob_reference ( utility::string_t  blob_name,
utility::string_t  snapshot_time 
) const

Gets a reference to a block blob in this container.

Parameters
blob_nameThe name of the blob.
snapshot_timeThe snapshot timestamp, if the blob is a snapshot.
Returns
A reference to an azure::storage::cloud_block_blob.

◆ get_directory_reference()

WASTORAGE_API cloud_blob_directory azure::storage::cloud_blob_container::get_directory_reference ( utility::string_t  directory_name) const

Gets a reference to a virtual blob directory beneath this container.

Parameters
directory_nameThe name of the virtual blob directory.
Returns
A reference to an azure::storage::cloud_blob_directory.

◆ get_page_blob_reference() [1/2]

WASTORAGE_API cloud_page_blob azure::storage::cloud_blob_container::get_page_blob_reference ( utility::string_t  blob_name) const

Gets a reference to a page blob in this container.

Parameters
blob_nameThe name of the blob.
Returns
A reference to an azure::storage::cloud_page_blob.

◆ get_page_blob_reference() [2/2]

WASTORAGE_API cloud_page_blob azure::storage::cloud_blob_container::get_page_blob_reference ( utility::string_t  blob_name,
utility::string_t  snapshot_time 
) const

Gets a reference to a page blob in this container.

Parameters
blob_nameThe name of the blob.
snapshot_timeThe snapshot timestamp, if the blob is a snapshot.
Returns
A reference to an azure::storage::cloud_page_blob.

◆ get_shared_access_signature() [1/2]

utility::string_t azure::storage::cloud_blob_container::get_shared_access_signature ( const blob_shared_access_policy policy) const
inline

Returns a shared access signature for the container.

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

◆ get_shared_access_signature() [2/2]

WASTORAGE_API utility::string_t azure::storage::cloud_blob_container::get_shared_access_signature ( const blob_shared_access_policy policy,
const utility::string_t &  stored_policy_identifier 
) const

Returns a shared access signature for the container.

Parameters
policyThe access policy for the shared access signature.
stored_policy_identifierA container-level access policy.
Returns
A string containing a shared access signature.

◆ get_user_delegation_sas()

WASTORAGE_API utility::string_t azure::storage::cloud_blob_container::get_user_delegation_sas ( const user_delegation_key key,
const blob_shared_access_policy policy 
) const

Returns a user delegation SAS for the container.

Parameters
keyUser delegation key used to sign this SAS.
policyThe access policy for the shared access signature.
Returns
A string containing a shared access signature.

◆ is_valid()

bool azure::storage::cloud_blob_container::is_valid ( ) const
inline

Indicates whether the azure::storage::cloud_blob_container object is valid.

Returns
true if the azure::storage::cloud_blob_container object is valid; otherwise, false.

◆ list_blobs() [1/2]

list_blob_item_iterator azure::storage::cloud_blob_container::list_blobs ( ) const
inline

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

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

◆ list_blobs() [2/2]

WASTORAGE_API list_blob_item_iterator azure::storage::cloud_blob_container::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 in the the container.

Parameters
prefixThe blob name prefix.
use_flat_blob_listingIndicates whether to list blobs in a flat listing, or whether to list blobs hierarchically, by virtual directory.
includesAn azure::storage::blob_listing_details::values enumeration describing which items to include in the listing.
max_resultsA 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.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn 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 in the the container.

◆ list_blobs_segmented() [1/3]

list_blob_item_segment azure::storage::cloud_blob_container::list_blobs_segmented ( const continuation_token token) const
inline

Returns a result segment containing a collection of blob items in the container.

Parameters
tokenA continuation token returned by a previous listing operation.
Returns
An azure::storage::list_blob_item_segment containing blob items, which may implement azure::storage::cloud_blob or azure::storage::cloud_blob_directory.

◆ list_blobs_segmented() [2/3]

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

Returns a result segment containing a collection of blob items in the container.

Parameters
prefixThe blob name prefix.
tokenA continuation token returned by a previous listing operation.
Returns
A razure::storage::list_blob_item_segment containing objects that implement azure::storage::cloud_blob and azure::storage::cloud_blob_directory.

◆ list_blobs_segmented() [3/3]

list_blob_item_segment azure::storage::cloud_blob_container::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 a result segment containing a collection of blob items in the container.

Parameters
prefixThe blob name prefix.
use_flat_blob_listingIndicates whether to list blobs in a flat listing, or whether to list blobs hierarchically, by virtual directory.
includesAn azure::storage::blob_listing_details::values enumeration describing which items to include in the listing.
max_resultsA 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.
tokenA continuation token returned by a previous listing operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn 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/4]

pplx::task<list_blob_item_segment> azure::storage::cloud_blob_container::list_blobs_segmented_async ( 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
tokenA 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/4]

pplx::task<list_blob_item_segment> azure::storage::cloud_blob_container::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
prefixThe blob name prefix.
tokenA 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() [3/4]

pplx::task<list_blob_item_segment> azure::storage::cloud_blob_container::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
prefixThe blob name prefix.
use_flat_blob_listingIndicates whether to list blobs in a flat listing, or whether to list blobs hierarchically, by virtual directory.
includesAn azure::storage::blob_listing_details::values enumeration describing which items to include in the listing.
max_resultsA 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.
tokenA continuation token returned by a previous listing operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn 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() [4/4]

WASTORAGE_API pplx::task<list_blob_item_segment> azure::storage::cloud_blob_container::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
prefixThe blob name prefix.
use_flat_blob_listingIndicates whether to list blobs in a flat listing, or whether to list blobs hierarchically, by virtual directory.
includesAn azure::storage::blob_listing_details::values enumeration describing which items to include in the listing.
max_resultsA 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.
tokenA continuation token returned by a previous listing operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
cancellation_tokenAn 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.

◆ metadata() [1/2]

cloud_metadata& azure::storage::cloud_blob_container::metadata ( )
inline

Gets the container's metadata.

Returns
An azure::storage::cloud_metadata object containing the container's metadata.

◆ metadata() [2/2]

const cloud_metadata& azure::storage::cloud_blob_container::metadata ( ) const
inline

Gets the container's metadata.

Returns
An azure::storage::cloud_metadata object containing the container's metadata.

◆ name()

const utility::string_t& azure::storage::cloud_blob_container::name ( ) const
inline

Gets the name of the container.

Returns
A string containing the container name.

◆ properties()

const cloud_blob_container_properties& azure::storage::cloud_blob_container::properties ( ) const
inline

Gets the container's system properties.

Returns
The container's properties.

◆ release_lease() [1/2]

void azure::storage::cloud_blob_container::release_lease ( ) const
inline

Releases a lease on the container.

◆ release_lease() [2/2]

void azure::storage::cloud_blob_container::release_lease ( const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Releases a lease on the container.

Parameters
conditionAn azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.

◆ release_lease_async() [1/3]

pplx::task<void> azure::storage::cloud_blob_container::release_lease_async ( ) const
inline

Initiates an asynchronous operation to release a lease on the container.

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

◆ release_lease_async() [2/3]

pplx::task<void> azure::storage::cloud_blob_container::release_lease_async ( const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Initiates an asynchronous operation to release a lease on the container.

Parameters
conditionAn azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
Returns
A pplx::task object that represents the current operation.

◆ release_lease_async() [3/3]

WASTORAGE_API pplx::task<void> azure::storage::cloud_blob_container::release_lease_async ( const access_condition condition,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
) const

Initiates an asynchronous operation to release a lease on the container.

Parameters
conditionAn azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
cancellation_tokenAn pplx::cancellation_token object that is used to cancel the current operation.
Returns
A pplx::task object that represents the current operation.

◆ renew_lease() [1/2]

void azure::storage::cloud_blob_container::renew_lease ( ) const
inline

Renews a lease on the container.

◆ renew_lease() [2/2]

void azure::storage::cloud_blob_container::renew_lease ( const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Renews a lease on the container.

Parameters
conditionAn azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.

◆ renew_lease_async() [1/3]

pplx::task<void> azure::storage::cloud_blob_container::renew_lease_async ( ) const
inline

Initiates an asynchronous operation to renew a lease on the container.

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

◆ renew_lease_async() [2/3]

pplx::task<void> azure::storage::cloud_blob_container::renew_lease_async ( const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Initiates an asynchronous operation to renew a lease on the container.

Parameters
conditionAn azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
Returns
A pplx::task object that represents the current operation.

◆ renew_lease_async() [3/3]

WASTORAGE_API pplx::task<void> azure::storage::cloud_blob_container::renew_lease_async ( const access_condition condition,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
) const

Initiates an asynchronous operation to renew a lease on the container.

Parameters
conditionAn azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
cancellation_tokenAn pplx::cancellation_token object that is used to cancel the current operation.
Returns
A pplx::task object that represents the current operation.

◆ service_client()

const cloud_blob_client& azure::storage::cloud_blob_container::service_client ( ) const
inline

Gets the Blob service client for the container.

Returns
An azure::storage::cloud_blob_client object that specifies the endpoint for the Blob service.

◆ upload_metadata() [1/2]

void azure::storage::cloud_blob_container::upload_metadata ( )
inline

Sets the container's user-defined metadata.

◆ upload_metadata() [2/2]

void azure::storage::cloud_blob_container::upload_metadata ( const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Sets the container's user-defined metadata.

Parameters
conditionAn azure::storage::access_condition object that represents the access condition for the operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.

◆ upload_metadata_async() [1/3]

pplx::task<void> azure::storage::cloud_blob_container::upload_metadata_async ( )
inline

Initiates an asynchronous operation to set the container's user-defined metadata.

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

◆ upload_metadata_async() [2/3]

WASTORAGE_API pplx::task<void> azure::storage::cloud_blob_container::upload_metadata_async ( const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to set the container's user-defined metadata.

Parameters
conditionAn azure::storage::access_condition object that represents the access condition for the operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
Returns
A pplx::task object that represents the current operation.

◆ upload_metadata_async() [3/3]

WASTORAGE_API pplx::task<void> azure::storage::cloud_blob_container::upload_metadata_async ( const access_condition condition,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
)

Initiates an asynchronous operation to set the container's user-defined metadata.

Parameters
conditionAn azure::storage::access_condition object that represents the access condition for the operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
cancellation_tokenAn pplx::cancellation_token object that is used to cancel the current operation.
Returns
A pplx::task object that represents the current operation.

◆ upload_permissions() [1/2]

void azure::storage::cloud_blob_container::upload_permissions ( const blob_container_permissions permissions)
inline

Sets permissions for the container.

Parameters
permissionsThe permissions to apply to the container.

◆ upload_permissions() [2/2]

void azure::storage::cloud_blob_container::upload_permissions ( const blob_container_permissions permissions,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Sets permissions for the container.

Parameters
permissionsThe permissions to apply to the container.
conditionAn azure::storage::access_condition object that represents the access condition for the operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.

◆ upload_permissions_async() [1/3]

pplx::task<void> azure::storage::cloud_blob_container::upload_permissions_async ( const blob_container_permissions permissions)
inline

Initiates an asynchronous operation to set permissions for the container.

Parameters
permissionsThe permissions to apply to the container.
Returns
A pplx::task object that represents the current operation.

◆ upload_permissions_async() [2/3]

pplx::task<void> azure::storage::cloud_blob_container::upload_permissions_async ( const blob_container_permissions permissions,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to set permissions for the container.

Parameters
permissionsThe permissions to apply to the container.
conditionAn azure::storage::access_condition object that represents the access condition for the operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
Returns
A pplx::task object that represents the current operation.

◆ upload_permissions_async() [3/3]

WASTORAGE_API pplx::task<void> azure::storage::cloud_blob_container::upload_permissions_async ( const blob_container_permissions permissions,
const access_condition condition,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
)

Initiates an asynchronous operation to set permissions for the container.

Parameters
permissionsThe permissions to apply to the container.
conditionAn azure::storage::access_condition object that represents the access condition for the operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
cancellation_tokenAn pplx::cancellation_token object that is used to cancel the current operation.
Returns
A pplx::task object that represents the current operation.

◆ uri()

const storage_uri& azure::storage::cloud_blob_container::uri ( ) const
inline

Gets the container URI for all locations.

Returns
An azure::storage::storage_uri containing the container URI for all locations.