@azure/eventgrid

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AcsChatMessageDeletedEventData

AcsChatMessageDeletedEventData: AcsChatMessageEventBase & { deleteTime: string }

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageDeleted event.

AcsChatMessageDeletedInThreadEventData

AcsChatMessageDeletedInThreadEventData: AcsChatMessageEventInThreadBase & { deleteTime: string }

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageDeletedInThread event.

AcsChatMessageEditedEventData

AcsChatMessageEditedEventData: AcsChatMessageEventBase & { editTime: string; messageBody: string; metadata: {} }

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageEdited event.

AcsChatMessageEditedInThreadEventData

AcsChatMessageEditedInThreadEventData: AcsChatMessageEventInThreadBase & { editTime: string; messageBody: string; metadata: {} }

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageEditedInThread event.

AcsChatMessageEventBase

AcsChatMessageEventBase: AcsChatEventBase & { composeTime: string; messageId: string; senderCommunicationIdentifier: CommunicationIdentifierModel; senderDisplayName: string; type: string; version: number }

Schema of common properties of all chat message events

AcsChatMessageEventInThreadBase

AcsChatMessageEventInThreadBase: AcsChatEventInThreadBase & { composeTime: string; messageId: string; senderCommunicationIdentifier: CommunicationIdentifierModel; senderDisplayName: string; type: string; version: number }

Schema of common properties of all thread-level chat message events

AcsChatMessageReceivedEventData

AcsChatMessageReceivedEventData: AcsChatMessageEventBase & { messageBody: string; metadata: {} }

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageReceived event.

AcsChatMessageReceivedInThreadEventData

AcsChatMessageReceivedInThreadEventData: AcsChatMessageEventInThreadBase & { messageBody: string; metadata: {} }

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageReceivedInThread event.

AcsChatParticipantAddedToThreadEventData

AcsChatParticipantAddedToThreadEventData: AcsChatEventInThreadBase & { addedByCommunicationIdentifier: CommunicationIdentifierModel; participantAdded: AcsChatThreadParticipant; time: string; version: number }

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadParticipantAdded event.

AcsChatParticipantAddedToThreadWithUserEventData

AcsChatParticipantAddedToThreadWithUserEventData: AcsChatThreadEventBase & { addedByCommunicationIdentifier: CommunicationIdentifierModel; participantAdded: AcsChatThreadParticipant; time: string }

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatParticipantAddedToThreadWithUser event.

AcsChatParticipantRemovedFromThreadEventData

AcsChatParticipantRemovedFromThreadEventData: AcsChatEventInThreadBase & { participantRemoved: AcsChatThreadParticipant; removedByCommunicationIdentifier: CommunicationIdentifierModel; time: string; version: number }

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadParticipantRemoved event.

AcsChatParticipantRemovedFromThreadWithUserEventData

AcsChatParticipantRemovedFromThreadWithUserEventData: AcsChatThreadEventBase & { participantRemoved: AcsChatThreadParticipant; removedByCommunicationIdentifier: CommunicationIdentifierModel; time: string }

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatParticipantRemovedFromThreadWithUser event.

AcsChatThreadCreatedEventData

AcsChatThreadCreatedEventData: AcsChatThreadEventInThreadBase & { createdByCommunicationIdentifier: CommunicationIdentifierModel; participants: AcsChatThreadParticipant[]; properties: {} }

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadCreated event.

AcsChatThreadCreatedWithUserEventData

AcsChatThreadCreatedWithUserEventData: AcsChatThreadEventBase & { createdByCommunicationIdentifier: CommunicationIdentifierModel; participants: AcsChatThreadParticipant[]; properties: {} }

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadCreatedWithUser event.

AcsChatThreadDeletedEventData

AcsChatThreadDeletedEventData: AcsChatThreadEventInThreadBase & { deleteTime: string; deletedByCommunicationIdentifier: CommunicationIdentifierModel }

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadDeleted event.

AcsChatThreadEventBase

AcsChatThreadEventBase: AcsChatEventBase & { createTime: string; version: number }

Schema of common properties of all chat thread events

AcsChatThreadEventInThreadBase

AcsChatThreadEventInThreadBase: AcsChatEventInThreadBase & { createTime: string; version: number }

Schema of common properties of all chat thread events

AcsChatThreadPropertiesUpdatedEventData

AcsChatThreadPropertiesUpdatedEventData: AcsChatThreadEventInThreadBase & { editTime: string; editedByCommunicationIdentifier: CommunicationIdentifierModel; properties: {} }

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadPropertiesUpdated event.

AcsChatThreadPropertiesUpdatedPerUserEventData

AcsChatThreadPropertiesUpdatedPerUserEventData: AcsChatThreadEventBase & { editTime: string; editedByCommunicationIdentifier: CommunicationIdentifierModel; properties: {} }

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadPropertiesUpdatedPerUser event.

AcsChatThreadWithUserDeletedEventData

AcsChatThreadWithUserDeletedEventData: AcsChatThreadEventBase & { deleteTime: string; deletedByCommunicationIdentifier: CommunicationIdentifierModel }

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadWithUserDeleted event.

AcsSmsDeliveryReportReceivedEventData

AcsSmsDeliveryReportReceivedEventData: AcsSmsEventBase & { deliveryAttempts: AcsSmsDeliveryAttempt[]; deliveryStatus: string; deliveryStatusDetails: string; receivedTimestamp: string; tag: string }

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.SMSDeliveryReportReceived event.

AcsSmsReceivedEventData

AcsSmsReceivedEventData: AcsSmsEventBase & { message: string; receivedTimestamp: string }

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.SMSReceived event.

AppAction

AppAction: string

Defines values for AppAction.
KnownAppAction can be used interchangeably with AppAction, this enum contains the known values that the service supports.

Known values supported by the service

Restarted: Web app was restarted.
Stopped: Web app was stopped.
ChangedAppSettings: There was an operation to change app setting on the web app.
Started: The job has started.
Completed: The job has completed.
Failed: The job has failed to complete.

AppServicePlanAction

AppServicePlanAction: string

Defines values for AppServicePlanAction.
KnownAppServicePlanAction can be used interchangeably with AppServicePlanAction, this enum contains the known values that the service supports.

Known values supported by the service

Updated: App Service plan is being updated.

AsyncStatus

AsyncStatus: string

Defines values for AsyncStatus.
KnownAsyncStatus can be used interchangeably with AsyncStatus, this enum contains the known values that the service supports.

Known values supported by the service

Started: Async operation has started.
Completed: Async operation has completed.
Failed: Async operation failed to complete.

CommunicationCloudEnvironmentModel

CommunicationCloudEnvironmentModel: string

Defines values for CommunicationCloudEnvironmentModel.
KnownCommunicationCloudEnvironmentModel can be used interchangeably with CommunicationCloudEnvironmentModel, this enum contains the known values that the service supports.

Known values supported by the service

public
dod
gcch

ContainerRegistryChartDeletedEventData

ContainerRegistryChartDeletedEventData: ContainerRegistryArtifactEventData & {}

Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartDeleted event.

ContainerRegistryChartPushedEventData

ContainerRegistryChartPushedEventData: ContainerRegistryArtifactEventData & {}

Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartPushed event.

ContainerRegistryImageDeletedEventData

ContainerRegistryImageDeletedEventData: ContainerRegistryEventData & {}

Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImageDeleted event.

ContainerRegistryImagePushedEventData

ContainerRegistryImagePushedEventData: ContainerRegistryEventData & {}

Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImagePushed event.

CustomEventDataDeserializer

CustomEventDataDeserializer: (o: any) => Promise<any>

A function which provides custom logic to be used when decoding events.

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

EventGridPublisherClientOptions

EventGridPublisherClientOptions: CommonClientOptions

Options for the Event Grid Client.

HealthcareFhirResourceType

HealthcareFhirResourceType: string

Defines values for HealthcareFhirResourceType.
KnownHealthcareFhirResourceType can be used interchangeably with HealthcareFhirResourceType, this enum contains the known values that the service supports.

Known values supported by the service

Account: The FHIR resource type defined in STU3 and R4.
ActivityDefinition: The FHIR resource type defined in STU3 and R4.
AdverseEvent: The FHIR resource type defined in STU3 and R4.
AllergyIntolerance: The FHIR resource type defined in STU3 and R4.
Appointment: The FHIR resource type defined in STU3 and R4.
AppointmentResponse: The FHIR resource type defined in STU3 and R4.
AuditEvent: The FHIR resource type defined in STU3 and R4.
Basic: The FHIR resource type defined in STU3 and R4.
Binary: The FHIR resource type defined in STU3 and R4.
BiologicallyDerivedProduct: The FHIR resource type defined in R4.
BodySite: The FHIR resource type defined in STU3.
BodyStructure: The FHIR resource type defined in R4.
Bundle: The FHIR resource type defined in STU3 and R4.
CapabilityStatement: The FHIR resource type defined in STU3 and R4.
CarePlan: The FHIR resource type defined in STU3 and R4.
CareTeam: The FHIR resource type defined in STU3 and R4.
CatalogEntry: The FHIR resource type defined in R4.
ChargeItem: The FHIR resource type defined in STU3 and R4.
ChargeItemDefinition: The FHIR resource type defined in R4.
Claim: The FHIR resource type defined in STU3 and R4.
ClaimResponse: The FHIR resource type defined in STU3 and R4.
ClinicalImpression: The FHIR resource type defined in STU3 and R4.
CodeSystem: The FHIR resource type defined in STU3 and R4.
Communication: The FHIR resource type defined in STU3 and R4.
CommunicationRequest: The FHIR resource type defined in STU3 and R4.
CompartmentDefinition: The FHIR resource type defined in STU3 and R4.
Composition: The FHIR resource type defined in STU3 and R4.
ConceptMap: The FHIR resource type defined in STU3 and R4.
Condition: The FHIR resource type defined in STU3 and R4.
Consent: The FHIR resource type defined in STU3 and R4.
Contract: The FHIR resource type defined in STU3 and R4.
Coverage: The FHIR resource type defined in STU3 and R4.
CoverageEligibilityRequest: The FHIR resource type defined in R4.
CoverageEligibilityResponse: The FHIR resource type defined in R4.
DataElement: The FHIR resource type defined in STU3.
DetectedIssue: The FHIR resource type defined in STU3 and R4.
Device: The FHIR resource type defined in STU3 and R4.
DeviceComponent: The FHIR resource type defined in STU3.
DeviceDefinition: The FHIR resource type defined in R4.
DeviceMetric: The FHIR resource type defined in STU3 and R4.
DeviceRequest: The FHIR resource type defined in STU3 and R4.
DeviceUseStatement: The FHIR resource type defined in STU3 and R4.
DiagnosticReport: The FHIR resource type defined in STU3 and R4.
DocumentManifest: The FHIR resource type defined in STU3 and R4.
DocumentReference: The FHIR resource type defined in STU3 and R4.
DomainResource: The FHIR resource type defined in STU3 and R4.
EffectEvidenceSynthesis: The FHIR resource type defined in R4.
EligibilityRequest: The FHIR resource type defined in STU3.
EligibilityResponse: The FHIR resource type defined in STU3.
Encounter: The FHIR resource type defined in STU3 and R4.
Endpoint: The FHIR resource type defined in STU3 and R4.
EnrollmentRequest: The FHIR resource type defined in STU3 and R4.
EnrollmentResponse: The FHIR resource type defined in STU3 and R4.
EpisodeOfCare: The FHIR resource type defined in STU3 and R4.
EventDefinition: The FHIR resource type defined in R4.
Evidence: The FHIR resource type defined in R4.
EvidenceVariable: The FHIR resource type defined in R4.
ExampleScenario: The FHIR resource type defined in R4.
ExpansionProfile: The FHIR resource type defined in STU3.
ExplanationOfBenefit: The FHIR resource type defined in STU3 and R4.
FamilyMemberHistory: The FHIR resource type defined in STU3 and R4.
Flag: The FHIR resource type defined in STU3 and R4.
Goal: The FHIR resource type defined in STU3 and R4.
GraphDefinition: The FHIR resource type defined in STU3 and R4.
Group: The FHIR resource type defined in STU3 and R4.
GuidanceResponse: The FHIR resource type defined in STU3 and R4.
HealthcareService: The FHIR resource type defined in STU3 and R4.
ImagingManifest: The FHIR resource type defined in STU3.
ImagingStudy: The FHIR resource type defined in STU3 and R4.
Immunization: The FHIR resource type defined in STU3 and R4.
ImmunizationEvaluation: The FHIR resource type defined in R4.
ImmunizationRecommendation: The FHIR resource type defined in STU3 and R4.
ImplementationGuide: The FHIR resource type defined in STU3 and R4.
InsurancePlan: The FHIR resource type defined in R4.
Invoice: The FHIR resource type defined in R4.
Library: The FHIR resource type defined in STU3 and R4.
Linkage: The FHIR resource type defined in STU3 and R4.
List: The FHIR resource type defined in STU3 and R4.
Location: The FHIR resource type defined in STU3 and R4.
Measure: The FHIR resource type defined in STU3 and R4.
MeasureReport: The FHIR resource type defined in STU3 and R4.
Media: The FHIR resource type defined in STU3 and R4.
Medication: The FHIR resource type defined in STU3 and R4.
MedicationAdministration: The FHIR resource type defined in STU3 and R4.
MedicationDispense: The FHIR resource type defined in STU3 and R4.
MedicationKnowledge: The FHIR resource type defined in R4.
MedicationRequest: The FHIR resource type defined in STU3 and R4.
MedicationStatement: The FHIR resource type defined in STU3 and R4.
MedicinalProduct: The FHIR resource type defined in R4.
MedicinalProductAuthorization: The FHIR resource type defined in R4.
MedicinalProductContraindication: The FHIR resource type defined in R4.
MedicinalProductIndication: The FHIR resource type defined in R4.
MedicinalProductIngredient: The FHIR resource type defined in R4.
MedicinalProductInteraction: The FHIR resource type defined in R4.
MedicinalProductManufactured: The FHIR resource type defined in R4.
MedicinalProductPackaged: The FHIR resource type defined in R4.
MedicinalProductPharmaceutical: The FHIR resource type defined in R4.
MedicinalProductUndesirableEffect: The FHIR resource type defined in R4.
MessageDefinition: The FHIR resource type defined in STU3 and R4.
MessageHeader: The FHIR resource type defined in STU3 and R4.
MolecularSequence: The FHIR resource type defined in R4.
NamingSystem: The FHIR resource type defined in STU3 and R4.
NutritionOrder: The FHIR resource type defined in STU3 and R4.
Observation: The FHIR resource type defined in STU3 and R4.
ObservationDefinition: The FHIR resource type defined in R4.
OperationDefinition: The FHIR resource type defined in STU3 and R4.
OperationOutcome: The FHIR resource type defined in STU3 and R4.
Organization: The FHIR resource type defined in STU3 and R4.
OrganizationAffiliation: The FHIR resource type defined in R4.
Parameters: The FHIR resource type defined in STU3 and R4.
Patient: The FHIR resource type defined in STU3 and R4.
PaymentNotice: The FHIR resource type defined in STU3 and R4.
PaymentReconciliation: The FHIR resource type defined in STU3 and R4.
Person: The FHIR resource type defined in STU3 and R4.
PlanDefinition: The FHIR resource type defined in STU3 and R4.
Practitioner: The FHIR resource type defined in STU3 and R4.
PractitionerRole: The FHIR resource type defined in STU3 and R4.
Procedure: The FHIR resource type defined in STU3 and R4.
ProcedureRequest: The FHIR resource type defined in STU3.
ProcessRequest: The FHIR resource type defined in STU3.
ProcessResponse: The FHIR resource type defined in STU3.
Provenance: The FHIR resource type defined in STU3 and R4.
Questionnaire: The FHIR resource type defined in STU3 and R4.
QuestionnaireResponse: The FHIR resource type defined in STU3 and R4.
ReferralRequest: The FHIR resource type defined in STU3.
RelatedPerson: The FHIR resource type defined in STU3 and R4.
RequestGroup: The FHIR resource type defined in STU3 and R4.
ResearchDefinition: The FHIR resource type defined in R4.
ResearchElementDefinition: The FHIR resource type defined in R4.
ResearchStudy: The FHIR resource type defined in STU3 and R4.
ResearchSubject: The FHIR resource type defined in STU3 and R4.
Resource: The FHIR resource type defined in STU3 and R4.
RiskAssessment: The FHIR resource type defined in STU3 and R4.
RiskEvidenceSynthesis: The FHIR resource type defined in R4.
Schedule: The FHIR resource type defined in STU3 and R4.
SearchParameter: The FHIR resource type defined in STU3 and R4.
Sequence: The FHIR resource type defined in STU3.
ServiceDefinition: The FHIR resource type defined in STU3.
ServiceRequest: The FHIR resource type defined in R4.
Slot: The FHIR resource type defined in STU3 and R4.
Specimen: The FHIR resource type defined in STU3 and R4.
SpecimenDefinition: The FHIR resource type defined in R4.
StructureDefinition: The FHIR resource type defined in STU3 and R4.
StructureMap: The FHIR resource type defined in STU3 and R4.
Subscription: The FHIR resource type defined in STU3 and R4.
Substance: The FHIR resource type defined in STU3 and R4.
SubstanceNucleicAcid: The FHIR resource type defined in R4.
SubstancePolymer: The FHIR resource type defined in R4.
SubstanceProtein: The FHIR resource type defined in R4.
SubstanceReferenceInformation: The FHIR resource type defined in R4.
SubstanceSourceMaterial: The FHIR resource type defined in R4.
SubstanceSpecification: The FHIR resource type defined in R4.
SupplyDelivery: The FHIR resource type defined in STU3 and R4.
SupplyRequest: The FHIR resource type defined in STU3 and R4.
Task: The FHIR resource type defined in STU3 and R4.
TerminologyCapabilities: The FHIR resource type defined in R4.
TestReport: The FHIR resource type defined in STU3 and R4.
TestScript: The FHIR resource type defined in STU3 and R4.
ValueSet: The FHIR resource type defined in STU3 and R4.
VerificationResult: The FHIR resource type defined in R4.
VisionPrescription: The FHIR resource type defined in STU3 and R4.

InputSchema

InputSchema: keyof InputSchemaToInputTypeMap

Allowed schema types, to be used when constructing the EventGridPublisherClient.

IotHubDeviceConnectedEventData

IotHubDeviceConnectedEventData: DeviceConnectionStateEvent & {}

Event data for Microsoft.Devices.DeviceConnected event.

IotHubDeviceCreatedEventData

IotHubDeviceCreatedEventData: DeviceLifeCycleEvent & {}

Event data for Microsoft.Devices.DeviceCreated event.

IotHubDeviceDeletedEventData

IotHubDeviceDeletedEventData: DeviceLifeCycleEvent & {}

Event data for Microsoft.Devices.DeviceDeleted event.

IotHubDeviceDisconnectedEventData

IotHubDeviceDisconnectedEventData: DeviceConnectionStateEvent & {}

Event data for Microsoft.Devices.DeviceDisconnected event.

IotHubDeviceTelemetryEventData

IotHubDeviceTelemetryEventData: DeviceTelemetryEvent & {}

Event data for Microsoft.Devices.DeviceTelemetry event.

KnownSystemEventTypes

KnownSystemEventTypes: keyof SystemEventNameToEventData

The Event Types for all System Events. These may be used with isSystemEvent to determine if an event is a system event of a given type.

MapsGeofenceEnteredEventData

MapsGeofenceEnteredEventData: MapsGeofenceEvent & {}

Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceEntered event.

MapsGeofenceExitedEventData

MapsGeofenceExitedEventData: MapsGeofenceEvent & {}

Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceExited event.

MapsGeofenceResultEventData

MapsGeofenceResultEventData: MapsGeofenceEvent & {}

Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceResult event.

MediaJobCanceledEventData

MediaJobCanceledEventData: MediaJobStateChangeEventData & { outputs: MediaJobOutputUnion[] }

Job canceled event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobCanceled event.

MediaJobCancelingEventData

MediaJobCancelingEventData: MediaJobStateChangeEventData & {}

Job canceling event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobCanceling event.

MediaJobErrorCategory

Defines values for MediaJobErrorCategory.

MediaJobErrorCode

Defines values for MediaJobErrorCode.

MediaJobErroredEventData

MediaJobErroredEventData: MediaJobStateChangeEventData & { outputs: MediaJobOutputUnion[] }

Job error state event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobErrored event.

MediaJobFinishedEventData

MediaJobFinishedEventData: MediaJobStateChangeEventData & { outputs: MediaJobOutputUnion[] }

Job finished event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobFinished event.

MediaJobOutputAsset

MediaJobOutputAsset: MediaJobOutput & { assetName: string; odataType: "#Microsoft.Media.JobOutputAsset" }

The event data for a Job output asset.

MediaJobOutputCanceledEventData

MediaJobOutputCanceledEventData: MediaJobOutputStateChangeEventData & {}

Job output canceled event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobOutputCanceled event.

MediaJobOutputCancelingEventData

MediaJobOutputCancelingEventData: MediaJobOutputStateChangeEventData & {}

Job output canceling event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobOutputCanceling event.

MediaJobOutputErroredEventData

MediaJobOutputErroredEventData: MediaJobOutputStateChangeEventData & {}

Job output error event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobOutputErrored event.

MediaJobOutputFinishedEventData

MediaJobOutputFinishedEventData: MediaJobOutputStateChangeEventData & {}

Job output finished event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobOutputFinished event.

MediaJobOutputProcessingEventData

MediaJobOutputProcessingEventData: MediaJobOutputStateChangeEventData & {}

Job output processing event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobOutputProcessing event.

MediaJobOutputScheduledEventData

MediaJobOutputScheduledEventData: MediaJobOutputStateChangeEventData & {}

Job output scheduled event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobOutputScheduled event.

MediaJobOutputUnion

MediaJobOutputUnion: MediaJobOutput | MediaJobOutputAsset

MediaJobProcessingEventData

MediaJobProcessingEventData: MediaJobStateChangeEventData & {}

Job processing event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobProcessing event.

MediaJobRetry

MediaJobRetry: "DoNotRetry" | "MayRetry"

Defines values for MediaJobRetry.

MediaJobScheduledEventData

MediaJobScheduledEventData: MediaJobStateChangeEventData & {}

Job scheduled event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobScheduled event.

MediaJobState

Defines values for MediaJobState.

RecordingChannelType

RecordingChannelType: string

Defines values for RecordingChannelType.
KnownRecordingChannelType can be used interchangeably with RecordingChannelType, this enum contains the known values that the service supports.

Known values supported by the service

Mixed
Unmixed

RecordingContentType

RecordingContentType: string

Defines values for RecordingContentType.
KnownRecordingContentType can be used interchangeably with RecordingContentType, this enum contains the known values that the service supports.

Known values supported by the service

AudioVideo
Audio

RecordingFormatType

RecordingFormatType: string

Defines values for RecordingFormatType.
KnownRecordingFormatType can be used interchangeably with RecordingFormatType, this enum contains the known values that the service supports.

Known values supported by the service

Wav
Mp3
Mp4

SendOptions

SendOptions: OperationOptions

Options for the send events operation.

StampKind

StampKind: string

Defines values for StampKind.
KnownStampKind can be used interchangeably with StampKind, this enum contains the known values that the service supports.

Known values supported by the service

Public: App Service Plan is running on a public stamp.
AseV1: App Service Plan is running on an App Service Environment V1.
AseV2: App Service Plan is running on an App Service Environment V2.

Variables

Const API_KEY_HEADER_NAME

API_KEY_HEADER_NAME: "aeg-sas-key" = "aeg-sas-key"

The name of the header to include when a Shared Key is used for authentication.

Const CLOUD_EVENT_1_0_SPEC_VERSION

CLOUD_EVENT_1_0_SPEC_VERSION: "1.0" = "1.0"

Const CloudEventBatchContentType

CloudEventBatchContentType: "application/cloudevents-batch+json; charset=utf-8" = "application/cloudevents-batch+json; charset=utf-8"

Const ContentTypeHeaderName

ContentTypeHeaderName: "Content-Type" = "Content-Type"

Const DEFAULT_API_VERSION

DEFAULT_API_VERSION: "2018-01-01" = "2018-01-01"

Const DEFAULT_EVENTGRID_SCOPE

DEFAULT_EVENTGRID_SCOPE: "https://eventgrid.azure.net/.default" = "https://eventgrid.azure.net/.default"

Const EVENT_GRID_SCHEMA_METADATA_VERSION

EVENT_GRID_SCHEMA_METADATA_VERSION: "1" = "1"

Const SAS_TOKEN_HEADER_NAME

SAS_TOKEN_HEADER_NAME: "aeg-sas-token" = "aeg-sas-token"

The name of the header to include when Shared Access Signature is used for authentication.

Const TraceParentHeaderName

TraceParentHeaderName: "traceparent" = "traceparent"

Const TraceStateHeaderName

TraceStateHeaderName: "tracestate" = "tracestate"

Const cloudEventDistributedTracingEnricherPolicyName

cloudEventDistributedTracingEnricherPolicyName: "cloudEventDistributedTracingEnricherPolicy" = "cloudEventDistributedTracingEnricherPolicy"

The programmatic identifier of the cloudEventDistributedTracingEnricherPolicy.

Const cloudEventReservedPropertyNames

cloudEventReservedPropertyNames: string[] = ["specversion","id","source","type","datacontenttype","dataschema","subject","time","data",]

Property names defined by the CloudEvents 1.0 specification, these may not be reused as the names of extension properties.

Const eventGridCredentialPolicyName

eventGridCredentialPolicyName: "eventGridCredentialPolicy" = "eventGridCredentialPolicy"

The programmatic identifier of the eventGridCredentialPolicy.

Const logger

logger: any = createClientLogger("eventgrid")

The @azure/logger configuration for this package.

Const serializer

serializer: any = coreClient.createSerializer(Mappers, /* isXml */ false)

Functions

cloudEventDistributedTracingEnricherPolicy

cloudEventDistributedTracingEnricherPolicy(): PipelinePolicy

- Defined in cloudEventDistrubtedTracingEnricherPolicy.ts:34
cloudEventDistributedTracingEnricherPolicy is a policy which adds distributed tracing information to a batch of cloud events. It does so by copying the traceparent and tracestate properties from the HTTP request into the individual events as extension properties.

This will only happen in the case where an event does not have a traceparent defined already. This allows events to explicitly set a traceparent and tracestate which would be respected during "multi-hop transmition".

See https://github.com/cloudevents/spec/blob/master/extensions/distributed-tracing.md for more information on distributed tracing and cloud events.

Returns PipelinePolicy

dateToServiceTimeString

dateToServiceTimeString(d: Date): string

- Defined in util.ts:19
Stringifies a Date object in the format expected by the Event Grid service, for use in a Shared Access Signiture.

The service expects this time string to be in the same format as what is returned by the .NET DateTime.ToString method, using the "en-US" culture.

This corresponds to the .NET format string: "M/d/yyyy h:mm:ss tt". For example, the date "June 5th, 2020, 12:09:03 PM" is represented as the string "6/5/2020 12:09:03 PM"

The service expects a UTC time, so this method returns a string based on the UTC time of the provided Date.

Parameters
- d: Date
  
  The Date object to convert to a string.
Returns string

eventGridCredentialPolicy

eventGridCredentialPolicy(credential: KeyCredential | SASCredential): PipelinePolicy

- Defined in eventGridAuthenticationPolicy.ts:33
A concrete implementation of an AzureKeyCredential policy using the appropriate header for Event Grid

Parameters
- credential: KeyCredential | SASCredential
Returns PipelinePolicy

generateSharedAccessSignature

generateSharedAccessSignature(endpointUrl: string, credential: KeyCredential, expiresOnUtc: Date, options?: GenerateSharedAccessSignatureOptions): Promise<string>

- Defined in generateSharedAccessSignature.ts:26
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.

Parameters
- endpointUrl: string
  
  The endpoint for the topic or domain you wish to generate a shared access signature for.
- credential: KeyCredential
  
  The credential to use when generating the shared access signatrue.
- expiresOnUtc: Date
- Optional options: GenerateSharedAccessSignatureOptions
  
  Options to control how the signature is generated.
Returns Promise<string>

isCloudEventLike

isCloudEventLike(o: EventGridEvent<unknown> | CloudEvent<unknown>): o is CloudEvent<unknown>

- Defined in predicates.ts:416
isCloudEventLike returns "true" when the event is a CloudEvent

Parameters
- o: EventGridEvent<unknown> | CloudEvent<unknown>
  
  Either an EventGrid our CloudEvent event.
Returns o is CloudEvent<unknown>

isKeyCredentialLike

isKeyCredentialLike(o: unknown): o is KeyCredential

- Defined in util.ts:38
Returns true if the credential object is like the KeyCredential interface (i.e. it has a key property).

Parameters
- o: unknown
Returns o is KeyCredential

isSystemEvent

isSystemEvent<T>(eventType: T, event: EventGridEvent<unknown>): event is EventGridEvent<SystemEventNameToEventData[T]>
isSystemEvent<T>(eventType: T, event: CloudEvent<unknown>): event is CloudEvent<SystemEventNameToEventData[T]>

- Defined in predicates.ts:430
iSystemEvent returns "true" when a given event is a system event of a given type. When using TypeScript, this function acts as a custom type guard and allows the TypeScript compiler to identify the underlying data

Type parameters
- T: KnownSystemEventTypes
Parameters
- eventType: T
  
  The type of system event to check for, e.g., "Microsoft.AppConfiguration.KeyValueDeleted"
- event: EventGridEvent<unknown>
  
  The event to test.
Returns event is EventGridEvent<SystemEventNameToEventData[T]>
- Defined in predicates.ts:443
iSystemEvent returns "true" when a given event is a system event of a given type. When using TypeScript, this function acts as a custom type guard and allows the TypeScript compiler to identify the underlying data

Type parameters
- T: KnownSystemEventTypes
Parameters
- eventType: T
  
  The type of system event to check for, e.g., "Microsoft.AppConfiguration.KeyValueDeleted"
- event: CloudEvent<unknown>
  
  The event to test.
Returns event is CloudEvent<SystemEventNameToEventData[T]>

parseAndWrap

parseAndWrap(jsonStringOrObject: string | Record<string, unknown>): any[]

- Defined in util.ts:45
Parameters
- jsonStringOrObject: string | Record<string, unknown>
Returns any[]

validateCloudEventEvent

validateCloudEventEvent(o: unknown): void

- Defined in util.ts:91
Parameters
- o: unknown
Returns void

validateEventGridEvent

validateEventGridEvent(o: unknown): void

- Defined in util.ts:64
Parameters
- o: unknown
Returns void

validateOptionalStringProperties

validateOptionalStringProperties(o: any, propertyNames: string[]): void

- Defined in util.ts:130
Parameters
- o: any
- propertyNames: string[]
Returns void

validateRequiredAnyProperties

validateRequiredAnyProperties(o: any, propertyNames: string[]): void

- Defined in util.ts:122
Parameters
- o: any
- propertyNames: string[]
Returns void

validateRequiredStringProperties

validateRequiredStringProperties(o: any, propertyNames: string[]): void

- Defined in util.ts:108
Parameters
- o: any
- propertyNames: string[]
Returns void

Object literals

Const AcsChatEventBase

AcsChatEventBase: object

type

type: object

className

className: string = "AcsChatEventBase"

name

modelProperties

modelProperties: object

recipientCommunicationIdentifier

recipientCommunicationIdentifier: object

serializedName

serializedName: string = "recipientCommunicationIdentifier"

type

type: object

className

className: string = "CommunicationIdentifierModel"

type

type: object

name

messageBody

messageBody: object

required

name

Const AcsChatMessageEventInThreadBase

AcsChatMessageEventInThreadBase: object

type

type: object

className

className: string = "AcsChatMessageEventInThreadBase"

name

modelProperties

name

Const AcsChatMessageReceivedEventData

AcsChatMessageReceivedEventData: object

type

type: object

className

className: string = "AcsChatMessageReceivedEventData"

name

modelProperties

modelProperties: object

messageBody

messageBody: object

required

type

type: object

name

metadata

metadata: object

required

className

className: string = "AcsChatParticipantAddedToThreadEventData"

name

modelProperties

modelProperties: object

addedByCommunicationIdentifier

addedByCommunicationIdentifier: object

serializedName

serializedName: string = "addedByCommunicationIdentifier"

type

type: object

className

className: string = "CommunicationIdentifierModel"

className

className: string = "CommunicationIdentifierModel"

name

participants

participants: object

required

type

type: object

type

type: object

name

editedByCommunicationIdentifier

editedByCommunicationIdentifier: object

serializedName

type

type: object

AcsSmsDeliveryAttempt: object

type

type: object

className

className: string = "AcsSmsDeliveryAttempt"

name

modelProperties

modelProperties: object

segmentsFailed

segmentsFailed: object

required

required: boolean = true

serializedName

serializedName: string = "segmentsFailed"

type

type: object

deliveryStatus: object

required

required: boolean = true

serializedName

serializedName: string = "deliveryStatus"

type

type: object

type

type: object

name

source

source: object

required

required: boolean = true

serializedName

serializedName: string = "source"

type

type: object

name

specversion

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

Const ContainerRegistryEventData

ContainerRegistryEventData: object

type

type: object

className

className: string = "ContainerRegistryEventData"

name

modelProperties

name

Const ContainerRegistryEventRequest

ContainerRegistryEventRequest: object

type

type: object

className

className: string = "ContainerRegistryEventRequest"

name

modelProperties

name

Const ContainerRegistryEventSource

ContainerRegistryEventSource: object

type

type: object

className

className: string = "ContainerRegistryEventSource"

name

modelProperties

modelProperties: object

addr

addr: object

required

required: boolean = true

serializedName

serializedName: string = "addr"

type

type: object

className

className: string = "DeviceTwinMetadata"

modelProperties: object

primaryThumbprint

primaryThumbprint: object

serializedName

serializedName: string = "primaryThumbprint"

type

type: object

name

secondaryThumbprint

secondaryThumbprint: object

serializedName

serializedName: string = "secondaryThumbprint"

type

type: object

name

Const DeviceTwinMetadata

DeviceTwinMetadata: object

type

type: object

className

className: string = "DeviceTwinMetadata"

name

modelProperties

modelProperties: object

lastUpdated

lastUpdated: object

required

required: boolean = true

serializedName

serializedName: string = "lastUpdated"

type

type: object

name

Const EventGridEvent

EventGridEvent: object

type

type: object

className

className: string = "EventGridEvent"

name

modelProperties

name

Const HealthcareFhirResourceCreatedEventData

HealthcareFhirResourceCreatedEventData: object

type

type: object

className

className: string = "HealthcareFhirResourceCreatedEventData"

name

modelProperties

modelProperties: object

resourceFhirAccount

resourceFhirAccount: object

required

required: boolean = true

serializedName

serializedName: string = "resourceFhirAccount"

type

type: object

modelProperties: object

Const MapsGeofenceEvent

MapsGeofenceEvent: object

type

type: object

className

className: string = "MapsGeofenceEvent"

name

modelProperties

modelProperties: object

expiredGeofenceGeometryId

expiredGeofenceGeometryId: object

required

required: boolean = true

serializedName

serializedName: string = "expiredGeofenceGeometryId"

type

type: object

name

element

element: object

type

type: object

name

geometries

geometries: object

required

name

Const MapsGeofenceExitedEventData

MapsGeofenceExitedEventData: object

type

type: object

className

className: string = "MapsGeofenceExitedEventData"

name

modelProperties

modelProperties: object

Const MapsGeofenceGeometry

MapsGeofenceGeometry: object

type

type: object

className

className: string = "MapsGeofenceGeometry"

name

modelProperties

name

Const MapsGeofenceResultEventData

MapsGeofenceResultEventData: object

type

type: object

className

className: string = "MapsGeofenceResultEventData"

name

modelProperties

modelProperties: object

Const MediaJobCanceledEventData

allowedValues

allowedValues: string[] = ["Service","Download","Upload","Configuration","Content","Account"]

name

code

code: object

readOnly

readOnly: boolean = true

required

name

retry

retry: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "retry"

type

type: object

allowedValues

allowedValues: string[] = ["DoNotRetry", "MayRetry"]

name

Const MediaJobErrorDetail

MediaJobErrorDetail: object

type

type: object

className

className: string = "MediaJobErrorDetail"

name

modelProperties

modelProperties: object

code

code: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

message

message: object

readOnly

MediaJobOutput: object

type

type: object

className

className: string = "MediaJobOutput"

name

uberParent

uberParent: string = "MediaJobOutput"

modelProperties

modelProperties: object

error

type

type: object

name

progress

progress: object

required

required: boolean = true

serializedName

serializedName: string = "progress"

type

type: object

name

state

state: object

required

required: boolean = true

serializedName

serializedName: string = "state"

type

type: object

allowedValues

allowedValues: string[] = ["Canceled","Canceling","Error","Finished","Processing","Queued","Scheduled"]

name

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "@odata\.type"

serializedName

serializedName: string = "@odata\.type"

Const MediaJobOutputAsset

MediaJobOutputAsset: object

serializedName

serializedName: string = "#Microsoft.Media.JobOutputAsset"

type

type: object

className

className: string = "MediaJobOutputAsset"

name

polymorphicDiscriminator

polymorphicDiscriminator: any = MediaJobOutput.type.polymorphicDiscriminator

uberParent

uberParent: string = "MediaJobOutput"

modelProperties

modelProperties: object

assetName

assetName: object

required

required: boolean = true

serializedName

serializedName: string = "assetName"

type

type: object

jobCorrelationData: object

required

required: boolean = true

serializedName

serializedName: string = "jobCorrelationData"

type

type: object

name

value

value: object

type

type: object

name

output

output: object

serializedName

serializedName: string = "output"

type

type: object

className

className: string = "MediaJobOutput"

name

previousState

previousState: object

readOnly

className

className: string = "MediaJobScheduledEventData"

name

modelProperties

modelProperties: object

Const MediaJobStateChangeEventData

MediaJobStateChangeEventData: object

type

type: object

className

className: string = "MediaJobStateChangeEventData"

name

modelProperties

modelProperties: object

correlationData

correlationData: object

required

required: boolean = true

serializedName

serializedName: string = "correlationData"

type

type: object

modelProperties

modelProperties: object

channelLatencyMs

channelLatencyMs: object

readOnly

name

Const MediaLiveEventEncoderConnectedEventData

MediaLiveEventEncoderConnectedEventData: object

type

type: object

className

className: string = "MediaLiveEventEncoderConnectedEventData"

name

modelProperties

name

Const MediaLiveEventIncomingDataChunkDroppedEventData

MediaLiveEventIncomingDataChunkDroppedEventData: object

type

type: object

className

className: string = "MediaLiveEventIncomingDataChunkDroppedEventData"

name

modelProperties

name

Const MediaLiveEventIncomingStreamReceivedEventData

MediaLiveEventIncomingStreamReceivedEventData: object

type

type: object

className

className: string = "MediaLiveEventIncomingStreamReceivedEventData"

name

modelProperties

name

Const MediaLiveEventIncomingStreamsOutOfSyncEventData

MediaLiveEventIncomingStreamsOutOfSyncEventData: object

type

type: object

className

className: string = "MediaLiveEventIncomingStreamsOutOfSyncEventData"

name

modelProperties

name

Const MediaLiveEventIncomingVideoStreamsOutOfSyncEventData

MediaLiveEventIncomingVideoStreamsOutOfSyncEventData: object

type

type: object

className

className: string = "MediaLiveEventIncomingVideoStreamsOutOfSyncEventData"

name

modelProperties

name

Const MediaLiveEventIngestHeartbeatEventData

MediaLiveEventIngestHeartbeatEventData: object

type

type: object

className

className: string = "MediaLiveEventIngestHeartbeatEventData"

name

modelProperties

name

Const MediaLiveEventTrackDiscontinuityDetectedEventData

MediaLiveEventTrackDiscontinuityDetectedEventData: object

type

type: object

className

className: string = "MediaLiveEventTrackDiscontinuityDetectedEventData"

name

modelProperties

name

Const MicrosoftTeamsUserIdentifierModel

MicrosoftTeamsUserIdentifierModel: object

type

type: object

className

className: string = "MicrosoftTeamsUserIdentifierModel"

name

modelProperties

modelProperties: object

cloud

cloud: object

serializedName

serializedName: string = "cloud"

type

type: object

name

isAnonymous

isAnonymous: object

serializedName

serializedName: string = "isAnonymous"

type

type: object

modelProperties: object

RedisImportRDBCompletedEventData: object

type

type: object

className

className: string = "RedisImportRDBCompletedEventData"

name

modelProperties

modelProperties: object

RedisPatchingCompletedEventData: object

type

type: object

className

className: string = "RedisPatchingCompletedEventData"

name

modelProperties

modelProperties: object

RedisScalingCompletedEventData: object

type

type: object

className

className: string = "RedisScalingCompletedEventData"

name

modelProperties

modelProperties: object

name

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

type: object

className

className: string = "ResourceActionFailureEventData"

name

modelProperties

modelProperties: object

authorization

authorization: object

serializedName

serializedName: string = "authorization"

type

type: object

className

className: string = "ResourceAuthorization"

name

claims

claims: object

required

required: boolean = true

serializedName

serializedName: string = "claims"

type

type: object

type: object

className

className: string = "ResourceActionSuccessEventData"

name

modelProperties

modelProperties: object

authorization

authorization: object

serializedName

serializedName: string = "authorization"

type

type: object

className

className: string = "ResourceAuthorization"

name

claims

claims: object

required

required: boolean = true

serializedName

serializedName: string = "claims"

type

type: object

type: object

className

className: string = "ResourceAuthorization"

name

modelProperties

modelProperties: object

action

action: object

required

name

Const ResourceDeleteCancelEventData

ResourceDeleteCancelEventData: object

type

type: object

className

className: string = "ResourceDeleteCancelEventData"

name

modelProperties

modelProperties: object

authorization

authorization: object

serializedName

serializedName: string = "authorization"

type

type: object

className

className: string = "ResourceAuthorization"

name

claims

claims: object

required

required: boolean = true

serializedName

serializedName: string = "claims"

type

type: object

type: object

className

className: string = "ResourceDeleteFailureEventData"

name

modelProperties

modelProperties: object

authorization

authorization: object

serializedName

serializedName: string = "authorization"

type

type: object

className

className: string = "ResourceAuthorization"

name

claims

claims: object

required

required: boolean = true

serializedName

serializedName: string = "claims"

type

type: object

type: object

className

className: string = "ResourceDeleteSuccessEventData"

name

modelProperties

modelProperties: object

authorization

authorization: object

serializedName

serializedName: string = "authorization"

type

type: object

className

className: string = "ResourceAuthorization"

name

claims

claims: object

required

required: boolean = true

serializedName

serializedName: string = "claims"

type

type: object

type: object

className

className: string = "ResourceHttpRequest"

name

modelProperties

modelProperties: object

clientIpAddress

clientIpAddress: object

required

required: boolean = true

serializedName

serializedName: string = "clientIpAddress"

type

type: object

type: object

className

className: string = "ResourceWriteFailureEventData"

name

modelProperties

modelProperties: object

authorization

authorization: object

serializedName

serializedName: string = "authorization"

type

type: object

className

className: string = "ResourceAuthorization"

name

claims

claims: object

required

required: boolean = true

serializedName

serializedName: string = "claims"

type

type: object

type: object

className

className: string = "ResourceWriteSuccessEventData"

name

modelProperties

modelProperties: object

authorization

authorization: object

serializedName

serializedName: string = "authorization"

type

type: object

className

className: string = "ResourceAuthorization"

name

claims

claims: object

required

required: boolean = true

serializedName

serializedName: string = "claims"

type

type: object

type: object

className

className: string = "ServiceBusActiveMessagesAvailablePeriodicNotificationsEventData"

name

modelProperties

name

Const ServiceBusActiveMessagesAvailableWithNoListenersEventData

ServiceBusActiveMessagesAvailableWithNoListenersEventData: object

type

type: object

className

className: string = "ServiceBusActiveMessagesAvailableWithNoListenersEventData"

name

modelProperties

name

Const ServiceBusDeadletterMessagesAvailablePeriodicNotificationsEventData

ServiceBusDeadletterMessagesAvailablePeriodicNotificationsEventData: object

type

type: object

className

className: string = "ServiceBusDeadletterMessagesAvailablePeriodicNotificationsEventData"

name

modelProperties

name

Const ServiceBusDeadletterMessagesAvailableWithNoListenersEventData

ServiceBusDeadletterMessagesAvailableWithNoListenersEventData: object

type

type: object

className

className: string = "ServiceBusDeadletterMessagesAvailableWithNoListenersEventData"

name

modelProperties

name

Const SignalRServiceClientConnectionConnectedEventData

SignalRServiceClientConnectionConnectedEventData: object

type

type: object

className

className: string = "SignalRServiceClientConnectionConnectedEventData"

name

modelProperties

modelProperties: object

connectionId

connectionId: object

required

required: boolean = true

serializedName

serializedName: string = "connectionId"

type

type: object

type

type: object

name

Const SubscriptionValidationEventData

SubscriptionValidationEventData: object

type

type: object

className

className: string = "SubscriptionValidationEventData"

name

modelProperties

modelProperties: object

validationCode

validationCode: object

readOnly

WebAppServicePlanUpdatedEventDataSku: object

type

type: object

className

className: string = "WebAppServicePlanUpdatedEventDataSku"

name

modelProperties

modelProperties: object

capacity

capacity: object

serializedName

serializedName: string = "Capacity"

type

type: object

name

family

family: object

serializedName

serializedName: string = "Family"

type

type: object

name

name

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

defaultValue: string = "2018-01-01"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

Const contentType

contentType: object

parameterPath

parameterPath: string[] = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

Const contentType1

contentType1: object

parameterPath

parameterPath: string[] = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/cloudevents-batch+json; charset=utf-8"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

Let discriminators

discriminators: object

MediaJobOutput

MediaJobOutput: any = MediaJobOutput

MediaJobOutput.#Microsoft.Media.JobOutputAsset

MediaJobOutput.#Microsoft.Media.JobOutputAsset: any = MediaJobOutputAsset

Const events

events: object

parameterPath

parameterPath: string = "events"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "events"

type

type: object

name

element

element: object

type

type: object

className

className: string = "EventGridEvent"

name

Const events1

events1: object

parameterPath

parameterPath: string = "events"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "events"

type

type: object

name

element

element: object

type

type: object

className

className: string = "CloudEvent"

name

Const events2

events2: object

parameterPath

parameterPath: string = "events"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "events"

type

type: object

name

element

element: object

type

type: object

name

Const publishCloudEventEventsOperationSpec

publishCloudEventEventsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType1, Parameters.aegChannelName]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = ""

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.events1

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.topicHostname]

responses

responses: object

200

200: {}

Type declaration

default

default: {}

Type declaration

Const publishCustomEventEventsOperationSpec

publishCustomEventEventsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = ""

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.events2

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.topicHostname]

responses

responses: object

200

200: {}

Type declaration

default

default: {}

Type declaration

Const publishEventsOperationSpec

publishEventsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = ""

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.events

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.topicHostname]

responses

responses: object

200

200: {}

Type declaration

default

default: {}

Type declaration

Const topicHostname

topicHostname: object

parameterPath

parameterPath: string = "topicHostname"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "topicHostname"

type

type: object

name

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AcsChatMessageDeletedEventData

AcsChatMessageDeletedInThreadEventData

AcsChatMessageEditedEventData

AcsChatMessageEditedInThreadEventData

AcsChatMessageEventBase

AcsChatMessageEventInThreadBase

AcsChatMessageReceivedEventData

AcsChatMessageReceivedInThreadEventData

AcsChatParticipantAddedToThreadEventData

AcsChatParticipantAddedToThreadWithUserEventData

AcsChatParticipantRemovedFromThreadEventData

AcsChatParticipantRemovedFromThreadWithUserEventData

AcsChatThreadCreatedEventData

AcsChatThreadCreatedWithUserEventData

AcsChatThreadDeletedEventData

AcsChatThreadEventBase

AcsChatThreadEventInThreadBase

AcsChatThreadPropertiesUpdatedEventData

AcsChatThreadPropertiesUpdatedPerUserEventData

AcsChatThreadWithUserDeletedEventData

AcsSmsDeliveryReportReceivedEventData

AcsSmsReceivedEventData

AppAction

Known values supported by the service

AppServicePlanAction

Known values supported by the service

AsyncStatus

Known values supported by the service

CommunicationCloudEnvironmentModel

Known values supported by the service

ContainerRegistryChartDeletedEventData

ContainerRegistryChartPushedEventData

ContainerRegistryImageDeletedEventData

ContainerRegistryImagePushedEventData

CustomEventDataDeserializer

Type declaration

Parameters

o: any

Returns Promise<any>

EventGridPublisherClientOptions

HealthcareFhirResourceType

Known values supported by the service

InputSchema

IotHubDeviceConnectedEventData

IotHubDeviceCreatedEventData

IotHubDeviceDeletedEventData

IotHubDeviceDisconnectedEventData

IotHubDeviceTelemetryEventData

KnownSystemEventTypes

MapsGeofenceEnteredEventData

MapsGeofenceExitedEventData

MapsGeofenceResultEventData

MediaJobCanceledEventData

MediaJobCancelingEventData

MediaJobErrorCategory

MediaJobErrorCode

MediaJobErroredEventData

MediaJobFinishedEventData

MediaJobOutputAsset

MediaJobOutputCanceledEventData

MediaJobOutputCancelingEventData

MediaJobOutputErroredEventData

MediaJobOutputFinishedEventData

MediaJobOutputProcessingEventData

MediaJobOutputScheduledEventData

MediaJobOutputUnion

MediaJobProcessingEventData

MediaJobRetry

MediaJobScheduledEventData

MediaJobState

RecordingChannelType