Labs - 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/{name}?api-version=2018-09-15

Параметры URI

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

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

Имя	Тип	Описание
location	string	Расположение ресурса.
properties.announcement	LabAnnouncementProperties	Свойства любого объявления лаборатории, связанного с этой лабораторией
properties.environmentPermission	EnvironmentPermission	Права доступа, предоставляемые пользователю при подготовке среды
properties.extendedProperties	object	Расширенные свойства лаборатории, используемые для экспериментальных функций
properties.labStorageType	StorageType	Тип хранилища, используемого лабораторией. Это может быть категория "Премиум" или "Стандартный". Значение по умолчанию — Premium.
properties.mandatoryArtifactsResourceIdsLinux	string[]	Упорядоченный список идентификаторов ресурсов артефактов, которые должны быть применены ко всем созданным виртуальным машинам Linux по умолчанию перед артефактами, указанными пользователем.
properties.mandatoryArtifactsResourceIdsWindows	string[]	Упорядоченный список идентификаторов ресурсов артефактов, которые должны применяться ко всем созданным виртуальным машинам Windows по умолчанию до артефактов, указанных пользователем.
properties.premiumDataDisks	PremiumDataDisk	Параметр для включения использования дисков данных уровня "Премиум". Если его значение равно "Включено", создание дисков данных уровня "Стандартный" или "Премиум" разрешено. Если для нее задано значение Disabled, допускается только создание стандартных дисков данных.
properties.support	LabSupportProperties	Свойства любого сообщения о поддержке лаборатории, связанного с этой лабораторией
tags	object	Теги ресурса.

Ответы

Имя	Тип	Описание
200 OK	Lab	ОК
201 Created	Lab	Создание
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

Примеры

Labs_CreateOrUpdate

Sample Request

HTTP

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

{
  "properties": {
    "labStorageType": "{Standard|Premium}"
  },
  "location": "{location}",
  "tags": {
    "tagName1": "tagValue1"
  }
}

Java

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

/** Samples for Labs CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_CreateOrUpdate.json
     */
    /**
     * Sample code: Labs_CreateOrUpdate.
     *
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void labsCreateOrUpdate(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager
            .labs()
            .define("{labName}")
            .withRegion("{location}")
            .withExistingResourceGroup("resourceGroupName")
            .withTags(mapOf("tagName1", "tagValue1"))
            .withLabStorageType(StorageType.fromString("{Standard|Premium}"))
            .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 labs_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.labs.begin_create_or_update(
        resource_group_name="resourceGroupName",
        name="{labName}",
        lab={
            "location": "{location}",
            "properties": {"labStorageType": "{Standard|Premium}"},
            "tags": {"tagName1": "tagValue1"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_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/Labs_CreateOrUpdate.json
func ExampleLabsClient_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.NewLabsClient().BeginCreateOrUpdate(ctx, "resourceGroupName", "{labName}", armdevtestlabs.Lab{
		Location: to.Ptr("{location}"),
		Tags: map[string]*string{
			"tagName1": to.Ptr("tagValue1"),
		},
		Properties: &armdevtestlabs.LabProperties{
			LabStorageType: to.Ptr(armdevtestlabs.StorageType("{Standard|Premium}")),
		},
	}, 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.Lab = armdevtestlabs.Lab{
	// 	Name: to.Ptr("{labName}"),
	// 	Type: to.Ptr("Microsoft.DevTestLab/labs"),
	// 	ID: to.Ptr("/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}"),
	// 	Location: to.Ptr("{location}"),
	// 	Tags: map[string]*string{
	// 		"tagName1": to.Ptr("tagValue1"),
	// 	},
	// 	Properties: &armdevtestlabs.LabProperties{
	// 		Announcement: &armdevtestlabs.LabAnnouncementProperties{
	// 			Enabled: to.Ptr(armdevtestlabs.EnableStatusDisabled),
	// 			Expired: to.Ptr(false),
	// 			Markdown: to.Ptr(""),
	// 			Title: to.Ptr(""),
	// 		},
	// 		CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-10-02T01:40:48.173Z"); return t}()),
	// 		EnvironmentPermission: to.Ptr(armdevtestlabs.EnvironmentPermissionReader),
	// 		LabStorageType: to.Ptr(armdevtestlabs.StorageTypeStandard),
	// 		MandatoryArtifactsResourceIDsLinux: []*string{
	// 		},
	// 		MandatoryArtifactsResourceIDsWindows: []*string{
	// 		},
	// 		PremiumDataDisks: to.Ptr(armdevtestlabs.PremiumDataDiskDisabled),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		Support: &armdevtestlabs.LabSupportProperties{
	// 			Enabled: to.Ptr(armdevtestlabs.EnableStatusDisabled),
	// 			Markdown: to.Ptr(""),
	// 		},
	// 		UniqueIdentifier: to.Ptr("{uniqueIdentifier}"),
	// 	},
	// }
}

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 lab. This operation can take a while to complete.
 *
 * @summary Create or replace an existing lab. This operation can take a while to complete.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_CreateOrUpdate.json
 */
async function labsCreateOrUpdate() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const name = "{labName}";
  const lab = {
    labStorageType: "{Standard|Premium}",
    location: "{location}",
    tags: { tagName1: "tagValue1" },
  };
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const result = await client.labs.beginCreateOrUpdateAndWait(resourceGroupName, name, lab);
  console.log(result);
}

labsCreateOrUpdate().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;
using Azure.ResourceManager.Resources;

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

// get the collection of this DevTestLabResource
DevTestLabCollection collection = resourceGroupResource.GetDevTestLabs();

// invoke the operation
string name = "{labName}";
DevTestLabData data = new DevTestLabData(new AzureLocation("{location}"))
{
    LabStorageType = new DevTestLabStorageType("{Standard|Premium}"),
    Tags =
    {
    ["tagName1"] = "tagValue1",
    },
};
ArmOperation<DevTestLabResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, name, data);
DevTestLabResource 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
DevTestLabData 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": {
    "labStorageType": "Standard",
    "mandatoryArtifactsResourceIdsLinux": [],
    "mandatoryArtifactsResourceIdsWindows": [],
    "createdDate": "2018-10-01T18:40:48.1739018-07:00",
    "premiumDataDisks": "Disabled",
    "environmentPermission": "Reader",
    "announcement": {
      "title": "",
      "markdown": "",
      "enabled": "Disabled",
      "expired": false
    },
    "support": {
      "enabled": "Disabled",
      "markdown": ""
    },
    "provisioningState": "Creating",
    "uniqueIdentifier": "{uniqueIdentifier}"
  },
  "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}",
  "name": "{labName}",
  "type": "Microsoft.DevTestLab/labs",
  "location": "{location}",
  "tags": {
    "tagName1": "tagValue1"
  }
}

Status code:

201

{
  "properties": {
    "labStorageType": "Standard",
    "mandatoryArtifactsResourceIdsLinux": [],
    "mandatoryArtifactsResourceIdsWindows": [],
    "createdDate": "2018-10-01T18:40:48.1739018-07:00",
    "premiumDataDisks": "Disabled",
    "environmentPermission": "Reader",
    "announcement": {
      "title": "",
      "markdown": "",
      "enabled": "Disabled",
      "expired": false
    },
    "support": {
      "enabled": "Disabled",
      "markdown": ""
    },
    "provisioningState": "Creating",
    "uniqueIdentifier": "{uniqueIdentifier}"
  },
  "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}",
  "name": "{labName}",
  "type": "Microsoft.DevTestLab/labs",
  "location": "{location}",
  "tags": {
    "tagName1": "tagValue1"
  }
}

Определения

Имя	Описание
CloudError	Ошибка из запроса REST.
CloudErrorBody	Текст ошибки из запроса REST.
EnableStatus	Состояние расписания (т. е. Включено, Отключено)
EnvironmentPermission	Права доступа, предоставляемые пользователю при подготовке среды
Lab	Лаборатория.
LabAnnouncementProperties	Свойства баннера объявления лаборатории
LabSupportProperties	Свойства баннера поддержки лаборатории
PremiumDataDisk	Параметр для включения использования дисков данных уровня "Премиум". Если его значение равно "Включено", создание дисков данных уровня "Стандартный" или "Премиум" разрешено. Если для нее задано значение Disabled, допускается только создание стандартных дисков данных.
StorageType	Тип хранилища для диска (например, "Стандартный", "Премиум").

CloudError

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

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

CloudErrorBody

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

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

EnableStatus

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

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

EnvironmentPermission

Права доступа, предоставляемые пользователю при подготовке среды

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

Lab

Лаборатория.

Имя	Тип	Значение по умолчанию	Описание
id	string		Идентификатор ресурса.
location	string		Расположение ресурса.
name	string		Имя ресурса.
properties.announcement	LabAnnouncementProperties		Свойства любого объявления лаборатории, связанного с этой лабораторией
properties.artifactsStorageAccount	string		Учетная запись хранения артефактов лаборатории.
properties.createdDate	string		Дата создания лаборатории.
properties.defaultPremiumStorageAccount	string		Учетная запись хранения класса "Премиум" по умолчанию.
properties.defaultStorageAccount	string		Учетная запись хранения лаборатории по умолчанию.
properties.environmentPermission	EnvironmentPermission		Права доступа, предоставляемые пользователю при подготовке среды
properties.extendedProperties	object		Расширенные свойства лаборатории, используемые для экспериментальных функций
properties.labStorageType	StorageType	Premium	Тип хранилища, используемого лабораторией. Это может быть категория "Премиум" или "Стандартный". Значение по умолчанию — Premium.
properties.loadBalancerId	string		Подсистема балансировки нагрузки, используемая для виртуальных машин лаборатории, использующих общий IP-адрес.
properties.mandatoryArtifactsResourceIdsLinux	string[]		Упорядоченный список идентификаторов ресурсов артефактов, которые должны быть применены ко всем созданным виртуальным машинам Linux по умолчанию перед артефактами, указанными пользователем.
properties.mandatoryArtifactsResourceIdsWindows	string[]		Упорядоченный список идентификаторов ресурсов артефактов, которые должны применяться ко всем созданным виртуальным машинам Windows по умолчанию до артефактов, указанных пользователем.
properties.networkSecurityGroupId	string		Группа безопасности сети, подключенная к виртуальным машинам лаборатории, сетевые интерфейсы для ограничения открытых портов.
properties.premiumDataDiskStorageAccount	string		Учетная запись хранения диска данных лаборатории уровня "Премиум".
properties.premiumDataDisks	PremiumDataDisk		Параметр для включения использования дисков данных уровня "Премиум". Если его значение равно "Включено", создание дисков данных уровня "Стандартный" или "Премиум" разрешено. Если для нее задано значение Disabled, допускается только создание стандартных дисков данных.
properties.provisioningState	string		Состояние подготовки ресурса.
properties.publicIpId	string		Общедоступный IP-адрес подсистемы балансировки нагрузки лаборатории.
properties.support	LabSupportProperties		Свойства любого сообщения о поддержке лаборатории, связанного с этой лабораторией
properties.uniqueIdentifier	string		Уникальный неизменяемый идентификатор ресурса (GUID).
properties.vaultName	string		Хранилище ключей лаборатории.
properties.vmCreationResourceGroup	string		Группа ресурсов, в которой будут созданы все новые виртуальные машины лаборатории. Чтобы позволить DevTest Labs управлять созданием группы ресурсов, присвойте этому значению значение null.
tags	object		Теги ресурса.
type	string		Тип ресурса.

LabAnnouncementProperties

Свойства баннера объявления лаборатории

Имя	Тип	Описание
enabled	EnableStatus	Является ли объявление лаборатории активным или включенным в настоящее время?
expirationDate	string	Время истечения срока действия объявления (null для никогда)
expired	boolean	Истек ли срок действия этого объявления?
markdown	string	Текст Markdown (при наличии), отображаемый в этом задании в пользовательском интерфейсе. Если оставить значение пустым или пустым, ничего не будет отображаться.
provisioningState	string	Состояние подготовки ресурса.
title	string	Заголовок в виде обычного текста для объявления лаборатории
uniqueIdentifier	string	Уникальный неизменяемый идентификатор ресурса (GUID).

LabSupportProperties

Свойства баннера поддержки лаборатории

Имя	Тип	Описание
enabled	EnableStatus	Активен или включен ли баннер поддержки лаборатории в настоящее время?
markdown	string	Текст Markdown (при наличии), отображаемый в этом задании в пользовательском интерфейсе. Если оставить значение пустым или пустым, ничего не будет отображаться.

PremiumDataDisk

Параметр для включения использования дисков данных уровня "Премиум". Если его значение равно "Включено", создание дисков данных уровня "Стандартный" или "Премиум" разрешено. Если для нее задано значение Disabled, допускается только создание стандартных дисков данных.

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

StorageType

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

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