Restore Points - Get

Serviço:: Compute

Versão da API:: 2025-04-01

A operação para obter o ponto de restauração.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{restorePointName}?api-version=2025-04-01

Com parâmetros opcionais:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{restorePointName}?api-version=2025-04-01&$expand=instanceView

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
restorePointCollectionName	path	True	string	O nome da coleção de pontos de restauração.
restorePointName	path	True	string	O nome do ponto de restauração.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
$expand	query		RestorePointExpandOptions	A expressão de expansão a ser aplicada na operação. 'InstanceView' recupera informações sobre o estado de tempo de execução de um ponto de restauração.

Respostas

Nome	Tipo	Description
200 OK	RestorePoint	A operação do Azure foi concluída com êxito.
Other Status Codes	CloudError	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get a restore point

Get restore point with instance view

Get a restore point

Solicitação de exemplo

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName?api-version=2025-04-01&$expand=instanceView


/**
 * Samples for RestorePoints Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/
     * restorePointExamples/RestorePoint_Get.json
     */
    /**
     * Sample code: Get a restore point.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getARestorePoint(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getRestorePoints().getWithResponse("myResourceGroup",
            "rpcName", "rpName", 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python restore_point_get.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}",
    )

    response = client.restore_points.get(
        resource_group_name="myResourceGroup",
        restore_point_collection_name="rpcName",
        restore_point_name="rpName",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/restorePointExamples/RestorePoint_Get.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/v7"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7033e85e1f80ef5cd9ca664b538ed193a8fd815b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/restorePointExamples/RestorePoint_Get.json
func ExampleRestorePointsClient_Get_getARestorePoint() {
	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)
	}
	res, err := clientFactory.NewRestorePointsClient().Get(ctx, "myResourceGroup", "rpcName", "rpName", &armcompute.RestorePointsClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.RestorePoint = armcompute.RestorePoint{
	// 	Name: to.Ptr("rpName"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName"),
	// 	Properties: &armcompute.RestorePointProperties{
	// 		ConsistencyMode: to.Ptr(armcompute.ConsistencyModeTypesApplicationConsistent),
	// 		ExcludeDisks: []*armcompute.APIEntityReference{
	// 			{
	// 				ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm8768_disk2_fe6ffde4f69b491ca33fb984d5bcd89f"),
	// 		}},
	// 		InstantAccessDurationMinutes: to.Ptr[int32](120),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		SourceMetadata: &armcompute.RestorePointSourceMetadata{
	// 			DiagnosticsProfile: &armcompute.DiagnosticsProfile{
	// 				BootDiagnostics: &armcompute.BootDiagnostics{
	// 					Enabled: to.Ptr(true),
	// 				},
	// 			},
	// 			HardwareProfile: &armcompute.HardwareProfile{
	// 				VMSize: to.Ptr(armcompute.VirtualMachineSizeTypesStandardB1S),
	// 			},
	// 			Location: to.Ptr("westus"),
	// 			OSProfile: &armcompute.OSProfile{
	// 				AdminUsername: to.Ptr("admin"),
	// 				AllowExtensionOperations: to.Ptr(true),
	// 				ComputerName: to.Ptr("computerName"),
	// 				RequireGuestProvisionSignal: to.Ptr(true),
	// 				Secrets: []*armcompute.VaultSecretGroup{
	// 				},
	// 				WindowsConfiguration: &armcompute.WindowsConfiguration{
	// 					EnableAutomaticUpdates: to.Ptr(true),
	// 					ProvisionVMAgent: to.Ptr(true),
	// 				},
	// 			},
	// 			StorageProfile: &armcompute.RestorePointSourceVMStorageProfile{
	// 				DataDisks: []*armcompute.RestorePointSourceVMDataDisk{
	// 					{
	// 						Name: to.Ptr("testingexcludedisk_DataDisk_1"),
	// 						Caching: to.Ptr(armcompute.CachingTypesNone),
	// 						DiskRestorePoint: &armcompute.DiskRestorePointAttributes{
	// 							ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5"),
	// 						},
	// 						Lun: to.Ptr[int32](1),
	// 						ManagedDisk: &armcompute.ManagedDiskParameters{
	// 							ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/testingexcludedisk_DataDisk_1"),
	// 							StorageAccountType: to.Ptr(armcompute.StorageAccountTypesStandardLRS),
	// 						},
	// 				}},
	// 				DiskControllerType: to.Ptr(armcompute.DiskControllerTypesNVMe),
	// 				OSDisk: &armcompute.RestorePointSourceVMOSDisk{
	// 					Name: to.Ptr("testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f"),
	// 					Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 					DiskRestorePoint: &armcompute.DiskRestorePointAttributes{
	// 						ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"),
	// 					},
	// 					ManagedDisk: &armcompute.ManagedDiskParameters{
	// 						ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f"),
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesStandardLRS),
	// 					},
	// 					OSType: to.Ptr(armcompute.OperatingSystemTypeWindows),
	// 				},
	// 			},
	// 			VMID: to.Ptr("76d6541e-80bd-4dc1-932b-3cae4cfb80e7"),
	// 		},
	// 		TimeCreated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-27T20:35:05.840Z"); return t}()),
	// 	},
	// }
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to The operation to get the restore point.
 *
 * @summary The operation to get the restore point.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/restorePointExamples/RestorePoint_Get.json
 */
async function getARestorePoint() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const restorePointCollectionName = "rpcName";
  const restorePointName = "rpName";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.restorePoints.get(
    resourceGroupName,
    restorePointCollectionName,
    restorePointName,
  );
  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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/restorePointExamples/RestorePoint_Get.json
// this example is just showing the usage of "RestorePoints_Get" 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 RestorePointGroupResource created on azure
// for more information of creating RestorePointGroupResource, please refer to the document of RestorePointGroupResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string restorePointGroupName = "rpcName";
ResourceIdentifier restorePointGroupResourceId = RestorePointGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, restorePointGroupName);
RestorePointGroupResource restorePointGroup = client.GetRestorePointGroupResource(restorePointGroupResourceId);

// get the collection of this RestorePointResource
RestorePointCollection collection = restorePointGroup.GetRestorePoints();

// invoke the operation
string restorePointName = "rpName";
NullableResponse<RestorePointResource> response = await collection.GetIfExistsAsync(restorePointName);
RestorePointResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    RestorePointData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Resposta de exemplo

Código de status:: 200

{
  "name": "rpName",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName",
  "properties": {
    "excludeDisks": [
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm8768_disk2_fe6ffde4f69b491ca33fb984d5bcd89f"
      }
    ],
    "sourceMetadata": {
      "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7",
      "hardwareProfile": {
        "vmSize": "Standard_B1s"
      },
      "storageProfile": {
        "osDisk": {
          "osType": "Windows",
          "name": "testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Standard_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f"
          },
          "diskRestorePoint": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
          }
        },
        "dataDisks": [
          {
            "lun": 1,
            "name": "testingexcludedisk_DataDisk_1",
            "caching": "None",
            "managedDisk": {
              "storageAccountType": "Standard_LRS",
              "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/testingexcludedisk_DataDisk_1"
            },
            "diskRestorePoint": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5"
            }
          }
        ],
        "diskControllerType": "NVMe"
      },
      "osProfile": {
        "computerName": "computerName",
        "adminUsername": "admin",
        "windowsConfiguration": {
          "provisionVMAgent": true,
          "enableAutomaticUpdates": true
        },
        "secrets": [],
        "allowExtensionOperations": true,
        "requireGuestProvisionSignal": true
      },
      "diagnosticsProfile": {
        "bootDiagnostics": {
          "enabled": true
        }
      },
      "location": "westus"
    },
    "instantAccessDurationMinutes": 120,
    "provisioningState": "Succeeded",
    "consistencyMode": "ApplicationConsistent",
    "timeCreated": "2021-01-27T20:35:05.8401519+00:00"
  }
}

Get restore point with instance view

Solicitação de exemplo

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName?api-version=2025-04-01&$expand=instanceView


/**
 * Samples for RestorePoints Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/
     * restorePointExamples/RestorePoint_Get_WithInstanceView.json
     */
    /**
     * Sample code: Get restore point with instance view.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getRestorePointWithInstanceView(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getRestorePoints().getWithResponse("myResourceGroup",
            "rpcName", "rpName", 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python restore_point_get_with_instance_view.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}",
    )

    response = client.restore_points.get(
        resource_group_name="myResourceGroup",
        restore_point_collection_name="rpcName",
        restore_point_name="rpName",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/restorePointExamples/RestorePoint_Get_WithInstanceView.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/v7"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7033e85e1f80ef5cd9ca664b538ed193a8fd815b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/restorePointExamples/RestorePoint_Get_WithInstanceView.json
func ExampleRestorePointsClient_Get_getRestorePointWithInstanceView() {
	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)
	}
	res, err := clientFactory.NewRestorePointsClient().Get(ctx, "myResourceGroup", "rpcName", "rpName", &armcompute.RestorePointsClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.RestorePoint = armcompute.RestorePoint{
	// 	Name: to.Ptr("rpName"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName"),
	// 	Properties: &armcompute.RestorePointProperties{
	// 		ConsistencyMode: to.Ptr(armcompute.ConsistencyModeTypesApplicationConsistent),
	// 		ExcludeDisks: []*armcompute.APIEntityReference{
	// 			{
	// 				ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm8768_disk2_fe6ffde4f69b491ca33fb984d5bcd89f"),
	// 		}},
	// 		InstanceView: &armcompute.RestorePointInstanceView{
	// 			DiskRestorePoints: []*armcompute.DiskRestorePointInstanceView{
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"),
	// 					ReplicationStatus: &armcompute.DiskRestorePointReplicationStatus{
	// 						CompletionPercent: to.Ptr[int32](100),
	// 						Status: &armcompute.InstanceViewStatus{
	// 							Code: to.Ptr("ReplicationState/succeeded"),
	// 							DisplayStatus: to.Ptr("Succeeded"),
	// 							Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 						},
	// 					},
	// 				},
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5"),
	// 					ReplicationStatus: &armcompute.DiskRestorePointReplicationStatus{
	// 						CompletionPercent: to.Ptr[int32](100),
	// 						Status: &armcompute.InstanceViewStatus{
	// 							Code: to.Ptr("ReplicationState/succeeded"),
	// 							DisplayStatus: to.Ptr("Succeeded"),
	// 							Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 						},
	// 					},
	// 					SnapshotAccessState: to.Ptr(armcompute.SnapshotAccessStateAvailableWithInstantAccess),
	// 			}},
	// 			Statuses: []*armcompute.InstanceViewStatus{
	// 				{
	// 					Code: to.Ptr("ReplicationState/succeeded"),
	// 					DisplayStatus: to.Ptr("Succeeded"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 			}},
	// 		},
	// 		InstantAccessDurationMinutes: to.Ptr[int32](120),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		SourceMetadata: &armcompute.RestorePointSourceMetadata{
	// 			DiagnosticsProfile: &armcompute.DiagnosticsProfile{
	// 				BootDiagnostics: &armcompute.BootDiagnostics{
	// 					Enabled: to.Ptr(true),
	// 				},
	// 			},
	// 			HardwareProfile: &armcompute.HardwareProfile{
	// 				VMSize: to.Ptr(armcompute.VirtualMachineSizeTypesStandardB1S),
	// 			},
	// 			Location: to.Ptr("westus"),
	// 			OSProfile: &armcompute.OSProfile{
	// 				AdminUsername: to.Ptr("admin"),
	// 				AllowExtensionOperations: to.Ptr(true),
	// 				ComputerName: to.Ptr("computerName"),
	// 				RequireGuestProvisionSignal: to.Ptr(true),
	// 				Secrets: []*armcompute.VaultSecretGroup{
	// 				},
	// 				WindowsConfiguration: &armcompute.WindowsConfiguration{
	// 					EnableAutomaticUpdates: to.Ptr(true),
	// 					ProvisionVMAgent: to.Ptr(true),
	// 				},
	// 			},
	// 			StorageProfile: &armcompute.RestorePointSourceVMStorageProfile{
	// 				DataDisks: []*armcompute.RestorePointSourceVMDataDisk{
	// 					{
	// 						Name: to.Ptr("testingexcludedisk_DataDisk_1"),
	// 						Caching: to.Ptr(armcompute.CachingTypesNone),
	// 						DiskRestorePoint: &armcompute.DiskRestorePointAttributes{
	// 							ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5"),
	// 						},
	// 						Lun: to.Ptr[int32](1),
	// 						ManagedDisk: &armcompute.ManagedDiskParameters{
	// 							ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/testingexcludedisk_DataDisk_1"),
	// 							StorageAccountType: to.Ptr(armcompute.StorageAccountTypesStandardLRS),
	// 						},
	// 				}},
	// 				DiskControllerType: to.Ptr(armcompute.DiskControllerTypesNVMe),
	// 				OSDisk: &armcompute.RestorePointSourceVMOSDisk{
	// 					Name: to.Ptr("testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f"),
	// 					Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 					DiskRestorePoint: &armcompute.DiskRestorePointAttributes{
	// 						ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"),
	// 					},
	// 					ManagedDisk: &armcompute.ManagedDiskParameters{
	// 						ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f"),
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesStandardLRS),
	// 					},
	// 					OSType: to.Ptr(armcompute.OperatingSystemTypeWindows),
	// 				},
	// 			},
	// 			VMID: to.Ptr("76d6541e-80bd-4dc1-932b-3cae4cfb80e7"),
	// 		},
	// 		TimeCreated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-27T20:35:05.840Z"); return t}()),
	// 	},
	// }
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to The operation to get the restore point.
 *
 * @summary The operation to get the restore point.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/restorePointExamples/RestorePoint_Get_WithInstanceView.json
 */
async function getRestorePointWithInstanceView() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const restorePointCollectionName = "rpcName";
  const restorePointName = "rpName";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.restorePoints.get(
    resourceGroupName,
    restorePointCollectionName,
    restorePointName,
  );
  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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/restorePointExamples/RestorePoint_Get_WithInstanceView.json
// this example is just showing the usage of "RestorePoints_Get" 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 RestorePointGroupResource created on azure
// for more information of creating RestorePointGroupResource, please refer to the document of RestorePointGroupResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string restorePointGroupName = "rpcName";
ResourceIdentifier restorePointGroupResourceId = RestorePointGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, restorePointGroupName);
RestorePointGroupResource restorePointGroup = client.GetRestorePointGroupResource(restorePointGroupResourceId);

// get the collection of this RestorePointResource
RestorePointCollection collection = restorePointGroup.GetRestorePoints();

// invoke the operation
string restorePointName = "rpName";
NullableResponse<RestorePointResource> response = await collection.GetIfExistsAsync(restorePointName);
RestorePointResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    RestorePointData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Resposta de exemplo

Código de status:: 200

{
  "name": "rpName",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName",
  "properties": {
    "excludeDisks": [
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm8768_disk2_fe6ffde4f69b491ca33fb984d5bcd89f"
      }
    ],
    "sourceMetadata": {
      "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7",
      "hardwareProfile": {
        "vmSize": "Standard_B1s"
      },
      "storageProfile": {
        "osDisk": {
          "osType": "Windows",
          "name": "testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Standard_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f"
          },
          "diskRestorePoint": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
          }
        },
        "dataDisks": [
          {
            "lun": 1,
            "name": "testingexcludedisk_DataDisk_1",
            "caching": "None",
            "managedDisk": {
              "storageAccountType": "Standard_LRS",
              "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/testingexcludedisk_DataDisk_1"
            },
            "diskRestorePoint": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5"
            }
          }
        ],
        "diskControllerType": "NVMe"
      },
      "osProfile": {
        "computerName": "computerName",
        "adminUsername": "admin",
        "windowsConfiguration": {
          "provisionVMAgent": true,
          "enableAutomaticUpdates": true
        },
        "secrets": [],
        "allowExtensionOperations": true,
        "requireGuestProvisionSignal": true
      },
      "diagnosticsProfile": {
        "bootDiagnostics": {
          "enabled": true
        }
      },
      "location": "westus"
    },
    "instantAccessDurationMinutes": 120,
    "provisioningState": "Succeeded",
    "consistencyMode": "ApplicationConsistent",
    "timeCreated": "2021-01-27T20:35:05.8401519+00:00",
    "instanceView": {
      "diskRestorePoints": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57",
          "replicationStatus": {
            "status": {
              "code": "ReplicationState/succeeded",
              "level": "Info",
              "displayStatus": "Succeeded"
            },
            "completionPercent": 100
          }
        },
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5",
          "snapshotAccessState": "AvailableWithInstantAccess",
          "replicationStatus": {
            "status": {
              "code": "ReplicationState/succeeded",
              "level": "Info",
              "displayStatus": "Succeeded"
            },
            "completionPercent": 100
          }
        }
      ],
      "statuses": [
        {
          "code": "ReplicationState/succeeded",
          "level": "Info",
          "displayStatus": "Succeeded"
        }
      ]
    }
  }
}

Definições

Nome	Description
AdditionalUnattendContent	Especifica informações adicionais formatadas em XML que podem ser incluídas no arquivo Unattend.xml, que é usado pela Instalação do Windows. O conteúdo é definido pelo nome da configuração, pelo nome do componente e pela passagem na qual o conteúdo é aplicado.
ApiEntityReference	A referência da entidade de API.
ApiError	Erro de API.
ApiErrorBase	Base de erros da API.
BootDiagnostics	O Diagnóstico de Inicialização é um recurso de depuração que permite exibir a Saída do Console e a Captura de Tela para diagnosticar o status da VM. Você pode exibir facilmente a saída do log do console. O Azure também permite que você veja uma captura de tela da VM do hipervisor.
CachingTypes	Especifica os requisitos de cache. Os valores possíveis são: None,ReadOnly,ReadWrite. Os valores padrão são: Nenhum para armazenamento padrão. ReadOnly para armazenamento Premium
CloudError	Uma resposta de erro do serviço Compute.
ComponentNames
ConsistencyModeTypes	ConsistencyMode do RestorePoint. Pode ser especificado na entrada durante a criação de um ponto de restauração. Por enquanto, somente CrashConsistent é aceito como uma entrada válida. Consulte https://aka.ms/RestorePoints para obter mais detalhes.
createdByType	O tipo de identidade que criou o recurso.
DiagnosticsProfile	Especifica o estado das configurações de diagnóstico de inicialização. Versão mínima da API: 2015-06-15.
DiskControllerTypes	Especifica o tipo de controlador de disco configurado para a VM e VirtualMachineScaleSet. Essa propriedade só tem suporte para máquinas virtuais cujo disco do sistema operacional e sku de VM dá suporte à Geração 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), verifique se a funcionalidade HyperVGenerations retornada como parte dos recursos de sku de VM na resposta da API de SKUs da Microsoft.Compute para a região contém V2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list). Para obter mais informações sobre os tipos de controlador de disco com suporte, consulte https://aka.ms/azure-diskcontrollertypes.
DiskEncryptionSetParameters	Descreve o parâmetro da ID de recurso do conjunto de criptografia de disco gerenciado pelo cliente que pode ser especificada para disco. Observação: A ID do recurso do conjunto de criptografia de disco só pode ser especificada para o disco gerenciado. Consulte https://aka.ms/mdssewithcmkoverview para obter mais detalhes.
DiskEncryptionSettings	Descreve as configurações de criptografia de um disco
DiskRestorePointAttributes	Detalhes do ponto de restauração de disco.
DiskRestorePointInstanceView	A exibição de instância de um ponto de restauração de disco.
DiskRestorePointReplicationStatus	A exibição de instância de um ponto de restauração de disco.
EncryptionIdentity	Especifica a Identidade Gerenciada usada pelo ADE para obter o token de acesso para operações de keyvault.
HardwareProfile	Especifica as configurações de hardware da máquina virtual.
HostEndpointSettings	Especifica configurações específicas do ponto de extremidade do host.
HyperVGenerationTypes	Especifica o tipo HyperVGeneration
InnerError	Detalhes do erro interno.
InstanceViewStatus	Status da exibição da instância.
KeyVaultKeyReference	Descreve uma referência à chave do Key Vault
KeyVaultSecretReference	Descreve uma referência ao Segredo do Key Vault
LinuxConfiguration	Especifica as configurações do sistema operacional Linux na máquina virtual. Para obter uma lista de distribuições do Linux com suporte, consulte Linux nodistribuições de Azure-Endorsed.
LinuxPatchAssessmentMode	Especifica o modo de Avaliação de Patch convidado da VM para a máquina virtual IaaS. Os valores possíveis são: ImageDefault – você controla o tempo das avaliações de patch em uma máquina virtual. AutomaticByPlatform – a plataforma disparará avaliações periódicas de patch. A propriedade provisionVMAgent deve ser verdadeira.
LinuxPatchSettings	Especifica as configurações relacionadas à aplicação de patch de convidado da VM no Linux.
LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Especifica a configuração de reinicialização para todas as operações de instalação de patch AutomaticByPlatform.
LinuxVMGuestPatchAutomaticByPlatformSettings	Especifica configurações adicionais a serem aplicadas quando o modo de patch AutomaticByPlatform é selecionado nas configurações de patch do Linux.
LinuxVMGuestPatchMode	Especifica o modo de aplicação de patch de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquinas virtuais com OrchestrationMode como Flexível. Os valores possíveis são: ImageDefault – a configuração de aplicação de patch padrão da máquina virtual é usada. AutomaticByPlatform – a máquina virtual será atualizada automaticamente pela plataforma. A propriedade provisionVMAgent deve ser verdadeira
ManagedDiskParameters	Os parâmetros de um disco gerenciado.
Mode	Especifica o modo no qual o ProxyAgent será executado se o recurso estiver habilitado. O ProxyAgent começará a auditar ou monitorar, mas não imporá o controle de acesso sobre solicitações para hospedar pontos de extremidade no modo auditoria, enquanto no modo Impor imporá o controle de acesso. O valor padrão é o modo Impor.
Modes	Especifica o modo de execução. No modo auditoria, o sistema atua como se estivesse impondo a política de controle de acesso, incluindo a emissão de entradas de negação de acesso nos logs, mas não nega nenhuma solicitação para hospedar pontos de extremidade. No modo Impor, o sistema imporá o controle de acesso e ele é o modo de operação recomendado.
OperatingSystemType	Obtém o tipo de sistema operacional.
OSProfile	Especifica as configurações do sistema operacional para a máquina virtual. Algumas das configurações não podem ser alteradas depois que a VM é provisionada.
PassNames
PatchSettings	Especifica as configurações relacionadas à aplicação de patch de convidado da VM no Windows.
ProtocolTypes	Especifica o protocolo do ouvinte WinRM. Os valores possíveis são: http,https.
ProxyAgentSettings	Especifica as configurações de ProxyAgent para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais. Versão mínima da API: 2023-09-01.
RestorePoint	Detalhes do ponto de restauração.
RestorePointEncryption	Criptografia em configurações de repouso para o ponto de restauração de disco. É uma propriedade opcional que pode ser especificada na entrada durante a criação de um ponto de restauração.
RestorePointEncryptionType	O tipo de chave usado para criptografar os dados do ponto de restauração de disco.
RestorePointExpandOptions
RestorePointInstanceView	A exibição de instância de um ponto de restauração.
RestorePointSourceMetadata	Descreve as propriedades da Máquina Virtual para a qual o ponto de restauração foi criado. As propriedades fornecidas são um subconjunto e o instantâneo das propriedades gerais da Máquina Virtual capturadas no momento da criação do ponto de restauração.
RestorePointSourceVMDataDisk	Descreve um disco de dados.
RestorePointSourceVMOSDisk	Descreve um disco do sistema operacional.
RestorePointSourceVMStorageProfile	Descreve o perfil de armazenamento.
SecurityEncryptionTypes	Especifica o EncryptionType do disco gerenciado. Ele é definido como DiskWithVMGuestState para criptografia do disco gerenciado juntamente com blob VMGuestState, VMGuestStateOnly para criptografia apenas do blob VMGuestState e NonPersistedTPM para não persistir o estado de firmware no blob VMGuestState.. Observação: Ele pode ser definido apenas para VMs confidenciais.
SecurityProfile	Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais.
SecurityTypes	Especifica o SecurityType da máquina virtual. Ele deve ser definido como qualquer valor especificado para habilitar UefiSettings. O comportamento padrão é: UefiSettings não será habilitado, a menos que essa propriedade esteja definida.
SettingNames	Especifica o nome da configuração à qual o conteúdo se aplica. Os valores possíveis são: FirstLogonCommands e AutoLogon.
SnapshotAccessState	O estado do snapshot que determina a disponibilidade de acesso do snapshot.
SshConfiguration	Configuração de SSH para VMs baseadas em Linux em execução no Azure
SshPublicKey	Contém informações sobre a chave pública do certificado SSH e o caminho na VM do Linux em que a chave pública é colocada.
StatusLevelTypes	O código de nível.
StorageAccountTypes	Especifica o tipo de conta de armazenamento para o disco gerenciado. O tipo de conta de armazenamento em disco do sistema operacional gerenciado só pode ser definido quando você cria o conjunto de dimensionamento. OBSERVAÇÃO: UltraSSD_LRS só pode ser usado com discos de dados. Ele não pode ser usado com o disco do sistema operacional. Standard_LRS usa o HDD Standard. StandardSSD_LRS usa o SSD Standard. Premium_LRS usa o SSD Premium. UltraSSD_LRS usa disco Ultra. Premium_ZRS usa o armazenamento com redundância de zona SSD Premium. StandardSSD_ZRS usa o armazenamento com redundância de zona SSD Standard. Para obter mais informações sobre discos com suporte para Máquinas Virtuais do Windows, consulte https://docs.microsoft.com/azure/virtual-machines/windows/disks-types e, para máquinas virtuais Linux, consulte https://docs.microsoft.com/azure/virtual-machines/linux/disks-types
SubResource
systemData	Metadados relativos à criação e última modificação do recurso.
UefiSettings	Especifica as configurações de segurança, como inicialização segura e vTPM usadas durante a criação da máquina virtual. Versão mínima da API: 2020-12-01.
VaultCertificate	Descreve uma única referência de certificado em um Key Vault e onde o certificado deve residir na VM.
VaultSecretGroup	Descreve um conjunto de certificados que estão todos no mesmo Key Vault.
VirtualMachineSizeTypes	Especifica o tamanho da máquina virtual. O tipo de dados de enumeração foi preterido no momento e será removido até 23 de dezembro de 2023. A maneira recomendada de obter a lista de tamanhos disponíveis é usar essas APIs: Listar todos os tamanhos de máquina virtual disponíveis em um conjunto de disponibilidade, Listar todos os tamanhos de máquina virtual disponíveis em uma região, Listar todos os tamanhos de máquina virtual disponíveis para redimensionar. Para obter mais informações sobre tamanhos de máquina virtual, consulte Sizes for virtual machines. Os tamanhos de VM disponíveis dependem da região e do conjunto de disponibilidade.
VMDiskSecurityProfile	Especifica as configurações de perfil de segurança para o disco gerenciado. Observação: Ele só pode ser definido para VMs confidenciais.
VMSizeProperties	Especifica as configurações da Propriedade tamanho da VM na máquina virtual.
WindowsConfiguration	Especifica as configurações do sistema operacional Windows na máquina virtual.
WindowsPatchAssessmentMode	Especifica o modo de avaliação de patch convidado da VM para a máquina virtual IaaS. Os valores possíveis são: ImageDefault – você controla o tempo das avaliações de patch em uma máquina virtual. AutomaticByPlatform – a plataforma disparará avaliações periódicas de patch. A propriedade provisionVMAgent deve ser verdadeira.
WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Especifica a configuração de reinicialização para todas as operações de instalação de patch AutomaticByPlatform.
WindowsVMGuestPatchAutomaticByPlatformSettings	Especifica configurações adicionais a serem aplicadas quando o modo de patch AutomaticByPlatform é selecionado nas configurações de patch do Windows.
WindowsVMGuestPatchMode	Especifica o modo de aplicação de patch de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquinas virtuais com OrchestrationMode como Flexível. Os valores possíveis são: Manual - Você controla a aplicação de patches em uma máquina virtual. Faça isso aplicando patches manualmente dentro da VM. Nesse modo, as atualizações automáticas são desabilitadas; a propriedade WindowsConfiguration.enableAutomaticUpdates deve ser falsa AutomaticByOS – a máquina virtual será atualizada automaticamente pelo sistema operacional. A propriedade WindowsConfiguration.enableAutomaticUpdates deve ser verdadeira. AutomaticByPlatform – a máquina virtual será atualizada automaticamente pela plataforma. As propriedades provisionVMAgent e WindowsConfiguration.enableAutomaticUpdates devem ser verdadeiras
WinRMConfiguration	Descreve a configuração de Gerenciamento Remoto do Windows da VM
WinRMListener	Descreve o protocolo e a impressão digital do ouvinte de Gerenciamento Remoto do Windows

AdditionalUnattendContent

Objeto

Especifica informações adicionais formatadas em XML que podem ser incluídas no arquivo Unattend.xml, que é usado pela Instalação do Windows. O conteúdo é definido pelo nome da configuração, pelo nome do componente e pela passagem na qual o conteúdo é aplicado.

Nome	Tipo	Description
componentName	ComponentNames	O nome do componente. Atualmente, o único valor permitido é Microsoft-Windows-Shell-Setup.
content	string	Especifica o conteúdo formatado XML que é adicionado ao arquivo unattend.xml para o caminho e o componente especificados. O XML deve ter menos de 4KB e deve incluir o elemento raiz para a configuração ou o recurso que está sendo inserido.
passName	PassNames	O nome da passagem. Atualmente, o único valor permitido é OobeSystem.
settingName	SettingNames	Especifica o nome da configuração à qual o conteúdo se aplica. Os valores possíveis são: FirstLogonCommands e AutoLogon.

ApiEntityReference

Objeto

A referência da entidade de API.

Nome	Tipo	Description
id	string	A ID de recurso do ARM na forma de /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Objeto

Erro de API.

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

ApiErrorBase

Objeto

Base de erros da API.

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

BootDiagnostics

Objeto

O Diagnóstico de Inicialização é um recurso de depuração que permite exibir a Saída do Console e a Captura de Tela para diagnosticar o status da VM. Você pode exibir facilmente a saída do log do console. O Azure também permite que você veja uma captura de tela da VM do hipervisor.

Nome	Tipo	Description
enabled	boolean	Se o diagnóstico de inicialização deve ser habilitado na Máquina Virtual.
storageUri	string	Uri da conta de armazenamento a ser usada para colocar a saída do console e a captura de tela. Se storageUri não for especificado ao habilitar o diagnóstico de inicialização, o armazenamento gerenciado será usado.

CachingTypes

Enumeração

Especifica os requisitos de cache. Os valores possíveis são: None,ReadOnly,ReadWrite. Os valores padrão são: Nenhum para armazenamento padrão. ReadOnly para armazenamento Premium

Valor	Description
None
ReadOnly
ReadWrite

CloudError

Objeto

Uma resposta de erro do serviço Compute.

Nome	Tipo	Description
error	ApiError	Erro de API.

ComponentNames

Enumeração

Valor	Description
Microsoft-Windows-Shell-Setup

ConsistencyModeTypes

Enumeração

ConsistencyMode do RestorePoint. Pode ser especificado na entrada durante a criação de um ponto de restauração. Por enquanto, somente CrashConsistent é aceito como uma entrada válida. Consulte https://aka.ms/RestorePoints para obter mais detalhes.

Valor	Description
CrashConsistent
FileSystemConsistent
ApplicationConsistent

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DiagnosticsProfile

Objeto

Especifica o estado das configurações de diagnóstico de inicialização. Versão mínima da API: 2015-06-15.

Nome	Tipo	Description
bootDiagnostics	BootDiagnostics	O Diagnóstico de Inicialização é um recurso de depuração que permite exibir a Saída do Console e a Captura de Tela para diagnosticar o status da VM. OBSERVAÇÃO: se storageUri estiver sendo especificado, verifique se a conta de armazenamento está na mesma região e assinatura da VM. Você pode exibir facilmente a saída do log do console. O Azure também permite que você veja uma captura de tela da VM do hipervisor.

DiskControllerTypes

Enumeração

Especifica o tipo de controlador de disco configurado para a VM e VirtualMachineScaleSet. Essa propriedade só tem suporte para máquinas virtuais cujo disco do sistema operacional e sku de VM dá suporte à Geração 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), verifique se a funcionalidade HyperVGenerations retornada como parte dos recursos de sku de VM na resposta da API de SKUs da Microsoft.Compute para a região contém V2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list). Para obter mais informações sobre os tipos de controlador de disco com suporte, consulte https://aka.ms/azure-diskcontrollertypes.

Valor	Description
SCSI
NVMe

DiskEncryptionSetParameters

Objeto

Descreve o parâmetro da ID de recurso do conjunto de criptografia de disco gerenciado pelo cliente que pode ser especificada para disco. Observação: A ID do recurso do conjunto de criptografia de disco só pode ser especificada para o disco gerenciado. Consulte https://aka.ms/mdssewithcmkoverview para obter mais detalhes.

Nome	Tipo	Description
id	string	ID do recurso

DiskEncryptionSettings

Objeto

Descreve as configurações de criptografia de um disco

Nome	Tipo	Description
diskEncryptionKey	KeyVaultSecretReference	Especifica o local da chave de criptografia de disco, que é um Segredo do Key Vault.
enabled	boolean	Especifica se a criptografia de disco deve ser habilitada na máquina virtual.
keyEncryptionKey	KeyVaultKeyReference	Especifica o local da chave de criptografia de chave no Key Vault.

DiskRestorePointAttributes

Objeto

Detalhes do ponto de restauração de disco.

Nome	Tipo	Description
encryption	RestorePointEncryption	Criptografia em configurações de repouso para o ponto de restauração de disco. É uma propriedade opcional que pode ser especificada na entrada durante a criação de um ponto de restauração.
id	string	ID do recurso
sourceDiskRestorePoint	ApiEntityReference	ID do recurso do ponto de restauração do disco de origem.

DiskRestorePointInstanceView

Objeto

A exibição de instância de um ponto de restauração de disco.

Nome	Tipo	Description
id	string	ID do ponto de restauração do disco.
replicationStatus	DiskRestorePointReplicationStatus	As informações de status de replicação do ponto de restauração do disco.
snapshotAccessState	SnapshotAccessState	O estado do snapshot que determina a disponibilidade de acesso do snapshot.

DiskRestorePointReplicationStatus

Objeto

A exibição de instância de um ponto de restauração de disco.

Nome	Tipo	Description
completionPercent	integer (int32)	Porcentagem de conclusão da replicação.
status	InstanceViewStatus	As informações de status do recurso.

EncryptionIdentity

Objeto

Especifica a Identidade Gerenciada usada pelo ADE para obter o token de acesso para operações de keyvault.

Nome	Tipo	Description
userAssignedIdentityResourceId	string	Especifica a ID de recurso do ARM de uma das identidades de usuário associadas à VM.

HardwareProfile

Objeto

Especifica as configurações de hardware da máquina virtual.

Nome	Tipo	Description
vmSize	VirtualMachineSizeTypes	Especifica o tamanho da máquina virtual. O tipo de dados de enumeração foi preterido no momento e será removido até 23 de dezembro de 2023. A maneira recomendada de obter a lista de tamanhos disponíveis é usar essas APIs: Listar todos os tamanhos de máquina virtual disponíveis em um conjunto de disponibilidade, Listar todos os tamanhos de máquina virtual disponíveis em uma região, Listar todos os tamanhos de máquina virtual disponíveis para redimensionar. Para obter mais informações sobre tamanhos de máquina virtual, consulte Sizes for virtual machines. Os tamanhos de VM disponíveis dependem da região e do conjunto de disponibilidade.
vmSizeProperties	VMSizeProperties	Especifica as propriedades para personalizar o tamanho da máquina virtual. Versão mínima da API: 2021-07-01. Esse recurso ainda está no modo de visualização e não tem suporte para VirtualMachineScaleSet. Siga as instruções em de Personalização de VM para obter mais detalhes.

HostEndpointSettings

Objeto

Especifica configurações específicas do ponto de extremidade do host.

Nome	Tipo	Description
inVMAccessControlProfileReferenceId	string	Especifica a ID do recurso InVMAccessControlProfileVersion no formato /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}
mode	Modes	Especifica o modo de execução. No modo auditoria, o sistema atua como se estivesse impondo a política de controle de acesso, incluindo a emissão de entradas de negação de acesso nos logs, mas não nega nenhuma solicitação para hospedar pontos de extremidade. No modo Impor, o sistema imporá o controle de acesso e ele é o modo de operação recomendado.

HyperVGenerationTypes

Enumeração

Especifica o tipo HyperVGeneration

Valor	Description
V1
V2

InnerError

Objeto

Detalhes do erro interno.

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

InstanceViewStatus

Objeto

Status da exibição da instância.

Nome	Tipo	Description
code	string	O código de status.
displayStatus	string	O rótulo localizável curto para o status.
level	StatusLevelTypes	O código de nível.
message	string	A mensagem de status detalhada, inclusive para alertas e mensagens de erro.
time	string (date-time)	A hora do status.

KeyVaultKeyReference

Objeto

Descreve uma referência à chave do Key Vault

Nome	Tipo	Description
keyUrl	string	A URL que faz referência a uma chave de criptografia de chave no Key Vault.
sourceVault	SubResource	A URL relativa do Key Vault que contém a chave.

KeyVaultSecretReference

Objeto

Descreve uma referência ao Segredo do Key Vault

Nome	Tipo	Description
secretUrl	string	A URL que faz referência a um segredo em um Key Vault.
sourceVault	SubResource	A URL relativa do Key Vault que contém o segredo.

LinuxConfiguration

Objeto

Especifica as configurações do sistema operacional Linux na máquina virtual. Para obter uma lista de distribuições do Linux com suporte, consulte Linux nodistribuições de Azure-Endorsed.

Nome	Tipo	Description
disablePasswordAuthentication	boolean	Especifica se a autenticação de senha deve ser desabilitada.
enableVMAgentPlatformUpdates	boolean	Indica se as Atualizações da Plataforma VMAgent estão habilitadas para a máquina virtual linux. O valor padrão é falso.
patchSettings	LinuxPatchSettings	[Recurso de visualização] Especifica as configurações relacionadas à aplicação de patch de convidado da VM no Linux.
provisionVMAgent	boolean	Indica se o agente de máquina virtual deve ser provisionado na máquina virtual. Quando essa propriedade não é especificada no corpo da solicitação, o comportamento padrão é defini-la como true. Isso garantirá que o Agente de VM seja instalado na VM para que as extensões possam ser adicionadas à VM posteriormente.
ssh	SshConfiguration	Especifica a configuração de chave ssh para um sistema operacional Linux.

LinuxPatchAssessmentMode

Enumeração

Especifica o modo de Avaliação de Patch convidado da VM para a máquina virtual IaaS.

Os valores possíveis são:

ImageDefault – você controla o tempo das avaliações de patch em uma máquina virtual.

AutomaticByPlatform – a plataforma disparará avaliações periódicas de patch. A propriedade provisionVMAgent deve ser verdadeira.

Valor	Description
ImageDefault
AutomaticByPlatform

LinuxPatchSettings

Objeto

Especifica as configurações relacionadas à aplicação de patch de convidado da VM no Linux.

Nome	Tipo	Description
assessmentMode	LinuxPatchAssessmentMode	Especifica o modo de Avaliação de Patch convidado da VM para a máquina virtual IaaS. Os valores possíveis são: ImageDefault – você controla o tempo das avaliações de patch em uma máquina virtual. AutomaticByPlatform – a plataforma disparará avaliações periódicas de patch. A propriedade provisionVMAgent deve ser verdadeira.
automaticByPlatformSettings	LinuxVMGuestPatchAutomaticByPlatformSettings	Especifica configurações adicionais para o modo de patch AutomaticByPlatform na Aplicação de Patch de Convidado de VM no Linux.
patchMode	LinuxVMGuestPatchMode	Especifica o modo de aplicação de patch de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquinas virtuais com OrchestrationMode como Flexível. Os valores possíveis são: ImageDefault – a configuração de aplicação de patch padrão da máquina virtual é usada. AutomaticByPlatform – a máquina virtual será atualizada automaticamente pela plataforma. A propriedade provisionVMAgent deve ser verdadeira

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Enumeração

Especifica a configuração de reinicialização para todas as operações de instalação de patch AutomaticByPlatform.

Valor	Description
Unknown
IfRequired
Never
Always

LinuxVMGuestPatchAutomaticByPlatformSettings

Objeto

Especifica configurações adicionais a serem aplicadas quando o modo de patch AutomaticByPlatform é selecionado nas configurações de patch do Linux.

Nome	Tipo	Description
bypassPlatformSafetyChecksOnUserSchedule	boolean	Permite que o cliente agende a aplicação de patch sem atualizações acidentais
rebootSetting	LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Especifica a configuração de reinicialização para todas as operações de instalação de patch AutomaticByPlatform.

LinuxVMGuestPatchMode

Enumeração

Valor	Description
ImageDefault
AutomaticByPlatform

ManagedDiskParameters

Objeto

Os parâmetros de um disco gerenciado.

Nome	Tipo	Description
diskEncryptionSet	DiskEncryptionSetParameters	Especifica a ID do recurso do conjunto de criptografia de disco gerenciado pelo cliente para o disco gerenciado.
id	string	ID do recurso
securityProfile	VMDiskSecurityProfile	Especifica o perfil de segurança do disco gerenciado.
storageAccountType	StorageAccountTypes	Especifica o tipo de conta de armazenamento para o disco gerenciado. OBSERVAÇÃO: UltraSSD_LRS só pode ser usado com discos de dados, ele não pode ser usado com o Disco do SISTEMA Operacional.

Mode

Enumeração

Especifica o modo no qual o ProxyAgent será executado se o recurso estiver habilitado. O ProxyAgent começará a auditar ou monitorar, mas não imporá o controle de acesso sobre solicitações para hospedar pontos de extremidade no modo auditoria, enquanto no modo Impor imporá o controle de acesso. O valor padrão é o modo Impor.

Valor	Description
Audit
Enforce

Modes

Enumeração

Especifica o modo de execução. No modo auditoria, o sistema atua como se estivesse impondo a política de controle de acesso, incluindo a emissão de entradas de negação de acesso nos logs, mas não nega nenhuma solicitação para hospedar pontos de extremidade. No modo Impor, o sistema imporá o controle de acesso e ele é o modo de operação recomendado.

Valor	Description
Audit
Enforce
Disabled

OperatingSystemType

Enumeração

Obtém o tipo de sistema operacional.

Valor	Description
Windows
Linux

OSProfile

Objeto

Especifica as configurações do sistema operacional para a máquina virtual. Algumas das configurações não podem ser alteradas depois que a VM é provisionada.

Nome	Tipo	Description
adminPassword	string (password)	Especifica a senha da conta de administrador. Comprimento mínimo (Windows): 8 caracteres Comprimento mínimo (Linux): 6 caracteres comprimento máximo (Windows): 123 caracteres comprimento máximo (Linux): 72 caracteres requisitos de complexidade: 3 de 4 condições abaixo precisam ser atendidas Tem caracteres inferiores Tem caracteres superiores Tem um dígito Tem um caractere especial (correspondência regex [\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 logon em uma VM do Windows Para redefinir a senha raiz, consulte Gerenciar usuários, SSH e verificar ou reparar discos em VMs linux do Azure usando a Extensão VMAccess
adminUsername	string	Especifica o nome da conta de administrador. Essa propriedade não pode ser atualizada após a criação da VM. restrição somente do Windows: Não é possível terminar em "". valores não permitidos: "administrador", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". comprimento mínimo (Linux): 1 caractere comprimento máximo (Linux): 64 caracteres Comprimento máximo (Windows): 20 caracteres.
allowExtensionOperations	boolean	Especifica se as operações de extensão devem ser permitidas na máquina virtual. Isso só poderá ser definido como False quando nenhuma extensão estiver presente na máquina virtual.
computerName	string	Especifica o nome do sistema operacional do host da máquina virtual. Esse nome não pode ser atualizado após a criação da VM. tamanho máximo (Windows): 15 caracteres. Comprimento máximo (Linux): 64 caracteres. Para convenções e restrições de nomenclatura, consulte diretrizes de implementação de serviços de infraestrutura do Azure.
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 salva como um arquivo na Máquina Virtual. O comprimento máximo da matriz binária é de 65535 bytes. Observação: não passe segredos ou senhas na propriedade customData. Essa propriedade não pode ser atualizada após a criação da VM. A propriedade 'customData' é passada para a VM a ser salva como um arquivo, para obter mais informações, consulte Dados Personalizados em VMs do Azure. Para usar o cloud-init para sua VM do Linux, consulte Usando o cloud-init para personalizar uma VM do Linux durante a criação.
linuxConfiguration	LinuxConfiguration	Especifica as configurações do sistema operacional Linux na máquina virtual. Para obter uma lista de distribuições do Linux com suporte, consulte Linux nodistribuições de Azure-Endorsed.
requireGuestProvisionSignal	boolean	Propriedade opcional que deve ser definida como True ou omitida.
secrets	VaultSecretGroup[]	Especifica o conjunto de certificados que devem ser instalados na máquina virtual. Para instalar certificados em uma máquina virtual, é recomendável usar a extensão de máquina virtual Azure Key Vault para Linux ou a extensão de máquina virtual do Azure Key Vault para Windows.
windowsConfiguration	WindowsConfiguration	Especifica as configurações do sistema operacional Windows na máquina virtual.

PassNames

Enumeração

Valor	Description
OobeSystem

PatchSettings

Objeto

Especifica as configurações relacionadas à aplicação de patch de convidado da VM no Windows.

Nome	Tipo	Description
assessmentMode	WindowsPatchAssessmentMode	Especifica o modo de avaliação de patch convidado da VM para a máquina virtual IaaS. Os valores possíveis são: ImageDefault – você controla o tempo das avaliações de patch em uma máquina virtual. AutomaticByPlatform – a plataforma disparará avaliações periódicas de patch. A propriedade provisionVMAgent deve ser verdadeira.
automaticByPlatformSettings	WindowsVMGuestPatchAutomaticByPlatformSettings	Especifica configurações adicionais para o modo de patch AutomaticByPlatform na Aplicação de Patch de Convidado de VM no Windows.
enableHotpatching	boolean	Permite que os clientes corrijam suas VMs do Azure sem exigir uma reinicialização. Para enableHotpatching, o 'provisionVMAgent' deve ser definido como true e 'patchMode' deve ser definido como 'AutomaticByPlatform'.
patchMode	WindowsVMGuestPatchMode	Especifica o modo de aplicação de patch de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquinas virtuais com OrchestrationMode como Flexível. Os valores possíveis são: Manual - Você controla a aplicação de patches em uma máquina virtual. Faça isso aplicando patches manualmente dentro da VM. Nesse modo, as atualizações automáticas são desabilitadas; a propriedade WindowsConfiguration.enableAutomaticUpdates deve ser falsa AutomaticByOS – a máquina virtual será atualizada automaticamente pelo sistema operacional. A propriedade WindowsConfiguration.enableAutomaticUpdates deve ser verdadeira. AutomaticByPlatform – a máquina virtual será atualizada automaticamente pela plataforma. As propriedades provisionVMAgent e WindowsConfiguration.enableAutomaticUpdates devem ser verdadeiras

ProtocolTypes

Enumeração

Especifica o protocolo do ouvinte WinRM. Os valores possíveis são: http,https.

Valor	Description
Http
Https

ProxyAgentSettings

Objeto

Especifica as configurações de ProxyAgent para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais. Versão mínima da API: 2023-09-01.

Nome	Tipo	Description
addProxyAgentExtension	boolean	Especifique se deseja instalar implicitamente a extensão ProxyAgent. No momento, essa opção é aplicável apenas para o sistema operacional Linux.
enabled	boolean	Especifica se o recurso ProxyAgent deve ser habilitado na máquina virtual ou no conjunto de dimensionamento de máquinas virtuais.
imds	HostEndpointSettings	Especifica as configurações de ponto de extremidade do IMDS ao criar a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais. Versão mínima da API: 2024-03-01.
keyIncarnationId	integer (int32)	Aumentar o valor dessa propriedade permite que os usuários redefinam a chave usada para proteger o canal de comunicação entre o convidado e o host.
mode	Mode	Especifica o modo no qual o ProxyAgent será executado. Aviso: esta propriedade foi preterida, especifique "modo" em uma configuração específica do ponto de host.
wireServer	HostEndpointSettings	Especifica as configurações do ponto de extremidade do Wire Server ao criar a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais. Versão mínima da API: 2024-03-01.

RestorePoint

Objeto

Detalhes do ponto de restauração.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.consistencyMode	ConsistencyModeTypes	ConsistencyMode do RestorePoint. Pode ser especificado na entrada durante a criação de um ponto de restauração. Por enquanto, somente CrashConsistent é aceito como uma entrada válida. Consulte https://aka.ms/RestorePoints para obter mais detalhes.
properties.excludeDisks	ApiEntityReference[]	Lista de IDs de recursos de disco que o cliente deseja excluir do ponto de restauração. Se nenhum disco for especificado, todos os discos serão incluídos.
properties.instanceView	RestorePointInstanceView	A exibição da instância do ponto de restauração.
properties.instantAccessDurationMinutes	integer (int32)	Essa propriedade determina o tempo em minutos em que o instantâneo é retido como acesso instantâneo para restaurar o disco SSD Premium v2 ou Ultra com desempenho de restauração rápida neste ponto de restauração.
properties.provisioningState	string	Obtém o estado de provisionamento do ponto de restauração.
properties.sourceMetadata	RestorePointSourceMetadata	Obtém os detalhes da VM capturada no momento da criação do ponto de restauração.
properties.sourceRestorePoint	ApiEntityReference	ID do recurso do ponto de restauração de origem do qual uma cópia precisa ser criada.
properties.timeCreated	string (date-time)	Obtém a hora de criação do ponto de restauração.
systemData	systemData	Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

RestorePointEncryption

Objeto

Criptografia em configurações de repouso para o ponto de restauração de disco. É uma propriedade opcional que pode ser especificada na entrada durante a criação de um ponto de restauração.

Nome	Tipo	Description
diskEncryptionSet	DiskEncryptionSetParameters	Descreve o parâmetro da ID de recurso do conjunto de criptografia de disco gerenciado pelo cliente que pode ser especificada para disco. Observação: A ID do recurso do conjunto de criptografia de disco só pode ser especificada para o disco gerenciado. Consulte https://aka.ms/mdssewithcmkoverview para obter mais detalhes.
type	RestorePointEncryptionType	O tipo de chave usado para criptografar os dados do ponto de restauração de disco.

RestorePointEncryptionType

Enumeração

O tipo de chave usado para criptografar os dados do ponto de restauração de disco.

Valor	Description
EncryptionAtRestWithPlatformKey	O Ponto de Restauração de Disco é criptografado em repouso com a chave gerenciada pela plataforma.
EncryptionAtRestWithCustomerKey	O Ponto de Restauração de Disco é criptografado em repouso com a chave gerenciada pelo cliente que pode ser alterada e revogada por um cliente.
EncryptionAtRestWithPlatformAndCustomerKeys	O ponto de restauração de disco é criptografado em repouso com 2 camadas de criptografia. Uma das chaves é gerenciada pelo cliente e a outra é gerenciada pela plataforma.

RestorePointExpandOptions

Enumeração

Valor	Description
instanceView

RestorePointInstanceView

Objeto

A exibição de instância de um ponto de restauração.

Nome	Tipo	Description
diskRestorePoints	DiskRestorePointInstanceView[]	As informações dos pontos de restauração do disco.
statuses	InstanceViewStatus[]	As informações de status do recurso.

RestorePointSourceMetadata

Objeto

Descreve as propriedades da Máquina Virtual para a qual o ponto de restauração foi criado. As propriedades fornecidas são um subconjunto e o instantâneo das propriedades gerais da Máquina Virtual capturadas no momento da criação do ponto de restauração.

Nome	Tipo	Description
diagnosticsProfile	DiagnosticsProfile	Obtém o perfil de diagnóstico.
hardwareProfile	HardwareProfile	Obtém o perfil de hardware.
hyperVGeneration	HyperVGenerationTypes	HyperVGeneration da VM de origem para a qual o ponto de restauração é capturado.
licenseType	string	Obtém o tipo de licença, que é para trazer seu próprio cenário de licença.
location	string	Local da VM da qual o ponto de restauração foi criado.
osProfile	OSProfile	Obtém o perfil do sistema operacional.
securityProfile	SecurityProfile	Obtém o perfil de segurança.
storageProfile	RestorePointSourceVMStorageProfile	Obtém o perfil de armazenamento.
userData	string	UserData associado à VM de origem para a qual o ponto de restauração é capturado, que é um valor codificado em base 64.
vmId	string	Obtém a ID exclusiva da máquina virtual.

RestorePointSourceVMDataDisk

Objeto

Descreve um disco de dados.

Nome	Tipo	Description
caching	CachingTypes	Obtém o tipo de cache.
diskRestorePoint	DiskRestorePointAttributes	Contém propriedades do Ponto de Restauração de Disco.
diskSizeGB	integer (int32)	Obtém o tamanho inicial do disco em GB para discos de dados em branco e o novo tamanho desejado para discos de dados e sistema operacional existentes.
lun	integer (int32)	Obtém o número da unidade lógica.
managedDisk	ManagedDiskParameters	Contém os detalhes do disco gerenciado.
name	string	Obtém o nome do disco.
writeAcceleratorEnabled	boolean	Mostra true se o disco estiver habilitado para acelerador de gravação.

RestorePointSourceVMOSDisk

Objeto

Descreve um disco do sistema operacional.

Nome	Tipo	Description
caching	CachingTypes	Obtém o tipo de cache.
diskRestorePoint	DiskRestorePointAttributes	Contém propriedades do Ponto de Restauração de Disco.
diskSizeGB	integer (int32)	Obtém o tamanho do disco em GB.
encryptionSettings	DiskEncryptionSettings	Obtém as configurações de criptografia de disco.
managedDisk	ManagedDiskParameters	Obtém os detalhes do disco gerenciado
name	string	Obtém o nome do disco.
osType	OperatingSystemType	Obtém o tipo de sistema operacional.
writeAcceleratorEnabled	boolean	Mostra true se o disco estiver habilitado para acelerador de gravação.

RestorePointSourceVMStorageProfile

Objeto

Descreve o perfil de armazenamento.

Nome	Tipo	Description
dataDisks	RestorePointSourceVMDataDisk[]	Obtém os discos de dados da VM capturada no momento da criação do ponto de restauração.
diskControllerType	DiskControllerTypes	Obtém o tipo de controlador de disco da VM capturado no momento da criação do ponto de restauração.
osDisk	RestorePointSourceVMOSDisk	Obtém o disco do sistema operacional da VM capturada no momento da criação do ponto de restauração.

SecurityEncryptionTypes

Enumeração

Especifica o EncryptionType do disco gerenciado. Ele é definido como DiskWithVMGuestState para criptografia do disco gerenciado juntamente com blob VMGuestState, VMGuestStateOnly para criptografia apenas do blob VMGuestState e NonPersistedTPM para não persistir o estado de firmware no blob VMGuestState.. Observação: Ele pode ser definido apenas para VMs confidenciais.

Valor	Description
VMGuestStateOnly
DiskWithVMGuestState
NonPersistedTPM

SecurityProfile

Objeto

Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais.

Nome	Tipo	Description
encryptionAtHost	boolean	Essa propriedade pode ser usada pelo usuário na solicitação para habilitar ou desabilitar a Criptografia de Host para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais. Isso habilitará a criptografia para todos os discos, incluindo o disco Resource/Temp no próprio host. O comportamento padrão é: a criptografia no host será desabilitada, a menos que essa propriedade seja definida como verdadeira para o recurso.
encryptionIdentity	EncryptionIdentity	Especifica a Identidade Gerenciada usada pelo ADE para obter o token de acesso para operações de keyvault.
proxyAgentSettings	ProxyAgentSettings	Especifica as configurações de ProxyAgent ao criar a máquina virtual. Versão mínima da API: 2023-09-01.
securityType	SecurityTypes	Especifica o SecurityType da máquina virtual. Ele deve ser definido como qualquer valor especificado para habilitar UefiSettings. O comportamento padrão é: UefiSettings não será habilitado, a menos que essa propriedade esteja definida.
uefiSettings	UefiSettings	Especifica as configurações de segurança, como inicialização segura e vTPM usadas durante a criação da máquina virtual. Versão mínima da API: 2020-12-01.

SecurityTypes

Enumeração

Especifica o SecurityType da máquina virtual. Ele deve ser definido como qualquer valor especificado para habilitar UefiSettings. O comportamento padrão é: UefiSettings não será habilitado, a menos que essa propriedade esteja definida.

Valor	Description
TrustedLaunch
ConfidentialVM

SettingNames

Enumeração

Especifica o nome da configuração à qual o conteúdo se aplica. Os valores possíveis são: FirstLogonCommands e AutoLogon.

Valor	Description
AutoLogon
FirstLogonCommands

SnapshotAccessState

Enumeração

O estado do snapshot que determina a disponibilidade de acesso do snapshot.

Valor	Description
Unknown	Valor padrão.
Pending	O snapshot não pode ser usado para restauração, cópia ou download para offline.
Available	O snapshot pode ser usado para restauração, cópia para região diferente e download para offline.
InstantAccess	O snapshot pode ser usado para restaurar discos com desempenho rápido, mas não pode ser copiado ou baixado.
AvailableWithInstantAccess	O instantâneo pode ser usado para restaurar discos com desempenho rápido, copiados e baixados.

SshConfiguration

Objeto

Configuração de SSH para VMs baseadas em Linux em execução no Azure

Nome	Tipo	Description
publicKeys	SshPublicKey[]	A lista de chaves públicas SSH usadas para autenticar com VMs baseadas em linux.

SshPublicKey

Objeto

Contém informações sobre a chave pública do certificado SSH e o caminho na VM do Linux em que a chave pública é colocada.

Nome	Tipo	Description
keyData	string	Certificado de chave pública SSH usado para autenticar com a VM por meio do ssh. A chave precisa ter pelo menos 2048 bits e no formato ssh-rsa. Para criar chaves ssh, consulte [Criar chaves SSH em VMs Linux e Mac para Linux no Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).
path	string	Especifica o caminho completo na VM criada em que a chave pública ssh é armazenada. Se o arquivo já existir, a chave especificada será acrescentada ao arquivo. Exemplo: /home/user/.ssh/authorized_keys

StatusLevelTypes

Enumeração

O código de nível.

Valor	Description
Info
Warning
Error

StorageAccountTypes

Enumeração

Especifica o tipo de conta de armazenamento para o disco gerenciado. O tipo de conta de armazenamento em disco do sistema operacional gerenciado só pode ser definido quando você cria o conjunto de dimensionamento. OBSERVAÇÃO: UltraSSD_LRS só pode ser usado com discos de dados. Ele não pode ser usado com o disco do sistema operacional. Standard_LRS usa o HDD Standard. StandardSSD_LRS usa o SSD Standard. Premium_LRS usa o SSD Premium. UltraSSD_LRS usa disco Ultra. Premium_ZRS usa o armazenamento com redundância de zona SSD Premium. StandardSSD_ZRS usa o armazenamento com redundância de zona SSD Standard. Para obter mais informações sobre discos com suporte para Máquinas Virtuais do Windows, consulte https://docs.microsoft.com/azure/virtual-machines/windows/disks-types e, para máquinas virtuais Linux, consulte https://docs.microsoft.com/azure/virtual-machines/linux/disks-types

Valor	Description
Standard_LRS
Premium_LRS
StandardSSD_LRS
UltraSSD_LRS
Premium_ZRS
StandardSSD_ZRS
PremiumV2_LRS

SubResource

Objeto

Nome	Tipo	Description
id	string	ID do recurso

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

UefiSettings

Objeto

Especifica as configurações de segurança, como inicialização segura e vTPM usadas durante a criação da máquina virtual. Versão mínima da API: 2020-12-01.

Nome	Tipo	Description
secureBootEnabled	boolean	Especifica se a inicialização segura deve ser habilitada na máquina virtual. Versão mínima da API: 2020-12-01.
vTpmEnabled	boolean	Especifica se o vTPM deve ser habilitado na máquina virtual. Versão mínima da API: 2020-12-01.

VaultCertificate

Objeto

Descreve uma única referência de certificado em um Key Vault e onde o certificado deve residir na VM.

Nome	Tipo	Description
certificateStore	string	Para VMs do Windows, especifica o repositório de certificados na Máquina Virtual à qual o certificado deve ser adicionado. O repositório de certificados especificado está implicitamente na conta LocalMachine. Para VMs linux, o arquivo de certificado é colocado no diretório /var/lib/waagent, com o nome do arquivo <UppercaseThumbprint>.crt para o arquivo de certificado X509 e <UppercaseThumbprint>.prv para chave privada. Ambos os arquivos são formatados em .pem.
certificateUrl	string	Essa é a URL de um certificado que foi carregado no Key Vault como um segredo. Para adicionar um segredo ao Key Vault, consulte Adicionar uma chave ou segredo ao cofre de chaves. Nesse caso, seu certificado precisa ser a codificação Base64 do seguinte objeto JSON codificado em UTF-8: { "data":"<>de certificado codificado em Base64", "dataType":"pfx", "senha":"<senha-de-arquivo-pfx>" } Para instalar certificados em uma máquina virtual, é recomendável usar a extensão de máquina virtual Azure Key Vault para Linux ou a extensão de máquina virtual do Azure Key Vault para Windows.

VaultSecretGroup

Objeto

Descreve um conjunto de certificados que estão todos no mesmo Key Vault.

Nome	Tipo	Description
sourceVault	SubResource	A URL relativa do Key Vault que contém todos os certificados em VaultCertificates.
vaultCertificates	VaultCertificate[]	A lista de referências do cofre de chaves no SourceVault que contêm certificados.

VirtualMachineSizeTypes

Enumeração

Especifica o tamanho da máquina virtual. O tipo de dados de enumeração foi preterido no momento e será removido até 23 de dezembro de 2023. A maneira recomendada de obter a lista de tamanhos disponíveis é usar essas APIs: Listar todos os tamanhos de máquina virtual disponíveis em um conjunto de disponibilidade, Listar todos os tamanhos de máquina virtual disponíveis em uma região, Listar todos os tamanhos de máquina virtual disponíveis para redimensionar. Para obter mais informações sobre tamanhos de máquina virtual, consulte Sizes for virtual machines. Os tamanhos de VM disponíveis dependem da região e do conjunto de disponibilidade.

Valor	Description
Basic_A0
Basic_A1
Basic_A2
Basic_A3
Basic_A4
Standard_A0
Standard_A1
Standard_A2
Standard_A3
Standard_A4
Standard_A5
Standard_A6
Standard_A7
Standard_A8
Standard_A9
Standard_A10
Standard_A11
Standard_A1_v2
Standard_A2_v2
Standard_A4_v2
Standard_A8_v2
Standard_A2m_v2
Standard_A4m_v2
Standard_A8m_v2
Standard_B1s
Standard_B1ms
Standard_B2s
Standard_B2ms
Standard_B4ms
Standard_B8ms
Standard_D1
Standard_D2
Standard_D3
Standard_D4
Standard_D11
Standard_D12
Standard_D13
Standard_D14
Standard_D1_v2
Standard_D2_v2
Standard_D3_v2
Standard_D4_v2
Standard_D5_v2
Standard_D2_v3
Standard_D4_v3
Standard_D8_v3
Standard_D16_v3
Standard_D32_v3
Standard_D64_v3
Standard_D2s_v3
Standard_D4s_v3
Standard_D8s_v3
Standard_D16s_v3
Standard_D32s_v3
Standard_D64s_v3
Standard_D11_v2
Standard_D12_v2
Standard_D13_v2
Standard_D14_v2
Standard_D15_v2
Standard_DS1
Standard_DS2
Standard_DS3
Standard_DS4
Standard_DS11
Standard_DS12
Standard_DS13
Standard_DS14
Standard_DS1_v2
Standard_DS2_v2
Standard_DS3_v2
Standard_DS4_v2
Standard_DS5_v2
Standard_DS11_v2
Standard_DS12_v2
Standard_DS13_v2
Standard_DS14_v2
Standard_DS15_v2
Standard_DS13-4_v2
Standard_DS13-2_v2
Standard_DS14-8_v2
Standard_DS14-4_v2
Standard_E2_v3
Standard_E4_v3
Standard_E8_v3
Standard_E16_v3
Standard_E32_v3
Standard_E64_v3
Standard_E2s_v3
Standard_E4s_v3
Standard_E8s_v3
Standard_E16s_v3
Standard_E32s_v3
Standard_E64s_v3
Standard_E32-16_v3
Standard_E32-8s_v3
Standard_E64-32s_v3
Standard_E64-16s_v3
Standard_F1
Standard_F2
Standard_F4
Standard_F8
Standard_F16
Standard_F1s
Standard_F2s
Standard_F4s
Standard_F8s
Standard_F16s
Standard_F2s_v2
Standard_F4s_v2
Standard_F8s_v2
Standard_F16s_v2
Standard_F32s_v2
Standard_F64s_v2
Standard_F72s_v2
Standard_G1
Standard_G2
Standard_G3
Standard_G4
Standard_G5
Standard_GS1
Standard_GS2
Standard_GS3
Standard_GS4
Standard_GS5
Standard_GS4-8
Standard_GS4-4
Standard_GS5-16
Standard_GS5-8
Standard_H8
Standard_H16
Standard_H8m
Standard_H16m
Standard_H16r
Standard_H16mr
Standard_L4s
Standard_L8s
Standard_L16s
Standard_L32s
Standard_M64s
Standard_M64ms
Standard_M128s
Standard_M128ms
Standard_M64-32ms
Standard_M64-16ms
Standard_M128-64ms
Standard_M128-32ms
Standard_NC6
Standard_NC12
Standard_NC24
Standard_NC24r
Standard_NC6s_v2
Standard_NC12s_v2
Standard_NC24s_v2
Standard_NC24rs_v2
Standard_NC6s_v3
Standard_NC12s_v3
Standard_NC24s_v3
Standard_NC24rs_v3
Standard_ND6s
Standard_ND12s
Standard_ND24s
Standard_ND24rs
Standard_NV6
Standard_NV12
Standard_NV24

VMDiskSecurityProfile

Objeto

Especifica as configurações de perfil de segurança para o disco gerenciado. Observação: Ele só pode ser definido para VMs confidenciais.

Nome	Tipo	Description
diskEncryptionSet	DiskEncryptionSetParameters	Especifica a ID do recurso do conjunto de criptografia de disco gerenciado pelo cliente para o disco gerenciado usado para a Chave Gerenciada pelo Cliente criptografado disco do sistema operacional ConfidentialVM e blob VMGuest.
securityEncryptionType	SecurityEncryptionTypes	Especifica o EncryptionType do disco gerenciado. Ele é definido como DiskWithVMGuestState para criptografia do disco gerenciado juntamente com blob VMGuestState, VMGuestStateOnly para criptografia apenas do blob VMGuestState e NonPersistedTPM para não persistir o estado de firmware no blob VMGuestState.. Observação: Ele pode ser definido apenas para VMs confidenciais.

VMSizeProperties

Objeto

Especifica as configurações da Propriedade tamanho da VM na máquina virtual.

Nome	Tipo	Description
vCPUsAvailable	integer (int32)	Especifica o número de vCPUs disponíveis para a VM. Quando essa propriedade não é especificada no corpo da solicitação, o comportamento padrão é defini-la para o valor de vCPUs disponíveis para esse tamanho de VM exposto na resposta à API de Listar todos os tamanhos de máquina virtual disponíveis em uma região.
vCPUsPerCore	integer (int32)	Especifica a relação vCPU com núcleo físico. Quando essa propriedade não é especificada no corpo da solicitação, o comportamento padrão é definido como o valor de vCPUsPerCore para o Tamanho da VM exposto na resposta à API de Listar todos os tamanhos de máquina virtual disponíveis em uma região. Definir essa propriedade como 1 também significa que o hiper-threading está desabilitado.

WindowsConfiguration

Objeto

Especifica as configurações do sistema operacional Windows na máquina virtual.

Nome	Tipo	Description
additionalUnattendContent	AdditionalUnattendContent[]	Especifica informações XML codificadas em base 64 adicionais que podem ser incluídas no arquivo Unattend.xml, que é usado pela Instalação do Windows.
enableAutomaticUpdates	boolean	Indica se as Atualizações Automáticas estão habilitadas para a máquina virtual do Windows. O valor padrão é verdadeiro. Para conjuntos de dimensionamento de máquinas virtuais, essa propriedade pode ser atualizada e as atualizações entrarão em vigor no reprovisionamento do sistema operacional.
enableVMAgentPlatformUpdates	boolean	Indica se as atualizações da plataforma VMAgent estão habilitadas para a máquina virtual do Windows.
patchSettings	PatchSettings	[Recurso de visualização] Especifica as configurações relacionadas à aplicação de patch de convidado da VM no Windows.
provisionVMAgent	boolean	Indica se o agente de máquina virtual deve ser provisionado na máquina virtual. Quando essa propriedade não é especificada no corpo da solicitação, ela é definida como true por padrão. Isso garantirá que o Agente de VM seja instalado na VM para que as extensões possam ser adicionadas à VM posteriormente.
timeZone	string	Especifica o fuso horário da máquina virtual. por exemplo, "Horário Padrão do Pacífico". Os valores possíveis podem ser TimeZoneInfo.Id valor de fusos horários retornados por TimeZoneInfo.GetSystemTimeZones.
winRM	WinRMConfiguration	Especifica os ouvintes de Gerenciamento Remoto do Windows. Isso habilita o Windows PowerShell remoto.

WindowsPatchAssessmentMode

Enumeração

Especifica o modo de avaliação de patch convidado da VM para a máquina virtual IaaS.

Os valores possíveis são:

ImageDefault – você controla o tempo das avaliações de patch em uma máquina virtual.

AutomaticByPlatform – a plataforma disparará avaliações periódicas de patch. A propriedade provisionVMAgent deve ser verdadeira.

Valor	Description
ImageDefault
AutomaticByPlatform

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Enumeração

Especifica a configuração de reinicialização para todas as operações de instalação de patch AutomaticByPlatform.

Valor	Description
Unknown
IfRequired
Never
Always

WindowsVMGuestPatchAutomaticByPlatformSettings

Objeto

Especifica configurações adicionais a serem aplicadas quando o modo de patch AutomaticByPlatform é selecionado nas configurações de patch do Windows.

Nome	Tipo	Description
bypassPlatformSafetyChecksOnUserSchedule	boolean	Permite que o cliente agende a aplicação de patch sem atualizações acidentais
rebootSetting	WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Especifica a configuração de reinicialização para todas as operações de instalação de patch AutomaticByPlatform.

WindowsVMGuestPatchMode

Enumeração

Especifica o modo de aplicação de patch de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquinas virtuais com OrchestrationMode como Flexível.

Os valores possíveis são:

Manual - Você controla a aplicação de patches em uma máquina virtual. Faça isso aplicando patches manualmente dentro da VM. Nesse modo, as atualizações automáticas são desabilitadas; a propriedade WindowsConfiguration.enableAutomaticUpdates deve ser falsa

AutomaticByOS – a máquina virtual será atualizada automaticamente pelo sistema operacional. A propriedade WindowsConfiguration.enableAutomaticUpdates deve ser verdadeira.

AutomaticByPlatform – a máquina virtual será atualizada automaticamente pela plataforma. As propriedades provisionVMAgent e WindowsConfiguration.enableAutomaticUpdates devem ser verdadeiras

Valor	Description
Manual
AutomaticByOS
AutomaticByPlatform

WinRMConfiguration

Objeto

Descreve a configuração de Gerenciamento Remoto do Windows da VM

Nome	Tipo	Description
listeners	WinRMListener[]	A lista de ouvintes de Gerenciamento Remoto do Windows

WinRMListener

Objeto

Descreve o protocolo e a impressão digital do ouvinte de Gerenciamento Remoto do Windows

Nome	Tipo	Description
certificateUrl	string	Essa é a URL de um certificado que foi carregado no Key Vault como um segredo. Para adicionar um segredo ao Key Vault, consulte Adicionar uma chave ou segredo ao cofre de chaves. Nesse caso, seu certificado precisa ser a codificação Base64 do seguinte objeto JSON codificado em UTF-8: { "data":"<>de certificado codificado em Base64", "dataType":"pfx", "senha":"<senha-de-arquivo-pfx>" } Para instalar certificados em uma máquina virtual, é recomendável usar a extensão de máquina virtual Azure Key Vault para Linux ou a extensão de máquina virtual do Azure Key Vault para Windows.
protocol	ProtocolTypes	Especifica o protocolo do ouvinte WinRM. Os valores possíveis são: http,https.

Compartilhar via

Restore Points - Get

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

Get a restore point

Solicitação de exemplo

Resposta de exemplo

Get restore point with instance view

Solicitação de exemplo

Resposta de exemplo

Definições

AdditionalUnattendContent

ApiEntityReference

ApiError

ApiErrorBase

BootDiagnostics

CachingTypes

CloudError

ComponentNames

ConsistencyModeTypes

createdByType

DiagnosticsProfile

DiskControllerTypes

DiskEncryptionSetParameters

DiskEncryptionSettings

DiskRestorePointAttributes

DiskRestorePointInstanceView

DiskRestorePointReplicationStatus

EncryptionIdentity

HardwareProfile

HostEndpointSettings

HyperVGenerationTypes

InnerError

InstanceViewStatus

KeyVaultKeyReference

KeyVaultSecretReference

LinuxConfiguration

LinuxPatchAssessmentMode

LinuxPatchSettings

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

LinuxVMGuestPatchAutomaticByPlatformSettings

LinuxVMGuestPatchMode

ManagedDiskParameters

Mode

Modes

OperatingSystemType

OSProfile

PassNames

PatchSettings

ProtocolTypes

ProxyAgentSettings

RestorePoint

RestorePointEncryption

RestorePointEncryptionType

RestorePointExpandOptions

RestorePointInstanceView

RestorePointSourceMetadata

RestorePointSourceVMDataDisk

RestorePointSourceVMOSDisk

RestorePointSourceVMStorageProfile

SecurityEncryptionTypes

SecurityProfile

SecurityTypes

SettingNames

SnapshotAccessState

SshConfiguration

SshPublicKey

StatusLevelTypes

StorageAccountTypes

SubResource

systemData

UefiSettings

VaultCertificate

VaultSecretGroup

VirtualMachineSizeTypes

VMDiskSecurityProfile