Labs - Create Or Update
创建或替换现有实验室。 此作可能需要一段时间才能完成。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}?api-version=2018-09-15
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
name
|
path | True |
string |
实验室的名称。 |
resource
|
path | True |
string |
资源组的名称。 |
subscription
|
path | True |
string |
订阅 ID。 |
api-version
|
query | True |
string |
客户端 API 版本。 |
请求正文
名称 | 类型 | 说明 |
---|---|---|
___location |
string |
资源的位置。 |
properties.announcement |
与此实验室关联的任何实验室公告的属性 |
|
properties.environmentPermission |
预配环境时要向用户授予的访问权限 |
|
properties.extendedProperties |
object |
用于实验功能的实验室的扩展属性 |
properties.labStorageType |
实验室使用的存储类型。 它可以是高级版或标准版。 默认值为 Premium。 |
|
properties.mandatoryArtifactsResourceIdsLinux |
string[] |
在用户指定的项目之前,默认在所有 Linux VM 创建上应用的项目资源 ID 的有序列表。 |
properties.mandatoryArtifactsResourceIdsWindows |
string[] |
默认情况下,应在用户指定的项目之前在所有 Windows VM 创建上应用的项目资源 ID 的有序列表。 |
properties.premiumDataDisks |
启用高级数据磁盘使用情况的设置。 如果其值为“Enabled”,则允许创建标准或高级数据磁盘。 当其值为“Disabled”时,仅允许创建标准数据磁盘。 |
|
properties.support |
与此实验室关联的任何实验室支持消息的属性 |
|
tags |
object |
资源的标记。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
还行 |
|
201 Created |
创建 |
|
Other Status Codes |
错误请求 |
安全性
azure_auth
OAuth2 隐式授权
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 访问 azure Microsoft |
示例
Labs_CreateOrUpdate
示例请求
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"
}
}
示例响应
{
"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"
}
}
{
"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"
}
}
定义
名称 | 说明 |
---|---|
Cloud |
REST 请求中的错误。 |
Cloud |
REST 请求的错误正文。 |
Enable |
计划的状态(即已启用、已禁用) |
Environment |
预配环境时要向用户授予的访问权限 |
Lab |
实验室。 |
Lab |
实验室公告横幅的属性 |
Lab |
实验室支持横幅的属性 |
Premium |
启用高级数据磁盘使用情况的设置。 如果其值为“Enabled”,则允许创建标准或高级数据磁盘。 当其值为“Disabled”时,仅允许创建标准数据磁盘。 |
Storage |
磁盘的存储类型(即标准、高级)。 |
CloudError
REST 请求中的错误。
名称 | 类型 | 说明 |
---|---|---|
error |
发生的云错误 |
CloudErrorBody
REST 请求的错误正文。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误代码。 |
details |
内部错误。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
EnableStatus
计划的状态(即已启用、已禁用)
值 | 说明 |
---|---|
Disabled | |
Enabled |
EnvironmentPermission
预配环境时要向用户授予的访问权限
值 | 说明 |
---|---|
Contributor | |
Reader |
Lab
实验室。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
id |
string |
资源的标识符。 |
|
___location |
string |
资源的位置。 |
|
name |
string |
资源的名称。 |
|
properties.announcement |
与此实验室关联的任何实验室公告的属性 |
||
properties.artifactsStorageAccount |
string |
实验室的项目存储帐户。 |
|
properties.createdDate |
string (date-time) |
实验室的创建日期。 |
|
properties.defaultPremiumStorageAccount |
string |
实验室的默认高级存储帐户。 |
|
properties.defaultStorageAccount |
string |
实验室的默认存储帐户。 |
|
properties.environmentPermission |
预配环境时要向用户授予的访问权限 |
||
properties.extendedProperties |
object |
用于实验功能的实验室的扩展属性 |
|
properties.labStorageType | 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 |
启用高级数据磁盘使用情况的设置。 如果其值为“Enabled”,则允许创建标准或高级数据磁盘。 当其值为“Disabled”时,仅允许创建标准数据磁盘。 |
||
properties.provisioningState |
string |
资源的预配状态。 |
|
properties.publicIpId |
string |
实验室负载均衡器的公共 IP 地址。 |
|
properties.support |
与此实验室关联的任何实验室支持消息的属性 |
||
properties.uniqueIdentifier |
string |
资源的唯一不可变标识符(Guid)。 |
|
properties.vaultName |
string |
实验室的密钥保管库。 |
|
properties.vmCreationResourceGroup |
string |
将在其中创建所有新实验室虚拟机的资源组。 若要让开发测试实验室管理资源组创建,请将此值设置为 null。 |
|
tags |
object |
资源的标记。 |
|
type |
string |
资源的类型。 |
LabAnnouncementProperties
实验室公告横幅的属性
名称 | 类型 | 说明 |
---|---|---|
enabled |
实验室公告目前是否处于活动状态/已启用? |
|
expirationDate |
string (date-time) |
公告到期的时间(永不为 null) |
expired |
boolean |
此公告是否已过期? |
markdown |
string |
此实验室在 UI 中显示的 Markdown 文本(如果有)。 如果留空/null,则不显示任何内容。 |
provisioningState |
string |
资源的预配状态。 |
title |
string |
实验室公告的纯文本标题 |
uniqueIdentifier |
string |
资源的唯一不可变标识符(Guid)。 |
LabSupportProperties
实验室支持横幅的属性
名称 | 类型 | 说明 |
---|---|---|
enabled |
实验室支持横幅目前是否处于活动状态/已启用? |
|
markdown |
string |
此实验室在 UI 中显示的 Markdown 文本(如果有)。 如果留空/null,则不显示任何内容。 |
PremiumDataDisk
启用高级数据磁盘使用情况的设置。 如果其值为“Enabled”,则允许创建标准或高级数据磁盘。 当其值为“Disabled”时,仅允许创建标准数据磁盘。
值 | 说明 |
---|---|
Disabled | |
Enabled |
StorageType
磁盘的存储类型(即标准、高级)。
值 | 说明 |
---|---|
Premium | |
Standard | |
StandardSSD |