Microsoft.DevTestLab labs/virtualmachines 2018-09-15
Bicep 資源定義
實驗室/virtualmachines 資源類型可以使用目標作業進行部署:
- 資源群組 - 請參閱 資源群組部署命令
如需每個 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 | 資源的位置。 | string |
tags | 資源的標記。 | 標記名稱和值的字典。 請參閱 範本中的標籤 |
父系 (parent) | 在 Bicep 中,您可以指定子資源的父資源。 只有在父資源外部宣告子資源時,才需要新增此屬性。 如需詳細資訊,請參閱 父資源外部的子資源。 |
類型資源的符號名稱: labs |
properties | 資源的屬性。 | LabVirtualMachineProperties (必要) |
LabVirtualMachineProperties
名稱 | 描述 | 值 |
---|---|---|
allowClaim | 指出其他使用者是否可以取得虛擬機器的擁有權 | bool |
artifacts | 要安裝在虛擬機器上的成品。 | ArtifactInstallProperties[] |
createdDate | 虛擬機器的建立日期。 | string |
customImageId | 虛擬機器的自訂映射識別碼。 | string |
dataDiskParameters | 建立之後要連結至虛擬機器的新或現有資料磁片 | DataDiskProperties[] |
disallowPublicIpAddress | 指出是否要在不使用公用 IP 位址的情況下建立虛擬機器。 | bool |
environmentId | 包含此虛擬機器的環境資源識別碼,如果有的話。 | string |
expirationDate | VM 的到期日。 | string |
galleryImageReference | 虛擬機器的 Microsoft Azure Marketplace映射參考。 | GalleryImageReference |
isAuthenticationWithSshKey | 指出此虛擬機器是否使用 SSH 金鑰進行驗證。 | bool |
labSubnetName | 虛擬機器的實驗室子網名稱。 | string |
labVirtualNetworkId | 虛擬機器的實驗室虛擬網路識別碼。 | string |
networkInterface | 網路介面屬性。 | NetworkInterfaceProperties |
附註 | 虛擬機器的附注。 | string |
ownerObjectId | 虛擬機器擁有者的物件識別碼。 | string |
ownerUserPrincipalName | 虛擬機器擁有者的使用者主體名稱。 | string |
密碼 | 虛擬機器系統管理員的密碼。 | string |
planId | 與虛擬機器映射相關聯的計畫識別碼 | string |
scheduleParameters | 要建立的虛擬機器排程 | ScheduleCreationParameter[] |
{1}size{2} | 虛擬機器的大小。 | string |
sshKey | 虛擬機器管理員的 SSH 金鑰。 | string |
storageType | 用於虛擬機器的儲存體類型 (亦即標準、進階) 。 | string |
userName | 虛擬機器的使用者名稱。 | string |
ArtifactInstallProperties
名稱 | 描述 | 值 |
---|---|---|
artifactId | 成品的識別碼。 | string |
artifactTitle | 成品的標題。 | string |
deploymentStatusMessage | 來自部署的狀態訊息。 | string |
installTime | 成品開始安裝在虛擬機器上的時間。 | string |
參數 | 成品的參數。 | ArtifactParameterProperties[] |
status | 成品的狀態。 | string |
vmExtensionStatusMessage | 虛擬機器擴充功能的狀態訊息。 | string |
ArtifactParameterProperties
名稱 | 描述 | 值 |
---|---|---|
NAME | 成品參數的名稱。 | 字串 |
value | 成品參數的值。 | string |
DataDiskProperties
名稱 | 描述 | 值 |
---|---|---|
attachNewDataDiskOptions | 指定將新磁片連結至虛擬機器的選項。 | AttachNewDataDiskOptions |
existingLabDiskId | 指定要連結至虛擬機器的現有實驗室磁片識別碼。 | string |
hostCaching | 資料磁片 (的快取選項,也就是 None、ReadOnly、ReadWrite) 。 | 'None' 'ReadOnly' 'ReadWrite' |
AttachNewDataDiskOptions
名稱 | 描述 | 值 |
---|---|---|
diskName | 要連結的磁片名稱。 | string |
diskSizeGiB | 要以 Gibibytes 連結的磁片大小。 | int |
diskType | 磁片的儲存體類型 (亦即標準、進階) 。 | 'Premium' 'Standard' 'StandardSSD' |
GalleryImageReference
名稱 | 描述 | 值 |
---|---|---|
供應項目 | 資源庫映射的供應專案。 | string |
osType | 資源庫映射的 OS 類型。 | string |
publisher | 資源庫映射的發行者。 | string |
sku | 資源庫映射的 SKU。 | string |
version | 資源庫映射的版本。 | string |
NetworkInterfaceProperties
名稱 | 描述 | 值 |
---|---|---|
dnsName | DNS 名稱。 | string |
privateIpAddress | 私人 IP 位址。 | string |
publicIpAddress | 公用 IP 位址。 | string |
publicIpAddressId | 公用 IP 位址的資源識別碼。 | string |
rdpAuthority | RdpAuthority 屬性是伺服器 DNS 主機名稱或 IP 位址,後面接著 RDP (遠端桌面通訊協定的服務埠號碼) 。 | string |
sharedPublicIpAddressConfiguration | 跨多部虛擬機器共用公用 IP 位址的組態。 | SharedPublicIpAddressConfiguration |
sshAuthority | SshAuthority 屬性是伺服器 DNS 主機名稱或 IP 位址,後面接著 SSH 的服務埠號碼。 | string |
subnetId | 子網路的資源識別碼。 | string |
virtualNetworkId | 虛擬網路的資源識別碼。 | string |
SharedPublicIpAddressConfiguration
名稱 | 描述 | 值 |
---|---|---|
inboundNatRules | 傳入 NAT 規則 | InboundNatRule[] |
InboundNatRule
名稱 | 描述 | 值 |
---|---|---|
backendPort | 將重新導向外部流量的埠。 | int |
frontendPort | 輸入連線的外部端點埠。 可能的值範圍介於 1 到 65535 (含) 之間。 如果未指定,系統會自動設定值。 | int |
transportProtocol | 端點的傳輸通訊協定。 | 'Tcp' 'Udp' |
ScheduleCreationParameter
名稱 | 描述 | 值 |
---|---|---|
NAME | 虛擬機器或環境的名稱 | string |
properties | 排程的屬性。 | ScheduleCreationParameterProperties |
tags | 資源的標記。 | object |
ScheduleCreationParameterProperties
名稱 | 描述 | 值 |
---|---|---|
dailyRecurrence | 如果排程會在每週的每一天發生一次,請指定每日週期。 | DayDetails |
hourlyRecurrence | 如果排程一天多次發生,請指定每小時週期。 | HourDetails |
notificationSettings | 通知設定。 | NotificationSettings |
status | 排程 (的狀態,也就是已啟用、停用) | 'Disabled' 'Enabled' |
targetResourceId | 排程所屬的資源識別碼 | string |
taskType | 排程的工作類型 (例如 LabVmsShutdownTask、LabVmAutoStart) 。 | string |
weeklyRecurrence | 如果排程只會發生一周的某些天數,請指定每週週期。 | WeekDetails |
DayDetails
名稱 | 描述 | 值 |
---|---|---|
time | 排程的當天時間。 | string |
HourDetails
名稱 | 描述 | 值 |
---|---|---|
minute | 排程執行的小時分鐘數。 | int |
NotificationSettings
名稱 | 描述 | 值 |
---|---|---|
emailRecipient | 傳送通知給 (的電子郵件收件者可以是分號分隔的電子郵件地址清單) 。 | string |
notificationLocale | 傳送通知時所要使用的地區設定 (不支援語言的後援為 EN) 。 | string |
status | 如果此排程已啟用通知, (亦即已啟用、停用) 。 | 'Disabled' 'Enabled' |
timeInMinutes | 在事件傳送通知前幾分鐘的時間。 | int |
webhookUrl | 將傳送通知的 Webhook URL。 | string |
WeekDetails
名稱 | 描述 | 值 |
---|---|---|
time | 排程的當天時間。 | string |
平日 | 排程設定的星期幾 (例如星期日、星期一、星期二等 ) 。 | string[] |
快速入門範本
下列快速入門範本會部署此資源類型。
[範本] | 描述 |
---|---|
使用 Windows Server VM 在 Azure DevTest Labs 中建立實驗室 |
此範本會在其中建立具有 Windows Server 2019 Datacenter VM 的新 DevTest Lab / DTL 實例。 如需更多適用于 Azure DevTest Labs 的 Azure Resource Manager快速入門範本,請參閱https://github.com/Azure/azure-devtestlab/tree/master/ARMTemplates |
使用宣告的 VM 在 Azure DevTest Labs 中建立實驗室 |
此範本會在其中建立具有宣告 Windows Server 2019 Datacenter VM 的新 DevTest Lab / DTL 實例。 如需更多適用于 Azure DevTest Labs 的 Azure Resource Manager快速入門範本,請參閱https://github.com/Azure/azure-devtestlab/tree/master/ARMTemplates |
ARM 範本資源定義
實驗室/virtualmachines 資源類型可以使用目標作業來部署:
- 資源群組 - 請參閱 資源群組部署命令
如需每個 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
名稱 | 描述 | 值 |
---|---|---|
類型 | 資源類型 | 'Microsoft.DevTestLab/labs/virtualmachines' |
apiVersion | 資源 API 版本 | '2018-09-15' |
NAME | 資源名稱 請參閱如何在 JSON ARM 範本中設定子資源的名稱和類型。 |
字串 (必要) 字元限制:1-15 (Windows) 1-64 (Linux) 有效字元: 英數字元和連字號。 以英數字元開頭及結尾。 不能全部為數字。 |
location | 資源的位置。 | string |
tags | 資源的標記。 | 標記名稱和值的字典。 請參閱 範本中的標記 |
properties | 資源的屬性。 | LabVirtualMachineProperties (必要) |
LabVirtualMachineProperties
名稱 | 描述 | 值 |
---|---|---|
allowClaim | 指出其他使用者是否可以取得虛擬機器的擁有權 | bool |
artifacts | 要安裝在虛擬機器上的成品。 | ArtifactInstallProperties[] |
createdDate | 虛擬機器的建立日期。 | string |
customImageId | 虛擬機器的自訂映射識別碼。 | string |
dataDiskParameters | 建立之後要連結至虛擬機器的新或現有資料磁片 | DataDiskProperties[] |
disallowPublicIpAddress | 指出是否要在不使用公用 IP 位址的情況下建立虛擬機器。 | bool |
environmentId | 包含此虛擬機器的環境資源識別碼,如果有的話。 | string |
expirationDate | VM 的到期日。 | string |
galleryImageReference | 虛擬機器的 Microsoft Azure Marketplace映射參考。 | GalleryImageReference |
isAuthenticationWithSshKey | 指出此虛擬機器是否使用 SSH 金鑰進行驗證。 | bool |
labSubnetName | 虛擬機器的實驗室子網名稱。 | string |
labVirtualNetworkId | 虛擬機器的實驗室虛擬網路識別碼。 | string |
networkInterface | 網路介面屬性。 | NetworkInterfaceProperties |
附註 | 虛擬機器的附注。 | string |
ownerObjectId | 虛擬機器擁有者的物件識別碼。 | string |
ownerUserPrincipalName | 虛擬機器擁有者的使用者主體名稱。 | string |
密碼 | 虛擬機器系統管理員的密碼。 | string |
planId | 與虛擬機器映射相關聯的計畫識別碼 | string |
scheduleParameters | 要建立的虛擬機器排程 | ScheduleCreationParameter[] |
{1}size{2} | 虛擬機器的大小。 | string |
sshKey | 虛擬機器系統管理員的 SSH 金鑰。 | string |
storageType | 要用於虛擬機器 (的儲存體類型,也就是標準、進階) 。 | string |
userName | 虛擬機器的使用者名稱。 | string |
ArtifactInstallProperties
名稱 | 描述 | 值 |
---|---|---|
artifactId | 成品的識別碼。 | string |
artifactTitle | 成品的標題。 | string |
deploymentStatusMessage | 來自部署的狀態訊息。 | string |
installTime | 成品開始在虛擬機器上安裝的時間。 | string |
參數 | 成品的參數。 | ArtifactParameterProperties[] |
status | 成品的狀態。 | string |
vmExtensionStatusMessage | 虛擬機器擴充功能的狀態訊息。 | string |
ArtifactParameterProperties
名稱 | 描述 | 值 |
---|---|---|
NAME | 成品參數的名稱。 | 字串 |
value | 成品參數的值。 | string |
DataDiskProperties
名稱 | 描述 | 值 |
---|---|---|
attachNewDataDiskOptions | 指定將新磁片連結至虛擬機器的選項。 | AttachNewDataDiskOptions |
existingLabDiskId | 指定要連結至虛擬機器的現有實驗室磁片識別碼。 | string |
hostCaching | 資料磁片 (的快取選項,也就是 None、ReadOnly、ReadWrite) 。 | 'None' 'ReadOnly' 'ReadWrite' |
AttachNewDataDiskOptions
名稱 | 描述 | 值 |
---|---|---|
diskName | 要連結的磁片名稱。 | string |
diskSizeGiB | 要以 Gibibytes 連結的磁片大小。 | int |
diskType | 磁片的儲存體類型 (亦即標準、進階) 。 | 'Premium' 'Standard' 'StandardSSD' |
GalleryImageReference
名稱 | 描述 | 值 |
---|---|---|
供應項目 | 資源庫映射的供應專案。 | string |
osType | 資源庫映射的 OS 類型。 | string |
publisher | 資源庫映射的發行者。 | string |
sku | 資源庫映射的 SKU。 | string |
version | 資源庫映射的版本。 | string |
NetworkInterfaceProperties
名稱 | 描述 | 值 |
---|---|---|
dnsName | DNS 名稱。 | string |
privateIpAddress | 私人 IP 位址。 | string |
publicIpAddress | 公用 IP 位址。 | string |
publicIpAddressId | 公用 IP 位址的資源識別碼。 | string |
rdpAuthority | RdpAuthority 屬性是伺服器 DNS 主機名稱或 IP 位址,後面接著 RDP (遠端桌面通訊協定的服務埠號碼) 。 | string |
sharedPublicIpAddressConfiguration | 跨多部虛擬機器共用公用 IP 位址的組態。 | SharedPublicIpAddressConfiguration |
sshAuthority | SshAuthority 屬性是伺服器 DNS 主機名稱或 IP 位址,後面接著 SSH 的服務埠號碼。 | string |
subnetId | 子網路的資源識別碼。 | string |
virtualNetworkId | 虛擬網路的資源識別碼。 | string |
SharedPublicIpAddressConfiguration
名稱 | 描述 | 值 |
---|---|---|
inboundNatRules | 傳入 NAT 規則 | InboundNatRule[] |
InboundNatRule
名稱 | 描述 | 值 |
---|---|---|
backendPort | 將重新導向外部流量的埠。 | int |
frontendPort | 輸入連線的外部端點埠。 可能的值範圍介於 1 到 65535 (含) 之間。 如果未指定,系統會自動設定值。 | int |
transportProtocol | 端點的傳輸通訊協定。 | 'Tcp' 'Udp' |
ScheduleCreationParameter
名稱 | 描述 | 值 |
---|---|---|
NAME | 虛擬機器或環境的名稱 | string |
properties | 排程的屬性。 | ScheduleCreationParameterProperties |
tags | 資源的標記。 | object |
ScheduleCreationParameterProperties
名稱 | 描述 | 值 |
---|---|---|
dailyRecurrence | 如果排程會在每週的每一天發生一次,請指定每日週期。 | DayDetails |
hourlyRecurrence | 如果排程一天多次發生,請指定每小時週期。 | HourDetails |
notificationSettings | 通知設定。 | NotificationSettings |
status | 排程 (的狀態,也就是已啟用、停用) | 'Disabled' 'Enabled' |
targetResourceId | 排程所屬的資源識別碼 | string |
taskType | 排程的工作類型 (例如 LabVmsShutdownTask、LabVmAutoStart) 。 | string |
weeklyRecurrence | 如果排程只會發生一周的某些天數,請指定每週週期。 | WeekDetails |
DayDetails
名稱 | 描述 | 值 |
---|---|---|
time | 排程的當天時間。 | string |
HourDetails
名稱 | 描述 | 值 |
---|---|---|
minute | 排程執行的小時分鐘數。 | int |
NotificationSettings
名稱 | 描述 | 值 |
---|---|---|
emailRecipient | 傳送通知給 (的電子郵件收件者可以是分號分隔的電子郵件地址清單) 。 | string |
notificationLocale | 傳送通知時所要使用的地區設定 (不支援語言的後援為 EN) 。 | string |
status | 如果此排程已啟用通知, (亦即已啟用、停用) 。 | 'Disabled' 'Enabled' |
timeInMinutes | 在事件傳送通知前幾分鐘的時間。 | int |
webhookUrl | 將傳送通知的 Webhook URL。 | string |
WeekDetails
名稱 | 描述 | 值 |
---|---|---|
time | 排程的當天時間。 | string |
平日 | 排程設定的星期幾 (例如星期日、星期一、星期二等 ) 。 | string[] |
快速入門範本
下列快速入門範本會部署此資源類型。
[範本] | 描述 |
---|---|
使用 Windows Server VM 在 Azure DevTest Labs 中建立實驗室 |
此範本會在其中建立具有 Windows Server 2019 Datacenter VM 的新 DevTest Lab / DTL 實例。 如需更多適用于 Azure DevTest Labs 的 Azure Resource Manager快速入門範本,請參閱https://github.com/Azure/azure-devtestlab/tree/master/ARMTemplates |
使用宣告的 VM 在 Azure DevTest Labs 中建立實驗室 |
此範本會在其中建立具有宣告 Windows Server 2019 Datacenter VM 的新 DevTest Lab / DTL 實例。 如需更多適用于 Azure DevTest Labs 的 Azure Resource Manager快速入門範本,請參閱https://github.com/Azure/azure-devtestlab/tree/master/ARMTemplates |
Terraform (AzAPI 提供者) 資源定義
實驗室/virtualmachines 資源類型可以使用目標作業來部署:
- 資源群組
如需每個 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
名稱 | 描述 | 值 |
---|---|---|
類型 | 資源類型 | 「Microsoft.DevTestLab/labs/virtualmachines@2018-09-15」 |
NAME | 資源名稱 | 需要字串 () 字元限制:1-15 (Windows) 1-64 (Linux) 有效字元: 英數字元和連字號。 以英數字元開頭及結尾。 不能全部為數字。 |
location | 資源的位置。 | string |
parent_id | 此資源父系之資源的識別碼。 | 類型資源的識別碼: labs |
tags | 資源的標記。 | 標記名稱和值的字典。 |
properties | 資源的屬性。 | LabVirtualMachineProperties (必要) |
LabVirtualMachineProperties
名稱 | 描述 | 值 |
---|---|---|
allowClaim | 指出其他使用者是否可以取得虛擬機器的擁有權 | bool |
artifacts | 要安裝在虛擬機器上的成品。 | ArtifactInstallProperties[] |
createdDate | 虛擬機器的建立日期。 | string |
customImageId | 虛擬機器的自訂映射識別碼。 | string |
dataDiskParameters | 建立之後要連結至虛擬機器的新或現有資料磁片 | DataDiskProperties[] |
disallowPublicIpAddress | 指出是否要在不使用公用 IP 位址的情況下建立虛擬機器。 | bool |
environmentId | 包含此虛擬機器的環境資源識別碼,如果有的話。 | string |
expirationDate | VM 的到期日。 | string |
galleryImageReference | 虛擬機器的 Microsoft Azure Marketplace映射參考。 | GalleryImageReference |
isAuthenticationWithSshKey | 指出此虛擬機器是否使用 SSH 金鑰進行驗證。 | bool |
labSubnetName | 虛擬機器的實驗室子網名稱。 | string |
labVirtualNetworkId | 虛擬機器的實驗室虛擬網路識別碼。 | string |
networkInterface | 網路介面屬性。 | NetworkInterfaceProperties |
附註 | 虛擬機器的附注。 | string |
ownerObjectId | 虛擬機器擁有者的物件識別碼。 | string |
ownerUserPrincipalName | 虛擬機器擁有者的使用者主體名稱。 | string |
密碼 | 虛擬機器系統管理員的密碼。 | string |
planId | 與虛擬機器映射相關聯的計畫識別碼 | string |
scheduleParameters | 要建立的虛擬機器排程 | ScheduleCreationParameter[] |
{1}size{2} | 虛擬機器的大小。 | string |
sshKey | 虛擬機器系統管理員的 SSH 金鑰。 | string |
storageType | 要用於虛擬機器 (的儲存體類型,也就是標準、進階) 。 | string |
userName | 虛擬機器的使用者名稱。 | string |
ArtifactInstallProperties
名稱 | 描述 | 值 |
---|---|---|
artifactId | 成品的識別碼。 | string |
artifactTitle | 成品的標題。 | string |
deploymentStatusMessage | 來自部署的狀態訊息。 | string |
installTime | 成品開始在虛擬機器上安裝的時間。 | string |
參數 | 成品的參數。 | ArtifactParameterProperties[] |
status | 成品的狀態。 | string |
vmExtensionStatusMessage | 虛擬機器擴充功能的狀態訊息。 | string |
ArtifactParameterProperties
名稱 | 描述 | 值 |
---|---|---|
NAME | 成品參數的名稱。 | 字串 |
value | 成品參數的值。 | string |
DataDiskProperties
名稱 | 描述 | 值 |
---|---|---|
attachNewDataDiskOptions | 指定將新磁片連結至虛擬機器的選項。 | AttachNewDataDiskOptions |
existingLabDiskId | 指定要連結至虛擬機器的現有實驗室磁片識別碼。 | string |
hostCaching | 資料磁片的快取選項 (例如 None、ReadOnly、ReadWrite) 。 | "None" 「ReadOnly」 「ReadWrite」 |
AttachNewDataDiskOptions
名稱 | 描述 | 值 |
---|---|---|
diskName | 要連接的磁片名稱。 | string |
diskSizeGiB | 要以 Gibibytes 連接之磁片的大小。 | int |
diskType | 磁片 (的儲存體類型,也就是標準、進階) 。 | 「Premium」 「標準」 「StandardSSD」 |
GalleryImageReference
名稱 | 描述 | 值 |
---|---|---|
供應項目 | 資源庫映射的供應專案。 | string |
osType | 資源庫映射的 OS 類型。 | string |
publisher | 資源庫映射的發行者。 | string |
sku | 資源庫映射的 SKU。 | string |
version | 資源庫映射的版本。 | string |
NetworkInterfaceProperties
名稱 | 描述 | 值 |
---|---|---|
dnsName | DNS 名稱。 | string |
privateIpAddress | 私人 IP 位址。 | string |
publicIpAddress | 公用 IP 位址。 | string |
publicIpAddressId | 公用 IP 位址的資源識別碼。 | string |
rdpAuthority | RdpAuthority 屬性是伺服器 DNS 主機名稱或 IP 位址,後面接著 RDP (遠端桌面通訊協定的服務埠號碼) 。 | string |
sharedPublicIpAddressConfiguration | 跨多部虛擬機器共用公用 IP 位址的組態。 | SharedPublicIpAddressConfiguration |
sshAuthority | SshAuthority 屬性是伺服器 DNS 主機名稱或 IP 位址,後面接著 SSH 的服務埠號碼。 | string |
subnetId | 子網路的資源識別碼。 | string |
virtualNetworkId | 虛擬網路的資源識別碼。 | string |
SharedPublicIpAddressConfiguration
名稱 | 描述 | 值 |
---|---|---|
inboundNatRules | 傳入 NAT 規則 | InboundNatRule[] |
InboundNatRule
名稱 | 描述 | 值 |
---|---|---|
backendPort | 將重新導向外部流量的埠。 | int |
frontendPort | 輸入連線的外部端點埠。 可能的值範圍介於 1 到 65535 (含) 之間。 如果未指定,則會自動設定值。 | int |
transportProtocol | 端點的傳輸通訊協定。 | 「Tcp」 「Udp」 |
ScheduleCreationParameter
名稱 | 描述 | 值 |
---|---|---|
NAME | 虛擬機器或環境的名稱 | string |
properties | 排程的屬性。 | ScheduleCreationParameterProperties |
tags | 資源的標記。 | object |
ScheduleCreationParameterProperties
名稱 | 描述 | 值 |
---|---|---|
dailyRecurrence | 如果排程會在一周的每一天發生一次,請指定每日週期。 | DayDetails |
hourlyRecurrence | 如果排程會在一天多次發生,請指定每小時週期。 | HourDetails |
notificationSettings | 通知設定。 | NotificationSettings |
status | 排程 (的狀態,也就是 [已啟用]、[已停用]) | 「Disabled」 「Enabled」 |
targetResourceId | 排程所屬的資源識別碼 | string |
taskType | 排程的工作類型 (例如 LabVmsShutdownTask、LabVmAutoStart) 。 | string |
weeklyRecurrence | 如果排程只會在星期幾發生,請指定每週週期。 | WeekDetails |
DayDetails
名稱 | 描述 | 值 |
---|---|---|
time | 排程將發生的一天時間。 | string |
HourDetails
名稱 | 描述 | 值 |
---|---|---|
minute | 排程將執行的小時分鐘數。 | int |
NotificationSettings
名稱 | 描述 | 值 |
---|---|---|
emailRecipient | 傳送通知給 (的電子郵件收件者可以是分號分隔的電子郵件地址清單,) 。 | string |
notificationLocale | 針對不支援的語言傳送通知 (後援時,要使用的地區設定為 EN) 。 | string |
status | 如果此排程已啟用通知, (即已啟用、已停用) 。 | 「Disabled」 「Enabled」 |
timeInMinutes | 在事件傳送通知之前,以分鐘為單位的時間。 | int |
webhookUrl | 將傳送通知的 Webhook URL。 | string |
WeekDetails
名稱 | 描述 | 值 |
---|---|---|
time | 排程將發生的一天時間。 | string |
平日 | 排程設定的星期幾 (例如星期日、星期一、星期二等 ) 。 | string[] |