Sdílet prostřednictvím

az keyvault secret

  • Reference

Správa tajných kódů

Příkazy

Name Description Typ Stav
az keyvault secret backup

Zálohuje zadaný tajný kód.

 Základ GA
az keyvault secret delete

Odstraňte všechny verze tajného kódu.

 Základ Zastaralé
az keyvault secret download

Stáhněte tajný kód ze služby KeyVault.

 Základ GA
az keyvault secret list

Výpis tajných kódů v zadaném trezoru klíčů

 Základ GA
az keyvault secret list-deleted

Zobrazí seznam odstraněných tajných kódů pro zadaný trezor.

 Základ GA
az keyvault secret list-versions

Zobrazí seznam všech verzí zadaného tajného kódu.

 Základ GA
az keyvault secret purge

Trvale odstraní zadaný tajný klíč.

 Základ GA
az keyvault secret recover

Obnoví odstraněný tajný kód na nejnovější verzi.

 Základ GA
az keyvault secret restore

Obnoví zálohovaný tajný kód do trezoru.

 Základ GA
az keyvault secret set

Vytvořte tajný klíč (pokud neexistuje) nebo aktualizujte tajný klíč ve službě KeyVault.

 Základ GA
az keyvault secret set-attributes

Aktualizace atributy přidružené k zadanému tajnému kódu v daném trezoru klíčů.

 Základ GA
az keyvault secret show

Získejte zadaný tajný klíč z daného trezoru klíčů.

 Základ GA
az keyvault secret show-deleted

Získá zadaný odstraněný tajný klíč.

 Základ GA

az keyvault secret backup

Upravit

Zálohuje zadaný tajný kód.

Požaduje, aby se do klienta stáhla záloha zadaného tajného klíče. Stáhnou se všechny verze tajného kódu. Tato operace vyžaduje oprávnění k tajným kódům nebo zálohování.

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

Povinné parametry

--file -f

Soubor pro příjem obsahu tajného kódu

Volitelné parametry

--id

ID tajného klíče. Pokud jsou zadány všechny ostatní argumenty ID, měly by být vynechány.

--name -n

Název tajného klíče. Vyžaduje se, pokud není zadán parametr --id.

--vault-name

Název služby Key Vault. Vyžaduje se, pokud není zadán parametr --id.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az keyvault secret delete

Upravit
Zastaralé

Upozornění! Pokud máte v tomto trezoru klíčů povolenou ochranu obnovitelného odstranění, přesune se tento tajný kód do stavu obnovitelného odstranění. V tomto trezoru klíčů nebudete moct vytvořit tajný kód se stejným názvem, dokud se tajný kód nevyprázdní ze stavu obnovitelného odstranění. Další pokyny najdete v následující dokumentaci. https://docs.microsoft.com/azure/key-vault/general/soft-delete-overview

Odstraňte všechny verze tajného kódu.

Vyžaduje oprávnění k tajným kódům nebo odstranění. Když tato metoda vrátí key Vault, začal odstraňovat tajný klíč. Odstranění může v trezoru s povoleným obnovitelném odstraněním trvat několik sekund. Tato metoda proto vrátí poller, který umožňuje počkat na dokončení odstranění.

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

Volitelné parametry

--id

ID tajného klíče. Pokud jsou zadány všechny ostatní argumenty ID, měly by být vynechány.

--name -n

Název tajného klíče. Vyžaduje se, pokud není zadán parametr --id.

--vault-name

Název služby Key Vault. Vyžaduje se, pokud není zadán parametr --id.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az keyvault secret download

Upravit

Stáhněte tajný kód ze služby KeyVault.

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

Povinné parametry

--file -f

Soubor pro příjem obsahu tajného kódu

Volitelné parametry

--encoding -e

Kódování tajného klíče. Ve výchozím nastavení vyhledá značku file-encoding u tajného kódu. Jinak se předpokládá ,utf-8'.

Přípustné hodnoty: ascii, base64, hex, utf-16be, utf-16le, utf-8
--id

ID tajného klíče. Pokud jsou zadány všechny ostatní argumenty ID, měly by být vynechány.

--name -n

Název tajného klíče. Vyžaduje se, pokud není zadán parametr --id.

--vault-name

Název služby Key Vault. Vyžaduje se, pokud není zadán parametr --id.

--version -v

Verze tajného kódu. Pokud tento parametr vynecháte, použije se nejnovější verze.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az keyvault secret list

Upravit

Výpis tajných kódů v zadaném trezoru klíčů

Operace Získání tajných kódů se vztahuje na celý trezor. V odpovědi jsou ale k dispozici pouze identifikátor základního tajného klíče a jeho atributy. Jednotlivé verze tajných kódů nejsou uvedené v odpovědi. Tato operace vyžaduje oprávnění k tajným kódům nebo seznamům.

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

Volitelné parametry

--id

Úplný identifikátor URI trezoru Pokud jsou zadány všechny ostatní argumenty ID, měly by být vynechány.

--include-managed

Zahrnout spravované tajné kódy. Výchozí hodnota: false.

Přípustné hodnoty: false, true
Default value: False
--maxresults

Maximální počet výsledků, které se mají vrátit na stránce Pokud není zadaný, služba vrátí až 25 výsledků.

--vault-name

Název služby Key Vault. Vyžaduje se, pokud není zadán parametr --id.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az keyvault secret list-deleted

Upravit

Zobrazí seznam odstraněných tajných kódů pro zadaný trezor.

Operace Získat odstraněné tajné kódy vrátí tajné kódy, které byly odstraněny pro trezor s povoleným obnovitelném odstraněním. Tato operace vyžaduje oprávnění k tajným kódům nebo seznamům.

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

Volitelné parametry

--id

Úplný identifikátor URI trezoru Pokud jsou zadány všechny ostatní argumenty ID, měly by být vynechány.

--maxresults

Maximální počet výsledků, které se mají vrátit na stránce Pokud není zadaný, služba vrátí až 25 výsledků.

--vault-name

Název služby Key Vault. Vyžaduje se, pokud není zadán parametr --id.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az keyvault secret list-versions

Upravit

Zobrazí seznam všech verzí zadaného tajného kódu.

Úplný identifikátor tajného kódu a atributy jsou k dispozici v odpovědi. Pro tajné kódy se nevrácejí žádné hodnoty. Tyto operace vyžadují oprávnění k tajným kódům nebo seznamům.

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

Volitelné parametry

--id

ID tajného klíče. Pokud jsou zadány všechny ostatní argumenty ID, měly by být vynechány.

--maxresults

Maximální počet výsledků, které se mají vrátit na stránce Pokud není zadaný, služba vrátí až 25 výsledků.

--name -n

Název tajného klíče. Vyžaduje se, pokud není zadán parametr --id.

--vault-name

Název služby Key Vault. Vyžaduje se, pokud není zadán parametr --id.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az keyvault secret purge

Upravit

Trvale odstraní zadaný tajný klíč.

Operace vymazání odstraněného tajného kódu trvale odebere tajný kód bez možnosti obnovení. Tuto operaci lze povolit pouze v trezoru s povoleným obnovitelném odstraněním. Tato operace vyžaduje oprávnění k vyprázdnění tajných kódů.

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

Volitelné parametry

--id

ID obnovení tajného klíče. Pokud jsou zadány všechny ostatní argumenty ID, měly by být vynechány.

--name -n

Název tajného klíče. Vyžaduje se, pokud není zadán parametr --id.

--vault-name

Název trezoru. Vyžaduje se, pokud není zadán parametr --id.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az keyvault secret recover

Upravit

Obnoví odstraněný tajný kód na nejnovější verzi.

Obnoví odstraněný tajný klíč v zadaném trezoru. Tuto operaci lze provést pouze v trezoru s povoleným obnovitelném odstraněním. Tato operace vyžaduje oprávnění k tajným kódům nebo obnovení.

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

Volitelné parametry

--id

ID obnovení tajného klíče. Pokud jsou zadány všechny ostatní argumenty ID, měly by být vynechány.

--name -n

Název tajného klíče. Vyžaduje se, pokud není zadán parametr --id.

--vault-name

Název trezoru. Vyžaduje se, pokud není zadán parametr --id.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az keyvault secret restore

Upravit

Obnoví zálohovaný tajný kód do trezoru.

Obnoví zálohovaný tajný klíč a všechny jeho verze do trezoru. Tato operace vyžaduje oprávnění k tajným kódům nebo obnovení.

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

Povinné parametry

--file -f

Soubor pro příjem obsahu tajného kódu

--vault-name

Název trezoru.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az keyvault secret set

Upravit

Vytvořte tajný klíč (pokud neexistuje) nebo aktualizujte tajný klíč ve službě 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]

Příklady

Vytvořte tajný klíč (pokud neexistuje) nebo aktualizujte tajný klíč ve službě KeyVault.

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

Vytvořte tajný klíč (pokud neexistuje) nebo aktualizujte tajný kód v keyVault prostřednictvím souboru.

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

Povinné parametry

--name -n

Název tajného klíče.

--vault-name

Název trezoru.

Volitelné parametry

--content-type --description

Popis tajného obsahu (např. heslo, připojovací řetězec atd.).

--disabled

Vytvořte tajný kód v zakázaném stavu.

Přípustné hodnoty: false, true
--encoding -e

Kódování zdrojového souboru. Hodnota se uloží jako značka (file-encoding=<val>) a použije se při stahování k automatickému kódování výsledného souboru.

Přípustné hodnoty: ascii, base64, hex, utf-16be, utf-16le, utf-8
Default value: utf-8
--expires

Datum a čas vypršení platnosti UTC (Y-m-d'T'H:M:S'Z').

--file -f

Zdrojový soubor pro tajný kód Používá se ve spojení s kódováním -.

--not-before

Tajný kód není použitelný před zadaným datetimem UTC (Y-m-d'T'H:M:S'Z').

--tags

Značky oddělené mezerami: klíč[=hodnota] [klíč[=hodnota] ...]. K vymazání existujících značek použijte "".

--value

Hodnota tajného kódu prostého textu. Nelze použít s příponou --file nebo --encoding.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az keyvault secret set-attributes

Upravit

Aktualizace atributy přidružené k zadanému tajnému kódu v daném trezoru klíčů.

Operace UPDATE změní zadané atributy existujícího uloženého tajného kódu. Atributy, které nejsou zadány v požadavku, zůstanou beze změny. Hodnotu samotného tajného kódu nelze změnit. Tato operace vyžaduje oprávnění tajného klíče nebo sady.

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

Volitelné parametry

--content-type

Typ tajné hodnoty, jako je heslo.

--enabled

Povolte tajný kód.

Přípustné hodnoty: false, true
--expires

Datum a čas vypršení platnosti UTC (Y-m-d'T'H:M:S'Z').

--id

ID tajného klíče. Pokud jsou zadány všechny ostatní argumenty ID, měly by být vynechány.

--name -n

Název tajného klíče. Vyžaduje se, pokud není zadán parametr --id.

--not-before

Tajný kód není použitelný před zadaným datetimem UTC (Y-m-d'T'H:M:S'Z').

--tags

Značky oddělené mezerami: klíč[=hodnota] [klíč[=hodnota] ...]. K vymazání existujících značek použijte "".

--vault-name

Název služby Key Vault. Vyžaduje se, pokud není zadán parametr --id.

--version -v

Verze tajného kódu. Pokud tento parametr vynecháte, použije se nejnovější verze.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az keyvault secret show

Upravit

Získejte zadaný tajný klíč z daného trezoru klíčů.

Operace GET se vztahuje na jakýkoli tajný klíč uložený ve službě Azure Key Vault. Tato operace vyžaduje tajné kódy nebo získat oprávnění.

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

Volitelné parametry

--id

ID tajného klíče. Pokud jsou zadány všechny ostatní argumenty ID, měly by být vynechány.

--name -n

Název tajného klíče. Vyžaduje se, pokud není zadán parametr --id.

--vault-name

Název služby Key Vault. Vyžaduje se, pokud není zadán parametr --id.

--version -v

Verze tajného kódu. Pokud tento parametr vynecháte, použije se nejnovější verze.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az keyvault secret show-deleted

Upravit

Získá zadaný odstraněný tajný klíč.

Operace Get Deleted Secret vrátí zadaný odstraněný tajný klíč spolu s jeho atributy. Tato operace vyžaduje tajné kódy nebo získat oprávnění.

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

Volitelné parametry

--id

ID obnovení tajného klíče. Pokud jsou zadány všechny ostatní argumenty ID, měly by být vynechány.

--name -n

Název tajného klíče. Vyžaduje se, pokud není zadán parametr --id.

--vault-name

Název trezoru. Vyžaduje se, pokud není zadán parametr --id.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.