Referência da API REST do Azure Key Vault

Use o Key Vault para proteger e gerenciar chaves criptográficas, certificados e segredos usados por aplicativos e serviços de nuvem.

Operações do Key Vault

Operação	Descrição
verificar de disponibilidade de nome	Verifica se o nome do cofre é válido e ainda não está em uso.
Criar ou atualizar	Crie ou atualize um cofre de chaves na assinatura especificada.
Atualizar política de acesso	Atualize as políticas de acesso em um cofre de chaves na assinatura especificada.
Obter	Obtém o cofre de chaves do Azure especificado.
Lista	A operação Lista obtém informações sobre os cofres associados à assinatura.
Listar por Grupo de Recursos	A operação Lista obtém informações sobre os cofres associados à assinatura e dentro do grupo de recursos especificado.
Listar por Assinatura	A operação Lista obtém informações sobre os cofres associados à assinatura.
Atualização	Atualize um cofre de chaves na assinatura especificada.
excluir	Exclui o cofre de chaves do Azure especificado.
Ser excluído	Obtém o cofre de chaves do Azure excluído.
Lista excluída	Obtém informações sobre os cofres excluídos em uma assinatura.
Purgar	Exclui permanentemente o cofre especificado.

Operações de link privado

Operação	Descrição
Listar por cofre	Obtém os recursos de link privado com suporte para o cofre de chaves.

Operações de conexões de ponto de extremidade privado

Operação	Descrição
Obter	Obtém a conexão de ponto de extremidade privado especificada associada ao cofre de chaves.
Listar por recurso	A operação Lista obtém informações sobre as conexões de ponto de extremidade privado associadas ao cofre.
Pôr	Atualiza a conexão de ponto de extremidade privado especificada associada ao cofre de chaves.
excluir	Exclui a conexão de ponto de extremidade privado especificada associada ao cofre de chaves.

Operações de HSM gerenciadas

Operação	Descrição
Criar ou atualizar	Crie ou atualize um Pool de HSM gerenciado na assinatura especificada.
Obter	Obtém o pool de HSM gerenciado especificado.
Listar por Grupo de Recursos	A operação Lista obtém informações sobre os pools de HSM gerenciados associados à assinatura e dentro do grupo de recursos especificado.
Listar por Assinatura	A operação Lista obtém informações sobre os pools de HSM gerenciados associados à assinatura.
Atualização	Atualize um Pool de HSM gerenciado na assinatura especificada.
Ser excluído	Obtém o HSM gerenciado excluído especificado.
Lista excluída	A operação Lista obtém informações sobre os HSMs gerenciados excluídos associados à assinatura.
excluir	Exclui o pool de HSM gerenciado especificado.
Limpar excluído	Exclui permanentemente o HSM gerenciado especificado.

Operações de link privado

Operação	Descrição
Listar por recurso MHSM	Obtém os recursos de link privado com suporte para o pool de HSM gerenciado.

Operações de conexões de ponto de extremidade privado

Operação	Descrição
Obter	Obtém a conexão de ponto de extremidade privado especificada associada ao Pool de HSM gerenciado.
Listar por recurso	A operação Lista obtém informações sobre as conexões de ponto de extremidade privado associadas ao pool de HSM gerenciado.
Pôr	Atualiza a conexão de ponto de extremidade privado especificada associada ao pool de HSM gerenciado.
excluir	Exclui a conexão de ponto de extremidade privado especificada associada ao pool de HSM gerenciado.

Operações do Domínio de Segurança do HSM

Operação	Descrição
Baixar	Recupera o Domínio de Segurança do HSM gerenciado. Chamar esse ponto de extremidade pode ser usado para ativar um recurso HSM gerenciado provisionado.
Download pendente	Recupera o status da operação de download do Domínio de Segurança.
Carregar	Restaure o Domínio de Segurança fornecido.
Upload pendente	Obtenha o status da operação de upload do Domínio de Segurança.

Operações de configurações de HSM gerenciado

Operação	Descrição
obter de configuração	Obter o objeto de configuração de conta especificado. Recupera o objeto de configuração de um nome de configuração especificado.
obter configurações	Listar as configurações da conta. Recupera uma lista de todas as configurações de conta disponíveis que podem ser configuradas.
de Configuração de Atualização	Atualiza a configuração da conta do cofre de chaves, armazena-a e retorna o nome e o valor da configuração para o cliente. Descrição da configuração do pool a ser atualizada

Operações de controle de acesso baseadas em função

Operações de atribuição de função

Operação	Descrição
Obter	Obtenha a atribuição de função especificada.
Lista	Obtém atribuições de função para um escopo.
Create	Cria uma atribuição de função.
excluir	Exclui uma atribuição de função.

Operações de definição de função

Operação	Descrição
Obter	Obtenha a definição de função especificada.
Lista	Obtenha todas as definições de função aplicáveis no escopo e acima.
Criar ou atualizar	Cria ou atualiza uma definição de função personalizada.
excluir	Exclui uma definição de função personalizada.

Operações de backup/restauração

Operação	Descrição
de Backup Completo	Cria um backup completo usando um token SAS fornecido pelo usuário em um contêiner de armazenamento de blobs do Azure. Essa operação tem suporte apenas pelo serviço HSM Gerenciado.
de Status de Backup do	Retorna o status da operação de backup completo.
Restauração completa	Restaura todos os materiais de chave usando o token SAS apontando para uma pasta de backup do Armazenamento de Blobs do Azure armazenada anteriormente.
Restauração seletiva	Restaura todas as versões de chave de uma determinada chave usando o token SAS fornecido pelo usuário apontando para uma pasta de backup do Armazenamento de Blobs do Azure armazenada anteriormente.
de Status de Restauração	Retorna o status da operação de restauração.

Operações de chave (Key Vault/HSM gerenciado)

Operação	Descrição
obter de chave	Obtém a parte pública de uma chave armazenada.
obter chaves	Listar chaves no cofre especificado.
obter versões principais	Recupera uma lista de versões de chave individuais com o mesmo nome de chave.
criar de chave	Cria uma nova chave, armazena-a e, em seguida, retorna parâmetros de chave e atributos para o cliente.
importar de chave	Importa uma chave criada externamente, armazena-a e retorna parâmetros e atributos de chave para o cliente.
atualizar de chave	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 Azure Key Vault.
excluir de chave	Exclui uma chave de qualquer tipo do armazenamento no Azure Key Vault.
obter de chave excluída	Obtém a parte pública de uma chave excluída.
obter chaves excluídas	Lista as chaves excluídas no cofre especificado.
limpar de chave excluída	Exclui permanentemente a chave especificada.
recuperar de chave excluída	Recupera a chave excluída para sua versão mais recente.
chave de backup	Solicita que um backup da chave especificada seja baixado para o cliente.
restaurar de chave	Restaura uma chave de backup em um cofre.
Chave de liberação	Libera uma chave. A operação de chave de versão é aplicável a todos os tipos de chave. A chave de destino deve ser marcada como exportável. Essa operação requer a permissão de liberação/chaves.
girar de chave	Cria uma nova versão de chave, armazena-a e retorna parâmetros de chave, atributos e política para o cliente. A operação girará a chave com base na política de chave. Ele requer a permissão de rotação/teclas.
obter de política de rotação de chaves	Lista a política para uma chave. A operação GetKeyRotationPolicy retorna os recursos de política de chave especificados no cofre de chaves especificado. Essa operação requer a permissão de obtenção/chaves.
atualizar a política de rotação de chaves	Atualiza a política de rotação de uma chave. Defina os membros especificados na política de chave. Deixe os outros como indefinidos. Essa operação requer a permissão de chaves/atualização.

Operações-chave (somente HSM gerenciado)

Operação	Descrição
obter bytes aleatórios	Obtenha o número solicitado de bytes que contêm valores aleatórios de um HSM gerenciado.

Operações criptográficas (Key Vault/HSM Gerenciado)

Operação	Descrição
Desencriptar	Descriptografa um único bloco de dados criptografados.
Encrypt	Criptografa uma sequência arbitrária de bytes usando uma chave de criptografia armazenada em um cofre de chaves.
Chave de embrulho	Encapsula uma chave simétrica usando uma chave especificada.
Chave de desencapsulamento	Desembrulha uma chave simétrica usando a chave especificada que foi inicialmente usada para encapsular essa chave.
Assinar	Cria uma assinatura de um resumo usando a chave especificada.
Verificar	Verifica uma assinatura usando uma chave especificada.

Operações secretas (somente Key Vault)

Operação	Descrição
obter secreto	Obtenha um segredo especificado de um determinado cofre de chaves.
obter segredos	Listar segredos em um cofre de chaves especificado.
obter versões secretas	Liste todas as versões do segredo especificado.
definir de segredo	Define um segredo em um cofre de chaves especificado.
atualizar de segredo	Atualiza os atributos associados a um segredo especificado em um determinado cofre de chaves.
excluir de segredo	Exclui um segredo de um cofre de chaves especificado.
obter de segredo excluído	Obtém o segredo excluído especificado.
obter segredos excluídos	Lista segredos excluídos para o cofre especificado.
limpar de segredo excluído	Exclui permanentemente o segredo especificado.
recuperar de segredo excluído	Recupera o segredo excluído para a versão mais recente.
de Segredo de Backup	Faz backup do segredo especificado.
restaurar de segredo	Restaura um segredo de backup em um cofre.

Operações de gerenciamento de chaves da conta de armazenamento (somente Key Vault)

Operações de configuração da Conta de Armazenamento

Operação	Descrição
obter de conta de armazenamento	Obtém informações sobre uma conta de armazenamento especificada. Essa operação requer a permissão de armazenamento/obtenção.
obter contas de armazenamento	Listar contas de armazenamento gerenciadas pelo cofre de chaves especificado. Essa operação requer a permissão de armazenamento/lista.
Atualizar conta de armazenamento	Atualiza os atributos especificados associados à conta de armazenamento fornecida. Essa operação requer a permissão de armazenamento/conjunto/atualização.
definir de conta de armazenamento	Cria ou atualiza uma nova conta de armazenamento. Essa operação requer a permissão de armazenamento/conjunto.
Excluir conta de armazenamento	Exclui uma conta de armazenamento. Essa operação requer a permissão de armazenamento/exclusão.
obter de conta de armazenamento excluída	Obtém a conta de armazenamento excluída especificada.
obter contas de armazenamento excluídas	Lista contas de armazenamento excluídas para o cofre especificado.
limpar de conta de armazenamento excluída	Exclui permanentemente a conta de armazenamento especificada.
recuperar de conta de armazenamento excluída	Recupera a conta de armazenamento excluída.
conta de armazenamento de backup	Faz backup da conta de armazenamento especificada.
restaurar a conta de armazenamento	Restaura uma conta de armazenamento de backup em um cofre.

Operações de chave da Conta de Armazenamento

Operação	Descrição
Regenerar a chave da conta de armazenamento	Regenera o valor de chave especificado para a conta de armazenamento fornecida. Essa operação requer a permissão storage/regeneratekey.

Operações de SAS da Conta de Armazenamento

Operação	Descrição
obter de definição sas	Obtém informações sobre uma definição de SAS para a conta de armazenamento especificada. Essa operação requer a permissão de armazenamento/getsas.
obter definições sas	Listar definições de SAS de armazenamento para a conta de armazenamento fornecida. Essa operação requer a permissão de armazenamento/listas como.
definir de definição de Sas	Cria ou atualiza uma nova definição de SAS para a conta de armazenamento especificada. Essa operação requer a permissão de armazenamento/conjuntos.
atualizar de definição sas	Atualiza os atributos especificados associados à definição de SAS fornecida. Essa operação requer a permissão de armazenamento/conjuntos.
excluir de definição de Sas	Exclui uma definição de SAS de uma conta de armazenamento especificada. Essa operação requer a permissão de armazenamento/exclusões como.
obter de definição sas excluída	Obtém a definição sas excluída especificada.
obter definições sas excluídas	Lista as definições de SAS excluídas para o cofre e a conta de armazenamento especificadas.
recuperar de definição sas excluída	Recupera a definição de SAS excluída.

Operações de certificado (somente Key Vault)

Operação	Descrição
obter de certificado	Obtém informações sobre um certificado.
obter certificados	Listar certificados em um cofre de chaves especificado
obter versões de certificado	Listar as versões de um certificado.
criar de certificado	Cria um novo certificado.
importar de certificado	Importa um certificado para um cofre de chaves especificado.
de certificado de mesclagem	Mescla um certificado ou uma cadeia de certificados com um par de chaves existente no servidor.
obter de operação de certificado	Obtém a operação de criação de um certificado.
atualizar de operação de certificado	Atualiza uma operação de certificado.
excluir de operação de certificado	Exclui a operação de criação de um certificado específico.
atualizar de certificado	Atualiza os atributos especificados associados ao certificado determinado.
excluir de certificado	Exclui um certificado de um cofre de chaves especificado.
obter certificado excluído	Recupera informações sobre o certificado excluído especificado.
obter certificados excluídos	Lista os certificados excluídos no cofre especificado atualmente disponíveis para recuperação.
limpar de certificado excluído	Exclui permanentemente o certificado excluído especificado.
recuperar de certificado excluído	Recupera o certificado excluído de volta para sua versão atual em /certificates.
de Certificado de Backup do	Faz backup do certificado especificado.
de certificado de restauração	Restaura um certificado de backup para um cofre.

Operações de política de certificado

Operação	Descrição
obter de política de certificado	Lista a política de um certificado.
atualizar a política de certificado	Atualiza a política de um certificado.

Operações de contatos de certificado

Operação	Descrição
obter contatos de certificado	Lista os contatos de certificado para um cofre de chaves especificado.
definir contatos de certificado	Define os contatos de certificado para o cofre de chaves especificado.
excluir contatos de certificado	Exclui os contatos de certificado de um cofre de chaves especificado.

Operações do emissor do certificado

Operação	Descrição
obter do emissor do certificado	Lista o emissor do certificado especificado.
obter de emissores de certificado	Listar emissores de certificado para um cofre de chaves especificado.
definir do emissor do certificado	Define o emissor do certificado especificado.
atualizar o emissor do certificado	Atualiza o emissor do certificado especificado.
excluir do emissor do certificado	Exclui o emissor do certificado especificado.

Consulte também

• Para obter conceitos e informações detalhadas sobre o Key Vault, consulte Sobre o Azure Key Vault.
• Para obter conceitos e informações detalhadas sobre o HSM Gerenciado, consulte O que é o HSM Gerenciado do Azure Key Vault?
• Para obter conceitos e informações detalhadas sobre objetos do plano de dados, consulte Sobre chaves, segredos e certificados.
• Para obter informações gerais sobre como construir solicitações de API REST do Azure, consulte a referência da API REST do Azure
• Para obter informações específicas sobre a construção de solicitações da API REST do Key Vault, consulte
  • Parâmetros e cabeçalhos comuns de solicitação HTTP
  • Autenticação, solicitações e respostas
• Consulte os tópicos a seguir para obter conceitos e detalhes adicionais do Key Vault
  • Guia do Desenvolvedor do Cofre de Chaves
  • Versões do Key Vault