azure::storage::cloud_blob Class Reference

A class for Windows Azure blob types. The azure::storage::cloud_block_blob and azure::storage::cloud_page_blob classes derive from the azure::storage::cloud_blob class. More...

Inheritance diagram for azure::storage::cloud_blob:

Public Member Functions
	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_properties >	download_account_properties_async () const
	Initiates an asynchronous operation to get properties for the account this blob resides on. More...
pplx::task< account_properties >	download_account_properties_async (const blob_request_options &options, operation_context context) const
	Initiates an asynchronous operation to get properties for the account this blob resides on. More...
WASTORAGE_API pplx::task< account_properties >	download_account_properties_async (const blob_request_options &options, operation_context context, const pplx::cancellation_token &cancellation_token) const
	Initiates an asynchronous operation to get properties for the account this 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_blob >	create_snapshot_async ()
	Initiates an asynchronous operation to create a snapshot of the blob. More...
pplx::task< azure::storage::cloud_blob >	create_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_blob >	create_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_client &	service_client () const
	Gets the azure::storage::cloud_blob_client object that represents the Blob service. More...
const cloud_blob_container &	container () const
	Gets an azure::storage::cloud_blob_container object representing the blob's container. More...
cloud_blob_properties &	properties ()
	Gets the blob's system properties. More...
const cloud_blob_properties &	properties () 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_state &	copy_state () const
	Gets the state of the most recent or pending copy operation. More...
const storage_uri &	uri () 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

A class for Windows Azure blob types. The azure::storage::cloud_block_blob and azure::storage::cloud_page_blob classes derive from the azure::storage::cloud_blob class.

Constructor & Destructor Documentation

cloud_blob() [1/4]

azure::storage::cloud_blob::cloud_blob ( )

inline

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

cloud_blob() [2/4]

WASTORAGE_API azure::storage::cloud_blob::cloud_blob

(

storage_uri

uri

)

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

Parameters

uri	An azure::storage::storage_uri object containing the absolute URI to the blob for all locations.

cloud_blob() [3/4]

WASTORAGE_API azure::storage::cloud_blob::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.

Parameters

uri	An azure::storage::storage_uri object containing the absolute URI to the blob for all locations.
credentials	The azure::storage::storage_credentials to use.

cloud_blob() [4/4]

WASTORAGE_API azure::storage::cloud_blob::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.

Parameters

uri	An azure::storage::storage_uri object containing the absolute URI to the blob for all locations.
snapshot_time	The snapshot timestamp, if the blob is a snapshot.
credentials	The azure::storage::storage_credentials to use.

Member Function Documentation

abort_copy() [1/2]

void azure::storage::cloud_blob::abort_copy ( const utility::string_t &  copy_id ) const

inline

Aborts an ongoing blob copy operation.

Parameters

copy_id

A string identifying the copy operation.

abort_copy() [2/2]

void azure::storage::cloud_blob::abort_copy ( const utility::string_t &  copy_id, const access_condition &  condition, const blob_request_options &  options, operation_context  context  ) const

inline

Aborts an ongoing blob copy operation.

Parameters

copy_id	A string identifying the copy operation.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

abort_copy_async() [1/3]

pplx::task<void> azure::storage::cloud_blob::abort_copy_async ( const utility::string_t &  copy_id ) const

inline

Initiates an asynchronous operation to abort an ongoing blob copy operation.

Parameters

copy_id

A string identifying the copy operation.

Returns

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

abort_copy_async() [2/3]

pplx::task<void> azure::storage::cloud_blob::abort_copy_async ( const utility::string_t &  copy_id, const access_condition &  condition, const blob_request_options &  options, operation_context  context  ) const

inline

Initiates an asynchronous operation to abort an ongoing blob copy operation.

Parameters

copy_id	A string identifying the copy operation.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

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

abort_copy_async() [3/3]

WASTORAGE_API pplx::task<void> azure::storage::cloud_blob::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.

Parameters

copy_id	A string identifying the copy operation.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

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

acquire_lease() [1/2]

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

inline

Acquires a lease on the blob.

Parameters

duration	An azure::storage::lease_time representing the span of time for which to acquire the lease.
proposed_lease_id	A string representing the proposed lease ID for the new lease. May be an empty string if no lease ID is proposed.

Returns

A string containing the lease ID.

acquire_lease() [2/2]

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

inline

Acquires a lease on the blob.

Parameters

duration	An azure::storage::lease_time representing the span of time for which to acquire the lease.
proposed_lease_id	A string representing the proposed lease ID for the new lease. May be an empty string if no lease ID is proposed.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A string containing the lease ID.

acquire_lease_async() [1/3]

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

inline

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

Parameters

duration	An azure::storage::lease_time representing the span of time for which to acquire the lease.
proposed_lease_id	A string representing the proposed lease ID for the new lease. May be an empty string if no lease ID is proposed.

Returns

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

acquire_lease_async() [2/3]

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

inline

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

Parameters

duration	An azure::storage::lease_time representing the span of time for which to acquire the lease.
proposed_lease_id	A string representing the proposed lease ID for the new lease. May be an empty string if no lease ID is proposed.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

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

acquire_lease_async() [3/3]

WASTORAGE_API pplx::task<utility::string_t> azure::storage::cloud_blob::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.

Parameters

duration	An azure::storage::lease_time representing the span of time for which to acquire the lease.
proposed_lease_id	A string representing the proposed lease ID for the new lease. May be an empty string if no lease ID is proposed.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

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

break_lease() [1/2]

std::chrono::seconds azure::storage::cloud_blob::break_lease ( const azure::storage::lease_break_period &  break_period ) const

inline

Breaks the current lease on the blob.

Parameters

break_period

An azure::storage::lease_break_period representing the amount of time to allow the lease to remain.

Returns

The time until the lease ends, in seconds.

break_lease() [2/2]

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

inline

Breaks the current lease on the blob.

Parameters

break_period	An azure::storage::lease_break_period representing the amount of time to allow the lease to remain.
condition	An azure::storage::access_condition object that represents the access conditions for the blob, including a required lease ID.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

The time until the lease ends, in seconds.

break_lease_async() [1/3]

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

inline

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

Parameters

break_period

An azure::storage::lease_break_period representing the amount of time to allow the lease to remain.

Returns

A pplx::task object of type std::chrono::seconds that represents the current operation.

break_lease_async() [2/3]

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

inline

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

Parameters

break_period	An azure::storage::lease_break_period representing the amount of time to allow the lease to remain.
condition	An azure::storage::access_condition object that represents the access conditions for the blob, including a required lease ID.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object of type std::chrono::seconds that represents the current operation.

break_lease_async() [3/3]

WASTORAGE_API pplx::task<std::chrono::seconds> azure::storage::cloud_blob::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.

Parameters

break_period	An azure::storage::lease_break_period representing the amount of time to allow the lease to remain.
condition	An azure::storage::access_condition object that represents the access conditions for the blob, including a required lease ID.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

A pplx::task object of type std::chrono::seconds that represents the current operation.

change_lease() [1/2]

utility::string_t azure::storage::cloud_blob::change_lease ( const utility::string_t &  proposed_lease_id, const access_condition &  condition  ) const

inline

Changes the lease ID on the blob.

Parameters

proposed_lease_id	A string containing the proposed lease ID for the lease. May not be empty.
condition	An azure::storage::access_condition object that represents the access conditions for the blob, including a required lease ID.

Returns

The new lease ID.

change_lease() [2/2]

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

inline

Changes the lease ID on the blob.

Parameters

proposed_lease_id	A string containing the proposed lease ID for the lease. May not be empty.
condition	An azure::storage::access_condition object that represents the access conditions for the blob, including a required lease ID.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

The new lease ID.

change_lease_async() [1/3]

pplx::task<utility::string_t> azure::storage::cloud_blob::change_lease_async ( const utility::string_t &  proposed_lease_id, const access_condition &  condition  ) const

inline

Initiates an asynchronous operation to change the lease ID on the blob.

Parameters

proposed_lease_id	A string containing the proposed lease ID for the lease. May not be empty.
condition	An azure::storage::access_condition object that represents the access conditions for the blob, including a required lease ID.

Returns

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

change_lease_async() [2/3]

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

inline

Initiates an asynchronous operation to change the lease ID on the blob.

Parameters

proposed_lease_id	A string containing the proposed lease ID for the lease. May not be empty.
condition	An azure::storage::access_condition object that represents the access conditions for the blob, including a required lease ID.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

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

change_lease_async() [3/3]

WASTORAGE_API pplx::task<utility::string_t> azure::storage::cloud_blob::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.

Parameters

proposed_lease_id	A string containing the proposed lease ID for the lease. May not be empty.
condition	An azure::storage::access_condition object that represents the access conditions for the blob, including a required lease ID.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

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

container()

const cloud_blob_container& azure::storage::cloud_blob::container ( ) const

inline

Gets an azure::storage::cloud_blob_container object representing the blob's container.

Returns

The blob's container.

copy_state()

const azure::storage::copy_state& azure::storage::cloud_blob::copy_state ( ) const

inline

Gets the state of the most recent or pending copy operation.

Returns

An azure::storage::copy_state object containing the copy state.

create_snapshot() [1/2]

cloud_blob azure::storage::cloud_blob::create_snapshot ( )

inline

Creates a snapshot of the blob.

Returns

A blob snapshot.

create_snapshot() [2/2]

cloud_blob azure::storage::cloud_blob::create_snapshot ( cloud_metadata  metadata, const access_condition &  condition, const blob_request_options &  options, operation_context  context  )

inline

Creates a snapshot of the blob.

Parameters

metadata	A collection of name-value pairs defining the metadata of the snapshot.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A blob snapshot.

create_snapshot_async() [1/3]

pplx::task<azure::storage::cloud_blob> azure::storage::cloud_blob::create_snapshot_async ( )

inline

Initiates an asynchronous operation to create a snapshot of the blob.

Returns

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

create_snapshot_async() [2/3]

pplx::task<azure::storage::cloud_blob> azure::storage::cloud_blob::create_snapshot_async ( cloud_metadata  metadata, const access_condition &  condition, const blob_request_options &  options, operation_context  context  )

inline

Initiates an asynchronous operation to create a snapshot of the blob.

Parameters

metadata	A collection of name-value pairs defining the metadata of the snapshot.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

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

create_snapshot_async() [3/3]

WASTORAGE_API pplx::task<azure::storage::cloud_blob> azure::storage::cloud_blob::create_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.

Parameters

metadata	A collection of name-value pairs defining the metadata of the snapshot.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

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

delete_blob() [1/2]

void azure::storage::cloud_blob::delete_blob ( )

inline

Deletes the blob.

delete_blob() [2/2]

void azure::storage::cloud_blob::delete_blob ( delete_snapshots_option  snapshots_option, const access_condition &  condition, const blob_request_options &  options, operation_context  context  )

inline

Deletes the blob.

Parameters

snapshots_option	Indicates whether to delete only the blob, to delete the blob and all snapshots, or to delete only snapshots.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

delete_blob_async() [1/3]

pplx::task<void> azure::storage::cloud_blob::delete_blob_async ( )

inline

Initiates an asynchronous operation to delete the blob.

Returns

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

delete_blob_async() [2/3]

WASTORAGE_API pplx::task<void> azure::storage::cloud_blob::delete_blob_async ( delete_snapshots_option  snapshots_option, const access_condition &  condition, const blob_request_options &  options, operation_context  context  )

inline

Initiates an asynchronous operation to delete the blob.

Parameters

snapshots_option	Indicates whether to delete only the blob, to delete the blob and all snapshots, or to delete only snapshots.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

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

delete_blob_async() [3/3]

WASTORAGE_API pplx::task<void> azure::storage::cloud_blob::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.

Parameters

snapshots_option	Indicates whether to delete only the blob, to delete the blob and all snapshots, or to delete only snapshots.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

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

delete_blob_if_exists() [1/2]

bool azure::storage::cloud_blob::delete_blob_if_exists ( )

inline

Deletes the blob if it already exists.

Returns

true if the blob did already exist and was deleted; otherwise false.

delete_blob_if_exists() [2/2]

bool azure::storage::cloud_blob::delete_blob_if_exists ( delete_snapshots_option  snapshots_option, const access_condition &  condition, const blob_request_options &  options, operation_context  context  )

inline

Deletes the blob if it already exists.

Parameters

snapshots_option	Indicates whether to delete only the blob, to delete the blob and all snapshots, or to delete only snapshots.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

true if the blob did already exist and was deleted; otherwise false.

delete_blob_if_exists_async() [1/3]

pplx::task<bool> azure::storage::cloud_blob::delete_blob_if_exists_async ( )

inline

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

Returns

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

delete_blob_if_exists_async() [2/3]

pplx::task<bool> azure::storage::cloud_blob::delete_blob_if_exists_async ( delete_snapshots_option  snapshots_option, const access_condition &  condition, const blob_request_options &  options, operation_context  context  )

inline

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

Parameters

snapshots_option	Indicates whether to delete only the blob, to delete the blob and all snapshots, or to delete only snapshots.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

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

delete_blob_if_exists_async() [3/3]

WASTORAGE_API pplx::task<bool> azure::storage::cloud_blob::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.

Parameters

snapshots_option	Indicates whether to delete only the blob, to delete the blob and all snapshots, or to delete only snapshots.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

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

download_account_properties() [1/2]

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

inline

Gets properties for the account this blob resides on.

Returns

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

download_account_properties() [2/2]

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

inline

Gets properties for the account this blob resides on.

Parameters

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

Returns

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

download_account_properties_async() [1/3]

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

inline

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

Returns

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

download_account_properties_async() [2/3]

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

inline

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

Parameters

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

Returns

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

download_account_properties_async() [3/3]

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

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

Parameters

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

Returns

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

download_attributes() [1/2]

void azure::storage::cloud_blob::download_attributes ( )

inline

Populates a blob's properties and metadata.

download_attributes() [2/2]

void azure::storage::cloud_blob::download_attributes ( const access_condition &  condition, const blob_request_options &  options, operation_context  context  )

inline

Populates a blob's properties and metadata.

Parameters

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

download_attributes_async() [1/3]

pplx::task<void> azure::storage::cloud_blob::download_attributes_async ( )

inline

Initiates an asynchronous operation to populate a blob's properties and metadata.

Returns

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

download_attributes_async() [2/3]

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

inline

Initiates an asynchronous operation to populate a blob's properties and metadata.

Parameters

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

Returns

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

download_attributes_async() [3/3]

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

inline

Initiates an asynchronous operation to populate a blob's properties and metadata.

Parameters

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

Returns

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

download_range_to_stream() [1/2]

void azure::storage::cloud_blob::download_range_to_stream ( concurrency::streams::ostream  target, utility::size64_t  offset, utility::size64_t  length  )

inline

Downloads a range of bytes in a blob to a stream.

Parameters

target	The target stream.
offset	The offset at which to begin downloading the blob, in bytes.
length	The length of the data to download from the blob, in bytes.

download_range_to_stream() [2/2]

void azure::storage::cloud_blob::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  )

inline

Downloads a range of bytes in a blob to a stream.

Parameters

target	The target stream.
offset	The offset at which to begin downloading the blob, in bytes.
length	The length of the data to download from the blob, in bytes.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

download_range_to_stream_async() [1/3]

pplx::task<void> azure::storage::cloud_blob::download_range_to_stream_async ( concurrency::streams::ostream  target, int64_t  offset, int64_t  length  )

inline

Initiates an asynchronous operation to download a range of bytes in a blob to a stream.

Parameters

target	The target stream.
offset	The offset at which to begin downloading the blob, in bytes.
length	The length of the data to download from the blob, in bytes.

Returns

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

download_range_to_stream_async() [2/3]

pplx::task<void> azure::storage::cloud_blob::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  )

inline

Initiates an asynchronous operation to download a range of bytes in a blob to a stream.

Parameters

target	The target stream.
offset	The offset at which to begin downloading the blob, in bytes.
length	The length of the data to download from the blob, in bytes.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

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

download_range_to_stream_async() [3/3]

WASTORAGE_API pplx::task<void> azure::storage::cloud_blob::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.

Parameters

target	The target stream.
offset	The offset at which to begin downloading the blob, in bytes.
length	The length of the data to download from the blob, in bytes.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

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

download_to_file() [1/2]

void azure::storage::cloud_blob::download_to_file ( const utility::string_t &  path )

inline

Downloads the contents of a blob to a file.

Parameters

path	The target file.

download_to_file() [2/2]

void azure::storage::cloud_blob::download_to_file ( const utility::string_t &  path, const access_condition &  condition, const blob_request_options &  options, operation_context  context  )

inline

Downloads the contents of a blob to a file.

Parameters

path	The target file.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

download_to_file_async() [1/3]

pplx::task<void> azure::storage::cloud_blob::download_to_file_async ( const utility::string_t &  path )

inline

Initiates an asynchronous operation to download the contents of a blob to a file.

Parameters

path	The target file.

Returns

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

download_to_file_async() [2/3]

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

inline

Initiates an asynchronous operation to download the contents of a blob to a file.

Parameters

path	The target file.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

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

download_to_file_async() [3/3]

WASTORAGE_API pplx::task<void> azure::storage::cloud_blob::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.

Parameters

path	The target file.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

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

download_to_stream() [1/2]

void azure::storage::cloud_blob::download_to_stream ( concurrency::streams::ostream  target )

inline

Downloads the contents of a blob to a stream.

Parameters

target

The target stream.

download_to_stream() [2/2]

void azure::storage::cloud_blob::download_to_stream ( concurrency::streams::ostream  target, const access_condition &  condition, const blob_request_options &  options, operation_context  context  )

inline

Downloads the contents of a blob to a stream.

Parameters

target	The target stream.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

download_to_stream_async() [1/3]

pplx::task<void> azure::storage::cloud_blob::download_to_stream_async ( concurrency::streams::ostream  target )

inline

Initiates an asynchronous operation to download the contents of a blob to a stream.

Parameters

target

The target stream.

Returns

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

download_to_stream_async() [2/3]

pplx::task<void> azure::storage::cloud_blob::download_to_stream_async ( concurrency::streams::ostream  target, const access_condition &  condition, const blob_request_options &  options, operation_context  context  )

inline

Initiates an asynchronous operation to download the contents of a blob to a stream.

Parameters

target	The target stream.
condition	An azure::storage::access_condition object that represents the access condition for the operation.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

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

download_to_stream_async() [3/3]

pplx::task<void> azure::storage::cloud_blob::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  )

inline

Initiates an asynchronous operation to download the contents of a blob to a stream.

Parameters

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

Returns

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

exists() [1/2]

bool azure::storage::cloud_blob::exists ( )

inline

Checks existence of the blob.

Returns

true if the blob exists.

exists() [2/2]

bool azure::storage::cloud_blob::exists ( const blob_request_options &  options, operation_context  context  )

inline

Checks existence of the blob.

Parameters

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

Returns

true if the blob exists.

exists_async() [1/3]

pplx::task<bool> azure::storage::cloud_blob::exists_async ( )

inline

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

Returns

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

exists_async() [2/3]

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

inline

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

Parameters

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

Returns

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

exists_async() [3/3]

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

inline

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

Parameters

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

Returns

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

get_parent_reference()

WASTORAGE_API cloud_blob_directory azure::storage::cloud_blob::get_parent_reference

(

)

const

Gets the azure::storage::cloud_blob_directory object representing the virtual parent directory for the blob.

Returns

The blob's virtual parent directory.

get_shared_access_signature() [1/3]

utility::string_t azure::storage::cloud_blob::get_shared_access_signature ( const blob_shared_access_policy &  policy ) const

inline

Returns a shared access signature for the blob.

Parameters

policy

The access policy for the shared access signature.

Returns

A string containing a shared access signature.

get_shared_access_signature() [2/3]

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

inline

Returns a shared access signature for the blob.

Parameters

policy	The access policy for the shared access signature.
stored_policy_identifier	A container-level access policy.

Returns

A string containing a shared access signature.

get_shared_access_signature() [3/3]

WASTORAGE_API utility::string_t azure::storage::cloud_blob::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.

Parameters

policy	The access policy for the shared access signature.
stored_policy_identifier	A container-level access policy.
headers	The optional header values to set for a blob returned with this SAS.

Returns

A string containing a shared access signature.

get_user_delegation_sas() [1/2]

utility::string_t azure::storage::cloud_blob::get_user_delegation_sas ( const user_delegation_key &  key, const blob_shared_access_policy &  policy  ) const

inline

Returns a user delegation SAS for the blob.

Parameters

key	User delegation key used to sign this SAS.
policy	The access policy for the shared access signature.

Returns

A string containing a shared access signature.

get_user_delegation_sas() [2/2]

WASTORAGE_API utility::string_t azure::storage::cloud_blob::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.

Parameters

key	User delegation key used to sign this SAS.
policy	The access policy for the shared access signature.
headers	The optional header values to set for a blob returned with this SAS.

Returns

A string containing a shared access signature.

is_snapshot()

bool azure::storage::cloud_blob::is_snapshot ( ) const

inline

Gets a value indicating whether this blob is a snapshot.

Returns

true if this blob is a snapshot; otherwise, false.

is_valid()

bool azure::storage::cloud_blob::is_valid ( ) const

inline

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

Returns

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

metadata() [1/2]

cloud_metadata& azure::storage::cloud_blob::metadata ( )

inline

Gets the user-defined metadata for the blob.

Returns

The blob's metadata, as a collection of name-value pairs.

metadata() [2/2]

const cloud_metadata& azure::storage::cloud_blob::metadata ( ) const

inline

Gets the user-defined metadata for the blob.

Returns

The blob's metadata, as a collection of name-value pairs.

name()

const utility::string_t& azure::storage::cloud_blob::name ( ) const

inline

Gets the blob's name.

Returns

The blob's name.

open_read() [1/2]

concurrency::streams::istream azure::storage::cloud_blob::open_read ( )

inline

Opens a stream for reading from the blob.

Returns

A stream to be used for reading from the blob.

open_read() [2/2]

concurrency::streams::istream azure::storage::cloud_blob::open_read ( const access_condition &  condition, const blob_request_options &  options, operation_context  context  )

inline

Opens a stream for reading from the blob.

Parameters

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

Returns

A stream to be used for reading from the blob.

open_read_async() [1/3]

pplx::task<concurrency::streams::istream> azure::storage::cloud_blob::open_read_async ( )

inline

Initiates an asynchronous operation to open a stream for reading from the blob.

Returns

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

open_read_async() [2/3]

pplx::task<concurrency::streams::istream> azure::storage::cloud_blob::open_read_async ( const access_condition &  condition, const blob_request_options &  options, operation_context  context  )

inline

Initiates an asynchronous operation to open a stream for reading from the blob.

Parameters

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

Returns

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

open_read_async() [3/3]

WASTORAGE_API pplx::task<concurrency::streams::istream> azure::storage::cloud_blob::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.

Parameters

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

Returns

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

properties() [1/2]

cloud_blob_properties& azure::storage::cloud_blob::properties ( )

inline

Gets the blob's system properties.

Returns

The blob's properties.

properties() [2/2]

const cloud_blob_properties& azure::storage::cloud_blob::properties ( ) const

inline

Gets the blob's system properties.

Returns

The blob's properties.

release_lease() [1/2]

void azure::storage::cloud_blob::release_lease ( const access_condition &  condition ) const

inline

Releases the lease on the blob.

Parameters

condition

An azure::storage::access_condition object that represents the access conditions for the blob, including a required lease ID.

release_lease() [2/2]

void azure::storage::cloud_blob::release_lease ( const access_condition &  condition, const blob_request_options &  options, operation_context  context  ) const

inline

Releases the lease on the blob.

Parameters

condition	An azure::storage::access_condition object that represents the access conditions for the blob, including a required lease ID.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

release_lease_async() [1/3]

pplx::task<void> azure::storage::cloud_blob::release_lease_async ( const access_condition &  condition ) const

inline

Initiates an asynchronous operation to release the lease on the blob.

Parameters

condition

An azure::storage::access_condition object that represents the access conditions for the blob, including a required lease ID.

Returns

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

release_lease_async() [2/3]

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

inline

Initiates an asynchronous operation to release the lease on the blob.

Parameters

condition	An azure::storage::access_condition object that represents the access conditions for the blob, including a required lease ID.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

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

release_lease_async() [3/3]

WASTORAGE_API pplx::task<void> azure::storage::cloud_blob::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.

Parameters

condition	An azure::storage::access_condition object that represents the access conditions for the blob, including a required lease ID.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

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

renew_lease() [1/2]

void azure::storage::cloud_blob::renew_lease ( const access_condition &  condition ) const

inline

Renews a lease on the blob.

Parameters

condition

An azure::storage::access_condition object that represents the access conditions for the blob, including a required lease ID.

renew_lease() [2/2]

void azure::storage::cloud_blob::renew_lease ( const access_condition &  condition, const blob_request_options &  options, operation_context  context  ) const

inline

Renews a lease on the blob.

Parameters

condition	An azure::storage::access_condition object that represents the access conditions for the blob, including a required lease ID.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

renew_lease_async() [1/3]

pplx::task<void> azure::storage::cloud_blob::renew_lease_async ( const access_condition &  condition ) const

inline

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

Parameters

condition

An azure::storage::access_condition object that represents the access conditions for the blob, including a required lease ID.

Returns

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

renew_lease_async() [2/3]

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

inline

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

Parameters

condition	An azure::storage::access_condition object that represents the access conditions for the blob, including a required lease ID.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

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

renew_lease_async() [3/3]

WASTORAGE_API pplx::task<void> azure::storage::cloud_blob::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.

Parameters

condition	An azure::storage::access_condition object that represents the access conditions for the blob, including a required lease ID.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

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

service_client()

const cloud_blob_client& azure::storage::cloud_blob::service_client ( ) const

inline

Gets the azure::storage::cloud_blob_client object that represents the Blob service.

Returns

A client object that specifies the Blob service endpoint.

set_version_id()

void azure::storage::cloud_blob::set_version_id ( utility::string_t  version_id )

inline

Sets the version id of this blob.

Parameters

version_id

The blob's version id.

snapshot_qualified_uri()

WASTORAGE_API storage_uri azure::storage::cloud_blob::snapshot_qualified_uri

(

)

const

Gets the snapshot-qualified URI to the blob.

Returns

The blob's snapshot-qualified URI, if the blob is a snapshot; otherwise, the absolute URI to the blob.

snapshot_time()

const utility::string_t& azure::storage::cloud_blob::snapshot_time ( ) const

inline

Gets the date and time that the blob snapshot was taken, if this blob is a snapshot.

Returns

The blob's snapshot time, if the blob is a snapshot; otherwise, returns an empty string.

start_copy() [1/9]

utility::string_t azure::storage::cloud_blob::start_copy ( const web::http::uri &  source )

inline

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

Parameters

source

The URI of a source blob.

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/9]

utility::string_t azure::storage::cloud_blob::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  )

inline

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

Parameters

source	The URI of a source blob.
source_condition	An object that represents the azure::storage::access_condition for the source blob.
destination_condition	An object that represents the azure::storage::access_condition for the destination blob.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

The 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() [3/9]

utility::string_t azure::storage::cloud_blob::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  )

inline

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

Parameters

source	The URI of a source blob.
metadata	Metadata that will be set on the destination blob.
source_condition	An object that represents the azure::storage::access_condition for the source blob.
destination_condition	An object that represents the azure::storage::access_condition for the destination blob.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

The 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() [4/9]

utility::string_t azure::storage::cloud_blob::start_copy ( const cloud_blob &  source )

inline

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

Parameters

source

The URI of a source blob.

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() [5/9]

utility::string_t azure::storage::cloud_blob::start_copy ( const cloud_blob &  source, 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

source	The URI of a source blob.
source_condition	An object that represents the access_condition for the source blob.
destination_condition	An object that represents the access_condition for the destination blob.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

The 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() [6/9]

utility::string_t azure::storage::cloud_blob::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  )

inline

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

Parameters

source	The URI of a source blob.
metadata	Metadata that will be set on the destination blob.
source_condition	An object that represents the access_condition for the source blob.
destination_condition	An object that represents the access_condition for the destination blob.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

The 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() [7/9]

utility::string_t azure::storage::cloud_blob::start_copy ( const cloud_file &  source )

inline

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

Parameters

source

The URI of a source file.

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() [8/9]

utility::string_t azure::storage::cloud_blob::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  )

inline

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

Parameters

source	The URI of a source file.
source_condition	An object that represents the access_condition for the source blob.
destination_condition	An object that represents the access_condition for the destination blob.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

The 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() [9/9]

utility::string_t azure::storage::cloud_blob::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  )

inline

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

Parameters

source	The URI of a source file.
metadata	Metadata that will be set on the destination blob.
source_condition	An object that represents the access_condition for the source blob.
destination_condition	An object that represents the access_condition for the destination blob.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

The 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/12]

pplx::task<utility::string_t> azure::storage::cloud_blob::start_copy_async ( const web::http::uri &  source )

inline

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

Parameters

source

The URI of a source blob.

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/12]

pplx::task<utility::string_t> azure::storage::cloud_blob::start_copy_async ( const cloud_blob &  source )

inline

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

Parameters

source

The URI of a source blob.

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/12]

WASTORAGE_API pplx::task<utility::string_t> azure::storage::cloud_blob::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.

Parameters

source

The URI of a source file.

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() [4/12]

pplx::task<utility::string_t> azure::storage::cloud_blob::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  )

inline

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

Parameters

source	The URI of a source blob.
source_condition	An object that represents the azure::storage::access_condition for the source blob.
destination_condition	An object that represents the azure::storage::access_condition for the destination blob.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object of type 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() [5/12]

pplx::task<utility::string_t> azure::storage::cloud_blob::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  )

inline

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

Parameters

source	The URI of a source blob.
source_condition	An object that represents the azure::storage::access_condition for the source blob.
destination_condition	An object that represents the azure::storage::access_condition for the destination blob.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

A pplx::task object of type 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() [6/12]

pplx::task<utility::string_t> azure::storage::cloud_blob::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  )

inline

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

Parameters

source	The URI of a source blob.
metadata	Metadata that will be set on the destination blob.
source_condition	An object that represents the azure::storage::access_condition for the source blob.
destination_condition	An object that represents the azure::storage::access_condition for the destination blob.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

A pplx::task object of type 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() [7/12]

pplx::task<utility::string_t> azure::storage::cloud_blob::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  )

inline

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

Parameters

source	The URI of a source blob.
source_condition	An object that represents the azure::storage::access_condition for the source blob.
destination_condition	An object that represents the azure::storage::access_condition for the destination blob.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object of type 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() [8/12]

pplx::task<utility::string_t> azure::storage::cloud_blob::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  )

inline

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

Parameters

source	The URI of a source blob.
source_condition	An object that represents the azure::storage::access_condition for the source blob.
destination_condition	An object that represents the azure::storage::access_condition for the destination blob.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

A pplx::task object of type 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() [9/12]

WASTORAGE_API pplx::task<utility::string_t> azure::storage::cloud_blob::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.

Parameters

source	The URI of a source blob.
metadata	Metadata that will be set on the destination blob.
source_condition	An object that represents the azure::storage::access_condition for the source blob.
destination_condition	An object that represents the azure::storage::access_condition for the destination blob.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

A pplx::task object of type 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() [10/12]

pplx::task<utility::string_t> azure::storage::cloud_blob::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  )

inline

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

Parameters

source	The URI of a source file.
source_condition	An object that represents the azure::storage::access_condition for the source blob.
destination_condition	An object that represents the azure::storage::access_condition for the destination blob.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object of type 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() [11/12]

pplx::task<utility::string_t> azure::storage::cloud_blob::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  )

inline

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

Parameters

source	The URI of a source file.
source_condition	An object that represents the azure::storage::access_condition for the source blob.
destination_condition	An object that represents the azure::storage::access_condition for the destination blob.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

A pplx::task object of type 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() [12/12]

WASTORAGE_API pplx::task<utility::string_t> azure::storage::cloud_blob::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.

Parameters

source	The URI of a source file.
metadata	Metadata that will be set on the destination blob.
source_condition	An object that represents the azure::storage::access_condition for the source blob.
destination_condition	An object that represents the azure::storage::access_condition for the destination blob.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.
cancellation_token	An pplx::cancellation_token object that is used to cancel the current operation.

Returns

A pplx::task object of type 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_from_blob() [1/4]

utility::string_t azure::storage::cloud_blob::start_copy_from_blob ( const web::http::uri &  source )

inline

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

Parameters

source

The URI of a source blob.

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.

This method is deprecated in favor of start_copy.

start_copy_from_blob() [2/4]

utility::string_t azure::storage::cloud_blob::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  )

inline

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

Parameters

source	The URI of a source blob.
source_condition	An object that represents the azure::storage::access_condition for the source blob.
destination_condition	An object that represents the azure::storage::access_condition for the destination blob.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

The 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.

This method is deprecated in favor of start_copy.

start_copy_from_blob() [3/4]

utility::string_t azure::storage::cloud_blob::start_copy_from_blob ( const cloud_blob &  source )

inline

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

Parameters

source

The URI of a source blob.

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.

This method is deprecated in favor of start_copy.

start_copy_from_blob() [4/4]

utility::string_t azure::storage::cloud_blob::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  )

inline

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

Parameters

source	The URI of a source blob.
source_condition	An object that represents the access_condition for the source blob.
destination_condition	An object that represents the access_condition for the destination blob.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

The 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.

This method is deprecated in favor of start_copy.

start_copy_from_blob_async() [1/4]

pplx::task<utility::string_t> azure::storage::cloud_blob::start_copy_from_blob_async ( const web::http::uri &  source )

inline

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

Parameters

source

The URI of a source blob.

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.

This method is deprecated in favor of start_copy.

start_copy_from_blob_async() [2/4]

pplx::task<utility::string_t> azure::storage::cloud_blob::start_copy_from_blob_async ( const cloud_blob &  source )

inline

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

Parameters

source

The URI of a source blob.

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.

This method is deprecated in favor of start_copy.

start_copy_from_blob_async() [3/4]

WASTORAGE_API pplx::task<utility::string_t> azure::storage::cloud_blob::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.

Parameters

source	The URI of a source blob.
source_condition	An object that represents the azure::storage::access_condition for the source blob.
destination_condition	An object that represents the azure::storage::access_condition for the destination blob.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object of type 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.

This method is deprecated in favor of start_copy.

start_copy_from_blob_async() [4/4]

WASTORAGE_API pplx::task<utility::string_t> azure::storage::cloud_blob::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.

Parameters

source	The URI of a source blob.
source_condition	An object that represents the azure::storage::access_condition for the source blob.
destination_condition	An object that represents the azure::storage::access_condition for the destination blob.
options	An azure::storage::blob_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object of type 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.

This method is deprecated in favor of start_copy.

type()

blob_type azure::storage::cloud_blob::type ( ) const

inline

Gets the type of the blob.

Returns

The type of the blob.

upload_metadata() [1/2]

void azure::storage::cloud_blob::upload_metadata ( )

inline

Updates the blob's metadata.

upload_metadata() [2/2]

void azure::storage::cloud_blob::upload_metadata ( const access_condition &  condition, const blob_request_options &  options, operation_context  context  )

inline

Updates the blob's metadata.

Parameters

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

upload_metadata_async() [1/3]

pplx::task<void> azure::storage::cloud_blob::upload_metadata_async ( )

inline

Initiates an asynchronous operation to update the blob's metadata.

Returns

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

upload_metadata_async() [2/3]

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

inline

Initiates an asynchronous operation to update the blob's metadata.

Parameters

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

Returns

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

upload_metadata_async() [3/3]

WASTORAGE_API pplx::task<void> azure::storage::cloud_blob::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.

Parameters

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

Returns

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

upload_properties() [1/2]

void azure::storage::cloud_blob::upload_properties ( )

inline

Updates the blob's properties.

upload_properties() [2/2]

void azure::storage::cloud_blob::upload_properties ( const access_condition &  condition, const blob_request_options &  options, operation_context  context  )

inline

Updates the blob's properties.

Parameters

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

upload_properties_async() [1/3]

pplx::task<void> azure::storage::cloud_blob::upload_properties_async ( )

inline

Initiates an asynchronous operation to update the blob's properties.

Returns

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

upload_properties_async() [2/3]

pplx::task<void> azure::storage::cloud_blob::upload_properties_async ( const access_condition &  condition, const blob_request_options &  options, operation_context  context  )

inline

Initiates an asynchronous operation to update the blob's properties.

Parameters

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

Returns

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

upload_properties_async() [3/3]

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

inline

Initiates an asynchronous operation to update the blob's properties.

Parameters

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

Returns

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

uri()

const storage_uri& azure::storage::cloud_blob::uri ( ) const

inline

Gets the blob URI for all locations.

Returns

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

version_id()

const utility::string_t& azure::storage::cloud_blob::version_id ( ) const

inline

Gets the version id of the blob, if this blob refers to a version.

Returns

The blob's version id, if the blob refers to a version; otherwise returns an empty string.