az keyvault secret

  • Referens

Hantera hemligheter.

Kommandon

Name Description Typ Status
az keyvault secret backup

Säkerhetskopierar den angivna hemligheten.

 Kärna Allmän tillgänglighet
az keyvault secret delete

Ta bort alla versioner av en hemlighet.

 Kärna Inaktuell
az keyvault secret download

Ladda ned en hemlighet från en KeyVault.

 Kärna Allmän tillgänglighet
az keyvault secret list

Visa en lista över hemligheter i ett angivet nyckelvalv.

 Kärna Allmän tillgänglighet
az keyvault secret list-deleted

Visar borttagna hemligheter för det angivna valvet.

 Kärna Allmän tillgänglighet
az keyvault secret list-versions

Visa en lista över alla versioner av den angivna hemligheten.

 Kärna Allmän tillgänglighet
az keyvault secret purge

Tar bort den angivna hemligheten permanent.

 Kärna Allmän tillgänglighet
az keyvault secret recover

Återställer den borttagna hemligheten till den senaste versionen.

 Kärna Allmän tillgänglighet
az keyvault secret restore

Återställer en säkerhetskopierad hemlighet till ett valv.

 Kärna Allmän tillgänglighet
az keyvault secret set

Skapa en hemlighet (om det inte finns någon) eller uppdatera en hemlighet i en KeyVault.

 Kärna Allmän tillgänglighet
az keyvault secret set-attributes

Uppdateringar attributen som är associerade med en angiven hemlighet i ett visst nyckelvalv.

 Kärna Allmän tillgänglighet
az keyvault secret show

Hämta en angiven hemlighet från ett visst nyckelvalv.

 Kärna Allmän tillgänglighet
az keyvault secret show-deleted

Hämtar den angivna borttagna hemligheten.

 Kärna Allmän tillgänglighet

az keyvault secret backup

Redigera

Säkerhetskopierar den angivna hemligheten.

Begär att en säkerhetskopia av den angivna hemligheten laddas ned till klienten. Alla versioner av hemligheten laddas ned. Den här åtgärden kräver behörigheten hemligheter/säkerhetskopiering.

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

Obligatoriska parametrar

--file -f

Fil för att ta emot det hemliga innehållet.

Valfria parametrar

--id

Id för hemligheten. Om det anges bör alla andra ID-argument utelämnas.

--name -n

Namnet på hemligheten. Krävs om --id inte har angetts.

--vault-name

Namnet på Nyckelvalvet. Krävs om --id inte har angetts.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az keyvault secret delete

Redigera
Inaktuell

Varning! Om du har aktiverat skydd för mjuk borttagning i det här nyckelvalvet flyttas den här hemligheten till tillståndet för mjuk borttagning. Du kommer inte att kunna skapa en hemlighet med samma namn i det här nyckelvalvet förrän hemligheten har rensats från det mjukt borttagna tillståndet. Mer information finns i följande dokumentation. https://docs.microsoft.com/azure/key-vault/general/soft-delete-overview

Ta bort alla versioner av en hemlighet.

Kräver behörighet för hemligheter/borttagning. När den här metoden returnerar har Key Vault börjat ta bort hemligheten. Borttagningen kan ta flera sekunder i ett valv med mjuk borttagning aktiverat. Den här metoden returnerar därför en poller som gör att du kan vänta tills borttagningen har slutförts.

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

Valfria parametrar

--id

Id för hemligheten. Om det anges bör alla andra ID-argument utelämnas.

--name -n

Namnet på hemligheten. Krävs om --id inte har angetts.

--vault-name

Namnet på Nyckelvalvet. Krävs om --id inte har angetts.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az keyvault secret download

Redigera

Ladda ned en hemlighet från en KeyVault.

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

Obligatoriska parametrar

--file -f

Fil för att ta emot det hemliga innehållet.

Valfria parametrar

--encoding -e

Kodning av hemligheten. Som standard letar efter taggen "file-encoding" på hemligheten. Annars förutsätts "utf-8".

Godkända värden: ascii, base64, hex, utf-16be, utf-16le, utf-8
--id

Id för hemligheten. Om det anges bör alla andra ID-argument utelämnas.

--name -n

Namnet på hemligheten. Krävs om --id inte har angetts.

--vault-name

Namnet på Nyckelvalvet. Krävs om --id inte har angetts.

--version -v

Den hemliga versionen. Om det utelämnas använder du den senaste versionen.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az keyvault secret list

Redigera

Visa en lista över hemligheter i ett angivet nyckelvalv.

Åtgärden Hämta hemligheter gäller för hela valvet. Endast den grundläggande hemliga identifieraren och dess attribut tillhandahålls dock i svaret. Enskilda hemliga versioner visas inte i svaret. Den här åtgärden kräver behörigheten hemligheter/lista.

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

Valfria parametrar

--id

Fullständig URI för valvet. Om det anges bör alla andra ID-argument utelämnas.

--include-managed

Inkludera hanterade hemligheter. Standard: falskt.

Godkända värden: false, true
Standardvärde: False
--maxresults

Maximalt antal resultat som ska returneras på en sida. Om det inte anges returnerar tjänsten upp till 25 resultat.

--vault-name

Namnet på Nyckelvalvet. Krävs om --id inte har angetts.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az keyvault secret list-deleted

Redigera

Visar borttagna hemligheter för det angivna valvet.

Åtgärden Hämta borttagna hemligheter returnerar de hemligheter som har tagits bort för ett valv som är aktiverat för mjuk borttagning. Den här åtgärden kräver behörigheten hemligheter/lista.

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

Valfria parametrar

--id

Fullständig URI för valvet. Om det anges bör alla andra ID-argument utelämnas.

--maxresults

Maximalt antal resultat som ska returneras på en sida. Om det inte anges returnerar tjänsten upp till 25 resultat.

--vault-name

Namnet på Nyckelvalvet. Krävs om --id inte har angetts.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az keyvault secret list-versions

Redigera

Visa en lista över alla versioner av den angivna hemligheten.

Den fullständiga hemliga identifieraren och attributen anges i svaret. Inga värden returneras för hemligheterna. De här åtgärderna kräver behörigheten hemligheter/lista.

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

Valfria parametrar

--id

Id för hemligheten. Om det anges bör alla andra ID-argument utelämnas.

--maxresults

Maximalt antal resultat som ska returneras på en sida. Om det inte anges returnerar tjänsten upp till 25 resultat.

--name -n

Namnet på hemligheten. Krävs om --id inte har angetts.

--vault-name

Namnet på Nyckelvalvet. Krävs om --id inte har angetts.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az keyvault secret purge

Redigera

Tar bort den angivna hemligheten permanent.

Åtgärden rensa borttagen hemlighet tar bort hemligheten permanent, utan möjlighet till återställning. Den här åtgärden kan bara aktiveras i ett aktiverat valv med mjuk borttagning. Den här åtgärden kräver behörigheten hemligheter/rensning.

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

Valfria parametrar

--id

Hemlighetens återställnings-ID. Om det anges bör alla andra ID-argument utelämnas.

--name -n

Namnet på hemligheten. Krävs om --id inte har angetts.

--vault-name

Namnet på valvet. Krävs om --id inte har angetts.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az keyvault secret recover

Redigera

Återställer den borttagna hemligheten till den senaste versionen.

Återställer den borttagna hemligheten i det angivna valvet. Den här åtgärden kan bara utföras i ett aktiverat valv med mjuk borttagning. Den här åtgärden kräver behörigheten hemligheter/återställning.

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

Valfria parametrar

--id

Hemlighetens återställnings-ID. Om det anges bör alla andra ID-argument utelämnas.

--name -n

Namnet på hemligheten. Krävs om --id inte har angetts.

--vault-name

Namnet på valvet. Krävs om --id inte har angetts.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az keyvault secret restore

Redigera

Återställer en säkerhetskopierad hemlighet till ett valv.

Återställer en säkerhetskopierad hemlighet och alla dess versioner till ett valv. Den här åtgärden kräver behörigheten hemligheter/återställning.

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

Obligatoriska parametrar

--file -f

Fil för att ta emot det hemliga innehållet.

--vault-name

Namnet på valvet.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az keyvault secret set

Redigera

Skapa en hemlighet (om det inte finns någon) eller uppdatera en hemlighet i en KeyVault.

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]

Exempel

Skapa en hemlighet (om det inte finns någon) eller uppdatera en hemlighet i en KeyVault.

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

Skapa en hemlighet (om det inte finns någon) eller uppdatera en hemlighet i en KeyVault via en fil.

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

Obligatoriska parametrar

--name -n

Namnet på hemligheten.

--vault-name

Namnet på valvet.

Valfria parametrar

--content-type --description

Beskrivning av det hemliga innehållet (t.ex. lösenord, anslutningssträng osv.).

--disabled

Skapa hemlighet i inaktiverat tillstånd.

Godkända värden: false, true
--encoding -e

Källfilkodning. Värdet sparas som en tagg (file-encoding=<val>) och används under nedladdningen för att automatiskt koda den resulterande filen.

Godkända värden: ascii, base64, hex, utf-16be, utf-16le, utf-8
Standardvärde: utf-8
--expires

Utc-datetime för förfallodatum (Y-m-d'T'H:M:S'Z').

--file -f

Källfil för hemlighet. Använd tillsammans med "--encoding".

--not-before

Hemligheten kan inte användas före den angivna UTC-datetime (Y-m-d'T'H:M:S'Z').

--tags

Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.

--value

Hemligt värde för oformaterad text. Det går inte att använda med "--file" eller "--encoding".

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az keyvault secret set-attributes

Redigera

Uppdateringar attributen som är associerade med en angiven hemlighet i ett visst nyckelvalv.

Update-åtgärden ändrar angivna attribut för en befintlig lagrad hemlighet. Attribut som inte anges i begäran lämnas oförändrade. Det går inte att ändra värdet för själva hemligheten. Den här åtgärden kräver behörigheten hemligheter/uppsättning.

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

Valfria parametrar

--content-type

Typ av hemligt värde, till exempel ett lösenord.

--enabled

Aktivera hemligheten.

Godkända värden: false, true
--expires

Utc-datetime för förfallodatum (Y-m-d'T'H:M:S'Z').

--id

Id för hemligheten. Om det anges bör alla andra ID-argument utelämnas.

--name -n

Namnet på hemligheten. Krävs om --id inte har angetts.

--not-before

Hemligheten kan inte användas före den angivna UTC-datetime (Y-m-d'T'H:M:S'Z').

--tags

Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.

--vault-name

Namnet på Nyckelvalvet. Krävs om --id inte har angetts.

--version -v

Den hemliga versionen. Om det utelämnas använder du den senaste versionen.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az keyvault secret show

Redigera

Hämta en angiven hemlighet från ett visst nyckelvalv.

GET-åtgärden gäller för alla hemligheter som lagras i Azure Key Vault. Den här åtgärden kräver behörigheten hemligheter/hämtar.

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

Valfria parametrar

--id

Id för hemligheten. Om det anges bör alla andra ID-argument utelämnas.

--name -n

Namnet på hemligheten. Krävs om --id inte har angetts.

--vault-name

Namnet på Nyckelvalvet. Krävs om --id inte har angetts.

--version -v

Den hemliga versionen. Om det utelämnas använder du den senaste versionen.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az keyvault secret show-deleted

Redigera

Hämtar den angivna borttagna hemligheten.

Åtgärden Hämta borttagen hemlighet returnerar den angivna borttagna hemligheten tillsammans med dess attribut. Den här åtgärden kräver behörigheten hemligheter/hämtar.

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

Valfria parametrar

--id

Hemlighetens återställnings-ID. Om det anges bör alla andra ID-argument utelämnas.

--name -n

Namnet på hemligheten. Krävs om --id inte har angetts.

--vault-name

Namnet på valvet. Krävs om --id inte har angetts.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.