Freigeben über

az providerhub notification-registration

  • Referenz

Hinweis

Diese Referenz ist Teil der ProviderHub-Erweiterung für die Azure CLI (Version 2.57.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen az providerhub notification-registration-Befehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

Verwalten sie die Benachrichtigungsregistrierung mit providerhub.

Befehle

Name Beschreibung Typ Status
az providerhub notification-registration create

Erstellen Sie eine Benachrichtigungsregistrierung.

 Erweiterung Allgemein verfügbar
az providerhub notification-registration delete

Löschen sie eine Benachrichtigungsregistrierung.

 Erweiterung Allgemein verfügbar
az providerhub notification-registration list

Liste der Benachrichtigungsregistrierungen für den angegebenen Anbieter auf.

 Erweiterung Allgemein verfügbar
az providerhub notification-registration show

Rufen Sie die Details zur Benachrichtigungsregistrierung ab.

 Erweiterung Allgemein verfügbar
az providerhub notification-registration update

Aktualisieren sie eine Benachrichtigungsregistrierung.

 Erweiterung Allgemein verfügbar

az providerhub notification-registration create

Erstellen Sie eine Benachrichtigungsregistrierung.

az providerhub notification-registration create --name
                                                --provider-namespace
                                                [--included-events]
                                                [--message-scope {NotSpecified, RegisteredSubscriptions}]
                                                [--notification-endpoints]
                                                [--notification-mode {EventHub, NotSpecified, WebHook}]

Beispiele

Erstellen einer Benachrichtigungsregistrierung

az providerhub notification-registration create --name "{notificationRegistration}" --included-events "*/write" "Microsoft.Contoso/employees/delete" --message-scope "RegisteredSubscriptions" --notification-endpoints [{notification-destination:/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-eastus/providers/Microsoft.EventHub/namespaces/unitedstates-mgmtexpint/eventhubs/armlinkednotifications,locations:[EastUS]}] --notification-mode "EventHub" --provider-namespace "{providerNamespace}"

Erforderliche Parameter

--name --notification-registration-name -n

Die Benachrichtigungsregistrierung.

--provider-namespace

Der Name des in ProviderHub gehosteten Ressourcenanbieters.

Optionale Parameter

--included-events

Dies sind die Ereignisse, an denen das RP gesendet werden soll. Das Nachrichtenformat befindet sich in der Form {RP Namespace}/{ResourceType}/{action}. Die verfügbaren Aktionen sind: Schreiben, Löschen und Verschieben/Aktion. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

--message-scope

Schränkt die Nachrichten ein, die an das RP gesendet werden. Der Standardwert ist RegisteredSubscriptions. Die verfügbaren Werte sind global (alle Nachrichten in Azure) und RegisteredSubscriptions (nur Nachrichten in Abonnements, die von RP registriert wurden).

Zulässige Werte: NotSpecified, RegisteredSubscriptions
--notification-endpoints

Dies sind die Speicherorte für die Benachrichtigungen. Benachrichtigungen werden an die Region des Standorts der Ereignisressource gesendet (z. B. vm in East Us sendet Nachrichten an den angegebenen Endpunkt in Ost-US). Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

--notification-mode

Bestimmt, wie die Benachrichtigungen an das RP gesendet werden. Die beiden verfügbaren Modi sind EventHub und Webhook.

Zulässige Werte: EventHub, NotSpecified, WebHook
Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az providerhub notification-registration delete

Löschen sie eine Benachrichtigungsregistrierung.

az providerhub notification-registration delete [--ids]
                                                [--name]
                                                [--provider-namespace]
                                                [--subscription]
                                                [--yes]

Beispiele

Löschen der Benachrichtigungsregistrierung

az providerhub notification-registration delete -y --name "{notificationRegistration}" --provider-namespace "{providerNamespace}"

Optionale Parameter

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der „Ressource id“-Argumente handeln. Sie sollten entweder „--ids“ oder andere „Resource Id“-Argumente angeben.

--name --notification-registration-name -n

Die Benachrichtigungsregistrierung.

--provider-namespace

Der Name des in ProviderHub gehosteten Ressourcenanbieters.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--yes -y

Nicht zur Bestätigung auffordern

Standardwert: False
Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az providerhub notification-registration list

Liste der Benachrichtigungsregistrierungen für den angegebenen Anbieter auf.

az providerhub notification-registration list --provider-namespace
                                              [--max-items]
                                              [--next-token]

Beispiele

Benachrichtigungsregistrierungsliste

az providerhub notification-registration list --provider-namespace "{providerNamespace}"

Erforderliche Parameter

--provider-namespace

Der Name des in ProviderHub gehosteten Ressourcenanbieters.

Optionale Parameter

--max-items

Die Gesamtanzahl der Elemente, die in der Ausgabe des Befehls zurückgegeben werden sollen. Wenn die Gesamtanzahl der verfügbaren Elemente größer als der angegebene Wert ist, wird ein Token in der Ausgabe des Befehls bereitgestellt. Um die Paginierung fortzusetzen, geben Sie den Tokenwert im --next-token Argument eines nachfolgenden Befehls an.

--next-token

Token, das angibt, wo die Paginierung beginnen soll. Dies ist der Tokenwert aus einer zuvor abgeschnittenen Antwort.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az providerhub notification-registration show

Rufen Sie die Details zur Benachrichtigungsregistrierung ab.

az providerhub notification-registration show [--ids]
                                              [--name]
                                              [--provider-namespace]
                                              [--subscription]

Beispiele

Benachrichtigungsregistrierung anzeigen

az providerhub notification-registration show --name "{notificationRegistration}" --provider-namespace "{providerNamespace}"

Optionale Parameter

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der „Ressource id“-Argumente handeln. Sie sollten entweder „--ids“ oder andere „Resource Id“-Argumente angeben.

--name --notification-registration-name -n

Die Benachrichtigungsregistrierung.

--provider-namespace

Der Name des in ProviderHub gehosteten Ressourcenanbieters.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az providerhub notification-registration update

Aktualisieren sie eine Benachrichtigungsregistrierung.

az providerhub notification-registration update [--add]
                                                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--ids]
                                                [--included-events]
                                                [--message-scope {NotSpecified, RegisteredSubscriptions}]
                                                [--name]
                                                [--notification-endpoints]
                                                [--notification-mode {EventHub, NotSpecified, WebHook}]
                                                [--provider-namespace]
                                                [--remove]
                                                [--set]
                                                [--subscription]

Beispiele

Update zur Benachrichtigungsregistrierung

az providerhub notification-registration update --name "{notificationRegistration}" --included-events "*/write" "Microsoft.Contoso/employees/delete" --message-scope "RegisteredSubscriptions" --notification-endpoints [{notification-destination:/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-eastus/providers/Microsoft.EventHub/namespaces/unitedstates-mgmtexpint/eventhubs/armlinkednotifications,locations:[EastUS]}] --notification-mode "EventHub" --provider-namespace "{providerNamespace}"

Optionale Parameter

--add

Fügen Sie einer Liste von Objekten ein Objekt hinzu, indem Sie ein Pfad- und Schlüsselwertpaar angeben. Beispiel: --add property.listProperty <key=value, string or JSON string>.

--force-string

Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgenliterale bei, anstatt zu versuchen, in JSON zu konvertieren.

Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der „Ressource id“-Argumente handeln. Sie sollten entweder „--ids“ oder andere „Resource Id“-Argumente angeben.

--included-events

Dies sind die Ereignisse, an denen das RP gesendet werden soll. Das Nachrichtenformat befindet sich in der Form {RP Namespace}/{ResourceType}/{action}. Die verfügbaren Aktionen sind: Schreiben, Löschen und Verschieben/Aktion. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

--message-scope

Schränkt die Nachrichten ein, die an das RP gesendet werden. Der Standardwert ist RegisteredSubscriptions. Die verfügbaren Werte sind global (alle Nachrichten in Azure) und RegisteredSubscriptions (nur Nachrichten in Abonnements, die von RP registriert wurden).

Zulässige Werte: NotSpecified, RegisteredSubscriptions
--name --notification-registration-name -n

Die Benachrichtigungsregistrierung.

--notification-endpoints

Dies sind die Speicherorte für die Benachrichtigungen. Benachrichtigungen werden an die Region des Standorts der Ereignisressource gesendet (z. B. vm in East Us sendet Nachrichten an den angegebenen Endpunkt in Ost-US). Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

--notification-mode

Bestimmt, wie die Benachrichtigungen an das RP gesendet werden. Die beiden verfügbaren Modi sind EventHub und Webhook.

Zulässige Werte: EventHub, NotSpecified, WebHook
--provider-namespace

Der Name des in ProviderHub gehosteten Ressourcenanbieters.

--remove

Entfernen sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list OR --remove propertyToRemove.

--set

Aktualisieren Sie ein Objekt, indem Sie einen festzulegenden Eigenschaftspfad und -wert angeben. Beispiel: --set property1.property2=.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.