Delen via

Microsoft.DevTestLab labs/virtuele machines

Bicep-resourcedefinitie

Het resourcetype labs/virtualmachines kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource microsoft.DevTestLab/labs/virtualmachines wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.DevTestLab/labs/virtualmachines@2018-09-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  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'
          timeZoneId: 'string'
          weeklyRecurrence: {
            time: 'string'
            weekdays: [
              'string'
            ]
          }
        }
        tags: {
          {customized property}: 'string'
        }
      }
    ]
    size: 'string'
    sshKey: 'string'
    storageType: 'string'
    userName: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Eigenschapswaarden

Microsoft.DevTestLab/labs/virtualmachines

Name Description Value
location De locatie van de resource. string
name De resourcenaam tekenreeks (vereist)
parent In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd.

Zie onderliggende resource buiten de bovenliggende resourcevoor meer informatie.		 Symbolische naam voor resource van het type: labs
properties De eigenschappen van de resource. LabVirtualMachineProperties (verplicht)
tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen

ArtifactInstallProperties

Name Description Value
artifactId De id van het artefact. string
artifactTitle De titel van het artefact. string
deploymentStatusMessage Het statusbericht van de implementatie. string
installTime Het tijdstip waarop het artefact wordt geïnstalleerd op de virtuele machine. string
parameters De parameters van het artefact. ArtifactParameterProperties[]
status De status van het artefact. string
vmExtensionStatusMessage Het statusbericht van de extensie van de virtuele machine. string

ArtifactParameterProperties

Name Description Value
name De naam van de artefactparameter. string
value De waarde van de artefactparameter. string

AttachNewDataDiskOptions

Name Description Value
diskName De naam van de schijf die moet worden gekoppeld. string
diskSizeGiB Grootte van de schijf die moet worden gekoppeld in Gibibytes. int
diskType Het opslagtype voor de schijf (bijvoorbeeld Standard, Premium). 'Premium'
'Standard'
'StandardSSD'

DataDiskProperties

Name Description Value
attachNewDataDiskOptions Hiermee geeft u opties voor het koppelen van een nieuwe schijf aan de virtuele machine. AttachNewDataDiskOptions
existingLabDiskId Hiermee geeft u de bestaande labschijf-id op die moet worden gekoppeld aan de virtuele machine. string
hostCaching Cacheoptie voor een gegevensschijf (bijvoorbeeld Geen, ReadOnly, ReadWrite). 'None'
'ReadOnly'
'ReadWrite'

DayDetails

Name Description Value
time Het tijdstip waarop de planning plaatsvindt. string

GalleryImageReference

Name Description Value
offer De aanbieding van de galerieafbeelding. string
osType Het type besturingssysteem van de galerie-installatiekopie. string
publisher De uitgever van de galerie-installatiekopieën. string
sku De SKU van de galerie-installatiekopieën. string
version De versie van de galerie-installatiekopieën. string

HourDetails

Name Description Value
minute Minuten van het uur dat de planning wordt uitgevoerd. int

InboundNatRule

Name Description Value
backendPort De poort waarnaar het externe verkeer wordt omgeleid. int
frontendPort De poort van het externe eindpunt van de binnenkomende verbinding. Mogelijke waarden variëren tussen 1 en 65535, inclusief. Indien niet opgegeven, wordt automatisch een waarde toegewezen. int
transportProtocol Het transportprotocol voor het eindpunt. 'Tcp'
'Udp'

LabVirtualMachineProperties

Name Description Value
allowClaim Geeft aan of een andere gebruiker eigenaar kan worden van de virtuele machine bool
artifacts De artefacten die op de virtuele machine moeten worden geïnstalleerd. ArtifactInstallProperties[]
createdDate De aanmaakdatum van de virtuele machine. string
customImageId De aangepaste installatiekopieën-id van de virtuele machine. string
dataDiskParameters Nieuwe of bestaande gegevensschijven die aan de virtuele machine moeten worden gekoppeld na het maken DataDiskProperties[]
disallowPublicIpAddress Hiermee wordt aangegeven of de virtuele machine moet worden gemaakt zonder een openbaar IP-adres. bool
environmentId De resource-id van de omgeving die deze virtuele machine bevat, indien van toepassing. string
expirationDate De vervaldatum voor de VIRTUELE machine. string
galleryImageReference De microsoft Azure Marketplace-installatiekopieën van de virtuele machine. GalleryImageReference
isAuthenticationWithSshKey Geeft aan of deze virtuele machine gebruikmaakt van een SSH-sleutel voor verificatie. bool
labSubnetName De naam van het labsubnet van de virtuele machine. string
labVirtualNetworkId De id van het virtuele labnetwerk van de virtuele machine. string
networkInterface De eigenschappen van de netwerkinterface. NetworkInterfaceProperties
notes De notities van de virtuele machine. string
ownerObjectId De object-id van de eigenaar van de virtuele machine. string
ownerUserPrincipalName De principal-naam van de gebruiker van de eigenaar van de virtuele machine. string
password Het wachtwoord van de beheerder van de virtuele machine. string
planId De id van het plan dat is gekoppeld aan de installatiekopieën van de virtuele machine string
scheduleParameters Planningen voor virtuele machines die moeten worden gemaakt ScheduleCreationParameter[]
size De grootte van de virtuele machine. string
sshKey De SSH-sleutel van de beheerder van de virtuele machine. string
storageType Opslagtype dat moet worden gebruikt voor virtuele machine (bijvoorbeeld Standard, Premium). string
userName De gebruikersnaam van de virtuele machine. string

NetworkInterfaceProperties

Name Description Value
dnsName De DNS-naam. string
privateIpAddress Het privé-IP-adres. string
publicIpAddress Het openbare IP-adres. string
publicIpAddressId De resource-id van het openbare IP-adres. string
rdpAuthority De eigenschap RdpAuthority is een DNS-hostnaam of IP-adres van de server, gevolgd door het servicepoortnummer voor RDP (Remote Desktop Protocol). string
sharedPublicIpAddressConfiguration De configuratie voor het delen van een openbaar IP-adres op meerdere virtuele machines. SharedPublicIpAddressConfiguration
sshAuthority De eigenschap SshAuthority is een DNS-hostnaam of IP-adres van de server, gevolgd door het servicepoortnummer voor SSH. string
subnetId De resource-id van het subnet. string
virtualNetworkId De resource-id van het virtuele netwerk. string

NotificationSettings

Name Description Value
emailRecipient De e-mailontvanger waar meldingen naar worden verzonden (kan een lijst met door puntkomma's gescheiden e-mailadressen zijn). string
notificationLocale De landinstelling die moet worden gebruikt bij het verzenden van een melding (terugval voor niet-ondersteunde talen is EN). string
status Als meldingen zijn ingeschakeld voor dit schema (bijvoorbeeld Ingeschakeld, Uitgeschakeld). 'Disabled'
'Enabled'
timeInMinutes Tijd in minuten vóór de gebeurtenis waarop een melding wordt verzonden. int
webhookUrl De webhook-URL waarnaar de melding wordt verzonden. string

ResourceTags

Name Description Value

ScheduleCreationParameter

Name Description Value
name De naam van de virtuele machine of omgeving string
properties De eigenschappen van de planning. ScheduleCreationParameterProperties
tags De tags van de resource. ScheduleCreationParameterTags

ScheduleCreationParameterProperties

Name Description Value
dailyRecurrence Als de planning eenmaal per dag van de week plaatsvindt, geeft u het dagelijkse terugkeerpatroon op. DayDetails
hourlyRecurrence Als het schema meerdere keren per dag plaatsvindt, geeft u het terugkeerpatroon per uur op. HourDetails
notificationSettings Instellingen voor meldingen. NotificationSettings
status De status van het schema (bijvoorbeeld Ingeschakeld, Uitgeschakeld) 'Disabled'
'Enabled'
targetResourceId De resource-id waartoe de planning behoort string
taskType Het taaktype van de planning (bijvoorbeeld LabVmsShutdownTask, LabVmAutoStart). string
timeZoneId De tijdzone-id (bijvoorbeeld China Standard Time, Groenland Standaardtijd, Pacific Standard Time, enz.). De mogelijke waarden voor deze eigenschap vindt u in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) string
weeklyRecurrence Als de planning slechts enkele dagen van de week plaatsvindt, geeft u het wekelijkse terugkeerpatroon op. WeekDetails

ScheduleCreationParameterTags

Name Description Value

SharedPublicIpAddressConfiguration

Name Description Value
inboundNatRules De binnenkomende NAT-regels InboundNatRule[]

WeekDetails

Name Description Value
time Het tijdstip van de dag waarop de planning plaatsvindt. string
weekdays De dagen van de week waarvoor de planning is ingesteld (bijvoorbeeld zondag, maandag, dinsdag, enzovoort). string[]

Gebruiksvoorbeelden

Azure-snelstartvoorbeelden

De volgende Azure-quickstartsjablonen bicep-voorbeelden bevatten voor het implementeren van dit resourcetype.

Bicep-bestand Description
Maakt een lab in Azure DevTest Labs met een geclaimde VM- Met deze sjabloon maakt u een nieuw DevTest Lab/DTL-exemplaar met daarin een geclaimde Virtuele Machine met Windows Server 2019 Datacenter. Meer Azure Resource Manager-quickstartsjablonen voor Azure DevTest Labs die beschikbaar zijn op https://github.com/Azure/azure-devtestlab/tree/master/ARMTemplates

Resourcedefinitie van ARM-sjabloon

Het resourcetype labs/virtualmachines kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource microsoft.DevTestLab/labs/virtualmachines wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.DevTestLab/labs/virtualmachines",
  "apiVersion": "2018-09-15",
  "name": "string",
  "location": "string",
  "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",
          "timeZoneId": "string",
          "weeklyRecurrence": {
            "time": "string",
            "weekdays": [ "string" ]
          }
        },
        "tags": {
          "{customized property}": "string"
        }
      }
    ],
    "size": "string",
    "sshKey": "string",
    "storageType": "string",
    "userName": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Eigenschapswaarden

Microsoft.DevTestLab/labs/virtualmachines

Name Description Value
apiVersion De API-versie '2018-09-15'
location De locatie van de resource. string
name De resourcenaam tekenreeks (vereist)
properties De eigenschappen van de resource. LabVirtualMachineProperties (verplicht)
tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen
type Het resourcetype 'Microsoft.DevTestLab/labs/virtualmachines'

ArtifactInstallProperties

Name Description Value
artifactId De id van het artefact. string
artifactTitle De titel van het artefact. string
deploymentStatusMessage Het statusbericht van de implementatie. string
installTime Het tijdstip waarop het artefact wordt geïnstalleerd op de virtuele machine. string
parameters De parameters van het artefact. ArtifactParameterProperties[]
status De status van het artefact. string
vmExtensionStatusMessage Het statusbericht van de extensie van de virtuele machine. string

ArtifactParameterProperties

Name Description Value
name De naam van de artefactparameter. string
value De waarde van de artefactparameter. string

AttachNewDataDiskOptions

Name Description Value
diskName De naam van de schijf die moet worden gekoppeld. string
diskSizeGiB Grootte van de schijf die moet worden gekoppeld in Gibibytes. int
diskType Het opslagtype voor de schijf (bijvoorbeeld Standard, Premium). 'Premium'
'Standard'
'StandardSSD'

DataDiskProperties

Name Description Value
attachNewDataDiskOptions Hiermee geeft u opties voor het koppelen van een nieuwe schijf aan de virtuele machine. AttachNewDataDiskOptions
existingLabDiskId Hiermee geeft u de bestaande labschijf-id op die moet worden gekoppeld aan de virtuele machine. string
hostCaching Cacheoptie voor een gegevensschijf (bijvoorbeeld Geen, ReadOnly, ReadWrite). 'None'
'ReadOnly'
'ReadWrite'

DayDetails

Name Description Value
time Het tijdstip waarop de planning plaatsvindt. string

GalleryImageReference

Name Description Value
offer De aanbieding van de galerieafbeelding. string
osType Het type besturingssysteem van de galerie-installatiekopie. string
publisher De uitgever van de galerie-installatiekopieën. string
sku De SKU van de galerie-installatiekopieën. string
version De versie van de galerie-installatiekopieën. string

HourDetails

Name Description Value
minute Minuten van het uur dat de planning wordt uitgevoerd. int

InboundNatRule

Name Description Value
backendPort De poort waarnaar het externe verkeer wordt omgeleid. int
frontendPort De poort van het externe eindpunt van de binnenkomende verbinding. Mogelijke waarden variëren tussen 1 en 65535, inclusief. Indien niet opgegeven, wordt automatisch een waarde toegewezen. int
transportProtocol Het transportprotocol voor het eindpunt. 'Tcp'
'Udp'

LabVirtualMachineProperties

Name Description Value
allowClaim Geeft aan of een andere gebruiker eigenaar kan worden van de virtuele machine bool
artifacts De artefacten die op de virtuele machine moeten worden geïnstalleerd. ArtifactInstallProperties[]
createdDate De aanmaakdatum van de virtuele machine. string
customImageId De aangepaste installatiekopieën-id van de virtuele machine. string
dataDiskParameters Nieuwe of bestaande gegevensschijven die aan de virtuele machine moeten worden gekoppeld na het maken DataDiskProperties[]
disallowPublicIpAddress Hiermee wordt aangegeven of de virtuele machine moet worden gemaakt zonder een openbaar IP-adres. bool
environmentId De resource-id van de omgeving die deze virtuele machine bevat, indien van toepassing. string
expirationDate De vervaldatum voor de VIRTUELE machine. string
galleryImageReference De microsoft Azure Marketplace-installatiekopieën van de virtuele machine. GalleryImageReference
isAuthenticationWithSshKey Geeft aan of deze virtuele machine gebruikmaakt van een SSH-sleutel voor verificatie. bool
labSubnetName De naam van het labsubnet van de virtuele machine. string
labVirtualNetworkId De id van het virtuele labnetwerk van de virtuele machine. string
networkInterface De eigenschappen van de netwerkinterface. NetworkInterfaceProperties
notes De notities van de virtuele machine. string
ownerObjectId De object-id van de eigenaar van de virtuele machine. string
ownerUserPrincipalName De principal-naam van de gebruiker van de eigenaar van de virtuele machine. string
password Het wachtwoord van de beheerder van de virtuele machine. string
planId De id van het plan dat is gekoppeld aan de installatiekopieën van de virtuele machine string
scheduleParameters Planningen voor virtuele machines die moeten worden gemaakt ScheduleCreationParameter[]
size De grootte van de virtuele machine. string
sshKey De SSH-sleutel van de beheerder van de virtuele machine. string
storageType Opslagtype dat moet worden gebruikt voor virtuele machine (bijvoorbeeld Standard, Premium). string
userName De gebruikersnaam van de virtuele machine. string

NetworkInterfaceProperties

Name Description Value
dnsName De DNS-naam. string
privateIpAddress Het privé-IP-adres. string
publicIpAddress Het openbare IP-adres. string
publicIpAddressId De resource-id van het openbare IP-adres. string
rdpAuthority De eigenschap RdpAuthority is een DNS-hostnaam of IP-adres van de server, gevolgd door het servicepoortnummer voor RDP (Remote Desktop Protocol). string
sharedPublicIpAddressConfiguration De configuratie voor het delen van een openbaar IP-adres op meerdere virtuele machines. SharedPublicIpAddressConfiguration
sshAuthority De eigenschap SshAuthority is een DNS-hostnaam of IP-adres van de server, gevolgd door het servicepoortnummer voor SSH. string
subnetId De resource-id van het subnet. string
virtualNetworkId De resource-id van het virtuele netwerk. string

NotificationSettings

Name Description Value
emailRecipient De e-mailontvanger waar meldingen naar worden verzonden (kan een lijst met door puntkomma's gescheiden e-mailadressen zijn). string
notificationLocale De landinstelling die moet worden gebruikt bij het verzenden van een melding (terugval voor niet-ondersteunde talen is EN). string
status Als meldingen zijn ingeschakeld voor dit schema (bijvoorbeeld Ingeschakeld, Uitgeschakeld). 'Disabled'
'Enabled'
timeInMinutes Tijd in minuten vóór de gebeurtenis waarop een melding wordt verzonden. int
webhookUrl De webhook-URL waarnaar de melding wordt verzonden. string

ResourceTags

Name Description Value

ScheduleCreationParameter

Name Description Value
name De naam van de virtuele machine of omgeving string
properties De eigenschappen van de planning. ScheduleCreationParameterProperties
tags De tags van de resource. ScheduleCreationParameterTags

ScheduleCreationParameterProperties

Name Description Value
dailyRecurrence Als de planning eenmaal per dag van de week plaatsvindt, geeft u het dagelijkse terugkeerpatroon op. DayDetails
hourlyRecurrence Als het schema meerdere keren per dag plaatsvindt, geeft u het terugkeerpatroon per uur op. HourDetails
notificationSettings Instellingen voor meldingen. NotificationSettings
status De status van het schema (bijvoorbeeld Ingeschakeld, Uitgeschakeld) 'Disabled'
'Enabled'
targetResourceId De resource-id waartoe de planning behoort string
taskType Het taaktype van de planning (bijvoorbeeld LabVmsShutdownTask, LabVmAutoStart). string
timeZoneId De tijdzone-id (bijvoorbeeld China Standard Time, Groenland Standaardtijd, Pacific Standard Time, enz.). De mogelijke waarden voor deze eigenschap vindt u in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) string
weeklyRecurrence Als de planning slechts enkele dagen van de week plaatsvindt, geeft u het wekelijkse terugkeerpatroon op. WeekDetails

ScheduleCreationParameterTags

Name Description Value

SharedPublicIpAddressConfiguration

Name Description Value
inboundNatRules De binnenkomende NAT-regels InboundNatRule[]

WeekDetails

Name Description Value
time Het tijdstip van de dag waarop de planning plaatsvindt. string
weekdays De dagen van de week waarvoor de planning is ingesteld (bijvoorbeeld zondag, maandag, dinsdag, enzovoort). string[]

Gebruiksvoorbeelden

Azure-snelstartsjablonen

De volgende Azure-quickstartsjablonen dit resourcetype implementeren.

Template Description
Maakt een lab in Azure DevTest Labs met een geclaimde VM-

implementeren in Azure 		Met deze sjabloon maakt u een nieuw DevTest Lab/DTL-exemplaar met daarin een geclaimde Virtuele Machine met Windows Server 2019 Datacenter. Meer Azure Resource Manager-quickstartsjablonen voor Azure DevTest Labs die beschikbaar zijn op https://github.com/Azure/azure-devtestlab/tree/master/ARMTemplates

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype labs/virtualmachines kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • Resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource microsoft.DevTestLab/labs/virtualmachines wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DevTestLab/labs/virtualmachines@2018-09-15"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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"
            timeZoneId = "string"
            weeklyRecurrence = {
              time = "string"
              weekdays = [
                "string"
              ]
            }
          }
          tags = {
            {customized property} = "string"
          }
        }
      ]
      size = "string"
      sshKey = "string"
      storageType = "string"
      userName = "string"
    }
  }
}

Eigenschapswaarden

Microsoft.DevTestLab/labs/virtualmachines

Name Description Value
location De locatie van de resource. string
name De resourcenaam tekenreeks (vereist)
parent_id De id van de resource die het bovenliggende item voor deze resource is. Id voor resource van het type: labs
properties De eigenschappen van de resource. LabVirtualMachineProperties (verplicht)
tags Resourcetags Woordenlijst met tagnamen en -waarden.
type Het resourcetype "Microsoft.DevTestLab/labs/virtualmachines@2018-09-15"

ArtifactInstallProperties

Name Description Value
artifactId De id van het artefact. string
artifactTitle De titel van het artefact. string
deploymentStatusMessage Het statusbericht van de implementatie. string
installTime Het tijdstip waarop het artefact wordt geïnstalleerd op de virtuele machine. string
parameters De parameters van het artefact. ArtifactParameterProperties[]
status De status van het artefact. string
vmExtensionStatusMessage Het statusbericht van de extensie van de virtuele machine. string

ArtifactParameterProperties

Name Description Value
name De naam van de artefactparameter. string
value De waarde van de artefactparameter. string

AttachNewDataDiskOptions

Name Description Value
diskName De naam van de schijf die moet worden gekoppeld. string
diskSizeGiB Grootte van de schijf die moet worden gekoppeld in Gibibytes. int
diskType Het opslagtype voor de schijf (bijvoorbeeld Standard, Premium). 'Premium'
'Standard'
'StandardSSD'

DataDiskProperties

Name Description Value
attachNewDataDiskOptions Hiermee geeft u opties voor het koppelen van een nieuwe schijf aan de virtuele machine. AttachNewDataDiskOptions
existingLabDiskId Hiermee geeft u de bestaande labschijf-id op die moet worden gekoppeld aan de virtuele machine. string
hostCaching Cacheoptie voor een gegevensschijf (bijvoorbeeld Geen, ReadOnly, ReadWrite). 'None'
'ReadOnly'
'ReadWrite'

DayDetails

Name Description Value
time Het tijdstip waarop de planning plaatsvindt. string

GalleryImageReference

Name Description Value
offer De aanbieding van de galerieafbeelding. string
osType Het type besturingssysteem van de galerie-installatiekopie. string
publisher De uitgever van de galerie-installatiekopieën. string
sku De SKU van de galerie-installatiekopieën. string
version De versie van de galerie-installatiekopieën. string

HourDetails

Name Description Value
minute Minuten van het uur dat de planning wordt uitgevoerd. int

InboundNatRule

Name Description Value
backendPort De poort waarnaar het externe verkeer wordt omgeleid. int
frontendPort De poort van het externe eindpunt van de binnenkomende verbinding. Mogelijke waarden variëren tussen 1 en 65535, inclusief. Indien niet opgegeven, wordt automatisch een waarde toegewezen. int
transportProtocol Het transportprotocol voor het eindpunt. 'Tcp'
'Udp'

LabVirtualMachineProperties

Name Description Value
allowClaim Geeft aan of een andere gebruiker eigenaar kan worden van de virtuele machine bool
artifacts De artefacten die op de virtuele machine moeten worden geïnstalleerd. ArtifactInstallProperties[]
createdDate De aanmaakdatum van de virtuele machine. string
customImageId De aangepaste installatiekopieën-id van de virtuele machine. string
dataDiskParameters Nieuwe of bestaande gegevensschijven die aan de virtuele machine moeten worden gekoppeld na het maken DataDiskProperties[]
disallowPublicIpAddress Hiermee wordt aangegeven of de virtuele machine moet worden gemaakt zonder een openbaar IP-adres. bool
environmentId De resource-id van de omgeving die deze virtuele machine bevat, indien van toepassing. string
expirationDate De vervaldatum voor de VIRTUELE machine. string
galleryImageReference De microsoft Azure Marketplace-installatiekopieën van de virtuele machine. GalleryImageReference
isAuthenticationWithSshKey Geeft aan of deze virtuele machine gebruikmaakt van een SSH-sleutel voor verificatie. bool
labSubnetName De naam van het labsubnet van de virtuele machine. string
labVirtualNetworkId De id van het virtuele labnetwerk van de virtuele machine. string
networkInterface De eigenschappen van de netwerkinterface. NetworkInterfaceProperties
notes De notities van de virtuele machine. string
ownerObjectId De object-id van de eigenaar van de virtuele machine. string
ownerUserPrincipalName De principal-naam van de gebruiker van de eigenaar van de virtuele machine. string
password Het wachtwoord van de beheerder van de virtuele machine. string
planId De id van het plan dat is gekoppeld aan de installatiekopieën van de virtuele machine string
scheduleParameters Planningen voor virtuele machines die moeten worden gemaakt ScheduleCreationParameter[]
size De grootte van de virtuele machine. string
sshKey De SSH-sleutel van de beheerder van de virtuele machine. string
storageType Opslagtype dat moet worden gebruikt voor virtuele machine (bijvoorbeeld Standard, Premium). string
userName De gebruikersnaam van de virtuele machine. string

NetworkInterfaceProperties

Name Description Value
dnsName De DNS-naam. string
privateIpAddress Het privé-IP-adres. string
publicIpAddress Het openbare IP-adres. string
publicIpAddressId De resource-id van het openbare IP-adres. string
rdpAuthority De eigenschap RdpAuthority is een DNS-hostnaam of IP-adres van de server, gevolgd door het servicepoortnummer voor RDP (Remote Desktop Protocol). string
sharedPublicIpAddressConfiguration De configuratie voor het delen van een openbaar IP-adres op meerdere virtuele machines. SharedPublicIpAddressConfiguration
sshAuthority De eigenschap SshAuthority is een DNS-hostnaam of IP-adres van de server, gevolgd door het servicepoortnummer voor SSH. string
subnetId De resource-id van het subnet. string
virtualNetworkId De resource-id van het virtuele netwerk. string

NotificationSettings

Name Description Value
emailRecipient De e-mailontvanger waar meldingen naar worden verzonden (kan een lijst met door puntkomma's gescheiden e-mailadressen zijn). string
notificationLocale De landinstelling die moet worden gebruikt bij het verzenden van een melding (terugval voor niet-ondersteunde talen is EN). string
status Als meldingen zijn ingeschakeld voor dit schema (bijvoorbeeld Ingeschakeld, Uitgeschakeld). 'Disabled'
'Enabled'
timeInMinutes Tijd in minuten vóór de gebeurtenis waarop een melding wordt verzonden. int
webhookUrl De webhook-URL waarnaar de melding wordt verzonden. string

ResourceTags

Name Description Value

ScheduleCreationParameter

Name Description Value
name De naam van de virtuele machine of omgeving string
properties De eigenschappen van de planning. ScheduleCreationParameterProperties
tags De tags van de resource. ScheduleCreationParameterTags

ScheduleCreationParameterProperties

Name Description Value
dailyRecurrence Als de planning eenmaal per dag van de week plaatsvindt, geeft u het dagelijkse terugkeerpatroon op. DayDetails
hourlyRecurrence Als het schema meerdere keren per dag plaatsvindt, geeft u het terugkeerpatroon per uur op. HourDetails
notificationSettings Instellingen voor meldingen. NotificationSettings
status De status van het schema (bijvoorbeeld Ingeschakeld, Uitgeschakeld) 'Disabled'
'Enabled'
targetResourceId De resource-id waartoe de planning behoort string
taskType Het taaktype van de planning (bijvoorbeeld LabVmsShutdownTask, LabVmAutoStart). string
timeZoneId De tijdzone-id (bijvoorbeeld China Standard Time, Groenland Standaardtijd, Pacific Standard Time, enz.). De mogelijke waarden voor deze eigenschap vindt u in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) string
weeklyRecurrence Als de planning slechts enkele dagen van de week plaatsvindt, geeft u het wekelijkse terugkeerpatroon op. WeekDetails

ScheduleCreationParameterTags

Name Description Value

SharedPublicIpAddressConfiguration

Name Description Value
inboundNatRules De binnenkomende NAT-regels InboundNatRule[]

WeekDetails

Name Description Value
time Het tijdstip van de dag waarop de planning plaatsvindt. string
weekdays De dagen van de week waarvoor de planning is ingesteld (bijvoorbeeld zondag, maandag, dinsdag, enzovoort). string[]

Gebruiksvoorbeelden

Terraform-monsters

Een eenvoudig voorbeeld van het implementeren van Virtual Machine binnen een Dev Test Lab.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

variable "vm_password" {
  type        = string
  description = "The password for the DevTest Lab virtual machine"
  sensitive   = true
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "lab" {
  type      = "Microsoft.DevTestLab/labs@2018-09-15"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      labStorageType = "Premium"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

data "azapi_resource_id" "virtualNetwork" {
  type      = "Microsoft.Network/virtualNetworks@2023-04-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
}

data "azapi_resource_id" "subnet" {
  type      = "Microsoft.Network/virtualNetworks/subnets@2023-04-01"
  parent_id = data.azapi_resource_id.virtualNetwork.id
  name      = "${var.resource_name}Subnet"
}

resource "azapi_resource" "virtualNetwork" {
  type      = "Microsoft.DevTestLab/labs/virtualNetworks@2018-09-15"
  parent_id = azapi_resource.lab.id
  name      = var.resource_name
  body = {
    properties = {
      description = ""
      subnetOverrides = [
        {
          labSubnetName                = data.azapi_resource_id.subnet.name
          resourceId                   = data.azapi_resource_id.subnet.id
          useInVmCreationPermission    = "Allow"
          usePublicIpAddressPermission = "Allow"
        },
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "virtualMachine" {
  type      = "Microsoft.DevTestLab/labs/virtualMachines@2018-09-15"
  parent_id = azapi_resource.lab.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      allowClaim              = true
      disallowPublicIpAddress = false
      galleryImageReference = {
        offer     = "WindowsServer"
        osType    = "Windows"
        publisher = "MicrosoftWindowsServer"
        sku       = "2012-Datacenter"
        version   = "latest"
      }
      isAuthenticationWithSshKey = false
      labSubnetName              = data.azapi_resource_id.subnet.name
      labVirtualNetworkId        = azapi_resource.virtualNetwork.id
      networkInterface = {
      }
      notes       = ""
      osType      = "Windows"
      password    = var.vm_password
      size        = "Standard_F2"
      storageType = "Standard"
      userName    = "acct5stU5er"
    }
  }
  ignore_casing             = true
  schema_validation_enabled = false
  response_export_values    = ["*"]
}
  • Last updated on