Partilhar via


EventGridReceiverClient.RenewLocksAsync Method

Definition

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

Exceptions

lockTokens is null.

Applies to