Microsoft.DevTestLab labs/virtualmachines 2016-05-15

Bicep-resursdefinition

Resurstypen labs/virtualmachines kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DevTestLab/labs/virtualmachines-resurs lägger du till följande Bicep i mallen.

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'
  }
}

Egenskapsvärden

Microsoft.DevTestLab/labs/virtualmachines

Namn Beskrivning Värde
plats Platsen för resursen. sträng
Namn Resursnamnet sträng (krävs)
förälder I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.

Mer information finns i Underordnad resurs utanför den överordnade resursen.
Symboliskt namn för resurs av typen: labb
Egenskaper Egenskaperna för resursen. LabVirtualMachineProperties (krävs)
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar

Tillämpligt schema

Namn Beskrivning Värde
plats Platsen för resursen. sträng
Egenskaper Egenskaperna för resursen. ApplicableScheduleProperties (krävs)
Taggar Taggarna för resursen. Resurstaggar

ApplicableScheduleProperties (ApplicableScheduleProperties)

Namn Beskrivning Värde
labVmsShutdown Schemat för automatisk avstängning, om ett har angetts på labb- eller labbresursnivå. Schemalägg
labVmsStartup Schemat för automatisk start, om ett har angetts på labb- eller labbresursnivå. Schemalägg

ArtifactDeploymentStatusProperties (på engelska)

Namn Beskrivning Värde
artefakterTillämpad Det totala antalet artefakter som har tillämpats. Int
deploymentStatus Artefaktens distributionsstatus. sträng
totalArtifacts (totalt) Det totala antalet artefakter som tillämpades preliminärt. Int

ArtifactInstallProperties (på engelska)

Namn Beskrivning Värde
artifaktId Artefaktens identifierare. sträng
deploymentStatusMessage Statusmeddelandet från distributionen. sträng
installTime (på engelska) Den tid då artefakten börjar installeras på den virtuella datorn. sträng
Parametrar Artefaktens parametrar. ArtifactParameterProperties[]
tillstånd Artefaktens status. sträng
vmExtensionStatusMessage Statusmeddelandet från tillägget för den virtuella datorn. sträng

ArtifactParameterEgenskaper

Namn Beskrivning Värde
Namn Namnet på artefaktparametern. sträng
värde Värdet för artefaktparametern. sträng

ComputeDataDisk

Namn Beskrivning Värde
diskSizeGiB Hämtar datadiskstorlek i GiB. Int
diskUri När den backas upp av en blob, URI för underliggande blob. sträng
managedDiskId När den backas upp av en hanterad disk är detta ID för beräkningsdiskresursen. sträng
Namn Hämtar datadiskens namn. sträng

ComputeVmInstanceViewStatus

Namn Beskrivning Värde
kod Hämtar statuskoden. sträng
displayStatus Hämtar den korta localizable-etiketten för statusen. sträng
meddelande Hämtar meddelandet som är associerat med statusen. sträng

ComputeVmProperties

Namn Beskrivning Värde
dataDiskIds Hämtar blob-uri för datadiskar för den virtuella datorn. sträng[]
dataDiskar Hämtar alla datadiskar som är anslutna till den virtuella datorn. ComputeDataDisk[]
networkInterfaceId Hämtar nätverksgränssnitts-ID för den virtuella datorn. sträng
osDiskId Hämtar URI för OS-diskblob för den virtuella datorn. sträng
operativsystemtyp Hämtar operativsystemtypen för den virtuella datorn. sträng
Status Hämtar status för den virtuella datorn. ComputeVmInstanceViewStatus[]
VM-storlek Hämtar storleken på den virtuella datorn. sträng

DagDetaljer

Namn Beskrivning Värde
Tid Den tid på dagen som schemat inträffar. sträng

GalleryImageReference (på engelska)

Namn Beskrivning Värde
erbjudande Galleribildens erbjudande. sträng
operativsystemtyp Operativsystemets typ av galleriavbildning. sträng
förläggare Utgivaren av galleribilden. sträng
Sku SKU:n för galleribilden. sträng
version Versionen av galleribilden. sträng

HourDetaljer

Namn Beskrivning Värde
minut Minuter i timmen som schemat körs. Int

InboundNatRule (InkommandeNatRule)

Namn Beskrivning Värde
backendPort Porten som den externa trafiken ska omdirigeras till. Int
frontendPort Den externa slutpunktsporten för den inkommande anslutningen. Möjliga värden mellan 1 och 65535, inklusive. Om det är ospecificerat allokeras ett värde automatiskt. Int
transportProtocol Transportprotokollet för slutpunkten. "Tcp"
"Udp"

LabVirtualMachineProperties

Namn Beskrivning Värde
allowClaim (tillåta) Anger om en annan användare kan ta över ägarskapet för den virtuella datorn Bool
tillämpligtSchema Tillämpligt schema för den virtuella datorn. Tillämpligt schema
artifactDeploymentStatus Artefaktdistributionsstatus för den virtuella datorn. ArtifactDeploymentStatusEgenskaper
Artefakter Artefakterna som ska installeras på den virtuella datorn. ArtifactInstallProperties[]
computeVm Egenskaperna för den virtuella datorn för beräkning. ComputeVmProperties
createdByUser E-postadressen till skaparen av den virtuella datorn. sträng
createdByUserId Objektidentifieraren för skaparen av den virtuella datorn. sträng
skapadDatum Skapandedatumet för den virtuella datorn. sträng
customImageId Den virtuella datorns anpassade avbildningsidentifierare. sträng
inte tillåtaPublicIpAddress Anger om den virtuella datorn ska skapas utan en offentlig IP-adress. Bool
environmentId Resurs-ID för miljön som innehåller den här virtuella datorn, om det finns några. sträng
utgångsdatum Förfallodatumet för den virtuella datorn. sträng
Fqdn Det fullständigt kvalificerade domännamnet för den virtuella datorn. sträng
galleryImageReference Microsoft Azure Marketplace-avbildningsreferensen för den virtuella datorn. GalleryImageReference (på engelska)
isAuthenticationWithSshKey Anger om den här virtuella datorn använder en SSH-nyckel för autentisering. Bool
labSubnetName Labbundernätets namn på den virtuella datorn. sträng
labVirtualNetworkId Labbidentifieraren för det virtuella nätverket för den virtuella datorn. sträng
networkInterface (nätverk) Egenskaperna för nätverksgränssnittet. NetworkInterfaceProperties (på engelska)
Anteckningar Anteckningarna för den virtuella datorn. sträng
operativsystemtyp Operativsystemtypen för den virtuella datorn. sträng
ownerObjectId Objektidentifieraren för den virtuella datorns ägare. sträng
ownerUserPrincipalName Användarens huvudnamn för den virtuella datorns ägare. sträng
lösenord Lösenordet för administratören för den virtuella datorn. sträng
försörjningsstatus Resursens etableringsstatus. sträng
storlek Storleken på den virtuella datorn. sträng
sshKey (på engelska) SSH-nyckeln för den virtuella datoradministratören. sträng
storageType Lagringstyp som ska användas för virtuella datorer (t.ex. Standard, Premium). sträng
uniqueIdentifier (unik) Den unika oföränderliga identifieraren för en resurs (Guid). sträng
användarnamn Användarnamnet för den virtuella datorn. sträng
virtualMachineCreationSource Anger källan för skapandet av den virtuella labbdatorn. Endast utdataegenskap. "FromCustomImage"
"FromGalleryImage"

NetworkInterfaceProperties (på engelska)

Namn Beskrivning Värde
dns-namn DNS-namnet. sträng
privateIpAddress Den privata IP-adressen. sträng
publicIpAddress Den offentliga IP-adressen. sträng
publicIpAddressId Resurs-ID för den offentliga IP-adressen. sträng
rdpMyndighet Egenskapen RdpAuthority är ett DNS-värdnamn eller IP-adress för servern följt av tjänstportnumret för RDP (Remote Desktop Protocol). sträng
sharedPublicIpAddressConfiguration Konfigurationen för att dela en offentlig IP-adress mellan flera virtuella datorer. SharedPublicIpAddressConfiguration
sshMyndighet Egenskapen SshAuthority är ett SERVER DNS-värdnamn eller IP-adress följt av tjänstportnumret för SSH. sträng
subnetId Resurs-ID för undernätet. sträng
virtualNetworkId Resurs-ID för det virtuella nätverket. sträng

Inställningar för anmälan

Namn Beskrivning Värde
tillstånd Om meddelanden är aktiverade för det här schemat (dvs. Aktiverad, Inaktiverad). "Inaktiverad"
"Aktiverad"
timeInMinutes (på engelska) Tid i minuter före händelsen då meddelandet skickas. Int
webhookUrl Webhook-URL:en som meddelandet ska skickas till. sträng

Resurstaggar

Namn Beskrivning Värde

Resurstaggar

Namn Beskrivning Värde

Resurstaggar

Namn Beskrivning Värde

Schema

Namn Beskrivning Värde
plats Platsen för resursen. sträng
Egenskaper Egenskaperna för resursen. ScheduleProperties (krävs)
Taggar Taggarna för resursen. Resurstaggar

Schemalägg egenskaper

Namn Beskrivning Värde
dailyRecurrence Om schemat inträffar en gång varje dag i veckan anger du den dagliga upprepningen. DagDetaljer
hourlyRecurrence Om schemat inträffar flera gånger om dagen anger du upprepning varje timme. HourDetaljer
aviseringsinställningar Meddelandeinställningar. Inställningar för anmälan
försörjningsstatus Resursens etableringsstatus. sträng
tillstånd Status för schemat (dvs. Aktiverad, Inaktiverad) "Inaktiverad"
"Aktiverad"
målresursId Det resurs-ID som schemat tillhör sträng
uppgiftstyp Uppgiftstypen för schemat (t.ex. LabVmsShutdownTask, LabVmAutoStart). sträng
timeZoneId Tidszons-ID (t.ex. Pacific Standard-tid). sträng
uniqueIdentifier (unik) Den unika oföränderliga identifieraren för en resurs (Guid). sträng
veckovisÅterfall Om schemat bara inträffar några dagar i veckan anger du veckovis upprepning. VeckaDetaljer

SharedPublicIpAddressConfiguration

Namn Beskrivning Värde
inkommandeNatRules Inkommande NAT-regler InboundNatRule[]

VeckaDetaljer

Namn Beskrivning Värde
Tid Den tid på dagen som schemat inträffar. sträng
Vardagar De veckodagar som schemat anges för (t.ex. söndag, måndag, tisdag osv.). sträng[]

Användningsexempel

Bicep-exempel

Ett grundläggande exempel på hur du distribuerar en virtuell dator i ett utvecklings- och testlabb.

param resourceName string = 'acctest0001'
param location string = 'westeurope'
@secure()
@description('The password for the DevTest Lab virtual machine')
param vmPassword string

resource lab 'Microsoft.DevTestLab/labs@2018-09-15' = {
  name: resourceName
  location: location
  properties: {
    labStorageType: 'Premium'
  }
}

resource virtualMachine 'Microsoft.DevTestLab/labs/virtualMachines@2018-09-15' = {
  parent: lab
  name: resourceName
  location: location
  properties: {
    allowClaim: true
    disallowPublicIpAddress: false
    galleryImageReference: {
      offer: 'WindowsServer'
      osType: 'Windows'
      publisher: 'MicrosoftWindowsServer'
      sku: '2012-Datacenter'
      version: 'latest'
    }
    isAuthenticationWithSshKey: false
    labSubnetName: '\'${resourceName}Subnet\''
    labVirtualNetworkId: virtualNetwork.id
    networkInterface: {}
    notes: ''
    osType: 'Windows'
    password: null
    size: 'Standard_F2'
    storageType: 'Standard'
    userName: 'acct5stU5er'
  }
}

resource virtualNetwork 'Microsoft.DevTestLab/labs/virtualNetworks@2018-09-15' = {
  parent: lab
  name: resourceName
  properties: {
    description: ''
    subnetOverrides: [
      {
        labSubnetName: '\'${resourceName}Subnet\''
        resourceId: resourceId('Microsoft.Network/virtualNetworks/subnets', resourceName, '${resourceName}Subnet')
        useInVmCreationPermission: 'Allow'
        usePublicIpAddressPermission: 'Allow'
      }
    ]
  }
}

Azure-snabbstartsexempel

Följande Azure-snabbstartsmallar innehålla Bicep-exempel för distribution av den här resurstypen.

Bicep-fil Beskrivning
Skapar ett labb i Azure DevTest Labs med en påstådd vm- Den här mallen skapar en ny DevTest Lab/DTL-instans med en anspråksbaserad virtuell Windows Server 2019 Datacenter-dator i den. Fler Azure Resource Manager-snabbstartsmallar för Azure DevTest Labs finns på https://github.com/Azure/azure-devtestlab/tree/master/samples/DevTestLabs/QuickStartTemplates

Resursdefinition för ARM-mall

Resurstypen labs/virtualmachines kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DevTestLab/labs/virtualmachines-resurs lägger du till följande JSON i mallen.

{
  "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"
  }
}

Egenskapsvärden

Microsoft.DevTestLab/labs/virtualmachines

Namn Beskrivning Värde
apiVersion API-versionen '2016-05-15'
plats Platsen för resursen. sträng
Namn Resursnamnet sträng (krävs)
Egenskaper Egenskaperna för resursen. LabVirtualMachineProperties (krävs)
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar
typ Resurstypen "Microsoft.DevTestLab/labs/virtualmachines"

Tillämpligt schema

Namn Beskrivning Värde
plats Platsen för resursen. sträng
Egenskaper Egenskaperna för resursen. ApplicableScheduleProperties (krävs)
Taggar Taggarna för resursen. Resurstaggar

ApplicableScheduleProperties (ApplicableScheduleProperties)

Namn Beskrivning Värde
labVmsShutdown Schemat för automatisk avstängning, om ett har angetts på labb- eller labbresursnivå. Schemalägg
labVmsStartup Schemat för automatisk start, om ett har angetts på labb- eller labbresursnivå. Schemalägg

ArtifactDeploymentStatusProperties (på engelska)

Namn Beskrivning Värde
artefakterTillämpad Det totala antalet artefakter som har tillämpats. Int
deploymentStatus Artefaktens distributionsstatus. sträng
totalArtifacts (totalt) Det totala antalet artefakter som tillämpades preliminärt. Int

ArtifactInstallProperties (på engelska)

Namn Beskrivning Värde
artifaktId Artefaktens identifierare. sträng
deploymentStatusMessage Statusmeddelandet från distributionen. sträng
installTime (på engelska) Den tid då artefakten börjar installeras på den virtuella datorn. sträng
Parametrar Artefaktens parametrar. ArtifactParameterProperties[]
tillstånd Artefaktens status. sträng
vmExtensionStatusMessage Statusmeddelandet från tillägget för den virtuella datorn. sträng

ArtifactParameterEgenskaper

Namn Beskrivning Värde
Namn Namnet på artefaktparametern. sträng
värde Värdet för artefaktparametern. sträng

ComputeDataDisk

Namn Beskrivning Värde
diskSizeGiB Hämtar datadiskstorlek i GiB. Int
diskUri När den backas upp av en blob, URI för underliggande blob. sträng
managedDiskId När den backas upp av en hanterad disk är detta ID för beräkningsdiskresursen. sträng
Namn Hämtar datadiskens namn. sträng

ComputeVmInstanceViewStatus

Namn Beskrivning Värde
kod Hämtar statuskoden. sträng
displayStatus Hämtar den korta localizable-etiketten för statusen. sträng
meddelande Hämtar meddelandet som är associerat med statusen. sträng

ComputeVmProperties

Namn Beskrivning Värde
dataDiskIds Hämtar blob-uri för datadiskar för den virtuella datorn. sträng[]
dataDiskar Hämtar alla datadiskar som är anslutna till den virtuella datorn. ComputeDataDisk[]
networkInterfaceId Hämtar nätverksgränssnitts-ID för den virtuella datorn. sträng
osDiskId Hämtar URI för OS-diskblob för den virtuella datorn. sträng
operativsystemtyp Hämtar operativsystemtypen för den virtuella datorn. sträng
Status Hämtar status för den virtuella datorn. ComputeVmInstanceViewStatus[]
VM-storlek Hämtar storleken på den virtuella datorn. sträng

DagDetaljer

Namn Beskrivning Värde
Tid Den tid på dagen som schemat inträffar. sträng

GalleryImageReference (på engelska)

Namn Beskrivning Värde
erbjudande Galleribildens erbjudande. sträng
operativsystemtyp Operativsystemets typ av galleriavbildning. sträng
förläggare Utgivaren av galleribilden. sträng
Sku SKU:n för galleribilden. sträng
version Versionen av galleribilden. sträng

HourDetaljer

Namn Beskrivning Värde
minut Minuter i timmen som schemat körs. Int

InboundNatRule (InkommandeNatRule)

Namn Beskrivning Värde
backendPort Porten som den externa trafiken ska omdirigeras till. Int
frontendPort Den externa slutpunktsporten för den inkommande anslutningen. Möjliga värden mellan 1 och 65535, inklusive. Om det är ospecificerat allokeras ett värde automatiskt. Int
transportProtocol Transportprotokollet för slutpunkten. "Tcp"
"Udp"

LabVirtualMachineProperties

Namn Beskrivning Värde
allowClaim (tillåta) Anger om en annan användare kan ta över ägarskapet för den virtuella datorn Bool
tillämpligtSchema Tillämpligt schema för den virtuella datorn. Tillämpligt schema
artifactDeploymentStatus Artefaktdistributionsstatus för den virtuella datorn. ArtifactDeploymentStatusEgenskaper
Artefakter Artefakterna som ska installeras på den virtuella datorn. ArtifactInstallProperties[]
computeVm Egenskaperna för den virtuella datorn för beräkning. ComputeVmProperties
createdByUser E-postadressen till skaparen av den virtuella datorn. sträng
createdByUserId Objektidentifieraren för skaparen av den virtuella datorn. sträng
skapadDatum Skapandedatumet för den virtuella datorn. sträng
customImageId Den virtuella datorns anpassade avbildningsidentifierare. sträng
inte tillåtaPublicIpAddress Anger om den virtuella datorn ska skapas utan en offentlig IP-adress. Bool
environmentId Resurs-ID för miljön som innehåller den här virtuella datorn, om det finns några. sträng
utgångsdatum Förfallodatumet för den virtuella datorn. sträng
Fqdn Det fullständigt kvalificerade domännamnet för den virtuella datorn. sträng
galleryImageReference Microsoft Azure Marketplace-avbildningsreferensen för den virtuella datorn. GalleryImageReference (på engelska)
isAuthenticationWithSshKey Anger om den här virtuella datorn använder en SSH-nyckel för autentisering. Bool
labSubnetName Labbundernätets namn på den virtuella datorn. sträng
labVirtualNetworkId Labbidentifieraren för det virtuella nätverket för den virtuella datorn. sträng
networkInterface (nätverk) Egenskaperna för nätverksgränssnittet. NetworkInterfaceProperties (på engelska)
Anteckningar Anteckningarna för den virtuella datorn. sträng
operativsystemtyp Operativsystemtypen för den virtuella datorn. sträng
ownerObjectId Objektidentifieraren för den virtuella datorns ägare. sträng
ownerUserPrincipalName Användarens huvudnamn för den virtuella datorns ägare. sträng
lösenord Lösenordet för administratören för den virtuella datorn. sträng
försörjningsstatus Resursens etableringsstatus. sträng
storlek Storleken på den virtuella datorn. sträng
sshKey (på engelska) SSH-nyckeln för den virtuella datoradministratören. sträng
storageType Lagringstyp som ska användas för virtuella datorer (t.ex. Standard, Premium). sträng
uniqueIdentifier (unik) Den unika oföränderliga identifieraren för en resurs (Guid). sträng
användarnamn Användarnamnet för den virtuella datorn. sträng
virtualMachineCreationSource Anger källan för skapandet av den virtuella labbdatorn. Endast utdataegenskap. "FromCustomImage"
"FromGalleryImage"

NetworkInterfaceProperties (på engelska)

Namn Beskrivning Värde
dns-namn DNS-namnet. sträng
privateIpAddress Den privata IP-adressen. sträng
publicIpAddress Den offentliga IP-adressen. sträng
publicIpAddressId Resurs-ID för den offentliga IP-adressen. sträng
rdpMyndighet Egenskapen RdpAuthority är ett DNS-värdnamn eller IP-adress för servern följt av tjänstportnumret för RDP (Remote Desktop Protocol). sträng
sharedPublicIpAddressConfiguration Konfigurationen för att dela en offentlig IP-adress mellan flera virtuella datorer. SharedPublicIpAddressConfiguration
sshMyndighet Egenskapen SshAuthority är ett SERVER DNS-värdnamn eller IP-adress följt av tjänstportnumret för SSH. sträng
subnetId Resurs-ID för undernätet. sträng
virtualNetworkId Resurs-ID för det virtuella nätverket. sträng

Inställningar för anmälan

Namn Beskrivning Värde
tillstånd Om meddelanden är aktiverade för det här schemat (dvs. Aktiverad, Inaktiverad). "Inaktiverad"
"Aktiverad"
timeInMinutes (på engelska) Tid i minuter före händelsen då meddelandet skickas. Int
webhookUrl Webhook-URL:en som meddelandet ska skickas till. sträng

Resurstaggar

Namn Beskrivning Värde

Resurstaggar

Namn Beskrivning Värde

Resurstaggar

Namn Beskrivning Värde

Schema

Namn Beskrivning Värde
plats Platsen för resursen. sträng
Egenskaper Egenskaperna för resursen. ScheduleProperties (krävs)
Taggar Taggarna för resursen. Resurstaggar

Schemalägg egenskaper

Namn Beskrivning Värde
dailyRecurrence Om schemat inträffar en gång varje dag i veckan anger du den dagliga upprepningen. DagDetaljer
hourlyRecurrence Om schemat inträffar flera gånger om dagen anger du upprepning varje timme. HourDetaljer
aviseringsinställningar Meddelandeinställningar. Inställningar för anmälan
försörjningsstatus Resursens etableringsstatus. sträng
tillstånd Status för schemat (dvs. Aktiverad, Inaktiverad) "Inaktiverad"
"Aktiverad"
målresursId Det resurs-ID som schemat tillhör sträng
uppgiftstyp Uppgiftstypen för schemat (t.ex. LabVmsShutdownTask, LabVmAutoStart). sträng
timeZoneId Tidszons-ID (t.ex. Pacific Standard-tid). sträng
uniqueIdentifier (unik) Den unika oföränderliga identifieraren för en resurs (Guid). sträng
veckovisÅterfall Om schemat bara inträffar några dagar i veckan anger du veckovis upprepning. VeckaDetaljer

SharedPublicIpAddressConfiguration

Namn Beskrivning Värde
inkommandeNatRules Inkommande NAT-regler InboundNatRule[]

VeckaDetaljer

Namn Beskrivning Värde
Tid Den tid på dagen som schemat inträffar. sträng
Vardagar De veckodagar som schemat anges för (t.ex. söndag, måndag, tisdag osv.). sträng[]

Användningsexempel

Azure-snabbstartsmallar

Följande Azure-snabbstartsmallar distribuera den här resurstypen.

Mall Beskrivning
Skapar ett labb i Azure DevTest Labs med en påstådd vm-

Distribuera till Azure
Den här mallen skapar en ny DevTest Lab/DTL-instans med en anspråksbaserad virtuell Windows Server 2019 Datacenter-dator i den. Fler Azure Resource Manager-snabbstartsmallar för Azure DevTest Labs finns på https://github.com/Azure/azure-devtestlab/tree/master/samples/DevTestLabs/QuickStartTemplates

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen labs/virtualmachines kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DevTestLab/labs/virtualmachines-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DevTestLab/labs/virtualmachines@2016-05-15"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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"
    }
  }
}

Egenskapsvärden

Microsoft.DevTestLab/labs/virtualmachines

Namn Beskrivning Värde
plats Platsen för resursen. sträng
Namn Resursnamnet sträng (krävs)
föräldra_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: labb
Egenskaper Egenskaperna för resursen. LabVirtualMachineProperties (krävs)
Taggar Resurstaggar Ordlista med taggnamn och värden.
typ Resurstypen "Microsoft.DevTestLab/labs/virtualmachines@2016-05-15"

Tillämpligt schema

Namn Beskrivning Värde
plats Platsen för resursen. sträng
Egenskaper Egenskaperna för resursen. ApplicableScheduleProperties (krävs)
Taggar Taggarna för resursen. Resurstaggar

ApplicableScheduleProperties (ApplicableScheduleProperties)

Namn Beskrivning Värde
labVmsShutdown Schemat för automatisk avstängning, om ett har angetts på labb- eller labbresursnivå. Schemalägg
labVmsStartup Schemat för automatisk start, om ett har angetts på labb- eller labbresursnivå. Schemalägg

ArtifactDeploymentStatusProperties (på engelska)

Namn Beskrivning Värde
artefakterTillämpad Det totala antalet artefakter som har tillämpats. Int
deploymentStatus Artefaktens distributionsstatus. sträng
totalArtifacts (totalt) Det totala antalet artefakter som tillämpades preliminärt. Int

ArtifactInstallProperties (på engelska)

Namn Beskrivning Värde
artifaktId Artefaktens identifierare. sträng
deploymentStatusMessage Statusmeddelandet från distributionen. sträng
installTime (på engelska) Den tid då artefakten börjar installeras på den virtuella datorn. sträng
Parametrar Artefaktens parametrar. ArtifactParameterProperties[]
tillstånd Artefaktens status. sträng
vmExtensionStatusMessage Statusmeddelandet från tillägget för den virtuella datorn. sträng

ArtifactParameterEgenskaper

Namn Beskrivning Värde
Namn Namnet på artefaktparametern. sträng
värde Värdet för artefaktparametern. sträng

ComputeDataDisk

Namn Beskrivning Värde
diskSizeGiB Hämtar datadiskstorlek i GiB. Int
diskUri När den backas upp av en blob, URI för underliggande blob. sträng
managedDiskId När den backas upp av en hanterad disk är detta ID för beräkningsdiskresursen. sträng
Namn Hämtar datadiskens namn. sträng

ComputeVmInstanceViewStatus

Namn Beskrivning Värde
kod Hämtar statuskoden. sträng
displayStatus Hämtar den korta localizable-etiketten för statusen. sträng
meddelande Hämtar meddelandet som är associerat med statusen. sträng

ComputeVmProperties

Namn Beskrivning Värde
dataDiskIds Hämtar blob-uri för datadiskar för den virtuella datorn. sträng[]
dataDiskar Hämtar alla datadiskar som är anslutna till den virtuella datorn. ComputeDataDisk[]
networkInterfaceId Hämtar nätverksgränssnitts-ID för den virtuella datorn. sträng
osDiskId Hämtar URI för OS-diskblob för den virtuella datorn. sträng
operativsystemtyp Hämtar operativsystemtypen för den virtuella datorn. sträng
Status Hämtar status för den virtuella datorn. ComputeVmInstanceViewStatus[]
VM-storlek Hämtar storleken på den virtuella datorn. sträng

DagDetaljer

Namn Beskrivning Värde
Tid Den tid på dagen som schemat inträffar. sträng

GalleryImageReference (på engelska)

Namn Beskrivning Värde
erbjudande Galleribildens erbjudande. sträng
operativsystemtyp Operativsystemets typ av galleriavbildning. sträng
förläggare Utgivaren av galleribilden. sträng
Sku SKU:n för galleribilden. sträng
version Versionen av galleribilden. sträng

HourDetaljer

Namn Beskrivning Värde
minut Minuter i timmen som schemat körs. Int

InboundNatRule (InkommandeNatRule)

Namn Beskrivning Värde
backendPort Porten som den externa trafiken ska omdirigeras till. Int
frontendPort Den externa slutpunktsporten för den inkommande anslutningen. Möjliga värden mellan 1 och 65535, inklusive. Om det är ospecificerat allokeras ett värde automatiskt. Int
transportProtocol Transportprotokollet för slutpunkten. "Tcp"
"Udp"

LabVirtualMachineProperties

Namn Beskrivning Värde
allowClaim (tillåta) Anger om en annan användare kan ta över ägarskapet för den virtuella datorn Bool
tillämpligtSchema Tillämpligt schema för den virtuella datorn. Tillämpligt schema
artifactDeploymentStatus Artefaktdistributionsstatus för den virtuella datorn. ArtifactDeploymentStatusEgenskaper
Artefakter Artefakterna som ska installeras på den virtuella datorn. ArtifactInstallProperties[]
computeVm Egenskaperna för den virtuella datorn för beräkning. ComputeVmProperties
createdByUser E-postadressen till skaparen av den virtuella datorn. sträng
createdByUserId Objektidentifieraren för skaparen av den virtuella datorn. sträng
skapadDatum Skapandedatumet för den virtuella datorn. sträng
customImageId Den virtuella datorns anpassade avbildningsidentifierare. sträng
inte tillåtaPublicIpAddress Anger om den virtuella datorn ska skapas utan en offentlig IP-adress. Bool
environmentId Resurs-ID för miljön som innehåller den här virtuella datorn, om det finns några. sträng
utgångsdatum Förfallodatumet för den virtuella datorn. sträng
Fqdn Det fullständigt kvalificerade domännamnet för den virtuella datorn. sträng
galleryImageReference Microsoft Azure Marketplace-avbildningsreferensen för den virtuella datorn. GalleryImageReference (på engelska)
isAuthenticationWithSshKey Anger om den här virtuella datorn använder en SSH-nyckel för autentisering. Bool
labSubnetName Labbundernätets namn på den virtuella datorn. sträng
labVirtualNetworkId Labbidentifieraren för det virtuella nätverket för den virtuella datorn. sträng
networkInterface (nätverk) Egenskaperna för nätverksgränssnittet. NetworkInterfaceProperties (på engelska)
Anteckningar Anteckningarna för den virtuella datorn. sträng
operativsystemtyp Operativsystemtypen för den virtuella datorn. sträng
ownerObjectId Objektidentifieraren för den virtuella datorns ägare. sträng
ownerUserPrincipalName Användarens huvudnamn för den virtuella datorns ägare. sträng
lösenord Lösenordet för administratören för den virtuella datorn. sträng
försörjningsstatus Resursens etableringsstatus. sträng
storlek Storleken på den virtuella datorn. sträng
sshKey (på engelska) SSH-nyckeln för den virtuella datoradministratören. sträng
storageType Lagringstyp som ska användas för virtuella datorer (t.ex. Standard, Premium). sträng
uniqueIdentifier (unik) Den unika oföränderliga identifieraren för en resurs (Guid). sträng
användarnamn Användarnamnet för den virtuella datorn. sträng
virtualMachineCreationSource Anger källan för skapandet av den virtuella labbdatorn. Endast utdataegenskap. "FromCustomImage"
"FromGalleryImage"

NetworkInterfaceProperties (på engelska)

Namn Beskrivning Värde
dns-namn DNS-namnet. sträng
privateIpAddress Den privata IP-adressen. sträng
publicIpAddress Den offentliga IP-adressen. sträng
publicIpAddressId Resurs-ID för den offentliga IP-adressen. sträng
rdpMyndighet Egenskapen RdpAuthority är ett DNS-värdnamn eller IP-adress för servern följt av tjänstportnumret för RDP (Remote Desktop Protocol). sträng
sharedPublicIpAddressConfiguration Konfigurationen för att dela en offentlig IP-adress mellan flera virtuella datorer. SharedPublicIpAddressConfiguration
sshMyndighet Egenskapen SshAuthority är ett SERVER DNS-värdnamn eller IP-adress följt av tjänstportnumret för SSH. sträng
subnetId Resurs-ID för undernätet. sträng
virtualNetworkId Resurs-ID för det virtuella nätverket. sträng

Inställningar för anmälan

Namn Beskrivning Värde
tillstånd Om meddelanden är aktiverade för det här schemat (dvs. Aktiverad, Inaktiverad). "Inaktiverad"
"Aktiverad"
timeInMinutes (på engelska) Tid i minuter före händelsen då meddelandet skickas. Int
webhookUrl Webhook-URL:en som meddelandet ska skickas till. sträng

Resurstaggar

Namn Beskrivning Värde

Resurstaggar

Namn Beskrivning Värde

Resurstaggar

Namn Beskrivning Värde

Schema

Namn Beskrivning Värde
plats Platsen för resursen. sträng
Egenskaper Egenskaperna för resursen. ScheduleProperties (krävs)
Taggar Taggarna för resursen. Resurstaggar

Schemalägg egenskaper

Namn Beskrivning Värde
dailyRecurrence Om schemat inträffar en gång varje dag i veckan anger du den dagliga upprepningen. DagDetaljer
hourlyRecurrence Om schemat inträffar flera gånger om dagen anger du upprepning varje timme. HourDetaljer
aviseringsinställningar Meddelandeinställningar. Inställningar för anmälan
försörjningsstatus Resursens etableringsstatus. sträng
tillstånd Status för schemat (dvs. Aktiverad, Inaktiverad) "Inaktiverad"
"Aktiverad"
målresursId Det resurs-ID som schemat tillhör sträng
uppgiftstyp Uppgiftstypen för schemat (t.ex. LabVmsShutdownTask, LabVmAutoStart). sträng
timeZoneId Tidszons-ID (t.ex. Pacific Standard-tid). sträng
uniqueIdentifier (unik) Den unika oföränderliga identifieraren för en resurs (Guid). sträng
veckovisÅterfall Om schemat bara inträffar några dagar i veckan anger du veckovis upprepning. VeckaDetaljer

SharedPublicIpAddressConfiguration

Namn Beskrivning Värde
inkommandeNatRules Inkommande NAT-regler InboundNatRule[]

VeckaDetaljer

Namn Beskrivning Värde
Tid Den tid på dagen som schemat inträffar. sträng
Vardagar De veckodagar som schemat anges för (t.ex. söndag, måndag, tisdag osv.). sträng[]

Användningsexempel

Terraform-exempel

Ett grundläggande exempel på hur du distribuerar en virtuell dator i ett utvecklings- och testlabb.

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    = ["*"]
}