Virtual Machine Images - Get

Service:: Compute

Version d'API:: 2025-11-01

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
location	path	True	string minLength: 1	Le nom de la région d’Azure.
offer	path	True	string	Offre d’éditeur d’images valide.
publisherName	path	True	string	Éditeur d’images valide.
skus	path	True	string	Référence SKU d’image valide.
subscriptionId	path	True	string minLength: 1	ID de l’abonnement cible.
version	path	True	string	Version de référence 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	Opération Azure terminée avec succès.
Other Status Codes	CloudError	Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

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

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/Compute/stable/2025-11-01/examples/virtualMachineImageExamples/VirtualMachineImage_Get_MaximumSet_Gen.json
// this example is just showing the usage of "VirtualMachineImages_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "{subscription-id}";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
AzureLocation location = new AzureLocation("aaaaaa");
string publisherName = "aaa";
string offer = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
string skus = "aaaaaaaaaaaaaaaaaaaaaaaaaaa";
string version = "aaaaaaaaaaaaaaaaaaa";
VirtualMachineImage result = await subscriptionResource.GetVirtualMachineImageAsync(location, publisherName, offer, skus, version);

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:: 200

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

HTTP
dotnet

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/Compute/stable/2025-11-01/examples/virtualMachineImageExamples/VirtualMachineImage_Get_MinimumSet_Gen.json
// this example is just showing the usage of "VirtualMachineImages_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "{subscription-id}";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
AzureLocation location = new AzureLocation("aaaaaaaaaaaa");
string publisherName = "aaaaaaaaaaa";
string offer = "aa";
string skus = "aaaaaaaaa";
string version = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
VirtualMachineImage result = await subscriptionResource.GetVirtualMachineImageAsync(location, publisherName, offer, skus, version);

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
AlternativeOption	Décrit l’option alternative spécifiée par le serveur de publication pour cette image lorsque cette image est déconseillée.
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 de disque de données.
DisallowedConfiguration	Spécifie la configuration non autorisée 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 de dépréciation de l’image sur 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 personnalisée. Les valeurs possibles sont : Windows,Linux.
OSDiskImage	Contient les informations d’image de disque du système d’exploitation.
PurchasePlan	Utilisé pour établir le contexte d’achat d’un artefact tiers via MarketPlace.
VirtualMachineImage	Décrit une image de machine virtuelle.
VirtualMachineImageFeature	Spécifie des fonctionnalités supplémentaires prises en charge par l’image
VmDiskTypes	Types de disques de machine virtuelle non autorisés.

AlternativeOption

Objet

Décrit l’option alternative spécifiée par le serveur de publication pour cette image lorsque cette image est déconseillée.

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 le nom du plan lorsque le type est Plan.

AlternativeType

Énumération

Décrit le type de l’option alternative.

Valeur	Description
None
Offer
Plan

ApiError

Objet

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

Objet

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

Énumération

Spécifie le type d’architecture

Valeur	Description
x64
Arm64

AutomaticOSUpgradeProperties

Objet

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

Objet

Réponse d’erreur du service de calcul.

Nom	Type	Description
error	ApiError	Erreur d’API.

DataDiskImage

Objet

Contient les informations sur les images de 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

Objet

Spécifie la configuration non autorisée pour une image de machine virtuelle.

Nom	Type	Description
vmDiskType	VmDiskTypes	Types de disques de machine virtuelle non autorisés.

ExtendedLocation

Objet

Type complexe de l’emplacement étendu.

Nom	Type	Description
name	string	Nom de l’emplacement étendu.
type	ExtendedLocationTypes	Type de l’emplacement étendu.

ExtendedLocationTypes

Énumération

Type de l’emplacement étendu.

Valeur	Description
EdgeZone

HyperVGenerationTypes

Énumération

Spécifie le type HyperVGeneration

Valeur	Description
V1
V2

ImageDeprecationStatus

Objet

Décrit les propriétés d’état de dépréciation de l’image sur l’image.

Nom	Type	Description
alternativeOption	AlternativeOption	Décrit l’option alternative spécifiée par le serveur de publication pour cette image lorsque cette image est déconseillée.
imageState	ImageState	Décrit l’état de l’image.
scheduledDeprecationTime	string (date-time)	L’heure, à l’avenir, à laquelle cette image sera marquée comme déconseillée. Cette heure planifiée est choisie par le serveur de publication.

ImageState

Énumération

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

Valeur	Description
Active
ScheduledForDeprecation
Deprecated

InnerError

Objet

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

Énumération

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 personnalisée. Les valeurs possibles sont : Windows,Linux.

Valeur	Description
Windows
Linux

OSDiskImage

Objet

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

Nom	Type	Description
operatingSystem	OperatingSystemTypes	Système d’exploitation de osDiskImage.

PurchasePlan

Objet

Utilisé pour établir le contexte d’achat d’un 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.