Compartilhar via


Parâmetros e cabeçalhos comuns

As informações a seguir são comuns a todas as operações que você pode executar nos recursos do Key Vault:

  • O cabeçalho HTTP Host deve estar sempre presente e deve especificar o nome do host do cofre. Exemplo: Host: contoso.vault.azure.net. Observe que a maioria das tecnologias de cliente preenche o cabeçalho Host do URI. Por exemplo, GET https://contoso.vault.azure.net/secrets/mysecret{...} definirá Host como contoso.vault.azure.net. Se você acessar o Key Vault com um endereço IP bruto como GET https://10.0.0.23/secrets/mysecret{...}, o valor automático do cabeçalho Host ficará incorreto e você terá de verificar manualmente se o cabeçalho Host contém o nome do host do cofre.
  • Substitua {api-version} pela versão da api no URI.
  • Substitua {subscription-id} pelo identificador de assinatura no URI
  • Substitua {resource-group-name} pelo grupo de recursos. Para saber mais, consulte Usar os grupos de recursos para gerenciar seus recursos do Azure.
  • Substitua {vault-name} pelo nome de seu cofre de chaves no URI.
  • Defina o cabeçalho Content-Type como application/json.
  • Defina o cabeçalho de autorização para um token Web JSON obtido do Microsoft Entra ID. Para saber mais, confira Autenticação de solicitações do Azure Resource Manager.

Resposta de erro comum

O serviço usará códigos de status HTTP para indicar êxito ou falha. Além disso, as falhas contêm uma resposta no seguinte formato:

   {  
     "error": {  
     "code": "BadRequest",  
     "message": "The key vault sku is invalid."  
     }  
   }  
Nome do elemento Type Descrição
code string O tipo de erro que ocorreu.
message string Uma descrição do que causou o erro.

Consulte Também

Referência da API REST do Azure Key Vault