CloudBlob.BreakLeaseAsync 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
| BreakLeaseAsync(Nullable<TimeSpan>) |
Initiates an asynchronous operation to break the current lease on this blob. |
| BreakLeaseAsync(Nullable<TimeSpan>, CancellationToken) |
Initiates an asynchronous operation to break the current lease on this blob. |
| BreakLeaseAsync(Nullable<TimeSpan>, AccessCondition, BlobRequestOptions, OperationContext) |
Initiates an asynchronous operation to break the current lease on this blob. |
| BreakLeaseAsync(Nullable<TimeSpan>, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken) |
Initiates an asynchronous operation to break the current lease on this blob. |
BreakLeaseAsync(Nullable<TimeSpan>)
Initiates an asynchronous operation to break the current lease on this blob.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<TimeSpan> BreakLeaseAsync (TimeSpan? breakPeriod);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member BreakLeaseAsync : Nullable<TimeSpan> -> System.Threading.Tasks.Task<TimeSpan>
override this.BreakLeaseAsync : Nullable<TimeSpan> -> System.Threading.Tasks.Task<TimeSpan>Public Overridable Function BreakLeaseAsync (breakPeriod As Nullable(Of TimeSpan)) As Task(Of TimeSpan)Parameters
A TimeSpan representing the amount of time to allow the lease to remain,
which will be rounded down to seconds. If null, the break period is the remainder of the current lease,
or zero for infinite leases.
Returns
A Task<TResult> object of type TimeSpan that represents the asynchronous operation.
- Attributes
Applies to
BreakLeaseAsync(Nullable<TimeSpan>, CancellationToken)
Initiates an asynchronous operation to break the current lease on this blob.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<TimeSpan> BreakLeaseAsync (TimeSpan? breakPeriod, System.Threading.CancellationToken cancellationToken);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member BreakLeaseAsync : Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<TimeSpan>
override this.BreakLeaseAsync : Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<TimeSpan>Public Overridable Function BreakLeaseAsync (breakPeriod As Nullable(Of TimeSpan), cancellationToken As CancellationToken) As Task(Of TimeSpan)Parameters
A TimeSpan representing the amount of time to allow the lease to remain,
which will be rounded down to seconds. If null, the break period is the remainder of the current lease,
or zero for infinite leases.
- cancellationToken
- CancellationToken
A CancellationToken to observe while waiting for a task to complete.
Returns
A Task<TResult> object of type TimeSpan that represents the asynchronous operation.
- Attributes
Applies to
BreakLeaseAsync(Nullable<TimeSpan>, AccessCondition, BlobRequestOptions, OperationContext)
Initiates an asynchronous operation to break the current lease on this blob.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<TimeSpan> BreakLeaseAsync (TimeSpan? breakPeriod, Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.Blob.BlobRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member BreakLeaseAsync : Nullable<TimeSpan> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task<TimeSpan>
override this.BreakLeaseAsync : Nullable<TimeSpan> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task<TimeSpan>Public Overridable Function BreakLeaseAsync (breakPeriod As Nullable(Of TimeSpan), accessCondition As AccessCondition, options As BlobRequestOptions, operationContext As OperationContext) As Task(Of TimeSpan)Parameters
A TimeSpan representing the amount of time to allow the lease to remain,
which will be rounded down to seconds. If null, the break period is the remainder of the current lease,
or zero for infinite leases.
- 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 of type TimeSpan that represents the asynchronous operation.
- Attributes
Applies to
BreakLeaseAsync(Nullable<TimeSpan>, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)
Initiates an asynchronous operation to break the current lease on this blob.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<TimeSpan> BreakLeaseAsync (TimeSpan? breakPeriod, 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 BreakLeaseAsync : Nullable<TimeSpan> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<TimeSpan>
override this.BreakLeaseAsync : Nullable<TimeSpan> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<TimeSpan>Public Overridable Function BreakLeaseAsync (breakPeriod As Nullable(Of TimeSpan), accessCondition As AccessCondition, options As BlobRequestOptions, operationContext As OperationContext, cancellationToken As CancellationToken) As Task(Of TimeSpan)Parameters
A TimeSpan representing the amount of time to allow the lease to remain,
which will be rounded down to seconds. If null, the break period is the remainder of the current lease,
or zero for infinite leases.
- 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 of type TimeSpan that represents the asynchronous operation.
- Attributes
Applies to
Azure SDK for .NET