你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Labs - Update

Service:

Dev Test Labs

API Version:

2018-09-15

允许修改实验室的标记。 将忽略所有其他属性。

PATCH 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	订阅的 ID。
api-version	query	True	string	客户端 API 版本。

请求正文

名称	类型	说明
tags	object	资源的标记。

响应

名称	类型	说明
200 OK	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_Update

Sample Request

HTTP

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

{}

Java

import com.azure.resourcemanager.devtestlabs.models.Lab;

/** Samples for Labs Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Update.json
     */
    /**
     * Sample code: Labs_Update.
     *
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void labsUpdate(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        Lab resource =
            manager
                .labs()
                .getByResourceGroupWithResponse(
                    "resourceGroupName", "{labName}", null, com.azure.core.util.Context.NONE)
                .getValue();
        resource.update().apply();
    }
}

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_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.update(
        resource_group_name="resourceGroupName",
        name="{labName}",
    )
    print(response)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Update.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/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_Update.json
func ExampleLabsClient_Update() {
	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)
	}
	res, err := clientFactory.NewLabsClient().Update(ctx, "resourceGroupName", "{labName}", armdevtestlabs.LabFragment{}, 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.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}"),
	// 		VaultName: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/{keyVaultName}"),
	// 	},
	// }
}

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 Allows modifying tags of labs. All other properties will be ignored.
 *
 * @summary Allows modifying tags of labs. All other properties will be ignored.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Update.json
 */
async function labsUpdate() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const name = "{labName}";
  const lab = {};
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const result = await client.labs.update(resourceGroupName, name, lab);
  console.log(result);
}

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

// Generated from example definition: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Update.json
// this example is just showing the usage of "Labs_Update" 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 name = "{labName}";
ResourceIdentifier devTestLabResourceId = DevTestLabResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
DevTestLabResource devTestLab = client.GetDevTestLabResource(devTestLabResourceId);

// invoke the operation
DevTestLabPatch patch = new DevTestLabPatch();
DevTestLabResource result = await devTestLab.UpdateAsync(patch);

// 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": {
    "vaultName": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/{keyVaultName}",
    "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": "Succeeded",
    "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	实验室公告横幅的属性
LabFragment	实验室。
LabSupportProperties	实验室支持横幅的属性
PremiumDataDisk	用于启用使用高级数据磁盘的设置。 当其值为“Enabled”时，允许创建标准或高级数据磁盘。 当其值为“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 地址的实验室 VM 的负载均衡器。
properties.mandatoryArtifactsResourceIdsLinux	string[]		在用户指定的项目之前，默认应用于所有 Linux VM 创建的项目资源 ID 的有序列表。
properties.mandatoryArtifactsResourceIdsWindows	string[]		在用户指定的项目之前，默认应用于所有 Windows VM 创建的项目资源 ID 的有序列表。
properties.networkSecurityGroupId	string		附加到实验室 VM 网络接口的网络安全组，以限制开放端口。
properties.premiumDataDiskStorageAccount	string		实验室的高级数据磁盘存储帐户。
properties.premiumDataDisks	PremiumDataDisk		用于启用使用高级数据磁盘的设置。 当其值为“Enabled”时，允许创建标准或高级数据磁盘。 当其值为“Disabled”时，仅允许创建标准数据磁盘。
properties.provisioningState	string		资源的预配状态。
properties.publicIpId	string		实验室负载均衡器的公共 IP 地址。
properties.support	LabSupportProperties		与此实验室关联的任何实验室支持消息的属性
properties.uniqueIdentifier	string		资源的唯一不可变标识符 (Guid) 。
properties.vaultName	string		实验室的密钥保管库。
properties.vmCreationResourceGroup	string		将在其中创建所有新实验室虚拟机的资源组。 若要让开发测试实验室管理资源组创建，请将此值设置为 null。
tags	object		资源的标记。
type	string		资源类型。

LabAnnouncementProperties

实验室公告横幅的属性

名称	类型	说明
enabled	EnableStatus	实验室公告目前是否处于活动状态/已启用？
expirationDate	string	公告过期的时间 (null，永远不会)
expired	boolean	此公告是否已过期？
markdown	string	如果此实验室在 UI 中显示任何) ，则 markdown 文本 (。 如果留空/空，则不显示任何内容。
provisioningState	string	资源的预配状态。
title	string	实验室公告的纯文本标题
uniqueIdentifier	string	资源的唯一不可变标识符 (Guid) 。

LabFragment

实验室。

名称	类型	说明
tags	object	资源的标记。

LabSupportProperties

实验室支持横幅的属性

名称	类型	说明
enabled	EnableStatus	实验室支持横幅目前是否处于活动状态/已启用？
markdown	string	如果此实验室在 UI 中显示任何) ，则 markdown 文本 (。 如果留空/空，则不显示任何内容。

PremiumDataDisk

用于启用使用高级数据磁盘的设置。 当其值为“Enabled”时，允许创建标准或高级数据磁盘。 当其值为“Disabled”时，仅允许创建标准数据磁盘。

名称	类型	说明
Disabled	string
Enabled	string

StorageType

磁盘 (存储类型，即标准、高级) 。

名称	类型	说明
Premium	string
Standard	string
StandardSSD	string