オファーを取得する

Note

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

パブリッシャーの名前空間に含まれるオファーを要約した一覧を取得します。

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

URI パラメーター

名前 説明 データの種類
publisherId パブリッシャー ID。たとえば、contoso String
api-version API の最新バージョン
名前 Value
Content-Type application/json
承認 Bearer YOUR_TOKEN

本文の例

回答

  200 OK 
  [ 
      {  
          "offerTypeId": "microsoft-azure-virtualmachines",
          "publisherId": "contoso",
          "status": "published",
          "id": "059afc24-07de-4126-b004-4e42a51816fe",
          "version": 1,
          "definition": {
              "displayText": "Contoso Virtual Machine"
          },
          "changedTime":"2017-05-23T23:33:47.8802283Z"
      }
  ]

応答本文のプロパティ

名前 説明
offerTypeId オファーの種類を示します
publisherId パブリッシャーを一意に示す ID
status オファーの状態。 使用可能な値の一覧については、下の「オファーの状態」を参照してください。
ID パブリッシャーの名前空間内のオファーを一意に示す GUID。
version オファーの現在のバージョン。 version プロパティは、クライアントによって変更できません。 発行のたびにインクリメントされます。
definition ワークロードの実際の定義の要約ビューが含まれます。 詳細な定義を取得するには、Retrieve specific offer API を使用します。
changedTime オファーが最後に変更されたときの UTC 日時

応答状態コード

コード 説明
200 OK - 要求が正常に処理され、発行元のすべてのオファーがクライアントに返されました。
400 Bad/Malformed request - エラー応答本文には、より多くの情報が含まれている場合があります。
403 Forbidden - クライアントは、指定の名前空間にアクセスできません。
404 Not found - 指定のエンティティが存在しません。

オファーの状態

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