az eventgrid namespace client

Kommentar

Den här referensen är en del av eventgrid-tillägget för Azure CLI (version 2.51.0 eller senare). Tillägget installeras automatiskt första gången du kör ett az eventgrid-namnområdesklientkommando . Läs mer om tillägg.

Kommandogruppen "az eventgrid" finns i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Hantera eventgrid-namnområdesklient.

Kommandon

Name Description Typ Status
az eventgrid namespace client create

Skapa en klient.

Anknytning Förhandsgranska
az eventgrid namespace client delete

Ta bort en befintlig klient.

Anknytning Förhandsgranska
az eventgrid namespace client list

Visa en lista över alla klienter under ett namnområde.

Anknytning Förhandsgranska
az eventgrid namespace client show

Visa en klient.

Anknytning Förhandsgranska
az eventgrid namespace client update

Uppdatera en klient.

Anknytning Förhandsgranska
az eventgrid namespace client wait

Placera CLI i vänteläge tills ett villkor uppfylls.

Anknytning Förhandsgranska

az eventgrid namespace client create

Förhandsgranskning

Kommandogruppen "az eventgrid namespace client" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Skapa en klient.

az eventgrid namespace client create --client-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}]

Exempel

Skapa en klient

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

Obligatoriska parametrar

--client-name --name -n

Klientnamnet.

--namespace-name

Namnområdets namnområde.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Valfria parametrar

--attributes

Attribut för klienten. Stöd för json-file och yaml-file.

--authentication

Autentiseringsinformation för klienten. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

--authentication-name

Det namn som klienten har presenterat för autentisering. Standardvärdet är namnet på resursen.

--client-certificate-authentication

Autentiseringsinformation för klientcertifikat. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

--description

Beskrivning för klientresursen.

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

accepterade värden: 0, 1, f, false, n, no, t, true, y, yes
--state

Anger om klienten är aktiverad eller inte. Standardvärdet är Aktiverat.

accepterade värden: Disabled, Enabled
standardvärde: Enabled
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az eventgrid namespace client delete

Förhandsgranskning

Kommandogruppen "az eventgrid namespace client" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Ta bort en befintlig klient.

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

Exempel

Ta bort klient

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

Valfria parametrar

--client-name --name -n

Namnet på klienten.

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--namespace-name

Namnområdets namnområde.

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

accepterade värden: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--yes -y

Fråga inte efter bekräftelse.

standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az eventgrid namespace client list

Förhandsgranskning

Kommandogruppen "az eventgrid namespace client" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Visa en lista över alla klienter under ett namnområde.

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

Exempel

Lista klient

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

Obligatoriska parametrar

--namespace-name

Namnområdets namnområde.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Valfria parametrar

--filter

Frågan som används för att filtrera sökresultaten med hjälp av OData-syntax. Filtrering tillåts endast för egenskapen "name" och med ett begränsat antal OData-åtgärder. Dessa åtgärder är: funktionen "contains" samt följande logiska åtgärder: inte, och, eller, eq (för lika) och ne (för inte lika med). Inga aritmetiska åtgärder stöds. Följande är ett giltigt filterexempel: $filter=contains(namE, 'PATTERN') och name ne 'PATTERN-1'. Följande är inte ett giltigt filterexempel: $filter=location eq 'westus'.

--max-items

Totalt antal objekt som ska returneras i kommandots utdata. Om det totala antalet tillgängliga objekt är mer än det angivna värdet anges en token i kommandots utdata. Om du vill återuppta sidnumreringen anger du tokenvärdet i --next-token argumentet för ett efterföljande kommando.

--next-token

Token för att ange var sidnumrering ska börja. Detta är tokenvärdet från ett tidigare trunkerat svar.

--top

Antalet resultat som ska returneras per sida för liståtgärden. Giltigt intervall för den översta parametern är 1 till 100. Om det inte anges är standardantalet resultat som ska returneras 20 objekt per sida.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az eventgrid namespace client show

Förhandsgranskning

Kommandogruppen "az eventgrid namespace client" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Visa en klient.

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

Exempel

Visa klient

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

Valfria parametrar

--client-name --name -n

Namnet på klienten.

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--namespace-name

Namnområdets namnområde.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az eventgrid namespace client update

Förhandsgranskning

Kommandogruppen "az eventgrid namespace client" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Uppdatera en klient.

az eventgrid namespace client update [--add]
                                     [--attributes]
                                     [--authentication]
                                     [--client-certificate-authentication]
                                     [--client-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]

Exempel

Uppdatera klienten

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

Valfria parametrar

--add

Lägg till ett objekt i en lista över objekt genom att ange en sökväg och nyckelvärdepar. Exempel: --add property.listProperty <key=value, string eller JSON string>.

--attributes

Attribut för klienten. Stöd för json-file och yaml-file.

--authentication

Autentiseringsinformation för klienten. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

--client-certificate-authentication

Autentiseringsinformation för klientcertifikat. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

--client-name --name -n

Namnet på klienten.

--description

Beskrivning för klientresursen.

--force-string

När du använder "set" eller "add" bevarar du strängliteraler i stället för att försöka konvertera till JSON.

accepterade värden: 0, 1, f, false, n, no, t, true, y, yes
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--namespace-name

Namnområdets namnområde.

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

accepterade värden: 0, 1, f, false, n, no, t, true, y, yes
--remove

Ta bort en egenskap eller ett element från en lista. Exempel: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--set

Uppdatera ett objekt genom att ange en egenskapssökväg och ett värde som ska anges. Exempel: --set property1.property2=.

--state

Anger om klienten är aktiverad eller inte. Standardvärdet är Aktiverat.

accepterade värden: Disabled, Enabled
--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az eventgrid namespace client wait

Förhandsgranskning

Kommandogruppen "az eventgrid namespace client" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Placera CLI i vänteläge tills ett villkor uppfylls.

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

Valfria parametrar

--client-name --name -n

Namnet på klienten.

--created

Vänta tills du har skapat med "provisioningState" på "Lyckades".

standardvärde: False
--custom

Vänta tills villkoret uppfyller en anpassad JMESPath-fråga. T.ex. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Vänta tills den har tagits bort.

standardvärde: False
--exists

Vänta tills resursen finns.

standardvärde: False
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--interval

Avsökningsintervall i sekunder.

standardvärde: 30
--namespace-name

Namnområdets namnområde.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--timeout

Maximal väntetid i sekunder.

standardvärde: 3600
--updated

Vänta tills det har uppdaterats med provisioningState på Lyckades.

standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.