Referência da API REST do Azure Key Vault
Utilize Key Vault para salvaguardar e gerir chaves criptográficas, certificados e segredos utilizados por aplicações e serviços na cloud.
Operações do Cofre de Chaves
Operação | Description |
---|---|
Verificar a Disponibilidade do Nome | Verifica se o nome do cofre é válido e ainda não está a ser utilizado. |
Criar ou Atualizar | Criar ou atualizar um cofre de chaves na subscrição especificada. |
Atualizar Política de Acesso | Atualize as políticas de acesso num cofre de chaves na subscrição especificada. |
Get | Obtém o cofre de chaves do Azure especificado. |
Lista | A operação Lista obtém informações sobre os cofres associados à subscrição. |
Listar por Grupo de Recursos | A operação Lista obtém informações sobre os cofres associados à subscrição e no grupo de recursos especificado. |
Lista por Subscrição | A operação Lista obtém informações sobre os cofres associados à subscrição. |
Atualizar | Atualize um cofre de chaves na subscrição especificada. |
Eliminar | Elimina o cofre de chaves do Azure especificado. |
Ser Eliminado | Obtém o cofre de chaves do Azure eliminado. |
Lista Eliminada | Obtém informações sobre os cofres eliminados numa subscrição. |
Remover | Elimina permanentemente o cofre especificado. |
Operações de ligação privada
Operação | Description |
---|---|
Listar por Cofre | Obtém os recursos de ligação privada suportados para o cofre de chaves. |
Operações de ligações de ponto final privado
Operação | Description |
---|---|
Get | Obtém a ligação de ponto final privado especificada associada ao cofre de chaves. |
Listar por Recurso | A operação Lista obtém informações sobre as ligações de ponto final privado associadas ao cofre. |
Colocar | Atualizações a ligação de ponto final privado especificada associada ao cofre de chaves. |
Eliminar | Elimina a ligação de ponto final privado especificada associada ao cofre de chaves. |
Operações HSM geridas
Operação | Description |
---|---|
Criar ou Atualizar | Crie ou atualize um Conjunto de HSM gerido na subscrição especificada. |
Get | Obtém o Conjunto de HSM gerido especificado. |
Listar por Grupo de Recursos | A operação Lista obtém informações sobre os Conjuntos de HSM geridos associados à subscrição e no grupo de recursos especificado. |
Lista por Subscrição | A operação Lista obtém informações sobre os Conjuntos de HSM geridos associados à subscrição. |
Atualizar | Atualize um Conjunto de HSM gerido na subscrição especificada. |
Ser Eliminado | Obtém o HSM gerido eliminado especificado. |
Lista Eliminada | A operação Lista obtém informações sobre os HSMs geridos eliminados associados à subscrição. |
Eliminar | Elimina o Conjunto de HSM gerido especificado. |
Remover Eliminado | Elimina permanentemente o HSM gerido especificado. |
Operações de ligação privada
Operação | Description |
---|---|
Lista por recurso MHSM | Obtém os recursos de ligação privada suportados para o conjunto HSM gerido. |
Operações de ligações de ponto final privado
Operação | Description |
---|---|
Get | Obtém a ligação de ponto final privado especificada associada ao Conjunto de HSM gerido. |
Listar por Recurso | A operação Lista obtém informações sobre as ligações de ponto final privado associadas ao Conjunto de HSM gerido. |
Colocar | Atualizações a ligação de ponto final privado especificada associada ao Conjunto de HSM gerido. |
Eliminar | Elimina a ligação de ponto final privado especificada associada ao Conjunto de HSM gerido. |
Operações de Domínio de Segurança do HSM
Operação | Description |
---|---|
Transferência | Obtém o Domínio de Segurança do HSM gerido. Chamar este ponto final pode ser utilizado para ativar um recurso HSM gerido aprovisionado. |
Transferir Pendente | Obtém o estado da operação de transferência do Domínio de Segurança. |
Carregar | Restaure o Domínio de Segurança fornecido. |
Carregar Pendente | Obter o estado da operação de carregamento do Domínio de Segurança. |
Operações de Definições do HSM Gerido
Operação | Description |
---|---|
Obter Definição | Obter objeto de definição de conta especificado. Obtém o objeto de definição de um nome de definição especificado. |
Obter Definições | Listar definições de conta. Obtém uma lista de todas as definições de conta disponíveis que podem ser configuradas. |
Definição de Atualização | Atualizações definição da conta do cofre de chaves, armazena-a e, em seguida, devolve o nome e o valor da definição ao cliente. Descrição da definição do conjunto a atualizar |
Operações de controlo de acesso baseado em funções
Operações de atribuição de funções
Operação | Description |
---|---|
Get | Obtenha a atribuição de função especificada. |
Lista | Obtém atribuições de funções para um âmbito. |
Criar | Cria uma atribuição de função. |
Eliminar | Elimina uma atribuição de função. |
Operações de definição de função
Operação | Description |
---|---|
Get | Obtenha a definição de função especificada. |
Lista | Obtenha todas as definições de função aplicáveis no âmbito e acima. |
Criar ou Atualizar | Cria ou atualiza uma definição de função personalizada. |
Eliminar | Elimina uma definição de função personalizada. |
Operações de cópia de segurança/restauro
Operação | Description |
---|---|
Cópia de Segurança Completa | Cria uma cópia de segurança completa com um token de SAS fornecido pelo utilizador para um contentor de armazenamento de blobs do Azure. Esta operação é suportada apenas pelo serviço HSM Gerido. |
Estado da Cópia de Segurança | Devolve o estado da operação de cópia de segurança completa. |
Restauro Total | Restaura todos os materiais principais com o token de SAS que aponta para uma pasta de cópia de segurança do Armazenamento de Blobs do Azure armazenada anteriormente. |
Restauro Seletivo | Restaura todas as versões principais de uma determinada chave com o token SAS fornecido pelo utilizador que aponta para uma pasta de cópia de segurança do Armazenamento de Blobs do Azure armazenada anteriormente. |
Estado do Restauro | Devolve o estado da operação de restauro. |
Principais operações (Key Vault/HSM Gerido)
Operação | Description |
---|---|
Obter Chave | Obtém a parte pública de uma chave armazenada. |
Obter Chaves | Listar chaves no cofre especificado. |
Obter Versões chave | Obtém uma lista de versões de chaves individuais com o mesmo nome de chave. |
Criar Chave | Cria uma nova chave, armazena-a e, em seguida, devolve parâmetros-chave e atributos ao cliente. |
Importar Chave | Importa uma chave criada externamente, armazena-a e devolve parâmetros e atributos chave ao cliente. |
Atualizar Chave | A operação de atualização da 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. |
Eliminar Chave | Elimina uma chave de qualquer tipo do armazenamento no Azure Key Vault. |
Obter Chave Eliminada | Obtém a parte pública de uma chave eliminada. |
Obter Chaves Eliminadas | Lista as chaves eliminadas no cofre especificado. |
Remover Chave Eliminada | Elimina permanentemente a chave especificada. |
Recuperar Chave Eliminada | Recupera a chave eliminada para a versão mais recente. |
Chave de Cópia de Segurança | Pede que seja transferida uma cópia de segurança da chave especificada para o cliente. |
Restaurar Chave | Restaura uma chave de cópia de segurança para um cofre. |
Chave de Versão | Liberta uma chave. A operação da chave de lançamento é aplicável a todos os tipos de chaves. A chave de destino tem de ser marcada como exportável. Esta operação requer a permissão de chaves/versão. |
Rodar Chave | Cria uma nova versão de chave, armazena-a e, em seguida, devolve parâmetros chave, atributos e política ao cliente. A operação irá rodar a chave com base na política de chave. Requer as chaves/permissões de rotação. |
Obter Política de Rotação de Chaves | Lista a política de uma chave. A operação GetKeyRotationPolicy devolve os recursos de política de chave especificados no cofre de chaves especificado. Esta operação requer as chaves/obter permissão. |
Atualizar Política de Rotação de Chaves | Atualizações a política de rotação de uma chave. Defina membros especificados na política de chave. Deixe as outras pessoas como indefinidas. Esta operação requer as chaves/permissão de atualização. |
Principais operações (apenas HSM gerido)
Operação | Description |
---|---|
Obter Bytes Aleatórios | Obtenha o número pedido de bytes que contêm valores aleatórios de um HSM gerido. |
Operações criptográficas (Key Vault/HSM Gerido)
Operação | Description |
---|---|
Desencriptar | Desencripta um único bloco de dados encriptados. |
Encriptar | Encripta uma sequência arbitrária de bytes com uma chave de encriptação armazenada num cofre de chaves. |
Moldar Tecla | Molda uma chave simétrica com uma chave especificada. |
Desembrulhar Chave | Desembrulha uma chave simétrica com a chave especificada que foi inicialmente utilizada para encapsular essa chave. |
Assinar | Cria uma assinatura a partir de um resumo com a chave especificada. |
Verificar | Verifica uma assinatura com uma chave especificada. |
Operações secretas (apenas Key Vault)
Operação | Description |
---|---|
Obter Segredo | Obtenha um segredo especificado a partir de um determinado cofre de chaves. |
Obter Segredos | Listar segredos num cofre de chaves especificado. |
Obter Versões Secretas | Listar todas as versões do segredo especificado. |
Definir Segredo | Define um segredo num cofre de chaves especificado. |
Atualizar Segredo | Atualizações os atributos associados a um segredo especificado num determinado cofre de chaves. |
Eliminar Segredo | Elimina um segredo de um cofre de chaves especificado. |
Obter Segredo Eliminado | Obtém o segredo eliminado especificado. |
Obter Segredos Eliminados | Lista segredos eliminados para o cofre especificado. |
Remover Segredo Eliminado | Elimina permanentemente o segredo especificado. |
Recuperar Segredo Eliminado | Recupera o segredo eliminado para a versão mais recente. |
Segredo da Cópia de Segurança | Cria uma cópia de segurança do segredo especificado. |
Restaurar Segredo | Restaura um segredo de cópia de segurança para um cofre. |
Operações de gestão de chaves da conta de armazenamento (apenas Key Vault)
Operações de configuração da Conta de Armazenamento
Operação | Description |
---|---|
Obter Conta de Armazenamento | Obtém informações sobre uma conta de armazenamento especificada. Esta operação requer a permissão de armazenamento/obtenção. |
Obter Contas de Armazenamento | Listar contas de armazenamento geridas pelo cofre de chaves especificado. Esta operação requer a permissão de armazenamento/lista. |
Atualizar Conta de Armazenamento | Atualizações os atributos especificados associados à conta de armazenamento especificada. Esta operação requer a permissão de armazenamento/conjunto/atualização. |
Definir Conta de Armazenamento | Cria ou atualiza uma nova conta de armazenamento. Esta operação requer a permissão de armazenamento/conjunto. |
Eliminar Conta de Armazenamento | Elimina uma conta de armazenamento. Esta operação requer a permissão de armazenamento/eliminação. |
Obter Conta de Armazenamento Eliminada | Obtém a conta de armazenamento eliminada especificada. |
Obter Contas de Armazenamento Eliminadas | Lista as contas de armazenamento eliminadas para o cofre especificado. |
Remover Conta de Armazenamento Eliminada | Elimina permanentemente a conta de armazenamento especificada. |
Recuperar Conta de Armazenamento Eliminada | Recupera a conta de armazenamento eliminada. |
Conta de Armazenamento de Cópias de Segurança | Cria uma cópia de segurança da conta de armazenamento especificada. |
Restaurar Conta de Armazenamento | Restaura uma conta de armazenamento com cópia de segurança para um cofre. |
Operações de chave da Conta de Armazenamento
Operação | Description |
---|---|
Regenerar Chave da Conta de Armazenamento | Regenera o valor da chave especificada para a conta de armazenamento especificada. Esta operação requer a permissão storage/regeneratekey. |
Operações de SAS da Conta de Armazenamento
Operação | Description |
---|---|
Obter Definição sas | Obtém informações sobre uma definição de SAS para a conta de armazenamento especificada. Esta operação requer a permissão storage/getsas. |
Obter Definições sas | Listar definições de SAS de armazenamento para a conta de armazenamento especificada. Esta operação requer a permissão storage/listsas. |
Definir Definição 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/conjuntos como. |
Atualizar Definição sas | Atualizações os atributos especificados associados à definição de SAS especificada. Esta operação requer a permissão de armazenamento/conjuntos como. |
Eliminar Definição sas | Elimina uma definição de SAS de uma conta de armazenamento especificada. Esta operação requer a permissão storage/deletesas. |
Obter Definição sas eliminada | Obtém a definição sas eliminada especificada. |
Obter Definições sas eliminadas | Lista as definições de SAS eliminadas para o cofre especificado e a conta de armazenamento. |
Recuperar Definição sas eliminada | Recupera a definição de SAS eliminada. |
Operações de certificado (apenas Key Vault)
Operação | Description |
---|---|
Obter Certificado | Obtém informações sobre um certificado. |
Obter Certificados | Listar certificados num cofre de chaves especificado |
Obter Versões do Certificado | Liste as versões de um certificado. |
Criar Certificado | Cria um novo certificado. |
Importar Certificado | Importa um certificado para um cofre de chaves especificado. |
Unir Certificado | Intercala 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. |
Eliminar Operação de Certificado | Elimina a operação de criação de um certificado específico. |
Atualizar Certificado | Atualizações os atributos especificados associados ao certificado especificado. |
Eliminar Certificado | Elimina um certificado de um cofre de chaves especificado. |
Obter Certificado Eliminado | Obtém informações sobre o certificado eliminado especificado. |
Obter Certificados Eliminados | Lista os certificados eliminados no cofre especificado atualmente disponíveis para recuperação. |
Remover Certificado Eliminado | Elimina permanentemente o certificado eliminado especificado. |
Recuperar Certificado Eliminado | Recupera o certificado eliminado novamente para a versão atual em /certificates. |
Certificado de Cópia de Segurança | Cria uma cópia de segurança do certificado especificado. |
Restaurar Certificado | Restaura um certificado de cópia de segurança para um cofre. |
Operações de política de certificados
Operação | Description |
---|---|
Obter Política de Certificados | Lista a política de um certificado. |
Atualizar Política de Certificados | Atualizações a política de um certificado. |
Operações de contactos de certificados
Operação | Description |
---|---|
Obter Contactos de Certificado | Lista os contactos do certificado de um cofre de chaves especificado. |
Definir Contactos de Certificado | Define os contactos do certificado para o cofre de chaves especificado. |
Eliminar Contactos de Certificado | Elimina os contactos do certificado de um cofre de chaves especificado. |
Operações do emissor de certificados
Operação | Description |
---|---|
Obter Emissor de Certificados | Lista o emissor de certificados especificado. |
Obter Emissores de Certificados | Listar emissores de certificados para um cofre de chaves especificado. |
Definir Emissor de Certificados | Define o emissor de certificados especificado. |
Atualizar Emissor de Certificados | Atualizações o emissor de certificados especificado. |
Eliminar Emissor de Certificados | Elimina o emissor de certificados especificado. |
Ver também
- Para obter conceitos e informações detalhadas sobre Key Vault, veja Acerca do Azure Key Vault.
- Para obter conceitos e informações detalhadas sobre o HSM Gerido, veja O que é o Azure Key Vault HSM Gerido?
- Para obter conceitos e informações detalhadas sobre objetos do plano de dados, veja Acerca de chaves, segredos e certificados.
- Para obter informações gerais sobre a construção de pedidos da API REST do Azure, veja a referência da API REST do Azure
- Para obter informações específicas sobre a construção de Key Vault pedidos da API REST, veja
- Veja os tópicos seguintes para obter mais Key Vault conceitos e detalhes