Referência da API REST do Azure Key Vault

  • Artigo

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

Operações do cofre de chaves

Operação Descrição
Verificar disponibilidade do 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.
Get 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.
Atualizar Atualize um cofre de chaves na assinatura especificada.
Excluir Exclui o cofre de chaves do Azure especificado.
Obter 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.
Limpar Exclui permanentemente o cofre especificado.
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
Get 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.
Colocar Atualizações 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.
Get 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.
Atualizar Atualize um pool de HSM gerenciado na assinatura especificada.
Obter 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.
Limpeza excluída Exclui permanentemente o HSM gerenciado especificado.
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
Get 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.
Colocar Atualizações 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 de domínio de segurança do HSM

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

Operações de configurações de HSM gerenciadas

Operação Descrição
Obter 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 definidas.
Configuração de Atualização Atualizações 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
Get Obtenha a atribuição de função especificada.
Lista Obtém atribuições de função para um escopo.
Criar 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
Get 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
Backup completo Cria um backup completo usando um token SAS fornecido pelo usuário para um contêiner de armazenamento de blobs do Azure. Essa operação tem suporte apenas pelo serviço HSM gerenciado.
Backup Status Retorna o status da operação de backup completa.
Restauração completa Restaura todos os principais materiais usando o token SAS apontando para uma pasta de backup do Armazenamento de Blobs do Azure armazenada anteriormente.
Restauração seletiva Restaura todas as principais versões 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.
Status da restauração Retorna o status da operação de restauração.

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

Operação Descrição
Obter Chave Obtém a parte pública de uma chave armazenada.
Obter chaves Listar chaves no cofre especificado.
Obter versões de chave Recupera uma lista de versões de chave individuais com o mesmo nome de chave.
Criar Chave Cria uma nova chave, armazena-a, retorna os parâmetros e atributos de chave para o cliente.
Importar Chave Importa uma chave criada externamente, armazena-a e retorna os parâmetros de chaves e atributos para o cliente.
Atualizar Chave A operação de atualização de chave 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 Chave Exclui uma chave de qualquer tipo de armazenamento no Key Vault do Azure.
Obter 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 chave excluída Exclui permanentemente a chave especificada.
Recuperar 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 chave Restaura uma chave de backup em um cofre.
Chave de liberação Libera uma chave. A operação de chave de liberaçã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 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 a Política de Rotação de Chaves Lista a política de uma chave. A operação GetKeyRotationPolicy retorna os recursos de política de chave especificados no cofre de chaves especificado. Essa operação requer as chaves/obter permissão.
Atualizar a Política de Rotação de Chaves Atualizações 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 atualização/chaves.

Operações de 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
Descriptografar 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.
Quebra de tecla Encapsula uma chave simétrica usando uma chave especificada.
Desembrulhar chave 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 Segredo 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 Segredo Define um segredo em um cofre de chaves especificado.
Atualizar segredo Atualizações os atributos associados a um segredo especificado em um determinado cofre de chaves.
Excluir Segredo Exclui um segredo de um cofre de chaves especificado.
Obter segredo excluído Obtém o segredo excluído especificado.
Obter segredos excluídos Lista os segredos excluídos para o cofre especificado.
Limpar segredo excluído Exclui permanentemente o segredo especificado.
Recuperar segredo excluído Recupera o segredo excluído para a versão mais recente.
Segredo de Backup Faz backup do segredo especificado.
Restaurar Segredo Restaura um segredo de backup em um cofre.

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

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

Operação Descrição
Obter 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ções os atributos especificados associados à conta de armazenamento fornecida. Essa operação requer a permissão de armazenamento/conjunto/atualização.
Definir 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 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 conta de armazenamento excluída Exclui permanentemente a conta de armazenamento especificada.
Recuperar 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 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 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 sas da conta de armazenamento

Operação Descrição
Obter Definição de Sas Obtém informações sobre uma definição de SAS para a conta de armazenamento especificada. Essa operação requer a permissão storage/getsas.
Obter definições de Sas Listar definições de SAS de armazenamento para a conta de armazenamento fornecida. Essa operação requer a permissão storage/listsas.
Definir Definição de Sas Cria ou atualiza uma nova definição de SAS para a conta de armazenamento especificada. Esta operação requer a permissão de armazenamento/setsas.
Atualizar Definição de Sas Atualizações os atributos especificados associados à definição de SAS fornecida. Esta operação requer a permissão de armazenamento/setsas.
Excluir Definição de Sas Exclui uma definição de SAS de uma conta de armazenamento especificada. Essa operação requer a permissão storage/deletesas.
Obter definição de 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 definição de Sas excluída Recupera a definição de SAS excluída.

Operações de certificado (somente Key Vault)

Operação Descrição
Obter 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 Certificado Cria um certificado.
Importar Certificado Importa um certificado para um cofre de chaves especificado.
Mesclar Certificado Mescla um certificado ou uma cadeia de certificados com um par de chaves existente no servidor.
Obter operação de certificado Obtém a operação de criação de um certificado.
Atualizar operação de certificado Atualizações uma operação de certificado.
Excluir operação de certificado Exclui a operação de criação de um certificado específico.
Atualizar Certificado Atualiza os atributos especificados associados ao certificado determinado.
Excluir 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 certificado excluído Exclui permanentemente o certificado excluído especificado.
Recuperar certificado excluído Recupera o certificado excluído de volta para sua versão atual em /certificates.
Certificado de Backup Faz backup do certificado especificado.
Restaurar Certificado Restaura um certificado de backup em um cofre.

Operações de política de certificado

Operação Descrição
Obter Política de Certificado Lista a política de um certificado.
Atualizar Política de Certificado Atualizações 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 emissor de certificado Lista o emissor do certificado especificado.
Obter emissores de certificado Listar emissores de certificado para um cofre de chaves especificado.
Definir emissor de certificado Define o emissor do certificado especificado.
Atualizar emissor de certificado Atualizações o emissor do certificado especificado.
Excluir Emissor de Certificado Exclui o emissor do certificado especificado.

Confira também