Azure::Storage::Blobs::BlockBlobClient Class Reference

The BlockBlobClient allows you to manipulate Azure Storage block blobs. More...

#include <block_blob_client.hpp>

Inheritance diagram for Azure::Storage::Blobs::BlockBlobClient:

Public Member Functions
	BlockBlobClient (const std::string &blobUri, std::shared_ptr< SharedKeyCredential > credential, const BlockBlobClientOptions &options=BlockBlobClientOptions())
	Initialize a new instance of BlockBlobClient. More...
	BlockBlobClient (const std::string &blobUri, std::shared_ptr< Core::Credentials::ClientSecretCredential > credential, const BlockBlobClientOptions &options=BlockBlobClientOptions())
	Initialize a new instance of BlockBlobClient. More...
	BlockBlobClient (const std::string &blobUri, const BlockBlobClientOptions &options=BlockBlobClientOptions())
	Initialize a new instance of BlockBlobClient. More...
BlockBlobClient	WithSnapshot (const std::string &snapshot) const
	Initializes a new instance of the BlockBlobClient class with an identical uri source but the specified snapshot timestamp. More...
BlockBlobClient	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< UploadBlockBlobResult >	Upload (Azure::Core::Http::BodyStream *content, const UploadBlockBlobOptions &options=UploadBlockBlobOptions()) const
	Creates a new block blob, or updates the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob. More...
Azure::Core::Response< UploadBlockBlobFromResult >	UploadFrom (const uint8_t *buffer, std::size_t bufferSize, const UploadBlockBlobFromOptions &options=UploadBlockBlobFromOptions()) const
	Creates a new block blob, or updates the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob. More...
Azure::Core::Response< UploadBlockBlobFromResult >	UploadFrom (const std::string &file, const UploadBlockBlobFromOptions &options=UploadBlockBlobFromOptions()) const
	Creates a new block blob, or updates the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob. More...
Azure::Core::Response< StageBlockResult >	StageBlock (const std::string &blockId, Azure::Core::Http::BodyStream *content, const StageBlockOptions &options=StageBlockOptions()) const
	Creates a new block as part of a block blob's staging area to be eventually committed via the CommitBlockList operation. More...
Azure::Core::Response< StageBlockFromUriResult >	StageBlockFromUri (const std::string &blockId, const std::string &sourceUri, const StageBlockFromUriOptions &options=StageBlockFromUriOptions()) const
	Creates a new block to be committed as part of a blob where the contents are read from the sourceUri. More...
Azure::Core::Response< CommitBlockListResult >	CommitBlockList (const std::vector< std::pair< BlockType, std::string >> &blockIds, const CommitBlockListOptions &options=CommitBlockListOptions()) const
	Writes a blob by specifying the list of block IDs that make up the blob. In order to be written as part of a blob, a block must have been successfully written to the server in a prior StageBlock operation. You can call CommitBlockList to update a blob by uploading only those blocks that have changed, then committing the new and existing blocks together. You can do this by specifying whether to commit a block from the committed block list or from the uncommitted block list, or to commit the most recently uploaded version of the block, whichever list it may belong to. More...
Azure::Core::Response< GetBlockListResult >	GetBlockList (const GetBlockListOptions &options=GetBlockListOptions()) const
	Retrieves the list of blocks that have been uploaded as part of a block blob. There are two block lists maintained for a blob. The Committed Block list has blocks that have been successfully committed to a given blob with CommitBlockList. The Uncommitted Block list has blocks that have been uploaded for a blob using StageBlock, but that have not yet been committed. 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 BlockBlobClient	CreateFromConnectionString (const std::string &connectionString, const std::string &containerName, const std::string &blobName, const BlockBlobClientOptions &options=BlockBlobClientOptions())
	Initialize a new instance of BlockBlobClient. 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
class	Files::DataLake::FileClient

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 BlockBlobClient allows you to manipulate Azure Storage block blobs.

Block blobs let you upload large blobs efficiently. Block blobs are comprised of blocks, each of which is identified by a block ID. You create or modify a block blob by writing a set of blocks and committing them by their block IDs. Each block can be a different size.

When you upload a block to a blob in your storage account, it is associated with the specified block blob, but it does not become part of the blob until you commit a list of blocks that includes the new block's ID. New blocks remain in an uncommitted state until they are specifically committed or discarded. Writing a block does not update the last modified time of an existing blob.

Constructor & Destructor Documentation

BlockBlobClient() [1/3]

Azure::Storage::Blobs::BlockBlobClient::BlockBlobClient ( const std::string &  blobUri, std::shared_ptr< SharedKeyCredential >  credential, const BlockBlobClientOptions &  options = BlockBlobClientOptions()  )

explicit

Initialize a new instance of BlockBlobClient.

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)
  {
  }

BlockBlobClient() [2/3]

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

explicit

Initialize a new instance of BlockBlobClient.

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)
  {
  }

BlockBlobClient() [3/3]

Azure::Storage::Blobs::BlockBlobClient::BlockBlobClient ( const std::string &  blobUri, const BlockBlobClientOptions &  options = BlockBlobClientOptions()  )

explicit

Initialize a new instance of BlockBlobClient.

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

CommitBlockList()

Azure::Core::Response< CommitBlockListResult > Azure::Storage::Blobs::BlockBlobClient::CommitBlockList	(	const std::vector< std::pair< BlockType, std::string >> &	blockIds,
		const CommitBlockListOptions &	options = CommitBlockListOptions()
	)		const

Writes a blob by specifying the list of block IDs that make up the blob. In order to be written as part of a blob, a block must have been successfully written to the server in a prior StageBlock operation. You can call CommitBlockList to update a blob by uploading only those blocks that have changed, then committing the new and existing blocks together. You can do this by specifying whether to commit a block from the committed block list or from the uncommitted block list, or to commit the most recently uploaded version of the block, whichever list it may belong to.

Parameters

blockIds	Base64 encoded block IDs to indicate that make up the blob.
options	Optional parameters to execute this function.

Returns

A CommitBlobBlockListResult describing the state of the updated block blob.

  {
    BlobRestClient::BlockBlob::CommitBlockListOptions protocolLayerOptions;
    protocolLayerOptions.BlockList = blockIds;
    protocolLayerOptions.HttpHeaders = options.HttpHeaders;
    protocolLayerOptions.Metadata = options.Metadata;
    protocolLayerOptions.Tier = options.Tier;
    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::BlockBlob::CommitBlockList(
        options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
  }

CreateFromConnectionString()

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

static

Initialize a new instance of BlockBlobClient.

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 BlockBlobClient instance.

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

GetBlockList()

Azure::Core::Response< GetBlockListResult > Azure::Storage::Blobs::BlockBlobClient::GetBlockList

(

const GetBlockListOptions &

options = GetBlockListOptions()

)

const

Retrieves the list of blocks that have been uploaded as part of a block blob. There are two block lists maintained for a blob. The Committed Block list has blocks that have been successfully committed to a given blob with CommitBlockList. The Uncommitted Block list has blocks that have been uploaded for a blob using StageBlock, but that have not yet been committed.

Parameters

options

Optional parameters to execute this function.

Returns

A GetBlobBlockListResult describing requested block list.

  {
    BlobRestClient::BlockBlob::GetBlockListOptions protocolLayerOptions;
    protocolLayerOptions.ListType = options.ListType;
    protocolLayerOptions.LeaseId = options.AccessConditions.LeaseId;
    protocolLayerOptions.IfTags = options.AccessConditions.TagConditions;
    return BlobRestClient::BlockBlob::GetBlockList(
        options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
  }

StageBlock()

Azure::Core::Response< StageBlockResult > Azure::Storage::Blobs::BlockBlobClient::StageBlock	(	const std::string &	blockId,
		Azure::Core::Http::BodyStream *	content,
		const StageBlockOptions &	options = StageBlockOptions()
	)		const

Creates a new block as part of a block blob's staging area to be eventually committed via the CommitBlockList operation.

Parameters

blockId	A valid Base64 string value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes in size.
content	A BodyStream containing the content to upload.
options	Optional parameters to execute this function.

Returns

A StageBlockResult describing the state of the updated block.

  {
    BlobRestClient::BlockBlob::StageBlockOptions protocolLayerOptions;
    protocolLayerOptions.BlockId = blockId;
    protocolLayerOptions.TransactionalContentMd5 = options.TransactionalContentMd5;
    protocolLayerOptions.TransactionalContentCrc64 = options.TransactionalContentCrc64;
    protocolLayerOptions.LeaseId = options.AccessConditions.LeaseId;
    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::BlockBlob::StageBlock(
        options.Context, *m_pipeline, m_blobUrl, content, protocolLayerOptions);
  }

StageBlockFromUri()

Azure::Core::Response< StageBlockFromUriResult > Azure::Storage::Blobs::BlockBlobClient::StageBlockFromUri	(	const std::string &	blockId,
		const std::string &	sourceUri,
		const StageBlockFromUriOptions &	options = StageBlockFromUriOptions()
	)		const

Creates a new block to be committed as part of a blob where the contents are read from the sourceUri.

Parameters

blockId	A valid Base64 string value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes in size.
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 StageBlockFromUriResult describing the state of the updated block blob.

  {
    BlobRestClient::BlockBlob::StageBlockFromUriOptions protocolLayerOptions;
    protocolLayerOptions.BlockId = blockId;
    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.SourceIfModifiedSince = options.SourceConditions.IfModifiedSince;
    protocolLayerOptions.SourceIfUnmodifiedSince = options.SourceConditions.IfUnmodifiedSince;
    protocolLayerOptions.SourceIfMatch = options.SourceConditions.IfMatch;
    protocolLayerOptions.SourceIfNoneMatch = options.SourceConditions.IfNoneMatch;
    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::BlockBlob::StageBlockFromUri(
        options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
  }

Upload()

Azure::Core::Response< UploadBlockBlobResult > Azure::Storage::Blobs::BlockBlobClient::Upload	(	Azure::Core::Http::BodyStream *	content,
		const UploadBlockBlobOptions &	options = UploadBlockBlobOptions()
	)		const

Creates a new block blob, or updates the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob.

Parameters

content	A BodyStream containing the content to upload.
options	Optional parameters to execute this function.

Returns

A UploadBlockBlobResult describing the state of the updated block blob.

  {
    BlobRestClient::BlockBlob::UploadBlockBlobOptions protocolLayerOptions;
    protocolLayerOptions.TransactionalContentMd5 = options.TransactionalContentMd5;
    protocolLayerOptions.TransactionalContentCrc64 = options.TransactionalContentCrc64;
    protocolLayerOptions.HttpHeaders = options.HttpHeaders;
    protocolLayerOptions.Metadata = options.Metadata;
    protocolLayerOptions.Tier = options.Tier;
    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::BlockBlob::Upload(
        options.Context, *m_pipeline, m_blobUrl, content, protocolLayerOptions);
  }

UploadFrom() [1/2]

Azure::Core::Response< UploadBlockBlobFromResult > Azure::Storage::Blobs::BlockBlobClient::UploadFrom	(	const std::string &	file,
		const UploadBlockBlobFromOptions &	options = UploadBlockBlobFromOptions()
	)		const

Creates a new block blob, or updates the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob.

Parameters

file	A file containing the content to upload.
options	Optional parameters to execute this function.

Returns

A UploadBlockBlobFromResult describing the state of the updated block blob.

  {
    constexpr int64_t c_defaultBlockSize = 8 * 1024 * 1024;
    constexpr int64_t c_maximumNumberBlocks = 50000;
    constexpr int64_t c_grainSize = 4 * 1024;
 
    Details::FileReader fileReader(file);
 
    int64_t chunkSize = c_defaultBlockSize;
    if (options.ChunkSize.HasValue())
    {
      chunkSize = options.ChunkSize.GetValue();
    }
    else
    {
      int64_t minBlockSize
          = (fileReader.GetFileSize() + c_maximumNumberBlocks - 1) / c_maximumNumberBlocks;
      chunkSize = std::max(chunkSize, minBlockSize);
      chunkSize = (chunkSize + c_grainSize - 1) / c_grainSize * c_grainSize;
    }
 
    if (fileReader.GetFileSize() <= chunkSize)
    {
      Azure::Core::Http::FileBodyStream contentStream(
          fileReader.GetHandle(), 0, fileReader.GetFileSize());
      UploadBlockBlobOptions uploadBlockBlobOptions;
      uploadBlockBlobOptions.Context = options.Context;
      uploadBlockBlobOptions.HttpHeaders = options.HttpHeaders;
      uploadBlockBlobOptions.Metadata = options.Metadata;
      uploadBlockBlobOptions.Tier = options.Tier;
      return Upload(&contentStream, uploadBlockBlobOptions);
    }
 
    std::vector<std::pair<BlockType, std::string>> blockIds;
    auto getBlockId = [](int64_t id) {
      constexpr std::size_t c_blockIdLength = 64;
      std::string blockId = std::to_string(id);
      blockId = std::string(c_blockIdLength - blockId.length(), '0') + blockId;
      return Base64Encode(blockId);
    };
 
    auto uploadBlockFunc = [&](int64_t offset, int64_t length, int64_t chunkId, int64_t numChunks) {
      Azure::Core::Http::FileBodyStream contentStream(fileReader.GetHandle(), offset, length);
      StageBlockOptions chunkOptions;
      chunkOptions.Context = options.Context;
      auto blockInfo = StageBlock(getBlockId(chunkId), &contentStream, chunkOptions);
      if (chunkId == numChunks - 1)
      {
        blockIds.resize(static_cast<std::size_t>(numChunks));
      }
    };
 
    Details::ConcurrentTransfer(
        0, fileReader.GetFileSize(), chunkSize, options.Concurrency, uploadBlockFunc);
 
    for (std::size_t i = 0; i < blockIds.size(); ++i)
    {
      blockIds[i].first = BlockType::Uncommitted;
      blockIds[i].second = getBlockId(static_cast<int64_t>(i));
    }
    CommitBlockListOptions commitBlockListOptions;
    commitBlockListOptions.Context = options.Context;
    commitBlockListOptions.HttpHeaders = options.HttpHeaders;
    commitBlockListOptions.Metadata = options.Metadata;
    commitBlockListOptions.Tier = options.Tier;
    auto commitBlockListResponse = CommitBlockList(blockIds, commitBlockListOptions);
 
    UploadBlockBlobFromResult result;
    result.ETag = commitBlockListResponse->ETag;
    result.LastModified = commitBlockListResponse->LastModified;
    result.VersionId = commitBlockListResponse->VersionId;
    result.ServerEncrypted = commitBlockListResponse->ServerEncrypted;
    result.EncryptionKeySha256 = commitBlockListResponse->EncryptionKeySha256;
    result.EncryptionScope = commitBlockListResponse->EncryptionScope;
    return Azure::Core::Response<UploadBlockBlobFromResult>(
        std::move(result),
        std::make_unique<Azure::Core::Http::RawResponse>(
            std::move(commitBlockListResponse.GetRawResponse())));
  }

UploadFrom() [2/2]

Azure::Core::Response< UploadBlockBlobFromResult > Azure::Storage::Blobs::BlockBlobClient::UploadFrom	(	const uint8_t *	buffer,
		std::size_t	bufferSize,
		const UploadBlockBlobFromOptions &	options = UploadBlockBlobFromOptions()
	)		const

Creates a new block blob, or updates the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob.

Parameters

buffer	A memory buffer containing the content to upload.
bufferSize	Size of the memory buffer.
options	Optional parameters to execute this function.

Returns

A UploadBlockBlobFromResult describing the state of the updated block blob.

  {
    constexpr int64_t c_defaultBlockSize = 8 * 1024 * 1024;
    constexpr int64_t c_maximumNumberBlocks = 50000;
    constexpr int64_t c_grainSize = 4 * 1024;
 
    int64_t chunkSize = c_defaultBlockSize;
    if (options.ChunkSize.HasValue())
    {
      chunkSize = options.ChunkSize.GetValue();
    }
    else
    {
      int64_t minBlockSize = (bufferSize + c_maximumNumberBlocks - 1) / c_maximumNumberBlocks;
      chunkSize = std::max(chunkSize, minBlockSize);
      chunkSize = (chunkSize + c_grainSize - 1) / c_grainSize * c_grainSize;
    }
 
    if (bufferSize <= static_cast<std::size_t>(chunkSize))
    {
      Azure::Core::Http::MemoryBodyStream contentStream(buffer, bufferSize);
      UploadBlockBlobOptions uploadBlockBlobOptions;
      uploadBlockBlobOptions.Context = options.Context;
      uploadBlockBlobOptions.HttpHeaders = options.HttpHeaders;
      uploadBlockBlobOptions.Metadata = options.Metadata;
      uploadBlockBlobOptions.Tier = options.Tier;
      return Upload(&contentStream, uploadBlockBlobOptions);
    }
 
    std::vector<std::pair<BlockType, std::string>> blockIds;
    auto getBlockId = [](int64_t id) {
      constexpr std::size_t c_blockIdLength = 64;
      std::string blockId = std::to_string(id);
      blockId = std::string(c_blockIdLength - blockId.length(), '0') + blockId;
      return Base64Encode(blockId);
    };
 
    auto uploadBlockFunc = [&](int64_t offset, int64_t length, int64_t chunkId, int64_t numChunks) {
      Azure::Core::Http::MemoryBodyStream contentStream(buffer + offset, length);
      StageBlockOptions chunkOptions;
      chunkOptions.Context = options.Context;
      auto blockInfo = StageBlock(getBlockId(chunkId), &contentStream, chunkOptions);
      if (chunkId == numChunks - 1)
      {
        blockIds.resize(static_cast<std::size_t>(numChunks));
      }
    };
 
    Details::ConcurrentTransfer(0, bufferSize, chunkSize, options.Concurrency, uploadBlockFunc);
 
    for (std::size_t i = 0; i < blockIds.size(); ++i)
    {
      blockIds[i].first = BlockType::Uncommitted;
      blockIds[i].second = getBlockId(static_cast<int64_t>(i));
    }
    CommitBlockListOptions commitBlockListOptions;
    commitBlockListOptions.Context = options.Context;
    commitBlockListOptions.HttpHeaders = options.HttpHeaders;
    commitBlockListOptions.Metadata = options.Metadata;
    commitBlockListOptions.Tier = options.Tier;
    auto commitBlockListResponse = CommitBlockList(blockIds, commitBlockListOptions);
 
    UploadBlockBlobFromResult ret;
    ret.ETag = std::move(commitBlockListResponse->ETag);
    ret.LastModified = std::move(commitBlockListResponse->LastModified);
    ret.VersionId = std::move(commitBlockListResponse->VersionId);
    ret.ServerEncrypted = commitBlockListResponse->ServerEncrypted;
    ret.EncryptionKeySha256 = std::move(commitBlockListResponse->EncryptionKeySha256);
    ret.EncryptionScope = std::move(commitBlockListResponse->EncryptionScope);
    return Azure::Core::Response<UploadBlockBlobFromResult>(
        std::move(ret),
        std::make_unique<Azure::Core::Http::RawResponse>(
            std::move(commitBlockListResponse.GetRawResponse())));
  }

WithSnapshot()

BlockBlobClient Azure::Storage::Blobs::BlockBlobClient::WithSnapshot

(

const std::string &

snapshot

)

const

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

Parameters

snapshot

The snapshot identifier.

Returns

A new BlockBlobClient instance.

Remarks

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

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

WithVersionId()

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

Remarks

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

  {
    BlockBlobClient 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/block_blob_client.hpp
• src/block_blob_client.cpp