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-03-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
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 клиента. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
ОК |
|
Other Status Codes |
Ответ об ошибке, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
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"
}
Определения
Имя | Описание |
---|---|
Alternative |
Описывает альтернативный параметр, заданный издателем для этого образа, если этот образ является нерекомендуемым. |
Alternative |
Описывает тип альтернативного варианта. |
Api |
Ошибка API. |
Api |
База ошибок API. |
Architecture |
Указывает тип архитектуры. |
Automatic |
Описывает свойства автоматического обновления ОС в образе. |
Cloud |
Ответ об ошибке от службы вычислений. |
Data |
Содержит сведения об образах дисков данных. |
Disallowed |
Указывает запрещенную конфигурацию для образа виртуальной машины. |
Extended |
Сложный тип расширенного расположения. |
Extended |
Тип расширенного расположения. |
Hyper |
Указывает тип HyperVGeneration. |
Image |
Описывает свойства состояния нерекомендуемого образа. |
Image |
Описывает состояние изображения. |
Inner |
Сведения о внутренней ошибке. |
Operating |
Операционная система osDiskImage. |
OSDisk |
Содержит сведения об образе диска ОС. |
Purchase |
Используется для определения контекста покупки любого артефакта стороннего производителя через MarketPlace. |
Virtual |
Описывает образ виртуальной машины. |
Virtual |
Указывает дополнительные возможности, поддерживаемые изображением. |
Vm |
Типы дисков виртуальных машин, которые запрещены. |
AlternativeOption
Описывает альтернативный параметр, заданный издателем для этого образа, если этот образ является нерекомендуемым.
Имя | Тип | Описание |
---|---|---|
type |
Описывает тип альтернативного варианта. |
|
value |
string |
Указывает значение альтернативного параметра, указанное издателем. Это имя предложения, если тип — Предложение, или имя плана, если тип — Plan. |
AlternativeType
Описывает тип альтернативного варианта.
Имя | Тип | Описание |
---|---|---|
None |
string |
|
Offer |
string |
|
Plan |
string |
ApiError
Ошибка API.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки. |
details |
Сведения об ошибке API |
|
innererror |
Внутренняя ошибка API |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект конкретной ошибки. |
ApiErrorBase
База ошибок API.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки. |
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект конкретной ошибки. |
ArchitectureTypes
Указывает тип архитектуры.
Имя | Тип | Описание |
---|---|---|
Arm64 |
string |
|
x64 |
string |
AutomaticOSUpgradeProperties
Описывает свойства автоматического обновления ОС в образе.
Имя | Тип | Описание |
---|---|---|
automaticOSUpgradeSupported |
boolean |
Указывает, поддерживается ли автоматическое обновление ОС в образе. |
CloudError
Ответ об ошибке от службы вычислений.
Имя | Тип | Описание |
---|---|---|
error |
Ошибка API. |
DataDiskImage
Содержит сведения об образах дисков данных.
Имя | Тип | Описание |
---|---|---|
lun |
integer |
Указывает номер логической единицы диска данных. Это значение используется для идентификации дисков данных в виртуальной машине и поэтому должно быть уникальным для каждого диска данных, подключенного к виртуальной машине. |
DisallowedConfiguration
Указывает запрещенную конфигурацию для образа виртуальной машины.
Имя | Тип | Описание |
---|---|---|
vmDiskType |
Типы дисков виртуальных машин, которые запрещены. |
ExtendedLocation
Сложный тип расширенного расположения.
Имя | Тип | Описание |
---|---|---|
name |
string |
Имя расширенного расположения. |
type |
Тип расширенного расположения. |
ExtendedLocationTypes
Тип расширенного расположения.
Имя | Тип | Описание |
---|---|---|
EdgeZone |
string |
HyperVGenerationTypes
Указывает тип HyperVGeneration.
Имя | Тип | Описание |
---|---|---|
V1 |
string |
|
V2 |
string |
ImageDeprecationStatus
Описывает свойства состояния нерекомендуемого образа.
Имя | Тип | Описание |
---|---|---|
alternativeOption |
Описывает альтернативный параметр, заданный издателем для этого образа, если этот образ является нерекомендуемым. |
|
imageState |
Описывает состояние изображения. |
|
scheduledDeprecationTime |
string |
Время в будущем, когда это изображение будет отмечено как нерекомендуемое. Это запланированное время выбирает издатель. |
ImageState
Описывает состояние изображения.
Имя | Тип | Описание |
---|---|---|
Active |
string |
|
Deprecated |
string |
|
ScheduledForDeprecation |
string |
InnerError
Сведения о внутренней ошибке.
Имя | Тип | Описание |
---|---|---|
errordetail |
string |
Внутреннее сообщение об ошибке или дамп исключений. |
exceptiontype |
string |
Тип исключения. |
OperatingSystemTypes
Операционная система osDiskImage.
Имя | Тип | Описание |
---|---|---|
Linux |
string |
|
Windows |
string |
OSDiskImage
Содержит сведения об образе диска ОС.
Имя | Тип | Описание |
---|---|---|
operatingSystem |
Операционная система osDiskImage. |
PurchasePlan
Используется для определения контекста покупки любого артефакта стороннего производителя через MarketPlace.
Имя | Тип | Описание |
---|---|---|
name |
string |
Идентификатор плана. |
product |
string |
Указывает продукт изображения из Marketplace. Это то же значение, что и Offer в элементе imageReference. |
publisher |
string |
Идентификатор издателя. |
VirtualMachineImage
Описывает образ виртуальной машины.
Имя | Тип | Описание |
---|---|---|
extendedLocation |
Расширенное расположение виртуальной машины. |
|
id |
string |
Идентификатор ресурса |
location |
string |
Поддерживаемая расположение ресурса в Azure. |
name |
string |
Имя ресурса. |
properties.architecture |
Указывает тип архитектуры. |
|
properties.automaticOSUpgradeProperties |
Описывает свойства автоматического обновления ОС в образе. |
|
properties.dataDiskImages |
Содержит сведения об образах дисков данных. |
|
properties.disallowed |
Указывает запрещенную конфигурацию для VirtualMachine, созданной на основе образа. |
|
properties.features |
Указывает дополнительные возможности, поддерживаемые изображением. |
|
properties.hyperVGeneration |
Указывает тип HyperVGeneration. |
|
properties.imageDeprecationStatus |
Описывает свойства состояния нерекомендуемого образа. |
|
properties.osDiskImage |
Содержит сведения об образе диска ОС. |
|
properties.plan |
Используется для определения контекста покупки любого артефакта стороннего производителя через MarketPlace. |
|
tags |
object |
Указывает теги, назначенные виртуальной машине. Дополнительные сведения об использовании тегов см. в статье Использование тегов для упорядочения ресурсов Azure. |
VirtualMachineImageFeature
Указывает дополнительные возможности, поддерживаемые изображением.
Имя | Тип | Описание |
---|---|---|
name |
string |
Имя компонента. |
value |
string |
Соответствующее значение для компонента. |
VmDiskTypes
Типы дисков виртуальных машин, которые запрещены.
Имя | Тип | Описание |
---|---|---|
None |
string |
|
Unmanaged |
string |