Udostępnij za pośrednictwem

Microsoft.DevTestLab labs/virtualmachines 2018-09-15

  • Artykuł

Definicja zasobu Bicep

Typ zasobu labs/virtualmachines można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DevTestLab/labs/virtualmachines, dodaj następujący kod Bicep do szablonu.

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

Wartości właściwości

ArtifactInstallProperties

Nazwa Opis Wartość
artifactId Identyfikator artefaktu. struna
artifactTitle Tytuł artefaktu. struna
deploymentStatusMessage Komunikat o stanie z wdrożenia. struna
installTime Czas rozpoczęcia instalacji artefaktu na maszynie wirtualnej. struna
Parametry Parametry artefaktu. ArtifactParameterProperties[]
stan Stan artefaktu. struna
vmExtensionStatusMessage Komunikat o stanie z rozszerzenia maszyny wirtualnej. struna

ArtifactParameterProperties

Nazwa Opis Wartość
nazwa Nazwa parametru artefaktu. struna
wartość Wartość parametru artefaktu. struna

AttachNewDataDiskOptions

Nazwa Opis Wartość
diskName Nazwa dysku do dołączenia. struna
diskSizeGiB Rozmiar dysku do dołączenia w gibibajtach. Int
diskType Typ magazynu dysku (tj. Standardowa, Premium). "Premium"
"Standardowa"
"StandardSSD"

DataDiskProperties

Nazwa Opis Wartość
attachNewDataDiskOptions Określa opcje dołączania nowego dysku do maszyny wirtualnej. AttachNewDataDiskOptions
existingLabDiskId Określa istniejący identyfikator dysku laboratorium, który ma zostać dołączony do maszyny wirtualnej. struna
hostCaching Opcja buforowania dysku danych (tj. Brak, ReadOnly, ReadWrite). "Brak"
"ReadOnly"
"ReadWrite"

DayDetails

Nazwa Opis Wartość
Godzina Godzina dnia, w ramach których zostanie zaplanowany harmonogram. struna

GalleryImageReference

Nazwa Opis Wartość
oferta Oferta obrazu galerii. struna
osType Typ systemu operacyjnego obrazu galerii. struna
wydawca Wydawca obrazu galerii. struna
Numer jednostki magazynowej Jednostka SKU obrazu galerii. struna
Wersja Wersja obrazu galerii. struna

HourDetails

Nazwa Opis Wartość
minuta Minuty godziny, w których zostanie uruchomiony harmonogram. Int

Ruch przychodzącyNatRule

Nazwa Opis Wartość
backendPort Port, do którego będzie przekierowywany ruch zewnętrzny. Int
frontonPort Zewnętrzny port punktu końcowego połączenia przychodzącego. Możliwy zakres wartości z zakresu od 1 do 65535 włącznie. Jeśli wartość nie zostanie określona, zostanie przydzielona automatycznie. Int
transportProtocol Protokół transportu dla punktu końcowego. "Tcp"
"Udp"

LabVirtualMachineProperties

Nazwa Opis Wartość
allowClaim Wskazuje, czy inny użytkownik może przejąć własność maszyny wirtualnej Bool
Artefakty Artefakty, które mają zostać zainstalowane na maszynie wirtualnej. ArtifactInstallProperties[]
createdDate Data utworzenia maszyny wirtualnej. struna
customImageId Identyfikator obrazu niestandardowego maszyny wirtualnej. struna
dataDiskParameters Nowe lub istniejące dyski danych do dołączenia do maszyny wirtualnej po utworzeniu DataDiskProperties[]
disallowPublicIpAddress Wskazuje, czy maszyna wirtualna ma zostać utworzona bez publicznego adresu IP. Bool
environmentId Identyfikator zasobu środowiska, który zawiera tę maszynę wirtualną, jeśli istnieje. struna
data wygaśnięcia Data wygaśnięcia maszyny wirtualnej. struna
galleryImageReference Dokumentacja obrazu witryny Microsoft Azure Marketplace maszyny wirtualnej. GalleryImageReference
isAuthenticationWithSshKey Wskazuje, czy ta maszyna wirtualna używa klucza SSH do uwierzytelniania. Bool
labSubnetName Nazwa podsieci laboratorium maszyny wirtualnej. struna
labVirtualNetworkId Identyfikator sieci wirtualnej laboratorium maszyny wirtualnej. struna
networkInterface Właściwości interfejsu sieciowego. NetworkInterfaceProperties
Notatki Uwagi dotyczące maszyny wirtualnej. struna
ownerObjectId Identyfikator obiektu właściciela maszyny wirtualnej. struna
ownerUserPrincipalName Główna nazwa użytkownika właściciela maszyny wirtualnej. struna
hasło Hasło administratora maszyny wirtualnej. struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr.
identyfikator planu Identyfikator planu skojarzonego z obrazem maszyny wirtualnej struna
scheduleParameters Harmonogramy tworzenia maszyn wirtualnych ScheduleCreationParameter[]
rozmiar Rozmiar maszyny wirtualnej. struna
sshKey Klucz SSH administratora maszyny wirtualnej. struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr.
storageType Typ magazynu do użycia dla maszyny wirtualnej (tj. Standardowa, Premium). struna
userName Nazwa użytkownika maszyny wirtualnej. struna

Microsoft.DevTestLab/labs/virtualmachines

Nazwa Opis Wartość
lokalizacja Lokalizacja zasobu. struna
nazwa Nazwa zasobu ciąg (wymagany)
rodzic W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.		 Nazwa symboliczna zasobu typu: labs
Właściwości Właściwości zasobu. LabVirtualMachineProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

NetworkInterfaceProperties

Nazwa Opis Wartość
dnsName Nazwa DNS. struna
privateIpAddress Prywatny adres IP. struna
publicIpAddress Publiczny adres IP. struna
publicIpAddressId Identyfikator zasobu publicznego adresu IP. struna
rdpAuthority Właściwość RdpAuthority jest nazwą hosta DNS serwera lub adresem IP, a następnie numerem portu usługi dla protokołu RDP (Remote Desktop Protocol). struna
sharedPublicIpAddressConfiguration Konfiguracja udostępniania publicznego adresu IP na wielu maszynach wirtualnych. SharedPublicIpAddressConfiguration
sshAuthority Właściwość SshAuthority jest nazwą hosta DNS serwera lub adresem IP, po którym następuje numer portu usługi dla protokołu SSH. struna
subnetId Identyfikator zasobu podsieci. struna
virtualNetworkId Identyfikator zasobu sieci wirtualnej. struna

NotificationSettings

Nazwa Opis Wartość
emailRecipient Adresat wiadomości e-mail do wysyłania powiadomień (może być listą adresów e-mail rozdzielonych średnikami). struna
notificationLocale Ustawienia regionalne do użycia podczas wysyłania powiadomienia (rezerwowe dla nieobsługiwanych języków to EN). struna
stan Jeśli powiadomienia są włączone dla tego harmonogramu (tj. Włączone, Wyłączone). "Wyłączone"
"Włączone"
timeInMinutes Czas w minutach przed zdarzeniem, w którym zostanie wysłane powiadomienie. Int
webhookUrl Adres URL elementu webhook, do którego zostanie wysłane powiadomienie. struna

Tagi zasobów

Nazwa Opis Wartość

ScheduleCreationParameter

Nazwa Opis Wartość
nazwa Nazwa maszyny wirtualnej lub środowiska struna
Właściwości Właściwości harmonogramu. ScheduleCreationParameterProperties
Tagi Tagi zasobu. ScheduleCreationParameterTags

ScheduleCreationParameterProperties

Nazwa Opis Wartość
dailyRecurrence Jeśli harmonogram będzie występować raz dziennie tygodnia, określ cykl dzienny. DayDetails
hourlyRecurrence Jeśli harmonogram będzie występować wiele razy dziennie, określ cykl godzinowy. HourDetails
notificationSettings Ustawienia powiadomień. NotificationSettings
stan Stan harmonogramu (tj. Włączone, Wyłączone) "Wyłączone"
"Włączone"
targetResourceId Identyfikator zasobu, do którego należy harmonogram struna
taskType Typ zadania harmonogramu (np. LabVmsShutdownTask, LabVmAutoStart). struna
timeZoneId Identyfikator strefy czasowej (np. Chiny (czas standardowy, Grenlandia (czas standardowy), Pacyfik (czas standardowy itp.). Możliwe wartości tej właściwości można znaleźć w IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) struna
weeklyRecurrence Jeśli harmonogram będzie występować tylko kilka dni tygodnia, określ cykl tygodniowy. WeekDetails

ScheduleCreationParameterTags

Nazwa Opis Wartość

SharedPublicIpAddressConfiguration

Nazwa Opis Wartość
inboundNatRules Przychodzące reguły NAT inboundNatRule[]

WeekDetails

Nazwa Opis Wartość
Godzina Godzina dnia, w ramach których zostanie zaplanowany harmonogram. struna
Dni powszednie Dni tygodnia, dla których zaplanowano harmonogram (np. niedziela, poniedziałek, wtorek itp.). string[]

Przykłady z przewodnika Szybki start

W poniższych przykładach szybkiego startu wdrożono ten typ zasobu.

Plik Bicep Opis
Tworzy laboratorium w usłudze Azure DevTest Labs z przejętą maszyną wirtualną Ten szablon tworzy nowe wystąpienie laboratorium DevTest Lab/DTL z maszyną wirtualną z systemem Windows Server 2019 Datacenter. Więcej szablonów szybkiego startu usługi Azure Resource Manager dla usługi Azure DevTest Labs dostępnych na stronie https://github.com/Azure/azure-devtestlab/tree/master/ARMTemplates

Definicja zasobu szablonu usługi ARM

Typ zasobu labs/virtualmachines można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DevTestLab/labs/virtualmachines, dodaj następujący kod JSON do szablonu.

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

Wartości właściwości

ArtifactInstallProperties

Nazwa Opis Wartość
artifactId Identyfikator artefaktu. struna
artifactTitle Tytuł artefaktu. struna
deploymentStatusMessage Komunikat o stanie z wdrożenia. struna
installTime Czas rozpoczęcia instalacji artefaktu na maszynie wirtualnej. struna
Parametry Parametry artefaktu. ArtifactParameterProperties[]
stan Stan artefaktu. struna
vmExtensionStatusMessage Komunikat o stanie z rozszerzenia maszyny wirtualnej. struna

ArtifactParameterProperties

Nazwa Opis Wartość
nazwa Nazwa parametru artefaktu. struna
wartość Wartość parametru artefaktu. struna

AttachNewDataDiskOptions

Nazwa Opis Wartość
diskName Nazwa dysku do dołączenia. struna
diskSizeGiB Rozmiar dysku do dołączenia w gibibajtach. Int
diskType Typ magazynu dysku (tj. Standardowa, Premium). "Premium"
"Standardowa"
"StandardSSD"

DataDiskProperties

Nazwa Opis Wartość
attachNewDataDiskOptions Określa opcje dołączania nowego dysku do maszyny wirtualnej. AttachNewDataDiskOptions
existingLabDiskId Określa istniejący identyfikator dysku laboratorium, który ma zostać dołączony do maszyny wirtualnej. struna
hostCaching Opcja buforowania dysku danych (tj. Brak, ReadOnly, ReadWrite). "Brak"
"ReadOnly"
"ReadWrite"

DayDetails

Nazwa Opis Wartość
Godzina Godzina dnia, w ramach których zostanie zaplanowany harmonogram. struna

GalleryImageReference

Nazwa Opis Wartość
oferta Oferta obrazu galerii. struna
osType Typ systemu operacyjnego obrazu galerii. struna
wydawca Wydawca obrazu galerii. struna
Numer jednostki magazynowej Jednostka SKU obrazu galerii. struna
Wersja Wersja obrazu galerii. struna

HourDetails

Nazwa Opis Wartość
minuta Minuty godziny, w których zostanie uruchomiony harmonogram. Int

Ruch przychodzącyNatRule

Nazwa Opis Wartość
backendPort Port, do którego będzie przekierowywany ruch zewnętrzny. Int
frontonPort Zewnętrzny port punktu końcowego połączenia przychodzącego. Możliwy zakres wartości z zakresu od 1 do 65535 włącznie. Jeśli wartość nie zostanie określona, zostanie przydzielona automatycznie. Int
transportProtocol Protokół transportu dla punktu końcowego. "Tcp"
"Udp"

LabVirtualMachineProperties

Nazwa Opis Wartość
allowClaim Wskazuje, czy inny użytkownik może przejąć własność maszyny wirtualnej Bool
Artefakty Artefakty, które mają zostać zainstalowane na maszynie wirtualnej. ArtifactInstallProperties[]
createdDate Data utworzenia maszyny wirtualnej. struna
customImageId Identyfikator obrazu niestandardowego maszyny wirtualnej. struna
dataDiskParameters Nowe lub istniejące dyski danych do dołączenia do maszyny wirtualnej po utworzeniu DataDiskProperties[]
disallowPublicIpAddress Wskazuje, czy maszyna wirtualna ma zostać utworzona bez publicznego adresu IP. Bool
environmentId Identyfikator zasobu środowiska, który zawiera tę maszynę wirtualną, jeśli istnieje. struna
data wygaśnięcia Data wygaśnięcia maszyny wirtualnej. struna
galleryImageReference Dokumentacja obrazu witryny Microsoft Azure Marketplace maszyny wirtualnej. GalleryImageReference
isAuthenticationWithSshKey Wskazuje, czy ta maszyna wirtualna używa klucza SSH do uwierzytelniania. Bool
labSubnetName Nazwa podsieci laboratorium maszyny wirtualnej. struna
labVirtualNetworkId Identyfikator sieci wirtualnej laboratorium maszyny wirtualnej. struna
networkInterface Właściwości interfejsu sieciowego. NetworkInterfaceProperties
Notatki Uwagi dotyczące maszyny wirtualnej. struna
ownerObjectId Identyfikator obiektu właściciela maszyny wirtualnej. struna
ownerUserPrincipalName Główna nazwa użytkownika właściciela maszyny wirtualnej. struna
hasło Hasło administratora maszyny wirtualnej. struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr.
identyfikator planu Identyfikator planu skojarzonego z obrazem maszyny wirtualnej struna
scheduleParameters Harmonogramy tworzenia maszyn wirtualnych ScheduleCreationParameter[]
rozmiar Rozmiar maszyny wirtualnej. struna
sshKey Klucz SSH administratora maszyny wirtualnej. struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr.
storageType Typ magazynu do użycia dla maszyny wirtualnej (tj. Standardowa, Premium). struna
userName Nazwa użytkownika maszyny wirtualnej. struna

Microsoft.DevTestLab/labs/virtualmachines

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2018-09-15'
lokalizacja Lokalizacja zasobu. struna
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości zasobu. LabVirtualMachineProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.DevTestLab/labs/virtualmachines"

NetworkInterfaceProperties

Nazwa Opis Wartość
dnsName Nazwa DNS. struna
privateIpAddress Prywatny adres IP. struna
publicIpAddress Publiczny adres IP. struna
publicIpAddressId Identyfikator zasobu publicznego adresu IP. struna
rdpAuthority Właściwość RdpAuthority jest nazwą hosta DNS serwera lub adresem IP, a następnie numerem portu usługi dla protokołu RDP (Remote Desktop Protocol). struna
sharedPublicIpAddressConfiguration Konfiguracja udostępniania publicznego adresu IP na wielu maszynach wirtualnych. SharedPublicIpAddressConfiguration
sshAuthority Właściwość SshAuthority jest nazwą hosta DNS serwera lub adresem IP, po którym następuje numer portu usługi dla protokołu SSH. struna
subnetId Identyfikator zasobu podsieci. struna
virtualNetworkId Identyfikator zasobu sieci wirtualnej. struna

NotificationSettings

Nazwa Opis Wartość
emailRecipient Adresat wiadomości e-mail do wysyłania powiadomień (może być listą adresów e-mail rozdzielonych średnikami). struna
notificationLocale Ustawienia regionalne do użycia podczas wysyłania powiadomienia (rezerwowe dla nieobsługiwanych języków to EN). struna
stan Jeśli powiadomienia są włączone dla tego harmonogramu (tj. Włączone, Wyłączone). "Wyłączone"
"Włączone"
timeInMinutes Czas w minutach przed zdarzeniem, w którym zostanie wysłane powiadomienie. Int
webhookUrl Adres URL elementu webhook, do którego zostanie wysłane powiadomienie. struna

Tagi zasobów

Nazwa Opis Wartość

ScheduleCreationParameter

Nazwa Opis Wartość
nazwa Nazwa maszyny wirtualnej lub środowiska struna
Właściwości Właściwości harmonogramu. ScheduleCreationParameterProperties
Tagi Tagi zasobu. ScheduleCreationParameterTags

ScheduleCreationParameterProperties

Nazwa Opis Wartość
dailyRecurrence Jeśli harmonogram będzie występować raz dziennie tygodnia, określ cykl dzienny. DayDetails
hourlyRecurrence Jeśli harmonogram będzie występować wiele razy dziennie, określ cykl godzinowy. HourDetails
notificationSettings Ustawienia powiadomień. NotificationSettings
stan Stan harmonogramu (tj. Włączone, Wyłączone) "Wyłączone"
"Włączone"
targetResourceId Identyfikator zasobu, do którego należy harmonogram struna
taskType Typ zadania harmonogramu (np. LabVmsShutdownTask, LabVmAutoStart). struna
timeZoneId Identyfikator strefy czasowej (np. Chiny (czas standardowy, Grenlandia (czas standardowy), Pacyfik (czas standardowy itp.). Możliwe wartości tej właściwości można znaleźć w IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) struna
weeklyRecurrence Jeśli harmonogram będzie występować tylko kilka dni tygodnia, określ cykl tygodniowy. WeekDetails

ScheduleCreationParameterTags

Nazwa Opis Wartość

SharedPublicIpAddressConfiguration

Nazwa Opis Wartość
inboundNatRules Przychodzące reguły NAT inboundNatRule[]

WeekDetails

Nazwa Opis Wartość
Godzina Godzina dnia, w ramach których zostanie zaplanowany harmonogram. struna
Dni powszednie Dni tygodnia, dla których zaplanowano harmonogram (np. niedziela, poniedziałek, wtorek itp.). string[]

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Szablon Opis
Tworzy laboratorium w usłudze Azure DevTest Labs z przejętą maszyną wirtualną

wdrażanie w usłudze Azure		 Ten szablon tworzy nowe wystąpienie laboratorium DevTest Lab/DTL z maszyną wirtualną z systemem Windows Server 2019 Datacenter. Więcej szablonów szybkiego startu usługi Azure Resource Manager dla usługi Azure DevTest Labs dostępnych na stronie https://github.com/Azure/azure-devtestlab/tree/master/ARMTemplates

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu labs/virtualmachines można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DevTestLab/labs/virtualmachines, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DevTestLab/labs/virtualmachines@2018-09-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      allowClaim = bool
      artifacts = [
        {
          artifactId = "string"
          artifactTitle = "string"
          deploymentStatusMessage = "string"
          installTime = "string"
          parameters = [
            {
              name = "string"
              value = "string"
            }
          ]
          status = "string"
          vmExtensionStatusMessage = "string"
        }
      ]
      createdDate = "string"
      customImageId = "string"
      dataDiskParameters = [
        {
          attachNewDataDiskOptions = {
            diskName = "string"
            diskSizeGiB = int
            diskType = "string"
          }
          existingLabDiskId = "string"
          hostCaching = "string"
        }
      ]
      disallowPublicIpAddress = bool
      environmentId = "string"
      expirationDate = "string"
      galleryImageReference = {
        offer = "string"
        osType = "string"
        publisher = "string"
        sku = "string"
        version = "string"
      }
      isAuthenticationWithSshKey = bool
      labSubnetName = "string"
      labVirtualNetworkId = "string"
      networkInterface = {
        dnsName = "string"
        privateIpAddress = "string"
        publicIpAddress = "string"
        publicIpAddressId = "string"
        rdpAuthority = "string"
        sharedPublicIpAddressConfiguration = {
          inboundNatRules = [
            {
              backendPort = int
              frontendPort = int
              transportProtocol = "string"
            }
          ]
        }
        sshAuthority = "string"
        subnetId = "string"
        virtualNetworkId = "string"
      }
      notes = "string"
      ownerObjectId = "string"
      ownerUserPrincipalName = "string"
      password = "string"
      planId = "string"
      scheduleParameters = [
        {
          name = "string"
          properties = {
            dailyRecurrence = {
              time = "string"
            }
            hourlyRecurrence = {
              minute = int
            }
            notificationSettings = {
              emailRecipient = "string"
              notificationLocale = "string"
              status = "string"
              timeInMinutes = int
              webhookUrl = "string"
            }
            status = "string"
            targetResourceId = "string"
            taskType = "string"
            timeZoneId = "string"
            weeklyRecurrence = {
              time = "string"
              weekdays = [
                "string"
              ]
            }
          }
          tags = {
            {customized property} = "string"
          }
        }
      ]
      size = "string"
      sshKey = "string"
      storageType = "string"
      userName = "string"
    }
  })
}

Wartości właściwości

ArtifactInstallProperties

Nazwa Opis Wartość
artifactId Identyfikator artefaktu. struna
artifactTitle Tytuł artefaktu. struna
deploymentStatusMessage Komunikat o stanie z wdrożenia. struna
installTime Czas rozpoczęcia instalacji artefaktu na maszynie wirtualnej. struna
Parametry Parametry artefaktu. ArtifactParameterProperties[]
stan Stan artefaktu. struna
vmExtensionStatusMessage Komunikat o stanie z rozszerzenia maszyny wirtualnej. struna

ArtifactParameterProperties

Nazwa Opis Wartość
nazwa Nazwa parametru artefaktu. struna
wartość Wartość parametru artefaktu. struna

AttachNewDataDiskOptions

Nazwa Opis Wartość
diskName Nazwa dysku do dołączenia. struna
diskSizeGiB Rozmiar dysku do dołączenia w gibibajtach. Int
diskType Typ magazynu dysku (tj. Standardowa, Premium). "Premium"
"Standardowa"
"StandardSSD"

DataDiskProperties

Nazwa Opis Wartość
attachNewDataDiskOptions Określa opcje dołączania nowego dysku do maszyny wirtualnej. AttachNewDataDiskOptions
existingLabDiskId Określa istniejący identyfikator dysku laboratorium, który ma zostać dołączony do maszyny wirtualnej. struna
hostCaching Opcja buforowania dysku danych (tj. Brak, ReadOnly, ReadWrite). "Brak"
"ReadOnly"
"ReadWrite"

DayDetails

Nazwa Opis Wartość
Godzina Godzina dnia, w ramach których zostanie zaplanowany harmonogram. struna

GalleryImageReference

Nazwa Opis Wartość
oferta Oferta obrazu galerii. struna
osType Typ systemu operacyjnego obrazu galerii. struna
wydawca Wydawca obrazu galerii. struna
Numer jednostki magazynowej Jednostka SKU obrazu galerii. struna
Wersja Wersja obrazu galerii. struna

HourDetails

Nazwa Opis Wartość
minuta Minuty godziny, w których zostanie uruchomiony harmonogram. Int

Ruch przychodzącyNatRule

Nazwa Opis Wartość
backendPort Port, do którego będzie przekierowywany ruch zewnętrzny. Int
frontonPort Zewnętrzny port punktu końcowego połączenia przychodzącego. Możliwy zakres wartości z zakresu od 1 do 65535 włącznie. Jeśli wartość nie zostanie określona, zostanie przydzielona automatycznie. Int
transportProtocol Protokół transportu dla punktu końcowego. "Tcp"
"Udp"

LabVirtualMachineProperties

Nazwa Opis Wartość
allowClaim Wskazuje, czy inny użytkownik może przejąć własność maszyny wirtualnej Bool
Artefakty Artefakty, które mają zostać zainstalowane na maszynie wirtualnej. ArtifactInstallProperties[]
createdDate Data utworzenia maszyny wirtualnej. struna
customImageId Identyfikator obrazu niestandardowego maszyny wirtualnej. struna
dataDiskParameters Nowe lub istniejące dyski danych do dołączenia do maszyny wirtualnej po utworzeniu DataDiskProperties[]
disallowPublicIpAddress Wskazuje, czy maszyna wirtualna ma zostać utworzona bez publicznego adresu IP. Bool
environmentId Identyfikator zasobu środowiska, który zawiera tę maszynę wirtualną, jeśli istnieje. struna
data wygaśnięcia Data wygaśnięcia maszyny wirtualnej. struna
galleryImageReference Dokumentacja obrazu witryny Microsoft Azure Marketplace maszyny wirtualnej. GalleryImageReference
isAuthenticationWithSshKey Wskazuje, czy ta maszyna wirtualna używa klucza SSH do uwierzytelniania. Bool
labSubnetName Nazwa podsieci laboratorium maszyny wirtualnej. struna
labVirtualNetworkId Identyfikator sieci wirtualnej laboratorium maszyny wirtualnej. struna
networkInterface Właściwości interfejsu sieciowego. NetworkInterfaceProperties
Notatki Uwagi dotyczące maszyny wirtualnej. struna
ownerObjectId Identyfikator obiektu właściciela maszyny wirtualnej. struna
ownerUserPrincipalName Główna nazwa użytkownika właściciela maszyny wirtualnej. struna
hasło Hasło administratora maszyny wirtualnej. struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr.
identyfikator planu Identyfikator planu skojarzonego z obrazem maszyny wirtualnej struna
scheduleParameters Harmonogramy tworzenia maszyn wirtualnych ScheduleCreationParameter[]
rozmiar Rozmiar maszyny wirtualnej. struna
sshKey Klucz SSH administratora maszyny wirtualnej. struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr.
storageType Typ magazynu do użycia dla maszyny wirtualnej (tj. Standardowa, Premium). struna
userName Nazwa użytkownika maszyny wirtualnej. struna

Microsoft.DevTestLab/labs/virtualmachines

Nazwa Opis Wartość
lokalizacja Lokalizacja zasobu. struna
nazwa Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: labs
Właściwości Właściwości zasobu. LabVirtualMachineProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.DevTestLab/labs/virtualmachines@2018-09-15"

NetworkInterfaceProperties

Nazwa Opis Wartość
dnsName Nazwa DNS. struna
privateIpAddress Prywatny adres IP. struna
publicIpAddress Publiczny adres IP. struna
publicIpAddressId Identyfikator zasobu publicznego adresu IP. struna
rdpAuthority Właściwość RdpAuthority jest nazwą hosta DNS serwera lub adresem IP, a następnie numerem portu usługi dla protokołu RDP (Remote Desktop Protocol). struna
sharedPublicIpAddressConfiguration Konfiguracja udostępniania publicznego adresu IP na wielu maszynach wirtualnych. SharedPublicIpAddressConfiguration
sshAuthority Właściwość SshAuthority jest nazwą hosta DNS serwera lub adresem IP, po którym następuje numer portu usługi dla protokołu SSH. struna
subnetId Identyfikator zasobu podsieci. struna
virtualNetworkId Identyfikator zasobu sieci wirtualnej. struna

NotificationSettings

Nazwa Opis Wartość
emailRecipient Adresat wiadomości e-mail do wysyłania powiadomień (może być listą adresów e-mail rozdzielonych średnikami). struna
notificationLocale Ustawienia regionalne do użycia podczas wysyłania powiadomienia (rezerwowe dla nieobsługiwanych języków to EN). struna
stan Jeśli powiadomienia są włączone dla tego harmonogramu (tj. Włączone, Wyłączone). "Wyłączone"
"Włączone"
timeInMinutes Czas w minutach przed zdarzeniem, w którym zostanie wysłane powiadomienie. Int
webhookUrl Adres URL elementu webhook, do którego zostanie wysłane powiadomienie. struna

Tagi zasobów

Nazwa Opis Wartość

ScheduleCreationParameter

Nazwa Opis Wartość
nazwa Nazwa maszyny wirtualnej lub środowiska struna
Właściwości Właściwości harmonogramu. ScheduleCreationParameterProperties
Tagi Tagi zasobu. ScheduleCreationParameterTags

ScheduleCreationParameterProperties

Nazwa Opis Wartość
dailyRecurrence Jeśli harmonogram będzie występować raz dziennie tygodnia, określ cykl dzienny. DayDetails
hourlyRecurrence Jeśli harmonogram będzie występować wiele razy dziennie, określ cykl godzinowy. HourDetails
notificationSettings Ustawienia powiadomień. NotificationSettings
stan Stan harmonogramu (tj. Włączone, Wyłączone) "Wyłączone"
"Włączone"
targetResourceId Identyfikator zasobu, do którego należy harmonogram struna
taskType Typ zadania harmonogramu (np. LabVmsShutdownTask, LabVmAutoStart). struna
timeZoneId Identyfikator strefy czasowej (np. Chiny (czas standardowy, Grenlandia (czas standardowy), Pacyfik (czas standardowy itp.). Możliwe wartości tej właściwości można znaleźć w IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) struna
weeklyRecurrence Jeśli harmonogram będzie występować tylko kilka dni tygodnia, określ cykl tygodniowy. WeekDetails

ScheduleCreationParameterTags

Nazwa Opis Wartość

SharedPublicIpAddressConfiguration

Nazwa Opis Wartość
inboundNatRules Przychodzące reguły NAT inboundNatRule[]

WeekDetails

Nazwa Opis Wartość
Godzina Godzina dnia, w ramach których zostanie zaplanowany harmonogram. struna
Dni powszednie Dni tygodnia, dla których zaplanowano harmonogram (np. niedziela, poniedziałek, wtorek itp.). string[]