az eventgrid namespace client

Vorschau

Note

This reference is part of the eventgrid extension for the Azure CLI (version 2.51.0 or higher). Die Erweiterung wird automatisch installiert, wenn Sie einen az eventgrid-Namespaceclient Befehl ausführen. Learn more about extensions.

Die Befehlsgruppe "az eventgrid" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Verwalten des Eventgrid-Namespaceclients.

Befehle

Name	Beschreibung	Typ	Status
az eventgrid namespace client create	Erstellen Sie einen Client.	Extension	Preview
az eventgrid namespace client delete	Löschen eines vorhandenen Clients.	Extension	Preview
az eventgrid namespace client list	Listet den gesamten Client unter einem Namespace auf.	Extension	Preview
az eventgrid namespace client show	Zeigen Sie einen Client an.	Extension	Preview
az eventgrid namespace client update	Aktualisieren eines Clients.	Extension	Preview
az eventgrid namespace client wait	Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung erfüllt ist.	Extension	Preview

az eventgrid namespace client create

Vorschau

Die Befehlsgruppe "az eventgrid namespace client" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Erstellen Sie einen Client.

az eventgrid namespace client create --client-name --name
                                     --namespace-name
                                     --resource-group
                                     [--attributes]
                                     [--authentication]
                                     [--authentication-name]
                                     [--client-certificate-authentication]
                                     [--description]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--state {Disabled, Enabled}]

Beispiele

Create client

az eventgrid namespace client create -g rg --namespace-name name -n client-name  --attributes "{'room':'345','floor':5}" --client-certificate-authentication "{validationScheme:SubjectMatchesAuthenticationName}"

Erforderliche Parameter

--client-name --name -n

Der Clientname.

--namespace-name

Name des Namespace.

--resource-group -g

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

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--attributes

Attribute für den Client. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

Eigenschaft	Wert
Parameter group:	Properties Arguments

--authentication

Authentifizierungsinformationen für den Client. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

Eigenschaft	Wert
Parameter group:	Properties Arguments

--authentication-name

Der vom Client für die Authentifizierung dargestellte Name. Der Standardwert ist der Name der Ressource.

Eigenschaft	Wert
Parameter group:	Properties Arguments

--client-certificate-authentication

Die Clientzertifikatauthentifizierungsinformationen. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

Eigenschaft	Wert
Parameter group:	Properties Arguments

--description

Beschreibung für die Clientressource.

Eigenschaft	Wert
Parameter group:	Properties Arguments

--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

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

--state

Gibt an, ob der Client aktiviert ist oder nicht. Der Standardwert ist aktiviert.

Eigenschaft	Wert
Parameter group:	Properties Arguments
Standardwert:	Enabled
Zulässige Werte:	Disabled, Enabled

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Output format.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az eventgrid namespace client delete

Vorschau

Die Befehlsgruppe "az eventgrid namespace client" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Löschen eines vorhandenen Clients.

az eventgrid namespace client delete [--client-name --name]
                                     [--ids]
                                     [--namespace-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--subscription]
                                     [--yes]

Beispiele

Delete client

az eventgrid namespace client delete -g rg --namespace-name name -n client-name

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--client-name --name -n

Name des Clients.

Eigenschaft	Wert
Parameter group:	Resource Id Arguments

--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

Eigenschaft	Wert
Parameter group:	Resource Id Arguments

--namespace-name

Name des Namespace.

Eigenschaft	Wert
Parameter group:	Resource Id Arguments

--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

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

--resource-group -g

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

Eigenschaft	Wert
Parameter group:	Resource Id Arguments

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft	Wert
Parameter group:	Resource Id Arguments

--yes -y

Zur Bestätigung nicht auffordern.

Eigenschaft	Wert
Standardwert:	False

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Output format.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az eventgrid namespace client list

Vorschau

Die Befehlsgruppe "az eventgrid namespace client" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Listet den gesamten Client unter einem Namespace auf.

az eventgrid namespace client list --namespace-name
                                   --resource-group
                                   [--filter]
                                   [--max-items]
                                   [--next-token]
                                   [--top]

Beispiele

List client

az eventgrid namespace client list -g rg --namespace-name name

Erforderliche Parameter

--namespace-name

Name des Namespace.

--resource-group -g

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

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--filter

Die Abfrage zum Filtern der Suchergebnisse mithilfe der OData-Syntax. Filterung ist nur für die Eigenschaft "name" und mit begrenzter Anzahl von OData-Vorgängen zulässig. Diese Vorgänge sind: die Funktion "contains" sowie die folgenden logischen Vorgänge: not, and, and, or, eq (for equal) and ne (for not equal). Es werden keine arithmetischen Vorgänge unterstützt. Es folgt ein gültiges Filterbeispiel: $filter=contains(namE, 'PATTERN') und name ne 'PATTERN-1'. Es folgt kein gültiges Filterbeispiel: $filter=location eq 'westus'.

--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 in --next-token Argument eines nachfolgenden Befehls an.

Eigenschaft	Wert
Parameter group:	Pagination Arguments

--next-token

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

Eigenschaft	Wert
Parameter group:	Pagination Arguments

--top

Die Anzahl der Ergebnisse, die pro Seite für den Listenvorgang zurückgegeben werden sollen. Der gültige Bereich für den oberen Parameter beträgt 1 bis 100. Wenn nicht angegeben, beträgt die Standardanzahl der zurückgegebenen Ergebnisse 20 Elemente pro Seite.

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Output format.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az eventgrid namespace client show

Vorschau

Die Befehlsgruppe "az eventgrid namespace client" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Zeigen Sie einen Client an.

az eventgrid namespace client show [--client-name --name]
                                   [--ids]
                                   [--namespace-name]
                                   [--resource-group]
                                   [--subscription]

Beispiele

Show client

az eventgrid namespace client show -g rg --namespace-name name -n client-name

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--client-name --name -n

Name des Clients.

Eigenschaft	Wert
Parameter group:	Resource Id Arguments

--ids

Eigenschaft	Wert
Parameter group:	Resource Id Arguments

--namespace-name

Name des Namespace.

Eigenschaft	Wert
Parameter group:	Resource Id Arguments

--resource-group -g

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

Eigenschaft	Wert
Parameter group:	Resource Id Arguments

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft	Wert
Parameter group:	Resource Id Arguments

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Output format.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az eventgrid namespace client update

Vorschau

Die Befehlsgruppe "az eventgrid namespace client" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Aktualisieren eines Clients.

az eventgrid namespace client update [--add]
                                     [--attributes]
                                     [--authentication]
                                     [--client-certificate-authentication]
                                     [--client-name --name]
                                     [--description]
                                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--ids]
                                     [--namespace-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--remove]
                                     [--resource-group]
                                     [--set]
                                     [--state {Disabled, Enabled}]
                                     [--subscription]

Beispiele

Update client

az eventgrid namespace client update -g rg --namespace-name name -n client-name --description test

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Eigenschaft	Wert
Parameter group:	Generic Update Arguments

--attributes

Attribute für den Client. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

Eigenschaft	Wert
Parameter group:	Properties Arguments

--authentication

Authentifizierungsinformationen für den Client. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

Eigenschaft	Wert
Parameter group:	Properties Arguments

--client-certificate-authentication

Die Clientzertifikatauthentifizierungsinformationen. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

Eigenschaft	Wert
Parameter group:	Properties Arguments

--client-name --name -n

Name des Clients.

Eigenschaft	Wert
Parameter group:	Resource Id Arguments

--description

Beschreibung für die Clientressource.

Eigenschaft	Wert
Parameter group:	Properties Arguments

--force-string

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

Eigenschaft	Wert
Parameter group:	Generic Update Arguments
Zulässige Werte:	0, 1, f, false, n, no, t, true, y, yes

--ids

Eigenschaft	Wert
Parameter group:	Resource Id Arguments

--namespace-name

Name des Namespace.

Eigenschaft	Wert
Parameter group:	Resource Id Arguments

--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

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

--remove

Entfernen sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list <indexToRemove> ODER --remove propertyToRemove.

Eigenschaft	Wert
Parameter group:	Generic Update Arguments

--resource-group -g

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

Eigenschaft	Wert
Parameter group:	Resource Id Arguments

--set

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

Eigenschaft	Wert
Parameter group:	Generic Update Arguments

--state

Gibt an, ob der Client aktiviert ist oder nicht. Der Standardwert ist aktiviert.

Eigenschaft	Wert
Parameter group:	Properties Arguments
Zulässige Werte:	Disabled, Enabled

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft	Wert
Parameter group:	Resource Id Arguments

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Output format.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az eventgrid namespace client wait

Vorschau

Die Befehlsgruppe "az eventgrid namespace client" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung erfüllt ist.

az eventgrid namespace client wait [--client-name --name]
                                   [--created]
                                   [--custom]
                                   [--deleted]
                                   [--exists]
                                   [--ids]
                                   [--interval]
                                   [--namespace-name]
                                   [--resource-group]
                                   [--subscription]
                                   [--timeout]
                                   [--updated]

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--client-name --name -n

Name des Clients.

Eigenschaft	Wert
Parameter group:	Resource Id Arguments

--created

Warten Sie, bis sie mit 'provisioningState' unter 'Succeeded' erstellt wurde.

Eigenschaft	Wert
Parameter group:	Wait Condition Arguments
Standardwert:	False

--custom

Warten Sie, bis die Bedingung eine benutzerdefinierte JMESPath-Abfrage erfüllt. Beispiel: provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Eigenschaft	Wert
Parameter group:	Wait Condition Arguments

--deleted

Warten Sie, bis sie gelöscht wurde.

Eigenschaft	Wert
Parameter group:	Wait Condition Arguments
Standardwert:	False

--exists

Warten Sie, bis die Ressource vorhanden ist.

Eigenschaft	Wert
Parameter group:	Wait Condition Arguments
Standardwert:	False

--ids

Eigenschaft	Wert
Parameter group:	Resource Id Arguments

--interval

Abrufintervall in Sekunden.

Eigenschaft	Wert
Parameter group:	Wait Condition Arguments
Standardwert:	30

--namespace-name

Name des Namespace.

Eigenschaft	Wert
Parameter group:	Resource Id Arguments

--resource-group -g

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

Eigenschaft	Wert
Parameter group:	Resource Id Arguments

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft	Wert
Parameter group:	Resource Id Arguments

--timeout

Maximale Wartezeit in Sekunden.

Eigenschaft	Wert
Parameter group:	Wait Condition Arguments
Standardwert:	3600

--updated

Warten Sie, bis sie mit provisioningState unter 'Succeeded' aktualisiert wurde.

Eigenschaft	Wert
Parameter group:	Wait Condition Arguments
Standardwert:	False

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Output format.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

Freigeben über

az eventgrid namespace client

Befehle

az eventgrid namespace client create

Beispiele

Erforderliche Parameter

Optionale Parameter

az eventgrid namespace client delete

Beispiele

Optionale Parameter

az eventgrid namespace client list

Beispiele

Erforderliche Parameter

Optionale Parameter

az eventgrid namespace client show

Beispiele

Optionale Parameter

az eventgrid namespace client update

Beispiele

Optionale Parameter

az eventgrid namespace client wait

Optionale Parameter

Feedback