CloudBlobContainer.AcquireLeaseAsync 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.
Overloads
| AcquireLeaseAsync(Nullable<TimeSpan>, String) |
Initiates an asynchronous operation that acquires a lease on this container. |
| AcquireLeaseAsync(Nullable<TimeSpan>, String, CancellationToken) |
Initiates an asynchronous operation that acquires a lease on this container. |
| AcquireLeaseAsync(Nullable<TimeSpan>, String, AccessCondition, BlobRequestOptions, OperationContext) |
Initiates an asynchronous operation that acquires a lease on this container. |
| AcquireLeaseAsync(Nullable<TimeSpan>, String, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken) |
Initiates an asynchronous operation that acquires a lease on this container. |
AcquireLeaseAsync(Nullable<TimeSpan>, String)
Initiates an asynchronous operation that acquires a lease on this container.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<string> AcquireLeaseAsync (TimeSpan? leaseTime, string proposedLeaseId = default);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member AcquireLeaseAsync : Nullable<TimeSpan> * string -> System.Threading.Tasks.Task<string>
override this.AcquireLeaseAsync : Nullable<TimeSpan> * string -> System.Threading.Tasks.Task<string>Public Overridable Function AcquireLeaseAsync (leaseTime As Nullable(Of TimeSpan), Optional proposedLeaseId As String = Nothing) As Task(Of 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.
Returns
A Task<TResult> object that represents the asynchronous operation.
- Attributes
Applies to
AcquireLeaseAsync(Nullable<TimeSpan>, String, CancellationToken)
Initiates an asynchronous operation that acquires a lease on this container.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<string> AcquireLeaseAsync (TimeSpan? leaseTime, string proposedLeaseId, System.Threading.CancellationToken cancellationToken);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member AcquireLeaseAsync : Nullable<TimeSpan> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>
override this.AcquireLeaseAsync : Nullable<TimeSpan> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>Public Overridable Function AcquireLeaseAsync (leaseTime As Nullable(Of TimeSpan), proposedLeaseId As String, cancellationToken As CancellationToken) As Task(Of 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.
- cancellationToken
- CancellationToken
A CancellationToken to observe while waiting for a task to complete.
Returns
A Task<TResult> object that represents the asynchronous operation.
- Attributes
Applies to
AcquireLeaseAsync(Nullable<TimeSpan>, String, AccessCondition, BlobRequestOptions, OperationContext)
Initiates an asynchronous operation that acquires a lease on this container.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<string> AcquireLeaseAsync (TimeSpan? leaseTime, string proposedLeaseId, Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.Blob.BlobRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member AcquireLeaseAsync : Nullable<TimeSpan> * string * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task<string>
override this.AcquireLeaseAsync : Nullable<TimeSpan> * string * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task<string>Public Overridable Function AcquireLeaseAsync (leaseTime As Nullable(Of TimeSpan), proposedLeaseId As String, accessCondition As AccessCondition, options As BlobRequestOptions, operationContext As OperationContext) As Task(Of 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.
- operationContext
- OperationContext
An OperationContext object that represents the context for the current operation.
Returns
A Task<TResult> object that represents the asynchronous operation.
- Attributes
Applies to
AcquireLeaseAsync(Nullable<TimeSpan>, String, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)
Initiates an asynchronous operation that acquires a lease on this container.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<string> AcquireLeaseAsync (TimeSpan? leaseTime, string proposedLeaseId, Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.Blob.BlobRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext, System.Threading.CancellationToken cancellationToken);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member AcquireLeaseAsync : Nullable<TimeSpan> * string * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>
override this.AcquireLeaseAsync : Nullable<TimeSpan> * string * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>Public Overridable Function AcquireLeaseAsync (leaseTime As Nullable(Of TimeSpan), proposedLeaseId As String, accessCondition As AccessCondition, options As BlobRequestOptions, operationContext As OperationContext, cancellationToken As CancellationToken) As Task(Of 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.
- operationContext
- OperationContext
An OperationContext object that represents the context for the current operation.
- cancellationToken
- CancellationToken
A CancellationToken to observe while waiting for a task to complete.
Returns
A Task<TResult> object that represents the asynchronous operation.
- Attributes
Applies to
Azure SDK for .NET