EventGridReceiverClient.Release Method

Definition

Release a batch of Cloud Events. The response will include the set of successfully released lock tokens, along with other failed lock tokens with their corresponding error information. Successfully released events can be received by consumers.

public virtual Azure.Response<Azure.Messaging.EventGrid.Namespaces.ReleaseResult> Release (System.Collections.Generic.IEnumerable<string> lockTokens, Azure.Messaging.EventGrid.Namespaces.ReleaseDelay? delay = default, System.Threading.CancellationToken cancellationToken = default);
abstract member Release : seq<string> * Nullable<Azure.Messaging.EventGrid.Namespaces.ReleaseDelay> * System.Threading.CancellationToken -> Azure.Response<Azure.Messaging.EventGrid.Namespaces.ReleaseResult>
override this.Release : seq<string> * Nullable<Azure.Messaging.EventGrid.Namespaces.ReleaseDelay> * System.Threading.CancellationToken -> Azure.Response<Azure.Messaging.EventGrid.Namespaces.ReleaseResult>
Public Overridable Function Release (lockTokens As IEnumerable(Of String), Optional delay As Nullable(Of ReleaseDelay) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ReleaseResult)

Parameters

lockTokens
IEnumerable<String>

Array of lock tokens.

delay
Nullable<ReleaseDelay>

Release cloud events with the specified delay in seconds.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

lockTokens is null.

Applies to