Azure::Storage::Blobs::AppendBlobClient Class Reference

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 &blobUri, std::shared_ptr< SharedKeyCredential > credential, const AppendBlobClientOptions &options=AppendBlobClientOptions())
	Initialize a new instance of AppendBlobClient. More...
	AppendBlobClient (const std::string &blobUri, std::shared_ptr< Core::Credentials::ClientSecretCredential > credential, const AppendBlobClientOptions &options=AppendBlobClientOptions())
	Initialize a new instance of AppendBlobClient. More...
	AppendBlobClient (const std::string &blobUri, const AppendBlobClientOptions &options=AppendBlobClientOptions())
	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 uri 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::Core::Response< CreateAppendBlobResult >	Create (const CreateAppendBlobOptions &options=CreateAppendBlobOptions()) const
	Creates a new 0-length append blob. The content of any existing blob is overwritten with the newly initialized append blob. More...
Azure::Core::Response< AppendBlockResult >	AppendBlock (Azure::Core::Http::BodyStream *content, const AppendBlockOptions &options=AppendBlockOptions()) const
	Commits a new block of data, represented by the content BodyStream to the end of the existing append blob. More...
Azure::Core::Response< AppendBlockFromUriResult >	AppendBlockFromUri (const std::string &sourceUri, const AppendBlockFromUriOptions &options=AppendBlockFromUriOptions()) const
	Commits a new block of data, represented by the content BodyStream to the end of the existing append blob. More...
Azure::Core::Response< SealAppendBlobResult >	Seal (const SealAppendBlobOptions &options=SealAppendBlobOptions()) const
	Seals the append blob, making it read only. Any subsequent appends will fail. More...
Public Member Functions inherited from Azure::Storage::Blobs::BlobClient
	BlobClient (const std::string &blobUri, std::shared_ptr< SharedKeyCredential > credential, const BlobClientOptions &options=BlobClientOptions())
	Initialize a new instance of BlobClient. More...
	BlobClient (const std::string &blobUri, std::shared_ptr< Core::Credentials::ClientSecretCredential > credential, const BlobClientOptions &options=BlobClientOptions())
	Initialize a new instance of BlobClient. More...
	BlobClient (const std::string &blobUri, const BlobClientOptions &options=BlobClientOptions())
	Initialize a new instance of BlobClient. More...
BlockBlobClient	GetBlockBlobClient () const
	Creates a new BlockBlobClient object with the same uri as this BlobClient. The new BlockBlobClient uses the same request policy pipeline as this BlobClient. More...
AppendBlobClient	GetAppendBlobClient () const
	Creates a new AppendBlobClient object with the same uri as this BlobClient. The new AppendBlobClient uses the same request policy pipeline as this BlobClient. More...
PageBlobClient	GetPageBlobClient () const
	Creates a new PageBlobClient object with the same uri as this BlobClient. The new PageBlobClient uses the same request policy pipeline as this BlobClient. More...
std::string	GetUri () const
	Gets the blob's primary uri endpoint. More...
BlobClient	WithSnapshot (const std::string &snapshot) const
	Initializes a new instance of the BlobClient class with an identical uri 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::Core::Response< GetBlobPropertiesResult >	GetProperties (const GetBlobPropertiesOptions &options=GetBlobPropertiesOptions()) 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::Core::Response< SetBlobHttpHeadersResult >	SetHttpHeaders (BlobHttpHeaders httpHeaders, const SetBlobHttpHeadersOptions &options=SetBlobHttpHeadersOptions()) const
	Sets system properties on the blob. More...
Azure::Core::Response< SetBlobMetadataResult >	SetMetadata (std::map< std::string, std::string > metadata, const SetBlobMetadataOptions &options=SetBlobMetadataOptions()) const
	Sets user-defined metadata for the specified blob as one or more name-value pairs. More...
Azure::Core::Response< SetBlobAccessTierResult >	SetAccessTier (AccessTier Tier, const SetBlobAccessTierOptions &options=SetBlobAccessTierOptions()) 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...
Azure::Core::Response< StartCopyBlobFromUriResult >	StartCopyFromUri (const std::string &sourceUri, const StartCopyBlobFromUriOptions &options=StartCopyBlobFromUriOptions()) const
	Copies data at from the source to this blob. More...
Azure::Core::Response< AbortCopyBlobFromUriResult >	AbortCopyFromUri (const std::string &copyId, const AbortCopyBlobFromUriOptions &options=AbortCopyBlobFromUriOptions()) const
	Aborts a pending StartCopyFromUri operation, and leaves this blob with zero length and full metadata. More...
Azure::Core::Response< DownloadBlobResult >	Download (const DownloadBlobOptions &options=DownloadBlobOptions()) const
	Downloads a blob or a blob range from the service, including its metadata and properties. More...
Azure::Core::Response< DownloadBlobToResult >	DownloadTo (uint8_t *buffer, std::size_t bufferSize, const DownloadBlobToOptions &options=DownloadBlobToOptions()) const
	Downloads a blob or a blob range from the service to a memory buffer using parallel requests. More...
Azure::Core::Response< DownloadBlobToResult >	DownloadTo (const std::string &file, const DownloadBlobToOptions &options=DownloadBlobToOptions()) const
	Downloads a blob or a blob range from the service to a file using parallel requests. More...
Azure::Core::Response< CreateBlobSnapshotResult >	CreateSnapshot (const CreateBlobSnapshotOptions &options=CreateBlobSnapshotOptions()) const
	Creates a read-only snapshot of a blob. More...
Azure::Core::Response< DeleteBlobResult >	Delete (const DeleteBlobOptions &options=DeleteBlobOptions()) 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::Core::Response< UndeleteBlobResult >	Undelete (const UndeleteBlobOptions &options=UndeleteBlobOptions()) const
	Restores the contents and metadata of a soft deleted blob and any associated soft deleted snapshots. More...
Azure::Core::Response< AcquireBlobLeaseResult >	AcquireLease (const std::string &proposedLeaseId, int32_t duration, const AcquireBlobLeaseOptions &options=AcquireBlobLeaseOptions()) const
	Acquires a lease on the blob. More...
Azure::Core::Response< RenewBlobLeaseResult >	RenewLease (const std::string &leaseId, const RenewBlobLeaseOptions &options=RenewBlobLeaseOptions()) const
	Renews the blob's previously-acquired lease. More...
Azure::Core::Response< ReleaseBlobLeaseResult >	ReleaseLease (const std::string &leaseId, const ReleaseBlobLeaseOptions &options=ReleaseBlobLeaseOptions()) const
	Releases the blob's previously-acquired lease. More...
Azure::Core::Response< ChangeBlobLeaseResult >	ChangeLease (const std::string &leaseId, const std::string &proposedLeaseId, const ChangeBlobLeaseOptions &options=ChangeBlobLeaseOptions()) const
	Changes the lease of an active lease. More...
Azure::Core::Response< BreakBlobLeaseResult >	BreakLease (const BreakBlobLeaseOptions &options=BreakBlobLeaseOptions()) const
	Breaks the previously-acquired lease. More...
Azure::Core::Response< SetBlobTagsResult >	SetTags (std::map< std::string, std::string > tags, const SetBlobTagsOptions &options=SetBlobTagsOptions()) const
	Sets tags on the underlying blob. More...
Azure::Core::Response< GetBlobTagsResult >	GetTags (const GetBlobTagsOptions &options=GetBlobTagsOptions()) const
	Gets the tags associated with the underlying blob. More...

Static Public Member Functions
static AppendBlobClient	CreateFromConnectionString (const std::string &connectionString, const std::string &containerName, const std::string &blobName, const AppendBlobClientOptions &options=AppendBlobClientOptions())
	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 &containerName, 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::Http::Url	m_blobUrl
std::shared_ptr< Azure::Core::Http::HttpPipeline >	m_pipeline
Azure::Core::Nullable< EncryptionKey >	m_customerProvidedKey
Azure::Core::Nullable< std::string >	m_encryptionScope

Detailed Description

The AppendBlobClient allows you to manipulate Azure Storage append blobs.

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 &  blobUri, std::shared_ptr< SharedKeyCredential >  credential, const AppendBlobClientOptions &  options = AppendBlobClientOptions()  )

explicit

Initialize a new instance of AppendBlobClient.

Parameters

blobUri	A uri 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(blobUri, std::move(credential), options)
  {
  }

AppendBlobClient() [2/3]

Azure::Storage::Blobs::AppendBlobClient::AppendBlobClient ( const std::string &  blobUri, std::shared_ptr< Core::Credentials::ClientSecretCredential >  credential, const AppendBlobClientOptions &  options = AppendBlobClientOptions()  )

explicit

Initialize a new instance of AppendBlobClient.

Parameters

blobUri	A uri referencing the blob that includes the name of the account, the name of the container, and the name of the blob.
credential	The client secret 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(blobUri, std::move(credential), options)
  {
  }

AppendBlobClient() [3/3]

Azure::Storage::Blobs::AppendBlobClient::AppendBlobClient ( const std::string &  blobUri, const AppendBlobClientOptions &  options = AppendBlobClientOptions()  )

explicit

Initialize a new instance of AppendBlobClient.

Parameters

blobUri	A uri 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.

      : BlobClient(blobUri, options)
  {
  }

Member Function Documentation

AppendBlock()

Azure::Core::Response< AppendBlockResult > Azure::Storage::Blobs::AppendBlobClient::AppendBlock	(	Azure::Core::Http::BodyStream *	content,
		const AppendBlockOptions &	options = AppendBlockOptions()
	)		const

Commits a new block of data, represented by the content BodyStream to the end of the existing append blob.

Parameters

content	A BodyStream containing the content of the block to append.
options	Optional parameters to execute this function.

Returns

A AppendBlockResult describing the state of the updated append blob.

  {
    BlobRestClient::AppendBlob::AppendBlockOptions protocolLayerOptions;
    protocolLayerOptions.TransactionalContentMd5 = options.TransactionalContentMd5;
    protocolLayerOptions.TransactionalContentCrc64 = options.TransactionalContentCrc64;
    protocolLayerOptions.LeaseId = options.AccessConditions.LeaseId;
    protocolLayerOptions.MaxSize = options.AccessConditions.MaxSize;
    protocolLayerOptions.AppendPosition = options.AccessConditions.AppendPosition;
    protocolLayerOptions.IfModifiedSince = options.AccessConditions.IfModifiedSince;
    protocolLayerOptions.IfUnmodifiedSince = options.AccessConditions.IfUnmodifiedSince;
    protocolLayerOptions.IfMatch = options.AccessConditions.IfMatch;
    protocolLayerOptions.IfNoneMatch = options.AccessConditions.IfNoneMatch;
    protocolLayerOptions.IfTags = options.AccessConditions.TagConditions;
    if (m_customerProvidedKey.HasValue())
    {
      protocolLayerOptions.EncryptionKey = m_customerProvidedKey.GetValue().Key;
      protocolLayerOptions.EncryptionKeySha256 = m_customerProvidedKey.GetValue().KeyHash;
      protocolLayerOptions.EncryptionAlgorithm = m_customerProvidedKey.GetValue().Algorithm;
    }
    protocolLayerOptions.EncryptionScope = m_encryptionScope;
    return BlobRestClient::AppendBlob::AppendBlock(
        options.Context, *m_pipeline, m_blobUrl, content, protocolLayerOptions);
  }

AppendBlockFromUri()

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

Commits a new block of data, represented by the content BodyStream to the end of the existing append blob.

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.

Returns

A AppendBlockFromUriResult describing the state of the updated append blob.

  {
    BlobRestClient::AppendBlob::AppendBlockFromUriOptions protocolLayerOptions;
    protocolLayerOptions.SourceUri = sourceUri;
    if (options.SourceOffset.HasValue() && options.SourceLength.HasValue())
    {
      protocolLayerOptions.SourceRange = std::make_pair(
          options.SourceOffset.GetValue(),
          options.SourceOffset.GetValue() + options.SourceLength.GetValue() - 1);
    }
    else if (options.SourceOffset.HasValue())
    {
      protocolLayerOptions.SourceRange = std::make_pair(
          options.SourceOffset.GetValue(),
          std::numeric_limits<
              std::remove_reference_t<decltype(options.SourceOffset.GetValue())>>::max());
    }
    protocolLayerOptions.TransactionalContentMd5 = options.TransactionalContentMd5;
    protocolLayerOptions.TransactionalContentCrc64 = options.TransactionalContentCrc64;
    protocolLayerOptions.LeaseId = options.AccessConditions.LeaseId;
    protocolLayerOptions.MaxSize = options.AccessConditions.MaxSize;
    protocolLayerOptions.AppendPosition = options.AccessConditions.AppendPosition;
    protocolLayerOptions.IfModifiedSince = options.AccessConditions.IfModifiedSince;
    protocolLayerOptions.IfUnmodifiedSince = options.AccessConditions.IfUnmodifiedSince;
    protocolLayerOptions.IfMatch = options.AccessConditions.IfMatch;
    protocolLayerOptions.IfNoneMatch = options.AccessConditions.IfNoneMatch;
    protocolLayerOptions.IfTags = options.AccessConditions.TagConditions;
    if (m_customerProvidedKey.HasValue())
    {
      protocolLayerOptions.EncryptionKey = m_customerProvidedKey.GetValue().Key;
      protocolLayerOptions.EncryptionKeySha256 = m_customerProvidedKey.GetValue().KeyHash;
      protocolLayerOptions.EncryptionAlgorithm = m_customerProvidedKey.GetValue().Algorithm;
    }
    protocolLayerOptions.EncryptionScope = m_encryptionScope;
    return BlobRestClient::AppendBlob::AppendBlockFromUri(
        options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
  }

Create()

Azure::Core::Response< CreateAppendBlobResult > Azure::Storage::Blobs::AppendBlobClient::Create

(

const CreateAppendBlobOptions &

options = CreateAppendBlobOptions()

)

const

Creates a new 0-length append blob. The content of any existing blob is overwritten with the newly initialized append blob.

Parameters

options

Optional parameters to execute this function.

Returns

A CreateAppendBlobResult describing the newly created append blob.

  {
    BlobRestClient::AppendBlob::CreateAppendBlobOptions protocolLayerOptions;
    protocolLayerOptions.HttpHeaders = options.HttpHeaders;
    protocolLayerOptions.Metadata = options.Metadata;
    protocolLayerOptions.LeaseId = options.AccessConditions.LeaseId;
    protocolLayerOptions.IfModifiedSince = options.AccessConditions.IfModifiedSince;
    protocolLayerOptions.IfUnmodifiedSince = options.AccessConditions.IfUnmodifiedSince;
    protocolLayerOptions.IfMatch = options.AccessConditions.IfMatch;
    protocolLayerOptions.IfNoneMatch = options.AccessConditions.IfNoneMatch;
    protocolLayerOptions.IfTags = options.AccessConditions.TagConditions;
    if (m_customerProvidedKey.HasValue())
    {
      protocolLayerOptions.EncryptionKey = m_customerProvidedKey.GetValue().Key;
      protocolLayerOptions.EncryptionKeySha256 = m_customerProvidedKey.GetValue().KeyHash;
      protocolLayerOptions.EncryptionAlgorithm = m_customerProvidedKey.GetValue().Algorithm;
    }
    protocolLayerOptions.EncryptionScope = m_encryptionScope;
    return BlobRestClient::AppendBlob::Create(
        options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
  }

CreateFromConnectionString()

AppendBlobClient Azure::Storage::Blobs::AppendBlobClient::CreateFromConnectionString ( const std::string &  connectionString, const std::string &  containerName, const std::string &  blobName, const AppendBlobClientOptions &  options = AppendBlobClientOptions()  )

static

Initialize a new instance of AppendBlobClient.

Parameters

connectionString	A connection string includes the authentication information required for your application to access data in an Azure Storage account at runtime.
containerName	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.

  {
    AppendBlobClient newClient(
        BlobClient::CreateFromConnectionString(connectionString, containerName, blobName, options));
    return newClient;
  }

Seal()

Azure::Core::Response< SealAppendBlobResult > Azure::Storage::Blobs::AppendBlobClient::Seal

(

const SealAppendBlobOptions &

options = SealAppendBlobOptions()

)

const

Seals the append blob, making it read only. Any subsequent appends will fail.

Parameters

options

Optional parameters to execute this function.

Returns

A SealAppendBlobResult describing the state of the sealed append blob.

  {
    BlobRestClient::AppendBlob::SealAppendBlobOptions protocolLayerOptions;
    protocolLayerOptions.LeaseId = options.AccessConditions.LeaseId;
    protocolLayerOptions.AppendPosition = options.AccessConditions.AppendPosition;
    protocolLayerOptions.IfModifiedSince = options.AccessConditions.IfModifiedSince;
    protocolLayerOptions.IfUnmodifiedSince = options.AccessConditions.IfUnmodifiedSince;
    protocolLayerOptions.IfMatch = options.AccessConditions.IfMatch;
    protocolLayerOptions.IfNoneMatch = options.AccessConditions.IfNoneMatch;
    protocolLayerOptions.IfTags = options.AccessConditions.TagConditions;
    return BlobRestClient::AppendBlob::Seal(
        options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
  }

WithSnapshot()

AppendBlobClient Azure::Storage::Blobs::AppendBlobClient::WithSnapshot

(

const std::string &

snapshot

)

const

Initializes a new instance of the AppendBlobClient class with an identical uri source but the specified snapshot timestamp.

Parameters

snapshot

The snapshot identifier.

Returns

A new AppendBlobClient instance.

Remarks

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

  {
    AppendBlobClient newClient(*this);
    if (snapshot.empty())
    {
      newClient.m_blobUrl.RemoveQuery(Details::c_HttpQuerySnapshot);
    }
    else
    {
      newClient.m_blobUrl.AppendQuery(Details::c_HttpQuerySnapshot, snapshot);
    }
    return newClient;
  }

WithVersionId()

AppendBlobClient Azure::Storage::Blobs::AppendBlobClient::WithVersionId

(

const std::string &

versionId

)

const

Creates a clone of this instance that references a version ID rather than the base blob.

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.

  {
    AppendBlobClient newClient(*this);
    if (versionId.empty())
    {
      newClient.m_blobUrl.RemoveQuery(Details::c_HttpQueryVersionId);
    }
    else
    {
      newClient.m_blobUrl.AppendQuery(Details::c_HttpQueryVersionId, versionId);
    }
    return newClient;
  }

---

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

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