常见参数和标头

以下信息常见于对密钥保管库资源执行的所有操作:

  • HTTP Host 标头必须始终存在并且必须指定保管库主机名。 示例:Host: contoso.vault.azure.cn。 请注意,大多数客户端技术将从 URI 填充 Host 标头。 例如,GET https://contoso.vault.azure.cn/secrets/mysecret{...} 会将 Host 设置为 contoso.vault.azure.cn。 如果使用 GET https://10.0.0.23/secrets/mysecret{...} 等原始 IP 地址访问密钥保管库,Host 标头的自动值将是错误的,并且必须手动确保 Host 标头包含保管库主机名。
  • {api-version} 替换为 URI 中的 API 版本。
  • {subscription-id} 替换为 URI 中的订阅标识符
  • {resource-group-name} 替换为资源组。 有关详细信息,请参阅“使用资源组管理 Azure 资源”。
  • {vault-name} 替换为 URI 中 Key Vault 的名称。
  • 将 Content-Type 表头设置为 application/json。
  • 将授权标头设置为从 Microsoft Entra ID 获得的 JSON Web 令牌。 有关详细信息,请参阅对 Azure 资源管理器请求进行身份验证

常见错误响应

服务使用 HTTP 状态代码指示成功或失败。 此外,失败还会包含采用以下格式的响应:

   {  
     "error": {  
     "code": "BadRequest",  
     "message": "The key vault sku is invalid."  
     }  
   }  
元素名称 类型 说明
code string 发生的错误类型。
message string 错误原因说明。

另请参阅

Azure Key Vault REST API 参考