Dela via


Virtual Machine Images - Get

Hämtar en avbildning av en virtuell dator.

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

Name I Obligatorisk Typ Description
location
path True

string

Namnet på en Azure-region som stöds.

offer
path True

string

Ett giltigt bildutgivarerbjudande.

publisherName
path True

string

En giltig bildutgivare.

skus
path True

string

En giltig avbildnings-SKU.

subscriptionId
path True

string

Prenumerationsautentiseringsuppgifter som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.

version
path True

string

En giltig SKU-version för avbildningar.

api-version
query True

string

Klient-API-version.

Svar

Name Typ Description
200 OK

VirtualMachineImage

OKEJ

Other Status Codes

CloudError

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

VirtualMachineImage_Get_MaximumSet_Gen
VirtualMachineImage_Get_MinimumSet_Gen

VirtualMachineImage_Get_MaximumSet_Gen

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
AlternativeOption

Beskriver det alternativa alternativ som anges av Publisher för den här bilden när den här bilden är inaktuell.

AlternativeType

Beskriver typen av alternativalternativ.

ApiError

Api-fel.

ApiErrorBase

Api-felbas.

ArchitectureTypes

Anger arkitekturtyp

AutomaticOSUpgradeProperties

Beskriver egenskaperna för automatisk operativsystemuppgradering på avbildningen.

CloudError

Ett felsvar från Compute-tjänsten.

DataDiskImage

Innehåller information om datadiskbilder.

DisallowedConfiguration

Anger den otillåtna konfigurationen för en virtuell datoravbildning.

ExtendedLocation

Den komplexa typen av utökad plats.

ExtendedLocationTypes

Typ av utökad plats.

HyperVGenerationTypes

Anger HyperVGeneration-typen

ImageDeprecationStatus

Beskriver statusegenskaper för bildutfasning på bilden.

ImageState

Beskriver bildens tillstånd.

InnerError

Inre felinformation.

OperatingSystemTypes

Operativsystemet för osDiskImage.

OSDiskImage

Innehåller information om os-diskavbildningen.

PurchasePlan

Används för att upprätta inköpskontexten för alla artefakter från tredje part via MarketPlace.

VirtualMachineImage

Beskriver en avbildning av en virtuell dator.

VirtualMachineImageFeature

Anger ytterligare funktioner som stöds av avbildningen

VmDiskTypes

Vm-disktyper som inte tillåts.

AlternativeOption

Beskriver det alternativa alternativ som anges av Publisher för den här bilden när den här bilden är inaktuell.

Name Typ Description
type

AlternativeType

Beskriver typen av alternativalternativ.

value

string

Anger det alternativa alternativvärde som anges av utgivaren. Det här är erbjudandets namn när typen är Erbjudande eller Plannamn när typen är Plan.

AlternativeType

Beskriver typen av alternativalternativ.

Name Typ Description
None

string

Offer

string

Plan

string

ApiError

Api-fel.

Name Typ Description
code

string

Felkoden.

details

ApiErrorBase[]

Api-felinformationen

innererror

InnerError

Api:ets inre fel

message

string

Felmeddelandet.

target

string

Målet för det specifika felet.

ApiErrorBase

Api-felbas.

Name Typ Description
code

string

Felkoden.

message

string

Felmeddelandet.

target

string

Målet för det specifika felet.

ArchitectureTypes

Anger arkitekturtyp

Name Typ Description
Arm64

string

x64

string

AutomaticOSUpgradeProperties

Beskriver egenskaperna för automatisk operativsystemuppgradering på avbildningen.

Name Typ Description
automaticOSUpgradeSupported

boolean

Anger om automatisk os-uppgradering stöds på avbildningen.

CloudError

Ett felsvar från Compute-tjänsten.

Name Typ Description
error

ApiError

Api-fel.

DataDiskImage

Innehåller information om datadiskbilder.

Name Typ Description
lun

integer

Anger datadiskens logiska enhetsnummer. Det här värdet används för att identifiera datadiskar i den virtuella datorn och måste därför vara unikt för varje datadisk som är ansluten till en virtuell dator.

DisallowedConfiguration

Anger den otillåtna konfigurationen för en virtuell datoravbildning.

Name Typ Description
vmDiskType

VmDiskTypes

Vm-disktyper som inte tillåts.

ExtendedLocation

Den komplexa typen av utökad plats.

Name Typ Description
name

string

Namnet på den utökade platsen.

type

ExtendedLocationTypes

Typ av utökad plats.

ExtendedLocationTypes

Typ av utökad plats.

Name Typ Description
EdgeZone

string

HyperVGenerationTypes

Anger HyperVGeneration-typen

Name Typ Description
V1

string

V2

string

ImageDeprecationStatus

Beskriver statusegenskaper för bildutfasning på bilden.

Name Typ Description
alternativeOption

AlternativeOption

Beskriver det alternativa alternativ som anges av Publisher för den här bilden när den här bilden är inaktuell.

imageState

ImageState

Beskriver bildens tillstånd.

scheduledDeprecationTime

string

Den tid i framtiden då den här avbildningen kommer att markeras som inaktuell. Den här schemalagda tiden väljs av utgivaren.

ImageState

Beskriver bildens tillstånd.

Name Typ Description
Active

string

Deprecated

string

ScheduledForDeprecation

string

InnerError

Inre felinformation.

Name Typ Description
errordetail

string

Det interna felmeddelandet eller undantagsdumpen.

exceptiontype

string

Undantagstypen.

OperatingSystemTypes

Operativsystemet för osDiskImage.

Name Typ Description
Linux

string

Windows

string

OSDiskImage

Innehåller information om os-diskavbildningen.

Name Typ Description
operatingSystem

OperatingSystemTypes

Operativsystemet för osDiskImage.

PurchasePlan

Används för att upprätta inköpskontexten för alla artefakter från tredje part via MarketPlace.

Name Typ Description
name

string

Plan-ID:t.

product

string

Anger produkten av avbildningen från marketplace. Det här är samma värde som Erbjudandet under elementet imageReference.

publisher

string

Utgivarens ID.

VirtualMachineImage

Beskriver en avbildning av en virtuell dator.

Name Typ Description
extendedLocation

ExtendedLocation

Den utökade platsen för den virtuella datorn.

id

string

Resurs-ID

location

string

Den Azure-plats som stöds för resursen.

name

string

Namnet på resursen.

properties.architecture

ArchitectureTypes

Anger arkitekturtyp

properties.automaticOSUpgradeProperties

AutomaticOSUpgradeProperties

Beskriver egenskaperna för automatisk operativsystemuppgradering på avbildningen.

properties.dataDiskImages

DataDiskImage[]

Innehåller information om datadiskbilder.

properties.disallowed

DisallowedConfiguration

Anger otillåten konfiguration för VirtualMachine som skapats från avbildningen

properties.features

VirtualMachineImageFeature[]

Anger ytterligare funktioner som stöds av avbildningen

properties.hyperVGeneration

HyperVGenerationTypes

Anger HyperVGeneration-typen

properties.imageDeprecationStatus

ImageDeprecationStatus

Beskriver statusegenskaper för bildutfasning på bilden.

properties.osDiskImage

OSDiskImage

Innehåller information om os-diskavbildningen.

properties.plan

PurchasePlan

Används för att upprätta inköpskontexten för alla artefakter från tredje part via MarketPlace.

tags

object

Anger de taggar som har tilldelats till den virtuella datorn. Mer information om hur du använder taggar finns i Använda taggar för att organisera dina Azure-resurser.

VirtualMachineImageFeature

Anger ytterligare funktioner som stöds av avbildningen

Name Typ Description
name

string

Namnet på funktionen.

value

string

Motsvarande värde för funktionen.

VmDiskTypes

Vm-disktyper som inte tillåts.

Name Typ Description
None

string

Unmanaged

string