プランの状態の取得

[アーティクル]
04/30/2024

Note

Cloud パートナーポータル API はパートナーセンターと統合されており、引き続き機能します。切り替えにより、小さな変更が加えられました。「Cloud パートナーポータルの API リファレンス」に記載されている変更内容を調べて、パートナーセンターへの切り替え後もコードが引き続き動作することを確認してください。 CPP API は、パートナーセンターへの切り替え前に既に統合されている既存の製品に対してのみ使用してください。新しい製品では、パートナーセンター申請 API を使用する必要があります。

プランの現在の状態が取得されます。

GET https://cloudpartner.azure.com/api/publishers/<publisherId>/offers/<offerId>/status?api-version=2017-10-31

URI パラメーター

名前	説明	データの種類
publisherId	パブリッシャー ID。たとえば、`Contoso`	String
offerId	プランを一意に識別する GUID	String
api-version	API の最新バージョン	日

名前	Value
コンテンツタイプ	`application/json`
承認	`Bearer YOUR_TOKEN`

本文の例

回答

  {
      "status": "succeeded",
      "messages": [],
      "steps": [
      {
          "estimatedTimeFrame": "< 15 min",
          "id": "displaydummycertify",
          "stepName": "Validate Pre-Requisites",
          "description": "Offer settings provided are validated.",
          "status": "complete",
          "messages": [
              {
                  "messageHtml": "Step completed.",
                  "level": "information",
                  "timestamp": "2018-03-16T17:50:45.7215661Z"
              }
          ],       
          "progressPercentage": 100
      },
      {
          "estimatedTimeFrame": "~2-3 days",
          "id": "displaycertify",
          "stepName": "Certification",
          "description": "Your offer is analyzed by our certification systems for issues.",
          "status": "notStarted",
          "messages": [],
          "progressPercentage": 0
      },
      {
          "estimatedTimeFrame": "< 1 day",
          "id": "displayprovision",
          "stepName": "Provisioning",
          "description": "Your virtual machine is being replicated in our production systems.",
          "status": "notStarted",
          "messages": [],
          "progressPercentage": 0
      },
      {
          "estimatedTimeFrame": "< 1 hour",
          "id": "displaypackage",
          "stepName": "Packaging and Lead Generation Registration",
          "description": "Your virtual machine is being packaged for customers. Additionally, lead systems are being configured and set up.",
          "status": "notStarted",
          "messages": [],
          "progressPercentage": 0
      },
      {
          "estimatedTimeFrame": "< 1 hour",
          "id": "publisher-signoff",
          "stepName": "Publisher signoff",
          "description": "Offer is available to preview. Ensure that everything looks good before making your offer live.",
          "status": "complete",
          "messages": [],
          "progressPercentage": 0
      },
      {
          "estimatedTimeFrame": "~2-5 days",
          "id": "live",
          "stepName": "Live",
          "description": "Offer is publicly visible and is available for purchase.",
          "status": "complete",
          "messages": [],
          "progressPercentage": 0
      }
      ],
      "previewLinks": [],
      liveLinks": [],
  }

応答本文のプロパティ

名前	説明
status	プランの状態。使用可能な値の一覧については、下の「オファーの状態」を参照してください。
メッセージ	プランに関連付けられている一連のメッセージ
steps	プラン発行時にプランが受ける一連の手順
estimatedTimeFrame	この手順の完了に必要な時間の見積もり。わかりやすい形式
ID	手順の識別子
stepName	手順の名前
description	手順の説明
status	手順の状態。使用可能な値の一覧については、下の「手順の状態」を参照してください。
メッセージ	手順に関連付けられている一連のメッセージ
processPercentage	手順の完了率
previewLinks	現在、実装されていません
liveLinks	現在、実装されていません
notificationEmails	パートナーセンターに移行されるプランでは非推奨となりました。移行されるプランの通知メールは、[アカウント設定] の販売者の連絡先情報で指定された電子メールに送信されます。移行されないプランの場合、操作の進捗状況を通知するメールアドレスのコンマ区切りの一覧です

応答状態コード

コード	説明
200	`OK` - 要求が正常に処理され、プランの現在の状態が返されました。
400	`Bad/Malformed request` - エラー応答本文には、より多くの情報が含まれている場合があります。
404	`Not found` - 指定のエンティティが存在しません。

オファーの状態

名前	説明
NeverPublished	オファーは発行されていません。
NotStarted	新しいオファーですが、開始されていません。
WaitingForPublisherReview	オファーは発行元の承認を待っています。
実行中	オファー提出が処理されています。
Succeeded	オファー提出の処理が完了しています。
取り消し済み	オファー提出が取り消されました。
Failed	オファーを提出できませんでした。

手順の状態

名前	説明
NotStarted	手順が開始されていません。
InProgress	手順を実行しています。
WaitingForPublisherReview	手順は発行元の承認を待っています。
WaitingForApproval	手順はプロセスの承認を待っています。
ブロック	手順はブロックされています。
拒否	手順は拒否されています。
完了	手順は完了しました。
取り消し済み	手順は取り消されました。

次の方法で共有