Delen via

Microsoft.DesktopVirtualization hostPools

Bicep-resourcedefinitie

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

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

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

resource symbolicname 'Microsoft.DesktopVirtualization/hostPools@2025-03-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  managedBy: 'string'
  name: 'string'
  plan: {
    name: 'string'
    product: 'string'
    promotionCode: 'string'
    publisher: 'string'
    version: 'string'
  }
  properties: {
    agentUpdate: {
      maintenanceWindows: [
        {
          dayOfWeek: 'string'
          hour: int
        }
      ]
      maintenanceWindowTimeZone: 'string'
      type: 'string'
      useSessionHostLocalTime: bool
    }
    customRdpProperty: 'string'
    description: 'string'
    directUDP: 'string'
    friendlyName: 'string'
    hostPoolType: 'string'
    loadBalancerType: 'string'
    managedPrivateUDP: 'string'
    managementType: 'string'
    maxSessionLimit: int
    personalDesktopAssignmentType: 'string'
    preferredAppGroupType: 'string'
    publicNetworkAccess: 'string'
    publicUDP: 'string'
    registrationInfo: {
      expirationTime: 'string'
      registrationTokenOperation: 'string'
      token: 'string'
    }
    relayUDP: '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'
  }
  tags: {
    {customized property}: 'string'
  }
}

Eigenschapswaarden

Microsoft.DesktopVirtualization/hostPools

Naam Beschrijving Waarde
identiteit Beheerde service-identiteit (door het systeem toegewezen en/of door de gebruiker toegewezen identiteiten) ManagedServiceIdentity-
soort Metagegevens die worden gebruikt door portal/tooling/etc om verschillende UX-ervaringen weer te geven voor resources van hetzelfde type. ApiApps is bijvoorbeeld een type Microsoft.Web/sites. Indien ondersteund, moet de resourceprovider deze waarde valideren en behouden. snaar

Beperkingen:
Patroon = ^[-\w\._,\(\)]+$
plaats De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
beheerd door 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 dit aanwezig is, wordt de resource niet verwijderd als deze uit de sjabloon wordt verwijderd omdat deze wordt beheerd door een andere resource. snaar
naam De resourcenaam snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 255
Patroon = ^[A-Za-z0-9@.\-_ ]*$ (vereist)
voorstel, schema, strategie (depending on context) Plan de resource. plannen
Eigenschappen Gedetailleerde eigenschappen voor HostPool HostPoolProperties (vereist)
Sku De definitie van het resourcemodel die de SKU vertegenwoordigt SKU-
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen

AgentUpdateEigenschappen

Naam Beschrijving Waarde
onderhoudRamen Lijst met onderhoudsvensters. Onderhoudsvensters zijn 2 uur lang. OnderhoudVensterEigenschappen
onderhoudWindowTimeZone Tijdzone voor onderhoud zoals gedefinieerd in /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Moet worden ingesteld als useLocalTime waar is. snaar
soort Het type onderhoud voor sessiehostonderdelen. 'Standaard'
'Gepland'
useSessionHostLocalTime Of u localTime van de virtuele machine wilt gebruiken. Bool

HostPoolEigenschappen

Naam Beschrijving Waarde
agent Update De sessiehostconfiguratie voor het bijwerken van agent, bewakingsagent en stackonderdeel. AgentUpdateProperties-
customRdpEigenschap Aangepaste rdp-eigenschap van HostPool. snaar
beschrijving Beschrijving van HostPool. snaar
directUDP Standaard: AVD-instellingen worden gebruikt om de beschikbaarheid van verbindingen te bepalen, ingeschakeld: UDP probeert dit verbindingstype bij het maken van verbindingen. Dit betekent dat deze verbinding mogelijk is, maar niet wordt gegarandeerd, omdat er andere factoren zijn die dit verbindingstype kunnen voorkomen, uitgeschakeld: UDP zal dit verbindingstype niet proberen bij het maken van verbindingen 'Standaard'
'Uitgeschakeld'
'Ingeschakeld'
vriendelijke naam Beschrijvende naam van HostPool. snaar
hostPoolType Type HostPool voor desktop. 'BYODesktop'
'Persoonlijk'
'Gegroepeerd' (vereist)
loadBalancerType Het type load balancer. 'Breedtefirst'
'Diepte eerst'
'Meervoudig aanhoudend'
Persistent (vereist)
beheerdPrivateUDP Standaard: AVD-instellingen worden gebruikt om de beschikbaarheid van verbindingen te bepalen, ingeschakeld: UDP probeert dit verbindingstype bij het maken van verbindingen. Dit betekent dat deze verbinding mogelijk is, maar niet wordt gegarandeerd, omdat er andere factoren zijn die dit verbindingstype kunnen voorkomen, uitgeschakeld: UDP zal dit verbindingstype niet proberen bij het maken van verbindingen 'Standaard'
'Uitgeschakeld'
'Ingeschakeld'
beheertype Het type beheer voor deze hostpool, Geautomatiseerd of Standard. De standaardwaarde is Geautomatiseerd. 'Geautomatiseerd'
'Standaard'
maxSessionLimit De maximale sessielimiet van HostPool. Int
personalDesktopAssignmentType Type PersonalDesktopAssignment voor HostPool. 'Automatisch'
'Direct'
voorkeurAppGroupType Het type voorkeurstoepassingsgroep, standaard ingesteld op bureaubladtoepassingsgroep Bureaublad
'Geen'
'RailApplications' (vereist)
toegang tot het openbare netwerk Ingeschakeld staat toe dat deze resource toegankelijk is vanuit zowel openbare als privénetwerken. Uitgeschakeld staat toe dat deze resource alleen toegankelijk is via privé-eindpunten 'Uitgeschakeld'
'Ingeschakeld'
'Alleen ingeschakeldVoorClients'
'Alleen ingeschakeldForSessionHosts'
publiekUDP Standaard: AVD-instellingen worden gebruikt om de beschikbaarheid van verbindingen te bepalen, ingeschakeld: UDP probeert dit verbindingstype bij het maken van verbindingen. Dit betekent dat deze verbinding mogelijk is, maar niet wordt gegarandeerd, omdat er andere factoren zijn die dit verbindingstype kunnen voorkomen, uitgeschakeld: UDP zal dit verbindingstype niet proberen bij het maken van verbindingen 'Standaard'
'Uitgeschakeld'
'Ingeschakeld'
registratieInfo De registratiegegevens van HostPool. Dit wordt niet geretourneerd op GET. Als u het registratietoken wilt ophalen, gebruikt u het retrieveRegistrationToken of listRegistrationTokens POST-aanroepen. RegistrationInfo-
relaisUDP Standaard: AVD-instellingen worden gebruikt om de beschikbaarheid van verbindingen te bepalen, ingeschakeld: UDP probeert dit verbindingstype bij het maken van verbindingen. Dit betekent dat deze verbinding mogelijk is, maar niet wordt gegarandeerd, omdat er andere factoren zijn die dit verbindingstype kunnen voorkomen, uitgeschakeld: UDP zal dit verbindingstype niet proberen bij het maken van verbindingen 'Standaard'
'Uitgeschakeld'
'Ingeschakeld'
ring Het ringnummer van HostPool. Int
ssoadfsAutoriteit URL naar de ADFS-server van de klant voor het ondertekenen van WVD SSO-certificaten. snaar
ssoClientId ClientId voor de geregistreerde Relying Party die wordt gebruikt voor het uitgeven van WVD SSO-certificaten. snaar
ssoClientSecretKeyVaultPath Pad naar Azure KeyVault waarmee het geheim wordt opgeslagen dat wordt gebruikt voor communicatie met ADFS. snaar
ssoSecretType Het type eenmalige aanmelding bij Secret Type. 'Certificaat'
CertificateInKeyVault
'Gedeelde sleutel'
SharedKeyInKeyVault
startVMOnVerbinden De vlag voor het in-/uitschakelen van de functie StartVMOnConnect. Bool
validatieOmgeving Is validatieomgeving. Bool
vmSjabloon VM-sjabloon voor sessionhosts-configuratie in hostpool. snaar

OnderhoudVensterEigenschappen

Naam Beschrijving Waarde
dagVanDeWeek Dag van de week. 'Vrijdag'
'Maandag'
'Zaterdag'
'Zondag'
'Donderdag'
'Dinsdag'
'Woensdag'
uur Het beginuur van de update van de dag. (0 - 23) Int

Beheerde ServiceIdentity

Naam Beschrijving Waarde
soort Type beheerde service-identiteit (waarbij zowel SystemAssigned- als UserAssigned-typen zijn toegestaan). 'Geen'
'Systeem toegewezen'
'SystemAssigned, UserAssigned'
UserAssigned (vereist)
gebruikers-toegewezen identiteiten De set door de gebruiker toegewezen identiteiten die aan de resource zijn gekoppeld. De woordenlijstsleutels userAssignedIdentities zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. De waarden van de woordenlijst kunnen lege objecten ({}) zijn in aanvragen. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Naam Beschrijving Waarde

Plannen

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 Data Market. tekenreeks (vereist)
PromotieCode Een uitgever heeft promotiecode verstrekt zoals ingericht in Data Market voor het genoemde product/artefact. snaar
uitgever De uitgever van het artefact van derden dat wordt gekocht. Bijvoorbeeld NewRelic tekenreeks (vereist)
Versie De versie van het gewenste product/artefact. snaar

Registratie Info

Naam Beschrijving Waarde
vervaltijd Verlooptijd van registratietoken. snaar
registrationTokenOperation Het type opnieuw instellen van het token. 'Verwijderen'
'Geen'
'Bijwerken'
teken De met base64 gecodeerde tekenreeks voor het registratietoken. snaar

Sku

Naam Beschrijving Waarde
capaciteit 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
Familie Als de service verschillende generaties hardware heeft, voor dezelfde SKU, kan die hier worden vastgelegd. snaar
naam De naam van de SKU. Bijvoorbeeld P3. Dit 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. snaar
rang 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'
'Premie'
'Standaard'

Gevolgde brontags

Naam Beschrijving Waarde

GebruikerstoewijzendeIdentiteit

Naam Beschrijving Waarde

Gebruiksvoorbeelden

Geverifieerde Azure-modules

De volgende azure-geverifieerde modules kunnen worden gebruikt om dit resourcetype te implementeren.

Moduul Beschrijving
AVD-hostgroep (Azure Virtual Desktop) AVM-resourcemodule voor AVD-hostgroep (Azure Virtual Desktop)

Azure-snelstartvoorbeelden

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

Bicep-bestand Beschrijving
MAAKT AVD met Microsoft Entra ID Join Met deze sjabloon kunt u Azure Virtual Desktop-resources maken, zoals hostgroep, toepassingsgroep, werkruimte, een host voor een testsessie en de extensies ervan met Microsoft Entra ID-deelname

Resourcedefinitie van ARM-sjabloon

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

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

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

{
  "type": "Microsoft.DesktopVirtualization/hostPools",
  "apiVersion": "2025-03-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "managedBy": "string",
  "plan": {
    "name": "string",
    "product": "string",
    "promotionCode": "string",
    "publisher": "string",
    "version": "string"
  },
  "properties": {
    "agentUpdate": {
      "maintenanceWindows": [
        {
          "dayOfWeek": "string",
          "hour": "int"
        }
      ],
      "maintenanceWindowTimeZone": "string",
      "type": "string",
      "useSessionHostLocalTime": "bool"
    },
    "customRdpProperty": "string",
    "description": "string",
    "directUDP": "string",
    "friendlyName": "string",
    "hostPoolType": "string",
    "loadBalancerType": "string",
    "managedPrivateUDP": "string",
    "managementType": "string",
    "maxSessionLimit": "int",
    "personalDesktopAssignmentType": "string",
    "preferredAppGroupType": "string",
    "publicNetworkAccess": "string",
    "publicUDP": "string",
    "registrationInfo": {
      "expirationTime": "string",
      "registrationTokenOperation": "string",
      "token": "string"
    },
    "relayUDP": "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Eigenschapswaarden

Microsoft.DesktopVirtualization/hostPools

Naam Beschrijving Waarde
apiVersion De API-versie '2025-03-01-voorbeschouwing'
identiteit Beheerde service-identiteit (door het systeem toegewezen en/of door de gebruiker toegewezen identiteiten) ManagedServiceIdentity-
soort Metagegevens die worden gebruikt door portal/tooling/etc om verschillende UX-ervaringen weer te geven voor resources van hetzelfde type. ApiApps is bijvoorbeeld een type Microsoft.Web/sites. Indien ondersteund, moet de resourceprovider deze waarde valideren en behouden. snaar

Beperkingen:
Patroon = ^[-\w\._,\(\)]+$
plaats De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
beheerd door 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 dit aanwezig is, wordt de resource niet verwijderd als deze uit de sjabloon wordt verwijderd omdat deze wordt beheerd door een andere resource. snaar
naam De resourcenaam snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 255
Patroon = ^[A-Za-z0-9@.\-_ ]*$ (vereist)
voorstel, schema, strategie (depending on context) Plan de resource. plannen
Eigenschappen Gedetailleerde eigenschappen voor HostPool HostPoolProperties (vereist)
Sku De definitie van het resourcemodel die de SKU vertegenwoordigt SKU-
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen
soort Het resourcetype 'Microsoft.DesktopVirtualization/hostPools'

AgentUpdateEigenschappen

Naam Beschrijving Waarde
onderhoudRamen Lijst met onderhoudsvensters. Onderhoudsvensters zijn 2 uur lang. OnderhoudVensterEigenschappen
onderhoudWindowTimeZone Tijdzone voor onderhoud zoals gedefinieerd in /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Moet worden ingesteld als useLocalTime waar is. snaar
soort Het type onderhoud voor sessiehostonderdelen. 'Standaard'
'Gepland'
useSessionHostLocalTime Of u localTime van de virtuele machine wilt gebruiken. Bool

HostPoolEigenschappen

Naam Beschrijving Waarde
agent Update De sessiehostconfiguratie voor het bijwerken van agent, bewakingsagent en stackonderdeel. AgentUpdateProperties-
customRdpEigenschap Aangepaste rdp-eigenschap van HostPool. snaar
beschrijving Beschrijving van HostPool. snaar
directUDP Standaard: AVD-instellingen worden gebruikt om de beschikbaarheid van verbindingen te bepalen, ingeschakeld: UDP probeert dit verbindingstype bij het maken van verbindingen. Dit betekent dat deze verbinding mogelijk is, maar niet wordt gegarandeerd, omdat er andere factoren zijn die dit verbindingstype kunnen voorkomen, uitgeschakeld: UDP zal dit verbindingstype niet proberen bij het maken van verbindingen 'Standaard'
'Uitgeschakeld'
'Ingeschakeld'
vriendelijke naam Beschrijvende naam van HostPool. snaar
hostPoolType Type HostPool voor desktop. 'BYODesktop'
'Persoonlijk'
'Gegroepeerd' (vereist)
loadBalancerType Het type load balancer. 'Breedtefirst'
'Diepte eerst'
'Meervoudig aanhoudend'
Persistent (vereist)
beheerdPrivateUDP Standaard: AVD-instellingen worden gebruikt om de beschikbaarheid van verbindingen te bepalen, ingeschakeld: UDP probeert dit verbindingstype bij het maken van verbindingen. Dit betekent dat deze verbinding mogelijk is, maar niet wordt gegarandeerd, omdat er andere factoren zijn die dit verbindingstype kunnen voorkomen, uitgeschakeld: UDP zal dit verbindingstype niet proberen bij het maken van verbindingen 'Standaard'
'Uitgeschakeld'
'Ingeschakeld'
beheertype Het type beheer voor deze hostpool, Geautomatiseerd of Standard. De standaardwaarde is Geautomatiseerd. 'Geautomatiseerd'
'Standaard'
maxSessionLimit De maximale sessielimiet van HostPool. Int
personalDesktopAssignmentType Type PersonalDesktopAssignment voor HostPool. 'Automatisch'
'Direct'
voorkeurAppGroupType Het type voorkeurstoepassingsgroep, standaard ingesteld op bureaubladtoepassingsgroep Bureaublad
'Geen'
'RailApplications' (vereist)
toegang tot het openbare netwerk Ingeschakeld staat toe dat deze resource toegankelijk is vanuit zowel openbare als privénetwerken. Uitgeschakeld staat toe dat deze resource alleen toegankelijk is via privé-eindpunten 'Uitgeschakeld'
'Ingeschakeld'
'Alleen ingeschakeldVoorClients'
'Alleen ingeschakeldForSessionHosts'
publiekUDP Standaard: AVD-instellingen worden gebruikt om de beschikbaarheid van verbindingen te bepalen, ingeschakeld: UDP probeert dit verbindingstype bij het maken van verbindingen. Dit betekent dat deze verbinding mogelijk is, maar niet wordt gegarandeerd, omdat er andere factoren zijn die dit verbindingstype kunnen voorkomen, uitgeschakeld: UDP zal dit verbindingstype niet proberen bij het maken van verbindingen 'Standaard'
'Uitgeschakeld'
'Ingeschakeld'
registratieInfo De registratiegegevens van HostPool. Dit wordt niet geretourneerd op GET. Als u het registratietoken wilt ophalen, gebruikt u het retrieveRegistrationToken of listRegistrationTokens POST-aanroepen. RegistrationInfo-
relaisUDP Standaard: AVD-instellingen worden gebruikt om de beschikbaarheid van verbindingen te bepalen, ingeschakeld: UDP probeert dit verbindingstype bij het maken van verbindingen. Dit betekent dat deze verbinding mogelijk is, maar niet wordt gegarandeerd, omdat er andere factoren zijn die dit verbindingstype kunnen voorkomen, uitgeschakeld: UDP zal dit verbindingstype niet proberen bij het maken van verbindingen 'Standaard'
'Uitgeschakeld'
'Ingeschakeld'
ring Het ringnummer van HostPool. Int
ssoadfsAutoriteit URL naar de ADFS-server van de klant voor het ondertekenen van WVD SSO-certificaten. snaar
ssoClientId ClientId voor de geregistreerde Relying Party die wordt gebruikt voor het uitgeven van WVD SSO-certificaten. snaar
ssoClientSecretKeyVaultPath Pad naar Azure KeyVault waarmee het geheim wordt opgeslagen dat wordt gebruikt voor communicatie met ADFS. snaar
ssoSecretType Het type eenmalige aanmelding bij Secret Type. 'Certificaat'
CertificateInKeyVault
'Gedeelde sleutel'
SharedKeyInKeyVault
startVMOnVerbinden De vlag voor het in-/uitschakelen van de functie StartVMOnConnect. Bool
validatieOmgeving Is validatieomgeving. Bool
vmSjabloon VM-sjabloon voor sessionhosts-configuratie in hostpool. snaar

OnderhoudVensterEigenschappen

Naam Beschrijving Waarde
dagVanDeWeek Dag van de week. 'Vrijdag'
'Maandag'
'Zaterdag'
'Zondag'
'Donderdag'
'Dinsdag'
'Woensdag'
uur Het beginuur van de update van de dag. (0 - 23) Int

Beheerde ServiceIdentity

Naam Beschrijving Waarde
soort Type beheerde service-identiteit (waarbij zowel SystemAssigned- als UserAssigned-typen zijn toegestaan). 'Geen'
'Systeem toegewezen'
'SystemAssigned, UserAssigned'
UserAssigned (vereist)
gebruikers-toegewezen identiteiten De set door de gebruiker toegewezen identiteiten die aan de resource zijn gekoppeld. De woordenlijstsleutels userAssignedIdentities zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. De waarden van de woordenlijst kunnen lege objecten ({}) zijn in aanvragen. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Naam Beschrijving Waarde

Plannen

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 Data Market. tekenreeks (vereist)
PromotieCode Een uitgever heeft promotiecode verstrekt zoals ingericht in Data Market voor het genoemde product/artefact. snaar
uitgever De uitgever van het artefact van derden dat wordt gekocht. Bijvoorbeeld NewRelic tekenreeks (vereist)
Versie De versie van het gewenste product/artefact. snaar

Registratie Info

Naam Beschrijving Waarde
vervaltijd Verlooptijd van registratietoken. snaar
registrationTokenOperation Het type opnieuw instellen van het token. 'Verwijderen'
'Geen'
'Bijwerken'
teken De met base64 gecodeerde tekenreeks voor het registratietoken. snaar

Sku

Naam Beschrijving Waarde
capaciteit 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
Familie Als de service verschillende generaties hardware heeft, voor dezelfde SKU, kan die hier worden vastgelegd. snaar
naam De naam van de SKU. Bijvoorbeeld P3. Dit 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. snaar
rang 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'
'Premie'
'Standaard'

Gevolgde brontags

Naam Beschrijving Waarde

GebruikerstoewijzendeIdentiteit

Naam Beschrijving Waarde

Gebruiksvoorbeelden

Azure-snelstartsjablonen

De volgende Azure-quickstartsjablonen dit resourcetype implementeren.

Sjabloon Beschrijving
MAAKT AVD met Microsoft Entra ID Join

implementeren in Azure 		Met deze sjabloon kunt u Azure Virtual Desktop-resources maken, zoals hostgroep, toepassingsgroep, werkruimte, een host voor een testsessie en de extensies ervan met Microsoft Entra ID-deelname

Resourcedefinitie van Terraform (AzAPI-provider)

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

  • resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DesktopVirtualization/hostPools@2025-03-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    kind = "string"
    managedBy = "string"
    plan = {
      name = "string"
      product = "string"
      promotionCode = "string"
      publisher = "string"
      version = "string"
    }
    properties = {
      agentUpdate = {
        maintenanceWindows = [
          {
            dayOfWeek = "string"
            hour = int
          }
        ]
        maintenanceWindowTimeZone = "string"
        type = "string"
        useSessionHostLocalTime = bool
      }
      customRdpProperty = "string"
      description = "string"
      directUDP = "string"
      friendlyName = "string"
      hostPoolType = "string"
      loadBalancerType = "string"
      managedPrivateUDP = "string"
      managementType = "string"
      maxSessionLimit = int
      personalDesktopAssignmentType = "string"
      preferredAppGroupType = "string"
      publicNetworkAccess = "string"
      publicUDP = "string"
      registrationInfo = {
        expirationTime = "string"
        registrationTokenOperation = "string"
        token = "string"
      }
      relayUDP = "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"
    }
  }
}

Eigenschapswaarden

Microsoft.DesktopVirtualization/hostPools

Naam Beschrijving Waarde
identiteit Beheerde service-identiteit (door het systeem toegewezen en/of door de gebruiker toegewezen identiteiten) ManagedServiceIdentity-
soort Metagegevens die worden gebruikt door portal/tooling/etc om verschillende UX-ervaringen weer te geven voor resources van hetzelfde type. ApiApps is bijvoorbeeld een type Microsoft.Web/sites. Indien ondersteund, moet de resourceprovider deze waarde valideren en behouden. snaar

Beperkingen:
Patroon = ^[-\w\._,\(\)]+$
plaats De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
beheerd door 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 dit aanwezig is, wordt de resource niet verwijderd als deze uit de sjabloon wordt verwijderd omdat deze wordt beheerd door een andere resource. snaar
naam De resourcenaam snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 255
Patroon = ^[A-Za-z0-9@.\-_ ]*$ (vereist)
voorstel, schema, strategie (depending on context) Plan de resource. plannen
Eigenschappen Gedetailleerde eigenschappen voor HostPool HostPoolProperties (vereist)
Sku De definitie van het resourcemodel die de SKU vertegenwoordigt SKU-
Tags Resourcetags Woordenlijst met tagnamen en -waarden.
soort Het resourcetype "Microsoft.DesktopVirtualization/hostPools@2025-03-01-preview"

AgentUpdateEigenschappen

Naam Beschrijving Waarde
onderhoudRamen Lijst met onderhoudsvensters. Onderhoudsvensters zijn 2 uur lang. OnderhoudVensterEigenschappen
onderhoudWindowTimeZone Tijdzone voor onderhoud zoals gedefinieerd in /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Moet worden ingesteld als useLocalTime waar is. snaar
soort Het type onderhoud voor sessiehostonderdelen. 'Standaard'
'Gepland'
useSessionHostLocalTime Of u localTime van de virtuele machine wilt gebruiken. Bool

HostPoolEigenschappen

Naam Beschrijving Waarde
agent Update De sessiehostconfiguratie voor het bijwerken van agent, bewakingsagent en stackonderdeel. AgentUpdateProperties-
customRdpEigenschap Aangepaste rdp-eigenschap van HostPool. snaar
beschrijving Beschrijving van HostPool. snaar
directUDP Standaard: AVD-instellingen worden gebruikt om de beschikbaarheid van verbindingen te bepalen, ingeschakeld: UDP probeert dit verbindingstype bij het maken van verbindingen. Dit betekent dat deze verbinding mogelijk is, maar niet wordt gegarandeerd, omdat er andere factoren zijn die dit verbindingstype kunnen voorkomen, uitgeschakeld: UDP zal dit verbindingstype niet proberen bij het maken van verbindingen 'Standaard'
'Uitgeschakeld'
'Ingeschakeld'
vriendelijke naam Beschrijvende naam van HostPool. snaar
hostPoolType Type HostPool voor desktop. 'BYODesktop'
'Persoonlijk'
'Gegroepeerd' (vereist)
loadBalancerType Het type load balancer. 'Breedtefirst'
'Diepte eerst'
'Meervoudig aanhoudend'
Persistent (vereist)
beheerdPrivateUDP Standaard: AVD-instellingen worden gebruikt om de beschikbaarheid van verbindingen te bepalen, ingeschakeld: UDP probeert dit verbindingstype bij het maken van verbindingen. Dit betekent dat deze verbinding mogelijk is, maar niet wordt gegarandeerd, omdat er andere factoren zijn die dit verbindingstype kunnen voorkomen, uitgeschakeld: UDP zal dit verbindingstype niet proberen bij het maken van verbindingen 'Standaard'
'Uitgeschakeld'
'Ingeschakeld'
beheertype Het type beheer voor deze hostpool, Geautomatiseerd of Standard. De standaardwaarde is Geautomatiseerd. 'Geautomatiseerd'
'Standaard'
maxSessionLimit De maximale sessielimiet van HostPool. Int
personalDesktopAssignmentType Type PersonalDesktopAssignment voor HostPool. 'Automatisch'
'Direct'
voorkeurAppGroupType Het type voorkeurstoepassingsgroep, standaard ingesteld op bureaubladtoepassingsgroep Bureaublad
'Geen'
'RailApplications' (vereist)
toegang tot het openbare netwerk Ingeschakeld staat toe dat deze resource toegankelijk is vanuit zowel openbare als privénetwerken. Uitgeschakeld staat toe dat deze resource alleen toegankelijk is via privé-eindpunten 'Uitgeschakeld'
'Ingeschakeld'
'Alleen ingeschakeldVoorClients'
'Alleen ingeschakeldForSessionHosts'
publiekUDP Standaard: AVD-instellingen worden gebruikt om de beschikbaarheid van verbindingen te bepalen, ingeschakeld: UDP probeert dit verbindingstype bij het maken van verbindingen. Dit betekent dat deze verbinding mogelijk is, maar niet wordt gegarandeerd, omdat er andere factoren zijn die dit verbindingstype kunnen voorkomen, uitgeschakeld: UDP zal dit verbindingstype niet proberen bij het maken van verbindingen 'Standaard'
'Uitgeschakeld'
'Ingeschakeld'
registratieInfo De registratiegegevens van HostPool. Dit wordt niet geretourneerd op GET. Als u het registratietoken wilt ophalen, gebruikt u het retrieveRegistrationToken of listRegistrationTokens POST-aanroepen. RegistrationInfo-
relaisUDP Standaard: AVD-instellingen worden gebruikt om de beschikbaarheid van verbindingen te bepalen, ingeschakeld: UDP probeert dit verbindingstype bij het maken van verbindingen. Dit betekent dat deze verbinding mogelijk is, maar niet wordt gegarandeerd, omdat er andere factoren zijn die dit verbindingstype kunnen voorkomen, uitgeschakeld: UDP zal dit verbindingstype niet proberen bij het maken van verbindingen 'Standaard'
'Uitgeschakeld'
'Ingeschakeld'
ring Het ringnummer van HostPool. Int
ssoadfsAutoriteit URL naar de ADFS-server van de klant voor het ondertekenen van WVD SSO-certificaten. snaar
ssoClientId ClientId voor de geregistreerde Relying Party die wordt gebruikt voor het uitgeven van WVD SSO-certificaten. snaar
ssoClientSecretKeyVaultPath Pad naar Azure KeyVault waarmee het geheim wordt opgeslagen dat wordt gebruikt voor communicatie met ADFS. snaar
ssoSecretType Het type eenmalige aanmelding bij Secret Type. 'Certificaat'
CertificateInKeyVault
'Gedeelde sleutel'
SharedKeyInKeyVault
startVMOnVerbinden De vlag voor het in-/uitschakelen van de functie StartVMOnConnect. Bool
validatieOmgeving Is validatieomgeving. Bool
vmSjabloon VM-sjabloon voor sessionhosts-configuratie in hostpool. snaar

OnderhoudVensterEigenschappen

Naam Beschrijving Waarde
dagVanDeWeek Dag van de week. 'Vrijdag'
'Maandag'
'Zaterdag'
'Zondag'
'Donderdag'
'Dinsdag'
'Woensdag'
uur Het beginuur van de update van de dag. (0 - 23) Int

Beheerde ServiceIdentity

Naam Beschrijving Waarde
soort Type beheerde service-identiteit (waarbij zowel SystemAssigned- als UserAssigned-typen zijn toegestaan). 'Geen'
'Systeem toegewezen'
'SystemAssigned, UserAssigned'
UserAssigned (vereist)
gebruikers-toegewezen identiteiten De set door de gebruiker toegewezen identiteiten die aan de resource zijn gekoppeld. De woordenlijstsleutels userAssignedIdentities zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. De waarden van de woordenlijst kunnen lege objecten ({}) zijn in aanvragen. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Naam Beschrijving Waarde

Plannen

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 Data Market. tekenreeks (vereist)
PromotieCode Een uitgever heeft promotiecode verstrekt zoals ingericht in Data Market voor het genoemde product/artefact. snaar
uitgever De uitgever van het artefact van derden dat wordt gekocht. Bijvoorbeeld NewRelic tekenreeks (vereist)
Versie De versie van het gewenste product/artefact. snaar

Registratie Info

Naam Beschrijving Waarde
vervaltijd Verlooptijd van registratietoken. snaar
registrationTokenOperation Het type opnieuw instellen van het token. 'Verwijderen'
'Geen'
'Bijwerken'
teken De met base64 gecodeerde tekenreeks voor het registratietoken. snaar

Sku

Naam Beschrijving Waarde
capaciteit 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
Familie Als de service verschillende generaties hardware heeft, voor dezelfde SKU, kan die hier worden vastgelegd. snaar
naam De naam van de SKU. Bijvoorbeeld P3. Dit 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. snaar
rang 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'
'Premie'
'Standaard'

Gevolgde brontags

Naam Beschrijving Waarde

GebruikerstoewijzendeIdentiteit

Naam Beschrijving Waarde

Gebruiksvoorbeelden

Geverifieerde Azure-modules

De volgende azure-geverifieerde modules kunnen worden gebruikt om dit resourcetype te implementeren.

Moduul Beschrijving
AVD-hostgroep (Azure Virtual Desktop) AVM-resourcemodule voor AVD-hostgroep (Azure Virtual Desktop)