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

BlobLeaseClient allows you to manipulate Azure Storage leases on containers and blobs.

#include <blob_lease_client.hpp>

◆ BlobLeaseClient() [1/2]

Azure::Storage::Blobs::BlobLeaseClient::BlobLeaseClient ( BlobClient  blobClient, std::string  leaseId  )

inlineexplicit

Parameters

blobClient	A BlobClient representing the blob being leased.
leaseId	A lease ID. This is not required for break operation.

◆ BlobLeaseClient() [2/2]

Azure::Storage::Blobs::BlobLeaseClient::BlobLeaseClient ( BlobContainerClient  blobContainerClient, std::string  leaseId  )

inlineexplicit

Parameters

blobContainerClient	A BlobContainerClient representing the blob container being leased.
leaseId	A lease ID. This is not required for break operation.

Parameters

duration	Specifies the duration of the lease, in seconds, or 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.
context	Context for cancelling long running operations.

Returns

An AcquireLeaseResult describing the lease.

Parameters

options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns

A BreakLeaseResult describing the broken lease.

Parameters

proposedLeaseId	Proposed lease ID, in a GUID string format.
options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns

A ChangeLeaseResult describing the changed lease.

◆ CreateUniqueLeaseId()

std::string Azure::Storage::Blobs::BlobLeaseClient::CreateUniqueLeaseId ( )

static

Returns

A unique lease ID.

◆ GetLeaseId()

std::string Azure::Storage::Blobs::BlobLeaseClient::GetLeaseId ( )

inline

Returns

Lease id of this lease client.

Parameters

options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns

A ReleaseLeaseResult describing the updated container or blob.

Parameters

options	Optional parameters to execute this function.
context	Context for cancelling long running operations.

Returns

A RenewLeaseResult describing the lease.

---

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