The BlobClient allows you to manipulate Azure Storage blobs. More...

#include <blob_client.hpp>

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

Public Member Functions
	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 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...

Protected Attributes
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

Friends
class	BlobContainerClient

class	Files::DataLake::DirectoryClient

class	Files::DataLake::FileClient

Detailed Description

The BlobClient allows you to manipulate Azure Storage blobs.

Constructor & Destructor Documentation

◆ BlobClient() [1/3]

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

explicit

Initialize a new instance of BlobClient.

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, options)
   {
     std::vector<std::unique_ptr<Azure::Core::Http::HttpPolicy>> policies;
     policies.emplace_back(std::make_unique<Azure::Core::Http::TelemetryPolicy>(
         Details::c_BlobServicePackageName, BlobServiceVersion));
     policies.emplace_back(std::make_unique<Azure::Core::Http::RequestIdPolicy>());
     for (const auto& p : options.PerOperationPolicies)
     {
       policies.emplace_back(p->Clone());
     }
     policies.emplace_back(
         std::make_unique<Azure::Core::Http::RetryPolicy>(Azure::Core::Http::RetryOptions()));
     for (const auto& p : options.PerRetryPolicies)
     {
       policies.emplace_back(p->Clone());
     }
     policies.emplace_back(std::make_unique<StoragePerRetryPolicy>());
     policies.emplace_back(std::make_unique<SharedKeyPolicy>(credential));
     policies.emplace_back(std::make_unique<Azure::Core::Http::TransportPolicy>(
         std::make_shared<Azure::Core::Http::CurlTransport>()));
     m_pipeline = std::make_shared<Azure::Core::Http::HttpPipeline>(policies);
   }

◆ BlobClient() [2/3]

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

explicit

Initialize a new instance of BlobClient.

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, options)
   {
     std::vector<std::unique_ptr<Azure::Core::Http::HttpPolicy>> policies;
     policies.emplace_back(std::make_unique<Azure::Core::Http::TelemetryPolicy>(
         Details::c_BlobServicePackageName, BlobServiceVersion));
     policies.emplace_back(std::make_unique<Azure::Core::Http::RequestIdPolicy>());
     for (const auto& p : options.PerOperationPolicies)
     {
       policies.emplace_back(p->Clone());
     }
     policies.emplace_back(
         std::make_unique<Azure::Core::Http::RetryPolicy>(Azure::Core::Http::RetryOptions()));
     for (const auto& p : options.PerRetryPolicies)
     {
       policies.emplace_back(p->Clone());
     }
     policies.emplace_back(std::make_unique<StoragePerRetryPolicy>());
     policies.emplace_back(
         std::make_unique<Core::Credentials::Policy::BearerTokenAuthenticationPolicy>(
             credential, Details::c_StorageScope));
     policies.emplace_back(std::make_unique<Azure::Core::Http::TransportPolicy>(
         std::make_shared<Azure::Core::Http::CurlTransport>()));
     m_pipeline = std::make_shared<Azure::Core::Http::HttpPipeline>(policies);
   }

◆ BlobClient() [3/3]

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

explicit

Initialize a new instance of BlobClient.

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.

       : m_blobUrl(blobUri), m_customerProvidedKey(options.CustomerProvidedKey),
         m_encryptionScope(options.EncryptionScope)
   {
     std::vector<std::unique_ptr<Azure::Core::Http::HttpPolicy>> policies;
     policies.emplace_back(std::make_unique<Azure::Core::Http::TelemetryPolicy>(
         Details::c_BlobServicePackageName, BlobServiceVersion));
     policies.emplace_back(std::make_unique<Azure::Core::Http::RequestIdPolicy>());
     for (const auto& p : options.PerOperationPolicies)
     {
       policies.emplace_back(p->Clone());
     }
     policies.emplace_back(
         std::make_unique<Azure::Core::Http::RetryPolicy>(Azure::Core::Http::RetryOptions()));
     for (const auto& p : options.PerRetryPolicies)
     {
       policies.emplace_back(p->Clone());
     }
     policies.emplace_back(std::make_unique<StoragePerRetryPolicy>());
     policies.emplace_back(std::make_unique<Azure::Core::Http::TransportPolicy>(
         std::make_shared<Azure::Core::Http::CurlTransport>()));
     m_pipeline = std::make_shared<Azure::Core::Http::HttpPipeline>(policies);
   }

Member Function Documentation

◆ AbortCopyFromUri()

Azure::Core::Response< AbortCopyBlobFromUriResult > Azure::Storage::Blobs::BlobClient::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.

Parameters

copyId	ID of the copy operation to abort.
options	Optional parameters to execute this function.

Returns: A AbortCopyBlobFromUriResult on successfully aborting.

   {
     BlobRestClient::Blob::AbortCopyBlobFromUriOptions protocolLayerOptions;
     protocolLayerOptions.CopyId = copyId;
     protocolLayerOptions.LeaseId = options.AccessConditions.LeaseId;
     return BlobRestClient::Blob::AbortCopyFromUri(
         options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
   }

◆ AcquireLease()

Azure::Core::Response< AcquireBlobLeaseResult > Azure::Storage::Blobs::BlobClient::AcquireLease	(	const std::string &	proposedLeaseId,
		int32_t	duration,
		const AcquireBlobLeaseOptions &	options = `AcquireBlobLeaseOptions()`
	)		const

Acquires a lease on the blob.

Parameters

proposedLeaseId	Proposed lease ID, in a GUID string format.
duration	Specifies the duration of the lease, in seconds, or Azure::Storage::c_InfiniteLeaseDuration for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change.
options	Optional parameters to execute this function.

Returns: A AcquireBlobLeaseResult describing the lease.

   {
     BlobRestClient::Blob::AcquireBlobLeaseOptions protocolLayerOptions;
     protocolLayerOptions.ProposedLeaseId = proposedLeaseId;
     protocolLayerOptions.LeaseDuration = duration;
     protocolLayerOptions.IfModifiedSince = options.IfModifiedSince;
     protocolLayerOptions.IfUnmodifiedSince = options.IfUnmodifiedSince;
     protocolLayerOptions.IfMatch = options.IfMatch;
     protocolLayerOptions.IfNoneMatch = options.IfNoneMatch;
     protocolLayerOptions.IfTags = options.TagConditions;
     return BlobRestClient::Blob::AcquireLease(
         options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
   }

◆ BreakLease()

Azure::Core::Response< BreakBlobLeaseResult > Azure::Storage::Blobs::BlobClient::BreakLease ( const BreakBlobLeaseOptions & options = BreakBlobLeaseOptions() ) const

Breaks the previously-acquired lease.

Parameters

options Optional parameters to execute this function.

Returns: A BreakBlobLeaseResult describing the broken lease.

   {
     BlobRestClient::Blob::BreakBlobLeaseOptions protocolLayerOptions;
     protocolLayerOptions.BreakPeriod = options.breakPeriod;
     protocolLayerOptions.IfModifiedSince = options.IfModifiedSince;
     protocolLayerOptions.IfUnmodifiedSince = options.IfUnmodifiedSince;
     protocolLayerOptions.IfMatch = options.IfMatch;
     protocolLayerOptions.IfNoneMatch = options.IfNoneMatch;
     protocolLayerOptions.IfTags = options.TagConditions;
     return BlobRestClient::Blob::BreakLease(
         options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
   }

◆ ChangeLease()

Azure::Core::Response< ChangeBlobLeaseResult > Azure::Storage::Blobs::BlobClient::ChangeLease	(	const std::string &	leaseId,
		const std::string &	proposedLeaseId,
		const ChangeBlobLeaseOptions &	options = `ChangeBlobLeaseOptions()`
	)		const

Changes the lease of an active lease.

Parameters

leaseId	ID of the previously-acquired lease.
proposedLeaseId	Proposed lease ID, in a GUID string format.
options	Optional parameters to execute this function.

Returns: A ChangeBlobLeaseResult describing the lease.

   {
     BlobRestClient::Blob::ChangeBlobLeaseOptions protocolLayerOptions;
     protocolLayerOptions.LeaseId = leaseId;
     protocolLayerOptions.ProposedLeaseId = proposedLeaseId;
     protocolLayerOptions.IfModifiedSince = options.IfModifiedSince;
     protocolLayerOptions.IfUnmodifiedSince = options.IfUnmodifiedSince;
     protocolLayerOptions.IfMatch = options.IfMatch;
     protocolLayerOptions.IfNoneMatch = options.IfNoneMatch;
     protocolLayerOptions.IfTags = options.TagConditions;
     return BlobRestClient::Blob::ChangeLease(
         options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
   }

◆ CreateFromConnectionString()

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

static

Initialize a new instance of BlobClient.

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

   {
     auto parsedConnectionString = Details::ParseConnectionString(connectionString);
     auto blobUri = std::move(parsedConnectionString.BlobServiceUri);
     blobUri.AppendPath(containerName, true);
     blobUri.AppendPath(blobName, true);
  
     if (parsedConnectionString.KeyCredential)
     {
       return BlobClient(blobUri.GetAbsoluteUrl(), parsedConnectionString.KeyCredential, options);
     }
     else
     {
       return BlobClient(blobUri.GetAbsoluteUrl(), options);
     }
   }

◆ CreateSnapshot()

Azure::Core::Response< CreateBlobSnapshotResult > Azure::Storage::Blobs::BlobClient::CreateSnapshot ( const CreateBlobSnapshotOptions & options = CreateBlobSnapshotOptions() ) const

Creates a read-only snapshot of a blob.

Parameters

options Optional parameters to execute this function.

Returns: A CreateBlobSnapshotResult describing the new blob snapshot.

   {
     BlobRestClient::Blob::CreateBlobSnapshotOptions protocolLayerOptions;
     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::Blob::CreateSnapshot(
         options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
   }

◆ Delete()

Azure::Core::Response< DeleteBlobResult > Azure::Storage::Blobs::BlobClient::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.

Parameters

options Optional parameters to execute this function.

Returns: A DeleteBlobResult on successfully deleting.

   {
     BlobRestClient::Blob::DeleteBlobOptions protocolLayerOptions;
     protocolLayerOptions.DeleteSnapshots = options.DeleteSnapshots;
     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;
     return BlobRestClient::Blob::Delete(
         options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
   }

◆ Download()

Azure::Core::Response< DownloadBlobResult > Azure::Storage::Blobs::BlobClient::Download ( const DownloadBlobOptions & options = DownloadBlobOptions() ) const

Downloads a blob or a blob range from the service, including its metadata and properties.

Parameters

options Optional parameters to execute this function.

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

   {
     BlobRestClient::Blob::DownloadBlobOptions protocolLayerOptions;
     if (options.Offset.HasValue() && options.Length.HasValue())
     {
       protocolLayerOptions.Range = std::make_pair(
           options.Offset.GetValue(), options.Offset.GetValue() + options.Length.GetValue() - 1);
     }
     else if (options.Offset.HasValue())
     {
       protocolLayerOptions.Range = std::make_pair(
           options.Offset.GetValue(),
           std::numeric_limits<std::remove_reference_t<decltype(options.Offset.GetValue())>>::max());
     }
     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;
     }
  
     auto downloadResponse = BlobRestClient::Blob::Download(
         options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
  
     {
       // In case network failure during reading the body
       std::string eTag = downloadResponse->ETag;
  
       auto retryFunction
           = [this, options, eTag](
                 const Azure::Core::Context& context,
                 const HttpGetterInfo& retryInfo) -> std::unique_ptr<Azure::Core::Http::BodyStream> {
         unused(context);
  
         DownloadBlobOptions newOptions = options;
         newOptions.Offset
             = (options.Offset.HasValue() ? options.Offset.GetValue() : 0) + retryInfo.Offset;
         newOptions.Length = options.Length;
         if (newOptions.Length.HasValue())
         {
           newOptions.Length = options.Length.GetValue() - retryInfo.Offset;
         }
         if (!newOptions.AccessConditions.IfMatch.HasValue())
         {
           newOptions.AccessConditions.IfMatch = eTag;
         }
         return std::move(Download(newOptions)->BodyStream);
       };
  
       ReliableStreamOptions reliableStreamOptions;
       reliableStreamOptions.MaxRetryRequests = Details::c_reliableStreamRetryCount;
       downloadResponse->BodyStream = std::make_unique<ReliableStream>(
           std::move(downloadResponse->BodyStream), reliableStreamOptions, retryFunction);
     }
     return downloadResponse;
   }

◆ DownloadTo() [1/2]

Azure::Core::Response< DownloadBlobToResult > Azure::Storage::Blobs::BlobClient::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.

Parameters

file	A file path to write the downloaded content to.
options	Optional parameters to execute this function.

Returns: A DownloadBlobToResult describing the downloaded blob.

   {
     constexpr int64_t c_defaultChunkSize = 4 * 1024 * 1024;
  
     // Just start downloading using an initial chunk. If it's a small blob, we'll get the whole
     // thing in one shot. If it's a large blob, we'll get its full size in Content-Range and can
     // keep downloading it in chunks.
     int64_t firstChunkOffset = options.Offset.HasValue() ? options.Offset.GetValue() : 0;
     int64_t firstChunkLength = c_defaultChunkSize;
     if (options.InitialChunkSize.HasValue())
     {
       firstChunkLength = options.InitialChunkSize.GetValue();
     }
     if (options.Length.HasValue())
     {
       firstChunkLength = std::min(firstChunkLength, options.Length.GetValue());
     }
  
     DownloadBlobOptions firstChunkOptions;
     firstChunkOptions.Context = options.Context;
     firstChunkOptions.Offset = options.Offset;
     if (firstChunkOptions.Offset.HasValue())
     {
       firstChunkOptions.Length = firstChunkLength;
     }
  
     Details::FileWriter fileWriter(file);
  
     auto firstChunk = Download(firstChunkOptions);
  
     int64_t blobSize;
     int64_t blobRangeSize;
     if (firstChunkOptions.Offset.HasValue())
     {
       blobSize = std::stoll(firstChunk->ContentRange.GetValue().substr(
           firstChunk->ContentRange.GetValue().find('/') + 1));
       blobRangeSize = blobSize - firstChunkOffset;
       if (options.Length.HasValue())
       {
         blobRangeSize = std::min(blobRangeSize, options.Length.GetValue());
       }
     }
     else
     {
       blobSize = firstChunk->BodyStream->Length();
       blobRangeSize = blobSize;
     }
     firstChunkLength = std::min(firstChunkLength, blobRangeSize);
  
     auto bodyStreamToFile = [](Azure::Core::Http::BodyStream& stream,
                                Details::FileWriter& fileWriter,
                                int64_t offset,
                                int64_t length,
                                Azure::Core::Context& context) {
       constexpr std::size_t bufferSize = 4 * 1024 * 1024;
       std::vector<uint8_t> buffer(bufferSize);
       while (length > 0)
       {
         int64_t readSize = std::min(static_cast<int64_t>(bufferSize), length);
         int64_t bytesRead
             = Azure::Core::Http::BodyStream::ReadToCount(context, stream, buffer.data(), readSize);
         if (bytesRead != readSize)
         {
           throw std::runtime_error("error when reading body stream");
         }
         fileWriter.Write(buffer.data(), bytesRead, offset);
         length -= bytesRead;
         offset += bytesRead;
       }
     };
  
     bodyStreamToFile(
         *(firstChunk->BodyStream), fileWriter, 0, firstChunkLength, firstChunkOptions.Context);
     firstChunk->BodyStream.reset();
  
     auto returnTypeConverter = [](Azure::Core::Response<DownloadBlobResult>& response) {
       DownloadBlobToResult ret;
       ret.ETag = std::move(response->ETag);
       ret.LastModified = std::move(response->LastModified);
       ret.HttpHeaders = std::move(response->HttpHeaders);
       ret.Metadata = std::move(response->Metadata);
       ret.BlobType = response->BlobType;
       ret.ServerEncrypted = response->ServerEncrypted;
       ret.EncryptionKeySha256 = std::move(response->EncryptionKeySha256);
       return Azure::Core::Response<DownloadBlobToResult>(
           std::move(ret),
           std::make_unique<Azure::Core::Http::RawResponse>(std::move(response.GetRawResponse())));
     };
     auto ret = returnTypeConverter(firstChunk);
  
     // Keep downloading the remaining in parallel
     auto downloadChunkFunc
         = [&](int64_t offset, int64_t length, int64_t chunkId, int64_t numChunks) {
             DownloadBlobOptions chunkOptions;
             chunkOptions.Context = options.Context;
             chunkOptions.Offset = offset;
             chunkOptions.Length = length;
             auto chunk = Download(chunkOptions);
             bodyStreamToFile(
                 *(chunk->BodyStream),
                 fileWriter,
                 offset - firstChunkOffset,
                 chunkOptions.Length.GetValue(),
                 chunkOptions.Context);
  
             if (chunkId == numChunks - 1)
             {
               ret = returnTypeConverter(chunk);
             }
           };
  
     int64_t remainingOffset = firstChunkOffset + firstChunkLength;
     int64_t remainingSize = blobRangeSize - firstChunkLength;
     int64_t chunkSize;
     if (options.ChunkSize.HasValue())
     {
       chunkSize = options.ChunkSize.GetValue();
     }
     else
     {
       int64_t c_grainSize = 4 * 1024;
       chunkSize = remainingSize / options.Concurrency;
       chunkSize = (std::max(chunkSize, int64_t(1)) + c_grainSize - 1) / c_grainSize * c_grainSize;
       chunkSize = std::min(chunkSize, c_defaultChunkSize);
     }
  
     Details::ConcurrentTransfer(
         remainingOffset, remainingSize, chunkSize, options.Concurrency, downloadChunkFunc);
     ret->ContentLength = blobRangeSize;
     return ret;
   }

◆ DownloadTo() [2/2]

Azure::Core::Response< DownloadBlobToResult > Azure::Storage::Blobs::BlobClient::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.

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.

Returns: A DownloadBlobToResult describing the downloaded blob.

   {
     constexpr int64_t c_defaultChunkSize = 4 * 1024 * 1024;
  
     // Just start downloading using an initial chunk. If it's a small blob, we'll get the whole
     // thing in one shot. If it's a large blob, we'll get its full size in Content-Range and can
     // keep downloading it in chunks.
     int64_t firstChunkOffset = options.Offset.HasValue() ? options.Offset.GetValue() : 0;
     int64_t firstChunkLength = c_defaultChunkSize;
     if (options.InitialChunkSize.HasValue())
     {
       firstChunkLength = options.InitialChunkSize.GetValue();
     }
     if (options.Length.HasValue())
     {
       firstChunkLength = std::min(firstChunkLength, options.Length.GetValue());
     }
  
     DownloadBlobOptions firstChunkOptions;
     firstChunkOptions.Context = options.Context;
     firstChunkOptions.Offset = options.Offset;
     if (firstChunkOptions.Offset.HasValue())
     {
       firstChunkOptions.Length = firstChunkLength;
     }
  
     auto firstChunk = Download(firstChunkOptions);
  
     int64_t blobSize;
     int64_t blobRangeSize;
     if (firstChunkOptions.Offset.HasValue())
     {
       blobSize = std::stoll(firstChunk->ContentRange.GetValue().substr(
           firstChunk->ContentRange.GetValue().find('/') + 1));
       blobRangeSize = blobSize - firstChunkOffset;
       if (options.Length.HasValue())
       {
         blobRangeSize = std::min(blobRangeSize, options.Length.GetValue());
       }
     }
     else
     {
       blobSize = firstChunk->BodyStream->Length();
       blobRangeSize = blobSize;
     }
     firstChunkLength = std::min(firstChunkLength, blobRangeSize);
  
     if (static_cast<std::size_t>(blobRangeSize) > bufferSize)
     {
       throw std::runtime_error(
           "buffer is not big enough, blob range size is " + std::to_string(blobRangeSize));
     }
  
     int64_t bytesRead = Azure::Core::Http::BodyStream::ReadToCount(
         firstChunkOptions.Context, *(firstChunk->BodyStream), buffer, firstChunkLength);
     if (bytesRead != firstChunkLength)
     {
       throw std::runtime_error("error when reading body stream");
     }
     firstChunk->BodyStream.reset();
  
     auto returnTypeConverter = [](Azure::Core::Response<DownloadBlobResult>& response) {
       DownloadBlobToResult ret;
       ret.ETag = std::move(response->ETag);
       ret.LastModified = std::move(response->LastModified);
       ret.HttpHeaders = std::move(response->HttpHeaders);
       ret.Metadata = std::move(response->Metadata);
       ret.BlobType = response->BlobType;
       ret.ServerEncrypted = response->ServerEncrypted;
       ret.EncryptionKeySha256 = std::move(response->EncryptionKeySha256);
       return Azure::Core::Response<DownloadBlobToResult>(
           std::move(ret),
           std::make_unique<Azure::Core::Http::RawResponse>(std::move(response.GetRawResponse())));
     };
     auto ret = returnTypeConverter(firstChunk);
  
     // Keep downloading the remaining in parallel
     auto downloadChunkFunc
         = [&](int64_t offset, int64_t length, int64_t chunkId, int64_t numChunks) {
             DownloadBlobOptions chunkOptions;
             chunkOptions.Context = options.Context;
             chunkOptions.Offset = offset;
             chunkOptions.Length = length;
             auto chunk = Download(chunkOptions);
             int64_t bytesRead = Azure::Core::Http::BodyStream::ReadToCount(
                 chunkOptions.Context,
                 *(chunk->BodyStream),
                 buffer + (offset - firstChunkOffset),
                 chunkOptions.Length.GetValue());
             if (bytesRead != chunkOptions.Length.GetValue())
             {
               throw std::runtime_error("error when reading body stream");
             }
  
             if (chunkId == numChunks - 1)
             {
               ret = returnTypeConverter(chunk);
             }
           };
  
     int64_t remainingOffset = firstChunkOffset + firstChunkLength;
     int64_t remainingSize = blobRangeSize - firstChunkLength;
     int64_t chunkSize;
     if (options.ChunkSize.HasValue())
     {
       chunkSize = options.ChunkSize.GetValue();
     }
     else
     {
       int64_t c_grainSize = 4 * 1024;
       chunkSize = remainingSize / options.Concurrency;
       chunkSize = (std::max(chunkSize, int64_t(1)) + c_grainSize - 1) / c_grainSize * c_grainSize;
       chunkSize = std::min(chunkSize, c_defaultChunkSize);
     }
  
     Details::ConcurrentTransfer(
         remainingOffset, remainingSize, chunkSize, options.Concurrency, downloadChunkFunc);
     ret->ContentLength = blobRangeSize;
     return ret;
   }

◆ GetAppendBlobClient()

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

Returns: A new AppendBlobClient instance.

125 { return AppendBlobClient(*this); }

◆ GetBlockBlobClient()

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

Returns: A new BlockBlobClient instance.

123 { return BlockBlobClient(*this); }

◆ GetPageBlobClient()

PageBlobClient Azure::Storage::Blobs::BlobClient::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.

Returns: A new PageBlobClient instance.

127 { return PageBlobClient(*this); }

◆ GetProperties()

Azure::Core::Response< GetBlobPropertiesResult > Azure::Storage::Blobs::BlobClient::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.

Parameters

options Optional parameters to execute this function.

Returns: A GetBlobPropertiesResult describing the blob's properties.

   {
     BlobRestClient::Blob::GetBlobPropertiesOptions protocolLayerOptions;
     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;
     }
     return BlobRestClient::Blob::GetProperties(
         options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
   }

◆ GetTags()

Azure::Core::Response< GetBlobTagsResult > Azure::Storage::Blobs::BlobClient::GetTags ( const GetBlobTagsOptions & options = GetBlobTagsOptions() ) const

Gets the tags associated with the underlying blob.

Parameters

options Optional parameters to execute this function.

Returns: Tags on successfully getting tags.

   {
     BlobRestClient::Blob::GetBlobTagsOptions protocolLayerOptions;
     protocolLayerOptions.IfTags = options.TagConditions;
     return BlobRestClient::Blob::GetTags(
         options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
   }

◆ GetUri()

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

inline

Gets the blob's primary uri endpoint.

Returns: The blob's primary uri endpoint.

120 { return m_blobUrl.GetAbsoluteUrl(); }

◆ ReleaseLease()

Azure::Core::Response< ReleaseBlobLeaseResult > Azure::Storage::Blobs::BlobClient::ReleaseLease	(	const std::string &	leaseId,
		const ReleaseBlobLeaseOptions &	options = `ReleaseBlobLeaseOptions()`
	)		const

Releases the blob's previously-acquired lease.

Parameters

leaseId	ID of the previously-acquired lease.
options	Optional parameters to execute this function.

Returns: A ReleaseBlobLeaseResult describing the updated container.

   {
     BlobRestClient::Blob::ReleaseBlobLeaseOptions protocolLayerOptions;
     protocolLayerOptions.LeaseId = leaseId;
     protocolLayerOptions.IfModifiedSince = options.IfModifiedSince;
     protocolLayerOptions.IfUnmodifiedSince = options.IfUnmodifiedSince;
     protocolLayerOptions.IfMatch = options.IfMatch;
     protocolLayerOptions.IfNoneMatch = options.IfNoneMatch;
     protocolLayerOptions.IfTags = options.TagConditions;
     return BlobRestClient::Blob::ReleaseLease(
         options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
   }

◆ RenewLease()

Azure::Core::Response< RenewBlobLeaseResult > Azure::Storage::Blobs::BlobClient::RenewLease	(	const std::string &	leaseId,
		const RenewBlobLeaseOptions &	options = `RenewBlobLeaseOptions()`
	)		const

Renews the blob's previously-acquired lease.

Parameters

leaseId	ID of the previously-acquired lease.
options	Optional parameters to execute this function.

Returns: A RenewBlobLeaseResult describing the lease.

   {
     BlobRestClient::Blob::RenewBlobLeaseOptions protocolLayerOptions;
     protocolLayerOptions.LeaseId = leaseId;
     protocolLayerOptions.IfModifiedSince = options.IfModifiedSince;
     protocolLayerOptions.IfUnmodifiedSince = options.IfUnmodifiedSince;
     protocolLayerOptions.IfMatch = options.IfMatch;
     protocolLayerOptions.IfNoneMatch = options.IfNoneMatch;
     protocolLayerOptions.IfTags = options.TagConditions;
     return BlobRestClient::Blob::RenewLease(
         options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
   }

◆ SetAccessTier()

Azure::Core::Response< SetBlobAccessTierResult > Azure::Storage::Blobs::BlobClient::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.

Parameters

Tier	Indicates the tier to be set on the blob.
options	Optional parameters to execute this function.

Returns: A SetBlobAccessTierResult on successfully setting the tier.

   {
     BlobRestClient::Blob::SetBlobAccessTierOptions protocolLayerOptions;
     protocolLayerOptions.Tier = Tier;
     protocolLayerOptions.RehydratePriority = options.RehydratePriority;
     return BlobRestClient::Blob::SetAccessTier(
         options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
   }

◆ SetHttpHeaders()

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

Sets system properties on the blob.

Parameters

httpHeaders	The standard HTTP header system properties to set.
options	Optional parameters to execute this function.

Returns: A SetBlobHttpHeadersResult describing the updated blob.

   {
     BlobRestClient::Blob::SetBlobHttpHeadersOptions protocolLayerOptions;
     protocolLayerOptions.HttpHeaders = std::move(httpHeaders);
     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;
     return BlobRestClient::Blob::SetHttpHeaders(
         options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
   }

◆ SetMetadata()

Azure::Core::Response< SetBlobMetadataResult > Azure::Storage::Blobs::BlobClient::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.

Parameters

metadata	Custom metadata to set for this blob.
options	Optional parameters to execute this function.

Returns: A SetBlobMetadataResult describing the updated blob.

   {
     BlobRestClient::Blob::SetBlobMetadataOptions protocolLayerOptions;
     protocolLayerOptions.Metadata = std::move(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::Blob::SetMetadata(
         options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
   }

◆ SetTags()

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

Sets tags on the underlying blob.

Parameters

tags	The tags to set on the blob.
options	Optional parameters to execute this function.

Returns: A SetBlobTagsInfo on successfully setting tags.

   {
     BlobRestClient::Blob::SetBlobTagsOptions protocolLayerOptions;
     protocolLayerOptions.Tags = std::move(tags);
     protocolLayerOptions.IfTags = options.TagConditions;
     return BlobRestClient::Blob::SetTags(
         options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
   }

◆ StartCopyFromUri()

Azure::Core::Response< StartCopyBlobFromUriResult > Azure::Storage::Blobs::BlobClient::StartCopyFromUri	(	const std::string &	sourceUri,
		const StartCopyBlobFromUriOptions &	options = `StartCopyBlobFromUriOptions()`
	)		const

Copies data at from the source to this blob.

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.

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

   {
     BlobRestClient::Blob::StartCopyBlobFromUriOptions protocolLayerOptions;
     protocolLayerOptions.Metadata = options.Metadata;
     protocolLayerOptions.SourceUri = sourceUri;
     protocolLayerOptions.Tier = options.Tier;
     protocolLayerOptions.RehydratePriority = options.RehydratePriority;
     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;
     protocolLayerOptions.SourceLeaseId = options.SourceConditions.LeaseId;
     protocolLayerOptions.SourceIfModifiedSince = options.SourceConditions.IfModifiedSince;
     protocolLayerOptions.SourceIfUnmodifiedSince = options.SourceConditions.IfUnmodifiedSince;
     protocolLayerOptions.SourceIfMatch = options.SourceConditions.IfMatch;
     protocolLayerOptions.SourceIfNoneMatch = options.SourceConditions.IfNoneMatch;
     protocolLayerOptions.ShouldSealDestination = options.ShouldSealDestination;
     protocolLayerOptions.SourceIfTags = options.SourceConditions.TagConditions;
     return BlobRestClient::Blob::StartCopyFromUri(
         options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
   }

◆ Undelete()

Azure::Core::Response< UndeleteBlobResult > Azure::Storage::Blobs::BlobClient::Undelete ( const UndeleteBlobOptions & options = UndeleteBlobOptions() ) const

Restores the contents and metadata of a soft deleted blob and any associated soft deleted snapshots.

Parameters

options Optional parameters to execute this function.

Returns: A UndeleteBlobResult on successfully deleting.

   {
     BlobRestClient::Blob::UndeleteBlobOptions protocolLayerOptions;
     return BlobRestClient::Blob::Undelete(
         options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
   }

◆ WithSnapshot()

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

Parameters

snapshot The snapshot identifier.

Returns: A new BlobClient instance.

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

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

◆ WithVersionId()

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

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

   {
     BlobClient 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/blob_client.hpp
src/blob_client.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ BlobClient() [1/3]

◆ BlobClient() [2/3]

◆ BlobClient() [3/3]

Member Function Documentation

◆ AbortCopyFromUri()

◆ AcquireLease()

◆ BreakLease()

◆ ChangeLease()

◆ CreateFromConnectionString()

◆ CreateSnapshot()

◆ Delete()

◆ Download()

◆ DownloadTo() [1/2]

◆ DownloadTo() [2/2]

◆ GetAppendBlobClient()

◆ GetBlockBlobClient()

◆ GetPageBlobClient()

◆ GetProperties()

◆ GetTags()

◆ GetUri()

◆ ReleaseLease()

◆ RenewLease()

◆ SetAccessTier()

◆ SetHttpHeaders()

◆ SetMetadata()

◆ SetTags()

◆ StartCopyFromUri()

◆ Undelete()

◆ WithSnapshot()

◆ WithVersionId()