EventGridReceiverClient.RenewLocksAsync Method

Reference

Definition

Namespace:: Azure.Messaging.EventGrid.Namespaces

Assembly:: Azure.Messaging.EventGrid.Namespaces.dll

Package:: Azure.Messaging.EventGrid.Namespaces v1.0.0

Source:: EventGridReceiverClient.cs

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.

Renew locks for a batch of Cloud Events. The response will include the set of successfully renewed lock tokens, along with other failed lock tokens with their corresponding error information. Successfully renewed locks will ensure that the associated event is only available to the consumer that holds the renewed lock.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.EventGrid.Namespaces.RenewLocksResult>> RenewLocksAsync (System.Collections.Generic.IEnumerable<string> lockTokens, System.Threading.CancellationToken cancellationToken = default);

abstract member RenewLocksAsync : seq<string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.EventGrid.Namespaces.RenewLocksResult>>
override this.RenewLocksAsync : seq<string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.EventGrid.Namespaces.RenewLocksResult>>

Public Overridable Function RenewLocksAsync (lockTokens As IEnumerable(Of String), Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of RenewLocksResult))

Parameters

lockTokens: IEnumerable<String>

Array of lock tokens.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<RenewLocksResult>>

Exceptions

ArgumentNullException

lockTokens is null.

Applies to

Share via