Lezen in het Engels

Delen via

Microsoft.DevTestLab labs/virtualmachines 2018-09-15

  • Artikel
Een implementatietaal kiezen

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

ArtifactInstallProperties

Naam Beschrijving Waarde
artifactId De id van het artefact. snaar
artifactTitle De titel van het artefact. snaar
deploymentStatusMessage Het statusbericht van de implementatie. snaar
installTime Het tijdstip waarop het artefact wordt geïnstalleerd op de virtuele machine. snaar
Parameters De parameters van het artefact. ArtifactParameterProperties[]
status De status van het artefact. snaar
vmExtensionStatusMessage Het statusbericht van de extensie van de virtuele machine. snaar

ArtifactParameterProperties

Naam Beschrijving Waarde
naam De naam van de artefactparameter. snaar
waarde De waarde van de artefactparameter. snaar

AttachNewDataDiskOptions

Naam Beschrijving Waarde
diskName De naam van de schijf die moet worden gekoppeld. snaar
diskSizeGiB Grootte van de schijf die moet worden gekoppeld in Gibibytes. Int
diskType Het opslagtype voor de schijf (bijvoorbeeld Standard, Premium). 'Premium'
'Standaard'
'StandardSSD'

DataDiskProperties

Naam Beschrijving Waarde
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. snaar
hostCaching Cacheoptie voor een gegevensschijf (bijvoorbeeld Geen, ReadOnly, ReadWrite). 'Geen'
'ReadOnly'
'ReadWrite'

DayDetails

Naam Beschrijving Waarde
Tijd Het tijdstip waarop de planning plaatsvindt. snaar

GalleryImageReference

Naam Beschrijving Waarde
aanbieden De aanbieding van de galerieafbeelding. snaar
osType Het type besturingssysteem van de galerie-installatiekopie. snaar
uitgever De uitgever van de galerie-installatiekopieën. snaar
Sku De SKU van de galerie-installatiekopieën. snaar
Versie De versie van de galerie-installatiekopieën. snaar

HourDetails

Naam Beschrijving Waarde
minuut Minuten van het uur dat de planning wordt uitgevoerd. Int

InboundNatRule

Naam Beschrijving Waarde
backendPort De poort waarnaar het externe verkeer wordt omgeleid. Int
front-endPort 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

Naam Beschrijving Waarde
allowClaim Geeft aan of een andere gebruiker eigenaar kan worden van de virtuele machine Bool
Artefacten De artefacten die op de virtuele machine moeten worden geïnstalleerd. ArtifactInstallProperties[]
createdDate De aanmaakdatum van de virtuele machine. snaar
customImageId De aangepaste installatiekopieën-id van de virtuele machine. snaar
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. snaar
expirationDate De vervaldatum voor de VIRTUELE machine. snaar
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. snaar
labVirtualNetworkId De id van het virtuele labnetwerk van de virtuele machine. snaar
networkInterface De eigenschappen van de netwerkinterface. NetworkInterfaceProperties-
Notities De notities van de virtuele machine. snaar
ownerObjectId De object-id van de eigenaar van de virtuele machine. snaar
ownerUserPrincipalName De principal-naam van de gebruiker van de eigenaar van de virtuele machine. snaar
wachtwoord Het wachtwoord van de beheerder van de virtuele machine. snaar

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
planId De id van het plan dat is gekoppeld aan de installatiekopieën van de virtuele machine snaar
scheduleParameters Planningen voor virtuele machines die moeten worden gemaakt ScheduleCreationParameter[]
grootte De grootte van de virtuele machine. snaar
sshKey De SSH-sleutel van de beheerder van de virtuele machine. snaar

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
storageType Opslagtype dat moet worden gebruikt voor virtuele machine (bijvoorbeeld Standard, Premium). snaar
userName De gebruikersnaam van de virtuele machine. snaar

Microsoft.DevTestLab/labs/virtualmachines

Naam Beschrijving Waarde
plaats De locatie van de resource. snaar
naam De resourcenaam tekenreeks (vereist)
ouder 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
Eigenschappen De eigenschappen van de resource. LabVirtualMachineProperties (vereist)
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen

NetworkInterfaceProperties

Naam Beschrijving Waarde
dnsName De DNS-naam. snaar
privateIpAddress Het privé-IP-adres. snaar
publicIpAddress Het openbare IP-adres. snaar
publicIpAddressId De resource-id van het openbare IP-adres. snaar
rdpAuthority De eigenschap RdpAuthority is een DNS-hostnaam of IP-adres van de server, gevolgd door het servicepoortnummer voor RDP (Remote Desktop Protocol). snaar
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. snaar
subnetId De resource-id van het subnet. snaar
virtualNetworkId De resource-id van het virtuele netwerk. snaar

NotificationSettings

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

ResourceTags

Naam Beschrijving Waarde

ScheduleCreationParameter

Naam Beschrijving Waarde
naam De naam van de virtuele machine of omgeving snaar
Eigenschappen De eigenschappen van de planning. ScheduleCreationParameterProperties-
Tags De tags van de resource. ScheduleCreationParameterTags

ScheduleCreationParameterProperties

Naam Beschrijving Waarde
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 Meldingsinstellingen. NotificationSettings-
status De status van het schema (bijvoorbeeld Ingeschakeld, Uitgeschakeld) 'Uitgeschakeld'
'Ingeschakeld'
targetResourceId De resource-id waartoe de planning behoort snaar
taskType Het taaktype van de planning (bijvoorbeeld LabVmsShutdownTask, LabVmAutoStart). snaar
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) snaar
weeklyRecurrence Als de planning slechts enkele dagen van de week plaatsvindt, geeft u het wekelijkse terugkeerpatroon op. WeekDetails

ScheduleCreationParameterTags

Naam Beschrijving Waarde

SharedPublicIpAddressConfiguration

Naam Beschrijving Waarde
inboundNatRules De binnenkomende NAT-regels InboundNatRule[]

Weekdetails

Naam Beschrijving Waarde
Tijd Het tijdstip van de dag waarop de planning plaatsvindt. snaar
Weekdagen De dagen van de week waarvoor de planning is ingesteld (bijvoorbeeld zondag, maandag, dinsdag, enzovoort). tekenreeks[]

Gebruiksvoorbeelden

Azure-snelstartvoorbeelden

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

Bicep-bestand Beschrijving
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

ArtifactInstallProperties

Naam Beschrijving Waarde
artifactId De id van het artefact. snaar
artifactTitle De titel van het artefact. snaar
deploymentStatusMessage Het statusbericht van de implementatie. snaar
installTime Het tijdstip waarop het artefact wordt geïnstalleerd op de virtuele machine. snaar
Parameters De parameters van het artefact. ArtifactParameterProperties[]
status De status van het artefact. snaar
vmExtensionStatusMessage Het statusbericht van de extensie van de virtuele machine. snaar

ArtifactParameterProperties

Naam Beschrijving Waarde
naam De naam van de artefactparameter. snaar
waarde De waarde van de artefactparameter. snaar

AttachNewDataDiskOptions

Naam Beschrijving Waarde
diskName De naam van de schijf die moet worden gekoppeld. snaar
diskSizeGiB Grootte van de schijf die moet worden gekoppeld in Gibibytes. Int
diskType Het opslagtype voor de schijf (bijvoorbeeld Standard, Premium). 'Premium'
'Standaard'
'StandardSSD'

DataDiskProperties

Naam Beschrijving Waarde
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. snaar
hostCaching Cacheoptie voor een gegevensschijf (bijvoorbeeld Geen, ReadOnly, ReadWrite). 'Geen'
'ReadOnly'
'ReadWrite'

DayDetails

Naam Beschrijving Waarde
Tijd Het tijdstip waarop de planning plaatsvindt. snaar

GalleryImageReference

Naam Beschrijving Waarde
aanbieden De aanbieding van de galerieafbeelding. snaar
osType Het type besturingssysteem van de galerie-installatiekopie. snaar
uitgever De uitgever van de galerie-installatiekopieën. snaar
Sku De SKU van de galerie-installatiekopieën. snaar
Versie De versie van de galerie-installatiekopieën. snaar

HourDetails

Naam Beschrijving Waarde
minuut Minuten van het uur dat de planning wordt uitgevoerd. Int

InboundNatRule

Naam Beschrijving Waarde
backendPort De poort waarnaar het externe verkeer wordt omgeleid. Int
front-endPort 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

Naam Beschrijving Waarde
allowClaim Geeft aan of een andere gebruiker eigenaar kan worden van de virtuele machine Bool
Artefacten De artefacten die op de virtuele machine moeten worden geïnstalleerd. ArtifactInstallProperties[]
createdDate De aanmaakdatum van de virtuele machine. snaar
customImageId De aangepaste installatiekopieën-id van de virtuele machine. snaar
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. snaar
expirationDate De vervaldatum voor de VIRTUELE machine. snaar
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. snaar
labVirtualNetworkId De id van het virtuele labnetwerk van de virtuele machine. snaar
networkInterface De eigenschappen van de netwerkinterface. NetworkInterfaceProperties-
Notities De notities van de virtuele machine. snaar
ownerObjectId De object-id van de eigenaar van de virtuele machine. snaar
ownerUserPrincipalName De principal-naam van de gebruiker van de eigenaar van de virtuele machine. snaar
wachtwoord Het wachtwoord van de beheerder van de virtuele machine. snaar

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
planId De id van het plan dat is gekoppeld aan de installatiekopieën van de virtuele machine snaar
scheduleParameters Planningen voor virtuele machines die moeten worden gemaakt ScheduleCreationParameter[]
grootte De grootte van de virtuele machine. snaar
sshKey De SSH-sleutel van de beheerder van de virtuele machine. snaar

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
storageType Opslagtype dat moet worden gebruikt voor virtuele machine (bijvoorbeeld Standard, Premium). snaar
userName De gebruikersnaam van de virtuele machine. snaar

Microsoft.DevTestLab/labs/virtualmachines

Naam Beschrijving Waarde
apiVersion De API-versie '2018-09-15'
plaats De locatie van de resource. snaar
naam De resourcenaam tekenreeks (vereist)
Eigenschappen De eigenschappen van de resource. LabVirtualMachineProperties (vereist)
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen
type Het resourcetype 'Microsoft.DevTestLab/labs/virtualmachines'

NetworkInterfaceProperties

Naam Beschrijving Waarde
dnsName De DNS-naam. snaar
privateIpAddress Het privé-IP-adres. snaar
publicIpAddress Het openbare IP-adres. snaar
publicIpAddressId De resource-id van het openbare IP-adres. snaar
rdpAuthority De eigenschap RdpAuthority is een DNS-hostnaam of IP-adres van de server, gevolgd door het servicepoortnummer voor RDP (Remote Desktop Protocol). snaar
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. snaar
subnetId De resource-id van het subnet. snaar
virtualNetworkId De resource-id van het virtuele netwerk. snaar

NotificationSettings

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

ResourceTags

Naam Beschrijving Waarde

ScheduleCreationParameter

Naam Beschrijving Waarde
naam De naam van de virtuele machine of omgeving snaar
Eigenschappen De eigenschappen van de planning. ScheduleCreationParameterProperties-
Tags De tags van de resource. ScheduleCreationParameterTags

ScheduleCreationParameterProperties

Naam Beschrijving Waarde
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 Meldingsinstellingen. NotificationSettings-
status De status van het schema (bijvoorbeeld Ingeschakeld, Uitgeschakeld) 'Uitgeschakeld'
'Ingeschakeld'
targetResourceId De resource-id waartoe de planning behoort snaar
taskType Het taaktype van de planning (bijvoorbeeld LabVmsShutdownTask, LabVmAutoStart). snaar
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) snaar
weeklyRecurrence Als de planning slechts enkele dagen van de week plaatsvindt, geeft u het wekelijkse terugkeerpatroon op. WeekDetails

ScheduleCreationParameterTags

Naam Beschrijving Waarde

SharedPublicIpAddressConfiguration

Naam Beschrijving Waarde
inboundNatRules De binnenkomende NAT-regels InboundNatRule[]

Weekdetails

Naam Beschrijving Waarde
Tijd Het tijdstip van de dag waarop de planning plaatsvindt. snaar
Weekdagen De dagen van de week waarvoor de planning is ingesteld (bijvoorbeeld zondag, maandag, dinsdag, enzovoort). tekenreeks[]

Gebruiksvoorbeelden

Azure-snelstartsjablonen

De volgende Azure-quickstartsjablonen dit resourcetype implementeren.

Sjabloon Beschrijving
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"
  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

ArtifactInstallProperties

Naam Beschrijving Waarde
artifactId De id van het artefact. snaar
artifactTitle De titel van het artefact. snaar
deploymentStatusMessage Het statusbericht van de implementatie. snaar
installTime Het tijdstip waarop het artefact wordt geïnstalleerd op de virtuele machine. snaar
Parameters De parameters van het artefact. ArtifactParameterProperties[]
status De status van het artefact. snaar
vmExtensionStatusMessage Het statusbericht van de extensie van de virtuele machine. snaar

ArtifactParameterProperties

Naam Beschrijving Waarde
naam De naam van de artefactparameter. snaar
waarde De waarde van de artefactparameter. snaar

AttachNewDataDiskOptions

Naam Beschrijving Waarde
diskName De naam van de schijf die moet worden gekoppeld. snaar
diskSizeGiB Grootte van de schijf die moet worden gekoppeld in Gibibytes. Int
diskType Het opslagtype voor de schijf (bijvoorbeeld Standard, Premium). 'Premium'
'Standaard'
'StandardSSD'

DataDiskProperties

Naam Beschrijving Waarde
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. snaar
hostCaching Cacheoptie voor een gegevensschijf (bijvoorbeeld Geen, ReadOnly, ReadWrite). 'Geen'
'ReadOnly'
'ReadWrite'

DayDetails

Naam Beschrijving Waarde
Tijd Het tijdstip waarop de planning plaatsvindt. snaar

GalleryImageReference

Naam Beschrijving Waarde
aanbieden De aanbieding van de galerieafbeelding. snaar
osType Het type besturingssysteem van de galerie-installatiekopie. snaar
uitgever De uitgever van de galerie-installatiekopieën. snaar
Sku De SKU van de galerie-installatiekopieën. snaar
Versie De versie van de galerie-installatiekopieën. snaar

HourDetails

Naam Beschrijving Waarde
minuut Minuten van het uur dat de planning wordt uitgevoerd. Int

InboundNatRule

Naam Beschrijving Waarde
backendPort De poort waarnaar het externe verkeer wordt omgeleid. Int
front-endPort 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

Naam Beschrijving Waarde
allowClaim Geeft aan of een andere gebruiker eigenaar kan worden van de virtuele machine Bool
Artefacten De artefacten die op de virtuele machine moeten worden geïnstalleerd. ArtifactInstallProperties[]
createdDate De aanmaakdatum van de virtuele machine. snaar
customImageId De aangepaste installatiekopieën-id van de virtuele machine. snaar
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. snaar
expirationDate De vervaldatum voor de VIRTUELE machine. snaar
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. snaar
labVirtualNetworkId De id van het virtuele labnetwerk van de virtuele machine. snaar
networkInterface De eigenschappen van de netwerkinterface. NetworkInterfaceProperties-
Notities De notities van de virtuele machine. snaar
ownerObjectId De object-id van de eigenaar van de virtuele machine. snaar
ownerUserPrincipalName De principal-naam van de gebruiker van de eigenaar van de virtuele machine. snaar
wachtwoord Het wachtwoord van de beheerder van de virtuele machine. snaar

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
planId De id van het plan dat is gekoppeld aan de installatiekopieën van de virtuele machine snaar
scheduleParameters Planningen voor virtuele machines die moeten worden gemaakt ScheduleCreationParameter[]
grootte De grootte van de virtuele machine. snaar
sshKey De SSH-sleutel van de beheerder van de virtuele machine. snaar

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
storageType Opslagtype dat moet worden gebruikt voor virtuele machine (bijvoorbeeld Standard, Premium). snaar
userName De gebruikersnaam van de virtuele machine. snaar

Microsoft.DevTestLab/labs/virtualmachines

Naam Beschrijving Waarde
plaats De locatie van de resource. snaar
naam 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
Eigenschappen De eigenschappen van de resource. LabVirtualMachineProperties (vereist)
Tags Resourcetags Woordenlijst met tagnamen en -waarden.
type Het resourcetype "Microsoft.DevTestLab/labs/virtualmachines@2018-09-15"

NetworkInterfaceProperties

Naam Beschrijving Waarde
dnsName De DNS-naam. snaar
privateIpAddress Het privé-IP-adres. snaar
publicIpAddress Het openbare IP-adres. snaar
publicIpAddressId De resource-id van het openbare IP-adres. snaar
rdpAuthority De eigenschap RdpAuthority is een DNS-hostnaam of IP-adres van de server, gevolgd door het servicepoortnummer voor RDP (Remote Desktop Protocol). snaar
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. snaar
subnetId De resource-id van het subnet. snaar
virtualNetworkId De resource-id van het virtuele netwerk. snaar

NotificationSettings

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

ResourceTags

Naam Beschrijving Waarde

ScheduleCreationParameter

Naam Beschrijving Waarde
naam De naam van de virtuele machine of omgeving snaar
Eigenschappen De eigenschappen van de planning. ScheduleCreationParameterProperties-
Tags De tags van de resource. ScheduleCreationParameterTags

ScheduleCreationParameterProperties

Naam Beschrijving Waarde
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 Meldingsinstellingen. NotificationSettings-
status De status van het schema (bijvoorbeeld Ingeschakeld, Uitgeschakeld) 'Uitgeschakeld'
'Ingeschakeld'
targetResourceId De resource-id waartoe de planning behoort snaar
taskType Het taaktype van de planning (bijvoorbeeld LabVmsShutdownTask, LabVmAutoStart). snaar
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) snaar
weeklyRecurrence Als de planning slechts enkele dagen van de week plaatsvindt, geeft u het wekelijkse terugkeerpatroon op. WeekDetails

ScheduleCreationParameterTags

Naam Beschrijving Waarde

SharedPublicIpAddressConfiguration

Naam Beschrijving Waarde
inboundNatRules De binnenkomende NAT-regels InboundNatRule[]

Weekdetails

Naam Beschrijving Waarde
Tijd Het tijdstip van de dag waarop de planning plaatsvindt. snaar
Weekdagen De dagen van de week waarvoor de planning is ingesteld (bijvoorbeeld zondag, maandag, dinsdag, enzovoort). tekenreeks[]