Virtual Machine Scale Sets - Reimage

Referenz

Service:: Compute

API Version:: 2024-03-01

Reimages (Upgrade des Betriebssystems) mindestens einen virtuellen Computer in einer VM-Skalierungsgruppe, die keinen kurzlebigen Betriebssystemdatenträger aufweisen. Für virtuelle Computer, die über einen kurzlebigen Betriebssystemdatenträger verfügen, wird der virtuelle Computer auf den Anfangszustand zurückgesetzt.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/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.
vmScaleSetName	path	True	string	Der Name der VM-Skalierungsgruppe.
api-version	query	True	string	Client-API-Version.

Anforderungstext

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.
forceUpdateOSDiskForEphemeral	boolean	Parameter zum Erzwingen der Aktualisierung eines kurzlebigen Betriebssystemdatenträgers für eine VM mit VM-Skalierungsgruppe
instanceIds	string[]	Die VM-Skalierungsgruppe instance-IDs. Das Weglassen der VM-Skalierungsgruppe instance-IDs führt dazu, dass der Vorgang auf allen virtuellen Computern in der VM-Skalierungsgruppe ausgeführt wird.
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.

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

VirtualMachineScaleSet_Reimage_MaximumSet_Gen

VirtualMachineScaleSet_Reimage_MinimumSet_Gen

VirtualMachineScaleSet_Reimage_MaximumSet_Gen

Sample Request

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

{
  "instanceIds": [
    "aaaaaaaaaa"
  ],
  "forceUpdateOSDiskForEphemeral": true,
  "tempDisk": true
}

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_scale_set_reimage_maximum_set_gen.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_machine_scale_sets.begin_reimage(
        resource_group_name="rgcompute",
        vm_scale_set_name="aaaaaaaaaaaaaaaaaaaaaaaaaa",
    ).result()


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MaximumSet_Gen.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/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MaximumSet_Gen.json
func ExampleVirtualMachineScaleSetsClient_BeginReimage_virtualMachineScaleSetReimageMaximumSetGen() {
	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.NewVirtualMachineScaleSetsClient().BeginReimage(ctx, "rgcompute", "aaaaaaaaaaaaaaaaaaaaaaaaaa", &armcompute.VirtualMachineScaleSetsClientBeginReimageOptions{VMScaleSetReimageInput: &armcompute.VirtualMachineScaleSetReimageParameters{
		TempDisk:                      to.Ptr(true),
		ForceUpdateOSDiskForEphemeral: to.Ptr(true),
		InstanceIDs: []*string{
			to.Ptr("aaaaaaaaaa")},
	},
	})
	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) one or more virtual machines in a VM scale set 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.
 *
 * @summary Reimages (upgrade the operating system) one or more virtual machines in a VM scale set 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.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MaximumSet_Gen.json
 */
async function virtualMachineScaleSetReimageMaximumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
  const vmScaleSetName = "aaaaaaaaaaaaaaaaaaaaaaaaaa";
  const vmScaleSetReimageInput = {
    forceUpdateOSDiskForEphemeral: true,
    instanceIds: ["aaaaaaaaaa"],
    tempDisk: true,
  };
  const options = {
    vmScaleSetReimageInput,
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSets.beginReimageAndWait(
    resourceGroupName,
    vmScaleSetName,
    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

Status code:: 200

Status code:: 202

location: https://foo.com/operationstatus

VirtualMachineScaleSet_Reimage_MinimumSet_Gen

Sample Request

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

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_scale_set_reimage_minimum_set_gen.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_machine_scale_sets.begin_reimage(
        resource_group_name="rgcompute",
        vm_scale_set_name="aaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    ).result()


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MinimumSet_Gen.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/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/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MinimumSet_Gen.json
func ExampleVirtualMachineScaleSetsClient_BeginReimage_virtualMachineScaleSetReimageMinimumSetGen() {
	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.NewVirtualMachineScaleSetsClient().BeginReimage(ctx, "rgcompute", "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", &armcompute.VirtualMachineScaleSetsClientBeginReimageOptions{VMScaleSetReimageInput: nil})
	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) one or more virtual machines in a VM scale set 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.
 *
 * @summary Reimages (upgrade the operating system) one or more virtual machines in a VM scale set 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.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MinimumSet_Gen.json
 */
async function virtualMachineScaleSetReimageMinimumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
  const vmScaleSetName = "aaaaaaaaaaaaaaaaaaaaaaaaaaaa";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSets.beginReimageAndWait(
    resourceGroupName,
    vmScaleSetName,
  );
  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

Status code:: 200

Status code:: 202

location: https://foo.com/operationstatus

Definitionen

Name	Beschreibung
ApiError	API-Fehler.
ApiErrorBase	API-Fehlerbasis.
CloudError	Eine Fehlerantwort des Computediensts.
InnerError	Innere Fehlerdetails.
OSProfileProvisioningData	Zusätzliche Parameter für das Reimaging nicht kurzlebiger virtueller Computer.
VirtualMachineScaleSetReimageParameters	Beschreibt VM-Reimageparameter für VM-Skalierungsgruppen.

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

Zusätzliche Parameter für das Reimaging nicht kurzlebiger virtueller Computer.

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.

VirtualMachineScaleSetReimageParameters

Beschreibt VM-Reimageparameter für VM-Skalierungsgruppen.

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.
forceUpdateOSDiskForEphemeral	boolean	Parameter zum Erzwingen der Aktualisierung eines kurzlebigen Betriebssystemdatenträgers für eine VM mit VM-Skalierungsgruppe
instanceIds	string[]	Die VM-Skalierungsgruppe instance-IDs. Das Weglassen der VM-Skalierungsgruppe instance-IDs führt dazu, dass der Vorgang auf allen virtuellen Computern in der VM-Skalierungsgruppe ausgeführt wird.
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.

Virtual Machine Scale Sets - Reimage

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Scopes

Beispiele

VirtualMachineScaleSet_Reimage_MaximumSet_Gen

Sample Request

Sample Response

VirtualMachineScaleSet_Reimage_MinimumSet_Gen

Sample Request

Sample Response

Definitionen

ApiError

ApiErrorBase

CloudError

InnerError

OSProfileProvisioningData

VirtualMachineScaleSetReimageParameters

Zusätzliche Ressourcen