Restore Point Collections - Update

Service:

Compute

API Version:

2024-03-01

A operação para atualizar a coleção de pontos de restauro.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos.
restorePointCollectionName	path	True	string	O nome da coleção de pontos de restauro.
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do Cliente.

Corpo do Pedido

Name	Tipo	Description
properties.source	RestorePointCollectionSourceProperties	As propriedades do recurso de origem a partir do qual esta coleção de pontos de restauro é criada.
tags	object	Etiquetas de recursos

Respostas

Name	Tipo	Description
200 OK	RestorePointCollection	OK
Other Status Codes	CloudError	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

RestorePointCollection_Update_MaximumSet_Gen

RestorePointCollection_Update_MinimumSet_Gen

RestorePointCollection_Update_MaximumSet_Gen

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/restorePointCollections/aaaaaaaaaaaaaaaaaaaa?api-version=2024-03-01

{
  "properties": {
    "source": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"
    }
  },
  "tags": {
    "key8536": "aaaaaaaaaaaaaaaaaaa"
  }
}

Java

import com.azure.resourcemanager.compute.models.RestorePointCollectionSourceProperties;
import com.azure.resourcemanager.compute.models.RestorePointCollectionUpdate;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for RestorePointCollections Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * restorePointExamples/RestorePointCollection_Update_MaximumSet_Gen.json
     */
    /**
     * Sample code: RestorePointCollection_Update_MaximumSet_Gen.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void restorePointCollectionUpdateMaximumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getRestorePointCollections().updateWithResponse("rgcompute",
            "aaaaaaaaaaaaaaaaaaaa",
            new RestorePointCollectionUpdate().withTags(mapOf("key8536", "fakeTokenPlaceholder"))
                .withSource(new RestorePointCollectionSourceProperties().withId(
                    "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM")),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

Python

from typing import Any, IO, Union

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_update_maximum_set_gen.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.update(
        resource_group_name="rgcompute",
        restore_point_collection_name="aaaaaaaaaaaaaaaaaaaa",
        parameters={
            "properties": {
                "source": {
                    "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"
                }
            },
            "tags": {"key8536": "aaaaaaaaaaaaaaaaaaa"},
        },
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/restorePointExamples/RestorePointCollection_Update_MaximumSet_Gen.json
if __name__ == "__main__":
    main()

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

Go

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/restorePointExamples/RestorePointCollection_Update_MaximumSet_Gen.json
func ExampleRestorePointCollectionsClient_Update_restorePointCollectionUpdateMaximumSetGen() {
	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().Update(ctx, "rgcompute", "aaaaaaaaaaaaaaaaaaaa", armcompute.RestorePointCollectionUpdate{
		Tags: map[string]*string{
			"key8536": to.Ptr("aaaaaaaaaaaaaaaaaaa"),
		},
		Properties: &armcompute.RestorePointCollectionProperties{
			Source: &armcompute.RestorePointCollectionSourceProperties{
				ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"),
			},
		},
	}, 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("norwayeast"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armcompute.RestorePointCollectionProperties{
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		RestorePointCollectionID: to.Ptr("638f052b-a7c2-450c-89e7-6a3b8f1d6a7c"),
	// 		RestorePoints: []*armcompute.RestorePoint{
	// 			{
	// 				Name: to.Ptr("aaaaaaaaaaaaaaaaaa"),
	// 				Type: to.Ptr("aaaaaaaaaaaaaaaaaaaaaaaaa"),
	// 				ID: to.Ptr("aaaaaaaaaaa"),
	// 				Properties: &armcompute.RestorePointProperties{
	// 					ConsistencyMode: to.Ptr(armcompute.ConsistencyModeTypesCrashConsistent),
	// 					ExcludeDisks: []*armcompute.APIEntityReference{
	// 						{
	// 							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"),
	// 					}},
	// 					ProvisioningState: to.Ptr("Succeeded"),
	// 					SourceMetadata: &armcompute.RestorePointSourceMetadata{
	// 						DiagnosticsProfile: &armcompute.DiagnosticsProfile{
	// 							BootDiagnostics: &armcompute.BootDiagnostics{
	// 								Enabled: to.Ptr(true),
	// 								StorageURI: to.Ptr("aaaaaaaaaaaaaaaaaaa"),
	// 							},
	// 						},
	// 						HardwareProfile: &armcompute.HardwareProfile{
	// 							VMSize: to.Ptr(armcompute.VirtualMachineSizeTypesStandardB1S),
	// 							VMSizeProperties: &armcompute.VMSizeProperties{
	// 								VCPUsAvailable: to.Ptr[int32](9),
	// 								VCPUsPerCore: to.Ptr[int32](12),
	// 							},
	// 						},
	// 						LicenseType: to.Ptr("aaaaaaaaaaaaaaaaaaaaaaaaaaa"),
	// 						Location: to.Ptr("westus"),
	// 						OSProfile: &armcompute.OSProfile{
	// 							AdminUsername: to.Ptr("admin"),
	// 							AllowExtensionOperations: to.Ptr(true),
	// 							ComputerName: to.Ptr("computerName"),
	// 							CustomData: to.Ptr("aaaaaaaaaaaaaaaaaaaaaaaaaaa"),
	// 							LinuxConfiguration: &armcompute.LinuxConfiguration{
	// 								DisablePasswordAuthentication: to.Ptr(true),
	// 								PatchSettings: &armcompute.LinuxPatchSettings{
	// 									AssessmentMode: to.Ptr(armcompute.LinuxPatchAssessmentModeImageDefault),
	// 									PatchMode: to.Ptr(armcompute.LinuxVMGuestPatchModeImageDefault),
	// 								},
	// 								ProvisionVMAgent: to.Ptr(true),
	// 								SSH: &armcompute.SSHConfiguration{
	// 									PublicKeys: []*armcompute.SSHPublicKey{
	// 										{
	// 											Path: to.Ptr("aaa"),
	// 											KeyData: to.Ptr("aaaaaa"),
	// 									}},
	// 								},
	// 							},
	// 							RequireGuestProvisionSignal: to.Ptr(true),
	// 							Secrets: []*armcompute.VaultSecretGroup{
	// 								{
	// 									SourceVault: &armcompute.SubResource{
	// 										ID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"),
	// 									},
	// 									VaultCertificates: []*armcompute.VaultCertificate{
	// 										{
	// 											CertificateStore: to.Ptr("aaaaaaaaaaaaaaaaaaaaaaaaa"),
	// 											CertificateURL: to.Ptr("aaaaaaa"),
	// 									}},
	// 							}},
	// 							WindowsConfiguration: &armcompute.WindowsConfiguration{
	// 								AdditionalUnattendContent: []*armcompute.AdditionalUnattendContent{
	// 									{
	// 										ComponentName: to.Ptr("Microsoft-Windows-Shell-Setup"),
	// 										Content: to.Ptr("aaaaaaaaaaaaaaaaaaaa"),
	// 										PassName: to.Ptr("OobeSystem"),
	// 										SettingName: to.Ptr(armcompute.SettingNamesAutoLogon),
	// 								}},
	// 								EnableAutomaticUpdates: to.Ptr(true),
	// 								PatchSettings: &armcompute.PatchSettings{
	// 									AssessmentMode: to.Ptr(armcompute.WindowsPatchAssessmentModeImageDefault),
	// 									EnableHotpatching: to.Ptr(true),
	// 									PatchMode: to.Ptr(armcompute.WindowsVMGuestPatchModeManual),
	// 								},
	// 								ProvisionVMAgent: to.Ptr(true),
	// 								TimeZone: to.Ptr("aaaaaaaaaaaaaaaaaaaaaaaaaaaaa"),
	// 								WinRM: &armcompute.WinRMConfiguration{
	// 									Listeners: []*armcompute.WinRMListener{
	// 										{
	// 											CertificateURL: to.Ptr("aaaaaaaaaaaaaaaaaaaaaa"),
	// 											Protocol: to.Ptr(armcompute.ProtocolTypesHTTP),
	// 									}},
	// 								},
	// 							},
	// 						},
	// 						SecurityProfile: &armcompute.SecurityProfile{
	// 							EncryptionAtHost: to.Ptr(true),
	// 							SecurityType: to.Ptr(armcompute.SecurityTypesTrustedLaunch),
	// 							UefiSettings: &armcompute.UefiSettings{
	// 								SecureBootEnabled: to.Ptr(true),
	// 								VTpmEnabled: 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"),
	// 									},
	// 									DiskSizeGB: to.Ptr[int32](24),
	// 									Lun: to.Ptr[int32](1),
	// 									ManagedDisk: &armcompute.ManagedDiskParameters{
	// 										ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_DataDisk_1"),
	// 										DiskEncryptionSet: &armcompute.DiskEncryptionSetParameters{
	// 											ID: to.Ptr("aaaaaaaaaaaa"),
	// 										},
	// 										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"),
	// 								},
	// 								DiskSizeGB: to.Ptr[int32](3),
	// 								EncryptionSettings: &armcompute.DiskEncryptionSettings{
	// 									DiskEncryptionKey: &armcompute.KeyVaultSecretReference{
	// 										SecretURL: to.Ptr("aaaaaaaa"),
	// 										SourceVault: &armcompute.SubResource{
	// 											ID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"),
	// 										},
	// 									},
	// 									Enabled: to.Ptr(true),
	// 									KeyEncryptionKey: &armcompute.KeyVaultKeyReference{
	// 										KeyURL: to.Ptr("aaaaaaaaaaaaaa"),
	// 										SourceVault: &armcompute.SubResource{
	// 											ID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"),
	// 										},
	// 									},
	// 								},
	// 								ManagedDisk: &armcompute.ManagedDiskParameters{
	// 									ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f"),
	// 									DiskEncryptionSet: &armcompute.DiskEncryptionSetParameters{
	// 										ID: to.Ptr("aaaaaaaaaaaa"),
	// 									},
	// 									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-11-30T12:58:26.593Z"); 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

JavaScript

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

/**
 * This sample demonstrates how to The operation to update the restore point collection.
 *
 * @summary The operation to update the restore point collection.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/restorePointExamples/RestorePointCollection_Update_MaximumSet_Gen.json
 */
async function restorePointCollectionUpdateMaximumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
  const restorePointCollectionName = "aaaaaaaaaaaaaaaaaaaa";
  const parameters = {
    source: {
      id: "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
    },
    tags: { key8536: "aaaaaaaaaaaaaaaaaaa" },
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.restorePointCollections.update(
    resourceGroupName,
    restorePointCollectionName,
    parameters,
  );
  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

Sample Response

Status code:

200

{
  "location": "norwayeast",
  "properties": {
    "source": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
      "location": "eastus"
    },
    "provisioningState": "Successful",
    "restorePointCollectionId": "638f052b-a7c2-450c-89e7-6a3b8f1d6a7c",
    "restorePoints": [
      {
        "properties": {
          "excludeDisks": [
            {
              "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
            }
          ],
          "sourceMetadata": {
            "hardwareProfile": {
              "vmSize": "Standard_B1s",
              "vmSizeProperties": {
                "vCPUsAvailable": 9,
                "vCPUsPerCore": 12
              }
            },
            "storageProfile": {
              "osDisk": {
                "osType": "Windows",
                "encryptionSettings": {
                  "diskEncryptionKey": {
                    "secretUrl": "aaaaaaaa",
                    "sourceVault": {
                      "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                    }
                  },
                  "keyEncryptionKey": {
                    "keyUrl": "aaaaaaaaaaaaaa",
                    "sourceVault": {
                      "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                    }
                  },
                  "enabled": true
                },
                "name": "testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f",
                "caching": "ReadWrite",
                "diskSizeGB": 3,
                "managedDisk": {
                  "storageAccountType": "Standard_LRS",
                  "diskEncryptionSet": {
                    "id": "aaaaaaaaaaaa"
                  },
                  "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",
                    "diskEncryptionSet": {
                      "id": "aaaaaaaaaaaa"
                    }
                  },
                  "diskRestorePoint": {
                    "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5"
                  },
                  "diskSizeGB": 24
                }
              ],
              "diskControllerType": "NVMe"
            },
            "osProfile": {
              "computerName": "computerName",
              "adminUsername": "admin",
              "customData": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
              "windowsConfiguration": {
                "provisionVMAgent": true,
                "enableAutomaticUpdates": true,
                "timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
                "additionalUnattendContent": [
                  {
                    "passName": "OobeSystem",
                    "componentName": "Microsoft-Windows-Shell-Setup",
                    "settingName": "AutoLogon",
                    "content": "aaaaaaaaaaaaaaaaaaaa"
                  }
                ],
                "patchSettings": {
                  "patchMode": "Manual",
                  "enableHotpatching": true,
                  "assessmentMode": "ImageDefault"
                },
                "winRM": {
                  "listeners": [
                    {
                      "protocol": "Http",
                      "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa"
                    }
                  ]
                }
              },
              "linuxConfiguration": {
                "disablePasswordAuthentication": true,
                "ssh": {
                  "publicKeys": [
                    {
                      "path": "aaa",
                      "keyData": "aaaaaa"
                    }
                  ]
                },
                "provisionVMAgent": true,
                "patchSettings": {
                  "patchMode": "ImageDefault",
                  "assessmentMode": "ImageDefault"
                }
              },
              "secrets": [
                {
                  "sourceVault": {
                    "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                  },
                  "vaultCertificates": [
                    {
                      "certificateUrl": "aaaaaaa",
                      "certificateStore": "aaaaaaaaaaaaaaaaaaaaaaaaa"
                    }
                  ]
                }
              ],
              "allowExtensionOperations": true,
              "requireGuestProvisionSignal": true
            },
            "diagnosticsProfile": {
              "bootDiagnostics": {
                "enabled": true,
                "storageUri": "aaaaaaaaaaaaaaaaaaa"
              }
            },
            "licenseType": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7",
            "securityProfile": {
              "uefiSettings": {
                "secureBootEnabled": true,
                "vTpmEnabled": true
              },
              "encryptionAtHost": true,
              "securityType": "TrustedLaunch"
            },
            "location": "westus"
          },
          "provisioningState": "aaaaaaaaaaaaaaaaa",
          "consistencyMode": "CrashConsistent",
          "timeCreated": "2021-11-30T12:58:26.593Z"
        },
        "id": "aaaaaaaaaaa",
        "name": "aaaaaaaaaaaaaaaaaa",
        "type": "aaaaaaaaaaaaaaaaaaaaaaaaa"
      }
    ]
  },
  "tags": {},
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc",
  "name": "myRpc",
  "type": "Microsoft.Compute/restorePointCollections"
}

RestorePointCollection_Update_MinimumSet_Gen

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/restorePointCollections/aaaaaaaaaaaaaaaaaa?api-version=2024-03-01

{}

Java

import com.azure.resourcemanager.compute.models.RestorePointCollectionUpdate;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for RestorePointCollections Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * restorePointExamples/RestorePointCollection_Update_MinimumSet_Gen.json
     */
    /**
     * Sample code: RestorePointCollection_Update_MinimumSet_Gen.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void restorePointCollectionUpdateMinimumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getRestorePointCollections().updateWithResponse("rgcompute",
            "aaaaaaaaaaaaaaaaaa", new RestorePointCollectionUpdate(), com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

Python

No code sample is available. To request a code sample, open a GitHub issue

Go

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/restorePointExamples/RestorePointCollection_Update_MinimumSet_Gen.json
func ExampleRestorePointCollectionsClient_Update_restorePointCollectionUpdateMinimumSetGen() {
	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().Update(ctx, "rgcompute", "aaaaaaaaaaaaaaaaaa", armcompute.RestorePointCollectionUpdate{}, 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{
	// 	Location: to.Ptr("norwayeast"),
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to The operation to update the restore point collection.
 *
 * @summary The operation to update the restore point collection.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/restorePointExamples/RestorePointCollection_Update_MinimumSet_Gen.json
 */
async function restorePointCollectionUpdateMinimumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
  const restorePointCollectionName = "aaaaaaaaaaaaaaaaaa";
  const parameters = {};
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.restorePointCollections.update(
    resourceGroupName,
    restorePointCollectionName,
    parameters,
  );
  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

Sample Response

Status code:

200

{
  "location": "norwayeast"
}

Definições

Name	Description
AdditionalUnattendContent	Especifica informações formatadas XML adicionais que podem ser incluídas no ficheiro Unattend.xml, que é utilizado pela Configuração do Windows. Os conteúdos são definidos por nome de definição, nome do componente e o passe no qual o conteúdo é aplicado.
ApiEntityReference	A referência de entidade da API.
ApiError	Erro de API.
ApiErrorBase	Base de erros da API.
BootDiagnostics	O Diagnóstico de Arranque é uma funcionalidade de depuração que lhe permite ver a Saída da Consola e a Captura de Ecrã para diagnosticar o estado da VM. Pode ver facilmente o resultado do registo da consola. O Azure também lhe permite ver uma captura de ecrã da VM a partir do hipervisor.
CachingTypes	Obtém o tipo de colocação em cache.
CloudError	Uma resposta de erro do serviço de Computação.
ComponentNames	O nome do componente. Atualmente, o único valor permitido é Microsoft-Windows-Shell-Setup.
ConsistencyModeTypes	ConsistencyMode do RestorePoint. Pode ser especificado na entrada ao criar um ponto de restauro. Por enquanto, apenas CrashConsistent é aceite como uma entrada válida. Veja para https://aka.ms/RestorePoints obter mais detalhes.
DiagnosticsProfile	Especifica o estado das definições de diagnóstico de arranque. Versão mínima da API: 2015-06-15.
DiskControllerTypes	Obtém o tipo de controlador de disco da VM capturada no momento da criação do ponto de restauro.
DiskEncryptionSetParameters	Descreve o parâmetro do ID de recurso do conjunto de encriptação de discos geridos pelo cliente que pode ser especificado para o disco. Nota: O ID de recurso do conjunto de encriptação de discos só pode ser especificado para o disco gerido. https://aka.ms/mdssewithcmkoverview Veja mais detalhes.
DiskEncryptionSettings	Descreve as Definições de Encriptação de um Disco
DiskRestorePointAttributes	Detalhes do Ponto de Restauro do Disco.
DiskRestorePointInstanceView	A vista de instância de um ponto de restauro de disco.
DiskRestorePointReplicationStatus	A vista de instância de um ponto de restauro de disco.
EncryptionIdentity	Especifica a Identidade Gerida utilizada pela ADE para obter o token de acesso para operações de keyvault.
HardwareProfile	Especifica as definições de hardware da máquina virtual.
HyperVGenerationTypes	HyperVGeneration da VM de origem para a qual o ponto de restauro é capturado.
InnerError	Detalhes do erro interno.
InstanceViewStatus	Estado da vista de instância.
KeyVaultKeyReference	Descreve uma referência a Key Vault Key
KeyVaultSecretReference	Descreve uma referência ao Segredo Key Vault
LinuxConfiguration	Especifica as definições do sistema operativo Linux na máquina virtual. Para obter uma lista de distribuições suportadas do Linux, veja Linux on Azure-Endorsed Distributions (Distribuições de Azure-Endorsed).
LinuxPatchAssessmentMode	Especifica o modo de Avaliação de Patch de Convidado da VM para a máquina virtual IaaS. Os valores possíveis são: ImageDefault - Controla a temporização das avaliações de patches numa máquina virtual. AutomaticByPlatform – a plataforma irá acionar avaliações periódicas de patches. A propriedade provisionVMAgent tem de ser verdadeira.
LinuxPatchSettings	Especifica as definições relacionadas com a Aplicação de Patches de Convidado da VM no Linux.
LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Especifica a definição de reinício para todas as operações de instalação de patch AutomaticByPlatform.
LinuxVMGuestPatchAutomaticByPlatformSettings	Especifica definições adicionais a aplicar quando o modo de patch AutomaticByPlatform está selecionado nas definições de patch do Linux.
LinuxVMGuestPatchMode	Especifica o modo de Aplicação de Patches de Convidado da VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquinas virtuais com OrchestrationMode como Flexível. Os valores possíveis são: ImageDefault – é utilizada a configuração de aplicação de patches predefinida da máquina virtual. AutomaticByPlatform – a máquina virtual será atualizada automaticamente pela plataforma. A propriedade provisionVMAgent tem de ser verdadeira
ManagedDiskParameters	Os parâmetros de um disco gerido.
Mode	Especifica o modo em que o ProxyAgent será executado se a funcionalidade estiver ativada. O ProxyAgent começará a auditar ou monitorizar, mas não imporá o controlo de acesso sobre os pedidos para alojar pontos finais no Modo de auditoria, enquanto no modo Impor irá impor o controlo de acesso. O valor predefinido é Impor modo.
OperatingSystemType	Obtém o tipo de Sistema Operativo.
OSProfile	Especifica as definições do sistema operativo para a máquina virtual. Algumas das definições não podem ser alteradas depois de a VM ser aprovisionada.
PassNames	O nome do passe. Atualmente, o único valor permitido é OobeSystem.
PatchSettings	Especifica as definições relacionadas com a Aplicação de Patches de Convidado da VM no Windows.
ProtocolTypes	Especifica o protocolo do serviço de escuta WinRM. Os valores possíveis são: http,https.
ProxyAgentSettings	Especifica as definições do ProxyAgent ao criar a máquina virtual. Versão mínima da API: 2024-03-01.
RestorePoint	Detalhes do Ponto de Restauro.
RestorePointCollection	Criar ou atualizar parâmetros de coleção do Ponto de Restauro.
RestorePointCollectionSourceProperties	As propriedades do recurso de origem a partir do qual esta coleção de pontos de restauro é criada.
RestorePointCollectionUpdate	Atualizar parâmetros de coleção do Ponto de Restauro.
RestorePointEncryption	Definições de encriptação inativa para o ponto de restauro do disco. É uma propriedade opcional que pode ser especificada na entrada ao criar um ponto de restauro.
RestorePointEncryptionType	O tipo de chave utilizada para encriptar os dados do ponto de restauro do disco.
RestorePointInstanceView	A vista de instância de um ponto de restauro.
RestorePointSourceMetadata	Descreve as propriedades da Máquina Virtual para a qual o ponto de restauro foi criado. As propriedades fornecidas são um subconjunto e o instantâneo das propriedades gerais da Máquina Virtual capturadas no momento da criação do ponto de restauro.
RestorePointSourceVMDataDisk	Descreve um disco de dados.
RestorePointSourceVMOSDisk	Descreve um disco do Sistema Operativo.
RestorePointSourceVMStorageProfile	Descreve o perfil de armazenamento.
securityEncryptionTypes	Especifica o EncryptionType do disco gerido. Está definido como DiskWithVMGuestState para encriptação do disco gerido juntamente com o blob VMGuestState, VMGuestStateOnly para encriptação apenas do blob VMGuestState e NonPersistedTPM para não persistir o estado de firmware no blob VMGuestState.. Nota: Só pode ser definido para VMs Confidenciais.
SecurityProfile	Especifica as definições de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais.
SecurityTypes	Especifica o SecurityType da máquina virtual. Tem de ser definido como qualquer valor especificado para ativar UefiSettings. O comportamento predefinido é: UefiSettings não será ativado a menos que esta propriedade esteja definida.
SettingNames	Especifica o nome da definição à qual o conteúdo se aplica. Os valores possíveis são: FirstLogonCommands e AutoLogon.
SshConfiguration	Configuração SSH para VMs baseadas no Linux em execução no Azure
SshPublicKey	Contém informações sobre a chave pública do certificado SSH e o caminho na VM do Linux onde a chave pública é colocada.
StatusLevelTypes	O código de nível.
StorageAccountTypes	Especifica o tipo de conta de armazenamento para o disco gerido. NOTA: UltraSSD_LRS só podem ser utilizadas com discos de dados, não podem ser utilizadas com o Disco do SO.
SubResource
UefiSettings	Especifica as definições de segurança, como o arranque seguro e o vTPM utilizados ao criar a máquina virtual. Versão mínima da API: 2020-12-01.
VaultCertificate	Descreve uma única referência de certificado numa Key Vault e onde o certificado deve residir na VM.
VaultSecretGroup	Descreve um conjunto de certificados que estão todos no mesmo Key Vault.
VirtualMachineSizeTypes	Especifica o tamanho da máquina virtual. O tipo de dados de numeração está atualmente preterido e será removido até 23 de dezembro de 2023. A forma recomendada de obter a lista de tamanhos disponíveis é utilizar estas APIs: Listar todos os tamanhos de máquinas virtuais disponíveis num conjunto de disponibilidade, Listar todos os tamanhos de máquinas virtuais disponíveis numa região, Listar todos os tamanhos de máquinas virtuais disponíveis para redimensionamento. Para obter mais informações sobre tamanhos de máquinas virtuais, veja Tamanhos para máquinas virtuais. Os tamanhos de VM disponíveis dependem da região e do conjunto de disponibilidade.
VMDiskSecurityProfile	Especifica as definições do perfil de segurança para o disco gerido. Nota: Só pode ser definido para VMs Confidenciais.
VMSizeProperties	Especifica as definições da Propriedade tamanho da VM na máquina virtual.
WindowsConfiguration	Especifica as definições do sistema operativo Windows na máquina virtual.
WindowsPatchAssessmentMode	Especifica o modo de avaliação do patch convidado da VM para a máquina virtual IaaS. Os valores possíveis são: ImageDefault - Controla a temporização das avaliações de patches numa máquina virtual. AutomaticByPlatform – a plataforma irá acionar avaliações periódicas de patches. A propriedade provisionVMAgent tem de ser verdadeira.
WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Especifica a definição de reinício para todas as operações de instalação de patch AutomaticByPlatform.
WindowsVMGuestPatchAutomaticByPlatformSettings	Especifica definições adicionais a aplicar quando o modo de patch AutomaticByPlatform está selecionado nas definições de patch do Windows.
WindowsVMGuestPatchMode	Especifica o modo de Aplicação de Patches de Convidado da VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquinas virtuais com OrchestrationMode como Flexível. Os valores possíveis são: Manual – controla a aplicação de patches a uma máquina virtual. Pode fazê-lo ao aplicar patches manualmente dentro da VM. Neste modo, as atualizações automáticas estão desativadas; a propriedade WindowsConfiguration.enableAutomaticUpdates tem de ser falsa AutomaticByOS – a máquina virtual será atualizada automaticamente pelo SO. A propriedade WindowsConfiguration.enableAutomaticUpdates tem de ser verdadeira. AutomaticByPlatform – a máquina virtual será atualizada automaticamente pela plataforma. As propriedades provisionVMAgent e WindowsConfiguration.enableAutomaticUpdates têm de ser verdadeiras
WinRMConfiguration	Descreve a configuração da Gestão Remota do Windows da VM
WinRMListener	Descreve o Protocolo e o thumbprint do serviço de escuta da Gestão Remota do Windows

AdditionalUnattendContent

Especifica informações formatadas XML adicionais que podem ser incluídas no ficheiro Unattend.xml, que é utilizado pela Configuração do Windows. Os conteúdos são definidos por nome de definição, nome do componente e o passe no qual o conteúdo é aplicado.

Name	Tipo	Description
componentName	ComponentNames	O nome do componente. Atualmente, o único valor permitido é Microsoft-Windows-Shell-Setup.
content	string	Especifica o conteúdo formatado XML que é adicionado ao ficheiro de unattend.xml para o caminho e componente especificados. O XML tem de ser inferior a 4KB e tem de incluir o elemento raiz para a definição ou funcionalidade que está a ser inserida.
passName	PassNames	O nome do passe. Atualmente, o único valor permitido é OobeSystem.
settingName	SettingNames	Especifica o nome da definição à qual o conteúdo se aplica. Os valores possíveis são: FirstLogonCommands e AutoLogon.

ApiEntityReference

A referência de entidade da API.

Name	Tipo	Description
id	string	O ID de recurso do ARM sob a forma de /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Erro de API.

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

ApiErrorBase

Base de erros da API.

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

BootDiagnostics

O Diagnóstico de Arranque é uma funcionalidade de depuração que lhe permite ver a Saída da Consola e a Captura de Ecrã para diagnosticar o estado da VM. Pode ver facilmente o resultado do registo da consola. O Azure também lhe permite ver uma captura de ecrã da VM a partir do hipervisor.

Name	Tipo	Description
enabled	boolean	Se os diagnósticos de arranque devem ser ativados na Máquina Virtual.
storageUri	string	Uri da conta de armazenamento a utilizar para colocar a saída e a captura de ecrã da consola. Se storageUri não for especificado ao ativar o diagnóstico de arranque, será utilizado o armazenamento gerido.

CachingTypes

Obtém o tipo de colocação em cache.

Name	Tipo	Description
None	string
ReadOnly	string
ReadWrite	string

CloudError

Uma resposta de erro do serviço de Computação.

Name	Tipo	Description
error	ApiError	Erro de API.

ComponentNames

O nome do componente. Atualmente, o único valor permitido é Microsoft-Windows-Shell-Setup.

Name	Tipo	Description
Microsoft-Windows-Shell-Setup	string

ConsistencyModeTypes

ConsistencyMode do RestorePoint. Pode ser especificado na entrada ao criar um ponto de restauro. Por enquanto, apenas CrashConsistent é aceite como uma entrada válida. Veja para https://aka.ms/RestorePoints obter mais detalhes.

Name	Tipo	Description
ApplicationConsistent	string
CrashConsistent	string
FileSystemConsistent	string

DiagnosticsProfile

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

Name	Tipo	Description
bootDiagnostics	BootDiagnostics	O Diagnóstico de Arranque é uma funcionalidade de depuração que lhe permite ver a Saída da Consola e a Captura de Ecrã para diagnosticar o estado da VM. NOTA: se o storageUri estiver a ser especificado, certifique-se de que a conta de armazenamento está na mesma região e subscrição que a VM. Pode ver facilmente o resultado do registo da consola. O Azure também lhe permite ver uma captura de ecrã da VM a partir do hipervisor.

DiskControllerTypes

Obtém o tipo de controlador de disco da VM capturada no momento da criação do ponto de restauro.

Name	Tipo	Description
NVMe	string
SCSI	string

DiskEncryptionSetParameters

Descreve o parâmetro do ID de recurso do conjunto de encriptação de discos geridos pelo cliente que pode ser especificado para o disco. Nota: O ID de recurso do conjunto de encriptação de discos só pode ser especificado para o disco gerido. https://aka.ms/mdssewithcmkoverview Veja mais detalhes.

Name	Tipo	Description
id	string	ID do Recurso

DiskEncryptionSettings

Descreve as Definições de Encriptação de um Disco

Name	Tipo	Description
diskEncryptionKey	KeyVaultSecretReference	Especifica a localização da chave de encriptação do disco, que é um segredo Key Vault.
enabled	boolean	Especifica se a encriptação de disco deve ser ativada na máquina virtual.
keyEncryptionKey	KeyVaultKeyReference	Especifica a localização da chave de encriptação de chave no Key Vault.

DiskRestorePointAttributes

Detalhes do Ponto de Restauro do Disco.

Name	Tipo	Description
encryption	RestorePointEncryption	Encriptação em definições inativas para o ponto de restauro do disco. É uma propriedade opcional que pode ser especificada na entrada ao criar um ponto de restauro.
id	string	ID do Recurso
sourceDiskRestorePoint	ApiEntityReference	ID do recurso do ponto de restauro do disco de origem.

DiskRestorePointInstanceView

A vista de instância de um ponto de restauro de disco.

Name	Tipo	Description
id	string	ID do ponto de restauro do disco.
replicationStatus	DiskRestorePointReplicationStatus	As informações do estado de replicação do ponto de restauro do disco.

DiskRestorePointReplicationStatus

A vista de instância de um ponto de restauro de disco.

Name	Tipo	Description
completionPercent	integer	Percentagem de conclusão da replicação.
status	InstanceViewStatus	As informações do estado do recurso.

EncryptionIdentity

Especifica a Identidade Gerida utilizada pela ADE para obter o token de acesso para operações de keyvault.

Name	Tipo	Description
userAssignedIdentityResourceId	string	Especifica o ID de Recurso do ARM de uma das identidades de utilizador associadas à VM.

HardwareProfile

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

Name	Tipo	Description
vmSize	VirtualMachineSizeTypes	Especifica o tamanho da máquina virtual. O tipo de dados de enumeração foi preterido e será removido até 23 de dezembro de 2023. A forma recomendada de obter a lista de tamanhos disponíveis é utilizar estas APIs: listar todos os tamanhos de máquinas virtuais disponíveis num conjunto de disponibilidade, Listar todos os tamanhos de máquinas virtuais disponíveis numa região, Listar todos os tamanhos de máquinas virtuais disponíveis para redimensionamento. Para obter mais informações sobre os tamanhos das máquinas virtuais, veja Tamanhos das máquinas virtuais. Os tamanhos de VM disponíveis dependem da região e do conjunto de disponibilidade.
vmSizeProperties	VMSizeProperties	Especifica as propriedades para personalizar o tamanho da máquina virtual. Versão mínima da API: 2021-07-01. Esta funcionalidade ainda está no modo de pré-visualização e não é suportada para VirtualMachineScaleSet. Siga as instruções em Personalização da VM para obter mais detalhes.

HyperVGenerationTypes

HyperVGeneration da VM de origem para a qual o ponto de restauro é capturado.

Name	Tipo	Description
V1	string
V2	string

InnerError

Detalhes do erro interno.

Name	Tipo	Description
errordetail	string	A mensagem de erro interna ou a informação de falha de segurança da exceção.
exceptiontype	string	O tipo de exceção.

InstanceViewStatus

Estado da vista de instância.

Name	Tipo	Description
code	string	O código de estado.
displayStatus	string	A etiqueta localizável curta para o estado.
level	StatusLevelTypes	O código de nível.
message	string	A mensagem de estado detalhada, incluindo para alertas e mensagens de erro.
time	string	A hora do estado.

KeyVaultKeyReference

Descreve uma referência a Key Vault Key

Name	Tipo	Description
keyUrl	string	O URL que referencia uma chave de encriptação de chave no Key Vault.
sourceVault	SubResource	O URL relativo do Key Vault que contém a chave.

KeyVaultSecretReference

Descreve uma referência ao Segredo Key Vault

Name	Tipo	Description
secretUrl	string	O URL que referencia um segredo numa Key Vault.
sourceVault	SubResource	O URL relativo do Key Vault que contém o segredo.

LinuxConfiguration

Especifica as definições do sistema operativo Linux na máquina virtual. Para obter uma lista de distribuições suportadas do Linux, veja Linux on Azure-Endorsed Distributions (Distribuições de Azure-Endorsed).

Name	Tipo	Description
disablePasswordAuthentication	boolean	Especifica se a autenticação por palavra-passe deve ser desativada.
enableVMAgentPlatformUpdates	boolean	Indica se o Atualizações da Plataforma VMAgent está ativado para a máquina virtual do Linux. O valor predefinido é falso.
patchSettings	LinuxPatchSettings	[Funcionalidade de Pré-visualização] Especifica as definições relacionadas com a Aplicação de Patches de Convidado da VM no Linux.
provisionVMAgent	boolean	Indica se o agente de máquina virtual deve ser aprovisionado na máquina virtual. Quando esta propriedade não é especificada no corpo do pedido, o comportamento predefinido é defini-la como verdadeira. Isto irá garantir que o Agente da VM está instalado na VM para que as extensões possam ser adicionadas à VM mais tarde.
ssh	SshConfiguration	Especifica a configuração da chave ssh para um SO Linux.

LinuxPatchAssessmentMode

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

Os valores possíveis são:

ImageDefault - Controla a temporização das avaliações de patches numa máquina virtual.

AutomaticByPlatform – a plataforma irá acionar avaliações periódicas de patches. A propriedade provisionVMAgent tem de ser verdadeira.

Name	Tipo	Description
AutomaticByPlatform	string
ImageDefault	string

LinuxPatchSettings

Especifica as definições relacionadas com a Aplicação de Patches de Convidado da VM no Linux.

Name	Tipo	Description
assessmentMode	LinuxPatchAssessmentMode	Especifica o modo de Avaliação de Patches de Convidado da VM para a máquina virtual IaaS. Os valores possíveis são: ImageDefault - Controla a temporização das avaliações de patches numa máquina virtual. AutomaticByPlatform - A plataforma irá acionar avaliações periódicas de patches. A propriedade provisionVMAgent tem de ser verdadeira.
automaticByPlatformSettings	LinuxVMGuestPatchAutomaticByPlatformSettings	Especifica definições adicionais para o modo de patch AutomaticByPlatform na Aplicação de Patches de Convidado da VM no Linux.
patchMode	LinuxVMGuestPatchMode	Especifica o modo de Aplicação de Patches de Convidado da VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquinas virtuais com OrchestrationMode como Flexível. Os valores possíveis são: ImageDefault – é utilizada a configuração de aplicação de patches predefinida da máquina virtual. AutomaticByPlatform - A máquina virtual será atualizada automaticamente pela plataforma. O provisionvMAgent da propriedade tem de ser verdadeiro

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Especifica a definição de reinício para todas as operações de instalação de patch AutomaticByPlatform.

Name	Tipo	Description
Always	string
IfRequired	string
Never	string
Unknown	string

LinuxVMGuestPatchAutomaticByPlatformSettings

Especifica definições adicionais a aplicar quando o modo de patch AutomaticByPlatform está selecionado nas definições de patch do Linux.

Name	Tipo	Description
bypassPlatformSafetyChecksOnUserSchedule	boolean	Permite ao cliente agendar a aplicação de patches sem atualizações acidentais
rebootSetting	LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Especifica a definição de reinício para todas as operações de instalação de patch AutomaticByPlatform.

LinuxVMGuestPatchMode

Especifica o modo de Aplicação de Patches de Convidado da VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquinas virtuais com OrchestrationMode como Flexível.

Os valores possíveis são:

ImageDefault – é utilizada a configuração de aplicação de patches predefinida da máquina virtual.

AutomaticByPlatform – a máquina virtual será atualizada automaticamente pela plataforma. A propriedade provisionVMAgent tem de ser verdadeira

Name	Tipo	Description
AutomaticByPlatform	string
ImageDefault	string

ManagedDiskParameters

Os parâmetros de um disco gerido.

Name	Tipo	Description
diskEncryptionSet	DiskEncryptionSetParameters	Especifica o ID de recurso do conjunto de encriptação de disco gerido pelo cliente para o disco gerido.
id	string	ID do Recurso
securityProfile	VMDiskSecurityProfile	Especifica o perfil de segurança do disco gerido.
storageAccountType	StorageAccountTypes	Especifica o tipo de conta de armazenamento para o disco gerido. NOTA: UltraSSD_LRS só podem ser utilizadas com discos de dados, não podem ser utilizadas com o Disco do SO.

Mode

Especifica o modo em que o ProxyAgent será executado se a funcionalidade estiver ativada. O ProxyAgent começará a auditar ou monitorizar, mas não imporá o controlo de acesso sobre os pedidos para alojar pontos finais no Modo de auditoria, enquanto no modo Impor irá impor o controlo de acesso. O valor predefinido é Impor modo.

Name	Tipo	Description
Audit	string
Enforce	string

OperatingSystemType

Obtém o tipo de Sistema Operativo.

Name	Tipo	Description
Linux	string
Windows	string

OSProfile

Especifica as definições do sistema operativo para a máquina virtual. Algumas das definições não podem ser alteradas depois de a VM ser aprovisionada.

Name	Tipo	Description
adminPassword	string	Especifica a palavra-passe da conta de administrador. Comprimento mínimo (Windows): 8 carateres Comprimento mínimo (Linux): 6 carateres Comprimento máximo (Windows): 123 carateres Comprimento máximo (Linux): 72 carateres Requisitos de complexidade: 3 em 4 condições abaixo têm de ser cumpridas Tem carateres mais baixos Tem carateres superiores Tem um dígito Tem um caráter especial (correspondência regex [\W_]) Valores não permitidos: "abc@123", "P@$$w 0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" Para repor a palavra-passe, veja Como repor o serviço de Ambiente de Trabalho Remoto ou a palavra-passe de início de sessão numa VM do Windows Para repor a palavra-passe de raiz, veja Gerir utilizadores, SSH e verificar ou reparar discos em VMs do Linux do Azure com a Extensão VMAccess
adminUsername	string	Especifica o nome da conta de administrador. Esta propriedade não pode ser atualizada depois de a VM ser criada. Restrição apenas para Windows: Não é possível terminar em "". Valores não permitidos: "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". Comprimento mínimo (Linux): 1 caráter Comprimento máximo (Linux): 64 carateres Comprimento máximo (Windows): 20 carateres.
allowExtensionOperations	boolean	Especifica se as operações de extensão devem ser permitidas na máquina virtual. Isto só pode ser definido como Falso quando não existem extensões na máquina virtual.
computerName	string	Especifica o nome do SO anfitrião da máquina virtual. Não é possível atualizar este nome depois de a VM ser criada. Comprimento máximo (Windows): 15 carateres. Comprimento máximo (Linux): 64 carateres. Para convenções de nomenclatura e restrições, veja Diretrizes de implementação dos serviços de infraestrutura do Azure.
customData	string	Especifica uma cadeia codificada de base 64 de dados personalizados. A cadeia codificada de base 64 é descodificada para uma matriz binária que é guardada como um ficheiro na Máquina Virtual. O comprimento máximo da matriz binária é de 65535 bytes. Nota: não transmita segredos ou palavras-passe na propriedade customData. Esta propriedade não pode ser atualizada depois de a VM ser criada. A propriedade "customData" é transmitida à VM para ser guardada como um ficheiro. Para obter mais informações, consulte Dados Personalizados em VMs do Azure. Para utilizar o cloud-init para a VM do Linux, veja Utilizar o cloud-init para personalizar uma VM do Linux durante a criação.
linuxConfiguration	LinuxConfiguration	Especifica as definições do sistema operativo Linux na máquina virtual. Para obter uma lista de distribuições suportadas do Linux, veja Linux on Azure-Endorsed Distributions (Distribuições de Azure-Endorsed).
requireGuestProvisionSignal	boolean	Propriedade opcional que tem de ser definida como Verdadeiro ou omitida.
secrets	VaultSecretGroup[]	Especifica o conjunto de certificados que devem ser instalados na máquina virtual. Para instalar certificados numa máquina virtual, recomenda-se que utilize a extensão de máquina virtual do Azure Key Vault para Linux ou a extensão de máquina virtual do Azure Key Vault para Windows.
windowsConfiguration	WindowsConfiguration	Especifica as definições do sistema operativo Windows na máquina virtual.

PassNames

O nome do passe. Atualmente, o único valor permitido é OobeSystem.

Name	Tipo	Description
OobeSystem	string

PatchSettings

Especifica as definições relacionadas com a Aplicação de Patches de Convidado da VM no Windows.

Name	Tipo	Description
assessmentMode	WindowsPatchAssessmentMode	Especifica o modo de avaliação do patch convidado da VM para a máquina virtual IaaS. Os valores possíveis são: ImageDefault - Controla a temporização das avaliações de patches numa máquina virtual. AutomaticByPlatform - A plataforma irá acionar avaliações periódicas de patches. A propriedade provisionVMAgent tem de ser verdadeira.
automaticByPlatformSettings	WindowsVMGuestPatchAutomaticByPlatformSettings	Especifica definições adicionais para o modo de patch AutomaticByPlatform na Aplicação de Patches de Convidado da VM no Windows.
enableHotpatching	boolean	Permite aos clientes corrigirem as VMs do Azure sem precisarem de reiniciar. Para enableHotpatching, o "provisionVMAgent" tem de ser definido como verdadeiro e "patchMode" tem de ser definido como "AutomaticByPlatform".
patchMode	WindowsVMGuestPatchMode	Especifica o modo de Aplicação de Patches de Convidado da VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquinas virtuais com OrchestrationMode como Flexível. Os valores possíveis são: Manual – controla a aplicação de patches numa máquina virtual. Pode fazê-lo ao aplicar patches manualmente dentro da VM. Neste modo, as atualizações automáticas são desativadas; a propriedade WindowsConfiguration.enableAutomaticUpdates tem de ser falsa AutomaticByOS – a máquina virtual será atualizada automaticamente pelo SO. A propriedade WindowsConfiguration.enableAutomaticUpdates tem de ser verdadeira. AutomaticByPlatform – a máquina virtual será atualizada automaticamente pela plataforma. As propriedades provisionVMAgent e WindowsConfiguration.enableAutomaticUpdates têm de ser verdadeiras

ProtocolTypes

Especifica o protocolo do serviço de escuta WinRM. Os valores possíveis são: http,https.

Name	Tipo	Description
Http	string
Https	string

ProxyAgentSettings

Especifica as definições do ProxyAgent ao criar a máquina virtual. Versão mínima da API: 2024-03-01.

Name	Tipo	Description
enabled	boolean	Especifica se a funcionalidade ProxyAgent deve ser ativada na máquina virtual ou no conjunto de dimensionamento de máquinas virtuais.
keyIncarnationId	integer	Aumentar o valor desta propriedade permite ao utilizador repor a chave utilizada para proteger o canal de comunicação entre o convidado e o anfitrião.
mode	Mode	Especifica o modo em que o ProxyAgent será executado se a funcionalidade estiver ativada. O ProxyAgent começará a auditar ou monitorizar, mas não imporá o controlo de acesso sobre pedidos para alojar pontos finais no modo auditoria, enquanto no modo Impor irá impor o controlo de acesso. O valor predefinido é Impor modo.

RestorePoint

Detalhes do Ponto de Restauro.

Name	Tipo	Description
id	string	ID do Recurso
name	string	Nome do recurso
properties.consistencyMode	ConsistencyModeTypes	ConsistencyMode do RestorePoint. Pode ser especificado na entrada ao criar um ponto de restauro. Por enquanto, apenas CrashConsistent é aceite como uma entrada válida. Veja para https://aka.ms/RestorePoints obter mais detalhes.
properties.excludeDisks	ApiEntityReference[]	Lista de IDs de recursos de disco que o cliente pretende excluir do ponto de restauro. Se não forem especificados discos, todos os discos serão incluídos.
properties.instanceView	RestorePointInstanceView	A vista de instância do ponto de restauro.
properties.provisioningState	string	Obtém o estado de aprovisionamento do ponto de restauro.
properties.sourceMetadata	RestorePointSourceMetadata	Obtém os detalhes da VM capturada no momento da criação do ponto de restauro.
properties.sourceRestorePoint	ApiEntityReference	ID do recurso do ponto de restauro de origem a partir do qual é necessário criar uma cópia.
properties.timeCreated	string	Obtém a hora de criação do ponto de restauro.
type	string	Tipo de recurso

RestorePointCollection

Criar ou atualizar parâmetros de coleção do Ponto de Restauro.

Name	Tipo	Description
id	string	ID do Recurso
location	string	Localização do recurso
name	string	Nome do recurso
properties.provisioningState	string	O estado de aprovisionamento da coleção de pontos de restauro.
properties.restorePointCollectionId	string	O ID exclusivo da coleção de pontos de restauro.
properties.restorePoints	RestorePoint[]	Uma lista que contém todos os pontos de restauro criados nesta coleção de pontos de restauro.
properties.source	RestorePointCollectionSourceProperties	As propriedades do recurso de origem a partir do qual esta coleção de pontos de restauro é criada.
tags	object	Etiquetas de recursos
type	string	Tipo de recurso

RestorePointCollectionSourceProperties

As propriedades do recurso de origem a partir do qual esta coleção de pontos de restauro é criada.

Name	Tipo	Description
id	string	ID do recurso de origem utilizado para criar esta coleção de pontos de restauro
location	string	Localização do recurso de origem utilizado para criar esta coleção de pontos de restauro.

RestorePointCollectionUpdate

Atualizar parâmetros de coleção do Ponto de Restauro.

Name	Tipo	Description
properties.provisioningState	string	O estado de aprovisionamento da coleção de pontos de restauro.
properties.restorePointCollectionId	string	O ID exclusivo da coleção de pontos de restauro.
properties.restorePoints	RestorePoint[]	Uma lista que contém todos os pontos de restauro criados nesta coleção de pontos de restauro.
properties.source	RestorePointCollectionSourceProperties	As propriedades do recurso de origem a partir do qual esta coleção de pontos de restauro é criada.
tags	object	Etiquetas de recursos

RestorePointEncryption

Definições de encriptação inativa para o ponto de restauro do disco. É uma propriedade opcional que pode ser especificada na entrada ao criar um ponto de restauro.

Name	Tipo	Description
diskEncryptionSet	DiskEncryptionSetParameters	Descreve o parâmetro do ID de recurso do conjunto de encriptação de discos geridos pelo cliente que pode ser especificado para o disco. Nota: O ID de recurso do conjunto de encriptação de discos só pode ser especificado para o disco gerido. https://aka.ms/mdssewithcmkoverview Veja mais detalhes.
type	RestorePointEncryptionType	O tipo de chave utilizada para encriptar os dados do ponto de restauro do disco.

RestorePointEncryptionType

O tipo de chave utilizada para encriptar os dados do ponto de restauro do disco.

Name	Tipo	Description
EncryptionAtRestWithCustomerKey	string	O Ponto de Restauro do Disco é encriptado inativo com a chave gerida pelo cliente que pode ser alterada e revogada por um cliente.
EncryptionAtRestWithPlatformAndCustomerKeys	string	O Ponto de Restauro do Disco é encriptado inativo com 2 camadas de encriptação. Uma das chaves é Gerida pelo cliente e a outra é Gerida pela plataforma.
EncryptionAtRestWithPlatformKey	string	O Ponto de Restauro do Disco é encriptado inativo com a chave gerida pela plataforma.

RestorePointInstanceView

A vista de instância de um ponto de restauro.

Name	Tipo	Description
diskRestorePoints	DiskRestorePointInstanceView[]	As informações dos pontos de restauro do disco.
statuses	InstanceViewStatus[]	As informações de estado do recurso.

RestorePointSourceMetadata

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

Name	Tipo	Description
diagnosticsProfile	DiagnosticsProfile	Obtém o perfil de diagnóstico.
hardwareProfile	HardwareProfile	Obtém o perfil de hardware.
hyperVGeneration	HyperVGenerationTypes	HyperVGeneration da VM de origem para a qual o ponto de restauro é capturado.
licenseType	string	Obtém o tipo de licença, que se destina ao cenário traga a sua própria licença.
location	string	Localização da VM a partir da qual o ponto de restauro foi criado.
osProfile	OSProfile	Obtém o perfil do SO.
securityProfile	SecurityProfile	Obtém o perfil de segurança.
storageProfile	RestorePointSourceVMStorageProfile	Obtém o perfil de armazenamento.
userData	string	UserData associado à VM de origem para a qual o ponto de restauro é capturado, que é um valor codificado de base 64.
vmId	string	Obtém o ID exclusivo da máquina virtual.

RestorePointSourceVMDataDisk

Descreve um disco de dados.

Name	Tipo	Description
caching	CachingTypes	Obtém o tipo de colocação em cache.
diskRestorePoint	DiskRestorePointAttributes	Contém propriedades do Ponto de Restauro do Disco.
diskSizeGB	integer	Obtém o tamanho do disco inicial em GB para discos de dados em branco e o novo tamanho pretendido para discos de SO e Dados existentes.
lun	integer	Obtém o número da unidade lógica.
managedDisk	ManagedDiskParameters	Contém os detalhes do disco gerido.
name	string	Obtém o nome do disco.
writeAcceleratorEnabled	boolean	Mostra verdadeiro se o disco estiver ativado para acelerador de escrita.

RestorePointSourceVMOSDisk

Descreve um disco do Sistema Operativo.

Name	Tipo	Description
caching	CachingTypes	Obtém o tipo de colocação em cache.
diskRestorePoint	DiskRestorePointAttributes	Contém propriedades do Ponto de Restauro do Disco.
diskSizeGB	integer	Obtém o tamanho do disco em GB.
encryptionSettings	DiskEncryptionSettings	Obtém as definições de encriptação do disco.
managedDisk	ManagedDiskParameters	Obtém os detalhes do disco gerido
name	string	Obtém o nome do disco.
osType	OperatingSystemType	Obtém o tipo de Sistema Operativo.
writeAcceleratorEnabled	boolean	Mostra verdadeiro se o disco estiver ativado para acelerador de escrita.

RestorePointSourceVMStorageProfile

Descreve o perfil de armazenamento.

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

securityEncryptionTypes

Especifica o EncryptionType do disco gerido. Está definido como DiskWithVMGuestState para encriptação do disco gerido juntamente com o blob VMGuestState, VMGuestStateOnly para encriptação apenas do blob VMGuestState e NonPersistedTPM para não persistir o estado de firmware no blob VMGuestState.. Nota: Só pode ser definido para VMs Confidenciais.

Name	Tipo	Description
DiskWithVMGuestState	string
NonPersistedTPM	string
VMGuestStateOnly	string

SecurityProfile

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

Name	Tipo	Description
encryptionAtHost	boolean	Esta propriedade pode ser utilizada pelo utilizador no pedido para ativar ou desativar a Encriptação de Anfitrião para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais. Isto irá ativar a encriptação para todos os discos, incluindo o disco Resource/Temp no próprio anfitrião. O comportamento predefinido é: a Encriptação no anfitrião será desativada, a menos que esta propriedade esteja definida como verdadeira para o recurso.
encryptionIdentity	EncryptionIdentity	Especifica a Identidade Gerida utilizada pela ADE para obter o token de acesso para operações de keyvault.
proxyAgentSettings	ProxyAgentSettings	Especifica as definições do ProxyAgent ao criar a máquina virtual. Versão mínima da API: 2024-03-01.
securityType	SecurityTypes	Especifica o SecurityType da máquina virtual. Tem de ser definido como qualquer valor especificado para ativar UefiSettings. O comportamento predefinido é: UefiSettings não será ativado a menos que esta propriedade esteja definida.
uefiSettings	UefiSettings	Especifica as definições de segurança, como o arranque seguro e o vTPM utilizados ao criar a máquina virtual. Versão mínima da API: 2020-12-01.

SecurityTypes

Especifica o SecurityType da máquina virtual. Tem de ser definido como qualquer valor especificado para ativar UefiSettings. O comportamento predefinido é: UefiSettings não será ativado a menos que esta propriedade esteja definida.

Name	Tipo	Description
ConfidentialVM	string
TrustedLaunch	string

SettingNames

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

Name	Tipo	Description
AutoLogon	string
FirstLogonCommands	string

SshConfiguration

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

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

SshPublicKey

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

Name	Tipo	Description
keyData	string	Certificado de chave pública SSH utilizado para autenticar com a VM através de ssh. A chave tem de ter, pelo menos, 2048 bits e estar no formato ssh-rsa. Para criar chaves ssh, veja [Criar chaves SSH no Linux e Mac para VMs do Linux no Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).
path	string	Especifica o caminho completo na VM criada onde a chave pública ssh está armazenada. Se o ficheiro já existir, a chave especificada é anexada ao ficheiro. Exemplo: /home/user/.ssh/authorized_keys

StatusLevelTypes

O código de nível.

Name	Tipo	Description
Error	string
Info	string
Warning	string

StorageAccountTypes

Especifica o tipo de conta de armazenamento para o disco gerido. NOTA: UltraSSD_LRS só podem ser utilizadas com discos de dados, não podem ser utilizadas com o Disco do SO.

Name	Tipo	Description
PremiumV2_LRS	string
Premium_LRS	string
Premium_ZRS	string
StandardSSD_LRS	string
StandardSSD_ZRS	string
Standard_LRS	string
UltraSSD_LRS	string

SubResource

Name	Tipo	Description
id	string	ID do Recurso

UefiSettings

Especifica as definições de segurança, como o arranque seguro e o vTPM utilizados ao criar a máquina virtual. Versão mínima da API: 2020-12-01.

Name	Tipo	Description
secureBootEnabled	boolean	Especifica se o arranque seguro deve ser ativado na máquina virtual. Versão mínima da API: 2020-12-01.
vTpmEnabled	boolean	Especifica se o vTPM deve ser ativado na máquina virtual. Versão mínima da API: 2020-12-01.

VaultCertificate

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

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

VaultSecretGroup

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

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

VirtualMachineSizeTypes

Especifica o tamanho da máquina virtual. O tipo de dados de numeração está atualmente preterido e será removido até 23 de dezembro de 2023. A forma recomendada de obter a lista de tamanhos disponíveis é utilizar estas APIs: Listar todos os tamanhos de máquinas virtuais disponíveis num conjunto de disponibilidade, Listar todos os tamanhos de máquinas virtuais disponíveis numa região, Listar todos os tamanhos de máquinas virtuais disponíveis para redimensionamento. Para obter mais informações sobre tamanhos de máquinas virtuais, veja Tamanhos para máquinas virtuais. Os tamanhos de VM disponíveis dependem da região e do conjunto de disponibilidade.

Name	Tipo	Description
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

Especifica as definições do perfil de segurança para o disco gerido. Nota: Só pode ser definido para VMs Confidenciais.

Name	Tipo	Description
diskEncryptionSet	DiskEncryptionSetParameters	Especifica o ID de recurso do conjunto de encriptação de discos geridos pelo cliente para o disco gerido que é utilizado para o Disco do SO ConfidentialVM encriptado por Chave Gerida pelo Cliente e o blob VMGuest.
securityEncryptionType	securityEncryptionTypes	Especifica o EncryptionType do disco gerido. Está definido como DiskWithVMGuestState para encriptação do disco gerido juntamente com o blob VMGuestState, VMGuestStateOnly para encriptação apenas do blob VMGuestState e NonPersistedTPM para não persistir o estado de firmware no blob VMGuestState.. Nota: Só pode ser definido para VMs Confidenciais.

VMSizeProperties

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

Name	Tipo	Description
vCPUsAvailable	integer	Especifica o número de vCPUs disponíveis para a VM. Quando esta propriedade não é especificada no corpo do pedido, o comportamento predefinido é defini-la para o valor das vCPUs disponíveis para esse tamanho de VM exposto na resposta da API de Listar todos os tamanhos de máquinas virtuais disponíveis numa região.
vCPUsPerCore	integer	Especifica a relação vCPU com o núcleo físico. Quando esta propriedade não é especificada no corpo do pedido, o comportamento predefinido é definido para o valor de vCPUsPerCore para o Tamanho da VM exposto na resposta da API de Listar todos os tamanhos de máquinas virtuais disponíveis numa região. Definir esta propriedade como 1 também significa que o hyper-threading está desativado.

WindowsConfiguration

Especifica as definições do sistema operativo Windows na máquina virtual.

Name	Tipo	Description
additionalUnattendContent	AdditionalUnattendContent[]	Especifica informações formatadas XML codificadas com base 64 adicionais que podem ser incluídas no ficheiro Unattend.xml, que é utilizado pela Configuração do Windows.
enableAutomaticUpdates	boolean	Indica se a Atualizações automática está ativada para a máquina virtual do Windows. O valor predefinido é verdadeiro. Para conjuntos de dimensionamento de máquinas virtuais, esta propriedade pode ser atualizada e as atualizações entrarão em vigor no reaprovisionamento do SO.
enableVMAgentPlatformUpdates	boolean	Indica se o Atualizações da Plataforma VMAgent está ativado para a máquina virtual do Windows. O valor predefinido é falso.
patchSettings	PatchSettings	[Funcionalidade de Pré-visualização] Especifica as definições relacionadas com a Aplicação de Patches de Convidado da VM no Windows.
provisionVMAgent	boolean	Indica se o agente de máquina virtual deve ser aprovisionado na máquina virtual. Quando esta propriedade não é especificada no corpo do pedido, esta é definida como true por predefinição. Isto irá garantir que o Agente da VM está instalado na VM para que as extensões possam ser adicionadas à VM mais tarde.
timeZone	string	Especifica o fuso horário da máquina virtual. por exemplo, "Hora Padrão do Pacífico". Os valores possíveis podem ser TimeZoneInfo.Id valor dos fusos horários devolvidos por TimeZoneInfo.GetSystemTimeZones.
winRM	WinRMConfiguration	Especifica os serviços de escuta da Gestão Remota do Windows. Isto permite Windows PowerShell remotos.

WindowsPatchAssessmentMode

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

Os valores possíveis são:

ImageDefault - Controla a temporização das avaliações de patches numa máquina virtual.

AutomaticByPlatform – a plataforma irá acionar avaliações periódicas de patches. A propriedade provisionVMAgent tem de ser verdadeira.

Name	Tipo	Description
AutomaticByPlatform	string
ImageDefault	string

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Especifica a definição de reinício para todas as operações de instalação de patch AutomaticByPlatform.

Name	Tipo	Description
Always	string
IfRequired	string
Never	string
Unknown	string

WindowsVMGuestPatchAutomaticByPlatformSettings

Especifica definições adicionais a aplicar quando o modo de patch AutomaticByPlatform está selecionado nas definições de patch do Windows.

Name	Tipo	Description
bypassPlatformSafetyChecksOnUserSchedule	boolean	Permite ao cliente agendar a aplicação de patches sem atualizações acidentais
rebootSetting	WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Especifica a definição de reinício para todas as operações de instalação de patch AutomaticByPlatform.

WindowsVMGuestPatchMode

Especifica o modo de Aplicação de Patches de Convidado da VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquinas virtuais com OrchestrationMode como Flexível.

Os valores possíveis são:

Manual – controla a aplicação de patches a uma máquina virtual. Pode fazê-lo ao aplicar patches manualmente dentro da VM. Neste modo, as atualizações automáticas estão desativadas; a propriedade WindowsConfiguration.enableAutomaticUpdates tem de ser falsa

AutomaticByOS – a máquina virtual será atualizada automaticamente pelo SO. A propriedade WindowsConfiguration.enableAutomaticUpdates tem de ser verdadeira.

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

Name	Tipo	Description
AutomaticByOS	string
AutomaticByPlatform	string
Manual	string

WinRMConfiguration

Descreve a configuração da Gestão Remota do Windows da VM

Name	Tipo	Description
listeners	WinRMListener[]	A lista de serviços de escuta da Gestão Remota do Windows

WinRMListener

Descreve o Protocolo e o thumbprint do serviço de escuta da Gestão Remota do Windows

Name	Tipo	Description
certificateUrl	string	Este é o URL de um certificado que foi carregado para Key Vault como segredo. Para adicionar um segredo à Key Vault, consulte Adicionar uma chave ou segredo ao cofre de chaves. Neste caso, o certificado tem de ser a codificação Base64 do seguinte Objeto JSON codificado em UTF-8: { "data":"", "dataType":"pfx", "password":"" } Para instalar certificados numa máquina virtual, é recomendado utilizar a extensão de máquina virtual do Azure Key Vault para Linux ou a extensão de máquina virtual do Azure Key Vault para Windows.
protocol	ProtocolTypes	Especifica o protocolo do serviço de escuta WinRM. Os valores possíveis são: http,https.