The BlobClient allows you to manipulate Azure Storage blobs.

#include <blob_client.hpp>

Inheritance diagram for Azure::Storage::Blobs::BlobClient:

Public Member Functions
virtual	~BlobClient ()=default
	Destructor.

	BlobClient (const std::string &blobUrl, std::shared_ptr< StorageSharedKeyCredential > credential, const BlobClientOptions &options=BlobClientOptions())
	Initialize a new instance of BlobClient.

	BlobClient (const std::string &blobUrl, std::shared_ptr< const Core::Credentials::TokenCredential > credential, const BlobClientOptions &options=BlobClientOptions())
	Initialize a new instance of BlobClient.

	BlobClient (const std::string &blobUrl, const BlobClientOptions &options=BlobClientOptions())
	Initialize a new instance of BlobClient.

BlockBlobClient	AsBlockBlobClient () const
	Creates a new BlockBlobClient object with the same URL as this BlobClient. The new BlockBlobClient uses the same request policy pipeline as this BlobClient.

AppendBlobClient	AsAppendBlobClient () const
	Creates a new AppendBlobClient object with the same URL as this BlobClient. The new AppendBlobClient uses the same request policy pipeline as this BlobClient.

PageBlobClient	AsPageBlobClient () const
	Creates a new PageBlobClient object with the same URL as this BlobClient. The new PageBlobClient uses the same request policy pipeline as this BlobClient.

std::string	GetUrl () const
	Gets the blob's primary URL endpoint.

BlobClient	WithSnapshot (const std::string &snapshot) const
	Initializes a new instance of the BlobClient class with an identical URL source but the specified snapshot timestamp.

BlobClient	WithVersionId (const std::string &versionId) const
	Creates a clone of this instance that references a version ID rather than the base blob.

Azure::Response< Models::BlobProperties >	GetProperties (const GetBlobPropertiesOptions &options=GetBlobPropertiesOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob.

Azure::Response< Models::SetBlobHttpHeadersResult >	SetHttpHeaders (Models::BlobHttpHeaders httpHeaders, const SetBlobHttpHeadersOptions &options=SetBlobHttpHeadersOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Sets system properties on the blob.

Azure::Response< Models::SetBlobMetadataResult >	SetMetadata (Metadata metadata, const SetBlobMetadataOptions &options=SetBlobMetadataOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Sets user-defined metadata for the specified blob as one or more name-value pairs.

Azure::Response< Models::SetBlobAccessTierResult >	SetAccessTier (Models::AccessTier accessTier, const SetBlobAccessTierOptions &options=SetBlobAccessTierOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Sets the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage or general purpose v2 account.

Azure::Response< Models::CopyBlobFromUriResult >	CopyFromUri (const std::string &sourceUri, const CopyBlobFromUriOptions &options=CopyBlobFromUriOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Copies data from the source to this blob, synchronously.

StartBlobCopyOperation	StartCopyFromUri (const std::string &sourceUri, const StartBlobCopyFromUriOptions &options=StartBlobCopyFromUriOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Copies data at from the source to this blob.

Azure::Response< Models::AbortBlobCopyFromUriResult >	AbortCopyFromUri (const std::string &copyId, const AbortBlobCopyFromUriOptions &options=AbortBlobCopyFromUriOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Aborts a pending StartCopyFromUri operation, and leaves this blob with zero length and full metadata.

Azure::Response< Models::DownloadBlobResult >	Download (const DownloadBlobOptions &options=DownloadBlobOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Downloads a blob or a blob range from the service, including its metadata and properties.

Azure::Response< Models::DownloadBlobToResult >	DownloadTo (uint8_t *buffer, size_t bufferSize, const DownloadBlobToOptions &options=DownloadBlobToOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Downloads a blob or a blob range from the service to a memory buffer using parallel requests.

Azure::Response< Models::DownloadBlobToResult >	DownloadTo (const std::string &fileName, const DownloadBlobToOptions &options=DownloadBlobToOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Downloads a blob or a blob range from the service to a file using parallel requests.

Azure::Response< Models::CreateBlobSnapshotResult >	CreateSnapshot (const CreateBlobSnapshotOptions &options=CreateBlobSnapshotOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Creates a read-only snapshot of a blob.

Azure::Response< Models::DeleteBlobResult >	Delete (const DeleteBlobOptions &options=DeleteBlobOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Marks the specified blob or snapshot for deletion. The blob is later deleted during garbage collection. Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time using DeleteBlobOptions.DeleteSnapshots.

Azure::Response< Models::DeleteBlobResult >	DeleteIfExists (const DeleteBlobOptions &options=DeleteBlobOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Marks the specified blob or snapshot for deletion if it exists.

Azure::Response< Models::UndeleteBlobResult >	Undelete (const UndeleteBlobOptions &options=UndeleteBlobOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Restores the contents and metadata of a soft deleted blob and any associated soft deleted snapshots.

Azure::Response< Models::SetBlobTagsResult >	SetTags (std::map< std::string, std::string > tags, const SetBlobTagsOptions &options=SetBlobTagsOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Sets tags on the underlying blob.

Azure::Response< std::map< std::string, std::string > >	GetTags (const GetBlobTagsOptions &options=GetBlobTagsOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Gets the tags associated with the underlying blob.

Azure::Response< Models::SetBlobImmutabilityPolicyResult >	SetImmutabilityPolicy (Models::BlobImmutabilityPolicy immutabilityPolicy, const SetBlobImmutabilityPolicyOptions &options=SetBlobImmutabilityPolicyOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Sets the immutability policy on a blob, snapshot or version. Note that Blob Versioning must be enabled on your storage account, and the blob must be in a Container with immutable storage with versioning enabled to call this API.

Azure::Response< Models::DeleteBlobImmutabilityPolicyResult >	DeleteImmutabilityPolicy (const DeleteBlobImmutabilityPolicyOptions &options=DeleteBlobImmutabilityPolicyOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Deletes the Immutability Policy associated with the Blob.

Azure::Response< Models::SetBlobLegalHoldResult >	SetLegalHold (bool hasLegalHold, const SetBlobLegalHoldOptions &options=SetBlobLegalHoldOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Sets a legal hold on the blob. Note that Blob Versioning must be enabled on your storage account, and the blob must be in a Container with immutable storage with versioning enabled to call this API.

Azure::Response< Models::AccountInfo >	GetAccountInfo (const GetAccountInfoOptions &options=GetAccountInfoOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Returns the sku name and account kind for the specified account.

Static Public Member Functions
static BlobClient	CreateFromConnectionString (const std::string &connectionString, const std::string &blobContainerName, const std::string &blobName, const BlobClientOptions &options=BlobClientOptions())
	Initialize a new instance of BlobClient.

Protected Attributes
Azure::Core::Url	m_blobUrl
	Blob Url.

std::shared_ptr< Azure::Core::Http::_internal::HttpPipeline >	m_pipeline
	Http Pipeline.

Azure::Nullable< EncryptionKey >	m_customerProvidedKey
	Customer provided encryption key.

Azure::Nullable< std::string >	m_encryptionScope
	Encryption scope.

Friends
class	BlobContainerClient

class	Files::DataLake::DataLakeFileSystemClient

class	Files::DataLake::DataLakeDirectoryClient

class	Files::DataLake::DataLakeFileClient

class	BlobLeaseClient

class	BlobServiceBatch

class	BlobContainerBatch

Constructor & Destructor Documentation

◆ ~BlobClient()

virtual Azure::Storage::Blobs::BlobClient::~BlobClient ( )

virtualdefault

◆ BlobClient() [1/3]

Azure::Storage::Blobs::BlobClient::BlobClient	(	const std::string &	blobUrl,
		std::shared_ptr< StorageSharedKeyCredential >	credential,
		const BlobClientOptions &	options = `BlobClientOptions()`
	)

explicit

Parameters

blobUrl	A URL referencing the blob that includes the name of the account, the name of the container, and the name of the blob.
credential	The shared key credential used to sign requests.
options	Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

◆ BlobClient() [2/3]

Azure::Storage::Blobs::BlobClient::BlobClient	(	const std::string &	blobUrl,
		std::shared_ptr< const Core::Credentials::TokenCredential >	credential,
		const BlobClientOptions &	options = `BlobClientOptions()`
	)

explicit

Parameters

blobUrl	A URL referencing the blob that includes the name of the account, the name of the container, and the name of the blob.
credential	The token credential used to sign requests.
options	Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

◆ BlobClient() [3/3]

Azure::Storage::Blobs::BlobClient::BlobClient	(	const std::string &	blobUrl,
		const BlobClientOptions &	options = `BlobClientOptions()`
	)

explicit

Parameters

blobUrl	A URL referencing the blob that includes the name of the account, the name of the container, and the name of the blob, and possibly also a SAS token.
options	Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

Member Function Documentation

◆ AbortCopyFromUri()

Azure::Response< Models::AbortBlobCopyFromUriResult > Azure::Storage::Blobs::BlobClient::AbortCopyFromUri	(	const std::string &	copyId,
		const AbortBlobCopyFromUriOptions &	options = `AbortBlobCopyFromUriOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

copyId	ID of the copy operation to abort.
options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns: An AbortBlobCopyFromUriResult on successfully aborting.

◆ AsAppendBlobClient()

AppendBlobClient Azure::Storage::Blobs::BlobClient::AsAppendBlobClient ( ) const

Returns: A new AppendBlobClient instance.

◆ AsBlockBlobClient()

BlockBlobClient Azure::Storage::Blobs::BlobClient::AsBlockBlobClient ( ) const

Returns: A new BlockBlobClient instance.

◆ AsPageBlobClient()

PageBlobClient Azure::Storage::Blobs::BlobClient::AsPageBlobClient ( ) const

Returns: A new PageBlobClient instance.

◆ CopyFromUri()

Azure::Response< Models::CopyBlobFromUriResult > Azure::Storage::Blobs::BlobClient::CopyFromUri	(	const std::string &	sourceUri,
		const CopyBlobFromUriOptions &	options = `CopyBlobFromUriOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

sourceUri	Specifies the URL of the source blob. The value may be a URL of up to 2 KB in length that specifies a blob. The value should be URL-encoded as it would appear in a request URI. The source blob must either be public or must be authorized via a shared access signature. If the size of the source blob is greater than 256 MB, the request will fail with 409 (Conflict). The blob type of the source blob has to be block blob.
options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns: A CopyBlobFromUriResult describing the copy result.

◆ CreateFromConnectionString()

static BlobClient Azure::Storage::Blobs::BlobClient::CreateFromConnectionString	(	const std::string &	connectionString,
		const std::string &	blobContainerName,
		const std::string &	blobName,
		const BlobClientOptions &	options = `BlobClientOptions()`
	)

static

Parameters

connectionString	A connection string includes the authentication information required for your application to access data in an Azure Storage account at runtime.
blobContainerName	The name of the container containing this blob.
blobName	The name of this blob.
options	Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

Returns: A new BlobClient instance.

◆ CreateSnapshot()

Azure::Response< Models::CreateBlobSnapshotResult > Azure::Storage::Blobs::BlobClient::CreateSnapshot	(	const CreateBlobSnapshotOptions &	options = `CreateBlobSnapshotOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns: A CreateBlobSnapshotResult describing the new blob snapshot.

◆ Delete()

Azure::Response< Models::DeleteBlobResult > Azure::Storage::Blobs::BlobClient::Delete	(	const DeleteBlobOptions &	options = `DeleteBlobOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns: A DeleteBlobResult on successfully deleting.

◆ DeleteIfExists()

Azure::Response< Models::DeleteBlobResult > Azure::Storage::Blobs::BlobClient::DeleteIfExists	(	const DeleteBlobOptions &	options = `DeleteBlobOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns: A DeleteBlobResult on successfully deleting. DeleteBlobResult.Deleted is false if the blob doesn't exist.

◆ DeleteImmutabilityPolicy()

Azure::Response< Models::DeleteBlobImmutabilityPolicyResult > Azure::Storage::Blobs::BlobClient::DeleteImmutabilityPolicy	(	const DeleteBlobImmutabilityPolicyOptions &	options = `DeleteBlobImmutabilityPolicyOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns: A DeleteBlobImmutabilityPolicyResult on successfully deleting immutability policy.

◆ Download()

Azure::Response< Models::DownloadBlobResult > Azure::Storage::Blobs::BlobClient::Download	(	const DownloadBlobOptions &	options = `DownloadBlobOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns: A DownloadBlobResult describing the downloaded blob. BlobDownloadResponse.BodyStream contains the blob's data.

◆ DownloadTo() [1/2]

Azure::Response< Models::DownloadBlobToResult > Azure::Storage::Blobs::BlobClient::DownloadTo	(	const std::string &	fileName,
		const DownloadBlobToOptions &	options = `DownloadBlobToOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

fileName	A file path to write the downloaded content to.
options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns: A DownloadBlobToResult describing the downloaded blob.

◆ DownloadTo() [2/2]

Azure::Response< Models::DownloadBlobToResult > Azure::Storage::Blobs::BlobClient::DownloadTo	(	uint8_t *	buffer,
		size_t	bufferSize,
		const DownloadBlobToOptions &	options = `DownloadBlobToOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

buffer	A memory buffer to write the blob content to.
bufferSize	Size of the memory buffer. Size must be larger or equal to size of the blob or blob range.
options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns: A DownloadBlobToResult describing the downloaded blob.

◆ GetAccountInfo()

Azure::Response< Models::AccountInfo > Azure::Storage::Blobs::BlobClient::GetAccountInfo	(	const GetAccountInfoOptions &	options = `GetAccountInfoOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns: AccountInfo describing the account.

◆ GetProperties()

Azure::Response< Models::BlobProperties > Azure::Storage::Blobs::BlobClient::GetProperties	(	const GetBlobPropertiesOptions &	options = `GetBlobPropertiesOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns: A BlobProperties describing the blob's properties.

◆ GetTags()

Azure::Response< std::map< std::string, std::string > > Azure::Storage::Blobs::BlobClient::GetTags	(	const GetBlobTagsOptions &	options = `GetBlobTagsOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns: BlobTags on successfully getting tags.

◆ GetUrl()

std::string Azure::Storage::Blobs::BlobClient::GetUrl ( ) const

inline

Returns: The blob's primary URL endpoint.

◆ SetAccessTier()

Azure::Response< Models::SetBlobAccessTierResult > Azure::Storage::Blobs::BlobClient::SetAccessTier	(	Models::AccessTier	accessTier,
		const SetBlobAccessTierOptions &	options = `SetBlobAccessTierOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

accessTier	Indicates the tier to be set on the blob.
options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns: A SetBlobAccessTierResult on successfully setting the tier.

◆ SetHttpHeaders()

Azure::Response< Models::SetBlobHttpHeadersResult > Azure::Storage::Blobs::BlobClient::SetHttpHeaders	(	Models::BlobHttpHeaders	httpHeaders,
		const SetBlobHttpHeadersOptions &	options = `SetBlobHttpHeadersOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

httpHeaders	The standard HTTP header system properties to set.
options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns: A SetBlobHttpHeadersResult describing the updated blob.

◆ SetImmutabilityPolicy()

Azure::Response< Models::SetBlobImmutabilityPolicyResult > Azure::Storage::Blobs::BlobClient::SetImmutabilityPolicy	(	Models::BlobImmutabilityPolicy	immutabilityPolicy,
		const SetBlobImmutabilityPolicyOptions &	options = `SetBlobImmutabilityPolicyOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

immutabilityPolicy	The blob immutability policy to set.
options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns: The blob's immutability policy.

◆ SetLegalHold()

Azure::Response< Models::SetBlobLegalHoldResult > Azure::Storage::Blobs::BlobClient::SetLegalHold	(	bool	hasLegalHold,
		const SetBlobLegalHoldOptions &	options = `SetBlobLegalHoldOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

hasLegalHold	Set to true to set a legal hold on the blob. Set to false to remove an existing legal hold.
options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns: A SetBlobLegalHoldResult on successfully setting legal hold.

◆ SetMetadata()

Azure::Response< Models::SetBlobMetadataResult > Azure::Storage::Blobs::BlobClient::SetMetadata	(	Metadata	metadata,
		const SetBlobMetadataOptions &	options = `SetBlobMetadataOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

metadata	Custom metadata to set for this blob.
options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns: A SetBlobMetadataResult describing the updated blob.

◆ SetTags()

Azure::Response< Models::SetBlobTagsResult > Azure::Storage::Blobs::BlobClient::SetTags	(	std::map< std::string, std::string >	tags,
		const SetBlobTagsOptions &	options = `SetBlobTagsOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

tags	The tags to set on the blob.
options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns: A SetBlobTagsInfo on successfully setting tags.

◆ StartCopyFromUri()

StartBlobCopyOperation Azure::Storage::Blobs::BlobClient::StartCopyFromUri	(	const std::string &	sourceUri,
		const StartBlobCopyFromUriOptions &	options = `StartBlobCopyFromUriOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

sourceUri	Specifies the uri of the source blob. The value may a uri of up to 2 KB in length that specifies a blob. A source blob in the same storage account can be authenticated via Shared Key. However, if the source is a blob in another account, the source blob must either be public or must be authenticated via a shared access signature. If the source blob is public, no authentication is required to perform the copy operation.
options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns: A StartBlobCopyOperation describing the state of the copy operation.

◆ Undelete()

Azure::Response< Models::UndeleteBlobResult > Azure::Storage::Blobs::BlobClient::Undelete	(	const UndeleteBlobOptions &	options = `UndeleteBlobOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns: A UndeleteBlobResult on successfully deleting.

◆ WithSnapshot()

BlobClient Azure::Storage::Blobs::BlobClient::WithSnapshot ( const std::string & snapshot ) const

Parameters

snapshot The snapshot identifier.

Returns: A new BlobClient instance.

Remarks: Pass empty string to remove the snapshot returning the base blob.

◆ WithVersionId()

BlobClient Azure::Storage::Blobs::BlobClient::WithVersionId ( const std::string & versionId ) const

Parameters

versionId The version ID returning a URL to the base blob.

Returns: A new BlobClient instance.

Remarks: Pass empty string to remove the version ID returning the base blob.

The documentation for this class was generated from the following file:

inc/azure/storage/blobs/blob_client.hpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Constructor & Destructor Documentation

◆ ~BlobClient()

◆ BlobClient() [1/3]

◆ BlobClient() [2/3]

◆ BlobClient() [3/3]

Member Function Documentation

◆ AbortCopyFromUri()

◆ AsAppendBlobClient()

◆ AsBlockBlobClient()

◆ AsPageBlobClient()

◆ CopyFromUri()

◆ CreateFromConnectionString()

◆ CreateSnapshot()

◆ Delete()

◆ DeleteIfExists()

◆ DeleteImmutabilityPolicy()

◆ Download()

◆ DownloadTo() [1/2]

◆ DownloadTo() [2/2]

◆ GetAccountInfo()

◆ GetProperties()

◆ GetTags()

◆ GetUrl()

◆ SetAccessTier()

◆ SetHttpHeaders()

◆ SetImmutabilityPolicy()

◆ SetLegalHold()

◆ SetMetadata()

◆ SetTags()

◆ StartCopyFromUri()

◆ Undelete()

◆ WithSnapshot()

◆ WithVersionId()