Azure::Storage::Blobs::PageBlobClient Class Reference

#include <page_blob_client.hpp>

Inheritance diagram for Azure::Storage::Blobs::PageBlobClient:

Public Member Functions
	PageBlobClient (const std::string &blobUri, std::shared_ptr< SharedKeyCredential > credential, const PageBlobClientOptions &options=PageBlobClientOptions())
	Initialize a new instance of PageBlobClient. More...
	PageBlobClient (const std::string &blobUri, std::shared_ptr< Core::Credentials::ClientSecretCredential > credential, const PageBlobClientOptions &options=PageBlobClientOptions())
	Initialize a new instance of PageBlobClient. More...
	PageBlobClient (const std::string &blobUri, const PageBlobClientOptions &options=PageBlobClientOptions())
	Initialize a new instance of PageBlobClient. More...
PageBlobClient	WithSnapshot (const std::string &snapshot) const
	Initializes a new instance of the PageBlobClient class with an identical uri source but the specified snapshot timestamp. More...
PageBlobClient	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< CreatePageBlobResult >	Create (int64_t blobContentLength, const CreatePageBlobOptions &options=CreatePageBlobOptions()) const
	Creates a new page blob of the specified size. The content of any existing blob is overwritten with the newly initialized page blob. More...
Azure::Core::Response< UploadPageBlobPagesResult >	UploadPages (int64_t offset, Azure::Core::Http::BodyStream *content, const UploadPageBlobPagesOptions &options=UploadPageBlobPagesOptions()) const
	Writes content to a range of pages in a page blob, starting at offset. More...
Azure::Core::Response< UploadPageBlobPagesFromUriResult >	UploadPagesFromUri (int64_t destinationoffset, std::string sourceUri, int64_t sourceOffset, int64_t sourceLength, const UploadPageBlobPagesFromUriOptions &options=UploadPageBlobPagesFromUriOptions()) const
	Writes a range of pages to a page blob where the contents are read from a uri. More...
Azure::Core::Response< ClearPageBlobPagesResult >	ClearPages (int64_t offset, int64_t length, const ClearPageBlobPagesOptions &options=ClearPageBlobPagesOptions()) const
	Clears one or more pages from the page blob, as specificed by offset and length. More...
Azure::Core::Response< ResizePageBlobResult >	Resize (int64_t blobContentLength, const ResizePageBlobOptions &options=ResizePageBlobOptions()) const
	Resizes the page blob to the specified size (which must be a multiple of 512). If the specified value is less than the current size of the blob, then all pages above the specified value are cleared. More...
Azure::Core::Response< GetPageBlobPageRangesResult >	GetPageRanges (const GetPageBlobPageRangesOptions &options=GetPageBlobPageRangesOptions()) const
	Returns the list of valid page ranges for a page blob or snapshot of a page blob. More...
Azure::Core::Response< StartCopyPageBlobIncrementalResult >	StartCopyIncremental (const std::string &sourceUri, const StartCopyPageBlobIncrementalOptions &options=StartCopyPageBlobIncrementalOptions()) const
	Starts copying a snapshot of the sourceUri page blob to this page blob. The snapshot is copied such that only the differential changes between the previously copied snapshot are transferred to the destination. The copied snapshots are complete copies of the original snapshot and can be read or copied from as usual. 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 PageBlobClient	CreateFromConnectionString (const std::string &connectionString, const std::string &containerName, const std::string &blobName, const PageBlobClientOptions &options=PageBlobClientOptions())
	Initialize a new instance of PageBlobClient. 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 PageBlobClient allows you to manipulate Azure Storage page blobs.

Page blobs are a collection of 512-byte pages optimized for random read and write operations. To create a page blob, you initialize the page blob and specify the maximum size the page blob will grow. To add or update the contents of a page blob, you write a page or pages by specifying an offset and a range that align to 512-byte page boundaries. Writes to page blobs happen in-place and are immediately committed to the blob.

Constructor & Destructor Documentation

PageBlobClient() [1/3]

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

explicit

Initialize a new instance of PageBlobClient.

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

PageBlobClient() [2/3]

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

explicit

Initialize a new instance of PageBlobClient.

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

PageBlobClient() [3/3]

Azure::Storage::Blobs::PageBlobClient::PageBlobClient ( const std::string &  blobUri, const PageBlobClientOptions &  options = PageBlobClientOptions()  )

explicit

Initialize a new instance of PageBlobClient.

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

ClearPages()

Azure::Core::Response< ClearPageBlobPagesResult > Azure::Storage::Blobs::PageBlobClient::ClearPages	(	int64_t	offset,
		int64_t	length,
		const ClearPageBlobPagesOptions &	options = ClearPageBlobPagesOptions()
	)		const

Clears one or more pages from the page blob, as specificed by offset and length.

Parameters

offset	Specifies the starting offset for the content to be cleared. Given that pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512.
length	Specifies the length of the content to be cleared. The length must be a modulus of 512.
options	Optional parameters to execute this function.

Returns

A ClearPageBlobPagesResult describing the state of the updated pages.

  {
    BlobRestClient::PageBlob::ClearPageBlobPagesOptions protocolLayerOptions;
    protocolLayerOptions.Range = std::make_pair(offset, offset + length - 1);
    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::PageBlob::ClearPages(
        options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
  }

Create()

Azure::Core::Response< CreatePageBlobResult > Azure::Storage::Blobs::PageBlobClient::Create	(	int64_t	blobContentLength,
		const CreatePageBlobOptions &	options = CreatePageBlobOptions()
	)		const

Creates a new page blob of the specified size. The content of any existing blob is overwritten with the newly initialized page blob.

Parameters

blobContentLength	Specifies the maximum size for the page blob. The size must be aligned to a 512-byte boundary.
options	Optional parameters to execute this function.

Returns

A CreatePageBlobResult describing the newly created page blob.

  {
    BlobRestClient::PageBlob::CreatePageBlobOptions protocolLayerOptions;
    protocolLayerOptions.BlobContentLength = blobContentLength;
    protocolLayerOptions.SequenceNumber = options.SequenceNumber;
    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::PageBlob::Create(
        options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
  }

CreateFromConnectionString()

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

static

Initialize a new instance of PageBlobClient.

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

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

GetPageRanges()

Azure::Core::Response< GetPageBlobPageRangesResult > Azure::Storage::Blobs::PageBlobClient::GetPageRanges

(

const GetPageBlobPageRangesOptions &

options = GetPageBlobPageRangesOptions()

)

const

Returns the list of valid page ranges for a page blob or snapshot of a page blob.

Parameters

options

Optional parameters to execute this function.

Returns

A GetPageBlobPageRangesResult describing the valid page ranges for this blob.

  {
    BlobRestClient::PageBlob::GetPageBlobPageRangesOptions protocolLayerOptions;
    protocolLayerOptions.PreviousSnapshot = options.PreviousSnapshot;
    protocolLayerOptions.PreviousSnapshotUrl = options.PreviousSnapshotUrl;
    if (options.Offset.HasValue() && options.Length.HasValue())
    {
      protocolLayerOptions.Range = std::make_pair(
          options.Offset.GetValue(), options.Offset.GetValue() + options.Length.GetValue() - 1);
    }
    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;
    auto protocolLayerResponse = BlobRestClient::PageBlob::GetPageRanges(
        options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
 
    GetPageBlobPageRangesResult ret;
    ret.ETag = std::move(protocolLayerResponse->ETag);
    ret.LastModified = std::move(protocolLayerResponse->LastModified);
    ret.BlobContentLength = protocolLayerResponse->BlobContentLength;
    for (const auto& range : protocolLayerResponse->PageRanges)
    {
      ret.PageRanges.emplace_back(PageRange{range.first, range.second - range.first + 1});
    }
    for (const auto& range : protocolLayerResponse->ClearRanges)
    {
      ret.ClearRanges.emplace_back(PageRange{range.first, range.second - range.first + 1});
    }
    return Azure::Core::Response<GetPageBlobPageRangesResult>(
        std::move(ret),
        std::make_unique<Azure::Core::Http::RawResponse>(
            std::move(protocolLayerResponse.GetRawResponse())));
  }

Resize()

Azure::Core::Response< ResizePageBlobResult > Azure::Storage::Blobs::PageBlobClient::Resize	(	int64_t	blobContentLength,
		const ResizePageBlobOptions &	options = ResizePageBlobOptions()
	)		const

Resizes the page blob to the specified size (which must be a multiple of 512). If the specified value is less than the current size of the blob, then all pages above the specified value are cleared.

Parameters

blobContentLength	Specifies the maximum size for the page blob. The size must be aligned to a 512-byte boundary.
options	Optional parameters to execute this function.

Returns

A ResizePageBlobResult describing the resized page blob.

  {
    BlobRestClient::PageBlob::ResizePageBlobOptions protocolLayerOptions;
    protocolLayerOptions.BlobContentLength = blobContentLength;
    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::PageBlob::Resize(
        options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
  }

StartCopyIncremental()

Azure::Core::Response< StartCopyPageBlobIncrementalResult > Azure::Storage::Blobs::PageBlobClient::StartCopyIncremental	(	const std::string &	sourceUri,
		const StartCopyPageBlobIncrementalOptions &	options = StartCopyPageBlobIncrementalOptions()
	)		const

Starts copying a snapshot of the sourceUri page blob to this page blob. The snapshot is copied such that only the differential changes between the previously copied snapshot are transferred to the destination. The copied snapshots are complete copies of the original snapshot and can be read or copied from as usual.

Parameters

sourceUri	Specifies the to the source page blob as a uri up to 2 KB in length. The source blob must either be public or must be authenticated via a shared access signature.
options	Optional parameters to execute this function.

Returns

A StartCopyPageBlobIncrementalResult describing the state of the copy operation.

  {
    BlobRestClient::PageBlob::StartCopyPageBlobIncrementalOptions protocolLayerOptions;
    protocolLayerOptions.CopySource = sourceUri;
    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::PageBlob::StartCopyIncremental(
        options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
  }

UploadPages()

Azure::Core::Response< UploadPageBlobPagesResult > Azure::Storage::Blobs::PageBlobClient::UploadPages	(	int64_t	offset,
		Azure::Core::Http::BodyStream *	content,
		const UploadPageBlobPagesOptions &	options = UploadPageBlobPagesOptions()
	)		const

Writes content to a range of pages in a page blob, starting at offset.

Parameters

offset	Specifies the starting offset for the content to be written as a page. Given that pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512.
content	A BodyStream containing the content of the pages to upload.
options	Optional parameters to execute this function.

Returns

A UploadPageBlobPagesResult describing the state of the updated pages.

  {
    BlobRestClient::PageBlob::UploadPageBlobPagesOptions protocolLayerOptions;
    protocolLayerOptions.Range = std::make_pair(offset, offset + content->Length() - 1);
    protocolLayerOptions.TransactionalContentMd5 = options.TransactionalContentMd5;
    protocolLayerOptions.TransactionalContentCrc64 = options.TransactionalContentCrc64;
    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::PageBlob::UploadPages(
        options.Context, *m_pipeline, m_blobUrl, content, protocolLayerOptions);
  }

UploadPagesFromUri()

Azure::Core::Response< UploadPageBlobPagesFromUriResult > Azure::Storage::Blobs::PageBlobClient::UploadPagesFromUri	(	int64_t	destinationoffset,
		std::string	sourceUri,
		int64_t	sourceOffset,
		int64_t	sourceLength,
		const UploadPageBlobPagesFromUriOptions &	options = UploadPageBlobPagesFromUriOptions()
	)		const

Writes a range of pages to a page blob where the contents are read from a uri.

Parameters

destinationOffset	Specifies the starting offset for the content to be written. Given that pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512.
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.
sourceOffset	Only upload a part of the blob in the sourceUri from the specified offset. This offset doesn't need to be a modulus of 512.
sourceLength	Only upload specified length of the blob in the sourceUri. This length must be a modulus of 512.
options	Optional parameters to execute this function.

Returns

A UploadPageBlobPagesFromUriResult describing the state of the updated pages.

  {
    BlobRestClient::PageBlob::UploadPageBlobPagesFromUriOptions protocolLayerOptions;
    protocolLayerOptions.SourceUri = sourceUri;
    protocolLayerOptions.SourceRange
        = std::make_pair(sourceOffset, sourceOffset + sourceLength - 1);
    protocolLayerOptions.Range
        = std::make_pair(destinationoffset, destinationoffset + sourceLength - 1);
    protocolLayerOptions.TransactionalContentMd5 = options.TransactionalContentMd5;
    protocolLayerOptions.TransactionalContentCrc64 = options.TransactionalContentCrc64;
    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::PageBlob::UploadPagesFromUri(
        options.Context, *m_pipeline, m_blobUrl, protocolLayerOptions);
  }

WithSnapshot()

PageBlobClient Azure::Storage::Blobs::PageBlobClient::WithSnapshot

(

const std::string &

snapshot

)

const

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

Parameters

snapshot

The snapshot identifier.

Returns

A new PageBlobClient instance.

Remarks

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

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

WithVersionId()

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

Remarks

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

  {
    PageBlobClient 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/page_blob_client.hpp
• src/page_blob_client.cpp