Virtual Machines - Reimage

Dienst:: Compute

API-Version:: 2025-11-01

Erstellt ein Reimaging (Upgrade des Betriebssystems) für eine virtuelle Maschine, die nicht über einen kurzlebigen Betriebssystemdatenträger verfügt, für virtuelle Maschinen mit einem kurzlebigen Betriebssystemdatenträger wird der virtuelle Computer auf den ursprünglichen Zustand zurückgesetzt. HINWEIS: Die Beibehaltung des alten Betriebssystemdatenträgers hängt vom Wert des DeleteOption-Betriebssystemdatenträgers ab. Wenn "deleteOption" abtrennt wird, wird der alte Betriebssystemdatenträger nach dem erneuten Image beibehalten. Wenn deleteOption gelöscht wird, wird der alte Betriebssystemdatenträger nach einer Neuimage gelöscht. Die deleteOption des Betriebssystemdatenträgers sollte entsprechend aktualisiert werden, bevor Sie die Neuimage ausführen.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
vmName	path	True	string	Der Name des virtuellen Computers.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
exactVersion	string	Gibt eine Dezimalzahl an, in der die Version des Betriebssystemdatenträgers neu erstellt werden soll. Wenn keine genaue Version bereitgestellt wird, wird der Betriebssystemdatenträger auf die vorhandene Version des Betriebssystemdatenträgers umgestellt.
osProfile	OSProfileProvisioningData	Gibt Informationen an, die für das erneute Erstellen eines Images des nicht kurzlebigen Betriebssystemdatenträgers erforderlich sind.
tempDisk	boolean	Gibt an, ob der temporäre Datenträger neu erstellt werden soll. Standardwert: False. Hinweis: Dieser parameter für temporäre Datenträgerumwendung wird nur für VM/VMSS mit ephemeralem Betriebssystemdatenträger unterstützt.

Antworten

Name	Typ	Beschreibung
200 OK		Die Anforderung ist erfolgreich.
202 Accepted		Ressourcenvorgang akzeptiert. Header Location: string Retry-After: integer
Other Status Codes	CloudError	Unerwartete Fehlerantwort.

Name

Typ

Beschreibung

200 OK

Die Anforderung ist erfolgreich.

202 Accepted

Ressourcenvorgang akzeptiert.

Header

Location: string
Retry-After: integer

Other Status Codes

CloudError

Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Reimage a Non-Ephemeral Virtual Machine.

Reimage a Virtual Machine.

Reimage a Non-Ephemeral Virtual Machine.

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

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

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.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/Compute/stable/2025-11-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

Beispiel für eine Antwort

Statuscode:: 200

Statuscode:: 202

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

Reimage a Virtual Machine.

Beispielanforderung

HTTP
dotnet

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

{
  "tempDisk": true
}

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.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/Compute/stable/2025-11-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

Beispiel für eine Antwort

Statuscode:: 200

Statuscode:: 202

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

Definitionen

Name	Beschreibung
ApiError	API-Fehler.
ApiErrorBase	API-Fehlerbasis.
CloudError	Eine Fehlerantwort vom Compute-Dienst.
InnerError	Innere Fehlerdetails.
OSProfileProvisioningData	Zusätzliche Parameter für das Reimaging non-Ephemeral Virtual Machine.
VirtualMachineReimageParameters	Parameter für den virtuellen Computer zum Reimaging. HINWEIS: Der Betriebssystemdatenträger des virtuellen Computers wird immer umimaged ausgeführt.

ApiError

Objekt

API-Fehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	ApiErrorBase[]	Die Details zum API-Fehler
innererror	InnerError	Der innere API-Fehler
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

ApiErrorBase

Objekt

API-Fehlerbasis.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

CloudError

Objekt

Eine Fehlerantwort vom Compute-Dienst.

Name	Typ	Beschreibung
error	ApiError	API-Fehler.

InnerError

Objekt

Innere Fehlerdetails.

Name	Typ	Beschreibung
errordetail	string	Die interne Fehlermeldung oder der Ausnahmedump.
exceptiontype	string	Der Ausnahmetyp.

OSProfileProvisioningData

Objekt

Zusätzliche Parameter für das Reimaging non-Ephemeral Virtual Machine.

Name	Typ	Beschreibung
adminPassword	string (password)	Gibt das Kennwort des Administratorkontos an. Mindestlänge (Windows): 8 Zeichen Mindestlänge (Linux): 6 Zeichen Max-Länge (Windows): 123 Zeichen Maximale Länge (Linux): 72 Zeichen Komplexitätsanforderungen: 3 von 4 unten aufgeführten Bedingungen müssen erfüllt sein Enthält Zeichen mit niedrigeren Zeichen Enthält groß geschriebene Zeichen Hat eine Ziffer Weist ein Sonderzeichen auf (Regex-Übereinstimmung [\W_]) Unzulässige Werte: "abc@123", "P@$$w 0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Passwort!", "Passwort1", "Passwort22", "iloveyou!" Um das Passwort zurückzusetzen, siehe Wie man den Remote Desktop-Dienst oder sein Anmeldepasswort in einer Windows VM Um das Root-Passwort zurückzusetzen, siehe Benutzer verwalten, SSH und Festplatten auf Azure Linux-VMs mit der VMAccess-Erweiterung
customData	string	Gibt eine base64-codierte Zeichenfolge von benutzerdefinierten Daten an. Die base64-codierte Zeichenfolge wird mit einem binären Array decodiert, das als Datei auf dem virtuellen Computer gespeichert wird. Die maximale Länge des binären Arrays beträgt 65535 Bytes. Hinweis: Übergeben Sie keine geheimen Schlüssel oder Kennwörter in der customData-Eigenschaft. Diese Eigenschaft kann nicht aktualisiert werden, nachdem der virtuelle Computer erstellt wurde. Die Eigenschaft customData wird an die VM übergeben, die als Datei gespeichert werden soll. Weitere Informationen finden Sie unter Benutzerdefinierte Daten auf Azure-VMs. Wenn Sie cloud-init für Ihre Linux-VM verwenden, finden Sie weitere Informationen unter Verwenden von cloud-init zum Anpassen einer Linux-VM während der Erstellung.

VirtualMachineReimageParameters

Objekt

Parameter für den virtuellen Computer zum Reimaging. HINWEIS: Der Betriebssystemdatenträger des virtuellen Computers wird immer umimaged ausgeführt.

Name	Typ	Beschreibung
exactVersion	string	Gibt eine Dezimalzahl an, in der die Version des Betriebssystemdatenträgers neu erstellt werden soll. Wenn keine genaue Version bereitgestellt wird, wird der Betriebssystemdatenträger auf die vorhandene Version des Betriebssystemdatenträgers umgestellt.
osProfile	OSProfileProvisioningData	Gibt Informationen an, die für das erneute Erstellen eines Images des nicht kurzlebigen Betriebssystemdatenträgers erforderlich sind.
tempDisk	boolean	Gibt an, ob der temporäre Datenträger neu erstellt werden soll. Standardwert: False. Hinweis: Dieser parameter für temporäre Datenträgerumwendung wird nur für VM/VMSS mit ephemeralem Betriebssystemdatenträger unterstützt.