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

Represents a Windows Azure page blob. More...

Inheritance diagram for azure::storage::cloud_page_blob:
azure::storage::cloud_blob

Public Member Functions

 cloud_page_blob ()
 Initializes a new instance of the azure::storage::cloud_page_blob class. More...
 
 cloud_page_blob (storage_uri uri)
 Initializes a new instance of the azure::storage::cloud_page_blob class using an absolute URI to the blob. More...
 
 cloud_page_blob (storage_uri uri, storage_credentials credentials)
 Initializes a new instance of the azure::storage::cloud_page_blob class using an absolute URI to the blob. More...
 
 cloud_page_blob (storage_uri uri, utility::string_t snapshot_time, storage_credentials credentials)
 Initializes a new instance of the azure::storage::cloud_page_blob class using an absolute URI to the blob. More...
 
 cloud_page_blob (const cloud_blob &blob)
 Initializes a new instance of the azure::storage::cloud_page_blob class. More...
 
concurrency::streams::ostream open_write ()
 Opens a stream for writing to an existing page blob. More...
 
concurrency::streams::ostream open_write (const access_condition &condition, const blob_request_options &options, operation_context context)
 Opens a stream for writing to an existing page blob. More...
 
concurrency::streams::ostream open_write (utility::size64_t size)
 Opens a stream for writing to a new page blob. More...
 
concurrency::streams::ostream open_write (utility::size64_t size, int64_t sequence_number, const access_condition &condition, const blob_request_options &options, operation_context context)
 Opens a stream for writing to a new page blob. More...
 
pplx::task< concurrency::streams::ostream > open_write_async ()
 Initiates an asynchronous operation to open a stream for writing to an existing page blob. 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 an existing page blob. More...
 
WASTORAGE_API 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 an existing page blob. More...
 
pplx::task< concurrency::streams::ostream > open_write_async (utility::size64_t size)
 Initiates an asynchronous operation to open a stream for writing to a new page blob. More...
 
pplx::task< concurrency::streams::ostream > open_write_async (utility::size64_t size, int64_t sequence_number, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to open a stream for writing to a new page blob. More...
 
pplx::task< concurrency::streams::ostream > open_write_async (utility::size64_t size, int64_t sequence_number, 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 a new page blob. More...
 
void clear_pages (int64_t start_offset, int64_t length)
 Clears pages from a page blob. More...
 
void clear_pages (int64_t start_offset, int64_t length, const access_condition &condition, const blob_request_options &options, operation_context context)
 Clears pages from a page blob. More...
 
pplx::task< void > clear_pages_async (int64_t start_offset, int64_t length)
 Initiates an asynchronous operation to clear pages from a page blob. More...
 
pplx::task< void > clear_pages_async (int64_t start_offset, int64_t length, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to clear pages from a page blob. More...
 
WASTORAGE_API pplx::task< void > clear_pages_async (int64_t start_offset, int64_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 clear pages from a page blob. More...
 
std::vector< page_rangedownload_page_ranges () const
 Gets a collection of valid page ranges and their starting and ending bytes. More...
 
std::vector< page_rangedownload_page_ranges (const access_condition &condition, const blob_request_options &options, operation_context context) const
 Gets a collection of valid page ranges and their starting and ending bytes. More...
 
std::vector< page_rangedownload_page_ranges (utility::size64_t offset, utility::size64_t length) const
 Gets a collection of valid page ranges and their starting and ending bytes. More...
 
std::vector< page_rangedownload_page_ranges (utility::size64_t offset, utility::size64_t length, const access_condition &condition, const blob_request_options &options, operation_context context) const
 Gets a collection of valid page ranges and their starting and ending bytes. More...
 
pplx::task< std::vector< page_range > > download_page_ranges_async () const
 Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes. More...
 
pplx::task< std::vector< page_range > > download_page_ranges_async (const access_condition &condition, const blob_request_options &options, operation_context context) const
 Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes. More...
 
pplx::task< std::vector< page_range > > download_page_ranges_async (utility::size64_t offset, utility::size64_t length) const
 Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes. More...
 
pplx::task< std::vector< page_range > > download_page_ranges_async (utility::size64_t offset, utility::size64_t length, const access_condition &condition, const blob_request_options &options, operation_context context) const
 Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes. More...
 
WASTORAGE_API pplx::task< std::vector< page_range > > download_page_ranges_async (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) const
 Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes. More...
 
std::vector< page_diff_rangedownload_page_ranges_diff (const utility::string_t &previous_snapshot_time) const
 Gets a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot. More...
 
std::vector< page_diff_rangedownload_page_ranges_diff (const utility::string_t &previous_snapshot_time, const access_condition &condition, const blob_request_options &options, operation_context context) const
 Gets a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot. More...
 
std::vector< page_diff_rangedownload_page_ranges_diff (const utility::string_t &previous_snapshot_time, utility::size64_t offset, utility::size64_t length) const
 Gets a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot. More...
 
std::vector< page_diff_rangedownload_page_ranges_diff (const utility::string_t &previous_snapshot_time, utility::size64_t offset, utility::size64_t length, const access_condition &condition, const blob_request_options &options, operation_context context) const
 Gets a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot. More...
 
pplx::task< std::vector< page_diff_range > > download_page_ranges_diff_async (const utility::string_t &previous_snapshot_time) const
 Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot. More...
 
pplx::task< std::vector< page_diff_range > > download_page_ranges_diff_async (const utility::string_t &previous_snapshot_time, const access_condition &condition, const blob_request_options &options, operation_context context) const
 Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot. More...
 
pplx::task< std::vector< page_diff_range > > download_page_ranges_diff_async (const utility::string_t &previous_snapshot_time, utility::size64_t offset, utility::size64_t length) const
 Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot. More...
 
pplx::task< std::vector< page_diff_range > > download_page_ranges_diff_async (const utility::string_t &previous_snapshot_time, utility::size64_t offset, utility::size64_t length, const access_condition &condition, const blob_request_options &options, operation_context context) const
 Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot. More...
 
pplx::task< std::vector< page_diff_range > > download_page_ranges_diff_async (const utility::string_t &previous_snapshot_time, 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) const
 Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot. More...
 
std::vector< page_diff_rangedownload_page_ranges_diff_md (const utility::string_t &previous_snapshot_url) const
 Gets a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot. More...
 
std::vector< page_diff_rangedownload_page_ranges_diff_md (const utility::string_t &previous_snapshot_url, const access_condition &condition, const blob_request_options &options, operation_context context) const
 Gets a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot. More...
 
std::vector< page_diff_rangedownload_page_ranges_diff_md (const utility::string_t &previous_snapshot_url, utility::size64_t offset, utility::size64_t length) const
 Gets a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot. More...
 
std::vector< page_diff_rangedownload_page_ranges_diff_md (const utility::string_t &previous_snapshot_url, utility::size64_t offset, utility::size64_t length, const access_condition &condition, const blob_request_options &options, operation_context context) const
 Gets a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot. More...
 
pplx::task< std::vector< page_diff_range > > download_page_ranges_diff_md_async (const utility::string_t &previous_snapshot_url) const
 Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot. More...
 
pplx::task< std::vector< page_diff_range > > download_page_ranges_diff_md_async (const utility::string_t &previous_snapshot_url, const access_condition &condition, const blob_request_options &options, operation_context context) const
 Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot. More...
 
pplx::task< std::vector< page_diff_range > > download_page_ranges_diff_md_async (const utility::string_t &previous_snapshot_url, utility::size64_t offset, utility::size64_t length) const
 Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot. More...
 
pplx::task< std::vector< page_diff_range > > download_page_ranges_diff_md_async (const utility::string_t &previous_snapshot_url, utility::size64_t offset, utility::size64_t length, const access_condition &condition, const blob_request_options &options, operation_context context) const
 Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot. More...
 
pplx::task< std::vector< page_diff_range > > download_page_ranges_diff_md_async (const utility::string_t &previous_snapshot_url, 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) const
 Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot. More...
 
void upload_pages (concurrency::streams::istream page_data, int64_t start_offset, const checksum &content_checksum)
 Writes pages to a page blob. More...
 
void upload_pages (concurrency::streams::istream page_data, int64_t start_offset, const checksum &content_checksum, const access_condition &condition, const blob_request_options &options, operation_context context)
 Writes pages to a page blob. More...
 
pplx::task< void > upload_pages_async (concurrency::streams::istream source, int64_t start_offset, const checksum &content_checksum)
 Initiates an asynchronous operation to write pages to a page blob. More...
 
pplx::task< void > upload_pages_async (concurrency::streams::istream source, int64_t start_offset, const checksum &content_checksum, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to write pages to a page blob. More...
 
pplx::task< void > upload_pages_async (concurrency::streams::istream source, int64_t start_offset, const checksum &content_checksum, const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to write pages to a page blob. More...
 
void upload_from_stream (concurrency::streams::istream source)
 Uploads a stream to a page blob. If the blob already exists on the service, it will be overwritten. More...
 
void upload_from_stream (concurrency::streams::istream source, int64_t sequence_number, const access_condition &condition, const blob_request_options &options, operation_context context)
 Uploads a stream to a page 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 page 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, int64_t sequence_number, const access_condition &condition, const blob_request_options &options, operation_context context)
 Uploads a stream to a page 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 page 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, int64_t sequence_number, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to upload a stream to a page 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 page 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, int64_t sequence_number, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to upload a stream to a page 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, int64_t sequence_number, 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 page 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 page blob. If the blob already exists on the service, it will be overwritten. More...
 
void upload_from_file (const utility::string_t &path, int64_t sequence_number, const access_condition &condition, const blob_request_options &options, operation_context context)
 Uploads a file to a page 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 page 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, int64_t sequence_number, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to upload a file to a page 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, int64_t sequence_number, 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 page blob. If the blob already exists on the service, it will be overwritten. More...
 
void create (utility::size64_t size)
 Creates a page blob. More...
 
void create (utility::size64_t size, int64_t sequence_number, const access_condition &condition, const blob_request_options &options, operation_context context)
 Creates a page blob. More...
 
void create (utility::size64_t size, const premium_blob_tier tier, int64_t sequence_number, const access_condition &condition, const blob_request_options &options, operation_context context)
 Creates a page blob. More...
 
pplx::task< void > create_async (utility::size64_t size)
 Initiates an asynchronous operation to create a page blob. More...
 
pplx::task< void > create_async (utility::size64_t size, int64_t sequence_number, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to create a page blob. More...
 
pplx::task< void > create_async (utility::size64_t size, const premium_blob_tier tier, int64_t sequence_number, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to create a page blob. More...
 
WASTORAGE_API pplx::task< void > create_async (utility::size64_t size, const premium_blob_tier tier, int64_t sequence_number, 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 page blob. More...
 
void resize (utility::size64_t size)
 Resizes the page blob to the specified size. More...
 
void resize (utility::size64_t size, const access_condition &condition, const blob_request_options &options, operation_context context)
 Resizes the page blob to the specified size. More...
 
pplx::task< void > resize_async (utility::size64_t size)
 Initiates an asynchronous operation to resize the page blob to the specified size. More...
 
pplx::task< void > resize_async (utility::size64_t size, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to resize the page blob to the specified size. More...
 
WASTORAGE_API pplx::task< void > resize_async (utility::size64_t size, const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to resize the page blob to the specified size. More...
 
void set_sequence_number (const azure::storage::sequence_number &sequence_number)
 Sets the page blob's sequence number. More...
 
void set_sequence_number (const azure::storage::sequence_number &sequence_number, const access_condition &condition, const blob_request_options &options, operation_context context)
 Sets the page blob's sequence number. More...
 
pplx::task< void > set_sequence_number_async (const azure::storage::sequence_number &sequence_number)
 Initiates an asynchronous operation to set the page blob's sequence number. More...
 
pplx::task< void > set_sequence_number_async (const azure::storage::sequence_number &sequence_number, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to set the page blob's sequence number. More...
 
WASTORAGE_API pplx::task< void > set_sequence_number_async (const azure::storage::sequence_number &sequence_number, 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 page blob's sequence number. More...
 
utility::string_t start_incremental_copy (const cloud_page_blob &source)
 Begin to copy a snapshot of the source page blob and metadata to a destination page blob. More...
 
utility::string_t start_incremental_copy (const web::http::uri &source)
 Begin to copy a snapshot of the source page blob and metadata to a destination page blob. More...
 
utility::string_t start_incremental_copy (const cloud_page_blob &source, const access_condition &condition, const blob_request_options &options, operation_context context)
 Begin to copy a snapshot of the source page blob and metadata to a destination page blob. More...
 
utility::string_t start_incremental_copy (const web::http::uri &source, const access_condition &condition, const blob_request_options &options, operation_context context)
 Begin to copy a snapshot of the source page blob and metadata to a destination page blob. More...
 
pplx::task< utility::string_t > start_incremental_copy_async (const cloud_page_blob &source)
 Initiates an asynchronous operation to begin to copy a snapshot of the source page blob and metadata to a destination page blob. More...
 
pplx::task< utility::string_t > start_incremental_copy_async (const web::http::uri &source)
 Initiates an asynchronous operation to begin to copy a snapshot of the source page blob and metadata to a destination page blob. More...
 
pplx::task< utility::string_t > start_incremental_copy_async (const cloud_page_blob &source, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to begin to copy a snapshot of the source page blob and metadata to a destination page blob. More...
 
WASTORAGE_API pplx::task< utility::string_t > start_incremental_copy_async (const cloud_page_blob &source, const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to begin to copy a snapshot of the source page blob and metadata to a destination page blob. More...
 
pplx::task< utility::string_t > start_incremental_copy_async (const web::http::uri &source, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to begin to copy a snapshot of the source page blob and metadata to a destination page blob. More...
 
WASTORAGE_API pplx::task< utility::string_t > start_incremental_copy_async (const web::http::uri &source, const access_condition &condition, const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token)
 Initiates an asynchronous operation to begin to copy a snapshot of the source page blob and metadata to a destination page blob. More...
 
void set_premium_blob_tier (const premium_blob_tier tier, const access_condition &condition, const blob_request_options &options, operation_context context)
 Sets premium account's page blob tier. More...
 
pplx::task< void > set_premium_blob_tier_async (const premium_blob_tier tier, const access_condition &condition, const blob_request_options &options, operation_context context)
 Initiates an asynchronous operation to set premium account's blob tier. More...
 
WASTORAGE_API pplx::task< void > set_premium_blob_tier_async (const premium_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 premium account's blob tier. More...
 
utility::string_t start_copy (const web::http::uri &source, const azure::storage::premium_blob_tier tier, 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 azure::storage::premium_blob_tier tier, 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...
 
pplx::task< utility::string_t > start_copy_async (const web::http::uri &source, const premium_blob_tier tier, 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 premium_blob_tier tier, 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 premium_blob_tier tier, 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...
 
- 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 Windows Azure page blob.

Constructor & Destructor Documentation

◆ cloud_page_blob() [1/5]

azure::storage::cloud_page_blob::cloud_page_blob ( )
inline

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

◆ cloud_page_blob() [2/5]

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

Initializes a new instance of the azure::storage::cloud_page_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_page_blob() [3/5]

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

Initializes a new instance of the azure::storage::cloud_page_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_page_blob() [4/5]

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

Initializes a new instance of the azure::storage::cloud_page_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_page_blob() [5/5]

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

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

Parameters
blobReference to the blob.

Member Function Documentation

◆ clear_pages() [1/2]

void azure::storage::cloud_page_blob::clear_pages ( int64_t  start_offset,
int64_t  length 
)
inline

Clears pages from a page blob.

Parameters
start_offsetThe offset at which to begin clearing pages, in bytes. The offset must be a multiple of 512.
lengthThe length of the data range to be cleared, in bytes. The length must be a multiple of 512.

◆ clear_pages() [2/2]

void azure::storage::cloud_page_blob::clear_pages ( int64_t  start_offset,
int64_t  length,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Clears pages from a page blob.

Parameters
start_offsetThe offset at which to begin clearing pages, in bytes. The offset must be a multiple of 512.
lengthThe length of the data range to be cleared, in bytes. The length must be a multiple of 512.
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.

◆ clear_pages_async() [1/3]

pplx::task<void> azure::storage::cloud_page_blob::clear_pages_async ( int64_t  start_offset,
int64_t  length 
)
inline

Initiates an asynchronous operation to clear pages from a page blob.

Parameters
start_offsetThe offset at which to begin clearing pages, in bytes. The offset must be a multiple of 512.
lengthThe length of the data range to be cleared, in bytes. The length must be a multiple of 512.
Returns
A pplx::task object that represents the current operation.

◆ clear_pages_async() [2/3]

pplx::task<void> azure::storage::cloud_page_blob::clear_pages_async ( int64_t  start_offset,
int64_t  length,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to clear pages from a page blob.

Parameters
start_offsetThe offset at which to begin clearing pages, in bytes. The offset must be a multiple of 512.
lengthThe length of the data range to be cleared, in bytes. The length must be a multiple of 512.
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.

◆ clear_pages_async() [3/3]

WASTORAGE_API pplx::task<void> azure::storage::cloud_page_blob::clear_pages_async ( int64_t  start_offset,
int64_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 clear pages from a page blob.

Parameters
start_offsetThe offset at which to begin clearing pages, in bytes. The offset must be a multiple of 512.
lengthThe length of the data range to be cleared, in bytes. The length must be a multiple of 512.
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.

◆ create() [1/3]

void azure::storage::cloud_page_blob::create ( utility::size64_t  size)
inline

Creates a page blob.

Parameters
sizeThe maximum size of the page blob, in bytes.

◆ create() [2/3]

void azure::storage::cloud_page_blob::create ( utility::size64_t  size,
int64_t  sequence_number,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Creates a page blob.

Parameters
sizeThe maximum size of the page blob, in bytes.
sequence_numberA user-controlled number to track request sequence, whose value must be between 0 and 2^63 - 1.
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.

◆ create() [3/3]

void azure::storage::cloud_page_blob::create ( utility::size64_t  size,
const premium_blob_tier  tier,
int64_t  sequence_number,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Creates a page blob.

Parameters
sizeThe maximum size of the page blob, in bytes.
tierA azure::storage::premium_blob_tier enum that represents the tier of the page blob to be created.
sequence_numberA user-controlled number to track request sequence, whose value must be between 0 and 2^63 - 1.
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.

◆ create_async() [1/4]

pplx::task<void> azure::storage::cloud_page_blob::create_async ( utility::size64_t  size)
inline

Initiates an asynchronous operation to create a page blob.

Parameters
sizeThe maximum size of the page blob, in bytes.
Returns
A pplx::task object that represents the current operation.

◆ create_async() [2/4]

pplx::task<void> azure::storage::cloud_page_blob::create_async ( utility::size64_t  size,
int64_t  sequence_number,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to create a page blob.

Parameters
sizeThe maximum size of the page blob, in bytes.
sequence_numberA user-controlled number to track request sequence, whose value must be between 0 and 2^63 - 1.
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.

◆ create_async() [3/4]

pplx::task<void> azure::storage::cloud_page_blob::create_async ( utility::size64_t  size,
const premium_blob_tier  tier,
int64_t  sequence_number,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to create a page blob.

Parameters
sizeThe maximum size of the page blob, in bytes.
tierA azure::storage::premium_blob_tier object that represents the tier of the page blob to be created.
sequence_numberA user-controlled number to track request sequence, whose value must be between 0 and 2^63 - 1.
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.

◆ create_async() [4/4]

WASTORAGE_API pplx::task<void> azure::storage::cloud_page_blob::create_async ( utility::size64_t  size,
const premium_blob_tier  tier,
int64_t  sequence_number,
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 page blob.

Parameters
sizeThe maximum size of the page blob, in bytes.
tierA azure::storage::premium_blob_tier object that represents the tier of the page blob to be created.
sequence_numberA user-controlled number to track request sequence, whose value must be between 0 and 2^63 - 1.
conditionAn azure::storage::access_condition object that represents the access condition for the operation.
optionsAn azure::storage::blob_request_options object that specifies additional options for the request.
contextAn azure::storage::operation_context object that represents the context for the current operation.
cancellation_tokenAn pplx::cancellation_token object that is used to cancel the current operation.
Returns
A pplx::task object that represents the current operation.

◆ download_page_ranges() [1/4]

std::vector<page_range> azure::storage::cloud_page_blob::download_page_ranges ( ) const
inline

Gets a collection of valid page ranges and their starting and ending bytes.

Returns
An enumerable collection of page ranges.

◆ download_page_ranges() [2/4]

std::vector<page_range> azure::storage::cloud_page_blob::download_page_ranges ( const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Gets a collection of valid page ranges and their starting and ending bytes.

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
An enumerable collection of page ranges.

◆ download_page_ranges() [3/4]

std::vector<page_range> azure::storage::cloud_page_blob::download_page_ranges ( utility::size64_t  offset,
utility::size64_t  length 
) const
inline

Gets a collection of valid page ranges and their starting and ending bytes.

Parameters
offsetThe starting offset of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
lengthThe length of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
Returns
An enumerable collection of page ranges.

◆ download_page_ranges() [4/4]

std::vector<page_range> azure::storage::cloud_page_blob::download_page_ranges ( utility::size64_t  offset,
utility::size64_t  length,
const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Gets a collection of valid page ranges and their starting and ending bytes.

Parameters
offsetThe starting offset of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
lengthThe length of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
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 page ranges.

◆ download_page_ranges_async() [1/5]

pplx::task<std::vector<page_range> > azure::storage::cloud_page_blob::download_page_ranges_async ( ) const
inline

Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes.

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

◆ download_page_ranges_async() [2/5]

pplx::task<std::vector<page_range> > azure::storage::cloud_page_blob::download_page_ranges_async ( const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes.

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 std::vector, of type azure::storage::page_range, that represents the current operation.

◆ download_page_ranges_async() [3/5]

pplx::task<std::vector<page_range> > azure::storage::cloud_page_blob::download_page_ranges_async ( utility::size64_t  offset,
utility::size64_t  length 
) const
inline

Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes.

Parameters
offsetThe starting offset of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
lengthThe length of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
Returns
A pplx::task object of type std::vector, of type azure::storage::page_range, that represents the current operation.

◆ download_page_ranges_async() [4/5]

pplx::task<std::vector<page_range> > azure::storage::cloud_page_blob::download_page_ranges_async ( utility::size64_t  offset,
utility::size64_t  length,
const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes.

Parameters
offsetThe starting offset of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
lengthThe length of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
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::page_range, that represents the current operation.

◆ download_page_ranges_async() [5/5]

WASTORAGE_API pplx::task<std::vector<page_range> > azure::storage::cloud_page_blob::download_page_ranges_async ( 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 
) const

Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes.

Parameters
offsetThe starting offset of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
lengthThe length of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
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::page_range, that represents the current operation.

◆ download_page_ranges_diff() [1/4]

std::vector<page_diff_range> azure::storage::cloud_page_blob::download_page_ranges_diff ( const utility::string_t &  previous_snapshot_time) const
inline

Gets a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot.

Parameters
previous_snapshot_timeA snapshot time string that represents previous snapshot.
Returns
An enumerable collection of page diff ranges.

◆ download_page_ranges_diff() [2/4]

std::vector<page_diff_range> azure::storage::cloud_page_blob::download_page_ranges_diff ( const utility::string_t &  previous_snapshot_time,
const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Gets a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot.

Parameters
previous_snapshot_timeA snapshot time string that represents previous snapshot.
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 page diff ranges.

◆ download_page_ranges_diff() [3/4]

std::vector<page_diff_range> azure::storage::cloud_page_blob::download_page_ranges_diff ( const utility::string_t &  previous_snapshot_time,
utility::size64_t  offset,
utility::size64_t  length 
) const
inline

Gets a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot.

Parameters
previous_snapshot_timeA snapshot time string that represents previous snapshot.
offsetThe starting offset of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
lengthThe length of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
Returns
An enumerable collection of page diff ranges.

◆ download_page_ranges_diff() [4/4]

std::vector<page_diff_range> azure::storage::cloud_page_blob::download_page_ranges_diff ( const utility::string_t &  previous_snapshot_time,
utility::size64_t  offset,
utility::size64_t  length,
const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Gets a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot.

Parameters
previous_snapshot_timeA snapshot time string that represents previous snapshot.
offsetThe starting offset of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
lengthThe length of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
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 page diff ranges.

◆ download_page_ranges_diff_async() [1/5]

pplx::task<std::vector<page_diff_range> > azure::storage::cloud_page_blob::download_page_ranges_diff_async ( const utility::string_t &  previous_snapshot_time) const
inline

Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot.

Parameters
previous_snapshot_timeA snapshot time string that represents previous snapshot.
Returns
A pplx::task object of type std::vector, of type azure::storage::page_diff_range, that represents the current operation.

◆ download_page_ranges_diff_async() [2/5]

pplx::task<std::vector<page_diff_range> > azure::storage::cloud_page_blob::download_page_ranges_diff_async ( const utility::string_t &  previous_snapshot_time,
const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot.

Parameters
previous_snapshot_timeA snapshot time string that represents previous snapshot.
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::page_diff_range, that represents the current operation.

◆ download_page_ranges_diff_async() [3/5]

pplx::task<std::vector<page_diff_range> > azure::storage::cloud_page_blob::download_page_ranges_diff_async ( const utility::string_t &  previous_snapshot_time,
utility::size64_t  offset,
utility::size64_t  length 
) const
inline

Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot.

Parameters
previous_snapshot_timeA snapshot time string that represents previous snapshot.
offsetThe starting offset of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
lengthThe length of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
Returns
A pplx::task object of type std::vector, of type azure::storage::page_diff_range, that represents the current operation.

◆ download_page_ranges_diff_async() [4/5]

pplx::task<std::vector<page_diff_range> > azure::storage::cloud_page_blob::download_page_ranges_diff_async ( const utility::string_t &  previous_snapshot_time,
utility::size64_t  offset,
utility::size64_t  length,
const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot.

Parameters
previous_snapshot_timeA snapshot time string that represents previous snapshot.
offsetThe starting offset of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
lengthThe length of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
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::page_diff_range, that represents the current operation.

◆ download_page_ranges_diff_async() [5/5]

pplx::task<std::vector<page_diff_range> > azure::storage::cloud_page_blob::download_page_ranges_diff_async ( const utility::string_t &  previous_snapshot_time,
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 
) const
inline

Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot.

Parameters
previous_snapshot_timeA snapshot time string that represents previous snapshot.
offsetThe starting offset of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
lengthThe length of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
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::page_diff_range, that represents the current operation.

◆ download_page_ranges_diff_md() [1/4]

std::vector<page_diff_range> azure::storage::cloud_page_blob::download_page_ranges_diff_md ( const utility::string_t &  previous_snapshot_url) const
inline

Gets a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot.

Parameters
previous_snapshot_urlA snapshot URL string that represents the previous snapshot. that represents previous snapshot.
Returns
An enumerable collection of page diff ranges.

This API can be only called against the incremental snapshots of Managed Disks that belong to the same snapshot family. Please browse following URI for more information: https://aka.ms/mdincrementalsnapshots

◆ download_page_ranges_diff_md() [2/4]

std::vector<page_diff_range> azure::storage::cloud_page_blob::download_page_ranges_diff_md ( const utility::string_t &  previous_snapshot_url,
const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Gets a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot.

Parameters
previous_snapshot_urlA snapshot URL string that represents the previous snapshot. that represents previous snapshot.
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 page diff ranges.

This API can be only called against the incremental snapshots of Managed Disks that belong to the same snapshot family. Please browse following URI for more information: https://aka.ms/mdincrementalsnapshots

◆ download_page_ranges_diff_md() [3/4]

std::vector<page_diff_range> azure::storage::cloud_page_blob::download_page_ranges_diff_md ( const utility::string_t &  previous_snapshot_url,
utility::size64_t  offset,
utility::size64_t  length 
) const
inline

Gets a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot.

Parameters
previous_snapshot_urlA snapshot URL string that represents the previous snapshot. that represents previous snapshot.
offsetThe starting offset of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
lengthThe length of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
Returns
An enumerable collection of page diff ranges.

This API can be only called against the incremental snapshots of Managed Disks that belong to the same snapshot family. Please browse following URI for more information: https://aka.ms/mdincrementalsnapshots

◆ download_page_ranges_diff_md() [4/4]

std::vector<page_diff_range> azure::storage::cloud_page_blob::download_page_ranges_diff_md ( const utility::string_t &  previous_snapshot_url,
utility::size64_t  offset,
utility::size64_t  length,
const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Gets a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot.

Parameters
previous_snapshot_urlA snapshot URL string that represents the previous snapshot. that represents previous snapshot.
offsetThe starting offset of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
lengthThe length of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
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 page diff ranges.

This API can be only called against the incremental snapshots of Managed Disks that belong to the same snapshot family. Please browse following URI for more information: https://aka.ms/mdincrementalsnapshots

◆ download_page_ranges_diff_md_async() [1/5]

pplx::task<std::vector<page_diff_range> > azure::storage::cloud_page_blob::download_page_ranges_diff_md_async ( const utility::string_t &  previous_snapshot_url) const
inline

Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot.

Parameters
previous_snapshot_urlA snapshot URL string that represents the previous snapshot. that represents previous snapshot.
Returns
A pplx::task object of type std::vector, of type azure::storage::page_diff_range, that represents the current operation.

This API can be only called against the incremental snapshots of Managed Disks that belong to the same snapshot family. Please browse following URI for more information: https://aka.ms/mdincrementalsnapshots

◆ download_page_ranges_diff_md_async() [2/5]

pplx::task<std::vector<page_diff_range> > azure::storage::cloud_page_blob::download_page_ranges_diff_md_async ( const utility::string_t &  previous_snapshot_url,
const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot.

Parameters
previous_snapshot_urlA snapshot URL string that represents the previous snapshot. that represents previous snapshot.
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::page_diff_range, that represents the current operation.

This API can be only called against the incremental snapshots of Managed Disks that belong to the same snapshot family. Please browse following URI for more information: https://aka.ms/mdincrementalsnapshots

◆ download_page_ranges_diff_md_async() [3/5]

pplx::task<std::vector<page_diff_range> > azure::storage::cloud_page_blob::download_page_ranges_diff_md_async ( const utility::string_t &  previous_snapshot_url,
utility::size64_t  offset,
utility::size64_t  length 
) const
inline

Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot.

Parameters
previous_snapshot_urlA snapshot URL string that represents the previous snapshot. that represents previous snapshot.
offsetThe starting offset of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
lengthThe length of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
Returns
A pplx::task object of type std::vector, of type azure::storage::page_diff_range, that represents the current operation.

This API can be only called against the incremental snapshots of Managed Disks that belong to the same snapshot family. Please browse following URI for more information: https://aka.ms/mdincrementalsnapshots

◆ download_page_ranges_diff_md_async() [4/5]

pplx::task<std::vector<page_diff_range> > azure::storage::cloud_page_blob::download_page_ranges_diff_md_async ( const utility::string_t &  previous_snapshot_url,
utility::size64_t  offset,
utility::size64_t  length,
const access_condition condition,
const blob_request_options options,
operation_context  context 
) const
inline

Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot.

Parameters
previous_snapshot_urlA snapshot URL string that represents the previous snapshot. that represents previous snapshot.
offsetThe starting offset of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
lengthThe length of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
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::page_diff_range, that represents the current operation.

This API can be only called against the incremental snapshots of Managed Disks that belong to the same snapshot family. Please browse following URI for more information: https://aka.ms/mdincrementalsnapshots

◆ download_page_ranges_diff_md_async() [5/5]

pplx::task<std::vector<page_diff_range> > azure::storage::cloud_page_blob::download_page_ranges_diff_md_async ( const utility::string_t &  previous_snapshot_url,
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 
) const
inline

Initiates an asynchronous operation to get a collection of valid page ranges and their starting and ending bytes, only pages that were changed between target blob and previous snapshot.

Parameters
previous_snapshot_urlA snapshot URL string that represents the previous snapshot. that represents previous snapshot.
offsetThe starting offset of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
lengthThe length of the data range over which to list page ranges, in bytes. Must be a multiple of 512.
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::page_diff_range, that represents the current operation.

This API can be only called against the incremental snapshots of Managed Disks that belong to the same snapshot family. Please browse following URI for more information: https://aka.ms/mdincrementalsnapshots

◆ open_write() [1/4]

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

Opens a stream for writing to an existing page blob.

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

◆ open_write() [2/4]

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

Opens a stream for writing to an existing page blob.

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.

◆ open_write() [3/4]

concurrency::streams::ostream azure::storage::cloud_page_blob::open_write ( utility::size64_t  size)
inline

Opens a stream for writing to a new page blob.

Parameters
sizeThe size of the write operation, in bytes. The size must be a multiple of 512.
Returns
A stream to be used for writing to the blob.

◆ open_write() [4/4]

concurrency::streams::ostream azure::storage::cloud_page_blob::open_write ( utility::size64_t  size,
int64_t  sequence_number,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Opens a stream for writing to a new page blob.

Parameters
sizeThe size of the write operation, in bytes. The size must be a multiple of 512.
sequence_numberA user-controlled number to track request sequence, whose value must be between 0 and 2^63 - 1.
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.

◆ open_write_async() [1/6]

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

Initiates an asynchronous operation to open a stream for writing to an existing page blob.

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

◆ open_write_async() [2/6]

pplx::task<concurrency::streams::ostream> azure::storage::cloud_page_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 an existing page blob.

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.

◆ open_write_async() [3/6]

WASTORAGE_API pplx::task<concurrency::streams::ostream> azure::storage::cloud_page_blob::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 an existing page blob.

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.

◆ open_write_async() [4/6]

pplx::task<concurrency::streams::ostream> azure::storage::cloud_page_blob::open_write_async ( utility::size64_t  size)
inline

Initiates an asynchronous operation to open a stream for writing to a new page blob.

Parameters
sizeThe size of the write operation, in bytes. The size must be a multiple of 512.
Returns
A pplx::task object of type concurrency::streams::ostream that represents the current operation.

◆ open_write_async() [5/6]

pplx::task<concurrency::streams::ostream> azure::storage::cloud_page_blob::open_write_async ( utility::size64_t  size,
int64_t  sequence_number,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to open a stream for writing to a new page blob.

Parameters
sizeThe size of the write operation, in bytes. The size must be a multiple of 512.
sequence_numberA user-controlled number to track request sequence, whose value must be between 0 and 2^63 - 1.
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.

◆ open_write_async() [6/6]

pplx::task<concurrency::streams::ostream> azure::storage::cloud_page_blob::open_write_async ( utility::size64_t  size,
int64_t  sequence_number,
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 a new page blob.

Parameters
sizeThe size of the write operation, in bytes. The size must be a multiple of 512.
sequence_numberA user-controlled number to track request sequence, whose value must be between 0 and 2^63 - 1.
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.

◆ resize() [1/2]

void azure::storage::cloud_page_blob::resize ( utility::size64_t  size)
inline

Resizes the page blob to the specified size.

Parameters
sizeThe size of the page blob, in bytes.

◆ resize() [2/2]

void azure::storage::cloud_page_blob::resize ( utility::size64_t  size,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Resizes the page blob to the specified size.

Parameters
sizeThe size of the page blob, in bytes.
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.

◆ resize_async() [1/3]

pplx::task<void> azure::storage::cloud_page_blob::resize_async ( utility::size64_t  size)
inline

Initiates an asynchronous operation to resize the page blob to the specified size.

Parameters
sizeThe size of the page blob, in bytes.
Returns
A pplx::task object that represents the current operation.

◆ resize_async() [2/3]

pplx::task<void> azure::storage::cloud_page_blob::resize_async ( utility::size64_t  size,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to resize the page blob to the specified size.

Parameters
sizeThe size of the page blob, in bytes.
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.

◆ resize_async() [3/3]

WASTORAGE_API pplx::task<void> azure::storage::cloud_page_blob::resize_async ( utility::size64_t  size,
const access_condition condition,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
)

Initiates an asynchronous operation to resize the page blob to the specified size.

Parameters
sizeThe size of the page blob, in bytes.
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.

◆ set_premium_blob_tier()

void azure::storage::cloud_page_blob::set_premium_blob_tier ( const premium_blob_tier  tier,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Sets premium account's page blob tier.

Parameters
conditionAn azure::storage::premium_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_premium_blob_tier_async() [1/2]

pplx::task<void> azure::storage::cloud_page_blob::set_premium_blob_tier_async ( const premium_blob_tier  tier,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

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

Parameters
conditionAn azure::storage::premium_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_premium_blob_tier_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_page_blob::set_premium_blob_tier_async ( const premium_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 premium account's blob tier.

Parameters
conditionAn azure::storage::premium_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.

◆ set_sequence_number() [1/2]

void azure::storage::cloud_page_blob::set_sequence_number ( const azure::storage::sequence_number sequence_number)
inline

Sets the page blob's sequence number.

Parameters
sequence_numberA value of type azure::storage::sequence_number, indicating the operation to perform on the sequence number.

◆ set_sequence_number() [2/2]

void azure::storage::cloud_page_blob::set_sequence_number ( const azure::storage::sequence_number sequence_number,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Sets the page blob's sequence number.

Parameters
sequence_numberA value of type azure::storage::sequence_number, indicating the operation to perform on the sequence number.
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.

◆ set_sequence_number_async() [1/3]

pplx::task<void> azure::storage::cloud_page_blob::set_sequence_number_async ( const azure::storage::sequence_number sequence_number)
inline

Initiates an asynchronous operation to set the page blob's sequence number.

Parameters
sequence_numberA value of type azure::storage::sequence_number, indicating the operation to perform on the sequence number.
Returns
A pplx::task object that represents the current operation.

◆ set_sequence_number_async() [2/3]

pplx::task<void> azure::storage::cloud_page_blob::set_sequence_number_async ( const azure::storage::sequence_number sequence_number,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to set the page blob's sequence number.

Parameters
sequence_numberA value of type azure::storage::sequence_number, indicating the operation to perform on the sequence number.
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.

◆ set_sequence_number_async() [3/3]

WASTORAGE_API pplx::task<void> azure::storage::cloud_page_blob::set_sequence_number_async ( const azure::storage::sequence_number sequence_number,
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 page blob's sequence number.

Parameters
sequence_numberA value of type azure::storage::sequence_number, indicating the operation to perform on the sequence number.
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.

◆ start_copy() [1/2]

utility::string_t azure::storage::cloud_page_blob::start_copy ( const web::http::uri &  source,
const azure::storage::premium_blob_tier  tier,
const access_condition source_condition,
const access_condition destination_condition,
const blob_request_options options,
operation_context  context 
)
inline

Begins an operation to copy a blob's contents, properties, and metadata to a new blob.

Parameters
sourceThe URI of a source blob.
tierAn enum that represents the azure::storage::premium_blob_tier for the destination blob.
source_conditionAn object that represents the azure::storage::access_condition for the source blob.
destination_conditionAn object that represents the azure::storage::access_condition for the destination blob.
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 copy ID associated with the copy operation.

This method fetches the blob's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_copy() [2/2]

utility::string_t azure::storage::cloud_page_blob::start_copy ( const web::http::uri &  source,
const azure::storage::premium_blob_tier  tier,
const cloud_metadata &  metadata,
const access_condition source_condition,
const access_condition destination_condition,
const blob_request_options options,
operation_context  context 
)
inline

Begins an operation to copy a blob's contents, properties, and metadata to a new blob.

Parameters
sourceThe URI of a source blob.
tierAn enum that represents the azure::storage::premium_blob_tier for the destination blob.
metadataMetadata that will be set on the destination blob.
source_conditionAn object that represents the azure::storage::access_condition for the source blob.
destination_conditionAn object that represents the azure::storage::access_condition for the destination blob.
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 copy ID associated with the copy operation.

This method fetches the blob's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_copy_async() [1/3]

pplx::task<utility::string_t> azure::storage::cloud_page_blob::start_copy_async ( const web::http::uri &  source,
const premium_blob_tier  tier,
const access_condition source_condition,
const access_condition destination_condition,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to begin to copy a blob's contents, properties, and metadata to a new blob.

Parameters
sourceThe URI of a source blob.
tierAn enum that represents the azure::storage::premium_blob_tier for the destination blob.
source_conditionAn object that represents the azure::storage::access_condition for the source blob.
destination_conditionAn object that represents the azure::storage::access_condition for the destination blob.
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.

This method fetches the blob's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_copy_async() [2/3]

pplx::task<utility::string_t> azure::storage::cloud_page_blob::start_copy_async ( const web::http::uri &  source,
const premium_blob_tier  tier,
const access_condition source_condition,
const access_condition destination_condition,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
)
inline

Initiates an asynchronous operation to begin to copy a blob's contents, properties, and metadata to a new blob.

Parameters
sourceThe URI of a source blob.
tierAn enum that represents the azure::storage::premium_blob_tier for the destination blob.
source_conditionAn object that represents the azure::storage::access_condition for the source blob.
destination_conditionAn object that represents the azure::storage::access_condition for the destination blob.
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.

This method fetches the blob's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_copy_async() [3/3]

pplx::task<utility::string_t> azure::storage::cloud_page_blob::start_copy_async ( const web::http::uri &  source,
const premium_blob_tier  tier,
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 
)
inline

Initiates an asynchronous operation to begin to copy a blob's contents, properties, and metadata to a new blob.

Parameters
sourceThe URI of a source blob.
tierAn enum that represents the azure::storage::premium_blob_tier for the destination blob.
metadataMetadata that will be set on the destination blob.
source_conditionAn object that represents the azure::storage::access_condition for the source blob.
destination_conditionAn object that represents the azure::storage::access_condition for the destination blob.
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.

This method fetches the blob's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_incremental_copy() [1/4]

utility::string_t azure::storage::cloud_page_blob::start_incremental_copy ( const cloud_page_blob source)
inline

Begin to copy a snapshot of the source page blob and metadata to a destination page blob.

Parameters
sourceThe source page blob object specified a snapshot.
Returns
The copy ID associated with the incremental copy operation.

The destination of an incremental copy must either not exist, or must have been created with a previous incremental copy from the same source blob. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_incremental_copy() [2/4]

utility::string_t azure::storage::cloud_page_blob::start_incremental_copy ( const web::http::uri &  source)
inline

Begin to copy a snapshot of the source page blob and metadata to a destination page blob.

Parameters
sourceThe URI of a snapshot of source page blob.
Returns
The copy ID associated with the incremental copy operation.

The destination of an incremental copy must either not exist, or must have been created with a previous incremental copy from the same source blob. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_incremental_copy() [3/4]

utility::string_t azure::storage::cloud_page_blob::start_incremental_copy ( const cloud_page_blob source,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Begin to copy a snapshot of the source page blob and metadata to a destination page blob.

Parameters
sourceThe source page blob object specified a snapshot.
conditionAn object that represents the azure::storage::access_condition for the destination blob.
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 copy ID associated with the incremental copy operation.

The destination of an incremental copy must either not exist, or must have been created with a previous incremental copy from the same source blob. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_incremental_copy() [4/4]

utility::string_t azure::storage::cloud_page_blob::start_incremental_copy ( const web::http::uri &  source,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Begin to copy a snapshot of the source page blob and metadata to a destination page blob.

Parameters
sourceThe URI of a snapshot of source page blob.
conditionAn object that represents the azure::storage::access_condition for the destination blob.
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 copy ID associated with the incremental copy operation.

The destination of an incremental copy must either not exist, or must have been created with a previous incremental copy from the same source blob. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_incremental_copy_async() [1/6]

pplx::task<utility::string_t> azure::storage::cloud_page_blob::start_incremental_copy_async ( const cloud_page_blob source)
inline

Initiates an asynchronous operation to begin to copy a snapshot of the source page blob and metadata to a destination page blob.

Parameters
sourceThe source page blob object specified a snapshot.
Returns
A pplx::task object of type utility::string_t that represents the current operation.

The destination of an incremental copy must either not exist, or must have been created with a previous incremental copy from the same source blob. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_incremental_copy_async() [2/6]

pplx::task<utility::string_t> azure::storage::cloud_page_blob::start_incremental_copy_async ( const web::http::uri &  source)
inline

Initiates an asynchronous operation to begin to copy a snapshot of the source page blob and metadata to a destination page blob.

Parameters
sourceThe URI of a snapshot of source page blob.
Returns
A pplx::task object of type utility::string_t that represents the current operation.

The destination of an incremental copy must either not exist, or must have been created with a previous incremental copy from the same source blob. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_incremental_copy_async() [3/6]

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

Initiates an asynchronous operation to begin to copy a snapshot of the source page blob and metadata to a destination page blob.

Parameters
sourceThe source page blob object specified a snapshot.
conditionAn object that represents the azure::storage::access_condition for the destination blob.
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.

The destination of an incremental copy must either not exist, or must have been created with a previous incremental copy from the same source blob. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_incremental_copy_async() [4/6]

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

Initiates an asynchronous operation to begin to copy a snapshot of the source page blob and metadata to a destination page blob.

Parameters
sourceThe source page blob object specified a snapshot.
conditionAn object that represents the azure::storage::access_condition for the destination blob.
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.

The destination of an incremental copy must either not exist, or must have been created with a previous incremental copy from the same source blob. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_incremental_copy_async() [5/6]

pplx::task<utility::string_t> azure::storage::cloud_page_blob::start_incremental_copy_async ( const web::http::uri &  source,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to begin to copy a snapshot of the source page blob and metadata to a destination page blob.

Parameters
sourceThe URI of a snapshot of source page blob.
conditionAn object that represents the azure::storage::access_condition for the destination blob.
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.

The destination of an incremental copy must either not exist, or must have been created with a previous incremental copy from the same source blob. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ start_incremental_copy_async() [6/6]

WASTORAGE_API pplx::task<utility::string_t> azure::storage::cloud_page_blob::start_incremental_copy_async ( const web::http::uri &  source,
const access_condition condition,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
)

Initiates an asynchronous operation to begin to copy a snapshot of the source page blob and metadata to a destination page blob.

Parameters
sourceThe URI of a snapshot of source page blob.
conditionAn object that represents the azure::storage::access_condition for the destination blob.
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.

The destination of an incremental copy must either not exist, or must have been created with a previous incremental copy from the same source blob. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.

◆ upload_from_file() [1/2]

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

Uploads a file to a page 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_page_blob::upload_from_file ( const utility::string_t &  path,
int64_t  sequence_number,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

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

Parameters
pathThe file providing the blob content.
sequence_numberA user-controlled number to track request sequence, whose value must be between 0 and 2^63 - 1.
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_page_blob::upload_from_file_async ( const utility::string_t &  path)
inline

Initiates an asynchronous operation to upload a file to a page 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_page_blob::upload_from_file_async ( const utility::string_t &  path,
int64_t  sequence_number,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

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

Parameters
pathThe file providing the blob content.
sequence_numberA user-controlled number to track request sequence, whose value must be between 0 and 2^63 - 1.
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_page_blob::upload_from_file_async ( const utility::string_t &  path,
int64_t  sequence_number,
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 page blob. If the blob already exists on the service, it will be overwritten.

Parameters
pathThe file providing the blob content.
sequence_numberA user-controlled number to track request sequence, whose value must be between 0 and 2^63 - 1.
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_page_blob::upload_from_stream ( concurrency::streams::istream  source)
inline

Uploads a stream to a page 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_page_blob::upload_from_stream ( concurrency::streams::istream  source,
int64_t  sequence_number,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

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

Parameters
sourceThe stream providing the blob content.
sequence_numberA user-controlled number to track request sequence, whose value must be between 0 and 2^63 - 1.
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_page_blob::upload_from_stream ( concurrency::streams::istream  source,
utility::size64_t  length 
)
inline

Uploads a stream to a page 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_page_blob::upload_from_stream ( concurrency::streams::istream  source,
utility::size64_t  length,
int64_t  sequence_number,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Uploads a stream to a page 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.
sequence_numberA user-controlled number to track request sequence, whose value must be between 0 and 2^63 - 1.
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_page_blob::upload_from_stream_async ( concurrency::streams::istream  source)
inline

Initiates an asynchronous operation to upload a stream to a page 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_page_blob::upload_from_stream_async ( concurrency::streams::istream  source,
int64_t  sequence_number,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

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

Parameters
sourceThe stream providing the blob content.
sequence_numberA user-controlled number to track request sequence, whose value must be between 0 and 2^63 - 1.
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_page_blob::upload_from_stream_async ( concurrency::streams::istream  source,
utility::size64_t  length 
)
inline

Initiates an asynchronous operation to upload a stream to a page 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_page_blob::upload_from_stream_async ( concurrency::streams::istream  source,
utility::size64_t  length,
int64_t  sequence_number,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to upload a stream to a page 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.
sequence_numberA user-controlled number to track request sequence, whose value must be between 0 and 2^63 - 1.
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_page_blob::upload_from_stream_async ( concurrency::streams::istream  source,
utility::size64_t  length,
int64_t  sequence_number,
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 page 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.
sequence_numberA user-controlled number to track request sequence, whose value must be between 0 and 2^63 - 1.
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_pages() [1/2]

void azure::storage::cloud_page_blob::upload_pages ( concurrency::streams::istream  page_data,
int64_t  start_offset,
const checksum content_checksum 
)
inline

Writes pages to a page blob.

Parameters
page_dataA stream providing the page data.
start_offsetThe offset at which to begin writing, in bytes. The offset must be a multiple of 512.
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_pages() [2/2]

void azure::storage::cloud_page_blob::upload_pages ( concurrency::streams::istream  page_data,
int64_t  start_offset,
const checksum content_checksum,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Writes pages to a page blob.

Parameters
page_dataA stream providing the page data.
start_offsetThe offset at which to begin writing, in bytes. The offset must be a multiple of 512.
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_pages_async() [1/3]

pplx::task<void> azure::storage::cloud_page_blob::upload_pages_async ( concurrency::streams::istream  source,
int64_t  start_offset,
const checksum content_checksum 
)
inline

Initiates an asynchronous operation to write pages to a page blob.

Parameters
sourceA stream providing the page data.
start_offsetThe offset at which to begin writing, in bytes. The offset must be a multiple of 512.
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_pages_async() [2/3]

pplx::task<void> azure::storage::cloud_page_blob::upload_pages_async ( concurrency::streams::istream  source,
int64_t  start_offset,
const checksum content_checksum,
const access_condition condition,
const blob_request_options options,
operation_context  context 
)
inline

Initiates an asynchronous operation to write pages to a page blob.

Parameters
sourceA stream providing the page data.
start_offsetThe offset at which to begin writing, in bytes. The offset must be a multiple of 512.
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_pages_async() [3/3]

pplx::task<void> azure::storage::cloud_page_blob::upload_pages_async ( concurrency::streams::istream  source,
int64_t  start_offset,
const checksum content_checksum,
const access_condition condition,
const blob_request_options options,
operation_context  context,
const pplx::cancellation_token &  cancellation_token 
)
inline

Initiates an asynchronous operation to write pages to a page blob.

Parameters
sourceA stream providing the page data.
start_offsetThe offset at which to begin writing, in bytes. The offset must be a multiple of 512.
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.