Partilhar 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-07-01

Parâmetros do URI

Name Em Necessário Tipo Description
location
path True

string

O nome de uma região do Azure com suporte.

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

Um SKU de imagem válido.

subscriptionId
path True

string

Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.

version
path True

string

Uma versão SKU de imagem válida.

api-version
query True

string

Versão da API do cliente.

Respostas

Name Tipo Description
200 OK

VirtualMachineImage

OK

Other Status Codes

CloudError

Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

VirtualMachineImage_Get_MaximumSet_Gen
VirtualMachineImage_Get_MinimumSet_Gen

VirtualMachineImage_Get_MaximumSet_Gen

Pedido de amostra

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

Resposta da amostra

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

Pedido de amostra

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

Resposta da amostra

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

Definições

Name Description
AlternativeOption

Descreve a opção alternativa especificada pelo Publisher para esta imagem quando esta imagem é preterida.

AlternativeType

Descreve o tipo da opção alternativa.

ApiError

Erro de api.

ApiErrorBase

Base de erro da 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 HyperVGeneration

ImageDeprecationStatus

Descreve as propriedades de status de depreciação da imagem na imagem.

ImageState

Descreve o estado da imagem.

InnerError

Detalhes do erro interno.

OperatingSystemTypes

O sistema operacional do osDiskImage.

OSDiskImage

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

PurchasePlan

Usado para estabelecer o contexto de compra de qualquer artefato de 3ª Parte através do MarketPlace.

VirtualMachineImage

Descreve uma imagem de máquina virtual.

VirtualMachineImageFeature

Especifica recursos adicionais suportados pela imagem

VmDiskTypes

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

AlternativeOption

Descreve a opção alternativa especificada pelo Publisher para esta imagem quando esta imagem é preterida.

Name Tipo Description
type

AlternativeType

Descreve o tipo da opção alternativa.

value

string

Indica o valor da opção alternativa especificada pelo Editor. Este é o nome da Oferta quando o tipo é Oferta ou o nome do Plano quando o tipo é Plano.

AlternativeType

Descreve o tipo da opção alternativa.

Name Tipo Description
None

string

Offer

string

Plan

string

ApiError

Erro de api.

Name Tipo Description
code

string

O código de erro.

details

ApiErrorBase[]

Os detalhes do erro Api

innererror

InnerError

O erro interno da Api

message

string

A mensagem de erro.

target

string

O alvo do erro específico.

ApiErrorBase

Base de erro da api.

Name Tipo Description
code

string

O código de erro.

message

string

A mensagem de erro.

target

string

O alvo do erro específico.

ArchitectureTypes

Especifica o tipo de arquitetura

Name Tipo Description
Arm64

string

x64

string

AutomaticOSUpgradeProperties

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

Name Tipo Description
automaticOSUpgradeSupported

boolean

Especifica se a atualização automática do sistema operacional é suportada na imagem.

CloudError

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

Name Tipo Description
error

ApiError

Erro de api.

DataDiskImage

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

Name Tipo Description
lun

integer

Especifica o número da 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 conectado a uma VM.

DisallowedConfiguration

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

Name Tipo Description
vmDiskType

VmDiskTypes

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

ExtendedLocation

O tipo complexo do local estendido.

Name Tipo Description
name

string

O nome do local estendido.

type

ExtendedLocationTypes

O tipo de local estendido.

ExtendedLocationTypes

O tipo de local estendido.

Name Tipo Description
EdgeZone

string

HyperVGenerationTypes

Especifica o tipo HyperVGeneration

Name Tipo Description
V1

string

V2

string

ImageDeprecationStatus

Descreve as propriedades de status de depreciação da imagem na imagem.

Name Tipo Description
alternativeOption

AlternativeOption

Descreve a opção alternativa especificada pelo Publisher para esta imagem quando esta imagem é preterida.

imageState

ImageState

Descreve o estado da imagem.

scheduledDeprecationTime

string

O momento, no futuro, em que esta imagem será marcada como obsoleta. Esta hora agendada é escolhida pela Editora.

ImageState

Descreve o estado da imagem.

Name Tipo Description
Active

string

Deprecated

string

ScheduledForDeprecation

string

InnerError

Detalhes do erro interno.

Name Tipo Description
errordetail

string

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

exceptiontype

string

O tipo de exceção.

OperatingSystemTypes

O sistema operacional do osDiskImage.

Name Tipo Description
Linux

string

Windows

string

OSDiskImage

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

Name Tipo Description
operatingSystem

OperatingSystemTypes

O sistema operacional do osDiskImage.

PurchasePlan

Usado para estabelecer o contexto de compra de qualquer artefato de 3ª Parte através do MarketPlace.

Name Tipo Description
name

string

O ID do plano.

product

string

Especifica o produto da imagem do mercado. Este é o mesmo valor que Offer sob o elemento imageReference.

publisher

string

O ID do editor.

VirtualMachineImage

Descreve uma imagem de máquina virtual.

Name 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[]

Contém as 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 suportados pela imagem

properties.hyperVGeneration

HyperVGenerationTypes

Especifica o tipo HyperVGeneration

properties.imageDeprecationStatus

ImageDeprecationStatus

Descreve as propriedades de status de depreciação da imagem na imagem.

properties.osDiskImage

OSDiskImage

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

properties.plan

PurchasePlan

Usado para estabelecer o contexto de compra de qualquer artefato de 3ª Parte através do MarketPlace.

tags

object

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

VirtualMachineImageFeature

Especifica recursos adicionais suportados pela imagem

Name Tipo Description
name

string

O nome do recurso.

value

string

O valor correspondente para o recurso.

VmDiskTypes

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

Name Tipo Description
None

string

Unmanaged

string