Microsoft. DesktopVirtualization hostPools 2021-09-03-preview

  • Artikel

Bicep-resourcedefinitie

Het resourcetype hostPools kan worden geïmplementeerd voor:

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

Resource-indeling

Een Microsoft maken. DesktopVirtualization/hostPools resource, voeg de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.DesktopVirtualization/hostPools@2021-09-03-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  kind: 'string'
  identity: {
    type: 'SystemAssigned'
  }
  managedBy: 'string'
  plan: {
    name: 'string'
    product: 'string'
    promotionCode: 'string'
    publisher: 'string'
    version: 'string'
  }
  properties: {
    customRdpProperty: 'string'
    description: 'string'
    friendlyName: 'string'
    hostPoolType: 'string'
    loadBalancerType: 'string'
    maxSessionLimit: int
    migrationRequest: {
      migrationPath: 'string'
      operation: 'string'
    }
    personalDesktopAssignmentType: 'string'
    preferredAppGroupType: 'string'
    publicNetworkAccess: '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 Beschrijving Waarde
naam De resourcenaam tekenreeks (vereist)
location De geografische locatie waar de resource zich bevindt tekenreeks
tags Resourcetags. Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
sku ResourceModelWithAllowedPropertySetSku
Soort Metagegevens die door portal/tooling/etc worden gebruikt om verschillende UX-ervaringen weer te geven voor resources van hetzelfde type; ApiApps zijn bijvoorbeeld een soort Microsoft. Type web/sites. Indien ondersteund, moet de resourceprovider deze waarde valideren en behouden. tekenreeks
identity ResourceModelWithAllowedPropertySetIdentity
beheerdDoor De volledig gekwalificeerde resource-id van de resource die deze resource beheert. Geeft aan of deze resource wordt beheerd door een andere Azure-resource. Als deze aanwezig is, wordt de resource in de volledige modus niet verwijderd als deze uit de sjabloon wordt verwijderd, omdat deze wordt beheerd door een andere resource. tekenreeks
plannen ResourceModelWithAllowedPropertySetPlan
properties Gedetailleerde eigenschappen voor HostPool HostPoolProperties (vereist)

ResourceModelWithAllowedPropertySetIdentity

Naam Beschrijving Waarde
type Het identiteitstype. 'SystemAssigned'

ResourceModelWithAllowedPropertySetPlan

Naam Beschrijving Waarde
naam Een door de gebruiker gedefinieerde naam van het artefact van derden dat wordt aangeschaft. tekenreeks (vereist)
product Het artefact van derden dat wordt aangeschaft. Bijvoorbeeld NewRelic. Product wordt toegewezen aan de OfferID die is opgegeven voor het artefact op het moment van onboarding van de gegevensmarkt. tekenreeks (vereist)
promotionCode Een uitgever heeft promotiecode opgegeven zoals ingericht in Data Market voor het genoemde product/artefact. tekenreeks
publisher De uitgever van het artefact van derden dat wordt gekocht. Bijvoorbeeld NewRelic tekenreeks (vereist)
versie De versie van het gewenste product/artefact. tekenreeks

HostPoolEigenschappen

Naam Beschrijving Waarde
customRdpProperty Aangepaste rdp-eigenschap van HostPool. tekenreeks
beschrijving Beschrijving van HostPool. tekenreeks
Friendlyname Beschrijvende naam van HostPool. tekenreeks
hostPoolType HostPool-type voor desktop. 'BYODesktop'
'Persoonlijk'
'Gegroepeerd' (vereist)
loadBalancerType Het type load balancer. 'BreadthFirst'
'DepthFirst'
'Permanent' (vereist)
maxSessionLimit De maximale sessielimiet van HostPool. int
migrationRequest De registratiegegevens van HostPool. MigrationRequestProperties
personalDesktopAssignmentType PersonalDesktopAssignment-type voor HostPool. 'Automatisch'
'Direct'
preferredAppGroupType Het type voorkeurstoepassingsgroep, standaard ingesteld op Bureaubladtoepassingsgroep 'Bureaublad'
'Geen'
'RailApplications' (vereist)
publicNetworkAccess Met Ingeschakeld kan deze resource worden geopend vanuit zowel openbare als particuliere netwerken. Uitgeschakeld staat toe dat deze resource alleen toegankelijk is via privé-eindpunten 'Uitgeschakeld'
Ingeschakeld
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

MigrationRequestProperties

Naam Beschrijving Waarde
migrationPath Het pad naar het verouderde object dat moet worden gemigreerd. tekenreeks
bewerking Het type bewerking voor migratie. 'Voltooien'
'Verbergen'
'Intrekken'
'Starten'
'Zichtbaar maken'

Registratieinfo

Naam Beschrijving 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

ResourceModelWithAllowedPropertySetSku

Naam Beschrijving Waarde
capacity Als de SKU uitschalen/inschalen ondersteunt, moet het gehele getal van de capaciteit worden opgenomen. Als uitschalen/inschalen niet mogelijk is voor de resource, wordt dit mogelijk weggelaten. int
gezin Als de service verschillende generaties hardware voor dezelfde SKU heeft, kan die hier worden vastgelegd. tekenreeks
naam De naam van de SKU. Ex - P3. Het is meestal een letter+cijfercode tekenreeks (vereist)
grootte De SKU-grootte. Wanneer het naamveld de combinatie van laag en een andere waarde is, is dit de zelfstandige code. tekenreeks
laag Dit veld moet worden geïmplementeerd door de resourceprovider als de service meer dan één laag heeft, maar niet vereist is voor een PUT. 'Basic'
'Gratis'
Premium
'Standaard'

Resourcedefinitie van ARM-sjabloon

Het resourcetype hostPools kan worden geïmplementeerd in:

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

Resource-indeling

Een Microsoft maken. Resource DesktopVirtualization/hostPools voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.DesktopVirtualization/hostPools",
  "apiVersion": "2021-09-03-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "kind": "string",
  "identity": {
    "type": "SystemAssigned"
  },
  "managedBy": "string",
  "plan": {
    "name": "string",
    "product": "string",
    "promotionCode": "string",
    "publisher": "string",
    "version": "string"
  },
  "properties": {
    "customRdpProperty": "string",
    "description": "string",
    "friendlyName": "string",
    "hostPoolType": "string",
    "loadBalancerType": "string",
    "maxSessionLimit": "int",
    "migrationRequest": {
      "migrationPath": "string",
      "operation": "string"
    },
    "personalDesktopAssignmentType": "string",
    "preferredAppGroupType": "string",
    "publicNetworkAccess": "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 Beschrijving Waarde
type Het resourcetype 'Microsoft. DesktopVirtualization/hostPools'
apiVersion De resource-API-versie '2021-09-03-preview'
naam De resourcenaam tekenreeks (vereist)
location De geografische locatie waar de resource zich bevindt tekenreeks
tags Resourcetags. Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
sku ResourceModelWithAllowedPropertySetSku
Soort Metagegevens die door portal/tooling/etc worden gebruikt om verschillende UX-ervaringen weer te geven voor resources van hetzelfde type; ApiApps zijn bijvoorbeeld een soort Microsoft. Type web/sites. Indien ondersteund, moet de resourceprovider deze waarde valideren en behouden. tekenreeks
identity ResourceModelWithAllowedPropertySetIdentity
beheerdDoor De volledig gekwalificeerde resource-id van de resource die deze resource beheert. Geeft aan of deze resource wordt beheerd door een andere Azure-resource. Als deze aanwezig is, wordt de resource in de volledige modus niet verwijderd als deze uit de sjabloon wordt verwijderd, omdat deze wordt beheerd door een andere resource. tekenreeks
plannen ResourceModelWithAllowedPropertySetPlan
properties Gedetailleerde eigenschappen voor HostPool HostPoolProperties (vereist)

ResourceModelWithAllowedPropertySetIdentity

Naam Beschrijving Waarde
type Het identiteitstype. 'SystemAssigned'

ResourceModelWithAllowedPropertySetPlan

Naam Beschrijving Waarde
naam Een door de gebruiker gedefinieerde naam van het artefact van derden dat wordt aangeschaft. tekenreeks (vereist)
product Het artefact van derden dat wordt aangeschaft. Bijvoorbeeld NewRelic. Product wordt toegewezen aan de OfferID die is opgegeven voor het artefact op het moment van onboarding van de gegevensmarkt. tekenreeks (vereist)
promotionCode Een uitgever heeft promotiecode opgegeven zoals ingericht in Gegevensmarkt voor het genoemde product/artefact. tekenreeks
publisher De uitgever van het artefact van derden dat wordt gekocht. Bijvoorbeeld NewRelic tekenreeks (vereist)
versie De versie van het gewenste product/artefact. tekenreeks

HostPoolEigenschappen

Naam Beschrijving Waarde
customRdpProperty Aangepaste rdp-eigenschap van HostPool. tekenreeks
beschrijving Beschrijving van HostPool. tekenreeks
Friendlyname Beschrijvende naam van HostPool. tekenreeks
hostPoolType HostPooltype voor desktop. 'BYODesktop'
'Persoonlijk'
'Gegroepeerd' (vereist)
loadBalancerType Het type load balancer. 'BreedteEerste'
'DepthFirst'
'Permanent' (vereist)
maxSessionLimit De maximale sessielimiet van HostPool. int
migrationRequest De registratiegegevens van HostPool. MigrationRequestProperties
personalDesktopAssignmentType PersonalDesktopAssignment-type voor HostPool. 'Automatisch'
'Direct'
preferredAppGroupType Het type voorkeurstype van toepassingsgroep, standaard ingesteld op Bureaubladtoepassingsgroep 'Bureaublad'
'Geen'
'RailApplications' (vereist)
publicNetworkAccess Met Ingeschakeld kan deze resource worden geopend vanuit openbare en particuliere netwerken. Uitgeschakeld staat toe dat deze resource alleen toegankelijk is via privé-eindpunten 'Uitgeschakeld'
Ingeschakeld
registrationInfo De registratiegegevens 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

MigrationRequestProperties

Naam Beschrijving Waarde
migrationPath Het pad naar het verouderde object dat moet worden gemigreerd. tekenreeks
bewerking Het type bewerking voor migratie. 'Voltooid'
'Verbergen'
'Intrekken'
'Start'
'Zichtbaar maken'

RegistrationInfo

Naam Beschrijving 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

ResourceModelWithAllowedPropertySetSku

Naam Beschrijving Waarde
capacity Als de SKU uitschalen/inschalen ondersteunt, moet het gehele getal van de capaciteit worden opgenomen. Als uitschalen/inschalen niet mogelijk is voor de resource, kan dit worden weggelaten. int
gezin Als de service verschillende generaties hardware heeft, voor dezelfde SKU, kan dat hier worden vastgelegd. tekenreeks
naam De naam van de SKU. Ex - P3. Het is meestal een letter+cijfercode tekenreeks (vereist)
grootte De SKU-grootte. Wanneer het naamveld de combinatie van de laag en een andere waarde is, is dit de zelfstandige code. tekenreeks
laag Dit veld moet worden geïmplementeerd door de resourceprovider als de service meer dan één laag heeft, maar niet vereist is voor een PUT. 'Basic'
'Gratis'
'Premium'
'Standaard'

Terraform-resourcedefinitie (AzAPI-provider)

Het resourcetype hostPools kan worden geïmplementeerd voor:

  • Resourcegroepen

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

Resource-indeling

Een Microsoft maken. DesktopVirtualization/hostPools resource, voeg de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DesktopVirtualization/hostPools@2021-09-03-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "SystemAssigned"
  }
  body = jsonencode({
    properties = {
      customRdpProperty = "string"
      description = "string"
      friendlyName = "string"
      hostPoolType = "string"
      loadBalancerType = "string"
      maxSessionLimit = int
      migrationRequest = {
        migrationPath = "string"
        operation = "string"
      }
      personalDesktopAssignmentType = "string"
      preferredAppGroupType = "string"
      publicNetworkAccess = "string"
      registrationInfo = {
        expirationTime = "string"
        registrationTokenOperation = "string"
        token = "string"
      }
      ring = int
      ssoadfsAuthority = "string"
      ssoClientId = "string"
      ssoClientSecretKeyVaultPath = "string"
      ssoSecretType = "string"
      startVMOnConnect = bool
      validationEnvironment = bool
      vmTemplate = "string"
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
    kind = "string"
    managedBy = "string"
    plan = {
      name = "string"
      product = "string"
      promotionCode = "string"
      publisher = "string"
      version = "string"
    }
  })
}

Eigenschapswaarden

hostpools

Naam Beschrijving Waarde
type Het resourcetype "Microsoft. DesktopVirtualization/hostPools@2021-09-03-preview"
naam De resourcenaam tekenreeks (vereist)
location De geografische locatie waar de resource zich bevindt tekenreeks
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.
sku ResourceModelWithAllowedPropertySetSku
Soort Metagegevens die door portal/tooling/etc worden gebruikt om verschillende UX-ervaringen weer te geven voor resources van hetzelfde type; ApiApps zijn bijvoorbeeld een soort Microsoft. Type web/sites. Indien ondersteund, moet de resourceprovider deze waarde valideren en behouden. tekenreeks
identity ResourceModelWithAllowedPropertySetIdentity
beheerdDoor De volledig gekwalificeerde resource-id van de resource die deze resource beheert. Geeft aan of deze resource wordt beheerd door een andere Azure-resource. Als deze aanwezig is, wordt de resource in de volledige modus niet verwijderd als deze uit de sjabloon wordt verwijderd, omdat deze wordt beheerd door een andere resource. tekenreeks
plannen ResourceModelWithAllowedPropertySetPlan
properties Gedetailleerde eigenschappen voor HostPool HostPoolProperties (vereist)

ResourceModelWithAllowedPropertySetIdentity

Naam Beschrijving Waarde
type Het identiteitstype. "SystemAssigned"

ResourceModelWithAllowedPropertySetPlan

Naam Beschrijving Waarde
naam Een door de gebruiker gedefinieerde naam van het artefact van derden dat wordt aangeschaft. tekenreeks (vereist)
product Het artefact van derden dat wordt aangeschaft. Bijvoorbeeld NewRelic. Product wordt toegewezen aan de OfferID die is opgegeven voor het artefact op het moment van onboarding van de gegevensmarkt. tekenreeks (vereist)
promotionCode Een uitgever heeft promotiecode opgegeven zoals ingericht in Data Market voor het genoemde product/artefact. tekenreeks
publisher De uitgever van het artefact van derden dat wordt gekocht. Bijvoorbeeld NewRelic tekenreeks (vereist)
versie De versie van het gewenste product/artefact. tekenreeks

HostPoolEigenschappen

Naam Beschrijving Waarde
customRdpProperty Aangepaste rdp-eigenschap van HostPool. tekenreeks
beschrijving Beschrijving van HostPool. tekenreeks
Friendlyname Beschrijvende naam van HostPool. tekenreeks
hostPoolType HostPool-type voor desktop. "BYODesktop"
"Persoonlijk"
'Gegroepeerd' (vereist)
loadBalancerType Het type load balancer. "Breedteeerste"
"DepthFirst"
'Permanent' (vereist)
maxSessionLimit De maximale sessielimiet van HostPool. int
migrationRequest De registratiegegevens van HostPool. MigrationRequestProperties
personalDesktopAssignmentType PersonalDesktopAssignment-type voor HostPool. "Automatisch"
"Direct"
preferredAppGroupType Het type voorkeurstoepassingsgroep, standaard ingesteld op Bureaubladtoepassingsgroep "Bureaublad"
"Geen"
"RailApplications" (vereist)
publicNetworkAccess Met Ingeschakeld kan deze resource worden geopend vanuit zowel openbare als particuliere netwerken. Uitgeschakeld staat toe dat deze resource alleen toegankelijk is via privé-eindpunten "Uitgeschakeld"
"Ingeschakeld"
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

MigrationRequestProperties

Naam Beschrijving Waarde
migrationPath Het pad naar het verouderde object dat moet worden gemigreerd. tekenreeks
bewerking Het type bewerking voor migratie. "Voltooien"
"Verbergen"
"Intrekken"
"Starten"
"Zichtbaar maken"

Registratieinfo

Naam Beschrijving 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

ResourceModelWithAllowedPropertySetSku

Naam Beschrijving Waarde
capacity Als de SKU uitschalen/inschalen ondersteunt, moet het gehele getal van de capaciteit worden opgenomen. Als uitschalen/inschalen niet mogelijk is voor de resource, wordt dit mogelijk weggelaten. int
gezin Als de service verschillende generaties hardware heeft, voor dezelfde SKU, kan dat hier worden vastgelegd. tekenreeks
naam De naam van de SKU. Ex - P3. Het is meestal een letter+cijfercode tekenreeks (vereist)
grootte De SKU-grootte. Wanneer het naamveld de combinatie van de laag en een andere waarde is, is dit de zelfstandige code. tekenreeks
laag Dit veld moet worden geïmplementeerd door de resourceprovider als de service meer dan één laag heeft, maar niet vereist is voor een PUT. "Basis"
"Gratis"
"Premium"
"Standaard"