az keyvault secret

Gerenciar segredos.

Comandos

az keyvault secret backup

Faz backup do segredo especificado.

az keyvault secret delete

Exclui um segredo de um cofre de chaves especificado.

az keyvault secret download

Baixe um segredo de um keyvault.

az keyvault secret list

Listar segredos em um cofre de chaves especificado.

az keyvault secret list-deleted

Lista os segredos excluídos para o cofre especificado.

az keyvault secret list-versions

Lista todas as versões do segredo especificado.

az keyvault secret purge

Exclui permanentemente o segredo especificado.

az keyvault secret recover

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

az keyvault secret restore

Restaura um segredo de backup para um cofre.

az keyvault secret set

Crie um segredo (se não houver um) ou atualize um segredo em um keyvault.

az keyvault secret set-attributes

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

az keyvault secret show

Obtenha um segredo especificado de um determinado cofre de chaves.

az keyvault secret show-deleted

Obtém o segredo excluído especificado.

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 de segredos/backup.

az keyvault secret backup --file
                          [--id]
                          [--name]
                          [--subscription]
                          [--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.

--subscription

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

--vault-name

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

az keyvault secret delete

Exclui um segredo de um cofre de chaves especificado.

A operação DELETE se aplica a qualquer segredo armazenado em um Cofre de Chaves do Azure. A operação DELETE não pode ser aplicada a uma versão individual de um segredo. Esta operação requer a permissão de segredos/excluir.

az keyvault secret delete [--id]
                          [--name]
                          [--subscription]
                          [--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.

--subscription

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

--vault-name

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

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]
                            [--subscription]
                            [--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, o procurará a marca ' file-Encoding ' 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.

--subscription

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

--vault-name

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

--version -v

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

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

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

Parâmetros Opcionais

--id

ID do cofre ou HSM. Se especificado, todos os outros argumentos ' ID ' devem ser omitidos.

--include-managed

Incluir segredos gerenciados. Padrão: falso.

valores aceitos: false, true
--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.

--query-examples

Recomende uma cadeia de caracteres JMESPath para você. Você pode copiar uma da consulta e colá-la após o parâmetro--Query entre aspas duplas para ver os resultados. Você pode adicionar uma ou mais palavras-chave posicionais para que possamos dar sugestões com base nessas palavras-chaves.

--subscription

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

--vault-name

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

az keyvault secret list-deleted

Lista os 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. Esta operação requer a permissão de segredos/lista.

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

Parâmetros Exigidos

--vault-name

Nome do cofre.

Parâmetros Opcionais

--id

ID 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.

--subscription

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

az keyvault secret list-versions

Lista todas as versões do segredo especificado.

O identificador completo do segredo 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]
                                 [--subscription]
                                 [--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.

--subscription

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

--vault-name

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

az keyvault secret purge

Exclui permanentemente o segredo especificado.

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

az keyvault secret purge [--id]
                         [--name]
                         [--subscription]
                         [--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.

--subscription

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

--vault-name

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

az keyvault secret recover

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 reversível. Esta operação requer a permissão de segredos/recuperar.

az keyvault secret recover [--id]
                           [--name]
                           [--subscription]
                           [--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.

--subscription

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

--vault-name

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

az keyvault secret restore

Restaura um segredo de backup para um cofre.

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

az keyvault secret restore --file
                           --vault-name
                           [--subscription]

Parâmetros Exigidos

--file -f

Arquivo para receber o conteúdo do segredo.

--vault-name

Nome do cofre.

Parâmetros Opcionais

--subscription

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

az keyvault secret set

Crie um segredo (se não houver um) ou atualize um segredo em um keyvault.

az keyvault secret set --name
                       --vault-name
                       [--description]
                       [--disabled {false, true}]
                       [--encoding {ascii, base64, hex, utf-16be, utf-16le, utf-8}]
                       [--expires]
                       [--file]
                       [--not-before]
                       [--subscription]
                       [--tags]
                       [--value]

Exemplos

Crie um segredo (se não houver um) ou atualize um segredo em um keyvault.

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

Crie um segredo (se não houver um) ou atualize um segredo em um cofre de chaves 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

--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 do 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

Data e hora UTC de expiração (Y-m-d'T ' H:M: S'Z ').

--file -f

Arquivo de origem para segredo. Use em conjunto com '--Encoding '.

--not-before

A chave não pode ser usada antes da data e hora UTC fornecida (Y-m-d'T ' H:M: S'Z ').

--subscription

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

--tags

Marcas separadas por espaço: chave [= valor] [chave [= valor]...]. Use "" para limpar as marcas existentes.

--value

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

az keyvault secret set-attributes

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 permanecem inalterados. O valor de um segredo em si não pode ser alterado. Esta operação requer a permissão de segredos/definir.

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

Parâmetros Opcionais

--content-type

Tipo do valor secreto, como uma senha.

--enabled

Habilite o segredo.

valores aceitos: false, true
--expires

Data e hora UTC de expiração (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

A chave não pode ser usada antes da data e hora UTC fornecida (Y-m-d'T ' H:M: S'Z ').

--subscription

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

--tags

Marcas separadas por espaço: chave [= valor] [chave [= valor]...]. Use "" para limpar as marcas existentes.

--vault-name

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

--version -v

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

az keyvault secret show

Obtenha um segredo especificado de um determinado cofre de chaves.

A operação GET se aplica a qualquer segredo armazenado em um Cofre de Chaves do Azure. Esta operação requer os segredos/obter permissão.

az keyvault secret show [--id]
                        [--name]
                        [--query-examples]
                        [--subscription]
                        [--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.

--query-examples

Recomende uma cadeia de caracteres JMESPath para você. Você pode copiar uma da consulta e colá-la após o parâmetro--Query entre aspas duplas para ver os resultados. Você pode adicionar uma ou mais palavras-chave posicionais para que possamos dar sugestões com base nessas palavras-chaves.

--subscription

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

--vault-name

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

--version -v

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

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]
                                [--subscription]
                                [--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.

--subscription

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

--vault-name

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