az keyvault

Referência

Gerencie chaves, segredos e certificados do KeyVault.

Comandos

Name	Description	Tipo	Estado
az keyvault backup	Gerencie o backup completo do HSM.	Principal	GA
az keyvault backup start	Inicie um backup completo do HSM.	Principal	GA
az keyvault certificate	Gerenciar certificados.	Principal	GA
az keyvault certificate backup	Faz backup do certificado especificado.	Principal	GA
az keyvault certificate contact	Gerencie contatos para gerenciamento de certificados.	Principal	GA
az keyvault certificate contact add	Adicione um contato ao cofre especificado para receber notificações de operações de certificado.	Principal	GA
az keyvault certificate contact delete	Remova um contato de certificado do cofre especificado.	Principal	GA
az keyvault certificate contact list	Lista os contatos de certificado para um cofre de chaves especificado.	Principal	GA
az keyvault certificate create	Crie um certificado do Cofre da Chave.	Principal	GA
az keyvault certificate delete	Exclui um certificado de um cofre de chaves especificado.	Principal	Preterido
az keyvault certificate download	Transfira a parte pública de um certificado do Cofre da Chave.	Principal	GA
az keyvault certificate get-default-policy	Obtenha a política padrão para certificados autoassinados.	Principal	GA
az keyvault certificate import	Importe um certificado para o KeyVault.	Principal	GA
az keyvault certificate issuer	Gerencie as informações do emissor do certificado.	Principal	GA
az keyvault certificate issuer admin	Gerencie informações de administrador para emissores de certificados.	Principal	GA
az keyvault certificate issuer admin add	Adicione detalhes de administrador para um emissor de certificado especificado.	Principal	GA
az keyvault certificate issuer admin delete	Remova os detalhes de administrador do emissor de certificado especificado.	Principal	GA
az keyvault certificate issuer admin list	Listar administradores para um emissor de certificado especificado.	Principal	GA
az keyvault certificate issuer create	Crie um registro de emissor de certificado.	Principal	GA
az keyvault certificate issuer delete	Exclui o emissor de certificado especificado.	Principal	GA
az keyvault certificate issuer list	Lista as propriedades dos emissores de certificados para o cofre de chaves.	Principal	GA
az keyvault certificate issuer show	Obtém o emissor de certificado especificado.	Principal	GA
az keyvault certificate issuer update	Atualize um registro de emissor de certificado.	Principal	GA
az keyvault certificate list	Listar certificados em um cofre de chaves especificado.	Principal	GA
az keyvault certificate list-deleted	Lista os certificados excluídos atualmente recuperáveis.	Principal	GA
az keyvault certificate list-versions	Liste as versões de um certificado.	Principal	GA
az keyvault certificate pending	Gerencie operações pendentes de criação de certificados.	Principal	GA
az keyvault certificate pending delete	Exclui a operação de criação de um certificado específico.	Principal	GA
az keyvault certificate pending merge	Mescla um certificado ou uma cadeia de certificados com um par de chaves existente no servidor.	Principal	GA
az keyvault certificate pending show	Obtém a operação de criação de um certificado.	Principal	GA
az keyvault certificate purge	Exclui permanentemente o certificado excluído especificado.	Principal	GA
az keyvault certificate recover	Recupere um certificado excluído para sua versão mais recente.	Principal	GA
az keyvault certificate restore	Restaura um certificado de backup em um cofre.	Principal	GA
az keyvault certificate set-attributes	Atualiza os atributos especificados associados ao certificado fornecido.	Principal	GA
az keyvault certificate show	Obtém informações sobre um certificado.	Principal	GA
az keyvault certificate show-deleted	Obtenha um certificado excluído.	Principal	GA
az keyvault check-name	Verifique se o nome é válido e ainda não está em uso.	Principal	GA
az keyvault create	Crie um Vault ou HSM.	Principal	GA
az keyvault delete	Exclua um cofre ou HSM.	Principal	GA
az keyvault delete-policy	Exclua as configurações de política de segurança de um Cofre de Chaves.	Principal	GA
az keyvault key	Gerir chaves.	Principal	GA
az keyvault key backup	Solicite que um backup da chave especificada seja baixado para o cliente.	Principal	GA
az keyvault key create	Crie uma nova chave, armazene-a e, em seguida, devolve parâmetros e atributos chave ao cliente.	Principal	GA
az keyvault key decrypt	Desencriptar um único bloco de dados encriptados.	Principal	Pré-visualizar
az keyvault key delete	Exclua uma chave de qualquer tipo do armazenamento no Vault ou HSM.	Principal	GA
az keyvault key download	Transfira a parte pública de uma chave armazenada.	Principal	GA
az keyvault key encrypt	Criptografe uma sequência arbitrária de bytes usando uma chave de criptografia armazenada em um Vault ou HSM.	Principal	Pré-visualizar
az keyvault key get-policy-template	Modelo de política de retorno como definição de política codificada JSON.	Principal	Pré-visualizar
az keyvault key import	Importe uma chave privada.	Principal	GA
az keyvault key list	Liste chaves no Vault ou HSM especificado.	Principal	GA
az keyvault key list-deleted	Liste as chaves excluídas no Vault ou HSM especificado.	Principal	GA
az keyvault key list-versions	Liste os identificadores e as propriedades das versões de uma chave.	Principal	GA
az keyvault key purge	Exclua permanentemente a chave especificada.	Principal	GA
az keyvault key random	Obtenha o número solicitado de bytes aleatórios de um HSM gerenciado.	Principal	GA
az keyvault key recover	Recupere a chave excluída para sua versão mais recente.	Principal	GA
az keyvault key restore	Restaure uma chave de backup para um Vault ou HSM.	Principal	GA
az keyvault key rotate	Gire a chave com base na política de chave gerando uma nova versão da chave.	Principal	GA
az keyvault key rotation-policy	Gerencie a política de rotação de chaves.	Principal	GA
az keyvault key rotation-policy show	Obtenha a política de rotação de uma chave do Cofre da Chave.	Principal	GA
az keyvault key rotation-policy update	Atualize a política de rotação de uma chave do Cofre da Chave.	Principal	GA
az keyvault key set-attributes	A operação de chave de atualização 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.	Principal	GA
az keyvault key show	Obtenha os atributos de uma chave e, se for uma chave assimétrica, o seu material público.	Principal	GA
az keyvault key show-deleted	Obtenha a parte pública de uma chave excluída.	Principal	GA
az keyvault key sign	Crie uma assinatura a partir de um resumo usando uma chave armazenada em um Vault ou HSM.	Principal	GA
az keyvault key verify	Verifique uma assinatura usando a chave armazenada em um Vault ou HSM.	Principal	GA
az keyvault list	Listar cofres e/ou HSMs.	Principal	GA
az keyvault list-deleted	Obtenha informações sobre os Cofres ou HSMs excluídos em uma assinatura.	Principal	GA
az keyvault network-rule	Gerencie ACLs de rede do vault.	Principal	GA
az keyvault network-rule add	Adicione uma regra de rede às ACLs de rede para um Cofre de Chaves.	Principal	GA
az keyvault network-rule list	Liste as regras de rede das ACLs de rede para um Cofre de Chaves.	Principal	GA
az keyvault network-rule remove	Remova uma regra de rede das ACLs de rede para um Cofre de Chaves.	Principal	GA
az keyvault network-rule wait	Coloque a CLI em um estado de espera até que uma condição do cofre seja atendida.	Principal	GA
az keyvault private-endpoint-connection	Gerencie conexões de ponto de extremidade privado do vault/HSM.	Principal	GA
az keyvault private-endpoint-connection approve	Aprove uma solicitação de conexão de ponto de extremidade privado para um Cofre de Chaves/HSM.	Principal	GA
az keyvault private-endpoint-connection delete	Exclua a conexão de ponto de extremidade privado especificada associada a um Cofre de Chaves/HSM.	Principal	GA
az keyvault private-endpoint-connection list	Liste todas as conexões de ponto de extremidade privadas associadas a um HSM.	Principal	GA
az keyvault private-endpoint-connection reject	Rejeitar uma solicitação de conexão de ponto de extremidade privado para um Cofre de Chaves/HSM.	Principal	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.	Principal	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.	Principal	GA
az keyvault private-link-resource	Gerencie recursos de link privado do vault/HSM.	Principal	GA
az keyvault private-link-resource list	Liste os recursos de link privado suportados para um Cofre de Chaves/HSM.	Principal	GA
az keyvault purge	Exclua permanentemente o Vault ou HSM especificado. Aka Limpa o Vault ou HSM excluído.	Principal	GA
az keyvault recover	Recupere um cofre ou HSM.	Principal	GA
az keyvault region	Gerencie várias regiões do MHSM.	Principal	GA
az keyvault region add	Adicione regiões para o Pool de HSM gerenciado.	Principal	GA
az keyvault region list	Obtenha informações de regiões associadas ao Pool de HSM gerenciado.	Principal	GA
az keyvault region remove	Remova as regiões do Pool de HSM gerenciado.	Principal	GA
az keyvault region wait	Coloque a CLI em um estado de espera até que uma condição do HSM seja atendida.	Principal	GA
az keyvault restore	Gerencie a restauração completa do HSM.	Principal	GA
az keyvault restore start	Restaure um backup completo de um HSM.	Principal	GA
az keyvault role	Gerencie funções de usuário para controle de acesso.	Principal	GA
az keyvault role assignment	Gerencie atribuições de funções.	Principal	GA
az keyvault role assignment create	Crie uma nova atribuição de função para um utilizador, grupo ou principal de serviço.	Principal	GA
az keyvault role assignment delete	Excluir uma atribuição de função.	Principal	GA
az keyvault role assignment list	Listar atribuições de função.	Principal	GA
az keyvault role definition	Gerencie definições de função.	Principal	GA
az keyvault role definition create	Crie uma definição de função personalizada.	Principal	GA
az keyvault role definition delete	Excluir uma definição de função.	Principal	GA
az keyvault role definition list	Listar definições de função.	Principal	GA
az keyvault role definition show	Mostrar os detalhes de uma definição de função.	Principal	GA
az keyvault role definition update	Atualizar uma definição de função.	Principal	GA
az keyvault secret	Gerencie segredos.	Principal	GA
az keyvault secret backup	Faz backup do segredo especificado.	Principal	GA
az keyvault secret delete	Exclua todas as versões de um segredo.	Principal	Preterido
az keyvault secret download	Faça o download de um segredo de um KeyVault.	Principal	GA
az keyvault secret list	Listar segredos em um cofre de chaves especificado.	Principal	GA
az keyvault secret list-deleted	Lista segredos excluídos para o cofre especificado.	Principal	GA
az keyvault secret list-versions	Liste todas as versões do segredo especificado.	Principal	GA
az keyvault secret purge	Exclui permanentemente o segredo especificado.	Principal	GA
az keyvault secret recover	Recupera o segredo excluído para a versão mais recente.	Principal	GA
az keyvault secret restore	Restaura um segredo de backup em um cofre.	Principal	GA
az keyvault secret set	Crie um segredo (se não existir) ou atualize um segredo em um KeyVault.	Principal	GA
az keyvault secret set-attributes	Atualiza os atributos associados a um segredo especificado em um determinado cofre de chaves.	Principal	GA
az keyvault secret show	Obtenha um segredo especificado de um determinado cofre de chaves.	Principal	GA
az keyvault secret show-deleted	Obtém o segredo excluído especificado.	Principal	GA
az keyvault security-domain	Gerencie operações de domínio de segurança.	Principal	GA
az keyvault security-domain download	Baixe o arquivo de domínio de segurança do HSM.	Principal	GA
az keyvault security-domain init-recovery	Recupere a chave de troca do HSM.	Principal	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 carregamento de domínio de segurança.	Principal	GA
az keyvault security-domain upload	Comece a restaurar o HSM.	Principal	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.	Principal	GA
az keyvault set-policy	Atualize as configurações de política de segurança de um Cofre de Chaves.	Principal	GA
az keyvault setting	Gerencie as configurações de MHSM.	Principal	GA
az keyvault setting list	Obtenha todas as configurações associadas ao HSM gerenciado.	Principal	GA
az keyvault setting show	Obtenha uma configuração específica associada ao HSM gerenciado.	Principal	GA
az keyvault setting update	Atualize a configuração específica associada ao HSM gerenciado.	Principal	GA
az keyvault show	Mostrar detalhes de um Vault ou HSM.	Principal	GA
az keyvault show-deleted	Mostrar detalhes de um Vault ou HSM excluído.	Principal	GA
az keyvault update	Atualize as propriedades de um Vault.	Principal	GA
az keyvault update-hsm	Atualize as propriedades de um HSM.	Principal	GA
az keyvault wait	Coloque a CLI em um estado de espera até que uma condição do Vault seja atendida.	Principal	GA
az keyvault wait-hsm	Coloque a CLI em um estado de espera até que uma condição do HSM seja atendida.	Principal	GA

az keyvault check-name

Editar

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

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

Parâmetros Obrigatórios

--name -n

O nome do HSM dentro do grupo de recursos especificado.

Parâmetros Opcionais

--resource-type

Tipo de recurso.

valores aceites: hsm

valor predefinido: hsm

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault create

Editar

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 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, as regras redundantes serão removidas, finalmente haverá 4 regras IP e 3 regras 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

Criar um cofre de chaves. (gerado automaticamente)

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

Parâmetros Obrigatórios

--resource-group -g

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

Parâmetros Opcionais

--administrators

[Apenas 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

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

valores aceites: AzureServices, None

--default-action

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

valores aceites: Allow, Deny

--enable-purge-protection

Propriedade especificando se a proteção contra limpeza está habilitada para este pool de HSM gerenciado/vault. Definir essa propriedade como true ativa a proteção contra limpeza para este pool de HSM gerenciado/vault e seu conteúdo - somente o serviço Key Vault/Managed HSM pode iniciar uma exclusão difícil e irrecuperável. A configuração só será efetiva se a exclusão suave também estiver habilitada. Ativar esta funcionalidade é irreversível.

valores aceites: 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 nulo ou não especificado, o cofre é criado com o valor padrão de false. Note que as ações de gestão são sempre autorizadas com o RBAC.

valores aceites: false, true

--enabled-for-deployment

[Apenas 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.

valores aceites: false, true

--enabled-for-disk-encryption

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

valores aceites: false, true

--enabled-for-template-deployment

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

valores aceites: false, true

--hsm-name

Nome do HSM. (--hsm-name e --name/-n excluem-se mutuamente, especifique apenas um deles).

--location -l

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

--mi-user-assigned

[Apenas HSM] Habilite identidades gerenciadas atribuídas pelo usuário para HSM gerenciado. Aceite uma lista separada por espaços 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>...]}.

--network-acls-ips

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

--network-acls-vnets

Regras de rede ACLS VNet. Lista separada por espaço de pares Vnet/sub-rede ou ids de recursos de sub-rede.

--no-self-perms

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

valores aceites: false, true

--no-wait

Não espere que a operação de longa duração termine.

valor predefinido: 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 estiver habilitado.

valores aceites: Disabled, Enabled

--retention-days

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 de MHSM.

--sku

Obrigatório. Detalhes do 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

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

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault delete

Editar

Exclua um cofre ou HSM.

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

Exemplos

Exclua um cofre de chaves. (gerado automaticamente)

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

Parâmetros Opcionais

--hsm-name

Nome do HSM. (--hsm-name e --name/-n excluem-se mutuamente, especifique apenas um deles).

--name -n

Nome do cofre.

--no-wait

Não espere que a operação de longa duração termine.

valor predefinido: False

--resource-group -g

Prossiga somente se o Cofre da Chave pertencer ao grupo de recursos especificado.

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault delete-policy

Editar

Exclua as configurações de política 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 Obrigatórios

--name -n

Nome do cofre.

Parâmetros Opcionais

--application-id

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

--no-wait

Não espere que a operação de longa duração termine.

valor predefinido: False

--object-id

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

--resource-group -g

Prossiga somente se o Cofre da Chave pertencer ao grupo de recursos especificado.

--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 de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault list

Editar

Listar cofres e/ou HSMs.

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

Parâmetros Opcionais

--resource-group -g

o 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 Vaults e HSMs. Os valores possíveis para --resource-type são vault e hsm.

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault list-deleted

Editar

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

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

Parâmetros Opcionais

--resource-type

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 de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault purge

Editar

Exclua permanentemente o Vault ou HSM especificado. Aka Limpa o Vault ou HSM excluído.

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

Parâmetros Opcionais

--hsm-name

Nome do HSM excluído. (--hsm-name e --name/-n excluem-se mutuamente, especifique apenas um deles).

--location -l

Localização do Cofre ou HSM excluído.

--name -n

Nome do cofre excluído.

--no-wait

Não espere que a operação de longa duração termine.

valor predefinido: False

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault recover

Editar

Recupere um cofre ou HSM.

Recupere um Vault ou HSM excluído anteriormente para o qual a exclusão suave foi habilitada.

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

Exemplos

Recupere um cofre de chaves. (gerado automaticamente)

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

Parâmetros Opcionais

--hsm-name

Nome do HSM excluído. (--hsm-name e --name/-n excluem-se mutuamente, especifique apenas um deles).

--location -l

Localização do Cofre ou HSM excluído.

--name -n

Nome do cofre excluído.

--no-wait

Não espere que a operação de longa duração termine.

valor predefinido: False

--resource-group -g

Grupo de recursos do Vault ou HSM excluído.

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault set-policy

Editar

Atualize as configurações de política de segurança de 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 um 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 Obrigatórios

--name -n

Nome do cofre.

Parâmetros Opcionais

--application-id

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

--certificate-permissions

Lista separada por espaço de permissões de certificado a atribuir.

valores aceites: 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 atribuir.

valores aceites: 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 espere que a operação de longa duração termine.

valor predefinido: False

--object-id

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

--resource-group -g

Prossiga somente se o Cofre da Chave pertencer ao grupo de recursos especificado.

--secret-permissions

Lista separada por espaço de permissões secretas a atribuir.

valores aceites: 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 atribuir.

valores aceites: 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 de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault show

Editar

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

--hsm-name

Nome do HSM. (--hsm-name e --name/-n excluem-se mutuamente, especifique apenas um deles).

--name -n

Nome do cofre.

--resource-group -g

Prossiga somente se o Cofre da Chave pertencer ao grupo de recursos especificado.

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault show-deleted

Editar

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

--hsm-name

Nome do HSM excluído. (--hsm-name e --name/-n excluem-se mutuamente, especifique apenas um deles).

--location -l

Localização do Cofre ou HSM excluído.

--name -n

Nome do cofre excluído.

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault update

Editar

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

--name -n

Nome do cofre.

Parâmetros Opcionais

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

valor predefinido: []

--bypass

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

valores aceites: AzureServices, None

--default-action

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

valores aceites: Allow, Deny

--enable-purge-protection

valores aceites: false, true

--enable-rbac-authorization

valores aceites: false, true

--enabled-for-deployment

[Apenas 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.

valores aceites: false, true

--enabled-for-disk-encryption

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

valores aceites: false, true

--enabled-for-template-deployment

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

valores aceites: false, true

--force-string

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

valor predefinido: False

--no-wait

Não espere que a operação de longa duração termine.

valor predefinido: 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 estiver habilitado.

valores aceites: Disabled, Enabled

--remove

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

valor predefinido: []

--resource-group -g

Prossiga somente se o Cofre da Chave pertencer ao grupo de recursos especificado.

--retention-days

Dias de retenção de dados de exclusão suave. Aceita >=7 e <=90.

--set

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

valor predefinido: []

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault update-hsm

Editar

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

--hsm-name

Nome do HSM.

Parâmetros Opcionais

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

valor predefinido: []

--bypass

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

valores aceites: AzureServices, None

--default-action

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

valores aceites: Allow, Deny

--enable-purge-protection -e

valores aceites: false, true

--force-string

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

valor predefinido: False

--mi-user-assigned

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

--no-wait

Não espere que a operação de longa duração termine.

valor predefinido: 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 estiver habilitado.

valores aceites: Disabled, Enabled

--remove

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

valor predefinido: []

--resource-group -g

Prossiga somente se o Cofre da Chave pertencer ao grupo de recursos especificado.

--secondary-locations

--secondary-locations estende/contrata 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>.

valor predefinido: []

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault wait

Editar

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

--name -n

Nome do cofre.

Parâmetros Opcionais

--created

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

valor predefinido: False

--custom

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

--deleted

Aguarde até ser excluído.

valor predefinido: False

--exists

Aguarde até que o recurso exista.

valor predefinido: False

--interval

Intervalo de sondagem em segundos.

valor predefinido: 30

--resource-group -g

Prossiga somente se o Cofre da Chave pertencer ao grupo de recursos especificado.

--timeout

Espera máxima em segundos.

valor predefinido: 3600

--updated

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

valor predefinido: False

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault wait-hsm

Editar

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

--hsm-name

Nome do HSM.

Parâmetros Opcionais

--created

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

valor predefinido: False

--custom

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

--deleted

Aguarde até ser excluído.

valor predefinido: False

--exists

Aguarde até que o recurso exista.

valor predefinido: False

--interval

Intervalo de sondagem em segundos.

valor predefinido: 30

--resource-group -g

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

--timeout

Espera máxima em segundos.

valor predefinido: 3600

--updated

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

valor predefinido: False

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az keyvault

Comandos

az keyvault check-name

Parâmetros Obrigatórios

Parâmetros Opcionais

az keyvault create

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az keyvault delete

Exemplos

Parâmetros Opcionais

az keyvault delete-policy

Parâmetros Obrigatórios

Parâmetros Opcionais

az keyvault list

Parâmetros Opcionais

az keyvault list-deleted

Parâmetros Opcionais

az keyvault purge

Parâmetros Opcionais

az keyvault recover

Exemplos

Parâmetros Opcionais

az keyvault set-policy

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az keyvault show

Exemplos

Parâmetros Opcionais

az keyvault show-deleted

Exemplos

Parâmetros Opcionais

az keyvault update

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az keyvault update-hsm

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az keyvault wait

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az keyvault wait-hsm

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

Comentários

Recursos adicionais