Udostępnij przez


Virtual Machine Images - Get

Pobiera obraz maszyny wirtualnej.

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

Parametry URI

Nazwa W Wymagane Typ Opis
location
path True

string

minLength: 1

Nazwa regionu świadczenia usługi Azure.

offer
path True

string

Ważna oferta dla wydawców obrazów.

publisherName
path True

string

Prawidłowy wydawca obrazów.

skus
path True

string

Prawidłowa jednostka SKU obrazu.

subscriptionId
path True

string

minLength: 1

Identyfikator subskrypcji docelowej.

version
path True

string

Prawidłowa wersja jednostki SKU obrazu.

api-version
query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa Typ Opis
200 OK

VirtualMachineImage

Operacja platformy Azure została zakończona pomyślnie.

Other Status Codes

CloudError

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

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

Zakresów

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

VirtualMachineImage_Get_MaximumSet_Gen
VirtualMachineImage_Get_MinimumSet_Gen

VirtualMachineImage_Get_MaximumSet_Gen

Przykładowa prośba

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

Przykładowa odpowiedź

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

Przykładowa prośba

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
AlternativeOption

Opisuje alternatywną opcję określoną przez wydawcę dla tego obrazu, gdy ten obraz jest przestarzały.

AlternativeType

Opisuje typ opcji alternatywnej.

ApiError

Błąd API.

ApiErrorBase

Baza błędów API.

ArchitectureTypes

Określa typ architektury

AutomaticOSUpgradeProperties

Opisuje właściwości automatycznego uaktualniania systemu operacyjnego na obrazie.

CloudError

Odpowiedź na błąd z usługi obliczeniowej.

DataDiskImage

Zawiera informacje o obrazach dysków danych.

DisallowedConfiguration

Określa niedozwoloną konfigurację obrazu maszyny wirtualnej.

ExtendedLocation

Typ złożony lokalizacji rozszerzonej.

ExtendedLocationTypes

Typ lokalizacji rozszerzonej.

HyperVGenerationTypes

Określa typ HyperVGeneration

ImageDeprecationStatus

Opisuje właściwości stanu wycofania obrazu na obrazie.

ImageState

Opisuje stan obrazu.

InnerError

Szczegóły błędu wewnętrznego.

OperatingSystemTypes

Ta właściwość umożliwia określenie typu systemu operacyjnego dołączonego do dysku, jeśli tworzysz maszynę wirtualną na podstawie obrazu użytkownika lub wyspecjalizowanego wirtualnego dysku twardego. Możliwe wartości to: Windows,Linux.

OSDiskImage

Zawiera informacje o obrazie dysku systemu operacyjnego.

PurchasePlan

Służy do ustanawiania kontekstu zakupu dowolnego artefaktu strony trzeciej za pośrednictwem MarketPlace.

VirtualMachineImage

Opisuje obraz maszyny wirtualnej.

VirtualMachineImageFeature

Określa dodatkowe możliwości obsługiwane przez obraz

VmDiskTypes

Typy dysków maszyn wirtualnych, które są niedozwolone.

AlternativeOption

Opisuje alternatywną opcję określoną przez wydawcę dla tego obrazu, gdy ten obraz jest przestarzały.

Nazwa Typ Opis
type

AlternativeType

Opisuje typ opcji alternatywnej.

value

string

Wskazuje wartość opcji alternatywnej określoną przez Wydawcę. Jest to nazwa oferty, gdy typ to Oferta, lub nazwa planu, gdy typ to Plan.

AlternativeType

Opisuje typ opcji alternatywnej.

Wartość Opis
None
Offer
Plan

ApiError

Błąd API.

Nazwa Typ Opis
code

string

Kod błędu.

details

ApiErrorBase[]

Szczegóły błędu interfejsu API

innererror

InnerError

Wewnętrzny błąd interfejsu API

message

string

Komunikat o błędzie.

target

string

Element docelowy określonego błędu.

ApiErrorBase

Baza błędów API.

Nazwa Typ Opis
code

string

Kod błędu.

message

string

Komunikat o błędzie.

target

string

Element docelowy określonego błędu.

ArchitectureTypes

Określa typ architektury

Wartość Opis
x64
Arm64

AutomaticOSUpgradeProperties

Opisuje właściwości automatycznego uaktualniania systemu operacyjnego na obrazie.

Nazwa Typ Opis
automaticOSUpgradeSupported

boolean

Określa, czy automatyczne uaktualnianie systemu operacyjnego jest obsługiwane na obrazie.

CloudError

Odpowiedź na błąd z usługi obliczeniowej.

Nazwa Typ Opis
error

ApiError

Błąd API.

DataDiskImage

Zawiera informacje o obrazach dysków danych.

Nazwa Typ Opis
lun

integer (int32)

Określa numer jednostki logicznej dysku danych. Ta wartość służy do identyfikowania dysków danych na maszynie wirtualnej i dlatego musi być unikatowa dla każdego dysku danych dołączonego do maszyny wirtualnej.

DisallowedConfiguration

Określa niedozwoloną konfigurację obrazu maszyny wirtualnej.

Nazwa Typ Opis
vmDiskType

VmDiskTypes

Typy dysków maszyn wirtualnych, które są niedozwolone.

ExtendedLocation

Typ złożony lokalizacji rozszerzonej.

Nazwa Typ Opis
name

string

Nazwa lokalizacji rozszerzonej.

type

ExtendedLocationTypes

Typ lokalizacji rozszerzonej.

ExtendedLocationTypes

Typ lokalizacji rozszerzonej.

Wartość Opis
EdgeZone

HyperVGenerationTypes

Określa typ HyperVGeneration

Wartość Opis
V1
V2

ImageDeprecationStatus

Opisuje właściwości stanu wycofania obrazu na obrazie.

Nazwa Typ Opis
alternativeOption

AlternativeOption

Opisuje alternatywną opcję określoną przez wydawcę dla tego obrazu, gdy ten obraz jest przestarzały.

imageState

ImageState

Opisuje stan obrazu.

scheduledDeprecationTime

string (date-time)

Godzina w przyszłości, w której ten obraz zostanie oznaczony jako przestarzały. Ten zaplanowany czas jest wybierany przez Wydawcę.

ImageState

Opisuje stan obrazu.

Wartość Opis
Active
ScheduledForDeprecation
Deprecated

InnerError

Szczegóły błędu wewnętrznego.

Nazwa Typ Opis
errordetail

string

Wewnętrzny komunikat o błędzie lub zrzut wyjątku.

exceptiontype

string

Typ wyjątku.

OperatingSystemTypes

Ta właściwość umożliwia określenie typu systemu operacyjnego dołączonego do dysku, jeśli tworzysz maszynę wirtualną na podstawie obrazu użytkownika lub wyspecjalizowanego wirtualnego dysku twardego. Możliwe wartości to: Windows,Linux.

Wartość Opis
Windows
Linux

OSDiskImage

Zawiera informacje o obrazie dysku systemu operacyjnego.

Nazwa Typ Opis
operatingSystem

OperatingSystemTypes

System operacyjny systemu operacyjnego osDiskImage.

PurchasePlan

Służy do ustanawiania kontekstu zakupu dowolnego artefaktu strony trzeciej za pośrednictwem MarketPlace.

Nazwa Typ Opis
name

string

Identyfikator planu.

product

string

Określa produkt obrazu z witryny Marketplace. Jest to ta sama wartość co offer w elemencie imageReference.

publisher

string

Identyfikator wydawcy.

VirtualMachineImage

Opisuje obraz maszyny wirtualnej.

Nazwa Typ Opis
extendedLocation

ExtendedLocation

Rozszerzona lokalizacja maszyny wirtualnej.

id

string

Identyfikator zasobu

location

string

Obsługiwana lokalizacja zasobu na platformie Azure.

name

string

Nazwa zasobu.

properties.architecture

ArchitectureTypes

Określa typ architektury

properties.automaticOSUpgradeProperties

AutomaticOSUpgradeProperties

Opisuje właściwości automatycznego uaktualniania systemu operacyjnego na obrazie.

properties.dataDiskImages

DataDiskImage[]

Lista informacji o obrazach dysków danych.

properties.disallowed

DisallowedConfiguration

Określa niedozwoloną konfigurację dla maszyny wirtualnej utworzonej na podstawie obrazu

properties.features

VirtualMachineImageFeature[]

Określa dodatkowe możliwości obsługiwane przez obraz

properties.hyperVGeneration

HyperVGenerationTypes

Określa typ HyperVGeneration

properties.imageDeprecationStatus

ImageDeprecationStatus

Opisuje właściwości stanu wycofania obrazu na obrazie.

properties.osDiskImage

OSDiskImage

Zawiera informacje o obrazie dysku systemu operacyjnego.

properties.plan

PurchasePlan

Służy do ustanawiania kontekstu zakupu dowolnego artefaktu strony trzeciej za pośrednictwem MarketPlace.

tags

object

Określa tagi, które są przypisane do maszyny wirtualnej. Aby uzyskać więcej informacji na temat używania tagów, zobacz Używanie tagów do organizowania zasobów platformy Azure.

VirtualMachineImageFeature

Określa dodatkowe możliwości obsługiwane przez obraz

Nazwa Typ Opis
name

string

Nazwa funkcji.

value

string

Odpowiednia wartość dla funkcji.

VmDiskTypes

Typy dysków maszyn wirtualnych, które są niedozwolone.

Wartość Opis
None
Unmanaged