az keyvault secret

  • Riferimento

Gestire i segreti.

Comandi

Nome Descrizione Tipo Status
az keyvault secret backup

Esegue il backup del segreto specificato.

 Memoria centrale Disponibilità generale
az keyvault secret delete

Eliminare tutte le versioni di un segreto.

 Memoria centrale Deprecato
az keyvault secret download

Scaricare un segreto da un insieme di credenziali delle chiavi.

 Memoria centrale Disponibilità generale
az keyvault secret list

Elencare i segreti in un insieme di credenziali delle chiavi specificato.

 Memoria centrale Disponibilità generale
az keyvault secret list-deleted

Elenca i segreti eliminati per l'insieme di credenziali specificato.

 Memoria centrale Disponibilità generale
az keyvault secret list-versions

Elencare tutte le versioni del segreto specificato.

 Memoria centrale Disponibilità generale
az keyvault secret purge

Elimina definitivamente il segreto specificato.

 Memoria centrale Disponibilità generale
az keyvault secret recover

Recupera il segreto eliminato nella versione più recente.

 Memoria centrale Disponibilità generale
az keyvault secret restore

Ripristina un segreto sottoposto a backup in un insieme di credenziali.

 Memoria centrale Disponibilità generale
az keyvault secret set

Creare un segreto (se non esiste) o aggiornare un segreto in un insieme di credenziali delle chiavi.

 Memoria centrale Disponibilità generale
az keyvault secret set-attributes

Aggiornamenti gli attributi associati a un segreto specificato in un determinato insieme di credenziali delle chiavi.

 Memoria centrale Disponibilità generale
az keyvault secret show

Ottenere un segreto specificato da un determinato insieme di credenziali delle chiavi.

 Memoria centrale Disponibilità generale
az keyvault secret show-deleted

Ottiene il segreto eliminato specificato.

 Memoria centrale Disponibilità generale

az keyvault secret backup

Modifica

Esegue il backup del segreto specificato.

Richiede il download di un backup del segreto specificato nel client. Tutte le versioni del segreto verranno scaricate. Questa operazione richiede l'autorizzazione segreti/backup.

az keyvault secret backup --file
                          [--id]
                          [--name]
                          [--vault-name]

Parametri necessari

--file -f

File per ricevere il contenuto del segreto.

Parametri facoltativi

--id

ID del segreto. Se si specificano tutti gli altri argomenti 'Id' devono essere omessi.

--name -n

Nome del segreto. Obbligatorio se --id non è specificato.

--vault-name

Nome dell'insieme di credenziali delle chiavi. Obbligatorio se --id non è specificato.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

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

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

az keyvault secret delete

Modifica
Deprecato

Avviso Se è abilitata la protezione per l'eliminazione temporanea in questo insieme di credenziali delle chiavi, questo segreto verrà spostato nello stato di eliminazione temporanea. Non sarà possibile creare un segreto con lo stesso nome all'interno di questo insieme di credenziali delle chiavi fino a quando il segreto non è stato eliminato definitivamente dallo stato eliminato temporaneamente. Per altre indicazioni, vedere la documentazione seguente. https://docs.microsoft.com/azure/key-vault/general/soft-delete-overview

Eliminare tutte le versioni di un segreto.

Richiede l'autorizzazione segreti/eliminazione. Quando questo metodo restituisce Key Vault ha iniziato a eliminare il segreto. L'eliminazione può richiedere alcuni secondi in un insieme di credenziali con eliminazione temporanea abilitata. Questo metodo restituisce quindi un poller che consente di attendere il completamento dell'eliminazione.

az keyvault secret delete [--id]
                          [--name]
                          [--vault-name]

Parametri facoltativi

--id

ID del segreto. Se si specificano tutti gli altri argomenti 'Id' devono essere omessi.

--name -n

Nome del segreto. Obbligatorio se --id non è specificato.

--vault-name

Nome dell'insieme di credenziali delle chiavi. Obbligatorio se --id non è specificato.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

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

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

az keyvault secret download

Modifica

Scaricare un segreto da un insieme di credenziali delle chiavi.

az keyvault secret download --file
                            [--encoding {ascii, base64, hex, utf-16be, utf-16le, utf-8}]
                            [--id]
                            [--name]
                            [--vault-name]
                            [--version]

Parametri necessari

--file -f

File per ricevere il contenuto del segreto.

Parametri facoltativi

--encoding -e

Codifica del segreto. Per impostazione predefinita, cercherà il tag 'file-encoding' nel segreto. In caso contrario, si presuppone 'utf-8'.

Valori accettati: ascii, base64, hex, utf-16be, utf-16le, utf-8
--id

ID del segreto. Se si specificano tutti gli altri argomenti 'Id' devono essere omessi.

--name -n

Nome del segreto. Obbligatorio se --id non è specificato.

--vault-name

Nome dell'insieme di credenziali delle chiavi. Obbligatorio se --id non è specificato.

--version -v

Versione privata. Se omesso, usa la versione più recente.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

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

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

az keyvault secret list

Modifica

Elencare i segreti in un insieme di credenziali delle chiavi specificato.

L'operazione Recupera segreti è applicabile all'intero insieme di credenziali. Tuttavia, nella risposta vengono forniti solo l'identificatore del segreto di base e i relativi attributi. Le singole versioni dei segreti non sono elencate nella risposta. Questa operazione richiede l'autorizzazione secrets/list.

az keyvault secret list [--id]
                        [--include-managed {false, true}]
                        [--maxresults]
                        [--vault-name]

Parametri facoltativi

--id

URI completo dell'insieme di credenziali. Se si specificano tutti gli altri argomenti 'Id' devono essere omessi.

--include-managed

Includere segreti gestiti. Valore predefinito: false.

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

Numero massimo di risultati da restituire in una pagina. Se non specificato, il servizio restituirà fino a 25 risultati.

--vault-name

Nome dell'insieme di credenziali delle chiavi. Obbligatorio se --id non è specificato.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

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

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

az keyvault secret list-deleted

Modifica

Elenca i segreti eliminati per l'insieme di credenziali specificato.

L'operazione Get Deleted Secrets restituisce i segreti eliminati per un insieme di credenziali abilitato per l'eliminazione temporanea. Questa operazione richiede l'autorizzazione secrets/list.

az keyvault secret list-deleted [--id]
                                [--maxresults]
                                [--vault-name]

Parametri facoltativi

--id

URI completo dell'insieme di credenziali. Se si specificano tutti gli altri argomenti 'Id' devono essere omessi.

--maxresults

Numero massimo di risultati da restituire in una pagina. Se non specificato, il servizio restituirà fino a 25 risultati.

--vault-name

Nome dell'insieme di credenziali delle chiavi. Obbligatorio se --id non è specificato.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

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

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

az keyvault secret list-versions

Modifica

Elencare tutte le versioni del segreto specificato.

Nella risposta vengono forniti gli attributi e l'identificatore completo del segreto. Non vengono restituiti valori per i segreti. Questa operazione richiede l'autorizzazione secrets/list.

az keyvault secret list-versions [--id]
                                 [--maxresults]
                                 [--name]
                                 [--vault-name]

Parametri facoltativi

--id

ID del segreto. Se si specificano tutti gli altri argomenti 'Id' devono essere omessi.

--maxresults

Numero massimo di risultati da restituire in una pagina. Se non specificato, il servizio restituirà fino a 25 risultati.

--name -n

Nome del segreto. Obbligatorio se --id non è specificato.

--vault-name

Nome dell'insieme di credenziali delle chiavi. Obbligatorio se --id non è specificato.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

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

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

az keyvault secret purge

Modifica

Elimina definitivamente il segreto specificato.

L'operazione di eliminazione del segreto eliminato rimuove definitivamente il segreto, senza la possibilità di ripristino. Questa operazione può essere abilitata solo in un insieme di credenziali abilitato per l'eliminazione temporanea. Questa operazione richiede l'autorizzazione segreti/ripulitura.

az keyvault secret purge [--id]
                         [--name]
                         [--vault-name]

Parametri facoltativi

--id

ID di ripristino del segreto. Se si specificano tutti gli altri argomenti 'Id' devono essere omessi.

--name -n

Nome del segreto. Obbligatorio se --id non è specificato.

--vault-name

Nome dell'insieme di credenziali. Obbligatorio se --id non è specificato.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

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

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

az keyvault secret recover

Modifica

Recupera il segreto eliminato nella versione più recente.

Recupera il segreto eliminato nell'insieme di credenziali specificato. Questa operazione può essere eseguita solo su un insieme di credenziali abilitato per l'eliminazione temporanea. Questa operazione richiede l'autorizzazione segreti/ripristino.

az keyvault secret recover [--id]
                           [--name]
                           [--vault-name]

Parametri facoltativi

--id

ID di ripristino del segreto. Se si specificano tutti gli altri argomenti 'Id' devono essere omessi.

--name -n

Nome del segreto. Obbligatorio se --id non è specificato.

--vault-name

Nome dell'insieme di credenziali. Obbligatorio se --id non è specificato.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

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

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

az keyvault secret restore

Modifica

Ripristina un segreto sottoposto a backup in un insieme di credenziali.

Ripristina un segreto di cui è stato eseguito il backup e tutte le relative versioni in un insieme di credenziali. Questa operazione richiede l'autorizzazione segreti/ripristino.

az keyvault secret restore --file
                           --vault-name

Parametri necessari

--file -f

File per ricevere il contenuto del segreto.

--vault-name

Nome dell'insieme di credenziali.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

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

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

az keyvault secret set

Modifica

Creare un segreto (se non esiste) o aggiornare un segreto in un insieme di credenziali delle chiavi.

az keyvault secret set --name
                       --vault-name
                       [--content-type]
                       [--disabled {false, true}]
                       [--encoding {ascii, base64, hex, utf-16be, utf-16le, utf-8}]
                       [--expires]
                       [--file]
                       [--not-before]
                       [--tags]
                       [--value]

Esempio

Creare un segreto (se non esiste) o aggiornare un segreto in un insieme di credenziali delle chiavi.

az keyvault secret set --name MySecretName --vault-name MyKeyVault --value MyVault

Creare un segreto (se non esiste) o aggiornare un segreto in un insieme di credenziali delle chiavi tramite un file.

az keyvault secret set --name MySecretName --vault-name MyKeyVault --file /path/to/file --encoding MyEncoding

Parametri necessari

--name -n

Nome del segreto.

--vault-name

Nome dell'insieme di credenziali.

Parametri facoltativi

--content-type --description

Descrizione del contenuto del segreto (ad esempio password, stringa di connessione e così via).

--disabled

Creare un segreto in stato disabilitato.

Valori accettati: false, true
--encoding -e

Codifica dei file di origine. Il valore viene salvato come tag (file-encoding=<val>) e usato durante il download per codificare automaticamente il file risultante.

Valori accettati: ascii, base64, hex, utf-16be, utf-16le, utf-8
Valore predefinito: utf-8
--expires

Scadenza UTC datetime (Y-m-d'H:M:S'Z').

--file -f

File di origine per il segreto. Usare in combinazione con '--encoding'.

--not-before

Segreto non utilizzabile prima dell'ora UTC specificata (Y-m-d'H:M:S'Z').

--tags

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

--value

Valore segreto testo normale. Impossibile usare '--file' o '--encoding'.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

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

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

az keyvault secret set-attributes

Modifica

Aggiornamenti gli attributi associati a un segreto specificato in un determinato insieme di credenziali delle chiavi.

L'operazione UPDATE modifica gli attributi specificati di un segreto archiviato esistente. Gli attributi non specificati nella richiesta vengono lasciati invariati. Il valore di un segreto stesso non può essere modificato. Questa operazione richiede l'autorizzazione secrets/set.

az keyvault secret set-attributes [--content-type]
                                  [--enabled {false, true}]
                                  [--expires]
                                  [--id]
                                  [--name]
                                  [--not-before]
                                  [--tags]
                                  [--vault-name]
                                  [--version]

Parametri facoltativi

--content-type

Tipo del valore del segreto, ad esempio una password.

--enabled

Abilitare il segreto.

Valori accettati: false, true
--expires

Scadenza UTC datetime (Y-m-d'H:M:S'Z').

--id

ID del segreto. Se si specificano tutti gli altri argomenti 'Id' devono essere omessi.

--name -n

Nome del segreto. Obbligatorio se --id non è specificato.

--not-before

Segreto non utilizzabile prima dell'ora UTC specificata (Y-m-d'H:M:S'Z').

--tags

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

--vault-name

Nome dell'insieme di credenziali delle chiavi. Obbligatorio se --id non è specificato.

--version -v

Versione privata. Se omesso, usa la versione più recente.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

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

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

az keyvault secret show

Modifica

Ottenere un segreto specificato da un determinato insieme di credenziali delle chiavi.

L'operazione GET è applicabile a qualsiasi segreto archiviato in Azure Key Vault. Questa operazione richiede l'autorizzazione secrets/get.

az keyvault secret show [--id]
                        [--name]
                        [--vault-name]
                        [--version]

Parametri facoltativi

--id

ID del segreto. Se si specificano tutti gli altri argomenti 'Id' devono essere omessi.

--name -n

Nome del segreto. Obbligatorio se --id non è specificato.

--vault-name

Nome dell'insieme di credenziali delle chiavi. Obbligatorio se --id non è specificato.

--version -v

Versione privata. Se omesso, usa la versione più recente.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

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

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

az keyvault secret show-deleted

Modifica

Ottiene il segreto eliminato specificato.

L'operazione Get Deleted Secret restituisce il segreto eliminato specificato insieme ai relativi attributi. Questa operazione richiede l'autorizzazione secrets/get.

az keyvault secret show-deleted [--id]
                                [--name]
                                [--vault-name]

Parametri facoltativi

--id

ID di ripristino del segreto. Se si specificano tutti gli altri argomenti 'Id' devono essere omessi.

--name -n

Nome del segreto. Obbligatorio se --id non è specificato.

--vault-name

Nome dell'insieme di credenziali. Obbligatorio se --id non è specificato.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

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

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