EventGridClient.AcknowledgeCloudEventsAsync Method

Definition

Namespace:

Azure.Messaging.EventGrid.Namespaces

Assemblies:

Azure.Messaging.EventGrid.dll, Azure.Messaging.EventGrid.Namespaces.dll

Packages:

Azure.Messaging.EventGrid v4.22.0-beta.1, Azure.Messaging.EventGrid.Namespaces v1.0.0-beta.1

Overloads

AcknowledgeCloudEventsAsync(String, String, AcknowledgeOptions, CancellationToken)

Acknowledge batch of Cloud Events. The server responds with an HTTP 200 status code if the request is successfully accepted. The response body will include the set of successfully acknowledged lockTokens, along with other failed lockTokens with their corresponding error information. Successfully acknowledged events will no longer be available to any consumer.

AcknowledgeCloudEventsAsync(String, String, RequestContent, RequestContext)

[Protocol Method] Acknowledge batch of Cloud Events. The server responds with an HTTP 200 status code if the request is successfully accepted. The response body will include the set of successfully acknowledged lockTokens, along with other failed lockTokens with their corresponding error information. Successfully acknowledged events will no longer be available to any consumer. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler AcknowledgeCloudEventsAsync(String, String, AcknowledgeOptions, CancellationToken) convenience overload with strongly typed models first.

AcknowledgeCloudEventsAsync(String, String, AcknowledgeOptions, CancellationToken)

Source:

EventGridClient.cs

Acknowledge batch of Cloud Events. The server responds with an HTTP 200 status code if the request is successfully accepted. The response body will include the set of successfully acknowledged lockTokens, along with other failed lockTokens with their corresponding error information. Successfully acknowledged events will no longer be available to any consumer.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.EventGrid.Namespaces.AcknowledgeResult>> AcknowledgeCloudEventsAsync (string topicName, string eventSubscriptionName, Azure.Messaging.EventGrid.Namespaces.AcknowledgeOptions acknowledgeOptions, System.Threading.CancellationToken cancellationToken = default);

abstract member AcknowledgeCloudEventsAsync : string * string * Azure.Messaging.EventGrid.Namespaces.AcknowledgeOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.EventGrid.Namespaces.AcknowledgeResult>>
override this.AcknowledgeCloudEventsAsync : string * string * Azure.Messaging.EventGrid.Namespaces.AcknowledgeOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.EventGrid.Namespaces.AcknowledgeResult>>

Public Overridable Function AcknowledgeCloudEventsAsync (topicName As String, eventSubscriptionName As String, acknowledgeOptions As AcknowledgeOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AcknowledgeResult))

Parameters

topicName

String

Topic Name.

eventSubscriptionName

String

Event Subscription Name.

acknowledgeOptions

AcknowledgeOptions

AcknowledgeOptions.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<AcknowledgeResult>>

Exceptions

ArgumentNullException

topicName, eventSubscriptionName or acknowledgeOptions is null.

ArgumentException

topicName or eventSubscriptionName is an empty string, and was expected to be non-empty.

Examples

This sample shows how to call AcknowledgeCloudEventsAsync.

Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
EventGridClient client = new EventGridClient(endpoint, credential);

AcknowledgeOptions acknowledgeOptions = new AcknowledgeOptions(new string[] { "<lockTokens>" });
Response<AcknowledgeResult> response = await client.AcknowledgeCloudEventsAsync("<topicName>", "<eventSubscriptionName>", acknowledgeOptions);

This sample shows how to call AcknowledgeCloudEventsAsync with all parameters.

Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
EventGridClient client = new EventGridClient(endpoint, credential);

AcknowledgeOptions acknowledgeOptions = new AcknowledgeOptions(new string[] { "<lockTokens>" });
Response<AcknowledgeResult> response = await client.AcknowledgeCloudEventsAsync("<topicName>", "<eventSubscriptionName>", acknowledgeOptions);

AcknowledgeCloudEventsAsync(String, String, RequestContent, RequestContext)

Source:

EventGridClient.cs

[Protocol Method] Acknowledge batch of Cloud Events. The server responds with an HTTP 200 status code if the request is successfully accepted. The response body will include the set of successfully acknowledged lockTokens, along with other failed lockTokens with their corresponding error information. Successfully acknowledged events will no longer be available to any consumer.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler AcknowledgeCloudEventsAsync(String, String, AcknowledgeOptions, CancellationToken) convenience overload with strongly typed models first.

public virtual System.Threading.Tasks.Task<Azure.Response> AcknowledgeCloudEventsAsync (string topicName, string eventSubscriptionName, Azure.Core.RequestContent content, Azure.RequestContext context = default);

abstract member AcknowledgeCloudEventsAsync : string * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.AcknowledgeCloudEventsAsync : string * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function AcknowledgeCloudEventsAsync (topicName As String, eventSubscriptionName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

topicName

String

Topic Name.

eventSubscriptionName

String

Event Subscription Name.

content

RequestContent

The content to send as the body of the request.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

topicName, eventSubscriptionName or content is null.

ArgumentException

topicName or eventSubscriptionName is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call AcknowledgeCloudEventsAsync and parse the result.

Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
EventGridClient client = new EventGridClient(endpoint, credential);

using RequestContent content = RequestContent.Create(new
{
    lockTokens = new object[]
    {
        "<lockTokens>"
    },
});
Response response = await client.AcknowledgeCloudEventsAsync("<topicName>", "<eventSubscriptionName>", content);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("failedLockTokens")[0].GetProperty("lockToken").ToString());
Console.WriteLine(result.GetProperty("failedLockTokens")[0].GetProperty("error").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("failedLockTokens")[0].GetProperty("error").GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("succeededLockTokens")[0].ToString());

This sample shows how to call AcknowledgeCloudEventsAsync with all parameters and request content and parse the result.

Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
EventGridClient client = new EventGridClient(endpoint, credential);

using RequestContent content = RequestContent.Create(new
{
    lockTokens = new object[]
    {
        "<lockTokens>"
    },
});
Response response = await client.AcknowledgeCloudEventsAsync("<topicName>", "<eventSubscriptionName>", content);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("failedLockTokens")[0].GetProperty("lockToken").ToString());
Console.WriteLine(result.GetProperty("failedLockTokens")[0].GetProperty("error").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("failedLockTokens")[0].GetProperty("error").GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("failedLockTokens")[0].GetProperty("error").GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("failedLockTokens")[0].GetProperty("error").GetProperty("innererror").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("succeededLockTokens")[0].ToString());