az keyvault
Gerencie chaves, segredos e certificados do KeyVault.
Comandos
Nome | Description | Tipo | Status |
---|---|---|---|
az keyvault backup |
Gerencie o backup completo do HSM. |
Núcleo | GA |
az keyvault backup start |
Inicie um backup completo do HSM. |
Núcleo | GA |
az keyvault certificate |
Gerencie certificados. |
Núcleo | GA |
az keyvault certificate backup |
Faz backup do certificado especificado. |
Núcleo | GA |
az keyvault certificate contact |
Gerenciar contatos para gerenciamento de certificados. |
Núcleo | GA |
az keyvault certificate contact add |
Adicione um contato ao cofre especificado para receber notificações de operações de certificado. |
Núcleo | GA |
az keyvault certificate contact delete |
Remova um contato de certificado do cofre especificado. |
Núcleo | GA |
az keyvault certificate contact list |
Lista os contatos de certificado para um cofre de chaves especificado. |
Núcleo | GA |
az keyvault certificate create |
Crie um certificado do Cofre de Chaves. |
Núcleo | GA |
az keyvault certificate delete |
Exclui um certificado de um cofre de chaves especificado. |
Núcleo | Preterido |
az keyvault certificate download |
Baixe a parte pública de um certificado do Cofre de Chaves. |
Núcleo | GA |
az keyvault certificate get-default-policy |
Obtenha a política padrão para certificados autoassinados. |
Núcleo | GA |
az keyvault certificate import |
Importe um certificado para o KeyVault. |
Núcleo | GA |
az keyvault certificate issuer |
Gerenciar informações do emissor do certificado. |
Núcleo | GA |
az keyvault certificate issuer admin |
Gerenciar informações de administrador para emissores de certificados. |
Núcleo | GA |
az keyvault certificate issuer admin add |
Adicione detalhes de administrador para um emissor de certificado especificado. |
Núcleo | GA |
az keyvault certificate issuer admin delete |
Remova os detalhes de administrador do emissor de certificado especificado. |
Núcleo | GA |
az keyvault certificate issuer admin list |
Listar administradores para um emissor de certificado especificado. |
Núcleo | GA |
az keyvault certificate issuer create |
Crie um registro de emissor de certificado. |
Núcleo | GA |
az keyvault certificate issuer delete |
Exclui o emissor de certificado especificado. |
Núcleo | GA |
az keyvault certificate issuer list |
Lista as propriedades dos emissores de certificados para o cofre de chaves. |
Núcleo | GA |
az keyvault certificate issuer show |
Obtém o emissor de certificado especificado. |
Núcleo | GA |
az keyvault certificate issuer update |
Atualizar um registro de emissor de certificado. |
Núcleo | GA |
az keyvault certificate list |
Listar certificados em um cofre de chaves especificado. |
Núcleo | GA |
az keyvault certificate list-deleted |
Lista os certificados excluídos atualmente recuperáveis. |
Núcleo | GA |
az keyvault certificate list-versions |
Listar as versões de um certificado. |
Núcleo | GA |
az keyvault certificate pending |
Gerenciar operações pendentes de criação de certificados. |
Núcleo | GA |
az keyvault certificate pending delete |
Exclui a operação de criação de um certificado específico. |
Núcleo | GA |
az keyvault certificate pending merge |
Mescla um certificado ou uma cadeia de certificados com um par de chaves existente no servidor. |
Núcleo | GA |
az keyvault certificate pending show |
Obtém a operação de criação de um certificado. |
Núcleo | GA |
az keyvault certificate purge |
Exclui permanentemente o certificado excluído especificado. |
Núcleo | GA |
az keyvault certificate recover |
Recupere um certificado excluído para sua versão mais recente. |
Núcleo | GA |
az keyvault certificate restore |
Restaura um certificado de backup em um cofre. |
Núcleo | GA |
az keyvault certificate set-attributes |
Atualiza os atributos especificados associados ao certificado determinado. |
Núcleo | GA |
az keyvault certificate show |
Obtém informações sobre um certificado. |
Núcleo | GA |
az keyvault certificate show-deleted |
Obter um certificado excluído. |
Núcleo | GA |
az keyvault check-name |
Verifique se o nome próprio é válido e ainda não está em uso. |
Núcleo | GA |
az keyvault create |
Crie um Vault ou HSM. |
Núcleo | GA |
az keyvault delete |
Exclua um Vault ou HSM. |
Núcleo | GA |
az keyvault delete-policy |
Exclua as configurações de diretiva de segurança de um Cofre de Chaves. |
Núcleo | GA |
az keyvault key |
Gerenciar as chaves. |
Núcleo | GA |
az keyvault key backup |
Solicite que um backup da chave especificada seja baixado para o cliente. |
Núcleo | GA |
az keyvault key create |
Crie uma nova chave, armazene-a e, em seguida, retorne parâmetros e atributos de chave para o cliente. |
Núcleo | GA |
az keyvault key decrypt |
Descriptografe um único bloco de dados criptografados. |
Núcleo | Visualizar |
az keyvault key delete |
Exclua uma chave de qualquer tipo do armazenamento no Vault ou no HSM. |
Núcleo | GA |
az keyvault key download |
Baixe a parte pública de uma chave armazenada. |
Núcleo | GA |
az keyvault key encrypt |
Criptografe uma sequência arbitrária de bytes usando uma chave de criptografia armazenada em um Vault ou HSM. |
Núcleo | Visualizar |
az keyvault key get-policy-template |
Modelo de política de retorno como definição de política codificada em JSON. |
Núcleo | Visualizar |
az keyvault key import |
Importar uma chave privada. |
Núcleo | GA |
az keyvault key list |
Listar chaves no Vault ou HSM especificado. |
Núcleo | GA |
az keyvault key list-deleted |
Liste as chaves excluídas no Vault ou HSM especificado. |
Núcleo | GA |
az keyvault key list-versions |
Listar os identificadores e as propriedades das versões de uma chave. |
Núcleo | GA |
az keyvault key purge |
Exclua permanentemente a chave especificada. |
Núcleo | GA |
az keyvault key random |
Obtenha o número solicitado de bytes aleatórios de um HSM gerenciado. |
Núcleo | GA |
az keyvault key recover |
Recupere a chave excluída para sua versão mais recente. |
Núcleo | GA |
az keyvault key restore |
Restaure uma chave de backup em um Vault ou HSM. |
Núcleo | GA |
az keyvault key rotate |
Gire a chave com base na política de chave gerando uma nova versão da chave. |
Núcleo | GA |
az keyvault key rotation-policy |
Gerenciar a política de rotação da chave. |
Núcleo | GA |
az keyvault key rotation-policy show |
Obtenha a política de rotação de uma chave do Cofre de Chaves. |
Núcleo | GA |
az keyvault key rotation-policy update |
Atualize a política de rotação de uma chave do Cofre da Chave. |
Núcleo | GA |
az keyvault key set-attributes |
A operação de atualização de chave altera atributos especificados de uma chave armazenada e pode ser aplicada a qualquer tipo de chave e versão de chave armazenada no Vault ou HSM. |
Núcleo | GA |
az keyvault key show |
Obtenha os atributos de uma chave e, se for uma chave assimétrica, seu material público. |
Núcleo | GA |
az keyvault key show-deleted |
Obtenha a parte pública de uma chave excluída. |
Núcleo | GA |
az keyvault key sign |
Crie uma assinatura a partir de um resumo usando uma chave armazenada em um Vault ou HSM. |
Núcleo | GA |
az keyvault key verify |
Verifique uma assinatura usando a chave armazenada em um Vault ou HSM. |
Núcleo | GA |
az keyvault list |
Listar cofres e/ou HSMs. |
Núcleo | GA |
az keyvault list-deleted |
Obtenha informações sobre os Vaults ou HSMs excluídos em uma assinatura. |
Núcleo | GA |
az keyvault network-rule |
Gerenciar ACLs de rede do vault. |
Núcleo | GA |
az keyvault network-rule add |
Adicione uma regra de rede às ACLs de rede de um Cofre de Chaves. |
Núcleo | GA |
az keyvault network-rule list |
Liste as regras de rede das ACLs de rede para um Cofre de Chaves. |
Núcleo | GA |
az keyvault network-rule remove |
Remova uma regra de rede das ACLs de rede de um Cofre de Chaves. |
Núcleo | GA |
az keyvault network-rule wait |
Coloque a CLI em um estado de espera até que uma condição do cofre seja atendida. |
Núcleo | GA |
az keyvault private-endpoint-connection |
Gerenciar conexões de endpoint privado do vault/HSM. |
Núcleo | GA |
az keyvault private-endpoint-connection approve |
Aprovar uma solicitação de conexão de ponto de extremidade privado para um Cofre de Chaves/HSM. |
Núcleo | GA |
az keyvault private-endpoint-connection delete |
Exclua a conexão de ponto de extremidade privada especificada associada a um Cofre de Chaves/HSM. |
Núcleo | GA |
az keyvault private-endpoint-connection list |
Liste todas as conexões de ponto de extremidade privadas associadas a um HSM. |
Núcleo | GA |
az keyvault private-endpoint-connection reject |
Rejeitar uma solicitação de conexão de ponto de extremidade privada para um Cofre de Chaves/HSM. |
Núcleo | GA |
az keyvault private-endpoint-connection show |
Mostrar detalhes de uma conexão de ponto de extremidade privada associada a um Cofre de Chaves/HSM. |
Núcleo | 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 privada seja atendida. |
Núcleo | GA |
az keyvault private-link-resource |
Gerenciar recursos de link privado do vault/HSM. |
Núcleo | GA |
az keyvault private-link-resource list |
Listar os recursos de link privado suportados para um Cofre de Chaves/HSM. |
Núcleo | GA |
az keyvault purge |
Exclua permanentemente o Vault ou HSM especificado. Aka Purga o Vault ou HSM excluído. |
Núcleo | GA |
az keyvault recover |
Recupere um cofre ou HSM. |
Núcleo | GA |
az keyvault region |
Gerenciar várias regiões MHSM. |
Núcleo | GA |
az keyvault region add |
Adicione regiões para o Pool de HSM gerenciado. |
Núcleo | GA |
az keyvault region list |
Obtenha informações de regiões associadas ao Pool de HSM gerenciado. |
Núcleo | GA |
az keyvault region remove |
Remova regiões do pool de HSM gerenciado. |
Núcleo | GA |
az keyvault region wait |
Coloque a CLI em um estado de espera até que uma condição do HSM seja atendida. |
Núcleo | GA |
az keyvault restore |
Gerencie a restauração completa do HSM. |
Núcleo | GA |
az keyvault restore start |
Restaure um backup completo de um HSM. |
Núcleo | GA |
az keyvault role |
Gerenciar funções de usuário para controle de acesso. |
Núcleo | GA |
az keyvault role assignment |
Gerenciar atribuições de função. |
Núcleo | GA |
az keyvault role assignment create |
Crie uma nova atribuição de função para um usuário, grupo ou entidade de serviço. |
Núcleo | GA |
az keyvault role assignment delete |
Excluir uma atribuição de função. |
Núcleo | GA |
az keyvault role assignment list |
Listar atribuições de função. |
Núcleo | GA |
az keyvault role definition |
Gerenciar definições de função. |
Núcleo | GA |
az keyvault role definition create |
Crie uma definição de função personalizada. |
Núcleo | GA |
az keyvault role definition delete |
Excluir uma definição de função. |
Núcleo | GA |
az keyvault role definition list |
Listar definições de função. |
Núcleo | GA |
az keyvault role definition show |
Mostrar os detalhes de uma definição de função. |
Núcleo | GA |
az keyvault role definition update |
Atualizar uma definição de função. |
Núcleo | GA |
az keyvault secret |
Gerenciar segredos. |
Núcleo | GA |
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 security-domain |
Gerenciar operações de domínio de segurança. |
Núcleo | GA |
az keyvault security-domain download |
Baixe o arquivo de domínio de segurança do HSM. |
Núcleo | GA |
az keyvault security-domain init-recovery |
Recupere a chave de troca do HSM. |
Núcleo | 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. |
Núcleo | GA |
az keyvault security-domain upload |
Comece a restaurar o HSM. |
Núcleo | 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. |
Núcleo | GA |
az keyvault set-policy |
Atualize as configurações de diretiva de segurança para um Cofre de Chaves. |
Núcleo | GA |
az keyvault setting |
Gerenciar configurações de MHSM. |
Núcleo | GA |
az keyvault setting list |
Obtenha todas as configurações associadas ao HSM gerenciado. |
Núcleo | GA |
az keyvault setting show |
Obtenha uma configuração específica associada ao HSM gerenciado. |
Núcleo | GA |
az keyvault setting update |
Atualize a configuração específica associada ao HSM gerenciado. |
Núcleo | GA |
az keyvault show |
Mostrar detalhes de um Vault ou HSM. |
Núcleo | GA |
az keyvault show-deleted |
Mostrar detalhes de um Vault ou HSM excluído. |
Núcleo | GA |
az keyvault update |
Atualize as propriedades de um Vault. |
Núcleo | GA |
az keyvault update-hsm |
Atualize as propriedades de um HSM. |
Núcleo | GA |
az keyvault wait |
Coloque a CLI em um estado de espera até que uma condição do Vault seja atendida. |
Núcleo | GA |
az keyvault wait-hsm |
Coloque a CLI em um estado de espera até que uma condição do HSM seja atendida. |
Núcleo | GA |
az keyvault check-name
Verifique se o nome próprio é válido e ainda não está em uso.
az keyvault check-name --name
[--resource-type {hsm}]
Parâmetros Exigidos
O nome do HSM dentro do grupo de recursos especificado.
Parâmetros Opcionais
Tipo de recurso.
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 create
Crie um Vault ou HSM.
Se --enable-rbac-authorization
não for especificado, as permissões padrão serão criadas para o usuário ou entidade de serviço atual, a menos que o --no-self-perms
sinalizador seja especificado.
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 rede virtual).
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. (gerado automaticamente)
az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup
Parâmetros Exigidos
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros Opcionais
[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.
Ignorar o tráfego para usos separados por espaço.
Ação padrão a ser aplicada quando nenhuma regra corresponder.
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 Cofre de Chaves/HSM Gerenciado pode iniciar uma exclusão dura e irrecuperável. A configuração só será efetiva se a exclusão flexível também estiver habilitada. Habilitar essa funcionalidade é irreversível.
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 Gerenciador de Recursos do Azure será ignorada. Se nulo ou não especificado, o cofre será criado com o valor padrão false. Observe que as ações de gerenciamento são sempre autorizadas com a RBAC.
[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.
[Somente cofre] Propriedade para especificar se a Criptografia de Disco do Azure tem permissão para recuperar segredos do cofre e desencapsular chaves.
[Somente cofre] Propriedade para especificar se o Gerenciador de Recursos do Azure tem permissão para recuperar segredos do cofre de chaves.
Nome do HSM. (--hsm-name e --name/-n são mutuamente exclusivos, especifique apenas um deles).
Local. Valores de: az account list-locations
. Você pode configurar o local padrão usando az configure --defaults location=<location>
.
[Somente HSM] Habilite identidades gerenciadas atribuídas pelo usuário para o HSM gerenciado. Aceite a lista separada por espaço de IDs de recursos de identidade.
Nome do cofre.
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>...]}
.
Regras de IP de ACLs de rede. Lista separada por espaço de endereços IP.
Regras de rede ACLS VNet. Lista separada por espaço de pares Vnet/sub-rede ou ids de recursos de sub-rede.
[Somente cofre] Não adicione permissões para a entidade de usuário/serviço atual no novo cofre.
Não aguarde a conclusão da operação de execução longa.
Controle a permissão para o tráfego do plano de dados proveniente de redes públicas enquanto o ponto de extremidade privado estiver habilitado.
Dias de retenção de dados de exclusão suave. Aceita >=7 e <=90. O padrão é 90 para a criação do keyvault. Necessário para a criação do MHSM.
Obrigatório. Detalhes da SKU. Valores permitidos para o Vault: premium, standard. Padrão: padrão. Valores permitidos para HSM: Standard_B1, Custom_B32. Padrão: Standard_B1.
Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar as tags existentes.
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 delete
Exclua um Vault ou HSM.
az keyvault delete [--hsm-name]
[--name]
[--no-wait]
[--resource-group]
Exemplos
Excluir um cofre de chaves. (gerado automaticamente)
az keyvault delete --name MyKeyVault --resource-group MyResourceGroup
Parâmetros Opcionais
Nome do HSM. (--hsm-name e --name/-n são mutuamente exclusivos, especifique apenas um deles).
Nome do cofre.
Não aguarde a conclusão da operação de execução longa.
Prossiga somente se o Cofre de Chaves pertencer ao grupo de recursos 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 delete-policy
Exclua as configurações de diretiva de segurança de um Cofre de Chaves.
az keyvault delete-policy --name
[--application-id]
[--no-wait]
[--object-id]
[--resource-group]
[--spn]
[--upn]
Parâmetros Exigidos
Nome do cofre.
Parâmetros Opcionais
ID do aplicativo do cliente que está fazendo a solicitação em nome de uma entidade de segurança. Exposto para identidade composta usando o fluxo de autenticação em nome de.
Não aguarde a conclusão da operação de execução longa.
Um GUID que identifica a entidade de segurança que receberá permissões.
Prossiga somente se o Cofre de Chaves pertencer ao grupo de recursos especificado.
Nome de uma entidade de serviço que receberá permissões.
Nome de uma entidade de usuário que receberá permissões.
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 list
Listar cofres e/ou HSMs.
az keyvault list [--resource-group]
[--resource-type]
Parâmetros Opcionais
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Quando --resource-type não estiver presente, o comando listará todos os Vaults e HSMs. Os valores possíveis para --resource-type são vault e hsm.
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 list-deleted
Obtenha informações sobre os Vaults ou HSMs excluídos em uma assinatura.
az keyvault list-deleted [--resource-type]
Parâmetros Opcionais
Quando --resource-type não estiver presente, o comando listará todos os Vaults e HSMs excluídos. Os valores possíveis para --resource-type são vault e hsm.
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 purge
Exclua permanentemente o Vault ou HSM especificado. Aka Purga o Vault ou HSM excluído.
az keyvault purge [--hsm-name]
[--location]
[--name]
[--no-wait]
Parâmetros Opcionais
Nome do HSM excluído. (--hsm-name e --name/-n são mutuamente exclusivos, especifique apenas um deles).
Localização do Vault ou HSM excluído.
Nome do cofre excluído.
Não aguarde a conclusão da operação de execução longa.
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 recover
Recupere um cofre ou HSM.
Recupere um Vault ou HSM excluído anteriormente para o qual a exclusão flexível foi habilitada.
az keyvault recover [--hsm-name]
[--location]
[--name]
[--no-wait]
[--resource-group]
Exemplos
Recuperar um cofre de chaves. (gerado automaticamente)
az keyvault recover --location westus2 --name MyKeyVault --resource-group MyResourceGroup
Parâmetros Opcionais
Nome do HSM excluído. (--hsm-name e --name/-n são mutuamente exclusivos, especifique apenas um deles).
Localização do Vault ou HSM excluído.
Nome do cofre excluído.
Não aguarde a conclusão da operação de execução longa.
Grupo de recursos do Vault ou HSM excluído.
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 set-policy
Atualize as configurações de diretiva de segurança para um Cofre de Chaves.
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 permissões secretas 'backup', 'restore' a 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 Principal do 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
Nome do cofre.
Parâmetros Opcionais
ID do aplicativo do cliente que está fazendo a solicitação em nome de uma entidade de segurança. Exposto para identidade composta usando o fluxo de autenticação em nome de.
Lista separada por espaço de permissões de certificado a serem atribuídas.
Lista separada por espaço de permissões de chave a serem atribuídas.
Não aguarde a conclusão da operação de execução longa.
Um GUID que identifica a entidade de segurança que receberá permissões.
Prossiga somente se o Cofre de Chaves pertencer ao grupo de recursos especificado.
Lista separada por espaço de permissões secretas a serem atribuídas.
Nome de uma entidade de serviço que receberá permissões.
Lista separada por espaço de permissões de armazenamento a serem atribuídas.
Nome de uma entidade de usuário que receberá permissões.
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 show
Mostrar detalhes de um Vault ou HSM.
az keyvault show [--hsm-name]
[--name]
[--resource-group]
Exemplos
Mostrar detalhes de um cofre de chaves. (gerado automaticamente)
az keyvault show --name MyKeyVault
Parâmetros Opcionais
Nome do HSM. (--hsm-name e --name/-n são mutuamente exclusivos, especifique apenas um deles).
Nome do cofre.
Prossiga somente se o Cofre de Chaves pertencer ao grupo de recursos 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 show-deleted
Mostrar detalhes de um Vault 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
Nome do HSM excluído. (--hsm-name e --name/-n são mutuamente exclusivos, especifique apenas um deles).
Localização do Vault ou HSM excluído.
Nome do cofre excluído.
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 update
Atualize as propriedades de um Vault.
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 Vault. (gerado automaticamente)
az keyvault update --enabled-for-disk-encryption true --name MyKeyVault --resource-group MyResourceGroup
Parâmetros Exigidos
Nome do cofre.
Parâmetros Opcionais
Adicione um objeto a uma lista de objetos especificando um caminho e pares de valores de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>
.
Ignorar o tráfego para usos separados por espaço.
Ação padrão a ser aplicada quando nenhuma regra corresponder.
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 Cofre de Chaves/HSM Gerenciado pode iniciar uma exclusão dura e irrecuperável. A configuração só será efetiva se a exclusão flexível também estiver habilitada. Habilitar essa funcionalidade é irreversível.
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 Gerenciador de Recursos do Azure será ignorada. Se nulo ou não especificado, o cofre será criado com o valor padrão false. Observe que as ações de gerenciamento são sempre autorizadas com a RBAC.
[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.
[Somente cofre] Propriedade para especificar se a Criptografia de Disco do Azure tem permissão para recuperar segredos do cofre e desencapsular chaves.
[Somente cofre] Propriedade para especificar se o Gerenciador de Recursos do Azure tem permissão para recuperar segredos do cofre de chaves.
Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter para JSON.
Não aguarde a conclusão da operação de execução longa.
Controle a permissão para o tráfego do plano de dados proveniente de redes públicas enquanto o ponto de extremidade privado estiver habilitado.
Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove>
OU --remove propertyToRemove
.
Prossiga somente se o Cofre de Chaves pertencer ao grupo de recursos especificado.
Dias de retenção de dados de exclusão suave. Aceita >=7 e <=90.
Atualize um objeto especificando um caminho de propriedade e um valor a serem definidos. Exemplo: --set property1.property2=<value>
.
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 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
Nome do HSM.
Parâmetros Opcionais
Adicione um objeto a uma lista de objetos especificando um caminho e pares de valores de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>
.
Ignorar o tráfego para usos separados por espaço.
Ação padrão a ser aplicada quando nenhuma regra corresponder.
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 Cofre de Chaves/HSM Gerenciado pode iniciar uma exclusão dura e irrecuperável. A configuração só será efetiva se a exclusão flexível também estiver habilitada. Habilitar essa funcionalidade é irreversível.
Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter para JSON.
Habilite identidades gerenciadas atribuídas pelo usuário para o HSM gerenciado. Aceite a lista separada por espaço de IDs de recursos de identidade.
Não aguarde a conclusão da operação de execução longa.
Controle a permissão para o tráfego do plano de dados proveniente de redes públicas enquanto o ponto de extremidade privado estiver habilitado.
Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove>
OU --remove propertyToRemove
.
Prossiga somente se o Cofre de Chaves pertencer ao grupo de recursos especificado.
--secondary-locations estende/contrata um pool de HSM para regiões listadas. O local primário onde o recurso foi originalmente criado NÃO pode ser removido.
Atualize um objeto especificando um caminho de propriedade e um valor a serem definidos. Exemplo: --set property1.property2=<value>
.
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 wait
Coloque a CLI em um estado de espera até que uma condição do Vault 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
Nome do cofre.
Parâmetros Opcionais
Aguarde até criar com 'provisioningState' em 'Succeeded'.
Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Aguarde até ser excluído.
Aguarde até que o recurso exista.
Intervalo de sondagem em segundos.
Prossiga somente se o Cofre de Chaves pertencer ao grupo de recursos especificado.
Espera máxima em segundos.
Aguarde até que seja atualizado com provisioningState em 'Succeeded'.
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 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
Nome do HSM.
Parâmetros Opcionais
Aguarde até criar com 'provisioningState' em 'Succeeded'.
Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Aguarde até ser excluído.
Aguarde até que o recurso exista.
Intervalo de sondagem em segundos.
Prossiga somente se o HSM pertencer ao grupo de recursos especificado.
Espera máxima em segundos.
Aguarde até que seja atualizado com provisioningState em 'Succeeded'.
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.
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de