az nginx deployment api-key

Nota

Questo riferimento fa parte dell'estensione nginx per l'interfaccia della riga di comando di Azure (versione 2.68.0 o successiva). L'estensione installerà automaticamente la prima volta che si esegue un comando az nginx deployment api-key. Altre sulle estensioni.

Gestione delle chiavi API di distribuzione Nginxaas.

Comandi

Nome	Descrizione	Tipo	Status
az nginx deployment api-key create	Creare una chiave API per la distribuzione Nginx per accedere all'endpoint dell'API del piano dati.	Estensione	GA
az nginx deployment api-key delete	Eliminare la chiave API per la distribuzione di Nginx.	Estensione	GA
az nginx deployment api-key list	Elencare tutte le chiavi API della distribuzione Nginx specificata.	Estensione	GA
az nginx deployment api-key show	Ottenere la chiave API specificata della distribuzione Nginx specificata.	Estensione	GA
az nginx deployment api-key update	Aggiornare una chiave API per la distribuzione Nginx per accedere all'endpoint dell'API del piano dati.	Estensione	GA

az nginx deployment api-key create

Creare una chiave API per la distribuzione Nginx per accedere all'endpoint dell'API del piano dati.

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

Parametri necessari

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

Nome della risorsa della chiave API.

--deployment-name

Nome della distribuzione NGINX di destinazione.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>.

Parametri facoltativi

--end-date-time

Ora dopo la quale questa chiave API del piano dati non è più valida.

--secret-text

Testo segreto da usare come chiave API del piano dati. Si tratta di una proprietà di sola scrittura che non può mai essere letta, ma i primi tre caratteri verranno restituiti nella proprietà 'hint'. Se il valore è vuoto, viene chiesto dal tty.

Parametri globali

--debug

Aumentare il livello di dettaglio della registrazione per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio della Guida e esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc

Valore predefinito: json

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per i log di debug completi.

az nginx deployment api-key delete

Eliminare la chiave API per la distribuzione di Nginx.

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

Parametri facoltativi

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

Nome della risorsa della chiave API.

--deployment-name

Nome della distribuzione NGINX di destinazione.

--ids

Uno o più ID risorsa (delimitati da spazi). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti "ID risorsa". È necessario specificare --ids o altri argomenti "ID risorsa".

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--yes -y

Non richiedere conferma.

Valore predefinito: False

Parametri globali

--debug

Aumentare il livello di dettaglio della registrazione per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio della Guida e esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc

Valore predefinito: json

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per i log di debug completi.

az nginx deployment api-key list

Elencare tutte le chiavi API della distribuzione Nginx specificata.

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

Parametri necessari

--deployment-name

Nome della distribuzione NGINX di destinazione.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>.

Parametri facoltativi

--max-items

Numero totale di elementi da restituire nell'output del comando. Se il numero totale di elementi disponibili è maggiore del valore specificato, nell'output del comando viene fornito un token. Per riprendere la paginazione, specificare il valore del token in --next-token argomento di un comando successivo.

--next-token

Token per specificare dove iniziare la paginazione. Si tratta del valore del token di una risposta troncata in precedenza.

Parametri globali

--debug

Aumentare il livello di dettaglio della registrazione per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio della Guida e esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc

Valore predefinito: json

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per i log di debug completi.

az nginx deployment api-key show

Ottenere la chiave API specificata della distribuzione Nginx specificata.

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

Parametri facoltativi

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

Nome della risorsa della chiave API.

--deployment-name

Nome della distribuzione NGINX di destinazione.

--ids

Uno o più ID risorsa (delimitati da spazi). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti "ID risorsa". È necessario specificare --ids o altri argomenti "ID risorsa".

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

Parametri globali

--debug

Aumentare il livello di dettaglio della registrazione per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio della Guida e esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc

Valore predefinito: json

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per i log di debug completi.

az nginx deployment api-key update

Aggiornare una chiave API per la distribuzione Nginx per accedere all'endpoint dell'API del piano dati.

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]

Parametri facoltativi

--add

Aggiungere un oggetto a un elenco di oggetti specificando un percorso e coppie chiave-valore. Esempio: --add property.listProperty <key=value, string or JSON string>.

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

Nome della risorsa della chiave API.

--deployment-name

Nome della distribuzione NGINX di destinazione.

--end-date-time

Ora dopo la quale questa chiave API del piano dati non è più valida.

--force-string

Quando si usa 'set' o 'add', mantenere i valori letterali stringa anziché tentare di eseguire la conversione in JSON.

Valori accettati: 0, 1, f, false, n, no, t, true, y, yes

--ids

Uno o più ID risorsa (delimitati da spazi). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti "ID risorsa". È necessario specificare --ids o altri argomenti "ID risorsa".

--remove

Rimuovere una proprietà o un elemento da un elenco. Esempio: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>.

--secret-text

Testo segreto da usare come chiave API del piano dati. Si tratta di una proprietà di sola scrittura che non può mai essere letta, ma i primi tre caratteri verranno restituiti nella proprietà 'hint'. Se il valore è vuoto, viene chiesto dal tty.

--set

Aggiornare un oggetto specificando un percorso di proprietà e un valore da impostare. Esempio: --set property1.property2=<value>.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

Parametri globali

--debug

Aumentare il livello di dettaglio della registrazione per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio della Guida e esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc

Valore predefinito: json

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per i log di debug completi.