Microsoft.EventGrid eventSubscriptions 2018-01-01
- dernière
- 2024-12-15-preview
- 2024-06-01-preview
- 2023-12-15-preview
- 2023-06-01-preview
- 2022-06-15
- 2021-12-01
- 2021-10-15-preview
- 2021-06-01-preview
- 2020-10-15-preview
- 2020-06-01
- 2020-04-01-preview
- 2020-01-01-preview
- 2019-06-01
- 2019-02-01-preview
- 2019-01-01
- 2018-09-15-preview
- 2018-05-01-preview
- 2018-01-01
- 2017-09-15-preview
- 2017-06-15-preview
Définition de ressource Bicep
Le type de ressource eventSubscriptions peut être déployé avec des opérations qui ciblent :
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Format de ressource
Pour créer une ressource Microsoft.EventGrid/eventSubscriptions, ajoutez le bicep suivant à votre modèle.
resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2018-01-01' = {
scope: resourceSymbolicName or scope
name: 'string'
properties: {
destination: {
endpointType: 'string'
// For remaining properties, see EventSubscriptionDestination objects
}
filter: {
includedEventTypes: [
'string'
]
isSubjectCaseSensitive: bool
subjectBeginsWith: 'string'
subjectEndsWith: 'string'
}
labels: [
'string'
]
}
}
Objets EventSubscriptionDestination
Définissez la propriété endpointType
Pour EventHub, utilisez :
{
endpointType: 'EventHub'
properties: {
resourceId: 'string'
}
}
Pour WebHook, utilisez :
{
endpointType: 'WebHook'
properties: {
endpointUrl: 'string'
}
}
Valeurs de propriété
EventHubEventSubscriptionDestination
| Nom | Description | Valeur |
|---|---|---|
| endpointType | Type du point de terminaison pour la destination de l’abonnement aux événements | 'EventHub' (obligatoire) |
| Propriétés | Propriétés event Hub de la destination de l’abonnement aux événements | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| Nom | Description | Valeur |
|---|---|---|
| resourceId | ID de ressource Azure qui représente le point de terminaison d’une destination Event Hub d’un abonnement aux événements. | corde |
EventSubscriptionDestination
| Nom | Description | Valeur |
|---|---|---|
| endpointType | Défini sur « EventHub » pour le type EventHubEventSubscriptionDestination. Défini sur « WebHook » pour le type WebHookEventSubscriptionDestination. | 'EventHub' 'WebHook' (obligatoire) |
EventSubscriptionFilter
| Nom | Description | Valeur |
|---|---|---|
| includedEventTypes | Liste des types d’événements applicables qui doivent faire partie de l’abonnement aux événements. S’il est souhaité s’abonner à tous les types d’événements, la chaîne « all » doit être spécifiée en tant qu’élément de cette liste. |
string[] |
| isSubjectCaseSensitive | Spécifie si les propriétés SubjectBeginsWith et SubjectEndsWith du filtre doit être comparé de manière sensible à la casse. |
Bool |
| subjectBeginsWith | Chaîne facultative permettant de filtrer les événements d’un abonnement aux événements en fonction d’un préfixe de chemin d’accès aux ressources. Le format de ce paramètre dépend de l’éditeur des événements. Les caractères génériques ne sont pas pris en charge dans ce chemin d’accès. |
corde |
| subjectEndsWith | Chaîne facultative permettant de filtrer les événements d’un abonnement aux événements en fonction d’un suffixe de chemin d’accès aux ressources. Les caractères génériques ne sont pas pris en charge dans ce chemin d’accès. |
corde |
EventSubscriptionProperties
| Nom | Description | Valeur |
|---|---|---|
| destination | Informations sur la destination où les événements doivent être remis pour l’abonnement aux événements. | EventSubscriptionDestination |
| filtre | Informations sur le filtre de l’abonnement aux événements. | EventSubscriptionFilter |
| Étiquettes | Liste des étiquettes définies par l’utilisateur. | string[] |
Microsoft.EventGrid/eventSubscriptions
| Nom | Description | Valeur |
|---|---|---|
| nom | Nom de la ressource | chaîne (obligatoire) |
| Propriétés | Propriétés de l’abonnement aux événements | EventSubscriptionProperties |
| portée | Utilisez-la lors de la création d’une ressource dans une étendue différente de l’étendue de déploiement. | Définissez cette propriété sur le nom symbolique d’une ressource pour appliquer la ressource d’extension . |
WebHookEventSubscriptionDestination
| Nom | Description | Valeur |
|---|---|---|
| endpointType | Type du point de terminaison pour la destination de l’abonnement aux événements | 'WebHook' (obligatoire) |
| Propriétés | Propriétés webHook de la destination de l’abonnement aux événements | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Nom | Description | Valeur |
|---|---|---|
| endpointUrl | URL qui représente le point de terminaison de la destination d’un abonnement à un événement. | corde |
Exemples de démarrage rapide
Les exemples de démarrage rapide suivants déploient ce type de ressource.
| Fichier Bicep | Description |
|---|---|
| créer une rubrique personnalisée Azure Event Grid et un abonnement file d’attente | Crée une rubrique personnalisée Azure Event Grid et un abonnement de file d’attente Service Bus. Modèle créé à l’origine par Markus Meyer. |
| Créer une rubrique personnalisée Azure Event Grid et un d’abonnement | Crée une rubrique personnalisée Azure Event Grid et un abonnement webhook. Modèle créé à l’origine par John Downs. |
Définition de ressource de modèle ARM
Le type de ressource eventSubscriptions peut être déployé avec des opérations qui ciblent :
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Format de ressource
Pour créer une ressource Microsoft.EventGrid/eventSubscriptions, ajoutez le code JSON suivant à votre modèle.
{
"type": "Microsoft.EventGrid/eventSubscriptions",
"apiVersion": "2018-01-01",
"name": "string",
"properties": {
"destination": {
"endpointType": "string"
// For remaining properties, see EventSubscriptionDestination objects
},
"filter": {
"includedEventTypes": [ "string" ],
"isSubjectCaseSensitive": "bool",
"subjectBeginsWith": "string",
"subjectEndsWith": "string"
},
"labels": [ "string" ]
}
}
Objets EventSubscriptionDestination
Définissez la propriété endpointType
Pour EventHub, utilisez :
{
"endpointType": "EventHub",
"properties": {
"resourceId": "string"
}
}
Pour WebHook, utilisez :
{
"endpointType": "WebHook",
"properties": {
"endpointUrl": "string"
}
}
Valeurs de propriété
EventHubEventSubscriptionDestination
| Nom | Description | Valeur |
|---|---|---|
| endpointType | Type du point de terminaison pour la destination de l’abonnement aux événements | 'EventHub' (obligatoire) |
| Propriétés | Propriétés event Hub de la destination de l’abonnement aux événements | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| Nom | Description | Valeur |
|---|---|---|
| resourceId | ID de ressource Azure qui représente le point de terminaison d’une destination Event Hub d’un abonnement aux événements. | corde |
EventSubscriptionDestination
| Nom | Description | Valeur |
|---|---|---|
| endpointType | Défini sur « EventHub » pour le type EventHubEventSubscriptionDestination. Défini sur « WebHook » pour le type WebHookEventSubscriptionDestination. | 'EventHub' 'WebHook' (obligatoire) |
EventSubscriptionFilter
| Nom | Description | Valeur |
|---|---|---|
| includedEventTypes | Liste des types d’événements applicables qui doivent faire partie de l’abonnement aux événements. S’il est souhaité s’abonner à tous les types d’événements, la chaîne « all » doit être spécifiée en tant qu’élément de cette liste. |
string[] |
| isSubjectCaseSensitive | Spécifie si les propriétés SubjectBeginsWith et SubjectEndsWith du filtre doit être comparé de manière sensible à la casse. |
Bool |
| subjectBeginsWith | Chaîne facultative permettant de filtrer les événements d’un abonnement aux événements en fonction d’un préfixe de chemin d’accès aux ressources. Le format de ce paramètre dépend de l’éditeur des événements. Les caractères génériques ne sont pas pris en charge dans ce chemin d’accès. |
corde |
| subjectEndsWith | Chaîne facultative permettant de filtrer les événements d’un abonnement aux événements en fonction d’un suffixe de chemin d’accès aux ressources. Les caractères génériques ne sont pas pris en charge dans ce chemin d’accès. |
corde |
EventSubscriptionProperties
| Nom | Description | Valeur |
|---|---|---|
| destination | Informations sur la destination où les événements doivent être remis pour l’abonnement aux événements. | EventSubscriptionDestination |
| filtre | Informations sur le filtre de l’abonnement aux événements. | EventSubscriptionFilter |
| Étiquettes | Liste des étiquettes définies par l’utilisateur. | string[] |
Microsoft.EventGrid/eventSubscriptions
| Nom | Description | Valeur |
|---|---|---|
| apiVersion | Version de l’API | '2018-01-01' |
| nom | Nom de la ressource | chaîne (obligatoire) |
| Propriétés | Propriétés de l’abonnement aux événements | EventSubscriptionProperties |
| type | Type de ressource | 'Microsoft.EventGrid/eventSubscriptions' |
WebHookEventSubscriptionDestination
| Nom | Description | Valeur |
|---|---|---|
| endpointType | Type du point de terminaison pour la destination de l’abonnement aux événements | 'WebHook' (obligatoire) |
| Propriétés | Propriétés webHook de la destination de l’abonnement aux événements | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Nom | Description | Valeur |
|---|---|---|
| endpointUrl | URL qui représente le point de terminaison de la destination d’un abonnement à un événement. | corde |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
créer une rubrique personnalisée Azure Event Grid et un abonnement file d’attente
|
Crée une rubrique personnalisée Azure Event Grid et un abonnement de file d’attente Service Bus. Modèle créé à l’origine par Markus Meyer. |
|
Créer une rubrique personnalisée Azure Event Grid et un d’abonnement
|
Crée une rubrique personnalisée Azure Event Grid et un abonnement webhook. Modèle créé à l’origine par John Downs. |
|
créer un abonnement à une rubrique personnalisée Azure Event Grid
|
Crée une rubrique personnalisée Azure Event Grid et un abonnement à une rubrique Service Bus. Modèle créé à l’origine par Markus Meyer. |
|
créer une rubrique personnalisée Event Grid et un gestionnaire event hub
|
Crée une rubrique personnalisée Azure Event Grid et un hub d’événements pour gérer les événements. |
|
Créer un abonnement Event Grid pour les événements de ressources
|
Crée un abonnement Event Grid à un groupe de ressources ou à un abonnement Azure. |
|
rubrique/abonnement Azure Event Grid personnalisé avec CloudEvents
|
Crée une rubrique Azure Event Grid personnalisée, un abonnement webhook ayant le schéma CloudEvents et une application logique en tant que gestionnaire d’événements. Modèle créé à l’origine par Justin Yoo. |
Définition de ressource Terraform (fournisseur AzAPI)
Le type de ressource eventSubscriptions peut être déployé avec des opérations qui ciblent :
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Format de ressource
Pour créer une ressource Microsoft.EventGrid/eventSubscriptions, ajoutez le terraform suivant à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/eventSubscriptions@2018-01-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
destination = {
endpointType = "string"
// For remaining properties, see EventSubscriptionDestination objects
}
filter = {
includedEventTypes = [
"string"
]
isSubjectCaseSensitive = bool
subjectBeginsWith = "string"
subjectEndsWith = "string"
}
labels = [
"string"
]
}
})
}
Objets EventSubscriptionDestination
Définissez la propriété endpointType
Pour EventHub, utilisez :
{
endpointType = "EventHub"
properties = {
resourceId = "string"
}
}
Pour WebHook, utilisez :
{
endpointType = "WebHook"
properties = {
endpointUrl = "string"
}
}
Valeurs de propriété
EventHubEventSubscriptionDestination
| Nom | Description | Valeur |
|---|---|---|
| endpointType | Type du point de terminaison pour la destination de l’abonnement aux événements | 'EventHub' (obligatoire) |
| Propriétés | Propriétés event Hub de la destination de l’abonnement aux événements | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| Nom | Description | Valeur |
|---|---|---|
| resourceId | ID de ressource Azure qui représente le point de terminaison d’une destination Event Hub d’un abonnement aux événements. | corde |
EventSubscriptionDestination
| Nom | Description | Valeur |
|---|---|---|
| endpointType | Défini sur « EventHub » pour le type EventHubEventSubscriptionDestination. Défini sur « WebHook » pour le type WebHookEventSubscriptionDestination. | 'EventHub' 'WebHook' (obligatoire) |
EventSubscriptionFilter
| Nom | Description | Valeur |
|---|---|---|
| includedEventTypes | Liste des types d’événements applicables qui doivent faire partie de l’abonnement aux événements. S’il est souhaité s’abonner à tous les types d’événements, la chaîne « all » doit être spécifiée en tant qu’élément de cette liste. |
string[] |
| isSubjectCaseSensitive | Spécifie si les propriétés SubjectBeginsWith et SubjectEndsWith du filtre doit être comparé de manière sensible à la casse. |
Bool |
| subjectBeginsWith | Chaîne facultative permettant de filtrer les événements d’un abonnement aux événements en fonction d’un préfixe de chemin d’accès aux ressources. Le format de ce paramètre dépend de l’éditeur des événements. Les caractères génériques ne sont pas pris en charge dans ce chemin d’accès. |
corde |
| subjectEndsWith | Chaîne facultative permettant de filtrer les événements d’un abonnement aux événements en fonction d’un suffixe de chemin d’accès aux ressources. Les caractères génériques ne sont pas pris en charge dans ce chemin d’accès. |
corde |
EventSubscriptionProperties
| Nom | Description | Valeur |
|---|---|---|
| destination | Informations sur la destination où les événements doivent être remis pour l’abonnement aux événements. | EventSubscriptionDestination |
| filtre | Informations sur le filtre de l’abonnement aux événements. | EventSubscriptionFilter |
| Étiquettes | Liste des étiquettes définies par l’utilisateur. | string[] |
Microsoft.EventGrid/eventSubscriptions
| Nom | Description | Valeur |
|---|---|---|
| nom | Nom de la ressource | chaîne (obligatoire) |
| parent_id | ID de la ressource à laquelle appliquer cette ressource d’extension. | chaîne (obligatoire) |
| Propriétés | Propriétés de l’abonnement aux événements | EventSubscriptionProperties |
| type | Type de ressource | « Microsoft.EventGrid/eventSubscriptions@2018-01-01 » |
WebHookEventSubscriptionDestination
| Nom | Description | Valeur |
|---|---|---|
| endpointType | Type du point de terminaison pour la destination de l’abonnement aux événements | 'WebHook' (obligatoire) |
| Propriétés | Propriétés webHook de la destination de l’abonnement aux événements | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Nom | Description | Valeur |
|---|---|---|
| endpointUrl | URL qui représente le point de terminaison de la destination d’un abonnement à un événement. | corde |