Microsoft.DesktopVirtualization-hostPools 2020-11-10-preview

  • Artikel

Bicep-resourcedefinitie

Het resourcetype hostPools kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.DesktopVirtualization/hostPools-resource wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.DesktopVirtualization/hostPools@2020-11-10-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    customRdpProperty: 'string'
    description: 'string'
    friendlyName: 'string'
    hostPoolType: 'string'
    loadBalancerType: 'string'
    maxSessionLimit: int
    personalDesktopAssignmentType: 'string'
    preferredAppGroupType: 'string'
    registrationInfo: {
      expirationTime: 'string'
      registrationTokenOperation: 'string'
      token: 'string'
    }
    ring: int
    ssoadfsAuthority: 'string'
    ssoClientId: 'string'
    ssoClientSecretKeyVaultPath: 'string'
    ssoSecretType: 'string'
    startVMOnConnect: bool
    validationEnvironment: bool
    vmTemplate: 'string'
  }
}

Eigenschapswaarden

hostpools

Naam Description Waarde
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 3-64

Geldige tekens:
Alfanumerieken, onderstrepingstekens, punten en afbreekstreepjes.

Begin met letter of cijfer. Eindig met letter, cijfer of onderstrepingsteken.
location De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
tags Resourcetags. Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
properties Gedetailleerde eigenschappen voor HostPool HostPoolProperties (vereist)

HostPoolProperties

Naam Description Waarde
customRdpProperty Aangepaste rdp-eigenschap van HostPool. tekenreeks
beschrijving Beschrijving van HostPool. tekenreeks
Friendlyname Beschrijvende naam van HostPool. tekenreeks
hostPoolType HostPool-type voor desktop. 'Persoonlijk'
'Gegroepeerd' (vereist)
loadBalancerType Het type load balancer. 'BreadthFirst'
'DepthFirst'
'Permanent' (vereist)
maxSessionLimit De maximale sessielimiet van HostPool. int
personalDesktopAssignmentType PersonalDesktopAssignment-type voor HostPool. 'Automatisch'
'Direct'
preferredAppGroupType Het type voorkeurstoepassingsgroep, standaard ingesteld op Bureaubladtoepassingsgroep 'Bureaublad'
'Geen'
'RailApplications' (vereist)
registrationInfo De registratiegegevens van HostPool. Registratieinfo
overgaan Het ringnummer van HostPool. int
ssoadfsAuthority URL naar de ADFS-server van de klant voor het ondertekenen van WVD SSO-certificaten. tekenreeks
ssoClientId ClientId voor de geregistreerde Relying Party die wordt gebruikt voor het uitgeven van WVD SSO-certificaten. tekenreeks
ssoClientSecretKeyVaultPath Pad naar Azure KeyVault waar het geheim wordt opgeslagen dat wordt gebruikt voor communicatie met ADFS. tekenreeks
ssoSecretType Het type eenmalige aanmelding bij Geheim type. 'Certificaat'
'CertificateInKeyVault'
'SharedKey'
'SharedKeyInKeyVault'
startVMOnConnect De vlag om de functie StartVMOnConnect in of uit te schakelen. booleaans
validationEnvironment Is validatieomgeving. booleaans
vmTemplate VM-sjabloon voor de configuratie van sessionhosts in de hostpool. tekenreeks

RegistrationInfo

Naam Description Waarde
expirationTime Verlooptijd van het registratietoken. tekenreeks
registrationTokenOperation Het type opnieuw instellen van het token. 'Verwijderen'
'Geen'
'Bijwerken'
token De met base64 gecodeerde tekenreeks van het registratietoken. tekenreeks

Resourcedefinitie van ARM-sjabloon

Het resourcetype hostPools kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.DesktopVirtualization/hostPools wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.DesktopVirtualization/hostPools",
  "apiVersion": "2020-11-10-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "customRdpProperty": "string",
    "description": "string",
    "friendlyName": "string",
    "hostPoolType": "string",
    "loadBalancerType": "string",
    "maxSessionLimit": "int",
    "personalDesktopAssignmentType": "string",
    "preferredAppGroupType": "string",
    "registrationInfo": {
      "expirationTime": "string",
      "registrationTokenOperation": "string",
      "token": "string"
    },
    "ring": "int",
    "ssoadfsAuthority": "string",
    "ssoClientId": "string",
    "ssoClientSecretKeyVaultPath": "string",
    "ssoSecretType": "string",
    "startVMOnConnect": "bool",
    "validationEnvironment": "bool",
    "vmTemplate": "string"
  }
}

Eigenschapswaarden

hostpools

Naam Description Waarde
type Het resourcetype 'Microsoft.DesktopVirtualization/hostPools'
apiVersion De resource-API-versie '2020-11-10-preview'
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 3-64

Geldige tekens:
Alfanumerieken, onderstrepingstekens, punten en afbreekstreepjes.

Begin met een letter of cijfer. Eindig met letter, cijfer of onderstrepingsteken.
location De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
tags Resourcetags. Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
properties Gedetailleerde eigenschappen voor HostPool HostPoolProperties (vereist)

HostPoolEigenschappen

Naam Description Waarde
customRdpProperty Aangepaste rdp-eigenschap van HostPool. tekenreeks
beschrijving Beschrijving van HostPool. tekenreeks
Friendlyname Beschrijvende naam van HostPool. tekenreeks
hostPoolType HostPooltype voor desktop. 'Persoonlijk'
'Gegroepeerd' (vereist)
loadBalancerType Het type load balancer. 'BreedteEerste'
'DepthFirst'
'Permanent' (vereist)
maxSessionLimit De maximale sessielimiet van HostPool. int
personalDesktopAssignmentType PersonalDesktopAssignment-type voor HostPool. 'Automatisch'
'Direct'
preferredAppGroupType Het type voorkeurstype van toepassingsgroep, standaard ingesteld op Bureaubladtoepassingsgroep 'Bureaublad'
'Geen'
'RailApplications' (vereist)
registrationInfo De registratie-informatie van HostPool. RegistrationInfo
overgaan Het ringnummer van HostPool. int
ssoadfsAuthority URL naar de ADFS-server van de klant voor het ondertekenen van WVD SSO-certificaten. tekenreeks
ssoClientId ClientId voor de geregistreerde Relying Party die wordt gebruikt voor het uitgeven van WVD SSO-certificaten. tekenreeks
ssoClientSecretKeyVaultPath Pad naar Azure KeyVault waar het geheim wordt opgeslagen dat wordt gebruikt voor communicatie met ADFS. tekenreeks
ssoSecretType Het type eenmalige aanmelding bij Geheim type. 'Certificaat'
'CertificateInKeyVault'
'SharedKey'
'SharedKeyInKeyVault'
startVMOnConnect De vlag om de functie StartVMOnConnect in of uit te schakelen. booleaans
validationEnvironment Is validatieomgeving. booleaans
vmTemplate VM-sjabloon voor de configuratie van sessionhosts in de hostpool. tekenreeks

RegistrationInfo

Naam Description Waarde
expirationTime Verlooptijd van het registratietoken. tekenreeks
registrationTokenOperation Het type opnieuw instellen van het token. 'Verwijderen'
'Geen'
'Bijwerken'
token De met base64 gecodeerde tekenreeks van het registratietoken. tekenreeks

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype hostPools kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • Resourcegroepen

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.DesktopVirtualization/hostPools wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DesktopVirtualization/hostPools@2020-11-10-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      customRdpProperty = "string"
      description = "string"
      friendlyName = "string"
      hostPoolType = "string"
      loadBalancerType = "string"
      maxSessionLimit = int
      personalDesktopAssignmentType = "string"
      preferredAppGroupType = "string"
      registrationInfo = {
        expirationTime = "string"
        registrationTokenOperation = "string"
        token = "string"
      }
      ring = int
      ssoadfsAuthority = "string"
      ssoClientId = "string"
      ssoClientSecretKeyVaultPath = "string"
      ssoSecretType = "string"
      startVMOnConnect = bool
      validationEnvironment = bool
      vmTemplate = "string"
    }
  })
}

Eigenschapswaarden

hostpools

Naam Description Waarde
type Het resourcetype "Microsoft.DesktopVirtualization/hostPools@2020-11-10-preview"
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 3-64

Geldige tekens:
Alfanumerieken, onderstrepingstekens, punten en afbreekstreepjes.

Begin met een letter of cijfer. Eindig met letter, cijfer of onderstrepingsteken.
location De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
parent_id Als u wilt implementeren in een resourcegroep, gebruikt u de id van die resourcegroep. tekenreeks (vereist)
tags Resourcetags. Woordenlijst met tagnamen en -waarden.
properties Gedetailleerde eigenschappen voor HostPool HostPoolProperties (vereist)

HostPoolEigenschappen

Naam Description Waarde
customRdpProperty Aangepaste rdp-eigenschap van HostPool. tekenreeks
beschrijving Beschrijving van HostPool. tekenreeks
Friendlyname Beschrijvende naam van HostPool. tekenreeks
hostPoolType HostPooltype voor desktop. "Persoonlijk"
'Gegroepeerd' (vereist)
loadBalancerType Het type load balancer. "Breedteeerste"
"DepthFirst"
'Permanent' (vereist)
maxSessionLimit De maximale sessielimiet van HostPool. int
personalDesktopAssignmentType PersonalDesktopAssignment-type voor HostPool. "Automatisch"
"Direct"
preferredAppGroupType Het type voorkeurstoepassingsgroep, standaard ingesteld op Bureaubladtoepassingsgroep "Bureaublad"
"Geen"
"RailApplications" (vereist)
registrationInfo De registratiegegevens van HostPool. Registratieinfo
overgaan Het ringnummer van HostPool. int
ssoadfsAuthority URL naar de ADFS-server van de klant voor het ondertekenen van WVD SSO-certificaten. tekenreeks
ssoClientId ClientId voor de geregistreerde Relying Party die wordt gebruikt voor het uitgeven van WVD SSO-certificaten. tekenreeks
ssoClientSecretKeyVaultPath Pad naar Azure KeyVault, waar het geheim wordt opgeslagen dat wordt gebruikt voor communicatie met ADFS. tekenreeks
ssoSecretType Het type eenmalige aanmelding op Geheim type. "Certificaat"
"CertificateInKeyVault"
"SharedKey"
"SharedKeyInKeyVault"
startVMOnConnect De vlag om de functie StartVMOnConnect in of uit te schakelen. booleaans
validationEnvironment Is validatieomgeving. booleaans
vmTemplate VM-sjabloon voor de configuratie van sessionhosts in de hostpool. tekenreeks

Registratieinfo

Naam Description Waarde
expirationTime Verlooptijd van registratietoken. tekenreeks
registrationTokenOperation Het type opnieuw instellen van het token. "Verwijderen"
"Geen"
"Bijwerken"
token De met base64 gecodeerde tekenreeks van het registratietoken. tekenreeks