Virtual Machine Scale Set VMs - Get

Service:: Compute

Version d'API:: 2025-04-01

Obtient une machine virtuelle à partir d’un groupe de machines virtuelles identiques.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
instanceId	path	True	string	ID d’instance de la machine virtuelle.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string minLength: 1	ID de l’abonnement cible.
vmScaleSetName	path	True	string	Nom du groupe de machines virtuelles identiques.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
$expand	query		InstanceViewTypes	Expression de développement à appliquer à l’opération. 'InstanceView' récupère la vue d’instance de la machine virtuelle. 'UserData' récupérera les UserData de la machine virtuelle.

Réponses

Nom	Type	Description
200 OK	VirtualMachineScaleSetVM	L’opération Azure s’est terminée avec succès.
Other Status Codes	CloudError	Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Get VM scale set VM with ResiliencyView

Get VM scale set VM with UserData

Get VM scale set VM with VMSizeProperties

Get VM scale set VM with ResiliencyView

Exemple de requête

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/1?api-version=2025-04-01


/**
 * Samples for VirtualMachineScaleSetVMs Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithResilientVMDeletionStatus.json
     */
    /**
     * Sample code: Get VM scale set VM with ResiliencyView.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getVMScaleSetVMWithResiliencyView(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSetVMs()
            .getWithResponse("myResourceGroup", "{vmss-name}", "1", 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 virtual_machine_scale_set_vm_get_with_resilient_vm_deletion_status.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.virtual_machine_scale_set_vms.get(
        resource_group_name="myResourceGroup",
        vm_scale_set_name="{vmss-name}",
        instance_id="1",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithResilientVMDeletionStatus.json
if __name__ == "__main__":
    main()

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

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7033e85e1f80ef5cd9ca664b538ed193a8fd815b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithResilientVMDeletionStatus.json
func ExampleVirtualMachineScaleSetVMsClient_Get_getVmScaleSetVmWithResiliencyView() {
	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.NewVirtualMachineScaleSetVMsClient().Get(ctx, "myResourceGroup", "{vmss-name}", "1", &armcompute.VirtualMachineScaleSetVMsClientGetOptions{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.VirtualMachineScaleSetVM = armcompute.VirtualMachineScaleSetVM{
	// 	Name: to.Ptr("{vmss-vm-name}"),
	// 	Type: to.Ptr("Microsoft.Compute/virtualMachineScaleSets/virtualMachines"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/1"),
	// 	Location: to.Ptr("eastus2euap"),
	// 	Etag: to.Ptr("\"3\""),
	// 	Identity: &armcompute.VirtualMachineIdentity{
	// 		Type: to.Ptr(armcompute.ResourceIdentityTypeUserAssigned),
	// 		UserAssignedIdentities: map[string]*armcompute.UserAssignedIdentitiesValue{
	// 			"/subscriptions/{subscription-id}/resourceGroups/AzSecPackAutoConfigRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/AzSecPackAutoConfigUA-eastus2euap": &armcompute.UserAssignedIdentitiesValue{
	// 				ClientID: to.Ptr("215414c9-8a82-4439-95ea-d09e3543a6e2"),
	// 				PrincipalID: to.Ptr("f31e5089-a1e5-44a6-9048-a767ce07d26c"),
	// 			},
	// 		},
	// 	},
	// 	InstanceID: to.Ptr("1"),
	// 	Properties: &armcompute.VirtualMachineScaleSetVMProperties{
	// 		DiagnosticsProfile: &armcompute.DiagnosticsProfile{
	// 			BootDiagnostics: &armcompute.BootDiagnostics{
	// 				Enabled: to.Ptr(true),
	// 			},
	// 		},
	// 		HardwareProfile: &armcompute.HardwareProfile{
	// 			VMSize: to.Ptr(armcompute.VirtualMachineSizeTypes("Standard_D2ls_v5")),
	// 		},
	// 		LatestModelApplied: to.Ptr(true),
	// 		ModelDefinitionApplied: to.Ptr("VirtualMachineScaleSet"),
	// 		NetworkProfile: &armcompute.NetworkProfile{
	// 			NetworkInterfaces: []*armcompute.NetworkInterfaceReference{
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/1/networkInterfaces/vnet-eastus2euap-2-nic01"),
	// 			}},
	// 		},
	// 		NetworkProfileConfiguration: &armcompute.VirtualMachineScaleSetVMNetworkProfileConfiguration{
	// 			NetworkInterfaceConfigurations: []*armcompute.VirtualMachineScaleSetNetworkConfiguration{
	// 				{
	// 					Name: to.Ptr("vnet-eastus2euap-2-nic01"),
	// 					Properties: &armcompute.VirtualMachineScaleSetNetworkConfigurationProperties{
	// 						DisableTCPStateTracking: to.Ptr(false),
	// 						DNSSettings: &armcompute.VirtualMachineScaleSetNetworkConfigurationDNSSettings{
	// 							DNSServers: []*string{
	// 							},
	// 						},
	// 						EnableAcceleratedNetworking: to.Ptr(true),
	// 						EnableIPForwarding: to.Ptr(false),
	// 						IPConfigurations: []*armcompute.VirtualMachineScaleSetIPConfiguration{
	// 							{
	// 								Name: to.Ptr("vnet-eastus2euap-2-nic01-defaultIpConfiguration"),
	// 								Properties: &armcompute.VirtualMachineScaleSetIPConfigurationProperties{
	// 									Primary: to.Ptr(true),
	// 									PrivateIPAddressVersion: to.Ptr(armcompute.IPVersionIPv4),
	// 									Subnet: &armcompute.APIEntityReference{
	// 										ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet-eastus2euap-2/subnets/snet-eastus2euap-1"),
	// 									},
	// 								},
	// 						}},
	// 						NetworkSecurityGroup: &armcompute.SubResource{
	// 							ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/basicNsgvnet-eastus2euap-2-nic01"),
	// 						},
	// 						Primary: to.Ptr(true),
	// 					},
	// 			}},
	// 		},
	// 		OSProfile: &armcompute.OSProfile{
	// 			AdminUsername: to.Ptr("SomeRandomUser"),
	// 			AllowExtensionOperations: to.Ptr(true),
	// 			ComputerName: to.Ptr("statustes000001"),
	// 			LinuxConfiguration: &armcompute.LinuxConfiguration{
	// 				DisablePasswordAuthentication: to.Ptr(false),
	// 				EnableVMAgentPlatformUpdates: to.Ptr(true),
	// 				PatchSettings: &armcompute.LinuxPatchSettings{
	// 					AssessmentMode: to.Ptr(armcompute.LinuxPatchAssessmentModeImageDefault),
	// 					PatchMode: to.Ptr(armcompute.LinuxVMGuestPatchModeImageDefault),
	// 				},
	// 				ProvisionVMAgent: to.Ptr(true),
	// 			},
	// 			RequireGuestProvisionSignal: to.Ptr(true),
	// 			Secrets: []*armcompute.VaultSecretGroup{
	// 			},
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		ResilientVMDeletionStatus: to.Ptr(armcompute.ResilientVMDeletionStatusEnabled),
	// 		SecurityProfile: &armcompute.SecurityProfile{
	// 			SecurityType: to.Ptr(armcompute.SecurityTypesTrustedLaunch),
	// 			UefiSettings: &armcompute.UefiSettings{
	// 				SecureBootEnabled: to.Ptr(true),
	// 				VTpmEnabled: to.Ptr(true),
	// 			},
	// 		},
	// 		StorageProfile: &armcompute.StorageProfile{
	// 			DataDisks: []*armcompute.DataDisk{
	// 			},
	// 			DiskControllerType: to.Ptr(armcompute.DiskControllerTypesSCSI),
	// 			ImageReference: &armcompute.ImageReference{
	// 				ExactVersion: to.Ptr("20.04.202501110"),
	// 				Offer: to.Ptr("0001-com-ubuntu-server-focal"),
	// 				Publisher: to.Ptr("canonical"),
	// 				SKU: to.Ptr("20_04-lts-gen2"),
	// 				Version: to.Ptr("latest"),
	// 			},
	// 			OSDisk: &armcompute.OSDisk{
	// 				Name: to.Ptr("{vmss-name}_{vmss-vm-name}_OsDisk_1_8e93ddcf18be4b0f9815910b3a0f8182"),
	// 				Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 				CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesFromImage),
	// 				DiskSizeGB: to.Ptr[int32](30),
	// 				ManagedDisk: &armcompute.ManagedDiskParameters{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/{vmss-name}_{vmss-vm-name}_OsDisk_1_8e93ddcf18be4b0f9815910b3a0f8182"),
	// 					StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 				},
	// 				OSType: to.Ptr(armcompute.OperatingSystemTypesLinux),
	// 			},
	// 		},
	// 		TimeCreated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-02-05T20:11:32.572Z"); return t}()),
	// 		VMID: to.Ptr("eb282db2-12d4-4fc6-8bd5-0c6473a4078c"),
	// 	},
	// 	Resources: []*armcompute.VirtualMachineExtension{
	// 		{
	// 			Name: to.Ptr("Microsoft.Azure.Security.Monitoring.AzureSecurityLinuxAgent"),
	// 			Type: to.Ptr("Microsoft.Compute/virtualMachines/extensions"),
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/{vmss-vm-name}/extensions/Microsoft.Azure.Security.Monitoring.AzureSecurityLinuxAgent"),
	// 			Location: to.Ptr("eastus2euap"),
	// 			Properties: &armcompute.VirtualMachineExtensionProperties{
	// 				Type: to.Ptr("AzureSecurityLinuxAgent"),
	// 				AutoUpgradeMinorVersion: to.Ptr(true),
	// 				EnableAutomaticUpgrade: to.Ptr(true),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				Publisher: to.Ptr("Microsoft.Azure.Security.Monitoring"),
	// 				Settings: map[string]any{
	// 					"enableAutoConfig": true,
	// 					"enableGenevaUpload": true,
	// 					"reportSuccessOnUnsupportedDistro": true,
	// 				},
	// 				TypeHandlerVersion: to.Ptr("2.0"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.Azure.Monitor.AzureMonitorLinuxAgent"),
	// 			Type: to.Ptr("Microsoft.Compute/virtualMachines/extensions"),
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/{vmss-vm-name}/extensions/Microsoft.Azure.Monitor.AzureMonitorLinuxAgent"),
	// 			Location: to.Ptr("eastus2euap"),
	// 			Properties: &armcompute.VirtualMachineExtensionProperties{
	// 				Type: to.Ptr("AzureMonitorLinuxAgent"),
	// 				AutoUpgradeMinorVersion: to.Ptr(true),
	// 				EnableAutomaticUpgrade: to.Ptr(true),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				Publisher: to.Ptr("Microsoft.Azure.Monitor"),
	// 				Settings: map[string]any{
	// 					"GCS_AUTO_CONFIG": true,
	// 				},
	// 				TypeHandlerVersion: to.Ptr("1.0"),
	// 			},
	// 	}},
	// 	SKU: &armcompute.SKU{
	// 		Name: to.Ptr("Standard_D2ls_v5"),
	// 		Tier: to.Ptr("Standard"),
	// 	},
	// }
}

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 Gets a virtual machine from a VM scale set.
 *
 * @summary Gets a virtual machine from a VM scale set.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithResilientVMDeletionStatus.json
 */
async function getVMScaleSetVMWithResiliencyView() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmScaleSetName = "{vmss-name}";
  const instanceId = "1";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSetVMs.get(
    resourceGroupName,
    vmScaleSetName,
    instanceId,
  );
  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.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithResilientVMDeletionStatus.json
// this example is just showing the usage of "VirtualMachineScaleSetVMs_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 VirtualMachineScaleSetResource created on azure
// for more information of creating VirtualMachineScaleSetResource, please refer to the document of VirtualMachineScaleSetResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "{vmss-name}";
ResourceIdentifier virtualMachineScaleSetResourceId = VirtualMachineScaleSetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName);
VirtualMachineScaleSetResource virtualMachineScaleSet = client.GetVirtualMachineScaleSetResource(virtualMachineScaleSetResourceId);

// get the collection of this VirtualMachineScaleSetVmResource
VirtualMachineScaleSetVmCollection collection = virtualMachineScaleSet.GetVirtualMachineScaleSetVms();

// invoke the operation
string instanceId = "1";
NullableResponse<VirtualMachineScaleSetVmResource> response = await collection.GetIfExistsAsync(instanceId);
VirtualMachineScaleSetVmResource 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
    VirtualMachineScaleSetVmData 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

Exemple de réponse

Code d’état:: 200

{
  "name": "{vmss-vm-name}",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/1",
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines",
  "location": "eastus2euap",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/{subscription-id}/resourceGroups/AzSecPackAutoConfigRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/AzSecPackAutoConfigUA-eastus2euap": {
        "principalId": "f31e5089-a1e5-44a6-9048-a767ce07d26c",
        "clientId": "215414c9-8a82-4439-95ea-d09e3543a6e2"
      }
    }
  },
  "instanceId": "1",
  "sku": {
    "name": "Standard_D2ls_v5",
    "tier": "Standard"
  },
  "properties": {
    "latestModelApplied": true,
    "modelDefinitionApplied": "VirtualMachineScaleSet",
    "networkProfileConfiguration": {
      "networkInterfaceConfigurations": [
        {
          "name": "vnet-eastus2euap-2-nic01",
          "properties": {
            "primary": true,
            "enableAcceleratedNetworking": true,
            "disableTcpStateTracking": false,
            "networkSecurityGroup": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/basicNsgvnet-eastus2euap-2-nic01"
            },
            "dnsSettings": {
              "dnsServers": []
            },
            "enableIPForwarding": false,
            "ipConfigurations": [
              {
                "name": "vnet-eastus2euap-2-nic01-defaultIpConfiguration",
                "properties": {
                  "primary": true,
                  "subnet": {
                    "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet-eastus2euap-2/subnets/snet-eastus2euap-1"
                  },
                  "privateIPAddressVersion": "IPv4"
                }
              }
            ]
          }
        }
      ]
    },
    "provisioningState": "Succeeded",
    "hardwareProfile": {
      "vmSize": "Standard_D2ls_v5"
    },
    "resilientVMDeletionStatus": "Enabled",
    "vmId": "eb282db2-12d4-4fc6-8bd5-0c6473a4078c",
    "storageProfile": {
      "imageReference": {
        "publisher": "canonical",
        "offer": "0001-com-ubuntu-server-focal",
        "sku": "20_04-lts-gen2",
        "version": "latest",
        "exactVersion": "20.04.202501110"
      },
      "osDisk": {
        "osType": "Linux",
        "name": "{vmss-name}_{vmss-vm-name}_OsDisk_1_8e93ddcf18be4b0f9815910b3a0f8182",
        "createOption": "FromImage",
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS",
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/{vmss-name}_{vmss-vm-name}_OsDisk_1_8e93ddcf18be4b0f9815910b3a0f8182"
        },
        "diskSizeGB": 30
      },
      "dataDisks": [],
      "diskControllerType": "SCSI"
    },
    "osProfile": {
      "computerName": "statustes000001",
      "adminUsername": "SomeRandomUser",
      "linuxConfiguration": {
        "disablePasswordAuthentication": false,
        "provisionVMAgent": true,
        "patchSettings": {
          "patchMode": "ImageDefault",
          "assessmentMode": "ImageDefault"
        },
        "enableVMAgentPlatformUpdates": true
      },
      "secrets": [],
      "allowExtensionOperations": true,
      "requireGuestProvisionSignal": true
    },
    "securityProfile": {
      "uefiSettings": {
        "secureBootEnabled": true,
        "vTpmEnabled": true
      },
      "securityType": "TrustedLaunch"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/1/networkInterfaces/vnet-eastus2euap-2-nic01"
        }
      ]
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "enabled": true
      }
    },
    "timeCreated": "2025-02-05T20:11:32.5722157+00:00"
  },
  "etag": "\"3\"",
  "resources": [
    {
      "name": "Microsoft.Azure.Security.Monitoring.AzureSecurityLinuxAgent",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/{vmss-vm-name}/extensions/Microsoft.Azure.Security.Monitoring.AzureSecurityLinuxAgent",
      "type": "Microsoft.Compute/virtualMachines/extensions",
      "location": "eastus2euap",
      "properties": {
        "autoUpgradeMinorVersion": true,
        "provisioningState": "Succeeded",
        "enableAutomaticUpgrade": true,
        "publisher": "Microsoft.Azure.Security.Monitoring",
        "type": "AzureSecurityLinuxAgent",
        "typeHandlerVersion": "2.0",
        "settings": {
          "enableGenevaUpload": true,
          "enableAutoConfig": true,
          "reportSuccessOnUnsupportedDistro": true
        }
      }
    },
    {
      "name": "Microsoft.Azure.Monitor.AzureMonitorLinuxAgent",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/{vmss-vm-name}/extensions/Microsoft.Azure.Monitor.AzureMonitorLinuxAgent",
      "type": "Microsoft.Compute/virtualMachines/extensions",
      "location": "eastus2euap",
      "properties": {
        "autoUpgradeMinorVersion": true,
        "provisioningState": "Succeeded",
        "enableAutomaticUpgrade": true,
        "publisher": "Microsoft.Azure.Monitor",
        "type": "AzureMonitorLinuxAgent",
        "typeHandlerVersion": "1.0",
        "settings": {
          "GCS_AUTO_CONFIG": true
        }
      }
    }
  ]
}

Get VM scale set VM with UserData

Exemple de requête

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0?api-version=2025-04-01


/**
 * Samples for VirtualMachineScaleSetVMs Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithUserData.json
     */
    /**
     * Sample code: Get VM scale set VM with UserData.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getVMScaleSetVMWithUserData(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSetVMs()
            .getWithResponse("myResourceGroup", "{vmss-name}", "0", 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 virtual_machine_scale_set_vm_get_with_user_data.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.virtual_machine_scale_set_vms.get(
        resource_group_name="myResourceGroup",
        vm_scale_set_name="{vmss-name}",
        instance_id="0",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithUserData.json
if __name__ == "__main__":
    main()

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

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7033e85e1f80ef5cd9ca664b538ed193a8fd815b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithUserData.json
func ExampleVirtualMachineScaleSetVMsClient_Get_getVmScaleSetVmWithUserData() {
	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.NewVirtualMachineScaleSetVMsClient().Get(ctx, "myResourceGroup", "{vmss-name}", "0", &armcompute.VirtualMachineScaleSetVMsClientGetOptions{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.VirtualMachineScaleSetVM = armcompute.VirtualMachineScaleSetVM{
	// 	Name: to.Ptr("{vmss-vm-name}"),
	// 	Type: to.Ptr("Microsoft.Compute/virtualMachines"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"myTag1": to.Ptr("tagValue1"),
	// 	},
	// 	Etag: to.Ptr("\"1\""),
	// 	Properties: &armcompute.VirtualMachineScaleSetVMProperties{
	// 		DiagnosticsProfile: &armcompute.DiagnosticsProfile{
	// 			BootDiagnostics: &armcompute.BootDiagnostics{
	// 				Enabled: to.Ptr(true),
	// 			},
	// 		},
	// 		HardwareProfile: &armcompute.HardwareProfile{
	// 		},
	// 		LatestModelApplied: to.Ptr(true),
	// 		ModelDefinitionApplied: to.Ptr("VirtualMachineScaleSet"),
	// 		NetworkProfile: &armcompute.NetworkProfile{
	// 			NetworkInterfaces: []*armcompute.NetworkInterfaceReference{
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415"),
	// 			}},
	// 		},
	// 		NetworkProfileConfiguration: &armcompute.VirtualMachineScaleSetVMNetworkProfileConfiguration{
	// 			NetworkInterfaceConfigurations: []*armcompute.VirtualMachineScaleSetNetworkConfiguration{
	// 				{
	// 					Name: to.Ptr("vmsstestnetconfig5415"),
	// 					Properties: &armcompute.VirtualMachineScaleSetNetworkConfigurationProperties{
	// 						DNSSettings: &armcompute.VirtualMachineScaleSetNetworkConfigurationDNSSettings{
	// 							DNSServers: []*string{
	// 							},
	// 						},
	// 						EnableAcceleratedNetworking: to.Ptr(false),
	// 						EnableIPForwarding: to.Ptr(false),
	// 						IPConfigurations: []*armcompute.VirtualMachineScaleSetIPConfiguration{
	// 							{
	// 								Name: to.Ptr("vmsstestnetconfig9693"),
	// 								Properties: &armcompute.VirtualMachineScaleSetIPConfigurationProperties{
	// 									PrivateIPAddressVersion: to.Ptr(armcompute.IPVersionIPv4),
	// 									Subnet: &armcompute.APIEntityReference{
	// 										ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503"),
	// 									},
	// 								},
	// 						}},
	// 						Primary: to.Ptr(true),
	// 					},
	// 			}},
	// 		},
	// 		OSProfile: &armcompute.OSProfile{
	// 			AdminUsername: to.Ptr("Foo12"),
	// 			AllowExtensionOperations: to.Ptr(true),
	// 			ComputerName: to.Ptr("test000000"),
	// 			RequireGuestProvisionSignal: to.Ptr(true),
	// 			Secrets: []*armcompute.VaultSecretGroup{
	// 			},
	// 			WindowsConfiguration: &armcompute.WindowsConfiguration{
	// 				EnableAutomaticUpdates: to.Ptr(true),
	// 				ProvisionVMAgent: to.Ptr(true),
	// 			},
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		StorageProfile: &armcompute.StorageProfile{
	// 			DataDisks: []*armcompute.DataDisk{
	// 				{
	// 					Name: to.Ptr("vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
	// 					Caching: to.Ptr(armcompute.CachingTypesNone),
	// 					CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesEmpty),
	// 					DiskSizeGB: to.Ptr[int32](128),
	// 					Lun: to.Ptr[int32](1),
	// 					ManagedDisk: &armcompute.ManagedDiskParameters{
	// 						ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesStandardLRS),
	// 					},
	// 					ToBeDetached: to.Ptr(false),
	// 			}},
	// 			ImageReference: &armcompute.ImageReference{
	// 				ExactVersion: to.Ptr("4.127.20180315"),
	// 				Offer: to.Ptr("WindowsServer"),
	// 				Publisher: to.Ptr("MicrosoftWindowsServer"),
	// 				SKU: to.Ptr("2012-R2-Datacenter"),
	// 				Version: to.Ptr("4.127.20180315"),
	// 			},
	// 			OSDisk: &armcompute.OSDisk{
	// 				Name: to.Ptr("vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc"),
	// 				Caching: to.Ptr(armcompute.CachingTypesNone),
	// 				CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesFromImage),
	// 				DiskSizeGB: to.Ptr[int32](127),
	// 				ManagedDisk: &armcompute.ManagedDiskParameters{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc"),
	// 					StorageAccountType: to.Ptr(armcompute.StorageAccountTypesStandardLRS),
	// 				},
	// 				OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 			},
	// 		},
	// 		UserData: to.Ptr("RXhhbXBsZSBVc2VyRGF0YQ=="),
	// 		VMID: to.Ptr("42af9fdf-b906-4ad7-9905-8316209ff619"),
	// 	},
	// 	Resources: []*armcompute.VirtualMachineExtension{
	// 		{
	// 			Name: to.Ptr("CustomScriptExtension-DSC"),
	// 			Type: to.Ptr("Microsoft.Compute/virtualMachines/extensions"),
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC"),
	// 			Location: to.Ptr("westus"),
	// 			Tags: map[string]*string{
	// 				"displayName": to.Ptr("CustomScriptExtension-DSC"),
	// 			},
	// 			Properties: &armcompute.VirtualMachineExtensionProperties{
	// 				Type: to.Ptr("CustomScriptExtension"),
	// 				AutoUpgradeMinorVersion: to.Ptr(true),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				Publisher: to.Ptr("Microsoft.Compute"),
	// 				Settings: map[string]any{
	// 				},
	// 				TypeHandlerVersion: to.Ptr("1.9"),
	// 			},
	// 	}},
	// }
}

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 Gets a virtual machine from a VM scale set.
 *
 * @summary Gets a virtual machine from a VM scale set.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithUserData.json
 */
async function getVMScaleSetVMWithUserData() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmScaleSetName = "{vmss-name}";
  const instanceId = "0";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSetVMs.get(
    resourceGroupName,
    vmScaleSetName,
    instanceId,
  );
  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.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithUserData.json
// this example is just showing the usage of "VirtualMachineScaleSetVMs_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 VirtualMachineScaleSetResource created on azure
// for more information of creating VirtualMachineScaleSetResource, please refer to the document of VirtualMachineScaleSetResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "{vmss-name}";
ResourceIdentifier virtualMachineScaleSetResourceId = VirtualMachineScaleSetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName);
VirtualMachineScaleSetResource virtualMachineScaleSet = client.GetVirtualMachineScaleSetResource(virtualMachineScaleSetResourceId);

// get the collection of this VirtualMachineScaleSetVmResource
VirtualMachineScaleSetVmCollection collection = virtualMachineScaleSet.GetVirtualMachineScaleSetVms();

// invoke the operation
string instanceId = "0";
NullableResponse<VirtualMachineScaleSetVmResource> response = await collection.GetIfExistsAsync(instanceId);
VirtualMachineScaleSetVmResource 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
    VirtualMachineScaleSetVmData 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

Exemple de réponse

Code d’état:: 200

{
  "name": "{vmss-vm-name}",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0",
  "type": "Microsoft.Compute/virtualMachines",
  "location": "westus",
  "tags": {
    "myTag1": "tagValue1"
  },
  "etag": "\"1\"",
  "properties": {
    "latestModelApplied": true,
    "modelDefinitionApplied": "VirtualMachineScaleSet",
    "networkProfileConfiguration": {
      "networkInterfaceConfigurations": [
        {
          "name": "vmsstestnetconfig5415",
          "properties": {
            "primary": true,
            "enableAcceleratedNetworking": false,
            "dnsSettings": {
              "dnsServers": []
            },
            "enableIPForwarding": false,
            "ipConfigurations": [
              {
                "name": "vmsstestnetconfig9693",
                "properties": {
                  "subnet": {
                    "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503"
                  },
                  "privateIPAddressVersion": "IPv4"
                }
              }
            ]
          }
        }
      ]
    },
    "vmId": "42af9fdf-b906-4ad7-9905-8316209ff619",
    "hardwareProfile": {},
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2012-R2-Datacenter",
        "version": "4.127.20180315",
        "exactVersion": "4.127.20180315"
      },
      "osDisk": {
        "osType": "Windows",
        "name": "vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc",
        "createOption": "FromImage",
        "caching": "None",
        "managedDisk": {
          "storageAccountType": "Standard_LRS",
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc"
        },
        "diskSizeGB": 127
      },
      "dataDisks": [
        {
          "lun": 1,
          "name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
          "createOption": "Empty",
          "caching": "None",
          "managedDisk": {
            "storageAccountType": "Standard_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"
          },
          "diskSizeGB": 128,
          "toBeDetached": false
        }
      ]
    },
    "osProfile": {
      "computerName": "test000000",
      "adminUsername": "Foo12",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      },
      "secrets": [],
      "allowExtensionOperations": true,
      "requireGuestProvisionSignal": true
    },
    "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415"
        }
      ]
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "enabled": true
      }
    },
    "provisioningState": "Succeeded"
  },
  "resources": [
    {
      "name": "CustomScriptExtension-DSC",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
      "type": "Microsoft.Compute/virtualMachines/extensions",
      "location": "westus",
      "tags": {
        "displayName": "CustomScriptExtension-DSC"
      },
      "properties": {
        "autoUpgradeMinorVersion": true,
        "provisioningState": "Succeeded",
        "publisher": "Microsoft.Compute",
        "type": "CustomScriptExtension",
        "typeHandlerVersion": "1.9",
        "settings": {}
      }
    }
  ]
}

Get VM scale set VM with VMSizeProperties

Exemple de requête

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0?api-version=2025-04-01


/**
 * Samples for VirtualMachineScaleSetVMs Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithVMSizeProperties.json
     */
    /**
     * Sample code: Get VM scale set VM with VMSizeProperties.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getVMScaleSetVMWithVMSizeProperties(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSetVMs()
            .getWithResponse("myResourceGroup", "{vmss-name}", "0", 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 virtual_machine_scale_set_vm_get_with_vm_size_properties.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.virtual_machine_scale_set_vms.get(
        resource_group_name="myResourceGroup",
        vm_scale_set_name="{vmss-name}",
        instance_id="0",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithVMSizeProperties.json
if __name__ == "__main__":
    main()

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

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7033e85e1f80ef5cd9ca664b538ed193a8fd815b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithVMSizeProperties.json
func ExampleVirtualMachineScaleSetVMsClient_Get_getVmScaleSetVmWithVmSizeProperties() {
	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.NewVirtualMachineScaleSetVMsClient().Get(ctx, "myResourceGroup", "{vmss-name}", "0", &armcompute.VirtualMachineScaleSetVMsClientGetOptions{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.VirtualMachineScaleSetVM = armcompute.VirtualMachineScaleSetVM{
	// 	Name: to.Ptr("{vmss-vm-name}"),
	// 	Type: to.Ptr("Microsoft.Compute/virtualMachines"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"myTag1": to.Ptr("tagValue1"),
	// 	},
	// 	Etag: to.Ptr("\"1\""),
	// 	Properties: &armcompute.VirtualMachineScaleSetVMProperties{
	// 		DiagnosticsProfile: &armcompute.DiagnosticsProfile{
	// 			BootDiagnostics: &armcompute.BootDiagnostics{
	// 				Enabled: to.Ptr(true),
	// 			},
	// 		},
	// 		HardwareProfile: &armcompute.HardwareProfile{
	// 			VMSizeProperties: &armcompute.VMSizeProperties{
	// 				VCPUsAvailable: to.Ptr[int32](1),
	// 				VCPUsPerCore: to.Ptr[int32](1),
	// 			},
	// 		},
	// 		LatestModelApplied: to.Ptr(true),
	// 		ModelDefinitionApplied: to.Ptr("VirtualMachineScaleSet"),
	// 		NetworkProfile: &armcompute.NetworkProfile{
	// 			NetworkInterfaces: []*armcompute.NetworkInterfaceReference{
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415"),
	// 			}},
	// 		},
	// 		NetworkProfileConfiguration: &armcompute.VirtualMachineScaleSetVMNetworkProfileConfiguration{
	// 			NetworkInterfaceConfigurations: []*armcompute.VirtualMachineScaleSetNetworkConfiguration{
	// 				{
	// 					Name: to.Ptr("vmsstestnetconfig5415"),
	// 					Properties: &armcompute.VirtualMachineScaleSetNetworkConfigurationProperties{
	// 						DNSSettings: &armcompute.VirtualMachineScaleSetNetworkConfigurationDNSSettings{
	// 							DNSServers: []*string{
	// 							},
	// 						},
	// 						EnableAcceleratedNetworking: to.Ptr(false),
	// 						EnableIPForwarding: to.Ptr(false),
	// 						IPConfigurations: []*armcompute.VirtualMachineScaleSetIPConfiguration{
	// 							{
	// 								Name: to.Ptr("vmsstestnetconfig9693"),
	// 								Properties: &armcompute.VirtualMachineScaleSetIPConfigurationProperties{
	// 									PrivateIPAddressVersion: to.Ptr(armcompute.IPVersionIPv4),
	// 									Subnet: &armcompute.APIEntityReference{
	// 										ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503"),
	// 									},
	// 								},
	// 						}},
	// 						Primary: to.Ptr(true),
	// 					},
	// 			}},
	// 		},
	// 		OSProfile: &armcompute.OSProfile{
	// 			AdminUsername: to.Ptr("Foo12"),
	// 			AllowExtensionOperations: to.Ptr(true),
	// 			ComputerName: to.Ptr("test000000"),
	// 			RequireGuestProvisionSignal: to.Ptr(true),
	// 			Secrets: []*armcompute.VaultSecretGroup{
	// 			},
	// 			WindowsConfiguration: &armcompute.WindowsConfiguration{
	// 				EnableAutomaticUpdates: to.Ptr(true),
	// 				ProvisionVMAgent: to.Ptr(true),
	// 			},
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		StorageProfile: &armcompute.StorageProfile{
	// 			DataDisks: []*armcompute.DataDisk{
	// 				{
	// 					Name: to.Ptr("vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
	// 					Caching: to.Ptr(armcompute.CachingTypesNone),
	// 					CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesEmpty),
	// 					DiskSizeGB: to.Ptr[int32](128),
	// 					Lun: to.Ptr[int32](1),
	// 					ManagedDisk: &armcompute.ManagedDiskParameters{
	// 						ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesStandardLRS),
	// 					},
	// 					ToBeDetached: to.Ptr(false),
	// 			}},
	// 			ImageReference: &armcompute.ImageReference{
	// 				ExactVersion: to.Ptr("4.127.20180315"),
	// 				Offer: to.Ptr("WindowsServer"),
	// 				Publisher: to.Ptr("MicrosoftWindowsServer"),
	// 				SKU: to.Ptr("2012-R2-Datacenter"),
	// 				Version: to.Ptr("4.127.20180315"),
	// 			},
	// 			OSDisk: &armcompute.OSDisk{
	// 				Name: to.Ptr("vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc"),
	// 				Caching: to.Ptr(armcompute.CachingTypesNone),
	// 				CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesFromImage),
	// 				DiskSizeGB: to.Ptr[int32](127),
	// 				ManagedDisk: &armcompute.ManagedDiskParameters{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc"),
	// 					StorageAccountType: to.Ptr(armcompute.StorageAccountTypesStandardLRS),
	// 				},
	// 				OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 			},
	// 		},
	// 		UserData: to.Ptr("RXhhbXBsZSBVc2VyRGF0YQ=="),
	// 		VMID: to.Ptr("42af9fdf-b906-4ad7-9905-8316209ff619"),
	// 	},
	// 	Resources: []*armcompute.VirtualMachineExtension{
	// 		{
	// 			Name: to.Ptr("CustomScriptExtension-DSC"),
	// 			Type: to.Ptr("Microsoft.Compute/virtualMachines/extensions"),
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC"),
	// 			Location: to.Ptr("westus"),
	// 			Tags: map[string]*string{
	// 				"displayName": to.Ptr("CustomScriptExtension-DSC"),
	// 			},
	// 			Properties: &armcompute.VirtualMachineExtensionProperties{
	// 				Type: to.Ptr("CustomScriptExtension"),
	// 				AutoUpgradeMinorVersion: to.Ptr(true),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				Publisher: to.Ptr("Microsoft.Compute"),
	// 				Settings: map[string]any{
	// 				},
	// 				TypeHandlerVersion: to.Ptr("1.9"),
	// 			},
	// 	}},
	// }
}

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 Gets a virtual machine from a VM scale set.
 *
 * @summary Gets a virtual machine from a VM scale set.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithVMSizeProperties.json
 */
async function getVMScaleSetVMWithVMSizeProperties() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmScaleSetName = "{vmss-name}";
  const instanceId = "0";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSetVMs.get(
    resourceGroupName,
    vmScaleSetName,
    instanceId,
  );
  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.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithVMSizeProperties.json
// this example is just showing the usage of "VirtualMachineScaleSetVMs_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 VirtualMachineScaleSetResource created on azure
// for more information of creating VirtualMachineScaleSetResource, please refer to the document of VirtualMachineScaleSetResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "{vmss-name}";
ResourceIdentifier virtualMachineScaleSetResourceId = VirtualMachineScaleSetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName);
VirtualMachineScaleSetResource virtualMachineScaleSet = client.GetVirtualMachineScaleSetResource(virtualMachineScaleSetResourceId);

// get the collection of this VirtualMachineScaleSetVmResource
VirtualMachineScaleSetVmCollection collection = virtualMachineScaleSet.GetVirtualMachineScaleSetVms();

// invoke the operation
string instanceId = "0";
NullableResponse<VirtualMachineScaleSetVmResource> response = await collection.GetIfExistsAsync(instanceId);
VirtualMachineScaleSetVmResource 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
    VirtualMachineScaleSetVmData 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

Exemple de réponse

Code d’état:: 200

{
  "name": "{vmss-vm-name}",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0",
  "type": "Microsoft.Compute/virtualMachines",
  "location": "westus",
  "tags": {
    "myTag1": "tagValue1"
  },
  "etag": "\"1\"",
  "properties": {
    "latestModelApplied": true,
    "modelDefinitionApplied": "VirtualMachineScaleSet",
    "networkProfileConfiguration": {
      "networkInterfaceConfigurations": [
        {
          "name": "vmsstestnetconfig5415",
          "properties": {
            "primary": true,
            "enableAcceleratedNetworking": false,
            "dnsSettings": {
              "dnsServers": []
            },
            "enableIPForwarding": false,
            "ipConfigurations": [
              {
                "name": "vmsstestnetconfig9693",
                "properties": {
                  "subnet": {
                    "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503"
                  },
                  "privateIPAddressVersion": "IPv4"
                }
              }
            ]
          }
        }
      ]
    },
    "vmId": "42af9fdf-b906-4ad7-9905-8316209ff619",
    "hardwareProfile": {
      "vmSizeProperties": {
        "vCPUsAvailable": 1,
        "vCPUsPerCore": 1
      }
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2012-R2-Datacenter",
        "version": "4.127.20180315",
        "exactVersion": "4.127.20180315"
      },
      "osDisk": {
        "osType": "Windows",
        "name": "vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc",
        "createOption": "FromImage",
        "caching": "None",
        "managedDisk": {
          "storageAccountType": "Standard_LRS",
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc"
        },
        "diskSizeGB": 127
      },
      "dataDisks": [
        {
          "lun": 1,
          "name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
          "createOption": "Empty",
          "caching": "None",
          "managedDisk": {
            "storageAccountType": "Standard_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"
          },
          "diskSizeGB": 128,
          "toBeDetached": false
        }
      ]
    },
    "osProfile": {
      "computerName": "test000000",
      "adminUsername": "Foo12",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      },
      "secrets": [],
      "allowExtensionOperations": true,
      "requireGuestProvisionSignal": true
    },
    "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415"
        }
      ]
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "enabled": true
      }
    },
    "provisioningState": "Succeeded"
  },
  "resources": [
    {
      "name": "CustomScriptExtension-DSC",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
      "type": "Microsoft.Compute/virtualMachines/extensions",
      "location": "westus",
      "tags": {
        "displayName": "CustomScriptExtension-DSC"
      },
      "properties": {
        "autoUpgradeMinorVersion": true,
        "provisioningState": "Succeeded",
        "publisher": "Microsoft.Compute",
        "type": "CustomScriptExtension",
        "typeHandlerVersion": "1.9",
        "settings": {}
      }
    }
  ]
}

Définitions

Nom	Description
AdditionalCapabilities	Active ou désactive une fonctionnalité sur la machine virtuelle ou le groupe de machines virtuelles identiques.
AdditionalUnattendContent	Spécifie des informations au format XML supplémentaires qui peuvent être incluses dans le fichier Unattend.xml, qui est utilisé par le programme d’installation de Windows. Le contenu est défini en définissant le nom, le nom du composant et le passage dans lequel le contenu est appliqué.
ApiEntityReference	Informations de référence sur l’entité API.
ApiError	Erreur d’API.
ApiErrorBase	Base d’erreur de l’API.
BootDiagnostics	Diagnostics de démarrage est une fonctionnalité de débogage qui vous permet d’afficher la sortie de la console et la capture d’écran pour diagnostiquer l’état de la machine virtuelle. Vous pouvez facilement afficher la sortie de votre journal de console. Azure vous permet également de voir une capture d’écran de la machine virtuelle à partir de l’hyperviseur.
BootDiagnosticsInstanceView	Vue d’instance des diagnostics de démarrage d’une machine virtuelle.
CachingTypes	Spécifie les exigences de mise en cache. Les valeurs possibles sont : None,ReadOnly,ReadWrite. Les valeurs par défaut sont : Aucune pour le stockage Standard. ReadOnly pour le stockage Premium
CloudError	Réponse d’erreur du service de calcul.
ComponentNames
createdByType	Type d’identité qui a créé la ressource.
DataDisk	Décrit un disque de données.
DeleteOptions	Spécifier ce qui se passe à l’interface réseau lorsque la machine virtuelle est supprimée
DiagnosticsProfile	Spécifie l’état des paramètres de diagnostic de démarrage. Version minimale de l’API : 2015-06-15.
DiffDiskOptions	Spécifie l’option disque éphémère pour le disque du système d’exploitation.
DiffDiskPlacement	Spécifie le placement de disque éphémère pour le disque du système d’exploitation. Cette propriété peut être utilisée par l’utilisateur dans la demande pour choisir l’emplacement, c’est-à-dire le disque de cache, le disque de ressources ou l’espace disque nvme pour le provisionnement de disque de système d’exploitation éphémère. Pour plus d’informations sur les exigences de taille de disque de système d’exploitation éphémère, reportez-vous à la configuration requise pour la taille de disque du système d’exploitation éphémère pour les machines virtuelles Windows sur https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements et la machine virtuelle Linux à l’adresse https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. Version minimale de l’API pour NvmeDisk : 2024-03-01.
DiffDiskSettings	Décrit les paramètres des paramètres de disque éphémères qui peuvent être spécifiés pour le disque du système d’exploitation. Remarque : Les paramètres de disque éphémères ne peuvent être spécifiés que pour le disque managé.
DiskControllerTypes	Spécifie le type de contrôleur de disque configuré pour la machine virtuelle et VirtualMachineScaleSet. Cette propriété est uniquement prise en charge pour les machines virtuelles dont le disque du système d’exploitation et la référence SKU de machine virtuelle prennent en charge la génération 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), vérifiez la fonctionnalité HyperVGenerations retournée dans le cadre des fonctionnalités de référence SKU de machine virtuelle dans la réponse de l’API SKU Microsoft.Compute pour la région contient V2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list). Pour plus d’informations sur les types de contrôleurs de disque pris en charge, consultez https://aka.ms/azure-diskcontrollertypes.
DiskCreateOptionTypes	Spécifie la façon dont le disque de machine virtuelle doit être créé. Les valeurs possibles sont Attacher : Cette valeur est utilisée lorsque vous utilisez un disque spécialisé pour créer la machine virtuelle. FromImage : Cette valeur est utilisée lorsque vous utilisez une image pour créer la machine virtuelle. Si vous utilisez une image de plateforme, vous devez également utiliser l’élément imageReference décrit ci-dessus. Si vous utilisez une image de la Place de marché, vous devez également utiliser l’élément de plan décrit précédemment. Vide : Cette valeur est utilisée lors de la création d’un disque de données vide. Copier : Cette valeur est utilisée pour créer un disque de données à partir d’un instantané ou d’un autre disque. Restauration : Cette valeur est utilisée pour créer un disque de données à partir d’un point de restauration de disque.
DiskDeleteOptionTypes	Spécifie le comportement du disque managé lorsque la machine virtuelle est supprimée, par exemple si le disque managé est supprimé ou détaché. Les valeurs prises en charge sont les suivantes : Supprimer. Si cette valeur est utilisée, le disque managé est supprimé lorsque la machine virtuelle est supprimée. Détacher. Si cette valeur est utilisée, le disque managé est conservé après la suppression de la machine virtuelle. Version minimale de l’API : 2021-03-01.
DiskDetachOptionTypes	Spécifie le comportement de détachement à utiliser lors du détachement d’un disque ou déjà en cours de détachement de la machine virtuelle. Les valeurs prises en charge sont les suivantes : ForceDetach. detachOption : ForceDetach ne s’applique qu’aux disques de données gérés. Si une tentative de détachement précédente du disque de données n’a pas été effectuée en raison d’une défaillance inattendue de la machine virtuelle et que le disque n’est toujours pas libéré, utilisez une option de détachement forcé comme option de dernier recours pour détacher le disque de force de la machine virtuelle. Toutes les écritures n’ont peut-être pas été vidées lors de l’utilisation de ce comportement de détachement. Cette fonctionnalité est encore en préversion. Pour forcer le détachement d’une mise à jour du disque de données versBeDetached à « true », ainsi que le paramètre detachOption : « ForceDetach ».
DiskEncryptionSetParameters	Décrit le paramètre de l’ID de ressource du jeu de chiffrement de disque géré par le client qui peut être spécifié pour le disque. Remarque : L’ID de ressource du jeu de chiffrement de disque ne peut être spécifié que pour le disque managé. Pour plus d’informations, consultez https://aka.ms/mdssewithcmkoverview.
DiskEncryptionSettings	Décrit les paramètres de chiffrement d’un disque
DiskInstanceView	Vue d’instance du disque.
DomainNameLabelScopeTypes	Étendue de l’étiquette du nom de domaine. La concaténation de l’étiquette de nom de domaine hachée générée en fonction de la stratégie à partir de l’étendue de l’étiquette de nom de domaine et de l’index de machine virtuelle sera les étiquettes de nom de domaine des ressources PublicIPAddress qui seront créées
EncryptionIdentity	Spécifie l’identité managée utilisée par ADE pour obtenir le jeton d’accès pour les opérations de coffre de clés.
HardwareProfile	Spécifie les paramètres matériels de la machine virtuelle.
HostEndpointSettings	Spécifie des paramètres de point de terminaison d’hôte particuliers.
HyperVGeneration	Génération d’hyperviseur de la machine virtuelle [V1, V2]
ImageReference	Spécifie des informations sur l’image à utiliser. Vous pouvez spécifier des informations sur les images de plateforme, les images de la Place de marché ou les images de machine virtuelle. Cet élément est requis lorsque vous souhaitez utiliser une image de plateforme, une image de la Place de marché ou une image de machine virtuelle, mais n’est pas utilisé dans d’autres opérations de création. REMARQUE : l’éditeur et l’offre de référence d’image ne peuvent être définis que lorsque vous créez le groupe identique.
InnerError	Détails de l’erreur interne.
InstanceViewStatus	État de l’affichage de l’instance.
InstanceViewTypes
IPVersion	Disponible à partir de Api-Version 2017-03-30, il indique si la configuration ip spécifique est IPv4 ou IPv6. La valeur par défaut est prise en tant que IPv4. Les valeurs possibles sont : « IPv4 » et « IPv6 ».
IPVersions	Disponible à partir de Api-Version 2017-03-30, il indique si la configuration ip spécifique est IPv4 ou IPv6. La valeur par défaut est prise en tant que IPv4. Les valeurs possibles sont : « IPv4 » et « IPv6 ».
KeyVaultKeyReference	Décrit une référence à Key Vault Key
KeyVaultSecretReference	Décrit une référence au secret Key Vault
LinuxConfiguration	Spécifie les paramètres du système d’exploitation Linux sur la machine virtuelle. Pour obtenir la liste des distributions Linux prises en charge, consultez Linux sur Azure-Endorsed Distributions.
LinuxPatchAssessmentMode	Spécifie le mode d’évaluation des correctifs invités de machine virtuelle pour la machine virtuelle IaaS. Les valeurs possibles sont les suivantes : ImageDefault : vous contrôlez le minutage des évaluations des correctifs sur une machine virtuelle. AutomaticByPlatform : la plateforme déclenche des évaluations périodiques des correctifs. La propriété provisionVMAgent doit être vraie.
LinuxPatchSettings	Spécifie les paramètres liés à la mise à jour corrective d’invité de machine virtuelle sur Linux.
LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Spécifie le paramètre de redémarrage pour toutes les opérations d’installation des correctifs AutomaticByPlatform.
LinuxVMGuestPatchAutomaticByPlatformSettings	Spécifie des paramètres supplémentaires à appliquer lorsque le mode correctif AutomatiqueByPlatform est sélectionné dans les paramètres de correctif Linux.
LinuxVMGuestPatchMode	Spécifie le mode de mise à jour corrective d’invité de machine virtuelle sur une machine virtuelle IaaS ou des machines virtuelles associées au groupe de machines virtuelles identiques avec OrchestrationMode en tant que flexible. Les valeurs possibles sont les suivantes : ImageDefault : la configuration de mise à jour corrective par défaut de la machine virtuelle est utilisée. AutomaticByPlatform : la machine virtuelle est automatiquement mise à jour par la plateforme. La propriété provisionVMAgent doit être true
MaintenanceOperationResultCodeTypes	Code de résultat de la dernière opération de maintenance.
MaintenanceRedeployStatus	État de fonctionnement de maintenance.
ManagedDiskParameters	Paramètres d’un disque managé.
Mode	Spécifie le mode sur lequel ProxyAgent s’exécute si la fonctionnalité est activée. ProxyAgent commence à auditer ou à surveiller, mais pas à appliquer le contrôle d’accès sur les demandes aux points de terminaison hôtes en mode Audit, tandis qu’en mode Appliquer, il applique le contrôle d’accès. La valeur par défaut est Appliquer le mode.
Modes	Spécifie le mode d’exécution. En mode Audit, le système agit comme s’il applique la stratégie de contrôle d’accès, y compris l’émission d’entrées de déni d’accès dans les journaux, mais il ne refuse pas réellement les demandes aux points de terminaison hôtes. En mode Appliquer, le système applique le contrôle d’accès et il s’agit du mode d’opération recommandé.
NetworkApiVersion	spécifie la version de l’API Microsoft.Network utilisée lors de la création de ressources réseau dans les configurations d’interface réseau
NetworkInterfaceAuxiliaryMode	Spécifie si le mode auxiliaire est activé pour la ressource d’interface réseau.
NetworkInterfaceAuxiliarySku	Spécifie si la référence SKU auxiliaire est activée pour la ressource d’interface réseau.
NetworkInterfaceReference	Décrit une référence d’interface réseau.
NetworkProfile	Spécifie les interfaces réseau ou la configuration réseau de la machine virtuelle.
OperatingSystemTypes	Cette propriété vous permet de spécifier le type du système d’exploitation inclus dans le disque si vous créez une machine virtuelle à partir d’une image utilisateur ou d’un disque dur virtuel spécialisé. Les valeurs possibles sont : Windows,Linux.
OSDisk	Spécifie des informations sur le disque du système d’exploitation utilisé par la machine virtuelle. Pour plus d’informations sur les disques, consultez À propos des disques et des disques durs virtuels pour les machines virtuelles Azure.
OSProfile	Spécifie les paramètres du système d’exploitation de la machine virtuelle. Certains des paramètres ne peuvent pas être modifiés une fois la machine virtuelle approvisionnée.
PassNames
PatchSettings	Spécifie les paramètres liés à la mise à jour corrective de l’invité de machine virtuelle sur Windows.
Plan	Spécifie des informations sur l’image de la Place de marché utilisée pour créer la machine virtuelle. Cet élément est utilisé uniquement pour les images de la Place de marché. Avant de pouvoir utiliser une image de la Place de marché à partir d’une API, vous devez activer l’image pour une utilisation programmatique. Dans le portail Azure, recherchez l’image de la Place de marché que vous souhaitez utiliser, puis cliquez sur Voulez déployer par programmation, Prise en main ->. Entrez les informations requises, puis cliquez sur Enregistrer.
ProtocolTypes	Spécifie le protocole de l’écouteur WinRM. Les valeurs possibles sont les suivantes : http,https.
ProxyAgentSettings	Spécifie les paramètres ProxyAgent pour la machine virtuelle ou le groupe de machines virtuelles identiques. Version minimale de l’API : 2023-09-01.
PublicIPAddressSku	Décrit la référence SKU IP publique. Il ne peut être défini qu’avec OrchestrationMode comme flexible.
PublicIPAddressSkuName	Spécifier le nom de la référence SKU IP publique
PublicIPAddressSkuTier	Spécifier le niveau de référence sku IP public
PublicIPAllocationMethod	Spécifier le type d’allocation d’adresses IP publiques
ResilientVMDeletionStatus	Spécifie l’état de suppression de machine virtuelle résiliente pour la machine virtuelle.
ResourceIdentityType	Type d’identité utilisé pour le groupe de machines virtuelles identiques. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du groupe de machines virtuelles identiques.
SecurityEncryptionTypes	Spécifie le EncryptionType du disque managé. Il est défini sur DiskWithVMGuestState pour le chiffrement du disque managé avec l’objet blob VMGuestState, VMGuestStateOnly pour le chiffrement de l’objet blob VMGuestState et nonPersistedTPM pour ne pas conserver l’état du microprogramme dans l’objet blob VMGuestState.. Remarque : Il peut être défini uniquement pour les machines virtuelles confidentielles.
SecurityProfile	Spécifie les paramètres du profil de sécurité pour la machine virtuelle ou le groupe de machines virtuelles identiques.
SecurityTypes	Spécifie le SecurityType de la machine virtuelle. Il doit être défini sur n’importe quelle valeur spécifiée pour activer UefiSettings. Le comportement par défaut est : UefiSettings n’est pas activé, sauf si cette propriété est définie.
SettingNames	Spécifie le nom du paramètre auquel le contenu s’applique. Les valeurs possibles sont les suivantes : FirstLogonCommands et AutoLogon.
Sku	Décrit la référence SKU d’un groupe de machines virtuelles identiques. REMARQUE : Si la nouvelle référence SKU de machine virtuelle n’est pas prise en charge sur le matériel sur lequel le groupe identique est actuellement activé, vous devez libérer les machines virtuelles du groupe identique avant de modifier le nom de la référence SKU.
SshConfiguration	Configuration SSH pour les machines virtuelles Linux s’exécutant sur Azure
SshPublicKey	Contient des informations sur la clé publique du certificat SSH et le chemin d’accès sur la machine virtuelle Linux où la clé publique est placée.
StatusLevelTypes	Code de niveau.
StorageAccountTypes	Spécifie le type de compte de stockage pour le disque managé. Le type de compte de stockage de disque de système d’exploitation managé ne peut être défini que lorsque vous créez le groupe identique. REMARQUE : UltraSSD_LRS ne peut être utilisé qu’avec des disques de données. Il ne peut pas être utilisé avec le disque du système d’exploitation. Standard_LRS utilise hdD Standard. StandardSSD_LRS utilise ssd Standard. Premium_LRS utilise ssd Premium. UltraSSD_LRS utilise le disque Ultra. Premium_ZRS utilise le stockage redondant interzone SSD Premium. StandardSSD_ZRS utilise le stockage redondant interzone SSD Standard. Pour plus d’informations sur les disques pris en charge pour les machines virtuelles Windows, reportez-vous à https://docs.microsoft.com/azure/virtual-machines/windows/disks-types et, pour les machines virtuelles Linux, reportez-vous à https://docs.microsoft.com/azure/virtual-machines/linux/disks-types
StorageProfile	Spécifie les paramètres de stockage des disques de machine virtuelle.
SubResource
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
UefiSettings	Spécifie les paramètres de sécurité tels que le démarrage sécurisé et vTPM utilisés lors de la création de la machine virtuelle. Version minimale de l’API : 2020-12-01.
UserAssignedIdentitiesValue
VaultCertificate	Décrit une référence de certificat unique dans un coffre de clés et l’emplacement où le certificat doit résider sur la machine virtuelle.
VaultSecretGroup	Décrit un ensemble de certificats qui se trouvent tous dans le même coffre de clés.
VirtualHardDisk	Décrit l’URI d’un disque.
VirtualMachineAgentInstanceView	Vue d’instance de l’agent de machine virtuelle en cours d’exécution sur la machine virtuelle.
VirtualMachineExtension	Décrit une extension de machine virtuelle.
VirtualMachineExtensionHandlerInstanceView	Vue d’instance d’un gestionnaire d’extensions de machine virtuelle.
VirtualMachineExtensionInstanceView	Vue d’instance d’une extension de machine virtuelle.
VirtualMachineHealthStatus	L’état d’intégrité de la machine virtuelle.
VirtualMachineIdentity	Identité de la machine virtuelle.
VirtualMachineIpTag	Contient la balise IP associée à l’adresse IP publique.
VirtualMachineNetworkInterfaceConfiguration	Décrit les configurations d’interface réseau d’une machine virtuelle.
VirtualMachineNetworkInterfaceDnsSettingsConfiguration	Décrit les paramètres DNS d’une configuration réseau de machines virtuelles.
VirtualMachineNetworkInterfaceIPConfiguration	Décrit la configuration IP d’un profil réseau de machine virtuelle.
VirtualMachinePublicIPAddressConfiguration	Décrit la configuration PublicIPAddress d’une machine virtuelle
VirtualMachinePublicIPAddressDnsSettingsConfiguration	Décrit les paramètres DNS d’une configuration réseau de machines virtuelles.
VirtualMachineScaleSetIPConfiguration	Décrit la configuration IP d’un groupe de machines virtuelles identiques.
VirtualMachineScaleSetIpTag	Contient la balise IP associée à l’adresse IP publique.
VirtualMachineScaleSetNetworkConfiguration	Décrit les configurations réseau d’un groupe de machines virtuelles identiques.
VirtualMachineScaleSetNetworkConfigurationDnsSettings	Décrit les paramètres DNS d’une configuration réseau des groupes de machines virtuelles identiques.
VirtualMachineScaleSetPublicIPAddressConfiguration	Décrit la configuration PublicIPAddress d’un groupe de machines virtuelles identiques
VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings	Décrit les paramètres DNS d’une configuration réseau des groupes de machines virtuelles identiques.
VirtualMachineScaleSetVM	Décrit une machine virtuelle de groupe virtuel identique.
VirtualMachineScaleSetVMInstanceView	Vue d’instance d’une machine virtuelle de groupe de machines virtuelles identiques.
VirtualMachineScaleSetVMNetworkProfileConfiguration	Décrit le profil réseau d’une machine virtuelle de groupe de machines virtuelles identiques.
VirtualMachineScaleSetVMProtectionPolicy	Stratégie de protection d’une machine virtuelle de machine virtuelle identique.
VirtualMachineSizeTypes	Spécifie la taille de la machine virtuelle. Le type de données enum est actuellement déconseillé et sera supprimé d’ici le 23 décembre 2023. La méthode recommandée pour obtenir la liste des tailles disponibles consiste à utiliser ces API : Répertorier toutes les tailles de machine virtuelle disponibles dans un groupe à haute disponibilité, Répertorier toutes les tailles de machine virtuelle disponibles dans une région, Répertorier toutes les tailles de machine virtuelle disponibles pour redimensionner. Pour plus d’informations sur les tailles de machine virtuelle, consultez Tailles des machines virtuelles. Les tailles de machine virtuelle disponibles dépendent de la région et du groupe à haute disponibilité.
VMDiskSecurityProfile	Spécifie les paramètres du profil de sécurité pour le disque managé. Remarque : Il ne peut être défini que pour les machines virtuelles confidentielles.
VMSizeProperties	Spécifie les paramètres de propriété taille de machine virtuelle sur la machine virtuelle.
WindowsConfiguration	Spécifie les paramètres du système d’exploitation Windows sur la machine virtuelle.
WindowsPatchAssessmentMode	Spécifie le mode d’évaluation des correctifs invités de machine virtuelle pour la machine virtuelle IaaS. Les valeurs possibles sont les suivantes : ImageDefault : vous contrôlez le minutage des évaluations des correctifs sur une machine virtuelle. AutomaticByPlatform : la plateforme déclenche des évaluations périodiques des correctifs. La propriété provisionVMAgent doit être vraie.
WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Spécifie le paramètre de redémarrage pour toutes les opérations d’installation des correctifs AutomaticByPlatform.
WindowsVMGuestPatchAutomaticByPlatformSettings	Spécifie des paramètres supplémentaires à appliquer lorsque le mode correctif AutomatiqueByPlatform est sélectionné dans les paramètres de correctif Windows.
WindowsVMGuestPatchMode	Spécifie le mode de mise à jour corrective d’invité de machine virtuelle sur une machine virtuelle IaaS ou des machines virtuelles associées au groupe de machines virtuelles identiques avec OrchestrationMode en tant que flexible. Les valeurs possibles sont les suivantes : manuel : vous contrôlez l’application de correctifs sur une machine virtuelle. Pour ce faire, appliquez manuellement des correctifs à l’intérieur de la machine virtuelle. Dans ce mode, les mises à jour automatiques sont désactivées ; la propriété WindowsConfiguration.enableAutomaticUpdates doit être false AutomaticByOS : la machine virtuelle est automatiquement mise à jour par le système d’exploitation. La propriété WindowsConfiguration.enableAutomaticUpdates doit être vraie. AutomaticByPlatform : la machine virtuelle est automatiquement mise à jour par la plateforme. Les propriétés provisionVMAgent et WindowsConfiguration.enableAutomaticUpdates doivent être vraies
WinRMConfiguration	Décrit la configuration de la gestion à distance windows de la machine virtuelle
WinRMListener	Décrit le protocole et l’empreinte numérique de l’écouteur de gestion à distance Windows

AdditionalCapabilities

Objet

Active ou désactive une fonctionnalité sur la machine virtuelle ou le groupe de machines virtuelles identiques.

Nom	Type	Description
enableFips1403Encryption	boolean	L’indicateur permet l’utilisation d’une cryptographie conforme à la norme FIPS 140-3 sur les paramètres protégés d’une extension. Pour en savoir plus, rendez-vous à l’adresse suivante : https://aka.ms/linuxagentfipssupport.
hibernationEnabled	boolean	Indicateur qui active ou désactive la fonctionnalité de mise en veille prolongée sur la machine virtuelle.
ultraSSDEnabled	boolean	Indicateur qui active ou désactive une fonctionnalité pour avoir un ou plusieurs disques de données managés avec UltraSSD_LRS type de compte de stockage sur la machine virtuelle ou VMSS. Les disques managés avec le type de compte de stockage UltraSSD_LRS peuvent être ajoutés à une machine virtuelle ou à un groupe de machines virtuelles identiques uniquement si cette propriété est activée.

AdditionalUnattendContent

Objet

Spécifie des informations au format XML supplémentaires qui peuvent être incluses dans le fichier Unattend.xml, qui est utilisé par le programme d’installation de Windows. Le contenu est défini en définissant le nom, le nom du composant et le passage dans lequel le contenu est appliqué.

Nom	Type	Description
componentName	ComponentNames	Nom du composant. Actuellement, la seule valeur autorisée est Microsoft-Windows-Shell-Setup.
content	string	Spécifie le contenu au format XML ajouté au fichier unattend.xml pour le chemin d’accès et le composant spécifiés. Le code XML doit être inférieur à 4 Ko et doit inclure l’élément racine du paramètre ou de la fonctionnalité en cours d’insertion.
passName	PassNames	Nom du passage. Actuellement, la seule valeur autorisée est OobeSystem.
settingName	SettingNames	Spécifie le nom du paramètre auquel le contenu s’applique. Les valeurs possibles sont les suivantes : FirstLogonCommands et AutoLogon.

ApiEntityReference

Objet

Informations de référence sur l’entité API.

Nom	Type	Description
id	string	ID de ressource ARM sous la forme de /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Objet

Erreur d’API.

Nom	Type	Description
code	string	Code d’erreur.
details	ApiErrorBase[]	Les détails de l’erreur Api
innererror	InnerError	L’erreur interne de l’API
message	string	Message d’erreur.
target	string	Cible de l’erreur particulière.

ApiErrorBase

Objet

Base d’erreur de l’API.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d’erreur.
target	string	Cible de l’erreur particulière.

BootDiagnostics

Objet

Diagnostics de démarrage est une fonctionnalité de débogage qui vous permet d’afficher la sortie de la console et la capture d’écran pour diagnostiquer l’état de la machine virtuelle. Vous pouvez facilement afficher la sortie de votre journal de console. Azure vous permet également de voir une capture d’écran de la machine virtuelle à partir de l’hyperviseur.

Nom	Type	Description
enabled	boolean	Indique si les diagnostics de démarrage doivent être activés sur la machine virtuelle.
storageUri	string	Uri du compte de stockage à utiliser pour placer la sortie de la console et la capture d’écran. Si storageUri n’est pas spécifié lors de l’activation des diagnostics de démarrage, le stockage managé sera utilisé.

BootDiagnosticsInstanceView

Objet

Vue d’instance des diagnostics de démarrage d’une machine virtuelle.

Nom	Type	Description
consoleScreenshotBlobUri	string	URI de l’objet blob de capture d’écran de la console. Note: Ce paramètre n’est pas défini si les diagnostics de démarrage sont actuellement activés avec le stockage géré.
serialConsoleLogBlobUri	string	Uri de l’objet blob de journaux de la console série. Note: Ce paramètre n’est pas défini si les diagnostics de démarrage sont actuellement activés avec le stockage géré.
status	InstanceViewStatus	Informations sur l’état des diagnostics de démarrage de la machine virtuelle. Note: Il ne sera défini que si des erreurs sont rencontrées lors de l’activation des diagnostics de démarrage.

CachingTypes

Énumération

Spécifie les exigences de mise en cache. Les valeurs possibles sont : None,ReadOnly,ReadWrite. Les valeurs par défaut sont : Aucune pour le stockage Standard. ReadOnly pour le stockage Premium

Valeur	Description
None
ReadOnly
ReadWrite

CloudError

Objet

Réponse d’erreur du service de calcul.

Nom	Type	Description
error	ApiError	Erreur d’API.

ComponentNames

Énumération

Valeur	Description
Microsoft-Windows-Shell-Setup

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

DataDisk

Objet

Décrit un disque de données.

Nom	Type	Description
caching	CachingTypes	Spécifie les exigences de mise en cache. Les valeurs possibles sont : None,ReadOnly,ReadWrite. Le comportement par défaut est : None pour le stockage Standard. ReadOnly pour le stockage Premium.
createOption	DiskCreateOptionTypes	Spécifie la façon dont le disque de machine virtuelle doit être créé. Les valeurs possibles sont Attacher : Cette valeur est utilisée lorsque vous utilisez un disque spécialisé pour créer la machine virtuelle. FromImage : Cette valeur est utilisée lorsque vous utilisez une image pour créer le disque de données de machine virtuelle. Si vous utilisez une image de plateforme, vous devez également utiliser l’élément imageReference décrit ci-dessus. Si vous utilisez une image de la Place de marché, vous devez également utiliser l’élément de plan décrit précédemment. Vide : Cette valeur est utilisée lors de la création d’un disque de données vide. Copier : Cette valeur est utilisée pour créer un disque de données à partir d’un instantané ou d’un autre disque. Restauration : Cette valeur est utilisée pour créer un disque de données à partir d’un point de restauration de disque.
deleteOption	DiskDeleteOptionTypes	Spécifie si le disque de données doit être supprimé ou détaché lors de la suppression de la machine virtuelle. Les valeurs possibles sont les suivantes : Supprimer. Si cette valeur est utilisée, le disque de données est supprimé lorsque la machine virtuelle est supprimée. Détacher. Si cette valeur est utilisée, le disque de données est conservé après la suppression de la machine virtuelle. La valeur par défaut est définie sur détacher.
detachOption	DiskDetachOptionTypes	Spécifie le comportement de détachement à utiliser lors du détachement d’un disque ou déjà en cours de détachement de la machine virtuelle. Valeurs prises en charge : ForceDetach. détacherOption : ForceDetach s’applique uniquement aux disques de données managés. Si une tentative de détachement précédente du disque de données n’a pas été effectuée en raison d’une défaillance inattendue de la machine virtuelle et que le disque n’est toujours pas libéré, utilisez une option de détachement forcé comme option de dernier recours pour détacher le disque de force de la machine virtuelle. Toutes les écritures n’ont peut-être pas été vidées lors de l’utilisation de ce comportement de détachement. Cette fonctionnalité est encore en préversion. Pour forcer le détachement d’une mise à jour du disque de données versBeDetached à « true », ainsi que le paramètre detachOption : « ForceDetach ».
diskIOPSReadWrite	integer (int64)	Spécifie les IOPS Read-Write pour le disque géré lorsque StorageAccountType est UltraSSD_LRS.
diskMBpsReadWrite	integer (int64)	Spécifie la bande passante en Mo par seconde pour le disque géré lorsque StorageAccountType est UltraSSD_LRS.
diskSizeGB	integer (int32)	Spécifie la taille d’un disque de données vide en gigaoctets. Cet élément peut être utilisé pour remplacer la taille du disque dans une image de machine virtuelle. La propriété « diskSizeGB » est le nombre d’octets x 1024^3 pour le disque et la valeur ne peut pas être supérieure à 1023.
image	VirtualHardDisk	Disque dur virtuel de l’image utilisateur source. Le disque dur virtuel est copié avant d’être attaché à la machine virtuelle. Si SourceImage est fourni, le disque dur virtuel de destination ne doit pas exister.
lun	integer (int32)	Spécifie le numéro d’unité logique du disque de données. Cette valeur est utilisée pour identifier les disques de données au sein de la machine virtuelle et doit donc être unique pour chaque disque de données attaché à une machine virtuelle.
managedDisk	ManagedDiskParameters	Paramètres de disque managé.
name	string	Nom du disque.
sourceResource	ApiEntityReference	Identificateur de ressource source. Il peut s’agir d’un instantané ou d’un point de restauration de disque à partir duquel créer un disque.
toBeDetached	boolean	Spécifie si le disque de données est en cours de détachement à partir de VirtualMachine/VirtualMachineScaleset
vhd	VirtualHardDisk	Disque dur virtuel.
writeAcceleratorEnabled	boolean	Spécifie si writeAccelerator doit être activé ou désactivé sur le disque.

DeleteOptions

Énumération

Spécifier ce qui se passe à l’interface réseau lorsque la machine virtuelle est supprimée

Valeur	Description
Delete
Detach

DiagnosticsProfile

Objet

Spécifie l’état des paramètres de diagnostic de démarrage. Version minimale de l’API : 2015-06-15.

Nom	Type	Description
bootDiagnostics	BootDiagnostics	Diagnostics de démarrage est une fonctionnalité de débogage qui vous permet d’afficher la sortie de la console et la capture d’écran pour diagnostiquer l’état de la machine virtuelle. REMARQUE: si storageUri est spécifié, vérifiez que le compte de stockage se trouve dans la même région et dans le même abonnement que la machine virtuelle. Vous pouvez facilement afficher la sortie de votre journal de console. Azure vous permet également de voir une capture d’écran de la machine virtuelle à partir de l’hyperviseur.

DiffDiskOptions

Énumération

Spécifie l’option disque éphémère pour le disque du système d’exploitation.

Valeur	Description
Local

DiffDiskPlacement

Énumération

Spécifie le placement de disque éphémère pour le disque du système d’exploitation. Cette propriété peut être utilisée par l’utilisateur dans la demande pour choisir l’emplacement, c’est-à-dire le disque de cache, le disque de ressources ou l’espace disque nvme pour le provisionnement de disque de système d’exploitation éphémère. Pour plus d’informations sur les exigences de taille de disque de système d’exploitation éphémère, reportez-vous à la configuration requise pour la taille de disque du système d’exploitation éphémère pour les machines virtuelles Windows sur https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements et la machine virtuelle Linux à l’adresse https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. Version minimale de l’API pour NvmeDisk : 2024-03-01.

Valeur	Description
CacheDisk
ResourceDisk
NvmeDisk

DiffDiskSettings

Objet

Décrit les paramètres des paramètres de disque éphémères qui peuvent être spécifiés pour le disque du système d’exploitation. Remarque : Les paramètres de disque éphémères ne peuvent être spécifiés que pour le disque managé.

Nom	Type	Description
option	DiffDiskOptions	Spécifie les paramètres de disque éphémères pour le disque du système d’exploitation.
placement	DiffDiskPlacement	Spécifie le placement de disque éphémère pour le disque du système d’exploitation. Les valeurs possibles sont les suivantes : CacheDisk,ResourceDisk,NvmeDisk. Le comportement par défaut est : CacheDisk si une taille de machine virtuelle est configurée pour la taille de machine virtuelle sinon ResourceDisk ou NvmeDisk est utilisé. Reportez-vous à la documentation sur la taille des machines virtuelles Windows sur https://docs.microsoft.com/azure/virtual-machines/windows/sizes et la machine virtuelle Linux à https://docs.microsoft.com/azure/virtual-machines/linux/sizes pour vérifier quelles tailles de machine virtuelle exposent un disque de cache. Version minimale de l’API pour NvmeDisk : 2024-03-01.

DiskControllerTypes

Énumération

Spécifie le type de contrôleur de disque configuré pour la machine virtuelle et VirtualMachineScaleSet. Cette propriété est uniquement prise en charge pour les machines virtuelles dont le disque du système d’exploitation et la référence SKU de machine virtuelle prennent en charge la génération 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), vérifiez la fonctionnalité HyperVGenerations retournée dans le cadre des fonctionnalités de référence SKU de machine virtuelle dans la réponse de l’API SKU Microsoft.Compute pour la région contient V2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list). Pour plus d’informations sur les types de contrôleurs de disque pris en charge, consultez https://aka.ms/azure-diskcontrollertypes.

Valeur	Description
SCSI
NVMe

DiskCreateOptionTypes

Énumération

Spécifie la façon dont le disque de machine virtuelle doit être créé. Les valeurs possibles sont Attacher : Cette valeur est utilisée lorsque vous utilisez un disque spécialisé pour créer la machine virtuelle. FromImage : Cette valeur est utilisée lorsque vous utilisez une image pour créer la machine virtuelle. Si vous utilisez une image de plateforme, vous devez également utiliser l’élément imageReference décrit ci-dessus. Si vous utilisez une image de la Place de marché, vous devez également utiliser l’élément de plan décrit précédemment. Vide : Cette valeur est utilisée lors de la création d’un disque de données vide. Copier : Cette valeur est utilisée pour créer un disque de données à partir d’un instantané ou d’un autre disque. Restauration : Cette valeur est utilisée pour créer un disque de données à partir d’un point de restauration de disque.

Valeur	Description
FromImage
Empty
Attach
Copy
Restore

DiskDeleteOptionTypes

Énumération

Spécifie le comportement du disque managé lorsque la machine virtuelle est supprimée, par exemple si le disque managé est supprimé ou détaché. Les valeurs prises en charge sont les suivantes : Supprimer. Si cette valeur est utilisée, le disque managé est supprimé lorsque la machine virtuelle est supprimée. Détacher. Si cette valeur est utilisée, le disque managé est conservé après la suppression de la machine virtuelle. Version minimale de l’API : 2021-03-01.

Valeur	Description
Delete
Detach

DiskDetachOptionTypes

Énumération

Spécifie le comportement de détachement à utiliser lors du détachement d’un disque ou déjà en cours de détachement de la machine virtuelle. Les valeurs prises en charge sont les suivantes : ForceDetach. detachOption : ForceDetach ne s’applique qu’aux disques de données gérés. Si une tentative de détachement précédente du disque de données n’a pas été effectuée en raison d’une défaillance inattendue de la machine virtuelle et que le disque n’est toujours pas libéré, utilisez une option de détachement forcé comme option de dernier recours pour détacher le disque de force de la machine virtuelle. Toutes les écritures n’ont peut-être pas été vidées lors de l’utilisation de ce comportement de détachement. Cette fonctionnalité est encore en préversion. Pour forcer le détachement d’une mise à jour du disque de données versBeDetached à « true », ainsi que le paramètre detachOption : « ForceDetach ».

Valeur	Description
ForceDetach

DiskEncryptionSetParameters

Objet

Décrit le paramètre de l’ID de ressource du jeu de chiffrement de disque géré par le client qui peut être spécifié pour le disque. Remarque : L’ID de ressource du jeu de chiffrement de disque ne peut être spécifié que pour le disque managé. Pour plus d’informations, consultez https://aka.ms/mdssewithcmkoverview.

Nom	Type	Description
id	string	ID de ressource

DiskEncryptionSettings

Objet

Décrit les paramètres de chiffrement d’un disque

Nom	Type	Description
diskEncryptionKey	KeyVaultSecretReference	Spécifie l’emplacement de la clé de chiffrement de disque, qui est un secret Key Vault.
enabled	boolean	Spécifie si le chiffrement de disque doit être activé sur la machine virtuelle.
keyEncryptionKey	KeyVaultKeyReference	Spécifie l’emplacement de la clé de chiffrement de clé dans Key Vault.

DiskInstanceView

Objet

Vue d’instance du disque.

Nom	Type	Description
encryptionSettings	DiskEncryptionSettings[]	Spécifie les paramètres de chiffrement du disque du système d’exploitation. Version minimale de l’API : 2015-06-15
name	string	Nom du disque.
statuses	InstanceViewStatus[]	Informations d’état de la ressource.

DomainNameLabelScopeTypes

Énumération

Étendue de l’étiquette du nom de domaine. La concaténation de l’étiquette de nom de domaine hachée générée en fonction de la stratégie à partir de l’étendue de l’étiquette de nom de domaine et de l’index de machine virtuelle sera les étiquettes de nom de domaine des ressources PublicIPAddress qui seront créées

Valeur	Description
TenantReuse
SubscriptionReuse
ResourceGroupReuse
NoReuse

EncryptionIdentity

Objet

Spécifie l’identité managée utilisée par ADE pour obtenir le jeton d’accès pour les opérations de coffre de clés.

Nom	Type	Description
userAssignedIdentityResourceId	string	Spécifie l’ID de ressource ARM de l’une des identités utilisateur associées à la machine virtuelle.

HardwareProfile

Objet

Spécifie les paramètres matériels de la machine virtuelle.

Nom	Type	Description
vmSize	VirtualMachineSizeTypes	Spécifie la taille de la machine virtuelle. Le type de données enum est actuellement déconseillé et sera supprimé d’ici le 23 décembre 2023. La méthode recommandée pour obtenir la liste des tailles disponibles consiste à utiliser ces API : Répertorier toutes les tailles de machine virtuelle disponibles dans un groupe à haute disponibilité, Répertorier toutes les tailles de machine virtuelle disponibles dans une région, Répertorier toutes les tailles de machine virtuelle disponibles pour redimensionner. Pour plus d’informations sur les tailles de machine virtuelle, consultez Tailles des machines virtuelles. Les tailles de machine virtuelle disponibles dépendent de la région et du groupe à haute disponibilité.
vmSizeProperties	VMSizeProperties	Spécifie les propriétés permettant de personnaliser la taille de la machine virtuelle. Version minimale de l’API : 2021-07-01. Cette fonctionnalité est toujours en mode préversion et n’est pas prise en charge pour VirtualMachineScaleSet. Pour plus d’informations, suivez les instructions de Personnalisation de machine virtuelle.

HostEndpointSettings

Objet

Spécifie des paramètres de point de terminaison d’hôte particuliers.

Nom	Type	Description
inVMAccessControlProfileReferenceId	string	Spécifie l’ID de ressource InVMAccessControlProfileVersion au format /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}
mode	Modes	Spécifie le mode d’exécution. En mode Audit, le système agit comme s’il applique la stratégie de contrôle d’accès, y compris l’émission d’entrées de déni d’accès dans les journaux, mais il ne refuse pas réellement les demandes aux points de terminaison hôtes. En mode Appliquer, le système applique le contrôle d’accès et il s’agit du mode d’opération recommandé.

HyperVGeneration

Énumération

Génération d’hyperviseur de la machine virtuelle [V1, V2]

Valeur	Description
V1
V2

ImageReference

Objet

Spécifie des informations sur l’image à utiliser. Vous pouvez spécifier des informations sur les images de plateforme, les images de la Place de marché ou les images de machine virtuelle. Cet élément est requis lorsque vous souhaitez utiliser une image de plateforme, une image de la Place de marché ou une image de machine virtuelle, mais n’est pas utilisé dans d’autres opérations de création. REMARQUE : l’éditeur et l’offre de référence d’image ne peuvent être définis que lorsque vous créez le groupe identique.

Nom	Type	Description
communityGalleryImageId	string	Spécifie l’ID unique de l’image de la galerie de communautés pour le déploiement de machines virtuelles. Cette opération peut être extraite de l’appel GET de la galerie de la communauté.
exactVersion	string	Spécifie, en nombres décimaux, la version de l’image de plateforme ou de l’image de la place de marché utilisée pour créer la machine virtuelle. Ce champ en lecture seule diffère de 'version', uniquement si la valeur spécifiée dans le champ 'version' est 'latest'.
id	string	ID de ressource
offer	string	Spécifie l’offre de l’image de plateforme ou de la place de marché utilisée pour créer la machine virtuelle.
publisher	string	Éditeur d’images.
sharedGalleryImageId	string	Spécifie l’ID unique de l’image de galerie partagée pour le déploiement de machines virtuelles. Cette opération peut être extraite de l’appel GET de l’image de galerie partagée.
sku	string	Référence SKU d’image.
version	string	Spécifie la version de l’image de plateforme ou de la place de marché utilisée pour créer la machine virtuelle. Les formats autorisés sont Major.Minor.Build ou « latest ». Les nombres principaux, mineurs et build sont des nombres décimaux. Spécifiez « latest » pour utiliser la dernière version d’une image disponible au moment du déploiement. Même si vous utilisez la « dernière version », l’image de machine virtuelle ne sera pas automatiquement mise à jour après le déploiement même si une nouvelle version devient disponible. N’utilisez pas le champ « version » pour le déploiement d’images de galerie, l’image de la galerie doit toujours utiliser le champ « ID » pour le déploiement, pour utiliser la version la plus récente de l’image de la galerie, il vous suffit de définir « /subscriptions/{subscriptionId}/resourceGroupName}/{resourceGroupName}/providers/Microsoft.Compute/galleryName}/images/{imageName} » dans le champ « id » sans entrée de version.

InnerError

Objet

Détails de l’erreur interne.

Nom	Type	Description
errordetail	string	Message d’erreur interne ou vidage d’exception.
exceptiontype	string	Type d’exception.

InstanceViewStatus

Objet

État de l’affichage de l’instance.

Nom	Type	Description
code	string	Code d’état.
displayStatus	string	Étiquette localisable courte pour l’état.
level	StatusLevelTypes	Code de niveau.
message	string	Message d’état détaillé, y compris pour les alertes et les messages d’erreur.
time	string (date-time)	Heure de l’état.

InstanceViewTypes

Énumération

Valeur	Description
instanceView
userData
resiliencyView

IPVersion

Énumération

Disponible à partir de Api-Version 2017-03-30, il indique si la configuration ip spécifique est IPv4 ou IPv6. La valeur par défaut est prise en tant que IPv4. Les valeurs possibles sont : « IPv4 » et « IPv6 ».

Valeur	Description
IPv4
IPv6

IPVersions

Énumération

Valeur	Description
IPv4
IPv6

KeyVaultKeyReference

Objet

Décrit une référence à Key Vault Key

Nom	Type	Description
keyUrl	string	URL référençant une clé de chiffrement de clé dans Key Vault.
sourceVault	SubResource	URL relative du coffre de clés contenant la clé.

KeyVaultSecretReference

Objet

Décrit une référence au secret Key Vault

Nom	Type	Description
secretUrl	string	URL référençant un secret dans un coffre de clés.
sourceVault	SubResource	URL relative du coffre de clés contenant le secret.

LinuxConfiguration

Objet

Spécifie les paramètres du système d’exploitation Linux sur la machine virtuelle. Pour obtenir la liste des distributions Linux prises en charge, consultez Linux sur Azure-Endorsed Distributions.

Nom	Type	Description
disablePasswordAuthentication	boolean	Spécifie si l’authentification par mot de passe doit être désactivée.
enableVMAgentPlatformUpdates	boolean	Indique si les mises à jour de la plateforme VMAgent sont activées pour la machine virtuelle Linux. La valeur par défaut est False.
patchSettings	LinuxPatchSettings	[Fonctionnalité en préversion] Spécifie les paramètres liés à la mise à jour corrective d’invité de machine virtuelle sur Linux.
provisionVMAgent	boolean	Indique si l’agent de machine virtuelle doit être approvisionné sur la machine virtuelle. Lorsque cette propriété n’est pas spécifiée dans le corps de la requête, le comportement par défaut est de le définir sur true. Cela garantit que l’agent de machine virtuelle est installé sur la machine virtuelle afin que les extensions puissent être ajoutées ultérieurement à la machine virtuelle.
ssh	SshConfiguration	Spécifie la configuration de la clé SSH pour un système d’exploitation Linux.

LinuxPatchAssessmentMode

Énumération

Spécifie le mode d’évaluation des correctifs invités de machine virtuelle pour la machine virtuelle IaaS.

Les valeurs possibles sont les suivantes :

ImageDefault : vous contrôlez le minutage des évaluations des correctifs sur une machine virtuelle.

AutomaticByPlatform : la plateforme déclenche des évaluations périodiques des correctifs. La propriété provisionVMAgent doit être vraie.

Valeur	Description
ImageDefault
AutomaticByPlatform

LinuxPatchSettings

Objet

Spécifie les paramètres liés à la mise à jour corrective d’invité de machine virtuelle sur Linux.

Nom	Type	Description
assessmentMode	LinuxPatchAssessmentMode	Spécifie le mode d’évaluation des correctifs invités de machine virtuelle pour la machine virtuelle IaaS. Les valeurs possibles sont les suivantes : ImageDefault : vous contrôlez le minutage des évaluations des correctifs sur une machine virtuelle. AutomaticByPlatform : la plateforme déclenche des évaluations périodiques des correctifs. La propriété provisionVMAgent doit être vraie.
automaticByPlatformSettings	LinuxVMGuestPatchAutomaticByPlatformSettings	Spécifie des paramètres supplémentaires pour le mode de correctif AutomatiqueByPlatform dans le correctif invité de machine virtuelle sur Linux.
patchMode	LinuxVMGuestPatchMode	Spécifie le mode de mise à jour corrective d’invité de machine virtuelle sur une machine virtuelle IaaS ou des machines virtuelles associées au groupe de machines virtuelles identiques avec OrchestrationMode en tant que flexible. Les valeurs possibles sont les suivantes : ImageDefault : la configuration de mise à jour corrective par défaut de la machine virtuelle est utilisée. AutomaticByPlatform : la machine virtuelle est automatiquement mise à jour par la plateforme. La propriété provisionVMAgent doit être true

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Énumération

Spécifie le paramètre de redémarrage pour toutes les opérations d’installation des correctifs AutomaticByPlatform.

Valeur	Description
Unknown
IfRequired
Never
Always

LinuxVMGuestPatchAutomaticByPlatformSettings

Objet

Spécifie des paramètres supplémentaires à appliquer lorsque le mode correctif AutomatiqueByPlatform est sélectionné dans les paramètres de correctif Linux.

Nom	Type	Description
bypassPlatformSafetyChecksOnUserSchedule	boolean	Permet au client de planifier la mise à jour corrective sans mises à niveau accidentelles
rebootSetting	LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Spécifie le paramètre de redémarrage pour toutes les opérations d’installation des correctifs AutomaticByPlatform.

LinuxVMGuestPatchMode

Énumération

Valeur	Description
ImageDefault
AutomaticByPlatform

MaintenanceOperationResultCodeTypes

Énumération

Code de résultat de la dernière opération de maintenance.

Valeur	Description
None
RetryLater
MaintenanceAborted
MaintenanceCompleted

MaintenanceRedeployStatus

Objet

État de fonctionnement de maintenance.

Nom	Type	Description
isCustomerInitiatedMaintenanceAllowed	boolean	Vrai, si le client est autorisé à effectuer la maintenance.
lastOperationMessage	string	Message renvoyé pour la dernière opération de maintenance.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	Code de résultat de la dernière opération de maintenance.
maintenanceWindowEndTime	string (date-time)	Heure de fin de la fenêtre de maintenance.
maintenanceWindowStartTime	string (date-time)	Heure de début de la fenêtre de maintenance.
preMaintenanceWindowEndTime	string (date-time)	Heure de fin de la fenêtre de pré-maintenance.
preMaintenanceWindowStartTime	string (date-time)	Heure de début de la fenêtre de pré-maintenance.

ManagedDiskParameters

Objet

Paramètres d’un disque managé.

Nom	Type	Description
diskEncryptionSet	DiskEncryptionSetParameters	Spécifie l’ID de ressource du jeu de chiffrement de disque managé du client pour le disque managé.
id	string	ID de ressource
securityProfile	VMDiskSecurityProfile	Spécifie le profil de sécurité du disque managé.
storageAccountType	StorageAccountTypes	Spécifie le type de compte de stockage pour le disque managé. REMARQUE : UltraSSD_LRS ne peut être utilisé qu’avec des disques de données, il ne peut pas être utilisé avec le disque du système d’exploitation.

Mode

Énumération

Spécifie le mode sur lequel ProxyAgent s’exécute si la fonctionnalité est activée. ProxyAgent commence à auditer ou à surveiller, mais pas à appliquer le contrôle d’accès sur les demandes aux points de terminaison hôtes en mode Audit, tandis qu’en mode Appliquer, il applique le contrôle d’accès. La valeur par défaut est Appliquer le mode.

Valeur	Description
Audit
Enforce

Modes

Énumération

Spécifie le mode d’exécution. En mode Audit, le système agit comme s’il applique la stratégie de contrôle d’accès, y compris l’émission d’entrées de déni d’accès dans les journaux, mais il ne refuse pas réellement les demandes aux points de terminaison hôtes. En mode Appliquer, le système applique le contrôle d’accès et il s’agit du mode d’opération recommandé.

Valeur	Description
Audit
Enforce
Disabled

NetworkApiVersion

Énumération

spécifie la version de l’API Microsoft.Network utilisée lors de la création de ressources réseau dans les configurations d’interface réseau

Valeur	Description
2020-11-01
2022-11-01

NetworkInterfaceAuxiliaryMode

Énumération

Spécifie si le mode auxiliaire est activé pour la ressource d’interface réseau.

Valeur	Description
None
AcceleratedConnections
Floating

NetworkInterfaceAuxiliarySku

Énumération

Spécifie si la référence SKU auxiliaire est activée pour la ressource d’interface réseau.

Valeur	Description
None
A1
A2
A4
A8

NetworkInterfaceReference

Objet

Décrit une référence d’interface réseau.

Nom	Type	Description
id	string	ID de ressource
properties.deleteOption	DeleteOptions	Spécifier ce qui se passe à l’interface réseau lorsque la machine virtuelle est supprimée
properties.primary	boolean	Spécifie l’interface réseau principale si la machine virtuelle a plus de 1 interface réseau.

NetworkProfile

Objet

Spécifie les interfaces réseau ou la configuration réseau de la machine virtuelle.

Nom	Type	Description
networkApiVersion	NetworkApiVersion	spécifie la version de l’API Microsoft.Network utilisée lors de la création de ressources réseau dans les configurations d’interface réseau
networkInterfaceConfigurations	VirtualMachineNetworkInterfaceConfiguration[]	Spécifie les configurations réseau qui seront utilisées pour créer les ressources réseau de la machine virtuelle.
networkInterfaces	NetworkInterfaceReference[]	Spécifie la liste des ID de ressource pour les interfaces réseau associées à la machine virtuelle.

OperatingSystemTypes

Énumération

Cette propriété vous permet de spécifier le type du système d’exploitation inclus dans le disque si vous créez une machine virtuelle à partir d’une image utilisateur ou d’un disque dur virtuel spécialisé. Les valeurs possibles sont : Windows,Linux.

Valeur	Description
Windows
Linux

OSDisk

Objet

Spécifie des informations sur le disque du système d’exploitation utilisé par la machine virtuelle. Pour plus d’informations sur les disques, consultez À propos des disques et des disques durs virtuels pour les machines virtuelles Azure.

Nom	Type	Description
caching	CachingTypes	Spécifie les exigences de mise en cache. Les valeurs possibles sont : None,ReadOnly,ReadWrite. Le comportement par défaut est : None pour le stockage Standard. ReadOnly pour le stockage Premium.
createOption	DiskCreateOptionTypes	Spécifie la façon dont le disque de machine virtuelle doit être créé. Les valeurs possibles sont Attacher : Cette valeur est utilisée lorsque vous utilisez un disque spécialisé pour créer la machine virtuelle. FromImage : Cette valeur est utilisée lorsque vous utilisez une image pour créer la machine virtuelle. Si vous utilisez une image de plateforme, vous devez également utiliser l’élément imageReference décrit ci-dessus. Si vous utilisez une image de la Place de marché, vous devez également utiliser l’élément de plan décrit précédemment.
deleteOption	DiskDeleteOptionTypes	Spécifie si le disque du système d’exploitation doit être supprimé ou détaché lors de la suppression de la machine virtuelle. Les valeurs possibles sont les suivantes : Supprimer. Si cette valeur est utilisée, le disque du système d’exploitation est supprimé lorsque la machine virtuelle est supprimée. Détacher. Si cette valeur est utilisée, le disque du système d’exploitation est conservé après la suppression de la machine virtuelle. La valeur par défaut est définie sur détacher. Pour un disque de système d’exploitation éphémère, la valeur par défaut est définie sur Supprimer. L’utilisateur ne peut pas modifier l’option de suppression d’un disque de système d’exploitation éphémère.
diffDiskSettings	DiffDiskSettings	Spécifie les paramètres de disque éphémères pour le disque du système d’exploitation utilisé par la machine virtuelle.
diskSizeGB	integer (int32)	Spécifie la taille d’un disque de données vide en gigaoctets. Cet élément peut être utilisé pour remplacer la taille du disque dans une image de machine virtuelle. La propriété « diskSizeGB » est le nombre d’octets x 1024^3 pour le disque et la valeur ne peut pas être supérieure à 1023.
encryptionSettings	DiskEncryptionSettings	Spécifie les paramètres de chiffrement du disque du système d’exploitation. Version minimale de l’API : 2015-06-15.
image	VirtualHardDisk	Disque dur virtuel de l’image utilisateur source. Le disque dur virtuel est copié avant d’être attaché à la machine virtuelle. Si SourceImage est fourni, le disque dur virtuel de destination ne doit pas exister.
managedDisk	ManagedDiskParameters	Paramètres de disque managé.
name	string	Nom du disque.
osType	OperatingSystemTypes	Cette propriété vous permet de spécifier le type du système d’exploitation inclus dans le disque si vous créez une machine virtuelle à partir d’une image utilisateur ou d’un disque dur virtuel spécialisé. Les valeurs possibles sont : Windows,Linux.
vhd	VirtualHardDisk	Disque dur virtuel.
writeAcceleratorEnabled	boolean	Spécifie si writeAccelerator doit être activé ou désactivé sur le disque.

OSProfile

Objet

Spécifie les paramètres du système d’exploitation de la machine virtuelle. Certains des paramètres ne peuvent pas être modifiés une fois la machine virtuelle approvisionnée.

Nom	Type	Description
adminPassword	string (password)	Spécifie le mot de passe du compte d’administrateur. Longueur minimale (Windows) : 8 caractères Longueur minimale (Linux) : 6 caractères Longueur maximale (Windows) : 123 caractères longueur maximale (Linux) : 72 caractères Exigences de complexité : 3 conditions sur 4 ci-dessous doivent être remplies Comporte des caractères inférieurs Comporte des caractères supérieurs A un chiffre A un caractère spécial (correspondance Regex [\W_]) Valeurs non autorisées : « abc@123 », « P@$$w 0rd », « P@ssw0rd », « P@ssword123 », « Pa$$word », « pass@word1 », « Password ! », « Password1 », « Password22 », « iloveyou ! » Pour réinitialiser le mot de passe, consultez Comment réinitialiser le service Bureau à distance ou son mot de passe de connexion dans une machine virtuelle Windows Pour réinitialiser le mot de passe racine, consultez Gérer les utilisateurs, SSH et vérifier ou réparer des disques sur des machines virtuelles Linux Azure à l’aide de l’extension VMAccess
adminUsername	string	Spécifie le nom du compte d’administrateur. Cette propriété ne peut pas être mise à jour une fois la machine virtuelle créée. restriction Windows uniquement : Impossible de se terminer par « ». Valeurs non autorisées : « administrateur », « admin », « user », « user1 », « test », « user2 », « test1 », « user3 », « admin1 », « 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 ». longueur minimale (Linux) : 1 caractère Longueur maximale (Linux) : 64 caractères Longueur maximale (Windows) : 20 caractères.
allowExtensionOperations	boolean	Spécifie si les opérations d’extension doivent être autorisées sur la machine virtuelle. Cela peut uniquement être défini sur False lorsqu’aucune extension n’est présente sur la machine virtuelle.
computerName	string	Spécifie le nom du système d’exploitation hôte de la machine virtuelle. Ce nom ne peut pas être mis à jour une fois la machine virtuelle créée. Longueur maximale (Windows) : 15 caractères. longueur maximale (Linux) : 64 caractères. Pour connaître les conventions et restrictions d’affectation de noms, consultez instructions d’implémentation des services d’infrastructure Azure.
customData	string	Spécifie une chaîne codée en base 64 de données personnalisées. La chaîne encodée en base 64 est décodée dans un tableau binaire enregistré en tant que fichier sur la machine virtuelle. La longueur maximale du tableau binaire est de 65535 octets. Remarque : Ne transmettez pas de secrets ou de mots de passe dans la propriété customData. Cette propriété ne peut pas être mise à jour une fois la machine virtuelle créée. La propriété « customData » est transmise à la machine virtuelle à enregistrer sous forme de fichier. Pour plus d’informations, consultez Données personnalisées sur les machines virtuelles Azure. Pour utiliser cloud-init pour votre machine virtuelle Linux, consultez Utilisation de cloud-init pour personnaliser une machine virtuelle Linux lors de la création.
linuxConfiguration	LinuxConfiguration	Spécifie les paramètres du système d’exploitation Linux sur la machine virtuelle. Pour obtenir la liste des distributions Linux prises en charge, consultez Linux sur Azure-Endorsed Distributions.
requireGuestProvisionSignal	boolean	Propriété facultative qui doit être définie sur True ou omise.
secrets	VaultSecretGroup[]	Spécifie le jeu de certificats qui doivent être installés sur la machine virtuelle. Pour installer des certificats sur une machine virtuelle, il est recommandé d’utiliser l’extension de machine virtuelle Azure Key Vault pour Linux ou l’extension de machine virtuelle Azure Key Vault pour Windows.
windowsConfiguration	WindowsConfiguration	Spécifie les paramètres du système d’exploitation Windows sur la machine virtuelle.

PassNames

Énumération

Valeur	Description
OobeSystem

PatchSettings

Objet

Spécifie les paramètres liés à la mise à jour corrective de l’invité de machine virtuelle sur Windows.

Nom	Type	Description
assessmentMode	WindowsPatchAssessmentMode	Spécifie le mode d’évaluation des correctifs invités de machine virtuelle pour la machine virtuelle IaaS. Les valeurs possibles sont les suivantes : ImageDefault : vous contrôlez le minutage des évaluations des correctifs sur une machine virtuelle. AutomaticByPlatform : la plateforme déclenche des évaluations périodiques des correctifs. La propriété provisionVMAgent doit être vraie.
automaticByPlatformSettings	WindowsVMGuestPatchAutomaticByPlatformSettings	Spécifie des paramètres supplémentaires pour le mode correctif AutomatiqueByPlatform dans la mise à jour corrective d’invité de machine virtuelle sur Windows.
enableHotpatching	boolean	Permet aux clients de corriger leurs machines virtuelles Azure sans nécessiter de redémarrage. Pour enableHotpatching, le paramètre « provisionVMAgent » doit être défini sur true et « patchMode » doit être défini sur « AutomaticByPlatform ».
patchMode	WindowsVMGuestPatchMode	Spécifie le mode de mise à jour corrective d’invité de machine virtuelle sur une machine virtuelle IaaS ou des machines virtuelles associées au groupe de machines virtuelles identiques avec OrchestrationMode en tant que flexible. Les valeurs possibles sont les suivantes : manuel : vous contrôlez l’application de correctifs sur une machine virtuelle. Pour ce faire, appliquez manuellement des correctifs à l’intérieur de la machine virtuelle. Dans ce mode, les mises à jour automatiques sont désactivées ; la propriété WindowsConfiguration.enableAutomaticUpdates doit être false AutomaticByOS : la machine virtuelle est automatiquement mise à jour par le système d’exploitation. La propriété WindowsConfiguration.enableAutomaticUpdates doit être vraie. AutomaticByPlatform : la machine virtuelle est automatiquement mise à jour par la plateforme. Les propriétés provisionVMAgent et WindowsConfiguration.enableAutomaticUpdates doivent être vraies

Plan

Objet

Spécifie des informations sur l’image de la Place de marché utilisée pour créer la machine virtuelle. Cet élément est utilisé uniquement pour les images de la Place de marché. Avant de pouvoir utiliser une image de la Place de marché à partir d’une API, vous devez activer l’image pour une utilisation programmatique. Dans le portail Azure, recherchez l’image de la Place de marché que vous souhaitez utiliser, puis cliquez sur Voulez déployer par programmation, Prise en main ->. Entrez les informations requises, puis cliquez sur Enregistrer.

Nom	Type	Description
name	string	ID du plan.
product	string	Spécifie le produit de l’image à partir de la Place de marché. Il s’agit de la même valeur que Offer sous l’élément imageReference.
promotionCode	string	Code de promotion.
publisher	string	ID de l’éditeur.

ProtocolTypes

Énumération

Spécifie le protocole de l’écouteur WinRM. Les valeurs possibles sont les suivantes : http,https.

Valeur	Description
Http
Https

ProxyAgentSettings

Objet

Spécifie les paramètres ProxyAgent pour la machine virtuelle ou le groupe de machines virtuelles identiques. Version minimale de l’API : 2023-09-01.

Nom	Type	Description
addProxyAgentExtension	boolean	Spécifiez s’il faut installer implicitement l’extension ProxyAgent. Cette option n’est actuellement applicable que pour le système d’exploitation Linux.
enabled	boolean	Spécifie si la fonctionnalité ProxyAgent doit être activée sur la machine virtuelle ou sur le groupe de machines virtuelles identiques.
imds	HostEndpointSettings	Spécifie les paramètres de point de terminaison IMDS lors de la création de la machine virtuelle ou du groupe de machines virtuelles identiques. Version minimale de l’API : 2024-03-01.
keyIncarnationId	integer (int32)	Augmenter la valeur de cette propriété permet aux utilisateurs de réinitialiser la clé utilisée pour sécuriser le canal de communication entre l’invité et l’hôte.
mode	Mode	Spécifie le mode sur lequel ProxyAgent s’exécute. Avertissement : cette propriété a été déconseillée, spécifiez « mode » sous un paramètre hostendpoint particulier.
wireServer	HostEndpointSettings	Spécifie les paramètres de point de terminaison Wire Server lors de la création de la machine virtuelle ou du groupe de machines virtuelles identiques. Version minimale de l’API : 2024-03-01.

PublicIPAddressSku

Objet

Décrit la référence SKU IP publique. Il ne peut être défini qu’avec OrchestrationMode comme flexible.

Nom	Type	Description
name	PublicIPAddressSkuName	Spécifier le nom de la référence SKU IP publique
tier	PublicIPAddressSkuTier	Spécifier le niveau de référence sku IP public

PublicIPAddressSkuName

Énumération

Spécifier le nom de la référence SKU IP publique

Valeur	Description
Basic
Standard

PublicIPAddressSkuTier

Énumération

Spécifier le niveau de référence sku IP public

Valeur	Description
Regional
Global

PublicIPAllocationMethod

Énumération

Spécifier le type d’allocation d’adresses IP publiques

Valeur	Description
Dynamic
Static

ResilientVMDeletionStatus

Énumération

Spécifie l’état de suppression de machine virtuelle résiliente pour la machine virtuelle.

Valeur	Description
Enabled
Disabled
InProgress
Failed

ResourceIdentityType

Énumération

Type d’identité utilisé pour le groupe de machines virtuelles identiques. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du groupe de machines virtuelles identiques.

Valeur	Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

SecurityEncryptionTypes

Énumération

Spécifie le EncryptionType du disque managé. Il est défini sur DiskWithVMGuestState pour le chiffrement du disque managé avec l’objet blob VMGuestState, VMGuestStateOnly pour le chiffrement de l’objet blob VMGuestState et nonPersistedTPM pour ne pas conserver l’état du microprogramme dans l’objet blob VMGuestState.. Remarque : Il peut être défini uniquement pour les machines virtuelles confidentielles.

Valeur	Description
VMGuestStateOnly
DiskWithVMGuestState
NonPersistedTPM

SecurityProfile

Objet

Spécifie les paramètres du profil de sécurité pour la machine virtuelle ou le groupe de machines virtuelles identiques.

Nom	Type	Description
encryptionAtHost	boolean	Cette propriété peut être utilisée par l’utilisateur dans la demande pour activer ou désactiver le chiffrement de l’hôte pour la machine virtuelle ou le groupe de machines virtuelles identiques. Cela active le chiffrement pour tous les disques, y compris le disque Resource/Temp sur l’hôte lui-même. Le comportement par défaut est : Le chiffrement sur l’hôte est désactivé, sauf si cette propriété a la valeur true pour la ressource.
encryptionIdentity	EncryptionIdentity	Spécifie l’identité managée utilisée par ADE pour obtenir le jeton d’accès pour les opérations de coffre de clés.
proxyAgentSettings	ProxyAgentSettings	Spécifie les paramètres ProxyAgent lors de la création de la machine virtuelle. Version minimale de l’API : 2023-09-01.
securityType	SecurityTypes	Spécifie le SecurityType de la machine virtuelle. Il doit être défini sur n’importe quelle valeur spécifiée pour activer UefiSettings. Le comportement par défaut est : UefiSettings n’est pas activé, sauf si cette propriété est définie.
uefiSettings	UefiSettings	Spécifie les paramètres de sécurité tels que le démarrage sécurisé et vTPM utilisés lors de la création de la machine virtuelle. Version minimale de l’API : 2020-12-01.

SecurityTypes

Énumération

Spécifie le SecurityType de la machine virtuelle. Il doit être défini sur n’importe quelle valeur spécifiée pour activer UefiSettings. Le comportement par défaut est : UefiSettings n’est pas activé, sauf si cette propriété est définie.

Valeur	Description
TrustedLaunch
ConfidentialVM

SettingNames

Énumération

Spécifie le nom du paramètre auquel le contenu s’applique. Les valeurs possibles sont les suivantes : FirstLogonCommands et AutoLogon.

Valeur	Description
AutoLogon
FirstLogonCommands

Sku

Objet

Décrit la référence SKU d’un groupe de machines virtuelles identiques. REMARQUE : Si la nouvelle référence SKU de machine virtuelle n’est pas prise en charge sur le matériel sur lequel le groupe identique est actuellement activé, vous devez libérer les machines virtuelles du groupe identique avant de modifier le nom de la référence SKU.

Nom	Type	Description
capacity	integer (int64)	Spécifie le nombre de machines virtuelles dans le groupe identique.
name	string	Nom de la référence SKU.
tier	string	Spécifie le niveau des machines virtuelles dans un groupe identique. Valeurs possibles : Standard Basic

SshConfiguration

Objet

Configuration SSH pour les machines virtuelles Linux s’exécutant sur Azure

Nom	Type	Description
publicKeys	SshPublicKey[]	Liste des clés publiques SSH utilisées pour s’authentifier auprès de machines virtuelles linux.

SshPublicKey

Objet

Contient des informations sur la clé publique du certificat SSH et le chemin d’accès sur la machine virtuelle Linux où la clé publique est placée.

Nom	Type	Description
keyData	string	Certificat de clé publique SSH utilisé pour s’authentifier auprès de la machine virtuelle via ssh. La clé doit être au moins 2048 bits et au format ssh-rsa. Pour créer des clés SSH, consultez [Créer des clés SSH sur Linux et Mac pour machines virtuelles Linux dans Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).
path	string	Spécifie le chemin complet sur la machine virtuelle créée où la clé publique ssh est stockée. Si le fichier existe déjà, la clé spécifiée est ajoutée au fichier. Exemple : /home/user/.ssh/authorized_keys

StatusLevelTypes

Énumération

Code de niveau.

Valeur	Description
Info
Warning
Error

StorageAccountTypes

Énumération

Spécifie le type de compte de stockage pour le disque managé. Le type de compte de stockage de disque de système d’exploitation managé ne peut être défini que lorsque vous créez le groupe identique. REMARQUE : UltraSSD_LRS ne peut être utilisé qu’avec des disques de données. Il ne peut pas être utilisé avec le disque du système d’exploitation. Standard_LRS utilise hdD Standard. StandardSSD_LRS utilise ssd Standard. Premium_LRS utilise ssd Premium. UltraSSD_LRS utilise le disque Ultra. Premium_ZRS utilise le stockage redondant interzone SSD Premium. StandardSSD_ZRS utilise le stockage redondant interzone SSD Standard. Pour plus d’informations sur les disques pris en charge pour les machines virtuelles Windows, reportez-vous à https://docs.microsoft.com/azure/virtual-machines/windows/disks-types et, pour les machines virtuelles Linux, reportez-vous à https://docs.microsoft.com/azure/virtual-machines/linux/disks-types

Valeur	Description
Standard_LRS
Premium_LRS
StandardSSD_LRS
UltraSSD_LRS
Premium_ZRS
StandardSSD_ZRS
PremiumV2_LRS

StorageProfile

Objet

Spécifie les paramètres de stockage des disques de machine virtuelle.

Nom	Type	Description
alignRegionalDisksToVMZone	boolean	Spécifie si les disques régionaux doivent être alignés/déplacés vers la zone de machine virtuelle. Cela s’applique uniquement aux machines virtuelles dont la propriété de placement est définie. Veuillez noter que cette modification est irréversible. Version minimale de l’API : 2024-11-01.
dataDisks	DataDisk[]	Spécifie les paramètres utilisés pour ajouter un disque de données à une machine virtuelle. Pour plus d’informations sur les disques, consultez À propos des disques et des disques durs virtuels pour les machines virtuelles Azure.
diskControllerType	DiskControllerTypes	Spécifie le type de contrôleur de disque configuré pour la machine virtuelle. Remarque : Cette propriété est définie sur le type de contrôleur de disque par défaut si aucune machine virtuelle fournie n’est créée avec « hyperVGeneration » définie sur V2 en fonction des fonctionnalités du disque du système d’exploitation et de la taille de machine virtuelle à partir de la version minimale spécifiée de l’API. Vous devez libérer la machine virtuelle avant de mettre à jour son type de contrôleur de disque, sauf si vous mettez à jour la taille de machine virtuelle dans la configuration de la machine virtuelle qui désalloue et réalloue implicitement la machine virtuelle. Version minimale de l’API : 2022-08-01.
imageReference	ImageReference	Spécifie des informations sur l’image à utiliser. Vous pouvez spécifier des informations sur les images de plateforme, les images de la Place de marché ou les images de machine virtuelle. Cet élément est requis lorsque vous souhaitez utiliser une image de plateforme, une image de la Place de marché ou une image de machine virtuelle, mais n’est pas utilisé dans d’autres opérations de création.
osDisk	OSDisk	Spécifie des informations sur le disque du système d’exploitation utilisé par la machine virtuelle. Pour plus d’informations sur les disques, consultez À propos des disques et des disques durs virtuels pour les machines virtuelles Azure.

SubResource

Objet

Nom	Type	Description
id	string	ID de ressource

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

UefiSettings

Objet

Spécifie les paramètres de sécurité tels que le démarrage sécurisé et vTPM utilisés lors de la création de la machine virtuelle. Version minimale de l’API : 2020-12-01.

Nom	Type	Description
secureBootEnabled	boolean	Spécifie si le démarrage sécurisé doit être activé sur la machine virtuelle. Version minimale de l’API : 2020-12-01.
vTpmEnabled	boolean	Spécifie si vTPM doit être activé sur la machine virtuelle. Version minimale de l’API : 2020-12-01.

UserAssignedIdentitiesValue

Objet

Nom	Type	Description
clientId	string	ID client de l’identité affectée par l’utilisateur.
principalId	string	ID principal de l’identité affectée par l’utilisateur.

VaultCertificate

Objet

Décrit une référence de certificat unique dans un coffre de clés et l’emplacement où le certificat doit résider sur la machine virtuelle.

Nom	Type	Description
certificateStore	string	Pour les machines virtuelles Windows, spécifie le magasin de certificats sur la machine virtuelle à laquelle le certificat doit être ajouté. Le magasin de certificats spécifié est implicitement dans le compte LocalMachine. Pour les machines virtuelles Linux, le fichier de certificat est placé sous le répertoire /var/lib/waagent, avec le nom de fichier <UppercaseThumbprint>.crt pour le fichier de certificat X509 et <UppercaseThumbprint>.prv pour la clé privée. Ces deux fichiers sont au format .pem.
certificateUrl	string	Il s’agit de l’URL d’un certificat qui a été chargé dans Key Vault en tant que secret. Pour ajouter un secret au coffre de clés, consultez Ajouter une clé ou un secret au coffre de clés. Dans ce cas, votre certificat doit être l’encodage Base64 de l’objet JSON suivant, qui est encodé en UTF-8 : { « data » : »<certificat codé en base64>« , « dataType » :"pfx », « password » : »<pfx-file-password>» } Pour installer des certificats sur une machine virtuelle, il est recommandé d’utiliser l’extension de machine virtuelle Azure Key Vault pour Linux ou l’extension de machine virtuelle Azure Key Vault pour Windows.

VaultSecretGroup

Objet

Décrit un ensemble de certificats qui se trouvent tous dans le même coffre de clés.

Nom	Type	Description
sourceVault	SubResource	URL relative du coffre de clés contenant tous les certificats dans VaultCertificates.
vaultCertificates	VaultCertificate[]	Liste des références de coffre de clés dans SourceVault qui contiennent des certificats.

VirtualHardDisk

Objet

Décrit l’URI d’un disque.

Nom	Type	Description
uri	string	Spécifie l’URI du disque dur virtuel.

VirtualMachineAgentInstanceView

Objet

Vue d’instance de l’agent de machine virtuelle en cours d’exécution sur la machine virtuelle.

Nom	Type	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	Vue d’instance du gestionnaire d’extension de machine virtuelle.
statuses	InstanceViewStatus[]	Informations d’état de la ressource.
vmAgentVersion	string	La version complète de VM Agent.

VirtualMachineExtension

Objet

Décrit une extension de machine virtuelle.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Emplacement géographique où réside la ressource
name	string	Nom de la ressource
properties.autoUpgradeMinorVersion	boolean	Indique si l’extension doit utiliser une version mineure plus récente si elle est disponible au moment du déploiement. Une fois déployée, toutefois, l’extension ne met pas à niveau les versions mineures, sauf si elle est redéployée, même avec cette propriété définie sur true.
properties.enableAutomaticUpgrade	boolean	Indique si l’extension doit être automatiquement mise à niveau par la plateforme s’il existe une version plus récente de l’extension disponible.
properties.forceUpdateTag	string	Comment le gestionnaire d’extensions doit être forcé de mettre à jour même si la configuration de l’extension n’a pas changé.
properties.instanceView	VirtualMachineExtensionInstanceView	Vue d’instance d’extension de machine virtuelle.
properties.protectedSettings		L’extension peut contenir protectedSettings ou protectedSettingsFromKeyVault ou aucun paramètre protégé du tout.
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	Paramètres protégés par extensions passés par référence et consommés à partir du coffre de clés
properties.provisionAfterExtensions	string[]	Collection de noms d’extensions après lesquels cette extension doit être provisionnée.
properties.provisioningState	string	État d’approvisionnement, qui apparaît uniquement dans la réponse.
properties.publisher	string	Nom du serveur de publication du gestionnaire d’extensions.
properties.settings		Paramètres publics au format Json pour l’extension.
properties.suppressFailures	boolean	Indique si les échecs résultant de l’extension seront supprimés (les échecs opérationnels tels que la connexion à la machine virtuelle ne seront pas supprimés indépendamment de cette valeur). La valeur par défaut est false.
properties.type	string	Spécifie le type de l’extension ; un exemple est « CustomScriptExtension ».
properties.typeHandlerVersion	string	Spécifie la version du gestionnaire de scripts.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

VirtualMachineExtensionHandlerInstanceView

Objet

Vue d’instance d’un gestionnaire d’extensions de machine virtuelle.

Nom	Type	Description
status	InstanceViewStatus	État du gestionnaire d’extensions.
type	string	Spécifie le type de l’extension ; un exemple est « CustomScriptExtension ».
typeHandlerVersion	string	Spécifie la version du gestionnaire de scripts.

VirtualMachineExtensionInstanceView

Objet

Vue d’instance d’une extension de machine virtuelle.

Nom	Type	Description
name	string	Nom de l’extension de machine virtuelle.
statuses	InstanceViewStatus[]	Informations d’état de la ressource.
substatuses	InstanceViewStatus[]	Informations d’état de la ressource.
type	string	Spécifie le type de l’extension ; un exemple est « CustomScriptExtension ».
typeHandlerVersion	string	Spécifie la version du gestionnaire de scripts.

VirtualMachineHealthStatus

Objet

L’état d’intégrité de la machine virtuelle.

Nom	Type	Description
status	InstanceViewStatus	Informations sur l’état d’intégrité de la machine virtuelle.

VirtualMachineIdentity

Objet

Identité de la machine virtuelle.

Nom	Type	Description
principalId	string	ID principal de l’identité de la machine virtuelle. Cette propriété est fournie uniquement pour une identité affectée par le système.
tenantId	string	ID de locataire associé à la machine virtuelle. Cette propriété est fournie uniquement pour une identité affectée par le système.
type	ResourceIdentityType	Type d’identité utilisé pour la machine virtuelle. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités de la machine virtuelle.
userAssignedIdentities	<string, UserAssignedIdentitiesValue>	Liste des identités utilisateur associées à la machine virtuelle. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».

VirtualMachineIpTag

Objet

Contient la balise IP associée à l’adresse IP publique.

Nom	Type	Description
ipTagType	string	Type d’étiquette IP. Exemple : FirstPartyUsage.
tag	string	Balise IP associée à l’adresse IP publique. Exemple : SQL, Stockage, etc.

VirtualMachineNetworkInterfaceConfiguration

Objet

Décrit les configurations d’interface réseau d’une machine virtuelle.

Nom	Type	Description
name	string	Nom de configuration de l’interface réseau.
properties.auxiliaryMode	NetworkInterfaceAuxiliaryMode	Spécifie si le mode auxiliaire est activé pour la ressource d’interface réseau.
properties.auxiliarySku	NetworkInterfaceAuxiliarySku	Spécifie si la référence SKU auxiliaire est activée pour la ressource d’interface réseau.
properties.deleteOption	DeleteOptions	Spécifier ce qui se passe à l’interface réseau lorsque la machine virtuelle est supprimée
properties.disableTcpStateTracking	boolean	Spécifie si l’interface réseau est désactivée pour le suivi de l’état tcp.
properties.dnsSettings	VirtualMachineNetworkInterfaceDnsSettingsConfiguration	Paramètres dns à appliquer sur les interfaces réseau.
properties.dscpConfiguration	SubResource
properties.enableAcceleratedNetworking	boolean	Spécifie si l’interface réseau est accélérée avec mise en réseau.
properties.enableFpga	boolean	Spécifie si l’interface réseau est compatible avec la mise en réseau FPGA.
properties.enableIPForwarding	boolean	Indique si le transfert IP est activé sur cette carte réseau.
properties.ipConfigurations	VirtualMachineNetworkInterfaceIPConfiguration[]	Spécifie les configurations IP de l’interface réseau.
properties.networkSecurityGroup	SubResource	Groupe de sécurité réseau.
properties.primary	boolean	Spécifie l’interface réseau principale si la machine virtuelle a plus de 1 interface réseau.
tags	object	Balises de ressource appliquées à l’adresse networkInterface créée par cette NetworkInterfaceConfiguration

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

Objet

Décrit les paramètres DNS d’une configuration réseau de machines virtuelles.

Nom	Type	Description
dnsServers	string[]	Liste des adresses IP des serveurs DNS

VirtualMachineNetworkInterfaceIPConfiguration

Objet

Décrit la configuration IP d’un profil réseau de machine virtuelle.

Nom	Type	Description
name	string	Nom de la configuration IP.
properties.applicationGatewayBackendAddressPools	SubResource[]	Spécifie un tableau de références aux pools d’adresses back-end des passerelles d’application. Une machine virtuelle peut référencer des pools d’adresses back-end de plusieurs passerelles d’application. Plusieurs machines virtuelles ne peuvent pas utiliser la même passerelle d’application.
properties.applicationSecurityGroups	SubResource[]	Spécifie un tableau de références au groupe de sécurité d’application.
properties.loadBalancerBackendAddressPools	SubResource[]	Spécifie un tableau de références aux pools d’adresses back-end d’équilibreurs de charge. Une machine virtuelle peut référencer des pools d’adresses back-end d’un équilibreur de charge public et interne. [Plusieurs machines virtuelles ne peuvent pas utiliser le même équilibreur de charge de référence SKU de base].
properties.primary	boolean	Spécifie l’interface réseau principale si la machine virtuelle a plus de 1 interface réseau.
properties.privateIPAddressVersion	IPVersions	Disponible à partir de Api-Version 2017-03-30, il indique si la configuration ip spécifique est IPv4 ou IPv6. La valeur par défaut est prise en tant que IPv4. Les valeurs possibles sont : « IPv4 » et « IPv6 ».
properties.publicIPAddressConfiguration	VirtualMachinePublicIPAddressConfiguration	PublicIPAddressConfiguration.
properties.subnet	SubResource	Spécifie l’identificateur du sous-réseau.

VirtualMachinePublicIPAddressConfiguration

Objet

Décrit la configuration PublicIPAddress d’une machine virtuelle

Nom	Type	Description
name	string	Nom de configuration de l’adresse PUBLICIP.
properties.deleteOption	DeleteOptions	Spécifiez ce qui se passe à l’adresse IP publique lorsque la machine virtuelle est supprimée
properties.dnsSettings	VirtualMachinePublicIPAddressDnsSettingsConfiguration	Paramètres dns à appliquer sur les adresses publicIP .
properties.idleTimeoutInMinutes	integer (int32)	Délai d’inactivité de l’adresse IP publique.
properties.ipTags	VirtualMachineIpTag[]	Liste des balises IP associées à l’adresse IP publique.
properties.publicIPAddressVersion	IPVersions	Disponible à partir de Api-Version 2019-07-01, il indique si la configuration ip spécifique est IPv4 ou IPv6. La valeur par défaut est prise en tant que IPv4. Les valeurs possibles sont : « IPv4 » et « IPv6 ».
properties.publicIPAllocationMethod	PublicIPAllocationMethod	Spécifier le type d’allocation d’adresses IP publiques
properties.publicIPPrefix	SubResource	PublicIPPrefix à partir duquel allouer des adresses publicIP.
sku	PublicIPAddressSku	Décrit la référence SKU IP publique. Il ne peut être défini qu’avec OrchestrationMode comme flexible.
tags	object	Balises de ressource appliquées à l’adresse publicIP créée par ce PublicIPAddressConfiguration

VirtualMachinePublicIPAddressDnsSettingsConfiguration

Objet

Décrit les paramètres DNS d’une configuration réseau de machines virtuelles.

Nom	Type	Description
domainNameLabel	string	Préfixe d’étiquette de nom de domaine des ressources PublicIPAddress qui seront créées. L’étiquette de nom générée est la concaténation de l’étiquette de nom de domaine et de l’ID unique du profil réseau de machine virtuelle.
domainNameLabelScope	DomainNameLabelScopeTypes	Étendue de l’étiquette de nom de domaine des ressources PublicIPAddress qui seront créées. L’étiquette de nom générée est la concaténation de l’étiquette de nom de domaine hachée avec une stratégie en fonction de l’étendue de l’étiquette de nom de domaine et de l’ID unique du profil réseau de machine virtuelle.

VirtualMachineScaleSetIPConfiguration

Objet

Décrit la configuration IP d’un groupe de machines virtuelles identiques.

Nom	Type	Description
name	string	Nom de la configuration IP.
properties.applicationGatewayBackendAddressPools	SubResource[]	Spécifie un tableau de références aux pools d’adresses back-end des passerelles d’application. Un groupe identique peut référencer des pools d’adresses back-end de plusieurs passerelles d’application. Plusieurs groupes identiques ne peuvent pas utiliser la même passerelle d’application.
properties.applicationSecurityGroups	SubResource[]	Spécifie un tableau de références au groupe de sécurité d’application.
properties.loadBalancerBackendAddressPools	SubResource[]	Spécifie un tableau de références aux pools d’adresses back-end d’équilibreurs de charge. Un groupe identique peut référencer des pools d’adresses back-end d’un équilibreur de charge public et interne. Plusieurs groupes identiques ne peuvent pas utiliser le même équilibreur de charge de référence SKU de base.
properties.loadBalancerInboundNatPools	SubResource[]	Spécifie un tableau de références aux pools Nat entrants des équilibreurs de charge. Un groupe identique peut référencer des pools nat entrants d’un équilibreur de charge public et interne. Plusieurs groupes identiques ne peuvent pas utiliser le même équilibreur de charge de référence SKU de base.
properties.primary	boolean	Spécifie l’interface réseau principale si la machine virtuelle a plus de 1 interface réseau.
properties.privateIPAddressVersion	IPVersion	Disponible à partir de Api-Version 2017-03-30, il indique si la configuration ip spécifique est IPv4 ou IPv6. La valeur par défaut est prise en tant que IPv4. Les valeurs possibles sont : « IPv4 » et « IPv6 ».
properties.publicIPAddressConfiguration	VirtualMachineScaleSetPublicIPAddressConfiguration	PublicIPAddressConfiguration.
properties.subnet	ApiEntityReference	Spécifie l’identificateur du sous-réseau.

VirtualMachineScaleSetIpTag

Objet

Contient la balise IP associée à l’adresse IP publique.

Nom	Type	Description
ipTagType	string	Type d’étiquette IP. Exemple : FirstPartyUsage.
tag	string	Balise IP associée à l’adresse IP publique. Exemple : SQL, Stockage, etc.

VirtualMachineScaleSetNetworkConfiguration

Objet

Décrit les configurations réseau d’un groupe de machines virtuelles identiques.

Nom	Type	Description
name	string	Nom de la configuration réseau.
properties.auxiliaryMode	NetworkInterfaceAuxiliaryMode	Spécifie si le mode auxiliaire est activé pour la ressource d’interface réseau.
properties.auxiliarySku	NetworkInterfaceAuxiliarySku	Spécifie si la référence SKU auxiliaire est activée pour la ressource d’interface réseau.
properties.deleteOption	DeleteOptions	Spécifier ce qui se passe à l’interface réseau lorsque la machine virtuelle est supprimée
properties.disableTcpStateTracking	boolean	Spécifie si l’interface réseau est désactivée pour le suivi de l’état tcp.
properties.dnsSettings	VirtualMachineScaleSetNetworkConfigurationDnsSettings	Paramètres dns à appliquer sur les interfaces réseau.
properties.enableAcceleratedNetworking	boolean	Spécifie si l’interface réseau est accélérée avec mise en réseau.
properties.enableFpga	boolean	Spécifie si l’interface réseau est compatible avec la mise en réseau FPGA.
properties.enableIPForwarding	boolean	Indique si le transfert IP est activé sur cette carte réseau.
properties.ipConfigurations	VirtualMachineScaleSetIPConfiguration[]	Spécifie les configurations IP de l’interface réseau.
properties.networkSecurityGroup	SubResource	Groupe de sécurité réseau.
properties.primary	boolean	Spécifie l’interface réseau principale si la machine virtuelle a plus de 1 interface réseau.
tags	object	Balises de ressource appliquées à l’adresse networkInterface créée par cette NetworkInterfaceConfiguration

VirtualMachineScaleSetNetworkConfigurationDnsSettings

Objet

Décrit les paramètres DNS d’une configuration réseau des groupes de machines virtuelles identiques.

Nom	Type	Description
dnsServers	string[]	Liste des adresses IP des serveurs DNS

VirtualMachineScaleSetPublicIPAddressConfiguration

Objet

Décrit la configuration PublicIPAddress d’un groupe de machines virtuelles identiques

Nom	Type	Description
name	string	Nom de configuration de l’adresse PUBLICIP.
properties.deleteOption	DeleteOptions	Spécifier ce qui arrive à l’adresse IP publique lorsque la machine virtuelle est supprimée
properties.dnsSettings	VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings	Paramètres dns à appliquer sur les adresses publicIP .
properties.idleTimeoutInMinutes	integer (int32)	Délai d’inactivité de l’adresse IP publique.
properties.ipTags	VirtualMachineScaleSetIpTag[]	Liste des balises IP associées à l’adresse IP publique.
properties.publicIPAddressVersion	IPVersion	Disponible à partir de Api-Version 2019-07-01, il indique si la configuration ip spécifique est IPv4 ou IPv6. La valeur par défaut est prise en tant que IPv4. Les valeurs possibles sont : « IPv4 » et « IPv6 ».
properties.publicIPPrefix	SubResource	PublicIPPrefix à partir duquel allouer des adresses publicIP.
sku	PublicIPAddressSku	Décrit la référence SKU IP publique. Il ne peut être défini qu’avec OrchestrationMode comme flexible.
tags	object	Balises de ressource appliquées à l’adresse publicIP créée par ce PublicIPAddressConfiguration

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

Objet

Décrit les paramètres DNS d’une configuration réseau des groupes de machines virtuelles identiques.

Nom	Type	Description
domainNameLabel	string	Étiquette du nom de domaine. La concaténation de l’étiquette de nom de domaine et de l’index de machine virtuelle sera les étiquettes de nom de domaine des ressources PublicIPAddress qui seront créées
domainNameLabelScope	DomainNameLabelScopeTypes	Étendue de l’étiquette du nom de domaine. La concaténation de l’étiquette de nom de domaine hachée générée en fonction de la stratégie à partir de l’étendue de l’étiquette de nom de domaine et de l’index de machine virtuelle sera les étiquettes de nom de domaine des ressources PublicIPAddress qui seront créées

VirtualMachineScaleSetVM

Objet

Décrit une machine virtuelle de groupe virtuel identique.

Nom	Type	Description
etag	string	Etag est une propriété renvoyée dans la réponse Update/Get de la VM VMSS, afin que le client puisse la fournir dans l’en-tête pour garantir des mises à jour optimistes.
id	string	ID de ressource complet pour la ressource. ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	VirtualMachineIdentity	Identité de la machine virtuelle, si elle est configurée.
instanceId	string	ID d’instance de machine virtuelle.
location	string	Emplacement géographique où réside la ressource
name	string	Nom de la ressource
plan	Plan	Spécifie des informations sur l’image de la Place de marché utilisée pour créer la machine virtuelle. Cet élément est utilisé uniquement pour les images de la Place de marché. Avant de pouvoir utiliser une image de la Place de marché à partir d’une API, vous devez activer l’image pour une utilisation programmatique. Dans le portail Azure, recherchez l’image de la Place de marché que vous souhaitez utiliser, puis cliquez sur Voulez déployer par programmation, Prise en main ->. Entrez les informations requises, puis cliquez sur Enregistrer.
properties.additionalCapabilities	AdditionalCapabilities	Spécifie des fonctionnalités supplémentaires activées ou désactivées sur la machine virtuelle dans le groupe identique. Par exemple : si la machine virtuelle a la possibilité de prendre en charge l’attachement de disques de données managés avec UltraSSD_LRS type de compte de stockage.
properties.availabilitySet	SubResource	Spécifie des informations sur le groupe à haute disponibilité auquel la machine virtuelle doit être affectée. Les machines virtuelles spécifiées dans le même groupe à haute disponibilité sont allouées à différents nœuds pour optimiser la disponibilité. Pour plus d’informations sur les groupes à haute disponibilité, consultez vue d’ensemble des groupes à haute disponibilité. Pour plus d’informations sur la maintenance planifiée Azure, consultez Maintenance et mises à jour des machines virtuelles dans Azure. Actuellement, une machine virtuelle ne peut être ajoutée qu’à un groupe à haute disponibilité au moment de la création. Impossible d’ajouter une machine virtuelle existante à un groupe à haute disponibilité.
properties.diagnosticsProfile	DiagnosticsProfile	Spécifie l’état des paramètres de diagnostic de démarrage. Version minimale de l’API : 2015-06-15.
properties.hardwareProfile	HardwareProfile	Spécifie les paramètres matériels de la machine virtuelle.
properties.instanceView	VirtualMachineScaleSetVMInstanceView	Vue de l’instance de machine virtuelle.
properties.latestModelApplied	boolean	Spécifie si le dernier modèle a été appliqué à la machine virtuelle.
properties.licenseType	string	Spécifie que l’image ou le disque utilisé a été concédé sous licence localement. Les valeurs possibles pour le système d’exploitation Windows Server sont les suivantes : Windows_Client Windows_Server Les valeurs possibles pour le système d’exploitation Linux Server sont les suivantes : RHEL_BYOS (pour RHEL) SLES_BYOS (pour SUSE) Pour plus d’informations, consultez Azure Hybrid Use Benefit pour Windows Server Azure Hybrid Use Benefit pour les Linux Server Version minimale de l’API : 2015-06-15
properties.modelDefinitionApplied	string	Spécifie si le modèle appliqué à la machine virtuelle est le modèle du groupe de machines virtuelles identiques ou le modèle personnalisé de la machine virtuelle.
properties.networkProfile	NetworkProfile	Spécifie les interfaces réseau de la machine virtuelle.
properties.networkProfileConfiguration	VirtualMachineScaleSetVMNetworkProfileConfiguration	Spécifie la configuration du profil réseau de la machine virtuelle.
properties.osProfile	OSProfile	Spécifie les paramètres du système d’exploitation de la machine virtuelle.
properties.protectionPolicy	VirtualMachineScaleSetVMProtectionPolicy	Spécifie la stratégie de protection de la machine virtuelle.
properties.provisioningState	string	État d’approvisionnement, qui apparaît uniquement dans la réponse.
properties.resilientVMDeletionStatus	ResilientVMDeletionStatus	Spécifie l’état de suppression de machine virtuelle résiliente pour la machine virtuelle.
properties.securityProfile	SecurityProfile	Spécifie les paramètres de profil associé à la sécurité pour la machine virtuelle.
properties.storageProfile	StorageProfile	Spécifie les paramètres de stockage des disques de machine virtuelle.
properties.timeCreated	string (date-time)	Spécifie l’heure à laquelle la ressource Machine virtuelle a été créée. Version minimale de l’API : 2021-11-01.
properties.userData	string	UserData pour la machine virtuelle, qui doit être encodée en base 64. Le client ne doit pas transmettre de secrets ici. Version minimale de l’API : 2021-03-01
properties.vmId	string	ID unique de machine virtuelle Azure.
resources	VirtualMachineExtension[]	Ressources d’extension enfant de machine virtuelle.
sku	Sku	Référence SKU de la machine virtuelle.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »
zones	string[]	Zones de machine virtuelle.

VirtualMachineScaleSetVMInstanceView

Objet

Vue d’instance d’une machine virtuelle de groupe de machines virtuelles identiques.

Nom	Type	Description
assignedHost	string	ID de ressource de l’hôte dédié, sur lequel la machine virtuelle est allouée par le biais du placement automatique, lorsque la machine virtuelle est associée à un groupe d’hôtes dédié pour lequel le placement automatique est activé. Version minimale de l’API : 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	Diagnostics de démarrage est une fonctionnalité de débogage qui vous permet d’afficher la sortie de la console et la capture d’écran pour diagnostiquer l’état de la machine virtuelle. Vous pouvez facilement afficher la sortie de votre journal de console. Azure vous permet également de voir une capture d’écran de la machine virtuelle à partir de l’hyperviseur.
computerName	string	Spécifie le nom du système d’exploitation hôte de la machine virtuelle. Ce nom ne peut pas être mis à jour une fois la machine virtuelle créée. Longueur maximale (Windows) : 15 caractères longueur maximale (Linux) : 64 caractères. Pour connaître les conventions et restrictions d’affectation de noms, consultez instructions d’implémentation des services d’infrastructure Azure.
disks	DiskInstanceView[]	Informations sur les disques.
extensions	VirtualMachineExtensionInstanceView[]	Les informations sur les extensions.
hyperVGeneration	HyperVGeneration	Génération d’hyperviseur de la machine virtuelle [V1, V2]
maintenanceRedeployStatus	MaintenanceRedeployStatus	L’état de l’opération de maintenance sur la machine virtuelle.
osName	string	Système d’exploitation s’exécutant sur la machine hybride.
osVersion	string	Version du système d’exploitation s’exécutant sur la machine hybride.
placementGroupId	string	Groupe de placement dans lequel la machine virtuelle s’exécute. Si la machine virtuelle est désallouée, elle n’aura pas de placementGroupId.
platformFaultDomain	integer (int32)	Le nombre de domaines d’erreur.
platformUpdateDomain	integer (int32)	Le nombre de domaines de mise à jour.
rdpThumbPrint	string	Empreinte numérique du certificat Bureau à distance.
statuses	InstanceViewStatus[]	Informations d’état de la ressource.
vmAgent	VirtualMachineAgentInstanceView	L’agent VM s’exécutant sur la machine virtuelle.
vmHealth	VirtualMachineHealthStatus	L’état d’intégrité de la machine virtuelle.

VirtualMachineScaleSetVMNetworkProfileConfiguration

Objet

Décrit le profil réseau d’une machine virtuelle de groupe de machines virtuelles identiques.

Nom	Type	Description
networkInterfaceConfigurations	VirtualMachineScaleSetNetworkConfiguration[]	Liste des configurations réseau.

VirtualMachineScaleSetVMProtectionPolicy

Objet

Stratégie de protection d’une machine virtuelle de machine virtuelle identique.

Nom	Type	Description
protectFromScaleIn	boolean	Indique que la machine virtuelle du groupe de machines virtuelles identiques ne doit pas être prise en compte pour la suppression pendant une opération de mise à l’échelle.
protectFromScaleSetActions	boolean	Indique que les mises à jour ou actions de modèle (y compris la mise à l’échelle) lancées sur le groupe de machines virtuelles identiques ne doivent pas être appliquées à la machine virtuelle du groupe de machines virtuelles identiques.

VirtualMachineSizeTypes

Énumération

Spécifie la taille de la machine virtuelle. Le type de données enum est actuellement déconseillé et sera supprimé d’ici le 23 décembre 2023. La méthode recommandée pour obtenir la liste des tailles disponibles consiste à utiliser ces API : Répertorier toutes les tailles de machine virtuelle disponibles dans un groupe à haute disponibilité, Répertorier toutes les tailles de machine virtuelle disponibles dans une région, Répertorier toutes les tailles de machine virtuelle disponibles pour redimensionner. Pour plus d’informations sur les tailles de machine virtuelle, consultez Tailles des machines virtuelles. Les tailles de machine virtuelle disponibles dépendent de la région et du groupe à haute disponibilité.

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

VMDiskSecurityProfile

Objet

Spécifie les paramètres du profil de sécurité pour le disque managé. Remarque : Il ne peut être défini que pour les machines virtuelles confidentielles.

Nom	Type	Description
diskEncryptionSet	DiskEncryptionSetParameters	Spécifie l’ID de ressource du jeu de chiffrement de disque managé du client pour le disque managé utilisé pour le disque de système d’exploitation ConfidentielVM chiffré par clé gérée par le client et l’objet blob VMGuest.
securityEncryptionType	SecurityEncryptionTypes	Spécifie le EncryptionType du disque managé. Il est défini sur DiskWithVMGuestState pour le chiffrement du disque managé avec l’objet blob VMGuestState, VMGuestStateOnly pour le chiffrement de l’objet blob VMGuestState et nonPersistedTPM pour ne pas conserver l’état du microprogramme dans l’objet blob VMGuestState.. Remarque : Il peut être défini uniquement pour les machines virtuelles confidentielles.

VMSizeProperties

Objet

Spécifie les paramètres de propriété taille de machine virtuelle sur la machine virtuelle.

Nom	Type	Description
vCPUsAvailable	integer (int32)	Spécifie le nombre de processeurs virtuels disponibles pour la machine virtuelle. Lorsque cette propriété n’est pas spécifiée dans le corps de la requête, le comportement par défaut consiste à le définir sur la valeur des processeurs virtuels disponibles pour cette taille de machine virtuelle exposée dans la réponse d’API de Répertorier toutes les tailles de machine virtuelle disponibles dans une région.
vCPUsPerCore	integer (int32)	Spécifie le ratio de cœurs virtuels en cœurs physiques. Lorsque cette propriété n’est pas spécifiée dans le corps de la requête, le comportement par défaut est défini sur la valeur de vCPUsPerCore pour la taille de machine virtuelle exposée dans la réponse d’API de Répertorier toutes les tailles de machine virtuelle disponibles dans une région. Définir cette propriété sur 1 signifie également que l’hyperthreading est désactivé.

WindowsConfiguration

Objet

Spécifie les paramètres du système d’exploitation Windows sur la machine virtuelle.

Nom	Type	Description
additionalUnattendContent	AdditionalUnattendContent[]	Spécifie des informations au format XML encodées en base 64 supplémentaires qui peuvent être incluses dans le fichier Unattend.xml, qui est utilisé par le programme d’installation de Windows.
enableAutomaticUpdates	boolean	Indique si les mises à jour automatiques sont activées pour la machine virtuelle Windows. La valeur par défaut est true. Pour les groupes de machines virtuelles identiques, cette propriété peut être mise à jour et les mises à jour prennent effet sur la reprovisionnement du système d’exploitation.
enableVMAgentPlatformUpdates	boolean	Indique si les mises à jour de la plate-forme VMAgent sont activées pour la machine virtuelle Windows.
patchSettings	PatchSettings	[Fonctionnalité en préversion] Spécifie les paramètres liés à la mise à jour corrective de l’invité de machine virtuelle sur Windows.
provisionVMAgent	boolean	Indique si l’agent de machine virtuelle doit être approvisionné sur la machine virtuelle. Lorsque cette propriété n’est pas spécifiée dans le corps de la requête, elle a la valeur true par défaut. Cela garantit que l’agent de machine virtuelle est installé sur la machine virtuelle afin que les extensions puissent être ajoutées ultérieurement à la machine virtuelle.
timeZone	string	Spécifie le fuseau horaire de la machine virtuelle. par exemple « Heure standard du Pacifique ». Les valeurs possibles peuvent être TimeZoneInfo.Id valeur des fuseaux horaires retournés par TimeZoneInfo.GetSystemTimeZones.
winRM	WinRMConfiguration	Spécifie les écouteurs de gestion à distance Windows. Cela active Windows PowerShell à distance.

WindowsPatchAssessmentMode

Énumération

Valeur	Description
ImageDefault
AutomaticByPlatform

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Énumération

Spécifie le paramètre de redémarrage pour toutes les opérations d’installation des correctifs AutomaticByPlatform.

Valeur	Description
Unknown
IfRequired
Never
Always

WindowsVMGuestPatchAutomaticByPlatformSettings

Objet

Spécifie des paramètres supplémentaires à appliquer lorsque le mode correctif AutomatiqueByPlatform est sélectionné dans les paramètres de correctif Windows.

Nom	Type	Description
bypassPlatformSafetyChecksOnUserSchedule	boolean	Permet au client de planifier la mise à jour corrective sans mises à niveau accidentelles
rebootSetting	WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Spécifie le paramètre de redémarrage pour toutes les opérations d’installation des correctifs AutomaticByPlatform.

WindowsVMGuestPatchMode

Énumération

Spécifie le mode de mise à jour corrective d’invité de machine virtuelle sur une machine virtuelle IaaS ou des machines virtuelles associées au groupe de machines virtuelles identiques avec OrchestrationMode en tant que flexible.

Les valeurs possibles sont les suivantes :

manuel : vous contrôlez l’application de correctifs sur une machine virtuelle. Pour ce faire, appliquez manuellement des correctifs à l’intérieur de la machine virtuelle. Dans ce mode, les mises à jour automatiques sont désactivées ; la propriété WindowsConfiguration.enableAutomaticUpdates doit être false

AutomaticByOS : la machine virtuelle est automatiquement mise à jour par le système d’exploitation. La propriété WindowsConfiguration.enableAutomaticUpdates doit être vraie.

AutomaticByPlatform : la machine virtuelle est automatiquement mise à jour par la plateforme. Les propriétés provisionVMAgent et WindowsConfiguration.enableAutomaticUpdates doivent être vraies

Valeur	Description
Manual
AutomaticByOS
AutomaticByPlatform

WinRMConfiguration

Objet

Décrit la configuration de la gestion à distance windows de la machine virtuelle

Nom	Type	Description
listeners	WinRMListener[]	Liste des écouteurs de gestion à distance Windows

WinRMListener

Objet

Décrit le protocole et l’empreinte numérique de l’écouteur de gestion à distance Windows

Nom	Type	Description
certificateUrl	string	Il s’agit de l’URL d’un certificat qui a été chargé dans Key Vault en tant que secret. Pour ajouter un secret au coffre de clés, consultez Ajouter une clé ou un secret au coffre de clés. Dans ce cas, votre certificat doit être l’encodage Base64 de l’objet JSON suivant, qui est encodé en UTF-8 : { « data » : »<certificat codé en base64>« , « dataType » :"pfx », « password » : »<pfx-file-password>» } Pour installer des certificats sur une machine virtuelle, il est recommandé d’utiliser l’extension de machine virtuelle Azure Key Vault pour Linux ou l’extension de machine virtuelle Azure Key Vault pour Windows.
protocol	ProtocolTypes	Spécifie le protocole de l’écouteur WinRM. Les valeurs possibles sont les suivantes : http,https.

Partager via

Virtual Machine Scale Set VMs - Get

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

Get VM scale set VM with ResiliencyView

Exemple de requête

Exemple de réponse

Get VM scale set VM with UserData

Exemple de requête

Exemple de réponse

Get VM scale set VM with VMSizeProperties

Exemple de requête

Exemple de réponse

Définitions

AdditionalCapabilities

AdditionalUnattendContent

ApiEntityReference

ApiError

ApiErrorBase

BootDiagnostics

BootDiagnosticsInstanceView

CachingTypes

CloudError

ComponentNames

createdByType

DataDisk

DeleteOptions

DiagnosticsProfile

DiffDiskOptions

DiffDiskPlacement

DiffDiskSettings

DiskControllerTypes

DiskCreateOptionTypes

DiskDeleteOptionTypes

DiskDetachOptionTypes

DiskEncryptionSetParameters

DiskEncryptionSettings

DiskInstanceView

DomainNameLabelScopeTypes

EncryptionIdentity

HardwareProfile

HostEndpointSettings

HyperVGeneration

ImageReference

InnerError

InstanceViewStatus

InstanceViewTypes

IPVersion

IPVersions

KeyVaultKeyReference

KeyVaultSecretReference

LinuxConfiguration

LinuxPatchAssessmentMode

LinuxPatchSettings

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

LinuxVMGuestPatchAutomaticByPlatformSettings

LinuxVMGuestPatchMode

MaintenanceOperationResultCodeTypes

MaintenanceRedeployStatus

ManagedDiskParameters

Mode

Modes

NetworkApiVersion

NetworkInterfaceAuxiliaryMode

NetworkInterfaceAuxiliarySku

NetworkInterfaceReference

NetworkProfile

OperatingSystemTypes

OSDisk

OSProfile

PassNames

PatchSettings

Plan

ProtocolTypes

ProxyAgentSettings

PublicIPAddressSku