取得客戶接受 Microsoft 客戶合約的確認

發行項
03/05/2024

適用於：合作夥伴中心

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

合作夥伴 中心目前僅支援 Microsoft 公用雲端中的合約 資源。

本文說明如何擷取客戶接受 Microsoft 客戶合約的確認。

必要條件

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

重要

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

鼓勵合作夥伴繼續使用合作夥伴中心 REST API。
認證，如合作夥伴中心驗證所述。此案例僅支援「應用程式 + 使用者」驗證。
客戶識別碼 (customer-tenant-id)。如果您不知道客戶的標識碼，您可以在合作夥伴中心中選取 [客戶] 工作區，然後從客戶清單中查看客戶，然後從 [帳戶]。在客戶的 [帳戶] 頁面上，在 [客戶帳戶資訊] 區段中尋找 Microsoft 標識符。 Microsoft 識別碼與客戶識別碼 (customer-tenant-id) 相同。

.NET

若要擷取先前提供的客戶接受確認：

使用 IAggregatePartner.Customers 集合，並使用指定的客戶標識符呼叫 ById 方法。
藉由呼叫 ByAgreementType 方法，擷取 Agreements 屬性並篩選結果以 Microsoft 客戶合約。
呼叫 Get 或 GetAsync 方法。

// IAggregatePartner partnerOperations;
// string selectedCustomerId;

string agreementType = "MicrosoftCustomerAgreement";

var customerAgreements = partnerOperations.Customers.ById(selectedCustomerId).Agreements.ByAgreementType(agreementType).Get();

您可以在主控台測試應用程式專案的 GetCustomerAgreements 類別中找到完整的範例。

REST 要求

若要擷取先前提供的客戶接受確認：

建立 REST 要求，以擷取客戶的合約集合。
使用 agreementType 查詢參數，將結果的範圍設定為只有 Microsoft 客戶合約。

要求語法

使用下列要求語法：

方法	要求 URI
GET	{baseURL}/v1/customers/{customer-tenant-id}/agreements？agreementType={agreement-type} HTTP/1.1

URI 參數

您可以搭配您的要求使用下列 URI 參數：

名稱	類型	必要	描述
customer-tenant-id	GUID	Yes	此值是 GUID 格式的 CustomerTenantId ，可讓您指定客戶。
合約類型	string	No	此參數會傳回所有合約元數據。使用此參數將查詢回應的範圍設定為特定的合約類型。支援的值為：僅包含 MicrosoftCloudAgreement 類型的合約元數據的 MicrosoftCloudAgreement。僅包含 MicrosoftCustomerAgreement 類型的合約元數據的 MicrosoftCustomerAgreement。 * 會傳回所有合約元數據。（除非您的程式代碼具有處理非預期合約類型的必要邏輯，否則請勿使用 * 。注意：如果未指定 URI 參數，查詢會預設為 MicrosoftCloudAgreement 以取得回溯相容性。 Microsoft 隨時可能會引進新合約類型的合約元數據。

要求標頭

如需詳細資訊，請參閱合作夥伴中心 REST 標頭。

要求本文

無。

要求範例

GET https://api.partnercenter.microsoft.com/v1/customers/14876998-c0dc-46e6-9d0c-65a57a6c32ec/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": 2,
    "items":
    [
        {
            "primaryContact":
            {
                "firstName":"Tania",
                "lastName":"Carr",
                "email":"SomeEmail@example.com"
                "phoneNumber":"1234567890"
            },
            "templateId":"aaaabbbb-0000-cccc-1111-dddd2222eeee",
            "dateAgreed":"2019-08-26T00:00:00",
            "type":"MicrosoftCustomerAgreement",
            "agreementLink":"https://aka.ms/customeragreement"
        },
        {
            "primaryContact":
            {
                "firstName":"Tania",
                "lastName":"Carr",
                "email":"SomeEmail@example.com"
                "phoneNumber:"1234567890"
            },
            "templateId":"aaaabbbb-0000-cccc-1111-dddd2222eeee",
            "dateAgreed":"2019-08-27T00:00:00",
            "type":"MicrosoftCustomerAgreement",
            "agreementLink":"https://aka.ms/customeragreement"
        }
    ]
}

共用方式為