az keyvault secret
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 | Preterido |
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
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 Exigidos
Arquivo para receber o conteúdo secreto.
Parâmetros Opcionais
Id do segredo. Se especificado, todos os outros argumentos 'Id' devem ser omitidos.
Nome do segredo. Obrigatório se --id não for especificado.
Nome do Cofre da Chave. Obrigatório se --id não for especificado.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az keyvault secret delete
Aviso! Se você tiver a proteção de exclusão suave habilitada 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 deste 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 secrets/delete. Quando esse método retorna, o Cofre de Chaves começou a excluir o segredo. A exclusão pode levar vários segundos em um cofre com soft-delete habilitado. Esse método, portanto, retorna 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 do segredo. Se especificado, todos os outros argumentos 'Id' devem ser omitidos.
Nome do segredo. Obrigatório se --id não for especificado.
Nome do Cofre da Chave. Obrigatório se --id não for especificado.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az keyvault secret download
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
Arquivo para receber o conteúdo secreto.
Parâmetros Opcionais
Codificação do segredo. Por padrão, procurará a tag 'file-encoding' no segredo. Caso contrário, assumirá 'utf-8'.
Id do segredo. Se especificado, todos os outros argumentos 'Id' devem ser omitidos.
Nome do segredo. Obrigatório se --id não for especificado.
Nome do Cofre da Chave. Obrigatório se --id não for especificado.
A versão secreta. Se omitido, usa a versão mais recente.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az keyvault secret list
Listar segredos em um cofre de chaves especificado.
A operação Obter Segredos é aplicável a todo o cofre. No entanto, apenas o identificador de segredo 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
URI completo do Vault. Se especificado, todos os outros argumentos 'Id' devem ser omitidos.
Inclua segredos gerenciados. Padrão: falso.
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.
Nome do Cofre da Chave. Obrigatório se --id não for especificado.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az keyvault secret list-deleted
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 flexível. Esta operação requer a permissão secrets/list.
az keyvault secret list-deleted [--id]
[--maxresults]
[--vault-name]
Parâmetros Opcionais
URI completo do Vault. Se especificado, todos os outros argumentos 'Id' devem ser omitidos.
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.
Nome do Cofre da Chave. Obrigatório se --id não for especificado.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az keyvault secret list-versions
Liste todas as versões do segredo especificado.
O identificador secreto completo e os atributos são fornecidos na resposta. Nenhum valor é retornado para os segredos. Essas operações exigem a permissão secrets/list.
az keyvault secret list-versions [--id]
[--maxresults]
[--name]
[--vault-name]
Parâmetros Opcionais
Id do segredo. Se especificado, todos os outros argumentos 'Id' devem ser omitidos.
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.
Nome do segredo. Obrigatório se --id não for especificado.
Nome do Cofre da Chave. Obrigatório se --id não for especificado.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az keyvault secret purge
Exclui permanentemente o segredo especificado.
A operação de limpeza do segredo eliminado remove o segredo permanentemente, sem a possibilidade de recuperação. Essa operação só pode ser habilitada em um cofre habilitado para soft-delete. Esta operação requer a permissão secrets/purge.
az keyvault secret purge [--id]
[--name]
[--vault-name]
Parâmetros Opcionais
O id de recuperação do segredo. Se especificado, todos os outros argumentos 'Id' devem ser omitidos.
Nome do segredo. Obrigatório se --id não for especificado.
Nome do cofre. Obrigatório se --id não for especificado.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az keyvault secret recover
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 soft-delete. Esta operação requer a permissão secrets/recover.
az keyvault secret recover [--id]
[--name]
[--vault-name]
Parâmetros Opcionais
O id de recuperação do segredo. Se especificado, todos os outros argumentos 'Id' devem ser omitidos.
Nome do segredo. Obrigatório se --id não for especificado.
Nome do cofre. Obrigatório se --id não for especificado.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az keyvault secret restore
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/restauração.
az keyvault secret restore --file
--vault-name
Parâmetros Exigidos
Arquivo para receber o conteúdo secreto.
Nome do cofre.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az keyvault secret set
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
Nome do segredo.
Nome do cofre.
Parâmetros Opcionais
Descrição do conteúdo secreto (por exemplo, senha, cadeia de conexão, etc).
Criar segredo no estado desabilitado.
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.
Data de expiração UTC (Y-m-d'T'H:M:S'Z').
Arquivo de origem para segredo. Use em conjunto com '--encoding'.
Segredo não utilizável antes da data/hora UTC fornecida (Y-m-d'T'H:M:S'Z').
Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar as tags existentes.
Valor secreto de texto sem formatação. Não pode ser usado com '--file' ou '--encoding'.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az keyvault secret set-attributes
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. Essa operação exige a permissão de segredos/definição.
az keyvault secret set-attributes [--content-type]
[--enabled {false, true}]
[--expires]
[--id]
[--name]
[--not-before]
[--tags]
[--vault-name]
[--version]
Parâmetros Opcionais
Digite o valor secreto, como uma senha.
Habilite o segredo.
Data de expiração UTC (Y-m-d'T'H:M:S'Z').
Id do segredo. Se especificado, todos os outros argumentos 'Id' devem ser omitidos.
Nome do segredo. Obrigatório se --id não for especificado.
Segredo não utilizável antes da data/hora UTC fornecida (Y-m-d'T'H:M:S'Z').
Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar as tags existentes.
Nome do Cofre da Chave. Obrigatório se --id não for especificado.
A versão secreta. Se omitido, usa a versão mais recente.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az keyvault secret show
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 do segredo. Se especificado, todos os outros argumentos 'Id' devem ser omitidos.
Nome do segredo. Obrigatório se --id não for especificado.
Nome do Cofre da Chave. Obrigatório se --id não for especificado.
A versão secreta. Se omitido, usa a versão mais recente.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az keyvault secret show-deleted
Obtém o segredo excluído especificado.
A operação Obter segredo excluído 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
O id de recuperação do segredo. Se especificado, todos os outros argumentos 'Id' devem ser omitidos.
Nome do segredo. Obrigatório se --id não for especificado.
Nome do cofre. Obrigatório se --id não for especificado.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.