Virtual Machine Scale Set VMs - Get

Служба:: Compute

Версия API:: 2024-11-01

Получает виртуальную машину из масштабируемого набора виртуальных машин.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
instanceId	path	True	string	Идентификатор экземпляра виртуальной машины.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не зависит от регистра.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
vmScaleSetName	path	True	string	Имя масштабируемого набора виртуальных машин.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
$expand	query		InstanceViewTypes	Выражение расширения, применяемое к операции. InstanceView извлекает представление экземпляра виртуальной машины. UserData извлекает UserData виртуальной машины.

Ответы

Имя	Тип	Описание
200 OK	VirtualMachineScaleSetVM	Операция Azure успешно завершена.
Other Status Codes	CloudError	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Get VM scale set VM with ResiliencyView

Get VM scale set VM with UserData

Get VM scale set VM with VMSizeProperties

Get VM scale set VM with ResiliencyView

Образец запроса

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


/**
 * Samples for VirtualMachineScaleSetVMs Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithResilientVMDeletionStatus.json
     */
    /**
     * Sample code: Get VM scale set VM with ResiliencyView.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getVMScaleSetVMWithResiliencyView(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSetVMs()
            .getWithResponse("myResourceGroup", "{vmss-name}", "1", null, com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_scale_set_vm_get_with_resilient_vm_deletion_status.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.virtual_machine_scale_set_vms.get(
        resource_group_name="myResourceGroup",
        vm_scale_set_name="{vmss-name}",
        instance_id="1",
    )
    print(response)


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

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

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4517f89a8ebd2f6a94e107e5ee60fff9886f3612/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithResilientVMDeletionStatus.json
func ExampleVirtualMachineScaleSetVMsClient_Get_getVmScaleSetVmWithResiliencyView() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVirtualMachineScaleSetVMsClient().Get(ctx, "myResourceGroup", "{vmss-name}", "1", &armcompute.VirtualMachineScaleSetVMsClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.VirtualMachineScaleSetVM = armcompute.VirtualMachineScaleSetVM{
	// 	Name: to.Ptr("{vmss-vm-name}"),
	// 	Type: to.Ptr("Microsoft.Compute/virtualMachineScaleSets/virtualMachines"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/1"),
	// 	Location: to.Ptr("eastus2euap"),
	// 	Etag: to.Ptr("\"3\""),
	// 	Identity: &armcompute.VirtualMachineIdentity{
	// 		Type: to.Ptr(armcompute.ResourceIdentityTypeUserAssigned),
	// 		UserAssignedIdentities: map[string]*armcompute.UserAssignedIdentitiesValue{
	// 			"/subscriptions/{subscription-id}/resourceGroups/AzSecPackAutoConfigRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/AzSecPackAutoConfigUA-eastus2euap": &armcompute.UserAssignedIdentitiesValue{
	// 				ClientID: to.Ptr("215414c9-8a82-4439-95ea-d09e3543a6e2"),
	// 				PrincipalID: to.Ptr("f31e5089-a1e5-44a6-9048-a767ce07d26c"),
	// 			},
	// 		},
	// 	},
	// 	InstanceID: to.Ptr("1"),
	// 	Properties: &armcompute.VirtualMachineScaleSetVMProperties{
	// 		DiagnosticsProfile: &armcompute.DiagnosticsProfile{
	// 			BootDiagnostics: &armcompute.BootDiagnostics{
	// 				Enabled: to.Ptr(true),
	// 			},
	// 		},
	// 		HardwareProfile: &armcompute.HardwareProfile{
	// 			VMSize: to.Ptr(armcompute.VirtualMachineSizeTypes("Standard_D2ls_v5")),
	// 		},
	// 		LatestModelApplied: to.Ptr(true),
	// 		ModelDefinitionApplied: to.Ptr("VirtualMachineScaleSet"),
	// 		NetworkProfile: &armcompute.NetworkProfile{
	// 			NetworkInterfaces: []*armcompute.NetworkInterfaceReference{
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/1/networkInterfaces/vnet-eastus2euap-2-nic01"),
	// 			}},
	// 		},
	// 		NetworkProfileConfiguration: &armcompute.VirtualMachineScaleSetVMNetworkProfileConfiguration{
	// 			NetworkInterfaceConfigurations: []*armcompute.VirtualMachineScaleSetNetworkConfiguration{
	// 				{
	// 					Name: to.Ptr("vnet-eastus2euap-2-nic01"),
	// 					Properties: &armcompute.VirtualMachineScaleSetNetworkConfigurationProperties{
	// 						DisableTCPStateTracking: to.Ptr(false),
	// 						DNSSettings: &armcompute.VirtualMachineScaleSetNetworkConfigurationDNSSettings{
	// 							DNSServers: []*string{
	// 							},
	// 						},
	// 						EnableAcceleratedNetworking: to.Ptr(true),
	// 						EnableIPForwarding: to.Ptr(false),
	// 						IPConfigurations: []*armcompute.VirtualMachineScaleSetIPConfiguration{
	// 							{
	// 								Name: to.Ptr("vnet-eastus2euap-2-nic01-defaultIpConfiguration"),
	// 								Properties: &armcompute.VirtualMachineScaleSetIPConfigurationProperties{
	// 									Primary: to.Ptr(true),
	// 									PrivateIPAddressVersion: to.Ptr(armcompute.IPVersionIPv4),
	// 									Subnet: &armcompute.APIEntityReference{
	// 										ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet-eastus2euap-2/subnets/snet-eastus2euap-1"),
	// 									},
	// 								},
	// 						}},
	// 						NetworkSecurityGroup: &armcompute.SubResource{
	// 							ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/basicNsgvnet-eastus2euap-2-nic01"),
	// 						},
	// 						Primary: to.Ptr(true),
	// 					},
	// 			}},
	// 		},
	// 		OSProfile: &armcompute.OSProfile{
	// 			AdminUsername: to.Ptr("SomeRandomUser"),
	// 			AllowExtensionOperations: to.Ptr(true),
	// 			ComputerName: to.Ptr("statustes000001"),
	// 			LinuxConfiguration: &armcompute.LinuxConfiguration{
	// 				DisablePasswordAuthentication: to.Ptr(false),
	// 				EnableVMAgentPlatformUpdates: to.Ptr(true),
	// 				PatchSettings: &armcompute.LinuxPatchSettings{
	// 					AssessmentMode: to.Ptr(armcompute.LinuxPatchAssessmentModeImageDefault),
	// 					PatchMode: to.Ptr(armcompute.LinuxVMGuestPatchModeImageDefault),
	// 				},
	// 				ProvisionVMAgent: to.Ptr(true),
	// 			},
	// 			RequireGuestProvisionSignal: to.Ptr(true),
	// 			Secrets: []*armcompute.VaultSecretGroup{
	// 			},
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		ResilientVMDeletionStatus: to.Ptr(armcompute.ResilientVMDeletionStatusEnabled),
	// 		SecurityProfile: &armcompute.SecurityProfile{
	// 			SecurityType: to.Ptr(armcompute.SecurityTypesTrustedLaunch),
	// 			UefiSettings: &armcompute.UefiSettings{
	// 				SecureBootEnabled: to.Ptr(true),
	// 				VTpmEnabled: to.Ptr(true),
	// 			},
	// 		},
	// 		StorageProfile: &armcompute.StorageProfile{
	// 			DataDisks: []*armcompute.DataDisk{
	// 			},
	// 			DiskControllerType: to.Ptr(armcompute.DiskControllerTypesSCSI),
	// 			ImageReference: &armcompute.ImageReference{
	// 				ExactVersion: to.Ptr("20.04.202501110"),
	// 				Offer: to.Ptr("0001-com-ubuntu-server-focal"),
	// 				Publisher: to.Ptr("canonical"),
	// 				SKU: to.Ptr("20_04-lts-gen2"),
	// 				Version: to.Ptr("latest"),
	// 			},
	// 			OSDisk: &armcompute.OSDisk{
	// 				Name: to.Ptr("{vmss-name}_{vmss-vm-name}_OsDisk_1_8e93ddcf18be4b0f9815910b3a0f8182"),
	// 				Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 				CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesFromImage),
	// 				DiskSizeGB: to.Ptr[int32](30),
	// 				ManagedDisk: &armcompute.ManagedDiskParameters{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/{vmss-name}_{vmss-vm-name}_OsDisk_1_8e93ddcf18be4b0f9815910b3a0f8182"),
	// 					StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 				},
	// 				OSType: to.Ptr(armcompute.OperatingSystemTypesLinux),
	// 			},
	// 		},
	// 		TimeCreated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-02-05T20:11:32.572Z"); return t}()),
	// 		VMID: to.Ptr("eb282db2-12d4-4fc6-8bd5-0c6473a4078c"),
	// 	},
	// 	Resources: []*armcompute.VirtualMachineExtension{
	// 		{
	// 			Name: to.Ptr("Microsoft.Azure.Security.Monitoring.AzureSecurityLinuxAgent"),
	// 			Type: to.Ptr("Microsoft.Compute/virtualMachines/extensions"),
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/{vmss-vm-name}/extensions/Microsoft.Azure.Security.Monitoring.AzureSecurityLinuxAgent"),
	// 			Location: to.Ptr("eastus2euap"),
	// 			Properties: &armcompute.VirtualMachineExtensionProperties{
	// 				Type: to.Ptr("AzureSecurityLinuxAgent"),
	// 				AutoUpgradeMinorVersion: to.Ptr(true),
	// 				EnableAutomaticUpgrade: to.Ptr(true),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				Publisher: to.Ptr("Microsoft.Azure.Security.Monitoring"),
	// 				Settings: map[string]any{
	// 					"enableAutoConfig": true,
	// 					"enableGenevaUpload": true,
	// 					"reportSuccessOnUnsupportedDistro": true,
	// 				},
	// 				TypeHandlerVersion: to.Ptr("2.0"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.Azure.Monitor.AzureMonitorLinuxAgent"),
	// 			Type: to.Ptr("Microsoft.Compute/virtualMachines/extensions"),
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/{vmss-vm-name}/extensions/Microsoft.Azure.Monitor.AzureMonitorLinuxAgent"),
	// 			Location: to.Ptr("eastus2euap"),
	// 			Properties: &armcompute.VirtualMachineExtensionProperties{
	// 				Type: to.Ptr("AzureMonitorLinuxAgent"),
	// 				AutoUpgradeMinorVersion: to.Ptr(true),
	// 				EnableAutomaticUpgrade: to.Ptr(true),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				Publisher: to.Ptr("Microsoft.Azure.Monitor"),
	// 				Settings: map[string]any{
	// 					"GCS_AUTO_CONFIG": true,
	// 				},
	// 				TypeHandlerVersion: to.Ptr("1.0"),
	// 			},
	// 	}},
	// 	SKU: &armcompute.SKU{
	// 		Name: to.Ptr("Standard_D2ls_v5"),
	// 		Tier: to.Ptr("Standard"),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Gets a virtual machine from a VM scale set.
 *
 * @summary Gets a virtual machine from a VM scale set.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithResilientVMDeletionStatus.json
 */
async function getVMScaleSetVMWithResiliencyView() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmScaleSetName = "{vmss-name}";
  const instanceId = "1";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSetVMs.get(
    resourceGroupName,
    vmScaleSetName,
    instanceId,
  );
  console.log(result);
}

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithResilientVMDeletionStatus.json
// this example is just showing the usage of "VirtualMachineScaleSetVMs_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this VirtualMachineScaleSetVmResource created on azure
// for more information of creating VirtualMachineScaleSetVmResource, please refer to the document of VirtualMachineScaleSetVmResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "{vmss-name}";
string instanceId = "1";
ResourceIdentifier virtualMachineScaleSetVmResourceId = VirtualMachineScaleSetVmResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName, instanceId);
VirtualMachineScaleSetVmResource virtualMachineScaleSetVm = client.GetVirtualMachineScaleSetVmResource(virtualMachineScaleSetVmResourceId);

// invoke the operation
VirtualMachineScaleSetVmResource result = await virtualMachineScaleSetVm.GetAsync();

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

Пример ответа

Код состояния:: 200

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

Get VM scale set VM with UserData

Образец запроса

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


/**
 * Samples for VirtualMachineScaleSetVMs Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithUserData.json
     */
    /**
     * Sample code: Get VM scale set VM with UserData.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getVMScaleSetVMWithUserData(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSetVMs()
            .getWithResponse("myResourceGroup", "{vmss-name}", "0", null, com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_scale_set_vm_get_with_user_data.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.virtual_machine_scale_set_vms.get(
        resource_group_name="myResourceGroup",
        vm_scale_set_name="{vmss-name}",
        instance_id="0",
    )
    print(response)


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

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

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4517f89a8ebd2f6a94e107e5ee60fff9886f3612/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithUserData.json
func ExampleVirtualMachineScaleSetVMsClient_Get_getVmScaleSetVmWithUserData() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVirtualMachineScaleSetVMsClient().Get(ctx, "myResourceGroup", "{vmss-name}", "0", &armcompute.VirtualMachineScaleSetVMsClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.VirtualMachineScaleSetVM = armcompute.VirtualMachineScaleSetVM{
	// 	Name: to.Ptr("{vmss-vm-name}"),
	// 	Type: to.Ptr("Microsoft.Compute/virtualMachines"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"myTag1": to.Ptr("tagValue1"),
	// 	},
	// 	Etag: to.Ptr("\"1\""),
	// 	Properties: &armcompute.VirtualMachineScaleSetVMProperties{
	// 		DiagnosticsProfile: &armcompute.DiagnosticsProfile{
	// 			BootDiagnostics: &armcompute.BootDiagnostics{
	// 				Enabled: to.Ptr(true),
	// 			},
	// 		},
	// 		HardwareProfile: &armcompute.HardwareProfile{
	// 		},
	// 		LatestModelApplied: to.Ptr(true),
	// 		ModelDefinitionApplied: to.Ptr("VirtualMachineScaleSet"),
	// 		NetworkProfile: &armcompute.NetworkProfile{
	// 			NetworkInterfaces: []*armcompute.NetworkInterfaceReference{
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415"),
	// 			}},
	// 		},
	// 		NetworkProfileConfiguration: &armcompute.VirtualMachineScaleSetVMNetworkProfileConfiguration{
	// 			NetworkInterfaceConfigurations: []*armcompute.VirtualMachineScaleSetNetworkConfiguration{
	// 				{
	// 					Name: to.Ptr("vmsstestnetconfig5415"),
	// 					Properties: &armcompute.VirtualMachineScaleSetNetworkConfigurationProperties{
	// 						DNSSettings: &armcompute.VirtualMachineScaleSetNetworkConfigurationDNSSettings{
	// 							DNSServers: []*string{
	// 							},
	// 						},
	// 						EnableAcceleratedNetworking: to.Ptr(false),
	// 						EnableIPForwarding: to.Ptr(false),
	// 						IPConfigurations: []*armcompute.VirtualMachineScaleSetIPConfiguration{
	// 							{
	// 								Name: to.Ptr("vmsstestnetconfig9693"),
	// 								Properties: &armcompute.VirtualMachineScaleSetIPConfigurationProperties{
	// 									PrivateIPAddressVersion: to.Ptr(armcompute.IPVersionIPv4),
	// 									Subnet: &armcompute.APIEntityReference{
	// 										ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503"),
	// 									},
	// 								},
	// 						}},
	// 						Primary: to.Ptr(true),
	// 					},
	// 			}},
	// 		},
	// 		OSProfile: &armcompute.OSProfile{
	// 			AdminUsername: to.Ptr("Foo12"),
	// 			AllowExtensionOperations: to.Ptr(true),
	// 			ComputerName: to.Ptr("test000000"),
	// 			RequireGuestProvisionSignal: to.Ptr(true),
	// 			Secrets: []*armcompute.VaultSecretGroup{
	// 			},
	// 			WindowsConfiguration: &armcompute.WindowsConfiguration{
	// 				EnableAutomaticUpdates: to.Ptr(true),
	// 				ProvisionVMAgent: to.Ptr(true),
	// 			},
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		StorageProfile: &armcompute.StorageProfile{
	// 			DataDisks: []*armcompute.DataDisk{
	// 				{
	// 					Name: to.Ptr("vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
	// 					Caching: to.Ptr(armcompute.CachingTypesNone),
	// 					CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesEmpty),
	// 					DiskSizeGB: to.Ptr[int32](128),
	// 					Lun: to.Ptr[int32](1),
	// 					ManagedDisk: &armcompute.ManagedDiskParameters{
	// 						ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesStandardLRS),
	// 					},
	// 					ToBeDetached: to.Ptr(false),
	// 			}},
	// 			ImageReference: &armcompute.ImageReference{
	// 				ExactVersion: to.Ptr("4.127.20180315"),
	// 				Offer: to.Ptr("WindowsServer"),
	// 				Publisher: to.Ptr("MicrosoftWindowsServer"),
	// 				SKU: to.Ptr("2012-R2-Datacenter"),
	// 				Version: to.Ptr("4.127.20180315"),
	// 			},
	// 			OSDisk: &armcompute.OSDisk{
	// 				Name: to.Ptr("vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc"),
	// 				Caching: to.Ptr(armcompute.CachingTypesNone),
	// 				CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesFromImage),
	// 				DiskSizeGB: to.Ptr[int32](127),
	// 				ManagedDisk: &armcompute.ManagedDiskParameters{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc"),
	// 					StorageAccountType: to.Ptr(armcompute.StorageAccountTypesStandardLRS),
	// 				},
	// 				OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 			},
	// 		},
	// 		UserData: to.Ptr("RXhhbXBsZSBVc2VyRGF0YQ=="),
	// 		VMID: to.Ptr("42af9fdf-b906-4ad7-9905-8316209ff619"),
	// 	},
	// 	Resources: []*armcompute.VirtualMachineExtension{
	// 		{
	// 			Name: to.Ptr("CustomScriptExtension-DSC"),
	// 			Type: to.Ptr("Microsoft.Compute/virtualMachines/extensions"),
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC"),
	// 			Location: to.Ptr("westus"),
	// 			Tags: map[string]*string{
	// 				"displayName": to.Ptr("CustomScriptExtension-DSC"),
	// 			},
	// 			Properties: &armcompute.VirtualMachineExtensionProperties{
	// 				Type: to.Ptr("CustomScriptExtension"),
	// 				AutoUpgradeMinorVersion: to.Ptr(true),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				Publisher: to.Ptr("Microsoft.Compute"),
	// 				Settings: map[string]any{
	// 				},
	// 				TypeHandlerVersion: to.Ptr("1.9"),
	// 			},
	// 	}},
	// }
}

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

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

/**
 * This sample demonstrates how to Gets a virtual machine from a VM scale set.
 *
 * @summary Gets a virtual machine from a VM scale set.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithUserData.json
 */
async function getVMScaleSetVMWithUserData() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmScaleSetName = "{vmss-name}";
  const instanceId = "0";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSetVMs.get(
    resourceGroupName,
    vmScaleSetName,
    instanceId,
  );
  console.log(result);
}

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-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 VirtualMachineScaleSetVmResource created on azure
// for more information of creating VirtualMachineScaleSetVmResource, please refer to the document of VirtualMachineScaleSetVmResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "{vmss-name}";
string instanceId = "0";
ResourceIdentifier virtualMachineScaleSetVmResourceId = VirtualMachineScaleSetVmResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName, instanceId);
VirtualMachineScaleSetVmResource virtualMachineScaleSetVm = client.GetVirtualMachineScaleSetVmResource(virtualMachineScaleSetVmResourceId);

// invoke the operation
VirtualMachineScaleSetVmResource result = await virtualMachineScaleSetVm.GetAsync();

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

Пример ответа

Код состояния:: 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

Образец запроса

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


/**
 * Samples for VirtualMachineScaleSetVMs Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithVMSizeProperties.json
     */
    /**
     * Sample code: Get VM scale set VM with VMSizeProperties.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getVMScaleSetVMWithVMSizeProperties(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSetVMs()
            .getWithResponse("myResourceGroup", "{vmss-name}", "0", null, com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_scale_set_vm_get_with_vm_size_properties.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.virtual_machine_scale_set_vms.get(
        resource_group_name="myResourceGroup",
        vm_scale_set_name="{vmss-name}",
        instance_id="0",
    )
    print(response)


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

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

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4517f89a8ebd2f6a94e107e5ee60fff9886f3612/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithVMSizeProperties.json
func ExampleVirtualMachineScaleSetVMsClient_Get_getVmScaleSetVmWithVmSizeProperties() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVirtualMachineScaleSetVMsClient().Get(ctx, "myResourceGroup", "{vmss-name}", "0", &armcompute.VirtualMachineScaleSetVMsClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.VirtualMachineScaleSetVM = armcompute.VirtualMachineScaleSetVM{
	// 	Name: to.Ptr("{vmss-vm-name}"),
	// 	Type: to.Ptr("Microsoft.Compute/virtualMachines"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"myTag1": to.Ptr("tagValue1"),
	// 	},
	// 	Etag: to.Ptr("\"1\""),
	// 	Properties: &armcompute.VirtualMachineScaleSetVMProperties{
	// 		DiagnosticsProfile: &armcompute.DiagnosticsProfile{
	// 			BootDiagnostics: &armcompute.BootDiagnostics{
	// 				Enabled: to.Ptr(true),
	// 			},
	// 		},
	// 		HardwareProfile: &armcompute.HardwareProfile{
	// 			VMSizeProperties: &armcompute.VMSizeProperties{
	// 				VCPUsAvailable: to.Ptr[int32](1),
	// 				VCPUsPerCore: to.Ptr[int32](1),
	// 			},
	// 		},
	// 		LatestModelApplied: to.Ptr(true),
	// 		ModelDefinitionApplied: to.Ptr("VirtualMachineScaleSet"),
	// 		NetworkProfile: &armcompute.NetworkProfile{
	// 			NetworkInterfaces: []*armcompute.NetworkInterfaceReference{
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415"),
	// 			}},
	// 		},
	// 		NetworkProfileConfiguration: &armcompute.VirtualMachineScaleSetVMNetworkProfileConfiguration{
	// 			NetworkInterfaceConfigurations: []*armcompute.VirtualMachineScaleSetNetworkConfiguration{
	// 				{
	// 					Name: to.Ptr("vmsstestnetconfig5415"),
	// 					Properties: &armcompute.VirtualMachineScaleSetNetworkConfigurationProperties{
	// 						DNSSettings: &armcompute.VirtualMachineScaleSetNetworkConfigurationDNSSettings{
	// 							DNSServers: []*string{
	// 							},
	// 						},
	// 						EnableAcceleratedNetworking: to.Ptr(false),
	// 						EnableIPForwarding: to.Ptr(false),
	// 						IPConfigurations: []*armcompute.VirtualMachineScaleSetIPConfiguration{
	// 							{
	// 								Name: to.Ptr("vmsstestnetconfig9693"),
	// 								Properties: &armcompute.VirtualMachineScaleSetIPConfigurationProperties{
	// 									PrivateIPAddressVersion: to.Ptr(armcompute.IPVersionIPv4),
	// 									Subnet: &armcompute.APIEntityReference{
	// 										ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503"),
	// 									},
	// 								},
	// 						}},
	// 						Primary: to.Ptr(true),
	// 					},
	// 			}},
	// 		},
	// 		OSProfile: &armcompute.OSProfile{
	// 			AdminUsername: to.Ptr("Foo12"),
	// 			AllowExtensionOperations: to.Ptr(true),
	// 			ComputerName: to.Ptr("test000000"),
	// 			RequireGuestProvisionSignal: to.Ptr(true),
	// 			Secrets: []*armcompute.VaultSecretGroup{
	// 			},
	// 			WindowsConfiguration: &armcompute.WindowsConfiguration{
	// 				EnableAutomaticUpdates: to.Ptr(true),
	// 				ProvisionVMAgent: to.Ptr(true),
	// 			},
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		StorageProfile: &armcompute.StorageProfile{
	// 			DataDisks: []*armcompute.DataDisk{
	// 				{
	// 					Name: to.Ptr("vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
	// 					Caching: to.Ptr(armcompute.CachingTypesNone),
	// 					CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesEmpty),
	// 					DiskSizeGB: to.Ptr[int32](128),
	// 					Lun: to.Ptr[int32](1),
	// 					ManagedDisk: &armcompute.ManagedDiskParameters{
	// 						ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesStandardLRS),
	// 					},
	// 					ToBeDetached: to.Ptr(false),
	// 			}},
	// 			ImageReference: &armcompute.ImageReference{
	// 				ExactVersion: to.Ptr("4.127.20180315"),
	// 				Offer: to.Ptr("WindowsServer"),
	// 				Publisher: to.Ptr("MicrosoftWindowsServer"),
	// 				SKU: to.Ptr("2012-R2-Datacenter"),
	// 				Version: to.Ptr("4.127.20180315"),
	// 			},
	// 			OSDisk: &armcompute.OSDisk{
	// 				Name: to.Ptr("vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc"),
	// 				Caching: to.Ptr(armcompute.CachingTypesNone),
	// 				CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesFromImage),
	// 				DiskSizeGB: to.Ptr[int32](127),
	// 				ManagedDisk: &armcompute.ManagedDiskParameters{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc"),
	// 					StorageAccountType: to.Ptr(armcompute.StorageAccountTypesStandardLRS),
	// 				},
	// 				OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 			},
	// 		},
	// 		UserData: to.Ptr("RXhhbXBsZSBVc2VyRGF0YQ=="),
	// 		VMID: to.Ptr("42af9fdf-b906-4ad7-9905-8316209ff619"),
	// 	},
	// 	Resources: []*armcompute.VirtualMachineExtension{
	// 		{
	// 			Name: to.Ptr("CustomScriptExtension-DSC"),
	// 			Type: to.Ptr("Microsoft.Compute/virtualMachines/extensions"),
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC"),
	// 			Location: to.Ptr("westus"),
	// 			Tags: map[string]*string{
	// 				"displayName": to.Ptr("CustomScriptExtension-DSC"),
	// 			},
	// 			Properties: &armcompute.VirtualMachineExtensionProperties{
	// 				Type: to.Ptr("CustomScriptExtension"),
	// 				AutoUpgradeMinorVersion: to.Ptr(true),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				Publisher: to.Ptr("Microsoft.Compute"),
	// 				Settings: map[string]any{
	// 				},
	// 				TypeHandlerVersion: to.Ptr("1.9"),
	// 			},
	// 	}},
	// }
}

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

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

/**
 * This sample demonstrates how to Gets a virtual machine from a VM scale set.
 *
 * @summary Gets a virtual machine from a VM scale set.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithVMSizeProperties.json
 */
async function getVMScaleSetVMWithVMSizeProperties() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmScaleSetName = "{vmss-name}";
  const instanceId = "0";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSetVMs.get(
    resourceGroupName,
    vmScaleSetName,
    instanceId,
  );
  console.log(result);
}

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-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 VirtualMachineScaleSetVmResource created on azure
// for more information of creating VirtualMachineScaleSetVmResource, please refer to the document of VirtualMachineScaleSetVmResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "{vmss-name}";
string instanceId = "0";
ResourceIdentifier virtualMachineScaleSetVmResourceId = VirtualMachineScaleSetVmResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName, instanceId);
VirtualMachineScaleSetVmResource virtualMachineScaleSetVm = client.GetVirtualMachineScaleSetVmResource(virtualMachineScaleSetVmResourceId);

// invoke the operation
VirtualMachineScaleSetVmResource result = await virtualMachineScaleSetVm.GetAsync();

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

Пример ответа

Код состояния:: 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": {}
      }
    }
  ]
}

Определения

Имя	Описание
AdditionalCapabilities	Включает или отключает возможность на виртуальной машине или масштабируемом наборе виртуальных машин.
AdditionalUnattendContent	Указывает дополнительные xml-форматированные сведения, которые можно включить в файл Unattend.xml, который используется программой установки Windows. Содержимое определяется по имени, имени компонента и передаче, в которой применяется содержимое.
ApiEntityReference	Справочник по сущностям API.
ApiError	Ошибка API.
ApiErrorBase	База ошибок API.
BootDiagnostics	Диагностика загрузки — это функция отладки, которая позволяет просматривать выходные данные консоли и снимок экрана для диагностики состояния виртуальной машины. Вы можете легко просмотреть выходные данные журнала консоли. Azure также позволяет просмотреть снимок экрана виртуальной машины из гипервизора.
BootDiagnosticsInstanceView	Представление экземпляра диагностики загрузки виртуальной машины.
CachingTypes	Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Значения по умолчанию: Нет для хранилища уровня "Стандартный". ReadOnly для хранилища Premium
CloudError	Ответ на ошибку из службы вычислений.
ComponentNames
createdByType	Тип удостоверения, создавшего ресурс.
DataDisk	Описывает диск данных.
DeleteOptions	Укажите, что происходит с сетевым интерфейсом при удалении виртуальной машины
DiagnosticsProfile	Указывает состояние параметров диагностики загрузки. Минимальная версия API: 2015-06-15.
DiffDiskOptions	Задает параметр временного диска для диска операционной системы.
DiffDiskPlacement	Задает эфемерное размещение дисков для диска операционной системы. Это свойство можно использовать пользователем в запросе, чтобы выбрать расположение, например диск кэша, диск ресурсов или место на диске nvme для подготовки диска Эфемеральной ОС. Дополнительные сведения о требованиях к размеру диска эфемерной ОС см. в разделе "Требования к размеру диска операционной системы" для виртуальной машины Windows на https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements виртуальной машине Windows и виртуальной машине Linux.https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements Минимальная версия API для NvmeDisk: 2024-03-01.
DiffDiskSettings	Описывает параметры временных параметров диска, которые можно указать для диска операционной системы. Примечание. Параметры временного диска можно указать только для управляемого диска.
DiskControllerTypes	Указывает тип контроллера диска, настроенный для виртуальной машины и VirtualMachineScaleSet. Это свойство поддерживается только для виртуальных машин, для которых диск операционной системы и SKU виртуальной машины поддерживают поколение 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), проверьте возможность HyperVGenerations, возвращенную как часть возможностей SKU виртуальной машины в ответ api SKU Microsoft.Compute для региона содержит версию 2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list). Дополнительные сведения о поддерживаемых типах контроллеров дисков см. в https://aka.ms/azure-diskcontrollertypes.
DiskCreateOptionTypes	Указывает, как должен быть создан диск виртуальной машины. Возможные значения — подключение : это значение используется при использовании специализированного диска для создания виртуальной машины. FromImage: это значение используется при использовании образа для создания виртуальной машины. При использовании образа платформы также следует использовать элемент imageReference, описанный выше. Если вы используете образ Marketplace, вы также должны использовать элемент плана, описанный ранее. Пустое: это значение используется при создании пустого диска данных. копирование: это значение используется для создания диска данных из моментального снимка или другого диска. восстановление: это значение используется для создания диска данных из точки восстановления диска.
DiskDeleteOptionTypes	Указывает поведение управляемого диска при удалении виртуальной машины, например, удаляется или отсоединяется ли управляемый диск. Поддерживаемые значения: Delete. Если это значение используется, управляемый диск удаляется при удалении виртуальной машины. Отделять. Если это значение используется, управляемый диск сохраняется после удаления виртуальной машины. Минимальная версия API: 2021-03-01.
DiskDetachOptionTypes	Указывает поведение отсоединения, используемое при отсоединение диска или уже в процессе отсоединения от виртуальной машины. Поддерживаемые значения: ForceDetach. detachOption : ForceDetach применим только для управляемых дисков данных. Если предыдущая попытка отсоединения диска данных не завершена из-за непредвиденного сбоя виртуальной машины, а диск по-прежнему не выпущен, используйте принудительное отключение в качестве последней возможности для принудительного отключения диска от виртуальной машины. Все записи, возможно, не были удалены при использовании этого поведения отсоединения. Эта функция все еще находится на стадии предварительной версии. Чтобы принудительно отсоединить диск данных, обновите его до true вместе с параметром detachOption: ForceDetach.
DiskEncryptionSetParameters	Описывает параметр набора ресурсов набора шифрования управляемых клиентом дисков, который можно указать для диска. Примечание. идентификатор ресурса набора шифрования дисков можно указать только для управляемого диска. Дополнительные сведения см. в https://aka.ms/mdssewithcmkoverview.
DiskEncryptionSettings	Описание параметров шифрования диска
DiskInstanceView	Представление экземпляра диска.
DomainNameLabelScopeTypes	Область метки доменного имени. Объединение метки хэшированного доменного имени, созданной в соответствии с политикой из области метки доменного имени и индексом виртуальной машины, будет метками доменных имен ресурсов PublicIPAddress, которые будут созданы.
EncryptionIdentity	Указывает управляемое удостоверение, используемое ADE для получения маркера доступа для операций keyvault.
HardwareProfile	Указывает параметры оборудования для виртуальной машины.
HostEndpointSettings	Указывает определенные параметры конечной точки узла.
HyperVGeneration	Создание гипервизора виртуальной машины [V1, V2]
ImageReference	Указывает сведения об используемом изображении. Вы можете указать сведения о образах платформы, образах Marketplace или образах виртуальных машин. Этот элемент необходим, если вы хотите использовать образ платформы, образ Marketplace или образ виртуальной машины, но не используется в других операциях создания. ПРИМЕЧАНИЕ. Издатель ссылок на изображения и предложение можно задать только при создании масштабируемого набора.
InnerError	Сведения о внутренней ошибке.
InstanceViewStatus	Состояние представления экземпляра.
InstanceViewTypes
IPVersion	Доступно из Api-Version 2017-03-30, он представляет, является ли конкретная ipconfiguration IPv4 или IPv6. По умолчанию используется протокол IPv4. Возможные значения: "IPv4" и "IPv6".
IPVersions	Доступно из Api-Version 2017-03-30, он представляет, является ли конкретная ipconfiguration IPv4 или IPv6. По умолчанию используется протокол IPv4. Возможные значения: "IPv4" и "IPv6".
KeyVaultKeyReference	Описание ссылки на ключ Key Vault
KeyVaultSecretReference	Описание ссылки на секрет Key Vault
LinuxConfiguration	Указывает параметры операционной системы Linux на виртуальной машине. Список поддерживаемых дистрибутивов Linux см. в Linux в Azure-Endorsed дистрибутивах.
LinuxPatchAssessmentMode	Указывает режим оценки гостевых исправлений виртуальной машины для виртуальной машины IaaS. Возможны следующие значения: ImageDefault. Вы управляете временем оценки исправлений на виртуальной машине. AutomaticByPlatform . Платформа будет запускать периодические оценки исправлений. Свойство provisionVMAgent должно быть true.
LinuxPatchSettings	Указывает параметры, связанные с исправлением гостевой виртуальной машины в Linux.
LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform.
LinuxVMGuestPatchAutomaticByPlatformSettings	Указывает дополнительные параметры, применяемые при выборе режима исправления AutomaticByPlatform в параметрах исправлений Linux.
LinuxVMGuestPatchMode	Указывает режим гостевой исправления виртуальной машины на виртуальную машину IaaS или виртуальные машины, связанные с масштабируемым набором виртуальных машин с OrchestrationMode как гибкий. Возможны следующие значения: ImageDefault — используется конфигурация исправления по умолчанию виртуальной машины. AutomaticByPlatform. Виртуальная машина будет автоматически обновляться платформой. Свойство provisionVMAgent должно иметь значение true
MaintenanceOperationResultCodeTypes	Код результата последней операции обслуживания.
MaintenanceRedeployStatus	Состояние операции обслуживания.
ManagedDiskParameters	Параметры управляемого диска.
Mode	Указывает режим, на котором будет выполняться ProxyAgent, если эта функция включена. ProxyAgent начнет аудит или мониторинг, но не применяет управление доступом к запросам к конечным точкам узла в режиме аудита, в то время как в режиме принудительного применения будет применяться управление доступом. Значением по умолчанию является режим принудительного применения.
Modes	Указывает режим выполнения. В режиме аудита система действует так, как если бы она применяла политику управления доступом, включая выдачу записей отказа в доступе в журналах, но фактически не запрещает какие-либо запросы на размещение конечных точек. В режиме принудительного применения система будет применять управление доступом, и это рекомендуемый режим работы.
NetworkApiVersion	указывает версию API Microsoft.Network, используемую при создании сетевых ресурсов в конфигурациях сетевого интерфейса.
NetworkInterfaceAuxiliaryMode	Указывает, включен ли вспомогательный режим для ресурса сетевого интерфейса.
NetworkInterfaceAuxiliarySku	Указывает, включен ли вспомогательный номер SKU для ресурса сетевого интерфейса.
NetworkInterfaceReference	Описание ссылки на сетевой интерфейс.
NetworkProfile	Указывает сетевые интерфейсы или конфигурацию сети виртуальной машины.
OperatingSystemTypes	Это свойство позволяет указать тип ОПЕРАЦИОННОй системы, включенной в диск, при создании виртуальной машины из пользовательского образа или специализированного виртуального жесткого диска. Возможные значения: Windows,Linux.
OSDisk	Указывает сведения о диске операционной системы, используемом виртуальной машиной. Дополнительные сведения о дисках см. в статье Сведения о дисках и виртуальных жестких дисках для виртуальных машин Azure.
OSProfile	Задает параметры операционной системы для виртуальной машины. Некоторые параметры нельзя изменить после подготовки виртуальной машины.
PassNames
PatchSettings	Указывает параметры, связанные с исправлением гостевой виртуальной машины в Windows.
Plan	Указывает сведения об образе Marketplace, используемом для создания виртуальной машины. Этот элемент используется только для образов Marketplace. Прежде чем использовать образ Marketplace из API, необходимо включить образ для программного использования. На портале Azure найдите образ Marketplace, который вы хотите использовать, а затем щелкните Хотите развернуть программным способом, Get Started (Начало работы—>). Введите все необходимые сведения и нажмите кнопку Сохранить.
ProtocolTypes	Задает протокол прослушивателя WinRM. Возможные значения: http,https.
ProxyAgentSettings	Указывает параметры ProxyAgent для масштабируемого набора виртуальных машин или виртуальной машины. Минимальная версия API: 2023-09-01.
PublicIPAddressSku	Описывает номер SKU общедоступного IP-адреса. Его можно задать только с помощью OrchestrationMode как гибкий.
PublicIPAddressSkuName	Указание имени SKU общедоступного IP-адреса
PublicIPAddressSkuTier	Указание уровня SKU общедоступного IP-адреса
PublicIPAllocationMethod	Укажите тип выделения общедоступных IP-адресов
ResilientVMDeletionStatus	Указывает состояние удаления отказоустойчивой виртуальной машины для виртуальной машины.
ResourceIdentityType	Тип удостоверения, используемого для масштабируемого набора виртуальных машин. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" приведет к удалению удостоверений из масштабируемого набора виртуальных машин.
SecurityEncryptionTypes	Указывает тип шифрования управляемого диска. Он имеет значение DiskWithVMGuestState для шифрования управляемого диска вместе с большим двоичным объектом VMGuestState, VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для сохранения состояния встроенного ПО в BLOB-объекте VMGuestState. Примечание. Его можно задать только для конфиденциальных виртуальных машин.
SecurityProfile	Задает параметры профиля безопасности для масштабируемого набора виртуальных машин или виртуальной машины.
SecurityTypes	Указывает тип безопасности виртуальной машины. Для включения UefiSettings необходимо задать любое указанное значение. Поведение по умолчанию: UefiSettings не будет включен, если это свойство не задано.
SettingNames	Указывает имя параметра, к которому применяется содержимое. Возможные значения: FirstLogonCommands и AutoLogon.
Sku	Описывает SKU масштабируемого набора виртуальных машин. ПРИМЕЧАНИЕ. Если новый номер SKU виртуальной машины не поддерживается на оборудовании, в настоящее время масштабируемый набор необходимо освободить виртуальные машины в масштабируемом наборе, прежде чем изменять имя SKU.
SshConfiguration	Конфигурация SSH для виртуальных машин под управлением Linux, работающих в Azure
SshPublicKey	Содержит сведения о открытом ключе сертификата SSH и пути к виртуальной машине Linux, где размещается открытый ключ.
StatusLevelTypes	Код уровня.
StorageAccountTypes	Указывает тип учетной записи хранения для управляемого диска. Тип учетной записи хранения управляемого диска ОС можно задать только при создании масштабируемого набора. ПРИМЕЧАНИЕ. UltraSSD_LRS можно использовать только с дисками данных. Его нельзя использовать с диском ОС. Standard_LRS использует HDD уровня "Стандартный". StandardSSD_LRS использует SSD уровня "Стандартный". Premium_LRS использует SSD уровня "Премиум". UltraSSD_LRS использует диск "Ультра". Premium_ZRS использует избыточное хранилище зоны SSD уровня "Премиум". StandardSSD_ZRS использует избыточное хранилище зоны SSD уровня "Стандартный". Дополнительные сведения о дисках, поддерживаемых для виртуальных машин Windows, см. в https://docs.microsoft.com/azure/virtual-machines/windows/disks-types и для виртуальных машин Linux см. в https://docs.microsoft.com/azure/virtual-machines/linux/disks-types
StorageProfile	Задает параметры хранилища для дисков виртуальной машины.
SubResource
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
UefiSettings	Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины. Минимальная версия API: 2020-12-01.
UserAssignedIdentitiesValue
VaultCertificate	Описывает одну ссылку на сертификат в Key Vault и расположение сертификата на виртуальной машине.
VaultSecretGroup	Описывает набор сертификатов, которые находятся в одном хранилище ключей.
VirtualHardDisk	Описывает универсальный код ресурса (URI) диска.
VirtualMachineAgentInstanceView	Представление экземпляра агента виртуальной машины, работающего на виртуальной машине.
VirtualMachineExtension	Описывает расширение виртуальной машины.
VirtualMachineExtensionHandlerInstanceView	Представление экземпляра обработчика расширений виртуальной машины.
VirtualMachineExtensionInstanceView	Представление экземпляра расширения виртуальной машины.
VirtualMachineHealthStatus	Состояние работоспособности виртуальной машины.
VirtualMachineIdentity	Удостоверение виртуальной машины.
VirtualMachineIpTag	Содержит тег IP, связанный с общедоступным IP-адресом.
VirtualMachineNetworkInterfaceConfiguration	Описывает конфигурации сетевого интерфейса виртуальной машины.
VirtualMachineNetworkInterfaceDnsSettingsConfiguration	Описывает параметры DNS конфигурации сети виртуальных машин.
VirtualMachineNetworkInterfaceIPConfiguration	Описывает IP-конфигурацию профиля сети виртуальной машины.
VirtualMachinePublicIPAddressConfiguration	Описывает конфигурацию PublicIPAddress для виртуальных машин
VirtualMachinePublicIPAddressDnsSettingsConfiguration	Описывает параметры DNS конфигурации сети виртуальных машин.
VirtualMachineScaleSetIPConfiguration	Описывает ip-конфигурацию сетевого профиля масштабируемого набора виртуальных машин.
VirtualMachineScaleSetIpTag	Содержит тег IP, связанный с общедоступным IP-адресом.
VirtualMachineScaleSetNetworkConfiguration	Описывает конфигурации сети сетевого профиля масштабируемого набора виртуальных машин.
VirtualMachineScaleSetNetworkConfigurationDnsSettings	Описывает параметры DNS конфигурации конфигурации сети масштабируемых наборов виртуальных машин.
VirtualMachineScaleSetPublicIPAddressConfiguration	Описание конфигурации publicIPAddress масштабируемого набора виртуальных машин
VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings	Описывает параметры DNS конфигурации конфигурации сети масштабируемых наборов виртуальных машин.
VirtualMachineScaleSetVM	Описывает виртуальную машину масштабируемого набора виртуальных машин.
VirtualMachineScaleSetVMInstanceView	Представление экземпляра виртуальной машины масштабируемого набора виртуальных машин.
VirtualMachineScaleSetVMNetworkProfileConfiguration	Описывает профиль сети виртуальной машины масштабируемого набора виртуальных машин.
VirtualMachineScaleSetVMProtectionPolicy	Политика защиты виртуальной машины масштабируемого набора виртуальных машин.
VirtualMachineSizeTypes	Указывает размер виртуальной машины. В настоящее время тип данных перечисления устарел и будет удален 23 декабря 2023 года. Рекомендуемый способ получить список доступных размеров использует следующие API: перечислить все доступные размеры виртуальных машин в группе доступности, Перечислить все доступные размеры виртуальных машин в регионе, перечислить все доступные размеры виртуальных машин для изменения размера. Дополнительные сведения о размерах виртуальных машин см. в разделе Размеры виртуальных машин. Доступные размеры виртуальных машин зависят от региона и группы доступности.
VMDiskSecurityProfile	Задает параметры профиля безопасности для управляемого диска. Примечание. его можно задать только для конфиденциальных виртуальных машин.
VMSizeProperties	Задает параметры свойства размера виртуальной машины на виртуальной машине.
WindowsConfiguration	Указывает параметры операционной системы Windows на виртуальной машине.
WindowsPatchAssessmentMode	Указывает режим оценки исправлений гостевой виртуальной машины для виртуальной машины IaaS. Возможны следующие значения: ImageDefault. Вы управляете временем оценки исправлений на виртуальной машине. AutomaticByPlatform . Платформа будет запускать периодические оценки исправлений. Свойство provisionVMAgent должно быть true.
WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform.
WindowsVMGuestPatchAutomaticByPlatformSettings	Указывает дополнительные параметры, применяемые при выборе режима исправления AutomaticByPlatform в параметрах исправлений Windows.
WindowsVMGuestPatchMode	Указывает режим гостевой исправления виртуальной машины на виртуальную машину IaaS или виртуальные машины, связанные с масштабируемым набором виртуальных машин с OrchestrationMode как гибкий. Возможны следующие значения: вручную . Вы управляете применением исправлений к виртуальной машине. Это можно сделать, применяя исправления вручную внутри виртуальной машины. В этом режиме автоматические обновления отключены; Свойство WindowsConfiguration.enableAutomaticUpdates должно быть false automaticByOS. Виртуальная машина автоматически обновляется ОС. Свойство WindowsConfiguration.enableAutomaticUpdates должно иметь значение true. AutomaticByPlatform — виртуальная машина автоматически обновляется платформой. Свойства provisionVMAgent и WindowsConfiguration.enableAutomaticUpdates должны иметь значение true.
WinRMConfiguration	Описание конфигурации удаленного управления Windows виртуальной машины
WinRMListener	Описание протокола и отпечатка прослушивателя удаленного управления Windows

AdditionalCapabilities

Object

Включает или отключает возможность на виртуальной машине или масштабируемом наборе виртуальных машин.

Имя	Тип	Описание
hibernationEnabled	boolean	Флаг, который включает или отключает возможность гибернации на виртуальной машине.
ultraSSDEnabled	boolean	Флаг, который включает или отключает возможность иметь один или несколько управляемых дисков данных с типом учетной записи хранения UltraSSD_LRS на виртуальной машине или vmSS. Управляемые диски с типом учетной записи хранения UltraSSD_LRS можно добавить в виртуальную машину или масштабируемый набор виртуальных машин, только если это свойство включено.

AdditionalUnattendContent

Object

Указывает дополнительные xml-форматированные сведения, которые можно включить в файл Unattend.xml, который используется программой установки Windows. Содержимое определяется по имени, имени компонента и передаче, в которой применяется содержимое.

Имя	Тип	Описание
componentName	ComponentNames	Имя компонента. В настоящее время единственным допустимым значением является Microsoft-Windows-Shell-Setup.
content	string	Задает форматированный XML-контент, добавляемый в файл unattend.xml для указанного пути и компонента. XML-код должен быть меньше 4 КБ и должен содержать корневой элемент для вставленного параметра или компонента.
passName	PassNames	Имя передачи. В настоящее время единственным допустимым значением является OobeSystem.
settingName	SettingNames	Указывает имя параметра, к которому применяется содержимое. Возможные значения: FirstLogonCommands и AutoLogon.

ApiEntityReference

Object

Справочник по сущностям API.

Имя	Тип	Описание
id	string	Идентификатор ресурса ARM в виде /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Object

Ошибка API.

Имя	Тип	Описание
code	string	Код ошибки.
details	ApiErrorBase[]	Сведения об ошибке API
innererror	InnerError	Внутренняя ошибка API
message	string	Сообщение об ошибке.
target	string	Целевой объект конкретной ошибки.

ApiErrorBase

Object

База ошибок API.

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке.
target	string	Целевой объект конкретной ошибки.

BootDiagnostics

Object

Диагностика загрузки — это функция отладки, которая позволяет просматривать выходные данные консоли и снимок экрана для диагностики состояния виртуальной машины. Вы можете легко просмотреть выходные данные журнала консоли. Azure также позволяет просмотреть снимок экрана виртуальной машины из гипервизора.

Имя	Тип	Описание
enabled	boolean	Следует ли включить диагностику загрузки на виртуальной машине.
storageUri	string	Uri учетной записи хранения, используемой для размещения выходных данных консоли и снимка экрана. Если storageUri не указан при включении диагностики загрузки, будет использоваться управляемое хранилище.

BootDiagnosticsInstanceView

Object

Представление экземпляра диагностики загрузки виртуальной машины.

Имя	Тип	Описание
consoleScreenshotBlobUri	string	URI большого двоичного объекта консоли. Примечание. это не задаваться, если диагностика загрузки в настоящее время включена с управляемым хранилищем.
serialConsoleLogBlobUri	string	Универсальный код ресурса (URI) URI для последовательной консоли консоли. Примечание. это не задаваться, если диагностика загрузки в настоящее время включена с управляемым хранилищем.
status	InstanceViewStatus	Сведения о состоянии диагностики загрузки для виртуальной машины. Примечание. Он будет задан только в том случае, если возникают ошибки при включении диагностики загрузки.

CachingTypes

Перечисление

Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Значения по умолчанию: Нет для хранилища уровня "Стандартный". ReadOnly для хранилища Premium

Значение	Описание
None
ReadOnly
ReadWrite

CloudError

Object

Ответ на ошибку из службы вычислений.

Имя	Тип	Описание
error	ApiError	Ошибка API.

ComponentNames

Перечисление

Значение	Описание
Microsoft-Windows-Shell-Setup

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

DataDisk

Object

Описывает диск данных.

Имя	Тип	Описание
caching	CachingTypes	Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Поведение по умолчанию: Нет для хранилища уровня "Стандартный". ReadOnly для хранилища Premium.
createOption	DiskCreateOptionTypes	Указывает, как должен быть создан диск виртуальной машины. Возможные значения — подключение : это значение используется при использовании специализированного диска для создания виртуальной машины. FromImage: Это значение используется при использовании образа для создания диска данных виртуальной машины. При использовании образа платформы также следует использовать элемент imageReference, описанный выше. Если вы используете образ Marketplace, вы также должны использовать элемент плана, описанный ранее. Пустое: это значение используется при создании пустого диска данных. копирование: это значение используется для создания диска данных из моментального снимка или другого диска. восстановление: это значение используется для создания диска данных из точки восстановления диска.
deleteOption	DiskDeleteOptionTypes	Указывает, следует ли удалять или отсоединять диск данных при удалении виртуальной машины. Возможные значения: Delete. Если это значение используется, диск данных удаляется при удалении виртуальной машины. Отделять. Если это значение используется, диск данных сохраняется после удаления виртуальной машины. Значение по умолчанию имеет значение Отсоединение.
detachOption	DiskDetachOptionTypes	Указывает поведение отсоединения, используемое при отсоединение диска или уже в процессе отсоединения от виртуальной машины. Поддерживаемые значения: ForceDetach. отсоединение: ForceDetach применимо только для управляемых дисков данных. Если предыдущая попытка отсоединения диска данных не завершена из-за непредвиденного сбоя виртуальной машины, а диск по-прежнему не выпущен, используйте принудительное отключение в качестве последней возможности для принудительного отключения диска от виртуальной машины. Все записи, возможно, не были удалены при использовании этого поведения отсоединения. Эта функция все еще находится на стадии предварительной версии. Чтобы принудительно отсоединить диск данных, обновите его до true вместе с параметром detachOption: ForceDetach.
diskIOPSReadWrite	integer (int64)	Указывает Read-Write операций ввода-вывода в секунду для управляемого диска при UltraSSD_LRS StorageAccountType. Возвращается только для дисков виртуальных машин VirtualMachine ScaleSet. Можно обновлять только с помощью обновлений масштабируемого набора VirtualMachine.
diskMBpsReadWrite	integer (int64)	Указывает пропускную способность в МБ в секунду для управляемого диска при UltraSSD_LRS StorageAccountType. Возвращается только для дисков виртуальных машин VirtualMachine ScaleSet. Можно обновлять только с помощью обновлений масштабируемого набора VirtualMachine.
diskSizeGB	integer (int32)	Задает размер пустого диска данных в гигабайтах. Этот элемент можно использовать для перезаписи размера диска в образе виртуальной машины. Свойство diskSizeGB — это число байтов x 1024^3 для диска, а значение не может быть больше 1023.
image	VirtualHardDisk	Исходный образ пользователя виртуального жесткого диска. Виртуальный жесткий диск будет скопирован перед присоединением к виртуальной машине. Если предоставляется SourceImage, целевой виртуальный жесткий диск не должен существовать.
lun	integer (int32)	Указывает логическую единицу диска данных. Это значение используется для идентификации дисков данных на виртуальной машине и поэтому должно быть уникальным для каждого диска данных, подключенного к виртуальной машине.
managedDisk	ManagedDiskParameters	Параметры управляемого диска.
name	string	Имя диска.
sourceResource	ApiEntityReference	Идентификатор исходного ресурса. Это может быть моментальный снимок или точка восстановления диска, из которой создается диск.
toBeDetached	boolean	Указывает, находится ли диск данных в процессе отсоединения от VirtualMachine/VirtualMachineScaleset
vhd	VirtualHardDisk	Виртуальный жесткий диск.
writeAcceleratorEnabled	boolean	Указывает, следует ли включить или отключить записьAccelerator на диске.

DeleteOptions

Перечисление

Укажите, что происходит с сетевым интерфейсом при удалении виртуальной машины

Значение	Описание
Delete
Detach

DiagnosticsProfile

Object

Указывает состояние параметров диагностики загрузки. Минимальная версия API: 2015-06-15.

Имя	Тип	Описание
bootDiagnostics	BootDiagnostics	Диагностика загрузки — это функция отладки, которая позволяет просматривать выходные данные консоли и снимок экрана для диагностики состояния виртуальной машины. ПРИМЕЧАНИЕ. Если указан URI хранилища, убедитесь, что учетная запись хранения находится в том же регионе и подписке, что и виртуальная машина. Вы можете легко просмотреть выходные данные журнала консоли. Azure также позволяет просмотреть снимок экрана виртуальной машины из гипервизора.

DiffDiskOptions

Перечисление

Задает параметр временного диска для диска операционной системы.

Значение	Описание
Local

DiffDiskPlacement

Перечисление

Задает эфемерное размещение дисков для диска операционной системы. Это свойство можно использовать пользователем в запросе, чтобы выбрать расположение, например диск кэша, диск ресурсов или место на диске nvme для подготовки диска Эфемеральной ОС. Дополнительные сведения о требованиях к размеру диска эфемерной ОС см. в разделе "Требования к размеру диска операционной системы" для виртуальной машины Windows на https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements виртуальной машине Windows и виртуальной машине Linux.https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements Минимальная версия API для NvmeDisk: 2024-03-01.

Значение	Описание
CacheDisk
ResourceDisk
NvmeDisk

DiffDiskSettings

Object

Описывает параметры временных параметров диска, которые можно указать для диска операционной системы. Примечание. Параметры временного диска можно указать только для управляемого диска.

Имя	Тип	Описание
option	DiffDiskOptions	Задает временные параметры диска для диска операционной системы.
placement	DiffDiskPlacement	Задает эфемерное размещение дисков для диска операционной системы. Возможные значения: CacheDisk,ResourceDisk,NvmeDisk. Поведение по умолчанию: CacheDisk, если он настроен для размера виртуальной машины в противном случае используется ResourceDisk или NvmeDisk. Ознакомьтесь с документацией по размеру виртуальной машины Windows на https://docs.microsoft.com/azure/virtual-machines/windows/sizes и виртуальной машине Linux в https://docs.microsoft.com/azure/virtual-machines/linux/sizes, чтобы проверить, какие размеры виртуальных машин предоставляют диск кэша. Минимальная версия API для NvmeDisk: 2024-03-01.

DiskControllerTypes

Перечисление

Указывает тип контроллера диска, настроенный для виртуальной машины и VirtualMachineScaleSet. Это свойство поддерживается только для виртуальных машин, для которых диск операционной системы и SKU виртуальной машины поддерживают поколение 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), проверьте возможность HyperVGenerations, возвращенную как часть возможностей SKU виртуальной машины в ответ api SKU Microsoft.Compute для региона содержит версию 2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list). Дополнительные сведения о поддерживаемых типах контроллеров дисков см. в https://aka.ms/azure-diskcontrollertypes.

Значение	Описание
SCSI
NVMe

DiskCreateOptionTypes

Перечисление

Указывает, как должен быть создан диск виртуальной машины. Возможные значения — подключение : это значение используется при использовании специализированного диска для создания виртуальной машины. FromImage: это значение используется при использовании образа для создания виртуальной машины. При использовании образа платформы также следует использовать элемент imageReference, описанный выше. Если вы используете образ Marketplace, вы также должны использовать элемент плана, описанный ранее. Пустое: это значение используется при создании пустого диска данных. копирование: это значение используется для создания диска данных из моментального снимка или другого диска. восстановление: это значение используется для создания диска данных из точки восстановления диска.

Значение	Описание
FromImage
Empty
Attach
Copy
Restore

DiskDeleteOptionTypes

Перечисление

Указывает поведение управляемого диска при удалении виртуальной машины, например, удаляется или отсоединяется ли управляемый диск. Поддерживаемые значения: Delete. Если это значение используется, управляемый диск удаляется при удалении виртуальной машины. Отделять. Если это значение используется, управляемый диск сохраняется после удаления виртуальной машины. Минимальная версия API: 2021-03-01.

Значение	Описание
Delete
Detach

DiskDetachOptionTypes

Перечисление

Указывает поведение отсоединения, используемое при отсоединение диска или уже в процессе отсоединения от виртуальной машины. Поддерживаемые значения: ForceDetach. detachOption : ForceDetach применим только для управляемых дисков данных. Если предыдущая попытка отсоединения диска данных не завершена из-за непредвиденного сбоя виртуальной машины, а диск по-прежнему не выпущен, используйте принудительное отключение в качестве последней возможности для принудительного отключения диска от виртуальной машины. Все записи, возможно, не были удалены при использовании этого поведения отсоединения. Эта функция все еще находится на стадии предварительной версии. Чтобы принудительно отсоединить диск данных, обновите его до true вместе с параметром detachOption: ForceDetach.

Значение	Описание
ForceDetach

DiskEncryptionSetParameters

Object

Описывает параметр набора ресурсов набора шифрования управляемых клиентом дисков, который можно указать для диска. Примечание. идентификатор ресурса набора шифрования дисков можно указать только для управляемого диска. Дополнительные сведения см. в https://aka.ms/mdssewithcmkoverview.

Имя	Тип	Описание
id	string	Идентификатор ресурса

DiskEncryptionSettings

Object

Описание параметров шифрования диска

Имя	Тип	Описание
diskEncryptionKey	KeyVaultSecretReference	Указывает расположение ключа шифрования диска, являющегося секретом Key Vault.
enabled	boolean	Указывает, следует ли включить шифрование дисков на виртуальной машине.
keyEncryptionKey	KeyVaultKeyReference	Указывает расположение ключа шифрования ключей в Key Vault.

DiskInstanceView

Object

Представление экземпляра диска.

Имя	Тип	Описание
encryptionSettings	DiskEncryptionSettings[]	Задает параметры шифрования для диска ОС. Минимальная версия API: 2015-06-15
name	string	Имя диска.
statuses	InstanceViewStatus[]	Сведения о состоянии ресурса.

DomainNameLabelScopeTypes

Перечисление

Область метки доменного имени. Объединение метки хэшированного доменного имени, созданной в соответствии с политикой из области метки доменного имени и индексом виртуальной машины, будет метками доменных имен ресурсов PublicIPAddress, которые будут созданы.

Значение	Описание
TenantReuse
SubscriptionReuse
ResourceGroupReuse
NoReuse

EncryptionIdentity

Object

Указывает управляемое удостоверение, используемое ADE для получения маркера доступа для операций keyvault.

Имя	Тип	Описание
userAssignedIdentityResourceId	string	Указывает идентификатор ресурса ARM одного из удостоверений пользователя, связанных с виртуальной машиной.

HardwareProfile

Object

Указывает параметры оборудования для виртуальной машины.

Имя	Тип	Описание
vmSize	VirtualMachineSizeTypes	Указывает размер виртуальной машины. В настоящее время тип данных перечисления устарел и будет удален 23 декабря 2023 года. Рекомендуемый способ получить список доступных размеров использует следующие API: перечислить все доступные размеры виртуальных машин в группе доступности, Перечислить все доступные размеры виртуальных машин в регионе, перечислить все доступные размеры виртуальных машин для изменения размера. Дополнительные сведения о размерах виртуальных машин см. в разделе Размеры виртуальных машин. Доступные размеры виртуальных машин зависят от региона и группы доступности.
vmSizeProperties	VMSizeProperties	Задает свойства для настройки размера виртуальной машины. Минимальная версия API: 2021-07-01. Эта функция по-прежнему находится в режиме предварительной версии и не поддерживается для VirtualMachineScaleSet. Дополнительные сведения см. в настройки виртуальной машины.

HostEndpointSettings

Object

Указывает определенные параметры конечной точки узла.

Имя	Тип	Описание
inVMAccessControlProfileReferenceId	string	Указывает идентификатор ресурса InVMAccessControlProfileVersion в формате /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{versions}
mode	Modes	Указывает режим выполнения. В режиме аудита система действует так, как если бы она применяла политику управления доступом, включая выдачу записей отказа в доступе в журналах, но фактически не запрещает какие-либо запросы на размещение конечных точек. В режиме принудительного применения система будет применять управление доступом, и это рекомендуемый режим работы.

HyperVGeneration

Перечисление

Создание гипервизора виртуальной машины [V1, V2]

Значение	Описание
V1
V2

ImageReference

Object

Указывает сведения об используемом изображении. Вы можете указать сведения о образах платформы, образах Marketplace или образах виртуальных машин. Этот элемент необходим, если вы хотите использовать образ платформы, образ Marketplace или образ виртуальной машины, но не используется в других операциях создания. ПРИМЕЧАНИЕ. Издатель ссылок на изображения и предложение можно задать только при создании масштабируемого набора.

Имя	Тип	Описание
communityGalleryImageId	string	Укажите уникальный идентификатор образа коллекции сообщества для развертывания виртуальной машины. Это можно получить из вызова GET изображения коллекции сообщества.
exactVersion	string	Указывает в десятичных числах версию образа платформы или образа Marketplace, используемого для создания виртуальной машины. Это поле чтения отличается от "version", только если значение, указанное в поле "версия", имеет значение "latest".
id	string	Идентификатор ресурса
offer	string	Указывает предложение образа платформы или образа Marketplace, используемого для создания виртуальной машины.
publisher	string	Издатель образа.
sharedGalleryImageId	string	Укажите уникальный идентификатор образа общей коллекции для развертывания виртуальной машины. Это можно получить из вызова GET образа общей коллекции.
sku	string	Номер SKU изображения.
version	string	Указывает версию образа платформы или образа Marketplace, используемого для создания виртуальной машины. Допустимые форматы: Major.Minor.Build или latest. Основные, незначительные и сборки — это десятичные числа. Укажите "последняя", чтобы использовать последнюю версию образа, доступного во время развертывания. Даже если вы используете "последнюю версию", образ виртуальной машины не будет автоматически обновляться после развертывания, даже если новая версия станет доступной. Не используйте поле "версия" для развертывания образа коллекции, образ коллекции всегда должен использовать поле "id" для развертывания, чтобы использовать последнюю версию образа коллекции, просто установить "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageName}" в поле "id" без ввода версии.

InnerError

Object

Сведения о внутренней ошибке.

Имя	Тип	Описание
errordetail	string	Внутреннее сообщение об ошибке или дамп исключений.
exceptiontype	string	Тип исключения.

InstanceViewStatus

Object

Состояние представления экземпляра.

Имя	Тип	Описание
code	string	Код состояния.
displayStatus	string	Короткая локализуемая метка для состояния.
level	StatusLevelTypes	Код уровня.
message	string	Подробное сообщение о состоянии, в том числе для оповещений и сообщений об ошибках.
time	string (date-time)	Время состояния.

InstanceViewTypes

Перечисление

Значение	Описание
instanceView
userData
resiliencyView

IPVersion

Перечисление

Доступно из Api-Version 2017-03-30, он представляет, является ли конкретная ipconfiguration IPv4 или IPv6. По умолчанию используется протокол IPv4. Возможные значения: "IPv4" и "IPv6".

Значение	Описание
IPv4
IPv6

IPVersions

Перечисление

Значение	Описание
IPv4
IPv6

KeyVaultKeyReference

Object

Описание ссылки на ключ Key Vault

Имя	Тип	Описание
keyUrl	string	URL-адрес, ссылающийся на ключ шифрования ключей в Key Vault.
sourceVault	SubResource	Относительный URL-адрес Хранилища ключей, содержащий ключ.

KeyVaultSecretReference

Object

Описание ссылки на секрет Key Vault

Имя	Тип	Описание
secretUrl	string	URL-адрес, ссылающийся на секрет в Key Vault.
sourceVault	SubResource	Относительный URL-адрес Хранилища ключей, содержащий секрет.

LinuxConfiguration

Object

Указывает параметры операционной системы Linux на виртуальной машине. Список поддерживаемых дистрибутивов Linux см. в Linux в Azure-Endorsed дистрибутивах.

Имя	Тип	Описание
disablePasswordAuthentication	boolean	Указывает, следует ли отключить проверку подлинности паролей.
enableVMAgentPlatformUpdates	boolean	Указывает, включены ли обновления платформы VMAgent для виртуальной машины Linux. По умолчанию используется значение false.
patchSettings	LinuxPatchSettings	[Предварительная версия компонента] Указывает параметры, связанные с исправлением гостевой виртуальной машины в Linux.
provisionVMAgent	boolean	Указывает, следует ли подготовить агент виртуальной машины на виртуальной машине. Если это свойство не указано в тексте запроса, поведение по умолчанию — задать для него значение true. Это гарантирует, что агент виртуальной машины установлен на виртуальной машине, чтобы расширения можно было добавить в виртуальную машину позже.
ssh	SshConfiguration	Указывает конфигурацию ключа SSH для ОС Linux.

LinuxPatchAssessmentMode

Перечисление

Указывает режим оценки гостевых исправлений виртуальной машины для виртуальной машины IaaS.

Возможны следующие значения:

ImageDefault. Вы управляете временем оценки исправлений на виртуальной машине.

AutomaticByPlatform . Платформа будет запускать периодические оценки исправлений. Свойство provisionVMAgent должно быть true.

Значение	Описание
ImageDefault
AutomaticByPlatform

LinuxPatchSettings

Object

Указывает параметры, связанные с исправлением гостевой виртуальной машины в Linux.

Имя	Тип	Описание
assessmentMode	LinuxPatchAssessmentMode	Указывает режим оценки гостевых исправлений виртуальной машины для виртуальной машины IaaS. Возможны следующие значения: ImageDefault. Вы управляете временем оценки исправлений на виртуальной машине. AutomaticByPlatform . Платформа будет запускать периодические оценки исправлений. Свойство provisionVMAgent должно быть true.
automaticByPlatformSettings	LinuxVMGuestPatchAutomaticByPlatformSettings	Задает дополнительные параметры режима исправления AutomaticByPlatform в гостевой исправлении виртуальной машины в Linux.
patchMode	LinuxVMGuestPatchMode	Указывает режим гостевой исправления виртуальной машины на виртуальную машину IaaS или виртуальные машины, связанные с масштабируемым набором виртуальных машин с OrchestrationMode как гибкий. Возможны следующие значения: ImageDefault — используется конфигурация исправления по умолчанию виртуальной машины. AutomaticByPlatform. Виртуальная машина будет автоматически обновляться платформой. Свойство provisionVMAgent должно иметь значение true

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Перечисление

Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform.

Значение	Описание
Unknown
IfRequired
Never
Always

LinuxVMGuestPatchAutomaticByPlatformSettings

Object

Указывает дополнительные параметры, применяемые при выборе режима исправления AutomaticByPlatform в параметрах исправлений Linux.

Имя	Тип	Описание
bypassPlatformSafetyChecksOnUserSchedule	boolean	Позволяет клиенту планировать исправление без случайного обновления
rebootSetting	LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform.

LinuxVMGuestPatchMode

Перечисление

Указывает режим гостевой исправления виртуальной машины на виртуальную машину IaaS или виртуальные машины, связанные с масштабируемым набором виртуальных машин с OrchestrationMode как гибкий.

Возможны следующие значения:

ImageDefault — используется конфигурация исправления по умолчанию виртуальной машины.

AutomaticByPlatform. Виртуальная машина будет автоматически обновляться платформой. Свойство provisionVMAgent должно иметь значение true

Значение	Описание
ImageDefault
AutomaticByPlatform

MaintenanceOperationResultCodeTypes

Перечисление

Код результата последней операции обслуживания.

Значение	Описание
None
RetryLater
MaintenanceAborted
MaintenanceCompleted

MaintenanceRedeployStatus

Object

Состояние операции обслуживания.

Имя	Тип	Описание
isCustomerInitiatedMaintenanceAllowed	boolean	Значение true, если клиенту разрешено выполнять обслуживание.
lastOperationMessage	string	Сообщение, возвращенное для последней операции обслуживания.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	Код результата последней операции обслуживания.
maintenanceWindowEndTime	string (date-time)	Время окончания периода обслуживания.
maintenanceWindowStartTime	string (date-time)	Время начала периода обслуживания.
preMaintenanceWindowEndTime	string (date-time)	Время окончания периода предварительного обслуживания.
preMaintenanceWindowStartTime	string (date-time)	Время начала периода предварительного обслуживания.

ManagedDiskParameters

Object

Параметры управляемого диска.

Имя	Тип	Описание
diskEncryptionSet	DiskEncryptionSetParameters	Указывает идентификатор ресурса набора шифрования управляемых пользователем дисков для управляемого диска.
id	string	Идентификатор ресурса
securityProfile	VMDiskSecurityProfile	Указывает профиль безопасности управляемого диска.
storageAccountType	StorageAccountTypes	Указывает тип учетной записи хранения для управляемого диска. ПРИМЕЧАНИЕ. UltraSSD_LRS можно использовать только с дисками данных, его нельзя использовать с диском ОС.

Mode

Перечисление

Указывает режим, на котором будет выполняться ProxyAgent, если эта функция включена. ProxyAgent начнет аудит или мониторинг, но не применяет управление доступом к запросам к конечным точкам узла в режиме аудита, в то время как в режиме принудительного применения будет применяться управление доступом. Значением по умолчанию является режим принудительного применения.

Значение	Описание
Audit
Enforce

Modes

Перечисление

Указывает режим выполнения. В режиме аудита система действует так, как если бы она применяла политику управления доступом, включая выдачу записей отказа в доступе в журналах, но фактически не запрещает какие-либо запросы на размещение конечных точек. В режиме принудительного применения система будет применять управление доступом, и это рекомендуемый режим работы.

Значение	Описание
Audit
Enforce
Disabled

NetworkApiVersion

Перечисление

указывает версию API Microsoft.Network, используемую при создании сетевых ресурсов в конфигурациях сетевого интерфейса.

Значение	Описание
2020-11-01
2022-11-01

NetworkInterfaceAuxiliaryMode

Перечисление

Указывает, включен ли вспомогательный режим для ресурса сетевого интерфейса.

Значение	Описание
None
AcceleratedConnections
Floating

NetworkInterfaceAuxiliarySku

Перечисление

Указывает, включен ли вспомогательный номер SKU для ресурса сетевого интерфейса.

Значение	Описание
None
A1
A2
A4
A8

NetworkInterfaceReference

Object

Описание ссылки на сетевой интерфейс.

Имя	Тип	Описание
id	string	Идентификатор ресурса
properties.deleteOption	DeleteOptions	Укажите, что происходит с сетевым интерфейсом при удалении виртуальной машины
properties.primary	boolean	Указывает основной сетевой интерфейс в случае, если виртуальная машина имеет более 1 сетевого интерфейса.

NetworkProfile

Object

Указывает сетевые интерфейсы или конфигурацию сети виртуальной машины.

Имя	Тип	Описание
networkApiVersion	NetworkApiVersion	указывает версию API Microsoft.Network, используемую при создании сетевых ресурсов в конфигурациях сетевого интерфейса.
networkInterfaceConfigurations	VirtualMachineNetworkInterfaceConfiguration[]	Указывает конфигурации сети, которые будут использоваться для создания сетевых ресурсов виртуальной машины.
networkInterfaces	NetworkInterfaceReference[]	Указывает список идентификаторов ресурсов для сетевых интерфейсов, связанных с виртуальной машиной.

OperatingSystemTypes

Перечисление

Это свойство позволяет указать тип ОПЕРАЦИОННОй системы, включенной в диск, при создании виртуальной машины из пользовательского образа или специализированного виртуального жесткого диска. Возможные значения: Windows,Linux.

Значение	Описание
Windows
Linux

OSDisk

Object

Указывает сведения о диске операционной системы, используемом виртуальной машиной. Дополнительные сведения о дисках см. в статье Сведения о дисках и виртуальных жестких дисках для виртуальных машин Azure.

Имя	Тип	Описание
caching	CachingTypes	Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Поведение по умолчанию: Нет для хранилища уровня "Стандартный". ReadOnly для хранилища Premium.
createOption	DiskCreateOptionTypes	Указывает, как должен быть создан диск виртуальной машины. Возможные значения — подключение : это значение используется при использовании специализированного диска для создания виртуальной машины. FromImage: это значение используется при использовании образа для создания виртуальной машины. При использовании образа платформы также следует использовать элемент imageReference, описанный выше. Если вы используете образ Marketplace, вы также должны использовать элемент плана, описанный ранее.
deleteOption	DiskDeleteOptionTypes	Указывает, следует ли удалять или отсоединять диск ОС при удалении виртуальной машины. Возможные значения: Delete. Если это значение используется, диск ОС удаляется при удалении виртуальной машины. Отделять. Если это значение используется, диск ос сохраняется после удаления виртуальной машины. Значение по умолчанию имеет значение Отсоединение. Для временного диска ОС по умолчанию задано значение Delete. Пользователь не может изменить параметр удаления для временного диска ОС.
diffDiskSettings	DiffDiskSettings	Задает временные параметры диска для диска операционной системы, используемого виртуальной машиной.
diskSizeGB	integer (int32)	Задает размер пустого диска данных в гигабайтах. Этот элемент можно использовать для перезаписи размера диска в образе виртуальной машины. Свойство diskSizeGB — это число байтов x 1024^3 для диска, а значение не может быть больше 1023.
encryptionSettings	DiskEncryptionSettings	Задает параметры шифрования для диска ОС. Минимальная версия API: 2015-06-15.
image	VirtualHardDisk	Исходный образ пользователя виртуального жесткого диска. Виртуальный жесткий диск будет скопирован перед присоединением к виртуальной машине. Если предоставляется SourceImage, целевой виртуальный жесткий диск не должен существовать.
managedDisk	ManagedDiskParameters	Параметры управляемого диска.
name	string	Имя диска.
osType	OperatingSystemTypes	Это свойство позволяет указать тип ОПЕРАЦИОННОй системы, включенной в диск, при создании виртуальной машины из пользовательского образа или специализированного виртуального жесткого диска. Возможные значения: Windows,Linux.
vhd	VirtualHardDisk	Виртуальный жесткий диск.
writeAcceleratorEnabled	boolean	Указывает, следует ли включить или отключить записьAccelerator на диске.

OSProfile

Object

Задает параметры операционной системы для виртуальной машины. Некоторые параметры нельзя изменить после подготовки виртуальной машины.

Имя	Тип	Описание
adminPassword	string (password)	Указывает пароль учетной записи администратора. минимальная длина (Windows): 8 символов минимальная длина (Linux): 6 символов Максимальная длина (Windows): 123 символов максимальная длина (Linux): 72 символов Требования к сложности: 3 из 4 условий, указанных ниже, необходимо выполнить Имеет нижние символы Имеет верхние символы Имеет цифру Имеет специальный символ (regex match [\W_]) Запрещенные значения: "abc@123", "P@$$w 0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "loweyou!" Сведения о сбросе пароля см. в статье Как сбросить службу удаленного рабочего стола или пароль для входа в виртуальной машины Windows. Сведения о сбросе корневого пароля см. в статье Управление пользователями, SSH и проверка или восстановление дисков на виртуальных машинах Linux Azure с помощью расширения VMAccess
adminUsername	string	Указывает имя учетной записи администратора. Это свойство невозможно обновить после создания виртуальной машины. ограничение только для Windows: не удается завершить ". Запрещенные значения: "admin", "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". минимальная длина (Linux): 1 символ максимальная длина (Linux): 64 символов максимальная длина (Windows): 20 символов.
allowExtensionOperations	boolean	Указывает, следует ли разрешать операции расширения на виртуальной машине. Это значение может быть задано только в том случае, если расширения отсутствуют на виртуальной машине.
computerName	string	Указывает имя ОС узла виртуальной машины. Это имя невозможно обновить после создания виртуальной машины. максимальная длина (Windows): 15 символов. Максимальная длина (Linux): 64 символов. Соглашения об именовании и ограничения см. в руководства по реализации служб инфраструктуры Azure.
customData	string	Задает строку в кодировке base-64 пользовательских данных. Строка в кодировке Base-64 декодируется в двоичный массив, сохраненный в виде файла на виртуальной машине. Максимальная длина двоичного массива составляет 65535 байтов. Примечание. Не передавать секреты или пароли в свойстве customData. Это свойство невозможно обновить после создания виртуальной машины. Свойство CustomData передается виртуальной машине для сохранения в виде файла, дополнительные сведения см. в пользовательских данных на виртуальных машинах Azure. Сведения об использовании cloud-init для виртуальной машины Linux см. в статье Использование cloud-init для настройки виртуальной машины Linux во время создания.
linuxConfiguration	LinuxConfiguration	Указывает параметры операционной системы Linux на виртуальной машине. Список поддерживаемых дистрибутивов Linux см. в Linux в Azure-Endorsed дистрибутивах.
requireGuestProvisionSignal	boolean	Необязательное свойство, которое должно иметь значение True или опущено.
secrets	VaultSecretGroup[]	Задает набор сертификатов, которые должны быть установлены на виртуальной машине. Чтобы установить сертификаты на виртуальной машине, рекомендуется использовать расширение виртуальной машины Azure Key Vault для Linux или расширение виртуальной машины Azure Key Vault для Windows.
windowsConfiguration	WindowsConfiguration	Указывает параметры операционной системы Windows на виртуальной машине.

PassNames

Перечисление

Значение	Описание
OobeSystem

PatchSettings

Object

Указывает параметры, связанные с исправлением гостевой виртуальной машины в Windows.

Имя	Тип	Описание
assessmentMode	WindowsPatchAssessmentMode	Указывает режим оценки исправлений гостевой виртуальной машины для виртуальной машины IaaS. Возможны следующие значения: ImageDefault. Вы управляете временем оценки исправлений на виртуальной машине. AutomaticByPlatform . Платформа будет запускать периодические оценки исправлений. Свойство provisionVMAgent должно быть true.
automaticByPlatformSettings	WindowsVMGuestPatchAutomaticByPlatformSettings	Указывает дополнительные параметры режима исправления AutomaticByPlatform в гостевой исправлении виртуальной машины в Windows.
enableHotpatching	boolean	Позволяет клиентам исправлять виртуальные машины Azure без перезагрузки. Для включенияHotpatching для параметра provisionVMAgent должно быть задано значение true, а для patchMode должно быть задано значение AutomaticByPlatform.
patchMode	WindowsVMGuestPatchMode	Указывает режим гостевой исправления виртуальной машины на виртуальную машину IaaS или виртуальные машины, связанные с масштабируемым набором виртуальных машин с OrchestrationMode как гибкий. Возможны следующие значения: вручную . Вы управляете применением исправлений к виртуальной машине. Это можно сделать, применяя исправления вручную внутри виртуальной машины. В этом режиме автоматические обновления отключены; Свойство WindowsConfiguration.enableAutomaticUpdates должно быть false automaticByOS. Виртуальная машина автоматически обновляется ОС. Свойство WindowsConfiguration.enableAutomaticUpdates должно иметь значение true. AutomaticByPlatform — виртуальная машина автоматически обновляется платформой. Свойства provisionVMAgent и WindowsConfiguration.enableAutomaticUpdates должны иметь значение true.

Plan

Object

Указывает сведения об образе Marketplace, используемом для создания виртуальной машины. Этот элемент используется только для образов Marketplace. Прежде чем использовать образ Marketplace из API, необходимо включить образ для программного использования. На портале Azure найдите образ Marketplace, который вы хотите использовать, а затем щелкните Хотите развернуть программным способом, Get Started (Начало работы—>). Введите все необходимые сведения и нажмите кнопку Сохранить.

Имя	Тип	Описание
name	string	Идентификатор плана.
product	string	Задает продукт изображения из Marketplace. Это то же значение, что и Предложение в элементе imageReference.
promotionCode	string	Код повышения.
publisher	string	Идентификатор издателя.

ProtocolTypes

Перечисление

Задает протокол прослушивателя WinRM. Возможные значения: http,https.

Значение	Описание
Http
Https

ProxyAgentSettings

Object

Указывает параметры ProxyAgent для масштабируемого набора виртуальных машин или виртуальной машины. Минимальная версия API: 2023-09-01.

Имя	Тип	Описание
enabled	boolean	Указывает, следует ли включить функцию ProxyAgent на виртуальной машине или масштабируемом наборе виртуальных машин.
imds	HostEndpointSettings	Задает параметры конечной точки IMDS при создании виртуальной машины или масштабируемого набора виртуальных машин. Минимальная версия API: 2024-03-01.
keyIncarnationId	integer (int32)	Увеличьте значение этого свойства, чтобы пользователи сбрасывали ключ, используемый для защиты канала связи между гостевым и узлом.
mode	Mode	Указывает режим, на котором будет выполняться ProxyAgent. Предупреждение: это свойство устарело, укажите "режим" в определенном параметре hostendpoint.
wireServer	HostEndpointSettings	Задает параметры конечной точки wire Server при создании виртуальной машины или масштабируемого набора виртуальных машин. Минимальная версия API: 2024-03-01.

PublicIPAddressSku

Object

Описывает номер SKU общедоступного IP-адреса. Его можно задать только с помощью OrchestrationMode как гибкий.

Имя	Тип	Описание
name	PublicIPAddressSkuName	Указание имени SKU общедоступного IP-адреса
tier	PublicIPAddressSkuTier	Указание уровня SKU общедоступного IP-адреса

PublicIPAddressSkuName

Перечисление

Указание имени SKU общедоступного IP-адреса

Значение	Описание
Basic
Standard

PublicIPAddressSkuTier

Перечисление

Указание уровня SKU общедоступного IP-адреса

Значение	Описание
Regional
Global

PublicIPAllocationMethod

Перечисление

Укажите тип выделения общедоступных IP-адресов

Значение	Описание
Dynamic
Static

ResilientVMDeletionStatus

Перечисление

Указывает состояние удаления отказоустойчивой виртуальной машины для виртуальной машины.

Значение	Описание
Enabled
Disabled
InProgress
Failed

ResourceIdentityType

Перечисление

Тип удостоверения, используемого для масштабируемого набора виртуальных машин. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" приведет к удалению удостоверений из масштабируемого набора виртуальных машин.

Значение	Описание
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

SecurityEncryptionTypes

Перечисление

Указывает тип шифрования управляемого диска. Он имеет значение DiskWithVMGuestState для шифрования управляемого диска вместе с большим двоичным объектом VMGuestState, VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для сохранения состояния встроенного ПО в BLOB-объекте VMGuestState. Примечание. Его можно задать только для конфиденциальных виртуальных машин.

Значение	Описание
VMGuestStateOnly
DiskWithVMGuestState
NonPersistedTPM

SecurityProfile

Object

Задает параметры профиля безопасности для масштабируемого набора виртуальных машин или виртуальной машины.

Имя	Тип	Описание
encryptionAtHost	boolean	Это свойство можно использовать пользователем в запросе, чтобы включить или отключить шифрование узла для виртуальной машины или масштабируемого набора виртуальных машин. Это позволит включить шифрование для всех дисков, включая диск Resource/Temp на самом узле. Поведение по умолчанию: шифрование на узле будет отключено, если для ресурса не задано значение true.
encryptionIdentity	EncryptionIdentity	Указывает управляемое удостоверение, используемое ADE для получения маркера доступа для операций keyvault.
proxyAgentSettings	ProxyAgentSettings	Задает параметры ProxyAgent при создании виртуальной машины. Минимальная версия API: 2023-09-01.
securityType	SecurityTypes	Указывает тип безопасности виртуальной машины. Для включения UefiSettings необходимо задать любое указанное значение. Поведение по умолчанию: UefiSettings не будет включен, если это свойство не задано.
uefiSettings	UefiSettings	Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины. Минимальная версия API: 2020-12-01.

SecurityTypes

Перечисление

Указывает тип безопасности виртуальной машины. Для включения UefiSettings необходимо задать любое указанное значение. Поведение по умолчанию: UefiSettings не будет включен, если это свойство не задано.

Значение	Описание
TrustedLaunch
ConfidentialVM

SettingNames

Перечисление

Указывает имя параметра, к которому применяется содержимое. Возможные значения: FirstLogonCommands и AutoLogon.

Значение	Описание
AutoLogon
FirstLogonCommands

Sku

Object

Описывает SKU масштабируемого набора виртуальных машин. ПРИМЕЧАНИЕ. Если новый номер SKU виртуальной машины не поддерживается на оборудовании, в настоящее время масштабируемый набор необходимо освободить виртуальные машины в масштабируемом наборе, прежде чем изменять имя SKU.

Имя	Тип	Описание
capacity	integer (int64)	Указывает количество виртуальных машин в масштабируемом наборе.
name	string	Имя SKU.
tier	string	Указывает уровень виртуальных машин в масштабируемом наборе. Возможные значения: Стандарт Базовая

SshConfiguration

Object

Конфигурация SSH для виртуальных машин под управлением Linux, работающих в Azure

Имя	Тип	Описание
publicKeys	SshPublicKey[]	Список открытых ключей SSH, используемых для проверки подлинности с помощью виртуальных машин на основе Linux.

SshPublicKey

Object

Содержит сведения о открытом ключе сертификата SSH и пути к виртуальной машине Linux, где размещается открытый ключ.

Имя	Тип	Описание
keyData	string	Сертификат открытого ключа SSH, используемый для проверки подлинности виртуальной машины через SSH. Ключ должен быть по крайней мере 2048-разрядным и в формате ssh-rsa. Сведения о создании ключей SSH см. в статье [Создание ключей SSH на виртуальных машинах Linux и Mac для Linux в Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).
path	string	Указывает полный путь на созданной виртуальной машине, где хранится открытый ключ SSH. Если файл уже существует, указанный ключ добавляется в файл. Пример: /home/user/.ssh/authorized_keys

StatusLevelTypes

Перечисление

Код уровня.

Значение	Описание
Info
Warning
Error

StorageAccountTypes

Перечисление

Указывает тип учетной записи хранения для управляемого диска. Тип учетной записи хранения управляемого диска ОС можно задать только при создании масштабируемого набора. ПРИМЕЧАНИЕ. UltraSSD_LRS можно использовать только с дисками данных. Его нельзя использовать с диском ОС. Standard_LRS использует HDD уровня "Стандартный". StandardSSD_LRS использует SSD уровня "Стандартный". Premium_LRS использует SSD уровня "Премиум". UltraSSD_LRS использует диск "Ультра". Premium_ZRS использует избыточное хранилище зоны SSD уровня "Премиум". StandardSSD_ZRS использует избыточное хранилище зоны SSD уровня "Стандартный". Дополнительные сведения о дисках, поддерживаемых для виртуальных машин Windows, см. в https://docs.microsoft.com/azure/virtual-machines/windows/disks-types и для виртуальных машин Linux см. в https://docs.microsoft.com/azure/virtual-machines/linux/disks-types

Значение	Описание
Standard_LRS
Premium_LRS
StandardSSD_LRS
UltraSSD_LRS
Premium_ZRS
StandardSSD_ZRS
PremiumV2_LRS

StorageProfile

Object

Задает параметры хранилища для дисков виртуальной машины.

Имя	Тип	Описание
alignRegionalDisksToVMZone	boolean	Указывает, должны ли региональные диски быть выровнены или перемещены в зону виртуальной машины. Это применимо только для виртуальных машин с набором свойств размещения. Обратите внимание, что это изменение является необратимым. Минимальная версия API: 2024-11-01.
dataDisks	DataDisk[]	Указывает параметры, используемые для добавления диска данных на виртуальную машину. Дополнительные сведения о дисках см. в статье Сведения о дисках и виртуальных жестких дисках для виртуальных машин Azure.
diskControllerType	DiskControllerTypes	Указывает тип контроллера диска, настроенный для виртуальной машины. Примечание. Это свойство будет иметь тип контроллера диска по умолчанию, если не указанная виртуальная машина создается с параметром HyperVGeneration, равным версии 2, в зависимости от возможностей диска операционной системы и размера виртуальной машины из указанной минимальной версии API. Перед обновлением типа контроллера диска необходимо освободить виртуальную машину, если вы не обновляете размер виртуальной машины в конфигурации виртуальной машины, которая неявно освобождает и перенаправляет виртуальную машину. Минимальная версия API: 2022-08-01.
imageReference	ImageReference	Указывает сведения об используемом изображении. Вы можете указать сведения о образах платформы, образах Marketplace или образах виртуальных машин. Этот элемент необходим, если вы хотите использовать образ платформы, образ Marketplace или образ виртуальной машины, но не используется в других операциях создания.
osDisk	OSDisk	Указывает сведения о диске операционной системы, используемом виртуальной машиной. Дополнительные сведения о дисках см. в статье Сведения о дисках и виртуальных жестких дисках для виртуальных машин Azure.

SubResource

Object

Имя	Тип	Описание
id	string	Идентификатор ресурса

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

UefiSettings

Object

Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины. Минимальная версия API: 2020-12-01.

Имя	Тип	Описание
secureBootEnabled	boolean	Указывает, следует ли включить безопасную загрузку на виртуальной машине. Минимальная версия API: 2020-12-01.
vTpmEnabled	boolean	Указывает, следует ли включить vTPM на виртуальной машине. Минимальная версия API: 2020-12-01.

UserAssignedIdentitiesValue

Object

Имя	Тип	Описание
clientId	string	Идентификатор клиента назначаемого пользователем удостоверения.
principalId	string	Идентификатор субъекта назначаемого пользователем удостоверения.

VaultCertificate

Object

Описывает одну ссылку на сертификат в Key Vault и расположение сертификата на виртуальной машине.

Имя	Тип	Описание
certificateStore	string	Для виртуальных машин Windows указывает хранилище сертификатов на виртуальной машине, в которую необходимо добавить сертификат. Указанное хранилище сертификатов неявно находится в учетной записи LocalMachine. Для виртуальных машин Linux файл сертификата помещается в каталог /var/lib/waagent с именем файла <TopcaseThumbprint>.crt для файла сертификата X509 и <TopcaseThumbprint>.prv для закрытого ключа. Оба этих файла имеют формат pem.
certificateUrl	string	Это URL-адрес сертификата, который был отправлен в Key Vault в качестве секрета. Сведения о добавлении секрета в Key Vault см. в статье Добавление ключа или секрета в хранилище ключей. В этом случае сертификат должен быть кодировкой Base64 следующего объекта JSON, который кодируется в UTF-8: {} "data":"<Base64-encoded-certificate>", "dataType":"pfx", "password":"<пароль-файл-файл"> } Чтобы установить сертификаты на виртуальной машине, рекомендуется использовать расширение виртуальной машины Azure Key Vault для Linux или расширение виртуальной машины Azure Key Vault для Windows.

VaultSecretGroup

Object

Описывает набор сертификатов, которые находятся в одном хранилище ключей.

Имя	Тип	Описание
sourceVault	SubResource	Относительный URL-адрес Хранилища ключей, содержащий все сертификаты в VaultCertificates.
vaultCertificates	VaultCertificate[]	Список ссылок на хранилище ключей в SourceVault, содержащий сертификаты.

VirtualHardDisk

Object

Описывает универсальный код ресурса (URI) диска.

Имя	Тип	Описание
uri	string	Задает универсальный код ресурса (URI) виртуального жесткого диска.

VirtualMachineAgentInstanceView

Object

Представление экземпляра агента виртуальной машины, работающего на виртуальной машине.

Имя	Тип	Описание
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	Представление экземпляра обработчика расширений виртуальной машины.
statuses	InstanceViewStatus[]	Сведения о состоянии ресурса.
vmAgentVersion	string	Полная версия агента виртуальной машины.

VirtualMachineExtension

Object

Описывает расширение виртуальной машины.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Географическое расположение, в котором находится ресурс
name	string	Имя ресурса
properties.autoUpgradeMinorVersion	boolean	Указывает, следует ли использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновлять дополнительные версии без повторного развертывания, даже если это свойство не имеет значения true.
properties.enableAutomaticUpgrade	boolean	Указывает, следует ли автоматически обновлять расширение платформой, если доступна более новая версия расширения.
properties.forceUpdateTag	string	Как обработчик расширений должен быть вынужден обновляться, даже если конфигурация расширения не изменилась.
properties.instanceView	VirtualMachineExtensionInstanceView	Представление экземпляра расширения виртуальной машины.
properties.protectedSettings		Расширение может содержать защищенные параметрыSettings или protectedSettingsFromKeyVault или не иметь защищенных параметров.
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	Защищенные расширения, передаваемые по ссылке, и используемые из хранилища ключей
properties.provisionAfterExtensions	string[]	Коллекция имен расширений, после которой необходимо подготовить это расширение.
properties.provisioningState	string	Состояние подготовки, которое отображается только в ответе.
properties.publisher	string	Имя издателя обработчика расширений.
properties.settings		Форматированные общедоступные параметры json для расширения.
properties.suppressFailures	boolean	Указывает, будут ли отключены сбои, возникающие из расширения (операционные сбои, такие как отсутствие подключения к виртуальной машине, не будут подавляться независимо от этого значения). Значение по умолчанию — false.
properties.type	string	Указывает тип расширения; примером является CustomScriptExtension.
properties.typeHandlerVersion	string	Указывает версию обработчика скрипта.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

VirtualMachineExtensionHandlerInstanceView

Object

Представление экземпляра обработчика расширений виртуальной машины.

Имя	Тип	Описание
status	InstanceViewStatus	Состояние обработчика расширения.
type	string	Указывает тип расширения; примером является CustomScriptExtension.
typeHandlerVersion	string	Указывает версию обработчика скрипта.

VirtualMachineExtensionInstanceView

Object

Представление экземпляра расширения виртуальной машины.

Имя	Тип	Описание
name	string	Имя расширения виртуальной машины.
statuses	InstanceViewStatus[]	Сведения о состоянии ресурса.
substatuses	InstanceViewStatus[]	Сведения о состоянии ресурса.
type	string	Указывает тип расширения; примером является CustomScriptExtension.
typeHandlerVersion	string	Указывает версию обработчика скрипта.

VirtualMachineHealthStatus

Object

Состояние работоспособности виртуальной машины.

Имя	Тип	Описание
status	InstanceViewStatus	Сведения о состоянии работоспособности виртуальной машины.

VirtualMachineIdentity

Object

Удостоверение виртуальной машины.

Имя	Тип	Описание
principalId	string	Идентификатор субъекта удостоверения виртуальной машины. Это свойство будет предоставлено только для назначаемого системой удостоверения.
tenantId	string	Идентификатор клиента, связанный с виртуальной машиной. Это свойство будет предоставлено только для назначаемого системой удостоверения.
type	ResourceIdentityType	Тип удостоверения, используемого для виртуальной машины. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" приведет к удалению удостоверений из виртуальной машины.
userAssignedIdentities	<string, UserAssignedIdentitiesValue>	Список удостоверений пользователей, связанных с виртуальной машиной. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

VirtualMachineIpTag

Object

Содержит тег IP, связанный с общедоступным IP-адресом.

Имя	Тип	Описание
ipTagType	string	Тип тега IP. Пример: FirstPartyUsage.
tag	string	Тег IP, связанный с общедоступным IP-адресом. Пример: SQL, хранилище и т. д.

VirtualMachineNetworkInterfaceConfiguration

Object

Описывает конфигурации сетевого интерфейса виртуальной машины.

Имя	Тип	Описание
name	string	Имя конфигурации сетевого интерфейса.
properties.auxiliaryMode	NetworkInterfaceAuxiliaryMode	Указывает, включен ли вспомогательный режим для ресурса сетевого интерфейса.
properties.auxiliarySku	NetworkInterfaceAuxiliarySku	Указывает, включен ли вспомогательный номер SKU для ресурса сетевого интерфейса.
properties.deleteOption	DeleteOptions	Укажите, что происходит с сетевым интерфейсом при удалении виртуальной машины
properties.disableTcpStateTracking	boolean	Указывает, отключен ли сетевой интерфейс для отслеживания состояния tcp.
properties.dnsSettings	VirtualMachineNetworkInterfaceDnsSettingsConfiguration	Параметры DNS, применяемые к сетевым интерфейсам.
properties.dscpConfiguration	SubResource
properties.enableAcceleratedNetworking	boolean	Указывает, включен ли сетевой интерфейс.
properties.enableFpga	boolean	Указывает, включен ли сетевой интерфейс FPGA в сети.
properties.enableIPForwarding	boolean	Включена ли переадресация IP-адресов для этой сетевой карты.
properties.ipConfigurations	VirtualMachineNetworkInterfaceIPConfiguration[]	Указывает IP-конфигурации сетевого интерфейса.
properties.networkSecurityGroup	SubResource	Группа безопасности сети.
properties.primary	boolean	Указывает основной сетевой интерфейс в случае, если виртуальная машина имеет более 1 сетевого интерфейса.

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

Object

Описывает параметры DNS конфигурации сети виртуальных машин.

Имя	Тип	Описание
dnsServers	string[]	Список IP-адресов DNS-серверов

VirtualMachineNetworkInterfaceIPConfiguration

Object

Описывает IP-конфигурацию профиля сети виртуальной машины.

Имя	Тип	Описание
name	string	Имя ip-конфигурации.
properties.applicationGatewayBackendAddressPools	SubResource[]	Задает массив ссылок на серверные пулы адресов шлюзов приложений. Виртуальная машина может ссылаться на пулы внутренних адресов нескольких шлюзов приложений. Несколько виртуальных машин не могут использовать один шлюз приложений.
properties.applicationSecurityGroups	SubResource[]	Задает массив ссылок на группу безопасности приложений.
properties.loadBalancerBackendAddressPools	SubResource[]	Задает массив ссылок на серверные пулы адресов подсистем балансировки нагрузки. Виртуальная машина может ссылаться на пулы адресов серверной части одной общедоступной и одной внутренней подсистемы балансировки нагрузки. [Несколько виртуальных машин не могут использовать один и тот же базовый подсистема балансировки нагрузки SKU].
properties.primary	boolean	Указывает основной сетевой интерфейс в случае, если виртуальная машина имеет более 1 сетевого интерфейса.
properties.privateIPAddressVersion	IPVersions	Доступно из Api-Version 2017-03-30, он представляет, является ли конкретная ipconfiguration IPv4 или IPv6. По умолчанию используется протокол IPv4. Возможные значения: "IPv4" и "IPv6".
properties.publicIPAddressConfiguration	VirtualMachinePublicIPAddressConfiguration	PublicIPAddressConfiguration.
properties.subnet	SubResource	Указывает идентификатор подсети.

VirtualMachinePublicIPAddressConfiguration

Object

Описывает конфигурацию PublicIPAddress для виртуальных машин

Имя	Тип	Описание
name	string	Имя конфигурации адреса publicIP.
properties.deleteOption	DeleteOptions	Укажите, что происходит с общедоступным IP-адресом при удалении виртуальной машины
properties.dnsSettings	VirtualMachinePublicIPAddressDnsSettingsConfiguration	Параметры DNS, применяемые к общедоступным АДРЕСАм.
properties.idleTimeoutInMinutes	integer (int32)	Время ожидания простоя общедоступного IP-адреса.
properties.ipTags	VirtualMachineIpTag[]	Список тегов IP-адресов, связанных с общедоступным IP-адресом.
properties.publicIPAddressVersion	IPVersions	Доступно из Api-Version 2019-07-01, он представляет, является ли конкретная ipconfiguration IPv4 или IPv6. По умолчанию используется протокол IPv4. Возможные значения: "IPv4" и "IPv6".
properties.publicIPAllocationMethod	PublicIPAllocationMethod	Укажите тип выделения общедоступных IP-адресов
properties.publicIPPrefix	SubResource	PublicIPPrefix, из которого следует выделить адреса publicIP.
sku	PublicIPAddressSku	Описывает номер SKU общедоступного IP-адреса. Его можно задать только с помощью OrchestrationMode как гибкий.

VirtualMachinePublicIPAddressDnsSettingsConfiguration

Object

Описывает параметры DNS конфигурации сети виртуальных машин.

Имя	Тип	Описание
domainNameLabel	string	Префикс метки имени домена для ресурсов PublicIPAddress, которые будут созданы. Созданная метка имени — это объединение метки доменного имени и уникального идентификатора сетевого профиля виртуальной машины.
domainNameLabelScope	DomainNameLabelScopeTypes	Область метки доменного имени для ресурсов PublicIPAddress, которые будут созданы. Созданная метка имени — это объединение метки хэшированного доменного имени с политикой в соответствии с областью метки доменного имени и уникальным идентификатором профиля сети виртуальной машины.

VirtualMachineScaleSetIPConfiguration

Object

Описывает ip-конфигурацию сетевого профиля масштабируемого набора виртуальных машин.

Имя	Тип	Описание
name	string	Имя ip-конфигурации.
properties.applicationGatewayBackendAddressPools	SubResource[]	Задает массив ссылок на серверные пулы адресов шлюзов приложений. Масштабируемый набор может ссылаться на пулы внутренних адресов нескольких шлюзов приложений. Несколько масштабируемых наборов не могут использовать один и тот же шлюз приложений.
properties.applicationSecurityGroups	SubResource[]	Задает массив ссылок на группу безопасности приложений.
properties.loadBalancerBackendAddressPools	SubResource[]	Задает массив ссылок на серверные пулы адресов подсистем балансировки нагрузки. Масштабируемый набор может ссылаться на пулы внутренних адресов одной общедоступной и одной внутренней подсистемы балансировки нагрузки. Несколько масштабируемых наборов не могут использовать один и тот же базовый балансировщик нагрузки SKU.
properties.loadBalancerInboundNatPools	SubResource[]	Задает массив ссылок на входящие пулы NAT подсистем балансировки нагрузки. Масштабируемый набор может ссылаться на входящие пулы NAT одного общедоступного и одного внутреннего балансировщика нагрузки. Несколько масштабируемых наборов не могут использовать один и тот же базовый балансировщик нагрузки SKU.
properties.primary	boolean	Указывает основной сетевой интерфейс в случае, если виртуальная машина имеет более 1 сетевого интерфейса.
properties.privateIPAddressVersion	IPVersion	Доступно из Api-Version 2017-03-30, он представляет, является ли конкретная ipconfiguration IPv4 или IPv6. По умолчанию используется протокол IPv4. Возможные значения: "IPv4" и "IPv6".
properties.publicIPAddressConfiguration	VirtualMachineScaleSetPublicIPAddressConfiguration	PublicIPAddressConfiguration.
properties.subnet	ApiEntityReference	Указывает идентификатор подсети.

VirtualMachineScaleSetIpTag

Object

Содержит тег IP, связанный с общедоступным IP-адресом.

Имя	Тип	Описание
ipTagType	string	Тип тега IP. Пример: FirstPartyUsage.
tag	string	Тег IP, связанный с общедоступным IP-адресом. Пример: SQL, хранилище и т. д.

VirtualMachineScaleSetNetworkConfiguration

Object

Описывает конфигурации сети сетевого профиля масштабируемого набора виртуальных машин.

Имя	Тип	Описание
name	string	Имя конфигурации сети.
properties.auxiliaryMode	NetworkInterfaceAuxiliaryMode	Указывает, включен ли вспомогательный режим для ресурса сетевого интерфейса.
properties.auxiliarySku	NetworkInterfaceAuxiliarySku	Указывает, включен ли вспомогательный номер SKU для ресурса сетевого интерфейса.
properties.deleteOption	DeleteOptions	Укажите, что происходит с сетевым интерфейсом при удалении виртуальной машины
properties.disableTcpStateTracking	boolean	Указывает, отключен ли сетевой интерфейс для отслеживания состояния tcp.
properties.dnsSettings	VirtualMachineScaleSetNetworkConfigurationDnsSettings	Параметры DNS, применяемые к сетевым интерфейсам.
properties.enableAcceleratedNetworking	boolean	Указывает, включен ли сетевой интерфейс.
properties.enableFpga	boolean	Указывает, включен ли сетевой интерфейс FPGA в сети.
properties.enableIPForwarding	boolean	Включена ли переадресация IP-адресов для этой сетевой карты.
properties.ipConfigurations	VirtualMachineScaleSetIPConfiguration[]	Указывает IP-конфигурации сетевого интерфейса.
properties.networkSecurityGroup	SubResource	Группа безопасности сети.
properties.primary	boolean	Указывает основной сетевой интерфейс в случае, если виртуальная машина имеет более 1 сетевого интерфейса.

VirtualMachineScaleSetNetworkConfigurationDnsSettings

Object

Описывает параметры DNS конфигурации конфигурации сети масштабируемых наборов виртуальных машин.

Имя	Тип	Описание
dnsServers	string[]	Список IP-адресов DNS-серверов

VirtualMachineScaleSetPublicIPAddressConfiguration

Object

Описание конфигурации publicIPAddress масштабируемого набора виртуальных машин

Имя	Тип	Описание
name	string	Имя конфигурации адреса publicIP.
properties.deleteOption	DeleteOptions	Укажите, что происходит с общедоступным IP-адресом при удалении виртуальной машины
properties.dnsSettings	VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings	Параметры DNS, применяемые к общедоступным АДРЕСАм.
properties.idleTimeoutInMinutes	integer (int32)	Время ожидания простоя общедоступного IP-адреса.
properties.ipTags	VirtualMachineScaleSetIpTag[]	Список тегов IP-адресов, связанных с общедоступным IP-адресом.
properties.publicIPAddressVersion	IPVersion	Доступно из Api-Version 2019-07-01, он представляет, является ли конкретная ipconfiguration IPv4 или IPv6. По умолчанию используется протокол IPv4. Возможные значения: "IPv4" и "IPv6".
properties.publicIPPrefix	SubResource	PublicIPPrefix, из которого следует выделить адреса publicIP.
sku	PublicIPAddressSku	Описывает номер SKU общедоступного IP-адреса. Его можно задать только с помощью OrchestrationMode как гибкий.

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

Object

Описывает параметры DNS конфигурации конфигурации сети масштабируемых наборов виртуальных машин.

Имя	Тип	Описание
domainNameLabel	string	Метка доменного имени. Объединение метки доменного имени и индекса виртуальной машины будет метками доменных имен ресурсов PublicIPAddress, которые будут созданы.
domainNameLabelScope	DomainNameLabelScopeTypes	Область метки доменного имени. Объединение метки хэшированного доменного имени, созданной в соответствии с политикой из области метки доменного имени и индексом виртуальной машины, будет метками доменных имен ресурсов PublicIPAddress, которые будут созданы.

VirtualMachineScaleSetVM

Object

Описывает виртуальную машину масштабируемого набора виртуальных машин.

Имя	Тип	Описание
etag	string	Etag — это свойство, возвращаемое в ответе update/Get виртуальной машины VMSS, чтобы клиент смог предоставить его в заголовке, чтобы обеспечить оптимистические обновления.
id	string	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	VirtualMachineIdentity	Удостоверение виртуальной машины, если настроено.
instanceId	string	Идентификатор экземпляра виртуальной машины.
location	string	Географическое расположение, в котором находится ресурс
name	string	Имя ресурса
plan	Plan	Указывает сведения об образе Marketplace, используемом для создания виртуальной машины. Этот элемент используется только для образов Marketplace. Прежде чем использовать образ Marketplace из API, необходимо включить образ для программного использования. На портале Azure найдите образ Marketplace, который вы хотите использовать, а затем щелкните Хотите развернуть программным способом, Get Started (Начало работы—>). Введите все необходимые сведения и нажмите кнопку Сохранить.
properties.additionalCapabilities	AdditionalCapabilities	Указывает дополнительные возможности, включенные или отключенные на виртуальной машине в масштабируемом наборе. Например, имеет ли виртуальная машина возможность подключения управляемых дисков данных с типом учетной записи хранения UltraSSD_LRS.
properties.availabilitySet	SubResource	Указывает сведения о группе доступности, к которому должна быть назначена виртуальная машина. Виртуальные машины, указанные в одном наборе доступности, выделяются различным узлам для обеспечения максимальной доступности. Дополнительные сведения о группах доступности см. в обзоренаборов доступности. Дополнительные сведения о плановом обслуживании Azure см. в статье Обслуживание и обновления виртуальных машин в Azure. В настоящее время виртуальная машина может быть добавлена только в группу доступности во время создания. Существующую виртуальную машину нельзя добавить в группу доступности.
properties.diagnosticsProfile	DiagnosticsProfile	Указывает состояние параметров диагностики загрузки. Минимальная версия API: 2015-06-15.
properties.hardwareProfile	HardwareProfile	Указывает параметры оборудования для виртуальной машины.
properties.instanceView	VirtualMachineScaleSetVMInstanceView	Представление экземпляра виртуальной машины.
properties.latestModelApplied	boolean	Указывает, применена ли последняя модель к виртуальной машине.
properties.licenseType	string	Указывает, что используемый образ или диск лицензирован локально. Возможные значения операционной системы Windows Server: Windows_Client Windows_Server Возможные значения операционной системы Linux Server: RHEL_BYOS (для RHEL) SLES_BYOS (для SUSE) Дополнительные сведения см. в статье Преимущество гибридного использования Azure для Windows Server преимущество гибридного использования Azure для Linux Server Минимальная версия API: 2015-06-15
properties.modelDefinitionApplied	string	Указывает, является ли модель, примененная к виртуальной машине, моделью масштабируемого набора виртуальных машин или настраиваемой моделью для виртуальной машины.
properties.networkProfile	NetworkProfile	Указывает сетевые интерфейсы виртуальной машины.
properties.networkProfileConfiguration	VirtualMachineScaleSetVMNetworkProfileConfiguration	Указывает конфигурацию сетевого профиля виртуальной машины.
properties.osProfile	OSProfile	Задает параметры операционной системы для виртуальной машины.
properties.protectionPolicy	VirtualMachineScaleSetVMProtectionPolicy	Задает политику защиты виртуальной машины.
properties.provisioningState	string	Состояние подготовки, которое отображается только в ответе.
properties.resilientVMDeletionStatus	ResilientVMDeletionStatus	Указывает состояние удаления отказоустойчивой виртуальной машины для виртуальной машины.
properties.securityProfile	SecurityProfile	Указывает параметры профиля, связанного с безопасностью для виртуальной машины.
properties.storageProfile	StorageProfile	Задает параметры хранилища для дисков виртуальной машины.
properties.timeCreated	string (date-time)	Указывает время создания ресурса виртуальной машины. Минимальная версия API: 2021-11-01.
properties.userData	string	UserData для виртуальной машины, которая должна быть закодирована в кодировке Base-64. Клиент не должен передавать здесь какие-либо секреты. Минимальная версия API: 2021-03-01
properties.vmId	string	Уникальный идентификатор виртуальной машины Azure.
resources	VirtualMachineExtension[]	Ресурсы дочернего расширения виртуальной машины.
sku	Sku	Номер SKU виртуальной машины.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"
zones	string[]	Зоны виртуальных машин.

VirtualMachineScaleSetVMInstanceView

Object

Представление экземпляра виртуальной машины масштабируемого набора виртуальных машин.

Имя	Тип	Описание
assignedHost	string	Идентификатор ресурса выделенного узла, на котором виртуальная машина выделяется с помощью автоматического размещения, когда виртуальная машина связана с выделенной группой узлов с включенным автоматическим размещением. Минимальная версия API: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	Диагностика загрузки — это функция отладки, которая позволяет просматривать выходные данные консоли и снимок экрана для диагностики состояния виртуальной машины. Вы можете легко просмотреть выходные данные журнала консоли. Azure также позволяет просмотреть снимок экрана виртуальной машины из гипервизора.
computerName	string	Указывает имя ОС узла виртуальной машины. Это имя невозможно обновить после создания виртуальной машины. Максимальная длина (Windows): 15 символов Максимальная длина (Linux): 64 символов. Соглашения об именовании и ограничения см. в руководства по реализации служб инфраструктуры Azure.
disks	DiskInstanceView[]	Сведения о дисках.
extensions	VirtualMachineExtensionInstanceView[]	Сведения о расширениях.
hyperVGeneration	HyperVGeneration	Создание гипервизора виртуальной машины [V1, V2]
maintenanceRedeployStatus	MaintenanceRedeployStatus	Состояние операции обслуживания на виртуальной машине.
osName	string	Операционная система, запущенная на гибридном компьютере.
osVersion	string	Версия операционной системы, запущенной на гибридном компьютере.
placementGroupId	string	Группа размещения, в которой выполняется виртуальная машина. Если виртуальная машина освобождена, у нее не будет идентификатора placementGroupId.
platformFaultDomain	integer (int32)	Число доменов сбоя.
platformUpdateDomain	integer (int32)	Число доменов обновления.
rdpThumbPrint	string	Отпечаток сертификата удаленного рабочего стола.
statuses	InstanceViewStatus[]	Сведения о состоянии ресурса.
vmAgent	VirtualMachineAgentInstanceView	Агент виртуальной машины, работающий на виртуальной машине.
vmHealth	VirtualMachineHealthStatus	Состояние работоспособности виртуальной машины.

VirtualMachineScaleSetVMNetworkProfileConfiguration

Object

Описывает профиль сети виртуальной машины масштабируемого набора виртуальных машин.

Имя	Тип	Описание
networkInterfaceConfigurations	VirtualMachineScaleSetNetworkConfiguration[]	Список конфигураций сети.

VirtualMachineScaleSetVMProtectionPolicy

Object

Политика защиты виртуальной машины масштабируемого набора виртуальных машин.

Имя	Тип	Описание
protectFromScaleIn	boolean	Указывает, что виртуальная машина масштабируемого набора виртуальных машин не должна рассматриваться для удаления во время операции масштабирования.
protectFromScaleSetActions	boolean	Указывает, что обновления или действия модели (включая масштабирование), инициированные в масштабируемом наборе виртуальных машин, не должны применяться к виртуальной машине масштабируемого набора виртуальных машин.

VirtualMachineSizeTypes

Перечисление

Указывает размер виртуальной машины. В настоящее время тип данных перечисления устарел и будет удален 23 декабря 2023 года. Рекомендуемый способ получить список доступных размеров использует следующие API: перечислить все доступные размеры виртуальных машин в группе доступности, Перечислить все доступные размеры виртуальных машин в регионе, перечислить все доступные размеры виртуальных машин для изменения размера. Дополнительные сведения о размерах виртуальных машин см. в разделе Размеры виртуальных машин. Доступные размеры виртуальных машин зависят от региона и группы доступности.

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

VMDiskSecurityProfile

Object

Задает параметры профиля безопасности для управляемого диска. Примечание. его можно задать только для конфиденциальных виртуальных машин.

Имя	Тип	Описание
diskEncryptionSet	DiskEncryptionSetParameters	Указывает идентификатор ресурса набора ресурсов шифрования управляемых пользователем дисков для управляемого диска, который используется для зашифрованного диска ОПЕРАЦИОННОй системы Конфиденциальной виртуальной машины и большого двоичного объекта VMGuest.
securityEncryptionType	SecurityEncryptionTypes	Указывает тип шифрования управляемого диска. Он имеет значение DiskWithVMGuestState для шифрования управляемого диска вместе с большим двоичным объектом VMGuestState, VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для сохранения состояния встроенного ПО в BLOB-объекте VMGuestState. Примечание. Его можно задать только для конфиденциальных виртуальных машин.

VMSizeProperties

Object

Задает параметры свойства размера виртуальной машины на виртуальной машине.

Имя	Тип	Описание
vCPUsAvailable	integer (int32)	Указывает количество виртуальных ЦП, доступных для виртуальной машины. Если это свойство не указано в тексте запроса, поведение по умолчанию — задать для него значение виртуальных ЦП, доступных для этого размера виртуальной машины, предоставляемого в ответе api Список всех доступных размеров виртуальных машин в регионе.
vCPUsPerCore	integer (int32)	Указывает отношение виртуальных ЦП к физическому ядру. Если это свойство не указано в тексте запроса, поведение по умолчанию присваивается значению vCPUsPerCore для размера виртуальной машины, предоставленного в ответе api Список всех доступных размеров виртуальных машин в регионе. параметру этого свойства значение 1 также означает, что гиперпоток отключен.

WindowsConfiguration

Object

Указывает параметры операционной системы Windows на виртуальной машине.

Имя	Тип	Описание
additionalUnattendContent	AdditionalUnattendContent[]	Указывает дополнительные сведения в формате XML в кодировке Base-64, которые можно включить в файл Unattend.xml, который используется программой установки Windows.
enableAutomaticUpdates	boolean	Указывает, включено ли автоматическое обновление для виртуальной машины Windows. Значение по умолчанию — «истина». Для масштабируемых наборов виртуальных машин это свойство можно обновить, и обновления вступают в силу при повторной подготовке ОС.
enableVMAgentPlatformUpdates	boolean	Указывает, включены ли обновления платформы VMAgent для виртуальной машины Windows.
patchSettings	PatchSettings	[Предварительная версия компонента] Указывает параметры, связанные с исправлением гостевой виртуальной машины в Windows.
provisionVMAgent	boolean	Указывает, следует ли подготовить агент виртуальной машины на виртуальной машине. Если это свойство не указано в тексте запроса, оно по умолчанию имеет значение true. Это гарантирует, что агент виртуальной машины установлен на виртуальной машине, чтобы расширения можно было добавить в виртуальную машину позже.
timeZone	string	Указывает часовой пояс виртуальной машины. Например, "Тихоокеанское стандартное время". Возможные значения можно TimeZoneInfo.Id из часовых поясов, возвращаемых TimeZoneInfo.GetSystemTimeZones.
winRM	WinRMConfiguration	Задает прослушиватели удаленного управления Windows. Это позволяет удаленно использовать Windows PowerShell.

WindowsPatchAssessmentMode

Перечисление

Указывает режим оценки исправлений гостевой виртуальной машины для виртуальной машины IaaS.

Возможны следующие значения:

ImageDefault. Вы управляете временем оценки исправлений на виртуальной машине.

AutomaticByPlatform . Платформа будет запускать периодические оценки исправлений. Свойство provisionVMAgent должно быть true.

Значение	Описание
ImageDefault
AutomaticByPlatform

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Перечисление

Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform.

Значение	Описание
Unknown
IfRequired
Never
Always

WindowsVMGuestPatchAutomaticByPlatformSettings

Object

Указывает дополнительные параметры, применяемые при выборе режима исправления AutomaticByPlatform в параметрах исправлений Windows.

Имя	Тип	Описание
bypassPlatformSafetyChecksOnUserSchedule	boolean	Позволяет клиенту планировать исправление без случайного обновления
rebootSetting	WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Задает параметр перезагрузки для всех операций установки исправлений AutomaticByPlatform.

WindowsVMGuestPatchMode

Перечисление

Указывает режим гостевой исправления виртуальной машины на виртуальную машину IaaS или виртуальные машины, связанные с масштабируемым набором виртуальных машин с OrchestrationMode как гибкий.

Возможны следующие значения:

вручную . Вы управляете применением исправлений к виртуальной машине. Это можно сделать, применяя исправления вручную внутри виртуальной машины. В этом режиме автоматические обновления отключены; Свойство WindowsConfiguration.enableAutomaticUpdates должно быть false

automaticByOS. Виртуальная машина автоматически обновляется ОС. Свойство WindowsConfiguration.enableAutomaticUpdates должно иметь значение true.

AutomaticByPlatform — виртуальная машина автоматически обновляется платформой. Свойства provisionVMAgent и WindowsConfiguration.enableAutomaticUpdates должны иметь значение true.

Значение	Описание
Manual
AutomaticByOS
AutomaticByPlatform

WinRMConfiguration

Object

Описание конфигурации удаленного управления Windows виртуальной машины

Имя	Тип	Описание
listeners	WinRMListener[]	Список прослушивателей удаленного управления Windows

WinRMListener

Object

Описание протокола и отпечатка прослушивателя удаленного управления Windows

Имя	Тип	Описание
certificateUrl	string	Это URL-адрес сертификата, который был отправлен в Key Vault в качестве секрета. Сведения о добавлении секрета в Key Vault см. в статье Добавление ключа или секрета в хранилище ключей. В этом случае сертификат должен быть кодировкой Base64 следующего объекта JSON, который кодируется в UTF-8: {} "data":"<Base64-encoded-certificate>", "dataType":"pfx", "password":"<пароль-файл-файл"> } Чтобы установить сертификаты на виртуальной машине, рекомендуется использовать расширение виртуальной машины Azure Key Vault для Linux или расширение виртуальной машины Azure Key Vault для Windows.
protocol	ProtocolTypes	Задает протокол прослушивателя WinRM. Возможные значения: http,https.

Поделиться через

Virtual Machine Scale Set VMs - Get

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

Get VM scale set VM with ResiliencyView

Образец запроса

Пример ответа

Get VM scale set VM with UserData

Образец запроса

Пример ответа

Get VM scale set VM with VMSizeProperties

Образец запроса

Пример ответа

Определения

AdditionalCapabilities

AdditionalUnattendContent

ApiEntityReference

ApiError

ApiErrorBase

BootDiagnostics

BootDiagnosticsInstanceView

CachingTypes

CloudError

ComponentNames

createdByType

DataDisk

DeleteOptions

DiagnosticsProfile

DiffDiskOptions

DiffDiskPlacement

DiffDiskSettings

DiskControllerTypes

DiskCreateOptionTypes

DiskDeleteOptionTypes

DiskDetachOptionTypes

DiskEncryptionSetParameters

DiskEncryptionSettings

DiskInstanceView

DomainNameLabelScopeTypes

EncryptionIdentity

HardwareProfile

HostEndpointSettings

HyperVGeneration

ImageReference

InnerError

InstanceViewStatus

InstanceViewTypes

IPVersion

IPVersions

KeyVaultKeyReference

KeyVaultSecretReference

LinuxConfiguration

LinuxPatchAssessmentMode

LinuxPatchSettings

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

LinuxVMGuestPatchAutomaticByPlatformSettings

LinuxVMGuestPatchMode

MaintenanceOperationResultCodeTypes

MaintenanceRedeployStatus

ManagedDiskParameters

Mode

Modes

NetworkApiVersion

NetworkInterfaceAuxiliaryMode

NetworkInterfaceAuxiliarySku

NetworkInterfaceReference

NetworkProfile

OperatingSystemTypes

OSDisk

OSProfile

PassNames

PatchSettings

Plan

ProtocolTypes

ProxyAgentSettings

PublicIPAddressSku