特定のプランの取得
Note
Cloud パートナー ポータル API はパートナー センターと統合されており、引き続き機能します。 切り替えにより、小さな変更が加えられました。 「Cloud パートナー ポータルの API リファレンス」に記載されている変更内容を調べて、パートナー センターへの切り替え後もコードが引き続き動作することを確認してください。 CPP API は、パートナー センターへの切り替え前に既に統合されている既存の製品に対してのみ使用してください。新しい製品では、パートナー センター申請 API を使用する必要があります。
発行元の名前空間内で指定のプランが取得されます。
特定のバージョンのプランを取得したり、ドラフト、ビュー、運用スロットのプランを取得したりすることもできます。 スロットが指定されていない場合、既定値は draft. プレビューまたは発行されていないオファーを取得しようとすると、エラーが発生 404 Not Found します。
警告
シークレット型フィールドのシークレット値はこの API では取得されません。
GET https://cloudpartner.azure.com/api/publishers/<publisherId>/offers/<offerId>?api-version=2017-10-3
URI パラメーター
| 名前 | 説明 | データの種類 |
|---|---|---|
| publisherId | 発行元の ID。 たとえば、Contoso です。 | String |
| offerId | プランを一意に識別する GUID。 | String |
| version | 取得されるプランのバージョン。 既定では、最新版のプランが取得されます。 | 整数型 |
| slotId | オファーの取得元となるスロットは、次のいずれかになります。 - Draft (既定) の場合、現在ドラフトの状態にあるプランが取得されます。 - Preview の場合、現在プレビューの状態にあるプランが取得されます。 - Production の場合、現在運用の状態にあるプランが取得されます。 |
enum |
| api-version | API の最新バージョン | 日 |
ヘッダー
| 名前 | Value |
|---|---|
| Content-Type | application/json |
| 承認 | Bearer YOUR_TOKEN |
本文の例
回答
{
"offerTypeId": "microsoft-azure-virtualmachines",
"publisherId": "contoso",
"status": "failed",
"id": "059afc24-07de-4126-b004-4e42a51816fe",
"version": 5,
"definition": {
"displayText": "Contoso Virtual Machine Offer",
"offer": {
"microsoft-azure-marketplace-testdrive.enabled": false,
"microsoft-azure-marketplace-testdrive.videos": [],
"microsoft-azure-marketplace.title": "Contoso App",
"microsoft-azure-marketplace.summary": "Contoso App makes dev ops a breeze",
"microsoft-azure-marketplace.longSummary": "Contoso App makes dev ops a breeze",
"microsoft-azure-marketplace.description": "Contoso App makes dev ops a breeze",
"microsoft-azure-marketplace.offerMarketingUrlIdentifier": "contosoapp",
"microsoft-azure-marketplace.allowedSubscriptions": [
"59160c40-2e25-4dcf-a2fd-6514cb08bf08"
],
"microsoft-azure-marketplace.usefulLinks": [
{
"linkTitle": "Contoso App for Azure",
"linkUrl": "https://azuremarketplace.microsoft.com"
}
],
"microsoft-azure-marketplace.categoryMap": [
{
"categoryL1": "analytics",
"categoryL2-analytics": [
"visualization-and-reporting"
]
},
{
"categoryL1": "ai-plus-machine-learning",
"categoryL2-ai-plus-machine-learning": [
"bot-services",
"cognitive-services",
"other"
]
}
],
"microsoft-azure-marketplace.smallLogo": "https://publishingapistore.blob.core.windows.net/testcontent/D6191_publishers_contoso/contosovirtualmachine/6218c455-9cbc-450c-9920-f2e7a69ee132.png?sv=2014-02-14&sr=b&sig=6O8MM9dgiJ48VK0MwddkyVbprRAnBszyhVkVHGShhkI%3D&se=2019-03-28T19%3A46%3A50Z&sp=r",
"microsoft-azure-marketplace.mediumLogo": "https://publishingapistore.blob.core.windows.net/testcontent/D6191_publishers_contoso/contosovirtualmachine/557e714b-2f31-4e12-b0cc-e48dd840edf4.png?sv=2014-02-14&sr=b&sig=NwL67NTQf9Gc9VScmZehtbHXpYmxhwZc2foy3o4xavs%3D&se=2019-03-28T19%3A46%3A49Z&sp=r",
"microsoft-azure-marketplace.largeLogo": "https://publishingapistore.blob.core.windows.net/testcontent/D6191_publishers_contoso/contosovirtualmachine/142485da-784c-44cb-9523-d4f396446258.png?sv=2014-02-14&sr=b&sig=xaMxhwx%2FlKYfz33mJGIg8UBdVpsOwVvqhjTJ883o0iY%3D&se=2019-03-28T19%3A46%3A49Z&sp=r",
"microsoft-azure-marketplace.wideLogo": "https://publishingapistore.blob.core.windows.net/testcontent/D6191_publishers_contoso/contosovirtualmachine/48af9013-1df7-4c94-8da8-4626e5039ce0.png?sv=2014-02-14&sr=b&sig=%2BnN7f2tprkrqb45ID6JlT01zXcy1PMTkWXtLKD6nfoE%3D&se=2019-03-28T19%3A46%3A49Z&sp=r",
"microsoft-azure-marketplace.screenshots": [],
"microsoft-azure-marketplace.videos": [],
"microsoft-azure-marketplace.leadDestination": "None",
"microsoft-azure-marketplace.tableLeadConfiguration": {},
"microsoft-azure-marketplace.blobLeadConfiguration": {},
"microsoft-azure-marketplace.salesForceLeadConfiguration": {},
"microsoft-azure-marketplace.crmLeadConfiguration": {},
"microsoft-azure-marketplace.httpsEndpointLeadConfiguration": {},
"microsoft-azure-marketplace.marketoLeadConfiguration": {},
"microsoft-azure-marketplace.privacyURL": "https://azuremarketplace.microsoft.com",
"microsoft-azure-marketplace.termsOfUse": "Terms of use",
"microsoft-azure-marketplace.engineeringContactName": "Jon Doe",
"microsoft-azure-marketplace.engineeringContactEmail": "jondoe@outlook.com",
"microsoft-azure-marketplace.engineeringContactPhone": "555-555-5555",
"microsoft-azure-marketplace.supportContactName": "Jon Doe",
"microsoft-azure-marketplace.supportContactEmail": "jondoe@outlook.com",
"microsoft-azure-marketplace.supportContactPhone": "555-555-5555",
"microsoft-azure-marketplace.publicAzureSupportUrl": "",
"microsoft-azure-marketplace.fairfaxSupportUrl": ""
},
"plans": [
{
"planId": "contososkuidentifier",
"microsoft-azure-virtualmachines.skuTitle": "Contoso App",
"microsoft-azure-virtualmachines.skuSummary": "Contoso App makes dev ops a breeze.",
"microsoft-azure-virtualmachines.skuDescription": "This is a description for the Contoso App that makes dev ops a breeze.",
"microsoft-azure-virtualmachines.hideSKUForSolutionTemplate": false,
"microsoft-azure-virtualmachines.cloudAvailability": [
"PublicAzure"
],
"microsoft-azure-virtualmachines.certificationsFairfax": [],
"virtualMachinePricing": {
"isByol": true,
"freeTrialDurationInMonths": 0
},
"microsoft-azure-virtualmachines.operatingSystemFamily": "Windows",
"microsoft-azure-virtualmachines.windowsOSType": "Other",
"microsoft-azure-virtualmachines.operationSystem": "Contoso App",
"microsoft-azure-virtualmachines.recommendedVMSizes": [
"a0-basic",
"a0-standard",
"a1-basic",
"a1-standard",
"a2-basic",
"a2-standard"
],
"microsoft-azure-virtualmachines.openPorts": [],
"microsoft-azure-virtualmachines.vmImages": {
"1.0.1": {
"osVhdUrl": "http://contosoteststorage.blob.core.windows.net/test/contosoVM.vhd?sv=2014-02-14&sig=WlDo6Q4xwYH%2B5QEJbItPUVdgHhBcrVxPBmntZ2vU96w%3D&st=2016-06-25T18%3A30%3A00Z&se=2017-06-25T18%3A30%3A00Z&sp=rl",
"lunVhdDetails": []
}
},
"regions": [
"DZ",
"AR"
]
}
]
},
"changedTime": "2017-06-07T06:15:39.7349221Z"
}
}
応答本文のプロパティ
| 名前 | 説明 |
|---|---|
| offerTypeId | オファーの種類を示します |
| publisherId | 発行元の一意の識別子。 |
| status | オファーの状態。 使用可能な値の一覧については、「プランの状態」を参照してください。 |
| Id | プランを一意に識別する GUID |
| version | オファーの現在のバージョン。 version プロパティは、クライアントによって変更できません。 発行のたびにインクリメントされます。 |
| definition | ワークロードの実際の定義 |
| changedTime | プランが最後に修正されたときの UTC 日時 |
応答状態コード
| コード | 説明 |
|---|---|
| 200 | OK - 要求が正常に処理され、発行元のすべてのオファーがクライアントに返されました。 |
| 400 | Bad/Malformed request - エラー応答本文には、より多くの情報が含まれている場合があります。 |
| 403 | Forbidden - クライアントは、指定の名前空間にアクセスできません。 |
| 404 | Not found - 指定のエンティティが存在しません。 クライアントでは、発行元 ID、プラン ID、バージョン (指定されている場合) の確認が求められます。 |
オファーの状態
| 名前 | 説明 |
|---|---|
| NeverPublished | オファーは発行されていません。 |
| NotStarted | オファーは新規ですが、開始されていません。 |
| WaitingForPublisherReview | オファーは発行元の承認を待っています。 |
| 実行中 | オファー提出が処理されています。 |
| Succeeded | オファーの申請処理が完了しました。 |
| 取り消し済み | オファー提出が取り消されました。 |
| Failed | オファーを提出できませんでした。 |
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示