Virtual Machine Scale Sets - Reimage

Serviço:

Compute

Versão da API:

2024-07-01

Recria imagens (atualiza o sistema operacional) de uma ou mais máquinas virtuais em um conjunto de escala de VM que não têm um disco de sistema operacional efêmero, para máquinas virtuais que têm um disco de sistema operacional efêmero, a máquina virtual é redefinida para o estado inicial.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.
vmScaleSetName	path	True	string	O nome do conjunto de escala de VM.
api-version	query	True	string	Versão da API do cliente.

Corpo do Pedido

Name	Tipo	Description
exactVersion	string	Especifica em número decimal, a versão para a qual o disco do sistema operacional deve ser recriado. Se a versão exata não for fornecida, o disco do sistema operacional será recriado para a versão existente do disco do sistema operacional.
forceUpdateOSDiskForEphemeral	boolean	Parâmetro para forçar a atualização do disco efêmero do sistema operacional para uma VM de conjunto de escala de máquina virtual
instanceIds	string[]	A máquina virtual dimensiona as ids de instância do conjunto. Omitir as ids de instância do conjunto de escala da máquina virtual resultará na execução da operação em todas as máquinas virtuais do conjunto de escala da máquina virtual.
osProfile	OSProfileProvisioningData	Especifica as informações necessárias para a criação de imagens do disco do sistema operacional não efêmero.
tempDisk	boolean	Especifica se o disco temporário deve ser recriado. Valor padrão: false. Nota: Este parâmetro de reimagem de disco temporário só é suportado para VM/VMSS com disco de SO efémero.

Respostas

Name	Tipo	Description
200 OK		OK
202 Accepted		Aceito
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

VirtualMachineScaleSet_Reimage_MaximumSet_Gen

VirtualMachineScaleSet_Reimage_MinimumSet_Gen

VirtualMachineScaleSet_Reimage_MaximumSet_Gen

Pedido de amostra

HTTP

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

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

Java

import com.azure.resourcemanager.compute.models.VirtualMachineScaleSetReimageParameters;
import java.util.Arrays;

/**
 * Samples for VirtualMachineScaleSets Reimage.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MaximumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachineScaleSet_Reimage_MaximumSet_Gen.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        virtualMachineScaleSetReimageMaximumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSets().reimage("rgcompute",
            "aaaaaaaaaaaaaaaaaaaaaaaaaa", new VirtualMachineScaleSetReimageParameters().withTempDisk(true)
                .withForceUpdateOSDiskForEphemeral(true).withInstanceIds(Arrays.asList("aaaaaaaaaa")),
            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_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-07-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

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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-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

JavaScript

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-07-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

dotnet

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.Models;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MaximumSet_Gen.json
// this example is just showing the usage of "VirtualMachineScaleSets_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 VirtualMachineScaleSetResource created on azure
// for more information of creating VirtualMachineScaleSetResource, please refer to the document of VirtualMachineScaleSetResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "rgcompute";
string virtualMachineScaleSetName = "aaaaaaaaaaaaaaaaaaaaaaaaaa";
ResourceIdentifier virtualMachineScaleSetResourceId = VirtualMachineScaleSetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName);
VirtualMachineScaleSetResource virtualMachineScaleSet = client.GetVirtualMachineScaleSetResource(virtualMachineScaleSetResourceId);

// invoke the operation
VirtualMachineScaleSetReimageContent content = new VirtualMachineScaleSetReimageContent
{
    InstanceIds = { "aaaaaaaaaa" },
    ForceUpdateOSDiskForEphemeral = true,
    TempDisk = true,
};
await virtualMachineScaleSet.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

Resposta da amostra

Código de estado:

200

Código de estado:

202

location: https://foo.com/operationstatus

VirtualMachineScaleSet_Reimage_MinimumSet_Gen

Pedido de amostra

HTTP

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

Java

/**
 * Samples for VirtualMachineScaleSets Reimage.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MinimumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachineScaleSet_Reimage_MinimumSet_Gen.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        virtualMachineScaleSetReimageMinimumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSets().reimage("rgcompute",
            "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", null, 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_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-07-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

Go

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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-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

JavaScript

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-07-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

dotnet

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.Models;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MinimumSet_Gen.json
// this example is just showing the usage of "VirtualMachineScaleSets_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 VirtualMachineScaleSetResource created on azure
// for more information of creating VirtualMachineScaleSetResource, please refer to the document of VirtualMachineScaleSetResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "rgcompute";
string virtualMachineScaleSetName = "aaaaaaaaaaaaaaaaaaaaaaaaaaaa";
ResourceIdentifier virtualMachineScaleSetResourceId = VirtualMachineScaleSetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName);
VirtualMachineScaleSetResource virtualMachineScaleSet = client.GetVirtualMachineScaleSetResource(virtualMachineScaleSetResourceId);

// invoke the operation
await virtualMachineScaleSet.ReimageAsync(WaitUntil.Completed);

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

Resposta da amostra

Código de estado:

200

Código de estado:

202

location: https://foo.com/operationstatus

Definições

Name	Description
ApiError	Erro de api.
ApiErrorBase	Base de erro da api.
CloudError	Uma resposta de erro do serviço de computação.
InnerError	Detalhes do erro interno.
OSProfileProvisioningData	Parâmetros adicionais para recriação de imagens de máquinas virtuais não efêmeras.
VirtualMachineScaleSetReimageParameters	Descreve os parâmetros de reimagem da VM de um conjunto de dimensionamento de máquina virtual.

ApiError

Erro de api.

Name	Tipo	Description
code	string	O código de erro.
details	ApiErrorBase[]	Os detalhes do erro Api
innererror	InnerError	O erro interno da Api
message	string	A mensagem de erro.
target	string	O alvo do erro específico.

ApiErrorBase

Base de erro da api.

Name	Tipo	Description
code	string	O código de erro.
message	string	A mensagem de erro.
target	string	O alvo do erro específico.

CloudError

Uma resposta de erro do serviço de computação.

Name	Tipo	Description
error	ApiError	Erro de api.

InnerError

Detalhes do erro interno.

Name	Tipo	Description
errordetail	string	A mensagem de erro interna ou despejo de exceção.
exceptiontype	string	O tipo de exceção.

OSProfileProvisioningData

Parâmetros adicionais para recriação de imagens de máquinas virtuais não efêmeras.

Name	Tipo	Description
adminPassword	string	Especifica a senha da conta de administrador. Comprimento mínimo (Windows): 8 caracteres Comprimento mínimo (Linux): 6 caracteres Max-length (Windows): 123 caracteres Max-length (Linux): 72 caracteres Requisitos de complexidade: 3 das 4 condições abaixo precisam ser cumpridas Tem caracteres mais baixos Tem caracteres superiores Tem um dígito Tem um caractere especial (Regex match [\W_]) Valores não permitidos: "abc@123", "P@$$w 0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" Para redefinir a senha, consulte Como redefinir o serviço de Área de Trabalho Remota ou sua senha de login em uma VM do Windows Para redefinir a senha de root, consulte Gerenciar usuários, SSH e verificar ou reparar discos em VMs Linux do Azure usando a Extensão VMAccess
customData	string	Especifica uma cadeia de caracteres codificada em base 64 de dados personalizados. A cadeia de caracteres codificada em base 64 é decodificada para uma matriz binária que é salva como um arquivo na máquina virtual. O comprimento máximo da matriz binária é de 65535 bytes. Nota: Não passe segredos ou senhas na propriedade customData. Essa propriedade não pode ser atualizada depois que a VM é criada. A propriedade customData é passada para a VM para ser salva como um arquivo, para obter mais informações, consulte Dados Personalizados em VMs do Azure. Se estiver usando cloud-init para sua VM Linux, consulte Usando cloud-init para personalizar uma VM Linux durante a criação.

VirtualMachineScaleSetReimageParameters

Descreve os parâmetros de reimagem da VM de um conjunto de dimensionamento de máquina virtual.

Name	Tipo	Description
exactVersion	string	Especifica em número decimal, a versão para a qual o disco do sistema operacional deve ser recriado. Se a versão exata não for fornecida, o disco do sistema operacional será recriado para a versão existente do disco do sistema operacional.
forceUpdateOSDiskForEphemeral	boolean	Parâmetro para forçar a atualização do disco efêmero do sistema operacional para uma VM de conjunto de escala de máquina virtual
instanceIds	string[]	A máquina virtual dimensiona as ids de instância do conjunto. Omitir as ids de instância do conjunto de escala da máquina virtual resultará na execução da operação em todas as máquinas virtuais do conjunto de escala da máquina virtual.
osProfile	OSProfileProvisioningData	Especifica as informações necessárias para a criação de imagens do disco do sistema operacional não efêmero.
tempDisk	boolean	Especifica se o disco temporário deve ser recriado. Valor padrão: false. Nota: Este parâmetro de reimagem de disco temporário só é suportado para VM/VMSS com disco de SO efémero.