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 Cofre de Chaves:
- O cabeçalho HTTP
Host
deve estar sempre presente e deve especificar o nome do host do vault. Exemplo:Host: contoso.vault.azure.net
. Observe que a maioria das tecnologias de cliente preenche oHost
cabeçalho do URI. Por exemplo,GET https://contoso.vault.azure.net/secrets/mysecret{...}
definirá oHost
comocontoso.vault.azure.net
. Se você acessar o Cofre da Chave usando o endereço IP bruto comoGET https://10.0.0.23/secrets/mysecret{...}
, o valor automático do cabeçalho estará errado e você terá que garantir manualmente que oHost
cabeçalho contenha o nome doHost
host do cofre. - Substitua
{api-version}
pela api-version no URI. - Substitua
{subscription-id}
pelo identificador de assinatura no URI - Substitua
{resource-group-name}
pelo grupo de recursos. Para obter mais informações, veja Utilizar Grupos de recursos para gerir os recursos do Azure. - Substitua
{vault-name}
pelo nome do cofre de chaves no URI. - Defina o cabeçalho Content-Type como application/json.
- Defina o cabeçalho Authorization como um token da Web JSON que você obtém da ID do Microsoft Entra. Para obter mais informações, consulte Autenticando solicitações do Azure Resource Manager .
Resposta de erro comum
O serviço usará códigos de status HTTP para indicar sucesso 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 | Tipo | Description |
---|---|---|
code | string | O tipo de erro que ocorreu. |
mensagem | string | Uma descrição do que causou o erro. |