Virtual Machines - Create Or Update

Service:

Dev Test Labs

API Version:

2018-09-15

Создайте или замените существующую виртуальную машину. Эта операция может занять некоторое время.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}?api-version=2018-09-15

Параметры URI

Имя	В	Обязательно	Тип	Описание
labName	path	True	string	Имя лаборатории.
name	path	True	string	Имя виртуальной машины.
resourceGroupName	path	True	string	Имя группы ресурсов.
subscriptionId	path	True	string	Идентификатор подписки.
api-version	query	True	string	Версия API клиента.

Текст запроса

Имя	Тип	Описание
location	string	Расположение ресурса.
properties.allowClaim	boolean	Указывает, может ли другой пользователь стать владельцем виртуальной машины.
properties.artifacts	ArtifactInstallProperties[]	Артефакты, устанавливаемые на виртуальной машине.
properties.createdDate	string	Дата создания виртуальной машины.
properties.customImageId	string	Идентификатор пользовательского образа виртуальной машины.
properties.dataDiskParameters	DataDiskProperties[]	Новые или существующие диски данных для подключения к виртуальной машине после создания
properties.disallowPublicIpAddress	boolean	Указывает, будет ли виртуальная машина создана без общедоступного IP-адреса.
properties.environmentId	string	Идентификатор ресурса среды, содержащей эту виртуальную машину, если таковой есть.
properties.expirationDate	string	Дата окончания срока действия виртуальной машины.
properties.galleryImageReference	GalleryImageReference	Ссылка на образ виртуальной машины microsoft Azure Marketplace.
properties.isAuthenticationWithSshKey	boolean	Указывает, использует ли эта виртуальная машина ключ SSH для проверки подлинности.
properties.labSubnetName	string	Имя подсети лаборатории виртуальной машины.
properties.labVirtualNetworkId	string	Идентификатор виртуальной сети лаборатории виртуальной машины.
properties.networkInterface	NetworkInterfaceProperties	Свойства сетевого интерфейса.
properties.notes	string	Заметки виртуальной машины.
properties.ownerObjectId	string	Идентификатор объекта владельца виртуальной машины.
properties.ownerUserPrincipalName	string	Имя участника-пользователя владельца виртуальной машины.
properties.password	string	Пароль администратора виртуальной машины.
properties.planId	string	Идентификатор плана, связанного с образом виртуальной машины.
properties.scheduleParameters	ScheduleCreationParameter[]	Создаваемые расписания виртуальных машин
properties.size	string	Размер виртуальной машины.
properties.sshKey	string	Ключ SSH администратора виртуальной машины.
properties.storageType	string	Тип хранилища, используемого для виртуальной машины (например, "Стандартный", "Премиум").
properties.userName	string	Имя пользователя виртуальной машины.
tags	object	Теги ресурса.

Ответы

Имя	Тип	Описание
200 OK	LabVirtualMachine	ОК
201 Created	LabVirtualMachine	Создание
Other Status Codes	CloudError	BadRequest

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

azure_auth

Неявное предоставление OAuth2

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

Scopes

Имя	Описание
user_impersonation	Доступ к Microsoft Azure

Примеры

VirtualMachines_CreateOrUpdate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{vmName}?api-version=2018-09-15

{
  "properties": {
    "size": "Standard_A2_v2",
    "userName": "{userName}",
    "password": "{userPassword}",
    "labSubnetName": "{virtualNetworkName}Subnet",
    "labVirtualNetworkId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualnetworks/{virtualNetworkName}",
    "disallowPublicIpAddress": true,
    "galleryImageReference": {
      "offer": "UbuntuServer",
      "publisher": "Canonical",
      "sku": "16.04-LTS",
      "osType": "Linux",
      "version": "Latest"
    },
    "allowClaim": true,
    "storageType": "Standard"
  },
  "location": "{location}",
  "tags": {
    "tagName1": "tagValue1"
  }
}

Java

import com.azure.resourcemanager.devtestlabs.models.GalleryImageReference;
import java.util.HashMap;
import java.util.Map;

/** Samples for VirtualMachines CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_CreateOrUpdate.json
     */
    /**
     * Sample code: VirtualMachines_CreateOrUpdate.
     *
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void virtualMachinesCreateOrUpdate(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager
            .virtualMachines()
            .define("{vmName}")
            .withRegion("{location}")
            .withExistingLab("resourceGroupName", "{labName}")
            .withTags(mapOf("tagName1", "tagValue1"))
            .withSize("Standard_A2_v2")
            .withUsername("{userName}")
            .withPassword("{userPassword}")
            .withLabSubnetName("{virtualNetworkName}Subnet")
            .withLabVirtualNetworkId(
                "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualnetworks/{virtualNetworkName}")
            .withDisallowPublicIpAddress(true)
            .withGalleryImageReference(
                new GalleryImageReference()
                    .withOffer("UbuntuServer")
                    .withPublisher("Canonical")
                    .withSku("16.04-LTS")
                    .withOsType("Linux")
                    .withVersion("Latest"))
            .withAllowClaim(true)
            .withStorageType("Standard")
            .create();
    }

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

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.devtestlabs import DevTestLabsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-devtestlabs
# USAGE
    python virtual_machines_create_or_update.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 = DevTestLabsClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscriptionId}",
    )

    response = client.virtual_machines.begin_create_or_update(
        resource_group_name="resourceGroupName",
        lab_name="{labName}",
        name="{vmName}",
        lab_virtual_machine={
            "location": "{location}",
            "properties": {
                "allowClaim": True,
                "disallowPublicIpAddress": True,
                "galleryImageReference": {
                    "offer": "UbuntuServer",
                    "osType": "Linux",
                    "publisher": "Canonical",
                    "sku": "16.04-LTS",
                    "version": "Latest",
                },
                "labSubnetName": "{virtualNetworkName}Subnet",
                "labVirtualNetworkId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualnetworks/{virtualNetworkName}",
                "password": "{userPassword}",
                "size": "Standard_A2_v2",
                "storageType": "Standard",
                "userName": "{userName}",
            },
            "tags": {"tagName1": "tagValue1"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_CreateOrUpdate.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 armdevtestlabs_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/devtestlabs/armdevtestlabs"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_CreateOrUpdate.json
func ExampleVirtualMachinesClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdevtestlabs.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewVirtualMachinesClient().BeginCreateOrUpdate(ctx, "resourceGroupName", "{labName}", "{vmName}", armdevtestlabs.LabVirtualMachine{
		Location: to.Ptr("{location}"),
		Tags: map[string]*string{
			"tagName1": to.Ptr("tagValue1"),
		},
		Properties: &armdevtestlabs.LabVirtualMachineProperties{
			AllowClaim:              to.Ptr(true),
			DisallowPublicIPAddress: to.Ptr(true),
			GalleryImageReference: &armdevtestlabs.GalleryImageReference{
				Offer:     to.Ptr("UbuntuServer"),
				OSType:    to.Ptr("Linux"),
				Publisher: to.Ptr("Canonical"),
				SKU:       to.Ptr("16.04-LTS"),
				Version:   to.Ptr("Latest"),
			},
			LabSubnetName:       to.Ptr("{virtualNetworkName}Subnet"),
			LabVirtualNetworkID: to.Ptr("/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualnetworks/{virtualNetworkName}"),
			Password:            to.Ptr("{userPassword}"),
			Size:                to.Ptr("Standard_A2_v2"),
			StorageType:         to.Ptr("Standard"),
			UserName:            to.Ptr("{userName}"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.LabVirtualMachine = armdevtestlabs.LabVirtualMachine{
	// 	Name: to.Ptr("{vmName}"),
	// 	Type: to.Ptr("Microsoft.DevTestLab/labs/virtualMachines"),
	// 	ID: to.Ptr("/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualmachines/{vmName}"),
	// 	Location: to.Ptr("{location}"),
	// 	Tags: map[string]*string{
	// 		"tagName1": to.Ptr("tagValue1"),
	// 	},
	// 	Properties: &armdevtestlabs.LabVirtualMachineProperties{
	// 		AllowClaim: to.Ptr(true),
	// 		ArtifactDeploymentStatus: &armdevtestlabs.ArtifactDeploymentStatusProperties{
	// 			ArtifactsApplied: to.Ptr[int32](0),
	// 			TotalArtifacts: to.Ptr[int32](0),
	// 		},
	// 		CreatedByUser: to.Ptr(""),
	// 		CreatedByUserID: to.Ptr(""),
	// 		CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-10-01T23:53:02.483Z"); return t}()),
	// 		DataDiskParameters: []*armdevtestlabs.DataDiskProperties{
	// 		},
	// 		DisallowPublicIPAddress: to.Ptr(true),
	// 		GalleryImageReference: &armdevtestlabs.GalleryImageReference{
	// 			Offer: to.Ptr("UbuntuServer"),
	// 			OSType: to.Ptr("Linux"),
	// 			Publisher: to.Ptr("Canonical"),
	// 			SKU: to.Ptr("16.04-LTS"),
	// 			Version: to.Ptr("Latest"),
	// 		},
	// 		LabSubnetName: to.Ptr("{virtualNetworkName}Subnet"),
	// 		LabVirtualNetworkID: to.Ptr("/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualnetworks/{virtualNetworkName}"),
	// 		NetworkInterface: &armdevtestlabs.NetworkInterfaceProperties{
	// 		},
	// 		OwnerObjectID: to.Ptr(""),
	// 		OwnerUserPrincipalName: to.Ptr(""),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		Size: to.Ptr("Standard_A2_v2"),
	// 		StorageType: to.Ptr("Standard"),
	// 		UniqueIdentifier: to.Ptr("{uniqueIdentifier}"),
	// 		UserName: to.Ptr("{userName}"),
	// 		VirtualMachineCreationSource: to.Ptr(armdevtestlabs.VirtualMachineCreationSourceFromGalleryImage),
	// 	},
	// }
}

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 { DevTestLabsClient } = require("@azure/arm-devtestlabs");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create or replace an existing virtual machine. This operation can take a while to complete.
 *
 * @summary Create or replace an existing virtual machine. This operation can take a while to complete.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_CreateOrUpdate.json
 */
async function virtualMachinesCreateOrUpdate() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{labName}";
  const name = "{vmName}";
  const labVirtualMachine = {
    allowClaim: true,
    disallowPublicIpAddress: true,
    galleryImageReference: {
      offer: "UbuntuServer",
      osType: "Linux",
      publisher: "Canonical",
      sku: "16.04-LTS",
      version: "Latest",
    },
    labSubnetName: "{virtualNetworkName}Subnet",
    labVirtualNetworkId:
      "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualnetworks/{virtualNetworkName}",
    location: "{location}",
    password: "{userPassword}",
    size: "Standard_A2_v2",
    storageType: "Standard",
    tags: { tagName1: "tagValue1" },
    userName: "{userName}",
  };
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const result = await client.virtualMachines.beginCreateOrUpdateAndWait(
    resourceGroupName,
    labName,
    name,
    labVirtualMachine
  );
  console.log(result);
}

virtualMachinesCreateOrUpdate().catch(console.error);

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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DevTestLabs;
using Azure.ResourceManager.DevTestLabs.Models;

// Generated from example definition: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_CreateOrUpdate.json
// this example is just showing the usage of "VirtualMachines_CreateOrUpdate" 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 DevTestLabResource created on azure
// for more information of creating DevTestLabResource, please refer to the document of DevTestLabResource
string subscriptionId = "{subscriptionId}";
string resourceGroupName = "resourceGroupName";
string labName = "{labName}";
ResourceIdentifier devTestLabResourceId = DevTestLabResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, labName);
DevTestLabResource devTestLab = client.GetDevTestLabResource(devTestLabResourceId);

// get the collection of this DevTestLabVmResource
DevTestLabVmCollection collection = devTestLab.GetDevTestLabVms();

// invoke the operation
string name = "{vmName}";
DevTestLabVmData data = new DevTestLabVmData(new AzureLocation("{location}"))
{
    Size = "Standard_A2_v2",
    UserName = "{userName}",
    Password = "{userPassword}",
    LabSubnetName = "{virtualNetworkName}Subnet",
    LabVirtualNetworkId = new ResourceIdentifier("/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualnetworks/{virtualNetworkName}"),
    DisallowPublicIPAddress = true,
    GalleryImageReference = new DevTestLabGalleryImageReference()
    {
        Offer = "UbuntuServer",
        Publisher = "Canonical",
        Sku = "16.04-LTS",
        OSType = "Linux",
        Version = "Latest",
    },
    AllowClaim = true,
    StorageType = "Standard",
    Tags =
    {
    ["tagName1"] = "tagValue1",
    },
};
ArmOperation<DevTestLabVmResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, name, data);
DevTestLabVmResource result = lro.Value;

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

Sample Response

Status code:

200

{
  "properties": {
    "ownerObjectId": "",
    "ownerUserPrincipalName": "",
    "createdByUserId": "",
    "createdByUser": "",
    "createdDate": "2018-10-01T16:53:02.4830866-07:00",
    "size": "Standard_A2_v2",
    "userName": "{userName}",
    "labSubnetName": "{virtualNetworkName}Subnet",
    "labVirtualNetworkId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualnetworks/{virtualNetworkName}",
    "disallowPublicIpAddress": true,
    "artifactDeploymentStatus": {
      "artifactsApplied": 0,
      "totalArtifacts": 0
    },
    "galleryImageReference": {
      "offer": "UbuntuServer",
      "publisher": "Canonical",
      "sku": "16.04-LTS",
      "osType": "Linux",
      "version": "Latest"
    },
    "networkInterface": {},
    "allowClaim": true,
    "storageType": "Standard",
    "virtualMachineCreationSource": "FromGalleryImage",
    "dataDiskParameters": [],
    "provisioningState": "Creating",
    "uniqueIdentifier": "{uniqueIdentifier}"
  },
  "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualmachines/{vmName}",
  "name": "{vmName}",
  "type": "Microsoft.DevTestLab/labs/virtualMachines",
  "location": "{location}",
  "tags": {
    "tagName1": "tagValue1"
  }
}

Status code:

201

{
  "properties": {
    "ownerObjectId": "",
    "ownerUserPrincipalName": "",
    "createdByUserId": "",
    "createdByUser": "",
    "createdDate": "2018-10-01T16:53:02.4830866-07:00",
    "size": "Standard_A2_v2",
    "userName": "{userName}",
    "labSubnetName": "{virtualNetworkName}Subnet",
    "labVirtualNetworkId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualnetworks/{virtualNetworkName}",
    "disallowPublicIpAddress": true,
    "artifactDeploymentStatus": {
      "artifactsApplied": 0,
      "totalArtifacts": 0
    },
    "galleryImageReference": {
      "offer": "UbuntuServer",
      "publisher": "Canonical",
      "sku": "16.04-LTS",
      "osType": "Linux",
      "version": "Latest"
    },
    "networkInterface": {},
    "allowClaim": true,
    "storageType": "Standard",
    "virtualMachineCreationSource": "FromGalleryImage",
    "dataDiskParameters": [],
    "provisioningState": "Creating",
    "uniqueIdentifier": "{uniqueIdentifier}"
  },
  "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualmachines/{vmName}",
  "name": "{vmName}",
  "type": "Microsoft.DevTestLab/labs/virtualMachines",
  "location": "{location}",
  "tags": {
    "tagName1": "tagValue1"
  }
}

Определения

Имя	Описание
ApplicableSchedule	Расписания, применимые к виртуальной машине. Расписания могли быть определены на виртуальной машине или на уровне лаборатории.
ArtifactDeploymentStatusProperties	Свойства развертывания артефакта.
ArtifactInstallProperties	Свойства артефакта.
ArtifactParameterProperties	Свойства параметра артефакта.
AttachNewDataDiskOptions	Свойства для подключения нового диска к виртуальной машине.
CloudError	Ошибка из запроса REST.
CloudErrorBody	Текст ошибки из запроса REST.
ComputeDataDisk	Диски данных, подключенные к виртуальной машине.
ComputeVmInstanceViewStatus	Сведения о состоянии виртуальной машины.
ComputeVmProperties	Свойства виртуальной машины, возвращаемые API Microsoft.Compute.
DataDiskProperties	Текст запроса на добавление нового или существующего диска данных в виртуальную машину.
DayDetails	Свойства ежедневного расписания.
EnableStatus	Состояние расписания (т. е. "Включено", "Отключено")
GalleryImageReference	Справочные сведения для Azure Marketplace изображения.
HostCachingOptions	Параметр кэширования для диска данных (т. е. None, ReadOnly, ReadWrite).
HourDetails	Свойства почасового расписания.
InboundNatRule	Правило для NAT — предоставление порта виртуальной машины (внутренний порт) на общедоступном IP-адресе с помощью подсистемы балансировки нагрузки.
LabVirtualMachine	Виртуальная машина.
NetworkInterfaceProperties	Свойства сетевого интерфейса.
NotificationSettings	Параметры уведомлений для расписания.
Schedule	Расписание.
ScheduleCreationParameter	Свойства для создания расписания.
SharedPublicIpAddressConfiguration	Свойства виртуальной машины, определяющие, как она подключена к подсистеме балансировки нагрузки.
StorageType	Тип хранилища для диска (например, "Стандартный", "Премиум").
TransportProtocol	Транспортный протокол для конечной точки.
VirtualMachineCreationSource	Сообщает источник создания виртуальной машины лаборатории. Только выходное свойство.
WeekDetails	Свойства еженедельного расписания.

ApplicableSchedule

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

Имя	Тип	Описание
id	string	Идентификатор ресурса.
location	string	Расположение ресурса.
name	string	Имя ресурса.
properties.labVmsShutdown	Schedule	Расписание автоматического завершения работы, если оно было задано на уровне лаборатории или ресурса лаборатории.
properties.labVmsStartup	Schedule	Расписание автоматического запуска, если оно было задано на уровне лаборатории или ресурса лаборатории.
tags	object	Теги ресурса.
type	string	Тип ресурса.

ArtifactDeploymentStatusProperties

Свойства развертывания артефакта.

Имя	Тип	Описание
artifactsApplied	integer	Общее число успешно примененных артефактов.
deploymentStatus	string	Состояние развертывания артефакта.
totalArtifacts	integer	Общее количество артефактов, которые были применены предварительно.

ArtifactInstallProperties

Свойства артефакта.

Имя	Тип	Описание
artifactId	string	Идентификатор артефакта.
artifactTitle	string	Название артефакта.
deploymentStatusMessage	string	Сообщение о состоянии из развертывания.
installTime	string	Время начала установки артефакта на виртуальной машине.
parameters	ArtifactParameterProperties[]	Параметры артефакта.
status	string	Состояние артефакта.
vmExtensionStatusMessage	string	Сообщение о состоянии из расширения виртуальной машины.

ArtifactParameterProperties

Свойства параметра артефакта.

Имя	Тип	Описание
name	string	Имя параметра артефакта.
value	string	Значение параметра артефакта.

AttachNewDataDiskOptions

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

Имя	Тип	Описание
diskName	string	Имя подключаемого диска.
diskSizeGiB	integer	Размер подключаемого диска в гибибайтах.
diskType	StorageType	Тип хранилища для диска (например, "Стандартный", "Премиум").

CloudError

Ошибка из запроса REST.

Имя	Тип	Описание
error	CloudErrorBody	Произошла облачная ошибка

CloudErrorBody

Текст ошибки из запроса REST.

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

ComputeDataDisk

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

Имя	Тип	Описание
diskSizeGiB	integer	Возвращает размер диска данных в ГиБ.
diskUri	string	При поддержке большого двоичного объекта — универсальный код ресурса (URI) базового blob-объекта.
managedDiskId	string	При поддержке управляемого диска это идентификатор ресурса вычислительного диска.
name	string	Возвращает имя диска данных.

ComputeVmInstanceViewStatus

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

Имя	Тип	Описание
code	string	Возвращает код состояния.
displayStatus	string	Возвращает короткую локализуемую метку для состояния.
message	string	Возвращает сообщение, связанное с состоянием.

ComputeVmProperties

Свойства виртуальной машины, возвращаемые API Microsoft.Compute.

Имя	Тип	Описание
dataDiskIds	string[]	Возвращает URI blob-объекта дисков данных для виртуальной машины.
dataDisks	ComputeDataDisk[]	Возвращает все диски данных, подключенные к виртуальной машине.
networkInterfaceId	string	Возвращает идентификатор сетевого интерфейса виртуальной машины.
osDiskId	string	Возвращает URI большого двоичного объекта диска ОС для виртуальной машины.
osType	string	Возвращает тип ОС виртуальной машины.
statuses	ComputeVmInstanceViewStatus[]	Возвращает состояния виртуальной машины.
vmSize	string	Возвращает размер виртуальной машины.

DataDiskProperties

Текст запроса на добавление нового или существующего диска данных в виртуальную машину.

Имя	Тип	Описание
attachNewDataDiskOptions	AttachNewDataDiskOptions	Задает параметры для подключения нового диска к виртуальной машине.
existingLabDiskId	string	Указывает идентификатор существующего диска лаборатории для подключения к виртуальной машине.
hostCaching	HostCachingOptions	Параметр кэширования для диска данных (например, None, ReadOnly, ReadWrite).

DayDetails

Свойства ежедневного расписания.

Имя	Тип	Описание
time	string	Время суток, когда расписание будет выполняться.

EnableStatus

Состояние расписания (т. е. "Включено", "Отключено")

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

GalleryImageReference

Справочные сведения для Azure Marketplace изображения.

Имя	Тип	Описание
offer	string	Предложение образа коллекции.
osType	string	Тип ОС образа коллекции.
publisher	string	Издатель образа коллекции.
sku	string	Номер SKU образа коллекции.
version	string	Версия образа коллекции.

HostCachingOptions

Параметр кэширования для диска данных (т. е. None, ReadOnly, ReadWrite).

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

HourDetails

Свойства почасового расписания.

Имя	Тип	Описание
minute	integer	Минуты часа выполнения расписания.

InboundNatRule

Правило для NAT — предоставление порта виртуальной машины (внутренний порт) на общедоступном IP-адресе с помощью подсистемы балансировки нагрузки.

Имя	Тип	Описание
backendPort	integer	Порт, на который будет перенаправляться внешний трафик.
frontendPort	integer	Порт внешней конечной точки входящего подключения. Возможный диапазон значений — от 1 до 65 535 включительно. Если значение не указано, значение будет выделено автоматически.
transportProtocol	TransportProtocol	Транспортный протокол для конечной точки.

LabVirtualMachine

Виртуальная машина.

Имя	Тип	Значение по умолчанию	Описание
id	string		Идентификатор ресурса.
location	string		Расположение ресурса.
name	string		Имя ресурса.
properties.allowClaim	boolean	False	Указывает, может ли другой пользователь стать владельцем виртуальной машины.
properties.applicableSchedule	ApplicableSchedule		Применимое расписание для виртуальной машины.
properties.artifactDeploymentStatus	ArtifactDeploymentStatusProperties		Состояние развертывания артефакта для виртуальной машины.
properties.artifacts	ArtifactInstallProperties[]		Артефакты, устанавливаемые на виртуальной машине.
properties.computeId	string		Идентификатор ресурса (Microsoft.Compute) виртуальной машины.
properties.computeVm	ComputeVmProperties		Свойства вычислительной виртуальной машины.
properties.createdByUser	string		Адрес электронной почты создателя виртуальной машины.
properties.createdByUserId	string		Идентификатор объекта создателя виртуальной машины.
properties.createdDate	string		Дата создания виртуальной машины.
properties.customImageId	string		Идентификатор пользовательского образа виртуальной машины.
properties.dataDiskParameters	DataDiskProperties[]		Новые или существующие диски данных для подключения к виртуальной машине после создания
properties.disallowPublicIpAddress	boolean	False	Указывает, будет ли виртуальная машина создана без общедоступного IP-адреса.
properties.environmentId	string		Идентификатор ресурса среды, содержащей эту виртуальную машину, если таковой есть.
properties.expirationDate	string		Дата окончания срока действия виртуальной машины.
properties.fqdn	string		Полное доменное имя виртуальной машины.
properties.galleryImageReference	GalleryImageReference		Ссылка на образ Azure Marketplace Microsoft для виртуальной машины.
properties.isAuthenticationWithSshKey	boolean		Указывает, использует ли эта виртуальная машина ключ SSH для проверки подлинности.
properties.labSubnetName	string		Имя подсети лаборатории виртуальной машины.
properties.labVirtualNetworkId	string		Идентификатор виртуальной сети лаборатории виртуальной машины.
properties.lastKnownPowerState	string		Последнее известное состояние вычислительной мощности, записанное в DTL
properties.networkInterface	NetworkInterfaceProperties		Свойства сетевого интерфейса.
properties.notes	string		Заметки о виртуальной машине.
properties.osType	string		Тип ОС виртуальной машины.
properties.ownerObjectId	string	dynamicValue	Идентификатор объекта владельца виртуальной машины.
properties.ownerUserPrincipalName	string		Имя участника-пользователя владельца виртуальной машины.
properties.password	string		Пароль администратора виртуальной машины.
properties.planId	string		Идентификатор плана, связанного с образом виртуальной машины
properties.provisioningState	string		Состояние подготовки ресурса.
properties.scheduleParameters	ScheduleCreationParameter[]		Создаваемые расписания виртуальных машин
properties.size	string		Размер виртуальной машины.
properties.sshKey	string		Ключ SSH администратора виртуальной машины.
properties.storageType	string	labStorageType	Тип хранилища, используемого для виртуальной машины (например, "Стандартный", "Премиум").
properties.uniqueIdentifier	string		Уникальный неизменяемый идентификатор ресурса (Guid).
properties.userName	string		Имя пользователя виртуальной машины.
properties.virtualMachineCreationSource	VirtualMachineCreationSource		Указывает источник создания виртуальной машины лаборатории. Только выходное свойство.
tags	object		Теги ресурса.
type	string		Тип ресурса.

NetworkInterfaceProperties

Свойства сетевого интерфейса.

Имя	Тип	Описание
dnsName	string	DNS-имя.
privateIpAddress	string	Частный IP-адрес.
publicIpAddress	string	Общедоступный IP-адрес.
publicIpAddressId	string	Идентификатор ресурса общедоступного IP-адреса.
rdpAuthority	string	Свойство RdpAuthority — это DNS-имя узла сервера или IP-адрес, за которым следует номер порта службы для протокола удаленного рабочего стола (RDP).
sharedPublicIpAddressConfiguration	SharedPublicIpAddressConfiguration	Конфигурация совместного использования общедоступного IP-адреса на нескольких виртуальных машинах.
sshAuthority	string	Свойство SshAuthority — это dns-имя узла сервера или IP-адрес, за которым следует номер порта службы для SSH.
subnetId	string	Идентификатор ресурса дочерней сети.
virtualNetworkId	string	Идентификатор ресурса виртуальной сети.

NotificationSettings

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

Имя	Тип	Значение по умолчанию	Описание
emailRecipient	string		Получатель электронной почты для отправки уведомлений (может быть списком адресов электронной почты, разделенных точкой с запятой).
notificationLocale	string		Языковой стандарт, используемый при отправке уведомления (резервным вариантом для неподдерживаемых языков является EN).
status	EnableStatus	Disabled	Если для этого расписания включены уведомления (т. е. включено, отключено).
timeInMinutes	integer		Время в минутах до события, когда будет отправлено уведомление.
webhookUrl	string		URL-адрес веб-перехватчика, по которому будет отправлено уведомление.

Schedule

Расписание.

Имя	Тип	Значение по умолчанию	Описание
id	string		Идентификатор ресурса.
location	string		Расположение ресурса.
name	string		Имя ресурса.
properties.createdDate	string		Дата создания расписания.
properties.dailyRecurrence	DayDetails		Если расписание будет выполняться один раз в день недели, укажите ежедневное повторение.
properties.hourlyRecurrence	HourDetails		Если расписание будет выполняться несколько раз в день, укажите ежечасное повторение.
properties.notificationSettings	NotificationSettings		Параметры уведомлений.
properties.provisioningState	string		Состояние подготовки ресурса.
properties.status	EnableStatus	Disabled	Состояние расписания (т. е. "Включено", "Отключено")
properties.targetResourceId	string		Идентификатор ресурса, которому принадлежит расписание
properties.taskType	string		Тип задачи расписания (например, LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId	string		Идентификатор часового пояса (например, стандартное время Китая, стандартное время Гренландии, стандартное тихоокеанское время и т. д.). Возможные значения для этого свойства можно найти в IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
properties.uniqueIdentifier	string		Уникальный неизменяемый идентификатор ресурса (Guid).
properties.weeklyRecurrence	WeekDetails		Если расписание будет выполняться только в некоторые дни недели, укажите еженедельное повторение.
tags	object		Теги ресурса.
type	string		Тип ресурса.

ScheduleCreationParameter

Свойства для создания расписания.

Имя	Тип	Значение по умолчанию	Описание
location	string		Расположение новой виртуальной машины или среды
name	string		Имя виртуальной машины или среды
properties.dailyRecurrence	DayDetails		Если расписание будет выполняться один раз в день недели, укажите ежедневное повторение.
properties.hourlyRecurrence	HourDetails		Если расписание будет выполняться несколько раз в день, укажите ежечасное повторение.
properties.notificationSettings	NotificationSettings		Параметры уведомлений.
properties.status	EnableStatus	Disabled	Состояние расписания (т. е. Включено, Отключено)
properties.targetResourceId	string		Идентификатор ресурса, которому принадлежит расписание
properties.taskType	string		Тип задачи расписания (например, LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId	string		Идентификатор часового пояса (например, стандартное время в Китае, стандартное время в Гренландии, тихоокеанское стандартное время и т. д.). Возможные значения для этого свойства можно найти в IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md).
properties.weeklyRecurrence	WeekDetails		Если расписание будет выполняться только в некоторые дни недели, укажите еженедельное повторение.
tags	object		Теги ресурса.

SharedPublicIpAddressConfiguration

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

Имя	Тип	Описание
inboundNatRules	InboundNatRule[]	Входящие правила NAT

StorageType

Тип хранилища для диска (например, "Стандартный", "Премиум").

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

TransportProtocol

Транспортный протокол для конечной точки.

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

VirtualMachineCreationSource

Сообщает источник создания виртуальной машины лаборатории. Только выходное свойство.

Имя	Тип	Описание
FromCustomImage	string
FromGalleryImage	string
FromSharedGalleryImage	string

WeekDetails

Свойства еженедельного расписания.

Имя	Тип	Описание
time	string	Время суток, когда расписание будет выполняться.
weekdays	string[]	Дни недели, для которых задано расписание (например, воскресенье, понедельник, вторник и т. д.).