Microsoft.DesktopVirtualisierung hostPools

Bicep-Ressourcendefinition

Der HostPools-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Verwendungsbeispiele

Von Azure verifizierte Module

Die folgenden Azure Verified Modules können verwendet werden, um diesen Ressourcentyp bereitzustellen.

Modul Beschreibung
Azure Virtual Desktop (AVD) Hostpool AVM-Ressourcenmodul für Den Azure Virtual Desktop (AVD)-Hostpool

Azure-Schnellstartbeispiele

Die folgenden Azure-Schnellstartvorlagen Bicep-Beispiele für die Bereitstellung dieses Ressourcentyps enthalten.

Bicep-Datei Beschreibung
erstellt AVD mit microsoft Entra ID Join Mit dieser Vorlage können Sie Azure Virtual Desktop-Ressourcen wie Hostpool, Anwendungsgruppe, Arbeitsbereich, einen Testsitzungshost und deren Erweiterungen mit Microsoft Entra ID erstellen.

Ressourcenformat

Um eine Microsoft.DesktopVirtualization/hostPools-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.

resource symbolicname 'Microsoft.DesktopVirtualization/hostPools@2026-04-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
    }
    allowRDPShortPathWithPrivateLink: 'string'
    conditionalRdpProperty: 'string'
    customRdpProperty: 'string'
    deploymentScope: 'string'
    description: 'string'
    directUDP: 'string'
    friendlyName: 'string'
    hostPoolType: 'string'
    loadBalancerType: 'string'
    managedPrivateUDP: 'string'
    managementType: 'string'
    maxSessionLimit: int
    oboTenantId: 'string'
    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'
  }
}

Eigenschaftswerte

Microsoft.DesktopVirtualisierung/hostPools

Name Beschreibung Wert
Identität Die verwalteten Dienstidentitäten, die dieser Ressource zugewiesen sind. ManagedServiceIdentity-
Art Metadaten, die von Portal/Tooling/etc. verwendet werden, um unterschiedliche UX-Oberflächen für Ressourcen desselben Typs zu rendern; z. B. ApiApps sind eine Art von Microsoft.Web/Sites-Typ. Wenn diese Unterstützung unterstützt wird, muss der Ressourcenanbieter diesen Wert überprüfen und beibehalten. Schnur

Zwänge:
Muster = ^[-\w\._,\(\)]+$
Ort Der geografische Standort, an dem sich die Ressource befindet Zeichenfolge (erforderlich)
managedBy Die vollqualifizierte Ressourcen-ID der Ressource, die diese Ressource verwaltet. Gibt an, ob diese Ressource von einer anderen Azure-Ressource verwaltet wird. Wenn dies vorhanden ist, löscht die Bereitstellung des vollständigen Modus die Ressource nicht, wenn sie aus der Vorlage entfernt wird, da sie von einer anderen Ressource verwaltet wird. Schnur
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 3
Max. Länge = 64
Pattern = ^[A-Za-z0-9@.\-_ ]*$ (erforderlich)
Plan Details zum Ressourcenplan. Planen
Eigenschaften Detaillierte Eigenschaften für HostPool HostPoolProperties- (erforderlich)
Sku Die dieser Ressource zugeordnete SKU (Lagerhaltungseinheit). Sku-
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen

AgentUpdate-Eigenschaften

Name Beschreibung Wert
WartungFenster Liste der Wartungsfenster. Wartungsfenster sind 2 Stunden lang. WartungFensterEigenschaften[]
maintenanceWindowTimeZone Zeitzone für wartung gemäß definition in /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Muss festgelegt werden, wenn useLocalTime "true" ist. Schnur
Art Der Wartungstyp für Sitzungshostkomponenten. 'Standard'
"Geplant"
useSessionHostLocalTime Gibt an, ob localTime des virtuellen Computers verwendet werden soll. Bool

HostPoolEigenschaften

Name Beschreibung Wert
agentAktualisieren Die Sitzungshostkonfiguration zum Aktualisieren von Agent, Überwachungs-Agent und Stapelkomponente. AgentUpdateProperties-
allowRDPShortPathWithPrivateLink Steuert, ob die Verwendung des RDPShortPath-Transports zulässig ist, wobei möglicherweise Private Link-Routen umgangen werden. "Deaktiviert"
"Aktiviert"
conditionalRdpProperty Die bedingten RDP-Eigenschaften des Hostpools, serialisiert als String im Format von <rdpPropertyName>:<type>:<value>:<conditionType>:<conditionValue>. Schnur
customRdp-Eigenschaft Benutzerdefinierte rdp-Eigenschaft von HostPool. Schnur
Einsatzbereich DeploymentScope-Typ für HostPool. 'Geographisch'
"Regional"
Beschreibung Beschreibung des HostPools. Schnur
directUDP Standard: AVD-weite Einstellungen werden verwendet, um die Verbindungsverfügbarkeit zu bestimmen, aktiviert: UDP versucht diesen Verbindungstyp beim Herstellen von Verbindungen. Dies bedeutet, dass diese Verbindung möglich ist, aber nicht garantiert ist, da es andere Faktoren gibt, die diesen Verbindungstyp verhindern können, deaktiviert: UDP versucht diesen Verbindungstyp nicht, wenn Verbindungen hergestellt werden. 'Standard'
"Deaktiviert"
"Aktiviert"
benutzerfreundlicher Name Anzeigename von HostPool. Schnur
hostPoolTyp HostPool-Typ für Desktop. 'BYODesktop'
"Persönlich"
"Pooled" (erforderlich)
loadBalancerTyp Der Typ des Lastenausgleichs. "BreadthFirst"
"DepthFirst"
"MultiplePersistent"
"Persistent" (erforderlich)
managedPrivateUDP Standard: AVD-weite Einstellungen werden verwendet, um die Verbindungsverfügbarkeit zu bestimmen, aktiviert: UDP versucht diesen Verbindungstyp beim Herstellen von Verbindungen. Dies bedeutet, dass diese Verbindung möglich ist, aber nicht garantiert ist, da es andere Faktoren gibt, die diesen Verbindungstyp verhindern können, deaktiviert: UDP versucht diesen Verbindungstyp nicht, wenn Verbindungen hergestellt werden. 'Standard'
"Deaktiviert"
"Aktiviert"
managementTyp Der Typ der Verwaltung für diesen Hostpool, automatisierte oder Standard. Der Standardwert ist automatisiert. "Automatisiert"
"Standard"
maxSessionLimit (maxSession) Der maximale Sitzungsgrenzwert von HostPool. Int
oboTenantId Mandant, für den die Ressource angefordert wird. Schnur
personalDesktopAssignmentType PersonalDesktopAssignment-Typ für HostPool. "Automatisch"
"Direkt"
preferredAppGroupType Der Typ des bevorzugten Anwendungsgruppentyps, standardmäßig desktopanwendungsgruppe "Desktop"
"Keine"
"RailApplications" (erforderlich)
Öffentlicher Netzwerkzugang Aktiviert ermöglicht den Zugriff auf diese Ressource aus öffentlichen und privaten Netzwerken. Deaktiviert ermöglicht den Zugriff auf diese Ressource nur über private Endpunkte. "Deaktiviert"
"Aktiviert"
'EnabledForClientsOnly'
'EnabledForSessionHostsOnly'
publicUDP Standard: AVD-weite Einstellungen werden verwendet, um die Verbindungsverfügbarkeit zu bestimmen, aktiviert: UDP versucht diesen Verbindungstyp beim Herstellen von Verbindungen. Dies bedeutet, dass diese Verbindung möglich ist, aber nicht garantiert ist, da es andere Faktoren gibt, die diesen Verbindungstyp verhindern können, deaktiviert: UDP versucht diesen Verbindungstyp nicht, wenn Verbindungen hergestellt werden. 'Standard'
"Deaktiviert"
"Aktiviert"
AnmeldungInfo Die Registrierungsinformationen von HostPool. RegistrationInfo-
RelaisUDP Standard: AVD-weite Einstellungen werden verwendet, um die Verbindungsverfügbarkeit zu bestimmen, aktiviert: UDP versucht diesen Verbindungstyp beim Herstellen von Verbindungen. Dies bedeutet, dass diese Verbindung möglich ist, aber nicht garantiert ist, da es andere Faktoren gibt, die diesen Verbindungstyp verhindern können, deaktiviert: UDP versucht diesen Verbindungstyp nicht, wenn Verbindungen hergestellt werden. 'Standard'
"Deaktiviert"
"Aktiviert"
Ring Die Ringnummer von HostPool. Int
ssoadfs-Behörde URL zum ADFS-Server des Kunden zum Signieren von WVD-SSO-Zertifikaten. Schnur
ssoClientId ClientId für die registrierte vertrauende Seite, die zum Ausgeben von WVD-SSO-Zertifikaten verwendet wird. Schnur
ssoClientSecretKeyVaultPath Pfad zu Azure KeyVault, der den geheimen Schlüssel speichert, der für die Kommunikation mit ADFS verwendet wird. Schnur
ssoSecretType Der Typ des einmaligen Anmeldens im geheimen Typ. "Zertifikat"
'CertificateInKeyVault'
"SharedKey"
"SharedKeyInKeyVault"
startenVMOnConnect Das Kennzeichen zum Aktivieren/Deaktivieren des StartVMOnConnect-Features. Bool
validationUmgebung Ist die Überprüfungsumgebung. Bool
vmTemplate (englisch) VM-Vorlage für die Sessionhosts-Konfiguration innerhalb des Hostpools. Schnur

MaintenanceWindowEigenschaften

Name Beschreibung Wert
TagDerWoche Wochentag. "Freitag"
"Montag"
"Samstag"
"Sonntag"
"Donnerstag"
"Dienstag"
'Mittwoch'
Stunde Die Startstunde des Updates. (0 - 23) Int

Verwaltete Dienstidentität

Name Beschreibung Wert
Art Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind). "Keine"
'SystemZugewiesen'
"SystemAssigned,UserAssigned"
"UserAssigned" (erforderlich)
vom Benutzer zugewiesene Identitäten Die Gruppe der benutzerzuweisungen Identitäten, die der Ressource zugeordnet sind. Die Wörterbuchschlüssel "userAssignedIdentities" sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Die Wörterbuchwerte können leere Objekte ({}) in Anforderungen sein. ManagedServiceIdentityUserAssignedIdentities-

ManagedServiceIdentityUserAssignedIdentities

Name Beschreibung Wert

Plan

Name Beschreibung Wert
Name Ein benutzerdefinierter Name des 3rd Party Artifact, das beschafft wird. Zeichenfolge (erforderlich)
Produkt Das 3rd Party Artefakt, das beschafft wird. Z.B. NewRelic. Das Produkt entspricht der Für das Artefakt angegebenen OfferID zum Zeitpunkt des Data Market-Onboardings. Zeichenfolge (erforderlich)
Aktionscode Ein Herausgeber hat Werbecode bereitgestellt, der im Data Market für das angegebene Produkt/Artefakt bereitgestellt wird. Schnur
Verlag Der Herausgeber des 3rd Party Artifact, das gekauft wird. Z. B. NewRelic Zeichenfolge (erforderlich)
Version Die Version des gewünschten Produkts/Artefakts. Schnur

Anmeldeinformationen

Name Beschreibung Wert
Ablaufzeit Ablaufzeit des Registrierungstokens. Schnur
registrationTokenOperation Der Typ des Zurücksetzens des Tokens. "Löschen"
"Keine"
"Aktualisieren"
Zeichen Die base64-codierte Zeichenfolge des Registrierungstokens. Schnur

Sku

Name Beschreibung Wert
Fassungsvermögen Wenn die SKU skalierungs-/in unterstützt, sollte die Ganze Kapazität eingeschlossen werden. Wenn eine Skalierung für die Ressource nicht möglich ist, wird dies möglicherweise weggelassen. Int
Familie Wenn der Dienst über unterschiedliche Hardwaregenerationen verfügt, kann dies für dieselbe SKU hier erfasst werden. Schnur
Name Der Name der SKU. Z.B. P3. Es handelt sich in der Regel um einen Buchstaben+Zahlencode. Zeichenfolge (erforderlich)
Größe Die SKU-Größe. Wenn das Namensfeld die Kombination aus Ebene und einem anderen Wert ist, wäre dies der eigenständige Code. Schnur
Rang Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst mehr als eine Ebene aufweist, für einen PUT jedoch nicht erforderlich ist. "Einfach"
"Kostenlos"
"Premium"
"Standard"

Verfolgte ResourceTags

Name Beschreibung Wert

UserAssignedIdentity

Name Beschreibung Wert

ARM-Vorlagenressourcendefinition

Der HostPools-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Verwendungsbeispiele

Azure-Schnellstartvorlagen

Die folgenden Azure-Schnellstartvorlagen diesen Ressourcentyp bereitstellen.

Schablone Beschreibung
erstellt AVD mit microsoft Entra ID Join

Bereitstellen in Azure
Mit dieser Vorlage können Sie Azure Virtual Desktop-Ressourcen wie Hostpool, Anwendungsgruppe, Arbeitsbereich, einen Testsitzungshost und deren Erweiterungen mit Microsoft Entra ID erstellen.

Ressourcenformat

Um eine Microsoft.DesktopVirtualization/hostPools-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.DesktopVirtualization/hostPools",
  "apiVersion": "2026-04-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"
    },
    "allowRDPShortPathWithPrivateLink": "string",
    "conditionalRdpProperty": "string",
    "customRdpProperty": "string",
    "deploymentScope": "string",
    "description": "string",
    "directUDP": "string",
    "friendlyName": "string",
    "hostPoolType": "string",
    "loadBalancerType": "string",
    "managedPrivateUDP": "string",
    "managementType": "string",
    "maxSessionLimit": "int",
    "oboTenantId": "string",
    "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"
  }
}

Eigenschaftswerte

Microsoft.DesktopVirtualisierung/hostPools

Name Beschreibung Wert
apiVersion (Englisch) Die API-Version '2026-04-01-Vorschau'
Identität Die verwalteten Dienstidentitäten, die dieser Ressource zugewiesen sind. ManagedServiceIdentity-
Art Metadaten, die von Portal/Tooling/etc. verwendet werden, um unterschiedliche UX-Oberflächen für Ressourcen desselben Typs zu rendern; z. B. ApiApps sind eine Art von Microsoft.Web/Sites-Typ. Wenn diese Unterstützung unterstützt wird, muss der Ressourcenanbieter diesen Wert überprüfen und beibehalten. Schnur

Zwänge:
Muster = ^[-\w\._,\(\)]+$
Ort Der geografische Standort, an dem sich die Ressource befindet Zeichenfolge (erforderlich)
managedBy Die vollqualifizierte Ressourcen-ID der Ressource, die diese Ressource verwaltet. Gibt an, ob diese Ressource von einer anderen Azure-Ressource verwaltet wird. Wenn dies vorhanden ist, löscht die Bereitstellung des vollständigen Modus die Ressource nicht, wenn sie aus der Vorlage entfernt wird, da sie von einer anderen Ressource verwaltet wird. Schnur
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 3
Max. Länge = 64
Pattern = ^[A-Za-z0-9@.\-_ ]*$ (erforderlich)
Plan Details zum Ressourcenplan. Planen
Eigenschaften Detaillierte Eigenschaften für HostPool HostPoolProperties- (erforderlich)
Sku Die dieser Ressource zugeordnete SKU (Lagerhaltungseinheit). Sku-
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Art Der Ressourcentyp 'Microsoft.DesktopVirtualisierung/hostPools'

AgentUpdate-Eigenschaften

Name Beschreibung Wert
WartungFenster Liste der Wartungsfenster. Wartungsfenster sind 2 Stunden lang. WartungFensterEigenschaften[]
maintenanceWindowTimeZone Zeitzone für wartung gemäß definition in /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Muss festgelegt werden, wenn useLocalTime "true" ist. Schnur
Art Der Wartungstyp für Sitzungshostkomponenten. 'Standard'
"Geplant"
useSessionHostLocalTime Gibt an, ob localTime des virtuellen Computers verwendet werden soll. Bool

HostPoolEigenschaften

Name Beschreibung Wert
agentAktualisieren Die Sitzungshostkonfiguration zum Aktualisieren von Agent, Überwachungs-Agent und Stapelkomponente. AgentUpdateProperties-
allowRDPShortPathWithPrivateLink Steuert, ob die Verwendung des RDPShortPath-Transports zulässig ist, wobei möglicherweise Private Link-Routen umgangen werden. "Deaktiviert"
"Aktiviert"
conditionalRdpProperty Die bedingten RDP-Eigenschaften des Hostpools, serialisiert als String im Format von <rdpPropertyName>:<type>:<value>:<conditionType>:<conditionValue>. Schnur
customRdp-Eigenschaft Benutzerdefinierte rdp-Eigenschaft von HostPool. Schnur
Einsatzbereich DeploymentScope-Typ für HostPool. 'Geographisch'
"Regional"
Beschreibung Beschreibung des HostPools. Schnur
directUDP Standard: AVD-weite Einstellungen werden verwendet, um die Verbindungsverfügbarkeit zu bestimmen, aktiviert: UDP versucht diesen Verbindungstyp beim Herstellen von Verbindungen. Dies bedeutet, dass diese Verbindung möglich ist, aber nicht garantiert ist, da es andere Faktoren gibt, die diesen Verbindungstyp verhindern können, deaktiviert: UDP versucht diesen Verbindungstyp nicht, wenn Verbindungen hergestellt werden. 'Standard'
"Deaktiviert"
"Aktiviert"
benutzerfreundlicher Name Anzeigename von HostPool. Schnur
hostPoolTyp HostPool-Typ für Desktop. 'BYODesktop'
"Persönlich"
"Pooled" (erforderlich)
loadBalancerTyp Der Typ des Lastenausgleichs. "BreadthFirst"
"DepthFirst"
"MultiplePersistent"
"Persistent" (erforderlich)
managedPrivateUDP Standard: AVD-weite Einstellungen werden verwendet, um die Verbindungsverfügbarkeit zu bestimmen, aktiviert: UDP versucht diesen Verbindungstyp beim Herstellen von Verbindungen. Dies bedeutet, dass diese Verbindung möglich ist, aber nicht garantiert ist, da es andere Faktoren gibt, die diesen Verbindungstyp verhindern können, deaktiviert: UDP versucht diesen Verbindungstyp nicht, wenn Verbindungen hergestellt werden. 'Standard'
"Deaktiviert"
"Aktiviert"
managementTyp Der Typ der Verwaltung für diesen Hostpool, automatisierte oder Standard. Der Standardwert ist automatisiert. "Automatisiert"
"Standard"
maxSessionLimit (maxSession) Der maximale Sitzungsgrenzwert von HostPool. Int
oboTenantId Mandant, für den die Ressource angefordert wird. Schnur
personalDesktopAssignmentType PersonalDesktopAssignment-Typ für HostPool. "Automatisch"
"Direkt"
preferredAppGroupType Der Typ des bevorzugten Anwendungsgruppentyps, standardmäßig desktopanwendungsgruppe "Desktop"
"Keine"
"RailApplications" (erforderlich)
Öffentlicher Netzwerkzugang Aktiviert ermöglicht den Zugriff auf diese Ressource aus öffentlichen und privaten Netzwerken. Deaktiviert ermöglicht den Zugriff auf diese Ressource nur über private Endpunkte. "Deaktiviert"
"Aktiviert"
'EnabledForClientsOnly'
'EnabledForSessionHostsOnly'
publicUDP Standard: AVD-weite Einstellungen werden verwendet, um die Verbindungsverfügbarkeit zu bestimmen, aktiviert: UDP versucht diesen Verbindungstyp beim Herstellen von Verbindungen. Dies bedeutet, dass diese Verbindung möglich ist, aber nicht garantiert ist, da es andere Faktoren gibt, die diesen Verbindungstyp verhindern können, deaktiviert: UDP versucht diesen Verbindungstyp nicht, wenn Verbindungen hergestellt werden. 'Standard'
"Deaktiviert"
"Aktiviert"
AnmeldungInfo Die Registrierungsinformationen von HostPool. RegistrationInfo-
RelaisUDP Standard: AVD-weite Einstellungen werden verwendet, um die Verbindungsverfügbarkeit zu bestimmen, aktiviert: UDP versucht diesen Verbindungstyp beim Herstellen von Verbindungen. Dies bedeutet, dass diese Verbindung möglich ist, aber nicht garantiert ist, da es andere Faktoren gibt, die diesen Verbindungstyp verhindern können, deaktiviert: UDP versucht diesen Verbindungstyp nicht, wenn Verbindungen hergestellt werden. 'Standard'
"Deaktiviert"
"Aktiviert"
Ring Die Ringnummer von HostPool. Int
ssoadfs-Behörde URL zum ADFS-Server des Kunden zum Signieren von WVD-SSO-Zertifikaten. Schnur
ssoClientId ClientId für die registrierte vertrauende Seite, die zum Ausgeben von WVD-SSO-Zertifikaten verwendet wird. Schnur
ssoClientSecretKeyVaultPath Pfad zu Azure KeyVault, der den geheimen Schlüssel speichert, der für die Kommunikation mit ADFS verwendet wird. Schnur
ssoSecretType Der Typ des einmaligen Anmeldens im geheimen Typ. "Zertifikat"
'CertificateInKeyVault'
"SharedKey"
"SharedKeyInKeyVault"
startenVMOnConnect Das Kennzeichen zum Aktivieren/Deaktivieren des StartVMOnConnect-Features. Bool
validationUmgebung Ist die Überprüfungsumgebung. Bool
vmTemplate (englisch) VM-Vorlage für die Sessionhosts-Konfiguration innerhalb des Hostpools. Schnur

MaintenanceWindowEigenschaften

Name Beschreibung Wert
TagDerWoche Wochentag. "Freitag"
"Montag"
"Samstag"
"Sonntag"
"Donnerstag"
"Dienstag"
'Mittwoch'
Stunde Die Startstunde des Updates. (0 - 23) Int

Verwaltete Dienstidentität

Name Beschreibung Wert
Art Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind). "Keine"
'SystemZugewiesen'
"SystemAssigned,UserAssigned"
"UserAssigned" (erforderlich)
vom Benutzer zugewiesene Identitäten Die Gruppe der benutzerzuweisungen Identitäten, die der Ressource zugeordnet sind. Die Wörterbuchschlüssel "userAssignedIdentities" sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Die Wörterbuchwerte können leere Objekte ({}) in Anforderungen sein. ManagedServiceIdentityUserAssignedIdentities-

ManagedServiceIdentityUserAssignedIdentities

Name Beschreibung Wert

Plan

Name Beschreibung Wert
Name Ein benutzerdefinierter Name des 3rd Party Artifact, das beschafft wird. Zeichenfolge (erforderlich)
Produkt Das 3rd Party Artefakt, das beschafft wird. Z.B. NewRelic. Das Produkt entspricht der Für das Artefakt angegebenen OfferID zum Zeitpunkt des Data Market-Onboardings. Zeichenfolge (erforderlich)
Aktionscode Ein Herausgeber hat Werbecode bereitgestellt, der im Data Market für das angegebene Produkt/Artefakt bereitgestellt wird. Schnur
Verlag Der Herausgeber des 3rd Party Artifact, das gekauft wird. Z. B. NewRelic Zeichenfolge (erforderlich)
Version Die Version des gewünschten Produkts/Artefakts. Schnur

Anmeldeinformationen

Name Beschreibung Wert
Ablaufzeit Ablaufzeit des Registrierungstokens. Schnur
registrationTokenOperation Der Typ des Zurücksetzens des Tokens. "Löschen"
"Keine"
"Aktualisieren"
Zeichen Die base64-codierte Zeichenfolge des Registrierungstokens. Schnur

Sku

Name Beschreibung Wert
Fassungsvermögen Wenn die SKU skalierungs-/in unterstützt, sollte die Ganze Kapazität eingeschlossen werden. Wenn eine Skalierung für die Ressource nicht möglich ist, wird dies möglicherweise weggelassen. Int
Familie Wenn der Dienst über unterschiedliche Hardwaregenerationen verfügt, kann dies für dieselbe SKU hier erfasst werden. Schnur
Name Der Name der SKU. Z.B. P3. Es handelt sich in der Regel um einen Buchstaben+Zahlencode. Zeichenfolge (erforderlich)
Größe Die SKU-Größe. Wenn das Namensfeld die Kombination aus Ebene und einem anderen Wert ist, wäre dies der eigenständige Code. Schnur
Rang Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst mehr als eine Ebene aufweist, für einen PUT jedoch nicht erforderlich ist. "Einfach"
"Kostenlos"
"Premium"
"Standard"

Verfolgte ResourceTags

Name Beschreibung Wert

UserAssignedIdentity

Name Beschreibung Wert

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der HostPools-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Change Log.

Verwendungsbeispiele

Von Azure verifizierte Module

Die folgenden Azure Verified Modules können verwendet werden, um diesen Ressourcentyp bereitzustellen.

Modul Beschreibung
Azure Virtual Desktop (AVD) Hostpool AVM-Ressourcenmodul für Den Azure Virtual Desktop (AVD)-Hostpool

Ressourcenformat

Um eine Microsoft.DesktopVirtualization/hostPools-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DesktopVirtualization/hostPools@2026-04-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
      }
      allowRDPShortPathWithPrivateLink = "string"
      conditionalRdpProperty = "string"
      customRdpProperty = "string"
      deploymentScope = "string"
      description = "string"
      directUDP = "string"
      friendlyName = "string"
      hostPoolType = "string"
      loadBalancerType = "string"
      managedPrivateUDP = "string"
      managementType = "string"
      maxSessionLimit = int
      oboTenantId = "string"
      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"
    }
  }
}

Eigenschaftswerte

Microsoft.DesktopVirtualisierung/hostPools

Name Beschreibung Wert
Identität Die verwalteten Dienstidentitäten, die dieser Ressource zugewiesen sind. ManagedServiceIdentity-
Art Metadaten, die von Portal/Tooling/etc. verwendet werden, um unterschiedliche UX-Oberflächen für Ressourcen desselben Typs zu rendern; z. B. ApiApps sind eine Art von Microsoft.Web/Sites-Typ. Wenn diese Unterstützung unterstützt wird, muss der Ressourcenanbieter diesen Wert überprüfen und beibehalten. Schnur

Zwänge:
Muster = ^[-\w\._,\(\)]+$
Ort Der geografische Standort, an dem sich die Ressource befindet Zeichenfolge (erforderlich)
managedBy Die vollqualifizierte Ressourcen-ID der Ressource, die diese Ressource verwaltet. Gibt an, ob diese Ressource von einer anderen Azure-Ressource verwaltet wird. Wenn dies vorhanden ist, löscht die Bereitstellung des vollständigen Modus die Ressource nicht, wenn sie aus der Vorlage entfernt wird, da sie von einer anderen Ressource verwaltet wird. Schnur
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 3
Max. Länge = 64
Pattern = ^[A-Za-z0-9@.\-_ ]*$ (erforderlich)
Plan Details zum Ressourcenplan. Planen
Eigenschaften Detaillierte Eigenschaften für HostPool HostPoolProperties- (erforderlich)
Sku Die dieser Ressource zugeordnete SKU (Lagerhaltungseinheit). Sku-
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte.
Art Der Ressourcentyp "Microsoft. DesktopVirtualization/hostPools@2026-04-01-preview"

AgentUpdate-Eigenschaften

Name Beschreibung Wert
WartungFenster Liste der Wartungsfenster. Wartungsfenster sind 2 Stunden lang. WartungFensterEigenschaften[]
maintenanceWindowTimeZone Zeitzone für wartung gemäß definition in /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Muss festgelegt werden, wenn useLocalTime "true" ist. Schnur
Art Der Wartungstyp für Sitzungshostkomponenten. 'Standard'
"Geplant"
useSessionHostLocalTime Gibt an, ob localTime des virtuellen Computers verwendet werden soll. Bool

HostPoolEigenschaften

Name Beschreibung Wert
agentAktualisieren Die Sitzungshostkonfiguration zum Aktualisieren von Agent, Überwachungs-Agent und Stapelkomponente. AgentUpdateProperties-
allowRDPShortPathWithPrivateLink Steuert, ob die Verwendung des RDPShortPath-Transports zulässig ist, wobei möglicherweise Private Link-Routen umgangen werden. "Deaktiviert"
"Aktiviert"
conditionalRdpProperty Die bedingten RDP-Eigenschaften des Hostpools, serialisiert als String im Format von <rdpPropertyName>:<type>:<value>:<conditionType>:<conditionValue>. Schnur
customRdp-Eigenschaft Benutzerdefinierte rdp-Eigenschaft von HostPool. Schnur
Einsatzbereich DeploymentScope-Typ für HostPool. 'Geographisch'
"Regional"
Beschreibung Beschreibung des HostPools. Schnur
directUDP Standard: AVD-weite Einstellungen werden verwendet, um die Verbindungsverfügbarkeit zu bestimmen, aktiviert: UDP versucht diesen Verbindungstyp beim Herstellen von Verbindungen. Dies bedeutet, dass diese Verbindung möglich ist, aber nicht garantiert ist, da es andere Faktoren gibt, die diesen Verbindungstyp verhindern können, deaktiviert: UDP versucht diesen Verbindungstyp nicht, wenn Verbindungen hergestellt werden. 'Standard'
"Deaktiviert"
"Aktiviert"
benutzerfreundlicher Name Anzeigename von HostPool. Schnur
hostPoolTyp HostPool-Typ für Desktop. 'BYODesktop'
"Persönlich"
"Pooled" (erforderlich)
loadBalancerTyp Der Typ des Lastenausgleichs. "BreadthFirst"
"DepthFirst"
"MultiplePersistent"
"Persistent" (erforderlich)
managedPrivateUDP Standard: AVD-weite Einstellungen werden verwendet, um die Verbindungsverfügbarkeit zu bestimmen, aktiviert: UDP versucht diesen Verbindungstyp beim Herstellen von Verbindungen. Dies bedeutet, dass diese Verbindung möglich ist, aber nicht garantiert ist, da es andere Faktoren gibt, die diesen Verbindungstyp verhindern können, deaktiviert: UDP versucht diesen Verbindungstyp nicht, wenn Verbindungen hergestellt werden. 'Standard'
"Deaktiviert"
"Aktiviert"
managementTyp Der Typ der Verwaltung für diesen Hostpool, automatisierte oder Standard. Der Standardwert ist automatisiert. "Automatisiert"
"Standard"
maxSessionLimit (maxSession) Der maximale Sitzungsgrenzwert von HostPool. Int
oboTenantId Mandant, für den die Ressource angefordert wird. Schnur
personalDesktopAssignmentType PersonalDesktopAssignment-Typ für HostPool. "Automatisch"
"Direkt"
preferredAppGroupType Der Typ des bevorzugten Anwendungsgruppentyps, standardmäßig desktopanwendungsgruppe "Desktop"
"Keine"
"RailApplications" (erforderlich)
Öffentlicher Netzwerkzugang Aktiviert ermöglicht den Zugriff auf diese Ressource aus öffentlichen und privaten Netzwerken. Deaktiviert ermöglicht den Zugriff auf diese Ressource nur über private Endpunkte. "Deaktiviert"
"Aktiviert"
'EnabledForClientsOnly'
'EnabledForSessionHostsOnly'
publicUDP Standard: AVD-weite Einstellungen werden verwendet, um die Verbindungsverfügbarkeit zu bestimmen, aktiviert: UDP versucht diesen Verbindungstyp beim Herstellen von Verbindungen. Dies bedeutet, dass diese Verbindung möglich ist, aber nicht garantiert ist, da es andere Faktoren gibt, die diesen Verbindungstyp verhindern können, deaktiviert: UDP versucht diesen Verbindungstyp nicht, wenn Verbindungen hergestellt werden. 'Standard'
"Deaktiviert"
"Aktiviert"
AnmeldungInfo Die Registrierungsinformationen von HostPool. RegistrationInfo-
RelaisUDP Standard: AVD-weite Einstellungen werden verwendet, um die Verbindungsverfügbarkeit zu bestimmen, aktiviert: UDP versucht diesen Verbindungstyp beim Herstellen von Verbindungen. Dies bedeutet, dass diese Verbindung möglich ist, aber nicht garantiert ist, da es andere Faktoren gibt, die diesen Verbindungstyp verhindern können, deaktiviert: UDP versucht diesen Verbindungstyp nicht, wenn Verbindungen hergestellt werden. 'Standard'
"Deaktiviert"
"Aktiviert"
Ring Die Ringnummer von HostPool. Int
ssoadfs-Behörde URL zum ADFS-Server des Kunden zum Signieren von WVD-SSO-Zertifikaten. Schnur
ssoClientId ClientId für die registrierte vertrauende Seite, die zum Ausgeben von WVD-SSO-Zertifikaten verwendet wird. Schnur
ssoClientSecretKeyVaultPath Pfad zu Azure KeyVault, der den geheimen Schlüssel speichert, der für die Kommunikation mit ADFS verwendet wird. Schnur
ssoSecretType Der Typ des einmaligen Anmeldens im geheimen Typ. "Zertifikat"
'CertificateInKeyVault'
"SharedKey"
"SharedKeyInKeyVault"
startenVMOnConnect Das Kennzeichen zum Aktivieren/Deaktivieren des StartVMOnConnect-Features. Bool
validationUmgebung Ist die Überprüfungsumgebung. Bool
vmTemplate (englisch) VM-Vorlage für die Sessionhosts-Konfiguration innerhalb des Hostpools. Schnur

MaintenanceWindowEigenschaften

Name Beschreibung Wert
TagDerWoche Wochentag. "Freitag"
"Montag"
"Samstag"
"Sonntag"
"Donnerstag"
"Dienstag"
'Mittwoch'
Stunde Die Startstunde des Updates. (0 - 23) Int

Verwaltete Dienstidentität

Name Beschreibung Wert
Art Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind). "Keine"
'SystemZugewiesen'
"SystemAssigned,UserAssigned"
"UserAssigned" (erforderlich)
vom Benutzer zugewiesene Identitäten Die Gruppe der benutzerzuweisungen Identitäten, die der Ressource zugeordnet sind. Die Wörterbuchschlüssel "userAssignedIdentities" sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Die Wörterbuchwerte können leere Objekte ({}) in Anforderungen sein. ManagedServiceIdentityUserAssignedIdentities-

ManagedServiceIdentityUserAssignedIdentities

Name Beschreibung Wert

Plan

Name Beschreibung Wert
Name Ein benutzerdefinierter Name des 3rd Party Artifact, das beschafft wird. Zeichenfolge (erforderlich)
Produkt Das 3rd Party Artefakt, das beschafft wird. Z.B. NewRelic. Das Produkt entspricht der Für das Artefakt angegebenen OfferID zum Zeitpunkt des Data Market-Onboardings. Zeichenfolge (erforderlich)
Aktionscode Ein Herausgeber hat Werbecode bereitgestellt, der im Data Market für das angegebene Produkt/Artefakt bereitgestellt wird. Schnur
Verlag Der Herausgeber des 3rd Party Artifact, das gekauft wird. Z. B. NewRelic Zeichenfolge (erforderlich)
Version Die Version des gewünschten Produkts/Artefakts. Schnur

Anmeldeinformationen

Name Beschreibung Wert
Ablaufzeit Ablaufzeit des Registrierungstokens. Schnur
registrationTokenOperation Der Typ des Zurücksetzens des Tokens. "Löschen"
"Keine"
"Aktualisieren"
Zeichen Die base64-codierte Zeichenfolge des Registrierungstokens. Schnur

Sku

Name Beschreibung Wert
Fassungsvermögen Wenn die SKU skalierungs-/in unterstützt, sollte die Ganze Kapazität eingeschlossen werden. Wenn eine Skalierung für die Ressource nicht möglich ist, wird dies möglicherweise weggelassen. Int
Familie Wenn der Dienst über unterschiedliche Hardwaregenerationen verfügt, kann dies für dieselbe SKU hier erfasst werden. Schnur
Name Der Name der SKU. Z.B. P3. Es handelt sich in der Regel um einen Buchstaben+Zahlencode. Zeichenfolge (erforderlich)
Größe Die SKU-Größe. Wenn das Namensfeld die Kombination aus Ebene und einem anderen Wert ist, wäre dies der eigenständige Code. Schnur
Rang Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst mehr als eine Ebene aufweist, für einen PUT jedoch nicht erforderlich ist. "Einfach"
"Kostenlos"
"Premium"
"Standard"

Verfolgte ResourceTags

Name Beschreibung Wert

UserAssignedIdentity

Name Beschreibung Wert