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++.
|
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_properties > | download_account_properties_async () const |
Initiates an asynchronous operation to get properties for the account this container resides on. More... | |
pplx::task< account_properties > | download_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_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 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_segment > | list_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_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... | |
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_permissions > | download_permissions_async () |
Initiates an asynchronous operation to get permissions settings for the container. More... | |
pplx::task< blob_container_permissions > | download_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_permissions > | 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. 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_client & | service_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_uri & | uri () 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_properties & | properties () const |
Gets the container's system properties. More... | |
bool | is_valid () const |
Indicates whether the azure::storage::cloud_blob_container object is valid. More... | |
Represents a container in the Windows Azure Blob service.
|
inline |
Initializes a new instance of the azure::storage::cloud_blob_container class.
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.
uri | An azure::storage::storage_uri object containing the absolute URI to the container for all locations. |
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.
uri | An azure::storage::storage_uri object containing the absolute URI to the container for all locations. |
credentials | The azure::storage::storage_credentials to use. |
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.
name | The name of the container. |
client | The Blob service client. |
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.
name | The container name. |
client | The Blob service client. |
properties | The properties for the container. |
metadata | The metadata for the container. |
|
inline |
Acquires a lease on the container.
duration | An azure::storage::lease_time representing the span of time for which to acquire the lease. |
proposed_lease_id | A string representing the proposed lease ID for the new lease. May be an empty string if no lease ID is proposed. |
|
inline |
Acquires a lease on the container.
duration | An azure::storage::lease_time representing the span of time for which to acquire the lease. |
proposed_lease_id | A string representing the proposed lease ID for the new lease. May be an empty string if no lease ID is proposed. |
condition | An azure::storage::access_condition object that represents the access condition for the 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. |
|
inline |
Initiates an asynchronous operation to acquire a lease on the container.
duration | An azure::storage::lease_time object representing the span of time for which to acquire the lease. |
proposed_lease_id | A string representing the proposed lease ID for the new lease. May be an empty string if no lease ID is proposed.. |
|
inline |
Initiates an asynchronous operation to acquire a lease on the container.
duration | An azure::storage::lease_time representing the span of time for which to acquire the lease. |
proposed_lease_id | A string representing the proposed lease ID for the new lease. May be an empty string if no lease ID is proposed. |
condition | An azure::storage::access_condition object that represents the access condition for the 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. |
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.
duration | An azure::storage::lease_time representing the span of time for which to acquire the lease. |
proposed_lease_id | A string representing the proposed lease ID for the new lease. May be an empty string if no lease ID is proposed. |
condition | An azure::storage::access_condition object that represents the access condition for the 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. |
|
inline |
Breaks the current lease on the container.
break_period | An azure::storage::lease_break_period representing the amount of time to allow the lease to remain. |
|
inline |
Breaks the current lease on the container.
break_period | An azure::storage::lease_break_period representing the amount of time to allow the lease to remain. |
condition | An azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID. |
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. |
|
inline |
Initiates an asynchronous operation to break the current lease on the container.
break_period | An azure::storage::lease_break_period representing the amount of time to allow the lease to remain. |
|
inline |
Initiates an asynchronous operation to break the current lease on the container.
break_period | An azure::storage::lease_break_period representing the amount of time to allow the lease to remain. |
condition | An azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID. |
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. |
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.
break_period | An azure::storage::lease_break_period representing the amount of time to allow the lease to remain. |
condition | An azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID. |
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. |
|
inline |
Changes the lease ID for a lease on the container.
proposed_lease_id | A string containing the proposed lease ID for the lease. May not be empty. |
|
inline |
Changes the lease ID for a lease on the container.
proposed_lease_id | A string containing the proposed lease ID for the lease. May not be empty. |
condition | An azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID. |
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. |
|
inline |
Initiates an asynchronous operation to change the lease ID for a lease on the container.
proposed_lease_id | A string containing the proposed lease ID for the lease. May not be empty. |
|
inline |
Initiates an asynchronous operation to change the lease ID for a lease on the container.
proposed_lease_id | A string containing the proposed lease ID for the lease. May not be empty. |
condition | An azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID. |
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. |
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.
proposed_lease_id | A string containing the proposed lease ID for the lease. May not be empty. |
condition | An azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID. |
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. |
|
inline |
Creates the container.
|
inline |
Creates the container and specifies the level of access to the container's data.
public_access | An 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. |
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. This object is used to track requests to the storage service, and to provide additional runtime information about the operation. |
|
inline |
Initiates an asynchronous operation to create the container.
|
inline |
Initiates an asynchronous operation to create the container.
public_access | An 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. |
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. |
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.
public_access | An 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. |
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. |
|
inline |
Creates the container if it does not already exist.
true
if the container did not already exist and was created; otherwise false
.
|
inline |
Creates the container if it does not already exist and specifies the level of public access to the container's data.
public_access | An 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. |
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. |
true
if the container did not already exist and was created; otherwise false
.
|
inline |
Initiates an asynchronous operation to create the container if it does not already exist.
|
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.
public_access | An 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. |
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. |
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.
public_access | An 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. |
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. |
|
inline |
Deletes the container.
|
inline |
Deletes the container.
condition | An azure::storage::access_condition object that represents the access condition for the 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. |
|
inline |
Initiates an asynchronous operation to delete the container.
|
inline |
Initiates an asynchronous operation to delete the container.
condition | An azure::storage::access_condition object that represents the access condition for the 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. |
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.
condition | An azure::storage::access_condition object that represents the access condition for the 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. |
|
inline |
Deletes the container if it already exists.
true
if the container did not already exist and was created; otherwise false
.
|
inline |
Deletes the container if it already exists.
condition | An azure::storage::access_condition object that represents the access condition for the 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. |
true
if the container did not already exist and was created; otherwise false
.
|
inline |
Initiates an asynchronous operation to delete the container if it already exists.
true
if the container did not already exist and was created; otherwise false
.
A pplx::task object that represents the current operation.
|
inline |
Initiates an asynchronous operation to delete the container if it already exists.
condition | An azure::storage::access_condition object that represents the access condition for the 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. |
true
if the container did not already exist and was created; otherwise false
.
A pplx::task object that represents the current operation.
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.
condition | An azure::storage::access_condition object that represents the access condition for the 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. |
true
if the container did not already exist and was created; otherwise false
.cancellation_token | An pplx::cancellation_token object that is used to cancel the current operation. |
|
inline |
Gets properties for the account this container resides on.
|
inline |
Gets properties for the account this container resides on.
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. |
|
inline |
Initiates an asynchronous operation to get properties for the account this container resides on.
|
inline |
Initiates an asynchronous operation to get properties for the account this container resides on.
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. |
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.
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. |
|
inline |
Retrieves the container's attributes.
|
inline |
Retrieves the container's attributes.
condition | An azure::storage::access_condition object that represents the access condition for the 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. |
|
inline |
Initiates an asynchronous operation to retrieve the container's attributes.
|
inline |
Initiates an asynchronous operation to retrieve the container's attributes.
condition | An azure::storage::access_condition object that represents the access condition for the 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. |
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.
condition | An azure::storage::access_condition object that represents the access condition for the 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. |
|
inline |
Gets the permissions settings for the container.
|
inline |
Gets the permissions settings for the container.
condition | An azure::storage::access_condition object that represents the access condition for the 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. |
|
inline |
Initiates an asynchronous operation to get permissions settings for the container.
|
inline |
Initiates an asynchronous operation to get permissions settings for the container.
condition | An azure::storage::access_condition object that represents the access condition for the 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. |
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.
condition | An azure::storage::access_condition object that represents the access condition for the 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. |
|
inline |
Checks existence of the container.
true
if the container exists.
|
inline |
Checks existence of the container.
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. |
true
if the container exists.
|
inline |
Initiates an asynchronous operation to check the existence of the container.
|
inline |
Initiates an asynchronous operation to check the existence of the container.
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. |
|
inline |
Initiates an asynchronous operation to check the existence of the container.
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. |
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.
blob_name | The name of the blob. |
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.
blob_name | The name of the blob. |
snapshot_time | The snapshot timestamp, if the blob is a snapshot. |
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.
blob_name | The name of the blob. |
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.
blob_name | The name of the blob. |
snapshot_time | The snapshot timestamp, if the blob is a snapshot. |
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.
blob_name | The name of the blob. |
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.
blob_name | The name of the blob. |
snapshot_time | The snapshot timestamp, if the blob is a snapshot. |
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.
directory_name | The name of the virtual blob directory. |
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.
blob_name | The name of the blob. |
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.
blob_name | The name of the blob. |
snapshot_time | The snapshot timestamp, if the blob is a snapshot. |
|
inline |
Returns a shared access signature for the container.
policy | The access policy for the shared access signature. |
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.
policy | The access policy for the shared access signature. |
stored_policy_identifier | A container-level access policy. |
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.
key | User delegation key used to sign this SAS. |
policy | The access policy for the shared access signature. |
|
inline |
Indicates whether the azure::storage::cloud_blob_container object is valid.
true
if the azure::storage::cloud_blob_container object is valid; otherwise, false
.
|
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.
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.
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. |
|
inline |
Returns a result segment containing a collection of blob items in the container.
token | A continuation token returned by a previous listing operation. |
|
inline |
Returns a result segment containing a collection of blob items in the container.
prefix | The blob name prefix. |
token | A continuation token returned by a previous listing operation. |
|
inline |
Returns a result segment containing a collection of blob items in the container.
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 | A 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. |
|
inline |
Initiates an asynchronous operation to return an azure::storage::list_blob_item_segment containing a collection of blob items in the container.
token | A continuation token returned by a previous listing operation. |
|
inline |
Initiates an asynchronous operation to return an azure::storage::list_blob_item_segment containing a collection of blob items in the container.
prefix | The blob name prefix. |
token | A continuation token returned by a previous listing operation. |
|
inline |
Initiates an asynchronous operation to return an azure::storage::list_blob_item_segment containing a collection of blob items in the container.
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 | A 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. |
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.
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 | A 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. |
|
inline |
Gets the container's metadata.
|
inline |
Gets the container's metadata.
|
inline |
Gets the name of the container.
|
inline |
Gets the container's system properties.
|
inline |
Releases a lease on the container.
|
inline |
Releases a lease on the container.
condition | An azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID. |
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. |
|
inline |
Initiates an asynchronous operation to release a lease on the container.
|
inline |
Initiates an asynchronous operation to release a lease on the container.
condition | An azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID. |
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. |
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.
condition | An azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID. |
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. |
|
inline |
Renews a lease on the container.
|
inline |
Renews a lease on the container.
condition | An azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID. |
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. |
|
inline |
Initiates an asynchronous operation to renew a lease on the container.
|
inline |
Initiates an asynchronous operation to renew a lease on the container.
condition | An azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID. |
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. |
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.
condition | An azure::storage::access_condition object that represents the access condition for the operation, including a required lease ID. |
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. |
|
inline |
Gets the Blob service client for the container.
|
inline |
Sets the container's user-defined metadata.
|
inline |
Sets the container's user-defined metadata.
condition | An azure::storage::access_condition object that represents the access condition for the 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. |
|
inline |
Initiates an asynchronous operation to set the container's user-defined metadata.
|
inline |
Initiates an asynchronous operation to set the container's user-defined metadata.
condition | An azure::storage::access_condition object that represents the access condition for the 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. |
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.
condition | An azure::storage::access_condition object that represents the access condition for the 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. |
|
inline |
Sets permissions for the container.
permissions | The permissions to apply to the container. |
|
inline |
Sets permissions for the container.
permissions | The permissions to apply to the container. |
condition | An azure::storage::access_condition object that represents the access condition for the 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. |
|
inline |
Initiates an asynchronous operation to set permissions for the container.
permissions | The permissions to apply to the container. |
|
inline |
Initiates an asynchronous operation to set permissions for the container.
permissions | The permissions to apply to the container. |
condition | An azure::storage::access_condition object that represents the access condition for the 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. |
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.
permissions | The permissions to apply to the container. |
condition | An azure::storage::access_condition object that represents the access condition for the 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. |
|
inline |
Gets the container URI for all locations.