@azure/eventgrid-system-events
Version:
An isomorphic client library for the Azure Event Grid service.
249 lines • 9.54 kB
TypeScript
/**
* Cloud Event Schema.
*/
export interface CloudEvent<T> {
/**
* Type of event related to the originating occurrence.
*/
type: string;
/**
* Identifies the context in which an event happened. The combination of id and source must be unique for each distinct event.
*/
source: string;
/**
* An identifier for the event. The combination of id and source must be unique for each distinct event.
*/
id: string;
/**
* The time the event was generated.
*/
time?: Date;
/**
* Identifies the schema that data adheres to.
*/
dataSchema?: string;
/**
* Content type of data value.
*/
dataContentType?: string;
/**
* Event data specific to the event type.
*/
data?: T;
/**
* This describes the subject of the event in the context of the event producer (identified by source).
*/
subject?: string;
/**
* 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";
}
/**
* An event in the in the Event Grid Schema.
*/
export interface EventGridEvent<T> {
/**
* The type of the event.
*/
eventType: string;
/**
* The time the event was generated.
*/
eventTime: Date;
/**
* An unique identifier for the event.
*/
id: string;
/**
* The resource path of the event source.
*/
topic?: string;
/**
* A resource path relative to the topic path.
*/
subject: string;
/**
* The schema version of the data object.
*/
dataVersion: string;
/**
* Event data specific to the event type.
*/
data: T;
}
/** Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateNewVersionCreated event. */
export interface KeyVaultCertificateNewVersionCreatedEventData {
/** The id of the object that triggered this event. */
id?: string;
/** Key vault name of the object that triggered this event. */
vaultName?: string;
/** The type of the object that triggered this event */
objectType?: string;
/** The name of the object that triggered this event */
objectName?: string;
/** The version of the object that triggered this event */
version?: string;
/** Not before date of the object that triggered this event */
nbf?: number;
/** The expiration date of the object that triggered this event */
exp?: number;
}
/** Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateNearExpiry event. */
export interface KeyVaultCertificateNearExpiryEventData {
/** The id of the object that triggered this event. */
id?: string;
/** Key vault name of the object that triggered this event. */
vaultName?: string;
/** The type of the object that triggered this event */
objectType?: string;
/** The name of the object that triggered this event */
objectName?: string;
/** The version of the object that triggered this event */
version?: string;
/** Not before date of the object that triggered this event */
nbf?: number;
/** The expiration date of the object that triggered this event */
exp?: number;
}
/** Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateExpired event. */
export interface KeyVaultCertificateExpiredEventData {
/** The id of the object that triggered this event. */
id?: string;
/** Key vault name of the object that triggered this event. */
vaultName?: string;
/** The type of the object that triggered this event */
objectType?: string;
/** The name of the object that triggered this event */
objectName?: string;
/** The version of the object that triggered this event */
version?: string;
/** Not before date of the object that triggered this event */
nbf?: number;
/** The expiration date of the object that triggered this event */
exp?: number;
}
/** Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyNewVersionCreated event. */
export interface KeyVaultKeyNewVersionCreatedEventData {
/** The id of the object that triggered this event. */
id?: string;
/** Key vault name of the object that triggered this event. */
vaultName?: string;
/** The type of the object that triggered this event */
objectType?: string;
/** The name of the object that triggered this event */
objectName?: string;
/** The version of the object that triggered this event */
version?: string;
/** Not before date of the object that triggered this event */
nbf?: number;
/** The expiration date of the object that triggered this event */
exp?: number;
}
/** Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyNearExpiry event. */
export interface KeyVaultKeyNearExpiryEventData {
/** The id of the object that triggered this event. */
id?: string;
/** Key vault name of the object that triggered this event. */
vaultName?: string;
/** The type of the object that triggered this event */
objectType?: string;
/** The name of the object that triggered this event */
objectName?: string;
/** The version of the object that triggered this event */
version?: string;
/** Not before date of the object that triggered this event */
nbf?: number;
/** The expiration date of the object that triggered this event */
exp?: number;
}
/** Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyExpired event. */
export interface KeyVaultKeyExpiredEventData {
/** The id of the object that triggered this event. */
id?: string;
/** Key vault name of the object that triggered this event. */
vaultName?: string;
/** The type of the object that triggered this event */
objectType?: string;
/** The name of the object that triggered this event */
objectName?: string;
/** The version of the object that triggered this event */
version?: string;
/** Not before date of the object that triggered this event */
nbf?: number;
/** The expiration date of the object that triggered this event */
exp?: number;
}
/** Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretNewVersionCreated event. */
export interface KeyVaultSecretNewVersionCreatedEventData {
/** The id of the object that triggered this event. */
id?: string;
/** Key vault name of the object that triggered this event. */
vaultName?: string;
/** The type of the object that triggered this event */
objectType?: string;
/** The name of the object that triggered this event */
objectName?: string;
/** The version of the object that triggered this event */
version?: string;
/** Not before date of the object that triggered this event */
nbf?: number;
/** The expiration date of the object that triggered this event */
exp?: number;
}
/** Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretNearExpiry event. */
export interface KeyVaultSecretNearExpiryEventData {
/** The id of the object that triggered this event. */
id?: string;
/** Key vault name of the object that triggered this event. */
vaultName?: string;
/** The type of the object that triggered this event */
objectType?: string;
/** The name of the object that triggered this event */
objectName?: string;
/** The version of the object that triggered this event */
version?: string;
/** Not before date of the object that triggered this event */
nbf?: number;
/** The expiration date of the object that triggered this event */
exp?: number;
}
/** Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.VaultAccessPolicyChanged event. */
export interface KeyVaultAccessPolicyChangedEventData {
/** The id of the object that triggered this event. */
id?: string;
/** Key vault name of the object that triggered this event. */
vaultName?: string;
/** The type of the object that triggered this event */
objectType?: string;
/** The name of the object that triggered this event */
objectName?: string;
/** The version of the object that triggered this event */
version?: string;
/** Not before date of the object that triggered this event */
nbf?: number;
/** The expiration date of the object that triggered this event */
exp?: number;
}
/** Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretExpired event. */
export interface KeyVaultSecretExpiredEventData {
/** The id of the object that triggered this event. */
id?: string;
/** Key vault name of the object that triggered this event. */
vaultName?: string;
/** The type of the object that triggered this event */
objectType?: string;
/** The name of the object that triggered this event */
objectName?: string;
/** The version of the object that triggered this event */
version?: string;
/** Not before date of the object that triggered this event */
nbf?: number;
/** The expiration date of the object that triggered this event */
exp?: number;
}
//# sourceMappingURL=models.d.ts.map