Virtual Machine Scale Set VMs - Get

Servicio:

Compute

Versión de la API:

2024-07-01

Obtiene una máquina virtual de un conjunto de escalado de máquinas virtuales.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
instanceId	path	True	string	Identificador de instancia de la máquina virtual.
resourceGroupName	path	True	string	Nombre del grupo de recursos.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
vmScaleSetName	path	True	string	Nombre del conjunto de escalado de máquinas virtuales.
api-version	query	True	string	Versión de api de cliente.
$expand	query		InstanceViewTypes	Expresión expand que se va a aplicar en la operación. "InstanceView" recuperará la vista de instancia de la máquina virtual. "UserData" recuperará userData de la máquina virtual.

Respuestas

Nombre	Tipo	Description
200 OK	VirtualMachineScaleSetVM	De acuerdo
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Get VM scale set VM with UserData

Get VM scale set VM with VMSizeProperties

Get VM scale set VM with UserData

Solicitud de ejemplo

HTTP

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

Java

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

Python

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/2024-07-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

Go

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/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

JavaScript

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

/**
 * 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/2024-07-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

dotnet

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/2024-07-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

Respuesta de muestra

status code:

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

Solicitud de ejemplo

HTTP

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

Java

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

Python

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/2024-07-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

Go

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/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

JavaScript

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

/**
 * 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/2024-07-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

dotnet

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/2024-07-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

Respuesta de muestra

status code:

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": {}
      }
    }
  ]
}

Definiciones

Nombre	Description
AdditionalCapabilities	Especifica funcionalidades adicionales habilitadas o deshabilitadas en la máquina virtual del conjunto de escalado. Por ejemplo: si la máquina virtual tiene la capacidad de admitir la conexión de discos de datos administrados con UltraSSD_LRS tipo de cuenta de almacenamiento.
AdditionalUnattendContent	Especifica información con formato XML codificado en base 64 adicional que se puede incluir en el archivo Unattend.xml, que usa el programa de instalación de Windows.
ApiEntityReference	Identificador del recurso de origen. Puede ser una instantánea o un punto de restauración de disco desde el que crear un disco.
ApiError	Error de API.
ApiErrorBase	Base de errores de api.
BootDiagnostics	El diagnóstico de arranque es una característica de depuración que permite ver la salida de la consola y la captura de pantalla para diagnosticar el estado de la máquina virtual. NOTA: si se especifica storageUri, asegúrese de que la cuenta de almacenamiento esté en la misma región y suscripción que la máquina virtual. Puede ver fácilmente la salida del registro de consola. Azure también le permite ver una captura de pantalla de la máquina virtual desde el hipervisor.
BootDiagnosticsInstanceView	El diagnóstico de arranque es una característica de depuración que permite ver la salida de la consola y la captura de pantalla para diagnosticar el estado de la máquina virtual. Puede ver fácilmente la salida del registro de consola. Azure también le permite ver una captura de pantalla de la máquina virtual desde el hipervisor.
CachingTypes	Especifica los requisitos de almacenamiento en caché. Los valores posibles son: None,ReadOnly,ReadWrite. El comportamiento predeterminado es: Ninguno para el almacenamiento estándar. ReadOnly para Premium Storage.
CloudError	Respuesta de error del servicio Compute.
ComponentNames	Nombre del componente. Actualmente, el único valor permitido es Microsoft-Windows-Shell-Setup.
DataDisk	Especifica los parámetros que se usan para agregar un disco de datos a una máquina virtual. Para más información sobre los discos, consulte Acerca de discos y discos duros virtuales para máquinas virtuales de Azure.
DeleteOptions	Especificación de lo que sucede con la interfaz de red cuando se elimina la máquina virtual
DiagnosticsProfile	Especifica el estado de configuración de diagnóstico de arranque. Versión mínima de api: 2015-06-15.
DiffDiskOptions	Especifica la configuración del disco efímero para el disco del sistema operativo.
DiffDiskPlacement	Especifica la ubicación del disco efímero para el disco del sistema operativo. Los valores posibles son: CacheDisk,ResourceDisk,NvmeDisk. El comportamiento predeterminado es: CacheDisk si se configura uno para el tamaño de la máquina virtual en caso contrario, se usa resourceDisk o nvmeDisk. Consulte la documentación sobre el tamaño de la máquina virtual Windows en https://docs.microsoft.com/azure/virtual-machines/windows/sizes y máquina virtual Linux en https://docs.microsoft.com/azure/virtual-machines/linux/sizes para comprobar qué tamaños de máquina virtual expone un disco de caché. Versión mínima de api para NvmeDisk: 2024-03-01.
DiffDiskSettings	Especifica la configuración de disco efímero para el disco del sistema operativo utilizado por la máquina virtual.
DiskControllerTypes	Especifica el tipo de controlador de disco configurado para la máquina virtual. Nota: Esta propiedad se establecerá en el tipo de controlador de disco predeterminado si no se especifica que se cree una máquina virtual con "hyperVGeneration" establecido en V2 en función de las funcionalidades del disco del sistema operativo y el tamaño de máquina virtual de la versión mínima de api especificada. Debe desasignar la máquina virtual antes de actualizar su tipo de controlador de disco a menos que actualice el tamaño de la máquina virtual en la configuración de la máquina virtual que desasigna implícitamente y reasigna la máquina virtual. Versión mínima de api: 2022-08-01.
DiskCreateOptionTypes	Especifica cómo se debe crear el disco de máquina virtual. Los valores posibles son Adjuntar: Este valor se usa cuando se usa un disco especializado para crear la máquina virtual. FromImage: Este valor se usa cuando se usa una imagen para crear la máquina virtual. Si usa una imagen de plataforma, también debe usar el elemento imageReference descrito anteriormente. Si usa una imagen de Marketplace, también debe usar el elemento plan descrito anteriormente.
DiskDeleteOptionTypes	Especifica si el disco del sistema operativo se debe eliminar o desasociar tras la eliminación de la máquina virtual. Los valores posibles son: Delete. Si se usa este valor, el disco del sistema operativo se elimina cuando se elimina la máquina virtual. Separar. Si se usa este valor, el disco del sistema operativo se conserva después de eliminar la máquina virtual. El valor predeterminado se establece en Desasociar. Para un disco de sistema operativo efímero, el valor predeterminado se establece en Eliminar. El usuario no puede cambiar la opción de eliminación de un disco de sistema operativo efímero.
DiskDetachOptionTypes	Especifica el comportamiento de desasociación que se va a usar al desasociar un disco o que ya está en proceso de desasociación de la máquina virtual. Valores admitidos: ForceDetach. detachOption: ForceDetach solo se aplica a discos de datos administrados. Si un intento anterior de desasociación del disco de datos no se completó debido a un error inesperado de la máquina virtual y el disco todavía no se libera, use la opción forzar la desasociación como última opción de recurso para separar el disco forzadamente de la máquina virtual. Es posible que todas las escrituras no se hayan vaciado al usar este comportamiento de desasociación. Para forzar la desasociación de una actualización del disco de datos aBeDetached a "true" junto con la configuración de detachOption: "ForceDetach".
DiskEncryptionSetParameters	Especifica el identificador de recurso del conjunto de cifrado de disco administrado del cliente para el disco administrado.
DiskEncryptionSettings	Especifica la configuración de cifrado del disco del sistema operativo. Versión mínima de api: 2015-06-15
DiskInstanceView	La información de los discos.
DomainNameLabelScopeTypes	Ámbito de la etiqueta Nombre de dominio de los recursos de PublicIPAddress que se crearán. La etiqueta de nombre generada es la concatenación de la etiqueta de nombre de dominio hash con directiva según el ámbito de la etiqueta de nombre de dominio y el identificador único del perfil de red de máquina virtual.
EncryptionIdentity	Especifica la identidad administrada usada por ADE para obtener el token de acceso para las operaciones de keyvault.
HardwareProfile	Especifica la configuración de hardware de la máquina virtual.
HyperVGeneration	Generación del hipervisor de la máquina virtual [V1, V2]
ImageReference	Especifica información sobre la imagen que se va a usar. Puede especificar información sobre imágenes de plataforma, imágenes de Marketplace o imágenes de máquina virtual. Este elemento es necesario cuando desea usar una imagen de plataforma, una imagen de Marketplace o una imagen de máquina virtual, pero no se usa en otras operaciones de creación.
InnerError	Detalles del error interno.
InstanceViewStatus	Estado de la vista de instancia.
InstanceViewTypes	Expresión expand que se va a aplicar en la operación. "InstanceView" recuperará la vista de instancia de la máquina virtual. "UserData" recuperará userData de la máquina virtual.
IPVersion	Disponible desde Api-Version 2019-07-01 y versiones posteriores, representa si la ipconfiguration específica es IPv4 o IPv6. El valor predeterminado se toma como IPv4. Los valores posibles son: "IPv4" e "IPv6".
IPVersions	Disponible desde Api-Version 2019-07-01 y versiones posteriores, representa si la ipconfiguration específica es IPv4 o IPv6. El valor predeterminado se toma como IPv4. Los valores posibles son: "IPv4" e "IPv6".
KeyVaultKeyReference	Especifica la ubicación de la clave de cifrado de claves en Key Vault.
KeyVaultSecretReference	Configuración protegida de extensiones que se pasan por referencia y que se consumen desde el almacén de claves.
LinuxConfiguration	Especifica la configuración del sistema operativo Linux en la máquina virtual. Para obtener una lista de las distribuciones de Linux admitidas, consulte Linux on Azure-Endorsed Distributions.
LinuxPatchAssessmentMode	Especifica el modo de evaluación de revisiones de invitado de máquina virtual para la máquina virtual IaaS. Los valores posibles son: ImageDefault: controla el tiempo de las evaluaciones de revisiones en una máquina virtual. AutomaticByPlatform: la plataforma desencadenará evaluaciones periódicas de revisiones. La propiedad provisionVMAgent debe ser true.
LinuxPatchSettings	[Característica de vista previa] Especifica la configuración relacionada con la aplicación de revisiones de invitado de máquina virtual en Linux.
LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Especifica la configuración de reinicio para todas las operaciones de instalación de revisiones AutomaticByPlatform.
LinuxVMGuestPatchAutomaticByPlatformSettings	Especifica la configuración adicional para el modo de revisión AutomaticByPlatform en la aplicación de revisiones de invitado de máquina virtual en Linux.
LinuxVMGuestPatchMode	Especifica el modo de aplicación de revisiones de invitado de máquina virtual a máquinas virtuales iaaS o máquinas virtuales asociadas al conjunto de escalado de máquinas virtuales con OrchestrationMode como flexible. Los valores posibles son: imageDefault: se usa la configuración de aplicación de revisiones predeterminada de la máquina virtual. AutomaticByPlatform: la plataforma actualizará automáticamente la máquina virtual. La propiedad provisionVMAgent debe ser true
MaintenanceOperationResultCodeTypes	Código de resultado de la última operación de mantenimiento.
MaintenanceRedeployStatus	Estado de la operación de mantenimiento en la máquina virtual.
ManagedDiskParameters	Parámetros de disco administrado.
Mode	Especifica el modo en el que se ejecutará ProxyAgent si la característica está habilitada. ProxyAgent comenzará a auditar o supervisar, pero no aplicará el control de acceso sobre las solicitudes a los puntos de conexión host en modo auditoría, mientras que en el modo Aplicar aplicará el control de acceso. El valor predeterminado es Aplicar modo.
NetworkApiVersion	especifica la versión de la API de Microsoft.Network que se usa al crear recursos de red en las configuraciones de interfaz de red.
NetworkInterfaceAuxiliaryMode	Especifica si el modo auxiliar está habilitado para el recurso interfaz de red.
NetworkInterfaceAuxiliarySku	Especifica si la SKU auxiliar está habilitada para el recurso interfaz de red.
NetworkInterfaceReference	Especifica la lista de identificadores de recursos para las interfaces de red asociadas a la máquina virtual.
NetworkProfile	Especifica las interfaces de red de la máquina virtual.
OperatingSystemTypes	Tipo de sistema operativo.
OSDisk	Especifica información sobre el disco del sistema operativo utilizado por la máquina virtual. Para más información sobre los discos, consulte Acerca de discos y discos duros virtuales para máquinas virtuales de Azure.
OSProfile	Especifica la configuración del sistema operativo para la máquina virtual.
PassNames	Nombre del pase. Actualmente, el único valor permitido es OobeSystem.
PatchSettings	[Característica de vista previa] Especifica la configuración relacionada con la aplicación de revisiones de invitado de máquina virtual en Windows.
Plan	Especifica información sobre la imagen de Marketplace que se usa para crear la máquina virtual. Este elemento solo se usa para imágenes de Marketplace. Para poder usar una imagen de Marketplace desde una API, debe habilitar la imagen para su uso mediante programación. En Azure Portal, busque la imagen de Marketplace que desea usar y, a continuación, haga clic en Desea implementar mediante programación, Introducción a>. Escriba cualquier información necesaria y haga clic en Guardar.
ProtocolTypes	Especifica el protocolo del agente de escucha winRM. Los valores posibles son: http,https.
ProxyAgentSettings	Especifica la configuración de ProxyAgent al crear la máquina virtual. Versión mínima de api: 2023-09-01.
PublicIPAddressSku	Describe la SKU de dirección IP pública. Solo se puede establecer con OrchestrationMode como flexible.
PublicIPAddressSkuName	Especificación del nombre de SKU de ip pública
PublicIPAddressSkuTier	Especificación del nivel de SKU de IP pública
PublicIPAllocationMethod	Especificar el tipo de asignación de IP pública
ResourceIdentityType	Tipo de identidad que se usa para la máquina virtual. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades de la máquina virtual.
securityEncryptionTypes	Especifica encryptionType del disco administrado. Se establece en DiskWithVMGuestState para el cifrado del disco administrado junto con el blob VMGuestState, VMGuestStateOnly para el cifrado de solo el blob VMGuestState y NonPersistedTPM para no conservar el estado de firmware en el blob VMGuestState. Nota: Solo se puede establecer para máquinas virtuales confidenciales.
SecurityProfile	Especifica la configuración del perfil relacionado con la seguridad de la máquina virtual.
SecurityTypes	Especifica securityType de la máquina virtual. Debe establecerse en cualquier valor especificado para habilitar UefiSettings. El comportamiento predeterminado es: UefiSettings no se habilitará a menos que se establezca esta propiedad.
SettingNames	Especifica el nombre de la configuración a la que se aplica el contenido. Los valores posibles son: FirstLogonCommands y AutoLogon.
Sku	SKU de máquina virtual.
SshConfiguration	Especifica la configuración de clave ssh para un sistema operativo Linux.
SshPublicKey	Lista de claves públicas SSH que se usan para autenticarse con máquinas virtuales basadas en Linux.
StatusLevelTypes	Código de nivel.
StorageAccountTypes	Especifica el tipo de cuenta de almacenamiento para el disco administrado. NOTA: UltraSSD_LRS solo se puede usar con discos de datos, no se puede usar con disco del sistema operativo.
StorageProfile	Especifica la configuración de almacenamiento de los discos de máquina virtual.
SubResource	Dirección URL relativa del almacén de claves que contiene el secreto.
UefiSettings	Especifica la configuración de seguridad, como el arranque seguro y vTPM que se usa al crear la máquina virtual. Versión mínima de api: 2020-12-01.
UserAssignedIdentities	Lista de identidades de usuario asociadas a la máquina virtual. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
VaultCertificate	Lista de referencias del almacén de claves en SourceVault que contienen certificados.
VaultSecretGroup	Especifica el conjunto de certificados que se deben instalar en la máquina virtual. Para instalar certificados en una máquina virtual, se recomienda usar la extensión de máquina virtual de Azure Key Vault de para Linux o la extensión de máquina virtual de Azure Key Vault de para Windows.
VirtualHardDisk	Disco duro virtual.
VirtualMachineAgentInstanceView	Agente de máquina virtual que se ejecuta en la máquina virtual.
VirtualMachineExtension	Recursos de extensión secundaria de máquina virtual.
VirtualMachineExtensionHandlerInstanceView	Vista de instancia del controlador de extensión de máquina virtual.
VirtualMachineExtensionInstanceView	Vista de instancia de extensión de máquina virtual.
VirtualMachineHealthStatus	Estado de mantenimiento de la máquina virtual.
VirtualMachineIdentity	Identidad de la máquina virtual, si está configurada.
VirtualMachineIpTag	Lista de etiquetas IP asociadas a la dirección IP pública.
VirtualMachineNetworkInterfaceConfiguration	Especifica las configuraciones de red que se usarán para crear los recursos de red de la máquina virtual.
VirtualMachineNetworkInterfaceDnsSettingsConfiguration	Configuración dns que se va a aplicar en las interfaces de red.
VirtualMachineNetworkInterfaceIPConfiguration	Especifica las configuraciones IP de la interfaz de red.
VirtualMachinePublicIPAddressConfiguration	PublicIPAddressConfiguration.
VirtualMachinePublicIPAddressDnsSettingsConfiguration	Configuración dns que se va a aplicar en las direcciones publicIP.
VirtualMachineScaleSetIPConfiguration	Especifica las configuraciones IP de la interfaz de red.
VirtualMachineScaleSetIpTag	Lista de etiquetas IP asociadas a la dirección IP pública.
VirtualMachineScaleSetNetworkConfiguration	Lista de configuraciones de red.
VirtualMachineScaleSetNetworkConfigurationDnsSettings	Configuración dns que se va a aplicar en las interfaces de red.
VirtualMachineScaleSetPublicIPAddressConfiguration	PublicIPAddressConfiguration.
VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings	Configuración dns que se va a aplicar en las direcciones publicIP.
VirtualMachineScaleSetVM	Describe una máquina virtual del conjunto de escalado de máquinas virtuales.
VirtualMachineScaleSetVMInstanceView	Vista de instancia de máquina virtual.
VirtualMachineScaleSetVMNetworkProfileConfiguration	Especifica la configuración del perfil de red de la máquina virtual.
VirtualMachineScaleSetVMProtectionPolicy	Especifica la directiva de protección de la máquina virtual.
VirtualMachineSizeTypes	Especifica el tamaño de la máquina virtual. El tipo de datos de enumeración está actualmente en desuso y se quitará el 23 de diciembre de 2023. La manera recomendada de obtener la lista de tamaños disponibles es usar estas API: Enumerar todos los tamaños de máquina virtual disponibles en un conjunto de disponibilidad, Enumerar todos los tamaños de máquina virtual disponibles en una región, Enumerar todos los tamaños de máquina virtual disponibles para cambiar el tamaño. Para obtener más información sobre los tamaños de máquina virtual, consulte tamaños de para máquinas virtuales. Los tamaños de máquina virtual disponibles dependen de la región y el conjunto de disponibilidad.
VMDiskSecurityProfile	Especifica el perfil de seguridad del disco administrado.
VMSizeProperties	Especifica las propiedades para personalizar el tamaño de la máquina virtual. Versión mínima de api: 2021-07-01. Esta característica sigue en modo de vista previa y no se admite para VirtualMachineScaleSet. Siga las instrucciones de personalización de máquina virtual para obtener más información.
WindowsConfiguration	Especifica la configuración del sistema operativo Windows en la máquina virtual.
WindowsPatchAssessmentMode	Especifica el modo de evaluación de revisiones de invitado de máquina virtual para la máquina virtual IaaS. Los valores posibles son: ImageDefault: controla el tiempo de las evaluaciones de revisiones en una máquina virtual. AutomaticByPlatform: la plataforma desencadenará evaluaciones periódicas de revisiones. La propiedad provisionVMAgent debe ser true.
WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Especifica la configuración de reinicio para todas las operaciones de instalación de revisiones AutomaticByPlatform.
WindowsVMGuestPatchAutomaticByPlatformSettings	Especifica la configuración adicional para el modo de revisión AutomaticByPlatform en la aplicación de revisiones de invitado de máquina virtual en Windows.
WindowsVMGuestPatchMode	Especifica el modo de aplicación de revisiones de invitado de máquina virtual a máquinas virtuales iaaS o máquinas virtuales asociadas al conjunto de escalado de máquinas virtuales con OrchestrationMode como flexible. Los valores posibles son: Manual: controla la aplicación de revisiones en una máquina virtual. Para ello, aplique revisiones manualmente dentro de la máquina virtual. En este modo, las actualizaciones automáticas están deshabilitadas; La propiedad WindowsConfiguration.enableAutomaticUpdates debe ser false AutomaticByOS: el sistema operativo actualizará automáticamente la máquina virtual. La propiedad WindowsConfiguration.enableAutomaticUpdates debe ser true. AutomaticByPlatform: la máquina virtual actualizará automáticamente la plataforma. Las propiedades provisionVMAgent y WindowsConfiguration.enableAutomaticUpdates deben ser true.
WinRMConfiguration	Especifica los agentes de escucha de administración remota de Windows. Esto habilita Windows PowerShell remoto.
WinRMListener	Lista de agentes de escucha de administración remota de Windows

AdditionalCapabilities

Especifica funcionalidades adicionales habilitadas o deshabilitadas en la máquina virtual del conjunto de escalado. Por ejemplo: si la máquina virtual tiene la capacidad de admitir la conexión de discos de datos administrados con UltraSSD_LRS tipo de cuenta de almacenamiento.

Nombre	Tipo	Description
hibernationEnabled	boolean	Marca que habilita o deshabilita la funcionalidad de hibernación en la máquina virtual.
ultraSSDEnabled	boolean	Marca que habilita o deshabilita una capacidad para tener uno o varios discos de datos administrados con UltraSSD_LRS tipo de cuenta de almacenamiento en la máquina virtual o VMSS. Los discos administrados con el tipo de cuenta de almacenamiento UltraSSD_LRS se pueden agregar a una máquina virtual o a un conjunto de escalado de máquinas virtuales solo si esta propiedad está habilitada.

AdditionalUnattendContent

Especifica información con formato XML codificado en base 64 adicional que se puede incluir en el archivo Unattend.xml, que usa el programa de instalación de Windows.

Nombre	Tipo	Description
componentName	ComponentNames	Nombre del componente. Actualmente, el único valor permitido es Microsoft-Windows-Shell-Setup.
content	string	Especifica el contenido con formato XML que se agrega al archivo unattend.xml para la ruta de acceso y el componente especificados. El XML debe ser inferior a 4 KB y debe incluir el elemento raíz para la configuración o característica que se está insertando.
passName	PassNames	Nombre del pase. Actualmente, el único valor permitido es OobeSystem.
settingName	SettingNames	Especifica el nombre de la configuración a la que se aplica el contenido. Los valores posibles son: FirstLogonCommands y AutoLogon.

ApiEntityReference

Identificador del recurso de origen. Puede ser una instantánea o un punto de restauración de disco desde el que crear un disco.

Nombre	Tipo	Description
id	string	Identificador de recurso de ARM en forma de /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Error de API.

Nombre	Tipo	Description
code	string	Código de error.
details	ApiErrorBase[]	Detalles del error de api
innererror	InnerError	Error interno de api
message	string	Mensaje de error.
target	string	Destino del error concreto.

ApiErrorBase

Base de errores de api.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error.
target	string	Destino del error concreto.

BootDiagnostics

El diagnóstico de arranque es una característica de depuración que permite ver la salida de la consola y la captura de pantalla para diagnosticar el estado de la máquina virtual. NOTA: si se especifica storageUri, asegúrese de que la cuenta de almacenamiento esté en la misma región y suscripción que la máquina virtual. Puede ver fácilmente la salida del registro de consola. Azure también le permite ver una captura de pantalla de la máquina virtual desde el hipervisor.

Nombre	Tipo	Description
enabled	boolean	Si se deben habilitar los diagnósticos de arranque en la máquina virtual.
storageUri	string	Uri de la cuenta de almacenamiento que se va a usar para colocar la salida y la captura de pantalla de la consola. Si no se especifica storageUri al habilitar los diagnósticos de arranque, se usará el almacenamiento administrado.

BootDiagnosticsInstanceView

El diagnóstico de arranque es una característica de depuración que permite ver la salida de la consola y la captura de pantalla para diagnosticar el estado de la máquina virtual. Puede ver fácilmente la salida del registro de consola. Azure también le permite ver una captura de pantalla de la máquina virtual desde el hipervisor.

Nombre	Tipo	Description
consoleScreenshotBlobUri	string	El URI del blob de la consola. Nota: Esto no establecer si el diagnóstico de arranque está habilitado actualmente con almacenamiento administrado.
serialConsoleLogBlobUri	string	Uri del blob de registro de la consola serie. Nota: Esto no establecer si el diagnóstico de arranque está habilitado actualmente con almacenamiento administrado.
status	InstanceViewStatus	La información de estado de diagnóstico de arranque de la máquina virtual. Nota: Solo se establecerá si se producen errores al habilitar los diagnósticos de arranque.

CachingTypes

Especifica los requisitos de almacenamiento en caché. Los valores posibles son: None,ReadOnly,ReadWrite. El comportamiento predeterminado es: Ninguno para el almacenamiento estándar. ReadOnly para Premium Storage.

Nombre	Tipo	Description
None	string
ReadOnly	string
ReadWrite	string

CloudError

Respuesta de error del servicio Compute.

Nombre	Tipo	Description
error	ApiError	Error de API.

ComponentNames

Nombre del componente. Actualmente, el único valor permitido es Microsoft-Windows-Shell-Setup.

Nombre	Tipo	Description
Microsoft-Windows-Shell-Setup	string

DataDisk

Especifica los parámetros que se usan para agregar un disco de datos a una máquina virtual. Para más información sobre los discos, consulte Acerca de discos y discos duros virtuales para máquinas virtuales de Azure.

Nombre	Tipo	Description
caching	CachingTypes	Especifica los requisitos de almacenamiento en caché. Los valores posibles son: None,ReadOnly,ReadWrite. El comportamiento predeterminado es: Ninguno para el almacenamiento estándar. ReadOnly para Premium Storage.
createOption	DiskCreateOptionTypes	Especifica cómo se debe crear el disco de máquina virtual. Los valores posibles son Adjuntar: Este valor se usa cuando se usa un disco especializado para crear la máquina virtual. FromImage: Este valor se usa cuando se usa una imagen para crear el disco de datos de la máquina virtual. Si usa una imagen de plataforma, también debe usar el elemento imageReference descrito anteriormente. Si usa una imagen de Marketplace, también debe usar el elemento plan descrito anteriormente. Vacío: Este valor se usa al crear un disco de datos vacío. Copiar: Este valor se usa para crear un disco de datos a partir de una instantánea u otro disco. Restaurar: Este valor se usa para crear un disco de datos a partir de un punto de restauración de disco.
deleteOption	DiskDeleteOptionTypes	Especifica si se debe eliminar o desasociar el disco de datos tras la eliminación de la máquina virtual. Los valores posibles son: Delete. Si se usa este valor, el disco de datos se elimina cuando se elimina la máquina virtual. Separar. Si se usa este valor, el disco de datos se conserva después de eliminar la máquina virtual. El valor predeterminado se establece en Desasociar.
detachOption	DiskDetachOptionTypes	Especifica el comportamiento de desasociación que se va a usar al desasociar un disco o que ya está en proceso de desasociación de la máquina virtual. Valores admitidos: ForceDetach. detachOption: ForceDetach solo se aplica a discos de datos administrados. Si un intento anterior de desasociación del disco de datos no se completó debido a un error inesperado de la máquina virtual y el disco todavía no se libera, use la opción forzar la desasociación como última opción de recurso para separar el disco forzadamente de la máquina virtual. Es posible que todas las escrituras no se hayan vaciado al usar este comportamiento de desasociación. Para forzar la desasociación de una actualización del disco de datos aBeDetached a "true" junto con la configuración de detachOption: "ForceDetach".
diskIOPSReadWrite	integer	Especifica el Read-Write IOPS del disco administrado cuando se UltraSSD_LRS StorageAccountType. Se devuelve solo para los discos de máquina virtual VirtualMachine ScaleSet. Solo se puede actualizar a través de las actualizaciones del conjunto de escalado virtualMachine.
diskMBpsReadWrite	integer	Especifica el ancho de banda en MB por segundo para el disco administrado cuando StorageAccountType es UltraSSD_LRS. Se devuelve solo para los discos de máquina virtual VirtualMachine ScaleSet. Solo se puede actualizar a través de las actualizaciones del conjunto de escalado virtualMachine.
diskSizeGB	integer	Especifica el tamaño de un disco de datos vacío en gigabytes. Este elemento se puede usar para sobrescribir el tamaño del disco en una imagen de máquina virtual. La propiedad 'diskSizeGB' es el número de bytes x 1024^3 para el disco y el valor no puede ser mayor que 1023.
image	VirtualHardDisk	Disco duro virtual de la imagen de usuario de origen. El disco duro virtual se copiará antes de conectarse a la máquina virtual. Si se proporciona SourceImage, el disco duro virtual de destino no debe existir.
lun	integer	Especifica el número de unidad lógica del disco de datos. Este valor se usa para identificar discos de datos dentro de la máquina virtual y, por tanto, debe ser único para cada disco de datos conectado a una máquina virtual.
managedDisk	ManagedDiskParameters	Parámetros de disco administrado.
name	string	Nombre del disco.
sourceResource	ApiEntityReference	Identificador del recurso de origen. Puede ser una instantánea o un punto de restauración de disco desde el que crear un disco.
toBeDetached	boolean	Especifica si el disco de datos está en proceso de desasociamiento de VirtualMachine/VirtualMachineScaleset
vhd	VirtualHardDisk	Disco duro virtual.
writeAcceleratorEnabled	boolean	Especifica si writeAccelerator debe estar habilitado o deshabilitado en el disco.

DeleteOptions

Especificación de lo que sucede con la interfaz de red cuando se elimina la máquina virtual

Nombre	Tipo	Description
Delete	string
Detach	string

DiagnosticsProfile

Especifica el estado de configuración de diagnóstico de arranque. Versión mínima de api: 2015-06-15.

Nombre	Tipo	Description
bootDiagnostics	BootDiagnostics	El diagnóstico de arranque es una característica de depuración que permite ver la salida de la consola y la captura de pantalla para diagnosticar el estado de la máquina virtual. NOTA: si se especifica storageUri, asegúrese de que la cuenta de almacenamiento esté en la misma región y suscripción que la máquina virtual. Puede ver fácilmente la salida del registro de consola. Azure también le permite ver una captura de pantalla de la máquina virtual desde el hipervisor.

DiffDiskOptions

Especifica la configuración del disco efímero para el disco del sistema operativo.

Nombre	Tipo	Description
Local	string

DiffDiskPlacement

Especifica la ubicación del disco efímero para el disco del sistema operativo. Los valores posibles son: CacheDisk,ResourceDisk,NvmeDisk. El comportamiento predeterminado es: CacheDisk si se configura uno para el tamaño de la máquina virtual en caso contrario, se usa resourceDisk o nvmeDisk. Consulte la documentación sobre el tamaño de la máquina virtual Windows en https://docs.microsoft.com/azure/virtual-machines/windows/sizes y máquina virtual Linux en https://docs.microsoft.com/azure/virtual-machines/linux/sizes para comprobar qué tamaños de máquina virtual expone un disco de caché. Versión mínima de api para NvmeDisk: 2024-03-01.

Nombre	Tipo	Description
CacheDisk	string
NvmeDisk	string
ResourceDisk	string

DiffDiskSettings

Especifica la configuración de disco efímero para el disco del sistema operativo utilizado por la máquina virtual.

Nombre	Tipo	Description
option	DiffDiskOptions	Especifica la configuración del disco efímero para el disco del sistema operativo.
placement	DiffDiskPlacement	Especifica la ubicación del disco efímero para el disco del sistema operativo. Los valores posibles son: CacheDisk,ResourceDisk,NvmeDisk. El comportamiento predeterminado es: CacheDisk si se configura uno para el tamaño de la máquina virtual en caso contrario, se usa resourceDisk o nvmeDisk. Consulte la documentación sobre el tamaño de la máquina virtual Windows en https://docs.microsoft.com/azure/virtual-machines/windows/sizes y máquina virtual Linux en https://docs.microsoft.com/azure/virtual-machines/linux/sizes para comprobar qué tamaños de máquina virtual expone un disco de caché. Versión mínima de api para NvmeDisk: 2024-03-01.

DiskControllerTypes

Especifica el tipo de controlador de disco configurado para la máquina virtual. Nota: Esta propiedad se establecerá en el tipo de controlador de disco predeterminado si no se especifica que se cree una máquina virtual con "hyperVGeneration" establecido en V2 en función de las funcionalidades del disco del sistema operativo y el tamaño de máquina virtual de la versión mínima de api especificada. Debe desasignar la máquina virtual antes de actualizar su tipo de controlador de disco a menos que actualice el tamaño de la máquina virtual en la configuración de la máquina virtual que desasigna implícitamente y reasigna la máquina virtual. Versión mínima de api: 2022-08-01.

Nombre	Tipo	Description
NVMe	string
SCSI	string

DiskCreateOptionTypes

Especifica cómo se debe crear el disco de máquina virtual. Los valores posibles son Adjuntar: Este valor se usa cuando se usa un disco especializado para crear la máquina virtual. FromImage: Este valor se usa cuando se usa una imagen para crear la máquina virtual. Si usa una imagen de plataforma, también debe usar el elemento imageReference descrito anteriormente. Si usa una imagen de Marketplace, también debe usar el elemento plan descrito anteriormente.

Nombre	Tipo	Description
Attach	string
Copy	string
Empty	string
FromImage	string
Restore	string

DiskDeleteOptionTypes

Especifica si el disco del sistema operativo se debe eliminar o desasociar tras la eliminación de la máquina virtual. Los valores posibles son: Delete. Si se usa este valor, el disco del sistema operativo se elimina cuando se elimina la máquina virtual. Separar. Si se usa este valor, el disco del sistema operativo se conserva después de eliminar la máquina virtual. El valor predeterminado se establece en Desasociar. Para un disco de sistema operativo efímero, el valor predeterminado se establece en Eliminar. El usuario no puede cambiar la opción de eliminación de un disco de sistema operativo efímero.

Nombre	Tipo	Description
Delete	string
Detach	string

DiskDetachOptionTypes

Especifica el comportamiento de desasociación que se va a usar al desasociar un disco o que ya está en proceso de desasociación de la máquina virtual. Valores admitidos: ForceDetach. detachOption: ForceDetach solo se aplica a discos de datos administrados. Si un intento anterior de desasociación del disco de datos no se completó debido a un error inesperado de la máquina virtual y el disco todavía no se libera, use la opción forzar la desasociación como última opción de recurso para separar el disco forzadamente de la máquina virtual. Es posible que todas las escrituras no se hayan vaciado al usar este comportamiento de desasociación. Para forzar la desasociación de una actualización del disco de datos aBeDetached a "true" junto con la configuración de detachOption: "ForceDetach".

Nombre	Tipo	Description
ForceDetach	string

DiskEncryptionSetParameters

Especifica el identificador de recurso del conjunto de cifrado de disco administrado del cliente para el disco administrado.

Nombre	Tipo	Description
id	string	Identificador de recurso

DiskEncryptionSettings

Especifica la configuración de cifrado del disco del sistema operativo.

Versión mínima de api: 2015-06-15

Nombre	Tipo	Description
diskEncryptionKey	KeyVaultSecretReference	Especifica la ubicación de la clave de cifrado de disco, que es un secreto de Key Vault.
enabled	boolean	Especifica si se debe habilitar el cifrado de disco en la máquina virtual.
keyEncryptionKey	KeyVaultKeyReference	Especifica la ubicación de la clave de cifrado de claves en Key Vault.

DiskInstanceView

La información de los discos.

Nombre	Tipo	Description
encryptionSettings	DiskEncryptionSettings[]	Especifica la configuración de cifrado del disco del sistema operativo. Versión mínima de api: 2015-06-15
name	string	Nombre del disco.
statuses	InstanceViewStatus[]	Información de estado del recurso.

DomainNameLabelScopeTypes

Ámbito de la etiqueta Nombre de dominio de los recursos de PublicIPAddress que se crearán. La etiqueta de nombre generada es la concatenación de la etiqueta de nombre de dominio hash con directiva según el ámbito de la etiqueta de nombre de dominio y el identificador único del perfil de red de máquina virtual.

Nombre	Tipo	Description
NoReuse	string
ResourceGroupReuse	string
SubscriptionReuse	string
TenantReuse	string

EncryptionIdentity

Especifica la identidad administrada usada por ADE para obtener el token de acceso para las operaciones de keyvault.

Nombre	Tipo	Description
userAssignedIdentityResourceId	string	Especifica el identificador de recurso de ARM de una de las identidades de usuario asociadas a la máquina virtual.

HardwareProfile

Especifica la configuración de hardware de la máquina virtual.

Nombre	Tipo	Description
vmSize	VirtualMachineSizeTypes	Especifica el tamaño de la máquina virtual. El tipo de datos de enumeración está actualmente en desuso y se quitará el 23 de diciembre de 2023. La manera recomendada de obtener la lista de tamaños disponibles es usar estas API: Enumerar todos los tamaños de máquina virtual disponibles en un conjunto de disponibilidad, Enumerar todos los tamaños de máquina virtual disponibles en una región, Enumerar todos los tamaños de máquina virtual disponibles para cambiar el tamaño. Para obtener más información sobre los tamaños de máquina virtual, consulte tamaños de para máquinas virtuales. Los tamaños de máquina virtual disponibles dependen de la región y el conjunto de disponibilidad.
vmSizeProperties	VMSizeProperties	Especifica las propiedades para personalizar el tamaño de la máquina virtual. Versión mínima de api: 2021-07-01. Esta característica sigue en modo de vista previa y no se admite para VirtualMachineScaleSet. Siga las instrucciones de personalización de máquina virtual para obtener más información.

HyperVGeneration

Generación del hipervisor de la máquina virtual [V1, V2]

Nombre	Tipo	Description
V1	string
V2	string

ImageReference

Especifica información sobre la imagen que se va a usar. Puede especificar información sobre imágenes de plataforma, imágenes de Marketplace o imágenes de máquina virtual. Este elemento es necesario cuando desea usar una imagen de plataforma, una imagen de Marketplace o una imagen de máquina virtual, pero no se usa en otras operaciones de creación.

Nombre	Tipo	Description
communityGalleryImageId	string	Se especificó el identificador único de la imagen de la galería de la comunidad para la implementación de la máquina virtual. Esto se puede capturar desde la llamada GET de la imagen de la galería de la comunidad.
exactVersion	string	Especifica en números decimales, la versión de la imagen de plataforma o la imagen de Marketplace que se usa para crear la máquina virtual. Este campo de solo lectura difiere de "version", solo si el valor especificado en el campo "version" es "latest".
id	string	Identificador de recurso
offer	string	Especifica la oferta de la imagen de plataforma o la imagen de Marketplace que se usa para crear la máquina virtual.
publisher	string	Publicador de imágenes.
sharedGalleryImageId	string	Se especificó el identificador único de la imagen de la galería compartida para la implementación de la máquina virtual. Esto se puede capturar desde la llamada GET de la imagen de la galería compartida.
sku	string	SKU de imagen.
version	string	Especifica la versión de la imagen de plataforma o la imagen de Marketplace que se usa para crear la máquina virtual. Los formatos permitidos son Major.Minor.Build o "latest". Major, Minor y Build son números decimales. Especifique "latest" para usar la versión más reciente de una imagen disponible en tiempo de implementación. Incluso si usa "latest", la imagen de máquina virtual no se actualizará automáticamente después del tiempo de implementación incluso si hay disponible una nueva versión. No use el campo "version" para la implementación de imágenes de la galería, la imagen de la galería siempre debe usar el campo "id" para la implementación, para usar la versión "latest" de la imagen de la galería, simplemente establezca "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/{imageName}" en el campo "id" sin entrada de versión.

InnerError

Detalles del error interno.

Nombre	Tipo	Description
errordetail	string	Mensaje de error interno o volcado de memoria de excepciones.
exceptiontype	string	Tipo de excepción.

InstanceViewStatus

Estado de la vista de instancia.

Nombre	Tipo	Description
code	string	Código de estado.
displayStatus	string	Etiqueta localizable corta para el estado.
level	StatusLevelTypes	Código de nivel.
message	string	Mensaje de estado detallado, incluido para alertas y mensajes de error.
time	string	Hora del estado.

InstanceViewTypes

Expresión expand que se va a aplicar en la operación. "InstanceView" recuperará la vista de instancia de la máquina virtual. "UserData" recuperará userData de la máquina virtual.

Nombre	Tipo	Description
instanceView	string
userData	string

IPVersion

Disponible desde Api-Version 2019-07-01 y versiones posteriores, representa si la ipconfiguration específica es IPv4 o IPv6. El valor predeterminado se toma como IPv4. Los valores posibles son: "IPv4" e "IPv6".

Nombre	Tipo	Description
IPv4	string
IPv6	string

IPVersions

Disponible desde Api-Version 2019-07-01 y versiones posteriores, representa si la ipconfiguration específica es IPv4 o IPv6. El valor predeterminado se toma como IPv4. Los valores posibles son: "IPv4" e "IPv6".

Nombre	Tipo	Description
IPv4	string
IPv6	string

KeyVaultKeyReference

Especifica la ubicación de la clave de cifrado de claves en Key Vault.

Nombre	Tipo	Description
keyUrl	string	Dirección URL que hace referencia a una clave de cifrado de claves en Key Vault.
sourceVault	SubResource	Dirección URL relativa del almacén de claves que contiene la clave.

KeyVaultSecretReference

Configuración protegida de extensiones que se pasan por referencia y que se consumen desde el almacén de claves.

Nombre	Tipo	Description
secretUrl	string	Dirección URL que hace referencia a un secreto en un almacén de claves.
sourceVault	SubResource	Dirección URL relativa del almacén de claves que contiene el secreto.

LinuxConfiguration

Especifica la configuración del sistema operativo Linux en la máquina virtual. Para obtener una lista de las distribuciones de Linux admitidas, consulte Linux on Azure-Endorsed Distributions.

Nombre	Tipo	Description
disablePasswordAuthentication	boolean	Especifica si se debe deshabilitar la autenticación de contraseña.
enableVMAgentPlatformUpdates	boolean	Indica si las actualizaciones de la plataforma VMAgent están habilitadas para la máquina virtual Linux. El valor predeterminado es false.
patchSettings	LinuxPatchSettings	[Característica de vista previa] Especifica la configuración relacionada con la aplicación de revisiones de invitado de máquina virtual en Linux.
provisionVMAgent	boolean	Indica si se debe aprovisionar el agente de máquina virtual en la máquina virtual. Cuando esta propiedad no se especifica en el cuerpo de la solicitud, el comportamiento predeterminado es establecerla en true. Esto garantizará que el agente de máquina virtual esté instalado en la máquina virtual para que las extensiones se puedan agregar a la máquina virtual más adelante.
ssh	SshConfiguration	Especifica la configuración de clave ssh para un sistema operativo Linux.

LinuxPatchAssessmentMode

Especifica el modo de evaluación de revisiones de invitado de máquina virtual para la máquina virtual IaaS.

Los valores posibles son:

ImageDefault: controla el tiempo de las evaluaciones de revisiones en una máquina virtual.

AutomaticByPlatform: la plataforma desencadenará evaluaciones periódicas de revisiones. La propiedad provisionVMAgent debe ser true.

Nombre	Tipo	Description
AutomaticByPlatform	string
ImageDefault	string

LinuxPatchSettings

[Característica de vista previa] Especifica la configuración relacionada con la aplicación de revisiones de invitado de máquina virtual en Linux.

Nombre	Tipo	Description
assessmentMode	LinuxPatchAssessmentMode	Especifica el modo de evaluación de revisiones de invitado de máquina virtual para la máquina virtual IaaS. Los valores posibles son: ImageDefault: controla el tiempo de las evaluaciones de revisiones en una máquina virtual. AutomaticByPlatform: la plataforma desencadenará evaluaciones periódicas de revisiones. La propiedad provisionVMAgent debe ser true.
automaticByPlatformSettings	LinuxVMGuestPatchAutomaticByPlatformSettings	Especifica la configuración adicional para el modo de revisión AutomaticByPlatform en la aplicación de revisiones de invitado de máquina virtual en Linux.
patchMode	LinuxVMGuestPatchMode	Especifica el modo de aplicación de revisiones de invitado de máquina virtual a máquinas virtuales iaaS o máquinas virtuales asociadas al conjunto de escalado de máquinas virtuales con OrchestrationMode como flexible. Los valores posibles son: imageDefault: se usa la configuración de aplicación de revisiones predeterminada de la máquina virtual. AutomaticByPlatform: la plataforma actualizará automáticamente la máquina virtual. La propiedad provisionVMAgent debe ser true

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Especifica la configuración de reinicio para todas las operaciones de instalación de revisiones AutomaticByPlatform.

Nombre	Tipo	Description
Always	string
IfRequired	string
Never	string
Unknown	string

LinuxVMGuestPatchAutomaticByPlatformSettings

Especifica la configuración adicional para el modo de revisión AutomaticByPlatform en la aplicación de revisiones de invitado de máquina virtual en Linux.

Nombre	Tipo	Description
bypassPlatformSafetyChecksOnUserSchedule	boolean	Permite al cliente programar la aplicación de revisiones sin actualizaciones accidentales
rebootSetting	LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Especifica la configuración de reinicio para todas las operaciones de instalación de revisiones AutomaticByPlatform.

LinuxVMGuestPatchMode

Especifica el modo de aplicación de revisiones de invitado de máquina virtual a máquinas virtuales iaaS o máquinas virtuales asociadas al conjunto de escalado de máquinas virtuales con OrchestrationMode como flexible.

Los valores posibles son:

imageDefault: se usa la configuración de aplicación de revisiones predeterminada de la máquina virtual.

AutomaticByPlatform: la plataforma actualizará automáticamente la máquina virtual. La propiedad provisionVMAgent debe ser true

Nombre	Tipo	Description
AutomaticByPlatform	string
ImageDefault	string

MaintenanceOperationResultCodeTypes

Código de resultado de la última operación de mantenimiento.

Nombre	Tipo	Description
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

Estado de la operación de mantenimiento en la máquina virtual.

Nombre	Tipo	Description
isCustomerInitiatedMaintenanceAllowed	boolean	True, si el cliente puede realizar el mantenimiento.
lastOperationMessage	string	Mensaje devuelto para la última operación de mantenimiento.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	Código de resultado de la última operación de mantenimiento.
maintenanceWindowEndTime	string	Hora de finalización de la ventana de mantenimiento.
maintenanceWindowStartTime	string	Hora de inicio de la ventana de mantenimiento.
preMaintenanceWindowEndTime	string	Hora de finalización de la ventana de mantenimiento previo.
preMaintenanceWindowStartTime	string	Hora de inicio de la ventana de mantenimiento previo.

ManagedDiskParameters

Parámetros de disco administrado.

Nombre	Tipo	Description
diskEncryptionSet	DiskEncryptionSetParameters	Especifica el identificador de recurso del conjunto de cifrado de disco administrado del cliente para el disco administrado.
id	string	Identificador de recurso
securityProfile	VMDiskSecurityProfile	Especifica el perfil de seguridad del disco administrado.
storageAccountType	StorageAccountTypes	Especifica el tipo de cuenta de almacenamiento para el disco administrado. NOTA: UltraSSD_LRS solo se puede usar con discos de datos, no se puede usar con disco del sistema operativo.

Mode

Especifica el modo en el que se ejecutará ProxyAgent si la característica está habilitada. ProxyAgent comenzará a auditar o supervisar, pero no aplicará el control de acceso sobre las solicitudes a los puntos de conexión host en modo auditoría, mientras que en el modo Aplicar aplicará el control de acceso. El valor predeterminado es Aplicar modo.

Nombre	Tipo	Description
Audit	string
Enforce	string

NetworkApiVersion

especifica la versión de la API de Microsoft.Network que se usa al crear recursos de red en las configuraciones de interfaz de red.

Nombre	Tipo	Description
2020-11-01	string

NetworkInterfaceAuxiliaryMode

Especifica si el modo auxiliar está habilitado para el recurso interfaz de red.

Nombre	Tipo	Description
AcceleratedConnections	string
Floating	string
None	string

NetworkInterfaceAuxiliarySku

Especifica si la SKU auxiliar está habilitada para el recurso interfaz de red.

Nombre	Tipo	Description
A1	string
A2	string
A4	string
A8	string
None	string

NetworkInterfaceReference

Especifica la lista de identificadores de recursos para las interfaces de red asociadas a la máquina virtual.

Nombre	Tipo	Description
id	string	Identificador de recurso
properties.deleteOption	DeleteOptions	Especificación de lo que sucede con la interfaz de red cuando se elimina la máquina virtual
properties.primary	boolean	Especifica la interfaz de red principal en caso de que la máquina virtual tenga más de 1 interfaz de red.

NetworkProfile

Especifica las interfaces de red de la máquina virtual.

Nombre	Tipo	Description
networkApiVersion	NetworkApiVersion	especifica la versión de la API de Microsoft.Network que se usa al crear recursos de red en las configuraciones de interfaz de red.
networkInterfaceConfigurations	VirtualMachineNetworkInterfaceConfiguration[]	Especifica las configuraciones de red que se usarán para crear los recursos de red de la máquina virtual.
networkInterfaces	NetworkInterfaceReference[]	Especifica la lista de identificadores de recursos para las interfaces de red asociadas a la máquina virtual.

OperatingSystemTypes

Tipo de sistema operativo.

Nombre	Tipo	Description
Linux	string
Windows	string

OSDisk

Especifica información sobre el disco del sistema operativo utilizado por la máquina virtual. Para más información sobre los discos, consulte Acerca de discos y discos duros virtuales para máquinas virtuales de Azure.

Nombre	Tipo	Description
caching	CachingTypes	Especifica los requisitos de almacenamiento en caché. Los valores posibles son: None,ReadOnly,ReadWrite. El comportamiento predeterminado es: Ninguno para el almacenamiento estándar. ReadOnly para Premium Storage.
createOption	DiskCreateOptionTypes	Especifica cómo se debe crear el disco de máquina virtual. Los valores posibles son Adjuntar: Este valor se usa cuando se usa un disco especializado para crear la máquina virtual. FromImage: Este valor se usa cuando se usa una imagen para crear la máquina virtual. Si usa una imagen de plataforma, también debe usar el elemento imageReference descrito anteriormente. Si usa una imagen de Marketplace, también debe usar el elemento plan descrito anteriormente.
deleteOption	DiskDeleteOptionTypes	Especifica si el disco del sistema operativo se debe eliminar o desasociar tras la eliminación de la máquina virtual. Los valores posibles son: Delete. Si se usa este valor, el disco del sistema operativo se elimina cuando se elimina la máquina virtual. Separar. Si se usa este valor, el disco del sistema operativo se conserva después de eliminar la máquina virtual. El valor predeterminado se establece en Desasociar. Para un disco de sistema operativo efímero, el valor predeterminado se establece en Eliminar. El usuario no puede cambiar la opción de eliminación de un disco de sistema operativo efímero.
diffDiskSettings	DiffDiskSettings	Especifica la configuración de disco efímero para el disco del sistema operativo utilizado por la máquina virtual.
diskSizeGB	integer	Especifica el tamaño de un disco de datos vacío en gigabytes. Este elemento se puede usar para sobrescribir el tamaño del disco en una imagen de máquina virtual. La propiedad 'diskSizeGB' es el número de bytes x 1024^3 para el disco y el valor no puede ser mayor que 1023.
encryptionSettings	DiskEncryptionSettings	Especifica la configuración de cifrado del disco del sistema operativo. Versión mínima de api: 2015-06-15.
image	VirtualHardDisk	Disco duro virtual de la imagen de usuario de origen. El disco duro virtual se copiará antes de conectarse a la máquina virtual. Si se proporciona SourceImage, el disco duro virtual de destino no debe existir.
managedDisk	ManagedDiskParameters	Parámetros de disco administrado.
name	string	Nombre del disco.
osType	OperatingSystemTypes	Esta propiedad permite especificar el tipo del sistema operativo que se incluye en el disco si crea una máquina virtual a partir de una imagen de usuario o un VHD especializado. Los valores posibles son: Windows,Linux.
vhd	VirtualHardDisk	Disco duro virtual.
writeAcceleratorEnabled	boolean	Especifica si writeAccelerator debe estar habilitado o deshabilitado en el disco.

OSProfile

Especifica la configuración del sistema operativo para la máquina virtual.

Nombre	Tipo	Description
adminPassword	string	Especifica la contraseña de la cuenta de administrador. longitud mínima (Windows): 8 caracteres longitud mínima (Linux): 6 caracteres longitud máxima (Windows): 123 caracteres longitud máxima (Linux): 72 caracteres requisitos de complejidad: 3 de 4 condiciones siguientes deben cumplirse. Tiene caracteres inferiores Tiene caracteres superiores Tiene un dígito Tiene un carácter especial (coincidencia regex [\W_]) valores no permitidos: "abc@123", "P@$$w 0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" Para restablecer la contraseña, consulte restablecimiento del servicio Escritorio remoto o su contraseña de inicio de sesión en una máquina virtual Windows Para restablecer la contraseña raíz, consulte Administración de usuarios, SSH y comprobación o reparación de discos en máquinas virtuales Linux de Azure mediante la extensión VMAccess
adminUsername	string	Especifica el nombre de la cuenta de administrador. Esta propiedad no se puede actualizar después de crear la máquina virtual. restricción solo de Windows: No se puede terminar en "." valores no permitidos: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm" ", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". longitud mínima (Linux): 1 carácter longitud máxima (Linux): 64 caracteres longitud máxima (Windows): 20 caracteres.
allowExtensionOperations	boolean	Especifica si se deben permitir operaciones de extensión en la máquina virtual. Esto solo se puede establecer en False cuando no hay extensiones presentes en la máquina virtual.
computerName	string	Especifica el nombre del sistema operativo host de la máquina virtual. Este nombre no se puede actualizar después de crear la máquina virtual. longitud máxima (Windows): 15 caracteres. longitud máxima (Linux): 64 caracteres. Para conocer las convenciones de nomenclatura y las restricciones, consulte directrices de implementación de servicios de infraestructura de Azure.
customData	string	Especifica una cadena codificada en base 64 de datos personalizados. La cadena codificada en base 64 se descodifica en una matriz binaria que se guarda como un archivo en la máquina virtual. La longitud máxima de la matriz binaria es de 65535 bytes. Nota: No pase secretos ni contraseñas en la propiedad customData. Esta propiedad no se puede actualizar después de crear la máquina virtual. La propiedad "customData" se pasa a la máquina virtual que se va a guardar como un archivo, para obtener más información, consulte Datos personalizados en máquinas virtuales de Azure. Para usar cloud-init para la máquina virtual Linux, consulte Uso de cloud-init para personalizar una máquina virtual Linux durante la creación.
linuxConfiguration	LinuxConfiguration	Especifica la configuración del sistema operativo Linux en la máquina virtual. Para obtener una lista de las distribuciones de Linux admitidas, consulte Linux on Azure-Endorsed Distributions.
requireGuestProvisionSignal	boolean	Propiedad opcional que debe establecerse en True o omitirse.
secrets	VaultSecretGroup[]	Especifica el conjunto de certificados que se deben instalar en la máquina virtual. Para instalar certificados en una máquina virtual, se recomienda usar la extensión de máquina virtual de Azure Key Vault de para Linux o la extensión de máquina virtual de Azure Key Vault de para Windows.
windowsConfiguration	WindowsConfiguration	Especifica la configuración del sistema operativo Windows en la máquina virtual.

PassNames

Nombre del pase. Actualmente, el único valor permitido es OobeSystem.

Nombre	Tipo	Description
OobeSystem	string

PatchSettings

[Característica de vista previa] Especifica la configuración relacionada con la aplicación de revisiones de invitado de máquina virtual en Windows.

Nombre	Tipo	Description
assessmentMode	WindowsPatchAssessmentMode	Especifica el modo de evaluación de revisiones de invitado de máquina virtual para la máquina virtual IaaS. Los valores posibles son: ImageDefault: controla el tiempo de las evaluaciones de revisiones en una máquina virtual. AutomaticByPlatform: la plataforma desencadenará evaluaciones periódicas de revisiones. La propiedad provisionVMAgent debe ser true.
automaticByPlatformSettings	WindowsVMGuestPatchAutomaticByPlatformSettings	Especifica la configuración adicional para el modo de revisión AutomaticByPlatform en la aplicación de revisiones de invitado de máquina virtual en Windows.
enableHotpatching	boolean	Permite a los clientes aplicar revisiones a sus máquinas virtuales de Azure sin necesidad de reiniciar. Para enableHotpatching, el "provisionVMAgent" debe establecerse en true y "patchMode" debe establecerse en "AutomaticByPlatform".
patchMode	WindowsVMGuestPatchMode	Especifica el modo de aplicación de revisiones de invitado de máquina virtual a máquinas virtuales iaaS o máquinas virtuales asociadas al conjunto de escalado de máquinas virtuales con OrchestrationMode como flexible. Los valores posibles son: Manual: controla la aplicación de revisiones en una máquina virtual. Para ello, aplique revisiones manualmente dentro de la máquina virtual. En este modo, las actualizaciones automáticas están deshabilitadas; La propiedad WindowsConfiguration.enableAutomaticUpdates debe ser false AutomaticByOS: el sistema operativo actualizará automáticamente la máquina virtual. La propiedad WindowsConfiguration.enableAutomaticUpdates debe ser true. AutomaticByPlatform: la máquina virtual actualizará automáticamente la plataforma. Las propiedades provisionVMAgent y WindowsConfiguration.enableAutomaticUpdates deben ser true.

Plan

Especifica información sobre la imagen de Marketplace que se usa para crear la máquina virtual. Este elemento solo se usa para imágenes de Marketplace. Para poder usar una imagen de Marketplace desde una API, debe habilitar la imagen para su uso mediante programación. En Azure Portal, busque la imagen de Marketplace que desea usar y, a continuación, haga clic en Desea implementar mediante programación, Introducción a>. Escriba cualquier información necesaria y haga clic en Guardar.

Nombre	Tipo	Description
name	string	Identificador del plan.
product	string	Especifica el producto de la imagen de Marketplace. Este es el mismo valor que Offer en el elemento imageReference.
promotionCode	string	El código de promoción.
publisher	string	Identificador del publicador.

ProtocolTypes

Especifica el protocolo del agente de escucha winRM. Los valores posibles son: http,https.

Nombre	Tipo	Description
Http	string
Https	string

ProxyAgentSettings

Especifica la configuración de ProxyAgent al crear la máquina virtual. Versión mínima de api: 2023-09-01.

Nombre	Tipo	Description
enabled	boolean	Especifica si la característica ProxyAgent debe estar habilitada en la máquina virtual o en el conjunto de escalado de máquinas virtuales.
keyIncarnationId	integer	Aumentar el valor de esta propiedad permite al usuario restablecer la clave utilizada para proteger el canal de comunicación entre invitado y host.
mode	Mode	Especifica el modo en el que se ejecutará ProxyAgent si la característica está habilitada. ProxyAgent comenzará a auditar o supervisar, pero no aplicará el control de acceso sobre las solicitudes a los puntos de conexión host en modo auditoría, mientras que en el modo Aplicar aplicará el control de acceso. El valor predeterminado es Aplicar modo.

PublicIPAddressSku

Describe la SKU de dirección IP pública. Solo se puede establecer con OrchestrationMode como flexible.

Nombre	Tipo	Description
name	PublicIPAddressSkuName	Especificación del nombre de SKU de ip pública
tier	PublicIPAddressSkuTier	Especificación del nivel de SKU de IP pública

PublicIPAddressSkuName

Especificación del nombre de SKU de ip pública

Nombre	Tipo	Description
Basic	string
Standard	string

PublicIPAddressSkuTier

Especificación del nivel de SKU de IP pública

Nombre	Tipo	Description
Global	string
Regional	string

PublicIPAllocationMethod

Especificar el tipo de asignación de IP pública

Nombre	Tipo	Description
Dynamic	string
Static	string

ResourceIdentityType

Tipo de identidad que se usa para la máquina virtual. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades de la máquina virtual.

Nombre	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

securityEncryptionTypes

Especifica encryptionType del disco administrado. Se establece en DiskWithVMGuestState para el cifrado del disco administrado junto con el blob VMGuestState, VMGuestStateOnly para el cifrado de solo el blob VMGuestState y NonPersistedTPM para no conservar el estado de firmware en el blob VMGuestState. Nota: Solo se puede establecer para máquinas virtuales confidenciales.

Nombre	Tipo	Description
DiskWithVMGuestState	string
NonPersistedTPM	string
VMGuestStateOnly	string

SecurityProfile

Especifica la configuración del perfil relacionado con la seguridad de la máquina virtual.

Nombre	Tipo	Description
encryptionAtHost	boolean	El usuario puede usar esta propiedad en la solicitud para habilitar o deshabilitar el cifrado de host para la máquina virtual o el conjunto de escalado de máquinas virtuales. Esto habilitará el cifrado para todos los discos, incluido el recurso o el disco temporal en el propio host. El comportamiento predeterminado es: el cifrado en el host se deshabilitará a menos que esta propiedad esté establecida en true para el recurso.
encryptionIdentity	EncryptionIdentity	Especifica la identidad administrada usada por ADE para obtener el token de acceso para las operaciones de keyvault.
proxyAgentSettings	ProxyAgentSettings	Especifica la configuración de ProxyAgent al crear la máquina virtual. Versión mínima de api: 2023-09-01.
securityType	SecurityTypes	Especifica securityType de la máquina virtual. Debe establecerse en cualquier valor especificado para habilitar UefiSettings. El comportamiento predeterminado es: UefiSettings no se habilitará a menos que se establezca esta propiedad.
uefiSettings	UefiSettings	Especifica la configuración de seguridad, como el arranque seguro y vTPM que se usa al crear la máquina virtual. Versión mínima de api: 2020-12-01.

SecurityTypes

Especifica securityType de la máquina virtual. Debe establecerse en cualquier valor especificado para habilitar UefiSettings. El comportamiento predeterminado es: UefiSettings no se habilitará a menos que se establezca esta propiedad.

Nombre	Tipo	Description
ConfidentialVM	string
TrustedLaunch	string

SettingNames

Especifica el nombre de la configuración a la que se aplica el contenido. Los valores posibles son: FirstLogonCommands y AutoLogon.

Nombre	Tipo	Description
AutoLogon	string
FirstLogonCommands	string

Sku

SKU de máquina virtual.

Nombre	Tipo	Description
capacity	integer	Especifica el número de máquinas virtuales del conjunto de escalado.
name	string	El nombre de la SKU.
tier	string	Especifica el nivel de máquinas virtuales de un conjunto de escalado. Valores posibles: Estándar Básico

SshConfiguration

Especifica la configuración de clave ssh para un sistema operativo Linux.

Nombre	Tipo	Description
publicKeys	SshPublicKey[]	Lista de claves públicas SSH que se usan para autenticarse con máquinas virtuales basadas en Linux.

SshPublicKey

Lista de claves públicas SSH que se usan para autenticarse con máquinas virtuales basadas en Linux.

Nombre	Tipo	Description
keyData	string	Certificado de clave pública SSH que se usa para autenticarse con la máquina virtual mediante ssh. La clave debe tener al menos 2048 bits y en formato ssh-rsa. Para crear claves SSH, consulte [Creación de claves SSH en máquinas virtuales Linux y Mac para Linux en Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).
path	string	Especifica la ruta de acceso completa en la máquina virtual creada donde se almacena la clave pública ssh. Si el archivo ya existe, la clave especificada se anexa al archivo. Ejemplo: /home/user/.ssh/authorized_keys

StatusLevelTypes

Código de nivel.

Nombre	Tipo	Description
Error	string
Info	string
Warning	string

StorageAccountTypes

Especifica el tipo de cuenta de almacenamiento para el disco administrado. NOTA: UltraSSD_LRS solo se puede usar con discos de datos, no se puede usar con disco del sistema operativo.

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

StorageProfile

Especifica la configuración de almacenamiento de los discos de máquina virtual.

Nombre	Tipo	Description
dataDisks	DataDisk[]	Especifica los parámetros que se usan para agregar un disco de datos a una máquina virtual. Para más información sobre los discos, consulte Acerca de discos y discos duros virtuales para máquinas virtuales de Azure.
diskControllerType	DiskControllerTypes	Especifica el tipo de controlador de disco configurado para la máquina virtual. Nota: Esta propiedad se establecerá en el tipo de controlador de disco predeterminado si no se especifica que se cree una máquina virtual con "hyperVGeneration" establecido en V2 en función de las funcionalidades del disco del sistema operativo y el tamaño de máquina virtual de la versión mínima de api especificada. Debe desasignar la máquina virtual antes de actualizar su tipo de controlador de disco a menos que actualice el tamaño de la máquina virtual en la configuración de la máquina virtual que desasigna implícitamente y reasigna la máquina virtual. Versión mínima de api: 2022-08-01.
imageReference	ImageReference	Especifica información sobre la imagen que se va a usar. Puede especificar información sobre imágenes de plataforma, imágenes de Marketplace o imágenes de máquina virtual. Este elemento es necesario cuando desea usar una imagen de plataforma, una imagen de Marketplace o una imagen de máquina virtual, pero no se usa en otras operaciones de creación.
osDisk	OSDisk	Especifica información sobre el disco del sistema operativo utilizado por la máquina virtual. Para más información sobre los discos, consulte Acerca de discos y discos duros virtuales para máquinas virtuales de Azure.

SubResource

Dirección URL relativa del almacén de claves que contiene el secreto.

Nombre	Tipo	Description
id	string	Identificador de recurso

UefiSettings

Especifica la configuración de seguridad, como el arranque seguro y vTPM que se usa al crear la máquina virtual. Versión mínima de api: 2020-12-01.

Nombre	Tipo	Description
secureBootEnabled	boolean	Especifica si se debe habilitar el arranque seguro en la máquina virtual. Versión mínima de api: 2020-12-01.
vTpmEnabled	boolean	Especifica si vTPM debe estar habilitado en la máquina virtual. Versión mínima de api: 2020-12-01.

UserAssignedIdentities

Lista de identidades de usuario asociadas a la máquina virtual. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Nombre	Tipo	Description

VaultCertificate

Lista de referencias del almacén de claves en SourceVault que contienen certificados.

Nombre	Tipo	Description
certificateStore	string	En el caso de las máquinas virtuales Windows, especifica el almacén de certificados en la máquina virtual a la que se debe agregar el certificado. El almacén de certificados especificado se encuentra implícitamente en la cuenta localMachine. En el caso de las máquinas virtuales Linux, el archivo de certificado se coloca en el directorio /var/lib/waagent, con el nombre de archivo <UppercaseThumbprint>.crt para el archivo de certificado X509 y <UppercaseThumbprint>.prv para la clave privada. Ambos archivos tienen formato .pem.
certificateUrl	string	Esta es la dirección URL de un certificado que se ha cargado en Key Vault como secreto. Para agregar un secreto a Key Vault, consulte Agregar una clave o un secreto al almacén de claves. En este caso, el certificado debe ser La codificación Base64 del siguiente objeto JSON que se codifica en UTF-8: { "data":"", "dataType":"pfx", "password":"" } Para instalar certificados en una máquina virtual, se recomienda usar la extensión de máquina virtual de Azure Key Vault de para Linux o la extensión de máquina virtual de Azure Key Vault de para Windows.

VaultSecretGroup

Especifica el conjunto de certificados que se deben instalar en la máquina virtual. Para instalar certificados en una máquina virtual, se recomienda usar la extensión de máquina virtual de Azure Key Vault de para Linux o la extensión de máquina virtual de Azure Key Vault de para Windows.

Nombre	Tipo	Description
sourceVault	SubResource	Dirección URL relativa del almacén de claves que contiene todos los certificados de VaultCertificates.
vaultCertificates	VaultCertificate[]	Lista de referencias del almacén de claves en SourceVault que contienen certificados.

VirtualHardDisk

Disco duro virtual.

Nombre	Tipo	Description
uri	string	Especifica el URI del disco duro virtual.

VirtualMachineAgentInstanceView

Agente de máquina virtual que se ejecuta en la máquina virtual.

Nombre	Tipo	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	Vista de instancia del controlador de extensión de máquina virtual.
statuses	InstanceViewStatus[]	Información de estado del recurso.
vmAgentVersion	string	Versión completa del agente de máquina virtual.

VirtualMachineExtension

Recursos de extensión secundaria de máquina virtual.

Nombre	Tipo	Description
id	string	Identificador de recurso
location	string	Ubicación del recurso
name	string	Nombre del recurso
properties.autoUpgradeMinorVersion	boolean	Indica si la extensión debe usar una versión secundaria más reciente si está disponible en el momento de la implementación. Sin embargo, una vez implementada, la extensión no actualizará las versiones secundarias a menos que se vuelva a implementar, incluso con esta propiedad establecida en true.
properties.enableAutomaticUpgrade	boolean	Indica si la plataforma debe actualizar automáticamente la extensión si hay una versión más reciente de la extensión disponible.
properties.forceUpdateTag	string	Cómo se debe forzar el controlador de extensión para actualizar incluso si la configuración de la extensión no ha cambiado.
properties.instanceView	VirtualMachineExtensionInstanceView	Vista de instancia de extensión de máquina virtual.
properties.protectedSettings	object	La extensión puede contener protectedSettings o protectedSettingsFromKeyVault o ninguna configuración protegida.
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	Configuración protegida de extensiones que se pasan por referencia y que se consumen desde el almacén de claves.
properties.provisionAfterExtensions	string[]	Colección de nombres de extensión después de los cuales se debe aprovisionar esta extensión.
properties.provisioningState	string	Estado de aprovisionamiento, que solo aparece en la respuesta.
properties.publisher	string	Nombre del publicador de controladores de extensión.
properties.settings	object	Configuración pública con formato JSON para la extensión.
properties.suppressFailures	boolean	Indica si los errores derivados de la extensión se suprimirán (los errores operativos, como no conectarse a la máquina virtual, no se suprimirán independientemente de este valor). El valor predeterminado es false.
properties.type	string	Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension".
properties.typeHandlerVersion	string	Especifica la versión del controlador de script.
tags	object	Etiquetas de recursos
type	string	Tipo de recurso

VirtualMachineExtensionHandlerInstanceView

Vista de instancia del controlador de extensión de máquina virtual.

Nombre	Tipo	Description
status	InstanceViewStatus	Estado del controlador de extensión.
type	string	Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension".
typeHandlerVersion	string	Especifica la versión del controlador de script.

VirtualMachineExtensionInstanceView

Vista de instancia de extensión de máquina virtual.

Nombre	Tipo	Description
name	string	Nombre de la extensión de máquina virtual.
statuses	InstanceViewStatus[]	Información de estado del recurso.
substatuses	InstanceViewStatus[]	Información de estado del recurso.
type	string	Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension".
typeHandlerVersion	string	Especifica la versión del controlador de script.

VirtualMachineHealthStatus

Estado de mantenimiento de la máquina virtual.

Nombre	Tipo	Description
status	InstanceViewStatus	Información de estado de mantenimiento de la máquina virtual.

VirtualMachineIdentity

Identidad de la máquina virtual, si está configurada.

Nombre	Tipo	Description
principalId	string	Identificador de entidad de seguridad de la identidad de máquina virtual. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
tenantId	string	Identificador de inquilino asociado a la máquina virtual. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
type	ResourceIdentityType	Tipo de identidad que se usa para la máquina virtual. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades de la máquina virtual.
userAssignedIdentities	UserAssignedIdentities	Lista de identidades de usuario asociadas a la máquina virtual. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

VirtualMachineIpTag

Lista de etiquetas IP asociadas a la dirección IP pública.

Nombre	Tipo	Description
ipTagType	string	Tipo de etiqueta IP. Ejemplo: FirstPartyUsage.
tag	string	Etiqueta IP asociada a la dirección IP pública. Ejemplo: SQL, Almacenamiento, etc.

VirtualMachineNetworkInterfaceConfiguration

Especifica las configuraciones de red que se usarán para crear los recursos de red de la máquina virtual.

Nombre	Tipo	Description
name	string	Nombre de configuración de la interfaz de red.
properties.auxiliaryMode	NetworkInterfaceAuxiliaryMode	Especifica si el modo auxiliar está habilitado para el recurso interfaz de red.
properties.auxiliarySku	NetworkInterfaceAuxiliarySku	Especifica si la SKU auxiliar está habilitada para el recurso interfaz de red.
properties.deleteOption	DeleteOptions	Especificación de lo que sucede con la interfaz de red cuando se elimina la máquina virtual
properties.disableTcpStateTracking	boolean	Especifica si la interfaz de red está deshabilitada para el seguimiento de estado tcp.
properties.dnsSettings	VirtualMachineNetworkInterfaceDnsSettingsConfiguration	Configuración dns que se va a aplicar en las interfaces de red.
properties.dscpConfiguration	SubResource
properties.enableAcceleratedNetworking	boolean	Especifica si la interfaz de red está habilitada para redes aceleradas.
properties.enableFpga	boolean	Especifica si la interfaz de red está habilitada para redes FPGA.
properties.enableIPForwarding	boolean	Indica si el reenvío IP está habilitado en esta NIC.
properties.ipConfigurations	VirtualMachineNetworkInterfaceIPConfiguration[]	Especifica las configuraciones IP de la interfaz de red.
properties.networkSecurityGroup	SubResource	El grupo de seguridad de red.
properties.primary	boolean	Especifica la interfaz de red principal en caso de que la máquina virtual tenga más de 1 interfaz de red.

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

Configuración dns que se va a aplicar en las interfaces de red.

Nombre	Tipo	Description
dnsServers	string[]	Lista de direcciones IP de servidores DNS

VirtualMachineNetworkInterfaceIPConfiguration

Especifica las configuraciones IP de la interfaz de red.

Nombre	Tipo	Description
name	string	Nombre de configuración de IP.
properties.applicationGatewayBackendAddressPools	SubResource[]	Especifica una matriz de referencias a grupos de direcciones de back-end de puertas de enlace de aplicaciones. Una máquina virtual puede hacer referencia a grupos de direcciones de back-end de varias puertas de enlace de aplicaciones. Varias máquinas virtuales no pueden usar la misma puerta de enlace de aplicaciones.
properties.applicationSecurityGroups	SubResource[]	Especifica una matriz de referencias al grupo de seguridad de aplicaciones.
properties.loadBalancerBackendAddressPools	SubResource[]	Especifica una matriz de referencias a grupos de direcciones de back-end de equilibradores de carga. Una máquina virtual puede hacer referencia a grupos de direcciones de back-end de un equilibrador de carga público y interno. [Varias máquinas virtuales no pueden usar el mismo equilibrador de carga de SKU básico].
properties.primary	boolean	Especifica la interfaz de red principal en caso de que la máquina virtual tenga más de 1 interfaz de red.
properties.privateIPAddressVersion	IPVersions	Disponible desde Api-Version 2017-03-30 y versiones posteriores, representa si la ipconfiguration específica es IPv4 o IPv6. El valor predeterminado se toma como IPv4. Los valores posibles son: "IPv4" e "IPv6".
properties.publicIPAddressConfiguration	VirtualMachinePublicIPAddressConfiguration	PublicIPAddressConfiguration.
properties.subnet	SubResource	Especifica el identificador de la subred.

VirtualMachinePublicIPAddressConfiguration

PublicIPAddressConfiguration.

Nombre	Tipo	Description
name	string	Nombre de configuración de la dirección publicIP.
properties.deleteOption	DeleteOptions	Especificación de lo que sucede con la dirección IP pública cuando se elimina la máquina virtual
properties.dnsSettings	VirtualMachinePublicIPAddressDnsSettingsConfiguration	Configuración dns que se va a aplicar en las direcciones publicIP.
properties.idleTimeoutInMinutes	integer	Tiempo de espera de inactividad de la dirección IP pública.
properties.ipTags	VirtualMachineIpTag[]	Lista de etiquetas IP asociadas a la dirección IP pública.
properties.publicIPAddressVersion	IPVersions	Disponible desde Api-Version 2019-07-01 y versiones posteriores, representa si la ipconfiguration específica es IPv4 o IPv6. El valor predeterminado se toma como IPv4. Los valores posibles son: "IPv4" e "IPv6".
properties.publicIPAllocationMethod	PublicIPAllocationMethod	Especificar el tipo de asignación de IP pública
properties.publicIPPrefix	SubResource	PublicIPPrefix desde el que se van a asignar direcciones publicIP.
sku	PublicIPAddressSku	Describe la SKU de dirección IP pública. Solo se puede establecer con OrchestrationMode como flexible.

VirtualMachinePublicIPAddressDnsSettingsConfiguration

Configuración dns que se va a aplicar en las direcciones publicIP.

Nombre	Tipo	Description
domainNameLabel	string	Prefijo de etiqueta nombre de dominio de los recursos publicIPAddress que se crearán. La etiqueta de nombre generada es la concatenación de la etiqueta de nombre de dominio y el identificador único del perfil de red de máquina virtual.
domainNameLabelScope	DomainNameLabelScopeTypes	Ámbito de la etiqueta Nombre de dominio de los recursos de PublicIPAddress que se crearán. La etiqueta de nombre generada es la concatenación de la etiqueta de nombre de dominio hash con directiva según el ámbito de la etiqueta de nombre de dominio y el identificador único del perfil de red de máquina virtual.

VirtualMachineScaleSetIPConfiguration

Especifica las configuraciones IP de la interfaz de red.

Nombre	Tipo	Description
name	string	Nombre de configuración de IP.
properties.applicationGatewayBackendAddressPools	SubResource[]	Especifica una matriz de referencias a grupos de direcciones de back-end de puertas de enlace de aplicaciones. Un conjunto de escalado puede hacer referencia a grupos de direcciones de back-end de varias puertas de enlace de aplicaciones. Varios conjuntos de escalado no pueden usar la misma puerta de enlace de aplicaciones.
properties.applicationSecurityGroups	SubResource[]	Especifica una matriz de referencias al grupo de seguridad de aplicaciones.
properties.loadBalancerBackendAddressPools	SubResource[]	Especifica una matriz de referencias a grupos de direcciones de back-end de equilibradores de carga. Un conjunto de escalado puede hacer referencia a los grupos de direcciones de back-end de un equilibrador de carga público y interno. Varios conjuntos de escalado no pueden usar el mismo equilibrador de carga de SKU básico.
properties.loadBalancerInboundNatPools	SubResource[]	Especifica una matriz de referencias a grupos Nat entrantes de los equilibradores de carga. Un conjunto de escalado puede hacer referencia a grupos nat de entrada de un equilibrador de carga público y uno interno. Varios conjuntos de escalado no pueden usar el mismo equilibrador de carga de SKU básico.
properties.primary	boolean	Especifica la interfaz de red principal en caso de que la máquina virtual tenga más de 1 interfaz de red.
properties.privateIPAddressVersion	IPVersion	Disponible desde Api-Version 2017-03-30 y versiones posteriores, representa si la ipconfiguration específica es IPv4 o IPv6. El valor predeterminado se toma como IPv4. Los valores posibles son: "IPv4" e "IPv6".
properties.publicIPAddressConfiguration	VirtualMachineScaleSetPublicIPAddressConfiguration	PublicIPAddressConfiguration.
properties.subnet	ApiEntityReference	Especifica el identificador de la subred.

VirtualMachineScaleSetIpTag

Lista de etiquetas IP asociadas a la dirección IP pública.

Nombre	Tipo	Description
ipTagType	string	Tipo de etiqueta IP. Ejemplo: FirstPartyUsage.
tag	string	Etiqueta IP asociada a la dirección IP pública. Ejemplo: SQL, Almacenamiento, etc.

VirtualMachineScaleSetNetworkConfiguration

Lista de configuraciones de red.

Nombre	Tipo	Description
name	string	Nombre de configuración de red.
properties.auxiliaryMode	NetworkInterfaceAuxiliaryMode	Especifica si el modo auxiliar está habilitado para el recurso interfaz de red.
properties.auxiliarySku	NetworkInterfaceAuxiliarySku	Especifica si la SKU auxiliar está habilitada para el recurso interfaz de red.
properties.deleteOption	DeleteOptions	Especificación de lo que sucede con la interfaz de red cuando se elimina la máquina virtual
properties.disableTcpStateTracking	boolean	Especifica si la interfaz de red está deshabilitada para el seguimiento de estado tcp.
properties.dnsSettings	VirtualMachineScaleSetNetworkConfigurationDnsSettings	Configuración dns que se va a aplicar en las interfaces de red.
properties.enableAcceleratedNetworking	boolean	Especifica si la interfaz de red está habilitada para redes aceleradas.
properties.enableFpga	boolean	Especifica si la interfaz de red está habilitada para redes FPGA.
properties.enableIPForwarding	boolean	Indica si el reenvío IP está habilitado en esta NIC.
properties.ipConfigurations	VirtualMachineScaleSetIPConfiguration[]	Especifica las configuraciones IP de la interfaz de red.
properties.networkSecurityGroup	SubResource	El grupo de seguridad de red.
properties.primary	boolean	Especifica la interfaz de red principal en caso de que la máquina virtual tenga más de 1 interfaz de red.

VirtualMachineScaleSetNetworkConfigurationDnsSettings

Configuración dns que se va a aplicar en las interfaces de red.

Nombre	Tipo	Description
dnsServers	string[]	Lista de direcciones IP de servidores DNS

VirtualMachineScaleSetPublicIPAddressConfiguration

PublicIPAddressConfiguration.

Nombre	Tipo	Description
name	string	Nombre de configuración de la dirección publicIP.
properties.deleteOption	DeleteOptions	Especificación de lo que sucede con la dirección IP pública cuando se elimina la máquina virtual
properties.dnsSettings	VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings	Configuración dns que se va a aplicar en las direcciones publicIP.
properties.idleTimeoutInMinutes	integer	Tiempo de espera de inactividad de la dirección IP pública.
properties.ipTags	VirtualMachineScaleSetIpTag[]	Lista de etiquetas IP asociadas a la dirección IP pública.
properties.publicIPAddressVersion	IPVersion	Disponible desde Api-Version 2019-07-01 y versiones posteriores, representa si la ipconfiguration específica es IPv4 o IPv6. El valor predeterminado se toma como IPv4. Los valores posibles son: "IPv4" e "IPv6".
properties.publicIPPrefix	SubResource	PublicIPPrefix desde el que se van a asignar direcciones publicIP.
sku	PublicIPAddressSku	Describe la SKU de dirección IP pública. Solo se puede establecer con OrchestrationMode como flexible.

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

Configuración dns que se va a aplicar en las direcciones publicIP.

Nombre	Tipo	Description
domainNameLabel	string	Etiqueta Nombre de dominio. La concatenación de la etiqueta de nombre de dominio y el índice de máquina virtual serán las etiquetas de nombre de dominio de los recursos publicIPAddress que se crearán.
domainNameLabelScope	DomainNameLabelScopeTypes	Ámbito de la etiqueta Nombre de dominio. La concatenación de la etiqueta de nombre de dominio hash generada según la directiva a partir del ámbito de la etiqueta de nombre de dominio y el índice de máquina virtual serán las etiquetas de nombre de dominio de los recursos de PublicIPAddress que se crearán.

VirtualMachineScaleSetVM

Describe una máquina virtual del conjunto de escalado de máquinas virtuales.

Nombre	Tipo	Description
etag	string	Etag es la propiedad devuelta en update/Get response of the VMSS VMS VM, para que el cliente pueda proporcionarla en el encabezado para garantizar las actualizaciones optimistas.
id	string	Identificador de recurso
identity	VirtualMachineIdentity	Identidad de la máquina virtual, si está configurada.
instanceId	string	Identificador de instancia de la máquina virtual.
location	string	Ubicación del recurso
name	string	Nombre del recurso
plan	Plan	Especifica información sobre la imagen de Marketplace que se usa para crear la máquina virtual. Este elemento solo se usa para imágenes de Marketplace. Para poder usar una imagen de Marketplace desde una API, debe habilitar la imagen para su uso mediante programación. En Azure Portal, busque la imagen de Marketplace que desea usar y, a continuación, haga clic en Desea implementar mediante programación, Introducción a>. Escriba cualquier información necesaria y haga clic en Guardar.
properties.additionalCapabilities	AdditionalCapabilities	Especifica funcionalidades adicionales habilitadas o deshabilitadas en la máquina virtual del conjunto de escalado. Por ejemplo: si la máquina virtual tiene la capacidad de admitir la conexión de discos de datos administrados con UltraSSD_LRS tipo de cuenta de almacenamiento.
properties.availabilitySet	SubResource	Especifica información sobre el conjunto de disponibilidad al que se debe asignar la máquina virtual. Las máquinas virtuales especificadas en el mismo conjunto de disponibilidad se asignan a distintos nodos para maximizar la disponibilidad. Para obtener más información sobre los conjuntos de disponibilidad, consulte Introducción a los conjuntos de disponibilidad. Para más información sobre el mantenimiento planeado de Azure, consulte mantenimiento y actualizaciones de para máquinas virtuales en Azure. Actualmente, una máquina virtual solo se puede agregar al conjunto de disponibilidad en el momento de la creación. No se puede agregar una máquina virtual existente a un conjunto de disponibilidad.
properties.diagnosticsProfile	DiagnosticsProfile	Especifica el estado de configuración de diagnóstico de arranque. Versión mínima de api: 2015-06-15.
properties.hardwareProfile	HardwareProfile	Especifica la configuración de hardware de la máquina virtual.
properties.instanceView	VirtualMachineScaleSetVMInstanceView	Vista de instancia de máquina virtual.
properties.latestModelApplied	boolean	Especifica si el modelo más reciente se ha aplicado a la máquina virtual.
properties.licenseType	string	Especifica que la imagen o el disco que se usa tenían licencias locales. Los valores posibles para el sistema operativo Windows Server son: Windows_Client Windows_Server Los valores posibles para el sistema operativo Linux Server son: RHEL_BYOS (para RHEL) SLES_BYOS (para SUSE) Para obtener más información, consulte Ventaja de uso híbrido de Azure para Windows Server Ventaja de uso híbrido de Azure para Linux Server Versión mínima de api: 2015-06-15
properties.modelDefinitionApplied	string	Especifica si el modelo aplicado a la máquina virtual es el modelo del conjunto de escalado de máquinas virtuales o el modelo personalizado para la máquina virtual.
properties.networkProfile	NetworkProfile	Especifica las interfaces de red de la máquina virtual.
properties.networkProfileConfiguration	VirtualMachineScaleSetVMNetworkProfileConfiguration	Especifica la configuración del perfil de red de la máquina virtual.
properties.osProfile	OSProfile	Especifica la configuración del sistema operativo para la máquina virtual.
properties.protectionPolicy	VirtualMachineScaleSetVMProtectionPolicy	Especifica la directiva de protección de la máquina virtual.
properties.provisioningState	string	Estado de aprovisionamiento, que solo aparece en la respuesta.
properties.securityProfile	SecurityProfile	Especifica la configuración del perfil relacionado con la seguridad de la máquina virtual.
properties.storageProfile	StorageProfile	Especifica la configuración de almacenamiento de los discos de máquina virtual.
properties.timeCreated	string	Especifica la hora en que se creó el recurso de máquina virtual. Versión mínima de api: 2021-11-01.
properties.userData	string	UserData para la máquina virtual, que debe estar codificada en base 64. El cliente no debe pasar ningún secreto aquí. Versión mínima de api: 2021-03-01
properties.vmId	string	Identificador único de máquina virtual de Azure.
resources	VirtualMachineExtension[]	Recursos de extensión secundaria de máquina virtual.
sku	Sku	SKU de máquina virtual.
tags	object	Etiquetas de recursos
type	string	Tipo de recurso
zones	string[]	Zonas de máquina virtual.

VirtualMachineScaleSetVMInstanceView

Vista de instancia de máquina virtual.

Nombre	Tipo	Description
assignedHost	string	Identificador de recurso del host dedicado, en el que se asigna la máquina virtual a través de la colocación automática, cuando la máquina virtual está asociada a un grupo host dedicado que tiene habilitada la selección de ubicación automática. Versión mínima de api: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	El diagnóstico de arranque es una característica de depuración que permite ver la salida de la consola y la captura de pantalla para diagnosticar el estado de la máquina virtual. Puede ver fácilmente la salida del registro de consola. Azure también le permite ver una captura de pantalla de la máquina virtual desde el hipervisor.
computerName	string	Especifica el nombre del sistema operativo host de la máquina virtual. Este nombre no se puede actualizar después de crear la máquina virtual. longitud máxima (Windows): 15 caracteres longitud máxima (Linux): 64 caracteres. Para conocer las convenciones de nomenclatura y las restricciones, consulte directrices de implementación de servicios de infraestructura de Azure.
disks	DiskInstanceView[]	La información de los discos.
extensions	VirtualMachineExtensionInstanceView[]	La información de extensiones.
hyperVGeneration	HyperVGeneration	Generación del hipervisor de la máquina virtual [V1, V2]
maintenanceRedeployStatus	MaintenanceRedeployStatus	Estado de la operación de mantenimiento en la máquina virtual.
osName	string	Sistema operativo que se ejecuta en la máquina híbrida.
osVersion	string	La versión del sistema operativo que se ejecuta en la máquina híbrida.
placementGroupId	string	Grupo de selección de ubicación en el que se ejecuta la máquina virtual. Si la máquina virtual está desasignada, no tendrá un placementGroupId.
platformFaultDomain	integer	Recuento de dominios de error.
platformUpdateDomain	integer	Recuento de dominios de actualización.
rdpThumbPrint	string	Huella digital del certificado de Escritorio remoto.
statuses	InstanceViewStatus[]	Información de estado del recurso.
vmAgent	VirtualMachineAgentInstanceView	Agente de máquina virtual que se ejecuta en la máquina virtual.
vmHealth	VirtualMachineHealthStatus	Estado de mantenimiento de la máquina virtual.

VirtualMachineScaleSetVMNetworkProfileConfiguration

Especifica la configuración del perfil de red de la máquina virtual.

Nombre	Tipo	Description
networkInterfaceConfigurations	VirtualMachineScaleSetNetworkConfiguration[]	Lista de configuraciones de red.

VirtualMachineScaleSetVMProtectionPolicy

Especifica la directiva de protección de la máquina virtual.

Nombre	Tipo	Description
protectFromScaleIn	boolean	Indica que la máquina virtual del conjunto de escalado de máquinas virtuales no debe considerarse para su eliminación durante una operación de reducción horizontal.
protectFromScaleSetActions	boolean	Indica que las actualizaciones o acciones del modelo (incluido el escalado) iniciados en el conjunto de escalado de máquinas virtuales no se deben aplicar a la máquina virtual del conjunto de escalado de máquinas virtuales.

VirtualMachineSizeTypes

Especifica el tamaño de la máquina virtual. El tipo de datos de enumeración está actualmente en desuso y se quitará el 23 de diciembre de 2023. La manera recomendada de obtener la lista de tamaños disponibles es usar estas API: Enumerar todos los tamaños de máquina virtual disponibles en un conjunto de disponibilidad, Enumerar todos los tamaños de máquina virtual disponibles en una región, Enumerar todos los tamaños de máquina virtual disponibles para cambiar el tamaño. Para obtener más información sobre los tamaños de máquina virtual, consulte tamaños de para máquinas virtuales. Los tamaños de máquina virtual disponibles dependen de la región y el conjunto de disponibilidad.

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

VMDiskSecurityProfile

Especifica el perfil de seguridad del disco administrado.

Nombre	Tipo	Description
diskEncryptionSet	DiskEncryptionSetParameters	Especifica el identificador de recurso del conjunto de cifrado de disco administrado del cliente para el disco administrado que se usa para el disco de sistema operativo ConfidentialVM cifrado con clave administrada por el cliente y el blob vmGuest.
securityEncryptionType	securityEncryptionTypes	Especifica encryptionType del disco administrado. Se establece en DiskWithVMGuestState para el cifrado del disco administrado junto con el blob VMGuestState, VMGuestStateOnly para el cifrado de solo el blob VMGuestState y NonPersistedTPM para no conservar el estado de firmware en el blob VMGuestState. Nota: Solo se puede establecer para máquinas virtuales confidenciales.

VMSizeProperties

Especifica las propiedades para personalizar el tamaño de la máquina virtual. Versión mínima de api: 2021-07-01. Esta característica sigue en modo de vista previa y no se admite para VirtualMachineScaleSet. Siga las instrucciones de personalización de máquina virtual para obtener más información.

Nombre	Tipo	Description
vCPUsAvailable	integer	Especifica el número de vCPU disponibles para la máquina virtual. Cuando esta propiedad no se especifica en el cuerpo de la solicitud, el comportamiento predeterminado es establecerlo en el valor de las vCPU disponibles para ese tamaño de máquina virtual expuesto en la respuesta de api de Enumerar todos los tamaños de máquina virtual disponibles en una región.
vCPUsPerCore	integer	Especifica la relación de núcleos físicos de vCPU. Cuando esta propiedad no se especifica en el cuerpo de la solicitud, el comportamiento predeterminado se establece en el valor de vCPUsPerCore para el tamaño de máquina virtual expuesto en la respuesta de api de Enumerar todos los tamaños de máquina virtual disponibles en una región. Establecer esta propiedad en 1 también significa que el hyper-threading está deshabilitado.

WindowsConfiguration

Especifica la configuración del sistema operativo Windows en la máquina virtual.

Nombre	Tipo	Description
additionalUnattendContent	AdditionalUnattendContent[]	Especifica información con formato XML codificado en base 64 adicional que se puede incluir en el archivo Unattend.xml, que usa el programa de instalación de Windows.
enableAutomaticUpdates	boolean	Indica si las actualizaciones automáticas están habilitadas para la máquina virtual Windows. El valor predeterminado es true. En el caso de los conjuntos de escalado de máquinas virtuales, esta propiedad se puede actualizar y las actualizaciones surtirán efecto en el reaprovisionamiento del sistema operativo.
enableVMAgentPlatformUpdates	boolean	Indica si las actualizaciones de la plataforma VMAgent están habilitadas para la máquina virtual Windows.
patchSettings	PatchSettings	[Característica de vista previa] Especifica la configuración relacionada con la aplicación de revisiones de invitado de máquina virtual en Windows.
provisionVMAgent	boolean	Indica si se debe aprovisionar el agente de máquina virtual en la máquina virtual. Cuando esta propiedad no se especifica en el cuerpo de la solicitud, se establece en true de forma predeterminada. Esto garantizará que el agente de máquina virtual esté instalado en la máquina virtual para que las extensiones se puedan agregar a la máquina virtual más adelante.
timeZone	string	Especifica la zona horaria de la máquina virtual. Por ejemplo, "Hora estándar del Pacífico". Los valores posibles se pueden TimeZoneInfo.Id valor de las zonas horarias devueltas por TimeZoneInfo.GetSystemTimeZones.
winRM	WinRMConfiguration	Especifica los agentes de escucha de administración remota de Windows. Esto habilita Windows PowerShell remoto.

WindowsPatchAssessmentMode

Especifica el modo de evaluación de revisiones de invitado de máquina virtual para la máquina virtual IaaS.

Los valores posibles son:

ImageDefault: controla el tiempo de las evaluaciones de revisiones en una máquina virtual.

AutomaticByPlatform: la plataforma desencadenará evaluaciones periódicas de revisiones. La propiedad provisionVMAgent debe ser true.

Nombre	Tipo	Description
AutomaticByPlatform	string
ImageDefault	string

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Especifica la configuración de reinicio para todas las operaciones de instalación de revisiones AutomaticByPlatform.

Nombre	Tipo	Description
Always	string
IfRequired	string
Never	string
Unknown	string

WindowsVMGuestPatchAutomaticByPlatformSettings

Especifica la configuración adicional para el modo de revisión AutomaticByPlatform en la aplicación de revisiones de invitado de máquina virtual en Windows.

Nombre	Tipo	Description
bypassPlatformSafetyChecksOnUserSchedule	boolean	Permite al cliente programar la aplicación de revisiones sin actualizaciones accidentales
rebootSetting	WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Especifica la configuración de reinicio para todas las operaciones de instalación de revisiones AutomaticByPlatform.

WindowsVMGuestPatchMode

Especifica el modo de aplicación de revisiones de invitado de máquina virtual a máquinas virtuales iaaS o máquinas virtuales asociadas al conjunto de escalado de máquinas virtuales con OrchestrationMode como flexible.

Los valores posibles son:

Manual: controla la aplicación de revisiones en una máquina virtual. Para ello, aplique revisiones manualmente dentro de la máquina virtual. En este modo, las actualizaciones automáticas están deshabilitadas; La propiedad WindowsConfiguration.enableAutomaticUpdates debe ser false

AutomaticByOS: el sistema operativo actualizará automáticamente la máquina virtual. La propiedad WindowsConfiguration.enableAutomaticUpdates debe ser true.

AutomaticByPlatform: la máquina virtual actualizará automáticamente la plataforma. Las propiedades provisionVMAgent y WindowsConfiguration.enableAutomaticUpdates deben ser true.

Nombre	Tipo	Description
AutomaticByOS	string
AutomaticByPlatform	string
Manual	string

WinRMConfiguration

Especifica los agentes de escucha de administración remota de Windows. Esto habilita Windows PowerShell remoto.

Nombre	Tipo	Description
listeners	WinRMListener[]	Lista de agentes de escucha de administración remota de Windows

WinRMListener

Lista de agentes de escucha de administración remota de Windows

Nombre	Tipo	Description
certificateUrl	string	Esta es la dirección URL de un certificado que se ha cargado en Key Vault como secreto. Para agregar un secreto a Key Vault, consulte Agregar una clave o un secreto al almacén de claves. En este caso, el certificado debe ser la codificación Base64 del siguiente objeto JSON que se codifica en UTF-8: { "data":"", "dataType":"pfx", "password":"" } Para instalar certificados en una máquina virtual, se recomienda usar la extensión de máquina virtual de Azure Key Vault de para Linux o la extensión de máquina virtual de Azure Key Vault de para Windows.
protocol	ProtocolTypes	Especifica el protocolo del agente de escucha winRM. Los valores posibles son: http,https.