Compartilhar via


Virtual Machine Images - Get

Obtém uma imagem de máquina virtual.

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-11-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
location
path True

string

minLength: 1

O nome da região do Azure.

offer
path True

string

Uma oferta válida do editor de imagens.

publisherName
path True

string

Um editor de imagens válido.

skus
path True

string

Uma SKU de imagem válida.

subscriptionId
path True

string

minLength: 1

A ID da assinatura de destino.

version
path True

string

Uma versão de SKU de imagem válida.

api-version
query True

string

minLength: 1

A versão da API a ser usada para esta operação.

Respostas

Nome Tipo Description
200 OK

VirtualMachineImage

A operação do Azure foi concluída com êxito.

Other Status Codes

CloudError

Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

VirtualMachineImage_Get_MaximumSet_Gen
VirtualMachineImage_Get_MinimumSet_Gen

VirtualMachineImage_Get_MaximumSet_Gen

Solicitação de exemplo

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-11-01

Resposta de exemplo

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

Solicitação de exemplo

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-11-01

Resposta de exemplo

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

Definições

Nome Description
AlternativeOption

Descreve a opção alternativa especificada pelo Publicador para essa imagem quando essa imagem é preterida.

AlternativeType

Descreve o tipo da opção alternativa.

ApiError

Erro de API.

ApiErrorBase

Base de erros de API.

ArchitectureTypes

Especifica o tipo de arquitetura

AutomaticOSUpgradeProperties

Descreve as propriedades de atualização automática do sistema operacional na imagem.

CloudError

Uma resposta de erro do serviço de computação.

DataDiskImage

Contém as informações de imagens de disco de dados.

DisallowedConfiguration

Especifica a configuração não permitida para uma imagem de máquina virtual.

ExtendedLocation

O tipo complexo do local estendido.

ExtendedLocationTypes

O tipo de local estendido.

HyperVGenerationTypes

Especifica o tipo de hipervgeração

ImageDeprecationStatus

Descreve as propriedades de status de substituição de imagem na imagem.

ImageState

Descreve o estado da imagem.

InnerError

Detalhes do erro interno.

OperatingSystemTypes

Essa propriedade permite que você especifique o tipo do sistema operacional incluído no disco se criar uma VM com base na imagem do usuário ou em um VHD especializado. Os valores possíveis são: Windows,Linux.

OSDiskImage

Contém as informações de imagem de disco do sistema operacional.

PurchasePlan

Usado para estabelecer o contexto de compra de qualquer artefato de terceiros por meio do MarketPlace.

VirtualMachineImage

Descreve uma imagem de máquina virtual.

VirtualMachineImageFeature

Especifica recursos adicionais compatíveis com a imagem

VmDiskTypes

Tipos de disco de VM que não são permitidos.

AlternativeOption

Descreve a opção alternativa especificada pelo Publicador para essa imagem quando essa imagem é preterida.

Nome Tipo Description
type

AlternativeType

Descreve o tipo da opção alternativa.

value

string

Indica o valor de opção alternativa especificado pelo Publicador. Esse é o nome da oferta quando o tipo é Offer ou o nome do plano quando o tipo é Plan.

AlternativeType

Descreve o tipo da opção alternativa.

Valor Description
None
Offer
Plan

ApiError

Erro de API.

Nome Tipo Description
code

string

O código de erro.

details

ApiErrorBase[]

Os detalhes do erro da API

innererror

InnerError

O erro interno da API

message

string

A mensagem de erro.

target

string

O destino do erro específico.

ApiErrorBase

Base de erros de API.

Nome Tipo Description
code

string

O código de erro.

message

string

A mensagem de erro.

target

string

O destino do erro específico.

ArchitectureTypes

Especifica o tipo de arquitetura

Valor Description
Arm64
x64

AutomaticOSUpgradeProperties

Descreve as propriedades de atualização automática do sistema operacional na imagem.

Nome Tipo Description
automaticOSUpgradeSupported

boolean

Especifica se há suporte para a atualização automática do sistema operacional na imagem.

CloudError

Uma resposta de erro do serviço de computação.

Nome Tipo Description
error

ApiError

Erro de API.

DataDiskImage

Contém as informações de imagens de disco de dados.

Nome Tipo Description
lun

integer (int32)

Especifica o número de unidade lógica do disco de dados. Esse valor é usado para identificar discos de dados dentro da VM e, portanto, deve ser exclusivo para cada disco de dados anexado a uma VM.

DisallowedConfiguration

Especifica a configuração não permitida para uma imagem de máquina virtual.

Nome Tipo Description
vmDiskType

VmDiskTypes

Tipos de disco de VM que não são permitidos.

ExtendedLocation

O tipo complexo do local estendido.

Nome Tipo Description
name

string

O nome do local estendido.

type

ExtendedLocationTypes

O tipo de local estendido.

ExtendedLocationTypes

O tipo de local estendido.

Valor Description
EdgeZone

HyperVGenerationTypes

Especifica o tipo de hipervgeração

Valor Description
V1
V2

ImageDeprecationStatus

Descreve as propriedades de status de substituição de imagem na imagem.

Nome Tipo Description
alternativeOption

AlternativeOption

Descreve a opção alternativa especificada pelo Publicador para essa imagem quando essa imagem é preterida.

imageState

ImageState

Descreve o estado da imagem.

scheduledDeprecationTime

string (date-time)

A hora, no futuro, em que essa imagem será marcada como preterida. Essa hora agendada é escolhida pelo Publicador.

ImageState

Descreve o estado da imagem.

Valor Description
Active
Deprecated
ScheduledForDeprecation

InnerError

Detalhes do erro interno.

Nome Tipo Description
errordetail

string

A mensagem de erro interna ou o despejo de exceção.

exceptiontype

string

O tipo de exceção.

OperatingSystemTypes

Essa propriedade permite que você especifique o tipo do sistema operacional incluído no disco se criar uma VM com base na imagem do usuário ou em um VHD especializado. Os valores possíveis são: Windows,Linux.

Valor Description
Linux
Windows

OSDiskImage

Contém as informações de imagem de disco do sistema operacional.

Nome Tipo Description
operatingSystem

OperatingSystemTypes

O sistema operacional do osDiskImage.

PurchasePlan

Usado para estabelecer o contexto de compra de qualquer artefato de terceiros por meio do MarketPlace.

Nome Tipo Description
name

string

A ID do plano.

product

string

Especifica o produto da imagem do marketplace. Esse é o mesmo valor que Offer no elemento imageReference.

publisher

string

A ID do editor.

VirtualMachineImage

Descreve uma imagem de máquina virtual.

Nome Tipo Description
extendedLocation

ExtendedLocation

O local estendido da Máquina Virtual.

id

string

ID do recurso

location

string

O local do Azure com suporte do recurso.

name

string

O nome do recurso.

properties.architecture

ArchitectureTypes

Especifica o tipo de arquitetura

properties.automaticOSUpgradeProperties

AutomaticOSUpgradeProperties

Descreve as propriedades de atualização automática do sistema operacional na imagem.

properties.dataDiskImages

DataDiskImage[]

A lista de informações de imagens de disco de dados.

properties.disallowed

DisallowedConfiguration

Especifica a configuração não permitida para o VirtualMachine criado a partir da imagem

properties.features

VirtualMachineImageFeature[]

Especifica recursos adicionais compatíveis com a imagem

properties.hyperVGeneration

HyperVGenerationTypes

Especifica o tipo de hipervgeração

properties.imageDeprecationStatus

ImageDeprecationStatus

Descreve as propriedades de status de substituição de imagem na imagem.

properties.osDiskImage

OSDiskImage

Contém as informações de imagem de disco do sistema operacional.

properties.plan

PurchasePlan

Usado para estabelecer o contexto de compra de qualquer artefato de terceiros por meio do MarketPlace.

tags

object

Especifica as marcas atribuídas à máquina virtual. Para obter mais informações sobre como usar marcas, consulte Usar marcas para organizar os recursos do Azure.

VirtualMachineImageFeature

Especifica recursos adicionais compatíveis com a imagem

Nome Tipo Description
name

string

O nome do recurso.

value

string

O valor correspondente para o recurso.

VmDiskTypes

Tipos de disco de VM que não são permitidos.

Valor Description
None
Unmanaged