The AppendBlobClient allows you to manipulate Azure Storage append blobs. More...

#include <append_blob_client.hpp>

Inheritance diagram for Azure::Storage::Blobs::AppendBlobClient:

Public Member Functions
	AppendBlobClient (const std::string &blobUrl, std::shared_ptr< StorageSharedKeyCredential > credential, const BlobClientOptions &options=BlobClientOptions())
	Initialize a new instance of AppendBlobClient. More...

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

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

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

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

Azure::Response< Models::CreateAppendBlobResult >	Create (const CreateAppendBlobOptions &options=CreateAppendBlobOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Creates a new 0-length append blob. The content of any existing blob is overwritten with the newly initialized append blob. More...

Azure::Response< Models::CreateAppendBlobResult >	CreateIfNotExists (const CreateAppendBlobOptions &options=CreateAppendBlobOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Creates a new 0-length append blob. The content keeps unchanged if the blob already exists. More...

Azure::Response< Models::AppendBlockResult >	AppendBlock (Azure::Core::IO::BodyStream &content, const AppendBlockOptions &options=AppendBlockOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Commits a new block of data, represented by the content BodyStream to the end of the existing append blob. More...

Azure::Response< Models::AppendBlockFromUriResult >	AppendBlockFromUri (const std::string &sourceUri, const AppendBlockFromUriOptions &options=AppendBlockFromUriOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Commits a new block of data, represented by the content BodyStream to the end of the existing append blob. More...

Azure::Response< Models::SealAppendBlobResult >	Seal (const SealAppendBlobOptions &options=SealAppendBlobOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const
	Seals the append blob, making it read only. Any subsequent appends will fail. More...

Public Member Functions inherited from Azure::Storage::Blobs::BlobClient
virtual	~BlobClient ()=default
	Destructor. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Static Public Member Functions inherited from Azure::Storage::Blobs::BlobClient
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. More...

Friends
class	BlobClient

Additional Inherited Members
Protected Attributes inherited from Azure::Storage::Blobs::BlobClient
Azure::Core::Url	m_blobUrl

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

Azure::Nullable< EncryptionKey >	m_customerProvidedKey

Azure::Nullable< std::string >	m_encryptionScope

Detailed Description

An append blob is comprised of blocks and is optimized for append operations. When you modify an append blob, blocks are added to the end of the blob only, via the AppendBlock operation. Updating or deleting of existing blocks is not supported. Unlike a block blob, an append blob does not expose its block IDs.

Constructor & Destructor Documentation

◆ AppendBlobClient() [1/3]

Azure::Storage::Blobs::AppendBlobClient::AppendBlobClient	(	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.

◆ AppendBlobClient() [2/3]

Azure::Storage::Blobs::AppendBlobClient::AppendBlobClient	(	const std::string &	blobUrl,
		std::shared_ptr< 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.

◆ AppendBlobClient() [3/3]

Azure::Storage::Blobs::AppendBlobClient::AppendBlobClient	(	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

◆ AppendBlock()

Azure::Response< Models::AppendBlockResult > Azure::Storage::Blobs::AppendBlobClient::AppendBlock	(	Azure::Core::IO::BodyStream &	content,
		const AppendBlockOptions &	options = `AppendBlockOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

content	A BodyStream containing the content of the block to append.
options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns: An AppendBlockResult describing the state of the updated append blob.

◆ AppendBlockFromUri()

Azure::Response< Models::AppendBlockFromUriResult > Azure::Storage::Blobs::AppendBlobClient::AppendBlockFromUri	(	const std::string &	sourceUri,
		const AppendBlockFromUriOptions &	options = `AppendBlockFromUriOptions()`,
		const Azure::Core::Context &	context = `Azure::Core::Context()`
	)		const

Parameters

sourceUri	Specifies the uri of the source blob. The value may be a uri of up to 2 KB in length that specifies a blob. 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 operation.
options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns: An AppendBlockFromUriResult describing the state of the updated append blob.

◆ Create()

Azure::Response< Models::CreateAppendBlobResult > Azure::Storage::Blobs::AppendBlobClient::Create	(	const CreateAppendBlobOptions &	options = `CreateAppendBlobOptions()`,
		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 CreateAppendBlobResult describing the newly created append blob.

◆ CreateFromConnectionString()

AppendBlobClient Azure::Storage::Blobs::AppendBlobClient::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 AppendBlobClient instance.

◆ CreateIfNotExists()

Azure::Response< Models::CreateAppendBlobResult > Azure::Storage::Blobs::AppendBlobClient::CreateIfNotExists	(	const CreateAppendBlobOptions &	options = `CreateAppendBlobOptions()`,
		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 CreateAppendBlobResult describing the newly created append blob. CreateAppendBlobResult.Created is false if the blob already exists.

◆ Seal()

Azure::Response< Models::SealAppendBlobResult > Azure::Storage::Blobs::AppendBlobClient::Seal	(	const SealAppendBlobOptions &	options = `SealAppendBlobOptions()`,
		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 SealAppendBlobResult describing the state of the sealed append blob.

◆ WithSnapshot()

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

Parameters

snapshot The snapshot identifier.

Returns: A new AppendBlobClient instance.

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

◆ WithVersionId()

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

Parameters

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

Returns: A new AppendBlobClient instance.

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

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

inc/azure/storage/blobs/append_blob_client.hpp
src/append_blob_client.cpp

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AppendBlobClient() [1/3]

◆ AppendBlobClient() [2/3]

◆ AppendBlobClient() [3/3]

Member Function Documentation

◆ AppendBlock()

◆ AppendBlockFromUri()

◆ Create()

◆ CreateFromConnectionString()

◆ CreateIfNotExists()

◆ Seal()

◆ WithSnapshot()

◆ WithVersionId()