az nginx deployment api-key

Notitie

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

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.	Extensie	GA
az nginx deployment api-key delete	Verwijder de API-sleutel voor Nginx-implementatie.	Extensie	GA
az nginx deployment api-key list	Geef alle API-sleutels van de opgegeven Nginx-implementatie weer.	Extensie	GA
az nginx deployment api-key show	Haal de opgegeven API-sleutel van de opgegeven Nginx-implementatie op.	Extensie	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.	Extensie	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
                                   --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

--end-date-time

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

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

Globale parameters

--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az nginx deployment api-key delete

Verwijder de API-sleutel voor Nginx-implementatie.

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

Optionele parameters

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

De resourcenaam van de API-sleutel.

--deployment-name

De naam van de beoogde NGINX-implementatie.

--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. Geef de argumenten --id's of andere resource-id's op.

--resource-group -g

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

--subscription

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

--yes -y

Niet vragen om bevestiging.

Default value: False

Globale parameters

--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

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

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

--next-token

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

Globale parameters

--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

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]
                                 [--deployment-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

Optionele parameters

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

De resourcenaam van de API-sleutel.

--deployment-name

De naam van de beoogde NGINX-implementatie.

--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. Geef de argumenten --id's of andere resource-id's op.

--resource-group -g

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

--subscription

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

Globale parameters

--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

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]
                                   [--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

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

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

De resourcenaam van de API-sleutel.

--deployment-name

De naam van de beoogde NGINX-implementatie.

--end-date-time

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

--force-string

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

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. Geef de argumenten --id's of andere resource-id's op.

--remove

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

--resource-group -g

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

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

--set

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

--subscription

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

Globale parameters

--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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