az nginx deployment api-key

Note

Den här referensen är en del av tillägget nginx för Azure CLI (version 2.75.0 eller senare). Tillägget installeras automatiskt första gången du kör ett kommandot az nginx deployment api-key. Läs mer om tillägg.

Hantera API-nycklar för Nginxaas-distribution.

Kommandon

Name Description Typ Status
az nginx deployment api-key create

Skapa en API-nyckel för Nginx-distributionen för att få åtkomst till api-slutpunkten för dataplan.

Extension GA
az nginx deployment api-key delete

Ta bort API-nyckel för Nginx-distribution.

Extension GA
az nginx deployment api-key list

Visa en lista över alla API-nycklar för den angivna Nginx-distributionen.

Extension GA
az nginx deployment api-key show

Hämta den angivna API-nyckeln för den angivna Nginx-distributionen.

Extension GA
az nginx deployment api-key update

Uppdatera en API-nyckel för Nginx-distributionen för att få åtkomst till dataplans-API-slutpunkten.

Extension GA

az nginx deployment api-key create

Skapa en API-nyckel för Nginx-distributionen för att få åtkomst till api-slutpunkten för dataplan.

az nginx deployment api-key create --api-key-name --name
                                   --deployment-name
                                   --resource-group
                                   [--acquire-policy-token]
                                   [--change-reference]
                                   [--end-date-time]
                                   [--secret-text]

Obligatoriska parametrar

--api-key-name --name -n

Resursnamnet för API-nyckeln.

--deployment-name

Namnet på den riktade NGINX-distributionen.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--end-date-time

Den tid efter vilken den här API-nyckeln för dataplan inte längre är giltig.

Egenskap Värde
Parametergrupp: Properties Arguments
--secret-text

Hemlig text som ska användas som en API-nyckel för dataplan. Det här är en skrivskyddad egenskap som aldrig kan läsas tillbaka, men de tre första tecknen returneras i egenskapen "hint". Om värdet är tomt efterfrågas det från tty.tty.

Egenskap Värde
Parametergrupp: Properties Arguments
Globala parametrar
--debug

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

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

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

Egenskap Värde
Standardvärde: False

az nginx deployment api-key delete

Ta bort API-nyckel för Nginx-distribution.

az nginx deployment api-key delete [--acquire-policy-token]
                                   [--api-key-name --name]
                                   [--change-reference]
                                   [--deployment-name]
                                   [--ids]
                                   [--resource-group]
                                   [--subscription]
                                   [--yes]

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--api-key-name --name -n

Resursnamnet för API-nyckeln.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--deployment-name

Namnet på den riktade NGINX-distributionen.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--ids

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

Egenskap Värde
Parametergrupp: Resource Id Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--yes -y

Fråga inte efter bekräftelse.

Egenskap Värde
Standardvärde: False
Globala parametrar
--debug

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

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Egenskap Värde
Standardvärde: False

az nginx deployment api-key list

Visa en lista över alla API-nycklar för den angivna Nginx-distributionen.

az nginx deployment api-key list --deployment-name
                                 --resource-group
                                 [--max-items]
                                 [--next-token]

Obligatoriska parametrar

--deployment-name

Namnet på den riktade NGINX-distributionen.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--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 argument för ett efterföljande kommando.

Egenskap Värde
Parametergrupp: Pagination Arguments
--next-token

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

Egenskap Värde
Parametergrupp: Pagination Arguments
Globala parametrar
--debug

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

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

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

Egenskap Värde
Standardvärde: False

az nginx deployment api-key show

Hämta den angivna API-nyckeln för den angivna Nginx-distributionen.

az nginx deployment api-key show [--api-key-name --name]
                                 [--deployment-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--api-key-name --name -n

Resursnamnet för API-nyckeln.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--deployment-name

Namnet på den riktade NGINX-distributionen.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--ids

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

Egenskap Värde
Parametergrupp: Resource Id Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap Värde
Parametergrupp: Resource Id Arguments
Globala parametrar
--debug

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

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Egenskap Värde
Standardvärde: False

az nginx deployment api-key update

Uppdatera en API-nyckel för Nginx-distributionen för att få åtkomst till dataplans-API-slutpunkten.

az nginx deployment api-key update [--acquire-policy-token]
                                   [--add]
                                   [--api-key-name --name]
                                   [--change-reference]
                                   [--deployment-name]
                                   [--end-date-time]
                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--ids]
                                   [--remove]
                                   [--resource-group]
                                   [--secret-text]
                                   [--set]
                                   [--subscription]

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--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 or JSON string>.

Egenskap Värde
Parametergrupp: Generic Update Arguments
--api-key-name --name -n

Resursnamnet för API-nyckeln.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--deployment-name

Namnet på den riktade NGINX-distributionen.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--end-date-time

Den tid efter vilken den här API-nyckeln för dataplan inte längre är giltig.

Egenskap Värde
Parametergrupp: Properties Arguments
--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.

Egenskap Värde
Parametergrupp: Generic Update Arguments
Godkända 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 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--remove

Ta bort en egenskap eller ett element från en lista. Exempel: --remove property.list <indexToRemove> ELLER --remove propertyToRemove.

Egenskap Värde
Parametergrupp: Generic Update Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--secret-text

Hemlig text som ska användas som en API-nyckel för dataplan. Det här är en skrivskyddad egenskap som aldrig kan läsas tillbaka, men de tre första tecknen returneras i egenskapen "hint". Om värdet är tomt efterfrågas det från tty.tty.

Egenskap Värde
Parametergrupp: Properties Arguments
--set

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

Egenskap Värde
Parametergrupp: Generic Update Arguments
--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap Värde
Parametergrupp: Resource Id Arguments
Globala parametrar
--debug

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

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Egenskap Värde
Standardvärde: False