顧客の製品アップグレードの状態を取得する

[アーティクル]
09/23/2023

ProductUpgradeRequest リソースを使用して、新しい製品ファミリへのアップグレードの状態を取得できます。このリソースは、Microsoft Azure (MS-AZR-0145P) サブスクリプションから Azure プランに顧客をアップグレードする場合に適用されます。要求が成功すると、 ProductUpgradesEligibility リソースが返されます。

前提条件

パートナーセンターの認証に関するページで説明している資格情報。このシナリオでは、アプリとユーザーの資格情報を使用した認証がサポートされます。パートナーセンター API で App+User 認証を使用する場合は、セキュリティで保護されたアプリモデルに従います。
顧客 ID です (customer-tenant-id)。顧客の ID がわからない場合は、[顧客] ワークスペースを選択し、顧客の一覧から顧客を選択し、[アカウント] を選択して、パートナーセンターで検索できます。顧客の [アカウント] ページで、[顧客アカウント情報] セクションで Microsoft ID を探します。 Microsoft ID は、顧客 ID (customer-tenant-id) と同じです。
製品ファミリ。
アップグレード要求の upgrade-id。

C#

顧客が Azure プランにアップグレードする資格があるかどうかをチェックするには:

ProductUpgradesRequest オブジェクトを作成し、顧客識別子と "Azure" を製品ファミリとして指定します。
IAggregatePartner.ProductUpgrades コレクションを使用します。
ById メソッドを呼び出し、upgrade-id を渡します。
CheckStatus メソッドを呼び出し、ProductUpgradeStatus オブジェクトを返す ProductUpgradesRequest オブジェクトを渡します。

// IAggregatePartner partnerOperations;

string selectedCustomerId = "58e2af4f-0ad3-4688-8744-be2357cd939a";

string selectedProductFamily = "azure";

var productUpgradeRequest = new ProductUpgradesRequest
{
    CustomerId = selectedCustomerId,
    ProductFamily = selectedProductFamily
};

ProductUpgradesStatus productUpgradeStatus = partnerOperations.ProductUpgrades.ById(selectedUpgradeId).CheckStatus(productUpgradeRequest);

if (productUpgradeEligibility.IsEligibile)
{
    ....
}

REST 要求

要求の構文

認証方法	要求 URI
投稿	{baseURL}/v1/productUpgrades/{upgrade-id}/status HTTP/1.1

URI パラメーター

次のクエリパラメーターを使用して、製品のアップグレード状態を取得する顧客を指定します。

名前	タイプ	Required	説明
upgrade-id	GUID	はい	値は GUID 形式のアップグレード識別子です。この識別子を使用して、追跡するアップグレードを指定できます。

要求ヘッダー

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

リクエストの本文

要求本文には ProductUpgradeRequest リソースが含まれている必要があります。

要求の例

POST https://api.partnercenter.microsoft.com/v1/productupgrades/42d075a4-bfe7-43e7-af6d-7c68a57edcb4/status  HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: c245d5f2-1de3-4ae0-9e42-95e38e3cb8ff
MS-CorrelationId: e3f26e6a-044f-4371-ad52-0d91ce4200be
X-Locale: en-US
MS-PartnerCenter-Application: Partner Center .NET SDK Samples
Content-Type: application/json
Host: api.partnercenter.microsoft.com
Content-Length: 340
Expect: 100-continue
Connection: Keep-Alive
{
 {
    "customerId": "4c721420-72ad-4708-a0a7-371a2f7b0969",
    "productFamily": "azure"
  }
  "Attributes": {
  "ObjectType": "ProductUpgradeRequest"
  }
}

重要

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

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

REST 応答

成功した場合、このメソッドは本文で ProductUpgradesEligibility リソースを返します。

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

各応答には、成功または失敗を示す HTTP ステータスコードと、追加のデバッグ情報が付属しています。このコード、エラーの種類、追加のパラメーターを読み取るには、ネットワークトレースツールを使用します。完全な一覧については、パートナーセンターの REST エラーコードに関する記事を参照してください。

応答の例

HTTP/1.1 200 Ok
Content-Length: 150
MS-CorrelationId: 772871a9-399b-4f3b-b8c7-38f550e4f22a
MS-RequestId: cb82f7d6-f0d9-44d4-82f9-f6eee6e68390
MS-CV: iqOqN0FnaE2y0HcD.0
MS-ServerId: 030020525
Date: Thu, 04 Oct 2019 20:35:35 GMT

{
    "id": "42d075a4-bfe7-43e7-af6d-7c68a57edcb4",
    "status": "Completed",
    "productFamily": "Azure",
    "lineItems": [
        {
            "sourceProduct": {
                "id": "b1beb621-3cad-4d7a-b360-62db33ce028e",
                "name": "AzureSubscription"
            },
            "targetProduct": {
                "id": "d231908e-31c1-de0e-027b-bc5ce11f09d9",
                "name": "Microsoft Azure plan"
            },
            "upgradedDate": "2019-08-29T23:47:28.8524555Z",
            "status": "Completed"
        }
    ]
}