Microsoft 顧客契約の契約メタデータを取得する

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

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

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

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

次の作業を行うには、Microsoft 顧客契約の契約メタデータを取得する必要があります。

前提条件

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

重要

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

パートナーの皆様には、パートナーセンター REST API を引き続き使用することをお勧めします。
パートナーセンターの認証に関するページで説明している資格情報。このシナリオでは、App+User 認証のみがサポートされます。

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

Microsoft 顧客契約の契約メタデータを取得するには:

まず、IAggregatePartner.AgreementDetails コレクションを取得します。
ByAgreementType メソッドを呼び出して、コレクションをフィルター処理してMicrosoft 顧客契約します。
最後に、Get メソッドまたは GetAsync メソッドを呼び出します。

// IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCustomerAgreement";

var microsoftCustomerAgreementDetails = partnerOperations.AgreementDetails.ByAgreementType(agreementType).Get().Items.Single();

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

REST 要求

Microsoft 顧客契約の契約メタデータを取得するには:

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

要求の構文

認証方法	要求 URI
GET	{baseURL}/v1/agreements?agreementType={agreement-type} HTTP/1.1

URI パラメーター

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

名前	タイプ	Required	説明
agreement-type	string	いいえ	クエリ応答の範囲を特定の契約の種類に設定するには、このパラメーターを使用します。サポートされている値は次のとおりです。 MicrosoftCloudAgreement 型の契約メタデータのみを含む MicrosoftCloudAgreement MicrosoftCustomerAgreement 型の契約メタデータのみを含む MicrosoftCustomerAgreement。 * すべての契約メタデータを返す (Microsoft では、新しい契約の種類を含む契約メタデータをいつでも導入する可能性があるため、不慣れな契約の種類を処理するためにコードに必要なランタイムロジックがない限り、使用 * しないでください)。注: URI パラメーターが指定されていない場合、下位互換性のためにクエリの既定値は MicrosoftCloudAgreement になります。

要求ヘッダー

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

要求本文

なし。

要求の例

GET https://api.partnercenter.microsoft.com/v1/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 応答

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

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

各応答には、成功または失敗とその他のデバッグ情報を示す 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": 1,
    "items": [
        {
            "templateId": "117a77b0-9360-443b-8795-c6dedc750cf9",
            "agreementType": "MicrosoftCustomerAgreement",
            "agreementLink": "https://aka.ms/customeragreement",
            "versionRank": 0
        }
    ],
    "attributes": {
        "objectType": "Collection"
    }
}

次の方法で共有