@azure/eventgrid 4.14.0 → 4.15.0-alpha.20231013.1

package/types/eventgrid.d.ts

@@ -328,6 +328,370 @@ export declare interface AcsRecordingStorageInfo {
     recordingChunks: AcsRecordingChunkInfo[];
 }
 
+/** Router Channel Configuration */
+export declare interface AcsRouterChannelConfiguration {
+    /** Channel ID for Router Job */
+    channelId: string;
+    /** Capacity Cost Per Job for Router Job */
+    capacityCostPerJob: number;
+    /** Max Number of Jobs for Router Job */
+    maxNumberOfJobs: number;
+}
+
+/** Router Communication Error */
+export declare interface AcsRouterCommunicationError {
+    /** Router Communication Error Code */
+    code: string;
+    /** Router Communication Error Message */
+    message: string;
+    /** Router Communication Error Target */
+    target: string;
+    /** Router Communication Inner Error */
+    innererror: AcsRouterCommunicationError;
+    /** List of Router Communication Errors */
+    details: AcsRouterCommunicationError[];
+}
+
+/** Schema of common properties of all Router events */
+export declare interface AcsRouterEventData {
+    /** Router Event Job ID */
+    jobId: string;
+    /** Router Event Channel Reference */
+    channelReference: string;
+    /** Router Event Channel ID */
+    channelId: string;
+}
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobCancelled event */
+export declare type AcsRouterJobCancelledEventData = AcsRouterJobEventData & {
+    /** Router Job Note */
+    note: string;
+    /** Router Job Disposition Code */
+    dispositionCode: string;
+};
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClassificationFailed event */
+export declare type AcsRouterJobClassificationFailedEventData = AcsRouterJobEventData & {
+    /** Router Job Classification Policy Id */
+    classificationPolicyId: string;
+    /** Router Job Classification Failed Errors */
+    errors: AcsRouterCommunicationError[];
+};
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClassified event */
+export declare type AcsRouterJobClassifiedEventData = AcsRouterJobEventData & {
+    /** Router Job Queue Info */
+    queueDetails: AcsRouterQueueDetails;
+    /** Router Job Classification Policy Id */
+    classificationPolicyId: string;
+    /** Router Job Priority */
+    priority: number;
+    /** Router Job Attached Worker Selector */
+    attachedWorkerSelectors: AcsRouterWorkerSelector[];
+};
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClosed event */
+export declare type AcsRouterJobClosedEventData = AcsRouterJobEventData & {
+    /** Router Job Closed Assignment Id */
+    assignmentId: string;
+    /** Router Job Closed Worker Id */
+    workerId: string;
+    /** Router Job Closed Disposition Code */
+    dispositionCode: string;
+};
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobCompleted event */
+export declare type AcsRouterJobCompletedEventData = AcsRouterJobEventData & {
+    /** Router Job Completed Assignment Id */
+    assignmentId: string;
+    /** Router Job Completed Worker Id */
+    workerId: string;
+};
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobDeleted event */
+export declare type AcsRouterJobDeletedEventData = AcsRouterJobEventData & {};
+
+/** Schema of common properties of all Router Job events */
+export declare type AcsRouterJobEventData = AcsRouterEventData & {
+    /** Router Job events Queue Id */
+    queueId: string;
+    /** Router Job events Labels */
+    labels: {
+        [propertyName: string]: string;
+    };
+    /** Router Jobs events Tags */
+    tags: {
+        [propertyName: string]: string;
+    };
+};
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobExceptionTriggered event */
+export declare type AcsRouterJobExceptionTriggeredEventData = AcsRouterJobEventData & {
+    /** Router Job Exception Triggered Rule Key */
+    ruleKey: string;
+    /** Router Job Exception Triggered Rule Id */
+    exceptionRuleId: string;
+};
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobQueued event */
+export declare type AcsRouterJobQueuedEventData = AcsRouterJobEventData & {
+    /** Router Job Priority */
+    priority: number;
+    /** Router Job Queued Attached Worker Selector */
+    attachedWorkerSelectors: AcsRouterWorkerSelector[];
+    /** Router Job Queued Requested Worker Selector */
+    requestedWorkerSelectors: AcsRouterWorkerSelector[];
+};
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobReceived event */
+export declare type AcsRouterJobReceivedEventData = AcsRouterJobEventData & {
+    /** Router Job Received Job Status */
+    jobStatus?: AcsRouterJobStatus;
+    /** Router Job Classification Policy Id */
+    classificationPolicyId?: string;
+    /** Router Job Priority */
+    priority?: number;
+    /** Router Job Received Requested Worker Selectors */
+    requestedWorkerSelectors?: AcsRouterWorkerSelector[];
+    /** Router Job Received Scheduled Time in UTC */
+    scheduledOn?: string;
+    /** Unavailable For Matching for Router Job Received */
+    unavailableForMatching: boolean;
+};
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobSchedulingFailed event */
+export declare type AcsRouterJobSchedulingFailedEventData = AcsRouterJobEventData & {
+    /** Router Job Priority */
+    priority: number;
+    /** Router Job Scheduling Failed Attached Worker Selector Expired */
+    expiredAttachedWorkerSelectors: AcsRouterWorkerSelector[];
+    /** Router Job Scheduling Failed Requested Worker Selector Expired */
+    expiredRequestedWorkerSelectors: AcsRouterWorkerSelector[];
+    /** Router Job Scheduling Failed Scheduled Time in UTC */
+    scheduledOn: string;
+    /** Router Job Scheduling Failed Reason */
+    failureReason: string;
+};
+
+/**
+ * Defines values for AcsRouterJobStatus. \
+ * {@link KnownAcsRouterJobStatus} can be used interchangeably with AcsRouterJobStatus,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **PendingClassification** \
+ * **Queued** \
+ * **Assigned** \
+ * **Completed** \
+ * **Closed** \
+ * **Cancelled** \
+ * **ClassificationFailed** \
+ * **Created** \
+ * **PendingSchedule** \
+ * **Scheduled** \
+ * **ScheduleFailed** \
+ * **WaitingForActivation**
+ */
+export declare type AcsRouterJobStatus = string;
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobUnassigned event */
+export declare type AcsRouterJobUnassignedEventData = AcsRouterJobEventData & {
+    /** Router Job Unassigned Assignment Id */
+    assignmentId: string;
+    /** Router Job Unassigned Worker Id */
+    workerId: string;
+};
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobWaitingForActivation event */
+export declare type AcsRouterJobWaitingForActivationEventData = AcsRouterJobEventData & {
+    /** Router Job Waiting For Activation Priority */
+    priority?: number;
+    /** Router Job Waiting For Activation Worker Selector Expired */
+    expiredAttachedWorkerSelectors?: AcsRouterWorkerSelector[];
+    /** Router Job Waiting For Activation Requested Worker Selector Expired */
+    expiredRequestedWorkerSelectors?: AcsRouterWorkerSelector[];
+    /** Router Job Waiting For Activation Scheduled Time in UTC */
+    scheduledOn?: string;
+    /** Router Job Waiting For Activation Unavailable For Matching */
+    unavailableForMatching: boolean;
+};
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobWorkerSelectorsExpired event */
+export declare type AcsRouterJobWorkerSelectorsExpiredEventData = AcsRouterJobEventData & {
+    /** Router Job Worker Selectors Expired Requested Worker Selectors */
+    expiredRequestedWorkerSelectors: AcsRouterWorkerSelector[];
+    /** Router Job Worker Selectors Expired Attached Worker Selectors */
+    expiredAttachedWorkerSelectors: AcsRouterWorkerSelector[];
+};
+
+/**
+ * Defines values for AcsRouterLabelOperator. \
+ * {@link KnownAcsRouterLabelOperator} can be used interchangeably with AcsRouterLabelOperator,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Equal**: = \
+ * **NotEqual**: != \
+ * **Greater**: > \
+ * **Less**: < \
+ * **GreaterThanOrEqual**: >= \
+ * **LessThanOrEqual**: <=
+ */
+export declare type AcsRouterLabelOperator = string;
+
+/** Router Queue Details */
+export declare interface AcsRouterQueueDetails {
+    /** Router Queue Id */
+    id: string;
+    /** Router Queue Name */
+    name: string;
+    /** Router Queue Labels */
+    labels: {
+        [propertyName: string]: string;
+    };
+}
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerDeleted event */
+export declare type AcsRouterWorkerDeletedEventData = AcsRouterWorkerEventData & {};
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerDeregistered event */
+export declare interface AcsRouterWorkerDeregisteredEventData {
+    /** Router Worker Deregistered Worker Id */
+    workerId: string;
+}
+
+/** Schema of common properties of all Router Worker events */
+export declare type AcsRouterWorkerEventData = AcsRouterEventData & {
+    /** Router Worker events Worker Id */
+    workerId: string;
+};
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferAccepted event */
+export declare type AcsRouterWorkerOfferAcceptedEventData = AcsRouterWorkerEventData & {
+    /** Router Worker Offer Accepted Queue Id */
+    queueId: string;
+    /** Router Worker Offer Accepted Offer Id */
+    offerId: string;
+    /** Router Worker Offer Accepted Assignment Id */
+    assignmentId: string;
+    /** Router Worker Offer Accepted Job Priority */
+    jobPriority: number;
+    /** Router Worker Offer Accepted Worker Labels */
+    workerLabels: {
+        [propertyName: string]: string;
+    };
+    /** Router Worker Offer Accepted Worker Tags */
+    workerTags: {
+        [propertyName: string]: string;
+    };
+    /** Router Worker Offer Accepted Job Labels */
+    jobLabels: {
+        [propertyName: string]: string;
+    };
+    /** Router Worker Offer Accepted Job Tags */
+    jobTags: {
+        [propertyName: string]: string;
+    };
+};
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferDeclined event */
+export declare type AcsRouterWorkerOfferDeclinedEventData = AcsRouterWorkerEventData & {
+    /** Router Worker Offer Declined Queue Id */
+    queueId: string;
+    /** Router Worker Offer Declined Offer Id */
+    offerId: string;
+};
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferExpired event */
+export declare type AcsRouterWorkerOfferExpiredEventData = AcsRouterWorkerEventData & {
+    /** Router Worker Offer Expired Queue Id */
+    queueId: string;
+    /** Router Worker Offer Expired Offer Id */
+    offerId: string;
+};
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferIssued event */
+export declare type AcsRouterWorkerOfferIssuedEventData = AcsRouterWorkerEventData & {
+    /** Router Worker Offer Issued Queue Id */
+    queueId: string;
+    /** Router Worker Offer Issued Offer Id */
+    offerId: string;
+    /** Router Worker Offer Issued Job Priority */
+    jobPriority: number;
+    /** Router Worker Offer Issued Worker Labels */
+    workerLabels: {
+        [propertyName: string]: string;
+    };
+    /** Router Worker Offer Issued Time in UTC */
+    offeredOn: string;
+    /** Router Worker Offer Issued Expiration Time in UTC */
+    expiresOn: string;
+    /** Router Worker Offer Issued Worker Tags */
+    workerTags: {
+        [propertyName: string]: string;
+    };
+    /** Router Worker Offer Issued Job Labels */
+    jobLabels: {
+        [propertyName: string]: string;
+    };
+    /** Router Worker Offer Issued Job Tags */
+    jobTags: {
+        [propertyName: string]: string;
+    };
+};
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferRevoked event */
+export declare type AcsRouterWorkerOfferRevokedEventData = AcsRouterWorkerEventData & {
+    /** Router Worker Offer Revoked Queue Id */
+    queueId: string;
+    /** Router Worker Offer Revoked Offer Id */
+    offerId: string;
+};
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerRegistered event */
+export declare interface AcsRouterWorkerRegisteredEventData {
+    /** Router Worker Registered Worker Id */
+    workerId: string;
+    /** Router Worker Registered Queue Info */
+    queueAssignments: AcsRouterQueueDetails[];
+    /** Router Worker Registered Channel Configuration */
+    channelConfigurations: AcsRouterChannelConfiguration[];
+    /** Router Worker Register Total Capacity */
+    totalCapacity: number;
+    /** Router Worker Registered Labels */
+    labels: {
+        [propertyName: string]: string;
+    };
+    /** Router Worker Registered Tags */
+    tags: {
+        [propertyName: string]: string;
+    };
+}
+
+/** Router Job Worker Selector */
+export declare interface AcsRouterWorkerSelector {
+    /** Router Job Worker Selector Key */
+    key: string;
+    /** Router Job Worker Selector Label Operator */
+    labelOperator: AcsRouterLabelOperator;
+    /** Router Job Worker Selector Value */
+    labelValue: any;
+    /** Router Job Worker Selector Time to Live in Seconds */
+    ttlSeconds: number;
+    /** Router Job Worker Selector State */
+    state: AcsRouterWorkerSelectorState;
+    /** Router Job Worker Selector Expiration Time */
+    expirationTime: string;
+}
+
+/**
+ * Defines values for AcsRouterWorkerSelectorState. \
+ * {@link KnownAcsRouterWorkerSelectorState} can be used interchangeably with AcsRouterWorkerSelectorState,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **active**: Router Job Worker Selector is Active \
+ * **expired**: Router Job Worker Selector has Expire
+ */
+export declare type AcsRouterWorkerSelectorState = string;
+
 /** Schema for details of a delivery attempt */
 export declare interface AcsSmsDeliveryAttempt {
     /** TimeStamp when delivery was attempted */
@@ -1767,6 +2131,46 @@ export declare interface KeyVaultSecretNewVersionCreatedEventData {
     exp: number;
 }
 
+/** Known values of {@link AcsRouterJobStatus} that the service accepts. */
+export declare const enum KnownAcsRouterJobStatus {
+    PendingClassification = "PendingClassification",
+    Queued = "Queued",
+    Assigned = "Assigned",
+    Completed = "Completed",
+    Closed = "Closed",
+    Cancelled = "Cancelled",
+    ClassificationFailed = "ClassificationFailed",
+    Created = "Created",
+    PendingSchedule = "PendingSchedule",
+    Scheduled = "Scheduled",
+    ScheduleFailed = "ScheduleFailed",
+    WaitingForActivation = "WaitingForActivation"
+}
+
+/** Known values of {@link AcsRouterLabelOperator} that the service accepts. */
+export declare const enum KnownAcsRouterLabelOperator {
+    /** = */
+    Equal = "Equal",
+    /** != */
+    NotEqual = "NotEqual",
+    /** > */
+    Greater = "Greater",
+    /** < */
+    Less = "Less",
+    /** >= */
+    GreaterThanOrEqual = "GreaterThanOrEqual",
+    /** <= */
+    LessThanOrEqual = "LessThanOrEqual"
+}
+
+/** Known values of {@link AcsRouterWorkerSelectorState} that the service accepts. */
+export declare const enum KnownAcsRouterWorkerSelectorState {
+    /** Router Job Worker Selector is Active */
+    Active = "active",
+    /** Router Job Worker Selector has Expire */
+    Expired = "expired"
+}
+
 /** Known values of {@link AppAction} that the service accepts. */
 export declare const enum KnownAppAction {
     /** Web app was restarted. */
@@ -2791,6 +3195,46 @@ export declare interface ResourceHttpRequest {
     url: string;
 }
 
+/** Schema of the Data property of an EventGridEvent for a Microsoft.ResourceNotifications.HealthResources.ResourceAnnotated event. */
+export declare type ResourceNotificationsHealthResourcesAnnotatedEventData = ResourceNotificationsResourceUpdatedEventData & {};
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.ResourceNotifications.HealthResources.AvailabilityStatusChanged event. */
+export declare type ResourceNotificationsHealthResourcesAvailabilityStatusChangedEventData = ResourceNotificationsResourceUpdatedEventData & {};
+
+/** details of operational info */
+export declare interface ResourceNotificationsOperationalDetails {
+    /** Date and Time when resource was updated */
+    resourceEventTime: string;
+}
+
+/** Describes the schema of the properties under resource info which are common across all ARN system topic events */
+export declare interface ResourceNotificationsResourceUpdatedDetails {
+    /** id of the resource for which the event is being emitted */
+    id: string;
+    /** name of the resource for which the event is being emitted */
+    name: string;
+    /** the type of the resource for which the event is being emitted */
+    type: string;
+    /** the location of the resource for which the event is being emitted */
+    location: string;
+    /** the tags on the resource for which the event is being emitted */
+    tags: string;
+    /** properties in the payload of the resource for which the event is being emitted */
+    properties: {
+        [propertyName: string]: any;
+    };
+}
+
+/** Describes the schema of the common properties across all ARN system topic events */
+export declare interface ResourceNotificationsResourceUpdatedEventData {
+    /** resourceInfo details for update event */
+    resourceDetails: ResourceNotificationsResourceUpdatedDetails;
+    /** details about operational info */
+    operationalDetails: ResourceNotificationsOperationalDetails;
+    /** api version of the resource properties bag */
+    apiVersion: string;
+}
+
 /** Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteCancel event. This is raised when a resource create or update operation is canceled. */
 export declare interface ResourceWriteCancelEventData {
     /** The tenant ID of the resource. */
@@ -3604,6 +4048,52 @@ export declare interface SystemEventNameToEventData {
     "Microsoft.AppConfiguration.SnapshotCreated": AppConfigurationSnapshotCreatedEventData;
     /** An interface for the event data of a "Microsoft.AppConfiguration.SnapshotModified" event. */
     "Microsoft.AppConfiguration.SnapshotModified": AppConfigurationSnapshotModifiedEventData;
+    /** An interface for the event data of a "Microsoft.ResourceNotifications.HealthResources.AvailabilityStatusChanged" event. */
+    "Microsoft.ResourceNotifications.HealthResources.AvailabilityStatusChanged": ResourceNotificationsHealthResourcesAvailabilityStatusChangedEventData;
+    /** An interface for the event data of a "Microsoft.ResourceNotifications.HealthResources.ResourceAnnotated" event. */
+    "Microsoft.ResourceNotifications.HealthResources.ResourceAnnotated": ResourceNotificationsHealthResourcesAnnotatedEventData;
+    /** An interface for the event data of a "Microsoft.Communication.RouterWorkerDeregistered" event. */
+    "Microsoft.Communication.RouterWorkerDeregistered": AcsRouterWorkerDeregisteredEventData;
+    /** An interface for the event data of a "Microsoft.Communication.RouterWorkerRegistered" event. */
+    "Microsoft.Communication.RouterWorkerRegistered": AcsRouterWorkerRegisteredEventData;
+    /** An interface for the event data of a "Microsoft.Communication.RouterJobCancelled" event. */
+    "Microsoft.Communication.RouterJobCancelled": AcsRouterJobCancelledEventData;
+    /** An interface for the event data of a "Microsoft.Communication.RouterJobClassificationFailed" event. */
+    "Microsoft.Communication.RouterJobClassificationFailed": AcsRouterJobClassificationFailedEventData;
+    /** An interface for the event data of a "Microsoft.Communication.RouterJobClassified" event. */
+    "Microsoft.Communication.RouterJobClassified": AcsRouterJobClassifiedEventData;
+    /** An interface for the event data of a "Microsoft.Communication.RouterJobClosed" event. */
+    "Microsoft.Communication.RouterJobClosed": AcsRouterJobClosedEventData;
+    /** An interface for the event data of a "Microsoft.Communication.RouterJobCompleted" event. */
+    "Microsoft.Communication.RouterJobCompleted": AcsRouterJobCompletedEventData;
+    /** An interface for the event data of a "Microsoft.Communication.RouterJobDeleted" event. */
+    "Microsoft.Communication.RouterJobDeleted": AcsRouterJobDeletedEventData;
+    /** An interface for the event data of a "Microsoft.Communication.RouterJobExceptionTriggered" event. */
+    "Microsoft.Communication.RouterJobExceptionTriggered": AcsRouterJobExceptionTriggeredEventData;
+    /** An interface for the event data of a "Microsoft.Communication.RouterJobQueued" event. */
+    "Microsoft.Communication.RouterJobQueued": AcsRouterJobQueuedEventData;
+    /** An interface for the event data of a "Microsoft.Communication.RouterJobReceived" event. */
+    "Microsoft.Communication.RouterJobReceived": AcsRouterJobReceivedEventData;
+    /** An interface for the event data of a "Microsoft.Communication.RouterJobSchedulingFailed" event. */
+    "Microsoft.Communication.RouterJobSchedulingFailed": AcsRouterJobSchedulingFailedEventData;
+    /** An interface for the event data of a "Microsoft.Communication.RouterJobUnassigned" event. */
+    "Microsoft.Communication.RouterJobUnassigned": AcsRouterJobUnassignedEventData;
+    /** An interface for the event data of a "Microsoft.Communication.RouterJobWaitingForActivation" event. */
+    "Microsoft.Communication.RouterJobWaitingForActivation": AcsRouterJobWaitingForActivationEventData;
+    /** An interface for the event data of a "Microsoft.Communication.RouterJobWorkerSelectorsExpire" event. */
+    "Microsoft.Communication.RouterJobWorkerSelectorsExpire": AcsRouterJobWorkerSelectorsExpiredEventData;
+    /** An interface for the event data of a "Microsoft.Communication.RouterWorkerDeleted" event. */
+    "Microsoft.Communication.RouterWorkerDeleted": AcsRouterWorkerDeletedEventData;
+    /** An interface for the event data of a "Microsoft.Communication.RouterWorkerOfferAccepted" event. */
+    "Microsoft.Communication.RouterWorkerOfferAccepted": AcsRouterWorkerOfferAcceptedEventData;
+    /** An interface for the event data of a "Microsoft.Communication.RouterWorkerOfferDeclined" event. */
+    "Microsoft.Communication.RouterWorkerOfferDeclined": AcsRouterWorkerOfferDeclinedEventData;
+    /** An interface for the event data of a "Microsoft.Communication.RouterWorkerOfferExpired" event. */
+    "Microsoft.Communication.RouterWorkerOfferExpired": AcsRouterWorkerOfferExpiredEventData;
+    /** An interface for the event data of a "Microsoft.Communication.RouterWorkerOfferIssued" event. */
+    "Microsoft.Communication.RouterWorkerOfferIssued": AcsRouterWorkerOfferIssuedEventData;
+    /** An interface for the event data of a "Microsoft.Communication.RouterWorkerOfferRevoked" event. */
+    "Microsoft.Communication.RouterWorkerOfferRevoked": AcsRouterWorkerOfferRevokedEventData;
 }
 
 /** Schema of the Data property of an EventGridEvent for a Microsoft.Web.AppServicePlanUpdated event. */