Microsoft.EventGrid eventSubscriptions 2017-09-15-preview
- neueste
- 2024-12-15-Vorschau-
- 2024-06-01-Preview-
- 2023-12-15-Vorschau-
- 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-
Bicep-Ressourcendefinition
Der Ressourcentyp "eventSubscriptions" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.EventGrid/eventSubscriptions-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.
resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2017-09-15-preview' = {
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'
]
}
}
EventSubscriptionDestination-Objekte
Legen Sie den endpointType--Eigenschaft fest, um den Objekttyp anzugeben.
Verwenden Sie für EventHub-:
{
endpointType: 'EventHub'
properties: {
resourceId: 'string'
}
}
Verwenden Sie für WebHook-:
{
endpointType: 'WebHook'
properties: {
endpointUrl: 'string'
}
}
Eigenschaftswerte
EventHubEventSubscriptionDestination
Name | Beschreibung | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel | 'EventHub' (erforderlich) |
Eigenschaften | Event Hub-Eigenschaften des Ereignisabonnementziels | EventHubEventSubscriptionDestinationProperties- |
EventHubEventSubscriptionDestinationProperties
Name | Beschreibung | Wert |
---|---|---|
resourceId | Die Azure-Ressourcen-ID, die den Endpunkt eines Event Hub-Ziels eines Ereignisabonnements darstellt. | Schnur |
EventSubscriptionDestination
Name | Beschreibung | Wert |
---|---|---|
endpointType | Set to 'EventHub' for type EventHubEventSubscriptionDestination. Legen Sie für den Typ WebHookEventSubscriptionDestinationauf 'WebHook' fest. | 'EventHub' 'WebHook' (erforderlich) |
EventSubscriptionFilter
Name | Beschreibung | Wert |
---|---|---|
includedEventTypes | Eine Liste der anwendbaren Ereignistypen, die Teil des Ereignisabonnements sein müssen. Wenn alle Ereignistypen abonniert werden sollen, muss die Zeichenfolge "all" als Element in dieser Liste angegeben werden. |
string[] |
isSubjectCaseSensitive | Gibt an, ob die Eigenschaften SubjectBeginsWith und SubjectEndsWith des Filters sollte auf die Groß-/Kleinschreibung unterschieden werden. |
Bool |
subjectBeginsWith | Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Ressourcenpfadpräfix. Das Format dieser Ereignisse hängt vom Herausgeber der Ereignisse ab. In diesem Pfad werden keine Wildcardzeichen unterstützt. |
Schnur |
subjectEndsWith | Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Ressourcenpfadsuffix. In diesem Pfad werden keine Wildcardzeichen unterstützt. |
Schnur |
EventSubscriptionProperties
Name | Beschreibung | Wert |
---|---|---|
Bestimmungsort | Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. | EventSubscriptionDestination |
Filter | Informationen zum Filter für das Ereignisabonnement. | EventSubscriptionFilter- |
etiketten | Liste der benutzerdefinierten Bezeichnungen. | string[] |
Microsoft.EventGrid/eventSubscriptions
Name | Beschreibung | Wert |
---|---|---|
Name | Der Ressourcenname | Zeichenfolge (erforderlich) |
Eigenschaften | Eigenschaften des Ereignisabonnements | EventSubscriptionProperties |
Umfang | Verwenden Sie diese Verwendung beim Erstellen einer Ressource in einem Bereich, der sich von dem Bereitstellungsbereich unterscheidet. | Legen Sie diese Eigenschaft auf den symbolischen Namen einer Ressource fest, um die Erweiterungsressourceanzuwenden. |
WebHookEventSubscriptionDestination
Name | Beschreibung | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel | 'WebHook' (erforderlich) |
Eigenschaften | WebHook-Eigenschaften des Ereignisabonnementziels | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
Name | Beschreibung | Wert |
---|---|---|
endpointUrl | Die URL, die den Endpunkt des Ziels eines Ereignisabonnements darstellt. | Schnur |
Schnellstartbeispiele
Die folgenden Schnellstartbeispiele stellen diesen Ressourcentyp bereit.
Bicep-Datei | Beschreibung |
---|---|
Erstellen eines benutzerdefinierten Azure Event Grid-Themas und eines Warteschlangenabonnements | Erstellt ein benutzerdefiniertes Azure Event Grid-Thema und ein Servicebus-Warteschlangenabonnement. Vorlage, die ursprünglich von Markus Meyer verfasst wurde. |
Erstellen eines benutzerdefinierten Azure Event Grid-Themas und eines benutzerdefinierten Abonnement- | Erstellt ein benutzerdefiniertes Thema für Azure Event Grid und ein Webhook-Abonnement. Vorlage, die ursprünglich von John Downs verfasst wurde. |
ARM-Vorlagenressourcendefinition
Der Ressourcentyp "eventSubscriptions" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.EventGrid/eventSubscriptions-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.EventGrid/eventSubscriptions",
"apiVersion": "2017-09-15-preview",
"name": "string",
"properties": {
"destination": {
"endpointType": "string"
// For remaining properties, see EventSubscriptionDestination objects
},
"filter": {
"includedEventTypes": [ "string" ],
"isSubjectCaseSensitive": "bool",
"subjectBeginsWith": "string",
"subjectEndsWith": "string"
},
"labels": [ "string" ]
}
}
EventSubscriptionDestination-Objekte
Legen Sie den endpointType--Eigenschaft fest, um den Objekttyp anzugeben.
Verwenden Sie für EventHub-:
{
"endpointType": "EventHub",
"properties": {
"resourceId": "string"
}
}
Verwenden Sie für WebHook-:
{
"endpointType": "WebHook",
"properties": {
"endpointUrl": "string"
}
}
Eigenschaftswerte
EventHubEventSubscriptionDestination
Name | Beschreibung | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel | 'EventHub' (erforderlich) |
Eigenschaften | Event Hub-Eigenschaften des Ereignisabonnementziels | EventHubEventSubscriptionDestinationProperties- |
EventHubEventSubscriptionDestinationProperties
Name | Beschreibung | Wert |
---|---|---|
resourceId | Die Azure-Ressourcen-ID, die den Endpunkt eines Event Hub-Ziels eines Ereignisabonnements darstellt. | Schnur |
EventSubscriptionDestination
Name | Beschreibung | Wert |
---|---|---|
endpointType | Set to 'EventHub' for type EventHubEventSubscriptionDestination. Legen Sie für den Typ WebHookEventSubscriptionDestinationauf 'WebHook' fest. | 'EventHub' 'WebHook' (erforderlich) |
EventSubscriptionFilter
Name | Beschreibung | Wert |
---|---|---|
includedEventTypes | Eine Liste der anwendbaren Ereignistypen, die Teil des Ereignisabonnements sein müssen. Wenn alle Ereignistypen abonniert werden sollen, muss die Zeichenfolge "all" als Element in dieser Liste angegeben werden. |
string[] |
isSubjectCaseSensitive | Gibt an, ob die Eigenschaften SubjectBeginsWith und SubjectEndsWith des Filters sollte auf die Groß-/Kleinschreibung unterschieden werden. |
Bool |
subjectBeginsWith | Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Ressourcenpfadpräfix. Das Format dieser Ereignisse hängt vom Herausgeber der Ereignisse ab. In diesem Pfad werden keine Wildcardzeichen unterstützt. |
Schnur |
subjectEndsWith | Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Ressourcenpfadsuffix. In diesem Pfad werden keine Wildcardzeichen unterstützt. |
Schnur |
EventSubscriptionProperties
Name | Beschreibung | Wert |
---|---|---|
Bestimmungsort | Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. | EventSubscriptionDestination |
Filter | Informationen zum Filter für das Ereignisabonnement. | EventSubscriptionFilter- |
etiketten | Liste der benutzerdefinierten Bezeichnungen. | string[] |
Microsoft.EventGrid/eventSubscriptions
Name | Beschreibung | Wert |
---|---|---|
apiVersion | Die API-Version | '2017-09-15-preview' |
Name | Der Ressourcenname | Zeichenfolge (erforderlich) |
Eigenschaften | Eigenschaften des Ereignisabonnements | EventSubscriptionProperties |
Art | Der Ressourcentyp | "Microsoft.EventGrid/eventSubscriptions" |
WebHookEventSubscriptionDestination
Name | Beschreibung | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel | 'WebHook' (erforderlich) |
Eigenschaften | WebHook-Eigenschaften des Ereignisabonnementziels | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
Name | Beschreibung | Wert |
---|---|---|
endpointUrl | Die URL, die den Endpunkt des Ziels eines Ereignisabonnements darstellt. | Schnur |
Schnellstartvorlagen
Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.
Schablone | Beschreibung |
---|---|
Erstellen eines benutzerdefinierten Azure Event Grid-Themas und eines Warteschlangenabonnements |
Erstellt ein benutzerdefiniertes Azure Event Grid-Thema und ein Servicebus-Warteschlangenabonnement. Vorlage, die ursprünglich von Markus Meyer verfasst wurde. |
Erstellen eines benutzerdefinierten Azure Event Grid-Themas und eines benutzerdefinierten Abonnement- |
Erstellt ein benutzerdefiniertes Thema für Azure Event Grid und ein Webhook-Abonnement. Vorlage, die ursprünglich von John Downs verfasst wurde. |
Erstellen eines benutzerdefinierten Azure Event Grid-Themenabonnements |
Erstellt ein benutzerdefiniertes Azure Event Grid-Thema und ein Servicebus-Themenabonnement. Vorlage, die ursprünglich von Markus Meyer verfasst wurde. |
Benutzerdefiniertes Thema und Ereignishubhandler erstellen |
Erstellt ein benutzerdefiniertes Thema und einen Ereignishub für Azure Event Grid, um die Ereignisse zu behandeln. |
Erstellen eines Ereignisrasterabonnements für Ressourcenereignisse |
Erstellt ein Ereignisrasterabonnement für eine Ressourcengruppe oder ein Azure-Abonnement. |
benutzerdefiniertes Azure Event Grid-Thema/Abonnement mit CloudEvents- |
Erstellt ein benutzerdefiniertes Azure Event Grid-Thema, ein Webhook-Abonnement mit CloudEvents-Schema und eine Logik-App als Ereignishandler. Vorlage, die ursprünglich von Justin Yoo erstellt wurde. |
Terraform -Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp "eventSubscriptions" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.EventGrid/eventSubscriptions-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/eventSubscriptions@2017-09-15-preview"
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"
]
}
})
}
EventSubscriptionDestination-Objekte
Legen Sie den endpointType--Eigenschaft fest, um den Objekttyp anzugeben.
Verwenden Sie für EventHub-:
{
endpointType = "EventHub"
properties = {
resourceId = "string"
}
}
Verwenden Sie für WebHook-:
{
endpointType = "WebHook"
properties = {
endpointUrl = "string"
}
}
Eigenschaftswerte
EventHubEventSubscriptionDestination
Name | Beschreibung | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel | 'EventHub' (erforderlich) |
Eigenschaften | Event Hub-Eigenschaften des Ereignisabonnementziels | EventHubEventSubscriptionDestinationProperties- |
EventHubEventSubscriptionDestinationProperties
Name | Beschreibung | Wert |
---|---|---|
resourceId | Die Azure-Ressourcen-ID, die den Endpunkt eines Event Hub-Ziels eines Ereignisabonnements darstellt. | Schnur |
EventSubscriptionDestination
Name | Beschreibung | Wert |
---|---|---|
endpointType | Set to 'EventHub' for type EventHubEventSubscriptionDestination. Legen Sie für den Typ WebHookEventSubscriptionDestinationauf 'WebHook' fest. | 'EventHub' 'WebHook' (erforderlich) |
EventSubscriptionFilter
Name | Beschreibung | Wert |
---|---|---|
includedEventTypes | Eine Liste der anwendbaren Ereignistypen, die Teil des Ereignisabonnements sein müssen. Wenn alle Ereignistypen abonniert werden sollen, muss die Zeichenfolge "all" als Element in dieser Liste angegeben werden. |
string[] |
isSubjectCaseSensitive | Gibt an, ob die Eigenschaften SubjectBeginsWith und SubjectEndsWith des Filters sollte auf die Groß-/Kleinschreibung unterschieden werden. |
Bool |
subjectBeginsWith | Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Ressourcenpfadpräfix. Das Format dieser Ereignisse hängt vom Herausgeber der Ereignisse ab. In diesem Pfad werden keine Wildcardzeichen unterstützt. |
Schnur |
subjectEndsWith | Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Ressourcenpfadsuffix. In diesem Pfad werden keine Wildcardzeichen unterstützt. |
Schnur |
EventSubscriptionProperties
Name | Beschreibung | Wert |
---|---|---|
Bestimmungsort | Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. | EventSubscriptionDestination |
Filter | Informationen zum Filter für das Ereignisabonnement. | EventSubscriptionFilter- |
etiketten | Liste der benutzerdefinierten Bezeichnungen. | string[] |
Microsoft.EventGrid/eventSubscriptions
Name | Beschreibung | Wert |
---|---|---|
Name | Der Ressourcenname | Zeichenfolge (erforderlich) |
parent_id | Die ID der Ressource, auf die diese Erweiterungsressource angewendet werden soll. | Zeichenfolge (erforderlich) |
Eigenschaften | Eigenschaften des Ereignisabonnements | EventSubscriptionProperties |
Art | Der Ressourcentyp | "Microsoft.EventGrid/eventSubscriptions@2017-09-15-preview" |
WebHookEventSubscriptionDestination
Name | Beschreibung | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel | 'WebHook' (erforderlich) |
Eigenschaften | WebHook-Eigenschaften des Ereignisabonnementziels | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
Name | Beschreibung | Wert |
---|---|---|
endpointUrl | Die URL, die den Endpunkt des Ziels eines Ereignisabonnements darstellt. | Schnur |