Dela via

Microsoft.DesktopVirtualization hostPools

Bicep-resursdefinition

Resurstypen hostPools kan distribueras med åtgärder som mål:

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

Resursformat

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

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

Egenskapsvärden

Microsoft.DesktopVirtualization/hostPools

Namn Beskrivning Värde
identitet Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter) ManagedServiceIdentity (HanteradServiceIdentitet)
sort Metadata som används av portal/verktyg/etc för att återge olika UX-funktioner för resurser av samma typ. ApiApps är t.ex. en typ av Microsoft.Web/sites-typ. Om det stöds måste resursprovidern verifiera och bevara det här värdet. sträng

Begränsningar:
Mönster = ^[-\w\._,\(\)]+$
plats Den geo-plats där resursen finns sträng (krävs)
hanterasAv Det fullständigt kvalificerade resurs-ID:t för resursen som hanterar den här resursen. Anger om den här resursen hanteras av en annan Azure-resurs. Om detta finns tar distributionen i fullständigt läge inte bort resursen om den tas bort från mallen eftersom den hanteras av en annan resurs. sträng
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 255
Mönster = ^[A-Za-z0-9@.\-_ ]*$ (krävs)
plan/planering/strategi Planera för resursen. Plan
Egenskaper Detaljerade egenskaper för HostPool HostPoolProperties (krävs)
Sku Resursmodelldefinitionen som representerar SKU Sku
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar

AgentUpdateProperties (på engelska)

Namn Beskrivning Värde
underhållWindows Lista över underhållsperioder. Underhållsfönstren är 2 timmar långa. UnderhållWindowProperties[]
underhållWindowTimeZone Tidszon för underhåll enligt definitionen i /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Måste anges om useLocalTime är sant. sträng
typ Typ av underhåll för sessionsvärdkomponenter. "Standard"
"Schemalagd"
useSessionHostLocalTime Om du vill använda localTime för den virtuella datorn. Bool

HostPoolEgenskaper

Namn Beskrivning Värde
agentUpdate Sessionsvärdkonfigurationen för uppdatering av agent, övervakningsagent och stackkomponent. AgentUpdateProperties (på engelska)
customRdpProperty Anpassad rdp-egenskap för HostPool. sträng
beskrivning Beskrivning av HostPool. sträng
directUDP Standard: AVD-wide-inställningar används för att fastställa anslutningstillgänglighet, Aktiverad: UDP försöker med den här anslutningstypen när anslutningar upprättas. Det innebär att den här anslutningen är möjlig men inte garanterad eftersom det finns andra faktorer som kan förhindra den här anslutningstypen. Inaktiverad: UDP försöker inte med den här anslutningstypen när anslutningar upprättas "Standard"
"Inaktiverad"
"Aktiverad"
användarvänligt namn Eget namn på HostPool. sträng
hostPoolType HostPool-typ för skrivbord. "BYODesktop"
"Personligt"
"Pooled" (krävs)
loadBalancerType Typen av lastbalanserare. "BreadthFirst"
"DepthFirst"
"MultiplePersistent"
"Beständiga" (krävs)
managedPrivateUDP Standard: AVD-wide-inställningar används för att fastställa anslutningstillgänglighet, Aktiverad: UDP försöker med den här anslutningstypen när anslutningar upprättas. Det innebär att den här anslutningen är möjlig men inte garanterad eftersom det finns andra faktorer som kan förhindra den här anslutningstypen. Inaktiverad: UDP försöker inte med den här anslutningstypen när anslutningar upprättas "Standard"
"Inaktiverad"
"Aktiverad"
förvaltningstyp Typ av hantering för den här värdpoolen, Automatiserad eller Standard. Standardvärdet är Automatiserad. "Automatiserad"
"Standard"
maxSessionLimit Maximal sessionsgräns för HostPool. Int
personalDesktopAssignmentType PersonalDesktopAssignment-typ för HostPool. "Automatisk"
"Direkt"
preferredAppGroupType Typ av önskad programgruppstyp, standard för skrivbordsprogramgrupp "Desktop"
"Ingen"
"RailApplications" (krävs)
publicNetworkAccess (publicNetworkÅtkomst) Aktiverad gör att den här resursen kan nås från både offentliga och privata nätverk. Inaktiverad tillåter att den här resursen endast nås via privata slutpunkter "Inaktiverad"
"Aktiverad"
"EnabledForClientsOnly"
"EnabledForSessionHostsOnly"
publicUDP Standard: AVD-wide-inställningar används för att fastställa anslutningstillgänglighet, Aktiverad: UDP försöker med den här anslutningstypen när anslutningar upprättas. Det innebär att den här anslutningen är möjlig men inte garanterad eftersom det finns andra faktorer som kan förhindra den här anslutningstypen. Inaktiverad: UDP försöker inte med den här anslutningstypen när anslutningar upprättas "Standard"
"Inaktiverad"
"Aktiverad"
registreringInfo Registreringsinformationen för HostPool. Detta returneras inte på GET. För att hämta registreringstoken använder du POST-anropen retrieveRegistrationToken eller listRegistrationTokens. RegistrationInfo (på engelska)
reläUDP Standard: AVD-wide-inställningar används för att fastställa anslutningstillgänglighet, Aktiverad: UDP försöker med den här anslutningstypen när anslutningar upprättas. Det innebär att den här anslutningen är möjlig men inte garanterad eftersom det finns andra faktorer som kan förhindra den här anslutningstypen. Inaktiverad: UDP försöker inte med den här anslutningstypen när anslutningar upprättas "Standard"
"Inaktiverad"
"Aktiverad"
ring Ringnumret för HostPool. Int
ssoadfsmyndighet URL till kundens ADFS-server för signering av WVD SSO-certifikat. sträng
ssoClientId ClientId för den registrerade förlitande parten som används för att utfärda WVD SSO-certifikat. sträng
ssoClientSecretKeyVaultPath Sökväg till Azure KeyVault som lagrar hemligheten som används för kommunikation till ADFS. sträng
ssoSecretType Typen av enkel inloggning på hemlig typ. "Certifikat"
"CertificateInKeyVault"
"SharedKey"
"SharedKeyInKeyVault"
startVMOnConnect Flaggan för att aktivera/inaktivera funktionen StartVMOnConnect. Bool
validationEnvironment (validering) Är valideringsmiljö. Bool
vm-mall VM-mall för konfiguration av sessionsvärdar i värdpoolen. sträng

UnderhållWindowProperties

Namn Beskrivning Värde
veckodag Dag i veckan. "Fredag"
"Måndag"
"Lördag"
"Söndag"
"Torsdag"
"Tisdag"
"Onsdag"
timme Uppdateringsstarttimen för dagen. (0 - 23) Int

ManagedServiceIdentity (HanteradServiceIdentitet)

Namn Beskrivning Värde
typ Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts). "Ingen"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (krävs)
användartilldelade identiteter Uppsättningen användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden. ManagedServiceIdentityUserAssignedIdentiteter

ManagedServiceIdentityUserAssignedIdentiteter

Namn Beskrivning Värde

Strategi

Namn Beskrivning Värde
Namn Ett användardefinierat namn på den artefakt från tredje part som införskaffas. sträng (krävs)
produkt Artefakten från tredje part som införskaffas. T.ex. NewRelic. Produkten mappar till OfferID som angetts för artefakten vid tidpunkten för registrering av datamarknaden. sträng (krävs)
kampanjkod En utgivare tillhandahöll kampanjkod som etablerats på datamarknaden för den nämnda produkten/artefakten. sträng
förläggare Utgivaren av den tredjepartsartefakt som köps. T.ex. NewRelic sträng (krävs)
version Versionen av önskad produkt/artefakt. sträng

RegistrationInfo (på engelska)

Namn Beskrivning Värde
utgångstid Förfallotid för registreringstoken. sträng
registrationTokenOperation Typ av återställning av token. "Ta bort"
"Ingen"
"Uppdatera"
bevis Den base64-kodade strängen för registreringstoken. sträng

Sku

Namn Beskrivning Värde
kapacitet Om SKU:n stöder utskalning/in bör kapacitets heltal inkluderas. Om det inte går att skala ut/in för resursen kan detta utelämnas. Int
familj Om tjänsten har olika generationer av maskinvara, för samma SKU, kan den samlas in här. sträng
Namn Namnet på SKU:n. T.ex. P3. Det är vanligtvis en bokstav+nummerkod sträng (krävs)
storlek SKU-storleken. När namnfältet är kombinationen av nivå och något annat värde är detta den fristående koden. sträng
Nivå Det här fältet måste implementeras av resursprovidern om tjänsten har mer än en nivå, men inte krävs på en PUT. "Grundläggande"
"Kostnadsfri"
"Premium"
"Standard"

Spårade resurstaggar

Namn Beskrivning Värde

Användartilldelad identitet

Namn Beskrivning Värde

Användningsexempel

Azure-verifierade moduler

Följande Azure-verifierade moduler kan användas för att distribuera den här resurstypen.

Modul Beskrivning
Värdpool för Azure Virtual Desktop (AVD) AVM-resursmodul för Värdpool för Azure Virtual Desktop (AVD)

Azure-snabbstartsexempel

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

Bicep-fil Beskrivning
skapar AVD med Microsoft Entra ID Join Med den här mallen kan du skapa Azure Virtual Desktop-resurser som värdpool, programgrupp, arbetsyta, en testsessionsvärd och dess tillägg med Microsoft Entra ID-anslutning

Resursdefinition för ARM-mall

Resurstypen hostPools kan distribueras med åtgärder som mål:

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

Resursformat

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

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

Egenskapsvärden

Microsoft.DesktopVirtualization/hostPools

Namn Beskrivning Värde
apiVersion API-versionen "2025-03-01-preview"
identitet Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter) ManagedServiceIdentity (HanteradServiceIdentitet)
sort Metadata som används av portal/verktyg/etc för att återge olika UX-funktioner för resurser av samma typ. ApiApps är t.ex. en typ av Microsoft.Web/sites-typ. Om det stöds måste resursprovidern verifiera och bevara det här värdet. sträng

Begränsningar:
Mönster = ^[-\w\._,\(\)]+$
plats Den geo-plats där resursen finns sträng (krävs)
hanterasAv Det fullständigt kvalificerade resurs-ID:t för resursen som hanterar den här resursen. Anger om den här resursen hanteras av en annan Azure-resurs. Om detta finns tar distributionen i fullständigt läge inte bort resursen om den tas bort från mallen eftersom den hanteras av en annan resurs. sträng
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 255
Mönster = ^[A-Za-z0-9@.\-_ ]*$ (krävs)
plan/planering/strategi Planera för resursen. Plan
Egenskaper Detaljerade egenskaper för HostPool HostPoolProperties (krävs)
Sku Resursmodelldefinitionen som representerar SKU Sku
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar
typ Resurstypen "Microsoft.DesktopVirtualization/hostPools"

AgentUpdateProperties (på engelska)

Namn Beskrivning Värde
underhållWindows Lista över underhållsperioder. Underhållsfönstren är 2 timmar långa. UnderhållWindowProperties[]
underhållWindowTimeZone Tidszon för underhåll enligt definitionen i /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Måste anges om useLocalTime är sant. sträng
typ Typ av underhåll för sessionsvärdkomponenter. "Standard"
"Schemalagd"
useSessionHostLocalTime Om du vill använda localTime för den virtuella datorn. Bool

HostPoolEgenskaper

Namn Beskrivning Värde
agentUpdate Sessionsvärdkonfigurationen för uppdatering av agent, övervakningsagent och stackkomponent. AgentUpdateProperties (på engelska)
customRdpProperty Anpassad rdp-egenskap för HostPool. sträng
beskrivning Beskrivning av HostPool. sträng
directUDP Standard: AVD-wide-inställningar används för att fastställa anslutningstillgänglighet, Aktiverad: UDP försöker med den här anslutningstypen när anslutningar upprättas. Det innebär att den här anslutningen är möjlig men inte garanterad eftersom det finns andra faktorer som kan förhindra den här anslutningstypen. Inaktiverad: UDP försöker inte med den här anslutningstypen när anslutningar upprättas "Standard"
"Inaktiverad"
"Aktiverad"
användarvänligt namn Eget namn på HostPool. sträng
hostPoolType HostPool-typ för skrivbord. "BYODesktop"
"Personligt"
"Pooled" (krävs)
loadBalancerType Typen av lastbalanserare. "BreadthFirst"
"DepthFirst"
"MultiplePersistent"
"Beständiga" (krävs)
managedPrivateUDP Standard: AVD-wide-inställningar används för att fastställa anslutningstillgänglighet, Aktiverad: UDP försöker med den här anslutningstypen när anslutningar upprättas. Det innebär att den här anslutningen är möjlig men inte garanterad eftersom det finns andra faktorer som kan förhindra den här anslutningstypen. Inaktiverad: UDP försöker inte med den här anslutningstypen när anslutningar upprättas "Standard"
"Inaktiverad"
"Aktiverad"
förvaltningstyp Typ av hantering för den här värdpoolen, Automatiserad eller Standard. Standardvärdet är Automatiserad. "Automatiserad"
"Standard"
maxSessionLimit Maximal sessionsgräns för HostPool. Int
personalDesktopAssignmentType PersonalDesktopAssignment-typ för HostPool. "Automatisk"
"Direkt"
preferredAppGroupType Typ av önskad programgruppstyp, standard för skrivbordsprogramgrupp "Desktop"
"Ingen"
"RailApplications" (krävs)
publicNetworkAccess (publicNetworkÅtkomst) Aktiverad gör att den här resursen kan nås från både offentliga och privata nätverk. Inaktiverad tillåter att den här resursen endast nås via privata slutpunkter "Inaktiverad"
"Aktiverad"
"EnabledForClientsOnly"
"EnabledForSessionHostsOnly"
publicUDP Standard: AVD-wide-inställningar används för att fastställa anslutningstillgänglighet, Aktiverad: UDP försöker med den här anslutningstypen när anslutningar upprättas. Det innebär att den här anslutningen är möjlig men inte garanterad eftersom det finns andra faktorer som kan förhindra den här anslutningstypen. Inaktiverad: UDP försöker inte med den här anslutningstypen när anslutningar upprättas "Standard"
"Inaktiverad"
"Aktiverad"
registreringInfo Registreringsinformationen för HostPool. Detta returneras inte på GET. För att hämta registreringstoken använder du POST-anropen retrieveRegistrationToken eller listRegistrationTokens. RegistrationInfo (på engelska)
reläUDP Standard: AVD-wide-inställningar används för att fastställa anslutningstillgänglighet, Aktiverad: UDP försöker med den här anslutningstypen när anslutningar upprättas. Det innebär att den här anslutningen är möjlig men inte garanterad eftersom det finns andra faktorer som kan förhindra den här anslutningstypen. Inaktiverad: UDP försöker inte med den här anslutningstypen när anslutningar upprättas "Standard"
"Inaktiverad"
"Aktiverad"
ring Ringnumret för HostPool. Int
ssoadfsmyndighet URL till kundens ADFS-server för signering av WVD SSO-certifikat. sträng
ssoClientId ClientId för den registrerade förlitande parten som används för att utfärda WVD SSO-certifikat. sträng
ssoClientSecretKeyVaultPath Sökväg till Azure KeyVault som lagrar hemligheten som används för kommunikation till ADFS. sträng
ssoSecretType Typen av enkel inloggning på hemlig typ. "Certifikat"
"CertificateInKeyVault"
"SharedKey"
"SharedKeyInKeyVault"
startVMOnConnect Flaggan för att aktivera/inaktivera funktionen StartVMOnConnect. Bool
validationEnvironment (validering) Är valideringsmiljö. Bool
vm-mall VM-mall för konfiguration av sessionsvärdar i värdpoolen. sträng

UnderhållWindowProperties

Namn Beskrivning Värde
veckodag Dag i veckan. "Fredag"
"Måndag"
"Lördag"
"Söndag"
"Torsdag"
"Tisdag"
"Onsdag"
timme Uppdateringsstarttimen för dagen. (0 - 23) Int

ManagedServiceIdentity (HanteradServiceIdentitet)

Namn Beskrivning Värde
typ Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts). "Ingen"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (krävs)
användartilldelade identiteter Uppsättningen användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden. ManagedServiceIdentityUserAssignedIdentiteter

ManagedServiceIdentityUserAssignedIdentiteter

Namn Beskrivning Värde

Strategi

Namn Beskrivning Värde
Namn Ett användardefinierat namn på den artefakt från tredje part som införskaffas. sträng (krävs)
produkt Artefakten från tredje part som införskaffas. T.ex. NewRelic. Produkten mappar till OfferID som angetts för artefakten vid tidpunkten för registrering av datamarknaden. sträng (krävs)
kampanjkod En utgivare tillhandahöll kampanjkod som etablerats på datamarknaden för den nämnda produkten/artefakten. sträng
förläggare Utgivaren av den tredjepartsartefakt som köps. T.ex. NewRelic sträng (krävs)
version Versionen av önskad produkt/artefakt. sträng

RegistrationInfo (på engelska)

Namn Beskrivning Värde
utgångstid Förfallotid för registreringstoken. sträng
registrationTokenOperation Typ av återställning av token. "Ta bort"
"Ingen"
"Uppdatera"
bevis Den base64-kodade strängen för registreringstoken. sträng

Sku

Namn Beskrivning Värde
kapacitet Om SKU:n stöder utskalning/in bör kapacitets heltal inkluderas. Om det inte går att skala ut/in för resursen kan detta utelämnas. Int
familj Om tjänsten har olika generationer av maskinvara, för samma SKU, kan den samlas in här. sträng
Namn Namnet på SKU:n. T.ex. P3. Det är vanligtvis en bokstav+nummerkod sträng (krävs)
storlek SKU-storleken. När namnfältet är kombinationen av nivå och något annat värde är detta den fristående koden. sträng
Nivå Det här fältet måste implementeras av resursprovidern om tjänsten har mer än en nivå, men inte krävs på en PUT. "Grundläggande"
"Kostnadsfri"
"Premium"
"Standard"

Spårade resurstaggar

Namn Beskrivning Värde

Användartilldelad identitet

Namn Beskrivning Värde

Användningsexempel

Azure-snabbstartsmallar

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

Mall Beskrivning
skapar AVD med Microsoft Entra ID Join

Distribuera till Azure 		Med den här mallen kan du skapa Azure Virtual Desktop-resurser som värdpool, programgrupp, arbetsyta, en testsessionsvärd och dess tillägg med Microsoft Entra ID-anslutning

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen hostPools kan distribueras med åtgärder som mål:

  • Resursgrupper

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

Resursformat

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

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

Egenskapsvärden

Microsoft.DesktopVirtualization/hostPools

Namn Beskrivning Värde
identitet Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter) ManagedServiceIdentity (HanteradServiceIdentitet)
sort Metadata som används av portal/verktyg/etc för att återge olika UX-funktioner för resurser av samma typ. ApiApps är t.ex. en typ av Microsoft.Web/sites-typ. Om det stöds måste resursprovidern verifiera och bevara det här värdet. sträng

Begränsningar:
Mönster = ^[-\w\._,\(\)]+$
plats Den geo-plats där resursen finns sträng (krävs)
hanterasAv Det fullständigt kvalificerade resurs-ID:t för resursen som hanterar den här resursen. Anger om den här resursen hanteras av en annan Azure-resurs. Om detta finns tar distributionen i fullständigt läge inte bort resursen om den tas bort från mallen eftersom den hanteras av en annan resurs. sträng
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 255
Mönster = ^[A-Za-z0-9@.\-_ ]*$ (krävs)
plan/planering/strategi Planera för resursen. Plan
Egenskaper Detaljerade egenskaper för HostPool HostPoolProperties (krävs)
Sku Resursmodelldefinitionen som representerar SKU Sku
Taggar Resurstaggar Ordlista med taggnamn och värden.
typ Resurstypen "Microsoft.DesktopVirtualization/hostPools@2025-03-01-preview"

AgentUpdateProperties (på engelska)

Namn Beskrivning Värde
underhållWindows Lista över underhållsperioder. Underhållsfönstren är 2 timmar långa. UnderhållWindowProperties[]
underhållWindowTimeZone Tidszon för underhåll enligt definitionen i /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Måste anges om useLocalTime är sant. sträng
typ Typ av underhåll för sessionsvärdkomponenter. "Standard"
"Schemalagd"
useSessionHostLocalTime Om du vill använda localTime för den virtuella datorn. Bool

HostPoolEgenskaper

Namn Beskrivning Värde
agentUpdate Sessionsvärdkonfigurationen för uppdatering av agent, övervakningsagent och stackkomponent. AgentUpdateProperties (på engelska)
customRdpProperty Anpassad rdp-egenskap för HostPool. sträng
beskrivning Beskrivning av HostPool. sträng
directUDP Standard: AVD-wide-inställningar används för att fastställa anslutningstillgänglighet, Aktiverad: UDP försöker med den här anslutningstypen när anslutningar upprättas. Det innebär att den här anslutningen är möjlig men inte garanterad eftersom det finns andra faktorer som kan förhindra den här anslutningstypen. Inaktiverad: UDP försöker inte med den här anslutningstypen när anslutningar upprättas "Standard"
"Inaktiverad"
"Aktiverad"
användarvänligt namn Eget namn på HostPool. sträng
hostPoolType HostPool-typ för skrivbord. "BYODesktop"
"Personligt"
"Pooled" (krävs)
loadBalancerType Typen av lastbalanserare. "BreadthFirst"
"DepthFirst"
"MultiplePersistent"
"Beständiga" (krävs)
managedPrivateUDP Standard: AVD-wide-inställningar används för att fastställa anslutningstillgänglighet, Aktiverad: UDP försöker med den här anslutningstypen när anslutningar upprättas. Det innebär att den här anslutningen är möjlig men inte garanterad eftersom det finns andra faktorer som kan förhindra den här anslutningstypen. Inaktiverad: UDP försöker inte med den här anslutningstypen när anslutningar upprättas "Standard"
"Inaktiverad"
"Aktiverad"
förvaltningstyp Typ av hantering för den här värdpoolen, Automatiserad eller Standard. Standardvärdet är Automatiserad. "Automatiserad"
"Standard"
maxSessionLimit Maximal sessionsgräns för HostPool. Int
personalDesktopAssignmentType PersonalDesktopAssignment-typ för HostPool. "Automatisk"
"Direkt"
preferredAppGroupType Typ av önskad programgruppstyp, standard för skrivbordsprogramgrupp "Desktop"
"Ingen"
"RailApplications" (krävs)
publicNetworkAccess (publicNetworkÅtkomst) Aktiverad gör att den här resursen kan nås från både offentliga och privata nätverk. Inaktiverad tillåter att den här resursen endast nås via privata slutpunkter "Inaktiverad"
"Aktiverad"
"EnabledForClientsOnly"
"EnabledForSessionHostsOnly"
publicUDP Standard: AVD-wide-inställningar används för att fastställa anslutningstillgänglighet, Aktiverad: UDP försöker med den här anslutningstypen när anslutningar upprättas. Det innebär att den här anslutningen är möjlig men inte garanterad eftersom det finns andra faktorer som kan förhindra den här anslutningstypen. Inaktiverad: UDP försöker inte med den här anslutningstypen när anslutningar upprättas "Standard"
"Inaktiverad"
"Aktiverad"
registreringInfo Registreringsinformationen för HostPool. Detta returneras inte på GET. För att hämta registreringstoken använder du POST-anropen retrieveRegistrationToken eller listRegistrationTokens. RegistrationInfo (på engelska)
reläUDP Standard: AVD-wide-inställningar används för att fastställa anslutningstillgänglighet, Aktiverad: UDP försöker med den här anslutningstypen när anslutningar upprättas. Det innebär att den här anslutningen är möjlig men inte garanterad eftersom det finns andra faktorer som kan förhindra den här anslutningstypen. Inaktiverad: UDP försöker inte med den här anslutningstypen när anslutningar upprättas "Standard"
"Inaktiverad"
"Aktiverad"
ring Ringnumret för HostPool. Int
ssoadfsmyndighet URL till kundens ADFS-server för signering av WVD SSO-certifikat. sträng
ssoClientId ClientId för den registrerade förlitande parten som används för att utfärda WVD SSO-certifikat. sträng
ssoClientSecretKeyVaultPath Sökväg till Azure KeyVault som lagrar hemligheten som används för kommunikation till ADFS. sträng
ssoSecretType Typen av enkel inloggning på hemlig typ. "Certifikat"
"CertificateInKeyVault"
"SharedKey"
"SharedKeyInKeyVault"
startVMOnConnect Flaggan för att aktivera/inaktivera funktionen StartVMOnConnect. Bool
validationEnvironment (validering) Är valideringsmiljö. Bool
vm-mall VM-mall för konfiguration av sessionsvärdar i värdpoolen. sträng

UnderhållWindowProperties

Namn Beskrivning Värde
veckodag Dag i veckan. "Fredag"
"Måndag"
"Lördag"
"Söndag"
"Torsdag"
"Tisdag"
"Onsdag"
timme Uppdateringsstarttimen för dagen. (0 - 23) Int

ManagedServiceIdentity (HanteradServiceIdentitet)

Namn Beskrivning Värde
typ Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts). "Ingen"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (krävs)
användartilldelade identiteter Uppsättningen användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden. ManagedServiceIdentityUserAssignedIdentiteter

ManagedServiceIdentityUserAssignedIdentiteter

Namn Beskrivning Värde

Strategi

Namn Beskrivning Värde
Namn Ett användardefinierat namn på den artefakt från tredje part som införskaffas. sträng (krävs)
produkt Artefakten från tredje part som införskaffas. T.ex. NewRelic. Produkten mappar till OfferID som angetts för artefakten vid tidpunkten för registrering av datamarknaden. sträng (krävs)
kampanjkod En utgivare tillhandahöll kampanjkod som etablerats på datamarknaden för den nämnda produkten/artefakten. sträng
förläggare Utgivaren av den tredjepartsartefakt som köps. T.ex. NewRelic sträng (krävs)
version Versionen av önskad produkt/artefakt. sträng

RegistrationInfo (på engelska)

Namn Beskrivning Värde
utgångstid Förfallotid för registreringstoken. sträng
registrationTokenOperation Typ av återställning av token. "Ta bort"
"Ingen"
"Uppdatera"
bevis Den base64-kodade strängen för registreringstoken. sträng

Sku

Namn Beskrivning Värde
kapacitet Om SKU:n stöder utskalning/in bör kapacitets heltal inkluderas. Om det inte går att skala ut/in för resursen kan detta utelämnas. Int
familj Om tjänsten har olika generationer av maskinvara, för samma SKU, kan den samlas in här. sträng
Namn Namnet på SKU:n. T.ex. P3. Det är vanligtvis en bokstav+nummerkod sträng (krävs)
storlek SKU-storleken. När namnfältet är kombinationen av nivå och något annat värde är detta den fristående koden. sträng
Nivå Det här fältet måste implementeras av resursprovidern om tjänsten har mer än en nivå, men inte krävs på en PUT. "Grundläggande"
"Kostnadsfri"
"Premium"
"Standard"

Spårade resurstaggar

Namn Beskrivning Värde

Användartilldelad identitet

Namn Beskrivning Värde

Användningsexempel

Azure-verifierade moduler

Följande Azure-verifierade moduler kan användas för att distribuera den här resurstypen.

Modul Beskrivning
Värdpool för Azure Virtual Desktop (AVD) AVM-resursmodul för Värdpool för Azure Virtual Desktop (AVD)