Umimages (Aktualisieren des Betriebssystems) eines virtuellen Computers ohne kurzlebigen Betriebssystemdatenträger. Für virtuelle Computer, die über einen kurzlebigen Betriebssystemdatenträger verfügen, wird der virtuelle Computer auf den Anfangszustand zurückgesetzt. HINWEIS: Die Beibehaltung des alten Betriebssystemdatenträgers hängt vom Wert von deleteOption des Betriebssystemdatenträgers ab. Wenn deleteOption getrennt wird, wird der alte Betriebssystemdatenträger nach dem Erneuten Image beibehalten. Wenn deleteOption gelöscht ist, wird der alte Betriebssystemdatenträger nach dem Erneuten Image gelöscht. Die deleteOption des Betriebssystemdatenträgers sollte entsprechend aktualisiert werden, bevor Sie das Reimage ausführen.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reimage?api-version=2024-03-01
URI-Parameter
| Name |
In |
Erforderlich |
Typ |
Beschreibung |
|
resourceGroupName
|
path |
True
|
string
|
Der Name der Ressourcengruppe.
|
|
subscriptionId
|
path |
True
|
string
|
Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
|
|
vmName
|
path |
True
|
string
|
Der Name des virtuellen Computers.
|
|
api-version
|
query |
True
|
string
|
Client-API-Version.
|
Anforderungstext
Antworten
| Name |
Typ |
Beschreibung |
|
200 OK
|
|
OK
|
|
202 Accepted
|
|
Akzeptiert
|
|
Other Status Codes
|
CloudError
|
Fehlerantwort mit Beschreibung des Grunds für den Fehler.
|
Sicherheit
azure_auth
Azure Active Directory-OAuth2-Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name |
Beschreibung |
|
user_impersonation
|
Identitätswechsel Ihres Benutzerkontos
|
Beispiele
Reimage a Non-Ephemeral Virtual Machine.
Sample Request
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}"
}
}
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
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
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
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
Sample Response
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.
Sample Request
POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVMName/reimage?api-version=2024-03-01
{
"tempDisk": true
}
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
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
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
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
Sample Response
Location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2024-03-01
Definitionen
ApiError
API-Fehler.
| Name |
Typ |
Beschreibung |
|
code
|
string
|
Der Fehlercode.
|
|
details
|
ApiErrorBase[]
|
Api-Fehlerdetails
|
|
innererror
|
InnerError
|
Der innere Api-Fehler
|
|
message
|
string
|
Die Fehlermeldung.
|
|
target
|
string
|
Das Ziel des jeweiligen Fehlers.
|
ApiErrorBase
API-Fehlerbasis.
| Name |
Typ |
Beschreibung |
|
code
|
string
|
Der Fehlercode.
|
|
message
|
string
|
Die Fehlermeldung.
|
|
target
|
string
|
Das Ziel des jeweiligen Fehlers.
|
CloudError
Eine Fehlerantwort des Computediensts.
| Name |
Typ |
Beschreibung |
|
error
|
ApiError
|
API-Fehler.
|
InnerError
Innere Fehlerdetails.
| Name |
Typ |
Beschreibung |
|
errordetail
|
string
|
Das interne Fehlermeldungs- oder Ausnahmedump.
|
|
exceptiontype
|
string
|
Der Ausnahmetyp.
|
OSProfileProvisioningData
Gibt Informationen an, die zum Neuagieren des nicht kurzlebigen Betriebssystemdatenträgers erforderlich sind.
| Name |
Typ |
Beschreibung |
|
adminPassword
|
string
|
Gibt das Kennwort des Administratorkontos an.
Mindestlänge (Windows): 8 Zeichen
Mindestlänge (Linux): 6 Zeichen
Maximale Länge (Windows): 123 Zeichen
Maximale Länge (Linux): 72 Zeichen
Komplexitätsanforderungen: 3 von vier folgenden Bedingungen müssen erfüllt werden
Hat niedrigere Zeichen
Hat obere Zeichen
Verfügt über eine Ziffer
Hat ein Sonderzeichen (Regex-Übereinstimmung [\W_])
Unzulässige Werte: "abc@123", "P@$$w 0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"
Informationen zum Zurücksetzen des Kennworts finden Sie unter Zurücksetzen des Remotedesktopdiensts oder seines Anmeldekennworts auf einem virtuellen Windows-Computer.
Informationen zum Zurücksetzen des Stammkennworts finden Sie unter Verwalten von Benutzern, SSH und Überprüfen oder Reparieren von Datenträgern auf Azure Linux-VMs mithilfe der VMAccess-Erweiterung.
|
|
customData
|
string
|
Gibt eine Base-64-codierte Zeichenfolge benutzerdefinierter Daten an. Die Base-64-codierte Zeichenfolge wird in ein binäres Array decodiert, das auf dem virtuellen Computer als Datei gespeichert wird. Die maximale Länge des binären Arrays beträgt 65535 Bytes. Hinweis: Übergeben Sie keine Geheimnisse oder Kennwörter in der customData-Eigenschaft. Diese Eigenschaft kann nicht aktualisiert werden, nachdem die VM erstellt wurde. Die Eigenschaft customData wird an den virtuellen Computer übergeben, um als Datei gespeichert zu werden. 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
Parameter, die für den Reimage Virtual Machine-Vorgang bereitgestellt werden.
| Name |
Typ |
Beschreibung |
|
exactVersion
|
string
|
Gibt in Dezimalzahl die Version an, in die der Betriebssystemdatenträger umgeschrieben werden soll. Wenn keine genaue Version angegeben wird, wird der Betriebssystemdatenträger auf die vorhandene Version des Betriebssystemdatenträgers umgestellt.
|
|
osProfile
|
OSProfileProvisioningData
|
Gibt Informationen an, die zum Neuagieren des nicht kurzlebigen Betriebssystemdatenträgers erforderlich sind.
|
|
tempDisk
|
boolean
|
Gibt an, ob ein temporärer Datenträger als Image umgestaltet werden soll. Standardwert: False Hinweis: Dieser Parameter für temporäre Datenträgerreimages wird nur für VM/VMSS mit kurzlebigem Betriebssystemdatenträger unterstützt.
|