Restore Point Collections - Get

Tjänst:: Compute

API-version:: 2025-04-01

Åtgärden för att hämta samlingen med återställningspunkter.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
restorePointCollectionName	path	True	string	Namnet på samlingen med återställningspunkter.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.
$expand	query		RestorePointCollectionExpandOptions	Det expanderingsuttryck som ska tillämpas på åtgärden. Om expand=restorePoints kommer servern att returnera alla återställningspunkter i restorePointCollection.

Svar

Name	Typ	Description
200 OK	RestorePointCollection	Azure-åtgärden har slutförts.
Other Status Codes	CloudError	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Get a restore point collection, including the restore points contained in the restore point collection

Get a restore point collection (but not the restore points contained in the restore point collection)

Get a restore point collection, including the restore points contained in the restore point collection

Exempelbegäran

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


/**
 * Samples for RestorePointCollections GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/
     * restorePointExamples/RestorePointCollection_Get_WithContainedRestorePoints.json
     */
    /**
     * Sample code: Get a restore point collection, including the restore points contained in the restore point
     * collection.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getARestorePointCollectionIncludingTheRestorePointsContainedInTheRestorePointCollection(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getRestorePointCollections()
            .getByResourceGroupWithResponse("myResourceGroup", "rpcName", 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_collection_get_with_contained_restore_points.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_point_collections.get(
        resource_group_name="myResourceGroup",
        restore_point_collection_name="rpcName",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/restorePointExamples/RestorePointCollection_Get_WithContainedRestorePoints.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/fb90eb1bec64c6e8ad3e288a64c84cc18742a394/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/restorePointExamples/RestorePointCollection_Get_WithContainedRestorePoints.json
func ExampleRestorePointCollectionsClient_Get_getARestorePointCollectionIncludingTheRestorePointsContainedInTheRestorePointCollection() {
	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.NewRestorePointCollectionsClient().Get(ctx, "myResourceGroup", "rpcName", &armcompute.RestorePointCollectionsClientGetOptions{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.RestorePointCollection = armcompute.RestorePointCollection{
	// 	Name: to.Ptr("rpcName"),
	// 	Type: to.Ptr("Microsoft.Compute/restorePointCollections"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"myTag1": to.Ptr("tagValue1"),
	// 	},
	// 	Properties: &armcompute.RestorePointCollectionProperties{
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		RestorePointCollectionID: to.Ptr("59f04a5d-f783-4200-a1bd-d3f464e8c4b4"),
	// 		RestorePoints: []*armcompute.RestorePoint{
	// 			{
	// 				Name: to.Ptr("restorePointName"),
	// 				ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName"),
	// 				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/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5"),
	// 									},
	// 									Lun: to.Ptr[int32](1),
	// 									ManagedDisk: &armcompute.ManagedDiskParameters{
	// 										ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/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/restorePointName/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}()),
	// 				},
	// 		}},
	// 		Source: &armcompute.RestorePointCollectionSourceProperties{
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"),
	// 			Location: to.Ptr("eastus"),
	// 		},
	// 	},
	// }
}

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

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/restorePointExamples/RestorePointCollection_Get_WithContainedRestorePoints.json
// this example is just showing the usage of "RestorePointCollections_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://free.blessedness.top/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);

// invoke the operation
RestorePointGroupResource result = await restorePointGroup.GetAsync();

// 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
RestorePointGroupData 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

Exempelsvar

Statuskod:: 200

{
  "name": "rpcName",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName",
  "type": "Microsoft.Compute/restorePointCollections",
  "location": "westus",
  "tags": {
    "myTag1": "tagValue1"
  },
  "properties": {
    "source": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
      "location": "eastus"
    },
    "instantAccess": true,
    "restorePointCollectionId": "59f04a5d-f783-4200-a1bd-d3f464e8c4b4",
    "provisioningState": "Succeeded",
    "restorePoints": [
      {
        "name": "restorePointName",
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName",
        "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/restorePointName/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/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_DataDisk_1"
                  },
                  "diskRestorePoint": {
                    "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/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 a restore point collection (but not the restore points contained in the restore point collection)

Exempelbegäran

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


/**
 * Samples for RestorePointCollections GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/
     * restorePointExamples/RestorePointCollection_Get.json
     */
    /**
     * Sample code: Get a restore point collection (but not the restore points contained in the restore point
     * collection).
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getARestorePointCollectionButNotTheRestorePointsContainedInTheRestorePointCollection(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getRestorePointCollections()
            .getByResourceGroupWithResponse("myResourceGroup", "myRpc", 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_collection_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_point_collections.get(
        resource_group_name="myResourceGroup",
        restore_point_collection_name="myRpc",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/restorePointExamples/RestorePointCollection_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/fb90eb1bec64c6e8ad3e288a64c84cc18742a394/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/restorePointExamples/RestorePointCollection_Get.json
func ExampleRestorePointCollectionsClient_Get_getARestorePointCollectionButNotTheRestorePointsContainedInTheRestorePointCollection() {
	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.NewRestorePointCollectionsClient().Get(ctx, "myResourceGroup", "myRpc", &armcompute.RestorePointCollectionsClientGetOptions{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.RestorePointCollection = armcompute.RestorePointCollection{
	// 	Name: to.Ptr("myRpc"),
	// 	Type: to.Ptr("Microsoft.Compute/restorePointCollections"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"myTag1": to.Ptr("tagValue1"),
	// 	},
	// 	Properties: &armcompute.RestorePointCollectionProperties{
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		RestorePointCollectionID: to.Ptr("59f04a5d-f783-4200-a1bd-d3f464e8c4b4"),
	// 		Source: &armcompute.RestorePointCollectionSourceProperties{
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc"),
	// 			Location: to.Ptr("eastus"),
	// 		},
	// 	},
	// }
}

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 collection.
 *
 * @summary The operation to get the restore point collection.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/restorePointExamples/RestorePointCollection_Get.json
 */
async function getARestorePointCollectionButNotTheRestorePointsContainedInTheRestorePointCollection() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const restorePointCollectionName = "myRpc";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.restorePointCollections.get(
    resourceGroupName,
    restorePointCollectionName,
  );
  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.Compute.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/restorePointExamples/RestorePointCollection_Get.json
// this example is just showing the usage of "RestorePointCollections_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://free.blessedness.top/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 = "myRpc";
ResourceIdentifier restorePointGroupResourceId = RestorePointGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, restorePointGroupName);
RestorePointGroupResource restorePointGroup = client.GetRestorePointGroupResource(restorePointGroupResourceId);

// invoke the operation
RestorePointGroupResource result = await restorePointGroup.GetAsync();

// 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
RestorePointGroupData 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

Exempelsvar

Statuskod:: 200

{
  "name": "myRpc",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc",
  "type": "Microsoft.Compute/restorePointCollections",
  "location": "westus",
  "tags": {
    "myTag1": "tagValue1"
  },
  "properties": {
    "source": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
      "location": "eastus"
    },
    "instantAccess": true,
    "restorePointCollectionId": "59f04a5d-f783-4200-a1bd-d3f464e8c4b4",
    "provisioningState": "Succeeded"
  }
}

Definitioner

Name	Description
AdditionalUnattendContent	Anger ytterligare XML-formaterad information som kan ingå i filen Unattend.xml, som används av Windows-installationsprogrammet. Innehållet definieras genom inställningsnamn, komponentnamn och passet där innehållet tillämpas.
ApiEntityReference	API-entitetsreferensen.
ApiError	API-fel.
ApiErrorBase	bas för API-fel.
BootDiagnostics	Startdiagnostik är en felsökningsfunktion som gör att du kan visa konsolutdata och skärmbild för att diagnostisera VM-status. Du kan enkelt visa utdata från konsolloggen. Med Azure kan du också se en skärmbild av den virtuella datorn från hypervisor-programmet.
CachingTypes	Anger cachelagringskraven. Möjliga värden är: None,ReadOnly,ReadWrite. Standardvärdena är: Ingen för Standard Storage. ReadOnly för Premium-lagring
CloudError	Ett felsvar från beräkningstjänsten.
ComponentNames
ConsistencyModeTypes	ConsistencyMode för RestorePoint. Kan anges i indata när du skapar en återställningspunkt. För tillfället godkänns endast CrashConsistent som en giltig indata. Mer information finns i https://aka.ms/RestorePoints.
createdByType	Den typ av identitet som skapade resursen.
DiagnosticsProfile	Anger status för startdiagnostikinställningar. Lägsta API-version: 2015-06-15.
DiskControllerTypes	Anger vilken typ av diskkontrollant som konfigurerats för den virtuella datorn och VirtualMachineScaleSet. Den här egenskapen stöds endast för virtuella datorer vars operativsystemdisk och VM-SKU stöder generation 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), kontrollera funktionen HyperVGenerations som returneras som en del av vm-sku-funktionerna i svaret från Microsoft.Compute SKU:er api för regionen innehåller V2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list). Mer information om diskkontrollanttyper som stöds finns i https://aka.ms/azure-diskcontrollertypes.
DiskEncryptionSetParameters	Beskriver parametern för resurs-ID för kundhanterad diskkrypteringsuppsättning som kan anges för disk. Obs! Diskkrypteringsuppsättningens resurs-ID kan bara anges för hanterad disk. Mer information finns i https://aka.ms/mdssewithcmkoverview.
DiskEncryptionSettings	Beskriver en krypteringsinställning för en disk
DiskRestorePointAttributes	Information om diskåterställningspunkt.
DiskRestorePointInstanceView	Instansvyn för en diskåterställningspunkt.
DiskRestorePointReplicationStatus	Instansvyn för en diskåterställningspunkt.
EncryptionIdentity	Anger den hanterade identitet som används av ADE för att hämta åtkomsttoken för keyvault-åtgärder.
HardwareProfile	Anger maskinvaruinställningarna för den virtuella datorn.
HostEndpointSettings	Anger specifika inställningar för värdslutpunkten.
HyperVGenerationTypes	Anger typen av HyperVGeneration
InnerError	Inre felinformation.
InstanceViewStatus	Status för instansvy.
KeyVaultKeyReference	Beskriver en referens till 密钥保管库 nyckel
KeyVaultSecretReference	Beskriver en referens till Key Vault Secret
LinuxConfiguration	Anger inställningarna för Linux-operativsystemet på den virtuella datorn. En lista över Linux-distributioner som stöds finns i Linux på Azure-Endorsed Distributioner.
LinuxPatchAssessmentMode	Anger läget för utvärdering av vm-gästkorrigering för den virtuella IaaS-datorn. Möjliga värden är: ImageDefault – Du styr tidpunkten för korrigeringsutvärderingar på en virtuell dator. AutomaticByPlatform – Plattformen utlöser periodiska korrigeringsutvärderingar. Egenskapen provisionVMAgent måste vara sann.
LinuxPatchSettings	Anger inställningar som rör vm-gästkorrigering i Linux.
LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Anger omstartsinställningen för alla installationsåtgärder för AutomaticByPlatform-korrigering.
LinuxVMGuestPatchAutomaticByPlatformSettings	Anger ytterligare inställningar som ska tillämpas när korrigeringsläget AutomaticByPlatform har valts i inställningarna för Linux-korrigering.
LinuxVMGuestPatchMode	Anger läget för vm-gästkorrigering till virtuell IaaS-dator eller virtuella datorer som är associerade med VM-skalningsuppsättning med OrchestrationMode som flexibel. Möjliga värden är: ImageDefault – Den virtuella datorns standardkonfiguration för korrigering används. AutomaticByPlatform – Den virtuella datorn uppdateras automatiskt av plattformen. Egenskapen provisionVMAgent måste vara sann
ManagedDiskParameters	Parametrarna för en hanterad disk.
Mode	Anger det läge som ProxyAgent ska köras på om funktionen är aktiverad. ProxyAgent börjar granska eller övervaka men framtvingar inte åtkomstkontroll över begäranden till värdslutpunkter i granskningsläge, medan åtkomstkontrollen tillämpas i läget Framtvinga. Standardvärdet är Framtvinga läge.
Modes	Anger körningsläget. I granskningsläge fungerar systemet som om det tillämpar åtkomstkontrollprincipen, inklusive att generera åtkomstnekande poster i loggarna, men det nekar faktiskt inte några begäranden om värdslutpunkter. I framtvinga läge framtvingar systemet åtkomstkontrollen och det är det rekommenderade driftsläget.
OperatingSystemType	Hämtar typen av operativsystem.
OSProfile	Anger inställningarna för operativsystemet för den virtuella datorn. Vissa av inställningarna kan inte ändras när den virtuella datorn har etablerats.
PassNames
PatchSettings	Anger inställningar som rör vm-gästkorrigering i Windows.
ProtocolTypes	Anger protokollet för WinRM-lyssnaren. Möjliga värden är: http,https.
ProxyAgentSettings	Anger ProxyAgent-inställningar för den virtuella datorn eller VM-skalningsuppsättningen. Lägsta API-version: 2023-09-01.
RestorePoint	Information om återställningspunkt.
RestorePointCollection	Skapa eller uppdatera samlingsparametrar för återställningspunkter.
RestorePointCollectionExpandOptions
RestorePointCollectionSourceProperties	Egenskaperna för källresursen som den här återställningspunktssamlingen skapas från.
RestorePointEncryption	Kryptering i viloläge för diskåterställningspunkt. Det är en valfri egenskap som kan anges i indata när du skapar en återställningspunkt.
RestorePointEncryptionType	Den typ av nyckel som används för att kryptera data för diskåterställningspunkten.
RestorePointInstanceView	Instansvyn för en återställningspunkt.
RestorePointSourceMetadata	Beskriver egenskaperna för den virtuella dator som återställningspunkten skapades för. De angivna egenskaperna är en delmängd och ögonblicksbilden av de övergripande egenskaperna för den virtuella datorn som avbildades när återställningspunkten skapades.
RestorePointSourceVMDataDisk	Beskriver en datadisk.
RestorePointSourceVMOSDisk	Beskriver en operativsystemdisk.
RestorePointSourceVMStorageProfile	Beskriver lagringsprofilen.
SecurityEncryptionTypes	Anger EncryptionType för den hanterade disken. Den är inställd på DiskWithVMGuestState för kryptering av den hanterade disken tillsammans med VMGuestState-blob, VMGuestStateOnly för kryptering av bara VMGuestState-bloben och NonPersistedTPM för att inte bevara tillståndet för inbyggd programvara i VMGuestState-bloben. Obs! Det kan endast anges för konfidentiella virtuella datorer.
SecurityProfile	Anger säkerhetsprofilinställningarna för den virtuella datorn eller vm-skalningsuppsättningen.
SecurityTypes	Anger SecurityType för den virtuella datorn. Det måste anges till ett angivet värde för att aktivera UefiSettings. Standardbeteendet är: UefiSettings aktiveras inte om inte den här egenskapen har angetts.
SettingNames	Anger namnet på den inställning som innehållet gäller för. Möjliga värden är: FirstLogonCommands och AutoLogon.
SnapshotAccessState	Tillståndet för ögonblicksbilden som avgör åtkomsttillgängligheten för ögonblicksbilden.
SshConfiguration	SSH-konfiguration för Linux-baserade virtuella datorer som körs på Azure
SshPublicKey	Innehåller information om offentlig SSH-certifikatnyckel och sökvägen på den virtuella Linux-dator där den offentliga nyckeln placeras.
StatusLevelTypes	Nivåkoden.
StorageAccountTypes	Anger lagringskontotypen för den hanterade disken. Kontotypen hanterad os-disklagring kan bara anges när du skapar skalningsuppsättningen. OBS: UltraSSD_LRS kan endast användas med datadiskar. Den kan inte användas med OS Disk. Standard_LRS använder standardhårddisk. StandardSSD_LRS använder Standard SSD. Premium_LRS använder Premium SSD. UltraSSD_LRS använder Ultra Disk. Premium_ZRS använder Premium SSD-zonredundant lagring. StandardSSD_ZRS använder zonredundant lagring av standard-SSD. Mer information om diskar som stöds för Windows Virtual Machines finns i https://docs.microsoft.com/azure/virtual-machines/windows/disks-types och, för Linux Virtual Machines, se https://docs.microsoft.com/azure/virtual-machines/linux/disks-types
SubResource
systemData	Metadata som rör skapande och senaste ändring av resursen.
UefiSettings	Anger de säkerhetsinställningar som säker start och vTPM som används när den virtuella datorn skapas. Lägsta API-version: 2020-12-01.
VaultCertificate	Beskriver en enda certifikatreferens i ett Key Vault och var certifikatet ska finnas på den virtuella datorn.
VaultSecretGroup	Beskriver en uppsättning certifikat som alla finns i samma Key Vault.
VirtualMachineSizeTypes	Anger storleken på den virtuella datorn. Uppräkningsdatatypen är för närvarande inaktuell och tas bort senast den 23 december 2023. Det rekommenderade sättet att hämta listan över tillgängliga storlekar är att använda dessa API:er: Lista alla tillgängliga storlekar för virtuella datorer i en tillgänglighetsuppsättning, Lista alla tillgängliga storlekar för virtuella datorer i en region, Lista alla tillgängliga storlekar för virtuella datorer för storleksändring. Mer information om storlekar på virtuella datorer finns i Storlekar för virtuella datorer. De tillgängliga VM-storlekarna beror på region och tillgänglighetsuppsättning.
VMDiskSecurityProfile	Anger säkerhetsprofilinställningarna för den hanterade disken. Obs! Det kan bara anges för konfidentiella virtuella datorer.
VMSizeProperties	Anger egenskapsinställningar för VM-storlek på den virtuella datorn.
WindowsConfiguration	Anger inställningarna för Windows-operativsystemet på den virtuella datorn.
WindowsPatchAssessmentMode	Anger läget för utvärdering av vm-gästkorrigering för den virtuella IaaS-datorn. Möjliga värden är: ImageDefault – Du styr tidpunkten för korrigeringsutvärderingar på en virtuell dator. AutomaticByPlatform – Plattformen utlöser periodiska korrigeringsutvärderingar. Egenskapen provisionVMAgent måste vara sann.
WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Anger omstartsinställningen för alla installationsåtgärder för AutomaticByPlatform-korrigering.
WindowsVMGuestPatchAutomaticByPlatformSettings	Anger ytterligare inställningar som ska tillämpas när korrigeringsläget AutomaticByPlatform har valts i Windows-korrigeringsinställningar.
WindowsVMGuestPatchMode	Anger läget för vm-gästkorrigering till virtuell IaaS-dator eller virtuella datorer som är associerade med VM-skalningsuppsättning med OrchestrationMode som flexibel. Möjliga värden är: Manuell – Du styr tillämpningen av korrigeringar på en virtuell dator. Det gör du genom att tillämpa korrigeringar manuellt i den virtuella datorn. I det här läget inaktiveras automatiska uppdateringar. egenskapen WindowsConfiguration.enableAutomaticUpdates måste vara false AutomaticByOS – Den virtuella datorn uppdateras automatiskt av operativsystemet. Egenskapen WindowsConfiguration.enableAutomaticUpdates måste vara sann. AutomaticByPlatform – uppdateras den virtuella datorn automatiskt av plattformen. Egenskaperna provisionVMAgent och WindowsConfiguration.enableAutomaticUpdates måste vara sanna
WinRMConfiguration	Beskriver konfigurationen av Windows Remote Management för den virtuella datorn
WinRMListener	Beskriver protokoll och tumavtryck för Windows Remote Management-lyssnare

AdditionalUnattendContent

Objekt

Anger ytterligare XML-formaterad information som kan ingå i filen Unattend.xml, som används av Windows-installationsprogrammet. Innehållet definieras genom inställningsnamn, komponentnamn och passet där innehållet tillämpas.

Name	Typ	Description
componentName	ComponentNames	Komponentnamnet. För närvarande är det enda tillåtna värdet Microsoft-Windows-Shell-Setup.
content	string	Anger det XML-formaterade innehåll som läggs till i unattend.xml-filen för den angivna sökvägen och komponenten. XML-koden måste vara mindre än 4 KB och måste innehålla rotelementet för den inställning eller funktion som infogas.
passName	PassNames	Passnamnet. För närvarande är det enda tillåtna värdet OobeSystem.
settingName	SettingNames	Anger namnet på den inställning som innehållet gäller för. Möjliga värden är: FirstLogonCommands och AutoLogon.

ApiEntityReference

Objekt

API-entitetsreferensen.

Name	Typ	Description
id	string	ARM-resurs-ID i form av /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Objekt

API-fel.

Name	Typ	Description
code	string	Felkoden.
details	ApiErrorBase[]	Information om API-fel
innererror	InnerError	Det inre API-felet
message	string	Felmeddelandet.
target	string	Målet för det specifika felet.

ApiErrorBase

Objekt

bas för API-fel.

Name	Typ	Description
code	string	Felkoden.
message	string	Felmeddelandet.
target	string	Målet för det specifika felet.

BootDiagnostics

Objekt

Startdiagnostik är en felsökningsfunktion som gör att du kan visa konsolutdata och skärmbild för att diagnostisera VM-status. Du kan enkelt visa utdata från konsolloggen. Med Azure kan du också se en skärmbild av den virtuella datorn från hypervisor-programmet.

Name	Typ	Description
enabled	boolean	Om startdiagnostik ska aktiveras på den virtuella datorn.
storageUri	string	Uri för lagringskontot som ska användas för att placera konsolens utdata och skärmbild. Om storageUri inte anges när startdiagnostik aktiveras används hanterad lagring.

CachingTypes

Uppräkning

Anger cachelagringskraven. Möjliga värden är: None,ReadOnly,ReadWrite. Standardvärdena är: Ingen för Standard Storage. ReadOnly för Premium-lagring

Värde	Description
None
ReadOnly
ReadWrite

CloudError

Objekt

Ett felsvar från beräkningstjänsten.

Name	Typ	Description
error	ApiError	API-fel.

ComponentNames

Uppräkning

Värde	Description
Microsoft-Windows-Shell-Setup

ConsistencyModeTypes

Uppräkning

ConsistencyMode för RestorePoint. Kan anges i indata när du skapar en återställningspunkt. För tillfället godkänns endast CrashConsistent som en giltig indata. Mer information finns i https://aka.ms/RestorePoints.

Värde	Description
CrashConsistent
FileSystemConsistent
ApplicationConsistent

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

DiagnosticsProfile

Objekt

Anger status för startdiagnostikinställningar. Lägsta API-version: 2015-06-15.

Name	Typ	Description
bootDiagnostics	BootDiagnostics	Startdiagnostik är en felsökningsfunktion som gör att du kan visa konsolutdata och skärmbild för att diagnostisera VM-status. NOTE: Om storageUri anges kontrollerar du att lagringskontot finns i samma region och prenumeration som den virtuella datorn. Du kan enkelt visa utdata från konsolloggen. Med Azure kan du också se en skärmbild av den virtuella datorn från hypervisor-programmet.

DiskControllerTypes

Uppräkning

Anger vilken typ av diskkontrollant som konfigurerats för den virtuella datorn och VirtualMachineScaleSet. Den här egenskapen stöds endast för virtuella datorer vars operativsystemdisk och VM-SKU stöder generation 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), kontrollera funktionen HyperVGenerations som returneras som en del av vm-sku-funktionerna i svaret från Microsoft.Compute SKU:er api för regionen innehåller V2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list). Mer information om diskkontrollanttyper som stöds finns i https://aka.ms/azure-diskcontrollertypes.

Värde	Description
SCSI
NVMe

DiskEncryptionSetParameters

Objekt

Beskriver parametern för resurs-ID för kundhanterad diskkrypteringsuppsättning som kan anges för disk. Obs! Diskkrypteringsuppsättningens resurs-ID kan bara anges för hanterad disk. Mer information finns i https://aka.ms/mdssewithcmkoverview.

Name	Typ	Description
id	string	Resurs-ID

DiskEncryptionSettings

Objekt

Beskriver en krypteringsinställning för en disk

Name	Typ	Description
diskEncryptionKey	KeyVaultSecretReference	Anger platsen för diskkrypteringsnyckeln, som är en Nyckelvalvshemlighet.
enabled	boolean	Anger om diskkryptering ska aktiveras på den virtuella datorn.
keyEncryptionKey	KeyVaultKeyReference	Anger platsen för nyckelkrypteringsnyckeln i Key Vault.

DiskRestorePointAttributes

Objekt

Information om diskåterställningspunkt.

Name	Typ	Description
encryption	RestorePointEncryption	Kryptering i viloläge för diskåterställningspunkt. Det är en valfri egenskap som kan anges i indata när du skapar en återställningspunkt.
id	string	Resurs-ID
sourceDiskRestorePoint	ApiEntityReference	Resurs-ID för källdiskens återställningspunkt.

DiskRestorePointInstanceView

Objekt

Instansvyn för en diskåterställningspunkt.

Name	Typ	Description
id	string	ID för diskåterställningspunkt.
replicationStatus	DiskRestorePointReplicationStatus	Information om replikeringsstatus för diskåterställningspunkten.
snapshotAccessState	SnapshotAccessState	Tillståndet för ögonblicksbilden som avgör åtkomsttillgängligheten för ögonblicksbilden.

DiskRestorePointReplicationStatus

Objekt

Instansvyn för en diskåterställningspunkt.

Name	Typ	Description
completionPercent	integer (int32)	Slutförandeprocent för replikering.
status	InstanceViewStatus	Information om resursstatus.

EncryptionIdentity

Objekt

Anger den hanterade identitet som används av ADE för att hämta åtkomsttoken för keyvault-åtgärder.

Name	Typ	Description
userAssignedIdentityResourceId	string	Anger ARM-resurs-ID för en av de användaridentiteter som är associerade med den virtuella datorn.

HardwareProfile

Objekt

Anger maskinvaruinställningarna för den virtuella datorn.

Name	Typ	Description
vmSize	VirtualMachineSizeTypes	Anger storleken på den virtuella datorn. Uppräkningsdatatypen är för närvarande inaktuell och tas bort senast den 23 december 2023. Det rekommenderade sättet att hämta listan över tillgängliga storlekar är att använda dessa API:er: Lista alla tillgängliga storlekar för virtuella datorer i en tillgänglighetsuppsättning, Lista alla tillgängliga storlekar för virtuella datorer i en region, Lista alla tillgängliga storlekar för virtuella datorer för storleksändring. Mer information om storlekar på virtuella datorer finns i Storlekar för virtuella datorer. De tillgängliga VM-storlekarna beror på region och tillgänglighetsuppsättning.
vmSizeProperties	VMSizeProperties	Anger egenskaperna för att anpassa storleken på den virtuella datorn. Lägsta API-version: 2021-07-01. Den här funktionen är fortfarande i förhandsgranskningsläge och stöds inte för VirtualMachineScaleSet. Följ anvisningarna i VM-anpassning för mer information.

HostEndpointSettings

Objekt

Anger specifika inställningar för värdslutpunkten.

Name	Typ	Description
inVMAccessControlProfileReferenceId	string	Anger resurs-ID:t InVMAccessControlProfileVersion i formatet /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}
mode	Modes	Anger körningsläget. I granskningsläge fungerar systemet som om det tillämpar åtkomstkontrollprincipen, inklusive att generera åtkomstnekande poster i loggarna, men det nekar faktiskt inte några begäranden om värdslutpunkter. I framtvinga läge framtvingar systemet åtkomstkontrollen och det är det rekommenderade driftsläget.

HyperVGenerationTypes

Uppräkning

Anger typen av HyperVGeneration

Värde	Description
V1
V2

InnerError

Objekt

Inre felinformation.

Name	Typ	Description
errordetail	string	Det interna felmeddelandet eller undantagsdumpen.
exceptiontype	string	Typen av undantag.

InstanceViewStatus

Objekt

Status för instansvy.

Name	Typ	Description
code	string	Statuskoden.
displayStatus	string	Den korta localizable-etiketten för statusen.
level	StatusLevelTypes	Nivåkoden.
message	string	Det detaljerade statusmeddelandet, inklusive för aviseringar och felmeddelanden.
time	string (date-time)	Tidpunkten för statusen.

KeyVaultKeyReference

Objekt

Beskriver en referens till 密钥保管库 nyckel

Name	Typ	Description
keyUrl	string	URL:en som refererar till en nyckelkrypteringsnyckel i Key Vault.
sourceVault	SubResource	Den relativa URL:en för nyckelvalvet som innehåller nyckeln.

KeyVaultSecretReference

Objekt

Beskriver en referens till Key Vault Secret

Name	Typ	Description
secretUrl	string	URL:en som refererar till en hemlighet i ett Nyckelvalv.
sourceVault	SubResource	Den relativa URL:en för nyckelvalvet som innehåller hemligheten.

LinuxConfiguration

Objekt

Anger inställningarna för Linux-operativsystemet på den virtuella datorn. En lista över Linux-distributioner som stöds finns i Linux på Azure-Endorsed Distributioner.

Name	Typ	Description
disablePasswordAuthentication	boolean	Anger om lösenordsautentisering ska inaktiveras.
enableVMAgentPlatformUpdates	boolean	Anger om VMAgent Platform Updates är aktiverat för den virtuella Linux-datorn. Standardvärdet är "falsk".
patchSettings	LinuxPatchSettings	[Förhandsversionsfunktion] Anger inställningar som rör vm-gästkorrigering i Linux.
provisionVMAgent	boolean	Anger om den virtuella datoragenten ska etableras på den virtuella datorn. När den här egenskapen inte anges i begärandetexten är standardbeteendet att ange den till true. Detta säkerställer att VM-agenten är installerad på den virtuella datorn så att tillägg kan läggas till i den virtuella datorn senare.
ssh	SshConfiguration	Anger ssh-nyckelkonfigurationen för ett Linux-operativsystem.

LinuxPatchAssessmentMode

Uppräkning

Anger läget för utvärdering av vm-gästkorrigering för den virtuella IaaS-datorn.

Möjliga värden är:

ImageDefault – Du styr tidpunkten för korrigeringsutvärderingar på en virtuell dator.

AutomaticByPlatform – Plattformen utlöser periodiska korrigeringsutvärderingar. Egenskapen provisionVMAgent måste vara sann.

Värde	Description
ImageDefault
AutomaticByPlatform

LinuxPatchSettings

Objekt

Anger inställningar som rör vm-gästkorrigering i Linux.

Name	Typ	Description
assessmentMode	LinuxPatchAssessmentMode	Anger läget för utvärdering av vm-gästkorrigering för den virtuella IaaS-datorn. Möjliga värden är: ImageDefault – Du styr tidpunkten för korrigeringsutvärderingar på en virtuell dator. AutomaticByPlatform – Plattformen utlöser periodiska korrigeringsutvärderingar. Egenskapen provisionVMAgent måste vara sann.
automaticByPlatformSettings	LinuxVMGuestPatchAutomaticByPlatformSettings	Anger ytterligare inställningar för korrigeringsläget AutomaticByPlatform i VM-gästkorrigering i Linux.
patchMode	LinuxVMGuestPatchMode	Anger läget för vm-gästkorrigering till virtuell IaaS-dator eller virtuella datorer som är associerade med VM-skalningsuppsättning med OrchestrationMode som flexibel. Möjliga värden är: ImageDefault – Den virtuella datorns standardkonfiguration för korrigering används. AutomaticByPlatform – Den virtuella datorn uppdateras automatiskt av plattformen. Egenskapen provisionVMAgent måste vara sann

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Uppräkning

Anger omstartsinställningen för alla installationsåtgärder för AutomaticByPlatform-korrigering.

Värde	Description
Unknown
IfRequired
Never
Always

LinuxVMGuestPatchAutomaticByPlatformSettings

Objekt

Anger ytterligare inställningar som ska tillämpas när korrigeringsläget AutomaticByPlatform har valts i inställningarna för Linux-korrigering.

Name	Typ	Description
bypassPlatformSafetyChecksOnUserSchedule	boolean	Gör det möjligt för kunden att schemalägga korrigeringar utan oavsiktliga uppgraderingar
rebootSetting	LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Anger omstartsinställningen för alla installationsåtgärder för AutomaticByPlatform-korrigering.

LinuxVMGuestPatchMode

Uppräkning

Anger läget för vm-gästkorrigering till virtuell IaaS-dator eller virtuella datorer som är associerade med VM-skalningsuppsättning med OrchestrationMode som flexibel.

Möjliga värden är:

ImageDefault – Den virtuella datorns standardkonfiguration för korrigering används.

AutomaticByPlatform – Den virtuella datorn uppdateras automatiskt av plattformen. Egenskapen provisionVMAgent måste vara sann

Värde	Description
ImageDefault
AutomaticByPlatform

ManagedDiskParameters

Objekt

Parametrarna för en hanterad disk.

Name	Typ	Description
diskEncryptionSet	DiskEncryptionSetParameters	Anger resurs-ID för kundhanterad diskkrypteringsuppsättning för den hanterade disken.
id	string	Resurs-ID
securityProfile	VMDiskSecurityProfile	Anger säkerhetsprofilen för den hanterade disken.
storageAccountType	StorageAccountTypes	Anger lagringskontotypen för den hanterade disken. Obs! UltraSSD_LRS endast kan användas med datadiskar kan den inte användas med OS-disk.

Mode

Uppräkning

Anger det läge som ProxyAgent ska köras på om funktionen är aktiverad. ProxyAgent börjar granska eller övervaka men framtvingar inte åtkomstkontroll över begäranden till värdslutpunkter i granskningsläge, medan åtkomstkontrollen tillämpas i läget Framtvinga. Standardvärdet är Framtvinga läge.

Värde	Description
Audit
Enforce

Modes

Uppräkning

Anger körningsläget. I granskningsläge fungerar systemet som om det tillämpar åtkomstkontrollprincipen, inklusive att generera åtkomstnekande poster i loggarna, men det nekar faktiskt inte några begäranden om värdslutpunkter. I framtvinga läge framtvingar systemet åtkomstkontrollen och det är det rekommenderade driftsläget.

Värde	Description
Audit
Enforce
Disabled

OperatingSystemType

Uppräkning

Hämtar typen av operativsystem.

Värde	Description
Windows
Linux

OSProfile

Objekt

Anger inställningarna för operativsystemet för den virtuella datorn. Vissa av inställningarna kan inte ändras när den virtuella datorn har etablerats.

Name	Typ	Description
adminPassword	string (password)	Anger lösenordet för administratörskontot. Minsta längd (Windows): 8 tecken Minsta längd (Linux): 6 tecken Maximal längd (Windows): 123 tecken Maxlängd (Linux): 72 tecken Komplexitetskrav: 3 av 4 villkor nedan måste uppfyllas Har lägre tecken Har övre tecken Har en siffra Har ett specialtecken (Regex matchar [\W_]) Otillåtna värden: "abc@123", "P@$$w 0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" Information om hur du återställer lösenordet finns i Så här återställer du fjärrskrivbordstjänsten eller dess inloggningslösenord på en virtuell Windows-dator Information om hur du återställer rotlösenord finns i Hantera användare, SSH och kontrollera eller reparera diskar på virtuella Azure Linux-datorer med hjälp av VMAccess-tillägget
adminUsername	string	Anger namnet på administratörskontot. Det går inte att uppdatera den här egenskapen när den virtuella datorn har skapats. begränsning endast för Windows: Kan inte sluta med "". Otillåtna värden: "administratör", "administratör", "användare", "användare1", "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". Minsta längd (Linux): 1 tecken Maximal längd (Linux): 64 tecken Maxlängd (Windows): 20 tecken.
allowExtensionOperations	boolean	Anger om tilläggsåtgärder ska tillåtas på den virtuella datorn. Detta kan bara anges till False när inga tillägg finns på den virtuella datorn.
computerName	string	Anger värdoperativsystemets namn på den virtuella datorn. Det går inte att uppdatera det här namnet när den virtuella datorn har skapats. Maximal längd (Windows): 15 tecken. Maxlängd (Linux): 64 tecken. Namngivningskonventioner och begränsningar finns i riktlinjer för implementering av Azure-infrastrukturtjänster.
customData	string	Anger en base-64-kodad sträng med anpassade data. Den base-64-kodade strängen avkodas till en binär matris som sparas som en fil på den virtuella datorn. Den maximala längden på den binära matrisen är 65535 byte. Obs! Skicka inga hemligheter eller lösenord i customData-egenskapen. Det går inte att uppdatera den här egenskapen när den virtuella datorn har skapats. Egenskapen "customData" skickas till den virtuella datorn för att sparas som en fil. Mer information finns i Anpassade data på virtuella Azure-datorer. Information om hur du använder cloud-init för din virtuella Linux-dator finns i Använda cloud-init för att anpassa en virtuell Linux-dator under skapandet.
linuxConfiguration	LinuxConfiguration	Anger inställningarna för Linux-operativsystemet på den virtuella datorn. En lista över Linux-distributioner som stöds finns i Linux på Azure-Endorsed Distributioner.
requireGuestProvisionSignal	boolean	Valfri egenskap som antingen måste anges till True eller utelämnas.
secrets	VaultSecretGroup[]	Anger en uppsättning certifikat som ska installeras på den virtuella datorn. Om du vill installera certifikat på en virtuell dator rekommenderar vi att du använder tillägget virtuella Azure Key Vault-dator för Linux eller tillägget virtuella Azure Key Vault-dator för Windows.
windowsConfiguration	WindowsConfiguration	Anger inställningarna för Windows-operativsystemet på den virtuella datorn.

PassNames

Uppräkning

Värde	Description
OobeSystem

PatchSettings

Objekt

Anger inställningar som rör vm-gästkorrigering i Windows.

Name	Typ	Description
assessmentMode	WindowsPatchAssessmentMode	Anger läget för utvärdering av vm-gästkorrigering för den virtuella IaaS-datorn. Möjliga värden är: ImageDefault – Du styr tidpunkten för korrigeringsutvärderingar på en virtuell dator. AutomaticByPlatform – Plattformen utlöser periodiska korrigeringsutvärderingar. Egenskapen provisionVMAgent måste vara sann.
automaticByPlatformSettings	WindowsVMGuestPatchAutomaticByPlatformSettings	Anger ytterligare inställningar för korrigeringsläget AutomaticByPlatform i VM-gästkorrigering i Windows.
enableHotpatching	boolean	Gör det möjligt för kunder att korrigera sina virtuella Azure-datorer utan att behöva starta om. För enableHotpatching måste "provisionVMAgent" anges till true och "patchMode" måste anges till "AutomaticByPlatform".
patchMode	WindowsVMGuestPatchMode	Anger läget för vm-gästkorrigering till virtuell IaaS-dator eller virtuella datorer som är associerade med VM-skalningsuppsättning med OrchestrationMode som flexibel. Möjliga värden är: Manuell – Du styr tillämpningen av korrigeringar på en virtuell dator. Det gör du genom att tillämpa korrigeringar manuellt i den virtuella datorn. I det här läget inaktiveras automatiska uppdateringar. egenskapen WindowsConfiguration.enableAutomaticUpdates måste vara false AutomaticByOS – Den virtuella datorn uppdateras automatiskt av operativsystemet. Egenskapen WindowsConfiguration.enableAutomaticUpdates måste vara sann. AutomaticByPlatform – uppdateras den virtuella datorn automatiskt av plattformen. Egenskaperna provisionVMAgent och WindowsConfiguration.enableAutomaticUpdates måste vara sanna

ProtocolTypes

Uppräkning

Anger protokollet för WinRM-lyssnaren. Möjliga värden är: http,https.

Värde	Description
Http
Https

ProxyAgentSettings

Objekt

Anger ProxyAgent-inställningar för den virtuella datorn eller VM-skalningsuppsättningen. Lägsta API-version: 2023-09-01.

Name	Typ	Description
addProxyAgentExtension	boolean	Ange om du vill installera ProxyAgent-tillägget implicit. Det här alternativet gäller för närvarande endast för Linux OS.
enabled	boolean	Anger om ProxyAgent-funktionen ska vara aktiverad på den virtuella datorn eller vm-skalningsuppsättningen.
imds	HostEndpointSettings	Anger inställningarna för IMDS-slutpunkten när den virtuella datorn eller vm-skalningsuppsättningen skapas. Lägsta API-version: 2024-03-01.
keyIncarnationId	integer (int32)	Om du ökar värdet för den här egenskapen kan användarna återställa nyckeln som används för att skydda kommunikationskanalen mellan gäst och värd.
mode	Mode	Anger det läge som ProxyAgent ska köras på. Varning! Den här egenskapen har föråldrats. Ange läge under en viss inställning för värddelspunkt.
wireServer	HostEndpointSettings	Anger inställningarna för Wire Server-slutpunkten när du skapar den virtuella datorn eller vm-skalningsuppsättningen. Lägsta API-version: 2024-03-01.

RestorePoint

Objekt

Information om återställningspunkt.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties.consistencyMode	ConsistencyModeTypes	ConsistencyMode för RestorePoint. Kan anges i indata när du skapar en återställningspunkt. För tillfället godkänns endast CrashConsistent som en giltig indata. Mer information finns i https://aka.ms/RestorePoints.
properties.excludeDisks	ApiEntityReference[]	Lista över diskresurs-ID:t som kunden vill undanta från återställningspunkten. Om inga diskar anges inkluderas alla diskar.
properties.instanceView	RestorePointInstanceView	Instansvyn för återställningspunkten.
properties.instantAccessDurationMinutes	integer (int32)	Den här egenskapen avgör hur lång tid i minuter ögonblicksbilden behålls som omedelbar åtkomst för att återställa Premium SSD v2 eller Ultra Disk med snabb återställningsprestanda i den här återställningspunkten.
properties.provisioningState	string	Hämtar etableringstillståndet för återställningspunkten.
properties.sourceMetadata	RestorePointSourceMetadata	Hämtar information om den virtuella datorn som registrerades när återställningspunkten skapades.
properties.sourceRestorePoint	ApiEntityReference	Resurs-ID för källåterställningspunkten från vilken en kopia måste skapas.
properties.timeCreated	string (date-time)	Hämtar skapandetiden för återställningspunkten.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. T.ex. "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

RestorePointCollection

Objekt

Skapa eller uppdatera samlingsparametrar för återställningspunkter.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Den geo-plats där resursen finns
name	string	Namnet på resursen
properties.instantAccess	boolean	Den här egenskapen avgör om ögonblicksbild av omedelbar åtkomst är aktiverat för återställningspunkter som skapats under den här återställningspunktsamlingen för Premium SSD v2 eller Ultra Disk. Ögonblicksbild med omedelbar åtkomst för Premium SSD v2 eller Ultra-disk är omedelbart tillgänglig för att återställa disk med snabb återställningsprestanda.
properties.provisioningState	string	Etableringstillståndet för samlingen med återställningspunkter.
properties.restorePointCollectionId	string	Det unika ID:t för samlingen med återställningspunkter.
properties.restorePoints	RestorePoint[]	En lista som innehåller alla återställningspunkter som skapats under den här samlingen med återställningspunkter.
properties.source	RestorePointCollectionSourceProperties	Egenskaperna för källresursen som den här återställningspunktssamlingen skapas från.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
tags	object	Resursetiketter.
type	string	Resurstypen. T.ex. "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

RestorePointCollectionExpandOptions

Uppräkning

Värde	Description
restorePoints

RestorePointCollectionSourceProperties

Objekt

Egenskaperna för källresursen som den här återställningspunktssamlingen skapas från.

Name	Typ	Description
id	string	Resurs-ID för källresursen som används för att skapa den här återställningspunktssamlingen
location	string	Platsen för källresursen som används för att skapa den här samlingen med återställningspunkter.

RestorePointEncryption

Objekt

Kryptering i viloläge för diskåterställningspunkt. Det är en valfri egenskap som kan anges i indata när du skapar en återställningspunkt.

Name	Typ	Description
diskEncryptionSet	DiskEncryptionSetParameters	Beskriver parametern för resurs-ID för kundhanterad diskkrypteringsuppsättning som kan anges för disk. Obs! Diskkrypteringsuppsättningens resurs-ID kan bara anges för hanterad disk. Mer information finns i https://aka.ms/mdssewithcmkoverview.
type	RestorePointEncryptionType	Den typ av nyckel som används för att kryptera data för diskåterställningspunkten.

RestorePointEncryptionType

Uppräkning

Den typ av nyckel som används för att kryptera data för diskåterställningspunkten.

Värde	Description
EncryptionAtRestWithPlatformKey	Diskåterställningspunkten krypteras i vila med plattformshanterad nyckel.
EncryptionAtRestWithCustomerKey	Diskåterställningspunkten krypteras i vila med en kundhanterad nyckel som kan ändras och återkallas av en kund.
EncryptionAtRestWithPlatformAndCustomerKeys	Diskåterställningspunkten krypteras i vila med 2 lager av kryptering. En av nycklarna är kundhanterad och den andra nyckeln är plattformshanterad.

RestorePointInstanceView

Objekt

Instansvyn för en återställningspunkt.

Name	Typ	Description
diskRestorePoints	DiskRestorePointInstanceView[]	Informationen om diskåterställningspunkter.
statuses	InstanceViewStatus[]	Information om resursstatus.

RestorePointSourceMetadata

Objekt

Beskriver egenskaperna för den virtuella dator som återställningspunkten skapades för. De angivna egenskaperna är en delmängd och ögonblicksbilden av de övergripande egenskaperna för den virtuella datorn som avbildades när återställningspunkten skapades.

Name	Typ	Description
diagnosticsProfile	DiagnosticsProfile	Hämtar diagnostikprofilen.
hardwareProfile	HardwareProfile	Hämtar maskinvaruprofilen.
hyperVGeneration	HyperVGenerationTypes	HyperVGeneration av den virtuella källdatorn som återställningspunkten avbildas för.
licenseType	string	Hämtar licenstypen, som är för att ta med ditt eget licensscenario.
location	string	Platsen för den virtuella dator som återställningspunkten skapades från.
osProfile	OSProfile	Hämtar OS-profilen.
securityProfile	SecurityProfile	Hämtar säkerhetsprofilen.
storageProfile	RestorePointSourceVMStorageProfile	Hämtar lagringsprofilen.
userData	string	UserData som är associerade med den virtuella källdatorn som återställningspunkten avbildas för, vilket är ett base-64-kodat värde.
vmId	string	Hämtar det unika ID:t för den virtuella datorn.

RestorePointSourceVMDataDisk

Objekt

Beskriver en datadisk.

Name	Typ	Description
caching	CachingTypes	Hämtar cachelagringstypen.
diskRestorePoint	DiskRestorePointAttributes	Innehåller egenskaper för diskåterställningspunkt.
diskSizeGB	integer (int32)	Hämtar den ursprungliga diskstorleken i GB för tomma datadiskar och den nya önskade storleken för befintliga operativsystem och datadiskar.
lun	integer (int32)	Hämtar det logiska enhetsnumret.
managedDisk	ManagedDiskParameters	Innehåller information om hanterade diskar.
name	string	Hämtar disknamnet.
writeAcceleratorEnabled	boolean	Visar true om disken är skrivacceleratoraktiverad.

RestorePointSourceVMOSDisk

Objekt

Beskriver en operativsystemdisk.

Name	Typ	Description
caching	CachingTypes	Hämtar cachelagringstypen.
diskRestorePoint	DiskRestorePointAttributes	Innehåller egenskaper för diskåterställningspunkt.
diskSizeGB	integer (int32)	Hämtar diskstorleken i GB.
encryptionSettings	DiskEncryptionSettings	Hämtar inställningarna för diskkryptering.
managedDisk	ManagedDiskParameters	Hämtar information om hanterade diskar
name	string	Hämtar disknamnet.
osType	OperatingSystemType	Hämtar typen av operativsystem.
writeAcceleratorEnabled	boolean	Visar true om disken är skrivacceleratoraktiverad.

RestorePointSourceVMStorageProfile

Objekt

Beskriver lagringsprofilen.

Name	Typ	Description
dataDisks	RestorePointSourceVMDataDisk[]	Hämtar datadiskarna för den virtuella datorn som samlas in när återställningspunkten skapas.
diskControllerType	DiskControllerTypes	Hämtar diskkontrollanttypen för den virtuella dator som avbildades när återställningspunkten skapades.
osDisk	RestorePointSourceVMOSDisk	Hämtar os-disken för den virtuella datorn som samlas in när återställningspunkten skapas.

SecurityEncryptionTypes

Uppräkning

Anger EncryptionType för den hanterade disken. Den är inställd på DiskWithVMGuestState för kryptering av den hanterade disken tillsammans med VMGuestState-blob, VMGuestStateOnly för kryptering av bara VMGuestState-bloben och NonPersistedTPM för att inte bevara tillståndet för inbyggd programvara i VMGuestState-bloben. Obs! Det kan endast anges för konfidentiella virtuella datorer.

Värde	Description
VMGuestStateOnly
DiskWithVMGuestState
NonPersistedTPM

SecurityProfile

Objekt

Anger säkerhetsprofilinställningarna för den virtuella datorn eller vm-skalningsuppsättningen.

Name	Typ	Description
encryptionAtHost	boolean	Den här egenskapen kan användas av användaren i begäran för att aktivera eller inaktivera värdkryptering för den virtuella datorn eller vm-skalningsuppsättningen. Detta aktiverar krypteringen för alla diskar, inklusive resurs/temp-disk på själva värden. Standardbeteendet är: Krypteringen på värden inaktiveras om inte den här egenskapen är inställd på true för resursen.
encryptionIdentity	EncryptionIdentity	Anger den hanterade identitet som används av ADE för att hämta åtkomsttoken för keyvault-åtgärder.
proxyAgentSettings	ProxyAgentSettings	Anger ProxyAgent-inställningar när den virtuella datorn skapas. Lägsta API-version: 2023-09-01.
securityType	SecurityTypes	Anger SecurityType för den virtuella datorn. Det måste anges till ett angivet värde för att aktivera UefiSettings. Standardbeteendet är: UefiSettings aktiveras inte om inte den här egenskapen har angetts.
uefiSettings	UefiSettings	Anger de säkerhetsinställningar som säker start och vTPM som används när den virtuella datorn skapas. Lägsta API-version: 2020-12-01.

SecurityTypes

Uppräkning

Anger SecurityType för den virtuella datorn. Det måste anges till ett angivet värde för att aktivera UefiSettings. Standardbeteendet är: UefiSettings aktiveras inte om inte den här egenskapen har angetts.

Värde	Description
TrustedLaunch
ConfidentialVM

SettingNames

Uppräkning

Anger namnet på den inställning som innehållet gäller för. Möjliga värden är: FirstLogonCommands och AutoLogon.

Värde	Description
AutoLogon
FirstLogonCommands

SnapshotAccessState

Uppräkning

Tillståndet för ögonblicksbilden som avgör åtkomsttillgängligheten för ögonblicksbilden.

Värde	Description
Unknown	Standardvärde.
Pending	Ögonblicksbilden kan inte användas för att återställa, kopiera eller ladda ned till offline.
Available	Ögonblicksbilden kan användas för återställning, kopiering till en annan region och nedladdning till offline.
InstantAccess	Ögonblicksbilden kan användas för att återställa diskar med snabb prestanda, men kan inte kopieras eller laddas ned.
AvailableWithInstantAccess	Ögonblicksbilden kan användas för att återställa diskar med snabb prestanda, kopieras och laddas ner.

SshConfiguration

Objekt

SSH-konfiguration för Linux-baserade virtuella datorer som körs på Azure

Name	Typ	Description
publicKeys	SshPublicKey[]	Listan över offentliga SSH-nycklar som används för att autentisera med linux-baserade virtuella datorer.

SshPublicKey

Objekt

Innehåller information om offentlig SSH-certifikatnyckel och sökvägen på den virtuella Linux-dator där den offentliga nyckeln placeras.

Name	Typ	Description
keyData	string	Certifikat för offentlig SSH-nyckel som används för att autentisera med den virtuella datorn via ssh. Nyckeln måste vara minst 2048-bitars och i ssh-rsa-format. Information om hur du skapar ssh-nycklar finns i [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).
path	string	Anger den fullständiga sökvägen på den skapade virtuella datorn där den offentliga SSH-nyckeln lagras. Om filen redan finns läggs den angivna nyckeln till i filen. Exempel: /home/user/.ssh/authorized_keys

StatusLevelTypes

Uppräkning

Nivåkoden.

Värde	Description
Info
Warning
Error

StorageAccountTypes

Uppräkning

Anger lagringskontotypen för den hanterade disken. Kontotypen hanterad os-disklagring kan bara anges när du skapar skalningsuppsättningen. OBS: UltraSSD_LRS kan endast användas med datadiskar. Den kan inte användas med OS Disk. Standard_LRS använder standardhårddisk. StandardSSD_LRS använder Standard SSD. Premium_LRS använder Premium SSD. UltraSSD_LRS använder Ultra Disk. Premium_ZRS använder Premium SSD-zonredundant lagring. StandardSSD_ZRS använder zonredundant lagring av standard-SSD. Mer information om diskar som stöds för Windows Virtual Machines finns i https://docs.microsoft.com/azure/virtual-machines/windows/disks-types och, för Linux Virtual Machines, se https://docs.microsoft.com/azure/virtual-machines/linux/disks-types

Värde	Description
Standard_LRS
Premium_LRS
StandardSSD_LRS
UltraSSD_LRS
Premium_ZRS
StandardSSD_ZRS
PremiumV2_LRS

SubResource

Objekt

Name	Typ	Description
id	string	Resurs-ID

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

UefiSettings

Objekt

Anger de säkerhetsinställningar som säker start och vTPM som används när den virtuella datorn skapas. Lägsta API-version: 2020-12-01.

Name	Typ	Description
secureBootEnabled	boolean	Anger om säker start ska aktiveras på den virtuella datorn. Lägsta API-version: 2020-12-01.
vTpmEnabled	boolean	Anger om vTPM ska aktiveras på den virtuella datorn. Lägsta API-version: 2020-12-01.

VaultCertificate

Objekt

Beskriver en enda certifikatreferens i ett Key Vault och var certifikatet ska finnas på den virtuella datorn.

Name	Typ	Description
certificateStore	string	För virtuella Windows-datorer anger certifikatarkivet på den virtuella dator som certifikatet ska läggas till i. Det angivna certifikatarkivet finns implicit i LocalMachine-kontot. För virtuella Linux-datorer placeras certifikatfilen under katalogen /var/lib/waagent, med filnamnet <UppercaseThumbprint>.crt för X509-certifikatfilen och <UppercaseThumbprint>.prv för privat nyckel. Båda dessa filer är .pem-formaterade.
certificateUrl	string	Det här är URL:en för ett certifikat som har laddats upp till Key Vault som en hemlighet. Information om hur du lägger till en hemlighet i Key Vault finns i Lägg till en nyckel eller hemlighet i nyckelvalvet. I det här fallet måste certifikatet vara Det är Base64-kodningen för följande JSON-objekt som är kodat i UTF-8: { "data":"<Base64-kodat-certifikat>", "dataType":"pfx", "lösenord":"<pfx-file-password>" } Om du vill installera certifikat på en virtuell dator rekommenderar vi att du använder tillägget virtuella Azure Key Vault-dator för Linux eller tillägget virtuella Azure Key Vault-dator för Windows.

VaultSecretGroup

Objekt

Beskriver en uppsättning certifikat som alla finns i samma Key Vault.

Name	Typ	Description
sourceVault	SubResource	Den relativa URL:en för nyckelvalvet som innehåller alla certifikat i VaultCertificates.
vaultCertificates	VaultCertificate[]	Listan över key vault-referenser i SourceVault som innehåller certifikat.

VirtualMachineSizeTypes

Uppräkning

Anger storleken på den virtuella datorn. Uppräkningsdatatypen är för närvarande inaktuell och tas bort senast den 23 december 2023. Det rekommenderade sättet att hämta listan över tillgängliga storlekar är att använda dessa API:er: Lista alla tillgängliga storlekar för virtuella datorer i en tillgänglighetsuppsättning, Lista alla tillgängliga storlekar för virtuella datorer i en region, Lista alla tillgängliga storlekar för virtuella datorer för storleksändring. Mer information om storlekar på virtuella datorer finns i Storlekar för virtuella datorer. De tillgängliga VM-storlekarna beror på region och tillgänglighetsuppsättning.

Värde	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

Objekt

Anger säkerhetsprofilinställningarna för den hanterade disken. Obs! Det kan bara anges för konfidentiella virtuella datorer.

Name	Typ	Description
diskEncryptionSet	DiskEncryptionSetParameters	Anger resurs-ID för kundhanterad diskkrypteringsuppsättning för den hanterade disk som används för customer managed key encrypted ConfidentialVM OS Disk och VMGuest blob.
securityEncryptionType	SecurityEncryptionTypes	Anger EncryptionType för den hanterade disken. Den är inställd på DiskWithVMGuestState för kryptering av den hanterade disken tillsammans med VMGuestState-blob, VMGuestStateOnly för kryptering av bara VMGuestState-bloben och NonPersistedTPM för att inte bevara tillståndet för inbyggd programvara i VMGuestState-bloben. Obs! Det kan endast anges för konfidentiella virtuella datorer.

VMSizeProperties

Objekt

Anger egenskapsinställningar för VM-storlek på den virtuella datorn.

Name	Typ	Description
vCPUsAvailable	integer (int32)	Anger antalet virtuella processorer som är tillgängliga för den virtuella datorn. När den här egenskapen inte anges i begärandetexten är standardbeteendet att ange värdet för vCPU:er som är tillgängliga för den vm-storleken som exponeras i API-svaret för Lista alla tillgängliga storlekar för virtuella datorer i en region.
vCPUsPerCore	integer (int32)	Anger förhållandet mellan vCPU och fysisk kärna. När den här egenskapen inte anges i begärandetexten är standardbeteendet inställt på värdet för vCPUsPerCore för vm-storleken som exponeras i API-svaret för Lista alla tillgängliga storlekar på virtuella datorer i en region. Inställningen av den här egenskapen till 1 innebär också att hypertrådning är inaktiverat.

WindowsConfiguration

Objekt

Anger inställningarna för Windows-operativsystemet på den virtuella datorn.

Name	Typ	Description
additionalUnattendContent	AdditionalUnattendContent[]	Anger ytterligare base-64-kodad XML-formaterad information som kan ingå i Unattend.xml-filen, som används av Installationsprogrammet för Windows.
enableAutomaticUpdates	boolean	Anger om automatiska uppdateringar är aktiverade för den virtuella Windows-datorn. Standardvärdet är sant. För vm-skalningsuppsättningar kan den här egenskapen uppdateras och uppdateringar börjar gälla vid ometablering av operativsystem.
enableVMAgentPlatformUpdates	boolean	Anger om VMAgent-plattformsuppdateringar är aktiverade för den virtuella Windows-datorn.
patchSettings	PatchSettings	[Förhandsversionsfunktion] Anger inställningar som rör vm-gästkorrigering i Windows.
provisionVMAgent	boolean	Anger om den virtuella datoragenten ska etableras på den virtuella datorn. När den här egenskapen inte anges i begärandetexten är den inställd på true som standard. Detta säkerställer att VM-agenten är installerad på den virtuella datorn så att tillägg kan läggas till i den virtuella datorn senare.
timeZone	string	Anger tidszonen för den virtuella datorn. t.ex. "Pacific Standard Time". Möjliga värden kan vara TimeZoneInfo.Id värde från tidszoner som returneras av TimeZoneInfo.GetSystemTimeZones.
winRM	WinRMConfiguration	Anger lyssnarna för Windows Remote Management. Detta aktiverar fjärransluten Windows PowerShell.

WindowsPatchAssessmentMode

Uppräkning

Värde	Description
ImageDefault
AutomaticByPlatform

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Uppräkning

Anger omstartsinställningen för alla installationsåtgärder för AutomaticByPlatform-korrigering.

Värde	Description
Unknown
IfRequired
Never
Always

WindowsVMGuestPatchAutomaticByPlatformSettings

Objekt

Anger ytterligare inställningar som ska tillämpas när korrigeringsläget AutomaticByPlatform har valts i Windows-korrigeringsinställningar.

Name	Typ	Description
bypassPlatformSafetyChecksOnUserSchedule	boolean	Gör det möjligt för kunden att schemalägga korrigeringar utan oavsiktliga uppgraderingar
rebootSetting	WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Anger omstartsinställningen för alla installationsåtgärder för AutomaticByPlatform-korrigering.

WindowsVMGuestPatchMode

Uppräkning

Anger läget för vm-gästkorrigering till virtuell IaaS-dator eller virtuella datorer som är associerade med VM-skalningsuppsättning med OrchestrationMode som flexibel.

Möjliga värden är:

Manuell – Du styr tillämpningen av korrigeringar på en virtuell dator. Det gör du genom att tillämpa korrigeringar manuellt i den virtuella datorn. I det här läget inaktiveras automatiska uppdateringar. egenskapen WindowsConfiguration.enableAutomaticUpdates måste vara false

AutomaticByOS – Den virtuella datorn uppdateras automatiskt av operativsystemet. Egenskapen WindowsConfiguration.enableAutomaticUpdates måste vara sann.

AutomaticByPlatform – uppdateras den virtuella datorn automatiskt av plattformen. Egenskaperna provisionVMAgent och WindowsConfiguration.enableAutomaticUpdates måste vara sanna

Värde	Description
Manual
AutomaticByOS
AutomaticByPlatform

WinRMConfiguration

Objekt

Beskriver konfigurationen av Windows Remote Management för den virtuella datorn

Name	Typ	Description
listeners	WinRMListener[]	Listan över Windows Remote Management-lyssnare

WinRMListener

Objekt

Beskriver protokoll och tumavtryck för Windows Remote Management-lyssnare

Name	Typ	Description
certificateUrl	string	Det här är URL:en för ett certifikat som har laddats upp till Key Vault som en hemlighet. Information om hur du lägger till en hemlighet i Key Vault finns i Lägg till en nyckel eller hemlighet i nyckelvalvet. I det här fallet måste certifikatet vara Base64-kodningen för följande JSON-objekt som är kodat i UTF-8: { "data":"<Base64-kodat-certifikat>", "dataType":"pfx", "lösenord":"<pfx-file-password>" } Om du vill installera certifikat på en virtuell dator rekommenderar vi att du använder tillägget virtuella Azure Key Vault-dator för Linux eller tillägget virtuella Azure Key Vault-dator för Windows.
protocol	ProtocolTypes	Anger protokollet för WinRM-lyssnaren. Möjliga värden är: http,https.

Dela via

Restore Point Collections - Get

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

Get a restore point collection, including the restore points contained in the restore point collection

Exempelbegäran

Exempelsvar

Get a restore point collection (but not the restore points contained in the restore point collection)

Exempelbegäran

Exempelsvar

Definitioner

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

RestorePointCollection

RestorePointCollectionExpandOptions

RestorePointCollectionSourceProperties

RestorePointEncryption

RestorePointEncryptionType

RestorePointInstanceView

RestorePointSourceMetadata

RestorePointSourceVMDataDisk

RestorePointSourceVMOSDisk

RestorePointSourceVMStorageProfile

SecurityEncryptionTypes

SecurityProfile

SecurityTypes

SettingNames

SnapshotAccessState

SshConfiguration

SshPublicKey

StatusLevelTypes

StorageAccountTypes

SubResource

systemData

UefiSettings

VaultCertificate

VaultSecretGroup