Restore Points - Get

Служба:

Compute

Версия API:

2024-07-01

Операция получения точки восстановления.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов.
restorePointCollectionName	path	True	string	Имя коллекции точек восстановления.
restorePointName	path	True	string	Имя точки восстановления.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
api-version	query	True	string	Версия клиентского API.
$expand	query		RestorePointExpandOptions	Выражение расширения, применяемое к операции. InstanceView получает сведения о состоянии времени выполнения точки восстановления.

Ответы

Имя	Тип	Описание
200 OK	RestorePoint	ХОРОШО
Other Status Codes	CloudError	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Get a restore point

Get restore point with instance view

Get a restore point

Образец запроса

HTTP

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

Java

/**
 * Samples for RestorePoints Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-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

Python

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

Go

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v6"
)

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

JavaScript

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * 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/2024-07-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

dotnet

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

Пример ответа

Код состояния:

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"
    },
    "provisioningState": "Succeeded",
    "consistencyMode": "ApplicationConsistent",
    "timeCreated": "2021-01-27T20:35:05.8401519+00:00"
  }
}

Get restore point with instance view

Образец запроса

HTTP

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

Java

/**
 * Samples for RestorePoints Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-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

Python

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

Go

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/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),
	// 						},
	// 					},
	// 			}},
	// 			Statuses: []*armcompute.InstanceViewStatus{
	// 				{
	// 					Code: to.Ptr("ReplicationState/succeeded"),
	// 					DisplayStatus: to.Ptr("Succeeded"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 			}},
	// 		},
	// 		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

JavaScript

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * 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/2024-07-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

dotnet

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

Пример ответа

Код состояния:

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"
    },
    "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",
          "replicationStatus": {
            "status": {
              "code": "ReplicationState/succeeded",
              "level": "Info",
              "displayStatus": "Succeeded"
            },
            "completionPercent": 100
          }
        }
      ],
      "statuses": [
        {
          "code": "ReplicationState/succeeded",
          "level": "Info",
          "displayStatus": "Succeeded"
        }
      ]
    }
  }
}

Определения

Имя	Описание
AdditionalUnattendContent	Указывает дополнительные xml-форматированные сведения, которые можно включить в файл Unattend.xml, который используется программой установки Windows. Содержимое определяется по имени, имени компонента и передаче, в которой применяется содержимое.
ApiEntityReference	Справочник по сущностям API.
ApiError	Ошибка API.
ApiErrorBase	База ошибок API.
BootDiagnostics	Диагностика загрузки — это функция отладки, которая позволяет просматривать выходные данные консоли и снимок экрана для диагностики состояния виртуальной машины. Вы можете легко просмотреть выходные данные журнала консоли. Azure также позволяет просмотреть снимок экрана виртуальной машины из гипервизора.
CachingTypes	Возвращает тип кэширования.
CloudError	Ответ на ошибку из службы вычислений.
ComponentNames	Имя компонента. В настоящее время единственным допустимым значением является Microsoft-Windows-Shell-Setup.
ConsistencyModeTypes	ConsistencyMode объекта RestorePoint. Можно указать во входных данных при создании точки восстановления. В настоящее время только CrashConsistent принимается в качестве допустимых входных данных. Дополнительные сведения см. в https://aka.ms/RestorePoints.
DiagnosticsProfile	Указывает состояние параметров диагностики загрузки. Минимальная версия API: 2015-06-15.
DiskControllerTypes	Возвращает тип контроллера диска виртуальной машины, захваченной во время создания точки восстановления.
DiskEncryptionSetParameters	Описывает параметр набора ресурсов набора шифрования управляемых клиентом дисков, который можно указать для диска. Примечание. идентификатор ресурса набора шифрования дисков можно указать только для управляемого диска. Дополнительные сведения см. в https://aka.ms/mdssewithcmkoverview.
DiskEncryptionSettings	Описание параметров шифрования диска
DiskRestorePointAttributes	Сведения о точке восстановления диска.
DiskRestorePointInstanceView	Представление экземпляра точки восстановления диска.
DiskRestorePointReplicationStatus	Представление экземпляра точки восстановления диска.
EncryptionIdentity	Указывает управляемое удостоверение, используемое ADE для получения маркера доступа для операций keyvault.
HardwareProfile	Указывает параметры оборудования для виртуальной машины.
HyperVGenerationTypes	HyperVGeneration исходной виртуальной машины, для которой фиксируется точка восстановления.
InnerError	Сведения о внутренней ошибке.
InstanceViewStatus	Состояние представления экземпляра.
KeyVaultKeyReference	Описание ссылки на ключ Key Vault
KeyVaultSecretReference	Описание ссылки на секрет Key Vault
LinuxConfiguration	Указывает параметры операционной системы Linux на виртуальной машине. Список поддерживаемых дистрибутивов Linux см. в Linux в Azure-Endorsed дистрибутивах.
LinuxPatchAssessmentMode	Указывает режим оценки гостевых исправлений виртуальной машины для виртуальной машины IaaS. Возможные значения: ImageDefault. Вы управляете временем оценки исправлений на виртуальной машине. AutomaticByPlatform . Платформа будет запускать периодические оценки исправлений. Свойство provisionVMAgent должно быть true.
LinuxPatchSettings	Указывает параметры, связанные с исправлением гостевой виртуальной машины в Linux.
LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform.
LinuxVMGuestPatchAutomaticByPlatformSettings	Указывает дополнительные параметры, применяемые при выборе режима исправления AutomaticByPlatform в параметрах исправлений Linux.
LinuxVMGuestPatchMode	Указывает режим гостевой исправления виртуальной машины на виртуальную машину IaaS или виртуальные машины, связанные с масштабируемым набором виртуальных машин с OrchestrationMode как гибкий. Возможные значения: ImageDefault — используется конфигурация исправления по умолчанию виртуальной машины. AutomaticByPlatform. Виртуальная машина будет автоматически обновляться платформой. Свойство provisionVMAgent должно иметь значение true
ManagedDiskParameters	Параметры управляемого диска.
Mode	Указывает режим, на котором будет выполняться ProxyAgent, если эта функция включена. ProxyAgent начнет аудит или мониторинг, но не применяет управление доступом к запросам к конечным точкам узла в режиме аудита, в то время как в режиме принудительного применения будет применяться управление доступом. Значением по умолчанию является режим принудительного применения.
OperatingSystemType	Возвращает тип операционной системы.
OSProfile	Задает параметры операционной системы для виртуальной машины. Некоторые параметры нельзя изменить после подготовки виртуальной машины.
PassNames	Имя передачи. В настоящее время единственным допустимым значением является OobeSystem.
PatchSettings	Указывает параметры, связанные с исправлением гостевой виртуальной машины в Windows.
ProtocolTypes	Задает протокол прослушивателя WinRM. Возможные значения: http,https.
ProxyAgentSettings	Задает параметры ProxyAgent при создании виртуальной машины. Минимальная версия API: 2023-09-01.
RestorePoint	Сведения о точке восстановления.
RestorePointEncryption	Параметры шифрования неактивных данных для точки восстановления диска. Это необязательное свойство, которое можно указать во входных данных при создании точки восстановления.
RestorePointEncryptionType	Тип ключа, используемого для шифрования данных точки восстановления диска.
RestorePointExpandOptions	Выражение расширения, применяемое к операции. InstanceView получает сведения о состоянии времени выполнения точки восстановления.
RestorePointInstanceView	Представление экземпляра точки восстановления.
RestorePointSourceMetadata	Описывает свойства виртуальной машины, для которой была создана точка восстановления. Предоставленные свойства представляют собой подмножество и моментальный снимок общих свойств виртуальной машины, захваченных во время создания точки восстановления.
RestorePointSourceVMDataDisk	Описывает диск данных.
RestorePointSourceVMOSDisk	Описывает диск операционной системы.
RestorePointSourceVMStorageProfile	Описывает профиль хранения.
securityEncryptionTypes	Указывает тип шифрования управляемого диска. Он имеет значение DiskWithVMGuestState для шифрования управляемого диска вместе с большим двоичным объектом VMGuestState, VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для сохранения состояния встроенного ПО в BLOB-объекте VMGuestState. Примечание. Его можно задать только для конфиденциальных виртуальных машин.
SecurityProfile	Задает параметры профиля безопасности для масштабируемого набора виртуальных машин или виртуальной машины.
SecurityTypes	Указывает тип безопасности виртуальной машины. Для включения UefiSettings необходимо задать любое указанное значение. Поведение по умолчанию: UefiSettings не будет включен, если это свойство не задано.
SettingNames	Указывает имя параметра, к которому применяется содержимое. Возможные значения: FirstLogonCommands и AutoLogon.
SshConfiguration	Конфигурация SSH для виртуальных машин под управлением Linux, работающих в Azure
SshPublicKey	Содержит сведения о открытом ключе сертификата SSH и пути к виртуальной машине Linux, где размещается открытый ключ.
StatusLevelTypes	Код уровня.
StorageAccountTypes	Указывает тип учетной записи хранения для управляемого диска. ПРИМЕЧАНИЕ. UltraSSD_LRS можно использовать только с дисками данных, его нельзя использовать с диском ОС.
SubResource
UefiSettings	Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины. Минимальная версия API: 2020-12-01.
VaultCertificate	Описывает одну ссылку на сертификат в Key Vault и расположение сертификата на виртуальной машине.
VaultSecretGroup	Описывает набор сертификатов, которые находятся в одном хранилище ключей.
VirtualMachineSizeTypes	Указывает размер виртуальной машины. В настоящее время тип данных перечисления устарел и будет удален 23 декабря 2023 года. Рекомендуемый способ получить список доступных размеров использует следующие API: перечислить все доступные размеры виртуальных машин в группе доступности, Перечислить все доступные размеры виртуальных машин в регионе, перечислить все доступные размеры виртуальных машин для изменения размера. Дополнительные сведения о размерах виртуальных машин см. в разделе Размеры виртуальных машин. Доступные размеры виртуальных машин зависят от региона и группы доступности.
VMDiskSecurityProfile	Задает параметры профиля безопасности для управляемого диска. Примечание. его можно задать только для конфиденциальных виртуальных машин.
VMSizeProperties	Задает параметры свойства размера виртуальной машины на виртуальной машине.
WindowsConfiguration	Указывает параметры операционной системы Windows на виртуальной машине.
WindowsPatchAssessmentMode	Указывает режим оценки исправлений гостевой виртуальной машины для виртуальной машины IaaS. Возможные значения: ImageDefault. Вы управляете временем оценки исправлений на виртуальной машине. AutomaticByPlatform . Платформа будет запускать периодические оценки исправлений. Свойство provisionVMAgent должно быть true.
WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform.
WindowsVMGuestPatchAutomaticByPlatformSettings	Указывает дополнительные параметры, применяемые при выборе режима исправления AutomaticByPlatform в параметрах исправлений Windows.
WindowsVMGuestPatchMode	Указывает режим гостевой исправления виртуальной машины на виртуальную машину IaaS или виртуальные машины, связанные с масштабируемым набором виртуальных машин с OrchestrationMode как гибкий. Возможные значения: вручную . Вы управляете применением исправлений к виртуальной машине. Это можно сделать, применяя исправления вручную внутри виртуальной машины. В этом режиме автоматические обновления отключены; Свойство WindowsConfiguration.enableAutomaticUpdates должно быть false automaticByOS. Виртуальная машина автоматически обновляется ОС. Свойство WindowsConfiguration.enableAutomaticUpdates должно иметь значение true. AutomaticByPlatform — виртуальная машина автоматически обновляется платформой. Свойства provisionVMAgent и WindowsConfiguration.enableAutomaticUpdates должны иметь значение true.
WinRMConfiguration	Описание конфигурации удаленного управления Windows виртуальной машины
WinRMListener	Описание протокола и отпечатка прослушивателя удаленного управления Windows

AdditionalUnattendContent

Указывает дополнительные xml-форматированные сведения, которые можно включить в файл Unattend.xml, который используется программой установки Windows. Содержимое определяется по имени, имени компонента и передаче, в которой применяется содержимое.

Имя	Тип	Описание
componentName	ComponentNames	Имя компонента. В настоящее время единственным допустимым значением является Microsoft-Windows-Shell-Setup.
content	string	Задает форматированный XML-контент, добавляемый в файл unattend.xml для указанного пути и компонента. XML-код должен быть меньше 4 КБ и должен содержать корневой элемент для вставленного параметра или компонента.
passName	PassNames	Имя передачи. В настоящее время единственным допустимым значением является OobeSystem.
settingName	SettingNames	Указывает имя параметра, к которому применяется содержимое. Возможные значения: FirstLogonCommands и AutoLogon.

ApiEntityReference

Справочник по сущностям API.

Имя	Тип	Описание
id	string	Идентификатор ресурса ARM в виде /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Ошибка API.

Имя	Тип	Описание
code	string	Код ошибки.
details	ApiErrorBase[]	Сведения об ошибке API
innererror	InnerError	Внутренняя ошибка API
message	string	Сообщение об ошибке.
target	string	Целевой объект конкретной ошибки.

ApiErrorBase

База ошибок API.

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке.
target	string	Целевой объект конкретной ошибки.

BootDiagnostics

Диагностика загрузки — это функция отладки, которая позволяет просматривать выходные данные консоли и снимок экрана для диагностики состояния виртуальной машины. Вы можете легко просмотреть выходные данные журнала консоли. Azure также позволяет просмотреть снимок экрана виртуальной машины из гипервизора.

Имя	Тип	Описание
enabled	boolean	Следует ли включить диагностику загрузки на виртуальной машине.
storageUri	string	Uri учетной записи хранения, используемой для размещения выходных данных консоли и снимка экрана. Если storageUri не указан при включении диагностики загрузки, будет использоваться управляемое хранилище.

CachingTypes

Возвращает тип кэширования.

Имя	Тип	Описание
None	string
ReadOnly	string
ReadWrite	string

CloudError

Ответ на ошибку из службы вычислений.

Имя	Тип	Описание
error	ApiError	Ошибка API.

ComponentNames

Имя компонента. В настоящее время единственным допустимым значением является Microsoft-Windows-Shell-Setup.

Имя	Тип	Описание
Microsoft-Windows-Shell-Setup	string

ConsistencyModeTypes

ConsistencyMode объекта RestorePoint. Можно указать во входных данных при создании точки восстановления. В настоящее время только CrashConsistent принимается в качестве допустимых входных данных. Дополнительные сведения см. в https://aka.ms/RestorePoints.

Имя	Тип	Описание
ApplicationConsistent	string
CrashConsistent	string
FileSystemConsistent	string

DiagnosticsProfile

Указывает состояние параметров диагностики загрузки. Минимальная версия API: 2015-06-15.

Имя	Тип	Описание
bootDiagnostics	BootDiagnostics	Диагностика загрузки — это функция отладки, которая позволяет просматривать выходные данные консоли и снимок экрана для диагностики состояния виртуальной машины. ПРИМЕЧАНИЕ. Если указан URI хранилища, убедитесь, что учетная запись хранения находится в том же регионе и подписке, что и виртуальная машина. Вы можете легко просмотреть выходные данные журнала консоли. Azure также позволяет просмотреть снимок экрана виртуальной машины из гипервизора.

DiskControllerTypes

Возвращает тип контроллера диска виртуальной машины, захваченной во время создания точки восстановления.

Имя	Тип	Описание
NVMe	string
SCSI	string

DiskEncryptionSetParameters

Описывает параметр набора ресурсов набора шифрования управляемых клиентом дисков, который можно указать для диска. Примечание. идентификатор ресурса набора шифрования дисков можно указать только для управляемого диска. Дополнительные сведения см. в https://aka.ms/mdssewithcmkoverview.

Имя	Тип	Описание
id	string	Идентификатор ресурса

DiskEncryptionSettings

Описание параметров шифрования диска

Имя	Тип	Описание
diskEncryptionKey	KeyVaultSecretReference	Указывает расположение ключа шифрования диска, являющегося секретом Key Vault.
enabled	boolean	Указывает, следует ли включить шифрование дисков на виртуальной машине.
keyEncryptionKey	KeyVaultKeyReference	Указывает расположение ключа шифрования ключей в Key Vault.

DiskRestorePointAttributes

Сведения о точке восстановления диска.

Имя	Тип	Описание
encryption	RestorePointEncryption	Параметры шифрования неактивных данных для точки восстановления диска. Это необязательное свойство, которое можно указать во входных данных при создании точки восстановления.
id	string	Идентификатор ресурса
sourceDiskRestorePoint	ApiEntityReference	Идентификатор ресурса точки восстановления исходного диска.

DiskRestorePointInstanceView

Представление экземпляра точки восстановления диска.

Имя	Тип	Описание
id	string	Идентификатор точки восстановления диска.
replicationStatus	DiskRestorePointReplicationStatus	Сведения о состоянии репликации точки восстановления диска.

DiskRestorePointReplicationStatus

Представление экземпляра точки восстановления диска.

Имя	Тип	Описание
completionPercent	integer	Процент завершения репликации.
status	InstanceViewStatus	Сведения о состоянии ресурса.

EncryptionIdentity

Указывает управляемое удостоверение, используемое ADE для получения маркера доступа для операций keyvault.

Имя	Тип	Описание
userAssignedIdentityResourceId	string	Указывает идентификатор ресурса ARM одного из удостоверений пользователя, связанных с виртуальной машиной.

HardwareProfile

Указывает параметры оборудования для виртуальной машины.

Имя	Тип	Описание
vmSize	VirtualMachineSizeTypes	Указывает размер виртуальной машины. В настоящее время тип данных перечисления устарел и будет удален 23 декабря 2023 года. Рекомендуемый способ получить список доступных размеров использует следующие API: перечислить все доступные размеры виртуальных машин в группе доступности, Перечислить все доступные размеры виртуальных машин в регионе, перечислить все доступные размеры виртуальных машин для изменения размера. Дополнительные сведения о размерах виртуальных машин см. в разделе Размеры виртуальных машин. Доступные размеры виртуальных машин зависят от региона и группы доступности.
vmSizeProperties	VMSizeProperties	Задает свойства для настройки размера виртуальной машины. Минимальная версия API: 2021-07-01. Эта функция по-прежнему находится в режиме предварительной версии и не поддерживается для VirtualMachineScaleSet. Дополнительные сведения см. в настройки виртуальной машины.

HyperVGenerationTypes

HyperVGeneration исходной виртуальной машины, для которой фиксируется точка восстановления.

Имя	Тип	Описание
V1	string
V2	string

InnerError

Сведения о внутренней ошибке.

Имя	Тип	Описание
errordetail	string	Внутреннее сообщение об ошибке или дамп исключений.
exceptiontype	string	Тип исключения.

InstanceViewStatus

Состояние представления экземпляра.

Имя	Тип	Описание
code	string	Код состояния.
displayStatus	string	Короткая локализуемая метка для состояния.
level	StatusLevelTypes	Код уровня.
message	string	Подробное сообщение о состоянии, в том числе для оповещений и сообщений об ошибках.
time	string	Время состояния.

KeyVaultKeyReference

Описание ссылки на ключ Key Vault

Имя	Тип	Описание
keyUrl	string	URL-адрес, ссылающийся на ключ шифрования ключей в Key Vault.
sourceVault	SubResource	Относительный URL-адрес Хранилища ключей, содержащий ключ.

KeyVaultSecretReference

Описание ссылки на секрет Key Vault

Имя	Тип	Описание
secretUrl	string	URL-адрес, ссылающийся на секрет в Key Vault.
sourceVault	SubResource	Относительный URL-адрес Хранилища ключей, содержащий секрет.

LinuxConfiguration

Указывает параметры операционной системы Linux на виртуальной машине. Список поддерживаемых дистрибутивов Linux см. в Linux в Azure-Endorsed дистрибутивах.

Имя	Тип	Описание
disablePasswordAuthentication	boolean	Указывает, следует ли отключить проверку подлинности паролей.
enableVMAgentPlatformUpdates	boolean	Указывает, включены ли обновления платформы VMAgent для виртуальной машины Linux. Значение по умолчанию — false.
patchSettings	LinuxPatchSettings	[Предварительная версия компонента] Указывает параметры, связанные с исправлением гостевой виртуальной машины в Linux.
provisionVMAgent	boolean	Указывает, следует ли подготовить агент виртуальной машины на виртуальной машине. Если это свойство не указано в тексте запроса, поведение по умолчанию — задать для него значение true. Это гарантирует, что агент виртуальной машины установлен на виртуальной машине, чтобы расширения можно было добавить в виртуальную машину позже.
ssh	SshConfiguration	Указывает конфигурацию ключа SSH для ОС Linux.

LinuxPatchAssessmentMode

Указывает режим оценки гостевых исправлений виртуальной машины для виртуальной машины IaaS.

Возможные значения:

ImageDefault. Вы управляете временем оценки исправлений на виртуальной машине.

AutomaticByPlatform . Платформа будет запускать периодические оценки исправлений. Свойство provisionVMAgent должно быть true.

Имя	Тип	Описание
AutomaticByPlatform	string
ImageDefault	string

LinuxPatchSettings

Указывает параметры, связанные с исправлением гостевой виртуальной машины в Linux.

Имя	Тип	Описание
assessmentMode	LinuxPatchAssessmentMode	Указывает режим оценки гостевых исправлений виртуальной машины для виртуальной машины IaaS. Возможные значения: ImageDefault. Вы управляете временем оценки исправлений на виртуальной машине. AutomaticByPlatform . Платформа будет запускать периодические оценки исправлений. Свойство provisionVMAgent должно быть true.
automaticByPlatformSettings	LinuxVMGuestPatchAutomaticByPlatformSettings	Задает дополнительные параметры режима исправления AutomaticByPlatform в гостевой исправлении виртуальной машины в Linux.
patchMode	LinuxVMGuestPatchMode	Указывает режим гостевой исправления виртуальной машины на виртуальную машину IaaS или виртуальные машины, связанные с масштабируемым набором виртуальных машин с OrchestrationMode как гибкий. Возможные значения: ImageDefault — используется конфигурация исправления по умолчанию виртуальной машины. AutomaticByPlatform. Виртуальная машина будет автоматически обновляться платформой. Свойство provisionVMAgent должно иметь значение true

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform.

Имя	Тип	Описание
Always	string
IfRequired	string
Never	string
Unknown	string

LinuxVMGuestPatchAutomaticByPlatformSettings

Указывает дополнительные параметры, применяемые при выборе режима исправления AutomaticByPlatform в параметрах исправлений Linux.

Имя	Тип	Описание
bypassPlatformSafetyChecksOnUserSchedule	boolean	Позволяет клиенту планировать исправление без случайного обновления
rebootSetting	LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform.

LinuxVMGuestPatchMode

Указывает режим гостевой исправления виртуальной машины на виртуальную машину IaaS или виртуальные машины, связанные с масштабируемым набором виртуальных машин с OrchestrationMode как гибкий.

Возможные значения:

ImageDefault — используется конфигурация исправления по умолчанию виртуальной машины.

AutomaticByPlatform. Виртуальная машина будет автоматически обновляться платформой. Свойство provisionVMAgent должно иметь значение true

Имя	Тип	Описание
AutomaticByPlatform	string
ImageDefault	string

ManagedDiskParameters

Параметры управляемого диска.

Имя	Тип	Описание
diskEncryptionSet	DiskEncryptionSetParameters	Указывает идентификатор ресурса набора шифрования управляемых пользователем дисков для управляемого диска.
id	string	Идентификатор ресурса
securityProfile	VMDiskSecurityProfile	Указывает профиль безопасности управляемого диска.
storageAccountType	StorageAccountTypes	Указывает тип учетной записи хранения для управляемого диска. ПРИМЕЧАНИЕ. UltraSSD_LRS можно использовать только с дисками данных, его нельзя использовать с диском ОС.

Mode

Указывает режим, на котором будет выполняться ProxyAgent, если эта функция включена. ProxyAgent начнет аудит или мониторинг, но не применяет управление доступом к запросам к конечным точкам узла в режиме аудита, в то время как в режиме принудительного применения будет применяться управление доступом. Значением по умолчанию является режим принудительного применения.

Имя	Тип	Описание
Audit	string
Enforce	string

OperatingSystemType

Возвращает тип операционной системы.

Имя	Тип	Описание
Linux	string
Windows	string

OSProfile

Задает параметры операционной системы для виртуальной машины. Некоторые параметры нельзя изменить после подготовки виртуальной машины.

Имя	Тип	Описание
adminPassword	string	Указывает пароль учетной записи администратора. минимальная длина (Windows): 8 символов минимальная длина (Linux): 6 символов Максимальная длина (Windows): 123 символов максимальная длина (Linux): 72 символов требования к сложности : необходимо выполнить 3 из 4 условий ниже. Имеет нижние символы Имеет верхние символы Имеет цифру Имеет специальный символ (regex match [\W_]) Запрещенные значения: "abc@123", "P@$$w 0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "loweyou!" Сведения о сбросе пароля см. в статье Как сбросить службу удаленного рабочего стола или пароль для входа в виртуальной машины Windows. Сведения о сбросе корневого пароля см. в статье Управление пользователями, SSH и проверка или восстановление дисков на виртуальных машинах Linux Azure с помощью расширения VMAccess
adminUsername	string	Указывает имя учетной записи администратора. Это свойство невозможно обновить после создания виртуальной машины. ограничение только для Windows: не удается завершить ". Запрещенные значения: "администратор", "admin", "user1", "user1", "test2", "test1", "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". минимальная длина (Linux): 1 символ максимальная длина (Linux): 64 символов максимальная длина (Windows): 20 символов.
allowExtensionOperations	boolean	Указывает, следует ли разрешать операции расширения на виртуальной машине. Это значение может быть задано только в том случае, если расширения отсутствуют на виртуальной машине.
computerName	string	Указывает имя ОС узла виртуальной машины. Это имя невозможно обновить после создания виртуальной машины. максимальная длина (Windows): 15 символов. Максимальная длина (Linux): 64 символов. Соглашения об именовании и ограничения см. в руководства по реализации служб инфраструктуры Azure.
customData	string	Задает строку в кодировке base-64 пользовательских данных. Строка в кодировке Base-64 декодируется в двоичный массив, сохраненный в виде файла на виртуальной машине. Максимальная длина двоичного массива составляет 65535 байтов. Примечание. Не передавать секреты или пароли в свойстве customData. Это свойство невозможно обновить после создания виртуальной машины. Свойство CustomData передается виртуальной машине для сохранения в виде файла, дополнительные сведения см. в пользовательских данных на виртуальных машинах Azure. Сведения об использовании cloud-init для виртуальной машины Linux см. в статье Использование cloud-init для настройки виртуальной машины Linux во время создания.
linuxConfiguration	LinuxConfiguration	Указывает параметры операционной системы Linux на виртуальной машине. Список поддерживаемых дистрибутивов Linux см. в Linux в Azure-Endorsed дистрибутивах.
requireGuestProvisionSignal	boolean	Необязательное свойство, которое должно иметь значение True или опущено.
secrets	VaultSecretGroup[]	Задает набор сертификатов, которые должны быть установлены на виртуальной машине. Чтобы установить сертификаты на виртуальной машине, рекомендуется использовать расширение виртуальной машины Azure Key Vault для Linux или расширение виртуальной машины Azure Key Vault для Windows.
windowsConfiguration	WindowsConfiguration	Указывает параметры операционной системы Windows на виртуальной машине.

PassNames

Имя передачи. В настоящее время единственным допустимым значением является OobeSystem.

Имя	Тип	Описание
OobeSystem	string

PatchSettings

Указывает параметры, связанные с исправлением гостевой виртуальной машины в Windows.

Имя	Тип	Описание
assessmentMode	WindowsPatchAssessmentMode	Указывает режим оценки исправлений гостевой виртуальной машины для виртуальной машины IaaS. Возможные значения: ImageDefault. Вы управляете временем оценки исправлений на виртуальной машине. AutomaticByPlatform . Платформа будет запускать периодические оценки исправлений. Свойство provisionVMAgent должно быть true.
automaticByPlatformSettings	WindowsVMGuestPatchAutomaticByPlatformSettings	Указывает дополнительные параметры режима исправления AutomaticByPlatform в гостевой исправлении виртуальной машины в Windows.
enableHotpatching	boolean	Позволяет клиентам исправлять виртуальные машины Azure без перезагрузки. Для включенияHotpatching для параметра provisionVMAgent должно быть задано значение true, а для patchMode должно быть задано значение AutomaticByPlatform.
patchMode	WindowsVMGuestPatchMode	Указывает режим гостевой исправления виртуальной машины на виртуальную машину IaaS или виртуальные машины, связанные с масштабируемым набором виртуальных машин с OrchestrationMode как гибкий. Возможные значения: вручную . Вы управляете применением исправлений к виртуальной машине. Это можно сделать, применяя исправления вручную внутри виртуальной машины. В этом режиме автоматические обновления отключены; Свойство WindowsConfiguration.enableAutomaticUpdates должно быть false automaticByOS. Виртуальная машина автоматически обновляется ОС. Свойство WindowsConfiguration.enableAutomaticUpdates должно иметь значение true. AutomaticByPlatform — виртуальная машина автоматически обновляется платформой. Свойства provisionVMAgent и WindowsConfiguration.enableAutomaticUpdates должны иметь значение true.

ProtocolTypes

Задает протокол прослушивателя WinRM. Возможные значения: http,https.

Имя	Тип	Описание
Http	string
Https	string

ProxyAgentSettings

Задает параметры ProxyAgent при создании виртуальной машины. Минимальная версия API: 2023-09-01.

Имя	Тип	Описание
enabled	boolean	Указывает, следует ли включить функцию ProxyAgent на виртуальной машине или масштабируемом наборе виртуальных машин.
keyIncarnationId	integer	Увеличьте значение этого свойства, чтобы пользователь сбрасывал ключ, используемый для защиты канала связи между гостевым и узлом.
mode	Mode	Указывает режим, на котором будет выполняться ProxyAgent, если эта функция включена. ProxyAgent начнет аудит или мониторинг, но не применяет управление доступом к запросам к конечным точкам узла в режиме аудита, в то время как в режиме принудительного применения будет применяться управление доступом. Значением по умолчанию является режим принудительного применения.

RestorePoint

Сведения о точке восстановления.

Имя	Тип	Описание
id	string	Идентификатор ресурса
name	string	Имя ресурса
properties.consistencyMode	ConsistencyModeTypes	ConsistencyMode объекта RestorePoint. Можно указать во входных данных при создании точки восстановления. В настоящее время только CrashConsistent принимается в качестве допустимых входных данных. Дополнительные сведения см. в https://aka.ms/RestorePoints.
properties.excludeDisks	ApiEntityReference[]	Список идентификаторов ресурсов диска, которые клиент хочет исключить из точки восстановления. Если диски не указаны, все диски будут включены.
properties.instanceView	RestorePointInstanceView	Представление экземпляра точки восстановления.
properties.provisioningState	string	Возвращает состояние подготовки точки восстановления.
properties.sourceMetadata	RestorePointSourceMetadata	Возвращает сведения о виртуальной машине, захваченной во время создания точки восстановления.
properties.sourceRestorePoint	ApiEntityReference	Идентификатор ресурса исходной точки восстановления, из которой необходимо создать копию.
properties.timeCreated	string	Возвращает время создания точки восстановления.
type	string	Тип ресурса

RestorePointEncryption

Параметры шифрования неактивных данных для точки восстановления диска. Это необязательное свойство, которое можно указать во входных данных при создании точки восстановления.

Имя	Тип	Описание
diskEncryptionSet	DiskEncryptionSetParameters	Описывает параметр набора ресурсов набора шифрования управляемых клиентом дисков, который можно указать для диска. Примечание. идентификатор ресурса набора шифрования дисков можно указать только для управляемого диска. Дополнительные сведения см. в https://aka.ms/mdssewithcmkoverview.
type	RestorePointEncryptionType	Тип ключа, используемого для шифрования данных точки восстановления диска.

RestorePointEncryptionType

Тип ключа, используемого для шифрования данных точки восстановления диска.

Имя	Тип	Описание
EncryptionAtRestWithCustomerKey	string	Точка восстановления диска шифруется неактивных данных с помощью управляемого клиентом ключа, который можно изменить и отозвать клиентом.
EncryptionAtRestWithPlatformAndCustomerKeys	string	Точка восстановления диска шифруется неактивных данных с 2 уровнями шифрования. Одним из ключей является управление клиентом, а другой — управление платформой.
EncryptionAtRestWithPlatformKey	string	Точка восстановления диска шифруется неактивных данных с помощью управляемого ключа Platform.

RestorePointExpandOptions

Выражение расширения, применяемое к операции. InstanceView получает сведения о состоянии времени выполнения точки восстановления.

Имя	Тип	Описание
instanceView	string

RestorePointInstanceView

Представление экземпляра точки восстановления.

Имя	Тип	Описание
diskRestorePoints	DiskRestorePointInstanceView[]	Сведения о точках восстановления диска.
statuses	InstanceViewStatus[]	Сведения о состоянии ресурса.

RestorePointSourceMetadata

Описывает свойства виртуальной машины, для которой была создана точка восстановления. Предоставленные свойства представляют собой подмножество и моментальный снимок общих свойств виртуальной машины, захваченных во время создания точки восстановления.

Имя	Тип	Описание
diagnosticsProfile	DiagnosticsProfile	Возвращает профиль диагностики.
hardwareProfile	HardwareProfile	Возвращает профиль оборудования.
hyperVGeneration	HyperVGenerationTypes	HyperVGeneration исходной виртуальной машины, для которой фиксируется точка восстановления.
licenseType	string	Возвращает тип лицензии, который предназначен для создания собственного сценария лицензии.
location	string	Расположение виртуальной машины, из которой была создана точка восстановления.
osProfile	OSProfile	Возвращает профиль ОС.
securityProfile	SecurityProfile	Возвращает профиль безопасности.
storageProfile	RestorePointSourceVMStorageProfile	Возвращает профиль хранилища.
userData	string	UserData, связанная с исходной виртуальной машиной, для которой фиксируется точка восстановления, которая является значением в кодировке base-64.
vmId	string	Возвращает уникальный идентификатор виртуальной машины.

RestorePointSourceVMDataDisk

Описывает диск данных.

Имя	Тип	Описание
caching	CachingTypes	Возвращает тип кэширования.
diskRestorePoint	DiskRestorePointAttributes	Содержит свойства точки восстановления диска.
diskSizeGB	integer	Возвращает начальный размер диска в ГБ для пустых дисков данных и новый требуемый размер для существующих дисков ОС и данных.
lun	integer	Возвращает логическую единицу.
managedDisk	ManagedDiskParameters	Содержит сведения об управляемом диске.
name	string	Возвращает имя диска.
writeAcceleratorEnabled	boolean	Отображает значение true, если диск включен с поддержкой ускорителя записи.

RestorePointSourceVMOSDisk

Описывает диск операционной системы.

Имя	Тип	Описание
caching	CachingTypes	Возвращает тип кэширования.
diskRestorePoint	DiskRestorePointAttributes	Содержит свойства точки восстановления диска.
diskSizeGB	integer	Возвращает размер диска в ГБ.
encryptionSettings	DiskEncryptionSettings	Возвращает параметры шифрования диска.
managedDisk	ManagedDiskParameters	Возвращает сведения об управляемом диске
name	string	Возвращает имя диска.
osType	OperatingSystemType	Возвращает тип операционной системы.
writeAcceleratorEnabled	boolean	Отображает значение true, если диск включен с поддержкой ускорителя записи.

RestorePointSourceVMStorageProfile

Описывает профиль хранения.

Имя	Тип	Описание
dataDisks	RestorePointSourceVMDataDisk[]	Возвращает диски данных виртуальной машины, захваченные во время создания точки восстановления.
diskControllerType	DiskControllerTypes	Возвращает тип контроллера диска виртуальной машины, захваченной во время создания точки восстановления.
osDisk	RestorePointSourceVMOSDisk	Возвращает диск ОС виртуальной машины, захваченной во время создания точки восстановления.

securityEncryptionTypes

Указывает тип шифрования управляемого диска. Он имеет значение DiskWithVMGuestState для шифрования управляемого диска вместе с большим двоичным объектом VMGuestState, VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для сохранения состояния встроенного ПО в BLOB-объекте VMGuestState. Примечание. Его можно задать только для конфиденциальных виртуальных машин.

Имя	Тип	Описание
DiskWithVMGuestState	string
NonPersistedTPM	string
VMGuestStateOnly	string

SecurityProfile

Задает параметры профиля безопасности для масштабируемого набора виртуальных машин или виртуальной машины.

Имя	Тип	Описание
encryptionAtHost	boolean	Это свойство можно использовать пользователем в запросе, чтобы включить или отключить шифрование узла для виртуальной машины или масштабируемого набора виртуальных машин. Это позволит включить шифрование для всех дисков, включая диск Resource/Temp на самом узле. Поведение по умолчанию: шифрование на узле будет отключено, если для ресурса не задано значение true.
encryptionIdentity	EncryptionIdentity	Указывает управляемое удостоверение, используемое ADE для получения маркера доступа для операций keyvault.
proxyAgentSettings	ProxyAgentSettings	Задает параметры ProxyAgent при создании виртуальной машины. Минимальная версия API: 2023-09-01.
securityType	SecurityTypes	Указывает тип безопасности виртуальной машины. Для включения UefiSettings необходимо задать любое указанное значение. Поведение по умолчанию: UefiSettings не будет включен, если это свойство не задано.
uefiSettings	UefiSettings	Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины. Минимальная версия API: 2020-12-01.

SecurityTypes

Указывает тип безопасности виртуальной машины. Для включения UefiSettings необходимо задать любое указанное значение. Поведение по умолчанию: UefiSettings не будет включен, если это свойство не задано.

Имя	Тип	Описание
ConfidentialVM	string
TrustedLaunch	string

SettingNames

Указывает имя параметра, к которому применяется содержимое. Возможные значения: FirstLogonCommands и AutoLogon.

Имя	Тип	Описание
AutoLogon	string
FirstLogonCommands	string

SshConfiguration

Конфигурация SSH для виртуальных машин под управлением Linux, работающих в Azure

Имя	Тип	Описание
publicKeys	SshPublicKey[]	Список открытых ключей SSH, используемых для проверки подлинности с помощью виртуальных машин на основе Linux.

SshPublicKey

Содержит сведения о открытом ключе сертификата SSH и пути к виртуальной машине Linux, где размещается открытый ключ.

Имя	Тип	Описание
keyData	string	Сертификат открытого ключа SSH, используемый для проверки подлинности виртуальной машины через SSH. Ключ должен быть по крайней мере 2048-разрядным и в формате ssh-rsa. Сведения о создании ключей SSH см. в статье [Создание ключей SSH на виртуальных машинах Linux и Mac для Linux в Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).
path	string	Указывает полный путь на созданной виртуальной машине, где хранится открытый ключ SSH. Если файл уже существует, указанный ключ добавляется в файл. Пример: /home/user/.ssh/authorized_keys

StatusLevelTypes

Код уровня.

Имя	Тип	Описание
Error	string
Info	string
Warning	string

StorageAccountTypes

Указывает тип учетной записи хранения для управляемого диска. ПРИМЕЧАНИЕ. UltraSSD_LRS можно использовать только с дисками данных, его нельзя использовать с диском ОС.

Имя	Тип	Описание
PremiumV2_LRS	string
Premium_LRS	string
Premium_ZRS	string
StandardSSD_LRS	string
StandardSSD_ZRS	string
Standard_LRS	string
UltraSSD_LRS	string

SubResource

Имя	Тип	Описание
id	string	Идентификатор ресурса

UefiSettings

Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины. Минимальная версия API: 2020-12-01.

Имя	Тип	Описание
secureBootEnabled	boolean	Указывает, следует ли включить безопасную загрузку на виртуальной машине. Минимальная версия API: 2020-12-01.
vTpmEnabled	boolean	Указывает, следует ли включить vTPM на виртуальной машине. Минимальная версия API: 2020-12-01.

VaultCertificate

Описывает одну ссылку на сертификат в Key Vault и расположение сертификата на виртуальной машине.

Имя	Тип	Описание
certificateStore	string	Для виртуальных машин Windows указывает хранилище сертификатов на виртуальной машине, в которую необходимо добавить сертификат. Указанное хранилище сертификатов неявно находится в учетной записи LocalMachine. Для виртуальных машин Linux файл сертификата помещается в каталог /var/lib/waagent с именем файла <TopcaseThumbprint>.crt для файла сертификата X509 и <TopcaseThumbprint>.prv для закрытого ключа. Оба этих файла имеют формат pem.
certificateUrl	string	Это URL-адрес сертификата, который был отправлен в Key Vault в качестве секрета. Сведения о добавлении секрета в Key Vault см. в статье Добавление ключа или секрета в хранилище ключей. В этом случае сертификат должен быть кодировкой Base64 следующего объекта JSON, который кодируется в UTF-8: { "data":", "dataType":"pfx", "password":"" } Чтобы установить сертификаты на виртуальной машине, рекомендуется использовать расширение виртуальной машины Azure Key Vault для Linux или расширение виртуальной машины Azure Key Vault для Windows.

VaultSecretGroup

Описывает набор сертификатов, которые находятся в одном хранилище ключей.

Имя	Тип	Описание
sourceVault	SubResource	Относительный URL-адрес Хранилища ключей, содержащий все сертификаты в VaultCertificates.
vaultCertificates	VaultCertificate[]	Список ссылок на хранилище ключей в SourceVault, содержащий сертификаты.

VirtualMachineSizeTypes

Указывает размер виртуальной машины. В настоящее время тип данных перечисления устарел и будет удален 23 декабря 2023 года. Рекомендуемый способ получить список доступных размеров использует следующие API: перечислить все доступные размеры виртуальных машин в группе доступности, Перечислить все доступные размеры виртуальных машин в регионе, перечислить все доступные размеры виртуальных машин для изменения размера. Дополнительные сведения о размерах виртуальных машин см. в разделе Размеры виртуальных машин. Доступные размеры виртуальных машин зависят от региона и группы доступности.

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

VMDiskSecurityProfile

Задает параметры профиля безопасности для управляемого диска. Примечание. его можно задать только для конфиденциальных виртуальных машин.

Имя	Тип	Описание
diskEncryptionSet	DiskEncryptionSetParameters	Указывает идентификатор ресурса набора ресурсов шифрования управляемых пользователем дисков для управляемого диска, который используется для зашифрованного диска ОПЕРАЦИОННОй системы Конфиденциальной виртуальной машины и большого двоичного объекта VMGuest.
securityEncryptionType	securityEncryptionTypes	Указывает тип шифрования управляемого диска. Он имеет значение DiskWithVMGuestState для шифрования управляемого диска вместе с большим двоичным объектом VMGuestState, VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для сохранения состояния встроенного ПО в BLOB-объекте VMGuestState. Примечание. Его можно задать только для конфиденциальных виртуальных машин.

VMSizeProperties

Задает параметры свойства размера виртуальной машины на виртуальной машине.

Имя	Тип	Описание
vCPUsAvailable	integer	Указывает количество виртуальных ЦП, доступных для виртуальной машины. Если это свойство не указано в тексте запроса, поведение по умолчанию — задать для него значение виртуальных ЦП, доступных для этого размера виртуальной машины, предоставляемого в ответе api Список всех доступных размеров виртуальных машин в регионе.
vCPUsPerCore	integer	Указывает отношение виртуальных ЦП к физическому ядру. Если это свойство не указано в тексте запроса, поведение по умолчанию присваивается значению vCPUsPerCore для размера виртуальной машины, предоставленного в ответе api Список всех доступных размеров виртуальных машин в регионе. параметру этого свойства значение 1 также означает, что гиперпоток отключен.

WindowsConfiguration

Указывает параметры операционной системы Windows на виртуальной машине.

Имя	Тип	Описание
additionalUnattendContent	AdditionalUnattendContent[]	Указывает дополнительные сведения в формате XML в кодировке Base-64, которые можно включить в файл Unattend.xml, который используется программой установки Windows.
enableAutomaticUpdates	boolean	Указывает, включено ли автоматическое обновление для виртуальной машины Windows. Значение по умолчанию — true. Для масштабируемых наборов виртуальных машин это свойство можно обновить, и обновления вступают в силу при повторной подготовке ОС.
enableVMAgentPlatformUpdates	boolean	Указывает, включены ли обновления платформы VMAgent для виртуальной машины Windows.
patchSettings	PatchSettings	[Предварительная версия компонента] Указывает параметры, связанные с исправлением гостевой виртуальной машины в Windows.
provisionVMAgent	boolean	Указывает, следует ли подготовить агент виртуальной машины на виртуальной машине. Если это свойство не указано в тексте запроса, оно по умолчанию имеет значение true. Это гарантирует, что агент виртуальной машины установлен на виртуальной машине, чтобы расширения можно было добавить в виртуальную машину позже.
timeZone	string	Указывает часовой пояс виртуальной машины. Например, "Тихоокеанское стандартное время". Возможные значения можно TimeZoneInfo.Id из часовых поясов, возвращаемых TimeZoneInfo.GetSystemTimeZones.
winRM	WinRMConfiguration	Задает прослушиватели удаленного управления Windows. Это позволяет удаленно использовать Windows PowerShell.

WindowsPatchAssessmentMode

Указывает режим оценки исправлений гостевой виртуальной машины для виртуальной машины IaaS.

Возможные значения:

ImageDefault. Вы управляете временем оценки исправлений на виртуальной машине.

AutomaticByPlatform . Платформа будет запускать периодические оценки исправлений. Свойство provisionVMAgent должно быть true.

Имя	Тип	Описание
AutomaticByPlatform	string
ImageDefault	string

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform.

Имя	Тип	Описание
Always	string
IfRequired	string
Never	string
Unknown	string

WindowsVMGuestPatchAutomaticByPlatformSettings

Указывает дополнительные параметры, применяемые при выборе режима исправления AutomaticByPlatform в параметрах исправлений Windows.

Имя	Тип	Описание
bypassPlatformSafetyChecksOnUserSchedule	boolean	Позволяет клиенту планировать исправление без случайного обновления
rebootSetting	WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform.

WindowsVMGuestPatchMode

Указывает режим гостевой исправления виртуальной машины на виртуальную машину IaaS или виртуальные машины, связанные с масштабируемым набором виртуальных машин с OrchestrationMode как гибкий.

Возможные значения:

вручную . Вы управляете применением исправлений к виртуальной машине. Это можно сделать, применяя исправления вручную внутри виртуальной машины. В этом режиме автоматические обновления отключены; Свойство WindowsConfiguration.enableAutomaticUpdates должно быть false

automaticByOS. Виртуальная машина автоматически обновляется ОС. Свойство WindowsConfiguration.enableAutomaticUpdates должно иметь значение true.

AutomaticByPlatform — виртуальная машина автоматически обновляется платформой. Свойства provisionVMAgent и WindowsConfiguration.enableAutomaticUpdates должны иметь значение true.

Имя	Тип	Описание
AutomaticByOS	string
AutomaticByPlatform	string
Manual	string

WinRMConfiguration

Описание конфигурации удаленного управления Windows виртуальной машины

Имя	Тип	Описание
listeners	WinRMListener[]	Список прослушивателей удаленного управления Windows

WinRMListener

Описание протокола и отпечатка прослушивателя удаленного управления Windows

Имя	Тип	Описание
certificateUrl	string	Это URL-адрес сертификата, который был отправлен в Key Vault в качестве секрета. Сведения о добавлении секрета в Key Vault см. в статье Добавление ключа или секрета в хранилище ключей. В этом случае сертификат должен быть кодировкой Base64 следующего объекта JSON, который кодируется в UTF-8: { "data":", "dataType":"pfx", "password":"" } Чтобы установить сертификаты на виртуальной машине, рекомендуется использовать расширение виртуальной машины Azure Key Vault для Linux или расширение виртуальной машины Azure Key Vault для Windows.
protocol	ProtocolTypes	Задает протокол прослушивателя WinRM. Возможные значения: http,https.