Microsoft 顧客契約に関する顧客の同意の確認を取得する

[アーティクル]
03/08/2024

適用対象: パートナーセンター

適用対象外: 21Vianet が運営するパートナーセンター | Microsoft Cloud for US Government のパートナーセンター

契約リソースは現在、Microsoft パブリッククラウドでのみパートナーセンターでサポートされています。

この記事では、Microsoft 顧客契約に対する顧客の同意の確認を取得する方法について説明します。

前提条件

パートナーセンター .NET SDK を使用している場合は、バージョン 1.14 以降が必要です。

重要

2023 年 6 月の時点で、最新のパートナーセンター .NET SDK リリース 3.4.0 がアーカイブされるようになりました。 SDK リリースは、有用な情報が記載された readme ファイルと一緒に GitHub からダウンロードできます。

パートナーの皆様には、パートナーセンター REST API を引き続き使用することをお勧めします。
パートナーセンターの認証に関するページで説明している資格情報。このシナリオでは、アプリとユーザー認証のみがサポートされます。
顧客 ID です (customer-tenant-id)。顧客の ID がわからない場合は、パートナーセンターで [顧客] ワークスペースを選び、顧客一覧から顧客を選び、[アカウント] を選んで調べることができます。顧客の [アカウント] ページの [顧客のアカウント情報] セクションで Microsoft ID を探します。 Microsoft ID は、顧客 ID (customer-tenant-id) と同じです。

.NET

以前に提供された顧客の同意の確認を取得するには:

IAggregatePartner.Customers コレクションを使用し、指定した顧客識別子で ById メソッドを呼び出します。
Agreements プロパティをフェッチし、ByAgreementType メソッドを呼び出して結果をフィルター処理してMicrosoft 顧客契約します。
Get メソッドまたは GetAsync メソッドを呼び出します。

// IAggregatePartner partnerOperations;
// string selectedCustomerId;

string agreementType = "MicrosoftCustomerAgreement";

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

完全なサンプルは、コンソールテストアプリプロジェクトの GetCustomerAgreements クラスにあります。

REST 要求

以前に提供された顧客の同意の確認を取得するには:

顧客の Agreements コレクションを取得する REST 要求を作成します。
agreementType クエリパラメーターを使用して、結果のスコープをMicrosoft 顧客契約のみに設定します。

要求の構文

次の要求構文を使用します。

メソッド	要求 URI
GET	{baseURL}/v1/customers/{customer-tenant-id}/agreements?agreementType={agreement-type} HTTP/1.1

URI パラメーター

要求では、次の URI パラメーターを使用できます。

名前	タイプ	Required	説明
customer-tenant-id	GUID	はい	値は、顧客を指定できる GUID 形式の CustomerTenantId です。
agreement-type	string	いいえ	このパラメーターは、すべての契約メタデータを返します。クエリ応答の範囲を特定の契約の種類に設定するには、このパラメーターを使用します。サポートされている値は次のとおりです。 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: ab993325-1605-4cf4-bac4-fb584142a31b

REST 応答

成功した場合、このメソッドは応答本文で Agreement リソースのコレクションを返します。

応答の成功とエラーのコード

各応答には、成功または失敗とその他のデバッグ情報を示す HTTP 状態コードが付属しています。

ネットワークトレースツールを使用して、このコード、エラーの種類、およびその他のパラメーターを読み取ります。完全な一覧については、パートナーセンターの REST エラーコードに関する記事を参照してください。

応答の例

HTTP/1.1 200 OK
Content-Length: 620
Content-Type: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: ab993325-1605-4cf4-bac4-fb584142a31b
{
    "totalCount": 2,
    "items":
    [
        {
            "primaryContact":
            {
                "firstName":"Tania",
                "lastName":"Carr",
                "email":"SomeEmail@example.com"
                "phoneNumber":"1234567890"
            },
            "templateId":"117a77b0-9360-443b-8795-c6dedc750cf9",
            "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":"117a77b0-9360-443b-8795-c6dedc750cf9",
            "dateAgreed":"2019-08-27T00:00:00",
            "type":"MicrosoftCustomerAgreement",
            "agreementLink":"https://aka.ms/customeragreement"
        }
    ]
}