Delen via


az eventgrid namespace client

Note

This reference is part of the eventgrid extension for the Azure CLI (version 2.51.0 or higher). De extensie installeert automatisch de eerste keer dat u een az eventgrid namespace client opdracht uitvoert. Learn more about extensions.

Opdrachtgroep az eventgrid is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Eventgrid-naamruimteclient beheren.

Opdracht

Name Description Type Status
az eventgrid namespace client create

Maak een client.

Extension Preview
az eventgrid namespace client delete

Een bestaande client verwijderen.

Extension Preview
az eventgrid namespace client list

Geef alle client weer onder een naamruimte.

Extension Preview
az eventgrid namespace client show

Een client weergeven.

Extension Preview
az eventgrid namespace client update

Een client bijwerken.

Extension Preview
az eventgrid namespace client wait

Plaats de CLI in een wachtstatus totdat aan een voorwaarde is voldaan.

Extension Preview

az eventgrid namespace client create

Preview

Opdrachtgroep az eventgrid namespace client is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Maak een 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}]

Voorbeelden

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}"

Vereiste parameters

--client-name --name -n

De clientnaam.

--namespace-name

Naam van de naamruimte.

--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Optionele parameters

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

--attributes

Kenmerken voor de client. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

Eigenschap Waarde
Parameter group: Properties Arguments
--authentication

Verificatiegegevens voor de client. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

Eigenschap Waarde
Parameter group: Properties Arguments
--authentication-name

De naam die door de client voor verificatie wordt weergegeven. De standaardwaarde is de naam van de resource.

Eigenschap Waarde
Parameter group: Properties Arguments
--client-certificate-authentication

De verificatiegegevens van het clientcertificaat. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

Eigenschap Waarde
Parameter group: Properties Arguments
--description

Beschrijving voor de clientresource.

Eigenschap Waarde
Parameter group: Properties Arguments
--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

Eigenschap Waarde
Geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--state

Geeft aan of de client is ingeschakeld of niet. De standaardwaarde is ingeschakeld.

Eigenschap Waarde
Parameter group: Properties Arguments
Default value: Enabled
Geaccepteerde waarden: Disabled, Enabled
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Output format.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az eventgrid namespace client delete

Preview

Opdrachtgroep az eventgrid namespace client is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Een bestaande client verwijderen.

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]

Voorbeelden

Delete client

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

Optionele parameters

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

Naam van de client.

Eigenschap Waarde
Parameter group: Resource Id Arguments
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parameter group: Resource Id Arguments
--namespace-name

Naam van de naamruimte.

Eigenschap Waarde
Parameter group: Resource Id Arguments
--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

Eigenschap Waarde
Geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Eigenschap Waarde
Parameter group: Resource Id Arguments
--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Eigenschap Waarde
Parameter group: Resource Id Arguments
--yes -y

Niet vragen om bevestiging.

Eigenschap Waarde
Default value: False
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Output format.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az eventgrid namespace client list

Preview

Opdrachtgroep az eventgrid namespace client is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Geef alle client weer onder een naamruimte.

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

Voorbeelden

List client

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

Vereiste parameters

--namespace-name

Naam van de naamruimte.

--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Optionele parameters

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

--filter

De query die wordt gebruikt om de zoekresultaten te filteren met behulp van de OData-syntaxis. Filteren is alleen toegestaan voor de eigenschap 'name' en met een beperkt aantal OData-bewerkingen. Deze bewerkingen zijn: de functie 'contains' en de volgende logische bewerkingen: niet, en, of, eq (voor gelijk) en ne (voor niet gelijk). Er worden geen rekenkundige bewerkingen ondersteund. Hier volgt een geldig filtervoorbeeld: $filter=contains(namE, 'PATTERN') en de naam ne 'PATTERN-1'. Hier volgt geen geldig filtervoorbeeld: $filter=location eq 'westus'.

--max-items

Totaal aantal items dat moet worden geretourneerd in de uitvoer van de opdracht. Als het totale aantal beschikbare items groter is dan de opgegeven waarde, wordt een token opgegeven in de uitvoer van de opdracht. Als u paginering wilt hervatten, geeft u de tokenwaarde op in --next-token argument van een volgende opdracht.

Eigenschap Waarde
Parameter group: Pagination Arguments
--next-token

Token om op te geven waar paginering moet worden gestart. Dit is de tokenwaarde van een eerder afgekapt antwoord.

Eigenschap Waarde
Parameter group: Pagination Arguments
--top

Het aantal resultaten dat per pagina moet worden geretourneerd voor de lijstbewerking. Geldig bereik voor topparameter is 1 tot 100. Als dit niet is opgegeven, is het standaardaantal te retourneren resultaten 20 items per pagina.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Output format.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az eventgrid namespace client show

Preview

Opdrachtgroep az eventgrid namespace client is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Een client weergeven.

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

Voorbeelden

Show client

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

Optionele parameters

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

Naam van de client.

Eigenschap Waarde
Parameter group: Resource Id Arguments
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parameter group: Resource Id Arguments
--namespace-name

Naam van de naamruimte.

Eigenschap Waarde
Parameter group: Resource Id Arguments
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Eigenschap Waarde
Parameter group: Resource Id Arguments
--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Eigenschap Waarde
Parameter group: Resource Id Arguments
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Output format.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az eventgrid namespace client update

Preview

Opdrachtgroep az eventgrid namespace client is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Een client bijwerken.

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]

Voorbeelden

Update client

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

Optionele parameters

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

--add

Voeg een object toe aan een lijst met objecten door een pad- en sleutelwaardeparen op te geven. Voorbeeld: --add property.listProperty <key=value, string or JSON string>.

Eigenschap Waarde
Parameter group: Generic Update Arguments
--attributes

Kenmerken voor de client. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

Eigenschap Waarde
Parameter group: Properties Arguments
--authentication

Verificatiegegevens voor de client. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

Eigenschap Waarde
Parameter group: Properties Arguments
--client-certificate-authentication

De verificatiegegevens van het clientcertificaat. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

Eigenschap Waarde
Parameter group: Properties Arguments
--client-name --name -n

Naam van de client.

Eigenschap Waarde
Parameter group: Resource Id Arguments
--description

Beschrijving voor de clientresource.

Eigenschap Waarde
Parameter group: Properties Arguments
--force-string

Wanneer u 'set' of 'toevoegen' gebruikt, behoudt u letterlijke tekenreeksen in plaats van te converteren naar JSON.

Eigenschap Waarde
Parameter group: Generic Update Arguments
Geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parameter group: Resource Id Arguments
--namespace-name

Naam van de naamruimte.

Eigenschap Waarde
Parameter group: Resource Id Arguments
--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

Eigenschap Waarde
Geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--remove

Een eigenschap of element uit een lijst verwijderen. Voorbeeld: --remove property.list <indexToRemove> OF --remove propertyToRemove.

Eigenschap Waarde
Parameter group: Generic Update Arguments
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Eigenschap Waarde
Parameter group: Resource Id Arguments
--set

Werk een object bij door een eigenschapspad en waarde op te geven die u wilt instellen. Voorbeeld: --set property1.property2=<value>.

Eigenschap Waarde
Parameter group: Generic Update Arguments
--state

Geeft aan of de client is ingeschakeld of niet. De standaardwaarde is ingeschakeld.

Eigenschap Waarde
Parameter group: Properties Arguments
Geaccepteerde waarden: Disabled, Enabled
--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Eigenschap Waarde
Parameter group: Resource Id Arguments
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Output format.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az eventgrid namespace client wait

Preview

Opdrachtgroep az eventgrid namespace client is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Plaats de CLI in een wachtstatus totdat aan een voorwaarde is voldaan.

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

Optionele parameters

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

Naam van de client.

Eigenschap Waarde
Parameter group: Resource Id Arguments
--created

Wacht totdat u 'provisioningState' hebt gemaakt bij 'Succeeded'.

Eigenschap Waarde
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wacht tot de voorwaarde voldoet aan een aangepaste JMESPath-query. Bijvoorbeeld provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Eigenschap Waarde
Parameter group: Wait Condition Arguments
--deleted

Wacht totdat deze is verwijderd.

Eigenschap Waarde
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wacht tot de resource bestaat.

Eigenschap Waarde
Parameter group: Wait Condition Arguments
Default value: False
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parameter group: Resource Id Arguments
--interval

Polling-interval in seconden.

Eigenschap Waarde
Parameter group: Wait Condition Arguments
Default value: 30
--namespace-name

Naam van de naamruimte.

Eigenschap Waarde
Parameter group: Resource Id Arguments
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Eigenschap Waarde
Parameter group: Resource Id Arguments
--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Eigenschap Waarde
Parameter group: Resource Id Arguments
--timeout

Maximale wachttijd in seconden.

Eigenschap Waarde
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wacht totdat deze is bijgewerkt met provisioningState op 'Succeeded'.

Eigenschap Waarde
Parameter group: Wait Condition Arguments
Default value: False
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Output format.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False