Condividi tramite

az apim nv

  • Riferimento

Gestire i valori denominati di Gestione API di Azure.

Comandi

Nome Descrizione Tipo Status
az apim nv create

Creare un valore denominato di Gestione API.

 Nucleo GA
az apim nv delete

Eliminare un valore denominato di Gestione API.

 Nucleo GA
az apim nv list

Elencare i valori denominati di Gestione API.

 Nucleo GA
az apim nv show

Visualizzare i dettagli di un valore denominato di Gestione API.

 Nucleo GA
az apim nv show-secret

Ottiene il segreto di un valore denominato di Gestione API.

 Nucleo GA
az apim nv update

Aggiornare un valore denominato di Gestione API.

 Nucleo GA
az apim nv wait

Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione di un valore denominato apim.

 Nucleo GA

az apim nv create

Modifica

Creare un valore denominato di Gestione API.

az apim nv create --display-name
                  --named-value-id
                  --resource-group
                  --service-name
                  [--if-match]
                  [--no-wait]
                  [--secret {false, true}]
                  [--tags]
                  [--value]

Esempio

Creare un valore denominato.

az apim nv create --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --display-name 'My Named Value' --value 'foo'

Parametri necessari

--display-name

Nome visualizzato del valore denominato.

--named-value-id

Nome univoco per il valore denominato da creare.

Deve essere univoco nell'istanza corrente del servizio Gestione API.

--resource-group -g

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

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri facoltativi

--if-match

ETag dell'entità.

--no-wait

Non attendere il completamento dell'operazione a esecuzione prolungata.

Valore predefinito: False
--secret

Determina se il valore è un segreto e deve essere crittografato o meno. Il valore predefinito è false.

Valori accettati: false, true
Valore predefinito: False
--tags

Tag separati da spazi: key[=value] [key[=value] ...]. Usare "" per cancellare i tag esistenti.

--value

Valore di Named Value.

Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato dell'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 posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

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

az apim nv delete

Modifica

Eliminare un valore denominato di Gestione API.

az apim nv delete --named-value-id
                  --resource-group
                  --service-name
                  [--yes]

Parametri necessari

--named-value-id

Identificatore di NamedValue.

--resource-group -g

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

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri facoltativi

--yes -y

Non richiedere conferma.

Valore predefinito: False
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato dell'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 posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

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

az apim nv list

Modifica

Elencare i valori denominati di Gestione API.

az apim nv list --resource-group
                --service-name

Parametri necessari

--resource-group -g

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

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato dell'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 posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

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

az apim nv show

Modifica

Visualizzare i dettagli di un valore denominato di Gestione API.

az apim nv show --named-value-id
                --resource-group
                --service-name

Parametri necessari

--named-value-id

Identificatore di NamedValue.

--resource-group -g

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

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato dell'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 posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

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

az apim nv show-secret

Modifica

Ottiene il segreto di un valore denominato di Gestione API.

az apim nv show-secret --named-value-id
                       --resource-group
                       --service-name

Parametri necessari

--named-value-id

Identificatore di NamedValue.

--resource-group -g

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

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato dell'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 posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

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

az apim nv update

Modifica

Aggiornare un valore denominato di Gestione API.

az apim nv update --named-value-id
                  --resource-group
                  --service-name
                  [--add]
                  [--force-string]
                  [--if-match]
                  [--remove]
                  [--secret {false, true}]
                  [--set]
                  [--tags]
                  [--value]

Esempio

Creare un'API di base.

az apim nv update --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --value foo

Parametri necessari

--named-value-id

Nome univoco dell'API da creare.

Deve essere univoco nell'istanza corrente del servizio Gestione API.

--resource-group -g

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

--service-name -n

Nome dell'istanza del servizio Gestione API.

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

Valore predefinito: []
--force-string

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

Valore predefinito: False
--if-match

ETag dell'entità.

--remove

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

Valore predefinito: []
--secret

Determina se il valore è un segreto e deve essere crittografato o meno. Il valore predefinito è false.

Valori accettati: false, true
--set

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

Valore predefinito: []
--tags

Tag separati da spazi: key[=value] [key[=value] ...]. Usare "" per cancellare i tag esistenti.

--value

Valore di Named Value.

Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato dell'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 posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

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

az apim nv wait

Modifica

Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione di un valore denominato apim.

az apim nv wait --named-value-id
                --resource-group
                --service-name
                [--created]
                [--custom]
                [--deleted]
                [--exists]
                [--interval]
                [--timeout]
                [--updated]

Esempio

Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione di apim.

az apim nv wait --created --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --resource-group MyResourceGroup

Parametri necessari

--named-value-id

Identificatore di NamedValue.

--resource-group -g

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

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri facoltativi

--created

Attendere fino a quando non viene creato con 'provisioningState' in 'Succeeded'.

Valore predefinito: False
--custom

Attendere che la condizione soddisfi una query JMESPath personalizzata. Ad esempio provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Attendere l'eliminazione.

Valore predefinito: False
--exists

Attendere che la risorsa esista.

Valore predefinito: False
--interval

Intervallo di polling in secondi.

Valore predefinito: 30
--timeout

Attesa massima in secondi.

Valore predefinito: 3600
--updated

Attendere fino a quando non viene aggiornato con provisioningState in 'Succeeded'.

Valore predefinito: False
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato dell'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 posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

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