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_block_blob Class Reference

Represents a blob that is uploaded as a set of blocks. More...

Inheritance diagram for azure::storage::cloud_block_blob:
azure::storage::cloud_blob

Public Member Functions

 cloud_block_blob ()
 Initializes a new instance of the azure::storage::cloud_block_blob class. More...
 
 cloud_block_blob (storage_uri uri)
 Initializes a new instance of the azure::storage::cloud_block_blob class using an absolute URI to the blob. More...
 
 cloud_block_blob (storage_uri uri, storage_credentials credentials)
 Initializes a new instance of the azure::storage::cloud_block_blob class using an absolute URI to the blob. More...
 
 cloud_block_blob (storage_uri uri, utility::string_t snapshot_time, storage_credentials credentials)
 Initializes a new instance of the azure::storage::cloud_block_blob class using an absolute URI to the blob. More...
 
 cloud_block_blob (const cloud_blob &blob)
 Initializes a new instance of the azure::storage::cloud_block_blob class. More...
 
concurrency::streams::ostream open_write ()
 Opens a stream for writing to the block blob. If the blob already exists on the service, it will be overwritten. More...
 
concurrency::streams::ostream open_write (const access_condition &condition, const blob_request_options &options, operation_context context)
 Opens a stream for writing to the block blob. If the blob already exists on the service, it will be overwritten. More...
 
pplx::task< concurrency::streams::ostream > open_write_async ()
 Initiates an asynchronous operation to open a stream for writing to the block blob. If the blob already exists on the service, it will be overwritten. More...
 
pplx::task< concurrency::streams::ostream > open_write_async (const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to open a stream for writing to the block blob. If the blob already exists on the service, it will be overwritten. More...
 
pplx::task< concurrency::streams::ostream > open_write_async (const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to open a stream for writing to the block blob. If the blob already exists on the service, it will be overwritten. More...
 
std::vector< block_list_itemdownload_block_list () const
 Returns an enumerable collection of the blob's blocks, using the specified block list filter. More...
 
std::vector< block_list_itemdownload_block_list (block_listing_filter listing_filter, const access_condition &condition, const blob_request_options &options, operation_context context) const
 Returns an enumerable collection of the blob's blocks, using the specified block list filter. More...
 
pplx::task< std::vector< block_list_item > > download_block_list_async () const
 Initiates an asynchronous operation to return an enumerable collection of the blob's blocks, using the specified block list filter. More...
 
pplx::task< std::vector< block_list_item > > download_block_list_async (block_listing_filter listing_filter, const access_condition &condition, const blob_request_options &options, operation_context context) const
 Initiates an asynchronous operation to return an enumerable collection of the blob's blocks, using the specified block list filter. More...
 
WASTORAGE_API pplx::task< std::vector< block_list_item > > download_block_list_async (block_listing_filter listing_filter, const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token) const
 Initiates an asynchronous operation to return an enumerable collection of the blob's blocks, using the specified block list filter. More...
 
utility::string_t download_text ()
 Downloads the blob's contents as a string. More...
 
utility::string_t download_text (const access_condition &condition, const blob_request_options &options, operation_context context)
 Downloads the blob's contents as a string. More...
 
pplx::task< utility::string_t > download_text_async ()
 Initiates an asynchronous operation to download the blob's contents as a string. More...
 
pplx::task< utility::string_t > download_text_async (const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to download the blob's contents as a string. More...
 
WASTORAGE_API pplx::task< utility::string_t > download_text_async (const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to download the blob's contents as a string. More...
 
void set_standard_blob_tier (const standard_blob_tier tier, const access_condition &condition, const blob_request_options &options, operation_context context)
 Sets standard account's blob tier. More...
 
pplx::task< void > set_standard_blob_tier_async (const standard_blob_tier tier, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to set standard account's blob tier. More...
 
WASTORAGE_API pplx::task< void > set_standard_blob_tier_async (const standard_blob_tier tier, const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to set standard account's blob tier. More...
 
void upload_block (const utility::string_t &block_id, concurrency::streams::istream block_data, const checksum &content_checksum) const
 Uploads a single block. More...
 
void upload_block (const utility::string_t &block_id, concurrency::streams::istream block_data, const checksum &content_checksum, const access_condition &condition, const blob_request_options &options, operation_context context) const
 Uploads a single block. More...
 
pplx::task< void > upload_block_async (const utility::string_t &block_id, concurrency::streams::istream block_data, const checksum &content_checksum) const
 Initiates an asynchronous operation to upload a single block. More...
 
WASTORAGE_API pplx::task< void > upload_block_async (const utility::string_t &block_id, concurrency::streams::istream block_data, const checksum &content_checksum, const access_condition &condition, const blob_request_options &options, operation_context context) const
 Initiates an asynchronous operation to upload a single block. More...
 
pplx::task< void > upload_block_async (const utility::string_t &block_id, concurrency::streams::istream block_data, const checksum &content_checksum, const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token) const
 Initiates an asynchronous operation to upload a single block. More...
 
void upload_block_list (const std::vector< block_list_item > &block_list)
 Uploads a list of blocks to a new or existing blob. More...
 
void upload_block_list (const std::vector< block_list_item > &block_list, const access_condition &condition, const blob_request_options &options, operation_context context)
 Uploads a list of blocks to a new or existing blob. More...
 
pplx::task< void > upload_block_list_async (const std::vector< block_list_item > &block_list)
 Initiates an asynchronous operation to upload a list of blocks to a new or existing blob. More...
 
pplx::task< void > upload_block_list_async (const std::vector< block_list_item > &block_list, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to upload a list of blocks to a new or existing blob. More...
 
pplx::task< void > upload_block_list_async (const std::vector< block_list_item > &block_list, const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to upload a list of blocks to a new or existing blob. More...
 
void upload_from_stream (concurrency::streams::istream source)
 Uploads a stream to a block blob. If the blob already exists on the service, it will be overwritten. More...
 
void upload_from_stream (concurrency::streams::istream source, const access_condition &condition, const blob_request_options &options, operation_context context)
 Uploads a stream to a block blob. If the blob already exists on the service, it will be overwritten. More...
 
void upload_from_stream (concurrency::streams::istream source, utility::size64_t length)
 Uploads a stream to a block blob. If the blob already exists on the service, it will be overwritten. More...
 
void upload_from_stream (concurrency::streams::istream source, utility::size64_t length, const access_condition &condition, const blob_request_options &options, operation_context context)
 Uploads a stream to a block blob. If the blob already exists on the service, it will be overwritten. More...
 
pplx::task< void > upload_from_stream_async (concurrency::streams::istream source)
 Initiates an asynchronous operation to upload a stream to a block blob. If the blob already exists on the service, it will be overwritten. More...
 
pplx::task< void > upload_from_stream_async (concurrency::streams::istream source, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to upload a stream to a block blob. If the blob already exists on the service, it will be overwritten. More...
 
pplx::task< void > upload_from_stream_async (concurrency::streams::istream source, utility::size64_t length)
 Initiates an asynchronous operation to upload a stream to a block blob. If the blob already exists on the service, it will be overwritten. More...
 
pplx::task< void > upload_from_stream_async (concurrency::streams::istream source, utility::size64_t length, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to upload a stream to a block blob. If the blob already exists on the service, it will be overwritten. More...
 
WASTORAGE_API pplx::task< void > upload_from_stream_async (concurrency::streams::istream source, utility::size64_t length, const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to upload a stream to a block blob. If the blob already exists on the service, it will be overwritten. More...
 
void upload_from_file (const utility::string_t &path)
 Uploads a file to a block blob. If the blob already exists on the service, it will be overwritten. More...
 
void upload_from_file (const utility::string_t &path, const access_condition &condition, const blob_request_options &options, operation_context context)
 Uploads a file to a block blob. If the blob already exists on the service, it will be overwritten. More...
 
pplx::task< void > upload_from_file_async (const utility::string_t &path)
 Initiates an asynchronous operation to upload a file to a block blob. If the blob already exists on the service, it will be overwritten. More...
 
pplx::task< void > upload_from_file_async (const utility::string_t &path, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to upload a file to a block blob. If the blob already exists on the service, it will be overwritten. More...
 
WASTORAGE_API pplx::task< void > upload_from_file_async (const utility::string_t &path, const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to upload a file to a block blob. If the blob already exists on the service, it will be overwritten. More...
 
void upload_text (const utility::string_t &content)
 Uploads a string of text to a blob. If the blob already exists on the service, it will be overwritten. More...
 
void upload_text (const utility::string_t &content, const access_condition &condition, const blob_request_options &options, operation_context context)
 Uploads a string of text to a blob. If the blob already exists on the service, it will be overwritten. More...
 
pplx::task< void > upload_text_async (const utility::string_t &content)
 Uploads a string of text to a blob. If the blob already exists on the service, it will be overwritten. More...
 
pplx::task< void > upload_text_async (const utility::string_t &content, const access_condition &condition, const blob_request_options &options, operation_context context)
 Uploads a string of text to a blob. If the blob already exists on the service, it will be overwritten. More...
 
WASTORAGE_API pplx::task< void > upload_text_async (const utility::string_t &content, const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Uploads a string of text to a blob. If the blob already exists on the service, it will be overwritten. More...
 
- Public Member Functions inherited from azure::storage::cloud_blob
 cloud_blob ()
 Initializes a new instance of the azure::storage::cloud_blob class. More...
 
WASTORAGE_API cloud_blob (storage_uri uri)
 Initializes a new instance of the azure::storage::cloud_blob class using an absolute URI to the blob. More...
 
WASTORAGE_API cloud_blob (storage_uri uri, storage_credentials credentials)
 Initializes a new instance of the azure::storage::cloud_blob class using an absolute URI to the blob. More...
 
WASTORAGE_API cloud_blob (storage_uri uri, utility::string_t snapshot_time, storage_credentials credentials)
 Initializes a new instance of the azure::storage::cloud_blob class using an absolute URI to the blob. More...
 
WASTORAGE_API cloud_blob_directory get_parent_reference () const
 Gets the azure::storage::cloud_blob_directory object representing the virtual parent directory for the blob. More...
 
WASTORAGE_API storage_uri snapshot_qualified_uri () const
 Gets the snapshot-qualified URI to the blob. More...
 
utility::string_t get_shared_access_signature (const blob_shared_access_policy &policy) const
 Returns a shared access signature for the blob. More...
 
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 blob. More...
 
WASTORAGE_API utility::string_t get_shared_access_signature (const blob_shared_access_policy &policy, const utility::string_t &stored_policy_identifier, const cloud_blob_shared_access_headers &headers) const
 Returns a shared access signature for the blob. More...
 
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 blob. More...
 
WASTORAGE_API utility::string_t get_user_delegation_sas (const user_delegation_key &key, const blob_shared_access_policy &policy, const cloud_blob_shared_access_headers &headers) const
 Returns a user delegation SAS for the blob. More...
 
concurrency::streams::istream open_read ()
 Opens a stream for reading from the blob. More...
 
concurrency::streams::istream open_read (const access_condition &condition, const blob_request_options &options, operation_context context)
 Opens a stream for reading from the blob. More...
 
pplx::task< concurrency::streams::istream > open_read_async ()
 Initiates an asynchronous operation to open a stream for reading from the blob. More...
 
pplx::task< concurrency::streams::istream > open_read_async (const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to open a stream for reading from the blob. More...
 
WASTORAGE_API pplx::task< concurrency::streams::istream > open_read_async (const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to open a stream for reading from the blob. More...
 
bool exists ()
 Checks existence of the blob. More...
 
bool exists (const blob_request_options &options, operation_context context)
 Checks existence of the blob. More...
 
pplx::task< bool > exists_async ()
 Initiates an asynchronous operation to check the existence of the blob. More...
 
pplx::task< bool > exists_async (const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to check the existence of the blob. 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 blob. More...
 
void download_attributes ()
 Populates a blob's properties and metadata. More...
 
void download_attributes (const access_condition &condition, const blob_request_options &options, operation_context context)
 Populates a blob's properties and metadata. More...
 
pplx::task< void > download_attributes_async ()
 Initiates an asynchronous operation to populate a blob's properties and metadata. More...
 
pplx::task< void > download_attributes_async (const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to populate a blob's properties and metadata. More...
 
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 populate a blob's properties and metadata. More...
 
void upload_metadata ()
 Updates the blob's metadata. More...
 
void upload_metadata (const access_condition &condition, const blob_request_options &options, operation_context context)
 Updates the blob's metadata. More...
 
pplx::task< void > upload_metadata_async ()
 Initiates an asynchronous operation to update the blob's metadata. More...
 
pplx::task< void > upload_metadata_async (const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to update the blob's 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 update the blob's metadata. More...
 
void upload_properties ()
 Updates the blob's properties. More...
 
void upload_properties (const access_condition &condition, const blob_request_options &options, operation_context context)
 Updates the blob's properties. More...
 
pplx::task< void > upload_properties_async ()
 Initiates an asynchronous operation to update the blob's properties. More...
 
pplx::task< void > upload_properties_async (const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to update the blob's properties. More...
 
pplx::task< void > upload_properties_async (const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to update the blob's properties. More...
 
account_properties download_account_properties () const
 Gets properties for the account this blob resides on. More...
 
account_properties download_account_properties (const blob_request_options &options, operation_context context) const
 Gets properties for the account this blob resides on. More...
 
pplx::task< account_propertiesdownload_account_properties_async () const
 Initiates an asynchronous operation to get properties for the account this blob 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 blob 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 blob resides on. More...
 
void delete_blob ()
 Deletes the blob. More...
 
void delete_blob (delete_snapshots_option snapshots_option, const access_condition &condition, const blob_request_options &options, operation_context context)
 Deletes the blob. More...
 
pplx::task< void > delete_blob_async ()
 Initiates an asynchronous operation to delete the blob. More...
 
WASTORAGE_API pplx::task< void > delete_blob_async (delete_snapshots_option snapshots_option, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to delete the blob. More...
 
WASTORAGE_API pplx::task< void > delete_blob_async (delete_snapshots_option snapshots_option, 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 blob. More...
 
bool delete_blob_if_exists ()
 Deletes the blob if it already exists. More...
 
bool delete_blob_if_exists (delete_snapshots_option snapshots_option, const access_condition &condition, const blob_request_options &options, operation_context context)
 Deletes the blob if it already exists. More...
 
pplx::task< bool > delete_blob_if_exists_async ()
 Initiates an asynchronous operation to delete the blob if it already exists. More...
 
pplx::task< bool > delete_blob_if_exists_async (delete_snapshots_option snapshots_option, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to delete the blob if it already exists. More...
 
WASTORAGE_API pplx::task< bool > delete_blob_if_exists_async (delete_snapshots_option snapshots_option, 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 blob if it already exists. 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 blob. 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 blob. 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 blob. 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 blob. 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 blob. More...
 
void renew_lease (const access_condition &condition) const
 Renews a lease on the blob. More...
 
void renew_lease (const access_condition &condition, const blob_request_options &options, operation_context context) const
 Renews a lease on the blob. More...
 
pplx::task< void > renew_lease_async (const access_condition &condition) const
 Initiates an asynchronous operation to renew a lease on the blob. 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 blob. 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 blob. More...
 
utility::string_t change_lease (const utility::string_t &proposed_lease_id, const access_condition &condition) const
 Changes the lease ID on the blob. 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 on the blob. More...
 
pplx::task< utility::string_t > change_lease_async (const utility::string_t &proposed_lease_id, const access_condition &condition) const
 Initiates an asynchronous operation to change the lease ID on the blob. 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
 Initiates an asynchronous operation to change the lease ID on the blob. 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 on the blob. More...
 
void release_lease (const access_condition &condition) const
 Releases the lease on the blob. More...
 
void release_lease (const access_condition &condition, const blob_request_options &options, operation_context context) const
 Releases the lease on the blob. More...
 
pplx::task< void > release_lease_async (const access_condition &condition) const
 Initiates an asynchronous operation to release the lease on the blob. 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 the lease on the blob. 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 the lease on the blob. More...
 
std::chrono::seconds break_lease (const azure::storage::lease_break_period &break_period) const
 Breaks the current lease on the blob. 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 blob. 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 blob. 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 blob. 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 blob. More...
 
void download_to_stream (concurrency::streams::ostream target)
 Downloads the contents of a blob to a stream. More...
 
void download_to_stream (concurrency::streams::ostream target, const access_condition &condition, const blob_request_options &options, operation_context context)
 Downloads the contents of a blob to a stream. More...
 
pplx::task< void > download_to_stream_async (concurrency::streams::ostream target)
 Initiates an asynchronous operation to download the contents of a blob to a stream. More...
 
pplx::task< void > download_to_stream_async (concurrency::streams::ostream target, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to download the contents of a blob to a stream. More...
 
pplx::task< void > download_to_stream_async (concurrency::streams::ostream target, const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to download the contents of a blob to a stream. More...
 
void download_range_to_stream (concurrency::streams::ostream target, utility::size64_t offset, utility::size64_t length)
 Downloads a range of bytes in a blob to a stream. More...
 
void download_range_to_stream (concurrency::streams::ostream target, utility::size64_t offset, utility::size64_t length, const access_condition &condition, const blob_request_options &options, operation_context context)
 Downloads a range of bytes in a blob to a stream. More...
 
pplx::task< void > download_range_to_stream_async (concurrency::streams::ostream target, int64_t offset, int64_t length)
 Initiates an asynchronous operation to download a range of bytes in a blob to a stream. More...
 
pplx::task< void > download_range_to_stream_async (concurrency::streams::ostream target, utility::size64_t offset, utility::size64_t length, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to download a range of bytes in a blob to a stream. More...
 
WASTORAGE_API pplx::task< void > download_range_to_stream_async (concurrency::streams::ostream target, utility::size64_t offset, utility::size64_t length, const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to download a range of bytes in a blob to a stream. More...
 
void download_to_file (const utility::string_t &path)
 Downloads the contents of a blob to a file. More...
 
void download_to_file (const utility::string_t &path, const access_condition &condition, const blob_request_options &options, operation_context context)
 Downloads the contents of a blob to a file. More...
 
pplx::task< void > download_to_file_async (const utility::string_t &path)
 Initiates an asynchronous operation to download the contents of a blob to a file. More...
 
pplx::task< void > download_to_file_async (const utility::string_t &path, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to download the contents of a blob to a file. More...
 
WASTORAGE_API pplx::task< void > download_to_file_async (const utility::string_t &path, const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to download the contents of a blob to a file. More...
 
utility::string_t start_copy_from_blob (const web::http::uri &source)
 Begins an operation to copy a blob's contents, properties, and metadata to a new blob. More...
 
utility::string_t start_copy_from_blob (const web::http::uri &source, const access_condition &source_condition, const access_condition &destination_condition, const blob_request_options &options, operation_context context)
 Begins an operation to copy a blob's contents, properties, and metadata to a new blob. More...
 
utility::string_t start_copy_from_blob (const cloud_blob &source)
 Begins an operation to copy a blob's contents, properties, and metadata to a new blob. More...
 
utility::string_t start_copy_from_blob (const cloud_blob &source, const access_condition &source_condition, const access_condition &destination_condition, const blob_request_options &options, operation_context context)
 Begins an operation to copy a blob's contents, properties, and metadata to a new blob. More...
 
pplx::task< utility::string_t > start_copy_from_blob_async (const web::http::uri &source)
 Initiates an asynchronous operation to begin to copy a blob's contents, properties, and metadata to a new blob. More...
 
pplx::task< utility::string_t > start_copy_from_blob_async (const cloud_blob &source)
 Initiates an asynchronous operation to begin to copy a blob's contents, properties, and metadata to a new blob. More...
 
WASTORAGE_API pplx::task< utility::string_t > start_copy_from_blob_async (const web::http::uri &source, const access_condition &source_condition, const access_condition &destination_condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to begin to copy a blob's contents, properties, and metadata to a new blob. More...
 
WASTORAGE_API pplx::task< utility::string_t > start_copy_from_blob_async (const cloud_blob &source, const access_condition &source_condition, const access_condition &destination_condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to begin to copy a blob's contents, properties, and metadata to a new blob. More...
 
utility::string_t start_copy (const web::http::uri &source)
 Begins an operation to copy a blob's contents, properties, and metadata to a new blob. More...
 
utility::string_t start_copy (const web::http::uri &source, const access_condition &source_condition, const access_condition &destination_condition, const blob_request_options &options, operation_context context)
 Begins an operation to copy a blob's contents, properties, and metadata to a new blob. More...
 
utility::string_t start_copy (const web::http::uri &source, const cloud_metadata &metadata, const access_condition &source_condition, const access_condition &destination_condition, const blob_request_options &options, operation_context context)
 Begins an operation to copy a blob's contents, properties, and metadata to a new blob. More...
 
utility::string_t start_copy (const cloud_blob &source)
 Begins an operation to copy a blob's contents, properties, and metadata to a new blob. More...
 
utility::string_t start_copy (const cloud_blob &source, const access_condition &source_condition, const access_condition &destination_condition, const blob_request_options &options, operation_context context)
 Begins an operation to copy a blob's contents, properties, and metadata to a new blob. More...
 
utility::string_t start_copy (const cloud_blob &source, const cloud_metadata &metadata, const access_condition &source_condition, const access_condition &destination_condition, const blob_request_options &options, operation_context context)
 Begins an operation to copy a blob's contents, properties, and metadata to a new blob. More...
 
utility::string_t start_copy (const cloud_file &source)
 Begins an operation to copy a file's contents, properties, and metadata to a new blob. More...
 
utility::string_t start_copy (const cloud_file &source, const file_access_condition &source_condition, const access_condition &destination_condition, const blob_request_options &options, operation_context context)
 Begins an operation to copy a file's contents, properties, and metadata to a new blob. More...
 
utility::string_t start_copy (const cloud_file &source, const cloud_metadata &metadata, const file_access_condition &source_condition, const access_condition &destination_condition, const blob_request_options &options, operation_context context)
 Begins an operation to copy a file's contents, properties, and metadata to a new blob. More...
 
pplx::task< utility::string_t > start_copy_async (const web::http::uri &source)
 Initiates an asynchronous operation to begin to copy a blob's contents, properties, and metadata to a new blob. More...
 
pplx::task< utility::string_t > start_copy_async (const cloud_blob &source)
 Initiates an asynchronous operation to begin to copy a blob's contents, properties, and metadata to a new blob. More...
 
WASTORAGE_API pplx::task< utility::string_t > start_copy_async (const cloud_file &source)
 Initiates an asynchronous operation to begin to copy a file's contents, properties, and metadata to a new blob. More...
 
pplx::task< utility::string_t > start_copy_async (const web::http::uri &source, const access_condition &source_condition, const access_condition &destination_condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to begin to copy a blob's contents, properties, and metadata to a new blob. More...
 
pplx::task< utility::string_t > start_copy_async (const web::http::uri &source, const access_condition &source_condition, const access_condition &destination_condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to begin to copy a blob's contents, properties, and metadata to a new blob. More...
 
pplx::task< utility::string_t > start_copy_async (const web::http::uri &source, const cloud_metadata &metadata, const access_condition &source_condition, const access_condition &destination_condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to begin to copy a blob's contents, properties, and metadata to a new blob. More...
 
pplx::task< utility::string_t > start_copy_async (const cloud_blob &source, const access_condition &source_condition, const access_condition &destination_condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to begin to copy a blob's contents, properties, and metadata to a new blob. More...
 
pplx::task< utility::string_t > start_copy_async (const cloud_blob &source, const access_condition &source_condition, const access_condition &destination_condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to begin to copy a blob's contents, properties, and metadata to a new blob. More...
 
WASTORAGE_API pplx::task< utility::string_t > start_copy_async (const cloud_blob &source, const cloud_metadata &metadata, const access_condition &source_condition, const access_condition &destination_condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to begin to copy a blob's contents, properties, and metadata to a new blob. More...
 
pplx::task< utility::string_t > start_copy_async (const cloud_file &source, const file_access_condition &source_condition, const access_condition &destination_condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to begin to copy a file's contents, properties, and metadata to a new blob. More...
 
pplx::task< utility::string_t > start_copy_async (const cloud_file &source, const file_access_condition &source_condition, const access_condition &destination_condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to begin to copy a file's contents, properties, and metadata to a new blob. More...
 
WASTORAGE_API pplx::task< utility::string_t > start_copy_async (const cloud_file &source, const cloud_metadata &metadata, const file_access_condition &source_condition, const access_condition &destination_condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to begin to copy a file's contents, properties, and metadata to a new blob. More...
 
void abort_copy (const utility::string_t &copy_id) const
 Aborts an ongoing blob copy operation. More...
 
void abort_copy (const utility::string_t &copy_id, const access_condition &condition, const blob_request_options &options, operation_context context) const
 Aborts an ongoing blob copy operation. More...
 
pplx::task< void > abort_copy_async (const utility::string_t &copy_id) const
 Initiates an asynchronous operation to abort an ongoing blob copy operation. More...
 
pplx::task< void > abort_copy_async (const utility::string_t &copy_id, const access_condition &condition, const blob_request_options &options, operation_context context) const
 Initiates an asynchronous operation to abort an ongoing blob copy operation. More...
 
WASTORAGE_API pplx::task< void > abort_copy_async (const utility::string_t &copy_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 abort an ongoing blob copy operation. More...
 
cloud_blob create_snapshot ()
 Creates a snapshot of the blob. More...
 
cloud_blob create_snapshot (cloud_metadata metadata, const access_condition &condition, const blob_request_options &options, operation_context context)
 Creates a snapshot of the blob. More...
 
pplx::task< azure::storage::cloud_blobcreate_snapshot_async ()
 Initiates an asynchronous operation to create a snapshot of the blob. More...
 
pplx::task< azure::storage::cloud_blobcreate_snapshot_async (cloud_metadata metadata, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to create a snapshot of the blob. More...
 
WASTORAGE_API pplx::task< azure::storage::cloud_blobcreate_snapshot_async (cloud_metadata metadata, const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to create a snapshot of the blob. More...
 
const cloud_blob_clientservice_client () const
 Gets the azure::storage::cloud_blob_client object that represents the Blob service. More...
 
const cloud_blob_containercontainer () const
 Gets an azure::storage::cloud_blob_container object representing the blob's container. More...
 
cloud_blob_propertiesproperties ()
 Gets the blob's system properties. More...
 
const cloud_blob_propertiesproperties () const
 Gets the blob's system properties. More...
 
cloud_metadata & metadata ()
 Gets the user-defined metadata for the blob. More...
 
const cloud_metadata & metadata () const
 Gets the user-defined metadata for the blob. More...
 
const utility::string_t & snapshot_time () const
 Gets the date and time that the blob snapshot was taken, if this blob is a snapshot. More...
 
bool is_snapshot () const
 Gets a value indicating whether this blob is a snapshot. More...
 
void set_version_id (utility::string_t version_id)
 Sets the version id of this blob. More...
 
const utility::string_t & version_id () const
 Gets the version id of the blob, if this blob refers to a version. More...
 
const azure::storage::copy_statecopy_state () const
 Gets the state of the most recent or pending copy operation. More...
 
const storage_uriuri () const
 Gets the blob URI for all locations. More...
 
const utility::string_t & name () const
 Gets the blob's name. More...
 
blob_type type () const
 Gets the type of the blob. More...
 
bool is_valid () const
 Indicates whether the azure::storage::cloud_blob object is valid. More...
 

Detailed Description

Represents a blob that is uploaded as a set of blocks.

Constructor & Destructor Documentation

◆ cloud_block_blob() [1/5]

azure::storage::cloud_block_blob::cloud_block_blob ( )
inline

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

◆ cloud_block_blob() [2/5]

azure::storage::cloud_block_blob::cloud_block_blob ( storage_uri  uri)
inlineexplicit

Initializes a new instance of the azure::storage::cloud_block_blob class using an absolute URI to the blob.

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

◆ cloud_block_blob() [3/5]

azure::storage::cloud_block_blob::cloud_block_blob ( storage_uri  uri,
storage_credentials  credentials 
)
inline

Initializes a new instance of the azure::storage::cloud_block_blob class using an absolute URI to the blob.

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

◆ cloud_block_blob() [4/5]

azure::storage::cloud_block_blob::cloud_block_blob ( storage_uri  uri,
utility::string_t  snapshot_time,
storage_credentials  credentials 
)
inline

Initializes a new instance of the azure::storage::cloud_block_blob class using an absolute URI to the blob.

Parameters
uriAn azure::storage::storage_uri object containing the absolute URI to the blob for all locations.
snapshot_timeThe snapshot timestamp, if the blob is a snapshot.
credentialsThe azure::storage::storage_credentials to use.

◆ cloud_block_blob() [5/5]

azure::storage::cloud_block_blob::cloud_block_blob ( const cloud_blob blob)
inline

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

Parameters
blobReference to the blob.

Member Function Documentation

◆ download_block_list() [1/2]

std::vector<block_list_item> azure::storage::cloud_block_blob::download_block_list ( ) const
inline

Returns an enumerable collection of the blob's blocks, using the specified block list filter.

Returns
An enumerable collection of objects implementing azure::storage::block_list_item.

◆ download_block_list() [2/2]

std::vector<block_list_item> azure::storage::cloud_block_blob::download_block_list ( block_listing_filter  listing_filter,
const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Returns an enumerable collection of the blob's blocks, using the specified block list filter.

Parameters
listing_filterOne of the enumeration values that indicates whether to return committed blocks, uncommitted blocks, or both.
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
An enumerable collection of objects implementing azure::storage::block_list_item.

◆ download_block_list_async() [1/3]

pplx::task<std::vector<block_list_item> > azure::storage::cloud_block_blob::download_block_list_async ( ) const
inline

Initiates an asynchronous operation to return an enumerable collection of the blob's blocks, using the specified block list filter.

Returns
A pplx::task object of type std::vector, of type azure::storage::block_list_item, that represents the current operation.

◆ download_block_list_async() [2/3]

pplx::task<std::vector<block_list_item> > azure::storage::cloud_block_blob::download_block_list_async ( block_listing_filter  listing_filter,
const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Initiates an asynchronous operation to return an enumerable collection of the blob's blocks, using the specified block list filter.

Parameters
listing_filterOne of the enumeration values that indicates whether to return committed blocks, uncommitted blocks, or both.
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 std::vector, of type azure::storage::block_list_item, that represents the current operation.

◆ download_block_list_async() [3/3]

WASTORAGE_API pplx::task<std::vector<block_list_item> > azure::storage::cloud_block_blob::download_block_list_async ( block_listing_filter  listing_filter,
const access_condition condition,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
) const

Initiates an asynchronous operation to return an enumerable collection of the blob's blocks, using the specified block list filter.

Parameters
listing_filterOne of the enumeration values that indicates whether to return committed blocks, uncommitted blocks, or both.
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 std::vector, of type azure::storage::block_list_item, that represents the current operation.

◆ download_text() [1/2]

utility::string_t azure::storage::cloud_block_blob::download_text ( )
inline

Downloads the blob's contents as a string.

Returns
The contents of the blob, as a string.

◆ download_text() [2/2]

utility::string_t azure::storage::cloud_block_blob::download_text ( const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Downloads the blob's contents as a string.

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 contents of the blob, as a string.

◆ download_text_async() [1/3]

pplx::task<utility::string_t> azure::storage::cloud_block_blob::download_text_async ( )
inline

Initiates an asynchronous operation to download the blob's contents as a string.

Returns
A pplx::task object of type utility::string_t that represents the current operation.

◆ download_text_async() [2/3]

pplx::task<utility::string_t> azure::storage::cloud_block_blob::download_text_async ( const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to download the blob's contents as a string.

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 utility::string_t that represents the current operation.

◆ download_text_async() [3/3]

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

Initiates an asynchronous operation to download the blob's contents as a string.

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 utility::string_t that represents the current operation.

◆ open_write() [1/2]

concurrency::streams::ostream azure::storage::cloud_block_blob::open_write ( )
inline

Opens a stream for writing to the block blob. If the blob already exists on the service, it will be overwritten.

Returns
A stream to be used for writing to the blob.

◆ open_write() [2/2]

concurrency::streams::ostream azure::storage::cloud_block_blob::open_write ( const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Opens a stream for writing to the block blob. If the blob already exists on the service, it will be overwritten.

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 stream to be used for writing to the blob.

To avoid overwriting and instead throw an error if the blob exists, please pass in an azure::storage::access_condition parameter generated using azure::storage::access_condition::generate_if_not_exists_condition

◆ open_write_async() [1/3]

pplx::task<concurrency::streams::ostream> azure::storage::cloud_block_blob::open_write_async ( )
inline

Initiates an asynchronous operation to open a stream for writing to the block blob. If the blob already exists on the service, it will be overwritten.

Returns
A pplx::task object of type concurrency::streams::ostream that represents the current operation.

◆ open_write_async() [2/3]

pplx::task<concurrency::streams::ostream> azure::storage::cloud_block_blob::open_write_async ( const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to open a stream for writing to the block blob. If the blob already exists on the service, it will be overwritten.

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 concurrency::streams::ostream that represents the current operation.

To avoid overwriting and instead throw an error if the blob exists, please pass in an azure::storage::access_condition parameter generated using azure::storage::access_condition::generate_if_not_exists_condition

◆ open_write_async() [3/3]

pplx::task<concurrency::streams::ostream> azure::storage::cloud_block_blob::open_write_async ( const access_condition condition,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
)
inline

Initiates an asynchronous operation to open a stream for writing to the block blob. If the blob already exists on the service, it will be overwritten.

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 concurrency::streams::ostream that represents the current operation.

To avoid overwriting and instead throw an error if the blob exists, please pass in an azure::storage::access_condition parameter generated using azure::storage::access_condition::generate_if_not_exists_condition

◆ set_standard_blob_tier()

void azure::storage::cloud_block_blob::set_standard_blob_tier ( const standard_blob_tier  tier,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Sets standard account's blob tier.

Parameters
conditionAn azure::storage::standard_blob_tier enum that represents the blob tier to be set.
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.

◆ set_standard_blob_tier_async() [1/2]

pplx::task<void> azure::storage::cloud_block_blob::set_standard_blob_tier_async ( const standard_blob_tier  tier,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to set standard account's blob tier.

Parameters
conditionAn azure::storage::standard_blob_tier enum that represents the blob tier to be set.
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.

◆ set_standard_blob_tier_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_block_blob::set_standard_blob_tier_async ( const standard_blob_tier  tier,
const access_condition condition,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
)

Initiates an asynchronous operation to set standard account's blob tier.

Parameters
conditionAn azure::storage::standard_blob_tier enum that represents the blob tier to be set.
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.

◆ upload_block() [1/2]

void azure::storage::cloud_block_blob::upload_block ( const utility::string_t &  block_id,
concurrency::streams::istream  block_data,
const checksum content_checksum 
) const
inline

Uploads a single block.

Parameters
block_idA Base64-encoded block ID that identifies the block.
block_dataA stream that provides the data for the block.
content_checksumA hash value used to ensure transactional integrity. May be azure::storage::checksum_none or a base64-encoded MD5 string or CRC64 integer.

◆ upload_block() [2/2]

void azure::storage::cloud_block_blob::upload_block ( const utility::string_t &  block_id,
concurrency::streams::istream  block_data,
const checksum content_checksum,
const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Uploads a single block.

Parameters
block_idA Base64-encoded block ID that identifies the block.
block_dataA stream that provides the data for the block.
content_checksumA hash value used to ensure transactional integrity. May be azure::storage::checksum_none or a base64-encoded MD5 string or CRC64 integer.
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_block_async() [1/3]

pplx::task<void> azure::storage::cloud_block_blob::upload_block_async ( const utility::string_t &  block_id,
concurrency::streams::istream  block_data,
const checksum content_checksum 
) const
inline

Initiates an asynchronous operation to upload a single block.

Parameters
block_idA Base64-encoded block ID that identifies the block.
block_dataA stream that provides the data for the block.
content_checksumA hash value used to ensure transactional integrity. May be azure::storage::checksum_none or a base64-encoded MD5 string or CRC64 integer.
Returns
A pplx::task object that represents the current operation.

◆ upload_block_async() [2/3]

WASTORAGE_API pplx::task<void> azure::storage::cloud_block_blob::upload_block_async ( const utility::string_t &  block_id,
concurrency::streams::istream  block_data,
const checksum content_checksum,
const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Initiates an asynchronous operation to upload a single block.

Parameters
block_idA Base64-encoded block ID that identifies the block.
block_dataA stream that provides the data for the block.
content_checksumA hash value used to ensure transactional integrity. May be azure::storage::checksum_none or a base64-encoded MD5 string or CRC64 integer.
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_block_async() [3/3]

pplx::task<void> azure::storage::cloud_block_blob::upload_block_async ( const utility::string_t &  block_id,
concurrency::streams::istream  block_data,
const checksum content_checksum,
const access_condition condition,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
) const
inline

Initiates an asynchronous operation to upload a single block.

Parameters
block_idA Base64-encoded block ID that identifies the block.
block_dataA stream that provides the data for the block.
content_checksumA hash value used to ensure transactional integrity. May be azure::storage::checksum_none or a base64-encoded MD5 string or CRC64 integer.
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_block_list() [1/2]

void azure::storage::cloud_block_blob::upload_block_list ( const std::vector< block_list_item > &  block_list)
inline

Uploads a list of blocks to a new or existing blob.

Parameters
block_listAn enumerable collection of block IDs, as Base64-encoded strings.

◆ upload_block_list() [2/2]

void azure::storage::cloud_block_blob::upload_block_list ( const std::vector< block_list_item > &  block_list,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Uploads a list of blocks to a new or existing blob.

Parameters
block_listAn enumerable collection of block IDs, as Base64-encoded strings.
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_block_list_async() [1/3]

pplx::task<void> azure::storage::cloud_block_blob::upload_block_list_async ( const std::vector< block_list_item > &  block_list)
inline

Initiates an asynchronous operation to upload a list of blocks to a new or existing blob.

Parameters
block_listAn enumerable collection of block IDs, as Base64-encoded strings.
Returns
A pplx::task object that represents the current operation.

◆ upload_block_list_async() [2/3]

pplx::task<void> azure::storage::cloud_block_blob::upload_block_list_async ( const std::vector< block_list_item > &  block_list,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to upload a list of blocks to a new or existing blob.

Parameters
block_listAn enumerable collection of block IDs, as Base64-encoded strings.
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_block_list_async() [3/3]

pplx::task<void> azure::storage::cloud_block_blob::upload_block_list_async ( const std::vector< block_list_item > &  block_list,
const access_condition condition,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
)
inline

Initiates an asynchronous operation to upload a list of blocks to a new or existing blob.

Parameters
block_listAn enumerable collection of block IDs, as Base64-encoded strings.
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_from_file() [1/2]

void azure::storage::cloud_block_blob::upload_from_file ( const utility::string_t &  path)
inline

Uploads a file to a block blob. If the blob already exists on the service, it will be overwritten.

Parameters
pathThe file providing the blob content.

◆ upload_from_file() [2/2]

void azure::storage::cloud_block_blob::upload_from_file ( const utility::string_t &  path,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Uploads a file to a block blob. If the blob already exists on the service, it will be overwritten.

Parameters
pathThe file providing the blob content.
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_from_file_async() [1/3]

pplx::task<void> azure::storage::cloud_block_blob::upload_from_file_async ( const utility::string_t &  path)
inline

Initiates an asynchronous operation to upload a file to a block blob. If the blob already exists on the service, it will be overwritten.

Parameters
pathThe file providing the blob content.
Returns
A pplx::task object that represents the current operation.

◆ upload_from_file_async() [2/3]

pplx::task<void> azure::storage::cloud_block_blob::upload_from_file_async ( const utility::string_t &  path,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to upload a file to a block blob. If the blob already exists on the service, it will be overwritten.

Parameters
pathThe file providing the blob content.
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_from_file_async() [3/3]

WASTORAGE_API pplx::task<void> azure::storage::cloud_block_blob::upload_from_file_async ( const utility::string_t &  path,
const access_condition condition,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
)

Initiates an asynchronous operation to upload a file to a block blob. If the blob already exists on the service, it will be overwritten.

Parameters
pathThe file providing the blob content.
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_from_stream() [1/4]

void azure::storage::cloud_block_blob::upload_from_stream ( concurrency::streams::istream  source)
inline

Uploads a stream to a block blob. If the blob already exists on the service, it will be overwritten.

Parameters
sourceThe stream providing the blob content.

◆ upload_from_stream() [2/4]

void azure::storage::cloud_block_blob::upload_from_stream ( concurrency::streams::istream  source,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Uploads a stream to a block blob. If the blob already exists on the service, it will be overwritten.

Parameters
sourceThe stream providing the blob content.
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_from_stream() [3/4]

void azure::storage::cloud_block_blob::upload_from_stream ( concurrency::streams::istream  source,
utility::size64_t  length 
)
inline

Uploads a stream to a block blob. If the blob already exists on the service, it will be overwritten.

Parameters
sourceThe stream providing the blob content.
lengthThe number of bytes to write from the source stream at its current position.

◆ upload_from_stream() [4/4]

void azure::storage::cloud_block_blob::upload_from_stream ( concurrency::streams::istream  source,
utility::size64_t  length,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Uploads a stream to a block blob. If the blob already exists on the service, it will be overwritten.

Parameters
sourceThe stream providing the blob content.
lengthThe number of bytes to write from the source stream at its current position.
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_from_stream_async() [1/5]

pplx::task<void> azure::storage::cloud_block_blob::upload_from_stream_async ( concurrency::streams::istream  source)
inline

Initiates an asynchronous operation to upload a stream to a block blob. If the blob already exists on the service, it will be overwritten.

Parameters
sourceThe stream providing the blob content.
Returns
A pplx::task object that represents the current operation.

◆ upload_from_stream_async() [2/5]

pplx::task<void> azure::storage::cloud_block_blob::upload_from_stream_async ( concurrency::streams::istream  source,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to upload a stream to a block blob. If the blob already exists on the service, it will be overwritten.

Parameters
sourceThe stream providing the blob content.
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_from_stream_async() [3/5]

pplx::task<void> azure::storage::cloud_block_blob::upload_from_stream_async ( concurrency::streams::istream  source,
utility::size64_t  length 
)
inline

Initiates an asynchronous operation to upload a stream to a block blob. If the blob already exists on the service, it will be overwritten.

Parameters
sourceThe stream providing the blob content.
lengthThe number of bytes to write from the source stream at its current position.
Returns
A pplx::task object that represents the current operation.

◆ upload_from_stream_async() [4/5]

pplx::task<void> azure::storage::cloud_block_blob::upload_from_stream_async ( concurrency::streams::istream  source,
utility::size64_t  length,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to upload a stream to a block blob. If the blob already exists on the service, it will be overwritten.

Parameters
sourceThe stream providing the blob content.
lengthThe number of bytes to write from the source stream at its current position.
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_from_stream_async() [5/5]

WASTORAGE_API pplx::task<void> azure::storage::cloud_block_blob::upload_from_stream_async ( concurrency::streams::istream  source,
utility::size64_t  length,
const access_condition condition,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
)

Initiates an asynchronous operation to upload a stream to a block blob. If the blob already exists on the service, it will be overwritten.

Parameters
sourceThe stream providing the blob content.
lengthThe number of bytes to write from the source stream at its current position.
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_text() [1/2]

void azure::storage::cloud_block_blob::upload_text ( const utility::string_t &  content)
inline

Uploads a string of text to a blob. If the blob already exists on the service, it will be overwritten.

Parameters
contentA string containing the text to upload.

◆ upload_text() [2/2]

void azure::storage::cloud_block_blob::upload_text ( const utility::string_t &  content,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Uploads a string of text to a blob. If the blob already exists on the service, it will be overwritten.

Parameters
contentA string containing the text to upload.
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_text_async() [1/3]

pplx::task<void> azure::storage::cloud_block_blob::upload_text_async ( const utility::string_t &  content)
inline

Uploads a string of text to a blob. If the blob already exists on the service, it will be overwritten.

Parameters
contentA string containing the text to upload.
Returns
A pplx::task object that represents the current operation.

◆ upload_text_async() [2/3]

pplx::task<void> azure::storage::cloud_block_blob::upload_text_async ( const utility::string_t &  content,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Uploads a string of text to a blob. If the blob already exists on the service, it will be overwritten.

Parameters
contentA string containing the text to upload.
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_text_async() [3/3]

WASTORAGE_API pplx::task<void> azure::storage::cloud_block_blob::upload_text_async ( const utility::string_t &  content,
const access_condition condition,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
)

Uploads a string of text to a blob. If the blob already exists on the service, it will be overwritten.

Parameters
contentA string containing the text to upload.
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.