Restore Point Collections - Get

Referentie

Service:: Compute

API-versie:: 2024-07-01

De bewerking voor het ophalen van de verzameling herstelpunten.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep.
restorePointCollectionName	path	True	string	De naam van de verzameling herstelpunten.
subscriptionId	path	True	string	Abonnementsreferenties die het Microsoft Azure-abonnement uniek identificeren. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
api-version	query	True	string	Client-API-versie.
$expand	query		RestorePointCollectionExpandOptions	De uitvouwexpressie die moet worden toegepast op de bewerking. Als expand=restorePoints, retourneert de server alle ingesloten herstelpunten in de restorePointCollection.

Antwoorden

Name	Type	Description
200 OK	RestorePointCollection	OK
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

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

Voorbeeldaanvraag

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/d6d0798c6f5eb196fba7bd1924db2b145a94f58c/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");
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/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

Voorbeeldrespons

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)

Voorbeeldaanvraag

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/d6d0798c6f5eb196fba7bd1924db2b145a94f58c/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");
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/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

Voorbeeldrespons

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"
  }
}

Definities

Name	Description
AdditionalUnattendContent	Hiermee geeft u aanvullende XML-opgemaakte informatie op die kan worden opgenomen in het Unattend.xml-bestand, dat wordt gebruikt door Windows Setup. De inhoud wordt gedefinieerd door de naam van de instelling, de onderdeelnaam en de pass waarin de inhoud wordt toegepast.
ApiEntityReference	De API-entiteitsreferentie.
ApiError	Api-fout.
ApiErrorBase	Api-foutbasis.
BootDiagnostics	Diagnostische gegevens over opstarten is een functie voor foutopsporing waarmee u console-uitvoer en schermopname kunt bekijken om de VM-status te diagnosticeren. U kunt eenvoudig de uitvoer van uw consolelogboek bekijken. Met Azure kunt u ook een schermopname van de virtuele machine bekijken vanuit de hypervisor.
CachingTypes	Hiermee haalt u het cachetype op.
CloudError	Een foutreactie van de Compute-service.
ComponentNames	De naam van het onderdeel. Momenteel is de enige toegestane waarde Microsoft-Windows-Shell-Setup.
ConsistencyModeTypes	ConsistencyMode van het RestorePoint. Kan worden opgegeven in de invoer tijdens het maken van een herstelpunt. Voorlopig wordt alleen CrashConsistent geaccepteerd als een geldige invoer. Raadpleeg https://aka.ms/RestorePoints voor meer informatie.
DiagnosticsProfile	Hiermee geeft u de status van diagnostische instellingen voor opstarten. Minimale API-versie: 2015-06-15.
DiskControllerTypes	Hiermee haalt u het type schijfcontroller op van de virtuele machine die is vastgelegd op het moment dat het herstelpunt is gemaakt.
DiskEncryptionSetParameters	Beschrijft de parameter van de resource-id van de door de klant beheerde schijfversleutelingsset die kan worden opgegeven voor schijf. Opmerking: de resource-id van de schijfversleutelingsset kan alleen worden opgegeven voor beheerde schijven. Raadpleeg https://aka.ms/mdssewithcmkoverview voor meer informatie.
DiskEncryptionSettings	Beschrijft een versleutelingsinstellingen voor een schijf
DiskRestorePointAttributes	Details van schijfherstelpunt.
DiskRestorePointInstanceView	De exemplaarweergave van een schijfherstelpunt.
DiskRestorePointReplicationStatus	De exemplaarweergave van een schijfherstelpunt.
EncryptionIdentity	Hiermee geeft u de beheerde identiteit op die door ADE wordt gebruikt om toegangstoken op te halen voor sleutelkluisbewerkingen.
HardwareProfile	Hiermee geeft u de hardware-instellingen voor de virtuele machine.
HyperVGenerationTypes	HyperVGeneratie van de bron-VM waarvoor het herstelpunt wordt vastgelegd.
InnerError	Interne foutdetails.
InstanceViewStatus	Status van exemplaarweergave.
KeyVaultKeyReference	Beschrijft een verwijzing naar Key Vault-sleutel
KeyVaultSecretReference	Beschrijft een verwijzing naar Key Vault-geheim
LinuxConfiguration	Hiermee geeft u de linux-besturingssysteeminstellingen op de virtuele machine. Zie Linux op Azure-Endorsed Distributiesvoor een lijst met ondersteunde Linux-distributies.
LinuxPatchAssessmentMode	Hiermee geeft u de modus van vm-gastpatchevaluatie voor de virtuele IaaS-machine. Mogelijke waarden zijn: ImageDefault-: u bepaalt de timing van patchevaluaties op een virtuele machine. AutomaticByPlatform - Het platform activeert periodieke patchevaluaties. De eigenschap provisionVMAgent moet waar zijn.
LinuxPatchSettings	Hiermee geeft u instellingen met betrekking tot VM-gastpatching op Linux.
LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Hiermee geeft u de instelling voor opnieuw opstarten voor alle installatiebewerkingen van de AutomaticByPlatform-patch.
LinuxVMGuestPatchAutomaticByPlatformSettings	Hiermee geeft u aanvullende instellingen op die moeten worden toegepast wanneer de patchmodus AutomaticByPlatform is geselecteerd in de Instellingen voor Linux-patches.
LinuxVMGuestPatchMode	Hiermee geeft u de modus van VM-gastpatching naar virtuele IaaS-machine of virtuele machines die zijn gekoppeld aan virtuele-machineschaalset met OrchestrationMode als Flexibel. Mogelijke waarden zijn: ImageDefault-: de standaardpatchconfiguratie van de virtuele machine wordt gebruikt. AutomaticByPlatform : de virtuele machine wordt automatisch bijgewerkt door het platform. De eigenschap provisionVMAgent moet waar zijn
ManagedDiskParameters	De parameters van een beheerde schijf.
Mode	Hiermee geeft u de modus op waarop ProxyAgent wordt uitgevoerd als de functie is ingeschakeld. ProxyAgent begint met controleren of bewaken, maar dwingt geen toegangsbeheer af over aanvragen voor hosteindpunten in de controlemodus, terwijl in de modus Afdwingen het toegangsbeheer wordt afgedwongen. De standaardwaarde is de modus Afdwingen.
OperatingSystemType	Hiermee haalt u het type besturingssysteem op.
OSProfile	Hiermee geeft u de besturingssysteeminstellingen voor de virtuele machine. Sommige instellingen kunnen niet worden gewijzigd zodra de VIRTUELE machine is ingericht.
PassNames	De wachtwoordnaam. Momenteel is de enige toegestane waarde OobeSystem.
PatchSettings	Hiermee geeft u instellingen met betrekking tot VM-gastpatching in Windows.
ProtocolTypes	Hiermee geeft u het protocol van WinRM-listener. Mogelijke waarden zijn: http,https.
ProxyAgentSettings	Hiermee geeft u ProxyAgent-instellingen op tijdens het maken van de virtuele machine. Minimale API-versie: 2023-09-01.
RestorePoint	Details van herstelpunt.
RestorePointCollection	Parameters voor het verzamelen van herstelpunten maken of bijwerken.
RestorePointCollectionExpandOptions	De uitvouwexpressie die moet worden toegepast op de bewerking. Als expand=restorePoints, retourneert de server alle ingesloten herstelpunten in de restorePointCollection.
RestorePointCollectionSourceProperties	De eigenschappen van de bronresource waaruit deze verzameling herstelpunten is gemaakt.
RestorePointEncryption	Versleuteling-at-rest-instellingen voor schijfherstelpunt. Het is een optionele eigenschap die kan worden opgegeven in de invoer tijdens het maken van een herstelpunt.
RestorePointEncryptionType	Het type sleutel dat wordt gebruikt voor het versleutelen van de gegevens van het schijfherstelpunt.
RestorePointInstanceView	De exemplaarweergave van een herstelpunt.
RestorePointSourceMetadata	Beschrijft de eigenschappen van de virtuele machine waarvoor het herstelpunt is gemaakt. De opgegeven eigenschappen zijn een subset en de momentopname van de algemene eigenschappen van de virtuele machine die zijn vastgelegd op het moment dat het herstelpunt is gemaakt.
RestorePointSourceVMDataDisk	Beschrijft een gegevensschijf.
RestorePointSourceVMOSDisk	Beschrijft een besturingssysteemschijf.
RestorePointSourceVMStorageProfile	Beschrijft het opslagprofiel.
securityEncryptionTypes	Hiermee geeft u het EncryptionType van de beheerde schijf. Deze is ingesteld op DiskWithVMGuestState voor versleuteling van de beheerde schijf, samen met VMGuestState-blob, VMGuestStateOnly voor versleuteling van alleen de VMGuestState-blob en NonPersistedTPM voor het niet behouden van de firmwarestatus in de VMGuestState-blob.. Opmerking: Deze kan alleen worden ingesteld voor vertrouwelijke VM's.
SecurityProfile	Hiermee geeft u de beveiligingsprofielinstellingen voor de virtuele machine of virtuele-machineschaalset op.
SecurityTypes	Hiermee geeft u het SecurityType van de virtuele machine. Deze moet worden ingesteld op een opgegeven waarde om UefiSettings in te schakelen. Het standaardgedrag is: UefiSettings wordt niet ingeschakeld, tenzij deze eigenschap is ingesteld.
SettingNames	Hiermee geeft u de naam op van de instelling waarop de inhoud van toepassing is. Mogelijke waarden zijn: FirstLogonCommands en AutoLogon.
SshConfiguration	SSH-configuratie voor op Linux gebaseerde VM's die worden uitgevoerd in Azure
SshPublicKey	Bevat informatie over de openbare SSH-certificaatsleutel en het pad op de Virtuele Linux-machine waarop de openbare sleutel wordt geplaatst.
StatusLevelTypes	De niveaucode.
StorageAccountTypes	Hiermee geeft u het type opslagaccount voor de beheerde schijf. OPMERKING: UltraSSD_LRS kan alleen worden gebruikt met gegevensschijven, deze kan niet worden gebruikt met besturingssysteemschijf.
SubResource
UefiSettings	Hiermee geeft u de beveiligingsinstellingen op, zoals beveiligd opstarten en vTPM die worden gebruikt tijdens het maken van de virtuele machine. Minimale API-versie: 2020-12-01.
VaultCertificate	Beschrijft één certificaatverwijzing in een Sleutelkluis en waar het certificaat zich op de virtuele machine moet bevinden.
VaultSecretGroup	Beschrijft een set certificaten die zich allemaal in dezelfde Key Vault bevinden.
VirtualMachineSizeTypes	Hiermee geeft u de grootte van de virtuele machine. Het enum-gegevenstype is momenteel afgeschaft en wordt op 23 december 2023 verwijderd. De aanbevolen manier om de lijst met beschikbare grootten op te halen, is met behulp van deze API's: Alle beschikbare grootten van virtuele machines in een beschikbaarheidsset weergeven, Alle beschikbare grootten van virtuele machines in een regio weergeven, Alle beschikbare grootten van virtuele machines weergeven voor het wijzigen van de grootte van. Zie Grootten voor virtuele machinesvoor meer informatie over de grootte van virtuele machines. De beschikbare VM-grootten zijn afhankelijk van de regio en beschikbaarheidsset.
VMDiskSecurityProfile	Hiermee geeft u de beveiligingsprofielinstellingen voor de beheerde schijf. Opmerking: Deze kan alleen worden ingesteld voor vertrouwelijke VM's.
VMSizeProperties	Hiermee geeft u de instellingen voor de eigenschap VM-grootte op de virtuele machine.
WindowsConfiguration	Hiermee geeft u windows-besturingssysteeminstellingen op de virtuele machine.
WindowsPatchAssessmentMode	Hiermee geeft u de modus van vm-gastpatchevaluatie voor de virtuele IaaS-machine. Mogelijke waarden zijn: ImageDefault-: u bepaalt de timing van patchevaluaties op een virtuele machine. AutomaticByPlatform - Het platform activeert periodieke patchevaluaties. De eigenschap provisionVMAgent moet waar zijn.
WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Hiermee geeft u de instelling voor opnieuw opstarten voor alle installatiebewerkingen van de AutomaticByPlatform-patch.
WindowsVMGuestPatchAutomaticByPlatformSettings	Hiermee geeft u aanvullende instellingen op die moeten worden toegepast wanneer de patchmodus AutomaticByPlatform is geselecteerd in de Windows-patchinstellingen.
WindowsVMGuestPatchMode	Hiermee geeft u de modus van VM-gastpatching naar virtuele IaaS-machine of virtuele machines die zijn gekoppeld aan virtuele-machineschaalset met OrchestrationMode als Flexibel. Mogelijke waarden zijn: Handmatige: u beheert de toepassing van patches op een virtuele machine. U doet dit door patches handmatig toe te passen in de VIRTUELE machine. In deze modus worden automatische updates uitgeschakeld; de eigenschap WindowsConfiguration.enableAutomaticUpdates moet onwaar zijn AutomaticByOS-: de virtuele machine wordt automatisch bijgewerkt door het besturingssysteem. De eigenschap WindowsConfiguration.enableAutomaticUpdates moet waar zijn. AutomaticByPlatform: de virtuele machine wordt automatisch bijgewerkt door het platform. De eigenschappen provisionVMAgent en WindowsConfiguration.enableAutomaticUpdates moeten waar zijn
WinRMConfiguration	Hierin wordt de configuratie van Windows Remote Management van de VM beschreven
WinRMListener	Beschrijft protocol en vingerafdruk van Windows Remote Management-listener

AdditionalUnattendContent

Object

Hiermee geeft u aanvullende XML-opgemaakte informatie op die kan worden opgenomen in het Unattend.xml-bestand, dat wordt gebruikt door Windows Setup. De inhoud wordt gedefinieerd door de naam van de instelling, de onderdeelnaam en de pass waarin de inhoud wordt toegepast.

Name	Type	Description
componentName	ComponentNames	De naam van het onderdeel. Momenteel is de enige toegestane waarde Microsoft-Windows-Shell-Setup.
content	string	Hiermee geeft u de xml-opgemaakte inhoud op die wordt toegevoegd aan het unattend.xml-bestand voor het opgegeven pad en het opgegeven onderdeel. De XML moet kleiner zijn dan 4 kB en moet het hoofdelement bevatten voor de instelling of functie die wordt ingevoegd.
passName	PassNames	De wachtwoordnaam. Momenteel is de enige toegestane waarde OobeSystem.
settingName	SettingNames	Hiermee geeft u de naam op van de instelling waarop de inhoud van toepassing is. Mogelijke waarden zijn: FirstLogonCommands en AutoLogon.

ApiEntityReference

Object

De API-entiteitsreferentie.

Name	Type	Description
id	string	De ARM-resource-id in de vorm van /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Object

Api-fout.

Name	Type	Description
code	string	De foutcode.
details	ApiErrorBase[]	Details van de API-fout
innererror	InnerError	De interne API-fout
message	string	Het foutbericht.
target	string	Het doel van de specifieke fout.

ApiErrorBase

Object

Api-foutbasis.

Name	Type	Description
code	string	De foutcode.
message	string	Het foutbericht.
target	string	Het doel van de specifieke fout.

BootDiagnostics

Object

Diagnostische gegevens over opstarten is een functie voor foutopsporing waarmee u console-uitvoer en schermopname kunt bekijken om de VM-status te diagnosticeren. U kunt eenvoudig de uitvoer van uw consolelogboek bekijken. Met Azure kunt u ook een schermopname van de virtuele machine bekijken vanuit de hypervisor.

Name	Type	Description
enabled	boolean	Of diagnostische gegevens over opstarten moeten worden ingeschakeld op de virtuele machine.
storageUri	string	Uri van het opslagaccount dat moet worden gebruikt voor het plaatsen van de console-uitvoer en schermopname. Als storageUri niet is opgegeven tijdens het inschakelen van diagnostische gegevens over opstarten, wordt beheerde opslag gebruikt.

CachingTypes

Inventarisatie

Hiermee haalt u het cachetype op.

Waarde	Description
None
ReadOnly
ReadWrite

CloudError

Object

Een foutreactie van de Compute-service.

Name	Type	Description
error	ApiError	Api-fout.

ComponentNames

Inventarisatie

De naam van het onderdeel. Momenteel is de enige toegestane waarde Microsoft-Windows-Shell-Setup.

Waarde	Description
Microsoft-Windows-Shell-Setup

ConsistencyModeTypes

Inventarisatie

ConsistencyMode van het RestorePoint. Kan worden opgegeven in de invoer tijdens het maken van een herstelpunt. Voorlopig wordt alleen CrashConsistent geaccepteerd als een geldige invoer. Raadpleeg https://aka.ms/RestorePoints voor meer informatie.

Waarde	Description
ApplicationConsistent
CrashConsistent
FileSystemConsistent

DiagnosticsProfile

Object

Hiermee geeft u de status van diagnostische instellingen voor opstarten. Minimale API-versie: 2015-06-15.

Name	Type	Description
bootDiagnostics	BootDiagnostics	Diagnostische gegevens over opstarten is een functie voor foutopsporing waarmee u console-uitvoer en schermopname kunt bekijken om de VM-status te diagnosticeren. OPMERKING: als storageUri wordt opgegeven, moet u ervoor zorgen dat het opslagaccount zich in dezelfde regio en hetzelfde abonnement bevindt als de virtuele machine. U kunt eenvoudig de uitvoer van uw consolelogboek bekijken. Met Azure kunt u ook een schermopname van de virtuele machine bekijken vanuit de hypervisor.

DiskControllerTypes

Inventarisatie

Hiermee haalt u het type schijfcontroller op van de virtuele machine die is vastgelegd op het moment dat het herstelpunt is gemaakt.

Waarde	Description
NVMe
SCSI

DiskEncryptionSetParameters

Object

Beschrijft de parameter van de resource-id van de door de klant beheerde schijfversleutelingsset die kan worden opgegeven voor schijf. Opmerking: de resource-id van de schijfversleutelingsset kan alleen worden opgegeven voor beheerde schijven. Raadpleeg https://aka.ms/mdssewithcmkoverview voor meer informatie.

Name	Type	Description
id	string	Resource-id

DiskEncryptionSettings

Object

Beschrijft een versleutelingsinstellingen voor een schijf

Name	Type	Description
diskEncryptionKey	KeyVaultSecretReference	Hiermee geeft u de locatie van de schijfversleutelingssleutel, een Sleutelkluisgeheim.
enabled	boolean	Hiermee geeft u op of schijfversleuteling moet worden ingeschakeld op de virtuele machine.
keyEncryptionKey	KeyVaultKeyReference	Hiermee geeft u de locatie van de sleutelversleutelingssleutel in Key Vault.

DiskRestorePointAttributes

Object

Details van schijfherstelpunt.

Name	Type	Description
encryption	RestorePointEncryption	Versleuteling-at-rest-instellingen voor schijfherstelpunt. Het is een optionele eigenschap die kan worden opgegeven in de invoer tijdens het maken van een herstelpunt.
id	string	Resource-id
sourceDiskRestorePoint	ApiEntityReference	Resource-id van het herstelpunt van de bronschijf.

DiskRestorePointInstanceView

Object

De exemplaarweergave van een schijfherstelpunt.

Name	Type	Description
id	string	Schijfherstelpunt-id.
replicationStatus	DiskRestorePointReplicationStatus	Informatie over de replicatiestatus van het schijfherstelpunt.

DiskRestorePointReplicationStatus

Object

De exemplaarweergave van een schijfherstelpunt.

Name	Type	Description
completionPercent	integer (int32)	Voltooiingspercentage van replicatie.
status	InstanceViewStatus	De informatie over de resourcestatus.

EncryptionIdentity

Object

Hiermee geeft u de beheerde identiteit op die door ADE wordt gebruikt om toegangstoken op te halen voor sleutelkluisbewerkingen.

Name	Type	Description
userAssignedIdentityResourceId	string	Hiermee geeft u de ARM-resource-id op van een van de gebruikersidentiteiten die zijn gekoppeld aan de virtuele machine.

HardwareProfile

Object

Hiermee geeft u de hardware-instellingen voor de virtuele machine.

Name	Type	Description
vmSize	VirtualMachineSizeTypes	Hiermee geeft u de grootte van de virtuele machine. Het enum-gegevenstype is momenteel afgeschaft en wordt op 23 december 2023 verwijderd. De aanbevolen manier om de lijst met beschikbare grootten op te halen, is met behulp van deze API's: Alle beschikbare grootten van virtuele machines in een beschikbaarheidsset weergeven, Alle beschikbare grootten van virtuele machines in een regio weergeven, Alle beschikbare grootten van virtuele machines weergeven voor het wijzigen van de grootte van. Zie Grootten voor virtuele machinesvoor meer informatie over de grootte van virtuele machines. De beschikbare VM-grootten zijn afhankelijk van de regio en beschikbaarheidsset.
vmSizeProperties	VMSizeProperties	Hiermee geeft u de eigenschappen voor het aanpassen van de grootte van de virtuele machine. Minimale API-versie: 2021-07-01. Deze functie bevindt zich nog steeds in de preview-modus en wordt niet ondersteund voor VirtualMachineScaleSet. Volg de instructies in VM-aanpassing voor meer informatie.

HyperVGenerationTypes

Inventarisatie

HyperVGeneratie van de bron-VM waarvoor het herstelpunt wordt vastgelegd.

Waarde	Description
V1
V2

InnerError

Object

Interne foutdetails.

Name	Type	Description
errordetail	string	Het interne foutbericht of de uitzonderingsdump.
exceptiontype	string	Het uitzonderingstype.

InstanceViewStatus

Object

Status van exemplaarweergave.

Name	Type	Description
code	string	De statuscode.
displayStatus	string	Het korte lokaliseerbare label voor de status.
level	StatusLevelTypes	De niveaucode.
message	string	Het gedetailleerde statusbericht, inclusief voor waarschuwingen en foutberichten.
time	string (date-time)	Het tijdstip van de status.

KeyVaultKeyReference

Object

Beschrijft een verwijzing naar Key Vault-sleutel

Name	Type	Description
keyUrl	string	De URL die verwijst naar een sleutelversleutelingssleutel in Key Vault.
sourceVault	SubResource	De relatieve URL van de sleutelkluis die de sleutel bevat.

KeyVaultSecretReference

Object

Beschrijft een verwijzing naar Key Vault-geheim

Name	Type	Description
secretUrl	string	De URL die verwijst naar een geheim in een Sleutelkluis.
sourceVault	SubResource	De relatieve URL van de sleutelkluis die het geheim bevat.

LinuxConfiguration

Object

Hiermee geeft u de linux-besturingssysteeminstellingen op de virtuele machine. Zie Linux op Azure-Endorsed Distributiesvoor een lijst met ondersteunde Linux-distributies.

Name	Type	Description
disablePasswordAuthentication	boolean	Hiermee geeft u op of wachtwoordverificatie moet worden uitgeschakeld.
enableVMAgentPlatformUpdates	boolean	Geeft aan of VMAgent-platformupdates zijn ingeschakeld voor de virtuele Linux-machine. De standaardwaarde is onwaar.
patchSettings	LinuxPatchSettings	[Preview-functie] Hiermee geeft u instellingen met betrekking tot VM-gastpatching op Linux.
provisionVMAgent	boolean	Hiermee wordt aangegeven of de virtuele-machineagent moet worden ingericht op de virtuele machine. Wanneer deze eigenschap niet is opgegeven in de hoofdtekst van de aanvraag, is het standaardgedrag ingesteld op waar. Dit zorgt ervoor dat de VM-agent op de VIRTUELE machine is geïnstalleerd, zodat extensies later aan de VIRTUELE machine kunnen worden toegevoegd.
ssh	SshConfiguration	Hiermee geeft u de ssh-sleutelconfiguratie voor een Linux-besturingssysteem.

LinuxPatchAssessmentMode

Inventarisatie

Hiermee geeft u de modus van vm-gastpatchevaluatie voor de virtuele IaaS-machine.

Mogelijke waarden zijn:

ImageDefault-: u bepaalt de timing van patchevaluaties op een virtuele machine.

AutomaticByPlatform - Het platform activeert periodieke patchevaluaties. De eigenschap provisionVMAgent moet waar zijn.

Waarde	Description
AutomaticByPlatform
ImageDefault

LinuxPatchSettings

Object

Hiermee geeft u instellingen met betrekking tot VM-gastpatching op Linux.

Name	Type	Description
assessmentMode	LinuxPatchAssessmentMode	Hiermee geeft u de modus van vm-gastpatchevaluatie voor de virtuele IaaS-machine. Mogelijke waarden zijn: ImageDefault-: u bepaalt de timing van patchevaluaties op een virtuele machine. AutomaticByPlatform - Het platform activeert periodieke patchevaluaties. De eigenschap provisionVMAgent moet waar zijn.
automaticByPlatformSettings	LinuxVMGuestPatchAutomaticByPlatformSettings	Hiermee geeft u aanvullende instellingen voor patchmodus AutomaticByPlatform in VM-gastpatching op Linux.
patchMode	LinuxVMGuestPatchMode	Hiermee geeft u de modus van VM-gastpatching naar virtuele IaaS-machine of virtuele machines die zijn gekoppeld aan virtuele-machineschaalset met OrchestrationMode als Flexibel. Mogelijke waarden zijn: ImageDefault-: de standaardpatchconfiguratie van de virtuele machine wordt gebruikt. AutomaticByPlatform : de virtuele machine wordt automatisch bijgewerkt door het platform. De eigenschap provisionVMAgent moet waar zijn

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Inventarisatie

Hiermee geeft u de instelling voor opnieuw opstarten voor alle installatiebewerkingen van de AutomaticByPlatform-patch.

Waarde	Description
Always
IfRequired
Never
Unknown

LinuxVMGuestPatchAutomaticByPlatformSettings

Object

Hiermee geeft u aanvullende instellingen op die moeten worden toegepast wanneer de patchmodus AutomaticByPlatform is geselecteerd in de Instellingen voor Linux-patches.

Name	Type	Description
bypassPlatformSafetyChecksOnUserSchedule	boolean	Stelt de klant in staat patches te plannen zonder onbedoelde upgrades
rebootSetting	LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Hiermee geeft u de instelling voor opnieuw opstarten voor alle installatiebewerkingen van de AutomaticByPlatform-patch.

LinuxVMGuestPatchMode

Inventarisatie

Hiermee geeft u de modus van VM-gastpatching naar virtuele IaaS-machine of virtuele machines die zijn gekoppeld aan virtuele-machineschaalset met OrchestrationMode als Flexibel.

Mogelijke waarden zijn:

ImageDefault-: de standaardpatchconfiguratie van de virtuele machine wordt gebruikt.

AutomaticByPlatform : de virtuele machine wordt automatisch bijgewerkt door het platform. De eigenschap provisionVMAgent moet waar zijn

Waarde	Description
AutomaticByPlatform
ImageDefault

ManagedDiskParameters

Object

De parameters van een beheerde schijf.

Name	Type	Description
diskEncryptionSet	DiskEncryptionSetParameters	Hiermee geeft u de resource-id van de door de klant beheerde schijfversleutelingsset voor de beheerde schijf op.
id	string	Resource-id
securityProfile	VMDiskSecurityProfile	Hiermee geeft u het beveiligingsprofiel voor de beheerde schijf.
storageAccountType	StorageAccountTypes	Hiermee geeft u het type opslagaccount voor de beheerde schijf. OPMERKING: UltraSSD_LRS kan alleen worden gebruikt met gegevensschijven, deze kan niet worden gebruikt met besturingssysteemschijf.

Mode

Inventarisatie

Hiermee geeft u de modus op waarop ProxyAgent wordt uitgevoerd als de functie is ingeschakeld. ProxyAgent begint met controleren of bewaken, maar dwingt geen toegangsbeheer af over aanvragen voor hosteindpunten in de controlemodus, terwijl in de modus Afdwingen het toegangsbeheer wordt afgedwongen. De standaardwaarde is de modus Afdwingen.

Waarde	Description
Audit
Enforce

OperatingSystemType

Inventarisatie

Hiermee haalt u het type besturingssysteem op.

Waarde	Description
Linux
Windows

OSProfile

Object

Hiermee geeft u de besturingssysteeminstellingen voor de virtuele machine. Sommige instellingen kunnen niet worden gewijzigd zodra de VIRTUELE machine is ingericht.

Name	Type	Description
adminPassword	string	Hiermee geeft u het wachtwoord van het beheerdersaccount. Minimale lengte (Windows): 8 tekens Minimale lengte (Linux): 6 tekens Maximale lengte (Windows): 123 tekens Maximale lengte (Linux): 72 tekens Complexiteitsvereisten: aan 3 van de 4 onderstaande voorwaarden moet worden voldaan Heeft lagere tekens Bevat bovenliggende tekens Heeft een cijfer Heeft een speciaal teken (Regex-overeenkomst [\W_]) Niet-toegestane waarden: "abc@123", "P@$$w 0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Wachtwoord!", "Wachtwoord1", "Wachtwoord22", "iloveyou!" Zie De extern bureaublad-service of het aanmeldingswachtwoord opnieuw instellen in een Windows-VM voor het opnieuw instellen van het wachtwoord. Zie Gebruikers, SSH beheren en schijven controleren of herstellen op virtuele Azure Linux-machines met behulp van de VMAccess-extensie voor het opnieuw instellen van het hoofdwachtwoord
adminUsername	string	Hiermee geeft u de naam van het beheerdersaccount. Deze eigenschap kan niet worden bijgewerkt nadat de virtuele machine is gemaakt. beperking voor alleen Windows: kan niet eindigen op '.' niet-toegestane waarden: '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". Minimale lengte (Linux): 1 teken Maximale lengte (Linux): 64 tekens Maximale lengte (Windows): 20 tekens.
allowExtensionOperations	boolean	Hiermee geeft u op of uitbreidingsbewerkingen moeten worden toegestaan op de virtuele machine. Dit kan alleen worden ingesteld op False wanneer er geen extensies aanwezig zijn op de virtuele machine.
computerName	string	Hiermee geeft u de naam van het host-besturingssysteem van de virtuele machine. Deze naam kan niet worden bijgewerkt nadat de virtuele machine is gemaakt. Maximale lengte (Windows): 15 tekens. Maximale lengte (Linux): 64 tekens. Zie implementatierichtlijnen voor Azure-infrastructuurservicesvoor naamconventies en -beperkingen.
customData	string	Hiermee geeft u een met base 64 gecodeerde tekenreeks van aangepaste gegevens op. De met base 64 gecodeerde tekenreeks wordt gedecodeerd naar een binaire matrix die wordt opgeslagen als een bestand op de virtuele machine. De maximale lengte van de binaire matrix is 65535 bytes. Opmerking: geef geen geheimen of wachtwoorden door in de eigenschap customData. Deze eigenschap kan niet worden bijgewerkt nadat de virtuele machine is gemaakt. De eigenschap 'customData' wordt doorgegeven aan de virtuele machine die als bestand moet worden opgeslagen. Zie Aangepaste gegevens op Virtuele Azure-machinesvoor meer informatie. Zie Cloud-init gebruiken om een Virtuele Linux-machine aan te passen tijdens het maken vanvoor het gebruik van cloud-init.
linuxConfiguration	LinuxConfiguration	Hiermee geeft u de linux-besturingssysteeminstellingen op de virtuele machine. Zie Linux op Azure-Endorsed Distributiesvoor een lijst met ondersteunde Linux-distributies.
requireGuestProvisionSignal	boolean	Optionele eigenschap die moet worden ingesteld op Waar of weggelaten.
secrets	VaultSecretGroup[]	Hiermee geeft u een set certificaten op die op de virtuele machine moeten worden geïnstalleerd. Als u certificaten op een virtuele machine wilt installeren, wordt u aangeraden de extensie van de virtuele Azure Key Vault-machine voor Linux- of de virtuele Machine-extensie van Azure Key Vault voor Windowste gebruiken.
windowsConfiguration	WindowsConfiguration	Hiermee geeft u windows-besturingssysteeminstellingen op de virtuele machine.

PassNames

Inventarisatie

De wachtwoordnaam. Momenteel is de enige toegestane waarde OobeSystem.

Waarde	Description
OobeSystem

PatchSettings

Object

Hiermee geeft u instellingen met betrekking tot VM-gastpatching in Windows.

Name	Type	Description
assessmentMode	WindowsPatchAssessmentMode	Hiermee geeft u de modus van vm-gastpatchevaluatie voor de virtuele IaaS-machine. Mogelijke waarden zijn: ImageDefault-: u bepaalt de timing van patchevaluaties op een virtuele machine. AutomaticByPlatform - Het platform activeert periodieke patchevaluaties. De eigenschap provisionVMAgent moet waar zijn.
automaticByPlatformSettings	WindowsVMGuestPatchAutomaticByPlatformSettings	Hiermee geeft u aanvullende instellingen voor patchmodus AutomaticByPlatform in VM-gastpatching in Windows.
enableHotpatching	boolean	Hiermee kunnen klanten hun Virtuele Azure-machines patchen zonder dat ze opnieuw hoeven op te starten. Voor enableHotpatching moet de 'provisionVMAgent' worden ingesteld op true en moet patchMode worden ingesteld op 'AutomaticByPlatform'.
patchMode	WindowsVMGuestPatchMode	Hiermee geeft u de modus van VM-gastpatching naar virtuele IaaS-machine of virtuele machines die zijn gekoppeld aan virtuele-machineschaalset met OrchestrationMode als Flexibel. Mogelijke waarden zijn: Handmatige: u beheert de toepassing van patches op een virtuele machine. U doet dit door patches handmatig toe te passen in de VIRTUELE machine. In deze modus worden automatische updates uitgeschakeld; de eigenschap WindowsConfiguration.enableAutomaticUpdates moet onwaar zijn AutomaticByOS-: de virtuele machine wordt automatisch bijgewerkt door het besturingssysteem. De eigenschap WindowsConfiguration.enableAutomaticUpdates moet waar zijn. AutomaticByPlatform: de virtuele machine wordt automatisch bijgewerkt door het platform. De eigenschappen provisionVMAgent en WindowsConfiguration.enableAutomaticUpdates moeten waar zijn

ProtocolTypes

Inventarisatie

Hiermee geeft u het protocol van WinRM-listener. Mogelijke waarden zijn: http,https.

Waarde	Description
Http
Https

ProxyAgentSettings

Object

Hiermee geeft u ProxyAgent-instellingen op tijdens het maken van de virtuele machine. Minimale API-versie: 2023-09-01.

Name	Type	Description
enabled	boolean	Hiermee geeft u op of de functie ProxyAgent moet worden ingeschakeld op de virtuele machine of virtuele-machineschaalset.
keyIncarnationId	integer (int32)	Verhoog de waarde van deze eigenschap zodat de gebruiker de sleutel die wordt gebruikt voor het beveiligen van het communicatiekanaal tussen gast en host opnieuw kan instellen.
mode	Mode	Hiermee geeft u de modus op waarop ProxyAgent wordt uitgevoerd als de functie is ingeschakeld. ProxyAgent begint met controleren of bewaken, maar dwingt geen toegangsbeheer af over aanvragen voor hosteindpunten in de controlemodus, terwijl in de modus Afdwingen het toegangsbeheer wordt afgedwongen. De standaardwaarde is de modus Afdwingen.

RestorePoint

Object

Details van herstelpunt.

Name	Type	Description
id	string	Resource-id
name	string	Resourcenaam
properties.consistencyMode	ConsistencyModeTypes	ConsistencyMode van het RestorePoint. Kan worden opgegeven in de invoer tijdens het maken van een herstelpunt. Voorlopig wordt alleen CrashConsistent geaccepteerd als een geldige invoer. Raadpleeg https://aka.ms/RestorePoints voor meer informatie.
properties.excludeDisks	ApiEntityReference[]	Lijst met schijfresource-id's die de klant wil uitsluiten van het herstelpunt. Als er geen schijven zijn opgegeven, worden alle schijven opgenomen.
properties.instanceView	RestorePointInstanceView	De weergave herstelpuntexemplaren.
properties.provisioningState	string	Hiermee haalt u de inrichtingsstatus van het herstelpunt op.
properties.sourceMetadata	RestorePointSourceMetadata	Hiermee haalt u de details op van de virtuele machine die is vastgelegd op het moment dat het herstelpunt is gemaakt.
properties.sourceRestorePoint	ApiEntityReference	Resource-id van het bronherstelpunt waaruit een kopie moet worden gemaakt.
properties.timeCreated	string (date-time)	Hiermee haalt u de aanmaaktijd van het herstelpunt op.
type	string	Resourcetype

RestorePointCollection

Object

Parameters voor het verzamelen van herstelpunten maken of bijwerken.

Name	Type	Description
id	string	Resource-id
location	string	Resourcelocatie
name	string	Resourcenaam
properties.provisioningState	string	De inrichtingsstatus van de verzameling herstelpunten.
properties.restorePointCollectionId	string	De unieke id van de verzameling herstelpunten.
properties.restorePoints	RestorePoint[]	Een lijst met alle herstelpunten die zijn gemaakt onder deze verzameling herstelpunten.
properties.source	RestorePointCollectionSourceProperties	De eigenschappen van de bronresource waaruit deze verzameling herstelpunten is gemaakt.
tags	object	Resourcetags
type	string	Resourcetype

RestorePointCollectionExpandOptions

Inventarisatie

De uitvouwexpressie die moet worden toegepast op de bewerking. Als expand=restorePoints, retourneert de server alle ingesloten herstelpunten in de restorePointCollection.

Waarde	Description
restorePoints

RestorePointCollectionSourceProperties

Object

De eigenschappen van de bronresource waaruit deze verzameling herstelpunten is gemaakt.

Name	Type	Description
id	string	Resource-id van de bronresource die wordt gebruikt om deze herstelpuntverzameling te maken
location	string	Locatie van de bronresource die wordt gebruikt om deze verzameling herstelpunten te maken.

RestorePointEncryption

Object

Versleuteling-at-rest-instellingen voor schijfherstelpunt. Het is een optionele eigenschap die kan worden opgegeven in de invoer tijdens het maken van een herstelpunt.

Name	Type	Description
diskEncryptionSet	DiskEncryptionSetParameters	Beschrijft de parameter van de resource-id van de door de klant beheerde schijfversleutelingsset die kan worden opgegeven voor schijf. Opmerking: de resource-id van de schijfversleutelingsset kan alleen worden opgegeven voor beheerde schijven. Raadpleeg https://aka.ms/mdssewithcmkoverview voor meer informatie.
type	RestorePointEncryptionType	Het type sleutel dat wordt gebruikt voor het versleutelen van de gegevens van het schijfherstelpunt.

RestorePointEncryptionType

Inventarisatie

Het type sleutel dat wordt gebruikt voor het versleutelen van de gegevens van het schijfherstelpunt.

Waarde	Description
EncryptionAtRestWithCustomerKey	Schijfherstelpunt wordt in rust versleuteld met door de klant beheerde sleutel die kan worden gewijzigd en ingetrokken door een klant.
EncryptionAtRestWithPlatformAndCustomerKeys	Schijfherstelpunt wordt in rust versleuteld met 2 lagen versleuteling. Een van de sleutels wordt door de klant beheerd en de andere sleutel wordt beheerd door platform.
EncryptionAtRestWithPlatformKey	Schijfherstelpunt wordt in rust versleuteld met door platform beheerde sleutel.

RestorePointInstanceView

Object

De exemplaarweergave van een herstelpunt.

Name	Type	Description
diskRestorePoints	DiskRestorePointInstanceView[]	Informatie over de schijfherstelpunten.
statuses	InstanceViewStatus[]	De informatie over de resourcestatus.

RestorePointSourceMetadata

Object

Beschrijft de eigenschappen van de virtuele machine waarvoor het herstelpunt is gemaakt. De opgegeven eigenschappen zijn een subset en de momentopname van de algemene eigenschappen van de virtuele machine die zijn vastgelegd op het moment dat het herstelpunt is gemaakt.

Name	Type	Description
diagnosticsProfile	DiagnosticsProfile	Hiermee haalt u het diagnostische profiel op.
hardwareProfile	HardwareProfile	Hiermee haalt u het hardwareprofiel op.
hyperVGeneration	HyperVGenerationTypes	HyperVGeneratie van de bron-VM waarvoor het herstelpunt wordt vastgelegd.
licenseType	string	Hiermee haalt u het licentietype op. Dit is voor uw eigen licentiescenario.
location	string	Locatie van de VIRTUELE machine waaruit het herstelpunt is gemaakt.
osProfile	OSProfile	Hiermee haalt u het besturingssysteemprofiel op.
securityProfile	SecurityProfile	Hiermee haalt u het beveiligingsprofiel op.
storageProfile	RestorePointSourceVMStorageProfile	Hiermee haalt u het opslagprofiel op.
userData	string	UserData die is gekoppeld aan de bron-VM waarvoor het herstelpunt wordt vastgelegd, een base-64-gecodeerde waarde.
vmId	string	Hiermee haalt u de unieke id van de virtuele machine op.

RestorePointSourceVMDataDisk

Object

Beschrijft een gegevensschijf.

Name	Type	Description
caching	CachingTypes	Hiermee haalt u het cachetype op.
diskRestorePoint	DiskRestorePointAttributes	Bevat eigenschappen van schijfherstelpunt.
diskSizeGB	integer (int32)	Hiermee wordt de initiële schijfgrootte in GB opgehaald voor lege gegevensschijven en de nieuwe gewenste grootte voor bestaande besturingssysteem- en gegevensschijven.
lun	integer (int32)	Hiermee haalt u het nummer van de logische eenheid op.
managedDisk	ManagedDiskParameters	Bevat de details van de beheerde schijf.
name	string	Hiermee haalt u de naam van de schijf op.
writeAcceleratorEnabled	boolean	Geeft waar weer als de schijf schrijfversneller is ingeschakeld.

RestorePointSourceVMOSDisk

Object

Beschrijft een besturingssysteemschijf.

Name	Type	Description
caching	CachingTypes	Hiermee haalt u het cachetype op.
diskRestorePoint	DiskRestorePointAttributes	Bevat eigenschappen van schijfherstelpunt.
diskSizeGB	integer (int32)	Hiermee haalt u de schijfgrootte op in GB.
encryptionSettings	DiskEncryptionSettings	Hiermee haalt u de instellingen voor schijfversleuteling op.
managedDisk	ManagedDiskParameters	Hiermee haalt u de details van de beheerde schijf op
name	string	Hiermee haalt u de naam van de schijf op.
osType	OperatingSystemType	Hiermee haalt u het type besturingssysteem op.
writeAcceleratorEnabled	boolean	Geeft waar weer als de schijf schrijfversneller is ingeschakeld.

RestorePointSourceVMStorageProfile

Object

Beschrijft het opslagprofiel.

Name	Type	Description
dataDisks	RestorePointSourceVMDataDisk[]	Haalt de gegevensschijven op van de VIRTUELE machine die is vastgelegd op het moment dat het herstelpunt is gemaakt.
diskControllerType	DiskControllerTypes	Hiermee haalt u het type schijfcontroller op van de virtuele machine die is vastgelegd op het moment dat het herstelpunt is gemaakt.
osDisk	RestorePointSourceVMOSDisk	Hiermee haalt u de besturingssysteemschijf op van de virtuele machine die is vastgelegd op het moment dat het herstelpunt is gemaakt.

securityEncryptionTypes

Inventarisatie

Hiermee geeft u het EncryptionType van de beheerde schijf. Deze is ingesteld op DiskWithVMGuestState voor versleuteling van de beheerde schijf, samen met VMGuestState-blob, VMGuestStateOnly voor versleuteling van alleen de VMGuestState-blob en NonPersistedTPM voor het niet behouden van de firmwarestatus in de VMGuestState-blob.. Opmerking: Deze kan alleen worden ingesteld voor vertrouwelijke VM's.

Waarde	Description
DiskWithVMGuestState
NonPersistedTPM
VMGuestStateOnly

SecurityProfile

Object

Hiermee geeft u de beveiligingsprofielinstellingen voor de virtuele machine of virtuele-machineschaalset op.

Name	Type	Description
encryptionAtHost	boolean	Deze eigenschap kan worden gebruikt door de gebruiker in de aanvraag om hostversleuteling voor de virtuele machine of virtuele-machineschaalset in of uit te schakelen. Hierdoor wordt de versleuteling ingeschakeld voor alle schijven, inclusief resource-/tijdelijke schijf op de host zelf. Het standaardgedrag is: De versleuteling op de host wordt uitgeschakeld, tenzij deze eigenschap is ingesteld op waar voor de resource.
encryptionIdentity	EncryptionIdentity	Hiermee geeft u de beheerde identiteit op die door ADE wordt gebruikt om toegangstoken op te halen voor sleutelkluisbewerkingen.
proxyAgentSettings	ProxyAgentSettings	Hiermee geeft u ProxyAgent-instellingen op tijdens het maken van de virtuele machine. Minimale API-versie: 2023-09-01.
securityType	SecurityTypes	Hiermee geeft u het SecurityType van de virtuele machine. Deze moet worden ingesteld op een opgegeven waarde om UefiSettings in te schakelen. Het standaardgedrag is: UefiSettings wordt niet ingeschakeld, tenzij deze eigenschap is ingesteld.
uefiSettings	UefiSettings	Hiermee geeft u de beveiligingsinstellingen op, zoals beveiligd opstarten en vTPM die worden gebruikt tijdens het maken van de virtuele machine. Minimale API-versie: 2020-12-01.

SecurityTypes

Inventarisatie

Hiermee geeft u het SecurityType van de virtuele machine. Deze moet worden ingesteld op een opgegeven waarde om UefiSettings in te schakelen. Het standaardgedrag is: UefiSettings wordt niet ingeschakeld, tenzij deze eigenschap is ingesteld.

Waarde	Description
ConfidentialVM
TrustedLaunch

SettingNames

Inventarisatie

Hiermee geeft u de naam op van de instelling waarop de inhoud van toepassing is. Mogelijke waarden zijn: FirstLogonCommands en AutoLogon.

Waarde	Description
AutoLogon
FirstLogonCommands

SshConfiguration

Object

SSH-configuratie voor op Linux gebaseerde VM's die worden uitgevoerd in Azure

Name	Type	Description
publicKeys	SshPublicKey[]	De lijst met openbare SSH-sleutels die worden gebruikt voor verificatie met virtuele Linux-machines.

SshPublicKey

Object

Bevat informatie over de openbare SSH-certificaatsleutel en het pad op de Virtuele Linux-machine waarop de openbare sleutel wordt geplaatst.

Name	Type	Description
keyData	string	Het openbare SSH-sleutelcertificaat dat wordt gebruikt voor verificatie met de virtuele machine via ssh. De sleutel moet ten minste 2048-bits en in ssh-rsa-indeling zijn. Zie [SSH-sleutels maken in Linux en Mac voor Linux-VM's in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). voor het maken van SSH-sleutels
path	string	Hiermee geeft u het volledige pad op de gemaakte VM waarin de openbare SSH-sleutel wordt opgeslagen. Als het bestand al bestaat, wordt de opgegeven sleutel toegevoegd aan het bestand. Voorbeeld: /home/user/.ssh/authorized_keys

StatusLevelTypes

Inventarisatie

De niveaucode.

Waarde	Description
Error
Info
Warning

StorageAccountTypes

Inventarisatie

Hiermee geeft u het type opslagaccount voor de beheerde schijf. OPMERKING: UltraSSD_LRS kan alleen worden gebruikt met gegevensschijven, deze kan niet worden gebruikt met besturingssysteemschijf.

Waarde	Description
PremiumV2_LRS
Premium_LRS
Premium_ZRS
StandardSSD_LRS
StandardSSD_ZRS
Standard_LRS
UltraSSD_LRS

SubResource

Object

Name	Type	Description
id	string	Resource-id

UefiSettings

Object

Hiermee geeft u de beveiligingsinstellingen op, zoals beveiligd opstarten en vTPM die worden gebruikt tijdens het maken van de virtuele machine. Minimale API-versie: 2020-12-01.

Name	Type	Description
secureBootEnabled	boolean	Hiermee geeft u op of beveiligd opstarten moet worden ingeschakeld op de virtuele machine. Minimale API-versie: 2020-12-01.
vTpmEnabled	boolean	Hiermee geeft u op of vTPM moet worden ingeschakeld op de virtuele machine. Minimale API-versie: 2020-12-01.

VaultCertificate

Object

Beschrijft één certificaatverwijzing in een Sleutelkluis en waar het certificaat zich op de virtuele machine moet bevinden.

Name	Type	Description
certificateStore	string	Voor Virtuele Windows-machines geeft u het certificaatarchief op de virtuele machine waaraan het certificaat moet worden toegevoegd. Het opgegeven certificaatarchief bevindt zich impliciet in het LocalMachine-account. Voor Linux-VM's wordt het certificaatbestand onder de map /var/lib/waagent geplaatst, met de bestandsnaam <HoofdletterThumbprint>.crt voor het X509-certificaatbestand en <HoofdlettercaseThumbprint>.prv voor persoonlijke sleutel. Beide bestanden zijn .pem-indeling.
certificateUrl	string	Dit is de URL van een certificaat dat als geheim is geüpload naar Key Vault. Zie Een sleutel of geheim toevoegen aan de sleutelkluisvoor informatie over het toevoegen van een geheim aan de sleutelkluis. In dit geval moet uw certificaat de Base64-codering zijn van het volgende JSON-object dat is gecodeerd in UTF-8: { "data":", "dataType":"pfx", "wachtwoord":"" } Als u certificaten op een virtuele machine wilt installeren, wordt u aangeraden de extensie van de virtuele Azure Key Vault-machine voor Linux- of de virtuele Machine-extensie van Azure Key Vault voor Windowste gebruiken.

VaultSecretGroup

Object

Beschrijft een set certificaten die zich allemaal in dezelfde Key Vault bevinden.

Name	Type	Description
sourceVault	SubResource	De relatieve URL van de Sleutelkluis met alle certificaten in VaultCertificates.
vaultCertificates	VaultCertificate[]	De lijst met sleutelkluisverwijzingen in SourceVault die certificaten bevatten.

VirtualMachineSizeTypes

Inventarisatie

Hiermee geeft u de grootte van de virtuele machine. Het enum-gegevenstype is momenteel afgeschaft en wordt op 23 december 2023 verwijderd. De aanbevolen manier om de lijst met beschikbare grootten op te halen, is met behulp van deze API's: Alle beschikbare grootten van virtuele machines in een beschikbaarheidsset weergeven, Alle beschikbare grootten van virtuele machines in een regio weergeven, Alle beschikbare grootten van virtuele machines weergeven voor het wijzigen van de grootte van. Zie Grootten voor virtuele machinesvoor meer informatie over de grootte van virtuele machines. De beschikbare VM-grootten zijn afhankelijk van de regio en beschikbaarheidsset.

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

VMDiskSecurityProfile

Object

Hiermee geeft u de beveiligingsprofielinstellingen voor de beheerde schijf. Opmerking: Deze kan alleen worden ingesteld voor vertrouwelijke VM's.

Name	Type	Description
diskEncryptionSet	DiskEncryptionSetParameters	Hiermee geeft u de door de klant beheerde schijfversleutelingssetresource-id op voor de beheerde schijf die wordt gebruikt voor door de klant beheerde sleutel versleutelde ConfidentialVM-besturingssysteemschijf en VMGuest-blob.
securityEncryptionType	securityEncryptionTypes	Hiermee geeft u het EncryptionType van de beheerde schijf. Deze is ingesteld op DiskWithVMGuestState voor versleuteling van de beheerde schijf, samen met VMGuestState-blob, VMGuestStateOnly voor versleuteling van alleen de VMGuestState-blob en NonPersistedTPM voor het niet behouden van de firmwarestatus in de VMGuestState-blob.. Opmerking: Deze kan alleen worden ingesteld voor vertrouwelijke VM's.

VMSizeProperties

Object

Hiermee geeft u de instellingen voor de eigenschap VM-grootte op de virtuele machine.

Name	Type	Description
vCPUsAvailable	integer (int32)	Hiermee geeft u het aantal vCPU's dat beschikbaar is voor de virtuele machine. Wanneer deze eigenschap niet is opgegeven in de aanvraagbody, wordt het standaardgedrag ingesteld op de waarde van vCPU's die beschikbaar zijn voor die VM-grootte die beschikbaar is in api-antwoord van Alle beschikbare grootten van virtuele machines in een regio weergeven.
vCPUsPerCore	integer (int32)	Hiermee geeft u de verhouding tussen vCPU en fysieke kern. Wanneer deze eigenschap niet is opgegeven in de aanvraagbody, wordt het standaardgedrag ingesteld op de waarde van vCPUUsPerCore voor de VM-grootte die wordt weergegeven in api-antwoord van Alle beschikbare grootten van virtuele machines in een regio weergeven. Deze eigenschap instellen op 1 betekent ook dat hyperthreading is uitgeschakeld.

WindowsConfiguration

Object

Hiermee geeft u windows-besturingssysteeminstellingen op de virtuele machine.

Name	Type	Description
additionalUnattendContent	AdditionalUnattendContent[]	Hiermee geeft u aanvullende base-64 gecodeerde XML-geformatteerde informatie op die kan worden opgenomen in het Unattend.xml-bestand, dat wordt gebruikt door Windows Setup.
enableAutomaticUpdates	boolean	Hiermee wordt aangegeven of Automatische updates is ingeschakeld voor de virtuele Windows-machine. De standaardwaarde is waar. Voor virtuele-machineschaalsets kan deze eigenschap worden bijgewerkt en worden updates van kracht bij het opnieuw inrichten van het besturingssysteem.
enableVMAgentPlatformUpdates	boolean	Geeft aan of VMAgent-platformupdates zijn ingeschakeld voor de virtuele Windows-machine.
patchSettings	PatchSettings	[Preview-functie] Hiermee geeft u instellingen met betrekking tot VM-gastpatching in Windows.
provisionVMAgent	boolean	Hiermee wordt aangegeven of de virtuele-machineagent moet worden ingericht op de virtuele machine. Wanneer deze eigenschap niet is opgegeven in de hoofdtekst van de aanvraag, is deze standaard ingesteld op true. Dit zorgt ervoor dat de VM-agent op de VIRTUELE machine is geïnstalleerd, zodat extensies later aan de VIRTUELE machine kunnen worden toegevoegd.
timeZone	string	Hiermee geeft u de tijdzone van de virtuele machine. bijvoorbeeld "Pacific Standard Time". Mogelijke waarden kunnen worden TimeZoneInfo.Id waarde uit tijdzones die worden geretourneerd door TimeZoneInfo.GetSystemTimeZones.
winRM	WinRMConfiguration	Hiermee geeft u de listeners voor Extern beheer van Windows op. Hiermee schakelt u externe Windows PowerShell in.

WindowsPatchAssessmentMode

Inventarisatie

Waarde	Description
AutomaticByPlatform
ImageDefault

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Inventarisatie

Hiermee geeft u de instelling voor opnieuw opstarten voor alle installatiebewerkingen van de AutomaticByPlatform-patch.

Waarde	Description
Always
IfRequired
Never
Unknown

WindowsVMGuestPatchAutomaticByPlatformSettings

Object

Hiermee geeft u aanvullende instellingen op die moeten worden toegepast wanneer de patchmodus AutomaticByPlatform is geselecteerd in de Windows-patchinstellingen.

Name	Type	Description
bypassPlatformSafetyChecksOnUserSchedule	boolean	Stelt de klant in staat patches te plannen zonder onbedoelde upgrades
rebootSetting	WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Hiermee geeft u de instelling voor opnieuw opstarten voor alle installatiebewerkingen van de AutomaticByPlatform-patch.

WindowsVMGuestPatchMode

Inventarisatie

Hiermee geeft u de modus van VM-gastpatching naar virtuele IaaS-machine of virtuele machines die zijn gekoppeld aan virtuele-machineschaalset met OrchestrationMode als Flexibel.

Mogelijke waarden zijn:

Handmatige: u beheert de toepassing van patches op een virtuele machine. U doet dit door patches handmatig toe te passen in de VIRTUELE machine. In deze modus worden automatische updates uitgeschakeld; de eigenschap WindowsConfiguration.enableAutomaticUpdates moet onwaar zijn

AutomaticByOS-: de virtuele machine wordt automatisch bijgewerkt door het besturingssysteem. De eigenschap WindowsConfiguration.enableAutomaticUpdates moet waar zijn.

AutomaticByPlatform: de virtuele machine wordt automatisch bijgewerkt door het platform. De eigenschappen provisionVMAgent en WindowsConfiguration.enableAutomaticUpdates moeten waar zijn

Waarde	Description
AutomaticByOS
AutomaticByPlatform
Manual

WinRMConfiguration

Object

Hierin wordt de configuratie van Windows Remote Management van de VM beschreven

Name	Type	Description
listeners	WinRMListener[]	De lijst met Windows Remote Management-listeners

WinRMListener

Object

Beschrijft protocol en vingerafdruk van Windows Remote Management-listener

Name	Type	Description
certificateUrl	string	Dit is de URL van een certificaat dat als geheim is geüpload naar Key Vault. Zie Een sleutel of geheim toevoegen aan de sleutelkluisvoor informatie over het toevoegen van een geheim aan de sleutelkluis. In dit geval moet uw certificaat de Base64-codering zijn van het volgende JSON-object dat is gecodeerd in UTF-8: { "data":", "dataType":"pfx", "wachtwoord":"" } Als u certificaten op een virtuele machine wilt installeren, wordt u aangeraden de extensie van de virtuele Azure Key Vault-machine voor Linux- of de virtuele Machine-extensie van Azure Key Vault voor Windowste gebruiken.
protocol	ProtocolTypes	Hiermee geeft u het protocol van WinRM-listener. Mogelijke waarden zijn: http,https.

Delen via

Restore Point Collections - Get

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

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

Voorbeeldaanvraag

Voorbeeldrespons

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

Voorbeeldaanvraag

Voorbeeldrespons

Definities

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