Virtual Machines - Reimage

Service:

Compute

Version d'API:

2024-03-01

Reimages (mettre à niveau le système d’exploitation) une machine virtuelle qui n’a pas de disque de système d’exploitation éphémère, pour les machines virtuelles qui ont un disque de système d’exploitation éphémère, la machine virtuelle est réinitialisée à l’état initial. REMARQUE : La conservation de l’ancien disque de système d’exploitation dépend de la valeur de deleteOption du disque du système d’exploitation. Si deleteOption est détaché, l’ancien disque du système d’exploitation est conservé après la réinitialisation. Si deleteOption est supprimé, l’ancien disque du système d’exploitation est supprimé après la réinitialisation. La deleteOption du disque du système d’exploitation doit être mise à jour en conséquence avant d’effectuer la réimage.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reimage?api-version=2024-03-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
vmName	path	True	string	Nom de la machine virtuelle.
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

Nom	Type	Description
parameters	VirtualMachineReimageParameters	Paramètres fournis à l’opération Reimage Virtual Machine.

Réponses

Nom	Type	Description
200 OK		D’ACCORD
202 Accepted		Accepté
Other Status Codes	CloudError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

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

Reimage a Non-Ephemeral Virtual Machine.

Reimage a Virtual Machine.

Reimage a Non-Ephemeral Virtual Machine.

Exemple de requête

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVMName/reimage?api-version=2024-03-01

{
  "tempDisk": true,
  "exactVersion": "aaaaaa",
  "osProfile": {
    "adminPassword": "{your-password}",
    "customData": "{your-custom-data}"
  }
}

Java

import com.azure.resourcemanager.compute.models.OSProfileProvisioningData;
import com.azure.resourcemanager.compute.models.VirtualMachineReimageParameters;

/**
 * Samples for VirtualMachines Reimage.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * virtualMachineExamples/VirtualMachine_Reimage_NonEphemeralVMs.json
     */
    /**
     * Sample code: Reimage a Non-Ephemeral Virtual Machine.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void reimageANonEphemeralVirtualMachine(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachines().reimage(
            "myResourceGroup", "myVMName", new VirtualMachineReimageParameters().withTempDisk(true)
                .withExactVersion("aaaaaa").withOsProfile(new OSProfileProvisioningData()
                    .withAdminPassword("fakeTokenPlaceholder").withCustomData("{your-custom-data}")),
            com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_reimage_non_ephemeral_vms.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    client.virtual_machines.begin_reimage(
        resource_group_name="myResourceGroup",
        vm_name="myVMName",
    ).result()


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineExamples/VirtualMachine_Reimage_NonEphemeralVMs.json
if __name__ == "__main__":
    main()

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

Go

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineExamples/VirtualMachine_Reimage_NonEphemeralVMs.json
func ExampleVirtualMachinesClient_BeginReimage_reimageANonEphemeralVirtualMachine() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewVirtualMachinesClient().BeginReimage(ctx, "myResourceGroup", "myVMName", &armcompute.VirtualMachinesClientBeginReimageOptions{Parameters: &armcompute.VirtualMachineReimageParameters{
		ExactVersion: to.Ptr("aaaaaa"),
		OSProfile: &armcompute.OSProfileProvisioningData{
			AdminPassword: to.Ptr("{your-password}"),
			CustomData:    to.Ptr("{your-custom-data}"),
		},
		TempDisk: to.Ptr(true),
	},
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

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

JavaScript

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Reimages (upgrade the operating system) a virtual machine which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state. NOTE: The retaining of old OS disk depends on the value of deleteOption of OS disk. If deleteOption is detach, the old OS disk will be preserved after reimage. If deleteOption is delete, the old OS disk will be deleted after reimage. The deleteOption of the OS disk should be updated accordingly before performing the reimage.
 *
 * @summary Reimages (upgrade the operating system) a virtual machine which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state. NOTE: The retaining of old OS disk depends on the value of deleteOption of OS disk. If deleteOption is detach, the old OS disk will be preserved after reimage. If deleteOption is delete, the old OS disk will be deleted after reimage. The deleteOption of the OS disk should be updated accordingly before performing the reimage.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineExamples/VirtualMachine_Reimage_NonEphemeralVMs.json
 */
async function reimageANonEphemeralVirtualMachine() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmName = "myVMName";
  const parameters = {
    exactVersion: "aaaaaa",
    osProfile: {
      adminPassword: "{your-password}",
      customData: "{your-custom-data}",
    },
    tempDisk: true,
  };
  const options = { parameters };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.beginReimageAndWait(
    resourceGroupName,
    vmName,
    options,
  );
  console.log(result);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
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/ComputeRP/stable/2024-03-01/examples/virtualMachineExamples/VirtualMachine_Reimage_NonEphemeralVMs.json
// this example is just showing the usage of "VirtualMachines_Reimage" 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 VirtualMachineResource created on azure
// for more information of creating VirtualMachineResource, please refer to the document of VirtualMachineResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string vmName = "myVMName";
ResourceIdentifier virtualMachineResourceId = VirtualMachineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName);
VirtualMachineResource virtualMachine = client.GetVirtualMachineResource(virtualMachineResourceId);

// invoke the operation
VirtualMachineReimageContent content = new VirtualMachineReimageContent()
{
    TempDisk = true,
    ExactVersion = "aaaaaa",
    OSProfile = new OSProfileProvisioningData()
    {
        AdminPassword = "{your-password}",
        CustomData = "{your-custom-data}",
    },
};
await virtualMachine.ReimageAsync(WaitUntil.Completed, content: content);

Console.WriteLine($"Succeeded");

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

Code d’état:

202

Location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2024-03-01

Reimage a Virtual Machine.

Exemple de requête

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVMName/reimage?api-version=2024-03-01

{
  "tempDisk": true
}

Java

import com.azure.resourcemanager.compute.models.VirtualMachineReimageParameters;

/**
 * Samples for VirtualMachines Reimage.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * virtualMachineExamples/VirtualMachine_Reimage.json
     */
    /**
     * Sample code: Reimage a Virtual Machine.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void reimageAVirtualMachine(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachines().reimage("myResourceGroup", "myVMName",
            new VirtualMachineReimageParameters().withTempDisk(true), com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_reimage.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    client.virtual_machines.begin_reimage(
        resource_group_name="myResourceGroup",
        vm_name="myVMName",
    ).result()


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineExamples/VirtualMachine_Reimage.json
if __name__ == "__main__":
    main()

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

Go

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineExamples/VirtualMachine_Reimage.json
func ExampleVirtualMachinesClient_BeginReimage_reimageAVirtualMachine() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewVirtualMachinesClient().BeginReimage(ctx, "myResourceGroup", "myVMName", &armcompute.VirtualMachinesClientBeginReimageOptions{Parameters: &armcompute.VirtualMachineReimageParameters{
		TempDisk: to.Ptr(true),
	},
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

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

JavaScript

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Reimages (upgrade the operating system) a virtual machine which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state. NOTE: The retaining of old OS disk depends on the value of deleteOption of OS disk. If deleteOption is detach, the old OS disk will be preserved after reimage. If deleteOption is delete, the old OS disk will be deleted after reimage. The deleteOption of the OS disk should be updated accordingly before performing the reimage.
 *
 * @summary Reimages (upgrade the operating system) a virtual machine which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state. NOTE: The retaining of old OS disk depends on the value of deleteOption of OS disk. If deleteOption is detach, the old OS disk will be preserved after reimage. If deleteOption is delete, the old OS disk will be deleted after reimage. The deleteOption of the OS disk should be updated accordingly before performing the reimage.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineExamples/VirtualMachine_Reimage.json
 */
async function reimageAVirtualMachine() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmName = "myVMName";
  const parameters = { tempDisk: true };
  const options = { parameters };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.beginReimageAndWait(
    resourceGroupName,
    vmName,
    options,
  );
  console.log(result);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
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/ComputeRP/stable/2024-03-01/examples/virtualMachineExamples/VirtualMachine_Reimage.json
// this example is just showing the usage of "VirtualMachines_Reimage" 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 VirtualMachineResource created on azure
// for more information of creating VirtualMachineResource, please refer to the document of VirtualMachineResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string vmName = "myVMName";
ResourceIdentifier virtualMachineResourceId = VirtualMachineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName);
VirtualMachineResource virtualMachine = client.GetVirtualMachineResource(virtualMachineResourceId);

// invoke the operation
VirtualMachineReimageContent content = new VirtualMachineReimageContent()
{
    TempDisk = true,
};
await virtualMachine.ReimageAsync(WaitUntil.Completed, content: content);

Console.WriteLine($"Succeeded");

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

Code d’état:

202

Location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2024-03-01

Définitions

Nom	Description
ApiError	Erreur d’API.
ApiErrorBase	Base d’erreurs d’API.
CloudError	Réponse d’erreur du service de calcul.
InnerError	Détails de l’erreur interne.
OSProfileProvisioningData	Spécifie les informations requises pour la réinitialisation du disque de système d’exploitation non éphémère.
VirtualMachineReimageParameters	Paramètres fournis à l’opération Reimage Virtual Machine.

ApiError

Erreur d’API.

Nom	Type	Description
code	string	Code d’erreur.
details	ApiErrorBase[]	Détails de l’erreur api
innererror	InnerError	Erreur interne de l’API
message	string	Message d’erreur.
target	string	Cible de l’erreur particulière.

ApiErrorBase

Base d’erreurs d’API.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d’erreur.
target	string	Cible de l’erreur particulière.

CloudError

Réponse d’erreur du service de calcul.

Nom	Type	Description
error	ApiError	Erreur d’API.

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.

OSProfileProvisioningData

Spécifie les informations requises pour la réinitialisation du disque de système d’exploitation non éphémère.

Nom	Type	Description
adminPassword	string	Spécifie le mot de passe du compte d’administrateur. Longueur minimale (Windows) : 8 caractères Longueur minimale (Linux) : 6 caractères Longueur maximale (Windows) : 123 caractères longueur maximale (Linux) : 72 caractères Exigences de complexité : 3 conditions sur 4 ci-dessous doivent être remplies Comporte des caractères inférieurs Comporte des caractères supérieurs A un chiffre A un caractère spécial (correspondance Regex [\W_]) Valeurs non autorisées : « abc@123 », « P@$$w 0rd », « P@ssw0rd », « P@ssword123 », « Pa$$word », « pass@word1 », « Password ! », « Password1 », « Password22 », « iloveyou ! » Pour réinitialiser le mot de passe, consultez Comment réinitialiser le service Bureau à distance ou son mot de passe de connexion dans une machine virtuelle Windows Pour réinitialiser le mot de passe racine, consultez Gérer les utilisateurs, SSH et vérifier ou réparer des disques sur des machines virtuelles Linux Azure à l’aide de l’extension VMAccess
customData	string	Spécifie une chaîne codée en base 64 de données personnalisées. La chaîne encodée en base 64 est décodée dans un tableau binaire enregistré en tant que fichier sur la machine virtuelle. La longueur maximale du tableau binaire est de 65535 octets. Remarque : Ne transmettez pas de secrets ou de mots de passe dans la propriété customData. Cette propriété ne peut pas être mise à jour une fois la machine virtuelle créée. La propriété customData est transmise à la machine virtuelle à enregistrer en tant que fichier, pour plus d’informations, consultez Données personnalisées sur les machines virtuelles Azure. Si vous utilisez cloud-init pour votre machine virtuelle Linux, consultez Utilisation de cloud-init pour personnaliser une machine virtuelle Linux lors de la création.

VirtualMachineReimageParameters

Paramètres fournis à l’opération Reimage Virtual Machine.

Nom	Type	Description
exactVersion	string	Spécifie en nombre décimal la version sur laquelle le disque du système d’exploitation doit être réimagené. Si la version exacte n’est pas fournie, le disque du système d’exploitation est réimagené à la version existante du disque du système d’exploitation.
osProfile	OSProfileProvisioningData	Spécifie les informations requises pour la réinitialisation du disque de système d’exploitation non éphémère.
tempDisk	boolean	Spécifie s’il faut réimager le disque temporaire. Valeur par défaut : false. Remarque : ce paramètre de réimageage de disque temporaire est pris en charge uniquement pour la machine virtuelle/VMSS avec le disque de système d’exploitation éphémère.