@azure/eventgrid 4.13.0-alpha.20230607.3 → 4.13.0-beta.2

package/types/eventgrid.d.ts

@@ -1,11 +1,33 @@
 import { AzureKeyCredential } from '@azure/core-auth';
 import { AzureSASCredential } from '@azure/core-auth';
+import { ClientOptions as ClientOptions_2 } from '@azure-rest/core-client';
 import { CommonClientOptions } from '@azure/core-client';
+import { HttpResponse } from '@azure-rest/core-client';
 import { KeyCredential } from '@azure/core-auth';
 import { OperationOptions } from '@azure/core-client';
+import { RawHttpHeadersInput } from '@azure/core-rest-pipeline';
 import { SASCredential } from '@azure/core-auth';
 import { TokenCredential } from '@azure/core-auth';
 
+export declare interface AcknowledgeCloudEventsOptions extends RequestOptions {
+    /** content type */
+    contentType?: string;
+}
+
+/** Array of lock token strings for the corresponding received Cloud Events to be acknowledged. */
+export declare interface AcknowledgeOptions {
+    /** String array of lock tokens. */
+    lockTokens: string[];
+}
+
+/** The result of the Acknowledge operation. */
+export declare interface AcknowledgeResult {
+    /** Array of LockToken values for failed cloud events. Each LockToken includes the lock token value along with the related error information (namely, the error code and description). */
+    failedLockTokens: FailedLockToken[];
+    /** Array of lock tokens values for the successfully acknowledged cloud events. */
+    succeededLockTokens: string[];
+}
+
 /** Schema of common properties of all chat events */
 export declare interface AcsChatEventBase {
     /** The communication identifier of the target user */
@@ -618,6 +640,17 @@ export { AzureKeyCredential }
 
 export { AzureSASCredential }
 
+/** Properties of the Event Broker operation. */
+export declare interface BrokerProperties {
+    /** The token used to lock the event. */
+    lockToken: string;
+    /** The attempt count for delivering the event. */
+    deliveryCount: number;
+}
+
+export declare interface ClientOptions extends ClientOptions_2 {
+}
+
 /**
  * An event in the Cloud Event 1.0 schema.
  */
@@ -658,6 +691,10 @@ export declare interface CloudEvent<T> {
      * Additional context attributes for the event. The Cloud Event specification refers to these as "extension attributes".
      */
     extensionAttributes?: Record<string, unknown>;
+    /**
+     * The version of the CloudEvents specification which the event uses.
+     */
+    specversion?: string | "1.0";
 }
 
 /**
@@ -819,18 +856,6 @@ export declare type ContainerRegistryImageDeletedEventData = ContainerRegistryEv
 /** Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImagePushed event. */
 export declare type ContainerRegistryImagePushedEventData = ContainerRegistryEventData & {};
 
-/** Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.ClusterSupportEnded event */
-export declare type ContainerServiceClusterSupportEndedEventData = ContainerServiceClusterSupportEventData & {};
-
-/** Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.ClusterSupportEnding event */
-export declare type ContainerServiceClusterSupportEndingEventData = ContainerServiceClusterSupportEventData & {};
-
-/** Schema of common properties of cluster support events */
-export declare interface ContainerServiceClusterSupportEventData {
-    /** The Kubernetes version of the ManagedCluster resource */
-    kubernetesVersion: string;
-}
-
 /** Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NewKubernetesVersionAvailable event */
 export declare interface ContainerServiceNewKubernetesVersionAvailableEventData {
     /** The highest PATCH Kubernetes version for the highest MINOR version supported by ManagedCluster resource */
@@ -843,21 +868,6 @@ export declare interface ContainerServiceNewKubernetesVersionAvailableEventData
     latestPreviewKubernetesVersion: string;
 }
 
-/** Schema of common properties of node pool rolling events */
-export declare interface ContainerServiceNodePoolRollingEventData {
-    /** The name of the node pool in the ManagedCluster resource */
-    nodePoolName: string;
-}
-
-/** Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NodePoolRollingFailed event */
-export declare type ContainerServiceNodePoolRollingFailedEventData = ContainerServiceNodePoolRollingEventData & {};
-
-/** Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NodePoolRollingStarted event */
-export declare type ContainerServiceNodePoolRollingStartedEventData = ContainerServiceNodePoolRollingEventData & {};
-
-/** Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NodePoolRollingSucceeded event */
-export declare type ContainerServiceNodePoolRollingSucceededEventData = ContainerServiceNodePoolRollingEventData & {};
-
 /** Schema of the Data property of an EventGridEvent for a Microsoft.DataBox.CopyCompleted event. */
 export declare interface DataBoxCopyCompletedEventData {
     /** Serial Number of the device associated with the event. The list is comma separated if more than one serial number is associated. */
@@ -997,6 +1007,85 @@ export declare interface DeviceTwinMetadata {
     lastUpdated: string;
 }
 
+/**
+ * Event Grid Client
+ */
+export declare class EventGridClient {
+    private _client;
+    /** Azure Messaging EventGrid Client */
+    constructor(endpoint: string, credential: AzureKeyCredential, options?: ClientOptions);
+    /**
+     * 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.
+     *
+     * @param event - Event to publish
+     * @param topicName - Topic to publish the event
+     * @param options - Options to publish
+     *
+     */
+    publishCloudEvent<T>(event: CloudEvent<T>, topicName: string, options?: PublishCloudEventOptions): Promise<PublishResultOutput>;
+    /**
+     * 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.
+     *
+     * @param events - Events to publish
+     * @param topicName - Topic to publish the event
+     * @param options - Options to publish
+     *
+     */
+    publishCloudEvents<T>(events: CloudEvent<T>[], topicName: string, options?: PublishCloudEventsOptions): Promise<PublishResultOutput>;
+    /**
+     * Receive Batch of Cloud Events from the Event Subscription.
+     *
+     * @param topicName - Topic to receive
+     * @param eventSubscriptionName - Name of the Event Subscription
+     * @param options - Options to receive
+     *
+     */
+    receiveCloudEvents<T>(topicName: string, eventSubscriptionName: string, options?: ReceiveCloudEventsOptions): Promise<ReceiveResult<T>>;
+    /**
+     * Acknowledge batch of Cloud Events. The server responds with an HTTP 200 status code if at least one
+     * event is successfully acknowledged. 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.
+     *
+     * @param lockTokens - Lock Tokens
+     * @param topicName - Topic Name
+     * @param eventSubscriptionName - Name of the Event Subscription
+     * @param options - Options to Acknowledge
+     *
+     */
+    acknowledgeCloudEvents(lockTokens: string[], topicName: string, eventSubscriptionName: string, options?: AcknowledgeCloudEventsOptions): Promise<AcknowledgeResult>;
+    /**
+     * Release batch of Cloud Events. The server responds with an HTTP 200 status code if at least one event is
+     * successfully released. The response body will include the set of successfully released lockTokens, along
+     * with other failed lockTokens with their corresponding error information.
+     *
+     * @param lockTokens - Lock Tokens
+     * @param topicName - Topic Name
+     * @param eventSubscriptionName - Name of the Event Subscription
+     * @param options - Options to release
+     *
+     */
+    releaseCloudEvents(lockTokens: string[], topicName: string, eventSubscriptionName: string, options?: ReleaseCloudEventsOptions): Promise<ReleaseResult>;
+    /**
+     * Reject batch of Cloud Events.
+     *
+     * @param lockTokens - Lock Tokens
+     * @param topicName - Topic Name
+     * @param eventSubscriptionName - Name of the Event Subscription
+     * @param options - Options to reject
+     *
+     */
+    rejectCloudEvents(lockTokens: string[], topicName: string, eventSubscriptionName: string, options?: RejectCloudEventsOptions): Promise<RejectResult>;
+}
+
 /**
  * EventGridDeserializer is used to aid in processing events delivered by EventGrid. It can deserialize a JSON encoded payload
  * of either a single event or batch of events as well as be used to convert the result of `JSON.parse` into an
@@ -1147,6 +1236,16 @@ export declare interface EventHubCaptureFileCreatedEventData {
     lastEnqueueTime: string;
 }
 
+/** Failed LockToken information. */
+export declare interface FailedLockToken {
+    /** LockToken value */
+    lockToken: string;
+    /** Error code related to the token. Example of such error codes are BadToken: which indicates the Token is not formatted correctly, TokenLost: which indicates that token is not found, and InternalServerError: For any internal server errors. */
+    errorCode: string;
+    /** Description of the token error. */
+    errorDescription: string;
+}
+
 /**
  * Generate a shared access signature, which allows a client to send events to an Event Grid Topic or Domain for a limited period of time. This
  * function may only be called when the EventGridPublisherClient was constructed with a KeyCredential instance.
@@ -2444,6 +2543,41 @@ export declare interface PolicyInsightsPolicyStateDeletedEventData {
     complianceReasonCode: string;
 }
 
+export declare interface PublishCloudEventOptions extends RequestOptions {
+    /** content type */
+    contentType?: string;
+}
+
+export declare interface PublishCloudEventsOptions extends RequestOptions {
+    /** content type */
+    contentType?: string;
+}
+
+/** The result of the Publish operation. */
+export declare interface PublishResultOutput {
+}
+
+export declare interface ReceiveCloudEventsOptions extends RequestOptions {
+    /** Max Events count to be received. Minimum value is 1, while maximum value is 100 events. If not specified, the default value is 1. */
+    maxEvents?: number;
+    /** Max wait time value for receive operation in Seconds. It is the time in seconds that the server approximately waits for the availability of an event and responds to the request. If an event is available, the broker responds immediately to the client. Minimum value is 10 seconds, while maximum value is 120 seconds. If not specified, the default value is 60 seconds. */
+    maxWaitTime?: number;
+}
+
+/** Receive operation details per Cloud Event. */
+export declare interface ReceiveDetails<T> {
+    /** The Event Broker details. */
+    brokerProperties: BrokerProperties;
+    /** Cloud Event details. */
+    event: CloudEvent<T>;
+}
+
+/** Details of the Receive operation response. */
+export declare interface ReceiveResult<T> {
+    /** Array of receive responses, one per cloud event. */
+    value: ReceiveDetails<T>[];
+}
+
 /**
  * Defines values for RecordingChannelType. \
  * {@link KnownRecordingChannelType} can be used interchangeably with RecordingChannelType,
@@ -2475,6 +2609,61 @@ export declare type RecordingContentType = string;
  */
 export declare type RecordingFormatType = string;
 
+export declare interface RejectCloudEventsOptions extends RequestOptions {
+    /** content type */
+    contentType?: string;
+}
+
+/** Array of lock token strings for the corresponding received Cloud Events to be rejected. */
+export declare interface RejectOptions {
+    /** String array of lock tokens. */
+    lockTokens: string[];
+}
+
+/** The result of the Reject operation. */
+export declare interface RejectResult {
+    /** Array of LockToken values for failed cloud events. Each LockToken includes the lock token value along with the related error information (namely, the error code and description). */
+    failedLockTokens: FailedLockToken[];
+    /** Array of lock tokens values for the successfully rejected cloud events. */
+    succeededLockTokens: string[];
+}
+
+export declare interface ReleaseCloudEventsOptions extends RequestOptions {
+    /** content type */
+    contentType?: string;
+}
+
+/** Array of lock token strings for the corresponding received Cloud Events to be released. */
+export declare interface ReleaseOptions {
+    /** String array of lock tokens. */
+    lockTokens: string[];
+}
+
+/** The result of the Release operation. */
+export declare interface ReleaseResult {
+    /** Array of LockToken values for failed cloud events. Each LockToken includes the lock token value along with the related error information (namely, the error code and description). */
+    failedLockTokens: FailedLockToken[];
+    /** Array of lock tokens values for the successfully released cloud events. */
+    succeededLockTokens: string[];
+}
+
+export declare interface RequestOptions {
+    requestOptions?: {
+        /**
+         * Headers to send along with the request
+         */
+        headers?: RawHttpHeadersInput;
+        /** Set to true if the request is sent over HTTP instead of HTTPS */
+        allowInsecureConnection?: boolean;
+        /** Set to true if you want to skip encoding the path parameters */
+        skipUrlEncoding?: boolean;
+        /**
+         * Callback to access the raw response object when the response is received
+         */
+        onResponse?: (response: HttpResponse) => void;
+    };
+}
+
 /** Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionCancel event. This is raised when a resource action operation is canceled. */
 export declare interface ResourceActionCancelEventData {
     /** The tenant ID of the resource. */
@@ -3458,16 +3647,6 @@ export declare interface SystemEventNameToEventData {
     "Microsoft.ApiManagement.GatewayAPIRemoved": ApiManagementGatewayApiRemovedEventData;
     /** An interface for the event data of a "Microsoft.HealthcareApis.DicomImageUpdated" event. */
     "Microsoft.HealthcareApis.DicomImageUpdated": HealthcareDicomImageUpdatedEventData;
-    /** An interface for the event data of a "Microsoft.ContainerService.ClusterSupportEnded" event. */
-    "Microsoft.ContainerService.ClusterSupportEnded": ContainerServiceClusterSupportEndedEventData;
-    /** An interface for the event data of a "Microsoft.ContainerService.ClusterSupportEnding" event. */
-    "Microsoft.ContainerService.ClusterSupportEnding": ContainerServiceClusterSupportEndingEventData;
-    /** An interface for the event data of a "Microsoft.ContainerService.NodePoolRollingStarted" event. */
-    "Microsoft.ContainerService.NodePoolRollingStarted": ContainerServiceNodePoolRollingStartedEventData;
-    /** An interface for the event data of a "Microsoft.ContainerService.NodePoolRollingSucceeded" event. */
-    "Microsoft.ContainerService.NodePoolRollingSucceeded": ContainerServiceNodePoolRollingSucceededEventData;
-    /** An interface for the event data of a "Microsoft.ContainerService.NodePoolRollingFailed" event. */
-    "Microsoft.ContainerService.NodePoolRollingFailed": ContainerServiceNodePoolRollingFailedEventData;
 }
 
 /** Schema of the Data property of an EventGridEvent for a Microsoft.Web.AppServicePlanUpdated event. */