Microsoft Cloud 契約の契約メタデータを取得するGet agreement metadata for Microsoft Cloud Agreement

適用対象Applies To

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

注意

AgreementMetaDataリソースは、現在、Microsoft パブリッククラウドのパートナーセンターでのみサポートされています。The AgreementMetaData resource is currently supported by Partner Center in the Microsoft public cloud only. 次の場合には適用されません。It isn't applicable 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

前提条件Prerequisites

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

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

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

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

Microsoft Cloud Agreement のアグリーメントメタデータを取得するには:To retrieve the agreement metadata for Microsoft Cloud Agreement:

  1. まず、 AgreementDetails コレクションを取得します。First, retrieve the IAggregatePartner.AgreementDetails collection.

  2. ByAgreementTypeメソッドを呼び出して、コレクションを Microsoft Cloud Agreement にフィルター処理します。Call ByAgreementType method to filter the collection to Microsoft Cloud Agreement.

  3. 最後に、 Get または GetAsync メソッドを呼び出します。Finally, call Get or GetAsync method.

// IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCloudAgreement";

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

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

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

Microsoft Cloud Agreement のアグリーメントメタデータを取得するには:To retrieve agreement metadata for the Microsoft Cloud Agreement:

まず Iaggregatepartner.customers AgreementDetails コレクションを取得し、 Get または GetAsync メソッドを呼び出します。First retrieve the IAggregatePartner.AgreementDetails collection and then call the Get or GetAsync methods. 次に、コレクション内の項目を検索します。これは Microsoft Cloud アグリーメントに対応しています。Then search for the item within the collection, which corresponds to the Microsoft Cloud Agreement:

// IAggregatePartner partnerOperations;

var agreements = partnerOperations.AgreementDetails.Get();

AgreementMetaData microsoftCloudAgreement = agreements.Items.FirstOrDefault (agr => agr.AgreementType == AgreementType.MicrosoftCloudAgreement);

JavaJava

パートナー センター Java SDK は、パートナーが自分のパートナー センター リソースを管理するために一般的に使用されます。The Partner Center Java SDK is commonly used by partners to manage their Partner Center resources. これはパートナー コミュニティによって管理されているオープン ソース プロジェクトです。It's an open-source project maintained by the partner community. このモジュールはパートナー コミュニティによって管理されているため、Microsoft では公式にサポートしていません。Since this module is maintained by the partner community, it isn't officially supported by Microsoft. 問題が発生した場合は、コミュニティから支援を得るか、GitHub に問題を投稿することができます。You can get help from the community or open an issue on GitHub if you experience a problem.

Microsoft Cloud Agreement のアグリーメントメタデータを取得するには:To retrieve agreement metadata for the Microsoft Cloud Agreement:

まず、 iaggregatepartner.customers 関数を呼び出し、次に get 関数を呼び出します。First call the IAggregatePartner.getAgreementDetails function and then call the get function. 次に、コレクション内の項目を検索します。これは Microsoft Cloud アグリーメントに対応しています。Then search for the item within the collection, which corresponds to the Microsoft Cloud Agreement:

// IAggregatePartner partnerOperations;

ResourceCollection<AgreementMetaData> agreements = partnerOperations.getAgreements().get();

AgreementMetaData microsoftCloudAgreement;

for (AgreementMetaData metadata : agreements)
{
    if(metadata.getAgreementType() == AgreementType.MicrosoftCloudAgreement)
    {
        microsoftCloudAgreement = metadata;
    }
}

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

PowerShellPowerShell

パートナー センター PowerShell モジュールは、パートナーが自分のパートナー センター リソースを管理するために一般的に使用されます。The Partner Center PowerShell module is commonly used by partners to manage their Partner Center resources. これはパートナー コミュニティによって管理されているオープン ソース プロジェクトです。It's an open-source project maintained by the partner community. このモジュールはパートナー コミュニティによって管理されているため、Microsoft では公式にサポートしていません。Since this module is maintained by the partner community, it isn't officially supported by Microsoft. 問題が発生した場合は、コミュニティから支援を得るか、GitHub に問題を投稿することができます。You can get help from the community or open an issue on GitHub if you experience a problem.

Microsoft Cloud Agreement のアグリーメントメタデータを取得するには:To retrieve agreement metadata for the Microsoft Cloud Agreement:

PartnerAgreementDetailコマンドを使用します。Use the Get-PartnerAgreementDetail command. 次に、コレクション内の項目を検索します。これは Microsoft Cloud アグリーメントに対応しています。Then search for the item within the collection, which corresponds to the Microsoft Cloud Agreement:

Get-PartnerAgreementDetail | Where-Object {$_.AgreementType -eq 'MicrosoftCloudAgreement'} | Select-Object -First 1

REST 要求REST request

Microsoft Cloud Agreement のアグリーメントメタデータを取得するには、まず REST 要求を作成して AgreementMetaData collection を取得します。To retrieve agreement metadata for Microsoft Cloud Agreement, first create a REST Request to retrieve the AgreementMetaData collection. 次に、Microsoft Cloud Agreement に対応するコレクション内の項目を検索します。Then search for the item in the collection which corresponds to the Microsoft Cloud Agreement.

要求の構文Request syntax

認証方法Method 要求 URIRequest URI
GETGET * { BASEURL } */v1/agreements HTTP/1.1{baseURL}/v1/agreements HTTP/1.1

要求ヘッダーRequest headers

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

[要求本文]Request body

[なし] :None.

要求の例Request example

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

成功した場合、このメソッドは応答本文で AgreementMetaData リソースのコレクションを返します。If successful, this method returns a collection of AgreementMetaData 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": 1,
    "items": [
        {
            "templateId": "998b88de-aa99-4388-a42c-1b3517d49490",
            "agreementType": "MicrosoftCloudAgreement",
            "agreementLink": "https://docs.microsoft.com/partner-center/agreements",
            "versionRank": 0
        }
    ],
    "links": {
        "self": {
            "uri": "/agreements",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "Collection"
    }
}

応答で Microsoft Cloud アグリーメントに対応するリソースを特定するには、 agreementType プロパティの値が "Microsoft cloudagreement" であるリソースを探します。To identify the resource in the response which corresponds to the Microsoft Cloud Agreement, look for the resource whose agreementType property has value "MicrosoftCloudAgreement".