EventGridClient.RejectCloudEvents 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

RejectCloudEvents(String, String, RequestContent, RequestContext)

[Protocol Method] Reject 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 rejected lockTokens, along with other failed lockTokens with their corresponding error information. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler RejectCloudEvents(String, String, RejectOptions, CancellationToken) convenience overload with strongly typed models first.

RejectCloudEvents(String, String, RejectOptions, CancellationToken)

Reject 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 rejected lockTokens, along with other failed lockTokens with their corresponding error information.

RejectCloudEvents(String, String, RequestContent, RequestContext)

Source:

EventGridClient.cs

[Protocol Method] Reject 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 rejected lockTokens, along with other failed lockTokens with their corresponding error information.

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

public virtual Azure.Response RejectCloudEvents (string topicName, string eventSubscriptionName, Azure.Core.RequestContent content, Azure.RequestContext context = default);

abstract member RejectCloudEvents : string * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.RejectCloudEvents : string * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response

Public Overridable Function RejectCloudEvents (topicName As String, eventSubscriptionName As String, content As RequestContent, Optional context As RequestContext = Nothing) As 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

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 RejectCloudEvents 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 = client.RejectCloudEvents("<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 RejectCloudEvents 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 = client.RejectCloudEvents("<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());

RejectCloudEvents(String, String, RejectOptions, CancellationToken)

Source:

EventGridClient.cs

Reject 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 rejected lockTokens, along with other failed lockTokens with their corresponding error information.

public virtual Azure.Response<Azure.Messaging.EventGrid.Namespaces.RejectResult> RejectCloudEvents (string topicName, string eventSubscriptionName, Azure.Messaging.EventGrid.Namespaces.RejectOptions rejectOptions, System.Threading.CancellationToken cancellationToken = default);

abstract member RejectCloudEvents : string * string * Azure.Messaging.EventGrid.Namespaces.RejectOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Messaging.EventGrid.Namespaces.RejectResult>
override this.RejectCloudEvents : string * string * Azure.Messaging.EventGrid.Namespaces.RejectOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Messaging.EventGrid.Namespaces.RejectResult>

Public Overridable Function RejectCloudEvents (topicName As String, eventSubscriptionName As String, rejectOptions As RejectOptions, Optional cancellationToken As CancellationToken = Nothing) As Response(Of RejectResult)

Parameters

topicName

String

Topic Name.

eventSubscriptionName

String

Event Subscription Name.

rejectOptions

RejectOptions

RejectOptions.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<RejectResult>

Exceptions

ArgumentNullException

topicName, eventSubscriptionName or rejectOptions is null.

ArgumentException

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

Examples

This sample shows how to call RejectCloudEvents.

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

RejectOptions rejectOptions = new RejectOptions(new string[] { "<lockTokens>" });
Response<RejectResult> response = client.RejectCloudEvents("<topicName>", "<eventSubscriptionName>", rejectOptions);

This sample shows how to call RejectCloudEvents with all parameters.

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

RejectOptions rejectOptions = new RejectOptions(new string[] { "<lockTokens>" });
Response<RejectResult> response = client.RejectCloudEvents("<topicName>", "<eventSubscriptionName>", rejectOptions);