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=2024-03-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
location
|
path | True |
string |
Nazwa obsługiwanego regionu świadczenia usługi Azure. |
offer
|
path | True |
string |
Prawidłowa oferta wydawcy obrazów. |
publisher
|
path | True |
string |
Prawidłowy wydawca obrazów. |
skus
|
path | True |
string |
Prawidłowa jednostka SKU obrazu. |
subscription
|
path | True |
string |
Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi. |
version
|
path | True |
string |
Prawidłowa wersja jednostki SKU obrazu. |
api-version
|
query | True |
string |
Wersja interfejsu API klienta. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się. |
Zabezpieczenia
azure_auth
Przepływ OAuth2 usługi Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nazwa | Opis |
---|---|
user_impersonation | personifikacja konta użytkownika |
Przykłady
Virtual |
Virtual |
VirtualMachineImage_Get_MaximumSet_Gen
Sample Request
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-03-01
Sample Response
{
"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
Sample Request
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-03-01
Sample Response
{
"name": "aaaaaaaaa",
"location": "aaaaa",
"id": "aaaaaaaaaaa"
}
Definicje
Nazwa | Opis |
---|---|
Alternative |
Opisuje alternatywną opcję określoną przez wydawcę dla tego obrazu, gdy ten obraz jest przestarzały. |
Alternative |
Opisuje typ opcji alternatywnej. |
Api |
Błąd interfejsu API. |
Api |
Baza błędów interfejsu API. |
Architecture |
Określa typ architektury |
Automatic |
Opisuje właściwości automatycznego uaktualniania systemu operacyjnego na obrazie. |
Cloud |
Odpowiedź o błędzie z usługi Compute. |
Data |
Zawiera informacje o obrazach dysków danych. |
Disallowed |
Określa niedozwoloną konfigurację obrazu maszyny wirtualnej. |
Extended |
Typ złożony lokalizacji rozszerzonej. |
Extended |
Typ lokalizacji rozszerzonej. |
Hyper |
Określa typ funkcji HyperVGeneration |
Image |
Opisuje właściwości stanu wycofania obrazu na obrazie. |
Image |
Opisuje stan obrazu. |
Inner |
Szczegóły błędu wewnętrznego. |
Operating |
System operacyjny osDiskImage. |
OSDisk |
Zawiera informacje o obrazie dysku systemu operacyjnego. |
Purchase |
Służy do ustanawiania kontekstu zakupu dowolnego artefaktu innej firmy za pośrednictwem platformy MarketPlace. |
Virtual |
Opisuje obraz maszyny wirtualnej. |
Virtual |
Określa dodatkowe możliwości obsługiwane przez obraz |
Vm |
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 |
Opisuje typ opcji alternatywnej. |
|
value |
string |
Wskazuje alternatywną wartość opcji określoną przez wydawcę. Jest to nazwa oferty, gdy typ to Oferta lub Nazwa planu, gdy typ to Plan. |
AlternativeType
Opisuje typ opcji alternatywnej.
Nazwa | Typ | Opis |
---|---|---|
None |
string |
|
Offer |
string |
|
Plan |
string |
ApiError
Błąd interfejsu API.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu. |
details |
Szczegóły błędu interfejsu API |
|
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 interfejsu 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
Nazwa | Typ | Opis |
---|---|---|
Arm64 |
string |
|
x64 |
string |
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ź o błędzie z usługi Compute.
Nazwa | Typ | Opis |
---|---|---|
error |
Błąd interfejsu API. |
DataDiskImage
Zawiera informacje o obrazach dysków danych.
Nazwa | Typ | Opis |
---|---|---|
lun |
integer |
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 |
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 |
Typ lokalizacji rozszerzonej. |
ExtendedLocationTypes
Typ lokalizacji rozszerzonej.
Nazwa | Typ | Opis |
---|---|---|
EdgeZone |
string |
HyperVGenerationTypes
Określa typ funkcji HyperVGeneration
Nazwa | Typ | Opis |
---|---|---|
V1 |
string |
|
V2 |
string |
ImageDeprecationStatus
Opisuje właściwości stanu wycofania obrazu na obrazie.
Nazwa | Typ | Opis |
---|---|---|
alternativeOption |
Opisuje alternatywną opcję określoną przez wydawcę dla tego obrazu, gdy ten obraz jest przestarzały. |
|
imageState |
Opisuje stan obrazu. |
|
scheduledDeprecationTime |
string |
Czas, w przyszłości, w którym ten obraz zostanie oznaczony jako przestarzały. Ten zaplanowany czas jest wybierany przez wydawcę. |
ImageState
Opisuje stan obrazu.
Nazwa | Typ | Opis |
---|---|---|
Active |
string |
|
Deprecated |
string |
|
ScheduledForDeprecation |
string |
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
System operacyjny osDiskImage.
Nazwa | Typ | Opis |
---|---|---|
Linux |
string |
|
Windows |
string |
OSDiskImage
Zawiera informacje o obrazie dysku systemu operacyjnego.
Nazwa | Typ | Opis |
---|---|---|
operatingSystem |
System operacyjny osDiskImage. |
PurchasePlan
Służy do ustanawiania kontekstu zakupu dowolnego artefaktu innej firmy za pośrednictwem platformy MarketPlace.
Nazwa | Typ | Opis |
---|---|---|
name |
string |
Identyfikator planu. |
product |
string |
Określa produkt obrazu z witryny Marketplace. Jest to ta sama wartość co oferta w elemencie imageReference. |
publisher |
string |
Identyfikator wydawcy. |
VirtualMachineImage
Opisuje obraz maszyny wirtualnej.
Nazwa | Typ | Opis |
---|---|---|
extendedLocation |
Rozszerzona lokalizacja maszyny wirtualnej. |
|
id |
string |
Identyfikator zasobu |
location |
string |
Obsługiwana lokalizacja zasobu platformy Azure. |
name |
string |
Nazwa zasobu. |
properties.architecture |
Określa typ architektury |
|
properties.automaticOSUpgradeProperties |
Opisuje właściwości automatycznego uaktualniania systemu operacyjnego na obrazie. |
|
properties.dataDiskImages |
Zawiera informacje o obrazach dysków danych. |
|
properties.disallowed |
Określa niedozwoloną konfigurację maszyny wirtualnej utworzonej na podstawie obrazu |
|
properties.features |
Określa dodatkowe możliwości obsługiwane przez obraz |
|
properties.hyperVGeneration |
Określa typ funkcji HyperVGeneration |
|
properties.imageDeprecationStatus |
Opisuje właściwości stanu wycofania obrazu na obrazie. |
|
properties.osDiskImage |
Zawiera informacje o obrazie dysku systemu operacyjnego. |
|
properties.plan |
Służy do ustanawiania kontekstu zakupu dowolnego artefaktu innej firmy za pośrednictwem platformy MarketPlace. |
|
tags |
object |
Określa tagi 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 |
Odpowiadająca wartość funkcji. |
VmDiskTypes
Typy dysków maszyn wirtualnych, które są niedozwolone.
Nazwa | Typ | Opis |
---|---|---|
None |
string |
|
Unmanaged |
string |