Compartilhar via

az keyvault secret

  • Referência

Gerenciar segredos.

Comandos

Nome Description Tipo Status
az keyvault secret backup

Faz backup do segredo especificado.

 Núcleo GA
az keyvault secret delete

Exclua todas as versões de um segredo.

 Núcleo Deprecado
az keyvault secret download

Baixe um segredo de um KeyVault.

 Núcleo GA
az keyvault secret list

Listar segredos em um cofre de chaves especificado.

 Núcleo GA
az keyvault secret list-deleted

Lista segredos excluídos para o cofre especificado.

 Núcleo GA
az keyvault secret list-versions

Liste todas as versões do segredo especificado.

 Núcleo GA
az keyvault secret purge

Exclui permanentemente o segredo especificado.

 Núcleo GA
az keyvault secret recover

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

 Núcleo GA
az keyvault secret restore

Restaura um segredo de backup em um cofre.

 Núcleo GA
az keyvault secret set

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

 Núcleo GA
az keyvault secret set-attributes

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

 Núcleo GA
az keyvault secret show

Obtenha um segredo especificado de um determinado cofre de chaves.

 Núcleo GA
az keyvault secret show-deleted

Obtém o segredo excluído especificado.

 Núcleo 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. Essa operação requer a permissão de segredos/backup.

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

Parâmetros Exigidos

--file -f

Arquivo para receber o conteúdo do segredo.

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 Key Vault. Obrigatório se --id não for especificado.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

az keyvault secret delete

Editar
Preterido

Aviso! Se você tiver a proteção de exclusão reversível habilitada neste cofre de chaves, esse segredo será movido para o estado de exclusão reversível. Você não poderá criar um segredo com o mesmo nome dentro desse cofre de chaves até que o segredo tenha sido limpo do estado de exclusão reversível. Consulte a documentação a seguir para obter diretrizes adicionais. https://learn.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, o Key Vault começou a excluir o segredo. A exclusão pode levar vários segundos em um cofre com a exclusão reversível habilitada. Esse método retorna, portanto, um poller que permite 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 Key Vault. Obrigatório se --id não for especificado.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

az keyvault secret download

Editar

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

--file -f

Arquivo para receber o conteúdo do segredo.

Parâmetros Opcionais

--encoding -e

Codificação do segredo. Por padrão, procurará a marca de "codificação de arquivo" no segredo. Caso contrário, assumirá 'utf-8'.

Valores aceitos: 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 Key Vault. Obrigatório se --id não for especificado.

--version -v

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

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. 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, somente o identificador de segredo base e seus atributos são fornecidos na resposta. As versões de segredo individuais não estão listadas na resposta. Essa operação requer a permissão de segredos/lista.

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. Padrão: false.

Valores aceitos: false, true
Valor padrão: 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 Key Vault. Obrigatório se --id não for especificado.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. 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 reversível. Essa operação requer a permissão de segredos/lista.

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 Key Vault. Obrigatório se --id não for especificado.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

az keyvault secret list-versions

Editar

Liste todas as versões do segredo especificado.

O identificador de segredo completo e os atributos são fornecidos na resposta. Nenhum valor é retornado para os segredos. Essas operações exigem a permissão de segredos/lista.

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 Key Vault. Obrigatório se --id não for especificado.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

az keyvault secret purge

Editar

Exclui permanentemente o segredo especificado.

A operação secreta de limpeza excluída remove o segredo permanentemente, sem a possibilidade de recuperação. Essa operação só pode ser habilitada em um cofre habilitado para exclusão reversível. Essa operação requer a permissão de segredos/limpeza.

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

Parâmetros Opcionais

--id

A 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 Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. 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. Essa operação só pode ser executada em um cofre habilitado para exclusão reversível. Essa operação requer a permissão de recuperação/segredos.

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

Parâmetros Opcionais

--id

A 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 Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. 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. Essa operação requer a permissão de segredos/restauração.

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

Parâmetros Exigidos

--file -f

Arquivo para receber o conteúdo do segredo.

--vault-name

Nome do Cofre.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. 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 por meio de um arquivo.

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

Parâmetros Exigidos

--name -n

Nome do segredo.

--vault-name

Nome do Cofre.

Parâmetros Opcionais

--content-type --description

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

--disabled

Criar segredo no estado desabilitado.

Valores aceitos: false, true
--encoding -e

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

Valores aceitos: ascii, base64, hex, utf-16be, utf-16le, utf-8
Valor padrão: utf-8
--expires

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

--file -f

Arquivo de origem para segredo. Use em conjunto com '--codificação'.

--not-before

Segredo não utilizável antes do datetime UTC fornecido (Y-m-d'T'H:M:S'Z').

--tags

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

--value

Valor de segredo de texto sem formatação. Não pode ser usado com '--file' ou '--encoding'.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. 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 os atributos especificados de um segredo armazenado existente. Os atributos que não são especificados na solicitação são deixados inalterados. O valor de um segredo em si não pode ser alterado. Essa operação requer a permissão de segredos/conjunto.

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

Parâmetros Opcionais

--content-type

Tipo do valor do segredo, como uma senha.

--enabled

Habilite o segredo.

Valores aceitos: 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 do datetime UTC fornecido (Y-m-d'T'H:M:S'Z').

--tags

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

--vault-name

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

--version -v

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

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. 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 Azure Key Vault. Essa operação requer a permissão de obtenção/segredos.

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 Key Vault. Obrigatório se --id não for especificado.

--version -v

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

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. 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. Essa operação requer a permissão de obtenção/segredos.

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

Parâmetros Opcionais

--id

A 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 Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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