CloudBlob.AcquireLease Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Acquires a lease on this blob.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual string AcquireLease (TimeSpan? leaseTime, string proposedLeaseId, Microsoft.Azure.Storage.AccessCondition accessCondition = default, Microsoft.Azure.Storage.Blob.BlobRequestOptions options = default, Microsoft.Azure.Storage.OperationContext operationContext = default);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member AcquireLease : Nullable<TimeSpan> * string * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> string
override this.AcquireLease : Nullable<TimeSpan> * string * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> string
Public Overridable Function AcquireLease (leaseTime As Nullable(Of TimeSpan), proposedLeaseId As String, Optional accessCondition As AccessCondition = Nothing, Optional options As BlobRequestOptions = Nothing, Optional operationContext As OperationContext = Nothing) As String
Parameters
A TimeSpan representing the span of time for which to acquire the lease,
which will be rounded down to seconds. If null
, an infinite lease will be acquired. If not null, this must be
15 to 60 seconds.
- proposedLeaseId
- String
A string representing the proposed lease ID for the new lease, or null
if no lease ID is proposed.
- accessCondition
- AccessCondition
An AccessCondition object that represents the condition that must be met in order for the request to proceed. If null
, no condition is used.
- options
- BlobRequestOptions
A BlobRequestOptions object that specifies additional options for the request. If null
, default options are applied to the request.
- operationContext
- OperationContext
An OperationContext object that represents the context for the current operation.
Returns
The ID of the acquired lease.
- Attributes