Compartilhar via


az keyvault

Gerencie chaves, segredos e certificados do KeyVault.

Comandos

Nome Description Tipo Status
az keyvault backup

Gerencie o backup completo do HSM.

Core GA
az keyvault backup start

Inicie um backup completo do HSM.

Core GA
az keyvault certificate

Gerenciar certificados.

Core GA
az keyvault certificate backup

Faz backup do certificado especificado.

Core GA
az keyvault certificate contact

Gerenciar contatos para gerenciamento de certificados.

Core GA
az keyvault certificate contact add

Adicione um contato ao cofre especificado para receber notificações de operações de certificado.

Core GA
az keyvault certificate contact delete

Remova um contato de certificado do cofre especificado.

Core GA
az keyvault certificate contact list

Lista os contatos de certificado para um cofre de chaves especificado.

Core GA
az keyvault certificate create

Crie um certificado do Key Vault.

Core GA
az keyvault certificate delete

Exclui um certificado de um cofre de chaves especificado.

Core Deprecated
az keyvault certificate download

Baixe a parte pública de um certificado do Key Vault.

Core GA
az keyvault certificate get-default-policy

Obtenha a política padrão para certificados autoassinados.

Core GA
az keyvault certificate import

Importe um certificado para KeyVault.

Core GA
az keyvault certificate issuer

Gerenciar informações do emissor do certificado.

Core GA
az keyvault certificate issuer admin

Gerenciar informações de administrador para emissores de certificado.

Core GA
az keyvault certificate issuer admin add

Adicione detalhes de administrador para um emissor de certificado especificado.

Core GA
az keyvault certificate issuer admin delete

Remova os detalhes do administrador para o emissor do certificado especificado.

Core GA
az keyvault certificate issuer admin list

Listar administradores para um emissor de certificado especificado.

Core GA
az keyvault certificate issuer create

Crie um registro do emissor do certificado.

Core GA
az keyvault certificate issuer delete

Exclui o emissor do certificado especificado.

Core GA
az keyvault certificate issuer list

Lista as propriedades dos emissores de certificado para o cofre de chaves.

Core GA
az keyvault certificate issuer show

Obtém o emissor do certificado especificado.

Core GA
az keyvault certificate issuer update

Atualize um registro do emissor do certificado.

Core GA
az keyvault certificate list

Listar certificados em um cofre de chaves especificado.

Core GA
az keyvault certificate list-deleted

Lista os certificados excluídos atualmente recuperáveis.

Core GA
az keyvault certificate list-versions

Listar as versões de um certificado.

Core GA
az keyvault certificate pending

Gerenciar operações de criação de certificado pendentes.

Core GA
az keyvault certificate pending delete

Exclui a operação de criação de um certificado específico.

Core GA
az keyvault certificate pending merge

Mescla um certificado ou uma cadeia de certificados com um par de chaves existente no servidor.

Core GA
az keyvault certificate pending show

Obtém a operação de criação de um certificado.

Core GA
az keyvault certificate purge

Exclui permanentemente o certificado excluído especificado.

Core GA
az keyvault certificate recover

Recupere um certificado excluído para sua versão mais recente.

Core GA
az keyvault certificate restore

Restaura um certificado de backup em um cofre.

Core GA
az keyvault certificate set-attributes

Atualiza os atributos especificados associados ao certificado determinado.

Core GA
az keyvault certificate show

Obtém informações sobre um certificado.

Core GA
az keyvault certificate show-deleted

Obtenha um certificado excluído.

Core GA
az keyvault check-name

Verifique se o nome fornecido é válido e ainda não está em uso.

Core GA
az keyvault create

Crie um Cofre ou HSM.

Core GA
az keyvault delete

Exclua um Cofre ou HSM.

Core GA
az keyvault delete-policy

Exclua as configurações de política de segurança para um Key Vault.

Core GA
az keyvault key

Gerenciar chaves.

Core GA
az keyvault key backup

Solicite que um backup da chave especificada seja baixado para o cliente.

Core GA
az keyvault key create

Crie uma nova chave, armazene-a e, em seguida, retorna parâmetros de chave e atributos para o cliente.

Core GA
az keyvault key decrypt

Descriptografe um único bloco de dados criptografados.

Core Preview
az keyvault key delete

Exclua uma chave de qualquer tipo do armazenamento no Cofre ou HSM.

Core GA
az keyvault key download

Baixe a parte pública de uma chave armazenada.

Core GA
az keyvault key encrypt

Criptografe uma sequência arbitrária de bytes usando uma chave de criptografia armazenada em um Cofre ou HSM.

Core Preview
az keyvault key get-attestation

Obtenha o blob de atestado de uma chave.

Core GA
az keyvault key get-policy-template

Retornar modelo de política como definição de política codificada em JSON.

Core Preview
az keyvault key import

Importe uma chave privada.

Core GA
az keyvault key list

Listar chaves no Cofre ou HSM especificado.

Core GA
az keyvault key list-deleted

Liste as chaves excluídas no Cofre ou HSM especificado.

Core GA
az keyvault key list-versions

Liste os identificadores e as propriedades das versões de uma chave.

Core GA
az keyvault key purge

Exclua permanentemente a chave especificada.

Core GA
az keyvault key random

Obtenha o número solicitado de bytes aleatórios de um HSM gerenciado.

Core GA
az keyvault key recover

Recupere a chave excluída para sua versão mais recente.

Core GA
az keyvault key restore

Restaure uma chave de backup para um Cofre ou HSM.

Core GA
az keyvault key rotate

Gire a chave com base na política de chave gerando uma nova versão da chave.

Core GA
az keyvault key rotation-policy

Gerenciar a política de rotação da chave.

Core GA
az keyvault key rotation-policy show

Obtenha a política de rotação de uma chave do Key Vault.

Core GA
az keyvault key rotation-policy update

Atualize a política de rotação de uma chave do Key Vault.

Core GA
az keyvault key set-attributes

A operação de chave de atualização altera os atributos especificados de uma chave armazenada e pode ser aplicada a qualquer tipo de chave e versão de chave armazenada no Cofre ou HSM.

Core GA
az keyvault key show

Obtenha os atributos de uma chave e, se for uma chave assimétrica, seu material público.

Core GA
az keyvault key show-deleted

Obtenha a parte pública de uma chave excluída.

Core GA
az keyvault key sign

Crie uma assinatura de um resumo usando uma chave armazenada em um Cofre ou HSM.

Core GA
az keyvault key verify

Verifique uma assinatura usando a chave armazenada em um Cofre ou HSM.

Core GA
az keyvault list

Listar cofres e/ou HSMs.

Core GA
az keyvault list-deleted

Obtenha informações sobre os Cofres ou HSMs excluídos em uma assinatura.

Core GA
az keyvault network-rule

Gerenciar ACLs de rede para cofre ou hsm gerenciado.

Core GA
az keyvault network-rule add

Adicione uma regra de rede às ACLs de rede para um Key Vault ou um HSM gerenciado.

Core GA
az keyvault network-rule list

Liste as regras de rede das ACLs de rede para um Key Vault ou um HSM gerenciado.

Core GA
az keyvault network-rule remove

Remova uma regra de rede das ACLs de rede para um Key Vault ou um HSM gerenciado.

Core GA
az keyvault network-rule wait

Coloque a CLI em um estado de espera até que uma condição do cofre ou hsm gerenciado seja atendida.

Core GA
az keyvault private-endpoint-connection

Gerencie conexões de ponto de extremidade privado do cofre/HSM.

Core GA
az keyvault private-endpoint-connection approve

Aprove uma solicitação de conexão de ponto de extremidade privado para um Key Vault/HSM.

Core GA
az keyvault private-endpoint-connection delete

Exclua a conexão de ponto de extremidade privado especificada associada a um Key Vault/HSM.

Core GA
az keyvault private-endpoint-connection list

Liste todas as conexões de ponto de extremidade privado associadas a um HSM.

Core GA
az keyvault private-endpoint-connection reject

Rejeite uma solicitação de conexão de ponto de extremidade privado para um Key Vault/HSM.

Core GA
az keyvault private-endpoint-connection show

Mostrar detalhes de uma conexão de ponto de extremidade privado associada a um Key Vault/HSM.

Core GA
az keyvault private-endpoint-connection wait

Coloque a CLI em um estado de espera até que uma condição da conexão de ponto de extremidade privado seja atendida.

Core GA
az keyvault private-link-resource

Gerencie recursos de link privado do cofre/HSM.

Core GA
az keyvault private-link-resource list

Liste os recursos de link privado com suporte para um Key Vault/HSM.

Core GA
az keyvault purge

Exclua permanentemente o Cofre ou O HSM especificado. Também conhecido como Limpar o Cofre excluído ou o HSM.

Core GA
az keyvault recover

Recuperar um Cofre ou HSM.

Core GA
az keyvault region

Gerencie multirregiões do MHSM.

Core GA
az keyvault region add

Adicione regiões para o pool de HSM gerenciado.

Core GA
az keyvault region list

Obtenha informações de regiões associadas ao pool de HSM gerenciado.

Core GA
az keyvault region remove

Remova regiões do pool de HSM gerenciado.

Core GA
az keyvault region wait

Coloque a CLI em um estado de espera até que uma condição do HSM seja atendida.

Core GA
az keyvault restore

Gerenciar a restauração completa do HSM.

Core GA
az keyvault restore start

Restaure um backup completo de um HSM.

Core GA
az keyvault role

Gerencie funções de usuário para controle de acesso.

Core GA
az keyvault role assignment

Gerenciar atribuições de função.

Core GA
az keyvault role assignment create

Crie uma nova atribuição de função para um usuário, grupo ou entidade de serviço.

Core GA
az keyvault role assignment delete

Exclua uma atribuição de função.

Core GA
az keyvault role assignment list

Listar atribuições de função.

Core GA
az keyvault role definition

Gerenciar definições de função.

Core GA
az keyvault role definition create

Crie uma definição de função personalizada.

Core GA
az keyvault role definition delete

Exclua uma definição de função.

Core GA
az keyvault role definition list

Listar definições de função.

Core GA
az keyvault role definition show

Mostre os detalhes de uma definição de função.

Core GA
az keyvault role definition update

Atualize uma definição de função.

Core GA
az keyvault secret

Gerenciar segredos.

Core GA
az keyvault secret backup

Faz backup do segredo especificado.

Core GA
az keyvault secret delete

Exclua todas as versões de um segredo.

Core Deprecated
az keyvault secret download

Baixe um segredo de um KeyVault.

Core GA
az keyvault secret list

Listar segredos em um cofre de chaves especificado.

Core GA
az keyvault secret list-deleted

Lista segredos excluídos para o cofre especificado.

Core GA
az keyvault secret list-versions

Liste todas as versões do segredo especificado.

Core GA
az keyvault secret purge

Exclui permanentemente o segredo especificado.

Core GA
az keyvault secret recover

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

Core GA
az keyvault secret restore

Restaura um segredo de backup em um cofre.

Core GA
az keyvault secret set

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

Core GA
az keyvault secret set-attributes

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

Core GA
az keyvault secret show

Obtenha um segredo especificado de um determinado cofre de chaves.

Core GA
az keyvault secret show-deleted

Obtém o segredo excluído especificado.

Core GA
az keyvault security-domain

Gerencie as operações do domínio de segurança.

Core GA
az keyvault security-domain download

Baixe o arquivo de domínio de segurança do HSM.

Core GA
az keyvault security-domain init-recovery

Recupere a chave de troca do HSM.

Core GA
az keyvault security-domain restore-blob

Habilite para descriptografar e criptografar o arquivo de domínio de segurança como blob. Pode ser executado em ambiente offline, antes que o arquivo seja carregado no HSM usando o upload do domínio de segurança.

Core GA
az keyvault security-domain upload

Comece a restaurar o HSM.

Core GA
az keyvault security-domain wait

Coloque a CLI em um estado de espera até que a operação do domínio de segurança do HSM seja concluída.

Core GA
az keyvault set-policy

Atualize as configurações de política de segurança para um Key Vault.

Core GA
az keyvault setting

Gerencie as configurações do MHSM.

Core GA
az keyvault setting list

Obtenha todas as configurações associadas ao HSM gerenciado.

Core GA
az keyvault setting show

Obtenha uma configuração específica associada ao HSM gerenciado.

Core GA
az keyvault setting update

Atualize a configuração específica associada ao HSM gerenciado.

Core GA
az keyvault show

Mostrar detalhes de um Cofre ou HSM.

Core GA
az keyvault show-deleted

Mostrar detalhes de um Cofre ou HSM excluído.

Core GA
az keyvault update

Atualize as propriedades de um Cofre.

Core GA
az keyvault update-hsm

Atualize as propriedades de um HSM.

Core GA
az keyvault wait

Coloque a CLI em um estado de espera até que uma condição do Cofre seja atendida.

Core GA
az keyvault wait-hsm

Coloque a CLI em um estado de espera até que uma condição do HSM seja atendida.

Core GA

az keyvault check-name

Verifique se o nome fornecido é válido e ainda não está em uso.

az keyvault check-name --name
                       [--resource-type {hsm}]

Parâmetros Exigidos

--name -n

O nome do HSM dentro do grupo de recursos especificado.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--resource-type

Tipo de recurso.

Propriedade Valor
Valor padrão: hsm
Valores aceitos: hsm
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Propriedade Valor
Valor padrão: False

az keyvault create

Crie um Cofre ou HSM.

A autorização do RBAC está habilitada por padrão. Se --enable-rbac-authorization for especificado manualmente para false e --no-self-perms sinalizador não for especificado, as permissões padrão serão criadas para o usuário ou a entidade de serviço atual.

Se você quiser atribuir a permissão padrão, precisará alterar a assinatura padrão com az account set primeiro, em vez de usar --subscription.

az keyvault create --resource-group
                   [--administrators]
                   [--bypass {AzureServices, None}]
                   [--default-action {Allow, Deny}]
                   [--enable-purge-protection {false, true}]
                   [--enable-rbac-authorization {false, true}]
                   [--enabled-for-deployment {false, true}]
                   [--enabled-for-disk-encryption {false, true}]
                   [--enabled-for-template-deployment {false, true}]
                   [--hsm-name]
                   [--location]
                   [--mi-user-assigned]
                   [--name]
                   [--network-acls]
                   [--network-acls-ips]
                   [--network-acls-vnets]
                   [--no-self-perms {false, true}]
                   [--no-wait]
                   [--public-network-access {Disabled, Enabled}]
                   [--retention-days]
                   [--sku]
                   [--tags]

Exemplos

Crie um cofre de chaves com ACLs de rede especificadas (use --network-acls para especificar regras de IP e VNet usando uma cadeia de caracteres JSON).

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls "{\"ip\": [\"1.2.3.4\", \"2.3.4.0/24\"], \"vnet\": [\"vnet_name_1/subnet_name1\", \"vnet_name_2/subnet_name2\", \"/subscriptions/000000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualNetworks/MyVNet/subnets/MySubnet\"]}"

Crie um cofre de chaves com ACLs de rede especificadas (use --network-acls para especificar regras de IP e VNet usando um arquivo JSON).

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls network-acls-example.json

Crie um cofre de chaves com ACLs de rede especificadas (use --network-acls-ips para especificar regras de IP).

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls-ips 3.4.5.0/24 4.5.6.0/24

Crie um cofre de chaves com ACLs de rede especificadas (use --network-acls-vnets para especificar regras de VNet).

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls-vnets vnet_name_2/subnet_name_2 vnet_name_3/subnet_name_3 /subscriptions/000000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet_name_4/subnets/subnet_name_4

Crie um cofre de chaves com ACLs de rede especificadas (use --network-acls, --network-acls-ips e --network-acls-vnets juntos, regras redundantes serão removidas, finalmente haverá 4 regras de IP e 3 regras de VNet).

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls "{\"ip\": [\"1.2.3.4\", \"2.3.4.0/24\"], \"vnet\": [\"vnet_name_1/subnet_name1\", \"vnet_name_2/subnet_name2\"]}" --network-acls-ips 3.4.5.0/24 4.5.6.0/24 --network-acls-vnets vnet_name_2/subnet_name_2 vnet_name_3/subnet_name_3 /subscriptions/000000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet_name_4/subnets/subnet_name_4

Crie um cofre de chaves. (autogenerated)

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup

Parâmetros Exigidos

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--administrators

[Somente HSM] Função de administrador para operações de plano de dados para HSM Gerenciado. Ele aceita uma lista separada por espaço de OIDs que serão atribuídos.

--bypass

Ignore o tráfego para usos separados por espaço.

Propriedade Valor
Grupo de parâmetros: Network Rule Arguments
Valores aceitos: AzureServices, None
--default-action

Ação padrão a ser aplicada quando nenhuma regra corresponder.

Propriedade Valor
Grupo de parâmetros: Network Rule Arguments
Valores aceitos: Allow, Deny
--enable-purge-protection

Propriedade que especifica se a proteção contra limpeza está habilitada para esse pool de HSM gerenciado/cofre. Definir essa propriedade como true ativa a proteção contra limpeza para esse pool de HSM gerenciado/cofre e seu conteúdo – somente o serviço HSM gerenciado/Key Vault pode iniciar uma exclusão dura e irrecuperável. A configuração só será efetiva se a exclusão reversível também estiver habilitada. Habilitar essa funcionalidade é irreversível.

Propriedade Valor
Valores aceitos: false, true
--enable-rbac-authorization

Propriedade que controla como as ações de dados são autorizadas. Quando verdadeiro, o cofre de chaves usará o RBAC (Controle de Acesso Baseado em Função) para autorização de ações de dados e as políticas de acesso especificadas nas propriedades do cofre serão ignoradas. Quando false, o cofre de chaves usará as políticas de acesso especificadas nas propriedades do cofre e qualquer política armazenada no Azure Resource Manager será ignorada. Se for nulo ou não especificado, o cofre será criado com o valor padrão de true. Observe que as ações de gerenciamento são sempre autorizadas com RBAC.

Propriedade Valor
Valor padrão: True
Valores aceitos: false, true
--enabled-for-deployment

[Somente cofre] Propriedade para especificar se as Máquinas Virtuais do Azure têm permissão para recuperar certificados armazenados como segredos do cofre de chaves.

Propriedade Valor
Valores aceitos: false, true
--enabled-for-disk-encryption

[Somente cofre] Propriedade para especificar se o Azure Disk Encryption tem permissão para recuperar segredos do cofre e desembrulhar chaves.

Propriedade Valor
Valores aceitos: false, true
--enabled-for-template-deployment

[Somente cofre] Propriedade para especificar se o Azure Resource Manager tem permissão para recuperar segredos do cofre de chaves.

Propriedade Valor
Valores aceitos: false, true
--hsm-name

Nome do HSM. (--hsm-name e --name/-n são mutuamente exclusivos, especifique apenas um deles).

--location -l

Location. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

--mi-user-assigned

[Somente HSM] Habilite identidades gerenciadas atribuídas pelo usuário para HSM gerenciado. Aceite a lista separada por espaço de IDs de recursos de identidade.

--name -n

Nome do Cofre.

--network-acls

ACLs de rede. Ele aceita um nome de arquivo JSON ou uma cadeia de caracteres JSON. Formato JSON: {\"ip\":[<ip1>, <ip2>...],\"vnet\":[<vnet_name_1>/<subnet_name_1>,<subnet_id2>...]}.

Propriedade Valor
Grupo de parâmetros: Network Rule Arguments
--network-acls-ips

Regras de IP de ACLs de rede. Lista separada por espaço de endereços IP.

Propriedade Valor
Grupo de parâmetros: Network Rule Arguments
--network-acls-vnets

Regras de VNet acls de rede. Lista separada por espaço de pares de rede virtual/sub-rede ou IDs de recursos de sub-rede.

Propriedade Valor
Grupo de parâmetros: Network Rule Arguments
--no-self-perms

[Somente cofre] Não adicione permissões para o usuário/entidade de serviço atual no novo cofre.

Propriedade Valor
Valores aceitos: false, true
--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valor padrão: False
--public-network-access

Controle a permissão para o tráfego do plano de dados proveniente de redes públicas enquanto o ponto de extremidade privado está habilitado.

Propriedade Valor
Valores aceitos: Disabled, Enabled
--retention-days

Dias de retenção de dados de exclusão reversível. Ele aceita >=7 e <=90. O padrão é 90 para a criação do keyvault. Necessário para a criação do MHSM.

--sku

Required. Detalhes da SKU. Valores permitidos para Vault: premium, standard. Padrão: padrão. Valores permitidos para HSM: Standard_B1, Custom_B32, Custom_B6, Custom_C42, Custom_C10. Padrão: Standard_B1.

--tags

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

Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Propriedade Valor
Valor padrão: False

az keyvault delete

Exclua um Cofre ou HSM.

az keyvault delete [--hsm-name]
                   [--name]
                   [--no-wait]
                   [--resource-group]

Exemplos

Exclua um cofre de chaves. (autogenerated)

az keyvault delete --name MyKeyVault --resource-group MyResourceGroup

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--hsm-name

Nome do HSM. (--hsm-name e --name/-n são mutuamente exclusivos, especifique apenas um deles).

--name -n

Nome do Cofre.

--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valor padrão: False
--resource-group -g

Nome do grupo de recursos.

Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Propriedade Valor
Valor padrão: False

az keyvault delete-policy

Exclua as configurações de política de segurança para um Key Vault.

az keyvault delete-policy --name
                          [--application-id]
                          [--no-wait]
                          [--object-id]
                          [--resource-group]
                          [--spn]
                          [--upn]

Parâmetros Exigidos

--name -n

Nome do Cofre.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--application-id

ID do aplicativo do cliente que está fazendo solicitação em nome de uma entidade de segurança. Exposto para identidade composta usando o fluxo de autenticação em nome.

--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valor padrão: False
--object-id

Um GUID que identifica a entidade de segurança que receberá permissões.

--resource-group -g

Nome do grupo de recursos.

--spn

Nome de uma entidade de serviço que receberá permissões.

--upn

Nome de uma entidade de usuário que receberá permissões.

Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Propriedade Valor
Valor padrão: False

az keyvault list

Listar cofres e/ou HSMs.

az keyvault list [--resource-group]
                 [--resource-type]

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--resource-type

Quando --resource-type não estiver presente, o comando listará todos os Cofres e HSMs. Os valores possíveis para --resource-type são cofre e hsm.

Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Propriedade Valor
Valor padrão: False

az keyvault list-deleted

Obtenha informações sobre os Cofres ou HSMs excluídos em uma assinatura.

az keyvault list-deleted [--resource-type]

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--resource-type

Quando --resource-type não estiver presente, o comando listará todos os Cofres e HSMs excluídos. Os valores possíveis para --resource-type são cofre e hsm.

Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Propriedade Valor
Valor padrão: False

az keyvault purge

Exclua permanentemente o Cofre ou O HSM especificado. Também conhecido como Limpar o Cofre excluído ou o HSM.

az keyvault purge [--hsm-name]
                  [--location]
                  [--name]
                  [--no-wait]

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--hsm-name

Nome do HSM excluído. (--hsm-name e --name/-n são mutuamente exclusivos, especifique apenas um deles).

--location -l

Local do Cofre ou HSM excluído.

--name -n

Nome do Cofre excluído.

--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valor padrão: False
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Propriedade Valor
Valor padrão: False

az keyvault recover

Recuperar um Cofre ou HSM.

Recupere um Cofre ou HSM excluído anteriormente para o qual a exclusão reversível foi habilitada.

az keyvault recover [--hsm-name]
                    [--location]
                    [--name]
                    [--no-wait]
                    [--resource-group]

Exemplos

Recuperar um cofre de chaves. (autogenerated)

az keyvault recover --location westus2 --name MyKeyVault --resource-group MyResourceGroup

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--hsm-name

Nome do HSM excluído. (--hsm-name e --name/-n são mutuamente exclusivos, especifique apenas um deles).

--location -l

Local do Cofre ou HSM excluído.

--name -n

Nome do Cofre excluído.

--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valor padrão: False
--resource-group -g

Grupo de recursos do Cofre ou HSM excluído.

Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Propriedade Valor
Valor padrão: False

az keyvault set-policy

Atualize as configurações de política de segurança para um Key Vault.

az keyvault set-policy --name
                       [--application-id]
                       [--certificate-permissions {all, backup, create, delete, deleteissuers, get, getissuers, import, list, listissuers, managecontacts, manageissuers, purge, recover, restore, setissuers, update}]
                       [--key-permissions {all, backup, create, decrypt, delete, encrypt, get, getrotationpolicy, import, list, purge, recover, release, restore, rotate, setrotationpolicy, sign, unwrapKey, update, verify, wrapKey}]
                       [--no-wait]
                       [--object-id]
                       [--resource-group]
                       [--secret-permissions {all, backup, delete, get, list, purge, recover, restore, set}]
                       [--spn]
                       [--storage-permissions {all, backup, delete, deletesas, get, getsas, list, listsas, purge, recover, regeneratekey, restore, set, setsas, update}]
                       [--upn]

Exemplos

Atribua permissões de chave 'get', 'list', 'import' e secret permissions 'backup', 'restore' para uma ID de objeto.

az keyvault set-policy -n MyVault --key-permissions get list import --secret-permissions backup restore --object-id {GUID}

Atribua permissões de chave 'get', 'list' a um UPN (Nome da Entidade de Usuário).

az keyvault set-policy -n MyVault --key-permissions get list --upn {UPN}

Atribua permissões de chave 'get', 'list' a um SPN (Nome da Entidade de Serviço).

az keyvault set-policy -n MyVault --key-permissions get list --spn {SPN}

Parâmetros Exigidos

--name -n

Nome do Cofre.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--application-id

ID do aplicativo do cliente que está fazendo solicitação em nome de uma entidade de segurança. Exposto para identidade composta usando o fluxo de autenticação em nome.

--certificate-permissions

Lista separada por espaço de permissões de certificado a serem atribuídas.

Propriedade Valor
Grupo de parâmetros: Permission Arguments
Valores aceitos: all, backup, create, delete, deleteissuers, get, getissuers, import, list, listissuers, managecontacts, manageissuers, purge, recover, restore, setissuers, update
--key-permissions

Lista separada por espaço de permissões de chave a serem atribuídas.

Propriedade Valor
Grupo de parâmetros: Permission Arguments
Valores aceitos: all, backup, create, decrypt, delete, encrypt, get, getrotationpolicy, import, list, purge, recover, release, restore, rotate, setrotationpolicy, sign, unwrapKey, update, verify, wrapKey
--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valor padrão: False
--object-id

Um GUID que identifica a entidade de segurança que receberá permissões.

--resource-group -g

Nome do grupo de recursos.

--secret-permissions

Lista separada por espaço de permissões secretas a serem atribuídas.

Propriedade Valor
Grupo de parâmetros: Permission Arguments
Valores aceitos: all, backup, delete, get, list, purge, recover, restore, set
--spn

Nome de uma entidade de serviço que receberá permissões.

--storage-permissions

Lista separada por espaço de permissões de armazenamento a serem atribuídas.

Propriedade Valor
Grupo de parâmetros: Permission Arguments
Valores aceitos: all, backup, delete, deletesas, get, getsas, list, listsas, purge, recover, regeneratekey, restore, set, setsas, update
--upn

Nome de uma entidade de usuário que receberá permissões.

Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Propriedade Valor
Valor padrão: False

az keyvault show

Mostrar detalhes de um Cofre ou HSM.

az keyvault show [--hsm-name]
                 [--name]
                 [--resource-group]

Exemplos

Mostrar detalhes de um cofre de chaves. (autogenerated)

az keyvault show --name MyKeyVault

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--hsm-name

Nome do HSM. (--hsm-name e --name/-n são mutuamente exclusivos, especifique apenas um deles).

--name -n

Nome do Cofre.

--resource-group -g

Nome do grupo de recursos.

Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Propriedade Valor
Valor padrão: False

az keyvault show-deleted

Mostrar detalhes de um Cofre ou HSM excluído.

az keyvault show-deleted [--hsm-name]
                         [--location]
                         [--name]

Exemplos

Mostrar detalhes de um cofre de chaves excluído.

az keyvault show-deleted --name MyKeyVault

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--hsm-name

Nome do HSM excluído. (--hsm-name e --name/-n são mutuamente exclusivos, especifique apenas um deles).

--location -l

Local do Cofre ou HSM excluído.

--name -n

Nome do Cofre excluído.

Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Propriedade Valor
Valor padrão: False

az keyvault update

Atualize as propriedades de um Cofre.

az keyvault update --name
                   [--add]
                   [--bypass {AzureServices, None}]
                   [--default-action {Allow, Deny}]
                   [--enable-purge-protection {false, true}]
                   [--enable-rbac-authorization {false, true}]
                   [--enabled-for-deployment {false, true}]
                   [--enabled-for-disk-encryption {false, true}]
                   [--enabled-for-template-deployment {false, true}]
                   [--force-string]
                   [--no-wait]
                   [--public-network-access {Disabled, Enabled}]
                   [--remove]
                   [--resource-group]
                   [--retention-days]
                   [--set]

Exemplos

Atualize as propriedades de um Cofre. (autogenerated)

az keyvault update --enabled-for-disk-encryption true --name MyKeyVault --resource-group MyResourceGroup

Parâmetros Exigidos

--name -n

Nome do Cofre.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valor padrão: []
--bypass

Ignore o tráfego para usos separados por espaço.

Propriedade Valor
Grupo de parâmetros: Network Rule Arguments
Valores aceitos: AzureServices, None
--default-action

Ação padrão a ser aplicada quando nenhuma regra corresponder.

Propriedade Valor
Grupo de parâmetros: Network Rule Arguments
Valores aceitos: Allow, Deny
--enable-purge-protection

Propriedade que especifica se a proteção contra limpeza está habilitada para esse pool de HSM gerenciado/cofre. Definir essa propriedade como true ativa a proteção contra limpeza para esse pool de HSM gerenciado/cofre e seu conteúdo – somente o serviço HSM gerenciado/Key Vault pode iniciar uma exclusão dura e irrecuperável. A configuração só será efetiva se a exclusão reversível também estiver habilitada. Habilitar essa funcionalidade é irreversível.

Propriedade Valor
Valores aceitos: false, true
--enable-rbac-authorization

Propriedade que controla como as ações de dados são autorizadas. Quando verdadeiro, o cofre de chaves usará o RBAC (Controle de Acesso Baseado em Função) para autorização de ações de dados e as políticas de acesso especificadas nas propriedades do cofre serão ignoradas. Quando false, o cofre de chaves usará as políticas de acesso especificadas nas propriedades do cofre e qualquer política armazenada no Azure Resource Manager será ignorada. Se for nulo ou não especificado, o cofre será criado com o valor padrão de true. Observe que as ações de gerenciamento são sempre autorizadas com RBAC.

Propriedade Valor
Valores aceitos: false, true
--enabled-for-deployment

[Somente cofre] Propriedade para especificar se as Máquinas Virtuais do Azure têm permissão para recuperar certificados armazenados como segredos do cofre de chaves.

Propriedade Valor
Valores aceitos: false, true
--enabled-for-disk-encryption

[Somente cofre] Propriedade para especificar se o Azure Disk Encryption tem permissão para recuperar segredos do cofre e desembrulhar chaves.

Propriedade Valor
Valores aceitos: false, true
--enabled-for-template-deployment

[Somente cofre] Propriedade para especificar se o Azure Resource Manager tem permissão para recuperar segredos do cofre de chaves.

Propriedade Valor
Valores aceitos: false, true
--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter em JSON.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valor padrão: False
--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valor padrão: False
--public-network-access

Controle a permissão para o tráfego do plano de dados proveniente de redes públicas enquanto o ponto de extremidade privado está habilitado.

Propriedade Valor
Valores aceitos: Disabled, Enabled
--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valor padrão: []
--resource-group -g

Nome do grupo de recursos.

--retention-days

Dias de retenção de dados de exclusão reversível. Ele aceita >=7 e <=90.

--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valor padrão: []
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Propriedade Valor
Valor padrão: False

az keyvault update-hsm

Atualize as propriedades de um HSM.

az keyvault update-hsm --hsm-name
                       [--add]
                       [--bypass {AzureServices, None}]
                       [--default-action {Allow, Deny}]
                       [--enable-purge-protection {false, true}]
                       [--force-string]
                       [--mi-user-assigned]
                       [--no-wait]
                       [--public-network-access {Disabled, Enabled}]
                       [--remove]
                       [--resource-group]
                       [--secondary-locations]
                       [--set]

Exemplos

Atualize as propriedades de um HSM.

az keyvault update-hsm --enable-purge-protection true --hsm-name MyHSM --resource-group MyResourceGroup

Parâmetros Exigidos

--hsm-name

Nome do HSM.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valor padrão: []
--bypass

Ignore o tráfego para usos separados por espaço.

Propriedade Valor
Grupo de parâmetros: Network Rule Arguments
Valores aceitos: AzureServices, None
--default-action

Ação padrão a ser aplicada quando nenhuma regra corresponder.

Propriedade Valor
Grupo de parâmetros: Network Rule Arguments
Valores aceitos: Allow, Deny
--enable-purge-protection -e

Propriedade que especifica se a proteção contra limpeza está habilitada para esse pool de HSM gerenciado/cofre. Definir essa propriedade como true ativa a proteção contra limpeza para esse pool de HSM gerenciado/cofre e seu conteúdo – somente o serviço HSM gerenciado/Key Vault pode iniciar uma exclusão dura e irrecuperável. A configuração só será efetiva se a exclusão reversível também estiver habilitada. Habilitar essa funcionalidade é irreversível.

Propriedade Valor
Valores aceitos: false, true
--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter em JSON.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valor padrão: False
--mi-user-assigned

Habilite identidades gerenciadas atribuídas pelo usuário para HSM gerenciado. Aceite a lista separada por espaço de IDs de recursos de identidade.

--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valor padrão: False
--public-network-access

Controle a permissão para o tráfego do plano de dados proveniente de redes públicas enquanto o ponto de extremidade privado está habilitado.

Propriedade Valor
Valores aceitos: Disabled, Enabled
--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valor padrão: []
--resource-group -g

Nome do grupo de recursos.

--secondary-locations

--secondary-locations estende/contrai um pool de HSM para regiões listadas. O local principal onde o recurso foi originalmente criado NÃO PODE ser removido.

--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valor padrão: []
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Propriedade Valor
Valor padrão: False

az keyvault wait

Coloque a CLI em um estado de espera até que uma condição do Cofre seja atendida.

az keyvault wait --name
                 [--created]
                 [--custom]
                 [--deleted]
                 [--exists]
                 [--interval]
                 [--resource-group]
                 [--timeout]
                 [--updated]

Exemplos

Pause a CLI até que o cofre seja criado.

az keyvault wait --name MyVault --created

Parâmetros Exigidos

--name -n

Nome do Cofre.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
--custom

Aguarde até que a condição atenda a uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
--deleted

Aguarde até ser excluído.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
--exists

Aguarde até que o recurso exista.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
--interval

Intervalo de sondagem em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: 30
--resource-group -g

Nome do grupo de recursos.

--timeout

Espera máxima em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: 3600
--updated

Aguarde até que seja atualizado com provisioningState em 'Succeeded'.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Propriedade Valor
Valor padrão: False

az keyvault wait-hsm

Coloque a CLI em um estado de espera até que uma condição do HSM seja atendida.

az keyvault wait-hsm --hsm-name
                     [--created]
                     [--custom]
                     [--deleted]
                     [--exists]
                     [--interval]
                     [--resource-group]
                     [--timeout]
                     [--updated]

Exemplos

Pause a CLI até que o HSM seja criado.

az keyvault wait-hsm --hsm-name MyHSM --created

Parâmetros Exigidos

--hsm-name

Nome do HSM.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
--custom

Aguarde até que a condição atenda a uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
--deleted

Aguarde até ser excluído.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
--exists

Aguarde até que o recurso exista.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
--interval

Intervalo de sondagem em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: 30
--resource-group -g

Prossiga somente se o HSM pertencer ao grupo de recursos especificado.

--timeout

Espera máxima em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: 3600
--updated

Aguarde até que seja atualizado com provisioningState em 'Succeeded'.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Propriedade Valor
Valor padrão: False