B
Beacon Globe News

azure-storage-blobs: Azure::Storage::Blobs::BlobClient Class Reference

Author

James Stevens

Published Feb 15, 2026

virtual ~BlobClient ()=default Destructor. More...
  BlobClient (const std::string &blobUrl, std::shared_ptr< StorageSharedKeyCredential > credential, const BlobClientOptions &options=BlobClientOptions()) Initialize a new instance of BlobClient. More...
  BlobClient (const std::string &blobUrl, std::shared_ptr< Core::Credentials::TokenCredential > credential, const BlobClientOptions &options=BlobClientOptions()) Initialize a new instance of BlobClient. More...
  BlobClient (const std::string &blobUrl, const BlobClientOptions &options=BlobClientOptions()) Initialize a new instance of BlobClient. More...
 BlockBlobClient AsBlockBlobClient () const Creates a new BlockBlobClient object with the same URL as this BlobClient. The new BlockBlobClient uses the same request policy pipeline as this BlobClient. More...
 AppendBlobClient AsAppendBlobClient () const Creates a new AppendBlobClient object with the same URL as this BlobClient. The new AppendBlobClient uses the same request policy pipeline as this BlobClient. More...
 PageBlobClient AsPageBlobClient () const Creates a new PageBlobClient object with the same URL as this BlobClient. The new PageBlobClient uses the same request policy pipeline as this BlobClient. More...
 std::string GetUrl () const Gets the blob's primary URL endpoint. More...
 BlobClient WithSnapshot (const std::string &snapshot) const Initializes a new instance of the BlobClient class with an identical URL source but the specified snapshot timestamp. More...
 BlobClient WithVersionId (const std::string &versionId) const Creates a clone of this instance that references a version ID rather than the base blob. More...
 Azure::Response< Models::BlobPropertiesGetProperties (const GetBlobPropertiesOptions &options=GetBlobPropertiesOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const Returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob. More...
 Azure::Response< Models::SetBlobHttpHeadersResultSetHttpHeaders (Models::BlobHttpHeaders httpHeaders, const SetBlobHttpHeadersOptions &options=SetBlobHttpHeadersOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const Sets system properties on the blob. More...
 Azure::Response< Models::SetBlobMetadataResultSetMetadata (Metadata metadata, const SetBlobMetadataOptions &options=SetBlobMetadataOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const Sets user-defined metadata for the specified blob as one or more name-value pairs. More...
 Azure::Response< Models::SetBlobAccessTierResultSetAccessTier (Models::AccessTier accessTier, const SetBlobAccessTierOptions &options=SetBlobAccessTierOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const Sets the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage or general purpose v2 account. More...
 StartBlobCopyOperation StartCopyFromUri (const std::string &sourceUri, const StartBlobCopyFromUriOptions &options=StartBlobCopyFromUriOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const Copies data at from the source to this blob. More...
 Azure::Response< Models::AbortBlobCopyFromUriResultAbortCopyFromUri (const std::string &copyId, const AbortBlobCopyFromUriOptions &options=AbortBlobCopyFromUriOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const Aborts a pending StartCopyFromUri operation, and leaves this blob with zero length and full metadata. More...
 Azure::Response< Models::DownloadBlobResultDownload (const DownloadBlobOptions &options=DownloadBlobOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const Downloads a blob or a blob range from the service, including its metadata and properties. More...
 Azure::Response< Models::DownloadBlobToResultDownloadTo (uint8_t *buffer, size_t bufferSize, const DownloadBlobToOptions &options=DownloadBlobToOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const Downloads a blob or a blob range from the service to a memory buffer using parallel requests. More...
 Azure::Response< Models::DownloadBlobToResultDownloadTo (const std::string &fileName, const DownloadBlobToOptions &options=DownloadBlobToOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const Downloads a blob or a blob range from the service to a file using parallel requests. More...
 Azure::Response< Models::CreateBlobSnapshotResultCreateSnapshot (const CreateBlobSnapshotOptions &options=CreateBlobSnapshotOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const Creates a read-only snapshot of a blob. More...
 Azure::Response< Models::DeleteBlobResultDelete (const DeleteBlobOptions &options=DeleteBlobOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const Marks the specified blob or snapshot for deletion. The blob is later deleted during garbage collection. Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time using DeleteBlobOptions.DeleteSnapshots. More...
 Azure::Response< Models::DeleteBlobResultDeleteIfExists (const DeleteBlobOptions &options=DeleteBlobOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const Marks the specified blob or snapshot for deletion if it exists. More...
 Azure::Response< Models::UndeleteBlobResultUndelete (const UndeleteBlobOptions &options=UndeleteBlobOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const Restores the contents and metadata of a soft deleted blob and any associated soft deleted snapshots. More...
 Azure::Response< Models::SetBlobTagsResultSetTags (std::map< std::string, std::string > tags, const SetBlobTagsOptions &options=SetBlobTagsOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const Sets tags on the underlying blob. More...
 Azure::Response< std::map< std::string, std::string > > GetTags (const GetBlobTagsOptions &options=GetBlobTagsOptions(), const Azure::Core::Context &context=Azure::Core::Context()) const Gets the tags associated with the underlying blob. More...
 Azure::Core::Url m_blobUrl std::shared_ptr< Azure::Core::Http::_internal::HttpPipeline > m_pipeline Azure::Nullable< EncryptionKeym_customerProvidedKey Azure::Nullable< std::string > m_encryptionScope class BlobContainerClient class Files::DataLake::DataLakeFileSystemClient class Files::DataLake::DataLakeDirectoryClient class Files::DataLake::DataLakeFileClient class BlobLeaseClient