Virtual Machine Images - Get

Dienst:: Compute

API-Version:: 2025-04-01

Ruft ein Image der virtuellen Maschine ab.

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-Parameter

Name	In	Erforderlich	Typ	Beschreibung
location	path	True	string minLength: 1	Der Name der Azure-Region.
offer	path	True	string	Ein gültiges Angebot des Bildherausgebers.
publisherName	path	True	string	Ein gültiger Bildherausgeber.
skus	path	True	string	Eine gültige Image-SKU.
subscriptionId	path	True	string minLength: 1	Hierbei handelt es sich um die ID des Zielabonnements.
version	path	True	string	Eine gültige Image-SKU-Version.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	VirtualMachineImage	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	CloudError	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

VirtualMachineImage_Get_MaximumSet_Gen

VirtualMachineImage_Get_MinimumSet_Gen

VirtualMachineImage_Get_MaximumSet_Gen

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "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

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

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

Definitionen

Name	Beschreibung
AlternativeOption	Beschreibt die alternative Option, die vom Verleger für dieses Image angegeben wird, wenn dieses Image veraltet ist.
AlternativeType	Beschreibt den Typ der alternativen Option.
ApiError	API-Fehler.
ApiErrorBase	API-Fehlerbasis.
ArchitectureTypes	Gibt den Architekturtyp an
AutomaticOSUpgradeProperties	Beschreibt die Eigenschaften für automatische Betriebssystemupgrades auf dem Image.
CloudError	Eine Fehlerantwort vom Compute-Dienst.
DataDiskImage	Enthält die Informationen zu den Datenträgerabbildern.
DisallowedConfiguration	Gibt die nicht zulässige Konfiguration für ein VM-Image an.
ExtendedLocation	Der komplexe Typ des erweiterten Standorts.
ExtendedLocationTypes	Der Typ des erweiterten Speicherorts.
HyperVGenerationTypes	Gibt den HyperVGeneration-Typ an
ImageDeprecationStatus	Beschreibt die Statuseigenschaften von Bildern für das Image.
ImageState	Beschreibt den Status des Abbilds.
InnerError	Innere Fehlerdetails.
OperatingSystemTypes	Mit dieser Eigenschaft können Sie den Typ des Betriebssystems angeben, das auf dem Datenträger enthalten ist, wenn sie einen virtuellen Computer aus einem benutzerdefinierten Image erstellen. Mögliche Werte sind: Windows,Linux.
OSDiskImage	Enthält die Informationen zum Betriebssystem-Disk-Image.
PurchasePlan	Wird verwendet, um den Kaufkontext eines Artefakts von Drittanbietern über MarketPlace zu ermitteln.
VirtualMachineImage	Beschreibt ein Image einer virtuellen Maschine.
VirtualMachineImageFeature	Gibt zusätzliche Funktionen an, die vom Image unterstützt werden
VmDiskTypes	VM-Datenträgertypen, die nicht zulässig sind.

AlternativeOption

Objekt

Beschreibt die alternative Option, die vom Verleger für dieses Image angegeben wird, wenn dieses Image veraltet ist.

Name	Typ	Beschreibung
type	AlternativeType	Beschreibt den Typ der alternativen Option.
value	string	Gibt den vom Verleger angegebenen alternativen Optionswert an. Dies ist der Name des Angebots, wenn der Typ "Angebot" ist, oder der Name des Plans, wenn der Typ "Plan" ist.

AlternativeType

Enumeration

Beschreibt den Typ der alternativen Option.

Wert	Beschreibung
None
Offer
Plan

ApiError

Objekt

API-Fehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	ApiErrorBase[]	Die Details zum API-Fehler
innererror	InnerError	Der innere API-Fehler
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

ApiErrorBase

Objekt

API-Fehlerbasis.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

ArchitectureTypes

Enumeration

Gibt den Architekturtyp an

Wert	Beschreibung
x64
Arm64

AutomaticOSUpgradeProperties

Objekt

Beschreibt die Eigenschaften für automatische Betriebssystemupgrades auf dem Image.

Name	Typ	Beschreibung
automaticOSUpgradeSupported	boolean	Gibt an, ob das automatische Betriebssystemupgrade für das Image unterstützt wird.

CloudError

Objekt

Eine Fehlerantwort vom Compute-Dienst.

Name	Typ	Beschreibung
error	ApiError	API-Fehler.

DataDiskImage

Objekt

Enthält die Informationen zu den Datenträgerabbildern.

Name	Typ	Beschreibung
lun	integer (int32)	Gibt die logische Einheitennummer des Datenträgers an. Dieser Wert wird verwendet, um Datenträger innerhalb des virtuellen Computers zu identifizieren und muss daher für jeden an eine VM angefügten Datenträger eindeutig sein.

DisallowedConfiguration

Objekt

Gibt die nicht zulässige Konfiguration für ein VM-Image an.

Name	Typ	Beschreibung
vmDiskType	VmDiskTypes	VM-Datenträgertypen, die nicht zulässig sind.

ExtendedLocation

Objekt

Der komplexe Typ des erweiterten Standorts.

Name	Typ	Beschreibung
name	string	Der Name des erweiterten Speicherorts.
type	ExtendedLocationTypes	Der Typ des erweiterten Speicherorts.

ExtendedLocationTypes

Enumeration

Der Typ des erweiterten Speicherorts.

Wert	Beschreibung
EdgeZone

HyperVGenerationTypes

Enumeration

Gibt den HyperVGeneration-Typ an

Wert	Beschreibung
V1
V2

ImageDeprecationStatus

Objekt

Beschreibt die Statuseigenschaften von Bildern für das Image.

Name	Typ	Beschreibung
alternativeOption	AlternativeOption	Beschreibt die alternative Option, die vom Verleger für dieses Image angegeben wird, wenn dieses Image veraltet ist.
imageState	ImageState	Beschreibt den Status des Abbilds.
scheduledDeprecationTime	string (date-time)	Der Zeitpunkt, zu dem dieses Bild in Zukunft als veraltet markiert wird. Diese geplante Zeit wird vom Verleger ausgewählt.

ImageState

Enumeration

Beschreibt den Status des Abbilds.

Wert	Beschreibung
Active
ScheduledForDeprecation
Deprecated

InnerError

Objekt

Innere Fehlerdetails.

Name	Typ	Beschreibung
errordetail	string	Die interne Fehlermeldung oder der Ausnahmedump.
exceptiontype	string	Der Ausnahmetyp.

OperatingSystemTypes

Enumeration

Mit dieser Eigenschaft können Sie den Typ des Betriebssystems angeben, das auf dem Datenträger enthalten ist, wenn sie einen virtuellen Computer aus einem benutzerdefinierten Image erstellen. Mögliche Werte sind: Windows,Linux.

Wert	Beschreibung
Windows
Linux

OSDiskImage

Objekt

Enthält die Informationen zum Betriebssystem-Disk-Image.

Name	Typ	Beschreibung
operatingSystem	OperatingSystemTypes	Das Betriebssystem von osDiskImage.

PurchasePlan

Objekt

Wird verwendet, um den Kaufkontext eines Artefakts von Drittanbietern über MarketPlace zu ermitteln.

Name	Typ	Beschreibung
name	string	Die Plan-ID.
product	string	Gibt das Produkt des Bilds vom Marketplace an. Dies ist derselbe Wert wie Offer unter dem imageReference-Element.
publisher	string	Die Herausgeber-ID.