Virtual Machines - Get

Служба:

Compute

Версия API:

2024-07-01

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

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

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
vmName	path	True	string	Имя виртуальной машины.
api-version	query	True	string	Версия клиентского API.
$expand	query		InstanceViewTypes	Выражение расширения, применяемое к операции. InstanceView извлекает моментальный снимок свойств среды выполнения виртуальной машины, управляемой платформой, и может изменяться вне операций плоскости управления. UserData извлекает свойство UserData как часть представления модели виртуальной машины, предоставленного пользователем во время операции создания и обновления виртуальной машины.

Ответы

Имя	Тип	Описание
200 OK	VirtualMachine	ХОРОШО
Other Status Codes	CloudError	Ответ на ошибку, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Области

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

Примеры

Get a virtual machine placed on a dedicated host group through automatic placement

Get a virtual machine with Disk Controller Type Properties

Get a virtual machine with VM Size Properties

Get a Virtual Machine.

Get a virtual machine placed on a dedicated host group through automatic placement

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

HTTP

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

Java

/**
 * Samples for VirtualMachines GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
     * virtualMachineExamples/VirtualMachine_Get_AutoPlacedOnDedicatedHostGroup.json
     */
    /**
     * Sample code: Get a virtual machine placed on a dedicated host group through automatic placement.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAVirtualMachinePlacedOnADedicatedHostGroupThroughAutomaticPlacement(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachines()
            .getByResourceGroupWithResponse("myResourceGroup", "myVM", null, com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_get_auto_placed_on_dedicated_host_group.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_machines.get(
        resource_group_name="myResourceGroup",
        vm_name="myVM",
    )
    print(response)


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

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

Go

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_Get_AutoPlacedOnDedicatedHostGroup.json
func ExampleVirtualMachinesClient_Get_getAVirtualMachinePlacedOnADedicatedHostGroupThroughAutomaticPlacement() {
	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.NewVirtualMachinesClient().Get(ctx, "myResourceGroup", "myVM", &armcompute.VirtualMachinesClientGetOptions{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.VirtualMachine = armcompute.VirtualMachine{
	// 	Name: to.Ptr("myVM"),
	// 	Type: to.Ptr("Microsoft.Compute/virtualMachines"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"myTag1": to.Ptr("tagValue1"),
	// 	},
	// 	Properties: &armcompute.VirtualMachineProperties{
	// 		HardwareProfile: &armcompute.HardwareProfile{
	// 			VMSize: to.Ptr(armcompute.VirtualMachineSizeTypesStandardD2SV3),
	// 		},
	// 		HostGroup: &armcompute.SubResource{
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"),
	// 		},
	// 		NetworkProfile: &armcompute.NetworkProfile{
	// 			NetworkInterfaces: []*armcompute.NetworkInterfaceReference{
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"),
	// 			}},
	// 		},
	// 		OSProfile: &armcompute.OSProfile{
	// 			AdminUsername: to.Ptr("admin"),
	// 			ComputerName: to.Ptr("myVM"),
	// 			Secrets: []*armcompute.VaultSecretGroup{
	// 			},
	// 			WindowsConfiguration: &armcompute.WindowsConfiguration{
	// 				EnableAutomaticUpdates: to.Ptr(false),
	// 				ProvisionVMAgent: to.Ptr(true),
	// 			},
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		StorageProfile: &armcompute.StorageProfile{
	// 			DataDisks: []*armcompute.DataDisk{
	// 			},
	// 			ImageReference: &armcompute.ImageReference{
	// 				Offer: to.Ptr("WindowsServer"),
	// 				Publisher: to.Ptr("MicrosoftWindowsServer"),
	// 				SKU: to.Ptr("2016-Datacenter"),
	// 				Version: to.Ptr("latest"),
	// 			},
	// 			OSDisk: &armcompute.OSDisk{
	// 				Name: to.Ptr("myOsDisk"),
	// 				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/myOsDisk"),
	// 					StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 				},
	// 				OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 			},
	// 		},
	// 		VMID: to.Ptr("0f47b100-583c-48e3-a4c0-aefc2c9bbcc1"),
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Retrieves information about the model view or the instance view of a virtual machine.
 *
 * @summary Retrieves information about the model view or the instance view of a virtual machine.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_Get_AutoPlacedOnDedicatedHostGroup.json
 */
async function getAVirtualMachinePlacedOnADedicatedHostGroupThroughAutomaticPlacement() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmName = "myVM";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.get(resourceGroupName, vmName);
  console.log(result);
}

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

dotnet

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

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

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

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this VirtualMachineResource
VirtualMachineCollection collection = resourceGroupResource.GetVirtualMachines();

// invoke the operation
string vmName = "myVM";
NullableResponse<VirtualMachineResource> response = await collection.GetIfExistsAsync(vmName);
VirtualMachineResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    VirtualMachineData 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": "myVM",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "location": "West US",
  "tags": {
    "myTag1": "tagValue1"
  },
  "properties": {
    "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1",
    "hostGroup": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"
    },
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2016-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "osType": "Windows",
        "name": "myOsDisk",
        "createOption": "FromImage",
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS",
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
        },
        "diskSizeGB": 30
      },
      "dataDisks": []
    },
    "osProfile": {
      "computerName": "myVM",
      "adminUsername": "admin",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": false
      },
      "secrets": []
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"
        }
      ]
    },
    "provisioningState": "Succeeded"
  }
}

Get a virtual machine with Disk Controller Type Properties

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

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?$expand=userData&api-version=2024-07-01

Java

import com.azure.resourcemanager.compute.models.InstanceViewTypes;

/**
 * Samples for VirtualMachines GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
     * virtualMachineExamples/VirtualMachine_Get_WithDiskControllerType.json
     */
    /**
     * Sample code: Get a virtual machine with Disk Controller Type Properties.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getAVirtualMachineWithDiskControllerTypeProperties(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachines().getByResourceGroupWithResponse(
            "myResourceGroup", "myVM", InstanceViewTypes.USER_DATA, com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_get_with_disk_controller_type.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_machines.get(
        resource_group_name="myResourceGroup",
        vm_name="myVM",
    )
    print(response)


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

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

Go

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_Get_WithDiskControllerType.json
func ExampleVirtualMachinesClient_Get_getAVirtualMachineWithDiskControllerTypeProperties() {
	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.NewVirtualMachinesClient().Get(ctx, "myResourceGroup", "myVM", &armcompute.VirtualMachinesClientGetOptions{Expand: to.Ptr(armcompute.InstanceViewTypesUserData)})
	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.VirtualMachine = armcompute.VirtualMachine{
	// 	Name: to.Ptr("myVM"),
	// 	Type: to.Ptr("Microsoft.Compute/virtualMachines"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"myTag1": to.Ptr("tagValue1"),
	// 	},
	// 	Properties: &armcompute.VirtualMachineProperties{
	// 		ApplicationProfile: &armcompute.ApplicationProfile{
	// 			GalleryApplications: []*armcompute.VMGalleryApplication{
	// 				{
	// 					ConfigurationReference: to.Ptr("https://mystorageaccount.blob.core.windows.net/configurations/settings.config"),
	// 					Order: to.Ptr[int32](1),
	// 					PackageReferenceID: to.Ptr("/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0"),
	// 					Tags: to.Ptr("myTag1"),
	// 				},
	// 				{
	// 					PackageReferenceID: to.Ptr("/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"),
	// 			}},
	// 		},
	// 		AvailabilitySet: &armcompute.SubResource{
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet"),
	// 		},
	// 		DiagnosticsProfile: &armcompute.DiagnosticsProfile{
	// 			BootDiagnostics: &armcompute.BootDiagnostics{
	// 				Enabled: to.Ptr(true),
	// 				StorageURI: to.Ptr("http://{myStorageAccount}.blob.core.windows.net"),
	// 			},
	// 		},
	// 		ExtensionsTimeBudget: to.Ptr("PT50M"),
	// 		HardwareProfile: &armcompute.HardwareProfile{
	// 			VMSize: to.Ptr(armcompute.VirtualMachineSizeTypesStandardDS3V2),
	// 			VMSizeProperties: &armcompute.VMSizeProperties{
	// 				VCPUsAvailable: to.Ptr[int32](1),
	// 				VCPUsPerCore: to.Ptr[int32](1),
	// 			},
	// 		},
	// 		NetworkProfile: &armcompute.NetworkProfile{
	// 			NetworkInterfaces: []*armcompute.NetworkInterfaceReference{
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"),
	// 			}},
	// 		},
	// 		OSProfile: &armcompute.OSProfile{
	// 			AdminUsername: to.Ptr("admin"),
	// 			ComputerName: to.Ptr("myVM"),
	// 			Secrets: []*armcompute.VaultSecretGroup{
	// 			},
	// 			WindowsConfiguration: &armcompute.WindowsConfiguration{
	// 				EnableAutomaticUpdates: to.Ptr(false),
	// 				ProvisionVMAgent: to.Ptr(true),
	// 			},
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		StorageProfile: &armcompute.StorageProfile{
	// 			DataDisks: []*armcompute.DataDisk{
	// 				{
	// 					Name: to.Ptr("myDataDisk0"),
	// 					Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 					CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesEmpty),
	// 					DiskSizeGB: to.Ptr[int32](30),
	// 					Lun: to.Ptr[int32](0),
	// 					ManagedDisk: &armcompute.ManagedDiskParameters{
	// 						ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0"),
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 					},
	// 				},
	// 				{
	// 					Name: to.Ptr("myDataDisk1"),
	// 					Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 					CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesAttach),
	// 					DiskSizeGB: to.Ptr[int32](100),
	// 					Lun: to.Ptr[int32](1),
	// 					ManagedDisk: &armcompute.ManagedDiskParameters{
	// 						ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1"),
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 					},
	// 			}},
	// 			DiskControllerType: to.Ptr(armcompute.DiskControllerTypesNVMe),
	// 			ImageReference: &armcompute.ImageReference{
	// 				Offer: to.Ptr("WindowsServer"),
	// 				Publisher: to.Ptr("MicrosoftWindowsServer"),
	// 				SKU: to.Ptr("2016-Datacenter"),
	// 				Version: to.Ptr("latest"),
	// 			},
	// 			OSDisk: &armcompute.OSDisk{
	// 				Name: to.Ptr("myOsDisk"),
	// 				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/myOsDisk"),
	// 					StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 				},
	// 				OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 			},
	// 		},
	// 		UserData: to.Ptr("RXhhbXBsZSBVc2VyRGF0YQ=="),
	// 		VMID: to.Ptr("0f47b100-583c-48e3-a4c0-aefc2c9bbcc1"),
	// 	},
	// 	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("west us"),
	// 			Tags: map[string]*string{
	// 				"displayName": to.Ptr("CustomScriptExtension-DSC"),
	// 			},
	// 			Properties: &armcompute.VirtualMachineExtensionProperties{
	// 				Type: to.Ptr("CustomScriptExtension"),
	// 				AutoUpgradeMinorVersion: to.Ptr(true),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				Publisher: to.Ptr("Microsoft.Compute"),
	// 				Settings: map[string]any{
	// 				},
	// 				TypeHandlerVersion: to.Ptr("1.9"),
	// 			},
	// 	}},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Retrieves information about the model view or the instance view of a virtual machine.
 *
 * @summary Retrieves information about the model view or the instance view of a virtual machine.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_Get_WithDiskControllerType.json
 */
async function getAVirtualMachineWithDiskControllerTypeProperties() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmName = "myVM";
  const expand = "userData";
  const options = { expand };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.get(resourceGroupName, vmName, options);
  console.log(result);
}

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

dotnet

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

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

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

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this VirtualMachineResource
VirtualMachineCollection collection = resourceGroupResource.GetVirtualMachines();

// invoke the operation
string vmName = "myVM";
InstanceViewType? expand = InstanceViewType.UserData;
NullableResponse<VirtualMachineResource> response = await collection.GetIfExistsAsync(vmName, expand: expand);
VirtualMachineResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    VirtualMachineData 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": "myVM",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "location": "West US",
  "tags": {
    "myTag1": "tagValue1"
  },
  "properties": {
    "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1",
    "availabilitySet": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet"
    },
    "hardwareProfile": {
      "vmSize": "Standard_DS3_v2",
      "vmSizeProperties": {
        "vCPUsAvailable": 1,
        "vCPUsPerCore": 1
      }
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2016-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "osType": "Windows",
        "name": "myOsDisk",
        "createOption": "FromImage",
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS",
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
        },
        "diskSizeGB": 30
      },
      "dataDisks": [
        {
          "lun": 0,
          "name": "myDataDisk0",
          "createOption": "Empty",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0"
          },
          "diskSizeGB": 30
        },
        {
          "lun": 1,
          "name": "myDataDisk1",
          "createOption": "Attach",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1"
          },
          "diskSizeGB": 100
        }
      ],
      "diskControllerType": "NVMe"
    },
    "applicationProfile": {
      "galleryApplications": [
        {
          "tags": "myTag1",
          "order": 1,
          "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
          "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
        },
        {
          "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
        }
      ]
    },
    "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
    "osProfile": {
      "computerName": "myVM",
      "adminUsername": "admin",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": false
      },
      "secrets": []
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"
        }
      ]
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "enabled": true,
        "storageUri": "http://{myStorageAccount}.blob.core.windows.net"
      }
    },
    "extensionsTimeBudget": "PT50M",
    "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": "west us",
      "tags": {
        "displayName": "CustomScriptExtension-DSC"
      },
      "properties": {
        "autoUpgradeMinorVersion": true,
        "provisioningState": "Succeeded",
        "publisher": "Microsoft.Compute",
        "type": "CustomScriptExtension",
        "typeHandlerVersion": "1.9",
        "settings": {}
      }
    }
  ]
}

Get a virtual machine with VM Size Properties

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

HTTP

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

Java

/**
 * Samples for VirtualMachines GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
     * virtualMachineExamples/VirtualMachine_Get_WithVMSizeProperties.json
     */
    /**
     * Sample code: Get a virtual machine with VM Size Properties.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAVirtualMachineWithVMSizeProperties(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachines()
            .getByResourceGroupWithResponse("myResourceGroup", "myVM", null, com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_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_machines.get(
        resource_group_name="myResourceGroup",
        vm_name="myVM",
    )
    print(response)


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

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

Go

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_Get_WithVMSizeProperties.json
func ExampleVirtualMachinesClient_Get_getAVirtualMachineWithVmSizeProperties() {
	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.NewVirtualMachinesClient().Get(ctx, "myResourceGroup", "myVM", &armcompute.VirtualMachinesClientGetOptions{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.VirtualMachine = armcompute.VirtualMachine{
	// 	Name: to.Ptr("myVM"),
	// 	Type: to.Ptr("Microsoft.Compute/virtualMachines"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"myTag1": to.Ptr("tagValue1"),
	// 	},
	// 	Properties: &armcompute.VirtualMachineProperties{
	// 		ApplicationProfile: &armcompute.ApplicationProfile{
	// 			GalleryApplications: []*armcompute.VMGalleryApplication{
	// 				{
	// 					ConfigurationReference: to.Ptr("https://mystorageaccount.blob.core.windows.net/configurations/settings.config"),
	// 					Order: to.Ptr[int32](1),
	// 					PackageReferenceID: to.Ptr("/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0"),
	// 					Tags: to.Ptr("myTag1"),
	// 				},
	// 				{
	// 					PackageReferenceID: to.Ptr("/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"),
	// 			}},
	// 		},
	// 		AvailabilitySet: &armcompute.SubResource{
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet"),
	// 		},
	// 		DiagnosticsProfile: &armcompute.DiagnosticsProfile{
	// 			BootDiagnostics: &armcompute.BootDiagnostics{
	// 				Enabled: to.Ptr(true),
	// 				StorageURI: to.Ptr("http://{myStorageAccount}.blob.core.windows.net"),
	// 			},
	// 		},
	// 		ExtensionsTimeBudget: to.Ptr("PT50M"),
	// 		HardwareProfile: &armcompute.HardwareProfile{
	// 			VMSize: to.Ptr(armcompute.VirtualMachineSizeTypesStandardDS3V2),
	// 			VMSizeProperties: &armcompute.VMSizeProperties{
	// 				VCPUsAvailable: to.Ptr[int32](1),
	// 				VCPUsPerCore: to.Ptr[int32](1),
	// 			},
	// 		},
	// 		NetworkProfile: &armcompute.NetworkProfile{
	// 			NetworkInterfaces: []*armcompute.NetworkInterfaceReference{
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"),
	// 			}},
	// 		},
	// 		OSProfile: &armcompute.OSProfile{
	// 			AdminUsername: to.Ptr("admin"),
	// 			ComputerName: to.Ptr("myVM"),
	// 			Secrets: []*armcompute.VaultSecretGroup{
	// 			},
	// 			WindowsConfiguration: &armcompute.WindowsConfiguration{
	// 				EnableAutomaticUpdates: to.Ptr(false),
	// 				ProvisionVMAgent: to.Ptr(true),
	// 			},
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		StorageProfile: &armcompute.StorageProfile{
	// 			DataDisks: []*armcompute.DataDisk{
	// 				{
	// 					Name: to.Ptr("myDataDisk0"),
	// 					Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 					CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesEmpty),
	// 					DiskSizeGB: to.Ptr[int32](30),
	// 					Lun: to.Ptr[int32](0),
	// 					ManagedDisk: &armcompute.ManagedDiskParameters{
	// 						ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0"),
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 					},
	// 				},
	// 				{
	// 					Name: to.Ptr("myDataDisk1"),
	// 					Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 					CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesAttach),
	// 					DiskSizeGB: to.Ptr[int32](100),
	// 					Lun: to.Ptr[int32](1),
	// 					ManagedDisk: &armcompute.ManagedDiskParameters{
	// 						ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1"),
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 					},
	// 			}},
	// 			ImageReference: &armcompute.ImageReference{
	// 				Offer: to.Ptr("WindowsServer"),
	// 				Publisher: to.Ptr("MicrosoftWindowsServer"),
	// 				SKU: to.Ptr("2016-Datacenter"),
	// 				Version: to.Ptr("latest"),
	// 			},
	// 			OSDisk: &armcompute.OSDisk{
	// 				Name: to.Ptr("myOsDisk"),
	// 				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/myOsDisk"),
	// 					StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 				},
	// 				OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 			},
	// 		},
	// 		UserData: to.Ptr("RXhhbXBsZSBVc2VyRGF0YQ=="),
	// 		VMID: to.Ptr("0f47b100-583c-48e3-a4c0-aefc2c9bbcc1"),
	// 	},
	// 	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("west us"),
	// 			Tags: map[string]*string{
	// 				"displayName": to.Ptr("CustomScriptExtension-DSC"),
	// 			},
	// 			Properties: &armcompute.VirtualMachineExtensionProperties{
	// 				Type: to.Ptr("CustomScriptExtension"),
	// 				AutoUpgradeMinorVersion: to.Ptr(true),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				Publisher: to.Ptr("Microsoft.Compute"),
	// 				Settings: map[string]any{
	// 				},
	// 				TypeHandlerVersion: to.Ptr("1.9"),
	// 			},
	// 	}},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Retrieves information about the model view or the instance view of a virtual machine.
 *
 * @summary Retrieves information about the model view or the instance view of a virtual machine.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_Get_WithVMSizeProperties.json
 */
async function getAVirtualMachineWithVMSizeProperties() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmName = "myVM";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.get(resourceGroupName, vmName);
  console.log(result);
}

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

dotnet

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

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

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

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this VirtualMachineResource
VirtualMachineCollection collection = resourceGroupResource.GetVirtualMachines();

// invoke the operation
string vmName = "myVM";
NullableResponse<VirtualMachineResource> response = await collection.GetIfExistsAsync(vmName);
VirtualMachineResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    VirtualMachineData 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": "myVM",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "location": "West US",
  "tags": {
    "myTag1": "tagValue1"
  },
  "properties": {
    "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1",
    "availabilitySet": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet"
    },
    "hardwareProfile": {
      "vmSize": "Standard_DS3_v2",
      "vmSizeProperties": {
        "vCPUsAvailable": 1,
        "vCPUsPerCore": 1
      }
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2016-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "osType": "Windows",
        "name": "myOsDisk",
        "createOption": "FromImage",
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS",
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
        },
        "diskSizeGB": 30
      },
      "dataDisks": [
        {
          "lun": 0,
          "name": "myDataDisk0",
          "createOption": "Empty",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0"
          },
          "diskSizeGB": 30
        },
        {
          "lun": 1,
          "name": "myDataDisk1",
          "createOption": "Attach",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1"
          },
          "diskSizeGB": 100
        }
      ]
    },
    "applicationProfile": {
      "galleryApplications": [
        {
          "tags": "myTag1",
          "order": 1,
          "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
          "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
        },
        {
          "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
        }
      ]
    },
    "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
    "osProfile": {
      "computerName": "myVM",
      "adminUsername": "admin",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": false
      },
      "secrets": []
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"
        }
      ]
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "enabled": true,
        "storageUri": "http://{myStorageAccount}.blob.core.windows.net"
      }
    },
    "extensionsTimeBudget": "PT50M",
    "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": "west us",
      "tags": {
        "displayName": "CustomScriptExtension-DSC"
      },
      "properties": {
        "autoUpgradeMinorVersion": true,
        "provisioningState": "Succeeded",
        "publisher": "Microsoft.Compute",
        "type": "CustomScriptExtension",
        "typeHandlerVersion": "1.9",
        "settings": {}
      }
    }
  ]
}

Get a Virtual Machine.

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

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?$expand=userData&api-version=2024-07-01

Java

import com.azure.resourcemanager.compute.models.InstanceViewTypes;

/**
 * Samples for VirtualMachines GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
     * virtualMachineExamples/VirtualMachine_Get.json
     */
    /**
     * Sample code: Get a Virtual Machine.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAVirtualMachine(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachines().getByResourceGroupWithResponse(
            "myResourceGroup", "myVM", InstanceViewTypes.USER_DATA, com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

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

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


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

    response = client.virtual_machines.get(
        resource_group_name="myResourceGroup",
        vm_name="myVM",
    )
    print(response)


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

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

Go

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_Get.json
func ExampleVirtualMachinesClient_Get_getAVirtualMachine() {
	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.NewVirtualMachinesClient().Get(ctx, "myResourceGroup", "myVM", &armcompute.VirtualMachinesClientGetOptions{Expand: to.Ptr(armcompute.InstanceViewTypesUserData)})
	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.VirtualMachine = armcompute.VirtualMachine{
	// 	Name: to.Ptr("myVM"),
	// 	Type: to.Ptr("Microsoft.Compute/virtualMachines"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"myTag1": to.Ptr("tagValue1"),
	// 	},
	// 	Etag: to.Ptr("\"1\""),
	// 	ManagedBy: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{MyVmss}"),
	// 	Properties: &armcompute.VirtualMachineProperties{
	// 		ApplicationProfile: &armcompute.ApplicationProfile{
	// 			GalleryApplications: []*armcompute.VMGalleryApplication{
	// 				{
	// 					ConfigurationReference: to.Ptr("https://mystorageaccount.blob.core.windows.net/configurations/settings.config"),
	// 					Order: to.Ptr[int32](1),
	// 					PackageReferenceID: to.Ptr("/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0"),
	// 					Tags: to.Ptr("myTag1"),
	// 				},
	// 				{
	// 					PackageReferenceID: to.Ptr("/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"),
	// 			}},
	// 		},
	// 		AvailabilitySet: &armcompute.SubResource{
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet"),
	// 		},
	// 		DiagnosticsProfile: &armcompute.DiagnosticsProfile{
	// 			BootDiagnostics: &armcompute.BootDiagnostics{
	// 				Enabled: to.Ptr(true),
	// 				StorageURI: to.Ptr("http://{myStorageAccount}.blob.core.windows.net"),
	// 			},
	// 		},
	// 		ExtensionsTimeBudget: to.Ptr("PT50M"),
	// 		HardwareProfile: &armcompute.HardwareProfile{
	// 			VMSize: to.Ptr(armcompute.VirtualMachineSizeTypesStandardDS3V2),
	// 		},
	// 		NetworkProfile: &armcompute.NetworkProfile{
	// 			NetworkInterfaces: []*armcompute.NetworkInterfaceReference{
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"),
	// 			}},
	// 		},
	// 		OSProfile: &armcompute.OSProfile{
	// 			AdminUsername: to.Ptr("admin"),
	// 			ComputerName: to.Ptr("myVM"),
	// 			Secrets: []*armcompute.VaultSecretGroup{
	// 			},
	// 			WindowsConfiguration: &armcompute.WindowsConfiguration{
	// 				EnableAutomaticUpdates: to.Ptr(false),
	// 				ProvisionVMAgent: to.Ptr(true),
	// 			},
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		ProximityPlacementGroup: &armcompute.SubResource{
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/my-ppg01"),
	// 		},
	// 		StorageProfile: &armcompute.StorageProfile{
	// 			DataDisks: []*armcompute.DataDisk{
	// 				{
	// 					Name: to.Ptr("myDataDisk0"),
	// 					Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 					CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesEmpty),
	// 					DiskSizeGB: to.Ptr[int32](30),
	// 					Lun: to.Ptr[int32](0),
	// 					ManagedDisk: &armcompute.ManagedDiskParameters{
	// 						ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0"),
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 					},
	// 				},
	// 				{
	// 					Name: to.Ptr("myDataDisk1"),
	// 					Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 					CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesAttach),
	// 					DiskSizeGB: to.Ptr[int32](100),
	// 					Lun: to.Ptr[int32](1),
	// 					ManagedDisk: &armcompute.ManagedDiskParameters{
	// 						ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1"),
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 					},
	// 			}},
	// 			ImageReference: &armcompute.ImageReference{
	// 				Offer: to.Ptr("WindowsServer"),
	// 				Publisher: to.Ptr("MicrosoftWindowsServer"),
	// 				SKU: to.Ptr("2016-Datacenter"),
	// 				Version: to.Ptr("latest"),
	// 			},
	// 			OSDisk: &armcompute.OSDisk{
	// 				Name: to.Ptr("myOsDisk"),
	// 				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/myOsDisk"),
	// 					StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 				},
	// 				OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 			},
	// 		},
	// 		TimeCreated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-27T01:02:38.313Z"); return t}()),
	// 		UserData: to.Ptr("RXhhbXBsZSBVc2VyRGF0YQ=="),
	// 		VMID: to.Ptr("0f47b100-583c-48e3-a4c0-aefc2c9bbcc1"),
	// 	},
	// 	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("west us"),
	// 			Tags: map[string]*string{
	// 				"displayName": to.Ptr("CustomScriptExtension-DSC"),
	// 			},
	// 			Properties: &armcompute.VirtualMachineExtensionProperties{
	// 				Type: to.Ptr("CustomScriptExtension"),
	// 				AutoUpgradeMinorVersion: to.Ptr(true),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				Publisher: to.Ptr("Microsoft.Compute"),
	// 				Settings: map[string]any{
	// 				},
	// 				TypeHandlerVersion: to.Ptr("1.9"),
	// 			},
	// 	}},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Retrieves information about the model view or the instance view of a virtual machine.
 *
 * @summary Retrieves information about the model view or the instance view of a virtual machine.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_Get.json
 */
async function getAVirtualMachine() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmName = "myVM";
  const expand = "userData";
  const options = { expand };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.get(resourceGroupName, vmName, options);
  console.log(result);
}

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

dotnet

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

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

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

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this VirtualMachineResource
VirtualMachineCollection collection = resourceGroupResource.GetVirtualMachines();

// invoke the operation
string vmName = "myVM";
InstanceViewType? expand = InstanceViewType.UserData;
NullableResponse<VirtualMachineResource> response = await collection.GetIfExistsAsync(vmName, expand: expand);
VirtualMachineResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    VirtualMachineData 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": "myVM",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "location": "West US",
  "tags": {
    "myTag1": "tagValue1"
  },
  "etag": "\"1\"",
  "properties": {
    "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1",
    "availabilitySet": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet"
    },
    "proximityPlacementGroup": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/my-ppg01"
    },
    "hardwareProfile": {
      "vmSize": "Standard_DS3_v2"
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2016-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "osType": "Windows",
        "name": "myOsDisk",
        "createOption": "FromImage",
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS",
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
        },
        "diskSizeGB": 30
      },
      "dataDisks": [
        {
          "lun": 0,
          "name": "myDataDisk0",
          "createOption": "Empty",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0"
          },
          "diskSizeGB": 30
        },
        {
          "lun": 1,
          "name": "myDataDisk1",
          "createOption": "Attach",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1"
          },
          "diskSizeGB": 100
        }
      ]
    },
    "applicationProfile": {
      "galleryApplications": [
        {
          "tags": "myTag1",
          "order": 1,
          "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
          "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
        },
        {
          "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
        }
      ]
    },
    "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
    "osProfile": {
      "computerName": "myVM",
      "adminUsername": "admin",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": false
      },
      "secrets": []
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"
        }
      ]
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "enabled": true,
        "storageUri": "http://{myStorageAccount}.blob.core.windows.net"
      }
    },
    "extensionsTimeBudget": "PT50M",
    "provisioningState": "Succeeded",
    "timeCreated": "2021-06-27T01:02:38.3138469+00:00"
  },
  "resources": [
    {
      "name": "CustomScriptExtension-DSC",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
      "type": "Microsoft.Compute/virtualMachines/extensions",
      "location": "west us",
      "tags": {
        "displayName": "CustomScriptExtension-DSC"
      },
      "properties": {
        "autoUpgradeMinorVersion": true,
        "provisioningState": "Succeeded",
        "publisher": "Microsoft.Compute",
        "type": "CustomScriptExtension",
        "typeHandlerVersion": "1.9",
        "settings": {}
      }
    }
  ],
  "managedBy": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{MyVmss}"
}

Определения

Имя	Описание
AdditionalCapabilities	Указывает дополнительные возможности, включенные или отключенные на виртуальной машине.
AdditionalUnattendContent	Указывает дополнительные сведения в формате XML в кодировке Base-64, которые можно включить в файл Unattend.xml, который используется программой установки Windows.
ApiEntityReference	Идентификатор исходного ресурса. Это может быть моментальный снимок или точка восстановления диска, из которой создается диск.
ApiError	Ошибка API.
ApiErrorBase	База ошибок API.
ApplicationProfile	Указывает приложения коллекции, которые должны быть доступны для виртуальной машины или VMSS.
AvailablePatchSummary	Доступная сводка по исправлению последней операции оценки для виртуальной машины.
BillingProfile	Указывает сведения о выставлении счетов, связанные с виртуальной машиной Azure Spot. Минимальная версия API: 2019-03-01.
BootDiagnostics	Диагностика загрузки — это функция отладки, которая позволяет просматривать выходные данные консоли и снимок экрана для диагностики состояния виртуальной машины. ПРИМЕЧАНИЕ. Если указан URI хранилища, убедитесь, что учетная запись хранения находится в том же регионе и подписке, что и виртуальная машина. Вы можете легко просмотреть выходные данные журнала консоли. Azure также позволяет просмотреть снимок экрана виртуальной машины из гипервизора.
BootDiagnosticsInstanceView	Диагностика загрузки — это функция отладки, которая позволяет просматривать выходные данные консоли и снимок экрана для диагностики состояния виртуальной машины. Вы можете легко просмотреть выходные данные журнала консоли. Azure также позволяет просмотреть снимок экрана виртуальной машины из гипервизора.
CachingTypes	Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Поведение по умолчанию: Нет для хранилища уровня "Стандартный". ReadOnly для хранилища Premium.
CapacityReservationProfile	Указывает сведения о резервировании емкости, используемом для выделения виртуальной машины. Минимальная версия API: 2021-04-01.
CloudError	Ответ на ошибку из службы вычислений.
ComponentNames	Имя компонента. В настоящее время единственным допустимым значением является Microsoft-Windows-Shell-Setup.
DataDisk	Указывает параметры, используемые для добавления диска данных на виртуальную машину. Дополнительные сведения о дисках см. в статье Сведения о дисках и виртуальных жестких дисках для виртуальных машин Azure.
DeleteOptions	Укажите, что происходит с сетевым интерфейсом при удалении виртуальной машины
DiagnosticsProfile	Указывает состояние параметров диагностики загрузки. Минимальная версия API: 2015-06-15.
DiffDiskOptions	Задает временные параметры диска для диска операционной системы.
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.
DiffDiskSettings	Задает временные параметры диска для диска операционной системы, используемого виртуальной машиной.
DiskControllerTypes	Указывает тип контроллера диска, настроенный для виртуальной машины. Примечание. Это свойство будет иметь тип контроллера диска по умолчанию, если не указанная виртуальная машина создается с параметром HyperVGeneration, равным версии 2, в зависимости от возможностей диска операционной системы и размера виртуальной машины из указанной минимальной версии API. Перед обновлением типа контроллера диска необходимо освободить виртуальную машину, если вы не обновляете размер виртуальной машины в конфигурации виртуальной машины, которая неявно освобождает и перенаправляет виртуальную машину. Минимальная версия API: 2022-08-01.
DiskCreateOptionTypes	Указывает, как должен быть создан диск виртуальной машины. Возможные значения — подключение : это значение используется при использовании специализированного диска для создания виртуальной машины. FromImage: это значение используется при использовании образа для создания виртуальной машины. При использовании образа платформы также следует использовать элемент imageReference, описанный выше. Если вы используете образ Marketplace, вы также должны использовать элемент плана, описанный ранее.
DiskDeleteOptionTypes	Указывает, следует ли удалять или отсоединять диск ОС при удалении виртуальной машины. Возможные значения: Delete. Если это значение используется, диск ОС удаляется при удалении виртуальной машины. Отделять. Если это значение используется, диск ос сохраняется после удаления виртуальной машины. Значение по умолчанию имеет значение Отсоединение. Для временного диска ОС по умолчанию задано значение Delete. Пользователь не может изменить параметр удаления для временного диска ОС.
DiskDetachOptionTypes	Указывает поведение отсоединения, используемое при отсоединение диска или уже в процессе отсоединения от виртуальной машины. Поддерживаемые значения: ForceDetach. отсоединение: ForceDetach применимо только для управляемых дисков данных. Если предыдущая попытка отсоединения диска данных не завершена из-за непредвиденного сбоя виртуальной машины, а диск по-прежнему не выпущен, используйте принудительное отключение в качестве последней возможности для принудительного отключения диска от виртуальной машины. Все записи, возможно, не были удалены при использовании этого поведения отсоединения. Чтобы принудительно отсоединить диск данных, обновите его до true вместе с параметром detachOption: ForceDetach.
DiskEncryptionSetParameters	Указывает идентификатор ресурса набора шифрования управляемых пользователем дисков для управляемого диска.
DiskEncryptionSettings	Задает параметры шифрования для диска ОС. Минимальная версия API: 2015-06-15.
DiskInstanceView	Сведения о диске виртуальной машины.
DomainNameLabelScopeTypes	Область метки доменного имени для ресурсов PublicIPAddress, которые будут созданы. Созданная метка имени — это объединение метки хэшированного доменного имени с политикой в соответствии с областью метки доменного имени и уникальным идентификатором профиля сети виртуальной машины.
EncryptionIdentity	Указывает управляемое удостоверение, используемое ADE для получения маркера доступа для операций keyvault.
EventGridAndResourceGraph	Параметры конфигурации, используемые при создании параметра eventGridAndResourceGraph Scheduled Event.
ExtendedLocation	Расширенное расположение виртуальной машины.
ExtendedLocationTypes	Тип расширенного расположения.
HardwareProfile	Указывает параметры оборудования для виртуальной машины.
HyperVGenerationType	Указывает тип HyperVGeneration, связанный с ресурсом
ImageReference	Указывает сведения об используемом изображении. Вы можете указать сведения о образах платформы, образах Marketplace или образах виртуальных машин. Этот элемент необходим, если вы хотите использовать образ платформы, образ Marketplace или образ виртуальной машины, но не используется в других операциях создания.
InnerError	Сведения о внутренней ошибке.
InstanceViewStatus	Состояние представления экземпляра.
InstanceViewTypes	Выражение расширения, применяемое к операции. InstanceView извлекает моментальный снимок свойств среды выполнения виртуальной машины, управляемой платформой, и может изменяться вне операций плоскости управления. UserData извлекает свойство UserData как часть представления модели виртуальной машины, предоставленного пользователем во время операции создания и обновления виртуальной машины.
IPVersions	Доступно из Api-Version 2019-07-01, он представляет, является ли конкретная ipconfiguration IPv4 или IPv6. По умолчанию используется протокол IPv4. Возможные значения: "IPv4" и "IPv6".
KeyVaultKeyReference	Указывает расположение ключа шифрования ключей в Key Vault.
KeyVaultSecretReference	Защищенные расширения, передаваемые по ссылке, и используемые из хранилища ключей
LastPatchInstallationSummary	Сводка по установке последней операции установки для виртуальной машины.
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 начнет аудит или мониторинг, но не применяет управление доступом к запросам к конечным точкам узла в режиме аудита, в то время как в режиме принудительного применения будет применяться управление доступом. Значением по умолчанию является режим принудительного применения.
NetworkApiVersion	указывает версию API Microsoft.Network, используемую при создании сетевых ресурсов в конфигурациях сетевого интерфейса.
NetworkInterfaceAuxiliaryMode	Указывает, включен ли вспомогательный режим для ресурса сетевого интерфейса.
NetworkInterfaceAuxiliarySku	Указывает, включен ли вспомогательный номер SKU для ресурса сетевого интерфейса.
NetworkInterfaceReference	Указывает список идентификаторов ресурсов для сетевых интерфейсов, связанных с виртуальной машиной.
NetworkProfile	Указывает сетевые интерфейсы виртуальной машины.
OperatingSystemTypes	Тип операционной системы.
OSDisk	Указывает сведения о диске операционной системы, используемом виртуальной машиной. Дополнительные сведения о дисках см. в статье Сведения о дисках и виртуальных жестких дисках для виртуальных машин Azure.
OSImageNotificationProfile	Указывает конфигурации, связанные с запланированным событием образа ОС.
OSProfile	Задает параметры операционной системы, используемые при создании виртуальной машины. Некоторые параметры нельзя изменить после подготовки виртуальной машины.
PassNames	Имя передачи. В настоящее время единственным допустимым значением является OobeSystem.
PatchOperationStatus	Общее состояние успешного выполнения или сбоя операции. Он остается "InProgress" до завершения операции. На этом этапе она станет "Неизвестно", "Сбой", "Успешно" или "CompletedWithWarnings".
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-адресов
ResourceIdentityType	Тип удостоверения, используемого для виртуальной машины. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" приведет к удалению удостоверений из виртуальной машины.
ScheduledEventsAdditionalPublishingTargets	Параметры конфигурации, используемые при публикации scheduledEventsAdditionalPublishingTargets.
ScheduledEventsPolicy	Указывает конфигурации запланированных событий, связанных с развертыванием, перезагрузкой и ScheduledEventsAdditionalPublishingTargets для виртуальной машины.
ScheduledEventsProfile	Указывает конфигурации, связанные с запланированными событиями.
securityEncryptionTypes	Указывает тип шифрования управляемого диска. Он имеет значение DiskWithVMGuestState для шифрования управляемого диска вместе с большим двоичным объектом VMGuestState, VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для сохранения состояния встроенного ПО в BLOB-объекте VMGuestState. Примечание. Его можно задать только для конфиденциальных виртуальных машин.
SecurityProfile	Указывает параметры профиля, связанного с безопасностью для виртуальной машины.
SecurityTypes	Указывает тип безопасности виртуальной машины. Для включения UefiSettings необходимо задать любое указанное значение. Поведение по умолчанию: UefiSettings не будет включен, если это свойство не задано.
SettingNames	Указывает имя параметра, к которому применяется содержимое. Возможные значения: FirstLogonCommands и AutoLogon.
SshConfiguration	Указывает конфигурацию ключа SSH для ОС Linux.
SshPublicKey	Список открытых ключей SSH, используемых для проверки подлинности с помощью виртуальных машин на основе Linux.
StatusLevelTypes	Код уровня.
StorageAccountTypes	Указывает тип учетной записи хранения для управляемого диска. ПРИМЕЧАНИЕ. UltraSSD_LRS можно использовать только с дисками данных, его нельзя использовать с диском ОС.
StorageProfile	Задает параметры хранилища для дисков виртуальной машины.
SubResource	Относительный URL-адрес Хранилища ключей, содержащий секрет.
TerminateNotificationProfile	Указывает конфигурации, связанные с запланированным событием завершения.
UefiSettings	Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины. Минимальная версия API: 2020-12-01.
UserAssignedIdentities	Список удостоверений пользователей, связанных с виртуальной машиной. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".
UserInitiatedReboot	Параметры конфигурации, используемые при создании параметра запланированного события userInitiatedReboot.
UserInitiatedRedeploy	Параметры конфигурации, используемые при создании параметра события userInitiatedRedeploy, запланированного.
VaultCertificate	Список ссылок на хранилище ключей в SourceVault, содержащий сертификаты.
VaultSecretGroup	Задает набор сертификатов, которые должны быть установлены на виртуальной машине. Чтобы установить сертификаты на виртуальной машине, рекомендуется использовать расширение виртуальной машины Azure Key Vault для Linux или расширение виртуальной машины Azure Key Vault для Windows.
VirtualHardDisk	Виртуальный жесткий диск.
VirtualMachine	Описывает виртуальную машину.
VirtualMachineAgentInstanceView	Агент виртуальной машины, работающий на виртуальной машине.
VirtualMachineEvictionPolicyTypes	Указывает политику вытеснения для виртуальной машины Azure Spot и масштабируемого набора Azure Spot. Для виртуальных машин Azure Spot поддерживаются как "Deallocate", так и "Delete", а минимальная версия API — 2019-03-01. Для масштабируемых наборов Azure Spot поддерживаются как "Deallocate", так и "Delete", а минимальная версия API — 2017-10-30-preview.
VirtualMachineExtension	Ресурсы дочернего расширения виртуальной машины.
VirtualMachineExtensionHandlerInstanceView	Представление экземпляра обработчика расширений виртуальной машины.
VirtualMachineExtensionInstanceView	Представление экземпляра расширения виртуальной машины.
VirtualMachineHealthStatus	Состояние работоспособности виртуальной машины.
VirtualMachineIdentity	Удостоверение виртуальной машины, если настроено.
VirtualMachineInstanceView	Представление экземпляра виртуальной машины.
VirtualMachineIpTag	Список тегов IP-адресов, связанных с общедоступным IP-адресом.
VirtualMachineNetworkInterfaceConfiguration	Указывает конфигурации сети, которые будут использоваться для создания сетевых ресурсов виртуальной машины.
VirtualMachineNetworkInterfaceDnsSettingsConfiguration	Параметры DNS, применяемые к сетевым интерфейсам.
VirtualMachineNetworkInterfaceIPConfiguration	Указывает IP-конфигурации сетевого интерфейса.
VirtualMachinePatchStatus	[Предварительная версия компонента] Состояние операций исправления виртуальной машины.
VirtualMachinePriorityTypes	Указывает приоритет виртуальной машины. Минимальная версия API: 2019-03-01
VirtualMachinePublicIPAddressConfiguration	PublicIPAddressConfiguration.
VirtualMachinePublicIPAddressDnsSettingsConfiguration	Параметры DNS, применяемые к общедоступным АДРЕСАм.
VirtualMachineSizeTypes	Указывает размер виртуальной машины. В настоящее время тип данных перечисления устарел и будет удален 23 декабря 2023 года. Рекомендуемый способ получить список доступных размеров использует следующие API: перечислить все доступные размеры виртуальных машин в группе доступности, Перечислить все доступные размеры виртуальных машин в регионе, перечислить все доступные размеры виртуальных машин для изменения размера. Дополнительные сведения о размерах виртуальных машин см. в разделе Размеры виртуальных машин. Доступные размеры виртуальных машин зависят от региона и группы доступности.
VMDiskSecurityProfile	Указывает профиль безопасности управляемого диска.
VMGalleryApplication	Указывает приложения коллекции, которые должны быть доступны для виртуальной машины или VMSS
VMSizeProperties	Задает свойства для настройки размера виртуальной машины. Минимальная версия API: 2021-07-01. Эта функция по-прежнему находится в режиме предварительной версии и не поддерживается для VirtualMachineScaleSet. Дополнительные сведения см. в настройки виртуальной машины.
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. Это позволяет удаленно использовать Windows PowerShell.
WinRMListener	Список прослушивателей удаленного управления Windows

AdditionalCapabilities

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

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

AdditionalUnattendContent

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

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

ApiEntityReference

Идентификатор исходного ресурса. Это может быть моментальный снимок или точка восстановления диска, из которой создается диск.

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

ApiError

Ошибка API.

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

ApiErrorBase

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

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

ApplicationProfile

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

Имя	Тип	Описание
galleryApplications	VMGalleryApplication[]	Указывает приложения коллекции, которые должны быть доступны для виртуальной машины или VMSS

AvailablePatchSummary

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

Имя	Тип	Описание
assessmentActivityId	string	Идентификатор действия операции, создающей этот результат. Он используется для корреляции между журналами БЕЗОПАСНОСТИ и расширений.
criticalAndSecurityPatchCount	integer	Количество критически важных или исправлений безопасности, обнаруженных как доступные и еще не установленные.
error	ApiError	Ошибки, возникшие во время выполнения операции. Массив сведений содержит список из них.
lastModifiedTime	string	Метка времени UTC при начале операции.
otherPatchCount	integer	Количество всех доступных исправлений, за исключением критически важных и безопасности.
rebootPending	boolean	Общее состояние перезагрузки виртуальной машины. Это будет верно, если частично установленные исправления требуют перезагрузки для завершения установки, но перезагрузка еще не произошла.
startTime	string	Метка времени UTC при начале операции.
status	PatchOperationStatus	Общее состояние успешного выполнения или сбоя операции. Он остается "InProgress" до завершения операции. На этом этапе она станет "Неизвестно", "Сбой", "Успешно" или "CompletedWithWarnings".

BillingProfile

Указывает сведения о выставлении счетов, связанные с виртуальной машиной Azure Spot. Минимальная версия API: 2019-03-01.

Имя	Тип	Описание
maxPrice	number	Указывает максимальную цену, которую вы хотите заплатить за виртуальную машину или виртуальную машину Azure. Эта цена находится в долларах США. Эта цена будет сравниваться с текущей ценой На месте Azure для размера виртуальной машины. Кроме того, цены сравниваются во время создания и обновления виртуальной машины и виртуальной машины Azure, и операция будет выполнена только в том случае, если максимальная цена на место Azure превышает текущую цену На месте Azure. MaxPrice также будет использоваться для вытеснения виртуальной машины и виртуальной машины Azure, если текущая цена на место Azure выходит за пределы maxPrice после создания виртуальной машины или VMSS. Возможные значения: — Любое десятичное значение больше нуля. Пример: 0.01538 -1 — указывает, что цена по умолчанию должна быть up-to по запросу. Значение maxPrice можно задать для -1, чтобы указать, что виртуальная машина или виртуальная машина Azure не должна быть вытесна по соображениям цены. Кроме того, максимальная цена по умолчанию -1, если она не предоставляется вами. Минимальная версия API: 2019-03-01.

BootDiagnostics

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

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

BootDiagnosticsInstanceView

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

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

CachingTypes

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

Имя	Тип	Описание
None	string
ReadOnly	string
ReadWrite	string

CapacityReservationProfile

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

Имя	Тип	Описание
capacityReservationGroup	SubResource	Указывает идентификатор ресурса группы резервирования емкости, который следует использовать для выделения экземпляров виртуальной машины или масштабируемого набора виртуальных машин, предоставленных достаточной емкости, зарезервированной. Дополнительные сведения см. в https://aka.ms/CapacityReservation.

CloudError

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

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

ComponentNames

Имя компонента. В настоящее время единственным допустимым значением является Microsoft-Windows-Shell-Setup.

Имя	Тип	Описание
Microsoft-Windows-Shell-Setup	string

DataDisk

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

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

DeleteOptions

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

Имя	Тип	Описание
Delete	string
Detach	string

DiagnosticsProfile

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

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

DiffDiskOptions

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

Имя	Тип	Описание
Local	string

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.

Имя	Тип	Описание
CacheDisk	string
NvmeDisk	string
ResourceDisk	string

DiffDiskSettings

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

Имя	Тип	Описание
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

Указывает тип контроллера диска, настроенный для виртуальной машины. Примечание. Это свойство будет иметь тип контроллера диска по умолчанию, если не указанная виртуальная машина создается с параметром HyperVGeneration, равным версии 2, в зависимости от возможностей диска операционной системы и размера виртуальной машины из указанной минимальной версии API. Перед обновлением типа контроллера диска необходимо освободить виртуальную машину, если вы не обновляете размер виртуальной машины в конфигурации виртуальной машины, которая неявно освобождает и перенаправляет виртуальную машину. Минимальная версия API: 2022-08-01.

Имя	Тип	Описание
NVMe	string
SCSI	string

DiskCreateOptionTypes

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

Имя	Тип	Описание
Attach	string
Copy	string
Empty	string
FromImage	string
Restore	string

DiskDeleteOptionTypes

Указывает, следует ли удалять или отсоединять диск ОС при удалении виртуальной машины. Возможные значения: Delete. Если это значение используется, диск ОС удаляется при удалении виртуальной машины. Отделять. Если это значение используется, диск ос сохраняется после удаления виртуальной машины. Значение по умолчанию имеет значение Отсоединение. Для временного диска ОС по умолчанию задано значение Delete. Пользователь не может изменить параметр удаления для временного диска ОС.

Имя	Тип	Описание
Delete	string
Detach	string

DiskDetachOptionTypes

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

Имя	Тип	Описание
ForceDetach	string

DiskEncryptionSetParameters

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

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

DiskEncryptionSettings

Задает параметры шифрования для диска ОС. Минимальная версия API: 2015-06-15.

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

DiskInstanceView

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

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

DomainNameLabelScopeTypes

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

Имя	Тип	Описание
NoReuse	string
ResourceGroupReuse	string
SubscriptionReuse	string
TenantReuse	string

EncryptionIdentity

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

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

EventGridAndResourceGraph

Параметры конфигурации, используемые при создании параметра eventGridAndResourceGraph Scheduled Event.

Имя	Тип	Описание
enable	boolean	Указывает, включена ли сетка событий и граф ресурсов для конфигураций, связанных с запланированными событиями.

ExtendedLocation

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

Имя	Тип	Описание
name	string	Имя расширенного расположения.
type	ExtendedLocationTypes	Тип расширенного расположения.

ExtendedLocationTypes

Тип расширенного расположения.

Имя	Тип	Описание
EdgeZone	string

HardwareProfile

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

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

HyperVGenerationType

Указывает тип HyperVGeneration, связанный с ресурсом

Имя	Тип	Описание
V1	string
V2	string

ImageReference

Указывает сведения об используемом изображении. Вы можете указать сведения о образах платформы, образах 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

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

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

InstanceViewStatus

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

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

InstanceViewTypes

Выражение расширения, применяемое к операции. InstanceView извлекает моментальный снимок свойств среды выполнения виртуальной машины, управляемой платформой, и может изменяться вне операций плоскости управления. UserData извлекает свойство UserData как часть представления модели виртуальной машины, предоставленного пользователем во время операции создания и обновления виртуальной машины.

Имя	Тип	Описание
instanceView	string
userData	string

IPVersions

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

Имя	Тип	Описание
IPv4	string
IPv6	string

KeyVaultKeyReference

Указывает расположение ключа шифрования ключей в Key Vault.

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

KeyVaultSecretReference

Защищенные расширения, передаваемые по ссылке, и используемые из хранилища ключей

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

LastPatchInstallationSummary

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

Имя	Тип	Описание
error	ApiError	Ошибки, возникшие во время выполнения операции. Массив сведений содержит список из них.
excludedPatchCount	integer	Количество всех доступных исправлений, кроме явно исключенных списком исключений, заданным клиентом.
failedPatchCount	integer	Количество исправлений, которые не удалось установить.
installationActivityId	string	Идентификатор действия операции, создающей этот результат. Он используется для корреляции между журналами БЕЗОПАСНОСТИ и расширений.
installedPatchCount	integer	Количество исправлений, которые успешно установлены.
lastModifiedTime	string	Метка времени UTC при начале операции.
maintenanceWindowExceeded	boolean	Описывает, истекло ли время операции до завершения всех предполагаемых действий.
notSelectedPatchCount	integer	Количество всех доступных исправлений, но не будет установлено, так как оно не соответствует записи списка классификации или включения.
pendingPatchCount	integer	Количество всех доступных исправлений, которые должны быть установлены в течение операции установки исправлений.
startTime	string	Метка времени UTC при начале операции.
status	PatchOperationStatus	Общее состояние успешного выполнения или сбоя операции. Он остается "InProgress" до завершения операции. На этом этапе она станет "Неизвестно", "Сбой", "Успешно" или "CompletedWithWarnings".

LinuxConfiguration

Указывает параметры операционной системы 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.

Имя	Тип	Описание
AutomaticByPlatform	string
ImageDefault	string

LinuxPatchSettings

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

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

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

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

Имя	Тип	Описание
Always	string
IfRequired	string
Never	string
Unknown	string

LinuxVMGuestPatchAutomaticByPlatformSettings

Задает дополнительные параметры режима исправления AutomaticByPlatform в гостевой исправлении виртуальной машины в Linux.

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

LinuxVMGuestPatchMode

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

Возможные значения:

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

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

Имя	Тип	Описание
AutomaticByPlatform	string
ImageDefault	string

MaintenanceOperationResultCodeTypes

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

Имя	Тип	Описание
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

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

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

ManagedDiskParameters

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

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

Mode

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

Имя	Тип	Описание
Audit	string
Enforce	string

NetworkApiVersion

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

Имя	Тип	Описание
2020-11-01	string

NetworkInterfaceAuxiliaryMode

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

Имя	Тип	Описание
AcceleratedConnections	string
Floating	string
None	string

NetworkInterfaceAuxiliarySku

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

Имя	Тип	Описание
A1	string
A2	string
A4	string
A8	string
None	string

NetworkInterfaceReference

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

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

NetworkProfile

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

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

OperatingSystemTypes

Тип операционной системы.

Имя	Тип	Описание
Linux	string
Windows	string

OSDisk

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

Имя	Тип	Описание
caching	CachingTypes	Указывает требования к кэшированию. Возможные значения: None,ReadOnly,ReadWrite. Поведение по умолчанию: Нет для хранилища уровня "Стандартный". ReadOnly для хранилища Premium.
createOption	DiskCreateOptionTypes	Указывает, как должен быть создан диск виртуальной машины. Возможные значения — подключение : это значение используется при использовании специализированного диска для создания виртуальной машины. FromImage: это значение используется при использовании образа для создания виртуальной машины. При использовании образа платформы также следует использовать элемент imageReference, описанный выше. Если вы используете образ Marketplace, вы также должны использовать элемент плана, описанный ранее.
deleteOption	DiskDeleteOptionTypes	Указывает, следует ли удалять или отсоединять диск ОС при удалении виртуальной машины. Возможные значения: Delete. Если это значение используется, диск ОС удаляется при удалении виртуальной машины. Отделять. Если это значение используется, диск ос сохраняется после удаления виртуальной машины. Значение по умолчанию имеет значение Отсоединение. Для временного диска ОС по умолчанию задано значение Delete. Пользователь не может изменить параметр удаления для временного диска ОС.
diffDiskSettings	DiffDiskSettings	Задает временные параметры диска для диска операционной системы, используемого виртуальной машиной.
diskSizeGB	integer	Задает размер пустого диска данных в гигабайтах. Этот элемент можно использовать для перезаписи размера диска в образе виртуальной машины. Свойство 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 на диске.

OSImageNotificationProfile

Указывает конфигурации, связанные с запланированным событием образа ОС.

Имя	Тип	Описание
enable	boolean	Указывает, включена или отключена ли запланированное событие образа ОС.
notBeforeTimeout	string	Время повторного переимыка виртуальной машины или обновление операционной системы может потенциально утвердить запланированное событие образа ОС, прежде чем событие будет утверждено автоматически (истекло время ожидания). Конфигурация указана в формате ISO 8601, а значение должно составлять 15 минут (PT15M)

OSProfile

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

Имя	Тип	Описание
adminPassword	string	Указывает пароль учетной записи администратора. минимальная длина (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", "user1", "user1", "test2", "test1", "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.

Имя	Тип	Описание
OobeSystem	string

PatchOperationStatus

Общее состояние успешного выполнения или сбоя операции. Он остается "InProgress" до завершения операции. На этом этапе она станет "Неизвестно", "Сбой", "Успешно" или "CompletedWithWarnings".

Имя	Тип	Описание
CompletedWithWarnings	string
Failed	string
InProgress	string
Succeeded	string
Unknown	string

PatchSettings

[Предварительная версия компонента] Указывает параметры, связанные с исправлением гостевой виртуальной машины в 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

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

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

ProtocolTypes

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

Имя	Тип	Описание
Http	string
Https	string

ProxyAgentSettings

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

Имя	Тип	Описание
enabled	boolean	Указывает, следует ли включить функцию ProxyAgent на виртуальной машине или масштабируемом наборе виртуальных машин.
keyIncarnationId	integer	Увеличьте значение этого свойства, чтобы пользователь сбрасывал ключ, используемый для защиты канала связи между гостевым и узлом.
mode	Mode	Указывает режим, на котором будет выполняться ProxyAgent, если эта функция включена. ProxyAgent начнет аудит или мониторинг, но не применяет управление доступом к запросам к конечным точкам узла в режиме аудита, в то время как в режиме принудительного применения будет применяться управление доступом. Значением по умолчанию является режим принудительного применения.

PublicIPAddressSku

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

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

PublicIPAddressSkuName

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

Имя	Тип	Описание
Basic	string
Standard	string

PublicIPAddressSkuTier

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

Имя	Тип	Описание
Global	string
Regional	string

PublicIPAllocationMethod

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

Имя	Тип	Описание
Dynamic	string
Static	string

ResourceIdentityType

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

Имя	Тип	Описание
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ScheduledEventsAdditionalPublishingTargets

Параметры конфигурации, используемые при публикации scheduledEventsAdditionalPublishingTargets.

Имя	Тип	Описание
eventGridAndResourceGraph	EventGridAndResourceGraph	Параметры конфигурации, используемые при создании параметра eventGridAndResourceGraph Scheduled Event.

ScheduledEventsPolicy

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

Имя	Тип	Описание
scheduledEventsAdditionalPublishingTargets	ScheduledEventsAdditionalPublishingTargets	Параметры конфигурации, используемые при публикации scheduledEventsAdditionalPublishingTargets.
userInitiatedReboot	UserInitiatedReboot	Параметры конфигурации, используемые при создании параметра запланированного события userInitiatedReboot.
userInitiatedRedeploy	UserInitiatedRedeploy	Параметры конфигурации, используемые при создании параметра события userInitiatedRedeploy, запланированного.

ScheduledEventsProfile

Указывает конфигурации, связанные с запланированными событиями.

Имя	Тип	Описание
osImageNotificationProfile	OSImageNotificationProfile	Указывает конфигурации, связанные с запланированным событием образа ОС.
terminateNotificationProfile	TerminateNotificationProfile	Указывает конфигурации, связанные с запланированным событием завершения.

securityEncryptionTypes

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

Имя	Тип	Описание
DiskWithVMGuestState	string
NonPersistedTPM	string
VMGuestStateOnly	string

SecurityProfile

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

Имя	Тип	Описание
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 не будет включен, если это свойство не задано.

Имя	Тип	Описание
ConfidentialVM	string
TrustedLaunch	string

SettingNames

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

Имя	Тип	Описание
AutoLogon	string
FirstLogonCommands	string

SshConfiguration

Указывает конфигурацию ключа SSH для ОС Linux.

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

SshPublicKey

Список открытых ключей 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

Код уровня.

Имя	Тип	Описание
Error	string
Info	string
Warning	string

StorageAccountTypes

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

Имя	Тип	Описание
PremiumV2_LRS	string
Premium_LRS	string
Premium_ZRS	string
StandardSSD_LRS	string
StandardSSD_ZRS	string
Standard_LRS	string
UltraSSD_LRS	string

StorageProfile

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

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

SubResource

Относительный URL-адрес Хранилища ключей, содержащий секрет.

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

TerminateNotificationProfile

Указывает конфигурации, связанные с запланированным событием завершения.

Имя	Тип	Описание
enable	boolean	Указывает, включено или отключено ли событие завершения.
notBeforeTimeout	string	Настраиваемая продолжительность удаления виртуальной машины должна будет потенциально утвердить запланированное событие завершения, прежде чем событие будет утверждено автоматически (истекло время ожидания). Конфигурация должна быть указана в формате ISO 8601, значение по умолчанию — 5 минут (PT5M)

UefiSettings

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

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

UserAssignedIdentities

Список удостоверений пользователей, связанных с виртуальной машиной. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

Имя	Тип	Описание

UserInitiatedReboot

Параметры конфигурации, используемые при создании параметра запланированного события userInitiatedReboot.

Имя	Тип	Описание
automaticallyApprove	boolean	Указывает конфигурации, связанные с запланированными событиями перезагрузки.

UserInitiatedRedeploy

Параметры конфигурации, используемые при создании параметра события userInitiatedRedeploy, запланированного.

Имя	Тип	Описание
automaticallyApprove	boolean	Указывает конфигурации, связанные с запланированным событием повторного развертывания.

VaultCertificate

Список ссылок на хранилище ключей в SourceVault, содержащий сертификаты.

Имя	Тип	Описание
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":", "dataType":"pfx", "password":"" } Чтобы установить сертификаты на виртуальной машине, рекомендуется использовать расширение виртуальной машины Azure Key Vault для Linux или расширение виртуальной машины Azure Key Vault для Windows.

VaultSecretGroup

Задает набор сертификатов, которые должны быть установлены на виртуальной машине. Чтобы установить сертификаты на виртуальной машине, рекомендуется использовать расширение виртуальной машины Azure Key Vault для Linux или расширение виртуальной машины Azure Key Vault для Windows.

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

VirtualHardDisk

Виртуальный жесткий диск.

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

VirtualMachine

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

Имя	Тип	Описание
etag	string	Etag — это свойство, возвращаемое в файле Create/Update/Get ответа виртуальной машины, чтобы клиент смог предоставить его в заголовке, чтобы обеспечить оптимистические обновления.
extendedLocation	ExtendedLocation	Расширенное расположение виртуальной машины.
id	string	Идентификатор ресурса
identity	VirtualMachineIdentity	Удостоверение виртуальной машины, если настроено.
location	string	Расположение ресурса
managedBy	string	ManagedBy имеет значение "Масштабируемый набор виртуальных машин" (VMSS) flex ARM RESOURCEID, если виртуальная машина является частью VMSS. Это свойство используется платформой для оптимизации удаления внутренней группы ресурсов.
name	string	Имя ресурса
plan	Plan	Указывает сведения об образе Marketplace, используемом для создания виртуальной машины. Этот элемент используется только для образов Marketplace. Прежде чем использовать образ Marketplace из API, необходимо включить образ для программного использования. На портале Azure найдите образ Marketplace, который вы хотите использовать, а затем щелкните Хотите развернуть программным способом, Get Started (Начало работы—>). Введите все необходимые сведения и нажмите кнопку Сохранить.
properties.additionalCapabilities	AdditionalCapabilities	Указывает дополнительные возможности, включенные или отключенные на виртуальной машине.
properties.applicationProfile	ApplicationProfile	Указывает приложения коллекции, которые должны быть доступны для виртуальной машины или VMSS.
properties.availabilitySet	SubResource	Указывает сведения о группе доступности, к которому должна быть назначена виртуальная машина. Виртуальные машины, указанные в одном наборе доступности, выделяются различным узлам для обеспечения максимальной доступности. Дополнительные сведения о группах доступности см. в обзоренаборов доступности. Дополнительные сведения о плановом обслуживании Azure см. в статье Обслуживание и обновления виртуальных машин в Azure. В настоящее время виртуальная машина может быть добавлена только в группу доступности во время создания. Группа доступности, к которой добавляется виртуальная машина, должна находиться в той же группе ресурсов, что и ресурс группы доступности. Существующую виртуальную машину нельзя добавить в группу доступности. Это свойство не может существовать вместе со ссылкой ненулевого свойства.virtualMachineScaleSet.
properties.billingProfile	BillingProfile	Указывает сведения о выставлении счетов, связанные с виртуальной машиной Azure Spot. Минимальная версия API: 2019-03-01.
properties.capacityReservation	CapacityReservationProfile	Указывает сведения о резервировании емкости, используемом для выделения виртуальной машины. Минимальная версия API: 2021-04-01.
properties.diagnosticsProfile	DiagnosticsProfile	Указывает состояние параметров диагностики загрузки. Минимальная версия API: 2015-06-15.
properties.evictionPolicy	VirtualMachineEvictionPolicyTypes	Указывает политику вытеснения для виртуальной машины Azure Spot и масштабируемого набора Azure Spot. Для виртуальных машин Azure Spot поддерживаются как "Deallocate", так и "Delete", а минимальная версия API — 2019-03-01. Для масштабируемых наборов Azure Spot поддерживаются как "Deallocate", так и "Delete", а минимальная версия API — 2017-10-30-preview.
properties.extensionsTimeBudget	string	Указывает время начала всех расширений. Длительность времени должна составлять от 15 минут до 120 минут (включительно) и должна быть указана в формате ISO 8601. Значение по умолчанию — 90 минут (PT1H30M). Минимальная версия API: 2020-06-01.
properties.hardwareProfile	HardwareProfile	Указывает параметры оборудования для виртуальной машины.
properties.host	SubResource	Указывает сведения о выделенном узле, в котором находится виртуальная машина. Минимальная версия API: 2018-10-01.
properties.hostGroup	SubResource	Указывает сведения о выделенной группе узлов, в которой находится виртуальная машина. Примечание. Пользователь не может указывать свойства узла и hostGroup. Минимальная версия API: 2020-06-01.
properties.instanceView	VirtualMachineInstanceView	Представление экземпляра виртуальной машины.
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.networkProfile	NetworkProfile	Указывает сетевые интерфейсы виртуальной машины.
properties.osProfile	OSProfile	Задает параметры операционной системы, используемые при создании виртуальной машины. Некоторые параметры нельзя изменить после подготовки виртуальной машины.
properties.platformFaultDomain	integer	Указывает домен логического сбоя масштабируемого набора, в котором будет создана виртуальная машина. По умолчанию виртуальная машина будет автоматически назначена домену сбоя, который лучше всего поддерживает баланс между доступными доменами сбоя. Это применимо, только если свойство virtualMachineScaleSet этой виртуальной машины задано. На масштабируемый набор виртуальных машин, на который ссылается, должен иметь значение platformFaultDomainCount больше 1. Это свойство невозможно обновить после создания виртуальной машины. Назначение домена сбоя можно просмотреть в представлении экземпляра виртуальной машины. Минимальная версия api:2020:12-01.
properties.priority	VirtualMachinePriorityTypes	Указывает приоритет виртуальной машины. Минимальная версия API: 2019-03-01
properties.provisioningState	string	Состояние подготовки, которое отображается только в ответе.
properties.proximityPlacementGroup	SubResource	Указывает сведения о группе размещения близкого взаимодействия, в которую должна быть назначена виртуальная машина. Минимальная версия API: 2018-04-01.
properties.scheduledEventsPolicy	ScheduledEventsPolicy	Указывает конфигурации запланированных событий, связанных с развертыванием, перезагрузкой и ScheduledEventsAdditionalPublishingTargets для виртуальной машины.
properties.scheduledEventsProfile	ScheduledEventsProfile	Указывает конфигурации, связанные с запланированными событиями.
properties.securityProfile	SecurityProfile	Указывает параметры профиля, связанного с безопасностью для виртуальной машины.
properties.storageProfile	StorageProfile	Задает параметры хранилища для дисков виртуальной машины.
properties.timeCreated	string	Указывает время создания ресурса виртуальной машины. Минимальная версия API: 2021-11-01.
properties.userData	string	UserData для виртуальной машины, которая должна быть закодирована в кодировке Base-64. Клиент не должен передавать здесь какие-либо секреты. Минимальная версия API: 2021-03-01.
properties.virtualMachineScaleSet	SubResource	Указывает сведения о масштабируемом наборе виртуальных машин, которому должна быть назначена виртуальная машина. Виртуальные машины, указанные в одном масштабируемом наборе виртуальных машин, выделяются различным узлам для обеспечения максимальной доступности. В настоящее время виртуальная машина может быть добавлена только в масштабируемый набор виртуальных машин во время создания. Существующую виртуальную машину нельзя добавить в масштабируемый набор виртуальных машин. Это свойство не может существовать вместе со ссылкой, отличной от null properties.availabilitySet. Минимальная версия API:2019_03_01.
properties.vmId	string	Указывает уникальный идентификатор виртуальной машины, который является 128-разрядным идентификатором, который кодируется и хранится во всех виртуальных машинах IaaS Azure SMBIOS и может быть считываться с помощью команд BIOS платформы.
resources	VirtualMachineExtension[]	Ресурсы дочернего расширения виртуальной машины.
tags	object	Теги ресурсов
type	string	Тип ресурса
zones	string[]	Зоны виртуальных машин.

VirtualMachineAgentInstanceView

Агент виртуальной машины, работающий на виртуальной машине.

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

VirtualMachineEvictionPolicyTypes

Указывает политику вытеснения для виртуальной машины Azure Spot и масштабируемого набора Azure Spot. Для виртуальных машин Azure Spot поддерживаются как "Deallocate", так и "Delete", а минимальная версия API — 2019-03-01. Для масштабируемых наборов Azure Spot поддерживаются как "Deallocate", так и "Delete", а минимальная версия API — 2017-10-30-preview.

Имя	Тип	Описание
Deallocate	string
Delete	string

VirtualMachineExtension

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

Имя	Тип	Описание
id	string	Идентификатор ресурса
location	string	Расположение ресурса
name	string	Имя ресурса
properties.autoUpgradeMinorVersion	boolean	Указывает, следует ли использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновлять дополнительные версии без повторного развертывания, даже если это свойство не имеет значения true.
properties.enableAutomaticUpgrade	boolean	Указывает, следует ли автоматически обновлять расширение платформой, если доступна более новая версия расширения.
properties.forceUpdateTag	string	Как обработчик расширений должен быть вынужден обновляться, даже если конфигурация расширения не изменилась.
properties.instanceView	VirtualMachineExtensionInstanceView	Представление экземпляра расширения виртуальной машины.
properties.protectedSettings	object	Расширение может содержать защищенные параметрыSettings или protectedSettingsFromKeyVault или не иметь защищенных параметров.
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	Защищенные расширения, передаваемые по ссылке, и используемые из хранилища ключей
properties.provisionAfterExtensions	string[]	Коллекция имен расширений, после которой необходимо подготовить это расширение.
properties.provisioningState	string	Состояние подготовки, которое отображается только в ответе.
properties.publisher	string	Имя издателя обработчика расширений.
properties.settings	object	Форматированные общедоступные параметры json для расширения.
properties.suppressFailures	boolean	Указывает, будут ли отключены сбои, возникающие из расширения (операционные сбои, такие как отсутствие подключения к виртуальной машине, не будут подавляться независимо от этого значения). Значение по умолчанию — false.
properties.type	string	Указывает тип расширения; примером является CustomScriptExtension.
properties.typeHandlerVersion	string	Указывает версию обработчика скрипта.
tags	object	Теги ресурсов
type	string	Тип ресурса

VirtualMachineExtensionHandlerInstanceView

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

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

VirtualMachineExtensionInstanceView

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

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

VirtualMachineHealthStatus

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

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

VirtualMachineIdentity

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

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

VirtualMachineInstanceView

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

Имя	Тип	Описание
assignedHost	string	Идентификатор ресурса выделенного узла, на котором виртуальная машина выделяется с помощью автоматического размещения, когда виртуальная машина связана с выделенной группой узлов с включенным автоматическим размещением. Минимальная версия API: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	Диагностика загрузки — это функция отладки, которая позволяет просматривать выходные данные консоли и снимок экрана для диагностики состояния виртуальной машины. Вы можете легко просмотреть выходные данные журнала консоли. Azure также позволяет просмотреть снимок экрана виртуальной машины из гипервизора.
computerName	string	Имя компьютера, назначенное виртуальной машине.
disks	DiskInstanceView[]	Сведения о диске виртуальной машины.
extensions	VirtualMachineExtensionInstanceView[]	Сведения о расширениях.
hyperVGeneration	HyperVGenerationType	Указывает тип HyperVGeneration, связанный с ресурсом
isVMInStandbyPool	boolean	[Предварительная версия компонента] Указывает, находится ли виртуальная машина в резервном пуле или вне нее.
maintenanceRedeployStatus	MaintenanceRedeployStatus	Состояние операции обслуживания на виртуальной машине.
osName	string	Операционная система, запущенная на виртуальной машине.
osVersion	string	Версия операционной системы, запущенной на виртуальной машине.
patchStatus	VirtualMachinePatchStatus	[Предварительная версия компонента] Состояние операций исправления виртуальной машины.
platformFaultDomain	integer	Указывает домен сбоя виртуальной машины.
platformUpdateDomain	integer	Указывает домен обновления виртуальной машины.
rdpThumbPrint	string	Отпечаток сертификата удаленного рабочего стола.
statuses	InstanceViewStatus[]	Сведения о состоянии ресурса.
vmAgent	VirtualMachineAgentInstanceView	Агент виртуальной машины, работающий на виртуальной машине.
vmHealth	VirtualMachineHealthStatus	Состояние работоспособности виртуальной машины.

VirtualMachineIpTag

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

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

VirtualMachineNetworkInterfaceConfiguration

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

Имя	Тип	Описание
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

Параметры DNS, применяемые к сетевым интерфейсам.

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

VirtualMachineNetworkInterfaceIPConfiguration

Указывает 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	Указывает идентификатор подсети.

VirtualMachinePatchStatus

[Предварительная версия компонента] Состояние операций исправления виртуальной машины.

Имя	Тип	Описание
availablePatchSummary	AvailablePatchSummary	Доступная сводка по исправлению последней операции оценки для виртуальной машины.
configurationStatuses	InstanceViewStatus[]	Состояние включения указанного patchMode
lastPatchInstallationSummary	LastPatchInstallationSummary	Сводка по установке последней операции установки для виртуальной машины.

VirtualMachinePriorityTypes

Указывает приоритет виртуальной машины. Минимальная версия API: 2019-03-01

Имя	Тип	Описание
Low	string
Regular	string
Spot	string

VirtualMachinePublicIPAddressConfiguration

PublicIPAddressConfiguration.

Имя	Тип	Описание
name	string	Имя конфигурации адреса publicIP.
properties.deleteOption	DeleteOptions	Укажите, что происходит с общедоступным IP-адресом при удалении виртуальной машины
properties.dnsSettings	VirtualMachinePublicIPAddressDnsSettingsConfiguration	Параметры DNS, применяемые к общедоступным АДРЕСАм.
properties.idleTimeoutInMinutes	integer	Время ожидания простоя общедоступного 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

Параметры DNS, применяемые к общедоступным АДРЕСАм.

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

VirtualMachineSizeTypes

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

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

VMDiskSecurityProfile

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

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

VMGalleryApplication

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

Имя	Тип	Описание
configurationReference	string	Необязательный. Указывает универсальный код ресурса ресурса (URI) для большого двоичного объекта Azure, который заменит конфигурацию по умолчанию для пакета при условии предоставления.
enableAutomaticUpgrade	boolean	Если задано значение true, когда новая версия приложения коллекции доступна в PIR/SIG, она будет автоматически обновлена для виртуальной машины или VMSS.
order	integer	Необязательный параметр указывает порядок установки пакетов
packageReferenceId	string	Указывает идентификатор ресурса GalleryApplicationVersion в форме /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/applications/{application}/versions/{versions/{versions}
tags	string	Необязательный атрибут— задает значение сквозного руководства для более универсального контекста.
treatFailureAsDeploymentFailure	boolean	Необязательный, если значение true, любой сбой для любой операции в VmApplication завершится сбоем развертывания.

VMSizeProperties

Задает свойства для настройки размера виртуальной машины. Минимальная версия API: 2021-07-01. Эта функция по-прежнему находится в режиме предварительной версии и не поддерживается для VirtualMachineScaleSet. Дополнительные сведения см. в настройки виртуальной машины.

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

WindowsConfiguration

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

Имя	Тип	Описание
additionalUnattendContent	AdditionalUnattendContent[]	Указывает дополнительные сведения в формате XML в кодировке Base-64, которые можно включить в файл Unattend.xml, который используется программой установки Windows.
enableAutomaticUpdates	boolean	Указывает, включено ли автоматическое обновление для виртуальной машины Windows. Значение по умолчанию — true. Для масштабируемых наборов виртуальных машин это свойство можно обновить, и обновления вступают в силу при повторной подготовке ОС.
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.

Имя	Тип	Описание
AutomaticByPlatform	string
ImageDefault	string

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

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

Имя	Тип	Описание
Always	string
IfRequired	string
Never	string
Unknown	string

WindowsVMGuestPatchAutomaticByPlatformSettings

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

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

WindowsVMGuestPatchMode

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

Возможные значения:

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

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

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

Имя	Тип	Описание
AutomaticByOS	string
AutomaticByPlatform	string
Manual	string

WinRMConfiguration

Задает прослушиватели удаленного управления Windows. Это позволяет удаленно использовать Windows PowerShell.

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

WinRMListener

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

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