Restore Point Collections - Get

Referenz

Dienst:: Compute

API-Version:: 2024-07-01

Der Vorgang zum Abrufen der Wiederherstellungspunktauflistung.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
restorePointCollectionName	path	True	string	Der Name der Wiederherstellungspunktauflistung.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.
$expand	query		RestorePointCollectionExpandOptions	Der erweiterungsausdruck, der für den Vorgang angewendet werden soll. Wenn expand=restorePoints, gibt der Server alle enthaltenen Wiederherstellungspunkte in der restorePointCollection zurück.

Antworten

Name	Typ	Beschreibung
200 OK	RestorePointCollection	OKAY
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

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

Beispielanforderung

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


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

/**
 * 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/2024-07-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.Resources;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-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://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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this RestorePointGroupResource
RestorePointGroupCollection collection = resourceGroupResource.GetRestorePointGroups();

// invoke the operation
string restorePointGroupName = "rpcName";
NullableResponse<RestorePointGroupResource> response = await collection.GetIfExistsAsync(restorePointGroupName);
RestorePointGroupResource 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
    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

Beispiel für eine Antwort

Statuscode:: 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"
    },
    "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"
          },
          "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)

Beispielanforderung

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


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

/**
 * 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/2024-07-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.Resources;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-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://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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this RestorePointGroupResource
RestorePointGroupCollection collection = resourceGroupResource.GetRestorePointGroups();

// invoke the operation
string restorePointGroupName = "myRpc";
NullableResponse<RestorePointGroupResource> response = await collection.GetIfExistsAsync(restorePointGroupName);
RestorePointGroupResource 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
    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

Beispiel für eine Antwort

Statuscode:: 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/restorePointCollections/myRpc",
      "location": "eastus"
    },
    "restorePointCollectionId": "59f04a5d-f783-4200-a1bd-d3f464e8c4b4",
    "provisioningState": "Succeeded"
  }
}

Definitionen

Name	Beschreibung
AdditionalUnattendContent	Gibt zusätzliche XML-formatierte Informationen an, die in der Unattend.xml-Datei enthalten sein können, die von Windows Setup verwendet wird. Inhalte werden durch Einstellungsname, Komponentenname und den Übergeben definiert, auf den der Inhalt angewendet wird.
ApiEntityReference	Der API-Entitätsverweis.
ApiError	API-Fehler.
ApiErrorBase	API-Fehlerbasis.
BootDiagnostics	Die Startdiagnose ist ein Debugfeature, mit dem Sie die Konsolenausgabe und den Screenshot anzeigen können, um den VM-Status zu diagnostizieren. Sie können die Ausgabe ihres Konsolenprotokolls ganz einfach anzeigen. Azure ermöglicht ihnen auch das Anzeigen eines Screenshots des virtuellen Computers vom Hypervisor.
CachingTypes	Ruft den Cachetyp ab.
CloudError	Eine Fehlerantwort des Computediensts.
ComponentNames	Der Komponentenname. Derzeit ist der einzige zulässige Wert Microsoft-Windows-Shell-Setup.
ConsistencyModeTypes	ConsistencyMode des RestorePoint. Kann beim Erstellen eines Wiederherstellungspunkts in der Eingabe angegeben werden. Derzeit wird nur CrashConsistent als gültige Eingabe akzeptiert. Weitere Informationen finden Sie unter https://aka.ms/RestorePoints.
DiagnosticsProfile	Gibt den Status der Startdiagnoseeinstellungen an. Mindest-API-Version: 2015-06-15.
DiskControllerTypes	Ruft den Datenträgercontrollertyp der VM ab, die zum Zeitpunkt der Erstellung des Wiederherstellungspunkts erfasst wurde.
DiskEncryptionSetParameters	Beschreibt den Parameter der vom Kunden verwalteten Datenträgerverschlüsselungssatz-Ressourcen-ID, die für den Datenträger angegeben werden kann. Hinweis: Die Ressourcen-ID des Datenträgerverschlüsselungssatzes kann nur für verwaltete Datenträger angegeben werden. Weitere Informationen finden Sie https://aka.ms/mdssewithcmkoverview.
DiskEncryptionSettings	Beschreibt eine Verschlüsselungseinstellungen für einen Datenträger
DiskRestorePointAttributes	Details des Datenträgerwiederherstellungspunkts.
DiskRestorePointInstanceView	Die Instanzansicht eines Datenträgerwiederherstellungspunkts.
DiskRestorePointReplicationStatus	Die Instanzansicht eines Datenträgerwiederherstellungspunkts.
EncryptionIdentity	Gibt die verwaltete Identität an, die von ADE zum Abrufen des Zugriffstokens für Keyvault-Vorgänge verwendet wird.
HardwareProfile	Gibt die Hardwareeinstellungen für den virtuellen Computer an.
HyperVGenerationTypes	HyperVGeneration der Quell-VM, für die der Wiederherstellungspunkt erfasst wird.
InnerError	Innere Fehlerdetails.
InstanceViewStatus	Instanzansichtsstatus.
KeyVaultKeyReference	Beschreibt einen Verweis auf Key Vault Key
KeyVaultSecretReference	Beschreibt einen Verweis auf key Vault Secret
LinuxConfiguration	Gibt die Linux-Betriebssystemeinstellungen auf dem virtuellen Computer an. Eine Liste der unterstützten Linux-Distributionen finden Sie unter Linux unter Azure-Endorsed Distributionen.
LinuxPatchAssessmentMode	Gibt den Modus der VM-Gastpatchbewertung für den virtuellen IaaS-Computer an. Mögliche Werte sind: ImageDefault- – Sie steuern den Zeitpunkt der Patchbewertungen auf einem virtuellen Computer. AutomaticByPlatform – Die Plattform löst regelmäßige Patchbewertungen aus. Die Eigenschaft provisionVMAgent muss true sein.
LinuxPatchSettings	Gibt Einstellungen im Zusammenhang mit VM-Gastpatching unter Linux an.
LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Gibt die Neustarteinstellung für alle AutomaticByPlatform-Patchinstallationsvorgänge an.
LinuxVMGuestPatchAutomaticByPlatformSettings	Gibt zusätzliche Einstellungen an, die angewendet werden sollen, wenn der Patchmodus AutomaticByPlatform in den Linux-Patcheinstellungen ausgewählt ist.
LinuxVMGuestPatchMode	Gibt den Modus des VM-Gastpatchings auf iaaS-VM-Computer oder virtuelle Computer an, die mit orchestrationMode als flexibel verknüpft sind. Mögliche Werte sind: ImageDefault- – Die Standardpatchingkonfiguration des virtuellen Computers wird verwendet. AutomaticByPlatform – Der virtuelle Computer wird automatisch von der Plattform aktualisiert. Die Eigenschaft provisionVMAgent muss true sein.
ManagedDiskParameters	Die Parameter eines verwalteten Datenträgers.
Mode	Gibt den Modus an, für den ProxyAgent ausgeführt wird, wenn das Feature aktiviert ist. ProxyAgent beginnt mit der Überwachung oder Überwachung, erzwingt jedoch keine Zugriffssteuerung für Anforderungen an Hostendpunkte im Überwachungsmodus, während im Erzwingungsmodus die Zugriffssteuerung erzwungen wird. Der Standardwert ist der Erzwingungsmodus.
OperatingSystemType	Ruft den Betriebssystemtyp ab.
OSProfile	Gibt die Betriebssystemeinstellungen für den virtuellen Computer an. Einige der Einstellungen können nicht geändert werden, nachdem der virtuelle Computer bereitgestellt wurde.
PassNames	Der Passname. Derzeit ist der einzige zulässige Wert OobeSystem.
PatchSettings	Gibt Einstellungen im Zusammenhang mit VM-Gastpatching unter Windows an.
ProtocolTypes	Gibt das Protokoll des WinRM-Listeners an. Mögliche Werte sind: http,https.
ProxyAgentSettings	Gibt proxyAgent-Einstellungen beim Erstellen des virtuellen Computers an. Mindest-API-Version: 2023-09-01.
RestorePoint	Punktdetails wiederherstellen.
RestorePointCollection	Dient zum Erstellen oder Aktualisieren von Wiederherstellungspunktsammlungsparametern.
RestorePointCollectionExpandOptions	Der erweiterungsausdruck, der für den Vorgang angewendet werden soll. Wenn expand=restorePoints, gibt der Server alle enthaltenen Wiederherstellungspunkte in der restorePointCollection zurück.
RestorePointCollectionSourceProperties	Die Eigenschaften der Quellressource, aus der diese Wiederherstellungspunktauflistung erstellt wird.
RestorePointEncryption	Verschlüsselung bei ruhenden Einstellungen für datenträgerwiederherstellungspunkt. Es handelt sich um eine optionale Eigenschaft, die beim Erstellen eines Wiederherstellungspunkts in der Eingabe angegeben werden kann.
RestorePointEncryptionType	Der Schlüsseltyp, der zum Verschlüsseln der Daten des Datenträgerwiederherstellungspunkts verwendet wird.
RestorePointInstanceView	Die Instanzansicht eines Wiederherstellungspunkts.
RestorePointSourceMetadata	Beschreibt die Eigenschaften des virtuellen Computers, für den der Wiederherstellungspunkt erstellt wurde. Die bereitgestellten Eigenschaften sind eine Teilmenge und die Momentaufnahme der allgemeinen Eigenschaften des virtuellen Computers, die zum Zeitpunkt der Erstellung des Wiederherstellungspunkts erfasst wurden.
RestorePointSourceVMDataDisk	Beschreibt einen Datenträger.
RestorePointSourceVMOSDisk	Beschreibt einen Betriebssystemdatenträger.
RestorePointSourceVMStorageProfile	Beschreibt das Speicherprofil.
securityEncryptionTypes	Gibt den EncryptionType des verwalteten Datenträgers an. Es ist für die Verschlüsselung des verwalteten Datenträgers auf DiskWithVMGuestStateState festgelegt, vmGuestStateOnly für die Verschlüsselung nur des VMGuestState-Blobs und NonPersistedTPM, um den Firmwarestatus im VMGuestState-Blob nicht beizubehalten. Hinweis: Sie kann nur für vertrauliche virtuelle Computer festgelegt werden.
SecurityProfile	Gibt die Sicherheitsprofileinstellungen für den Skalierungssatz des virtuellen Computers oder des virtuellen Computers an.
SecurityTypes	Gibt den SecurityType des virtuellen Computers an. Sie muss auf einen beliebigen angegebenen Wert festgelegt werden, um UefiSettings zu aktivieren. Das Standardverhalten lautet: UefiSettings wird nur aktiviert, wenn diese Eigenschaft festgelegt ist.
SettingNames	Gibt den Namen der Einstellung an, auf die der Inhalt angewendet wird. Mögliche Werte sind: FirstLogonCommands und AutoLogon.
SshConfiguration	SSH-Konfiguration für linuxbasierte VMs, die auf Azure ausgeführt werden
SshPublicKey	Enthält Informationen über den öffentlichen SSH-Zertifikatschlüssel und den Pfad auf der Linux-VM, auf der der öffentliche Schlüssel platziert wird.
StatusLevelTypes	Der Ebenencode.
StorageAccountTypes	Gibt den Speicherkontotyp für den verwalteten Datenträger an. HINWEIS: UltraSSD_LRS nur mit Datenträgern verwendet werden kann, kann sie nicht mit Betriebssystemdatenträgern verwendet werden.
SubResource
UefiSettings	Gibt die Sicherheitseinstellungen wie sicherer Start und vTPM an, die beim Erstellen des virtuellen Computers verwendet werden. Mindest-API-Version: 2020-12-01.
VaultCertificate	Beschreibt einen einzelnen Zertifikatverweis in einem Key Vault und wo sich das Zertifikat auf dem virtuellen Computer befinden soll.
VaultSecretGroup	Beschreibt eine Gruppe von Zertifikaten, die sich alle im selben Key Vault befinden.
VirtualMachineSizeTypes	Gibt die Größe des virtuellen Computers an. Der Enumerationsdatentyp ist derzeit veraltet und wird bis zum 23. Dezember 2023 entfernt. Die empfohlene Methode zum Abrufen der Liste der verfügbaren Größen ist die Verwendung dieser APIs: Auflisten aller verfügbaren Größe virtueller Computergrößen in einem Verfügbarkeitssatz, Auflisten aller verfügbaren größen virtueller Computer in einer Region, Auflisten aller verfügbaren Größen für virtuelle Computer zum Ändern der Größe. Weitere Informationen zu den Größen virtueller Computer finden Sie unter Größen für virtuelle Computer. Die verfügbaren VM-Größen sind von Region und Verfügbarkeitssatz abhängig.
VMDiskSecurityProfile	Gibt die Sicherheitsprofileinstellungen für den verwalteten Datenträger an. Hinweis: Es kann nur für vertrauliche VMs festgelegt werden.
VMSizeProperties	Gibt die Einstellungen der VM Size-Eigenschaft auf dem virtuellen Computer an.
WindowsConfiguration	Gibt die Windows-Betriebssystemeinstellungen auf dem virtuellen Computer an.
WindowsPatchAssessmentMode	Gibt den Modus der VM-Gastpatchbewertung für den virtuellen IaaS-Computer an. Mögliche Werte sind: ImageDefault- – Sie steuern den Zeitpunkt der Patchbewertungen auf einem virtuellen Computer. AutomaticByPlatform – Die Plattform löst regelmäßige Patchbewertungen aus. Die Eigenschaft provisionVMAgent muss true sein.
WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Gibt die Neustarteinstellung für alle AutomaticByPlatform-Patchinstallationsvorgänge an.
WindowsVMGuestPatchAutomaticByPlatformSettings	Gibt zusätzliche Einstellungen an, die angewendet werden sollen, wenn der Patchmodus AutomaticByPlatform in den Windows-Patcheinstellungen ausgewählt ist.
WindowsVMGuestPatchMode	Gibt den Modus des VM-Gastpatchings auf iaaS-VM-Computer oder virtuelle Computer an, die mit orchestrationMode als flexibel verknüpft sind. Mögliche Werte sind: Manuelle – Sie steuern die Anwendung von Patches auf einen virtuellen Computer. Dazu wenden Sie Patches manuell innerhalb des virtuellen Computers an. In diesem Modus sind automatische Updates deaktiviert; die Eigenschaft "WindowsConfiguration.enableAutomaticUpdates" muss "false" sein. AutomaticByOS- – Der virtuelle Computer wird automatisch vom Betriebssystem aktualisiert. Die Eigenschaft "WindowsConfiguration.enableAutomaticUpdates" muss "true" sein. AutomaticByPlatform – der virtuelle Computer wird automatisch von der Plattform aktualisiert. Die Eigenschaften provisionVMAgent und WindowsConfiguration.enableAutomaticUpdates müssen true sein.
WinRMConfiguration	Beschreibt die Konfiguration der Windows-Remoteverwaltung des virtuellen Computers
WinRMListener	Beschreibt Protokoll und Fingerabdruck des Windows-Remoteverwaltungslisteners

AdditionalUnattendContent

Gibt zusätzliche XML-formatierte Informationen an, die in der Unattend.xml-Datei enthalten sein können, die von Windows Setup verwendet wird. Inhalte werden durch Einstellungsname, Komponentenname und den Übergeben definiert, auf den der Inhalt angewendet wird.

Name	Typ	Beschreibung
componentName	ComponentNames	Der Komponentenname. Derzeit ist der einzige zulässige Wert Microsoft-Windows-Shell-Setup.
content	string	Gibt den XML-formatierten Inhalt an, der der unattend.xml-Datei für den angegebenen Pfad und die angegebene Komponente hinzugefügt wird. Der XML-Code muss kleiner als 4 KB sein und das Stammelement für die einstellung oder das Feature enthalten, das eingefügt wird.
passName	PassNames	Der Passname. Derzeit ist der einzige zulässige Wert OobeSystem.
settingName	SettingNames	Gibt den Namen der Einstellung an, auf die der Inhalt angewendet wird. Mögliche Werte sind: FirstLogonCommands und AutoLogon.

ApiEntityReference

Der API-Entitätsverweis.

Name	Typ	Beschreibung
id	string	Die ARM-Ressourcen-ID in Form von /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

API-Fehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	ApiErrorBase[]	Die API-Fehlerdetails
innererror	InnerError	Interner API-Fehler
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

ApiErrorBase

API-Fehlerbasis.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

BootDiagnostics

Die Startdiagnose ist ein Debugfeature, mit dem Sie die Konsolenausgabe und den Screenshot anzeigen können, um den VM-Status zu diagnostizieren. Sie können die Ausgabe ihres Konsolenprotokolls ganz einfach anzeigen. Azure ermöglicht ihnen auch das Anzeigen eines Screenshots des virtuellen Computers vom Hypervisor.

Name	Typ	Beschreibung
enabled	boolean	Gibt an, ob die Startdiagnose auf dem virtuellen Computer aktiviert werden soll.
storageUri	string	URI des Speicherkontos, das zum Platzieren der Konsolenausgabe und des Screenshots verwendet werden soll. Wenn "storageUri" beim Aktivieren der Startdiagnose nicht angegeben wird, wird verwalteter Speicher verwendet.

CachingTypes

Ruft den Cachetyp ab.

Name	Typ	Beschreibung
None	string
ReadOnly	string
ReadWrite	string

CloudError

Eine Fehlerantwort des Computediensts.

Name	Typ	Beschreibung
error	ApiError	API-Fehler.

ComponentNames

Der Komponentenname. Derzeit ist der einzige zulässige Wert Microsoft-Windows-Shell-Setup.

Name	Typ	Beschreibung
Microsoft-Windows-Shell-Setup	string

ConsistencyModeTypes

ConsistencyMode des RestorePoint. Kann beim Erstellen eines Wiederherstellungspunkts in der Eingabe angegeben werden. Derzeit wird nur CrashConsistent als gültige Eingabe akzeptiert. Weitere Informationen finden Sie unter https://aka.ms/RestorePoints.

Name	Typ	Beschreibung
ApplicationConsistent	string
CrashConsistent	string
FileSystemConsistent	string

DiagnosticsProfile

Gibt den Status der Startdiagnoseeinstellungen an. Mindest-API-Version: 2015-06-15.

Name	Typ	Beschreibung
bootDiagnostics	BootDiagnostics	Die Startdiagnose ist ein Debugfeature, mit dem Sie die Konsolenausgabe und den Screenshot anzeigen können, um den VM-Status zu diagnostizieren. HINWEIS: Wenn "storageUri" angegeben wird, stellen Sie sicher, dass sich das Speicherkonto in derselben Region und im selben Abonnement wie der virtuelle Computer befindet. Sie können die Ausgabe ihres Konsolenprotokolls ganz einfach anzeigen. Azure ermöglicht ihnen auch das Anzeigen eines Screenshots des virtuellen Computers vom Hypervisor.

DiskControllerTypes

Ruft den Datenträgercontrollertyp der VM ab, die zum Zeitpunkt der Erstellung des Wiederherstellungspunkts erfasst wurde.

Name	Typ	Beschreibung
NVMe	string
SCSI	string

DiskEncryptionSetParameters

Beschreibt den Parameter der vom Kunden verwalteten Datenträgerverschlüsselungssatz-Ressourcen-ID, die für den Datenträger angegeben werden kann. Hinweis: Die Ressourcen-ID des Datenträgerverschlüsselungssatzes kann nur für verwaltete Datenträger angegeben werden. Weitere Informationen finden Sie https://aka.ms/mdssewithcmkoverview.

Name	Typ	Beschreibung
id	string	Ressourcen-ID

DiskEncryptionSettings

Beschreibt eine Verschlüsselungseinstellungen für einen Datenträger

Name	Typ	Beschreibung
diskEncryptionKey	KeyVaultSecretReference	Gibt den Speicherort des Datenträgerverschlüsselungsschlüssels an, bei dem es sich um einen Schlüsseltresorschlüssel handelt.
enabled	boolean	Gibt an, ob die Datenträgerverschlüsselung auf dem virtuellen Computer aktiviert werden soll.
keyEncryptionKey	KeyVaultKeyReference	Gibt den Speicherort des Schlüsselverschlüsselungsschlüssels im Key Vault an.

DiskRestorePointAttributes

Details des Datenträgerwiederherstellungspunkts.

Name	Typ	Beschreibung
encryption	RestorePointEncryption	Verschlüsselung bei ruhenden Einstellungen für datenträgerwiederherstellungspunkt. Es handelt sich um eine optionale Eigenschaft, die beim Erstellen eines Wiederherstellungspunkts in der Eingabe angegeben werden kann.
id	string	Ressourcen-ID
sourceDiskRestorePoint	ApiEntityReference	Ressourcen-ID des Wiederherstellungspunkts des Quelldatenträgers.

DiskRestorePointInstanceView

Die Instanzansicht eines Datenträgerwiederherstellungspunkts.

Name	Typ	Beschreibung
id	string	Datenträgerwiederherstellungspunkt-ID.
replicationStatus	DiskRestorePointReplicationStatus	Die Informationen zum Replikationspunkt des Datenträgerwiederherstellungspunkts.

DiskRestorePointReplicationStatus

Die Instanzansicht eines Datenträgerwiederherstellungspunkts.

Name	Typ	Beschreibung
completionPercent	integer	Prozentsatz des Replikationsabschlusses.
status	InstanceViewStatus	Die Ressourcenstatusinformationen.

EncryptionIdentity

Gibt die verwaltete Identität an, die von ADE zum Abrufen des Zugriffstokens für Keyvault-Vorgänge verwendet wird.

Name	Typ	Beschreibung
userAssignedIdentityResourceId	string	Gibt die ARM-Ressourcen-ID einer der Benutzeridentitäten an, die der VM zugeordnet sind.

HardwareProfile

Gibt die Hardwareeinstellungen für den virtuellen Computer an.

Name	Typ	Beschreibung
vmSize	VirtualMachineSizeTypes	Gibt die Größe des virtuellen Computers an. Der Enumerationsdatentyp ist derzeit veraltet und wird bis zum 23. Dezember 2023 entfernt. Die empfohlene Methode zum Abrufen der Liste der verfügbaren Größen ist die Verwendung dieser APIs: Auflisten aller verfügbaren Größe virtueller Computergrößen in einem Verfügbarkeitssatz, Auflisten aller verfügbaren größen virtueller Computer in einer Region, Auflisten aller verfügbaren Größen für virtuelle Computer zum Ändern der Größe. Weitere Informationen zu den Größen virtueller Computer finden Sie unter Größen für virtuelle Computer. Die verfügbaren VM-Größen sind von Region und Verfügbarkeitssatz abhängig.
vmSizeProperties	VMSizeProperties	Gibt die Eigenschaften zum Anpassen der Größe des virtuellen Computers an. Mindest-API-Version: 2021-07-01. Dieses Feature befindet sich weiterhin im Vorschaumodus und wird für VirtualMachineScaleSet nicht unterstützt. Weitere Informationen finden Sie in VM Customization.

HyperVGenerationTypes

HyperVGeneration der Quell-VM, für die der Wiederherstellungspunkt erfasst wird.

Name	Typ	Beschreibung
V1	string
V2	string

InnerError

Innere Fehlerdetails.

Name	Typ	Beschreibung
errordetail	string	Die interne Fehlermeldung oder das Ausnahmeabbild.
exceptiontype	string	Der Ausnahmetyp.

InstanceViewStatus

Instanzansichtsstatus.

Name	Typ	Beschreibung
code	string	Der Statuscode.
displayStatus	string	Die kurze lokalisierbare Bezeichnung für den Status.
level	StatusLevelTypes	Der Ebenencode.
message	string	Die detaillierte Statusmeldung, einschließlich warnungen und Fehlermeldungen.
time	string	Die Uhrzeit des Status.

KeyVaultKeyReference

Beschreibt einen Verweis auf Key Vault Key

Name	Typ	Beschreibung
keyUrl	string	Die URL, die auf einen Schlüsselverschlüsselungsschlüssel im Key Vault verweist.
sourceVault	SubResource	Die relative URL des Schlüsseltresors, der den Schlüssel enthält.

KeyVaultSecretReference

Beschreibt einen Verweis auf key Vault Secret

Name	Typ	Beschreibung
secretUrl	string	Die URL, die auf einen geheimen Schlüssel in einem Key Vault verweist.
sourceVault	SubResource	Die relative URL des Schlüsseltresors, der den geheimen Schlüssel enthält.

LinuxConfiguration

Gibt die Linux-Betriebssystemeinstellungen auf dem virtuellen Computer an. Eine Liste der unterstützten Linux-Distributionen finden Sie unter Linux unter Azure-Endorsed Distributionen.

Name	Typ	Beschreibung
disablePasswordAuthentication	boolean	Gibt an, ob die Kennwortauthentifizierung deaktiviert werden soll.
enableVMAgentPlatformUpdates	boolean	Gibt an, ob VMAgent Platform Updates für den virtuellen Linux-Computer aktiviert ist. Der Standardwert ist "false".
patchSettings	LinuxPatchSettings	[Vorschaufeature] Gibt Einstellungen im Zusammenhang mit VM-Gastpatching unter Linux an.
provisionVMAgent	boolean	Gibt an, ob der Agent des virtuellen Computers auf dem virtuellen Computer bereitgestellt werden soll. Wenn diese Eigenschaft nicht im Anforderungstext angegeben ist, wird sie standardmäßig auf "true" festgelegt. Dadurch wird sichergestellt, dass der VM-Agent auf dem virtuellen Computer installiert ist, damit Erweiterungen später zur VM hinzugefügt werden können.
ssh	SshConfiguration	Gibt die Ssh-Schlüsselkonfiguration für ein Linux-Betriebssystem an.

LinuxPatchAssessmentMode

Gibt den Modus der VM-Gastpatchbewertung für den virtuellen IaaS-Computer an.

Mögliche Werte sind:

ImageDefault- – Sie steuern den Zeitpunkt der Patchbewertungen auf einem virtuellen Computer.

AutomaticByPlatform – Die Plattform löst regelmäßige Patchbewertungen aus. Die Eigenschaft provisionVMAgent muss true sein.

Name	Typ	Beschreibung
AutomaticByPlatform	string
ImageDefault	string

LinuxPatchSettings

Gibt Einstellungen im Zusammenhang mit VM-Gastpatching unter Linux an.

Name	Typ	Beschreibung
assessmentMode	LinuxPatchAssessmentMode	Gibt den Modus der VM-Gastpatchbewertung für den virtuellen IaaS-Computer an. Mögliche Werte sind: ImageDefault- – Sie steuern den Zeitpunkt der Patchbewertungen auf einem virtuellen Computer. AutomaticByPlatform – Die Plattform löst regelmäßige Patchbewertungen aus. Die Eigenschaft provisionVMAgent muss true sein.
automaticByPlatformSettings	LinuxVMGuestPatchAutomaticByPlatformSettings	Gibt zusätzliche Einstellungen für den Patchmodus AutomaticByPlatform in VM-Gastpatching unter Linux an.
patchMode	LinuxVMGuestPatchMode	Gibt den Modus des VM-Gastpatchings auf iaaS-VM-Computer oder virtuelle Computer an, die mit orchestrationMode als flexibel verknüpft sind. Mögliche Werte sind: ImageDefault- – Die Standardpatchingkonfiguration des virtuellen Computers wird verwendet. AutomaticByPlatform – Der virtuelle Computer wird automatisch von der Plattform aktualisiert. Die Eigenschaft provisionVMAgent muss true sein.

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Gibt die Neustarteinstellung für alle AutomaticByPlatform-Patchinstallationsvorgänge an.

Name	Typ	Beschreibung
Always	string
IfRequired	string
Never	string
Unknown	string

LinuxVMGuestPatchAutomaticByPlatformSettings

Gibt zusätzliche Einstellungen an, die angewendet werden sollen, wenn der Patchmodus AutomaticByPlatform in den Linux-Patcheinstellungen ausgewählt ist.

Name	Typ	Beschreibung
bypassPlatformSafetyChecksOnUserSchedule	boolean	Ermöglicht es Kunden, Patching ohne versehentliche Upgrades zu planen
rebootSetting	LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Gibt die Neustarteinstellung für alle AutomaticByPlatform-Patchinstallationsvorgänge an.

LinuxVMGuestPatchMode

Gibt den Modus des VM-Gastpatchings auf iaaS-VM-Computer oder virtuelle Computer an, die mit orchestrationMode als flexibel verknüpft sind.

Mögliche Werte sind:

ImageDefault- – Die Standardpatchingkonfiguration des virtuellen Computers wird verwendet.

AutomaticByPlatform – Der virtuelle Computer wird automatisch von der Plattform aktualisiert. Die Eigenschaft provisionVMAgent muss true sein.

Name	Typ	Beschreibung
AutomaticByPlatform	string
ImageDefault	string

ManagedDiskParameters

Die Parameter eines verwalteten Datenträgers.

Name	Typ	Beschreibung
diskEncryptionSet	DiskEncryptionSetParameters	Gibt die vom Kunden verwaltete Datenträgerverschlüsselungssatz-Ressourcen-ID für den verwalteten Datenträger an.
id	string	Ressourcen-ID
securityProfile	VMDiskSecurityProfile	Gibt das Sicherheitsprofil für den verwalteten Datenträger an.
storageAccountType	StorageAccountTypes	Gibt den Speicherkontotyp für den verwalteten Datenträger an. HINWEIS: UltraSSD_LRS nur mit Datenträgern verwendet werden kann, kann sie nicht mit Betriebssystemdatenträgern verwendet werden.

Mode

Gibt den Modus an, für den ProxyAgent ausgeführt wird, wenn das Feature aktiviert ist. ProxyAgent beginnt mit der Überwachung oder Überwachung, erzwingt jedoch keine Zugriffssteuerung für Anforderungen an Hostendpunkte im Überwachungsmodus, während im Erzwingungsmodus die Zugriffssteuerung erzwungen wird. Der Standardwert ist der Erzwingungsmodus.

Name	Typ	Beschreibung
Audit	string
Enforce	string

OperatingSystemType

Ruft den Betriebssystemtyp ab.

Name	Typ	Beschreibung
Linux	string
Windows	string

OSProfile

Gibt die Betriebssystemeinstellungen für den virtuellen Computer an. Einige der Einstellungen können nicht geändert werden, nachdem der virtuelle Computer bereitgestellt wurde.

Name	Typ	Beschreibung
adminPassword	string	Gibt das Kennwort des Administratorkontos an. Mindestlänge (Windows): 8 Zeichen Mindestlänge (Linux): 6 Zeichen Max. Länge (Windows): 123 Zeichen Max-Length (Linux): 72 Zeichen Komplexitätsanforderungen: 3 von 4 unten aufgeführten Bedingungen müssen erfüllt sein Enthält Zeichen mit niedrigeren Zeichen Enthält groß geschriebene Zeichen Hat eine Ziffer Weist ein Sonderzeichen auf (Regex-Übereinstimmung [\W_]) Unzulässige Werte: "abc@123", "P@$$w 0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" Informationen zum Zurücksetzen des Kennworts finden Sie unter Zurücksetzen des Remotedesktopdiensts oder seines Anmeldekennworts in einer Windows-VM- Informationen zum Zurücksetzen des Stammkennworts finden Sie unter Verwalten von Benutzern, SSH und Überprüfen oder Reparieren von Datenträgern auf Azure Linux-VMs mithilfe der VMAccess-Erweiterung
adminUsername	string	Gibt den Namen des Administratorkontos an. Diese Eigenschaft kann nicht aktualisiert werden, nachdem der virtuelle Computer erstellt wurde. Nur-Windows-Einschränkung: Kann nicht in "" enden. Unzulässige Werte: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". Mindestlänge (Linux): 1 Zeichen Max-Length (Linux): 64 Zeichen Max. Länge (Windows): 20 Zeichen.
allowExtensionOperations	boolean	Gibt an, ob Erweiterungsvorgänge auf dem virtuellen Computer zulässig sein sollen. Dies kann nur auf False festgelegt werden, wenn keine Erweiterungen auf dem virtuellen Computer vorhanden sind.
computerName	string	Gibt den Hostnamen des virtuellen Computers an. Dieser Name kann nicht aktualisiert werden, nachdem der virtuelle Computer erstellt wurde. Max. Länge (Windows): 15 Zeichen. Max-Length (Linux): 64 Zeichen. Benennungskonventionen und Einschränkungen finden Sie in Implementierungsrichtlinien für Azure-Infrastrukturdienste.
customData	string	Gibt eine base64-codierte Zeichenfolge von benutzerdefinierten Daten an. Die base64-codierte Zeichenfolge wird mit einem binären Array decodiert, das als Datei auf dem virtuellen Computer gespeichert wird. Die maximale Länge des binären Arrays beträgt 65535 Bytes. Hinweis: Übergeben Sie keine geheimen Schlüssel oder Kennwörter in der customData-Eigenschaft. Diese Eigenschaft kann nicht aktualisiert werden, nachdem der virtuelle Computer erstellt wurde. Die Eigenschaft "customData" wird an den virtuellen Computer übergeben, der als Datei gespeichert werden soll. Weitere Informationen finden Sie unter Benutzerdefinierte Daten auf Azure-VMs. Informationen zur Verwendung von Cloud-Init für Ihre Linux-VM finden Sie unter Verwenden von Cloud-Init zum Anpassen einer Linux-VM während der Erstellung.
linuxConfiguration	LinuxConfiguration	Gibt die Linux-Betriebssystemeinstellungen auf dem virtuellen Computer an. Eine Liste der unterstützten Linux-Distributionen finden Sie unter Linux unter Azure-Endorsed Distributionen.
requireGuestProvisionSignal	boolean	Optionale Eigenschaft, die entweder auf True festgelegt oder weggelassen werden muss.
secrets	VaultSecretGroup[]	Gibt einen Satz von Zertifikaten an, die auf dem virtuellen Computer installiert werden sollen. Um Zertifikate auf einem virtuellen Computer zu installieren, empfiehlt es sich, die erweiterung des virtuellen Azure Key Vault-Computers für Linux oder die erweiterung des virtuellen Azure Key Vault-Computers für Windowszu verwenden.
windowsConfiguration	WindowsConfiguration	Gibt die Windows-Betriebssystemeinstellungen auf dem virtuellen Computer an.

PassNames

Der Passname. Derzeit ist der einzige zulässige Wert OobeSystem.

Name	Typ	Beschreibung
OobeSystem	string

PatchSettings

Gibt Einstellungen im Zusammenhang mit VM-Gastpatching unter Windows an.

Name	Typ	Beschreibung
assessmentMode	WindowsPatchAssessmentMode	Gibt den Modus der VM-Gastpatchbewertung für den virtuellen IaaS-Computer an. Mögliche Werte sind: ImageDefault- – Sie steuern den Zeitpunkt der Patchbewertungen auf einem virtuellen Computer. AutomaticByPlatform – Die Plattform löst regelmäßige Patchbewertungen aus. Die Eigenschaft provisionVMAgent muss true sein.
automaticByPlatformSettings	WindowsVMGuestPatchAutomaticByPlatformSettings	Gibt zusätzliche Einstellungen für den Patchmodus AutomaticByPlatform in VM-Gastpatching unter Windows an.
enableHotpatching	boolean	Ermöglicht Es Kunden, ihre Azure-VMs zu patchen, ohne dass ein Neustart erforderlich ist. Für enableHotpatching muss "provisionVMAgent" auf "true" festgelegt werden, und "patchMode" muss auf "AutomaticByPlatform" festgelegt werden.
patchMode	WindowsVMGuestPatchMode	Gibt den Modus des VM-Gastpatchings auf iaaS-VM-Computer oder virtuelle Computer an, die mit orchestrationMode als flexibel verknüpft sind. Mögliche Werte sind: Manuelle – Sie steuern die Anwendung von Patches auf einen virtuellen Computer. Dazu wenden Sie Patches manuell innerhalb des virtuellen Computers an. In diesem Modus sind automatische Updates deaktiviert; die Eigenschaft "WindowsConfiguration.enableAutomaticUpdates" muss "false" sein. AutomaticByOS- – Der virtuelle Computer wird automatisch vom Betriebssystem aktualisiert. Die Eigenschaft "WindowsConfiguration.enableAutomaticUpdates" muss "true" sein. AutomaticByPlatform – der virtuelle Computer wird automatisch von der Plattform aktualisiert. Die Eigenschaften provisionVMAgent und WindowsConfiguration.enableAutomaticUpdates müssen true sein.

ProtocolTypes

Gibt das Protokoll des WinRM-Listeners an. Mögliche Werte sind: http,https.

Name	Typ	Beschreibung
Http	string
Https	string

ProxyAgentSettings

Gibt proxyAgent-Einstellungen beim Erstellen des virtuellen Computers an. Mindest-API-Version: 2023-09-01.

Name	Typ	Beschreibung
enabled	boolean	Gibt an, ob das ProxyAgent-Feature auf dem virtuellen Computer oder im Skalierungssatz des virtuellen Computers aktiviert werden soll.
keyIncarnationId	integer	Wenn Sie den Wert dieser Eigenschaft erhöhen, können Benutzer den Schlüssel zurücksetzen, der zum Sichern des Kommunikationskanals zwischen Gast und Host verwendet wird.
mode	Mode	Gibt den Modus an, für den ProxyAgent ausgeführt wird, wenn das Feature aktiviert ist. ProxyAgent beginnt mit der Überwachung oder Überwachung, erzwingt jedoch keine Zugriffssteuerung für Anforderungen an Hostendpunkte im Überwachungsmodus, während im Erzwingungsmodus die Zugriffssteuerung erzwungen wird. Der Standardwert ist der Erzwingungsmodus.

RestorePoint

Punktdetails wiederherstellen.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
name	string	Ressourcenname
properties.consistencyMode	ConsistencyModeTypes	ConsistencyMode des RestorePoint. Kann beim Erstellen eines Wiederherstellungspunkts in der Eingabe angegeben werden. Derzeit wird nur CrashConsistent als gültige Eingabe akzeptiert. Weitere Informationen finden Sie unter https://aka.ms/RestorePoints.
properties.excludeDisks	ApiEntityReference[]	Liste der Datenträgerressourcen-IDs, die der Kunde vom Wiederherstellungspunkt ausschließen möchte. Wenn keine Datenträger angegeben sind, werden alle Datenträger eingeschlossen.
properties.instanceView	RestorePointInstanceView	Die Wiederherstellungspunktinstanzansicht.
properties.provisioningState	string	Ruft den Bereitstellungsstatus des Wiederherstellungspunkts ab.
properties.sourceMetadata	RestorePointSourceMetadata	Ruft die Details der VM ab, die zum Zeitpunkt der Erstellung des Wiederherstellungspunkts erfasst wurde.
properties.sourceRestorePoint	ApiEntityReference	Ressourcen-ID des Quellwiederherstellungspunkts, von dem aus eine Kopie erstellt werden muss.
properties.timeCreated	string	Ruft die Erstellungszeit des Wiederherstellungspunkts ab.
type	string	Ressourcentyp

RestorePointCollection

Dient zum Erstellen oder Aktualisieren von Wiederherstellungspunktsammlungsparametern.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
location	string	Ressourcenspeicherort
name	string	Ressourcenname
properties.provisioningState	string	Der Bereitstellungsstatus der Wiederherstellungspunktsammlung.
properties.restorePointCollectionId	string	Die eindeutige ID der Wiederherstellungspunktauflistung.
properties.restorePoints	RestorePoint[]	Eine Liste mit allen Wiederherstellungspunkten, die unter dieser Wiederherstellungspunktsammlung erstellt wurden.
properties.source	RestorePointCollectionSourceProperties	Die Eigenschaften der Quellressource, aus der diese Wiederherstellungspunktauflistung erstellt wird.
tags	object	Ressourcentags
type	string	Ressourcentyp

RestorePointCollectionExpandOptions

Der erweiterungsausdruck, der für den Vorgang angewendet werden soll. Wenn expand=restorePoints, gibt der Server alle enthaltenen Wiederherstellungspunkte in der restorePointCollection zurück.

Name	Typ	Beschreibung
restorePoints	string

RestorePointCollectionSourceProperties

Die Eigenschaften der Quellressource, aus der diese Wiederherstellungspunktauflistung erstellt wird.

Name	Typ	Beschreibung
id	string	Ressourcen-ID der Quellressource, die zum Erstellen dieser Wiederherstellungspunktauflistung verwendet wird
location	string	Speicherort der Quellressource, die zum Erstellen dieser Wiederherstellungspunktauflistung verwendet wird.

RestorePointEncryption

Verschlüsselung bei ruhenden Einstellungen für datenträgerwiederherstellungspunkt. Es handelt sich um eine optionale Eigenschaft, die beim Erstellen eines Wiederherstellungspunkts in der Eingabe angegeben werden kann.

Name	Typ	Beschreibung
diskEncryptionSet	DiskEncryptionSetParameters	Beschreibt den Parameter der vom Kunden verwalteten Datenträgerverschlüsselungssatz-Ressourcen-ID, die für den Datenträger angegeben werden kann. Hinweis: Die Ressourcen-ID des Datenträgerverschlüsselungssatzes kann nur für verwaltete Datenträger angegeben werden. Weitere Informationen finden Sie https://aka.ms/mdssewithcmkoverview.
type	RestorePointEncryptionType	Der Schlüsseltyp, der zum Verschlüsseln der Daten des Datenträgerwiederherstellungspunkts verwendet wird.

RestorePointEncryptionType

Der Schlüsseltyp, der zum Verschlüsseln der Daten des Datenträgerwiederherstellungspunkts verwendet wird.

Name	Typ	Beschreibung
EncryptionAtRestWithCustomerKey	string	Der ruhende Datenträgerwiederherstellungspunkt wird mit dem vom Kunden verwalteten Schlüssel verschlüsselt, der von einem Kunden geändert und widerrufen werden kann.
EncryptionAtRestWithPlatformAndCustomerKeys	string	Der Datenträgerwiederherstellungspunkt wird ruhende Daten mit 2 Verschlüsselungsebenen verschlüsselt. Einer der Schlüssel ist vom Kunden verwaltet, und der andere Schlüssel wird plattformverwaltet.
EncryptionAtRestWithPlatformKey	string	Der Datenträgerwiederherstellungspunkt wird mit verwaltetem Plattformschlüssel verschlüsselt.

RestorePointInstanceView

Die Instanzansicht eines Wiederherstellungspunkts.

Name	Typ	Beschreibung
diskRestorePoints	DiskRestorePointInstanceView[]	Informationen zur Datenträgerwiederherstellung.
statuses	InstanceViewStatus[]	Die Ressourcenstatusinformationen.

RestorePointSourceMetadata

Beschreibt die Eigenschaften des virtuellen Computers, für den der Wiederherstellungspunkt erstellt wurde. Die bereitgestellten Eigenschaften sind eine Teilmenge und die Momentaufnahme der allgemeinen Eigenschaften des virtuellen Computers, die zum Zeitpunkt der Erstellung des Wiederherstellungspunkts erfasst wurden.

Name	Typ	Beschreibung
diagnosticsProfile	DiagnosticsProfile	Ruft das Diagnoseprofil ab.
hardwareProfile	HardwareProfile	Ruft das Hardwareprofil ab.
hyperVGeneration	HyperVGenerationTypes	HyperVGeneration der Quell-VM, für die der Wiederherstellungspunkt erfasst wird.
licenseType	string	Ruft den Lizenztyp ab, der für ein eigenes Lizenzszenario vorgesehen ist.
location	string	Speicherort des virtuellen Computers, von dem der Wiederherstellungspunkt erstellt wurde.
osProfile	OSProfile	Ruft das Betriebssystemprofil ab.
securityProfile	SecurityProfile	Ruft das Sicherheitsprofil ab.
storageProfile	RestorePointSourceVMStorageProfile	Ruft das Speicherprofil ab.
userData	string	UserData, die der Quell-VM zugeordnet ist, für die der Wiederherstellungspunkt erfasst wird, bei dem es sich um einen base64-codierten Wert handelt.
vmId	string	Ruft die eindeutige ID des virtuellen Computers ab.

RestorePointSourceVMDataDisk

Beschreibt einen Datenträger.

Name	Typ	Beschreibung
caching	CachingTypes	Ruft den Cachetyp ab.
diskRestorePoint	DiskRestorePointAttributes	Enthält Eigenschaften des Datenträgerwiederherstellungspunkts.
diskSizeGB	integer	Ruft die anfängliche Datenträgergröße in GB für leere Datenträger und die neue gewünschte Größe für vorhandene Betriebssystem- und Datenträger ab.
lun	integer	Ruft die logische Einheitsnummer ab.
managedDisk	ManagedDiskParameters	Enthält die Details des verwalteten Datenträgers.
name	string	Ruft den Datenträgernamen ab.
writeAcceleratorEnabled	boolean	Zeigt "true" an, wenn der Datenträger schreibzugriffstasten aktiviert ist.

RestorePointSourceVMOSDisk

Beschreibt einen Betriebssystemdatenträger.

Name	Typ	Beschreibung
caching	CachingTypes	Ruft den Cachetyp ab.
diskRestorePoint	DiskRestorePointAttributes	Enthält Eigenschaften des Datenträgerwiederherstellungspunkts.
diskSizeGB	integer	Ruft die Datenträgergröße in GB ab.
encryptionSettings	DiskEncryptionSettings	Ruft die Datenträgerverschlüsselungseinstellungen ab.
managedDisk	ManagedDiskParameters	Ruft die Details des verwalteten Datenträgers ab.
name	string	Ruft den Datenträgernamen ab.
osType	OperatingSystemType	Ruft den Betriebssystemtyp ab.
writeAcceleratorEnabled	boolean	Zeigt "true" an, wenn der Datenträger schreibzugriffstasten aktiviert ist.

RestorePointSourceVMStorageProfile

Beschreibt das Speicherprofil.

Name	Typ	Beschreibung
dataDisks	RestorePointSourceVMDataDisk[]	Ruft die Datenträger der VM ab, die zum Zeitpunkt der Erstellung des Wiederherstellungspunkts erfasst wurden.
diskControllerType	DiskControllerTypes	Ruft den Datenträgercontrollertyp der VM ab, die zum Zeitpunkt der Erstellung des Wiederherstellungspunkts erfasst wurde.
osDisk	RestorePointSourceVMOSDisk	Ruft den Betriebssystemdatenträger des virtuellen Computers ab, der zum Zeitpunkt der Erstellung des Wiederherstellungspunkts erfasst wurde.

securityEncryptionTypes

Gibt den EncryptionType des verwalteten Datenträgers an. Es ist für die Verschlüsselung des verwalteten Datenträgers auf DiskWithVMGuestStateState festgelegt, vmGuestStateOnly für die Verschlüsselung nur des VMGuestState-Blobs und NonPersistedTPM, um den Firmwarestatus im VMGuestState-Blob nicht beizubehalten. Hinweis: Sie kann nur für vertrauliche virtuelle Computer festgelegt werden.

Name	Typ	Beschreibung
DiskWithVMGuestState	string
NonPersistedTPM	string
VMGuestStateOnly	string

SecurityProfile

Gibt die Sicherheitsprofileinstellungen für den Skalierungssatz des virtuellen Computers oder des virtuellen Computers an.

Name	Typ	Beschreibung
encryptionAtHost	boolean	Diese Eigenschaft kann vom Benutzer in der Anforderung verwendet werden, um die Hostverschlüsselung für den virtuellen Computer oder die Skalierungsgruppe des virtuellen Computers zu aktivieren oder zu deaktivieren. Dadurch wird die Verschlüsselung für alle Datenträger einschließlich Ressourcen-/Temp-Datenträger auf dem Host selbst aktiviert. Das Standardverhalten lautet: Die Verschlüsselung auf dem Host wird deaktiviert, es sei denn, diese Eigenschaft ist für die Ressource auf "true" festgelegt.
encryptionIdentity	EncryptionIdentity	Gibt die verwaltete Identität an, die von ADE zum Abrufen des Zugriffstokens für Keyvault-Vorgänge verwendet wird.
proxyAgentSettings	ProxyAgentSettings	Gibt proxyAgent-Einstellungen beim Erstellen des virtuellen Computers an. Mindest-API-Version: 2023-09-01.
securityType	SecurityTypes	Gibt den SecurityType des virtuellen Computers an. Sie muss auf einen beliebigen angegebenen Wert festgelegt werden, um UefiSettings zu aktivieren. Das Standardverhalten lautet: UefiSettings wird nur aktiviert, wenn diese Eigenschaft festgelegt ist.
uefiSettings	UefiSettings	Gibt die Sicherheitseinstellungen wie sicherer Start und vTPM an, die beim Erstellen des virtuellen Computers verwendet werden. Mindest-API-Version: 2020-12-01.

SecurityTypes

Gibt den SecurityType des virtuellen Computers an. Sie muss auf einen beliebigen angegebenen Wert festgelegt werden, um UefiSettings zu aktivieren. Das Standardverhalten lautet: UefiSettings wird nur aktiviert, wenn diese Eigenschaft festgelegt ist.

Name	Typ	Beschreibung
ConfidentialVM	string
TrustedLaunch	string

SettingNames

Gibt den Namen der Einstellung an, auf die der Inhalt angewendet wird. Mögliche Werte sind: FirstLogonCommands und AutoLogon.

Name	Typ	Beschreibung
AutoLogon	string
FirstLogonCommands	string

SshConfiguration

SSH-Konfiguration für linuxbasierte VMs, die auf Azure ausgeführt werden

Name	Typ	Beschreibung
publicKeys	SshPublicKey[]	Die Liste der öffentlichen SSH-Schlüssel, die für die Authentifizierung mit linuxbasierten VMs verwendet werden.

SshPublicKey

Enthält Informationen über den öffentlichen SSH-Zertifikatschlüssel und den Pfad auf der Linux-VM, auf der der öffentliche Schlüssel platziert wird.

Name	Typ	Beschreibung
keyData	string	SSH-Zertifikat für öffentliche Schlüssel, das für die Authentifizierung mit dem virtuellen Computer über ssh verwendet wird. Der Schlüssel muss mindestens 2048-Bit und im ssh-rsa-Format sein. Informationen zum Erstellen von SSH-Schlüsseln finden Sie unter [Erstellen von SSH-Schlüsseln unter Linux und Mac für Linux-VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).
path	string	Gibt den vollständigen Pfad auf der erstellten VM an, auf der ssh-öffentlicher Schlüssel gespeichert ist. Wenn die Datei bereits vorhanden ist, wird der angegebene Schlüssel an die Datei angefügt. Beispiel: /home/user/.ssh/authorized_keys

StatusLevelTypes

Der Ebenencode.

Name	Typ	Beschreibung
Error	string
Info	string
Warning	string

StorageAccountTypes

Gibt den Speicherkontotyp für den verwalteten Datenträger an. HINWEIS: UltraSSD_LRS nur mit Datenträgern verwendet werden kann, kann sie nicht mit Betriebssystemdatenträgern verwendet werden.

Name	Typ	Beschreibung
PremiumV2_LRS	string
Premium_LRS	string
Premium_ZRS	string
StandardSSD_LRS	string
StandardSSD_ZRS	string
Standard_LRS	string
UltraSSD_LRS	string

SubResource

Name	Typ	Beschreibung
id	string	Ressourcen-ID

UefiSettings

Gibt die Sicherheitseinstellungen wie sicherer Start und vTPM an, die beim Erstellen des virtuellen Computers verwendet werden. Mindest-API-Version: 2020-12-01.

Name	Typ	Beschreibung
secureBootEnabled	boolean	Gibt an, ob der sichere Start auf dem virtuellen Computer aktiviert werden soll. Mindest-API-Version: 2020-12-01.
vTpmEnabled	boolean	Gibt an, ob vTPM auf dem virtuellen Computer aktiviert werden soll. Mindest-API-Version: 2020-12-01.

VaultCertificate

Beschreibt einen einzelnen Zertifikatverweis in einem Key Vault und wo sich das Zertifikat auf dem virtuellen Computer befinden soll.

Name	Typ	Beschreibung
certificateStore	string	Gibt für Windows-VMs den Zertifikatspeicher auf dem virtuellen Computer an, dem das Zertifikat hinzugefügt werden soll. Der angegebene Zertifikatspeicher befindet sich implizit im LocalMachine-Konto. Für Linux-VMs wird die Zertifikatdatei unter dem Verzeichnis "/var/lib/waagent" platziert, wobei der Dateiname <"UppercaseThumbprint">.crt für die X509-Zertifikatdatei und <"UppercaseThumbprint">.prv für privaten Schlüssel. Beide Dateien sind PEM formatiert.
certificateUrl	string	Dies ist die URL eines Zertifikats, das als geheimer Schlüssel in den Key Vault hochgeladen wurde. Informationen zum Hinzufügen eines Geheimschlüssels zum Schlüsseltresor finden Sie unter Hinzufügen eines Schlüssels oder geheimen Schlüssels zum Schlüsseltresor. In diesem Fall muss Ihr Zertifikat die Base64-Codierung des folgenden JSON-Objekts sein, das in UTF-8 codiert ist: { "data":", "dataType":"pfx", "password":"" } Um Zertifikate auf einem virtuellen Computer zu installieren, empfiehlt es sich, die erweiterung des virtuellen Azure Key Vault-Computers für Linux oder die erweiterung des virtuellen Azure Key Vault-Computers für Windowszu verwenden.

VaultSecretGroup

Beschreibt eine Gruppe von Zertifikaten, die sich alle im selben Key Vault befinden.

Name	Typ	Beschreibung
sourceVault	SubResource	Die relative URL des Key Vault mit allen Zertifikaten in VaultCertificates.
vaultCertificates	VaultCertificate[]	Die Liste der Schlüsseltresorverweise in SourceVault, die Zertifikate enthalten.

VirtualMachineSizeTypes

Gibt die Größe des virtuellen Computers an. Der Enumerationsdatentyp ist derzeit veraltet und wird bis zum 23. Dezember 2023 entfernt. Die empfohlene Methode zum Abrufen der Liste der verfügbaren Größen ist die Verwendung dieser APIs: Auflisten aller verfügbaren Größe virtueller Computergrößen in einem Verfügbarkeitssatz, Auflisten aller verfügbaren größen virtueller Computer in einer Region, Auflisten aller verfügbaren Größen für virtuelle Computer zum Ändern der Größe. Weitere Informationen zu den Größen virtueller Computer finden Sie unter Größen für virtuelle Computer. Die verfügbaren VM-Größen sind von Region und Verfügbarkeitssatz abhängig.

Name	Typ	Beschreibung
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

Gibt die Sicherheitsprofileinstellungen für den verwalteten Datenträger an. Hinweis: Es kann nur für vertrauliche VMs festgelegt werden.

Name	Typ	Beschreibung
diskEncryptionSet	DiskEncryptionSetParameters	Gibt die Vom Kunden verwaltete Datenträgerverschlüsselungssatz-Ressourcen-ID für den verwalteten Datenträger an, der für den vom Kunden verwalteten Schlüssel verschlüsselter VertraulichVM-Betriebssystemdatenträger und vmGuest-Blob verwendet wird.
securityEncryptionType	securityEncryptionTypes	Gibt den EncryptionType des verwalteten Datenträgers an. Es ist für die Verschlüsselung des verwalteten Datenträgers auf DiskWithVMGuestStateState festgelegt, vmGuestStateOnly für die Verschlüsselung nur des VMGuestState-Blobs und NonPersistedTPM, um den Firmwarestatus im VMGuestState-Blob nicht beizubehalten. Hinweis: Sie kann nur für vertrauliche virtuelle Computer festgelegt werden.

VMSizeProperties

Gibt die Einstellungen der VM Size-Eigenschaft auf dem virtuellen Computer an.

Name	Typ	Beschreibung
vCPUsAvailable	integer	Gibt die Anzahl der für den virtuellen Computer verfügbaren vCPUs an. Wenn diese Eigenschaft nicht im Anforderungstext angegeben ist, ist das Standardverhalten, es auf den Wert von vCPUs festzulegen, der für diese VM-Größe verfügbar ist, die in api-Antwort von Auflisten aller verfügbaren virtuellen Computergrößen in einer Region.
vCPUsPerCore	integer	Gibt das vCPU-Verhältnis zum physischen Kernverhältnis an. Wenn diese Eigenschaft nicht im Anforderungstext angegeben ist, wird das Standardverhalten auf den Wert von vCPUsPerCore für die VM-Größe festgelegt, die in api-Antwort von Auflisten aller verfügbaren virtuellen Computergrößen in einer Region. Festlegen dieser Eigenschaft auf 1 bedeutet auch, dass Hyperthreading deaktiviert ist.

WindowsConfiguration

Gibt die Windows-Betriebssystemeinstellungen auf dem virtuellen Computer an.

Name	Typ	Beschreibung
additionalUnattendContent	AdditionalUnattendContent[]	Gibt zusätzliche base64-codierte XML-formatierte Informationen an, die in der Unattend.xml-Datei enthalten sein können, die von Windows Setup verwendet wird.
enableAutomaticUpdates	boolean	Gibt an, ob automatische Updates für den virtuellen Windows-Computer aktiviert sind. Der Standardwert ist true. Bei Skalierungssätzen für virtuelle Computer kann diese Eigenschaft aktualisiert werden, und Updates wirken sich auf die Erneute Bereitstellung des Betriebssystems aus.
enableVMAgentPlatformUpdates	boolean	Gibt an, ob VMAgent-Plattformupdates für den virtuellen Windows-Computer aktiviert sind.
patchSettings	PatchSettings	[Vorschaufeature] Gibt Einstellungen im Zusammenhang mit VM-Gastpatching unter Windows an.
provisionVMAgent	boolean	Gibt an, ob der Agent des virtuellen Computers auf dem virtuellen Computer bereitgestellt werden soll. Wenn diese Eigenschaft nicht im Anforderungstext angegeben ist, wird sie standardmäßig auf "true" festgelegt. Dadurch wird sichergestellt, dass der VM-Agent auf dem virtuellen Computer installiert ist, damit Erweiterungen später zur VM hinzugefügt werden können.
timeZone	string	Gibt die Zeitzone des virtuellen Computers an. z.B. "Pacific Standard Time". Mögliche Werte können TimeZoneInfo.Id Wert aus Zeitzonen sein, die von TimeZoneInfo.GetSystemTimeZoneszurückgegeben werden.
winRM	WinRMConfiguration	Gibt die Windows-Remoteverwaltungslistener an. Dies ermöglicht Remote-Windows PowerShell.

WindowsPatchAssessmentMode

Name	Typ	Beschreibung
AutomaticByPlatform	string
ImageDefault	string

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Gibt die Neustarteinstellung für alle AutomaticByPlatform-Patchinstallationsvorgänge an.

Name	Typ	Beschreibung
Always	string
IfRequired	string
Never	string
Unknown	string

WindowsVMGuestPatchAutomaticByPlatformSettings

Gibt zusätzliche Einstellungen an, die angewendet werden sollen, wenn der Patchmodus AutomaticByPlatform in den Windows-Patcheinstellungen ausgewählt ist.

Name	Typ	Beschreibung
bypassPlatformSafetyChecksOnUserSchedule	boolean	Ermöglicht es Kunden, Patching ohne versehentliche Upgrades zu planen
rebootSetting	WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Gibt die Neustarteinstellung für alle AutomaticByPlatform-Patchinstallationsvorgänge an.

WindowsVMGuestPatchMode

Gibt den Modus des VM-Gastpatchings auf iaaS-VM-Computer oder virtuelle Computer an, die mit orchestrationMode als flexibel verknüpft sind.

Mögliche Werte sind:

Manuelle – Sie steuern die Anwendung von Patches auf einen virtuellen Computer. Dazu wenden Sie Patches manuell innerhalb des virtuellen Computers an. In diesem Modus sind automatische Updates deaktiviert; die Eigenschaft "WindowsConfiguration.enableAutomaticUpdates" muss "false" sein.

AutomaticByOS- – Der virtuelle Computer wird automatisch vom Betriebssystem aktualisiert. Die Eigenschaft "WindowsConfiguration.enableAutomaticUpdates" muss "true" sein.

AutomaticByPlatform – der virtuelle Computer wird automatisch von der Plattform aktualisiert. Die Eigenschaften provisionVMAgent und WindowsConfiguration.enableAutomaticUpdates müssen true sein.

Name	Typ	Beschreibung
AutomaticByOS	string
AutomaticByPlatform	string
Manual	string

WinRMConfiguration

Beschreibt die Konfiguration der Windows-Remoteverwaltung des virtuellen Computers

Name	Typ	Beschreibung
listeners	WinRMListener[]	Die Liste der Windows-Remoteverwaltungslistener

WinRMListener

Beschreibt Protokoll und Fingerabdruck des Windows-Remoteverwaltungslisteners

Name	Typ	Beschreibung
certificateUrl	string	Dies ist die URL eines Zertifikats, das als geheimer Schlüssel in den Key Vault hochgeladen wurde. Informationen zum Hinzufügen eines Geheimschlüssels zum Schlüsseltresor finden Sie unter Hinzufügen eines Schlüssels oder geheimen Schlüssels zum Schlüsseltresor. In diesem Fall muss Ihr Zertifikat die Base64-Codierung des folgenden JSON-Objekts sein, das in UTF-8 codiert ist: { "data":", "dataType":"pfx", "password":"" } Um Zertifikate auf einem virtuellen Computer zu installieren, empfiehlt es sich, die erweiterung des virtuellen Azure Key Vault-Computers für Linux oder die erweiterung des virtuellen Azure Key Vault-Computers für Windowszu verwenden.
protocol	ProtocolTypes	Gibt das Protokoll des WinRM-Listeners an. Mögliche Werte sind: http,https.

Freigeben über

Restore Point Collections - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

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

Beispielanforderung

Beispiel für eine Antwort

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

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AdditionalUnattendContent

ApiEntityReference

ApiError

ApiErrorBase

BootDiagnostics

CachingTypes

CloudError

ComponentNames

ConsistencyModeTypes

DiagnosticsProfile

DiskControllerTypes

DiskEncryptionSetParameters

DiskEncryptionSettings

DiskRestorePointAttributes

DiskRestorePointInstanceView

DiskRestorePointReplicationStatus

EncryptionIdentity

HardwareProfile

HyperVGenerationTypes

InnerError

InstanceViewStatus

KeyVaultKeyReference

KeyVaultSecretReference

LinuxConfiguration

LinuxPatchAssessmentMode

LinuxPatchSettings

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

LinuxVMGuestPatchAutomaticByPlatformSettings

LinuxVMGuestPatchMode

ManagedDiskParameters

Mode

OperatingSystemType

OSProfile

PassNames

PatchSettings

ProtocolTypes

ProxyAgentSettings

RestorePoint

RestorePointCollection

RestorePointCollectionExpandOptions

RestorePointCollectionSourceProperties

RestorePointEncryption

RestorePointEncryptionType

RestorePointInstanceView

RestorePointSourceMetadata

RestorePointSourceVMDataDisk

RestorePointSourceVMOSDisk

RestorePointSourceVMStorageProfile

securityEncryptionTypes

SecurityProfile

SecurityTypes

SettingNames

SshConfiguration

SshPublicKey

StatusLevelTypes

StorageAccountTypes

SubResource

UefiSettings

VaultCertificate

VaultSecretGroup

VirtualMachineSizeTypes

VMDiskSecurityProfile

VMSizeProperties

WindowsConfiguration

WindowsPatchAssessmentMode