Virtual Machine Images - Get
仮想マシン イメージを取得します。
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}?api-version=2024-07-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
location
|
path | True |
string |
サポートされている Azure リージョンの名前。 |
offer
|
path | True |
string |
有効なイメージ発行元オファー。 |
publisher
|
path | True |
string |
有効なイメージ発行元。 |
skus
|
path | True |
string |
有効なイメージ SKU。 |
subscription
|
path | True |
string |
Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。 |
version
|
path | True |
string |
有効なイメージ SKU バージョン。 |
api-version
|
query | True |
string |
クライアント API のバージョン。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
わかりました |
|
Other Status Codes |
操作が失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントを偽装する |
例
Virtual |
Virtual |
VirtualMachineImage_Get_MaximumSet_Gen
要求のサンプル
GET https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Compute/locations/aaaaaa/publishers/aaa/artifacttypes/vmimage/offers/aaaaaaaaaaaaaaaaaaaaaaaaaaaaa/skus/aaaaaaaaaaaaaaaaaaaaaaaaaaa/versions/aaaaaaaaaaaaaaaaaaa?api-version=2024-07-01
応答のサンプル
{
"properties": {
"plan": {
"publisher": "aaaaaaaaaaaaaaaaaaa",
"name": "aaaaaaaaa",
"product": "aaaaaaaaaaaaaa"
},
"osDiskImage": {
"operatingSystem": "Windows"
},
"dataDiskImages": [
{
"lun": 17
}
],
"automaticOSUpgradeProperties": {
"automaticOSUpgradeSupported": true
},
"hyperVGeneration": "V1",
"disallowed": {
"vmDiskType": "None"
},
"features": [
{
"name": "aaaaaaaaaaaaaaaaaaaaa",
"value": "aaaaaaaaaaaaaaaaaaaa"
}
],
"imageDeprecationStatus": {
"imageState": "ScheduledForDeprecation",
"scheduledDeprecationTime": "2023-01-13T00:00:00+00:00",
"alternativeOption": {
"type": "Offer",
"value": "aaaaaaa"
}
}
},
"name": "aaaaaaaaa",
"location": "aaaaa",
"tags": {
"key6817": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"extendedLocation": {
"name": "aaaaaaaaaaaaaaaaaaaaa",
"type": "EdgeZone"
},
"id": "aaaaaaaaaaa"
}
VirtualMachineImage_Get_MinimumSet_Gen
要求のサンプル
応答のサンプル
{
"name": "aaaaaaaaa",
"location": "aaaaa",
"id": "aaaaaaaaaaa"
}
定義
名前 | 説明 |
---|---|
Alternative |
このイメージが非推奨になった場合に、パブリッシャーによってこのイメージに対して指定された代替オプションについて説明します。 |
Alternative |
代替オプションの種類について説明します。 |
Api |
API エラー。 |
Api |
API エラーベース。 |
Architecture |
アーキテクチャの種類を指定します |
Automatic |
イメージの OS の自動アップグレード プロパティについて説明します。 |
Cloud |
コンピューティング サービスからのエラー応答。 |
Data |
データ ディスク イメージ情報を格納します。 |
Disallowed |
仮想マシン イメージの許可されていない構成を指定します。 |
Extended |
拡張された場所の複合型。 |
Extended |
拡張された場所の型。 |
Hyper |
HyperVGeneration の種類を指定します。 |
Image |
イメージの非推奨状態プロパティについて説明します。 |
Image |
イメージの状態について説明します。 |
Inner |
内部エラーの詳細。 |
Operating |
osDiskImage のオペレーティング システム。 |
OSDisk |
os ディスク イメージの情報が含まれています。 |
Purchase |
MarketPlace を通じてサード パーティの成果物の購入コンテキストを確立するために使用されます。 |
Virtual |
仮想マシン イメージについて説明します。 |
Virtual |
イメージでサポートされる追加機能を指定します |
Vm |
許可されていない VM ディスクの種類。 |
AlternativeOption
このイメージが非推奨になった場合に、パブリッシャーによってこのイメージに対して指定された代替オプションについて説明します。
名前 | 型 | 説明 |
---|---|---|
type |
代替オプションの種類について説明します。 |
|
value |
string |
パブリッシャーによって指定された代替オプション値を示します。 種類がプランの場合はプラン名、種類がプランの場合はプラン名です。 |
AlternativeType
代替オプションの種類について説明します。
名前 | 型 | 説明 |
---|---|---|
None |
string |
|
Offer |
string |
|
Plan |
string |
ApiError
API エラー。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
details |
Api エラーの詳細 |
|
innererror |
Api 内部エラー |
|
message |
string |
エラー メッセージ。 |
target |
string |
特定のエラーのターゲット。 |
ApiErrorBase
API エラーベース。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
message |
string |
エラー メッセージ。 |
target |
string |
特定のエラーのターゲット。 |
ArchitectureTypes
アーキテクチャの種類を指定します
名前 | 型 | 説明 |
---|---|---|
Arm64 |
string |
|
x64 |
string |
AutomaticOSUpgradeProperties
イメージの OS の自動アップグレード プロパティについて説明します。
名前 | 型 | 説明 |
---|---|---|
automaticOSUpgradeSupported |
boolean |
イメージで OS の自動アップグレードをサポートするかどうかを指定します。 |
CloudError
コンピューティング サービスからのエラー応答。
名前 | 型 | 説明 |
---|---|---|
error |
API エラー。 |
DataDiskImage
データ ディスク イメージ情報を格納します。
名前 | 型 | 説明 |
---|---|---|
lun |
integer |
データ ディスクの論理ユニット番号を指定します。 この値は、VM 内のデータ ディスクを識別するために使用されるため、VM に接続されているデータ ディスクごとに一意である必要があります。 |
DisallowedConfiguration
仮想マシン イメージの許可されていない構成を指定します。
名前 | 型 | 説明 |
---|---|---|
vmDiskType |
許可されていない VM ディスクの種類。 |
ExtendedLocation
拡張された場所の複合型。
名前 | 型 | 説明 |
---|---|---|
name |
string |
拡張された場所の名前。 |
type |
拡張された場所の型。 |
ExtendedLocationTypes
拡張された場所の型。
名前 | 型 | 説明 |
---|---|---|
EdgeZone |
string |
HyperVGenerationTypes
HyperVGeneration の種類を指定します。
名前 | 型 | 説明 |
---|---|---|
V1 |
string |
|
V2 |
string |
ImageDeprecationStatus
イメージの非推奨状態プロパティについて説明します。
名前 | 型 | 説明 |
---|---|---|
alternativeOption |
このイメージが非推奨になった場合に、パブリッシャーによってこのイメージに対して指定された代替オプションについて説明します。 |
|
imageState |
イメージの状態について説明します。 |
|
scheduledDeprecationTime |
string |
このイメージが非推奨としてマークされる将来の時刻。 このスケジュールされた時刻は、パブリッシャーによって選択されます。 |
ImageState
イメージの状態について説明します。
名前 | 型 | 説明 |
---|---|---|
Active |
string |
|
Deprecated |
string |
|
ScheduledForDeprecation |
string |
InnerError
内部エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
errordetail |
string |
内部エラー メッセージまたは例外ダンプ。 |
exceptiontype |
string |
例外の種類。 |
OperatingSystemTypes
osDiskImage のオペレーティング システム。
名前 | 型 | 説明 |
---|---|---|
Linux |
string |
|
Windows |
string |
OSDiskImage
os ディスク イメージの情報が含まれています。
名前 | 型 | 説明 |
---|---|---|
operatingSystem |
osDiskImage のオペレーティング システム。 |
PurchasePlan
MarketPlace を通じてサード パーティの成果物の購入コンテキストを確立するために使用されます。
名前 | 型 | 説明 |
---|---|---|
name |
string |
プラン ID。 |
product |
string |
マーケットプレースからのイメージの製品を指定します。 これは、imageReference 要素の下の Offer と同じ値です。 |
publisher |
string |
発行元 ID。 |
VirtualMachineImage
仮想マシン イメージについて説明します。
名前 | 型 | 説明 |
---|---|---|
extendedLocation |
仮想マシンの拡張された場所。 |
|
id |
string |
リソース ID |
location |
string |
サポートされているリソースの Azure の場所。 |
name |
string |
リソースの名前。 |
properties.architecture |
アーキテクチャの種類を指定します |
|
properties.automaticOSUpgradeProperties |
イメージの OS の自動アップグレード プロパティについて説明します。 |
|
properties.dataDiskImages |
データ ディスク イメージ情報を格納します。 |
|
properties.disallowed |
イメージから作成された VirtualMachine の許可されていない構成を指定します |
|
properties.features |
イメージでサポートされる追加機能を指定します |
|
properties.hyperVGeneration |
HyperVGeneration の種類を指定します。 |
|
properties.imageDeprecationStatus |
イメージの非推奨状態プロパティについて説明します。 |
|
properties.osDiskImage |
os ディスク イメージの情報が含まれています。 |
|
properties.plan |
MarketPlace を通じてサード パーティの成果物の購入コンテキストを確立するために使用されます。 |
|
tags |
object |
仮想マシンに割り当てられるタグを指定します。 タグの使用の詳細については、「タグを使用した Azure リソースのの整理」を参照してください。 |
VirtualMachineImageFeature
イメージでサポートされる追加機能を指定します
名前 | 型 | 説明 |
---|---|---|
name |
string |
機能の名前。 |
value |
string |
機能の対応する値。 |
VmDiskTypes
許可されていない VM ディスクの種類。
名前 | 型 | 説明 |
---|---|---|
None |
string |
|
Unmanaged |
string |