Freigeben über


Microsoft.EventGrid eventSubscriptions 2017-09-15-preview

Bicep-Ressourcendefinition

Der Ressourcentyp eventSubscriptions ist eine Erweiterungsressource, was bedeutet, dass Sie sie auf eine andere Ressource anwenden können.

Verwenden Sie die scope -Eigenschaft für diese Ressource, um den Bereich für diese Ressource festzulegen. Weitere Informationen finden Sie unter Festlegen des Bereichs für Erweiterungsressourcen in Bicep.

Der Ressourcentyp eventSubscriptions kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

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 Bicep hinzu.

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2017-09-15-preview' = {
  name: 'string'
  scope: resourceSymbolicName
  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 die endpointType-Eigenschaft fest, um den Typ des Objekts anzugeben.

Verwenden Sie für EventHub Folgendes:

  endpointType: 'EventHub'
  properties: {
    resourceId: 'string'
  }

Verwenden Sie für WebHook Folgendes:

  endpointType: 'WebHook'
  properties: {
    endpointUrl: 'string'
  }

Eigenschaftswerte

eventSubscriptions

Name BESCHREIBUNG Wert
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 3-64

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.
scope Verwenden Sie beim Erstellen einer Erweiterungsressource in einem bereich, der sich vom Bereitstellungsbereich unterscheidet. Zielressource

Legen Sie für Bicep diese Eigenschaft auf den symbolischen Namen der Ressource fest, um die Erweiterungsressource anzuwenden.
properties Eigenschaften des Ereignisabonnements EventSubscriptionProperties

EventSubscriptionProperties

Name BESCHREIBUNG Wert
destination Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. EventSubscriptionDestination
filter Informationen zum Filter für das Ereignisabonnement. EventSubscriptionFilter
Bezeichnungen Liste der benutzerdefinierten Bezeichnungen. string[]

EventSubscriptionDestination

Name BESCHREIBUNG Wert
endpointType Festlegen des Objekttyps EventHub
WebHook (erforderlich)

EventHubEventSubscriptionDestination

Name BESCHREIBUNG Wert
endpointType Typ des Endpunkts für das Ereignisabonnementziel "EventHub" (erforderlich)
properties 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. Zeichenfolge

WebHookEventSubscriptionDestination

Name BESCHREIBUNG Wert
endpointType Typ des Endpunkts für das Ereignisabonnementziel "WebHook" (erforderlich)
properties WebHook-Eigenschaften des Ereignisabonnementziels WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Name BESCHREIBUNG Wert
endpointUrl Die URL, die den Endpunkt des Ziels eines Ereignisabonnements darstellt. Zeichenfolge

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 eine Weise verglichen werden, bei der die Groß-/Kleinschreibung beachtet wird.
bool
subjectBeginsWith Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Ressourcenpfadpräfix.
Das Format hängt vom Herausgeber der Ereignisse ab.
In diesem Pfad werden keine Wildcardzeichen unterstützt.
Zeichenfolge
subjectEndsWith Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Ressourcenpfadsuffix.
In diesem Pfad werden keine Wildcardzeichen unterstützt.
Zeichenfolge

Schnellstartvorlagen

In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.

Vorlage BESCHREIBUNG
Erstellen Azure Event Grid benutzerdefinierten Themas und Abonnements

Bereitstellen in Azure
Erstellt ein Azure Event Grid benutzerdefiniertes Thema und ein Webhookabonnement. Vorlage, die ursprünglich von John Downs erstellt wurde.
Thema/Abonnement für benutzerdefinierte Azure Event Grid mit CloudEvents

Bereitstellen in Azure
Erstellt ein benutzerdefiniertes Azure Event Grid Thema, ein Webhookabonnement mit dem CloudEvents-Schema und eine Logik-App als Ereignishandler. Vorlage, die ursprünglich von Justin Yoo erstellt wurde.
Erstellen eines benutzerdefinierten Event Grid-Themas und Event Hub-Handlers

Bereitstellen in Azure
Erstellt einen Azure Event Grid benutzerdefinierten Thema und Event Hub, um die Ereignisse zu behandeln.
Erstellen eines Event Grid-Abonnements für Ressourcenereignisse

Bereitstellen in Azure
Erstellt ein Event Grid-Abonnement für eine Ressourcengruppe oder ein Azure-Abonnement.
Erstellen Azure Event Grid benutzerdefinierten Themen- und Warteschlangenabonnements

Bereitstellen in Azure
Erstellt ein Azure Event Grid benutzerdefiniertes Thema und ein Service Bus-Warteschlangenabonnement. Vorlage, die ursprünglich von Markus Meyer erstellt wurde.
Erstellen eines Azure Event Grid benutzerdefinierten Themenabonnements

Bereitstellen in Azure
Erstellt ein Azure Event Grid benutzerdefiniertes Thema und ein Service Bus-Themenabonnement. Vorlage, die ursprünglich von Markus Meyer erstellt wurde.

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp eventSubscriptions ist eine Erweiterungsressource, d. h. Sie können sie auf eine andere Ressource anwenden.

Verwenden Sie die scope -Eigenschaft für diese Ressource, um den Bereich für diese Ressource festzulegen. Weitere Informationen finden Sie unter Festlegen des Bereichs für Erweiterungsressourcen in ARM-Vorlagen.

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 im Ä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",
  "scope": "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 die endpointType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für EventHub Folgendes:

  "endpointType": "EventHub",
  "properties": {
    "resourceId": "string"
  }

Verwenden Sie für WebHook Folgendes:

  "endpointType": "WebHook",
  "properties": {
    "endpointUrl": "string"
  }

Eigenschaftswerte

eventSubscriptions

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.EventGrid/eventSubscriptions"
apiVersion Die Version der Ressourcen-API '2017-09-15-preview'
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 3-64

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.
scope Verwenden Sie beim Erstellen einer Erweiterungsressource in einem anderen Bereich als dem Bereitstellungsbereich. Zielressource

Legen Sie für JSON den Wert auf den vollständigen Namen der Ressource fest, auf die die Erweiterungsressource angewendet werden soll.
properties Eigenschaften des Ereignisabonnements EventSubscriptionProperties

EventSubscriptionProperties

Name BESCHREIBUNG Wert
destination Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. EventSubscriptionDestination
filter Informationen zum Filter für das Ereignisabonnement. EventSubscriptionFilter
Bezeichnungen Liste der benutzerdefinierten Bezeichnungen. string[]

EventSubscriptionDestination

Name BESCHREIBUNG Wert
endpointType Festlegen des Objekttyps EventHub
WebHook (erforderlich)

EventHubEventSubscriptionDestination

Name BESCHREIBUNG Wert
endpointType Typ des Endpunkts für das Ereignisabonnementziel "EventHub" (erforderlich)
properties 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. Zeichenfolge

WebHookEventSubscriptionDestination

Name BESCHREIBUNG Wert
endpointType Typ des Endpunkts für das Ereignisabonnementziel "WebHook" (erforderlich)
properties WebHook-Eigenschaften des Ereignisabonnementziels WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Name BESCHREIBUNG Wert
endpointUrl Die URL, die den Endpunkt des Ziels eines Ereignisabonnements darstellt. Zeichenfolge

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 mit der Groß-/Kleinschreibung verglichen werden.
bool
subjectBeginsWith Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Ressourcenpfadpräfix.
Das Format hängt vom Herausgeber der Ereignisse ab.
Wildcardzeichen werden in diesem Pfad nicht unterstützt.
Zeichenfolge
subjectEndsWith Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Ressourcenpfadsuffix.
Wildcardzeichen werden in diesem Pfad nicht unterstützt.
Zeichenfolge

Schnellstartvorlagen

Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.

Vorlage BESCHREIBUNG
Erstellen Azure Event Grid benutzerdefinierten Themas und Abonnements

Bereitstellen in Azure
Erstellt ein Azure Event Grid benutzerdefiniertes Thema und ein Webhookabonnement. Vorlage, die ursprünglich von John Downs erstellt wurde.
Benutzerdefiniertes Azure Event Grid Thema/Abonnement mit CloudEvents

Bereitstellen in Azure
Erstellt ein benutzerdefiniertes Azure Event Grid Thema, ein Webhookabonnement mit CloudEvents-Schema und eine Logik-App als Ereignishandler. Vorlage, die ursprünglich von Justin Yoo erstellt wurde.
Erstellen eines benutzerdefinierten Event Grid-Themas und eines Event Hub-Handlers

Bereitstellen in Azure
Erstellt ein Azure Event Grid benutzerdefinierten Thema und Event Hub, um die Ereignisse zu behandeln.
Erstellen eines Event Grid-Abonnements für Ressourcenereignisse

Bereitstellen in Azure
Erstellt ein Event Grid-Abonnement für eine Ressourcengruppe oder ein Azure-Abonnement.
Erstellen eines Azure Event Grid benutzerdefinierten Themas und eines Warteschlangenabonnements

Bereitstellen in Azure
Erstellt ein Azure Event Grid benutzerdefiniertes Thema und ein Service Bus-Warteschlangenabonnement. Vorlage ursprünglich von Markus Meyer erstellt.
Erstellen eines Azure Event Grid benutzerdefinierten Themenabonnements

Bereitstellen in Azure
Erstellt ein Azure Event Grid benutzerdefiniertes Thema und ein Service Bus-Themenabonnement. Vorlage ursprünglich von Markus Meyer erstellt.

Terraform (AzAPI-Anbieter) Ressourcendefinition

Der Ressourcentyp eventSubscriptions ist eine Erweiterungsressource, was bedeutet, dass Sie sie auf eine andere Ressource anwenden können.

Verwenden Sie die parent_id -Eigenschaft für diese Ressource, um den Bereich für diese Ressource festzulegen.

Der Ressourcentyp eventSubscriptions kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen
  • Abonnements

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.EventGrid/eventSubscriptions-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource 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 die endpointType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für EventHub Folgendes:

  endpointType = "EventHub"
  properties = {
    resourceId = "string"
  }

Verwenden Sie für WebHook Folgendes:

  endpointType = "WebHook"
  properties = {
    endpointUrl = "string"
  }

Eigenschaftswerte

eventSubscriptions

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.EventGrid/eventSubscriptions@2017-09-15-preview"
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 3-64

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.
parent_id Die ID der Ressource, auf die diese Erweiterungsressource angewendet werden soll. Zeichenfolge (erforderlich)
properties Eigenschaften des Ereignisabonnements EventSubscriptionProperties

EventSubscriptionProperties

Name BESCHREIBUNG Wert
destination Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. EventSubscriptionDestination
filter Informationen zum Filter für das Ereignisabonnement. EventSubscriptionFilter
Bezeichnungen Liste der benutzerdefinierten Bezeichnungen. string[]

EventSubscriptionDestination

Name BESCHREIBUNG Wert
endpointType Festlegen des Objekttyps EventHub
WebHook (erforderlich)

EventHubEventSubscriptionDestination

Name BESCHREIBUNG Wert
endpointType Typ des Endpunkts für das Ereignisabonnementziel "EventHub" (erforderlich)
properties 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. Zeichenfolge

WebHookEventSubscriptionDestination

Name BESCHREIBUNG Wert
endpointType Typ des Endpunkts für das Ereignisabonnementziel "WebHook" (erforderlich)
properties WebHook-Eigenschaften des Ereignisabonnementziels WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Name BESCHREIBUNG Wert
endpointUrl Die URL, die den Endpunkt des Ziels eines Ereignisabonnements darstellt. Zeichenfolge

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 eine Weise verglichen werden, bei der die Groß-/Kleinschreibung beachtet wird.
bool
subjectBeginsWith Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Ressourcenpfadpräfix.
Das Format hängt vom Herausgeber der Ereignisse ab.
Wildcardzeichen werden in diesem Pfad nicht unterstützt.
Zeichenfolge
subjectEndsWith Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Ressourcenpfadsuffix.
Wildcardzeichen werden in diesem Pfad nicht unterstützt.
Zeichenfolge