次の方法で共有

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

  • [アーティクル]

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

はには適用されません: 21Vianet が運営するパートナー センター |Microsoft Cloud for US Government のパートナー センター

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

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

前提条件

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

    重要

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

    パートナーは、パートナー センター REST API引き続き使用することをお勧めします。

  • パートナー センターの認証に関するページで説明している資格情報。 このシナリオでは、App+User 認証のみがサポートされます。

  • 顧客 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 要求

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

  1. REST 要求を作成して、顧客の Agreements コレクションを取得します。

  2. agreementType クエリ パラメーターを使用して、結果の範囲を Microsoft 顧客契約のみに設定します。

リクエスト構文

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

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

URI パラメーター

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

名前 タイプ 必須 説明
カスタマー・テナントID (customer-tenant-id) GUID イエス 値は、顧客を指定できる GUID 形式の CustomerTenantId です。
契約タイプ 糸 いいえ このパラメーターは、すべての契約メタデータを返します。 クエリ応答の範囲を特定の契約の種類に設定するには、このパラメーターを使用します。 サポートされている値は次のとおりです。

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 応答

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

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

各応答には、成功または失敗とその他のデバッグ情報を示す 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"
        }
    ]
}