Microsoft.DesktopPule hostówwirtualizacji

Definicja zasobu Bicep

Typ zasobu hostPools można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Przykłady użycia

Moduły zweryfikowane na platformie Azure

Następujące moduły zweryfikowane platformy Azure mogą służyć do wdrażania tego typu zasobu.

Moduł Opis
puli hostów usługi Azure Virtual Desktop (AVD) Moduł zasobów AVM dla puli hostów usługi Azure Virtual Desktop (AVD)

Przykłady szybkiego startu platformy Azure

Poniższe szablony szybkiego startu platformy Azure zawierają przykłady Bicep na potrzeby wdrażania tego typu zasobu.

Plik Bicep Opis
tworzy usługę AVD przy użyciu dołączania do identyfikatora entra firmy Microsoft Ten szablon umożliwia tworzenie zasobów usługi Azure Virtual Desktop, takich jak pula hostów, grupa aplikacji, obszar roboczy, host sesji testowej i jego rozszerzenia za pomocą dołączania identyfikatora Entra firmy Microsoft

Format zasobu

Aby utworzyć zasób Microsoft.DesktopVirtualization/hostPools, dodaj następujący kod Bicep do szablonu.

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

Wartości właściwości

Microsoft.DesktopVirtualization/hostPools

Nazwa Opis Wartość
tożsamość Tożsamości usługi zarządzanej przypisane do tego zasobu. ManagedServiceIdentity (tożsamość usługi)
rodzaj Metadane używane przez portal/narzędzia/itp. do renderowania różnych środowisk środowiska użytkownika dla zasobów tego samego typu; Np. ApiApps to rodzaj typu Microsoft.Web/sites. Jeśli jest obsługiwana, dostawca zasobów musi zweryfikować i utrwalić tę wartość. struna

Ograniczenia:
Wzorzec = ^[-\w\._,\(\)]+$
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
zarządzanePrzez W pełni kwalifikowany identyfikator zasobu, który zarządza tym zasobem. Wskazuje, czy ten zasób jest zarządzany przez inny zasób platformy Azure. Jeśli jest to obecne, wdrożenie trybu pełnego nie spowoduje usunięcia zasobu, jeśli zostanie usunięty z szablonu, ponieważ jest on zarządzany przez inny zasób. ciąg
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 3
Maksymalna długość = 64
Wzorzec = ^[A-Za-z0-9@.\-_ ]*$ (wymagane)
plan Szczegóły planu zasobów. planu
Właściwości Szczegółowe właściwości puli hostów HostPoolProperties (wymagane)
Numer jednostki magazynowej Jednostka SKU (jednostka przechowywania zapasów) przypisana do tego zasobu. sku
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

AgentUpdateProperties

Nazwa Opis Wartość
konserwacjaWindows Lista okien obsługi. Okna obsługi to 2 godziny. Właściwości MaintenanceWindow[]
maintenanceWindowTimeZone (strefa czasowa) Strefa czasowa konserwacji zgodnie z definicją w pliku /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Należy ustawić wartość , jeśli parametr useLocalTime ma wartość true. ciąg
typ Typ konserwacji składników hosta sesji. "Wartość domyślna"
"Zaplanowane"
useSessionHostLocalTime Czy używać lokalnego czasu maszyny wirtualnej. Bool

Właściwości puli hostów

Nazwa Opis Wartość
Aktualizacja agenta Konfiguracja hosta sesji do aktualizowania agenta, agenta monitorowania i składnika stosu. AgentUpdateProperties
allowRDPShortPathWithPrivateLink Określa, czy korzystanie z transportu RDPShortPath jest dozwolone, co może oznaczać pomijanie tras Private Link. "Wyłączone"
"Włączone"
warunkowaRdpWłasność Warunkowe właściwości RDP puli hostów, serializowane jako ciąg znaków w formacie <rdpPropertyName>:<type>:<value>:<conditionType>:<conditionValue>. ciąg
customRdpProperty (właściwość customRdp) Niestandardowa właściwość rdp puli hostów. ciąg
deploymentScope (zakres) Typ DeploymentScope dla puli hostów. 'Geograficzne'
"Regionalny"
opis Opis puli hostów. ciąg
DirectUDP Ustawienie domyślne: ustawienia dla całej usługi AVD są używane do określania dostępności połączenia: Włączone: UDP podejmie próbę tego typu połączenia podczas nawiązywania połączeń. Oznacza to, że to połączenie jest możliwe, ale nie jest gwarantowane, ponieważ istnieją inne czynniki, które mogą zapobiec temu typowi połączenia, Wyłączone: UDP nie podejmie próby tego typu połączenia podczas nawiązywania połączeń "Wartość domyślna"
"Wyłączone"
"Włączone"
przyjaznaNazwa Przyjazna nazwa puli hostów. ciąg
hostPoolType (typ puli hostów) Typ puli hostów dla pulpitu. "BYODesktop"
"Osobiste"
"Pooled" (wymagane)
loadBalancerType (typ obciążenia) Typ modułu równoważenia obciążenia. "BreadthFirst"
"DepthFirst"
"MultiplePersistent"
"Trwały" (wymagany)
managedPrivateUDP Ustawienie domyślne: ustawienia dla całej usługi AVD są używane do określania dostępności połączenia: Włączone: UDP podejmie próbę tego typu połączenia podczas nawiązywania połączeń. Oznacza to, że to połączenie jest możliwe, ale nie jest gwarantowane, ponieważ istnieją inne czynniki, które mogą zapobiec temu typowi połączenia, Wyłączone: UDP nie podejmie próby tego typu połączenia podczas nawiązywania połączeń "Wartość domyślna"
"Wyłączone"
"Włączone"
typ zarządzania Typ zarządzania dla tej puli hostów, zautomatyzowany lub standardowy. Wartość domyślna to Zautomatyzowane. "Zautomatyzowane"
"Standardowa"
maxSessionLimit (maksymalny limit sesji) Maksymalny limit sesji puli hostów. Int
oboTenantId Dzierżawca, w imieniu którego jest żądany zasób. ciąg
personalDesktopAssignmentType PersonalDesktopAssignment typ puli hostów. "Automatyczny"
"Bezpośredni"
preferredAppGroupType Typ preferowanej grupy aplikacji, domyślnie to Grupa aplikacji klasycznych "Pulpit"
"Brak"
"RailApplications" (wymagane)
dostęp do sieci publicznej Włączone umożliwia dostęp do tego zasobu zarówno z sieci publicznych, jak i prywatnych. Opcja Wyłączone umożliwia dostęp do tego zasobu tylko za pośrednictwem prywatnych punktów końcowych "Wyłączone"
"Włączone"
"EnabledForClientsOnly"
"EnabledForSessionHostsOnly"
publicUDP (publiczny) Ustawienie domyślne: ustawienia dla całej usługi AVD są używane do określania dostępności połączenia: Włączone: UDP podejmie próbę tego typu połączenia podczas nawiązywania połączeń. Oznacza to, że to połączenie jest możliwe, ale nie jest gwarantowane, ponieważ istnieją inne czynniki, które mogą zapobiec temu typowi połączenia, Wyłączone: UDP nie podejmie próby tego typu połączenia podczas nawiązywania połączeń "Wartość domyślna"
"Wyłączone"
"Włączone"
registrationInfo (informacje o rejestracji) Informacje o rejestracji puli hostów. Informacje o rejestracji
przekaźnikUDP Ustawienie domyślne: ustawienia dla całej usługi AVD są używane do określania dostępności połączenia: Włączone: UDP podejmie próbę tego typu połączenia podczas nawiązywania połączeń. Oznacza to, że to połączenie jest możliwe, ale nie jest gwarantowane, ponieważ istnieją inne czynniki, które mogą zapobiec temu typowi połączenia, Wyłączone: UDP nie podejmie próby tego typu połączenia podczas nawiązywania połączeń "Wartość domyślna"
"Wyłączone"
"Włączone"
pierścień Numer pierścienia puli hostów. Int
ssoadfsAuthority (Uprawnienia) Adres URL serwera usług AD FS klienta do podpisywania certyfikatów logowania jednokrotnego WVD. ciąg
ssoClientId (identyfikator klienta) ClientId zarejestrowanej jednostki uzależnionej używanej do wystawiania certyfikatów logowania jednokrotnego WVD. ciąg
ssoClientSecretKeyVaultPath Ścieżka do usługi Azure KeyVault przechowując wpis tajny używany do komunikacji z usługami ADFS. ciąg
ssoSecretType (typ sekretu) Typ logowania jednokrotnego w typie wpisu tajnego. "Certyfikat"
"CertificateInKeyVault"
"SharedKey"
"SharedKeyInKeyVault"
startVMOnConnect (start VMOnConnect) Flaga włączania/wyłączania funkcji StartVMOnConnect. Bool
validationEnvironment (walidacjaŚrodowisko) To środowisko weryfikacji. Bool
Szablon vmTemplate Szablon maszyny wirtualnej dla konfiguracji hostów sesji w puli hostów. ciąg

KonserwacjaWindowProperties

Nazwa Opis Wartość
dzień tygodnia Dzień tygodnia. "Piątek"
"Poniedziałek"
"Sobota"
"Niedziela"
"Czwartek"
"Wtorek"
"Środa"
godzina Godzina rozpoczęcia aktualizacji dnia. (0 - 23) Int

ManagedServiceIdentity

Nazwa Opis Wartość
typ Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned). "Brak"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (wymagane)
tożsamości przypisane użytkownikom Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Klucze słownika userAssignedIdentities będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Wartości słownika mogą być pustymi obiektami ({}) w żądaniach. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nazwa Opis Wartość

Planowanie

Nazwa Opis Wartość
nazwa Zdefiniowana przez użytkownika nazwa artefaktu innej firmy, który jest pozyskiwany. ciąg (wymagany)
produkt Artefakt innej firmy, który jest pozyskiwany. Np. NewRelic. Produkt jest mapowy na wartość OfferID określoną dla artefaktu podczas dołączania do usługi Data Market. ciąg (wymagany)
kod podwyższania poziomu Wydawca dostarczył kod podwyższania poziomu jako zaaprowizowany w usłudze Data Market dla podanego produktu/artefaktu. ciąg
wydawca Wydawca zakupionego artefaktu innej firmy. Np. NewRelic ciąg (wymagany)
wersja Wersja żądanego produktu/artefaktu. ciąg

Informacje o rejestracji

Nazwa Opis Wartość
czas wygaśnięcia Czas wygaśnięcia tokenu rejestracji. ciąg
registrationTokenOperation (operacja tokenu) Typ resetowania tokenu. "Usuń"
"Brak"
"Aktualizuj"
kod przedpłaty Ciąg zakodowany w tokenie rejestracji base64. ciąg

Numer jednostki magazynowej

Nazwa Opis Wartość
dyspozycyjność Jeśli jednostka SKU obsługuje skalowanie w poziomie/w, należy uwzględnić liczbę całkowitą pojemności. Jeśli skalowanie w poziomie/w nie jest możliwe dla zasobu, może to zostać pominięte. Int
rodzina Jeśli usługa ma różne generacje sprzętu, dla tej samej jednostki SKU, można je przechwycić tutaj. ciąg
nazwa Nazwa jednostki SKU. Np. P3. Zazwyczaj jest to kod z literą i cyfrą ciąg (wymagany)
rozmiar Rozmiar jednostki SKU. Gdy pole nazwy jest kombinacją warstwy i innej wartości, będzie to autonomiczny kod. ciąg
warstwa To pole jest wymagane do zaimplementowania przez dostawcę zasobów, jeśli usługa ma więcej niż jedną warstwę, ale nie jest wymagana w put. "Podstawowa"
"Bezpłatna"
"Premium"
"Standardowa"

Śledzone tagi zasobów

Nazwa Opis Wartość

Tożsamość przypisana przez użytkownika

Nazwa Opis Wartość

Definicja zasobu szablonu usługi ARM

Typ zasobu hostPools można wdrożyć przy użyciu operacji docelowych:

Przykłady użycia

Szablony szybkiego startu platformy Azure

Następujące szablony szybkiego startu platformy Azure wdrożyć ten typ zasobu.

Szablon Opis
tworzy usługę AVD przy użyciu dołączania do identyfikatora entra firmy Microsoft

wdrażanie w usłudze Azure
Ten szablon umożliwia tworzenie zasobów usługi Azure Virtual Desktop, takich jak pula hostów, grupa aplikacji, obszar roboczy, host sesji testowej i jego rozszerzenia za pomocą dołączania identyfikatora Entra firmy Microsoft

Format zasobu

Aby utworzyć zasób Microsoft.DesktopVirtualization/hostPools, dodaj następujący kod JSON do szablonu.

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

Wartości właściwości

Microsoft.DesktopVirtualization/hostPools

Nazwa Opis Wartość
apiVersion (wersja interfejsu api) Wersja interfejsu API 'Zapowiedź 2026-04-01'
tożsamość Tożsamości usługi zarządzanej przypisane do tego zasobu. ManagedServiceIdentity (tożsamość usługi)
rodzaj Metadane używane przez portal/narzędzia/itp. do renderowania różnych środowisk środowiska użytkownika dla zasobów tego samego typu; Np. ApiApps to rodzaj typu Microsoft.Web/sites. Jeśli jest obsługiwana, dostawca zasobów musi zweryfikować i utrwalić tę wartość. struna

Ograniczenia:
Wzorzec = ^[-\w\._,\(\)]+$
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
zarządzanePrzez W pełni kwalifikowany identyfikator zasobu, który zarządza tym zasobem. Wskazuje, czy ten zasób jest zarządzany przez inny zasób platformy Azure. Jeśli jest to obecne, wdrożenie trybu pełnego nie spowoduje usunięcia zasobu, jeśli zostanie usunięty z szablonu, ponieważ jest on zarządzany przez inny zasób. ciąg
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 3
Maksymalna długość = 64
Wzorzec = ^[A-Za-z0-9@.\-_ ]*$ (wymagane)
plan Szczegóły planu zasobów. planu
Właściwości Szczegółowe właściwości puli hostów HostPoolProperties (wymagane)
Numer jednostki magazynowej Jednostka SKU (jednostka przechowywania zapasów) przypisana do tego zasobu. sku
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.DesktopVirtualization/hostPools"

AgentUpdateProperties

Nazwa Opis Wartość
konserwacjaWindows Lista okien obsługi. Okna obsługi to 2 godziny. Właściwości MaintenanceWindow[]
maintenanceWindowTimeZone (strefa czasowa) Strefa czasowa konserwacji zgodnie z definicją w pliku /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Należy ustawić wartość , jeśli parametr useLocalTime ma wartość true. ciąg
typ Typ konserwacji składników hosta sesji. "Wartość domyślna"
"Zaplanowane"
useSessionHostLocalTime Czy używać lokalnego czasu maszyny wirtualnej. Bool

Właściwości puli hostów

Nazwa Opis Wartość
Aktualizacja agenta Konfiguracja hosta sesji do aktualizowania agenta, agenta monitorowania i składnika stosu. AgentUpdateProperties
allowRDPShortPathWithPrivateLink Określa, czy korzystanie z transportu RDPShortPath jest dozwolone, co może oznaczać pomijanie tras Private Link. "Wyłączone"
"Włączone"
warunkowaRdpWłasność Warunkowe właściwości RDP puli hostów, serializowane jako ciąg znaków w formacie <rdpPropertyName>:<type>:<value>:<conditionType>:<conditionValue>. ciąg
customRdpProperty (właściwość customRdp) Niestandardowa właściwość rdp puli hostów. ciąg
deploymentScope (zakres) Typ DeploymentScope dla puli hostów. 'Geograficzne'
"Regionalny"
opis Opis puli hostów. ciąg
DirectUDP Ustawienie domyślne: ustawienia dla całej usługi AVD są używane do określania dostępności połączenia: Włączone: UDP podejmie próbę tego typu połączenia podczas nawiązywania połączeń. Oznacza to, że to połączenie jest możliwe, ale nie jest gwarantowane, ponieważ istnieją inne czynniki, które mogą zapobiec temu typowi połączenia, Wyłączone: UDP nie podejmie próby tego typu połączenia podczas nawiązywania połączeń "Wartość domyślna"
"Wyłączone"
"Włączone"
przyjaznaNazwa Przyjazna nazwa puli hostów. ciąg
hostPoolType (typ puli hostów) Typ puli hostów dla pulpitu. "BYODesktop"
"Osobiste"
"Pooled" (wymagane)
loadBalancerType (typ obciążenia) Typ modułu równoważenia obciążenia. "BreadthFirst"
"DepthFirst"
"MultiplePersistent"
"Trwały" (wymagany)
managedPrivateUDP Ustawienie domyślne: ustawienia dla całej usługi AVD są używane do określania dostępności połączenia: Włączone: UDP podejmie próbę tego typu połączenia podczas nawiązywania połączeń. Oznacza to, że to połączenie jest możliwe, ale nie jest gwarantowane, ponieważ istnieją inne czynniki, które mogą zapobiec temu typowi połączenia, Wyłączone: UDP nie podejmie próby tego typu połączenia podczas nawiązywania połączeń "Wartość domyślna"
"Wyłączone"
"Włączone"
typ zarządzania Typ zarządzania dla tej puli hostów, zautomatyzowany lub standardowy. Wartość domyślna to Zautomatyzowane. "Zautomatyzowane"
"Standardowa"
maxSessionLimit (maksymalny limit sesji) Maksymalny limit sesji puli hostów. Int
oboTenantId Dzierżawca, w imieniu którego jest żądany zasób. ciąg
personalDesktopAssignmentType PersonalDesktopAssignment typ puli hostów. "Automatyczny"
"Bezpośredni"
preferredAppGroupType Typ preferowanej grupy aplikacji, domyślnie to Grupa aplikacji klasycznych "Pulpit"
"Brak"
"RailApplications" (wymagane)
dostęp do sieci publicznej Włączone umożliwia dostęp do tego zasobu zarówno z sieci publicznych, jak i prywatnych. Opcja Wyłączone umożliwia dostęp do tego zasobu tylko za pośrednictwem prywatnych punktów końcowych "Wyłączone"
"Włączone"
"EnabledForClientsOnly"
"EnabledForSessionHostsOnly"
publicUDP (publiczny) Ustawienie domyślne: ustawienia dla całej usługi AVD są używane do określania dostępności połączenia: Włączone: UDP podejmie próbę tego typu połączenia podczas nawiązywania połączeń. Oznacza to, że to połączenie jest możliwe, ale nie jest gwarantowane, ponieważ istnieją inne czynniki, które mogą zapobiec temu typowi połączenia, Wyłączone: UDP nie podejmie próby tego typu połączenia podczas nawiązywania połączeń "Wartość domyślna"
"Wyłączone"
"Włączone"
registrationInfo (informacje o rejestracji) Informacje o rejestracji puli hostów. Informacje o rejestracji
przekaźnikUDP Ustawienie domyślne: ustawienia dla całej usługi AVD są używane do określania dostępności połączenia: Włączone: UDP podejmie próbę tego typu połączenia podczas nawiązywania połączeń. Oznacza to, że to połączenie jest możliwe, ale nie jest gwarantowane, ponieważ istnieją inne czynniki, które mogą zapobiec temu typowi połączenia, Wyłączone: UDP nie podejmie próby tego typu połączenia podczas nawiązywania połączeń "Wartość domyślna"
"Wyłączone"
"Włączone"
pierścień Numer pierścienia puli hostów. Int
ssoadfsAuthority (Uprawnienia) Adres URL serwera usług AD FS klienta do podpisywania certyfikatów logowania jednokrotnego WVD. ciąg
ssoClientId (identyfikator klienta) ClientId zarejestrowanej jednostki uzależnionej używanej do wystawiania certyfikatów logowania jednokrotnego WVD. ciąg
ssoClientSecretKeyVaultPath Ścieżka do usługi Azure KeyVault przechowując wpis tajny używany do komunikacji z usługami ADFS. ciąg
ssoSecretType (typ sekretu) Typ logowania jednokrotnego w typie wpisu tajnego. "Certyfikat"
"CertificateInKeyVault"
"SharedKey"
"SharedKeyInKeyVault"
startVMOnConnect (start VMOnConnect) Flaga włączania/wyłączania funkcji StartVMOnConnect. Bool
validationEnvironment (walidacjaŚrodowisko) To środowisko weryfikacji. Bool
Szablon vmTemplate Szablon maszyny wirtualnej dla konfiguracji hostów sesji w puli hostów. ciąg

KonserwacjaWindowProperties

Nazwa Opis Wartość
dzień tygodnia Dzień tygodnia. "Piątek"
"Poniedziałek"
"Sobota"
"Niedziela"
"Czwartek"
"Wtorek"
"Środa"
godzina Godzina rozpoczęcia aktualizacji dnia. (0 - 23) Int

ManagedServiceIdentity

Nazwa Opis Wartość
typ Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned). "Brak"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (wymagane)
tożsamości przypisane użytkownikom Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Klucze słownika userAssignedIdentities będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Wartości słownika mogą być pustymi obiektami ({}) w żądaniach. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nazwa Opis Wartość

Planowanie

Nazwa Opis Wartość
nazwa Zdefiniowana przez użytkownika nazwa artefaktu innej firmy, który jest pozyskiwany. ciąg (wymagany)
produkt Artefakt innej firmy, który jest pozyskiwany. Np. NewRelic. Produkt jest mapowy na wartość OfferID określoną dla artefaktu podczas dołączania do usługi Data Market. ciąg (wymagany)
kod podwyższania poziomu Wydawca dostarczył kod podwyższania poziomu jako zaaprowizowany w usłudze Data Market dla podanego produktu/artefaktu. ciąg
wydawca Wydawca zakupionego artefaktu innej firmy. Np. NewRelic ciąg (wymagany)
wersja Wersja żądanego produktu/artefaktu. ciąg

Informacje o rejestracji

Nazwa Opis Wartość
czas wygaśnięcia Czas wygaśnięcia tokenu rejestracji. ciąg
registrationTokenOperation (operacja tokenu) Typ resetowania tokenu. "Usuń"
"Brak"
"Aktualizuj"
kod przedpłaty Ciąg zakodowany w tokenie rejestracji base64. ciąg

Numer jednostki magazynowej

Nazwa Opis Wartość
dyspozycyjność Jeśli jednostka SKU obsługuje skalowanie w poziomie/w, należy uwzględnić liczbę całkowitą pojemności. Jeśli skalowanie w poziomie/w nie jest możliwe dla zasobu, może to zostać pominięte. Int
rodzina Jeśli usługa ma różne generacje sprzętu, dla tej samej jednostki SKU, można je przechwycić tutaj. ciąg
nazwa Nazwa jednostki SKU. Np. P3. Zazwyczaj jest to kod z literą i cyfrą ciąg (wymagany)
rozmiar Rozmiar jednostki SKU. Gdy pole nazwy jest kombinacją warstwy i innej wartości, będzie to autonomiczny kod. ciąg
warstwa To pole jest wymagane do zaimplementowania przez dostawcę zasobów, jeśli usługa ma więcej niż jedną warstwę, ale nie jest wymagana w put. "Podstawowa"
"Bezpłatna"
"Premium"
"Standardowa"

Śledzone tagi zasobów

Nazwa Opis Wartość

Tożsamość przypisana przez użytkownika

Nazwa Opis Wartość

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu hostPools można wdrożyć przy użyciu operacji docelowych:

  • Grupy zasobów Listę zmienionych właściwości w każdej wersji API można znaleźć w dzienniku zmian.

Przykłady użycia

Moduły zweryfikowane na platformie Azure

Następujące moduły zweryfikowane platformy Azure mogą służyć do wdrażania tego typu zasobu.

Moduł Opis
puli hostów usługi Azure Virtual Desktop (AVD) Moduł zasobów AVM dla puli hostów usługi Azure Virtual Desktop (AVD)

Format zasobu

Aby utworzyć zasób Microsoft.DesktopVirtualization/hostPools, dodaj następujący program Terraform do szablonu.

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

Wartości właściwości

Microsoft.DesktopVirtualization/hostPools

Nazwa Opis Wartość
tożsamość Tożsamości usługi zarządzanej przypisane do tego zasobu. ManagedServiceIdentity (tożsamość usługi)
rodzaj Metadane używane przez portal/narzędzia/itp. do renderowania różnych środowisk środowiska użytkownika dla zasobów tego samego typu; Np. ApiApps to rodzaj typu Microsoft.Web/sites. Jeśli jest obsługiwana, dostawca zasobów musi zweryfikować i utrwalić tę wartość. struna

Ograniczenia:
Wzorzec = ^[-\w\._,\(\)]+$
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
zarządzanePrzez W pełni kwalifikowany identyfikator zasobu, który zarządza tym zasobem. Wskazuje, czy ten zasób jest zarządzany przez inny zasób platformy Azure. Jeśli jest to obecne, wdrożenie trybu pełnego nie spowoduje usunięcia zasobu, jeśli zostanie usunięty z szablonu, ponieważ jest on zarządzany przez inny zasób. ciąg
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 3
Maksymalna długość = 64
Wzorzec = ^[A-Za-z0-9@.\-_ ]*$ (wymagane)
plan Szczegóły planu zasobów. planu
Właściwości Szczegółowe właściwości puli hostów HostPoolProperties (wymagane)
Numer jednostki magazynowej Jednostka SKU (jednostka przechowywania zapasów) przypisana do tego zasobu. sku
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft. DesktopVirtualization/hostPools@2026-04-01-preview"

AgentUpdateProperties

Nazwa Opis Wartość
konserwacjaWindows Lista okien obsługi. Okna obsługi to 2 godziny. Właściwości MaintenanceWindow[]
maintenanceWindowTimeZone (strefa czasowa) Strefa czasowa konserwacji zgodnie z definicją w pliku /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Należy ustawić wartość , jeśli parametr useLocalTime ma wartość true. ciąg
typ Typ konserwacji składników hosta sesji. "Wartość domyślna"
"Zaplanowane"
useSessionHostLocalTime Czy używać lokalnego czasu maszyny wirtualnej. Bool

Właściwości puli hostów

Nazwa Opis Wartość
Aktualizacja agenta Konfiguracja hosta sesji do aktualizowania agenta, agenta monitorowania i składnika stosu. AgentUpdateProperties
allowRDPShortPathWithPrivateLink Określa, czy korzystanie z transportu RDPShortPath jest dozwolone, co może oznaczać pomijanie tras Private Link. "Wyłączone"
"Włączone"
warunkowaRdpWłasność Warunkowe właściwości RDP puli hostów, serializowane jako ciąg znaków w formacie <rdpPropertyName>:<type>:<value>:<conditionType>:<conditionValue>. ciąg
customRdpProperty (właściwość customRdp) Niestandardowa właściwość rdp puli hostów. ciąg
deploymentScope (zakres) Typ DeploymentScope dla puli hostów. 'Geograficzne'
"Regionalny"
opis Opis puli hostów. ciąg
DirectUDP Ustawienie domyślne: ustawienia dla całej usługi AVD są używane do określania dostępności połączenia: Włączone: UDP podejmie próbę tego typu połączenia podczas nawiązywania połączeń. Oznacza to, że to połączenie jest możliwe, ale nie jest gwarantowane, ponieważ istnieją inne czynniki, które mogą zapobiec temu typowi połączenia, Wyłączone: UDP nie podejmie próby tego typu połączenia podczas nawiązywania połączeń "Wartość domyślna"
"Wyłączone"
"Włączone"
przyjaznaNazwa Przyjazna nazwa puli hostów. ciąg
hostPoolType (typ puli hostów) Typ puli hostów dla pulpitu. "BYODesktop"
"Osobiste"
"Pooled" (wymagane)
loadBalancerType (typ obciążenia) Typ modułu równoważenia obciążenia. "BreadthFirst"
"DepthFirst"
"MultiplePersistent"
"Trwały" (wymagany)
managedPrivateUDP Ustawienie domyślne: ustawienia dla całej usługi AVD są używane do określania dostępności połączenia: Włączone: UDP podejmie próbę tego typu połączenia podczas nawiązywania połączeń. Oznacza to, że to połączenie jest możliwe, ale nie jest gwarantowane, ponieważ istnieją inne czynniki, które mogą zapobiec temu typowi połączenia, Wyłączone: UDP nie podejmie próby tego typu połączenia podczas nawiązywania połączeń "Wartość domyślna"
"Wyłączone"
"Włączone"
typ zarządzania Typ zarządzania dla tej puli hostów, zautomatyzowany lub standardowy. Wartość domyślna to Zautomatyzowane. "Zautomatyzowane"
"Standardowa"
maxSessionLimit (maksymalny limit sesji) Maksymalny limit sesji puli hostów. Int
oboTenantId Dzierżawca, w imieniu którego jest żądany zasób. ciąg
personalDesktopAssignmentType PersonalDesktopAssignment typ puli hostów. "Automatyczny"
"Bezpośredni"
preferredAppGroupType Typ preferowanej grupy aplikacji, domyślnie to Grupa aplikacji klasycznych "Pulpit"
"Brak"
"RailApplications" (wymagane)
dostęp do sieci publicznej Włączone umożliwia dostęp do tego zasobu zarówno z sieci publicznych, jak i prywatnych. Opcja Wyłączone umożliwia dostęp do tego zasobu tylko za pośrednictwem prywatnych punktów końcowych "Wyłączone"
"Włączone"
"EnabledForClientsOnly"
"EnabledForSessionHostsOnly"
publicUDP (publiczny) Ustawienie domyślne: ustawienia dla całej usługi AVD są używane do określania dostępności połączenia: Włączone: UDP podejmie próbę tego typu połączenia podczas nawiązywania połączeń. Oznacza to, że to połączenie jest możliwe, ale nie jest gwarantowane, ponieważ istnieją inne czynniki, które mogą zapobiec temu typowi połączenia, Wyłączone: UDP nie podejmie próby tego typu połączenia podczas nawiązywania połączeń "Wartość domyślna"
"Wyłączone"
"Włączone"
registrationInfo (informacje o rejestracji) Informacje o rejestracji puli hostów. Informacje o rejestracji
przekaźnikUDP Ustawienie domyślne: ustawienia dla całej usługi AVD są używane do określania dostępności połączenia: Włączone: UDP podejmie próbę tego typu połączenia podczas nawiązywania połączeń. Oznacza to, że to połączenie jest możliwe, ale nie jest gwarantowane, ponieważ istnieją inne czynniki, które mogą zapobiec temu typowi połączenia, Wyłączone: UDP nie podejmie próby tego typu połączenia podczas nawiązywania połączeń "Wartość domyślna"
"Wyłączone"
"Włączone"
pierścień Numer pierścienia puli hostów. Int
ssoadfsAuthority (Uprawnienia) Adres URL serwera usług AD FS klienta do podpisywania certyfikatów logowania jednokrotnego WVD. ciąg
ssoClientId (identyfikator klienta) ClientId zarejestrowanej jednostki uzależnionej używanej do wystawiania certyfikatów logowania jednokrotnego WVD. ciąg
ssoClientSecretKeyVaultPath Ścieżka do usługi Azure KeyVault przechowując wpis tajny używany do komunikacji z usługami ADFS. ciąg
ssoSecretType (typ sekretu) Typ logowania jednokrotnego w typie wpisu tajnego. "Certyfikat"
"CertificateInKeyVault"
"SharedKey"
"SharedKeyInKeyVault"
startVMOnConnect (start VMOnConnect) Flaga włączania/wyłączania funkcji StartVMOnConnect. Bool
validationEnvironment (walidacjaŚrodowisko) To środowisko weryfikacji. Bool
Szablon vmTemplate Szablon maszyny wirtualnej dla konfiguracji hostów sesji w puli hostów. ciąg

KonserwacjaWindowProperties

Nazwa Opis Wartość
dzień tygodnia Dzień tygodnia. "Piątek"
"Poniedziałek"
"Sobota"
"Niedziela"
"Czwartek"
"Wtorek"
"Środa"
godzina Godzina rozpoczęcia aktualizacji dnia. (0 - 23) Int

ManagedServiceIdentity

Nazwa Opis Wartość
typ Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned). "Brak"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (wymagane)
tożsamości przypisane użytkownikom Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Klucze słownika userAssignedIdentities będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Wartości słownika mogą być pustymi obiektami ({}) w żądaniach. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nazwa Opis Wartość

Planowanie

Nazwa Opis Wartość
nazwa Zdefiniowana przez użytkownika nazwa artefaktu innej firmy, który jest pozyskiwany. ciąg (wymagany)
produkt Artefakt innej firmy, który jest pozyskiwany. Np. NewRelic. Produkt jest mapowy na wartość OfferID określoną dla artefaktu podczas dołączania do usługi Data Market. ciąg (wymagany)
kod podwyższania poziomu Wydawca dostarczył kod podwyższania poziomu jako zaaprowizowany w usłudze Data Market dla podanego produktu/artefaktu. ciąg
wydawca Wydawca zakupionego artefaktu innej firmy. Np. NewRelic ciąg (wymagany)
wersja Wersja żądanego produktu/artefaktu. ciąg

Informacje o rejestracji

Nazwa Opis Wartość
czas wygaśnięcia Czas wygaśnięcia tokenu rejestracji. ciąg
registrationTokenOperation (operacja tokenu) Typ resetowania tokenu. "Usuń"
"Brak"
"Aktualizuj"
kod przedpłaty Ciąg zakodowany w tokenie rejestracji base64. ciąg

Numer jednostki magazynowej

Nazwa Opis Wartość
dyspozycyjność Jeśli jednostka SKU obsługuje skalowanie w poziomie/w, należy uwzględnić liczbę całkowitą pojemności. Jeśli skalowanie w poziomie/w nie jest możliwe dla zasobu, może to zostać pominięte. Int
rodzina Jeśli usługa ma różne generacje sprzętu, dla tej samej jednostki SKU, można je przechwycić tutaj. ciąg
nazwa Nazwa jednostki SKU. Np. P3. Zazwyczaj jest to kod z literą i cyfrą ciąg (wymagany)
rozmiar Rozmiar jednostki SKU. Gdy pole nazwy jest kombinacją warstwy i innej wartości, będzie to autonomiczny kod. ciąg
warstwa To pole jest wymagane do zaimplementowania przez dostawcę zasobów, jeśli usługa ma więcej niż jedną warstwę, ale nie jest wymagana w put. "Podstawowa"
"Bezpłatna"
"Premium"
"Standardowa"

Śledzone tagi zasobów

Nazwa Opis Wartość

Tożsamość przypisana przez użytkownika

Nazwa Opis Wartość