获取 Microsoft 客户协议的协议元数据

项目
03/17/2025

适用于：合作伙伴中心

不适用于：由世纪互联运营的合作伙伴中心 |美国政府Microsoft云合作伙伴中心

合作伙伴中心目前仅在Microsoft公有云中支持Microsoft客户协议的协议元数据。

必须先检索Microsoft客户协议的协议元数据，然后才能：

先决条件

如果使用合作伙伴中心 .NET SDK，则需要版本 1.14 或更高版本。

重要

截至 2023 年 6 月，最新的合作伙伴中心 .NET SDK 版本 3.4.0 现已存档。可以从 GitHub 下载 SDK 版本，以及包含有用信息的自述文件。

建议合作伙伴继续使用合作伙伴中心 REST API。
合作伙伴中心身份验证中所述的凭据。此方案仅支持 App+User 身份验证。

.NET （版本 1.14 或更高版本）

检索Microsoft客户协议的协议元数据：

首先，检索 IAggregatePartner.AgreementDetails 集合。
调用 ByAgreementType 方法筛选 Microsoft 客户协议的集合。
最后，调用 Get 或 GetAsync 方法。

// IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCustomerAgreement";

var microsoftCustomerAgreementDetails = partnerOperations.AgreementDetails.ByAgreementType(agreementType).Get().Items.Single();

可以从控制台测试应用项目中的 GetAgreementDetails 类中找到完整的示例。

REST 请求

检索Microsoft客户协议的协议元数据：

创建 REST 请求以检索 AgreementMetaData 集合。
使用 agreementType 查询参数将结果的范围限定为仅Microsoft客户协议。

请求语法

方法	请求 URI
GET	{baseURL}/v1/agreements?agreementType={agreement-type} HTTP/1.1

URI 参数

将以下 URI 参数用于请求：

名字	类型	必需	说明
协议类型	字符串	否	使用此参数将查询响应的范围限定为特定的协议类型。支持的值包括： MicrosoftCloudAgreement，它仅包含 MicrosoftCloudAgreement 类型的协议元数据 MicrosoftCustomerAgreement，它仅包含 MicrosoftCustomerAgreement 类型的协议元数据。，返回所有协议元数据。（除非代码具有处理不熟悉的协议类型所需的运行时逻辑，否则不要使用，因为Microsoft随时可能会引入具有新协议类型的协议元数据。注意：如果未指定 URI 参数，则查询默认 MicrosoftCloudAgreement 以实现向后兼容性。

请求头

如需了解更多信息，请参阅合作伙伴中心 REST 标头。

请求主体

没有。

请求示例

GET https://api.partnercenter.microsoft.com/v1/agreements?agreementType=MicrosoftCustomerAgreement HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd

REST 响应

如果成功，此方法将在响应正文中返回 AgreementMetaData 资源的集合。

成功响应和错误代码

每个响应都有一个 HTTP 状态代码，指示成功或失败和其他调试信息。

使用网络跟踪工具读取此代码、错误类型和其他参数。如需完整列表，请参阅合作伙伴中心 REST 错误代码。

响应示例

HTTP/1.1 200 OK
Content-Length: 620
Content-Type: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
{
    "totalCount": 1,
    "items": [
        {
            "templateId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
            "agreementType": "MicrosoftCustomerAgreement",
            "agreementLink": "https://aka.ms/customeragreement",
            "versionRank": 0
        }
    ],
    "attributes": {
        "objectType": "Collection"
    }
}

通过