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 minLength: 1maxLength: 90 |
资源组的名称。 此名称不区分大小写。 |
subscription
|
path | True |
string minLength: 1 |
目标订阅的 ID。 |
api-version
|
query | True |
string minLength: 1 |
用于此操作的 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
Azure Active Directory OAuth2 流程。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
Labs_CreateOrUpdate
示例请求
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}?api-version=2018-09-15
{
"location": "{location}",
"properties": {
"labStorageType": "{Standard|Premium}"
},
"tags": {
"tagName1": "tagValue1"
}
}
示例响应
{
"name": "{labName}",
"type": "Microsoft.DevTestLab/labs",
"id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}",
"location": "{location}",
"properties": {
"announcement": {
"enabled": "Disabled",
"expired": false,
"markdown": "",
"title": ""
},
"createdDate": "2018-10-01T18:40:48.1739018-07:00",
"environmentPermission": "Reader",
"labStorageType": "Standard",
"mandatoryArtifactsResourceIdsLinux": [],
"mandatoryArtifactsResourceIdsWindows": [],
"premiumDataDisks": "Disabled",
"provisioningState": "Creating",
"support": {
"enabled": "Disabled",
"markdown": ""
},
"uniqueIdentifier": "{uniqueIdentifier}"
},
"tags": {
"tagName1": "tagValue1"
}
}
{
"name": "{labName}",
"type": "Microsoft.DevTestLab/labs",
"id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}",
"location": "{location}",
"properties": {
"announcement": {
"enabled": "Disabled",
"expired": false,
"markdown": "",
"title": ""
},
"createdDate": "2018-10-01T18:40:48.1739018-07:00",
"environmentPermission": "Reader",
"labStorageType": "Standard",
"mandatoryArtifactsResourceIdsLinux": [],
"mandatoryArtifactsResourceIdsWindows": [],
"premiumDataDisks": "Disabled",
"provisioningState": "Creating",
"support": {
"enabled": "Disabled",
"markdown": ""
},
"uniqueIdentifier": "{uniqueIdentifier}"
},
"tags": {
"tagName1": "tagValue1"
}
}
定义
名称 | 说明 |
---|---|
Enable |
指示项目源是否已启用(值:Enabled,Disabled)。 |
Environment |
预配环境时要向用户授予的访问权限 |
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Error |
错误响应 |
Lab |
实验室。 |
Lab |
实验室公告横幅的属性 |
Lab |
实验室支持横幅的属性 |
Premium |
启用高级数据磁盘使用情况的设置。 如果其值为“Enabled”,则允许创建标准或高级数据磁盘。 当其值为“Disabled”时,仅允许创建标准数据磁盘。 |
Storage |
磁盘的存储类型(即标准、高级)。 |
EnableStatus
指示项目源是否已启用(值:Enabled,Disabled)。
值 | 说明 |
---|---|
Enabled | |
Disabled |
EnvironmentPermission
预配环境时要向用户授予的访问权限
值 | 说明 |
---|---|
Reader | |
Contributor |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
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
磁盘的存储类型(即标准、高级)。
值 | 说明 |
---|---|
Standard | |
Premium | |
StandardSSD |