EventGridClient Class

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

Source:

EventGridClient.cs

Azure Messaging EventGrid Client.

public class EventGridClient

type EventGridClient = class

Public Class EventGridClient

Inheritance

Object

EventGridClient

Constructors

EventGridClient()	Initializes a new instance of EventGridClient for mocking.
EventGridClient(Uri, AzureKeyCredential, EventGridClientOptions)	Initializes a new instance of EventGridClient.
EventGridClient(Uri, AzureKeyCredential)	Initializes a new instance of EventGridClient.
EventGridClient(Uri, TokenCredential, EventGridClientOptions)	Initializes a new instance of EventGridClient.
EventGridClient(Uri, TokenCredential)	Initializes a new instance of EventGridClient.

Properties

Pipeline

The HTTP pipeline for sending and receiving REST requests and responses.

Methods

AcknowledgeCloudEvents(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.
AcknowledgeCloudEvents(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 AcknowledgeCloudEvents(String, String, AcknowledgeOptions, CancellationToken) convenience overload with strongly typed models first.
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.
PublishCloudEvent(String, CloudEvent, Boolean, CancellationToken)	Publish Single Cloud Event to namespace topic. In case of success, the server responds with an HTTP 200 status code with an empty JSON object in response. Otherwise, the server can return various error codes. For example, 401: which indicates authorization failure, 403: which indicates quota exceeded or message is too large, 410: which indicates that specific topic is not found, 400: for bad request, and 500: for internal server error.
PublishCloudEvent(String, RequestContent, RequestContext)	[Protocol Method] Publish Single Cloud Event to namespace topic. In case of success, the server responds with an HTTP 200 status code with an empty JSON object in response. Otherwise, the server can return various error codes. For example, 401: which indicates authorization failure, 403: which indicates quota exceeded or message is too large, 410: which indicates that specific topic is not found, 400: for bad request, and 500: for internal server error. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
PublishCloudEventAsync(String, CloudEvent, Boolean, CancellationToken)	Publish Single Cloud Event to namespace topic. In case of success, the server responds with an HTTP 200 status code with an empty JSON object in response. Otherwise, the server can return various error codes. For example, 401: which indicates authorization failure, 403: which indicates quota exceeded or message is too large, 410: which indicates that specific topic is not found, 400: for bad request, and 500: for internal server error.
PublishCloudEventAsync(String, RequestContent, RequestContext)	[Protocol Method] Publish Single Cloud Event to namespace topic. In case of success, the server responds with an HTTP 200 status code with an empty JSON object in response. Otherwise, the server can return various error codes. For example, 401: which indicates authorization failure, 403: which indicates quota exceeded or message is too large, 410: which indicates that specific topic is not found, 400: for bad request, and 500: for internal server error. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
PublishCloudEvents(String, IEnumerable<CloudEvent>, CancellationToken)	Publish Batch Cloud Event to namespace topic. In case of success, the server responds with an HTTP 200 status code with an empty JSON object in response. Otherwise, the server can return various error codes. For example, 401: which indicates authorization failure, 403: which indicates quota exceeded or message is too large, 410: which indicates that specific topic is not found, 400: for bad request, and 500: for internal server error.
PublishCloudEvents(String, RequestContent, RequestContext)	[Protocol Method] Publish Batch Cloud Event to namespace topic. In case of success, the server responds with an HTTP 200 status code with an empty JSON object in response. Otherwise, the server can return various error codes. For example, 401: which indicates authorization failure, 403: which indicates quota exceeded or message is too large, 410: which indicates that specific topic is not found, 400: for bad request, and 500: for internal server error. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
PublishCloudEventsAsync(String, IEnumerable<CloudEvent>, CancellationToken)	Publish Batch Cloud Event to namespace topic. In case of success, the server responds with an HTTP 200 status code with an empty JSON object in response. Otherwise, the server can return various error codes. For example, 401: which indicates authorization failure, 403: which indicates quota exceeded or message is too large, 410: which indicates that specific topic is not found, 400: for bad request, and 500: for internal server error.
PublishCloudEventsAsync(String, RequestContent, RequestContext)	[Protocol Method] Publish Batch Cloud Event to namespace topic. In case of success, the server responds with an HTTP 200 status code with an empty JSON object in response. Otherwise, the server can return various error codes. For example, 401: which indicates authorization failure, 403: which indicates quota exceeded or message is too large, 410: which indicates that specific topic is not found, 400: for bad request, and 500: for internal server error. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ReceiveCloudEvents(String, String, Nullable<Int32>, Nullable<TimeSpan>, CancellationToken)	Receive Batch of Cloud Events from the Event Subscription.
ReceiveCloudEvents(String, String, Nullable<Int32>, Nullable<TimeSpan>, RequestContext)	[Protocol Method] Receive Batch of Cloud Events from the Event Subscription. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler ReceiveCloudEvents(String, String, Nullable<Int32>, Nullable<TimeSpan>, CancellationToken) convenience overload with strongly typed models first.
ReceiveCloudEventsAsync(String, String, Nullable<Int32>, Nullable<TimeSpan>, CancellationToken)	Receive Batch of Cloud Events from the Event Subscription.
ReceiveCloudEventsAsync(String, String, Nullable<Int32>, Nullable<TimeSpan>, RequestContext)	[Protocol Method] Receive Batch of Cloud Events from the Event Subscription. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler ReceiveCloudEventsAsync(String, String, Nullable<Int32>, Nullable<TimeSpan>, 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)	[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.
RejectCloudEventsAsync(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.
RejectCloudEventsAsync(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 RejectCloudEventsAsync(String, String, RejectOptions, CancellationToken) convenience overload with strongly typed models first.
ReleaseCloudEvents(String, String, ReleaseOptions, Nullable<ReleaseDelay>, CancellationToken)	Release 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 released lockTokens, along with other failed lockTokens with their corresponding error information.
ReleaseCloudEvents(String, String, RequestContent, Nullable<Int32>, RequestContext)	[Protocol Method] Release 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 released 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 ReleaseCloudEvents(String, String, ReleaseOptions, Nullable<ReleaseDelay>, CancellationToken) convenience overload with strongly typed models first.
ReleaseCloudEventsAsync(String, String, ReleaseOptions, Nullable<ReleaseDelay>, CancellationToken)	Release 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 released lockTokens, along with other failed lockTokens with their corresponding error information.
ReleaseCloudEventsAsync(String, String, RequestContent, Nullable<Int32>, RequestContext)	[Protocol Method] Release 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 released 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 ReleaseCloudEventsAsync(String, String, ReleaseOptions, Nullable<ReleaseDelay>, CancellationToken) convenience overload with strongly typed models first.
RenewCloudEventLocks(String, String, RenewLockOptions, CancellationToken)	Renew lock for 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 renewed lockTokens, along with other failed lockTokens with their corresponding error information.
RenewCloudEventLocks(String, String, RequestContent, RequestContext)	[Protocol Method] Renew lock for 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 renewed 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 RenewCloudEventLocks(String, String, RenewLockOptions, CancellationToken) convenience overload with strongly typed models first.
RenewCloudEventLocksAsync(String, String, RenewLockOptions, CancellationToken)	Renew lock for 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 renewed lockTokens, along with other failed lockTokens with their corresponding error information.
RenewCloudEventLocksAsync(String, String, RequestContent, RequestContext)	[Protocol Method] Renew lock for 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 renewed 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 RenewCloudEventLocksAsync(String, String, RenewLockOptions, CancellationToken) convenience overload with strongly typed models first.