Virtual Machine Images - Get
取得虛擬機映像。
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 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
location
|
path | True |
string |
支援的 Azure 區域名稱。 |
offer
|
path | True |
string |
有效的映像發行者供應專案。 |
publisher
|
path | True |
string |
有效的映像發行者。 |
skus
|
path | True |
string |
有效的映像 SKU。 |
subscription
|
path | True |
string |
可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。 |
version
|
path | True |
string |
有效的映像 SKU 版本。 |
api-version
|
query | True |
string |
用戶端 API 版本。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
還行 |
|
Other Status Codes |
描述作業失敗原因的錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
範例
Virtual |
Virtual |
VirtualMachineImage_Get_MaximumSet_Gen
範例要求
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
範例回覆
{
"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
範例要求
範例回覆
{
"name": "aaaaaaaaa",
"location": "aaaaa",
"id": "aaaaaaaaaaa"
}
定義
名稱 | Description |
---|---|
Alternative |
描述當此映像已被取代時,發行者為此映像指定的替代選項。 |
Alternative |
描述替代選項的類型。 |
Api |
Api 錯誤。 |
Api |
API 錯誤基底。 |
Architecture |
指定架構類型 |
Automatic |
描述映像上的自動OS升級屬性。 |
Cloud |
來自計算服務的錯誤回應。 |
Data |
包含數據磁碟映像資訊。 |
Disallowed |
指定虛擬機映像不允許的組態。 |
Extended |
擴充位置的複雜類型。 |
Extended |
擴充位置的類型。 |
Hyper |
指定 HyperVGeneration 類型 |
Image |
描述映像上的映像取代狀態屬性。 |
Image |
描述影像的狀態。 |
Inner |
內部錯誤詳細數據。 |
Operating |
osDiskImage 的操作系統。 |
OSDisk |
包含 os 磁碟映像資訊。 |
Purchase |
用於透過 MarketPlace 建立第三方成品的購買內容。 |
Virtual |
描述虛擬機映像。 |
Virtual |
指定映像支援的其他功能 |
Vm |
不允許的 VM 磁碟類型。 |
AlternativeOption
描述當此映像已被取代時,發行者為此映像指定的替代選項。
名稱 | 類型 | Description |
---|---|---|
type |
描述替代選項的類型。 |
|
value |
string |
表示發行者所指定的替代選項值。 當類型為 [供應專案] 或類型為 [方案] 時,這是供應項目名稱。 |
AlternativeType
描述替代選項的類型。
名稱 | 類型 | Description |
---|---|---|
None |
string |
|
Offer |
string |
|
Plan |
string |
ApiError
Api 錯誤。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤碼。 |
details |
Api 錯誤詳細數據 |
|
innererror |
Api 內部錯誤 |
|
message |
string |
錯誤訊息。 |
target |
string |
特定錯誤的目標。 |
ApiErrorBase
API 錯誤基底。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤碼。 |
message |
string |
錯誤訊息。 |
target |
string |
特定錯誤的目標。 |
ArchitectureTypes
指定架構類型
名稱 | 類型 | Description |
---|---|---|
Arm64 |
string |
|
x64 |
string |
AutomaticOSUpgradeProperties
描述映像上的自動OS升級屬性。
名稱 | 類型 | Description |
---|---|---|
automaticOSUpgradeSupported |
boolean |
指定映像上是否支援自動OS升級。 |
CloudError
來自計算服務的錯誤回應。
名稱 | 類型 | Description |
---|---|---|
error |
Api 錯誤。 |
DataDiskImage
包含數據磁碟映像資訊。
名稱 | 類型 | Description |
---|---|---|
lun |
integer |
指定數據磁碟的邏輯單元編號。 這個值是用來識別 VM 內的數據磁碟,因此對於連結至 VM 的每個數據磁碟而言都必須是唯一的。 |
DisallowedConfiguration
指定虛擬機映像不允許的組態。
名稱 | 類型 | Description |
---|---|---|
vmDiskType |
不允許的 VM 磁碟類型。 |
ExtendedLocation
擴充位置的複雜類型。
名稱 | 類型 | Description |
---|---|---|
name |
string |
擴充位置的名稱。 |
type |
擴充位置的類型。 |
ExtendedLocationTypes
擴充位置的類型。
名稱 | 類型 | Description |
---|---|---|
EdgeZone |
string |
HyperVGenerationTypes
指定 HyperVGeneration 類型
名稱 | 類型 | Description |
---|---|---|
V1 |
string |
|
V2 |
string |
ImageDeprecationStatus
描述映像上的映像取代狀態屬性。
名稱 | 類型 | Description |
---|---|---|
alternativeOption |
描述當此映像已被取代時,發行者為此映像指定的替代選項。 |
|
imageState |
描述影像的狀態。 |
|
scheduledDeprecationTime |
string |
未來,此映射將會標示為已被取代的時間。 發行者會選擇此排程的時間。 |
ImageState
描述影像的狀態。
名稱 | 類型 | Description |
---|---|---|
Active |
string |
|
Deprecated |
string |
|
ScheduledForDeprecation |
string |
InnerError
內部錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
errordetail |
string |
內部錯誤訊息或例外狀況傾印。 |
exceptiontype |
string |
例外狀況類型。 |
OperatingSystemTypes
osDiskImage 的操作系統。
名稱 | 類型 | Description |
---|---|---|
Linux |
string |
|
Windows |
string |
OSDiskImage
包含 os 磁碟映像資訊。
名稱 | 類型 | Description |
---|---|---|
operatingSystem |
osDiskImage 的操作系統。 |
PurchasePlan
用於透過 MarketPlace 建立第三方成品的購買內容。
名稱 | 類型 | Description |
---|---|---|
name |
string |
方案標識碼。 |
product |
string |
指定來自市集的映像產品。 這個值與 imageReference 元素下的 Offer 值相同。 |
publisher |
string |
發行者標識碼。 |
VirtualMachineImage
描述虛擬機映像。
名稱 | 類型 | Description |
---|---|---|
extendedLocation |
虛擬機的擴充位置。 |
|
id |
string |
資源標識碼 |
location |
string |
支援的 Azure 資源位置。 |
name |
string |
資源的名稱。 |
properties.architecture |
指定架構類型 |
|
properties.automaticOSUpgradeProperties |
描述映像上的自動OS升級屬性。 |
|
properties.dataDiskImages |
包含數據磁碟映像資訊。 |
|
properties.disallowed |
指定從映像建立的 VirtualMachine 不允許的組態 |
|
properties.features |
指定映像支援的其他功能 |
|
properties.hyperVGeneration |
指定 HyperVGeneration 類型 |
|
properties.imageDeprecationStatus |
描述映像上的映像取代狀態屬性。 |
|
properties.osDiskImage |
包含 os 磁碟映像資訊。 |
|
properties.plan |
用於透過 MarketPlace 建立第三方成品的購買內容。 |
|
tags |
object |
指定指派給虛擬機的標記。 如需使用標籤的詳細資訊,請參閱 使用標籤來組織 Azure 資源。 |
VirtualMachineImageFeature
指定映像支援的其他功能
名稱 | 類型 | Description |
---|---|---|
name |
string |
功能的名稱。 |
value |
string |
特徵的對應值。 |
VmDiskTypes
不允許的 VM 磁碟類型。
名稱 | 類型 | Description |
---|---|---|
None |
string |
|
Unmanaged |
string |