Partager via


Virtual Machine Images - Get

Obtient une image de machine virtuelle.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}?api-version=2025-04-01

Paramètres URI

Nom Dans Obligatoire Type Description
location
path True

string

minLength: 1

Nom de la région Azure.

offer
path True

string

Une offre d’éditeur d’images valide.

publisherName
path True

string

Un éditeur d’images valide.

skus
path True

string

Un SKU d’image valide.

subscriptionId
path True

string

minLength: 1

ID de l’abonnement cible.

version
path True

string

Une version SKU d’image valide.

api-version
query True

string

minLength: 1

Version de l’API à utiliser pour cette opération.

Réponses

Nom Type Description
200 OK

VirtualMachineImage

L’opération Azure s’est terminée avec succès.

Other Status Codes

CloudError

Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

VirtualMachineImage_Get_MaximumSet_Gen
VirtualMachineImage_Get_MinimumSet_Gen

VirtualMachineImage_Get_MaximumSet_Gen

Exemple de requête

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=2025-04-01

Exemple de réponse

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

Exemple de requête

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=2025-04-01

Exemple de réponse

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

Définitions

Nom Description
AlternativeOption

Décrit l’autre option spécifiée par le serveur de publication pour cette image lorsque celle-ci est obsolète.

AlternativeType

Décrit le type de l’option alternative.

ApiError

Erreur d’API.

ApiErrorBase

Base d’erreur de l’API.

ArchitectureTypes

Spécifie le type d’architecture

AutomaticOSUpgradeProperties

Décrit les propriétés de mise à niveau automatique du système d’exploitation sur l’image.

CloudError

Réponse d’erreur du service de calcul.

DataDiskImage

Contient les informations sur les images du disque de données.

DisallowedConfiguration

Spécifie la configuration interdite pour une image de machine virtuelle.

ExtendedLocation

Type complexe de l’emplacement étendu.

ExtendedLocationTypes

Type de l’emplacement étendu.

HyperVGenerationTypes

Spécifie le type HyperVGeneration

ImageDeprecationStatus

Décrit les propriétés d’état d’obsolescence de l’image.

ImageState

Décrit l’état de l’image.

InnerError

Détails de l’erreur interne.

OperatingSystemTypes

Cette propriété vous permet de spécifier le type du système d’exploitation inclus dans le disque si vous créez une machine virtuelle à partir d’une image utilisateur ou d’un disque dur virtuel spécialisé. Les valeurs possibles sont : Windows,Linux.

OSDiskImage

Contient les informations de l’image disque du système d’exploitation.

PurchasePlan

Utilisé pour établir le contexte d’achat de tout artefact tiers via MarketPlace.

VirtualMachineImage

Décrit une image de machine virtuelle.

VirtualMachineImageFeature

Spécifie les fonctionnalités supplémentaires prises en charge par l’image

VmDiskTypes

Types de disques de machine virtuelle qui ne sont pas autorisés.

AlternativeOption

Décrit l’autre option spécifiée par le serveur de publication pour cette image lorsque celle-ci est obsolète.

Nom Type Description
type

AlternativeType

Décrit le type de l’option alternative.

value

string

Indique la valeur d’option alternative spécifiée par le serveur de publication. Il s’agit du nom de l’offre lorsque le type est Offre ou du nom du Plan lorsque le type est Plan.

AlternativeType

Décrit le type de l’option alternative.

Valeur Description
None
Offer
Plan

ApiError

Erreur d’API.

Nom Type Description
code

string

Code d’erreur.

details

ApiErrorBase[]

Les détails de l’erreur Api

innererror

InnerError

L’erreur interne de l’API

message

string

Message d’erreur.

target

string

Cible de l’erreur particulière.

ApiErrorBase

Base d’erreur de l’API.

Nom Type Description
code

string

Code d’erreur.

message

string

Message d’erreur.

target

string

Cible de l’erreur particulière.

ArchitectureTypes

Spécifie le type d’architecture

Valeur Description
x64
Arm64

AutomaticOSUpgradeProperties

Décrit les propriétés de mise à niveau automatique du système d’exploitation sur l’image.

Nom Type Description
automaticOSUpgradeSupported

boolean

Spécifie si la mise à niveau automatique du système d’exploitation est prise en charge sur l’image.

CloudError

Réponse d’erreur du service de calcul.

Nom Type Description
error

ApiError

Erreur d’API.

DataDiskImage

Contient les informations sur les images du disque de données.

Nom Type Description
lun

integer (int32)

Spécifie le numéro d’unité logique du disque de données. Cette valeur est utilisée pour identifier les disques de données au sein de la machine virtuelle et doit donc être unique pour chaque disque de données attaché à une machine virtuelle.

DisallowedConfiguration

Spécifie la configuration interdite pour une image de machine virtuelle.

Nom Type Description
vmDiskType

VmDiskTypes

Types de disques de machine virtuelle qui ne sont pas autorisés.

ExtendedLocation

Type complexe de l’emplacement étendu.

Nom Type Description
name

string

Nom de l’emplacement étendu.

type

ExtendedLocationTypes

Type de l’emplacement étendu.

ExtendedLocationTypes

Type de l’emplacement étendu.

Valeur Description
EdgeZone

HyperVGenerationTypes

Spécifie le type HyperVGeneration

Valeur Description
V1
V2

ImageDeprecationStatus

Décrit les propriétés d’état d’obsolescence de l’image.

Nom Type Description
alternativeOption

AlternativeOption

Décrit l’autre option spécifiée par le serveur de publication pour cette image lorsque celle-ci est obsolète.

imageState

ImageState

Décrit l’état de l’image.

scheduledDeprecationTime

string (date-time)

Le moment, à l’avenir, auquel cette image sera marquée comme obsolète. Cette heure programmée est choisie par l’éditeur.

ImageState

Décrit l’état de l’image.

Valeur Description
Active
ScheduledForDeprecation
Deprecated

InnerError

Détails de l’erreur interne.

Nom Type Description
errordetail

string

Message d’erreur interne ou vidage d’exception.

exceptiontype

string

Type d’exception.

OperatingSystemTypes

Cette propriété vous permet de spécifier le type du système d’exploitation inclus dans le disque si vous créez une machine virtuelle à partir d’une image utilisateur ou d’un disque dur virtuel spécialisé. Les valeurs possibles sont : Windows,Linux.

Valeur Description
Windows
Linux

OSDiskImage

Contient les informations de l’image disque du système d’exploitation.

Nom Type Description
operatingSystem

OperatingSystemTypes

Le système d’exploitation de osDiskImage.

PurchasePlan

Utilisé pour établir le contexte d’achat de tout artefact tiers via MarketPlace.

Nom Type Description
name

string

ID du plan.

product

string

Spécifie le produit de l’image à partir de la Place de marché. Il s’agit de la même valeur que Offer sous l’élément imageReference.

publisher

string

ID de l’éditeur.

VirtualMachineImage

Décrit une image de machine virtuelle.

Nom Type Description
extendedLocation

ExtendedLocation

Emplacement étendu de la machine virtuelle.

id

string

ID de ressource

location

string

Emplacement Azure pris en charge de la ressource.

name

string

Nom de la ressource.

properties.architecture

ArchitectureTypes

Spécifie le type d’architecture

properties.automaticOSUpgradeProperties

AutomaticOSUpgradeProperties

Décrit les propriétés de mise à niveau automatique du système d’exploitation sur l’image.

properties.dataDiskImages

DataDiskImage[]

La liste des informations sur les images de disque de données.

properties.disallowed

DisallowedConfiguration

Spécifie la configuration non autorisée pour la VirtualMachine créée à partir de l’image

properties.features

VirtualMachineImageFeature[]

Spécifie les fonctionnalités supplémentaires prises en charge par l’image

properties.hyperVGeneration

HyperVGenerationTypes

Spécifie le type HyperVGeneration

properties.imageDeprecationStatus

ImageDeprecationStatus

Décrit les propriétés d’état d’obsolescence de l’image.

properties.osDiskImage

OSDiskImage

Contient les informations de l’image disque du système d’exploitation.

properties.plan

PurchasePlan

Utilisé pour établir le contexte d’achat de tout artefact tiers via MarketPlace.

tags

object

Spécifie les balises affectées à la machine virtuelle. Pour plus d’informations sur l’utilisation des balises, consultez Utilisation des balises pour organiser vos ressources Azure.

VirtualMachineImageFeature

Spécifie les fonctionnalités supplémentaires prises en charge par l’image

Nom Type Description
name

string

Nom de la fonctionnalité.

value

string

Valeur correspondante pour la fonctionnalité.

VmDiskTypes

Types de disques de machine virtuelle qui ne sont pas autorisés.

Valeur Description
None
Unmanaged