次の方法で共有


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=2025-04-01

URI パラメーター

名前 / 必須 説明
location
path True

string

minLength: 1

Azure リージョンの名前。

offer
path True

string

有効なイメージ パブリッシャー オファー。

publisherName
path True

string

有効なイメージ発行元。

skus
path True

string

有効な画像 SKU。

subscriptionId
path True

string

minLength: 1

ターゲット サブスクリプションの ID。

version
path True

string

有効なイメージ SKU バージョン。

api-version
query True

string

minLength: 1

この操作に使用する API バージョン。

応答

名前 説明
200 OK

VirtualMachineImage

Azure 操作は正常に完了しました。

Other Status Codes

CloudError

予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントを偽装する

VirtualMachineImage_Get_MaximumSet_Gen
VirtualMachineImage_Get_MinimumSet_Gen

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=2025-04-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

要求のサンプル

GET https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Compute/locations/aaaaaaaaaaaa/publishers/aaaaaaaaaaa/artifacttypes/vmimage/offers/aa/skus/aaaaaaaaa/versions/aaaaaaaaaaaaaaaaaaaaaaaaaaaaa?api-version=2025-04-01

応答のサンプル

{
  "name": "aaaaaaaaa",
  "location": "aaaaa",
  "id": "aaaaaaaaaaa"
}

定義

名前 説明
AlternativeOption

このイメージが非推奨になったときに、このイメージに対してパブリッシャーによって指定される代替オプションについて説明します。

AlternativeType

代替オプションのタイプについて説明します。

ApiError

API エラー。

ApiErrorBase

API エラー ベース。

ArchitectureTypes

アーキテクチャタイプを指定します。

AutomaticOSUpgradeProperties

イメージの OS 自動アップグレード プロパティについて説明します。

CloudError

コンピュート・サービスからのエラー・レスポンス。

DataDiskImage

データディスクイメージ情報が含まれます。

DisallowedConfiguration

仮想マシンイメージの許可されていない構成を指定します。

ExtendedLocation

拡張された場所の複合型。

ExtendedLocationTypes

拡張された場所の種類。

HyperVGenerationTypes

HyperVGeneration タイプを指定します。

ImageDeprecationStatus

イメージのイメージの非推奨状態プロパティについて説明します。

ImageState

イメージの状態を記述します。

InnerError

内部エラーの詳細。

OperatingSystemTypes

このプロパティを使用すると、ユーザー イメージまたは特殊化された VHD から VM を作成する場合に、ディスクに含まれる OS の種類を指定できます。 使用可能な値は、Windows Linuxです。

OSDiskImage

OS ディスクイメージ情報が含まれます。

PurchasePlan

MarketPlaceを介してサードパーティアーティファクトの購入コンテキストを確立するために使用されます。

VirtualMachineImage

仮想マシンイメージについて説明します。

VirtualMachineImageFeature

イメージでサポートされる追加機能を指定します

VmDiskTypes

許可されていない VM ディスクの種類。

AlternativeOption

このイメージが非推奨になったときに、このイメージに対してパブリッシャーによって指定される代替オプションについて説明します。

名前 説明
type

AlternativeType

代替オプションのタイプについて説明します。

value

string

パブリッシャーによって指定された代替オプション値を示します。 これは、タイプが [オファー] の場合は [オファー名] で、タイプが [プラン] の場合はプラン名です。

AlternativeType

代替オプションのタイプについて説明します。

説明
None
Offer
Plan

ApiError

API エラー。

名前 説明
code

string

エラー コード。

details

ApiErrorBase[]

Api エラーの詳細

innererror

InnerError

Api 内部エラー

message

string

エラー メッセージ。

target

string

特定のエラーのターゲット。

ApiErrorBase

API エラー ベース。

名前 説明
code

string

エラー コード。

message

string

エラー メッセージ。

target

string

特定のエラーのターゲット。

ArchitectureTypes

アーキテクチャタイプを指定します。

説明
x64
Arm64

AutomaticOSUpgradeProperties

イメージの OS 自動アップグレード プロパティについて説明します。

名前 説明
automaticOSUpgradeSupported

boolean

イメージで OS の自動アップグレードをサポートするかどうかを指定します。

CloudError

コンピュート・サービスからのエラー・レスポンス。

名前 説明
error

ApiError

API エラー。

DataDiskImage

データディスクイメージ情報が含まれます。

名前 説明
lun

integer (int32)

データ ディスクの論理ユニット番号を指定します。 この値は、VM 内のデータ ディスクを識別するために使用されるため、VM に接続されているデータ ディスクごとに一意である必要があります。

DisallowedConfiguration

仮想マシンイメージの許可されていない構成を指定します。

名前 説明
vmDiskType

VmDiskTypes

許可されていない VM ディスクの種類。

ExtendedLocation

拡張された場所の複合型。

名前 説明
name

string

拡張された場所の名前。

type

ExtendedLocationTypes

拡張された場所の種類。

ExtendedLocationTypes

拡張された場所の種類。

説明
EdgeZone

HyperVGenerationTypes

HyperVGeneration タイプを指定します。

説明
V1
V2

ImageDeprecationStatus

イメージのイメージの非推奨状態プロパティについて説明します。

名前 説明
alternativeOption

AlternativeOption

このイメージが非推奨になったときに、このイメージに対してパブリッシャーによって指定される代替オプションについて説明します。

imageState

ImageState

イメージの状態を記述します。

scheduledDeprecationTime

string (date-time)

将来、このイメージが非推奨としてマークされる時刻。 このスケジュールされた時刻は、パブリッシャーによって選択されます。

ImageState

イメージの状態を記述します。

説明
Active
ScheduledForDeprecation
Deprecated

InnerError

内部エラーの詳細。

名前 説明
errordetail

string

内部エラー・メッセージまたは例外ダンプ。

exceptiontype

string

例外タイプ。

OperatingSystemTypes

このプロパティを使用すると、ユーザー イメージまたは特殊化された VHD から VM を作成する場合に、ディスクに含まれる OS の種類を指定できます。 使用可能な値は、Windows Linuxです。

説明
Windows
Linux

OSDiskImage

OS ディスクイメージ情報が含まれます。

名前 説明
operatingSystem

OperatingSystemTypes

osDiskImage のオペレーティングシステム。

PurchasePlan

MarketPlaceを介してサードパーティアーティファクトの購入コンテキストを確立するために使用されます。

名前 説明
name

string

プラン ID。

product

string

マーケットプレースからのイメージの製品を指定します。 これは、imageReference 要素の下の Offer と同じ値です。

publisher

string

発行元 ID。

VirtualMachineImage

仮想マシンイメージについて説明します。

名前 説明
extendedLocation

ExtendedLocation

仮想マシンの拡張された場所。

id

string

リソース ID

location

string

リソースのサポートされている Azure の場所。

name

string

リソースの名前。

properties.architecture

ArchitectureTypes

アーキテクチャタイプを指定します。

properties.automaticOSUpgradeProperties

AutomaticOSUpgradeProperties

イメージの OS 自動アップグレード プロパティについて説明します。

properties.dataDiskImages

DataDiskImage[]

データディスクイメージ情報のリスト。

properties.disallowed

DisallowedConfiguration

イメージから作成された仮想マシンに対して許可されていない構成を指定します

properties.features

VirtualMachineImageFeature[]

イメージでサポートされる追加機能を指定します

properties.hyperVGeneration

HyperVGenerationTypes

HyperVGeneration タイプを指定します。

properties.imageDeprecationStatus

ImageDeprecationStatus

イメージのイメージの非推奨状態プロパティについて説明します。

properties.osDiskImage

OSDiskImage

OS ディスクイメージ情報が含まれます。

properties.plan

PurchasePlan

MarketPlaceを介してサードパーティアーティファクトの購入コンテキストを確立するために使用されます。

tags

object

仮想マシンに割り当てられるタグを指定します。 タグの使用の詳細については、「 タグを使用した Azure リソースの整理」を参照してください。

VirtualMachineImageFeature

イメージでサポートされる追加機能を指定します

名前 説明
name

string

機能の名前。

value

string

フィーチャーに対応する値。

VmDiskTypes

許可されていない VM ディスクの種類。

説明
None
Unmanaged