Event Subscriptions - Create Or Update

Créez ou mettez à jour un abonnement aux événements.
Crée de façon asynchrone un abonnement aux événements ou met à jour un abonnement à un événement existant en fonction de l’étendue spécifiée.

PUT https://management.azure.com/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}?api-version=2022-06-15

Paramètres URI

Name In Required Type Description
eventSubscriptionName
path True
  • string

Nom de l’abonnement aux événements. Les noms d’abonnement aux événements doivent être compris entre 3 et 64 caractères et doivent utiliser uniquement des lettres alphanumériques.

scope
path True
  • string

Identificateur de la ressource à laquelle l’abonnement aux événements doit être créé ou mis à jour. L’étendue peut être un abonnement, un groupe de ressources ou une ressource de niveau supérieur appartenant à un espace de noms de fournisseur de ressources ou une rubrique EventGrid. Par exemple, utilisez « /subscriptions/{subscriptionId} / » pour un abonnement, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName} » pour un groupe de ressources, et « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} » pour une ressource et « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName} » pour une rubrique EventGrid.

api-version
query True
  • string

Version de l’API à utiliser avec la demande du client.

Corps de la demande

Name Type Description
properties.deadLetterDestination DeadLetterDestination:

Destination de lettres mortes de l’abonnement aux événements. Tout événement qui ne peut pas être remis à sa destination est envoyé à la destination de la lettre morte. Utilise l’identité de Azure Event Grid pour acquérir les jetons d’authentification utilisés lors de la remise/ de la lettre morte.

properties.deadLetterWithResourceIdentity

Destination de lettres mortes de l’abonnement aux événements. Tout événement qui ne peut pas être remis à sa destination est envoyé à la destination de la lettre morte. Utilise la configuration de l’identité managée sur la ressource parente (à savoir, rubrique ou domaine) pour acquérir les jetons d’authentification utilisés lors de la remise/ de la lettre morte.

properties.deliveryWithResourceIdentity

Informations sur la destination où les événements doivent être remis pour l’abonnement aux événements. Utilise la configuration de l’identité managée sur la ressource parente (à savoir, rubrique ou domaine) pour acquérir les jetons d’authentification utilisés lors de la remise/ de la lettre morte.

properties.destination EventSubscriptionDestination:

Informations sur la destination où les événements doivent être remis pour l’abonnement aux événements. Utilise l’identité de Azure Event Grid pour acquérir les jetons d’authentification utilisés lors de la remise/ de la lettre morte.

properties.eventDeliverySchema

Schéma de remise d’événements pour l’abonnement aux événements.

properties.expirationTimeUtc
  • string

Délai d’expiration de l’abonnement aux événements.

properties.filter

Informations sur le filtre de l’abonnement aux événements.

properties.labels
  • string[]

Liste des étiquettes définies par l’utilisateur.

properties.retryPolicy

Stratégie de nouvelle tentative pour les événements. Cela peut être utilisé pour configurer le nombre maximal de tentatives de remise et la durée de vie des événements.

Réponses

Name Type Description
201 Created

Demande CreateOrUpdate EventSubscription acceptée.

Other Status Codes

Réponses d’erreur : ***

  • 400 Demande incorrecte.

  • 500 Erreur interne du serveur.

Exemples

EventSubscriptions_CreateOrUpdateForCustomTopic
EventSubscriptions_CreateOrUpdateForCustomTopic_AzureFunctionDestination
EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination
EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination
EventSubscriptions_CreateOrUpdateForCustomTopic_ServiceBusQueueDestination
EventSubscriptions_CreateOrUpdateForCustomTopic_ServiceBusTopicDestination
EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination
EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination
EventSubscriptions_CreateOrUpdateForResource
EventSubscriptions_CreateOrUpdateForResourceGroup
EventSubscriptions_CreateOrUpdateForSubscription

EventSubscriptions_CreateOrUpdateForCustomTopic

Sample Request

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "EventHub",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    }
  }
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic1"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForCustomTopic_AzureFunctionDestination

Sample Request

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "AzureFunction",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Web/sites/ContosoSite/funtions/ContosoFunc"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  }
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Web/sites/ContosoSite/funtions/ContosoFunc"
      },
      "endpointType": "AzureFunction"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
    "provisioningState": "Creating",
    "labels": null,
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination

Sample Request

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "EventHub",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  }
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
      },
      "endpointType": "EventHub"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
    "provisioningState": "Creating",
    "labels": null,
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination

Sample Request

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "HybridConnection",
      "properties": {
        "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Relay/namespaces/ContosoNamespace/hybridConnections/HC1"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  }
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Relay/namespaces/ContosoNamespace/hybridConnections/HC1"
      },
      "endpointType": "HybridConnection"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
    "provisioningState": "Creating",
    "labels": null,
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForCustomTopic_ServiceBusQueueDestination

Sample Request

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "ServiceBusQueue",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/queues/SBQ"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  }
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/queues/SBQ"
      },
      "endpointType": "ServiceBusQueue"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
    "provisioningState": "Creating",
    "labels": null,
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForCustomTopic_ServiceBusTopicDestination

Sample Request

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "ServiceBusTopic",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/topics/SBT"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  }
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/topics/SBT"
      },
      "endpointType": "ServiceBusTopic"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
    "provisioningState": "Creating",
    "labels": null,
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination

Sample Request

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "StorageQueue",
      "properties": {
        "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "queueName": "queue1"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  }
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "queueName": "queue1"
      },
      "endpointType": "StorageQueue"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
    "provisioningState": "Creating",
    "labels": null,
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination

Sample Request

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "WebHook",
      "properties": {
        "endpointUrl": "https://azurefunctionexample.azurewebsites.net/runtime/webhooks/EventGrid?functionName=EventGridTrigger1&code=PASSWORDCODE"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    }
  }
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://azurefunctionexample.azurewebsites.net/runtime/webhooks/EventGrid"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic1"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForResource

Sample Request

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "WebHook",
      "properties": {
        "endpointUrl": "https://requestb.in/15ksip71"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    }
  }
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10",
  "name": "examplesubscription10",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForResourceGroup

Sample Request

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "WebHook",
      "properties": {
        "endpointUrl": "https://requestb.in/15ksip71"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    }
  }
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2",
  "name": "examplesubscription2",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForSubscription

Sample Request

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "WebHook",
      "properties": {
        "endpointUrl": "https://requestb.in/15ksip71"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false
    }
  }
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "",
      "subjectEndsWith": ""
    },
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3",
  "name": "examplesubscription3",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

Définitions

AzureFunctionEventSubscriptionDestination

Informations sur la destination de fonction Azure pour un abonnement aux événements.

BoolEqualsAdvancedFilter

Filtre avancé BoolEquals.

createdByType

Type d’identité qui a créé la ressource.

DeadLetterWithResourceIdentity

Informations sur la destination deadletter avec l’identité de ressource.

DeliveryWithResourceIdentity

Informations sur la remise d’un abonnement aux événements avec l’identité de ressource.

DynamicDeliveryAttributeMapping

Détails du mappage des attributs de remise dynamique.

EventDeliverySchema

Schéma de remise d’événements pour l’abonnement aux événements.

EventHubEventSubscriptionDestination

Informations sur la destination du hub d’événements pour un abonnement aux événements.

EventSubscription

Abonnement à un événement

EventSubscriptionFilter

Filtrez l’abonnement aux événements.

EventSubscriptionIdentity

Informations d’identité avec l’abonnement à l’événement.

EventSubscriptionIdentityType

Type d’identité managée utilisée. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toute identité.

EventSubscriptionProvisioningState

État d’approvisionnement de l’abonnement aux événements.

HybridConnectionEventSubscriptionDestination

Informations sur la destination HybridConnection pour un abonnement aux événements.

IsNotNullAdvancedFilter

Filtre avancé IsNotNull.

IsNullOrUndefinedAdvancedFilter

Filtre avancé IsNullOrUndefined.

NumberGreaterThanAdvancedFilter

Filtre avancé NumberGreaterThan.

NumberGreaterThanOrEqualsAdvancedFilter

Filtre avancé NumberGreaterThanOrEquals.

NumberInAdvancedFilter

Filtre avancé NumberIn.

NumberInRangeAdvancedFilter

Filtre avancé NumberInRange.

NumberLessThanAdvancedFilter

Filtre avancé NumberLessThan.

NumberLessThanOrEqualsAdvancedFilter

Filtre avancé NumberLessThanOrEquals.

NumberNotInAdvancedFilter

Filtre avancé NumberNotIn.

NumberNotInRangeAdvancedFilter

Filtre avancé NumberNotInRange.

RetryPolicy

Informations sur la stratégie de nouvelle tentative pour un abonnement aux événements.

ServiceBusQueueEventSubscriptionDestination

Informations sur la destination service bus pour un abonnement aux événements.

ServiceBusTopicEventSubscriptionDestination

Informations sur la destination de la rubrique Service Bus pour un abonnement aux événements.

StaticDeliveryAttributeMapping

Détails du mappage d’attribut de remise statique.

StorageBlobDeadLetterDestination

Informations sur la destination de lettre morte basée sur l’objet blob de stockage.

StorageQueueEventSubscriptionDestination

Informations sur la destination de file d’attente de stockage pour un abonnement aux événements.

StringBeginsWithAdvancedFilter

StringBeginsWith Advanced Filter.

StringContainsAdvancedFilter

Filtre avancé StringContains.

StringEndsWithAdvancedFilter

StringEndsWith Advanced Filter.

StringInAdvancedFilter

Filtre avancé StringIn.

StringNotBeginsWithAdvancedFilter

StringNotBeginsWith Advanced Filter.

StringNotContainsAdvancedFilter

Filtre avancé StringNotContains.

StringNotEndsWithAdvancedFilter

StringNotEndsWith Advanced Filter.

StringNotInAdvancedFilter

Filtre avancé StringNotIn.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

WebHookEventSubscriptionDestination

Informations sur la destination du webhook pour un abonnement aux événements.

AzureFunctionEventSubscriptionDestination

Informations sur la destination de fonction Azure pour un abonnement aux événements.

Name Type Default Value Description
endpointType string:
  • AzureFunction

Type du point de terminaison de la destination de l’abonnement aux événements.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Détails de l’attribut de remise.

properties.maxEventsPerBatch
  • integer
1

Nombre maximal d’événements par lot.

properties.preferredBatchSizeInKilobytes
  • integer
64

Taille de lot préférée en Kilo-octets.

properties.resourceId
  • string

ID de ressource Azure qui représente le point de terminaison de la destination de fonction Azure d’un abonnement aux événements.

BoolEqualsAdvancedFilter

Filtre avancé BoolEquals.

Name Type Description
key
  • string

Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer.

operatorType string:
  • BoolEquals

Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres.

value
  • boolean

Valeur de filtre booléenne.

createdByType

Type d’identité qui a créé la ressource.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

DeadLetterWithResourceIdentity

Informations sur la destination deadletter avec l’identité de ressource.

Name Type Description
deadLetterDestination DeadLetterDestination:

Informations sur la destination où les événements doivent être remis pour l’abonnement aux événements. Utilise la configuration de l’identité managée sur la ressource parente (à savoir, rubrique ou domaine) pour acquérir les jetons d’authentification utilisés lors de la remise/ de la lettre morte.

identity

Identité à utiliser lors des événements de lettre morte.

DeliveryWithResourceIdentity

Informations sur la remise d’un abonnement aux événements avec l’identité de ressource.

Name Type Description
destination EventSubscriptionDestination:

Informations sur la destination où les événements doivent être remis pour l’abonnement aux événements. Utilise l’identité de Azure Event Grid pour acquérir les jetons d’authentification utilisés lors de la remise/ de la lettre morte.

identity

Identité à utiliser lors de la remise d’événements.

DynamicDeliveryAttributeMapping

Détails du mappage des attributs de remise dynamique.

Name Type Description
name
  • string

Nom de l’attribut ou de l’en-tête de remise.

properties.sourceField
  • string

Chemin JSON dans l’événement qui contient la valeur d’attribut.

type string:
  • Dynamic

Type de l’attribut de remise ou du nom de l’en-tête.

EventDeliverySchema

Schéma de remise d’événements pour l’abonnement aux événements.

Name Type Description
CloudEventSchemaV1_0
  • string
CustomInputSchema
  • string
EventGridSchema
  • string

EventHubEventSubscriptionDestination

Informations sur la destination du hub d’événements pour un abonnement aux événements.

Name Type Description
endpointType string:
  • EventHub

Type du point de terminaison de la destination de l’abonnement aux événements.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Détails de l’attribut de remise.

properties.resourceId
  • string

ID de ressource Azure qui représente le point de terminaison d’une destination Event Hub d’un abonnement aux événements.

EventSubscription

Abonnement à un événement

Name Type Default Value Description
id
  • string

Identificateur complet de la ressource.

name
  • string

Nom de la ressource.

properties.deadLetterDestination DeadLetterDestination:

Destination de la lettre morte de l’abonnement à l’événement. Tout événement qui ne peut pas être remis à sa destination est envoyé à la destination de la lettre morte. Utilise l’identité de Azure Event Grid pour acquérir les jetons d’authentification utilisés lors de la remise/ de la lettre morte.

properties.deadLetterWithResourceIdentity

Destination de la lettre morte de l’abonnement à l’événement. Tout événement qui ne peut pas être remis à sa destination est envoyé à la destination de la lettre morte. Utilise la configuration de l’identité managée sur la ressource parente (à savoir, rubrique ou domaine) pour acquérir les jetons d’authentification utilisés lors de la remise/ de la lettre morte.

properties.deliveryWithResourceIdentity

Informations sur la destination où les événements doivent être remis pour l’abonnement aux événements. Utilise la configuration de l’identité managée sur la ressource parente (à savoir, rubrique ou domaine) pour acquérir les jetons d’authentification utilisés lors de la remise/ de la lettre morte.

properties.destination EventSubscriptionDestination:

Informations sur la destination où les événements doivent être remis pour l’abonnement aux événements. Utilise l’identité de Azure Event Grid pour acquérir les jetons d’authentification utilisés lors de la remise/ de la lettre morte.

properties.eventDeliverySchema EventGridSchema

Schéma de remise d’événements pour l’abonnement aux événements.

properties.expirationTimeUtc
  • string

Heure d’expiration de l’abonnement à l’événement.

properties.filter

Informations sur le filtre de l’abonnement aux événements.

properties.labels
  • string[]

Liste des étiquettes définies par l’utilisateur.

properties.provisioningState

État d’approvisionnement de l’abonnement aux événements.

properties.retryPolicy

Stratégie de nouvelle tentative pour les événements. Cela peut être utilisé pour configurer le nombre maximal de tentatives de remise et de temps à vivre pour les événements.

properties.topic
  • string

Nom de la rubrique de l’abonnement à l’événement.

systemData

Métadonnées système relatives à la ressource d’abonnement aux événements.

type
  • string

Type de la ressource.

EventSubscriptionFilter

Filtrez l’abonnement aux événements.

Name Type Default Value Description
advancedFilters AdvancedFilter[]:

Tableau de filtres avancés utilisés pour filtrer les abonnements aux événements.

enableAdvancedFilteringOnArrays
  • boolean

Permet aux filtres avancés d’être évalués par rapport à un tableau de valeurs au lieu d’attendre une valeur singulière.

includedEventTypes
  • string[]

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 par défaut, définissez les IncludedEventTypes sur Null.

isSubjectCaseSensitive
  • boolean
False

Spécifie si les propriétés SubjectBeginsWith et SubjectEndsWith du filtre doivent être comparées de manière sensible à la casse.

subjectBeginsWith
  • string

Chaîne facultative pour 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 cette opération dépend de l’éditeur des événements. Les caractères génériques ne sont pas pris en charge dans ce chemin.

subjectEndsWith
  • string

Chaîne facultative pour 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.

EventSubscriptionIdentity

Informations d’identité avec l’abonnement à l’événement.

Name Type Description
type

Type d’identité managée utilisée. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toute identité.

userAssignedIdentity
  • string

Identité utilisateur associée à la ressource.

EventSubscriptionIdentityType

Type d’identité managée utilisée. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toute identité.

Name Type Description
SystemAssigned
  • string
UserAssigned
  • string

EventSubscriptionProvisioningState

État d’approvisionnement de l’abonnement aux événements.

Name Type Description
AwaitingManualAction
  • string
Canceled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

HybridConnectionEventSubscriptionDestination

Informations sur la destination HybridConnection pour un abonnement aux événements.

Name Type Description
endpointType string:
  • HybridConnection

Type du point de terminaison de la destination de l’abonnement aux événements.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Détails de l’attribut de remise.

properties.resourceId
  • string

ID de ressource Azure d’une connexion hybride qui est la destination d’un abonnement aux événements.

IsNotNullAdvancedFilter

Filtre avancé IsNotNull.

Name Type Description
key
  • string

Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer.

operatorType string:
  • IsNotNull

Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres.

IsNullOrUndefinedAdvancedFilter

Filtre avancé IsNullOrUndefined.

Name Type Description
key
  • string

Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer.

operatorType string:
  • IsNullOrUndefined

Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres.

NumberGreaterThanAdvancedFilter

Filtre avancé NumberGreaterThan.

Name Type Description
key
  • string

Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer.

operatorType string:
  • NumberGreaterThan

Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres.

value
  • number

Valeur de filtre.

NumberGreaterThanOrEqualsAdvancedFilter

Filtre avancé NumberGreaterThanOrEquals.

Name Type Description
key
  • string

Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer.

operatorType string:
  • NumberGreaterThanOrEquals

Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres.

value
  • number

Valeur de filtre.

NumberInAdvancedFilter

Filtre avancé NumberIn.

Name Type Description
key
  • string

Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer.

operatorType string:
  • NumberIn

Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres.

values
  • number[]

Ensemble de valeurs de filtre.

NumberInRangeAdvancedFilter

Filtre avancé NumberInRange.

Name Type Description
key
  • string

Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer.

operatorType string:
  • NumberInRange

Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres.

values
  • array[]

Ensemble de valeurs de filtre.

NumberLessThanAdvancedFilter

Filtre avancé NumberLessThan.

Name Type Description
key
  • string

Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer.

operatorType string:
  • NumberLessThan

Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres.

value
  • number

Valeur de filtre.

NumberLessThanOrEqualsAdvancedFilter

Filtre avancé NumberLessThanOrEquals.

Name Type Description
key
  • string

Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer.

operatorType string:
  • NumberLessThanOrEquals

Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres.

value
  • number

Valeur de filtre.

NumberNotInAdvancedFilter

Filtre avancé NumberNotIn.

Name Type Description
key
  • string

Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer.

operatorType string:
  • NumberNotIn

Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres.

values
  • number[]

Ensemble de valeurs de filtre.

NumberNotInRangeAdvancedFilter

Filtre avancé NumberNotInRange.

Name Type Description
key
  • string

Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer.

operatorType string:
  • NumberNotInRange

Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres.

values
  • array[]

Ensemble de valeurs de filtre.

RetryPolicy

Informations sur la stratégie de nouvelle tentative pour un abonnement aux événements.

Name Type Default Value Description
eventTimeToLiveInMinutes
  • integer
1440

Durée de vie (en minutes) pour les événements.

maxDeliveryAttempts
  • integer
30

Nombre maximal de tentatives de remise pour les événements.

ServiceBusQueueEventSubscriptionDestination

Informations sur la destination service bus pour un abonnement aux événements.

Name Type Description
endpointType string:
  • ServiceBusQueue

Type du point de terminaison de la destination de l’abonnement aux événements.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Détails de l’attribut de remise.

properties.resourceId
  • string

ID de ressource Azure qui représente le point de terminaison de la destination Service Bus d’un abonnement aux événements.

ServiceBusTopicEventSubscriptionDestination

Informations sur la destination de la rubrique Service Bus pour un abonnement aux événements.

Name Type Description
endpointType string:
  • ServiceBusTopic

Type du point de terminaison de la destination de l’abonnement aux événements.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Détails de l’attribut de remise.

properties.resourceId
  • string

ID de ressource Azure qui représente le point de terminaison de la destination de rubrique Service Bus d’un abonnement aux événements.

StaticDeliveryAttributeMapping

Détails du mappage d’attribut de remise statique.

Name Type Default Value Description
name
  • string

Nom de l’attribut ou de l’en-tête de remise.

properties.isSecret
  • boolean
False

Indicateur booléen pour indiquer si l’attribut contient des informations sensibles.

properties.value
  • string

Valeur de l’attribut de remise.

type string:
  • Static

Type de l’attribut de remise ou du nom de l’en-tête.

StorageBlobDeadLetterDestination

Informations sur la destination de lettre morte basée sur l’objet blob de stockage.

Name Type Description
endpointType string:
  • StorageBlob

Type du point de terminaison pour la destination de lettre morte

properties.blobContainerName
  • string

Nom du conteneur d’objets blob de stockage qui est la destination des événements deadletter

properties.resourceId
  • string

ID de ressource Azure du compte de stockage qui est la destination des événements deadletter

StorageQueueEventSubscriptionDestination

Informations sur la destination de file d’attente de stockage pour un abonnement aux événements.

Name Type Description
endpointType string:
  • StorageQueue

Type du point de terminaison de la destination de l’abonnement aux événements.

properties.queueMessageTimeToLiveInSeconds
  • integer

Temps de message de file d’attente de stockage à vivre en secondes.

properties.queueName
  • string

Nom de la file d’attente de stockage sous un compte de stockage qui est la destination d’un abonnement aux événements.

properties.resourceId
  • string

ID de ressource Azure du compte de stockage qui contient la file d’attente qui est la destination d’un abonnement aux événements.

StringBeginsWithAdvancedFilter

StringBeginsWith Advanced Filter.

Name Type Description
key
  • string

Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer.

operatorType string:
  • StringBeginsWith

Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres.

values
  • string[]

Ensemble de valeurs de filtre.

StringContainsAdvancedFilter

Filtre avancé StringContains.

Name Type Description
key
  • string

Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer.

operatorType string:
  • StringContains

Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres.

values
  • string[]

Ensemble de valeurs de filtre.

StringEndsWithAdvancedFilter

StringEndsWith Advanced Filter.

Name Type Description
key
  • string

Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer.

operatorType string:
  • StringEndsWith

Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres.

values
  • string[]

Ensemble de valeurs de filtre.

StringInAdvancedFilter

Filtre avancé StringIn.

Name Type Description
key
  • string

Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer.

operatorType string:
  • StringIn

Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres.

values
  • string[]

Ensemble de valeurs de filtre.

StringNotBeginsWithAdvancedFilter

StringNotBeginsWith Advanced Filter.

Name Type Description
key
  • string

Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer.

operatorType string:
  • StringNotBeginsWith

Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres.

values
  • string[]

Ensemble de valeurs de filtre.

StringNotContainsAdvancedFilter

Filtre avancé StringNotContains.

Name Type Description
key
  • string

Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer.

operatorType string:
  • StringNotContains

Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres.

values
  • string[]

Ensemble de valeurs de filtre.

StringNotEndsWithAdvancedFilter

StringNotEndsWith Advanced Filter.

Name Type Description
key
  • string

Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer.

operatorType string:
  • StringNotEndsWith

Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres.

values
  • string[]

Ensemble de valeurs de filtre.

StringNotInAdvancedFilter

Filtre avancé StringNotIn.

Name Type Description
key
  • string

Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer.

operatorType string:
  • StringNotIn

Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres.

values
  • string[]

Ensemble de valeurs de filtre.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Name Type Description
createdAt
  • string

Horodatage de la création de ressources (UTC).

createdBy
  • string

Identité qui a créé la ressource.

createdByType

Type d’identité qui a créé la ressource.

lastModifiedAt
  • string

Horodatage de la dernière modification de ressource (UTC)

lastModifiedBy
  • string

Identité qui a modifié la ressource pour la dernière fois.

lastModifiedByType

Type d’identité qui a modifié la ressource pour la dernière fois.

WebHookEventSubscriptionDestination

Informations sur la destination du webhook pour un abonnement aux événements.

Name Type Default Value Description
endpointType string:
  • WebHook

Type du point de terminaison de la destination de l’abonnement aux événements.

properties.azureActiveDirectoryApplicationIdOrUri
  • string

ID ou URI d’application Azure Active Directory pour obtenir le jeton d’accès qui sera inclus en tant que jeton de porteur dans les demandes de remise.

properties.azureActiveDirectoryTenantId
  • string

ID de locataire Azure Active Directory pour obtenir le jeton d’accès qui sera inclus en tant que jeton de porteur dans les demandes de remise.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Détails de l’attribut de remise.

properties.endpointBaseUrl
  • string

URL de base qui représente le point de terminaison de la destination d’un abonnement aux événements.

properties.endpointUrl
  • string

URL qui représente le point de terminaison de la destination d’un abonnement aux événements.

properties.maxEventsPerBatch
  • integer
1

Nombre maximal d’événements par lot.

properties.preferredBatchSizeInKilobytes
  • integer
64

Taille de lot préférée en Kilo-octets.