Delen via

az nginx deployment api-key

Note

Deze verwijzing maakt deel uit van de nginx-extensie voor de Azure CLI (versie 2.75.0 of hoger). De extensie installeert automatisch de eerste keer dat u een az nginx deployment api-key opdracht uitvoert. Meer informatie over uitbreidingen.

Nginxaas-implementatie-API-sleutels beheren.

Opdracht

Name Description Type Status
az nginx deployment api-key create

Maak een API-sleutel voor de Nginx-implementatie om toegang te krijgen tot het dataplane API-eindpunt.

 Extension GA
az nginx deployment api-key delete

Verwijder de API-sleutel voor Nginx-implementatie.

 Extension GA
az nginx deployment api-key list

Geef alle API-sleutels van de opgegeven Nginx-implementatie weer.

 Extension GA
az nginx deployment api-key show

Haal de opgegeven API-sleutel van de opgegeven Nginx-implementatie op.

 Extension GA
az nginx deployment api-key update

Werk een API-sleutel voor de Nginx-implementatie bij om toegang te krijgen tot het dataplane API-eindpunt.

 Extension GA

az nginx deployment api-key create

Maak een API-sleutel voor de Nginx-implementatie om toegang te krijgen tot het dataplane API-eindpunt.

az nginx deployment api-key create --api-key-name --name
                                   --deployment-name
                                   --resource-group
                                   [--end-date-time]
                                   [--secret-text]

Vereiste parameters

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

De resourcenaam van de API-sleutel.

--deployment-name

De naam van de beoogde NGINX-implementatie.

--resource-group -g

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

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--end-date-time

De tijd waarna deze Dataplane API-sleutel niet meer geldig is.

Eigenschap Waarde
Parametergroep: Properties Arguments
--secret-text

Geheime tekst die moet worden gebruikt als een Dataplane API-sleutel. Dit is een alleen-schrijven-eigenschap die nooit kan worden gelezen, maar de eerste drie tekens worden geretourneerd in de eigenschap Hint. Als de waarde leeg is, wordt deze door de tty gevraagd.

Eigenschap Waarde
Parametergroep: Properties 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

Uitvoerindeling.

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 nginx deployment api-key delete

Verwijder de API-sleutel voor Nginx-implementatie.

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

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

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

De resourcenaam van de API-sleutel.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--deployment-name

De naam van de beoogde NGINX-implementatie.

Eigenschap Waarde
Parametergroep: 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
Parametergroep: Resource Id Arguments
--resource-group -g

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

Eigenschap Waarde
Parametergroep: 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
Parametergroep: 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

Uitvoerindeling.

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 nginx deployment api-key list

Geef alle API-sleutels van de opgegeven Nginx-implementatie weer.

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

Vereiste parameters

--deployment-name

De naam van de beoogde NGINX-implementatie.

--resource-group -g

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

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--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
Parametergroep: 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
Parametergroep: Pagination 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

Uitvoerindeling.

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 nginx deployment api-key show

Haal de opgegeven API-sleutel van de opgegeven Nginx-implementatie op.

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

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

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

De resourcenaam van de API-sleutel.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--deployment-name

De naam van de beoogde NGINX-implementatie.

Eigenschap Waarde
Parametergroep: 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
Parametergroep: Resource Id Arguments
--resource-group -g

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

Eigenschap Waarde
Parametergroep: 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
Parametergroep: 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

Uitvoerindeling.

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 nginx deployment api-key update

Werk een API-sleutel voor de Nginx-implementatie bij om toegang te krijgen tot het dataplane API-eindpunt.

az nginx deployment api-key update [--add]
                                   [--api-key-name --name]
                                   [--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]

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--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
Parametergroep: Generic Update Arguments
--api-key-name --name -n

De resourcenaam van de API-sleutel.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--deployment-name

De naam van de beoogde NGINX-implementatie.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--end-date-time

De tijd waarna deze Dataplane API-sleutel niet meer geldig is.

Eigenschap Waarde
Parametergroep: Properties Arguments
--force-string

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

Eigenschap Waarde
Parametergroep: 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
Parametergroep: Resource Id Arguments
--remove

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

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

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

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--secret-text

Geheime tekst die moet worden gebruikt als een Dataplane API-sleutel. Dit is een alleen-schrijven-eigenschap die nooit kan worden gelezen, maar de eerste drie tekens worden geretourneerd in de eigenschap Hint. Als de waarde leeg is, wordt deze door de tty gevraagd.

Eigenschap Waarde
Parametergroep: Properties 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
Parametergroep: Generic Update Arguments
--subscription

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

Eigenschap Waarde
Parametergroep: 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

Uitvoerindeling.

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