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

  • [アーティクル]

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

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

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

前提条件

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

    重要

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

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

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

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

  • 顧客 ID です (customer-tenant-id)。 顧客の ID がわからない場合は、パートナー センターで [顧客] ワークスペースを選び、顧客一覧から顧客を選び、[アカウント] を選んで調べることができます。 顧客の [アカウント] ページの [顧客のアカウント情報] セクションで Microsoft ID を探します。 Microsoft ID は、顧客 ID (customer-tenant-id) と同じです。

.NET (バージョン 1.4 以降)

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

  • IAggregatePartner.Customers コレクションを使用し、指定した顧客識別子で ById メソッドを呼び出します。

  • Agreements プロパティをフェッチし、ByAgreementType メソッドを呼び出して結果を Microsoft Cloud Agreement にフィルター処理します。

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

// IAggregatePartner partnerOperations;
// string selectedCustomerId;

string agreementType = "MicrosoftCloudAgreement";

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

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

.NET (バージョン 1.9 - 1.13)

前に指定した顧客の同意の確認を取得するには:

IAggregatePartner.Customers コレクションを使用し、指定した顧客の識別子を使用して ById メソッドを呼び出します。 次に、Agreements プロパティを取得し、次に Get メソッドまたは GetAsync メソッドを呼び出します。

// IAggregatePartner partnerOperations;
// string selectedCustomerId;

var agreements = partnerOperations.Customers.ById(selectedCustomerId).Agreements.Get();

Java

パートナー センター Java SDK を使用して、パートナー センター リソースを管理できます。 これは、パートナー コミュニティによってメインされ、Microsoft によって正式にサポートされていないオープンソース プロジェクトです。 問題が発生した場合は、コミュニティから支援を得るか、GitHub に問題を投稿することができます。

前に指定した顧客の同意の確認を取得するには:

IAggregatePartner.getCustomers 関数を使用し、指定した顧客の識別子で byId 関数を呼び出します。 次に、getAgreements 関数を取得し、次に get 関数を呼び出します。

// IAggregatePartner partnerOperations;
// String selectedCustomerId;

ResourceCollection<Agreement> agreements = partnerOperations.getCustomers().byId(selectedCustomerId).getAgreements().get();

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

PowerShell

パートナー センター PowerShell モジュールを使用して、パートナー センター リソースを管理できます。 これは、パートナー コミュニティによってメインされ、Microsoft によって正式にサポートされていないオープンソース プロジェクトです。 問題が発生した場合は、コミュニティから支援を得るか、GitHub に問題を投稿することができます。

前に指定した顧客の同意の確認を取得するには:

Get-PartnerCustomerAgreement コマンドを使用します。

Get-PartnerCustomerAgreement -CustomerId '14876998-c0dc-46e6-9d0c-65a57a6c32ec'

REST 要求

前に指定した顧客の同意の確認を取得するには、次の手順を参照してください。

関連する認定情報を含む新しい Agreement リソースを作成します。

要求の構文

認証方法 要求 URI
GET {baseURL}/v1/customers/{customer-tenant-id}/agreements HTTP/1.1

URI パラメーター

確認する顧客を指定するには、次のクエリ パラメーターを使用します。

名前 タイプ Required 説明
CustomerTenantId GUID 年 値は、顧客を指定できる GUID 形式の CustomerTenantId です。

要求ヘッダー

詳細については、「パートナー センター REST ヘッダー」を参照してください。

要求本文

なし。

要求の例

GET https://api.partnercenter.microsoft.com/v1/customers/14876998-c0dc-46e6-9d0c-65a57a6c32ec/agreements 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@Outlook.com"
                "phoneNumber":"1234567890"
            },
            "templateId":"998b88de-aa99-4388-a42c-1b3517d49490",
            "dateAgreed":"2018-07-28T00:00:00",
            "type":"MicrosoftCloudAgreement",
            "agreementLink":"https://learn.microsoft.com/partner-center/agreements"
        },
        {
            "primaryContact":
            {
                "firstName":"Tania",
                "lastName":"Carr",
                "email":"SomeEmail@Outlook.com"
                "phoneNumber:"1234567890"
            },
            "templateId":"998b88de-aa99-4388-a42c-1b3517d49490",
            "dateAgreed":"2017-08-01T00:00:00",
            "type":"MicrosoftCloudAgreement",
            "agreementLink":"https://learn.microsoft.com/partner-center/agreements"
        }
    ]
}