Freigeben über


Virtual Machine Images - Get

Ruft ein Image eines virtuellen Computers 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=2024-07-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
location
path True

string

Der Name einer unterstützten Azure-Region.

offer
path True

string

Ein gültiges Bildherausgeberangebot.

publisherName
path True

string

Ein gültiger Bildherausgeber.

skus
path True

string

Eine gültige Bild-SKU.

subscriptionId
path True

string

Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

version
path True

string

Eine gültige SKU-Version des Bilds.

api-version
query True

string

Client-API-Version.

Antworten

Name Typ Beschreibung
200 OK

VirtualMachineImage

OKAY

Other Status Codes

CloudError

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

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

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

Beispiel für eine Antwort

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

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=2024-07-01

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
AlternativeOption

Beschreibt die alternative Option, die von Publisher für dieses Bild angegeben wird, wenn dieses Bild 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 im Image.

CloudError

Eine Fehlerantwort des Computediensts.

DataDiskImage

Enthält die Datendatenträgerimageinformationen.

DisallowedConfiguration

Gibt die unzulässige Konfiguration für ein Image eines virtuellen Computers an.

ExtendedLocation

Der komplexe Typ des erweiterten Standorts.

ExtendedLocationTypes

Der Typ des erweiterten Speicherorts.

HyperVGenerationTypes

Gibt den HyperVGeneration-Typ an.

ImageDeprecationStatus

Beschreibt die Statuseigenschaften des Bildstatus des Bilds.

ImageState

Beschreibt den Zustand des Bilds.

InnerError

Innere Fehlerdetails.

OperatingSystemTypes

Das Betriebssystem des osDiskImage.

OSDiskImage

Enthält die Betriebssystemdatenträgerimageinformationen.

PurchasePlan

Wird zum Einrichten des Kaufkontexts eines Drittanbieterartefaktes über MarketPlace verwendet.

VirtualMachineImage

Beschreibt ein Image eines virtuellen Computers.

VirtualMachineImageFeature

Gibt zusätzliche Funktionen an, die vom Bild unterstützt werden

VmDiskTypes

VM-Datenträgertypen, die unzulässig sind.

AlternativeOption

Beschreibt die alternative Option, die von Publisher für dieses Bild angegeben wird, wenn dieses Bild veraltet ist.

Name Typ Beschreibung
type

AlternativeType

Beschreibt den Typ der alternativen Option.

value

string

Gibt den alternativen Optionswert an, der von Publisher angegeben wird. Dies ist der Angebotsname, wenn der Typ "Angebot" oder der Name "Plan" lautet, wenn der Typ "Plan" lautet.

AlternativeType

Beschreibt den Typ der alternativen Option.

Name Typ Beschreibung
None

string

Offer

string

Plan

string

ApiError

API-Fehler.

Name Typ Beschreibung
code

string

Der Fehlercode.

details

ApiErrorBase[]

Die API-Fehlerdetails

innererror

InnerError

Interner API-Fehler

message

string

Die Fehlermeldung.

target

string

Das Ziel des bestimmten Fehlers.

ApiErrorBase

API-Fehlerbasis.

Name Typ Beschreibung
code

string

Der Fehlercode.

message

string

Die Fehlermeldung.

target

string

Das Ziel des bestimmten Fehlers.

ArchitectureTypes

Gibt den Architekturtyp an.

Name Typ Beschreibung
Arm64

string

x64

string

AutomaticOSUpgradeProperties

Beschreibt die Eigenschaften für automatische Betriebssystemupgrades im Image.

Name Typ Beschreibung
automaticOSUpgradeSupported

boolean

Gibt an, ob das automatische Betriebssystemupgrade auf dem Image unterstützt wird.

CloudError

Eine Fehlerantwort des Computediensts.

Name Typ Beschreibung
error

ApiError

API-Fehler.

DataDiskImage

Enthält die Datendatenträgerimageinformationen.

Name Typ Beschreibung
lun

integer

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

Gibt die unzulässige Konfiguration für ein Image eines virtuellen Computers an.

Name Typ Beschreibung
vmDiskType

VmDiskTypes

VM-Datenträgertypen, die unzulässig sind.

ExtendedLocation

Der komplexe Typ des erweiterten Standorts.

Name Typ Beschreibung
name

string

Der Name des erweiterten Speicherorts.

type

ExtendedLocationTypes

Der Typ des erweiterten Speicherorts.

ExtendedLocationTypes

Der Typ des erweiterten Speicherorts.

Name Typ Beschreibung
EdgeZone

string

HyperVGenerationTypes

Gibt den HyperVGeneration-Typ an.

Name Typ Beschreibung
V1

string

V2

string

ImageDeprecationStatus

Beschreibt die Statuseigenschaften des Bildstatus des Bilds.

Name Typ Beschreibung
alternativeOption

AlternativeOption

Beschreibt die alternative Option, die von Publisher für dieses Bild angegeben wird, wenn dieses Bild veraltet ist.

imageState

ImageState

Beschreibt den Zustand des Bilds.

scheduledDeprecationTime

string

Die Zeit, zu der dieses Bild in Zukunft als veraltet gekennzeichnet wird. Diese geplante Zeit wird vom Publisher ausgewählt.

ImageState

Beschreibt den Zustand des Bilds.

Name Typ Beschreibung
Active

string

Deprecated

string

ScheduledForDeprecation

string

InnerError

Innere Fehlerdetails.

Name Typ Beschreibung
errordetail

string

Die interne Fehlermeldung oder das Ausnahmeabbild.

exceptiontype

string

Der Ausnahmetyp.

OperatingSystemTypes

Das Betriebssystem des osDiskImage.

Name Typ Beschreibung
Linux

string

Windows

string

OSDiskImage

Enthält die Betriebssystemdatenträgerimageinformationen.

Name Typ Beschreibung
operatingSystem

OperatingSystemTypes

Das Betriebssystem des osDiskImage.

PurchasePlan

Wird zum Einrichten des Kaufkontexts eines Drittanbieterartefaktes über MarketPlace verwendet.

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.

VirtualMachineImage

Beschreibt ein Image eines virtuellen Computers.

Name Typ Beschreibung
extendedLocation

ExtendedLocation

Der erweiterte Speicherort des virtuellen Computers.

id

string

Ressourcen-ID

location

string

Der unterstützte Azure-Speicherort der Ressource.

name

string

Der Name der Ressource.

properties.architecture

ArchitectureTypes

Gibt den Architekturtyp an.

properties.automaticOSUpgradeProperties

AutomaticOSUpgradeProperties

Beschreibt die Eigenschaften für automatische Betriebssystemupgrades im Image.

properties.dataDiskImages

DataDiskImage[]

Enthält die Datendatenträgerimageinformationen.

properties.disallowed

DisallowedConfiguration

Gibt die nicht zulässige Konfiguration für die virtualMachine an, die aus dem Image erstellt wurde.

properties.features

VirtualMachineImageFeature[]

Gibt zusätzliche Funktionen an, die vom Bild unterstützt werden

properties.hyperVGeneration

HyperVGenerationTypes

Gibt den HyperVGeneration-Typ an.

properties.imageDeprecationStatus

ImageDeprecationStatus

Beschreibt die Statuseigenschaften des Bildstatus des Bilds.

properties.osDiskImage

OSDiskImage

Enthält die Betriebssystemdatenträgerimageinformationen.

properties.plan

PurchasePlan

Wird zum Einrichten des Kaufkontexts eines Drittanbieterartefaktes über MarketPlace verwendet.

tags

object

Gibt die Tags an, die dem virtuellen Computer zugewiesen sind. Weitere Informationen zum Verwenden von Tags finden Sie unter Verwenden von Tags zum Organisieren Ihrer Azure-Ressourcen.

VirtualMachineImageFeature

Gibt zusätzliche Funktionen an, die vom Bild unterstützt werden

Name Typ Beschreibung
name

string

Der Name des Features.

value

string

Der entsprechende Wert für das Feature.

VmDiskTypes

VM-Datenträgertypen, die unzulässig sind.

Name Typ Beschreibung
None

string

Unmanaged

string