注
クラウドパートナーポータル API は統合されており、パートナーセンターで引き続き動作します。 移行によって、小さな変化がもたらされます。 「Cloud パートナー ポータルの API リファレンス」の中に記載されている変更を確認し、パートナー センターに移行した後も確実にコードが引き続き動作するようにしてください。 CPP APIは、パートナー センターへの移行前にすでに統合されていた既存の製品にのみ使用すべきです。新しい製品には、パートナー センター提出 APIを使用してください。
オファーに対するすべての操作を取得するか、指定した operationId の特定の操作を取得します。 クライアントは、クエリ パラメーターを使用して、実行中の操作をフィルター処理できます。
GET https://cloudpartner.azure.com/api/publishers/<publisherId>/offers/<offerId>/operations/<operationId>?api-version=2017-10-31
URI パラメーター
|
名前 |
説明 |
データ型 |
| パブリッシャーID |
発行元識別子 (例: Contoso |
糸 |
| offerId |
オファー識別子 |
糸 |
| operationId |
オファーに対する操作を一意に識別する GUID。 operationId は、この API を使用して取得でき、 Publish オファー API などの長時間実行操作の応答の HTTP ヘッダーでも返されます。 |
Guid |
| APIバージョン |
APIの最新バージョン |
日付 |
|
名前 |
価値 |
| コンテンツタイプ |
application/json |
| 認証 |
Bearer YOUR_TOKEN |
ボディ例
[応答]
GET 操作
[
{
"id": "5a63deb5-925b-4ee0-938b-7c86fbf287c5",
"offerId": "56615b67-2185-49fe-80d2-c4ddf77bb2e8",
"offerVersion": 1,
"offerTypeId": "microsoft-azure-virtualmachines",
"publisherId": "contoso",
"submissionType": "publish",
"submissionState": "running",
"publishingVersion": 2,
"slot": "staging",
"version": 636576975611768314,
"definition": {
"metadata": {
"emails": "jdoe@contoso.com"
}
},
"changedTime": "2018-03-26T21:46:01.179948Z"
}
]
GET操作
[
{
"status" : "running",
"messages" : [],
"publishingVersion" : 2,
"offerVersion" : 1,
"cancellationRequestState": "canCancel",
"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": "2017-03-28T19:50:36.500052Z"
}
],
"progressPercentage": 100
},
{
"estimatedTimeFrame": "< 5 day",
"id": "displaycertify",
"stepName": "Certification",
"description": "Your offer is analyzed by our certification systems for issues.",
"status": "blocked",
"messages":
[
{
"messageHtml": "No virtual machine image was found for the plan contoso.",
"level": "error",
"timestamp": "2017-03-28T19:50:39.5506018Z"
},
{
"messageHtml": "This step has not started yet.",
"level": "information",
"timestamp": "2017-03-28T19:50:39.5506018Z"
}
],
"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 packaged for being shown to your customers. Additionally, we hookup our lead generation systems to send leads for your offer.",
"status": "notStarted",
"messages": [],
"progressPercentage": 0
},
{
"id": "publisher-signoff",
"stepName": "Publisher signoff",
"description": "Offer is available to preview. Ensure that everything looks good before making your offer live.",
"status": "notStarted",
"messages": [],
"progressPercentage": 0
},
{
"estimatedTimeFrame": "~2-5 days",
"id": "live",
"stepName": "Live",
"description": "Offer is publicly visible and is available for purchase.",
"status": "notStarted",
"messages": [],
"progressPercentage": 0
}
],
"previewLinks": [],
"liveLinks": [],
}
}
]
応答本文のプロパティ
|
名前 |
説明 |
| 身分証明書 |
操作を一意に識別する GUID |
| submissionType (サブミッションタイプ) |
オファーに対して報告される操作のタイプを識別します。例: Publish/GoLive |
| createdDateTime |
操作が作成された UTC 日時 |
| 最終アクション日時 |
操作で最後の更新が行われた UTC 日時 |
| ステータス |
操作のステータス ( not started | running | failed | completed)。 一度にステータス running を持つことができる操作は 1 つだけです。 |
| エラー |
失敗した操作のエラーメッセージ |
応答ステップのプロパティ
|
名前 |
説明 |
| 推定タイムフレーム |
この操作の推定所要時間 |
| 身分証明書 |
ステッププロセスの一意の識別子 |
| 説明 |
ステップの説明 |
| ステップ名 |
ステップのフレンドリ名 |
| ステータス |
ステップのステータス (次のいずれか) notStarted | running | failed | completed |
| メッセージ |
ステップ中に発生した通知または警告。 文字列の配列 |
| progressPercentage (進行状況) |
ステップの進行を示す 0 から 100 までの整数 |
応答ステータスコード
|
コード |
説明 |
| 200 |
OK - 要求は正常に処理され、要求された操作が返されました。 |
| 400 |
Bad/Malformed request - エラー応答本文には、より多くの情報が含まれている場合があります。 |
| 403 |
Forbidden - クライアントは、指定された名前空間にアクセスできません。 |
| 404 |
Not found - 指定されたエンティティが存在しません。 |