Aracılığıyla paylaş

Microsoft.DesktopVirtualization hostPools

  • Makale

Bicep kaynak tanımı

hostPools kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

  • kaynak grupları - Bkz. kaynak grubu dağıtım komutları

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.DesktopVirtualization/hostPools kaynağı oluşturmak için şablonunuza aşağıdaki Bicep'i ekleyin.

resource symbolicname 'Microsoft.DesktopVirtualization/hostPools@2024-11-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'
  }
}

Özellik Değerleri

AgentUpdateProperties

Ad Açıklama Değer
maintenanceWindows Bakım pencerelerinin listesi. Bakım pencereleri 2 saat uzunluğundadır. MaintenanceWindowProperties[]
maintenanceWindowTimeZone /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0 içinde tanımlanan bakım için saat dilimi. useLocalTime true ise ayarlanmalıdır. dizgi
tür Oturum konağı bileşenleri için bakım türü. 'Varsayılan'
'Zamanlanmış'
useSessionHostLocalTime Sanal makinenin localTime kullanılıp kullanılmaymayacağı. Bool

HostPoolProperties

Ad Açıklama Değer
agentUpdate Aracıyı, izleme aracısını ve yığın bileşenini güncelleştirmek için oturum ana bilgisayar yapılandırması. AgentUpdateProperties
customRdpProperty HostPool'un özel rdp özelliği. dizgi
Açıklama HostPool açıklaması. dizgi
directUDP Varsayılan: Bağlantı kullanılabilirliğini belirlemek için AVD genelinde ayarlar kullanılır, Etkin: UDP, bağlantı kurarken bu bağlantı türünü dener. Bu, bu bağlantı türünün engellenmesine neden olabilecek başka faktörler olduğundan bu bağlantının mümkün olduğu ancak garanti edilmediği anlamına gelir, Devre Dışı: UDP, bağlantı kurarken bu bağlantı türünü denemez 'Varsayılan'
'Devre Dışı'
'Etkin'
dostça İsim HostPool'un kolay adı. dizgi
hostPoolType Masaüstü için HostPool türü. 'BYODesktop'
'Kişisel'
'Havuza Alınan' (gerekli)
loadBalancerType Yük dengeleyicinin türü. 'BreadthFirst'
'DepthFirst'
'MultiplePersistent'
'Kalıcı' (gerekli)
managedPrivateUDP Varsayılan: Bağlantı kullanılabilirliğini belirlemek için AVD genelinde ayarlar kullanılır, Etkin: UDP, bağlantı kurarken bu bağlantı türünü dener. Bu, bu bağlantı türünün engellenmesine neden olabilecek başka faktörler olduğundan bu bağlantının mümkün olduğu ancak garanti edilmediği anlamına gelir, Devre Dışı: UDP, bağlantı kurarken bu bağlantı türünü denemez 'Varsayılan'
'Devre Dışı'
'Etkin'
yönetim türü Bu konak havuzu için yönetim türü, Otomatik veya Standart. Varsayılan değer Otomatik'tir. 'Otomatik'
'Standart'
maxSessionLimit HostPool'un en yüksek oturum sınırı. Int
personalDesktopAssignmentType HostPool için PersonalDesktopAssignment türü. 'Otomatik'
'Doğrudan'
preferredAppGroupType Tercih edilen uygulama grubu türü, varsayılan olarak Masaüstü Uygulama Grubu 'Masaüstü'
'Hiçbiri'
'RailApplications' (gerekli)
publicNetworkAccess Etkin, bu kaynağa hem genel hem de özel ağlardan erişilmesine izin verir, Devre Dışı ayarı bu kaynağa yalnızca özel uç noktalar üzerinden erişilmesine izin verir 'Devre Dışı'
'Etkin'
'EnabledForClientsOnly'
'EnabledForSessionHostsOnly'
publicUDP Varsayılan: Bağlantı kullanılabilirliğini belirlemek için AVD genelinde ayarlar kullanılır, Etkin: UDP, bağlantı kurarken bu bağlantı türünü dener. Bu, bu bağlantı türünün engellenmesine neden olabilecek başka faktörler olduğundan bu bağlantının mümkün olduğu ancak garanti edilmediği anlamına gelir, Devre Dışı: UDP, bağlantı kurarken bu bağlantı türünü denemez 'Varsayılan'
'Devre Dışı'
'Etkin'
registrationInfo HostPool'un kayıt bilgileri. Bu, GET'de döndürülmüyor. Kayıt belirtecini almak için retrieveRegistrationToken veya listRegistrationTokens POST çağrılarını kullanın. RegistrationInfo
relayUDP Varsayılan: Bağlantı kullanılabilirliğini belirlemek için AVD genelinde ayarlar kullanılır, Etkin: UDP, bağlantı kurarken bu bağlantı türünü dener. Bu, bu bağlantı türünün engellenmesine neden olabilecek başka faktörler olduğundan bu bağlantının mümkün olduğu ancak garanti edilmediği anlamına gelir, Devre Dışı: UDP, bağlantı kurarken bu bağlantı türünü denemez 'Varsayılan'
'Devre Dışı'
'Etkin'
halka HostPool'un halka numarası. Int
ssoadfsAuthority WVD SSO sertifikalarını imzalamak için müşteri ADFS sunucusunun URL'si. dizgi
ssoClientId WVD SSO sertifikaları vermek için kullanılan kayıtlı Bağlı Olan Taraf için ClientId. dizgi
ssoClientSecretKeyVaultPath ADFS ile iletişim için kullanılan gizli diziyi depolayarak Azure KeyVault yolu. dizgi
ssoSecretType Gizli Dizi Türünde çoklu oturum açma türü. 'Sertifika'
'CertificateInKeyVault'
'SharedKey'
'SharedKeyInKeyVault'
startVMOnConnect StartVMOnConnect özelliğini açma/kapatma bayrağı. Bool
validationEnvironment Doğrulama ortamıdır. Bool
vmTemplate Konak havuzu içindeki sessionhosts yapılandırması için VM şablonu. dizgi

MaintenanceWindowProperties

Ad Açıklama Değer
dayOfWeek Haftanın günü. 'Cuma'
'Pazartesi'
'Cumartesi'
'Pazar'
'Perşembe'
'Salı'
'Çarşamba'
saat Güncelleştirme günün başlangıç saati. (0 - 23) Int

ManagedServiceIdentity (Yönetilen Servis Kimliği)

Ad Açıklama Değer
tür Yönetilen hizmet kimliği türü (hem SystemAssigned hem de UserAssigned türlerine izin verilir). 'Hiçbiri'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (gerekli)
kullanıcı tarafından atanan kimlikler Kaynakla ilişkili kullanıcı tarafından atanan kimlik kümesi. userAssignedIdentities sözlük anahtarları şu formda ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Sözlük değerleri, isteklerdeki boş nesneler ({}) olabilir. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Ad Açıklama Değer

Microsoft.DesktopVirtualization/hostPools

Ad Açıklama Değer
kimlik Yönetilen hizmet kimliği (sistem tarafından atanan ve/veya kullanıcı tarafından atanan kimlikler) ManagedServiceIdentity
tür Portal/araçlar/vb. tarafından aynı türdeki kaynaklar için farklı UX deneyimlerini işlemek için kullanılan meta veriler. Örneğin ApiApps bir tür Microsoft.Web/sites türüdür. Destekleniyorsa, kaynak sağlayıcısı bu değeri doğrulamalı ve kalıcı olmalıdır. dizgi

Kısıtlama -ları:
Desen = ^[-\w\._,\(\)]+$
yer Kaynağın bulunduğu coğrafi konum dize (gerekli)
managedBy Bu kaynağı yöneten kaynağın tam kaynak kimliği. Bu kaynağın başka bir Azure kaynağı tarafından yönetilip yönetilmediğini gösterir. Bu varsa, başka bir kaynak tarafından yönetildiğinden, şablondan kaldırılırsa tam mod dağıtımı kaynağı silmez. dizgi
ad Kaynak adı dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 255
Desen = ^[A-Za-z0-9@.\-_ ]*$ (gerekli)
tasarı Kaynağı planlayın. Tasarı
Özellikler HostPool için ayrıntılı özellikler HostPoolProperties (gerekli)
Sku SKU'yu temsil eden kaynak modeli tanımı Sku
Etiketler Kaynak etiketleri Etiket adları ve değerleri sözlüğü. Bkz. şablonlardaki Etiketleri

Tasarı

Ad Açıklama Değer
ad Temin edilen 3. Taraf Yapıtı'nın kullanıcı tanımlı adı. dize (gerekli)
ürün Temin edilen 3. Taraf yapıtı. Örneğin, NewRelic. Ürün, Veri Pazarı ekleme sırasında yapıt için belirtilen OfferID ile eşler. dize (gerekli)
promotionCode Yayımcı, söz edilen ürün/yapıt için Data Market'te sağlanan promosyon kodunu sağladı. dizgi
yayınevi Satın alınan 3. Taraf Yapıtı'nın yayımcısı. Örneğin, NewRelic dize (gerekli)
Sürüm İstenen ürünün/yapıtın sürümü. dizgi

RegistrationInfo

Ad Açıklama Değer
son kullanma zamanı Kayıt belirtecinin sona erme zamanı. dizgi
registrationTokenOperation Belirteci sıfırlama türü. 'Sil'
'Hiçbiri'
'Update'
jeton Kayıt belirteci base64 kodlanmış dizesi. dizgi

Sku

Ad Açıklama Değer
kapasite SKU ölçeği genişletmeyi/genişletmeyi destekliyorsa kapasite tamsayısı dahil edilmelidir. Kaynak için ölçeği genişletme/daraltma mümkün değilse bu atlanabilir. Int
aile Hizmetin aynı SKU için farklı donanım nesilleri varsa, bu burada yakalanabilir. dizgi
ad SKU'nun adı. Örneğin P3. Bu genellikle bir harf+sayı kodudur dize (gerekli)
boyut SKU boyutu. Ad alanı katman ile başka bir değerin birleşimi olduğunda, bu tek başına kod olacaktır. dizgi
Katmanı Hizmetin birden fazla katmanı varsa, ancak PUT üzerinde gerekli değilse, bu alanın Kaynak Sağlayıcısı tarafından uygulanması gerekir. 'Temel'
'Ücretsiz'
'Premium'
'Standart'

TrackedResourceTags

Ad Açıklama Değer

Kullanıcı Atanmış Kimlik

Ad Açıklama Değer

Kullanım Örnekleri

Azure Doğrulanmış Modülleri

Aşağıdaki Azure Doğrulanmış Modüller bu kaynak türünü dağıtmak için kullanılabilir.

Modül Açıklama
Azure Sanal Masaüstü (AVD) Konak Havuzu Azure Sanal Masaüstü (AVD) Konak Havuzu için AVM Kaynak Modülü

Azure Hızlı Başlangıç Örnekleri

Aşağıdaki Azure Hızlı Başlangıç şablonları bu kaynak türünü dağıtmak için Bicep örnekleri içerir.

Bicep Dosyası Açıklama
Microsoft Entra ID Join ile AVD Oluşturur Bu şablon konak havuzu, uygulama grubu, çalışma alanı, test oturumu konağı ve Microsoft Entra ID join ile uzantıları gibi Azure Sanal Masaüstü kaynakları oluşturmanıza olanak tanır

ARM şablonu kaynak tanımı

hostPools kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

  • kaynak grupları - Bkz. kaynak grubu dağıtım komutları

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.DesktopVirtualization/hostPools kaynağı oluşturmak için şablonunuza aşağıdaki JSON dosyasını ekleyin.

{
  "type": "Microsoft.DesktopVirtualization/hostPools",
  "apiVersion": "2024-11-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"
  }
}

Özellik Değerleri

AgentUpdateProperties

Ad Açıklama Değer
maintenanceWindows Bakım pencerelerinin listesi. Bakım pencereleri 2 saat uzunluğundadır. MaintenanceWindowProperties[]
maintenanceWindowTimeZone /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0 içinde tanımlanan bakım için saat dilimi. useLocalTime true ise ayarlanmalıdır. dizgi
tür Oturum konağı bileşenleri için bakım türü. 'Varsayılan'
'Zamanlanmış'
useSessionHostLocalTime Sanal makinenin localTime kullanılıp kullanılmaymayacağı. Bool

HostPoolProperties

Ad Açıklama Değer
agentUpdate Aracıyı, izleme aracısını ve yığın bileşenini güncelleştirmek için oturum ana bilgisayar yapılandırması. AgentUpdateProperties
customRdpProperty HostPool'un özel rdp özelliği. dizgi
Açıklama HostPool açıklaması. dizgi
directUDP Varsayılan: Bağlantı kullanılabilirliğini belirlemek için AVD genelinde ayarlar kullanılır, Etkin: UDP, bağlantı kurarken bu bağlantı türünü dener. Bu, bu bağlantı türünün engellenmesine neden olabilecek başka faktörler olduğundan bu bağlantının mümkün olduğu ancak garanti edilmediği anlamına gelir, Devre Dışı: UDP, bağlantı kurarken bu bağlantı türünü denemez 'Varsayılan'
'Devre Dışı'
'Etkin'
dostça İsim HostPool'un kolay adı. dizgi
hostPoolType Masaüstü için HostPool türü. 'BYODesktop'
'Kişisel'
'Havuza Alınan' (gerekli)
loadBalancerType Yük dengeleyicinin türü. 'BreadthFirst'
'DepthFirst'
'MultiplePersistent'
'Kalıcı' (gerekli)
managedPrivateUDP Varsayılan: Bağlantı kullanılabilirliğini belirlemek için AVD genelinde ayarlar kullanılır, Etkin: UDP, bağlantı kurarken bu bağlantı türünü dener. Bu, bu bağlantı türünün engellenmesine neden olabilecek başka faktörler olduğundan bu bağlantının mümkün olduğu ancak garanti edilmediği anlamına gelir, Devre Dışı: UDP, bağlantı kurarken bu bağlantı türünü denemez 'Varsayılan'
'Devre Dışı'
'Etkin'
yönetim türü Bu konak havuzu için yönetim türü, Otomatik veya Standart. Varsayılan değer Otomatik'tir. 'Otomatik'
'Standart'
maxSessionLimit HostPool'un en yüksek oturum sınırı. Int
personalDesktopAssignmentType HostPool için PersonalDesktopAssignment türü. 'Otomatik'
'Doğrudan'
preferredAppGroupType Tercih edilen uygulama grubu türü, varsayılan olarak Masaüstü Uygulama Grubu 'Masaüstü'
'Hiçbiri'
'RailApplications' (gerekli)
publicNetworkAccess Etkin, bu kaynağa hem genel hem de özel ağlardan erişilmesine izin verir, Devre Dışı ayarı bu kaynağa yalnızca özel uç noktalar üzerinden erişilmesine izin verir 'Devre Dışı'
'Etkin'
'EnabledForClientsOnly'
'EnabledForSessionHostsOnly'
publicUDP Varsayılan: Bağlantı kullanılabilirliğini belirlemek için AVD genelinde ayarlar kullanılır, Etkin: UDP, bağlantı kurarken bu bağlantı türünü dener. Bu, bu bağlantı türünün engellenmesine neden olabilecek başka faktörler olduğundan bu bağlantının mümkün olduğu ancak garanti edilmediği anlamına gelir, Devre Dışı: UDP, bağlantı kurarken bu bağlantı türünü denemez 'Varsayılan'
'Devre Dışı'
'Etkin'
registrationInfo HostPool'un kayıt bilgileri. Bu, GET'de döndürülmüyor. Kayıt belirtecini almak için retrieveRegistrationToken veya listRegistrationTokens POST çağrılarını kullanın. RegistrationInfo
relayUDP Varsayılan: Bağlantı kullanılabilirliğini belirlemek için AVD genelinde ayarlar kullanılır, Etkin: UDP, bağlantı kurarken bu bağlantı türünü dener. Bu, bu bağlantı türünün engellenmesine neden olabilecek başka faktörler olduğundan bu bağlantının mümkün olduğu ancak garanti edilmediği anlamına gelir, Devre Dışı: UDP, bağlantı kurarken bu bağlantı türünü denemez 'Varsayılan'
'Devre Dışı'
'Etkin'
halka HostPool'un halka numarası. Int
ssoadfsAuthority WVD SSO sertifikalarını imzalamak için müşteri ADFS sunucusunun URL'si. dizgi
ssoClientId WVD SSO sertifikaları vermek için kullanılan kayıtlı Bağlı Olan Taraf için ClientId. dizgi
ssoClientSecretKeyVaultPath ADFS ile iletişim için kullanılan gizli diziyi depolayarak Azure KeyVault yolu. dizgi
ssoSecretType Gizli Dizi Türünde çoklu oturum açma türü. 'Sertifika'
'CertificateInKeyVault'
'SharedKey'
'SharedKeyInKeyVault'
startVMOnConnect StartVMOnConnect özelliğini açma/kapatma bayrağı. Bool
validationEnvironment Doğrulama ortamıdır. Bool
vmTemplate Konak havuzu içindeki sessionhosts yapılandırması için VM şablonu. dizgi

MaintenanceWindowProperties

Ad Açıklama Değer
dayOfWeek Haftanın günü. 'Cuma'
'Pazartesi'
'Cumartesi'
'Pazar'
'Perşembe'
'Salı'
'Çarşamba'
saat Güncelleştirme günün başlangıç saati. (0 - 23) Int

ManagedServiceIdentity (Yönetilen Servis Kimliği)

Ad Açıklama Değer
tür Yönetilen hizmet kimliği türü (hem SystemAssigned hem de UserAssigned türlerine izin verilir). 'Hiçbiri'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (gerekli)
kullanıcı tarafından atanan kimlikler Kaynakla ilişkili kullanıcı tarafından atanan kimlik kümesi. userAssignedIdentities sözlük anahtarları şu formda ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Sözlük değerleri, isteklerdeki boş nesneler ({}) olabilir. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Ad Açıklama Değer

Microsoft.DesktopVirtualization/hostPools

Ad Açıklama Değer
apiVersiyonu API sürümü '2024-11-01-preview'
kimlik Yönetilen hizmet kimliği (sistem tarafından atanan ve/veya kullanıcı tarafından atanan kimlikler) ManagedServiceIdentity
tür Portal/araçlar/vb. tarafından aynı türdeki kaynaklar için farklı UX deneyimlerini işlemek için kullanılan meta veriler. Örneğin ApiApps bir tür Microsoft.Web/sites türüdür. Destekleniyorsa, kaynak sağlayıcısı bu değeri doğrulamalı ve kalıcı olmalıdır. dizgi

Kısıtlama -ları:
Desen = ^[-\w\._,\(\)]+$
yer Kaynağın bulunduğu coğrafi konum dize (gerekli)
managedBy Bu kaynağı yöneten kaynağın tam kaynak kimliği. Bu kaynağın başka bir Azure kaynağı tarafından yönetilip yönetilmediğini gösterir. Bu varsa, başka bir kaynak tarafından yönetildiğinden, şablondan kaldırılırsa tam mod dağıtımı kaynağı silmez. dizgi
ad Kaynak adı dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 255
Desen = ^[A-Za-z0-9@.\-_ ]*$ (gerekli)
tasarı Kaynağı planlayın. Tasarı
Özellikler HostPool için ayrıntılı özellikler HostPoolProperties (gerekli)
Sku SKU'yu temsil eden kaynak modeli tanımı Sku
Etiketler Kaynak etiketleri Etiket adları ve değerleri sözlüğü. Bkz. şablonlardaki Etiketleri
tür Kaynak türü 'Microsoft.DesktopVirtualization/hostPools'

Tasarı

Ad Açıklama Değer
ad Temin edilen 3. Taraf Yapıtı'nın kullanıcı tanımlı adı. dize (gerekli)
ürün Temin edilen 3. Taraf yapıtı. Örneğin, NewRelic. Ürün, Veri Pazarı ekleme sırasında yapıt için belirtilen OfferID ile eşler. dize (gerekli)
promotionCode Yayımcı, söz edilen ürün/yapıt için Data Market'te sağlanan promosyon kodunu sağladı. dizgi
yayınevi Satın alınan 3. Taraf Yapıtı'nın yayımcısı. Örneğin, NewRelic dize (gerekli)
Sürüm İstenen ürünün/yapıtın sürümü. dizgi

RegistrationInfo

Ad Açıklama Değer
son kullanma zamanı Kayıt belirtecinin sona erme zamanı. dizgi
registrationTokenOperation Belirteci sıfırlama türü. 'Sil'
'Hiçbiri'
'Update'
jeton Kayıt belirteci base64 kodlanmış dizesi. dizgi

Sku

Ad Açıklama Değer
kapasite SKU ölçeği genişletmeyi/genişletmeyi destekliyorsa kapasite tamsayısı dahil edilmelidir. Kaynak için ölçeği genişletme/daraltma mümkün değilse bu atlanabilir. Int
aile Hizmetin aynı SKU için farklı donanım nesilleri varsa, bu burada yakalanabilir. dizgi
ad SKU'nun adı. Örneğin P3. Bu genellikle bir harf+sayı kodudur dize (gerekli)
boyut SKU boyutu. Ad alanı katman ile başka bir değerin birleşimi olduğunda, bu tek başına kod olacaktır. dizgi
Katmanı Hizmetin birden fazla katmanı varsa, ancak PUT üzerinde gerekli değilse, bu alanın Kaynak Sağlayıcısı tarafından uygulanması gerekir. 'Temel'
'Ücretsiz'
'Premium'
'Standart'

TrackedResourceTags

Ad Açıklama Değer

Kullanıcı Atanmış Kimlik

Ad Açıklama Değer

Kullanım Örnekleri

Azure Hızlı Başlangıç Şablonları

Aşağıdaki Azure Hızlı Başlangıç şablonları bu kaynak türünü dağıtmak.

Şablon Açıklama
Microsoft Entra ID Join ile AVD Oluşturur

Azure 'a dağıtma		 Bu şablon konak havuzu, uygulama grubu, çalışma alanı, test oturumu konağı ve Microsoft Entra ID join ile uzantıları gibi Azure Sanal Masaüstü kaynakları oluşturmanıza olanak tanır

Terraform (AzAPI sağlayıcısı) kaynak tanımı

hostPools kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

  • Kaynak grupları

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.DesktopVirtualization/hostPools kaynağı oluşturmak için şablonunuza aşağıdaki Terraform'u ekleyin.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DesktopVirtualization/hostPools@2024-11-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"
    }
  }
}

Özellik Değerleri

AgentUpdateProperties

Ad Açıklama Değer
maintenanceWindows Bakım pencerelerinin listesi. Bakım pencereleri 2 saat uzunluğundadır. MaintenanceWindowProperties[]
maintenanceWindowTimeZone /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0 içinde tanımlanan bakım için saat dilimi. useLocalTime true ise ayarlanmalıdır. dizgi
tür Oturum konağı bileşenleri için bakım türü. 'Varsayılan'
'Zamanlanmış'
useSessionHostLocalTime Sanal makinenin localTime kullanılıp kullanılmaymayacağı. Bool

HostPoolProperties

Ad Açıklama Değer
agentUpdate Aracıyı, izleme aracısını ve yığın bileşenini güncelleştirmek için oturum ana bilgisayar yapılandırması. AgentUpdateProperties
customRdpProperty HostPool'un özel rdp özelliği. dizgi
Açıklama HostPool açıklaması. dizgi
directUDP Varsayılan: Bağlantı kullanılabilirliğini belirlemek için AVD genelinde ayarlar kullanılır, Etkin: UDP, bağlantı kurarken bu bağlantı türünü dener. Bu, bu bağlantı türünün engellenmesine neden olabilecek başka faktörler olduğundan bu bağlantının mümkün olduğu ancak garanti edilmediği anlamına gelir, Devre Dışı: UDP, bağlantı kurarken bu bağlantı türünü denemez 'Varsayılan'
'Devre Dışı'
'Etkin'
dostça İsim HostPool'un kolay adı. dizgi
hostPoolType Masaüstü için HostPool türü. 'BYODesktop'
'Kişisel'
'Havuza Alınan' (gerekli)
loadBalancerType Yük dengeleyicinin türü. 'BreadthFirst'
'DepthFirst'
'MultiplePersistent'
'Kalıcı' (gerekli)
managedPrivateUDP Varsayılan: Bağlantı kullanılabilirliğini belirlemek için AVD genelinde ayarlar kullanılır, Etkin: UDP, bağlantı kurarken bu bağlantı türünü dener. Bu, bu bağlantı türünün engellenmesine neden olabilecek başka faktörler olduğundan bu bağlantının mümkün olduğu ancak garanti edilmediği anlamına gelir, Devre Dışı: UDP, bağlantı kurarken bu bağlantı türünü denemez 'Varsayılan'
'Devre Dışı'
'Etkin'
yönetim türü Bu konak havuzu için yönetim türü, Otomatik veya Standart. Varsayılan değer Otomatik'tir. 'Otomatik'
'Standart'
maxSessionLimit HostPool'un en yüksek oturum sınırı. Int
personalDesktopAssignmentType HostPool için PersonalDesktopAssignment türü. 'Otomatik'
'Doğrudan'
preferredAppGroupType Tercih edilen uygulama grubu türü, varsayılan olarak Masaüstü Uygulama Grubu 'Masaüstü'
'Hiçbiri'
'RailApplications' (gerekli)
publicNetworkAccess Etkin, bu kaynağa hem genel hem de özel ağlardan erişilmesine izin verir, Devre Dışı ayarı bu kaynağa yalnızca özel uç noktalar üzerinden erişilmesine izin verir 'Devre Dışı'
'Etkin'
'EnabledForClientsOnly'
'EnabledForSessionHostsOnly'
publicUDP Varsayılan: Bağlantı kullanılabilirliğini belirlemek için AVD genelinde ayarlar kullanılır, Etkin: UDP, bağlantı kurarken bu bağlantı türünü dener. Bu, bu bağlantı türünün engellenmesine neden olabilecek başka faktörler olduğundan bu bağlantının mümkün olduğu ancak garanti edilmediği anlamına gelir, Devre Dışı: UDP, bağlantı kurarken bu bağlantı türünü denemez 'Varsayılan'
'Devre Dışı'
'Etkin'
registrationInfo HostPool'un kayıt bilgileri. Bu, GET'de döndürülmüyor. Kayıt belirtecini almak için retrieveRegistrationToken veya listRegistrationTokens POST çağrılarını kullanın. RegistrationInfo
relayUDP Varsayılan: Bağlantı kullanılabilirliğini belirlemek için AVD genelinde ayarlar kullanılır, Etkin: UDP, bağlantı kurarken bu bağlantı türünü dener. Bu, bu bağlantı türünün engellenmesine neden olabilecek başka faktörler olduğundan bu bağlantının mümkün olduğu ancak garanti edilmediği anlamına gelir, Devre Dışı: UDP, bağlantı kurarken bu bağlantı türünü denemez 'Varsayılan'
'Devre Dışı'
'Etkin'
halka HostPool'un halka numarası. Int
ssoadfsAuthority WVD SSO sertifikalarını imzalamak için müşteri ADFS sunucusunun URL'si. dizgi
ssoClientId WVD SSO sertifikaları vermek için kullanılan kayıtlı Bağlı Olan Taraf için ClientId. dizgi
ssoClientSecretKeyVaultPath ADFS ile iletişim için kullanılan gizli diziyi depolayarak Azure KeyVault yolu. dizgi
ssoSecretType Gizli Dizi Türünde çoklu oturum açma türü. 'Sertifika'
'CertificateInKeyVault'
'SharedKey'
'SharedKeyInKeyVault'
startVMOnConnect StartVMOnConnect özelliğini açma/kapatma bayrağı. Bool
validationEnvironment Doğrulama ortamıdır. Bool
vmTemplate Konak havuzu içindeki sessionhosts yapılandırması için VM şablonu. dizgi

MaintenanceWindowProperties

Ad Açıklama Değer
dayOfWeek Haftanın günü. 'Cuma'
'Pazartesi'
'Cumartesi'
'Pazar'
'Perşembe'
'Salı'
'Çarşamba'
saat Güncelleştirme günün başlangıç saati. (0 - 23) Int

ManagedServiceIdentity (Yönetilen Servis Kimliği)

Ad Açıklama Değer
tür Yönetilen hizmet kimliği türü (hem SystemAssigned hem de UserAssigned türlerine izin verilir). 'Hiçbiri'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (gerekli)
kullanıcı tarafından atanan kimlikler Kaynakla ilişkili kullanıcı tarafından atanan kimlik kümesi. userAssignedIdentities sözlük anahtarları şu formda ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Sözlük değerleri, isteklerdeki boş nesneler ({}) olabilir. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Ad Açıklama Değer

Microsoft.DesktopVirtualization/hostPools

Ad Açıklama Değer
kimlik Yönetilen hizmet kimliği (sistem tarafından atanan ve/veya kullanıcı tarafından atanan kimlikler) ManagedServiceIdentity
tür Portal/araçlar/vb. tarafından aynı türdeki kaynaklar için farklı UX deneyimlerini işlemek için kullanılan meta veriler. Örneğin ApiApps bir tür Microsoft.Web/sites türüdür. Destekleniyorsa, kaynak sağlayıcısı bu değeri doğrulamalı ve kalıcı olmalıdır. dizgi

Kısıtlama -ları:
Desen = ^[-\w\._,\(\)]+$
yer Kaynağın bulunduğu coğrafi konum dize (gerekli)
managedBy Bu kaynağı yöneten kaynağın tam kaynak kimliği. Bu kaynağın başka bir Azure kaynağı tarafından yönetilip yönetilmediğini gösterir. Bu varsa, başka bir kaynak tarafından yönetildiğinden, şablondan kaldırılırsa tam mod dağıtımı kaynağı silmez. dizgi
ad Kaynak adı dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 255
Desen = ^[A-Za-z0-9@.\-_ ]*$ (gerekli)
tasarı Kaynağı planlayın. Tasarı
Özellikler HostPool için ayrıntılı özellikler HostPoolProperties (gerekli)
Sku SKU'yu temsil eden kaynak modeli tanımı Sku
Etiketler Kaynak etiketleri Etiket adları ve değerleri sözlüğü.
tür Kaynak türü "Microsoft.DesktopVirtualization/hostPools@2024-11-01-preview"

Tasarı

Ad Açıklama Değer
ad Temin edilen 3. Taraf Yapıtı'nın kullanıcı tanımlı adı. dize (gerekli)
ürün Temin edilen 3. Taraf yapıtı. Örneğin, NewRelic. Ürün, Veri Pazarı ekleme sırasında yapıt için belirtilen OfferID ile eşler. dize (gerekli)
promotionCode Yayımcı, söz edilen ürün/yapıt için Data Market'te sağlanan promosyon kodunu sağladı. dizgi
yayınevi Satın alınan 3. Taraf Yapıtı'nın yayımcısı. Örneğin, NewRelic dize (gerekli)
Sürüm İstenen ürünün/yapıtın sürümü. dizgi

RegistrationInfo

Ad Açıklama Değer
son kullanma zamanı Kayıt belirtecinin sona erme zamanı. dizgi
registrationTokenOperation Belirteci sıfırlama türü. 'Sil'
'Hiçbiri'
'Update'
jeton Kayıt belirteci base64 kodlanmış dizesi. dizgi

Sku

Ad Açıklama Değer
kapasite SKU ölçeği genişletmeyi/genişletmeyi destekliyorsa kapasite tamsayısı dahil edilmelidir. Kaynak için ölçeği genişletme/daraltma mümkün değilse bu atlanabilir. Int
aile Hizmetin aynı SKU için farklı donanım nesilleri varsa, bu burada yakalanabilir. dizgi
ad SKU'nun adı. Örneğin P3. Bu genellikle bir harf+sayı kodudur dize (gerekli)
boyut SKU boyutu. Ad alanı katman ile başka bir değerin birleşimi olduğunda, bu tek başına kod olacaktır. dizgi
Katmanı Hizmetin birden fazla katmanı varsa, ancak PUT üzerinde gerekli değilse, bu alanın Kaynak Sağlayıcısı tarafından uygulanması gerekir. 'Temel'
'Ücretsiz'
'Premium'
'Standart'

TrackedResourceTags

Ad Açıklama Değer

Kullanıcı Atanmış Kimlik

Ad Açıklama Değer

Kullanım Örnekleri

Azure Doğrulanmış Modülleri

Aşağıdaki Azure Doğrulanmış Modüller bu kaynak türünü dağıtmak için kullanılabilir.

Modül Açıklama
Azure Sanal Masaüstü (AVD) Konak Havuzu Azure Sanal Masaüstü (AVD) Konak Havuzu için AVM Kaynak Modülü