Microsoft 顧客契約に関する顧客の同意の確認を取得する Get confirmation of customer acceptance of Microsoft Customer Agreement

適用対象:Applies to:

  • パートナー センターPartner Center

現在、 アグリーメント リソースは、 Microsoft パブリッククラウドのパートナーセンターでのみサポートされています。The Agreement resource is currently supported by Partner Center only in the Microsoft public cloud. このリソースはに適用されません:This resource doesn't apply to:

  • 21Vianet が運営するパートナー センターPartner Center operated by 21Vianet
  • Microsoft Cloud ドイツのパートナー センターPartner Center for Microsoft Cloud Germany
  • 米国政府機関向け Microsoft Cloud のパートナー センターPartner Center for Microsoft Cloud for US Government

この記事では、お客様が Microsoft カスタマーアグリーメントに同意したかどうかを確認する方法について説明します。This article explains how you can retrieve confirmation(s) of a customer's acceptance of the Microsoft Customer Agreement.

前提条件Prerequisites

  • パートナー センター .NET SDK を使用している場合、バージョン 1.14 以降が必要です。If you are using the Partner Center .NET SDK, version 1.14 or newer is required.

  • パートナー センターの認証に関するページで説明している資格情報。Credentials as described in Partner Center authentication. このシナリオでは、アプリとユーザー認証のみがサポートされます。This scenario only supports App+User authentication.

  • 顧客 ID です (customer-tenant-id)。A customer ID (customer-tenant-id). お客様の ID がわからない場合は、パートナー センターのダッシュボードで検索できます。If you don't know the customer's ID, you can look it up in the Partner Center dashboard. パートナー センター メニューの [CSP] を選択し、 [顧客] を選択します。Select CSP from the Partner Center menu, followed by Customers. 顧客一覧からお客様を選び、 [アカウント] を選択します。Select the customer from the customer list, then select Account. お客様のアカウント ページで、 [顧客のアカウント情報] セクションの Microsoft ID を探します。On the customer’s Account page, look for the Microsoft ID in the Customer Account Info section. Microsoft ID は、顧客 ID (customer-tenant-id) と同じです。The Microsoft ID is the same as the customer ID (customer-tenant-id).

.NET.NET

以前に提供された顧客の同意の確認を取得するには、次のようにします。To retrieve confirmation(s) of customer acceptance that was previously provided:

  • Iaggregatepartner.customersコレクションを使用し、指定された顧客識別子を使用してByIdメソッドを呼び出します。Use the IAggregatePartner.Customers collection and call ById method with the specified customer identifier.

  • ByAgreementTypeメソッドを呼び出して、アグリーメントのプロパティを取得し、結果を Microsoft Customer Agreement にフィルター処理します。Fetch the Agreements property and filter the results to Microsoft Customer Agreement by calling ByAgreementType method.

  • GetまたはGetAsyncメソッドを呼び出します。Call Get or GetAsync method.

// IAggregatePartner partnerOperations;
// string selectedCustomerId;

string agreementType = "MicrosoftCustomerAgreement";

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

完全なサンプルは、コンソールテストアプリプロジェクトのget顧客契約クラスにあります。A complete sample can be found in the GetCustomerAgreements class from the console test app project.

REST 要求REST request

以前に提供された顧客の同意の確認を取得するには、次のようにします。To retrieve confirmation of customer acceptance that was previously provided:

  1. REST 要求を作成して、顧客の 契約 コレクションを取得します。Create a REST request to retrieve the Agreements collection for the customer.

  2. AgreementTypeクエリパラメーターを使用して、結果の範囲を Microsoft Customer Agreement のみに限定します。Use the agreementType query parameter to scope the results to only the Microsoft Customer Agreement.

要求の構文Request syntax

次の要求構文を使用します。Use the following request syntax:

MethodMethod 要求 URIRequest URI
GETGET * { baseURL } */v1/customers/{customer-tenant-id}/agreements? agreementType = {AGREEMENT-type} HTTP/1.1{baseURL}/v1/customers/{customer-tenant-id}/agreements?agreementType={agreement-type} HTTP/1.1

URI パラメーターURI parameters

要求では、次の URI パラメーターを使用できます。You can use the following URI parameters with your request:

名前Name TypeType 必須Required 説明Description
customer-tenant-idcustomer-tenant-id GUIDGUID はいYes 値は、顧客を指定できるようにする GUID 形式の顧客 tenantid です。The value is a GUID formatted CustomerTenantId that allows you to specify a customer.
契約タイプagreement-type stringstring いいえNo このパラメーターは、すべてのアグリーメントメタデータを返します。This parameter returns all agreement metadata. このパラメーターを使用して、特定のアグリーメントの種類に対するクエリ応答のスコープを指定します。Use this parameter to scope the query response to specific agreement type. サポートされる値はThe supported values are:

Microsoft のCloudagreementでは、種類が " microsoft" の契約のメタデータのみが含まれています。MicrosoftCloudAgreement that only includes agreement metadata of the type MicrosoftCloudAgreement.

Microsoft の顧客契約では、種類が「 Microsoft の顧客契約」の契約メタデータのみが含まれています。MicrosoftCustomerAgreement that only includes agreement metadata of the type MicrosoftCustomerAgreement.

* すべてのアグリーメントメタデータを返します。* that returns all agreement metadata. (予期しない * 契約の種類を処理するために必要なロジックがコードに含まれていない場合は、を使用しないでください)。(Don't use * unless your code has the necessary logic to handle unexpected agreement types.)

注: URI パラメーターが指定されていない場合、クエリは、旧バージョンとの互換性のために、既定では Microsoft Cloudagreement に設定されます。Note: If the URI parameter isn't specified, the query defaults to MicrosoftCloudAgreement for backward compatibility. Microsoft では、契約のメタデータをいつでも新しい契約の種類と共に導入する場合があります。Microsoft may introduce agreement metadata with new agreement types at any time.

要求ヘッダーRequest headers

詳細については、「パートナー センター REST ヘッダー」を参照してください。For more information, see Partner Center REST headers.

[要求本文]Request body

[なし] :None.

要求の例Request example

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

成功した場合、このメソッドは応答本文で アグリーメント リソースのコレクションを返します。If successful, this method returns a collection of Agreement resources in the response body.

応答の成功とエラーのコードResponse success and error codes

各応答には、成功または失敗を示す HTTP ステータス コードと、追加のデバッグ情報が付属しています。Each response comes with an HTTP status code that indicates success or failure and additional debugging information.

このコード、エラーの種類、追加のパラメーターを読み取るには、ネットワーク トレース ツールを使用します。Use a network trace tool to read this code, error type, and additional parameters. 完全な一覧については、パートナー センターの REST エラーコードに関する記事を参照してください。For the full list, see Partner Center REST error codes.

応答の例Response example

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"
        }
    ]
}