az keyvault secret

Gerir segredos.

Comandos

az keyvault secret backup

Confirma o segredo especificado.

az keyvault secret delete

Elimina um segredo de um cofre de chaves especificado.

az keyvault secret download

Descarregue um segredo de um KeyVault.

az keyvault secret list

Listar segredos num cofre de chaves especificado.

az keyvault secret list-deleted

Lista segredos apagados para o cofre especificado.

az keyvault secret list-versions

Lista todas as versões do segredo especificado.

az keyvault secret purge

Elimina permanentemente o segredo especificado.

az keyvault secret recover

Recupera o segredo apagado para a versão mais recente.

az keyvault secret restore

Restaura um segredo de apoio a um cofre.

az keyvault secret set

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

az keyvault secret set-attributes

Atualiza os atributos associados a um segredo especificado num dado cofre de chaves.

az keyvault secret show

Obter um segredo especificado de um cofre de chaves.

az keyvault secret show-deleted

Obtém o segredo apagado especificado.

az keyvault secret backup

Confirma o segredo especificado.

Solicita que uma cópia de segurança do segredo especificado seja transferida para o cliente. Todas as versões do segredo serão descarregadas. Esta operação requer a permissão de segredos/backup.

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

Parâmetros Obrigatórios

--file -f

Arquivar para receber o conteúdo secreto.

Parâmetros Opcionais

--id

Identificação do segredo. Se especificados todos os outros argumentos de identificação devem ser omitidos.

--name -n

O nome do segredo. Necessário se não for especificado o id.

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição padrão utilizando az account set -s NAME_OR_ID .

--vault-name

Nome do Cofre de Chaves. Necessário se não for especificado o id.

az keyvault secret delete

Elimina um segredo de um cofre de chaves especificado.

A operação DELETE aplica-se a qualquer segredo armazenado no Cofre da Chave Azure. A DELETE não pode ser aplicada a uma versão individual de um segredo. Esta operação requer a permissão de segredos/eliminação.

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

Parâmetros Opcionais

--id

Identificação do segredo. Se especificados todos os outros argumentos de identificação devem ser omitidos.

--name -n

O nome do segredo. Necessário se não for especificado o id.

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição padrão utilizando az account set -s NAME_OR_ID .

--vault-name

Nome do Cofre de Chaves. Necessário se não for especificado o id.

az keyvault secret download

Descarregue 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 Obrigatórios

--file -f

Arquivar para receber o conteúdo secreto.

Parâmetros Opcionais

--encoding -e

Codificar o segredo. Por predefinição, procurará a etiqueta de codificação de ficheiros no segredo. Caso contrário, assumirá 'utf-8'.

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

Identificação do segredo. Se especificados todos os outros argumentos de identificação devem ser omitidos.

--name -n

O nome do segredo. Necessário se não for especificado o id.

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição padrão utilizando az account set -s NAME_OR_ID .

--vault-name

Nome do Cofre de Chaves. Necessário se não for especificado o id.

--version -v

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

az keyvault secret list

Listar segredos num cofre de chaves especificado.

A operação Get Secrets é aplicável a todo o cofre. No entanto, apenas o identificador de base secreto e os seus atributos são fornecidos na resposta. As versões secretas individuais não estão listadas na resposta. Esta operação requer a permissão 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 especificados todos os outros argumentos de identificação devem ser omitidos.

--include-managed

Inclua segredos geridos. Predefinição: false.

valores aceites: false, true
--maxresults

Número máximo de resultados para devolver numa página. Se não for especificado, o serviço retornará até 25 resultados.

--query-examples

Recomende a cadeia JMESPath para si. Pode copiar uma das consultas e colá-la depois de --parâmetro de consulta dentro de duas aspas para ver os resultados. Pode adicionar uma ou mais palavras-chave posicionais para que possamos dar sugestões com base nestas palavras-chave.

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição padrão utilizando az account set -s NAME_OR_ID .

--vault-name

Nome do Cofre de Chaves. Necessário se não for especificado o id.

az keyvault secret list-deleted

Lista segredos apagados para o cofre especificado.

A operação Get Deleted Secrets devolve os segredos que foram eliminados para um cofre ativado para eliminar suavemente. Esta operação requer a permissão segredos/lista.

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

Parâmetros Obrigatórios

--vault-name

Nome do Cofre.

Parâmetros Opcionais

--id

Identificação do Cofre. Se especificados todos os outros argumentos de identificação devem ser omitidos.

--maxresults

Número máximo de resultados para devolver numa página. Se não for especificado, o serviço retornará até 25 resultados.

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição padrão utilizando az account set -s NAME_OR_ID .

az keyvault secret list-versions

Lista todas as versões do segredo especificado.

O identificador e atributos secretos completos são fornecidos na resposta. Nenhum valor é devolvido pelos segredos. Estas operações requerem a permissão segredos/lista.

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

Parâmetros Opcionais

--id

Identificação do segredo. Se especificados todos os outros argumentos de identificação devem ser omitidos.

--maxresults

Número máximo de resultados para devolver numa página. Se não for especificado, o serviço retornará até 25 resultados.

--name -n

O nome do segredo. Necessário se não for especificado o id.

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição padrão utilizando az account set -s NAME_OR_ID .

--vault-name

Nome do Cofre de Chaves. Necessário se não for especificado o id.

az keyvault secret purge

Elimina permanentemente o segredo especificado.

A purga eliminada operação secreta remove o segredo permanentemente, sem possibilidade de recuperação. Esta operação só pode ser ativada num cofre ativado por eliminação suave. Esta operação requer a permissão de segredos/purga.

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

Parâmetros Opcionais

--id

A identificação de recuperação do segredo. Se especificados todos os outros argumentos de identificação devem ser omitidos.

--name -n

O nome do segredo. Necessário se não for especificado o id.

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição padrão utilizando az account set -s NAME_OR_ID .

--vault-name

Nome do Cofre. Necessário se não for especificado o id.

az keyvault secret recover

Recupera o segredo apagado para a versão mais recente.

Recupera o segredo apagado no cofre especificado. Esta operação só pode ser efetuada num cofre com uma eliminação suave. Esta operação requer a permissão de segredos/recuperação.

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

Parâmetros Opcionais

--id

A identificação de recuperação do segredo. Se especificados todos os outros argumentos de identificação devem ser omitidos.

--name -n

O nome do segredo. Necessário se não for especificado o id.

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição padrão utilizando az account set -s NAME_OR_ID .

--vault-name

Nome do Cofre. Necessário se não for especificado o id.

az keyvault secret restore

Restaura um segredo de apoio a um cofre.

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

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

Parâmetros Obrigatórios

--file -f

Arquivar para receber o conteúdo secreto.

--vault-name

Nome do Cofre.

Parâmetros Opcionais

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição padrão utilizando az account set -s NAME_OR_ID .

az keyvault secret set

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

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

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

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

Parâmetros Obrigatórios

--name -n

O nome do segredo.

--vault-name

Nome do Cofre.

Parâmetros Opcionais

--description

Descrição do conteúdo secreto (por exemplo, palavra-passe, fio de ligação, etc).

--disabled

Criar segredo em estado de deficientes.

valores aceites: false, true
--encoding -e

Codificação de ficheiros de origem. O valor é guardado como uma etiqueta ( file-encoding=<val> ) e utilizado durante o download para codificar automaticamente o ficheiro resultante.

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

Data de validade utc (Y-m-d'T'H:M:S'Z').

--file -f

Arquivo de origem para segredo. Utilizar em conjunto com "codificação".

--not-before

Chave não utilizável antes da data de data fornecida utc (Y-m-d'T'H:M:S'Z').

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição padrão utilizando az account set -s NAME_OR_ID .

--tags

Etiquetas separadas pelo espaço: chave[=valor] [chave[=valor] ...]. Utilize "" para limpar as etiquetas existentes.

--value

Valor secreto de texto simples. Não pode ser usado com "ficheiro" ou "codificação".

az keyvault secret set-attributes

Atualiza os atributos associados a um segredo especificado num dado cofre de chaves.

A operação UPDATE altera os atributos especificados de um segredo armazenado existente. Os atributos que não são especificados no pedido ficam inalterados. O valor de um segredo em si não pode ser alterado. Esta operação requer a permissão secreta/definida.

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

Ativar o segredo.

valores aceites: false, true
--expires

Data de validade utc (Y-m-d'T'H:M:S'Z').

--id

Identificação do segredo. Se especificados todos os outros argumentos de identificação devem ser omitidos.

--name -n

O nome do segredo. Necessário se não for especificado o id.

--not-before

Chave não utilizável antes da data de data fornecida utc (Y-m-d'T'H:M:S'Z').

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição padrão utilizando az account set -s NAME_OR_ID .

--tags

Etiquetas separadas pelo espaço: chave[=valor] [chave[=valor] ...]. Utilize "" para limpar as etiquetas existentes.

--vault-name

Nome do Cofre de Chaves. Necessário se não for especificado o id.

--version -v

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

az keyvault secret show

Obter um segredo especificado de um cofre de chaves.

A operação GET é aplicável a qualquer segredo armazenado no Cofre da Chave 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

Identificação do segredo. Se especificados todos os outros argumentos de identificação devem ser omitidos.

--name -n

O nome do segredo. Necessário se não for especificado o id.

--query-examples

Recomende a cadeia JMESPath para si. Pode copiar uma das consultas e colá-la depois de --parâmetro de consulta dentro de duas aspas para ver os resultados. Pode adicionar uma ou mais palavras-chave posicionais para que possamos dar sugestões com base nestas palavras-chave.

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição padrão utilizando az account set -s NAME_OR_ID .

--vault-name

Nome do Cofre de Chaves. Necessário se não for especificado o id.

--version -v

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

az keyvault secret show-deleted

Obtém o segredo apagado especificado.

A operação Get Deleted Secret devolve o segredo eliminado especificado juntamente com os 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 identificação de recuperação do segredo. Se especificados todos os outros argumentos de identificação devem ser omitidos.

--name -n

O nome do segredo. Necessário se não for especificado o id.

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição padrão utilizando az account set -s NAME_OR_ID .

--vault-name

Nome do Cofre. Necessário se não for especificado o id.