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

Microsoft.DevTestLab labs/virtualmachines 2018-09-15

项目
08/13/2023

Bicep 资源定义

实验室/虚拟机资源类型可以使用以下目标操作进行部署：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.DevTestLab/labs/virtualmachines 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.DevTestLab/labs/virtualmachines@2018-09-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    allowClaim: bool
    artifacts: [
      {
        artifactId: 'string'
        artifactTitle: 'string'
        deploymentStatusMessage: 'string'
        installTime: 'string'
        parameters: [
          {
            name: 'string'
            value: 'string'
          }
        ]
        status: 'string'
        vmExtensionStatusMessage: 'string'
      }
    ]
    createdDate: 'string'
    customImageId: 'string'
    dataDiskParameters: [
      {
        attachNewDataDiskOptions: {
          diskName: 'string'
          diskSizeGiB: int
          diskType: 'string'
        }
        existingLabDiskId: 'string'
        hostCaching: 'string'
      }
    ]
    disallowPublicIpAddress: bool
    environmentId: 'string'
    expirationDate: 'string'
    galleryImageReference: {
      offer: 'string'
      osType: 'string'
      publisher: 'string'
      sku: 'string'
      version: 'string'
    }
    isAuthenticationWithSshKey: bool
    labSubnetName: 'string'
    labVirtualNetworkId: 'string'
    networkInterface: {
      dnsName: 'string'
      privateIpAddress: 'string'
      publicIpAddress: 'string'
      publicIpAddressId: 'string'
      rdpAuthority: 'string'
      sharedPublicIpAddressConfiguration: {
        inboundNatRules: [
          {
            backendPort: int
            frontendPort: int
            transportProtocol: 'string'
          }
        ]
      }
      sshAuthority: 'string'
      subnetId: 'string'
      virtualNetworkId: 'string'
    }
    notes: 'string'
    ownerObjectId: 'string'
    ownerUserPrincipalName: 'string'
    password: 'string'
    planId: 'string'
    scheduleParameters: [
      {
        name: 'string'
        properties: {
          dailyRecurrence: {
            time: 'string'
          }
          hourlyRecurrence: {
            minute: int
          }
          notificationSettings: {
            emailRecipient: 'string'
            notificationLocale: 'string'
            status: 'string'
            timeInMinutes: int
            webhookUrl: 'string'
          }
          status: 'string'
          targetResourceId: 'string'
          taskType: 'string'
          weeklyRecurrence: {
            time: 'string'
            weekdays: [
              'string'
            ]
          }
        }
        tags: {}
      }
    ]
    size: 'string'
    sshKey: 'string'
    storageType: 'string'
    userName: 'string'
  }
}

属性值

labs/virtualmachines

名称	说明	值
name	资源名称了解如何在 Bicep 中设置子资源的名称和类型。	字符串 (必需) 字符限制：1-15 (Windows) 1-64 (Linux) 有效字符：字母数字和连字符。以字母数字开头和结尾。不得全都是数字。
location	资源的位置。	字符串
标记	资源的标记。	标记名称和值的字典。请参阅模板中的标记
父级 (parent)	在 Bicep 中，可以为子资源指定父资源。仅当子资源在父资源外部声明时，才需要添加此属性。有关详细信息，请参阅父资源之外的子资源。	类型为的资源的符号名称： labs
properties	资源的属性。	LabVirtualMachineProperties (必需)

LabVirtualMachineProperties

名称	说明	值
allowClaim	指示其他用户是否可以获取虚拟机的所有权	bool
项目	要安装在虚拟机上的项目。	ArtifactInstallProperties[]
createdDate	虚拟机的创建日期。	string
customImageId	虚拟机的自定义映像标识符。	字符串
dataDiskParameters	创建后要附加到虚拟机的新数据磁盘或现有数据磁盘	DataDiskProperties[]
disallowPublicIpAddress	指示是否在没有公共 IP 地址的情况下创建虚拟机。	bool
environmentId	包含此虚拟机的环境的资源 ID（如果有）。	字符串
expirationDate	VM 的到期日期。	字符串
galleryImageReference	虚拟机的 Microsoft Azure 市场映像引用。	GalleryImageReference
isAuthenticationWithSshKey	指示此虚拟机是否使用 SSH 密钥进行身份验证。	bool
labSubnetName	虚拟机的实验室子网名称。	string
labVirtualNetworkId	虚拟机的实验室虚拟网络标识符。	字符串
networkInterface	网络接口属性。	NetworkInterfaceProperties
说明	虚拟机的说明。	字符串
ownerObjectId	虚拟机所有者的对象标识符。	字符串
ownerUserPrincipalName	虚拟机所有者的用户主体名称。	字符串
password	虚拟机管理员的密码。	字符串
planId	与虚拟机映像关联的计划的 ID	字符串
scheduleParameters	要创建的虚拟机计划	ScheduleCreationParameter[]
大小	虚拟机的大小。	string
sshKey	虚拟机管理员的 SSH 密钥。	字符串
storageType	用于虚拟机 (存储类型，即标准、高级) 。	字符串
userName	虚拟机的用户名。	string

ArtifactInstallProperties

名称	说明	值
artifactId	项目的标识符。	string
artifactTitle	项目的标题。	字符串
deploymentStatusMessage	来自部署的状态消息。	字符串
installTime	项目开始在虚拟机上安装的时间。	字符串
parameters	项目的参数。	ArtifactParameterProperties[]
status	项目的状态。	字符串
vmExtensionStatusMessage	来自虚拟机扩展的状态消息。	字符串

ArtifactParameterProperties

名称	说明	值
name	项目参数的名称。	string
value	项目参数的值。	字符串

DataDiskProperties

名称	说明	值
attachNewDataDiskOptions	指定将新磁盘附加到虚拟机的选项。	AttachNewDataDiskOptions
existingLabDiskId	指定要附加到虚拟机的现有实验室磁盘 ID。	字符串
hostCaching	数据磁盘 (缓存选项，即 None、ReadOnly、ReadWrite) 。	“None” “ReadOnly” “ReadWrite”

AttachNewDataDiskOptions

名称	说明	值
diskName	要附加的磁盘的名称。	字符串
diskSizeGiB	要附加的磁盘的大小（以 Gibibytes 为单位）。	int
diskType	磁盘 (存储类型，即标准、高级) 。	“Premium” 'Standard' 'StandardSSD'

GalleryImageReference

名称	说明	值
offer	库映像的产品/服务。	string
osType	库映像的 OS 类型。	string
publisher	库映像的发布者。	字符串
sku	库映像的 SKU。	string
版本	库映像的版本。	string

NetworkInterfaceProperties

名称	说明	值
dnsName	DNS 名称。	string
privateIpAddress	专用 IP 地址。	string
publicIpAddress	公共 IP 地址。	字符串
publicIpAddressId	公共 IP 地址的资源 ID。	字符串
rdpAuthority	RdpAuthority 属性是服务器 DNS 主机名或 IP 地址，后跟 RDP (远程桌面协议) 的服务端口号。	字符串
sharedPublicIpAddressConfiguration	用于跨多个虚拟机共享公共 IP 地址的配置。	SharedPublicIpAddressConfiguration
sshAuthority	SshAuthority 属性是服务器 DNS 主机名或 IP 地址，后跟 SSH 的服务端口号。	字符串
subnetId	子网络的资源 ID。	字符串
virtualNetworkId	虚拟网络的资源 ID。	字符串

SharedPublicIpAddressConfiguration

名称	说明	值
inboundNatRules	传入 NAT 规则	InboundNatRule[]

InboundNatRule

名称	说明	值
backendPort	外部流量将重定向到的端口。	int
frontendPort	入站连接的外部终结点端口。可能的值介于 1 和 65535（含）之间。如果未指定，则会自动分配值。	int
transportProtocol	终结点的传输协议。	“Tcp” “Udp”

ScheduleCreationParameter

名称	说明	值
name	虚拟机或环境的名称	string
properties	计划的属性。	ScheduleCreationParameterProperties
标记	资源的标记。	object

ScheduleCreationParameterProperties

名称	说明	值
dailyRecurrence	如果计划将在一周中的每一天发生一次，请指定每日重复周期。	DayDetails
hourlyRecurrence	如果计划将一天发生多次，请指定每小时定期。	HourDetails
notificationSettings	通知设置。	NotificationSettings
status	计划的状态 (，即“已启用”、“已禁用”)	“Disabled” “已启用”
targetResourceId	计划所属的资源 ID	string
taskType	计划的任务类型 (例如 LabVmsShutdownTask、LabVmAutoStart) 。	字符串
weeklyRecurrence	如果计划仅在一周中的某几天发生，请指定每周定期。	WeekDetails

DayDetails

名称	说明	值
time	计划将发生一天中的时间。	字符串

HourDetails

名称	说明	值
minute	计划将运行的小时分钟数。	int

NotificationSettings

名称	说明	值
emailRecipient	要向 (发送通知的电子邮件收件人可以是分号分隔的电子邮件地址列表) 。	字符串
notificationLocale	发送不受支持的语言的通知 (回退时要使用的区域设置为 EN) 。	字符串
status	如果为此计划启用了通知， (即启用、禁用) 。	“Disabled” “已启用”
timeInMinutes	发送通知的事件之前的时间（分钟）。	int
webhookUrl	将向其发送通知的 Webhook URL。	string

WeekDetails

名称	说明	值
time	计划发生当天的时间。	字符串
平日	设置计划 (一周中的日期，例如星期日、星期一、星期二等 ) 。	string[]

快速入门模板

以下快速入门模板部署此资源类型。

模板	说明
使用 Windows Server VM 在 Azure 开发测试实验室中创建实验室	此模板创建一个新的开发测试实验室/DTL 实例，其中包含 Windows Server 2019 Datacenter VM。有关Azure 开发测试实验室的更多 Azure 资源管理器快速入门模板，请参阅https://github.com/Azure/azure-devtestlab/tree/master/ARMTemplates
使用声明的 VM 在 Azure 开发测试实验室中创建实验室	此模板创建一个新的开发测试实验室/DTL 实例，其中包含声明的 Windows Server 2019 Datacenter VM。有关Azure 开发测试实验室的更多 Azure 资源管理器快速入门模板，请参阅https://github.com/Azure/azure-devtestlab/tree/master/ARMTemplates

ARM 模板资源定义

实验室/虚拟机资源类型可以使用面向以下操作进行部署：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中更改的属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.DevTestLab/labs/virtualmachines 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.DevTestLab/labs/virtualmachines",
  "apiVersion": "2018-09-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "allowClaim": "bool",
    "artifacts": [
      {
        "artifactId": "string",
        "artifactTitle": "string",
        "deploymentStatusMessage": "string",
        "installTime": "string",
        "parameters": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "status": "string",
        "vmExtensionStatusMessage": "string"
      }
    ],
    "createdDate": "string",
    "customImageId": "string",
    "dataDiskParameters": [
      {
        "attachNewDataDiskOptions": {
          "diskName": "string",
          "diskSizeGiB": "int",
          "diskType": "string"
        },
        "existingLabDiskId": "string",
        "hostCaching": "string"
      }
    ],
    "disallowPublicIpAddress": "bool",
    "environmentId": "string",
    "expirationDate": "string",
    "galleryImageReference": {
      "offer": "string",
      "osType": "string",
      "publisher": "string",
      "sku": "string",
      "version": "string"
    },
    "isAuthenticationWithSshKey": "bool",
    "labSubnetName": "string",
    "labVirtualNetworkId": "string",
    "networkInterface": {
      "dnsName": "string",
      "privateIpAddress": "string",
      "publicIpAddress": "string",
      "publicIpAddressId": "string",
      "rdpAuthority": "string",
      "sharedPublicIpAddressConfiguration": {
        "inboundNatRules": [
          {
            "backendPort": "int",
            "frontendPort": "int",
            "transportProtocol": "string"
          }
        ]
      },
      "sshAuthority": "string",
      "subnetId": "string",
      "virtualNetworkId": "string"
    },
    "notes": "string",
    "ownerObjectId": "string",
    "ownerUserPrincipalName": "string",
    "password": "string",
    "planId": "string",
    "scheduleParameters": [
      {
        "name": "string",
        "properties": {
          "dailyRecurrence": {
            "time": "string"
          },
          "hourlyRecurrence": {
            "minute": "int"
          },
          "notificationSettings": {
            "emailRecipient": "string",
            "notificationLocale": "string",
            "status": "string",
            "timeInMinutes": "int",
            "webhookUrl": "string"
          },
          "status": "string",
          "targetResourceId": "string",
          "taskType": "string",
          "weeklyRecurrence": {
            "time": "string",
            "weekdays": [ "string" ]
          }
        },
        "tags": {}
      }
    ],
    "size": "string",
    "sshKey": "string",
    "storageType": "string",
    "userName": "string"
  }
}

属性值

labs/virtualmachines

名称	说明	Value
type	资源类型	“Microsoft.DevTestLab/labs/virtualmachines”
apiVersion	资源 API 版本	'2018-09-15'
name	资源名称了解如何在 JSON ARM 模板中为子资源设置名称和类型。	字符串 (必需) 字符限制：1-15 (Windows) 1-64 (Linux) 有效字符：字母数字和连字符。以字母数字开头和结尾。不得全都是数字。
location	资源的位置。	string
标记	资源的标记。	标记名称和值的字典。请参阅模板中的标记
properties	资源的属性。	需要 LabVirtualMachineProperties ()

LabVirtualMachineProperties

名称	说明	值
allowClaim	指示其他用户是否可以获取虚拟机的所有权	bool
项目	要安装在虚拟机上的项目。	ArtifactInstallProperties[]
createdDate	虚拟机的创建日期。	string
customImageId	虚拟机的自定义映像标识符。	字符串
dataDiskParameters	创建后要附加到虚拟机的新数据磁盘或现有数据磁盘	DataDiskProperties[]
disallowPublicIpAddress	指示是否在没有公共 IP 地址的情况下创建虚拟机。	bool
environmentId	包含此虚拟机的环境的资源 ID（如果有）。	string
expirationDate	VM 的到期日期。	字符串
galleryImageReference	Microsoft Azure 市场虚拟机的映像参考。	GalleryImageReference
isAuthenticationWithSshKey	指示此虚拟机是否使用 SSH 密钥进行身份验证。	bool
labSubnetName	虚拟机的实验室子网名称。	string
labVirtualNetworkId	虚拟机的实验室虚拟网络标识符。	字符串
networkInterface	网络接口属性。	NetworkInterfaceProperties
说明	虚拟机的说明。	字符串
ownerObjectId	虚拟机所有者的对象标识符。	字符串
ownerUserPrincipalName	虚拟机所有者的用户主体名称。	字符串
password	虚拟机管理员的密码。	字符串
planId	与虚拟机映像关联的计划的 ID	字符串
scheduleParameters	要创建的虚拟机计划	ScheduleCreationParameter[]
大小	虚拟机的大小。	string
sshKey	虚拟机管理员的 SSH 密钥。	string
storageType	用于虚拟机 (的存储类型，即标准、高级) 。	字符串
userName	虚拟机的用户名。	string

ArtifactInstallProperties

名称	说明	值
artifactId	项目的标识符。	字符串
artifactTitle	项目的标题。	字符串
deploymentStatusMessage	部署中的状态消息。	字符串
installTime	项目开始在虚拟机上安装的时间。	字符串
parameters	项目的参数。	ArtifactParameterProperties[]
status	项目的状态。	字符串
vmExtensionStatusMessage	虚拟机扩展中的状态消息。	字符串

ArtifactParameterProperties

名称	说明	值
name	项目参数的名称。	string
value	项目参数的值。	字符串

DataDiskProperties

名称	说明	值
attachNewDataDiskOptions	指定将新磁盘附加到虚拟机的选项。	AttachNewDataDiskOptions
existingLabDiskId	指定要附加到虚拟机的现有实验室磁盘 ID。	字符串
hostCaching	数据磁盘的缓存选项 (即 None、ReadOnly、ReadWrite) 。	“None” “ReadOnly” “ReadWrite”

AttachNewDataDiskOptions

名称	说明	值
diskName	要附加的磁盘的名称。	字符串
diskSizeGiB	要附加的磁盘的大小（以 Gibibytes 为单位）。	int
diskType	磁盘的存储类型 (即标准、高级) 。	“Premium” “Standard” “StandardSSD”

GalleryImageReference

名称	说明	值
offer	库映像的产品/服务。	string
osType	库映像的 OS 类型。	string
publisher	库映像的发布者。	字符串
sku	库映像的 SKU。	string
版本	库映像的版本。	字符串

NetworkInterfaceProperties

名称	说明	值
dnsName	DNS 名称。	string
privateIpAddress	专用 IP 地址。	string
publicIpAddress	公共 IP 地址。	string
publicIpAddressId	公共 IP 地址的资源 ID。	字符串
rdpAuthority	RdpAuthority 属性是服务器 DNS 主机名或 IP 地址，后跟 RDP (远程桌面协议) 的服务端口号。	字符串
sharedPublicIpAddressConfiguration	用于跨多个虚拟机共享公共 IP 地址的配置。	SharedPublicIpAddressConfiguration
sshAuthority	SshAuthority 属性是服务器 DNS 主机名或 IP 地址，后跟 SSH 的服务端口号。	字符串
subnetId	子网络的资源 ID。	string
virtualNetworkId	虚拟网络的资源 ID。	string

SharedPublicIpAddressConfiguration

名称	说明	值
inboundNatRules	传入 NAT 规则	InboundNatRule[]

InboundNatRule

名称	说明	值
backendPort	外部流量将重定向到的端口。	int
frontendPort	入站连接的外部终结点端口。可能的值介于 1 和 65535（含）之间。如果未指定，则会自动分配值。	int
transportProtocol	终结点的传输协议。	“Tcp” “Udp”

ScheduleCreationParameter

名称	说明	值
name	虚拟机或环境的名称	string
properties	计划的属性。	ScheduleCreationParameterProperties
标记	资源的标记。	object

ScheduleCreationParameterProperties

名称	说明	值
dailyRecurrence	如果计划将在一周中的每一天发生一次，请指定每日重复周期。	DayDetails
hourlyRecurrence	如果计划将一天发生多次，请指定每小时定期。	HourDetails
notificationSettings	通知设置。	NotificationSettings
status	计划的状态 (，即“已启用”、“已禁用”)	“Disabled” “已启用”
targetResourceId	计划所属的资源 ID	字符串
taskType	计划的任务类型 (例如 LabVmsShutdownTask、LabVmAutoStart) 。	字符串
weeklyRecurrence	如果计划仅在一周中的某几天发生，请指定每周定期。	WeekDetails

DayDetails

名称	说明	值
time	计划将发生一天中的时间。	字符串

HourDetails

名称	说明	值
minute	计划将运行的小时分钟数。	int

NotificationSettings

名称	说明	值
emailRecipient	要向 (发送通知的电子邮件收件人可以是分号分隔的电子邮件地址列表) 。	字符串
notificationLocale	发送不受支持的语言的通知 (回退时要使用的区域设置为 EN) 。	字符串
status	如果为此计划启用了通知， (即启用、禁用) 。	“Disabled” “已启用”
timeInMinutes	发送通知的事件之前的时间（分钟）。	int
webhookUrl	将向其发送通知的 Webhook URL。	string

WeekDetails

名称	说明	值
time	计划发生当天的时间。	字符串
平日	设置计划 (一周中的日期，例如星期日、星期一、星期二等 ) 。	string[]

快速入门模板

以下快速入门模板部署此资源类型。

模板	说明
使用 Windows Server VM 在 Azure 开发测试实验室中创建实验室	此模板创建一个新的开发测试实验室/DTL 实例，其中包含 Windows Server 2019 Datacenter VM。有关Azure 开发测试实验室的更多 Azure 资源管理器快速入门模板，请参阅https://github.com/Azure/azure-devtestlab/tree/master/ARMTemplates
使用声明的 VM 在 Azure 开发测试实验室中创建实验室	此模板创建一个新的开发测试实验室/DTL 实例，其中包含声明的 Windows Server 2019 Datacenter VM。有关Azure 开发测试实验室的更多 Azure 资源管理器快速入门模板，请参阅https://github.com/Azure/azure-devtestlab/tree/master/ARMTemplates

Terraform (AzAPI 提供程序) 资源定义

实验室/虚拟机资源类型可以使用面向以下操作进行部署：

资源组

有关每个 API 版本中更改的属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.DevTestLab/labs/virtualmachines 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DevTestLab/labs/virtualmachines@2018-09-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      allowClaim = bool
      artifacts = [
        {
          artifactId = "string"
          artifactTitle = "string"
          deploymentStatusMessage = "string"
          installTime = "string"
          parameters = [
            {
              name = "string"
              value = "string"
            }
          ]
          status = "string"
          vmExtensionStatusMessage = "string"
        }
      ]
      createdDate = "string"
      customImageId = "string"
      dataDiskParameters = [
        {
          attachNewDataDiskOptions = {
            diskName = "string"
            diskSizeGiB = int
            diskType = "string"
          }
          existingLabDiskId = "string"
          hostCaching = "string"
        }
      ]
      disallowPublicIpAddress = bool
      environmentId = "string"
      expirationDate = "string"
      galleryImageReference = {
        offer = "string"
        osType = "string"
        publisher = "string"
        sku = "string"
        version = "string"
      }
      isAuthenticationWithSshKey = bool
      labSubnetName = "string"
      labVirtualNetworkId = "string"
      networkInterface = {
        dnsName = "string"
        privateIpAddress = "string"
        publicIpAddress = "string"
        publicIpAddressId = "string"
        rdpAuthority = "string"
        sharedPublicIpAddressConfiguration = {
          inboundNatRules = [
            {
              backendPort = int
              frontendPort = int
              transportProtocol = "string"
            }
          ]
        }
        sshAuthority = "string"
        subnetId = "string"
        virtualNetworkId = "string"
      }
      notes = "string"
      ownerObjectId = "string"
      ownerUserPrincipalName = "string"
      password = "string"
      planId = "string"
      scheduleParameters = [
        {
          name = "string"
          properties = {
            dailyRecurrence = {
              time = "string"
            }
            hourlyRecurrence = {
              minute = int
            }
            notificationSettings = {
              emailRecipient = "string"
              notificationLocale = "string"
              status = "string"
              timeInMinutes = int
              webhookUrl = "string"
            }
            status = "string"
            targetResourceId = "string"
            taskType = "string"
            weeklyRecurrence = {
              time = "string"
              weekdays = [
                "string"
              ]
            }
          }
          tags = {}
        }
      ]
      size = "string"
      sshKey = "string"
      storageType = "string"
      userName = "string"
    }
  })
}

属性值

labs/virtualmachines

名称	说明	Value
type	资源类型	“Microsoft.DevTestLab/labs/virtualmachines@2018-09-15”
name	资源名称	字符串 (必需) 字符限制：1-15 (Windows) 1-64 (Linux) 有效字符：字母数字和连字符。以字母数字开头和结尾。不得全都是数字。
location	资源的位置。	string
parent_id	此资源的父资源 ID。	类型为“实验室”的资源的 ID
标记	资源的标记。	标记名称和值的字典。
properties	资源的属性。	需要 LabVirtualMachineProperties ()

LabVirtualMachineProperties

名称	说明	值
allowClaim	指示其他用户是否可以获取虚拟机的所有权	bool
项目	要安装在虚拟机上的项目。	ArtifactInstallProperties[]
createdDate	虚拟机的创建日期。	string
customImageId	虚拟机的自定义映像标识符。	字符串
dataDiskParameters	创建后要附加到虚拟机的新数据磁盘或现有数据磁盘	DataDiskProperties[]
disallowPublicIpAddress	指示是否在没有公共 IP 地址的情况下创建虚拟机。	bool
environmentId	包含此虚拟机的环境的资源 ID（如果有）。	字符串
expirationDate	VM 的到期日期。	字符串
galleryImageReference	Microsoft Azure 市场虚拟机的映像参考。	GalleryImageReference
isAuthenticationWithSshKey	指示此虚拟机是否使用 SSH 密钥进行身份验证。	bool
labSubnetName	虚拟机的实验室子网名称。	string
labVirtualNetworkId	虚拟机的实验室虚拟网络标识符。	字符串
networkInterface	网络接口属性。	NetworkInterfaceProperties
说明	虚拟机的说明。	字符串
ownerObjectId	虚拟机所有者的对象标识符。	字符串
ownerUserPrincipalName	虚拟机所有者的用户主体名称。	字符串
password	虚拟机管理员的密码。	字符串
planId	与虚拟机映像关联的计划的 ID	字符串
scheduleParameters	要创建的虚拟机计划	ScheduleCreationParameter[]
大小	虚拟机的大小。	字符串
sshKey	虚拟机管理员的 SSH 密钥。	string
storageType	用于虚拟机 (的存储类型，即标准、高级) 。	字符串
userName	虚拟机的用户名。	string

ArtifactInstallProperties

名称	说明	值
artifactId	项目的标识符。	string
artifactTitle	项目的标题。	字符串
deploymentStatusMessage	来自部署的状态消息。	字符串
installTime	项目开始在虚拟机上安装的时间。	字符串
parameters	项目的参数。	ArtifactParameterProperties[]
status	项目的状态。	字符串
vmExtensionStatusMessage	来自虚拟机扩展的状态消息。	字符串

ArtifactParameterProperties

名称	说明	值
name	项目参数的名称。	string
value	项目参数的值。	字符串

DataDiskProperties

名称	说明	值
attachNewDataDiskOptions	指定将新磁盘附加到虚拟机的选项。	AttachNewDataDiskOptions
existingLabDiskId	指定要附加到虚拟机的现有实验室磁盘 ID。	字符串
hostCaching	数据磁盘 (缓存选项，即 None、ReadOnly、ReadWrite) 。	"None" “ReadOnly” “ReadWrite”

AttachNewDataDiskOptions

名称	说明	值
diskName	要附加的磁盘的名称。	字符串
diskSizeGiB	要附加的磁盘的大小（以 Gibibytes 为单位）。	int
diskType	磁盘 (存储类型，即标准、高级) 。	“Premium” “Standard” “StandardSSD”

GalleryImageReference

名称	说明	值
offer	库映像的产品/服务。	字符串
osType	库映像的 OS 类型。	string
publisher	库映像的发布者。	字符串
sku	库映像的 SKU。	字符串
版本	库映像的版本。	字符串

NetworkInterfaceProperties

名称	说明	值
dnsName	DNS 名称。	string
privateIpAddress	专用 IP 地址。	string
publicIpAddress	公共 IP 地址。	string
publicIpAddressId	公共 IP 地址的资源 ID。	string
rdpAuthority	RdpAuthority 属性是服务器 DNS 主机名或 IP 地址，后跟 RDP (远程桌面协议) 的服务端口号。	字符串
sharedPublicIpAddressConfiguration	用于跨多个虚拟机共享公共 IP 地址的配置。	SharedPublicIpAddressConfiguration
sshAuthority	SshAuthority 属性是服务器 DNS 主机名或 IP 地址，后跟 SSH 的服务端口号。	字符串
subnetId	子网络的资源 ID。	string
virtualNetworkId	虚拟网络的资源 ID。	string

SharedPublicIpAddressConfiguration

名称	说明	值
inboundNatRules	传入 NAT 规则	InboundNatRule[]

InboundNatRule

名称	说明	值
backendPort	外部流量将重定向到的端口。	int
frontendPort	入站连接的外部终结点端口。可能的值介于 1 和 65535（含）之间。如果未指定，将自动分配值。	int
transportProtocol	终结点的传输协议。	“Tcp” “Udp”

ScheduleCreationParameter

名称	说明	值
name	虚拟机或环境的名称	string
properties	计划的属性。	ScheduleCreationParameterProperties
标记	资源的标记。	object

ScheduleCreationParameterProperties

名称	说明	值
dailyRecurrence	如果计划将在一周中的每一天发生一次，请指定每日重复周期。	DayDetails
hourlyRecurrence	如果计划一天发生多次，请指定每小时重复周期。	HourDetails
notificationSettings	通知设置。	NotificationSettings
status	计划的状态 (，即“已启用”、“已禁用”)	“Disabled” “Enabled”
targetResourceId	计划所属的资源 ID	字符串
taskType	计划的任务类型 (例如 LabVmsShutdownTask、LabVmAutoStart) 。	字符串
weeklyRecurrence	如果计划仅在一周中的某几天发生，请指定每周重复周期。	WeekDetails

DayDetails

名称	说明	值
time	计划的发生时间。	字符串

HourDetails

名称	说明	值
minute	计划将运行的小时分钟数。	int

NotificationSettings

名称	说明	值
emailRecipient	向 (发送通知的电子邮件收件人可以是分号分隔的电子邮件地址列表) 。	字符串
notificationLocale	发送不受支持的语言的通知 (回退时要使用的区域设置为 EN) 。	字符串
status	如果为此计划启用了通知 (即“已启用”、“禁用”) 。	“Disabled” “Enabled”
timeInMinutes	发送通知的事件之前的时间（以分钟为单位）。	int
webhookUrl	通知将发送到的 Webhook URL。	string

WeekDetails

名称	说明	值
time	计划发生日期的时间。	字符串
平日	将计划设置为 (星期几天，例如星期日、星期一、星期二等 ) 。	string[]

Microsoft.DevTestLab labs/virtualmachines 2018-09-15

Bicep 资源定义

资源格式

属性值

labs/virtualmachines

LabVirtualMachineProperties

ArtifactInstallProperties

ArtifactParameterProperties

DataDiskProperties

AttachNewDataDiskOptions

GalleryImageReference

NetworkInterfaceProperties

SharedPublicIpAddressConfiguration

InboundNatRule

ScheduleCreationParameter

ScheduleCreationParameterProperties

DayDetails

HourDetails

NotificationSettings

WeekDetails

快速入门模板

ARM 模板资源定义

资源格式

属性值

labs/virtualmachines

LabVirtualMachineProperties

ArtifactInstallProperties

ArtifactParameterProperties

DataDiskProperties

AttachNewDataDiskOptions

GalleryImageReference

NetworkInterfaceProperties

SharedPublicIpAddressConfiguration

InboundNatRule

ScheduleCreationParameter

ScheduleCreationParameterProperties

DayDetails

HourDetails

NotificationSettings

WeekDetails

快速入门模板

Terraform (AzAPI 提供程序) 资源定义

资源格式

属性值

labs/virtualmachines

LabVirtualMachineProperties

ArtifactInstallProperties

ArtifactParameterProperties

DataDiskProperties

AttachNewDataDiskOptions

GalleryImageReference

NetworkInterfaceProperties

SharedPublicIpAddressConfiguration

InboundNatRule

ScheduleCreationParameter

ScheduleCreationParameterProperties

DayDetails

HourDetails

NotificationSettings

WeekDetails

反馈

反馈

其他资源