Feedback

az eventgrid system-topic event-subscription

  • Referenz

Verwalten von Ereignisabonnements des Systemthemas.

Befehle

az eventgrid system-topic event-subscription create

Erstellen Sie ein neues Ereignisabonnement für ein Systemthema.
az eventgrid system-topic event-subscription delete

Löschen eines Ereignisabonnements eines Systemthemas.
az eventgrid system-topic event-subscription list

Listen von Ereignisabonnements eines bestimmten Systemthemas.
az eventgrid system-topic event-subscription show

Rufen Sie die Details eines Ereignisabonnements eines Systemthemas ab.
az eventgrid system-topic event-subscription update

Aktualisieren eines Ereignisabonnements eines Systemthemas.

az eventgrid system-topic event-subscription create

Bearbeiten

Erstellen Sie ein neues Ereignisabonnement für ein Systemthema.

az eventgrid system-topic event-subscription create --name
                                                    --resource-group
                                                    --system-topic-name
                                                    [--aad-tenant-id]
                                                    [--advanced-filter]
                                                    [--azure-active-directory-application-id-or-uri]
                                                    [--deadletter-endpoint]
                                                    [--delivery-attribute-mapping]
                                                    [--enable-advanced-filtering-on-arrays {false, true}]
                                                    [--endpoint]
                                                    [--endpoint-type {azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook}]
                                                    [--event-delivery-schema {cloudeventschemav1_0, custominputschema, eventgridschema}]
                                                    [--event-ttl]
                                                    [--expiration-date]
                                                    [--included-event-types]
                                                    [--labels]
                                                    [--max-delivery-attempts]
                                                    [--max-events-per-batch]
                                                    [--preferred-batch-size-in-kilobytes]
                                                    [--qttl]
                                                    [--subject-begins-with]
                                                    [--subject-case-sensitive {false, true}]
                                                    [--subject-ends-with]

Beispiele

Erstellen Sie ein neues Ereignisabonnement für ein Ereignisrastersystemthema mithilfe von Standardfiltern.

az eventgrid system-topic event-subscription create --name es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code

Erstellen Sie ein neues Ereignisabonnement für ein Ereignisrastersystemthema, mit einem Filter, der ein Betreffpräfix angibt.

az eventgrid system-topic event-subscription create --name es4 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code \
    --subject-begins-with mysubject_prefix

Erstellen Sie ein neues Ereignisabonnement für ein Ereignisrastersystemthema mit Standardfiltern und CloudEvent V 1.0 als Übermittlungsschema.

az eventgrid system-topic event-subscription create -n es2 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code \
    --event-delivery-schema cloudeventschemav1_0

Erstellen Sie ein neues Ereignisabonnement für ein Ereignisrastersystemthema mit einem Deadletter-Ziel und einer benutzerdefinierten Wiederholungsrichtlinie von maximal 10 Übermittlungsversuchen und einer Ereignis-TTL von 2 Stunden (je nachdem, was früher geschieht) und Ablaufdatum.

az eventgrid system-topic event-subscription create --name es2 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code \
    --deadletter-endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/s2/blobServices/default/containers/blobcontainer1 \
    --max-delivery-attempts 10 --event-ttl 120 --expiration-date "2022-10-31"

Erstellen Sie ein neues Ereignisabonnement für ein Ereignisrastersystemthema, wobei Azure Active Directory Webhook als Ziel aktiviert hat.

az eventgrid system-topic event-subscription create --name es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code
    --azure-active-directory-tenant-id azureactivedirectorytenantid
    --azure-active-directory-application-id-or-uri azureactivedirectoryapplicationidoruri

Erstellen Sie ein neues Ereignisabonnement für ein Ereignisrastersystemthema, wobei Azure Function als Ziel verwendet wird.

az eventgrid system-topic event-subscription create -n es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Web/sites/{functionappname}/functions/{functionname} --endpoint-type azurefunction

Erstellen eines neuen Ereignisabonnements für ein Ereignisrastersystemthema mithilfe der Speicherwarteschlange als Ziel mit einer Ttl von 5 Minuten

az eventgrid system-topic event-subscription create -n es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint-type storagequeue \
    --endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/queueservices/default/queues/q1 \
    --storage-queue-msg-ttl 300

Erstellen eines neuen Ereignisabonnements für ein Ereignisrastersystemthema und Aktivieren der erweiterten Filterung auf Arrays

az eventgrid system-topic event-subscription create -n es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Web/sites/{functionappname}/functions/{functionname} --endpoint-type azurefunction \
    --enable-advanced-filtering-on-arrays true

Erforderliche Parameter

--name -n

Name des Ereignisabonnements.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--system-topic-name

Name des Systemthemas.

Optionale Parameter

--aad-tenant-id --azure-active-directory-tenant-id

Die Azure Active Directory-Mandanten-ID, um das Zugriffstoken abzurufen, das als Bearertoken in Übermittlungsanforderungen eingeschlossen wird. Gilt nur für Webhook als Ziel.

--advanced-filter

Ein erweiterter Filter ermöglicht das Filtern von Ereignissen basierend auf einer bestimmten Ereigniseigenschaft.

--azure-active-directory-application-id-or-uri

Die Azure Active Directory-Anwendungs-ID oder der Uri zum Abrufen des Zugriffstokens, das als Bearertoken in Übermittlungsanforderungen eingeschlossen wird. Gilt nur für Webhook als Ziel.

--deadletter-endpoint

Die Azure-Ressourcen-ID eines Azure Storage-Blob-Containerziels, an dem EventGrid für dieses Ereignisabonnement unzustellbare Ereignisse angibt.

--delivery-attribute-mapping

Fügen Sie die Zuordnung des Übermittlungsattributes hinzu, um zusätzliche Informationen über HTTP-Header zu senden, wenn Ereignisse bereitgestellt werden. Dieses Attribut ist für alle Zieltypen mit Ausnahme von StorageQueue gültig. Mehrere Attribute können mithilfe mehrerer --delivery-attribute-mapping Argumente angegeben werden.

--enable-advanced-filtering-on-arrays --enable-af-arr

Ermöglicht erweiterten Filtern, die anhand eines Arrays von Werten ausgewertet werden können, anstatt einen singularen Wert zu erwarten.

Zulässige Werte: false, true
--endpoint

Endpunkt, an dem EventGrid Ereignisse bereitstellen soll, die diesem Ereignisabonnement entsprechen. Bei Webhook-Endpunkttyp sollte dies die entsprechende Webhook-URL sein. Bei anderen Endpunkttypen sollte dies der Azure-Ressourcenbezeichner des Endpunkts sein. Es wird erwartet, dass der Zielendpunkt bereits erstellt und für die Verwendung verfügbar ist, bevor ein Ereignisrasterbefehl ausgeführt wird.

--endpoint-type

Der Typ des Zielendpunkts.

Zulässige Werte: azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook
Standardwert: webhook
--event-delivery-schema

Das Schema, in dem Ereignisse für dieses Ereignisabonnement bereitgestellt werden sollen. Standardmäßig werden Ereignisse im gleichen Schema bereitgestellt, in dem sie veröffentlicht werden (basierend auf dem Eingabeschema des entsprechenden Themas).

Zulässige Werte: cloudeventschemav1_0, custominputschema, eventgridschema
--event-ttl

Ereigniszeit für live (in Minuten). Muss eine Zahl zwischen 1 und 1440 sein.

Standardwert: 1440
--expiration-date

Datum oder Datum (in UTC, z. B. "2018-11-30T11:59:59+00:00" oder "2018-11-30"),, nach dem das Ereignisabonnement abläuft. Standardmäßig ist kein Ablauf für das Ereignisabonnement vorhanden.

--included-event-types

Eine leer getrennte Liste von Ereignistypen (z. B. Microsoft.Storage.BlobCreated und Microsoft.Storage.BlobDeleted). Um alle Standardereignistypen zu abonnieren, geben Sie keinen Wert für dieses Argument an. Für Ereignisrasterthemen sind Ereignistypen kundendefiniert. Für Azure-Ereignisse, z. B. Speicherkonten, IoT Hub usw., können Sie ihre Ereignistypen mithilfe dieses CLI-Befehls "az eventgrid topic-type list-event-types" abfragen.

--labels

Eine leer getrennte Liste von Bezeichnungen, die diesem Ereignisabonnement zugeordnet werden sollen.

--max-delivery-attempts

Maximale Anzahl von Übermittlungsversuchen. Muss eine Zahl zwischen 1 und 30 sein.

Standardwert: 30
--max-events-per-batch

Maximale Anzahl von Ereignissen in einem Batch. Muss eine Zahl im Bereich 1 bis 5.000 sein.

--preferred-batch-size-in-kilobytes

Bevorzugte Batchgröße in Kilobyte. Muss eine Zahl im Bereich 1 bis 1.024 sein.

--qttl --storage-queue-msg-ttl

Zeit für speicherwarteschleifende Nachrichten, die in Sekunden zu leben sind.

--subject-begins-with

Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Präfix. Platzhalterzeichen werden nicht unterstützt.

--subject-case-sensitive

Geben Sie an, ob die Betrefffelder in einer Groß-/Kleinschreibung verglichen werden sollen. True, wenn flag vorhanden ist.

Zulässige Werte: false, true
--subject-ends-with

Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Suffix. Platzhalterzeichen werden nicht unterstützt.

az eventgrid system-topic event-subscription delete

Bearbeiten

Löschen eines Ereignisabonnements eines Systemthemas.

az eventgrid system-topic event-subscription delete --name
                                                    --resource-group
                                                    --system-topic-name
                                                    [--yes]

Beispiele

Löschen eines Ereignisabonnements für ein Ereignisrastersystemthema.

az eventgrid system-topic event-subscription delete --name es1 \
    -g rg1 --system-topic-name systemtopic1 \

Erforderliche Parameter

--name -n

Name des Ereignisabonnements.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--system-topic-name

Name des Systemthemas.

Optionale Parameter

--yes -y

Nicht zur Bestätigung auffordern

az eventgrid system-topic event-subscription list

Bearbeiten

Listen von Ereignisabonnements eines bestimmten Systemthemas.

az eventgrid system-topic event-subscription list --resource-group
                                                  --system-topic-name
                                                  [--odata-query]

Beispiele

Listet alle Ereignisabonnements auf, die für ein Ereignisrastersystemthema erstellt wurden.

az eventgrid system-topic event-subscription list -g rg1 --system-topic-name systemtopic1

Erforderliche Parameter

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--system-topic-name

Name des Systemthemas.

Optionale Parameter

--odata-query

Die OData-Abfrage, die zum Filtern der Listenergebnisse verwendet wird. Die Filterung ist derzeit nur für die Name-Eigenschaft zulässig. Die unterstützten Vorgänge umfassen: CONTAINS, eq (für gleichheit), ne (nicht gleich), AND, OR und NOT.

az eventgrid system-topic event-subscription show

Bearbeiten

Rufen Sie die Details eines Ereignisabonnements eines Systemthemas ab.

az eventgrid system-topic event-subscription show --name
                                                  --resource-group
                                                  --system-topic-name
                                                  [--include-attrib-secret {false, true}]
                                                  [--include-full-endpoint-url {false, true}]

Beispiele

Zeigen Sie die Details eines Ereignisabonnements für ein Ereignisrastersystemthema an.

az eventgrid system-topic event-subscription show --name es1 \
     -g rg1 --system-topic-name systemtopic1

Zeigen Sie die Details eines Ereignisabonnements für ein Ereignisrastersystemthema an, das alle geheimen Schlüssel des statischen Übermittlungsattributes enthält.

az eventgrid system-topic event-subscription show --name es1 \
     -g rg1 --system-topic-name systemtopic1 --include-attrib-secret

Erforderliche Parameter

--name -n

Name des Ereignisabonnements.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--system-topic-name

Name des Systemthemas.

Optionale Parameter

--include-attrib-secret --include-static-delivery-attribute-secret

Geben Sie an, ob geheime Schlüssel für statische Übermittlungsattribute zurückgegeben werden sollen. True, wenn flag vorhanden ist.

Zulässige Werte: false, true
--include-full-endpoint-url

Geben Sie an, ob die vollständige Endpunkt-URL zurückgegeben werden soll. True, wenn flag vorhanden ist.

Zulässige Werte: false, true

az eventgrid system-topic event-subscription update

Bearbeiten

Aktualisieren eines Ereignisabonnements eines Systemthemas.

az eventgrid system-topic event-subscription update --name
                                                    --resource-group
                                                    --system-topic-name
                                                    [--advanced-filter]
                                                    [--deadletter-endpoint]
                                                    [--delivery-attribute-mapping]
                                                    [--enable-advanced-filtering-on-arrays {false, true}]
                                                    [--endpoint]
                                                    [--endpoint-type {azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook}]
                                                    [--included-event-types]
                                                    [--labels]
                                                    [--qttl]
                                                    [--subject-begins-with]
                                                    [--subject-ends-with]

Beispiele

Aktualisieren Sie ein Ereignisabonnement für ein Ereignisrastersystemthema, um einen neuen Endpunkt anzugeben.

az eventgrid system-topic event-subscription update --name es1 \
    -g rg1 --system-topic-name systemtopic1 --endpoint https://contoso.azurewebsites.net/api/f1?code=code

Aktualisieren Sie ein Ereignisabonnement für ein Ereignisrastersystemthema, um einen neuen Betreff-End-mit-Filter anzugeben.

az eventgrid system-topic event-subscription update --name es2 \
    -g rg1 --system-topic-name systemtopic1 \
    --subject-ends-with .jpg

Aktualisieren Sie ein Ereignisabonnement für ein Ereignisrastersystemthema, um einen neuen Endpunkt und eine neue Betreff-End-End-Liste einer neuen Liste der enthaltenen Ereignistypen anzugeben.

az eventgrid system-topic event-subscription update --name es3 \
    -g rg1 --system-topic-name systemtopic1 \
    --subject-ends-with .png \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code
    --included-event-types Microsoft.Storage.BlobCreated Microsoft.Storage.BlobDeleted

Aktualisieren Sie ein Ereignisabonnement für ein Azure Event Grid Systemthema, um ein Totletterziel einzuschließen.

az eventgrid system-topic event-subscription update --name es2 \
    -g rg1 --system-topic-name systemtopic1 \
    --deadletter-endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/blobServices/default/containers/blobcontainer1

Aktualisieren Sie ein Ereignisabonnement für ein Azure Event Grid Systemthema mit erweiterten Filtern.

az eventgrid system-topic event-subscription update --name es3 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code
    --advanced-filter data.blobType StringIn BlockBlob
    --advanced-filter data.url StringBeginsWith https://myaccount.blob.core.windows.net

Aktualisieren eines Ereignisabonnements für ein Ereignisrastersystemthema mit Speicherwarteschlange als Ziel mit ttl von 5 Minuten

az eventgrid system-topic event-subscription update -n es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --storage-queue-msg-ttl 300

Aktualisieren eines Ereignisabonnements für ein Ereignisrastersystemthema mit erweiterter Filterung auf aktivierten Arrays

az eventgrid system-topic event-subscription update -n es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --enable-advanced-filtering-on-arrays true

Erforderliche Parameter

--name -n

Name des Ereignisabonnements.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--system-topic-name

Name des Systemthemas.

Optionale Parameter

--advanced-filter

Ein erweiterter Filter ermöglicht das Filtern von Ereignissen basierend auf einer bestimmten Ereigniseigenschaft.

--deadletter-endpoint

Die Azure-Ressourcen-ID eines Azure Storage-Blob-Containerziels, an dem EventGrid für dieses Ereignisabonnement unzustellbare Ereignisse angibt.

--delivery-attribute-mapping

Fügen Sie die Zuordnung des Übermittlungsattributes hinzu, um zusätzliche Informationen über HTTP-Header zu senden, wenn Ereignisse bereitgestellt werden. Dieses Attribut ist für alle Zieltypen mit Ausnahme von StorageQueue gültig. Mehrere Attribute können mithilfe mehrerer --delivery-attribute-mapping Argumente angegeben werden.

--enable-advanced-filtering-on-arrays --enable-af-arr

Ermöglicht erweiterten Filtern, die anhand eines Arrays von Werten ausgewertet werden können, anstatt einen singularen Wert zu erwarten.

Zulässige Werte: false, true
--endpoint

Endpunkt, an dem EventGrid Ereignisse bereitstellen soll, die diesem Ereignisabonnement entsprechen. Bei Webhook-Endpunkttyp sollte dies die entsprechende Webhook-URL sein. Bei anderen Endpunkttypen sollte dies der Azure-Ressourcenbezeichner des Endpunkts sein. Es wird erwartet, dass der Zielendpunkt bereits erstellt und für die Verwendung verfügbar ist, bevor ein Ereignisrasterbefehl ausgeführt wird.

--endpoint-type

Der Typ des Zielendpunkts.

Zulässige Werte: azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook
Standardwert: webhook
--included-event-types

Eine leer getrennte Liste von Ereignistypen (z. B. Microsoft.Storage.BlobCreated und Microsoft.Storage.BlobDeleted). Um alle Standardereignistypen zu abonnieren, geben Sie keinen Wert für dieses Argument an. Für Ereignisrasterthemen sind Ereignistypen kundendefiniert. Für Azure-Ereignisse, z. B. Speicherkonten, IoT Hub usw., können Sie ihre Ereignistypen mithilfe dieses CLI-Befehls "az eventgrid topic-type list-event-types" abfragen.

--labels

Eine leer getrennte Liste von Bezeichnungen, die diesem Ereignisabonnement zugeordnet werden sollen.

--qttl --storage-queue-msg-ttl

Zeit für speicherwarteschleifende Nachrichten, die in Sekunden zu leben sind.

--subject-begins-with

Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Präfix. Platzhalterzeichen werden nicht unterstützt.

--subject-ends-with

Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Suffix. Platzhalterzeichen werden nicht unterstützt.