Поделиться через


Microsoft.DevTestLab labs/virtualmachines 2016-05-15

Определение ресурсов Bicep

Тип ресурсов labs/virtualmachines можно развернуть с помощью операций, предназначенных для следующих целей:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.DevTestLab/labs/virtualmachines, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.DevTestLab/labs/virtualmachines@2016-05-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    allowClaim: bool
    applicableSchedule: {
      location: 'string'
      properties: {
        labVmsShutdown: {
          location: 'string'
          properties: {
            dailyRecurrence: {
              time: 'string'
            }
            hourlyRecurrence: {
              minute: int
            }
            notificationSettings: {
              status: 'string'
              timeInMinutes: int
              webhookUrl: 'string'
            }
            provisioningState: 'string'
            status: 'string'
            targetResourceId: 'string'
            taskType: 'string'
            timeZoneId: 'string'
            uniqueIdentifier: 'string'
            weeklyRecurrence: {
              time: 'string'
              weekdays: [
                'string'
              ]
            }
          }
          tags: {
            {customized property}: 'string'
          }
        }
        labVmsStartup: {
          location: 'string'
          properties: {
            dailyRecurrence: {
              time: 'string'
            }
            hourlyRecurrence: {
              minute: int
            }
            notificationSettings: {
              status: 'string'
              timeInMinutes: int
              webhookUrl: 'string'
            }
            provisioningState: 'string'
            status: 'string'
            targetResourceId: 'string'
            taskType: 'string'
            timeZoneId: 'string'
            uniqueIdentifier: 'string'
            weeklyRecurrence: {
              time: 'string'
              weekdays: [
                'string'
              ]
            }
          }
          tags: {
            {customized property}: 'string'
          }
        }
      }
      tags: {
        {customized property}: 'string'
      }
    }
    artifactDeploymentStatus: {
      artifactsApplied: int
      deploymentStatus: 'string'
      totalArtifacts: int
    }
    artifacts: [
      {
        artifactId: 'string'
        deploymentStatusMessage: 'string'
        installTime: 'string'
        parameters: [
          {
            name: 'string'
            value: 'string'
          }
        ]
        status: 'string'
        vmExtensionStatusMessage: 'string'
      }
    ]
    computeVm: {
      dataDiskIds: [
        'string'
      ]
      dataDisks: [
        {
          diskSizeGiB: int
          diskUri: 'string'
          managedDiskId: 'string'
          name: 'string'
        }
      ]
      networkInterfaceId: 'string'
      osDiskId: 'string'
      osType: 'string'
      statuses: [
        {
          code: 'string'
          displayStatus: 'string'
          message: 'string'
        }
      ]
      vmSize: 'string'
    }
    createdByUser: 'string'
    createdByUserId: 'string'
    createdDate: 'string'
    customImageId: 'string'
    disallowPublicIpAddress: bool
    environmentId: 'string'
    expirationDate: 'string'
    fqdn: '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'
    osType: 'string'
    ownerObjectId: 'string'
    ownerUserPrincipalName: 'string'
    password: 'string'
    provisioningState: 'string'
    size: 'string'
    sshKey: 'string'
    storageType: 'string'
    uniqueIdentifier: 'string'
    userName: 'string'
    virtualMachineCreationSource: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Значения свойств

ПрименимоеSchedule

Имя Описание Ценность
местоположение Расположение ресурса. струна
свойства Свойства ресурса. ApplicableScheduleProperties (обязательно)
Теги Теги ресурса. ResourceTags

ApplicableScheduleProperties

Имя Описание Ценность
labVmsShutdown Расписание автоматического завершения работы, если оно установлено на уровне лаборатории или лаборатории. расписания
labVmsStartup Расписание автоматического запуска, если оно установлено на уровне лаборатории или лаборатории. расписания

ArtifactDeploymentStatusProperties

Имя Описание Ценность
артефактыApplied Общее количество артефактов, которые были успешно применены. int
deploymentStatus Состояние развертывания артефакта. струна
totalArtifacts Общее количество артефактов, которые были предварительно применены. int

ArtifactInstallProperties

Имя Описание Ценность
artifactId Идентификатор артефакта. струна
deploymentStatusMessage Сообщение о состоянии из развертывания. струна
installTime Время установки артефакта на виртуальной машине. струна
Параметры Параметры артефакта. ArtifactParameterProperties[]
статус Состояние артефакта. струна
vmExtensionStatusMessage Сообщение о состоянии из расширения виртуальной машины. струна

ArtifactParameterProperties

Имя Описание Ценность
имя Имя параметра артефакта. струна
ценность Значение параметра артефакта. струна

ComputeDataDisk

Имя Описание Ценность
diskSizeGiB Возвращает размер диска данных в ГиБ. int
diskUri При поддержке большого двоичного объекта универсальный код ресурса (URI) базового большого двоичного объекта. струна
managedDiskId При поддержке управляемого диска это идентификатор ресурса вычислительного диска. струна
имя Возвращает имя диска данных. струна

ComputeVmInstanceViewStatus

Имя Описание Ценность
код Возвращает код состояния. струна
displayStatus Возвращает короткую локализуемую метку для состояния. струна
Сообщение Возвращает сообщение, связанное с состоянием. струна

ComputeVmProperties

Имя Описание Ценность
dataDiskIds Возвращает URI больших двоичных объектов дисков данных для виртуальной машины. string[]
dataDisks Возвращает все диски данных, подключенные к виртуальной машине. ComputeDataDisk[]
networkInterfaceId Возвращает идентификатор сетевого интерфейса виртуальной машины. струна
osDiskId Возвращает универсальный код ресурса (URI) диска ОПЕРАЦИОННОй системы для виртуальной машины. струна
osType Возвращает тип ОС виртуальной машины. струна
Статусы Возвращает состояния виртуальной машины. ComputeVmInstanceViewStatus[]
vmSize Возвращает размер виртуальной машины. струна

DayDetails

Имя Описание Ценность
Время Время суток будет выполняться. струна

GalleryImageReference

Имя Описание Ценность
предлагать Предложение изображения коллекции. струна
osType Тип ОС образа коллекции. струна
издатель Издатель образа коллекции. струна
SKU Номер SKU образа коллекции. струна
Версия Версия образа коллекции. струна

HourDetails

Имя Описание Ценность
минута В минутах часа будет выполняться расписание. int

InboundNatRule

Имя Описание Ценность
серверный порт Порт, на который будет перенаправлен внешний трафик. int
frontendPort Порт внешней конечной точки входящего подключения. Возможные значения в диапазоне от 1 до 65535 включительно. Если не указано, значение будет выделено автоматически. int
transportProtocol Транспортный протокол для конечной точки. Tcp
'Udp'

LabVirtualMachineProperties

Имя Описание Ценность
allowClaim Указывает, может ли другой пользователь взять на себя ответственность за виртуальную машину. bool
применимоеSchedule Применимое расписание для виртуальной машины. ApplicableSchedule
artifactDeploymentStatus Состояние развертывания артефакта для виртуальной машины. ArtifactDeploymentStatusProperties
Артефакты Артефакты, которые необходимо установить на виртуальной машине. ArtifactInstallProperties[]
computeVm Свойства вычислительной виртуальной машины. ComputeVmProperties
createdByUser Адрес электронной почты создателя виртуальной машины. струна
createdByUserId Идентификатор объекта создателя виртуальной машины. струна
createdDate Дата создания виртуальной машины. струна
customImageId Пользовательский идентификатор образа виртуальной машины. струна
disallowPublicIpAddress Указывает, должна ли виртуальная машина создаваться без общедоступного IP-адреса. bool
environmentId Идентификатор ресурса среды, содержащей эту виртуальную машину, при наличии. струна
дата окончания срока действия Дата окончания срока действия виртуальной машины. струна
Полное доменное имя Полное доменное имя виртуальной машины. струна
galleryImageReference Справочник по образу Microsoft Azure Marketplace виртуальной машины. GalleryImageReference
isAuthenticationWithSshKey Указывает, использует ли эта виртуальная машина ключ SSH для проверки подлинности. bool
labSubnetName Имя подсети лаборатории виртуальной машины. струна
labVirtualNetworkId Идентификатор виртуальной сети лаборатории виртуальной машины. струна
networkInterface Свойства сетевого интерфейса. NetworkInterfaceProperties
примечания Заметки о виртуальной машине. струна
osType Тип ОС виртуальной машины. струна
ownerObjectId Идентификатор объекта владельца виртуальной машины. струна
ownerUserPrincipalName Имя субъекта-пользователя владельца виртуальной машины. струна
пароль Пароль администратора виртуальной машины. струна
provisioningState Состояние подготовки ресурса. струна
размер Размер виртуальной машины. струна
sshKey Ключ SSH администратора виртуальной машины. струна
storageType Тип хранилища, используемый для виртуальной машины (например, "Стандартный", "Премиум"). струна
uniqueIdentifier Уникальный неизменяемый идентификатор ресурса (GUID). струна
userName Имя пользователя виртуальной машины. струна
virtualMachineCreationSource Указывает источник создания виртуальной машины лаборатории. Только выходное свойство. FromCustomImage
'FromGalleryImage'

Microsoft.DevTestLab/labs/virtualmachines

Имя Описание Ценность
местоположение Расположение ресурса. струна
имя Имя ресурса строка (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.
Символьное имя ресурса типа: лабораторий
свойства Свойства ресурса. LabVirtualMachineProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

NetworkInterfaceProperties

Имя Описание Ценность
dnsName DNS-имя. струна
privateIpAddress Частный IP-адрес. струна
publicIpAddress Общедоступный IP-адрес. струна
publicIpAddressId Идентификатор ресурса общедоступного IP-адреса. струна
rdpAuthority Свойство RdpAuthority — это имя узла DNS сервера или IP-адрес, за которым следует номер порта службы для RDP (протокол удаленного рабочего стола). струна
sharedPublicIpAddressConfiguration Конфигурация общего доступа к общедоступному IP-адресу на нескольких виртуальных машинах. SharedPublicIpAddressConfiguration
sshAuthority Свойство SshAuthority — это имя узла DNS сервера или IP-адрес, за которым следует номер порта службы для SSH. струна
SubnetId Идентификатор ресурса подсети. струна
virtualNetworkId Идентификатор ресурса виртуальной сети. струна

NotificationSettings

Имя Описание Ценность
статус Если уведомления включены для этого расписания (т. е. включено, отключено). "Отключено"
"Включено"
timeInMinutes Время в минутах до события, по которому будет отправлено уведомление. int
webhookUrl URL-адрес веб-перехватчика, на который будет отправлено уведомление. струна

ResourceTags

Имя Описание Ценность

ResourceTags

Имя Описание Ценность

ResourceTags

Имя Описание Ценность

Расписание

Имя Описание Ценность
местоположение Расположение ресурса. струна
свойства Свойства ресурса. ScheduleProperties (обязательно)
Теги Теги ресурса. ResourceTags

ScheduleProperties

Имя Описание Ценность
dailyRecurrence Если расписание будет происходить один раз в день недели, укажите ежедневное повторение. DayDetails
почасоваяrecurrence Если расписание будет происходить несколько раз в день, укажите почасовое повторение. HourDetails
notificationSettings Параметры уведомлений. NotificationSettings
provisioningState Состояние подготовки ресурса. струна
статус Состояние расписания (т. е. включено, отключено) "Отключено"
"Включено"
targetResourceId Идентификатор ресурса, к которому принадлежит расписание струна
taskType Тип задачи расписания (например, LabVmsShutdownTask, LabVmAutoStart). струна
timeZoneId Идентификатор часового пояса (например, тихоокеанское стандартное время). струна
uniqueIdentifier Уникальный неизменяемый идентификатор ресурса (GUID). струна
еженедельнаяrecurrence Если расписание будет выполняться только в течение нескольких дней недели, укажите еженедельное повторение. WeekDetails

SharedPublicIpAddressConfiguration

Имя Описание Ценность
inboundNatRules Входящие правила NAT InboundNatRule[]

WeekDetails

Имя Описание Ценность
Время Время дня будет происходить. струна
будни Дни недели, для которых устанавливается расписание (например, воскресенье, понедельник, вторник и т. д.). string[]

Примеры краткого руководства

Следующие примеры краткого руководства по развертыванию этого типа ресурса.

Bicep-файл Описание
Создание лаборатории в Azure DevTest Labs с использованием виртуальной машины Этот шаблон создает новый экземпляр DevTest Lab или DTL с указанной виртуальной машиной Центра обработки данных Windows Server 2019. Дополнительные шаблоны быстрого запуска Azure Resource Manager для Azure DevTest Labs доступны на https://github.com/Azure/azure-devtestlab/tree/master/ARMTemplates

Определение ресурса шаблона ARM

Тип ресурсов labs/virtualmachines можно развернуть с помощью операций, предназначенных для следующих целей:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.DevTestLab/labs/virtualmachines, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.DevTestLab/labs/virtualmachines",
  "apiVersion": "2016-05-15",
  "name": "string",
  "location": "string",
  "properties": {
    "allowClaim": "bool",
    "applicableSchedule": {
      "location": "string",
      "properties": {
        "labVmsShutdown": {
          "location": "string",
          "properties": {
            "dailyRecurrence": {
              "time": "string"
            },
            "hourlyRecurrence": {
              "minute": "int"
            },
            "notificationSettings": {
              "status": "string",
              "timeInMinutes": "int",
              "webhookUrl": "string"
            },
            "provisioningState": "string",
            "status": "string",
            "targetResourceId": "string",
            "taskType": "string",
            "timeZoneId": "string",
            "uniqueIdentifier": "string",
            "weeklyRecurrence": {
              "time": "string",
              "weekdays": [ "string" ]
            }
          },
          "tags": {
            "{customized property}": "string"
          }
        },
        "labVmsStartup": {
          "location": "string",
          "properties": {
            "dailyRecurrence": {
              "time": "string"
            },
            "hourlyRecurrence": {
              "minute": "int"
            },
            "notificationSettings": {
              "status": "string",
              "timeInMinutes": "int",
              "webhookUrl": "string"
            },
            "provisioningState": "string",
            "status": "string",
            "targetResourceId": "string",
            "taskType": "string",
            "timeZoneId": "string",
            "uniqueIdentifier": "string",
            "weeklyRecurrence": {
              "time": "string",
              "weekdays": [ "string" ]
            }
          },
          "tags": {
            "{customized property}": "string"
          }
        }
      },
      "tags": {
        "{customized property}": "string"
      }
    },
    "artifactDeploymentStatus": {
      "artifactsApplied": "int",
      "deploymentStatus": "string",
      "totalArtifacts": "int"
    },
    "artifacts": [
      {
        "artifactId": "string",
        "deploymentStatusMessage": "string",
        "installTime": "string",
        "parameters": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "status": "string",
        "vmExtensionStatusMessage": "string"
      }
    ],
    "computeVm": {
      "dataDiskIds": [ "string" ],
      "dataDisks": [
        {
          "diskSizeGiB": "int",
          "diskUri": "string",
          "managedDiskId": "string",
          "name": "string"
        }
      ],
      "networkInterfaceId": "string",
      "osDiskId": "string",
      "osType": "string",
      "statuses": [
        {
          "code": "string",
          "displayStatus": "string",
          "message": "string"
        }
      ],
      "vmSize": "string"
    },
    "createdByUser": "string",
    "createdByUserId": "string",
    "createdDate": "string",
    "customImageId": "string",
    "disallowPublicIpAddress": "bool",
    "environmentId": "string",
    "expirationDate": "string",
    "fqdn": "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",
    "osType": "string",
    "ownerObjectId": "string",
    "ownerUserPrincipalName": "string",
    "password": "string",
    "provisioningState": "string",
    "size": "string",
    "sshKey": "string",
    "storageType": "string",
    "uniqueIdentifier": "string",
    "userName": "string",
    "virtualMachineCreationSource": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Значения свойств

ПрименимоеSchedule

Имя Описание Ценность
местоположение Расположение ресурса. струна
свойства Свойства ресурса. ApplicableScheduleProperties (обязательно)
Теги Теги ресурса. ResourceTags

ApplicableScheduleProperties

Имя Описание Ценность
labVmsShutdown Расписание автоматического завершения работы, если оно установлено на уровне лаборатории или лаборатории. расписания
labVmsStartup Расписание автоматического запуска, если оно установлено на уровне лаборатории или лаборатории. расписания

ArtifactDeploymentStatusProperties

Имя Описание Ценность
артефактыApplied Общее количество артефактов, которые были успешно применены. int
deploymentStatus Состояние развертывания артефакта. струна
totalArtifacts Общее количество артефактов, которые были предварительно применены. int

ArtifactInstallProperties

Имя Описание Ценность
artifactId Идентификатор артефакта. струна
deploymentStatusMessage Сообщение о состоянии из развертывания. струна
installTime Время установки артефакта на виртуальной машине. струна
Параметры Параметры артефакта. ArtifactParameterProperties[]
статус Состояние артефакта. струна
vmExtensionStatusMessage Сообщение о состоянии из расширения виртуальной машины. струна

ArtifactParameterProperties

Имя Описание Ценность
имя Имя параметра артефакта. струна
ценность Значение параметра артефакта. струна

ComputeDataDisk

Имя Описание Ценность
diskSizeGiB Возвращает размер диска данных в ГиБ. int
diskUri При поддержке большого двоичного объекта универсальный код ресурса (URI) базового большого двоичного объекта. струна
managedDiskId При поддержке управляемого диска это идентификатор ресурса вычислительного диска. струна
имя Возвращает имя диска данных. струна

ComputeVmInstanceViewStatus

Имя Описание Ценность
код Возвращает код состояния. струна
displayStatus Возвращает короткую локализуемую метку для состояния. струна
Сообщение Возвращает сообщение, связанное с состоянием. струна

ComputeVmProperties

Имя Описание Ценность
dataDiskIds Возвращает URI больших двоичных объектов дисков данных для виртуальной машины. string[]
dataDisks Возвращает все диски данных, подключенные к виртуальной машине. ComputeDataDisk[]
networkInterfaceId Возвращает идентификатор сетевого интерфейса виртуальной машины. струна
osDiskId Возвращает универсальный код ресурса (URI) диска ОПЕРАЦИОННОй системы для виртуальной машины. струна
osType Возвращает тип ОС виртуальной машины. струна
Статусы Возвращает состояния виртуальной машины. ComputeVmInstanceViewStatus[]
vmSize Возвращает размер виртуальной машины. струна

DayDetails

Имя Описание Ценность
Время Время суток будет выполняться. струна

GalleryImageReference

Имя Описание Ценность
предлагать Предложение изображения коллекции. струна
osType Тип ОС образа коллекции. струна
издатель Издатель образа коллекции. струна
SKU Номер SKU образа коллекции. струна
Версия Версия образа коллекции. струна

HourDetails

Имя Описание Ценность
минута В минутах часа будет выполняться расписание. int

InboundNatRule

Имя Описание Ценность
серверный порт Порт, на который будет перенаправлен внешний трафик. int
frontendPort Порт внешней конечной точки входящего подключения. Возможные значения в диапазоне от 1 до 65535 включительно. Если не указано, значение будет выделено автоматически. int
transportProtocol Транспортный протокол для конечной точки. Tcp
'Udp'

LabVirtualMachineProperties

Имя Описание Ценность
allowClaim Указывает, может ли другой пользователь взять на себя ответственность за виртуальную машину. bool
применимоеSchedule Применимое расписание для виртуальной машины. ApplicableSchedule
artifactDeploymentStatus Состояние развертывания артефакта для виртуальной машины. ArtifactDeploymentStatusProperties
Артефакты Артефакты, которые необходимо установить на виртуальной машине. ArtifactInstallProperties[]
computeVm Свойства вычислительной виртуальной машины. ComputeVmProperties
createdByUser Адрес электронной почты создателя виртуальной машины. струна
createdByUserId Идентификатор объекта создателя виртуальной машины. струна
createdDate Дата создания виртуальной машины. струна
customImageId Пользовательский идентификатор образа виртуальной машины. струна
disallowPublicIpAddress Указывает, должна ли виртуальная машина создаваться без общедоступного IP-адреса. bool
environmentId Идентификатор ресурса среды, содержащей эту виртуальную машину, при наличии. струна
дата окончания срока действия Дата окончания срока действия виртуальной машины. струна
Полное доменное имя Полное доменное имя виртуальной машины. струна
galleryImageReference Справочник по образу Microsoft Azure Marketplace виртуальной машины. GalleryImageReference
isAuthenticationWithSshKey Указывает, использует ли эта виртуальная машина ключ SSH для проверки подлинности. bool
labSubnetName Имя подсети лаборатории виртуальной машины. струна
labVirtualNetworkId Идентификатор виртуальной сети лаборатории виртуальной машины. струна
networkInterface Свойства сетевого интерфейса. NetworkInterfaceProperties
примечания Заметки о виртуальной машине. струна
osType Тип ОС виртуальной машины. струна
ownerObjectId Идентификатор объекта владельца виртуальной машины. струна
ownerUserPrincipalName Имя субъекта-пользователя владельца виртуальной машины. струна
пароль Пароль администратора виртуальной машины. струна
provisioningState Состояние подготовки ресурса. струна
размер Размер виртуальной машины. струна
sshKey Ключ SSH администратора виртуальной машины. струна
storageType Тип хранилища, используемый для виртуальной машины (например, "Стандартный", "Премиум"). струна
uniqueIdentifier Уникальный неизменяемый идентификатор ресурса (GUID). струна
userName Имя пользователя виртуальной машины. струна
virtualMachineCreationSource Указывает источник создания виртуальной машины лаборатории. Только выходное свойство. FromCustomImage
'FromGalleryImage'

Microsoft.DevTestLab/labs/virtualmachines

Имя Описание Ценность
apiVersion Версия API '2016-05-15'
местоположение Расположение ресурса. струна
имя Имя ресурса строка (обязательно)
свойства Свойства ресурса. LabVirtualMachineProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
тип Тип ресурса "Microsoft.DevTestLab/labs/virtualmachines"

NetworkInterfaceProperties

Имя Описание Ценность
dnsName DNS-имя. струна
privateIpAddress Частный IP-адрес. струна
publicIpAddress Общедоступный IP-адрес. струна
publicIpAddressId Идентификатор ресурса общедоступного IP-адреса. струна
rdpAuthority Свойство RdpAuthority — это имя узла DNS сервера или IP-адрес, за которым следует номер порта службы для RDP (протокол удаленного рабочего стола). струна
sharedPublicIpAddressConfiguration Конфигурация общего доступа к общедоступному IP-адресу на нескольких виртуальных машинах. SharedPublicIpAddressConfiguration
sshAuthority Свойство SshAuthority — это имя узла DNS сервера или IP-адрес, за которым следует номер порта службы для SSH. струна
SubnetId Идентификатор ресурса подсети. струна
virtualNetworkId Идентификатор ресурса виртуальной сети. струна

NotificationSettings

Имя Описание Ценность
статус Если уведомления включены для этого расписания (т. е. включено, отключено). "Отключено"
"Включено"
timeInMinutes Время в минутах до события, по которому будет отправлено уведомление. int
webhookUrl URL-адрес веб-перехватчика, на который будет отправлено уведомление. струна

ResourceTags

Имя Описание Ценность

ResourceTags

Имя Описание Ценность

ResourceTags

Имя Описание Ценность

Расписание

Имя Описание Ценность
местоположение Расположение ресурса. струна
свойства Свойства ресурса. ScheduleProperties (обязательно)
Теги Теги ресурса. ResourceTags

ScheduleProperties

Имя Описание Ценность
dailyRecurrence Если расписание будет происходить один раз в день недели, укажите ежедневное повторение. DayDetails
почасоваяrecurrence Если расписание будет происходить несколько раз в день, укажите почасовое повторение. HourDetails
notificationSettings Параметры уведомлений. NotificationSettings
provisioningState Состояние подготовки ресурса. струна
статус Состояние расписания (т. е. включено, отключено) "Отключено"
"Включено"
targetResourceId Идентификатор ресурса, к которому принадлежит расписание струна
taskType Тип задачи расписания (например, LabVmsShutdownTask, LabVmAutoStart). струна
timeZoneId Идентификатор часового пояса (например, тихоокеанское стандартное время). струна
uniqueIdentifier Уникальный неизменяемый идентификатор ресурса (GUID). струна
еженедельнаяrecurrence Если расписание будет выполняться только в течение нескольких дней недели, укажите еженедельное повторение. WeekDetails

SharedPublicIpAddressConfiguration

Имя Описание Ценность
inboundNatRules Входящие правила NAT InboundNatRule[]

WeekDetails

Имя Описание Ценность
Время Время дня будет происходить. струна
будни Дни недели, для которых устанавливается расписание (например, воскресенье, понедельник, вторник и т. д.). string[]

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
Создание лаборатории в Azure DevTest Labs с использованием виртуальной машины

развертывание в Azure
Этот шаблон создает новый экземпляр DevTest Lab или DTL с указанной виртуальной машиной Центра обработки данных Windows Server 2019. Дополнительные шаблоны быстрого запуска Azure Resource Manager для Azure DevTest Labs доступны на https://github.com/Azure/azure-devtestlab/tree/master/ARMTemplates

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурсов labs/virtualmachines можно развернуть с помощью операций, предназначенных для следующих целей:

  • групп ресурсов

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.DevTestLab/labs/virtualmachines, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DevTestLab/labs/virtualmachines@2016-05-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      allowClaim = bool
      applicableSchedule = {
        location = "string"
        properties = {
          labVmsShutdown = {
            location = "string"
            properties = {
              dailyRecurrence = {
                time = "string"
              }
              hourlyRecurrence = {
                minute = int
              }
              notificationSettings = {
                status = "string"
                timeInMinutes = int
                webhookUrl = "string"
              }
              provisioningState = "string"
              status = "string"
              targetResourceId = "string"
              taskType = "string"
              timeZoneId = "string"
              uniqueIdentifier = "string"
              weeklyRecurrence = {
                time = "string"
                weekdays = [
                  "string"
                ]
              }
            }
            tags = {
              {customized property} = "string"
            }
          }
          labVmsStartup = {
            location = "string"
            properties = {
              dailyRecurrence = {
                time = "string"
              }
              hourlyRecurrence = {
                minute = int
              }
              notificationSettings = {
                status = "string"
                timeInMinutes = int
                webhookUrl = "string"
              }
              provisioningState = "string"
              status = "string"
              targetResourceId = "string"
              taskType = "string"
              timeZoneId = "string"
              uniqueIdentifier = "string"
              weeklyRecurrence = {
                time = "string"
                weekdays = [
                  "string"
                ]
              }
            }
            tags = {
              {customized property} = "string"
            }
          }
        }
        tags = {
          {customized property} = "string"
        }
      }
      artifactDeploymentStatus = {
        artifactsApplied = int
        deploymentStatus = "string"
        totalArtifacts = int
      }
      artifacts = [
        {
          artifactId = "string"
          deploymentStatusMessage = "string"
          installTime = "string"
          parameters = [
            {
              name = "string"
              value = "string"
            }
          ]
          status = "string"
          vmExtensionStatusMessage = "string"
        }
      ]
      computeVm = {
        dataDiskIds = [
          "string"
        ]
        dataDisks = [
          {
            diskSizeGiB = int
            diskUri = "string"
            managedDiskId = "string"
            name = "string"
          }
        ]
        networkInterfaceId = "string"
        osDiskId = "string"
        osType = "string"
        statuses = [
          {
            code = "string"
            displayStatus = "string"
            message = "string"
          }
        ]
        vmSize = "string"
      }
      createdByUser = "string"
      createdByUserId = "string"
      createdDate = "string"
      customImageId = "string"
      disallowPublicIpAddress = bool
      environmentId = "string"
      expirationDate = "string"
      fqdn = "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"
      osType = "string"
      ownerObjectId = "string"
      ownerUserPrincipalName = "string"
      password = "string"
      provisioningState = "string"
      size = "string"
      sshKey = "string"
      storageType = "string"
      uniqueIdentifier = "string"
      userName = "string"
      virtualMachineCreationSource = "string"
    }
  })
}

Значения свойств

ПрименимоеSchedule

Имя Описание Ценность
местоположение Расположение ресурса. струна
свойства Свойства ресурса. ApplicableScheduleProperties (обязательно)
Теги Теги ресурса. ResourceTags

ApplicableScheduleProperties

Имя Описание Ценность
labVmsShutdown Расписание автоматического завершения работы, если оно установлено на уровне лаборатории или лаборатории. расписания
labVmsStartup Расписание автоматического запуска, если оно установлено на уровне лаборатории или лаборатории. расписания

ArtifactDeploymentStatusProperties

Имя Описание Ценность
артефактыApplied Общее количество артефактов, которые были успешно применены. int
deploymentStatus Состояние развертывания артефакта. струна
totalArtifacts Общее количество артефактов, которые были предварительно применены. int

ArtifactInstallProperties

Имя Описание Ценность
artifactId Идентификатор артефакта. струна
deploymentStatusMessage Сообщение о состоянии из развертывания. струна
installTime Время установки артефакта на виртуальной машине. струна
Параметры Параметры артефакта. ArtifactParameterProperties[]
статус Состояние артефакта. струна
vmExtensionStatusMessage Сообщение о состоянии из расширения виртуальной машины. струна

ArtifactParameterProperties

Имя Описание Ценность
имя Имя параметра артефакта. струна
ценность Значение параметра артефакта. струна

ComputeDataDisk

Имя Описание Ценность
diskSizeGiB Возвращает размер диска данных в ГиБ. int
diskUri При поддержке большого двоичного объекта универсальный код ресурса (URI) базового большого двоичного объекта. струна
managedDiskId При поддержке управляемого диска это идентификатор ресурса вычислительного диска. струна
имя Возвращает имя диска данных. струна

ComputeVmInstanceViewStatus

Имя Описание Ценность
код Возвращает код состояния. струна
displayStatus Возвращает короткую локализуемую метку для состояния. струна
Сообщение Возвращает сообщение, связанное с состоянием. струна

ComputeVmProperties

Имя Описание Ценность
dataDiskIds Возвращает URI больших двоичных объектов дисков данных для виртуальной машины. string[]
dataDisks Возвращает все диски данных, подключенные к виртуальной машине. ComputeDataDisk[]
networkInterfaceId Возвращает идентификатор сетевого интерфейса виртуальной машины. струна
osDiskId Возвращает универсальный код ресурса (URI) диска ОПЕРАЦИОННОй системы для виртуальной машины. струна
osType Возвращает тип ОС виртуальной машины. струна
Статусы Возвращает состояния виртуальной машины. ComputeVmInstanceViewStatus[]
vmSize Возвращает размер виртуальной машины. струна

DayDetails

Имя Описание Ценность
Время Время суток будет выполняться. струна

GalleryImageReference

Имя Описание Ценность
предлагать Предложение изображения коллекции. струна
osType Тип ОС образа коллекции. струна
издатель Издатель образа коллекции. струна
SKU Номер SKU образа коллекции. струна
Версия Версия образа коллекции. струна

HourDetails

Имя Описание Ценность
минута В минутах часа будет выполняться расписание. int

InboundNatRule

Имя Описание Ценность
серверный порт Порт, на который будет перенаправлен внешний трафик. int
frontendPort Порт внешней конечной точки входящего подключения. Возможные значения в диапазоне от 1 до 65535 включительно. Если не указано, значение будет выделено автоматически. int
transportProtocol Транспортный протокол для конечной точки. Tcp
'Udp'

LabVirtualMachineProperties

Имя Описание Ценность
allowClaim Указывает, может ли другой пользователь взять на себя ответственность за виртуальную машину. bool
применимоеSchedule Применимое расписание для виртуальной машины. ApplicableSchedule
artifactDeploymentStatus Состояние развертывания артефакта для виртуальной машины. ArtifactDeploymentStatusProperties
Артефакты Артефакты, которые необходимо установить на виртуальной машине. ArtifactInstallProperties[]
computeVm Свойства вычислительной виртуальной машины. ComputeVmProperties
createdByUser Адрес электронной почты создателя виртуальной машины. струна
createdByUserId Идентификатор объекта создателя виртуальной машины. струна
createdDate Дата создания виртуальной машины. струна
customImageId Пользовательский идентификатор образа виртуальной машины. струна
disallowPublicIpAddress Указывает, должна ли виртуальная машина создаваться без общедоступного IP-адреса. bool
environmentId Идентификатор ресурса среды, содержащей эту виртуальную машину, при наличии. струна
дата окончания срока действия Дата окончания срока действия виртуальной машины. струна
Полное доменное имя Полное доменное имя виртуальной машины. струна
galleryImageReference Справочник по образу Microsoft Azure Marketplace виртуальной машины. GalleryImageReference
isAuthenticationWithSshKey Указывает, использует ли эта виртуальная машина ключ SSH для проверки подлинности. bool
labSubnetName Имя подсети лаборатории виртуальной машины. струна
labVirtualNetworkId Идентификатор виртуальной сети лаборатории виртуальной машины. струна
networkInterface Свойства сетевого интерфейса. NetworkInterfaceProperties
примечания Заметки о виртуальной машине. струна
osType Тип ОС виртуальной машины. струна
ownerObjectId Идентификатор объекта владельца виртуальной машины. струна
ownerUserPrincipalName Имя субъекта-пользователя владельца виртуальной машины. струна
пароль Пароль администратора виртуальной машины. струна
provisioningState Состояние подготовки ресурса. струна
размер Размер виртуальной машины. струна
sshKey Ключ SSH администратора виртуальной машины. струна
storageType Тип хранилища, используемый для виртуальной машины (например, "Стандартный", "Премиум"). струна
uniqueIdentifier Уникальный неизменяемый идентификатор ресурса (GUID). струна
userName Имя пользователя виртуальной машины. струна
virtualMachineCreationSource Указывает источник создания виртуальной машины лаборатории. Только выходное свойство. FromCustomImage
'FromGalleryImage'

Microsoft.DevTestLab/labs/virtualmachines

Имя Описание Ценность
местоположение Расположение ресурса. струна
имя Имя ресурса строка (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: лабораторий
свойства Свойства ресурса. LabVirtualMachineProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.DevTestLab/labs/virtualmachines@2016-05-15"

NetworkInterfaceProperties

Имя Описание Ценность
dnsName DNS-имя. струна
privateIpAddress Частный IP-адрес. струна
publicIpAddress Общедоступный IP-адрес. струна
publicIpAddressId Идентификатор ресурса общедоступного IP-адреса. струна
rdpAuthority Свойство RdpAuthority — это имя узла DNS сервера или IP-адрес, за которым следует номер порта службы для RDP (протокол удаленного рабочего стола). струна
sharedPublicIpAddressConfiguration Конфигурация общего доступа к общедоступному IP-адресу на нескольких виртуальных машинах. SharedPublicIpAddressConfiguration
sshAuthority Свойство SshAuthority — это имя узла DNS сервера или IP-адрес, за которым следует номер порта службы для SSH. струна
SubnetId Идентификатор ресурса подсети. струна
virtualNetworkId Идентификатор ресурса виртуальной сети. струна

NotificationSettings

Имя Описание Ценность
статус Если уведомления включены для этого расписания (т. е. включено, отключено). "Отключено"
"Включено"
timeInMinutes Время в минутах до события, по которому будет отправлено уведомление. int
webhookUrl URL-адрес веб-перехватчика, на который будет отправлено уведомление. струна

ResourceTags

Имя Описание Ценность

ResourceTags

Имя Описание Ценность

ResourceTags

Имя Описание Ценность

Расписание

Имя Описание Ценность
местоположение Расположение ресурса. струна
свойства Свойства ресурса. ScheduleProperties (обязательно)
Теги Теги ресурса. ResourceTags

ScheduleProperties

Имя Описание Ценность
dailyRecurrence Если расписание будет происходить один раз в день недели, укажите ежедневное повторение. DayDetails
почасоваяrecurrence Если расписание будет происходить несколько раз в день, укажите почасовое повторение. HourDetails
notificationSettings Параметры уведомлений. NotificationSettings
provisioningState Состояние подготовки ресурса. струна
статус Состояние расписания (т. е. включено, отключено) "Отключено"
"Включено"
targetResourceId Идентификатор ресурса, к которому принадлежит расписание струна
taskType Тип задачи расписания (например, LabVmsShutdownTask, LabVmAutoStart). струна
timeZoneId Идентификатор часового пояса (например, тихоокеанское стандартное время). струна
uniqueIdentifier Уникальный неизменяемый идентификатор ресурса (GUID). струна
еженедельнаяrecurrence Если расписание будет выполняться только в течение нескольких дней недели, укажите еженедельное повторение. WeekDetails

SharedPublicIpAddressConfiguration

Имя Описание Ценность
inboundNatRules Входящие правила NAT InboundNatRule[]

WeekDetails

Имя Описание Ценность
Время Время дня будет происходить. струна
будни Дни недели, для которых устанавливается расписание (например, воскресенье, понедельник, вторник и т. д.). string[]