取得Microsoft客戶合約的合約元數據

發行項
03/11/2025

適用於：合作夥伴中心

不適用於：由 21Vianet 營運的合作夥伴中心 |美國政府Microsoft雲端合作夥伴中心

Microsoft客戶合約的合約元數據目前僅受到合作夥伴中心Microsoft公用雲端的支援。

您必須先擷取Microsoft客戶合約的合約元數據，才能：

先決條件

如果您使用合作夥伴中心 .NET SDK，則需要 1.14 版或更新版本。

重要

自 2023 年 6 月起，最新的合作夥伴中心 .NET SDK 3.4.0 版現已封存。您可以從 GitHub下載 SDK 版本，以及包含實用資訊的自述檔。

鼓勵合作夥伴繼續使用合作夥伴中心 REST API。
認證如合作夥伴中心驗證中所述。此案例僅支援 App+用戶驗證。

.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
獲取	{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 回應訊息

如果成功，這個方法會在回應本文中傳回一個協議元數據資源的集合。

回應成功和錯誤碼

每個回應都有一個 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"
    }
}

共用方式為