az keyvault secret

  • Referência

Gerencie segredos.

Comandos

Name Description Tipo Estado
az keyvault secret backup

Faz backup do segredo especificado.

 Principal GA
az keyvault secret delete

Exclua todas as versões de um segredo.

 Principal Preterido
az keyvault secret download

Faça o download de um segredo de um KeyVault.

 Principal GA
az keyvault secret list

Listar segredos em um cofre de chaves especificado.

 Principal GA
az keyvault secret list-deleted

Lista segredos excluídos para o cofre especificado.

 Principal GA
az keyvault secret list-versions

Liste todas as versões do segredo especificado.

 Principal GA
az keyvault secret purge

Exclui permanentemente o segredo especificado.

 Principal GA
az keyvault secret recover

Recupera o segredo excluído para a versão mais recente.

 Principal GA
az keyvault secret restore

Restaura um segredo de backup em um cofre.

 Principal GA
az keyvault secret set

Crie um segredo (se não existir) ou atualize um segredo em um KeyVault.

 Principal GA
az keyvault secret set-attributes

Atualiza os atributos associados a um segredo especificado em um determinado cofre de chaves.

 Principal GA
az keyvault secret show

Obtenha um segredo especificado de um determinado cofre de chaves.

 Principal GA
az keyvault secret show-deleted

Obtém o segredo excluído especificado.

 Principal GA

az keyvault secret backup

Editar

Faz backup do segredo especificado.

Solicita que um backup do segredo especificado seja baixado para o cliente. Todas as versões do segredo serão baixadas. Esta operação requer a permissão secrets/backup.

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

Parâmetros Obrigatórios

--file -f

Arquivo para receber o conteúdo secreto.

Parâmetros Opcionais

--id

Id do segredo. Se especificado, todos os outros argumentos 'Id' devem ser omitidos.

--name -n

Nome do segredo. Obrigatório se --id não for especificado.

--vault-name

Nome do Cofre da Chave. Obrigatório se --id não for especificado.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault secret delete

Editar
Preterido

Aviso! Se você tiver a proteção de exclusão suave ativada neste cofre de chaves, esse segredo será movido para o estado de exclusão suave. Você não poderá criar um segredo com o mesmo nome dentro desse cofre de chaves até que o segredo tenha sido removido do estado de exclusão suave. Consulte a documentação a seguir para obter orientações adicionais. https://docs.microsoft.com/azure/key-vault/general/soft-delete-overview

Exclua todas as versões de um segredo.

Requer permissão de segredos/exclusão. Quando esse método retorna Key Vault começou a excluir o segredo. A exclusão pode levar vários segundos em um cofre com soft-delete habilitado. Portanto, esse método retorna um poller permitindo que você aguarde a conclusão da exclusão.

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

Parâmetros Opcionais

--id

Id do segredo. Se especificado, todos os outros argumentos 'Id' devem ser omitidos.

--name -n

Nome do segredo. Obrigatório se --id não for especificado.

--vault-name

Nome do Cofre da Chave. Obrigatório se --id não for especificado.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault secret download

Editar

Faça o download de um segredo de um KeyVault.

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

Parâmetros Obrigatórios

--file -f

Arquivo para receber o conteúdo secreto.

Parâmetros Opcionais

--encoding -e

Codificação do segredo. Por padrão, procurará a tag 'file-encoding' no segredo. Caso contrário, assumirá 'utf-8'.

valores aceites: ascii, base64, hex, utf-16be, utf-16le, utf-8
--id

Id do segredo. Se especificado, todos os outros argumentos 'Id' devem ser omitidos.

--name -n

Nome do segredo. Obrigatório se --id não for especificado.

--vault-name

Nome do Cofre da Chave. Obrigatório se --id não for especificado.

--version -v

A versão secreta. Se omitido, usa a versão mais recente.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault secret list

Editar

Listar segredos em um cofre de chaves especificado.

A operação Obter Segredos é aplicável a todo o cofre. No entanto, apenas o identificador secreto base e seus atributos são fornecidos na resposta. Versões secretas individuais não são listadas na resposta. Esta operação requer a permissão secrets/list.

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

Parâmetros Opcionais

--id

URI completo do cofre. Se especificado, todos os outros argumentos 'Id' devem ser omitidos.

--include-managed

Inclua segredos gerenciados. Predefinição: false.

valores aceites: false, true
valor predefinido: False
--maxresults

Número máximo de resultados a serem retornados em uma página. Se não for especificado, o serviço retornará até 25 resultados.

--vault-name

Nome do Cofre da Chave. Obrigatório se --id não for especificado.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault secret list-deleted

Editar

Lista segredos excluídos para o cofre especificado.

A operação Obter Segredos Excluídos retorna os segredos que foram excluídos para um cofre habilitado para exclusão suave. Esta operação requer a permissão secrets/list.

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

Parâmetros Opcionais

--id

URI completo do cofre. Se especificado, todos os outros argumentos 'Id' devem ser omitidos.

--maxresults

Número máximo de resultados a serem retornados em uma página. Se não for especificado, o serviço retornará até 25 resultados.

--vault-name

Nome do Cofre da Chave. Obrigatório se --id não for especificado.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault secret list-versions

Editar

Liste todas as versões do segredo especificado.

O identificador e os atributos secretos completos são fornecidos na resposta. Nenhum valor é retornado para os segredos. Esta operação requer a permissão secrets/list.

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

Parâmetros Opcionais

--id

Id do segredo. Se especificado, todos os outros argumentos 'Id' devem ser omitidos.

--maxresults

Número máximo de resultados a serem retornados em uma página. Se não for especificado, o serviço retornará até 25 resultados.

--name -n

Nome do segredo. Obrigatório se --id não for especificado.

--vault-name

Nome do Cofre da Chave. Obrigatório se --id não for especificado.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault secret purge

Editar

Exclui permanentemente o segredo especificado.

A operação secreta de purga eliminada remove o segredo permanentemente, sem a possibilidade de recuperação. Esta operação só pode ser ativada em um cofre habilitado para exclusão suave. Esta operação requer a permissão secrets/purge.

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

Parâmetros Opcionais

--id

O id de recuperação do segredo. Se especificado, todos os outros argumentos 'Id' devem ser omitidos.

--name -n

Nome do segredo. Obrigatório se --id não for especificado.

--vault-name

Nome do cofre. Obrigatório se --id não for especificado.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault secret recover

Editar

Recupera o segredo excluído para a versão mais recente.

Recupera o segredo excluído no cofre especificado. Esta operação só pode ser executada em um cofre habilitado para exclusão suave. Esta operação requer a permissão secrets/recover.

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

Parâmetros Opcionais

--id

O id de recuperação do segredo. Se especificado, todos os outros argumentos 'Id' devem ser omitidos.

--name -n

Nome do segredo. Obrigatório se --id não for especificado.

--vault-name

Nome do cofre. Obrigatório se --id não for especificado.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault secret restore

Editar

Restaura um segredo de backup em um cofre.

Restaura um segredo de backup e todas as suas versões em um cofre. Esta operação requer a permissão secrets/restaurar.

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

Parâmetros Obrigatórios

--file -f

Arquivo para receber o conteúdo secreto.

--vault-name

Nome do cofre.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault secret set

Editar

Crie um segredo (se não existir) ou atualize um segredo em um 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]

Exemplos

Crie um segredo (se não existir) ou atualize um segredo em um KeyVault.

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

Crie um segredo (se não existir) ou atualize um segredo em um KeyVault através de um arquivo.

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

Parâmetros Obrigatórios

--name -n

Nome do segredo.

--vault-name

Nome do cofre.

Parâmetros Opcionais

--content-type --description

Descrição do conteúdo secreto (por exemplo, senha, cadeia de conexão, etc.).

--disabled

Criar segredo no estado desativado.

valores aceites: false, true
--encoding -e

Codificação do arquivo de origem. O valor é salvo como uma tag (file-encoding=<val>) e usado durante o download para codificar automaticamente o arquivo resultante.

valores aceites: ascii, base64, hex, utf-16be, utf-16le, utf-8
valor predefinido: utf-8
--expires

Expiração UTC datetime (Y-m-d'T'H:M:S'Z').

--file -f

Arquivo de origem para secret. Use em conjunto com '--encoding'.

--not-before

Segredo não utilizável antes da data/hora UTC fornecida (Y-m-d'T'H:M:S'Z').

--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes.

--value

Valor secreto de texto simples. Não pode ser usado com '--file' ou '--encoding'.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault secret set-attributes

Editar

Atualiza os atributos associados a um segredo especificado em um determinado cofre de chaves.

A operação UPDATE altera atributos especificados de um segredo armazenado existente. Os atributos que não são especificados na solicitação são mantidos inalterados. O valor de um segredo em si não pode ser alterado. Esta operação requer a permissão secrets/set.

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

Parâmetros Opcionais

--content-type

Digite o valor secreto, como uma senha.

--enabled

Habilite o segredo.

valores aceites: false, true
--expires

Expiração UTC datetime (Y-m-d'T'H:M:S'Z').

--id

Id do segredo. Se especificado, todos os outros argumentos 'Id' devem ser omitidos.

--name -n

Nome do segredo. Obrigatório se --id não for especificado.

--not-before

Segredo não utilizável antes da data/hora UTC fornecida (Y-m-d'T'H:M:S'Z').

--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes.

--vault-name

Nome do Cofre da Chave. Obrigatório se --id não for especificado.

--version -v

A versão secreta. Se omitido, usa a versão mais recente.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault secret show

Editar

Obtenha um segredo especificado de um determinado cofre de chaves.

A operação GET é aplicável a qualquer segredo armazenado no Cofre de Chaves do Azure. Esta operação requer os segredos/obter permissão.

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

Parâmetros Opcionais

--id

Id do segredo. Se especificado, todos os outros argumentos 'Id' devem ser omitidos.

--name -n

Nome do segredo. Obrigatório se --id não for especificado.

--vault-name

Nome do Cofre da Chave. Obrigatório se --id não for especificado.

--version -v

A versão secreta. Se omitido, usa a versão mais recente.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault secret show-deleted

Editar

Obtém o segredo excluído especificado.

A operação Get Deleted Secret retorna o segredo excluído especificado junto com seus atributos. Esta operação requer os segredos/obter permissão.

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

Parâmetros Opcionais

--id

O id de recuperação do segredo. Se especificado, todos os outros argumentos 'Id' devem ser omitidos.

--name -n

Nome do segredo. Obrigatório se --id não for especificado.

--vault-name

Nome do cofre. Obrigatório se --id não for especificado.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.