共用方式為


Microsoft.DesktopVirtualization hostPools 2021-07-12

Bicep 資源定義

hostPools 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄

資源格式

若要建立 Microsoft.DesktopVirtualization/hostPools 資源,請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.DesktopVirtualization/hostPools@2021-07-12' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
    {customized property}: 'string'
    {customized property}: 'string'
    {customized property}: 'string'
    {customized property}: 'string'
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  kind: 'string'
  identity: {
    type: 'SystemAssigned'
  }
  managedBy: 'string'
  plan: {
    name: 'string'
    product: 'string'
    promotionCode: 'string'
    publisher: 'string'
    version: 'string'
  }
  properties: {
    customRdpProperty: 'string'
    description: 'string'
    friendlyName: 'string'
    hostPoolType: 'string'
    loadBalancerType: 'string'
    maxSessionLimit: int
    migrationRequest: {
      migrationPath: 'string'
      operation: 'string'
    }
    personalDesktopAssignmentType: 'string'
    preferredAppGroupType: 'string'
    registrationInfo: {
      expirationTime: 'string'
      registrationTokenOperation: 'string'
      token: 'string'
    }
    ring: int
    ssoadfsAuthority: 'string'
    ssoClientId: 'string'
    ssoClientSecretKeyVaultPath: 'string'
    ssoSecretType: 'string'
    startVMOnConnect: bool
    validationEnvironment: bool
    vmTemplate: 'string'
  }
}

屬性值

hostPools

名稱 描述
NAME 資源名稱 字串 (必要)

字元限制:3-64

合法字元:
英數字元、底線、句號和連字號。

以字母或數字開頭。 以字母、數位或底線結尾。
location 資源所在的地理位置 字串
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標記
sku ResourceModelWithAllowedPropertySetSku
kind 入口網站/工具等用來轉譯相同類型資源的不同UX體驗的元數據;例如,ApiApps 是一種 Microsoft.Web/sites 類型。 如果支援,資源提供者必須驗證並保存此值。 字串

約束:
模式 = ^[-\w\._,\(\)]+$
身分識別 ResourceModelWithAllowedPropertySetIdentity
managedBy 管理此資源之資源的完整資源標識碼。 指出此資源是否由另一個 Azure 資源管理。 如果存在,如果從範本中移除,則完整模式部署將不會刪除該資源,因為該資源是由另一個資源管理。 字串
方案 ResourceModelWithAllowedPropertySetPlan
properties HostPool 的詳細屬性 HostPoolProperties (必要)

ResourceModelWithAllowedPropertySetIdentity

名稱 描述
類型 識別類型。 'SystemAssigned'

ResourceModelWithAllowedPropertySetPlan

名稱 描述
NAME 要購買的第三方成品的用戶定義名稱。 字串 (必要)
產品 要購買的第三方成品。 例如 NewRelic。 產品會對應至數據市場上線時為成品指定的 OfferID。 字串 (必要)
promotionCode 發行者針對上述產品/成品在數據市場中布建促銷碼。 字串
publisher 要購買的第三方成品發行者。 例如 NewRelic 字串 (必要)
version 所需產品/成品的版本。 字串

HostPoolProperties

名稱 描述
customRdpProperty HostPool 的自定義 rdp 屬性。 字串
description HostPool 的描述。 字串
friendlyName HostPool 的易記名稱。 字串
hostPoolType 桌面的 HostPool 類型。 'BYODesktop'
'Personal'
「集區」 (必要)
loadBalancerType 負載平衡器的型別。 'BreadthFirst'
'DepthFirst'
必要 ()
maxSessionLimit HostPool 的最大會話限制。 int
migrationRequest HostPool 的註冊資訊。 MigrationRequestProperties
personalDesktopAssignmentType HostPool 的 PersonalDesktopAssignment 類型。 'Automatic'
'Direct'
preferredAppGroupType 慣用應用程式群組類型的類型,預設為傳統型應用程式群組 'Desktop'
'None'
'RailApplications' (必要)
registrationInfo HostPool 的註冊資訊。 RegistrationInfo
響鈴 HostPool 的通道編號。 int
ssoadfsAuthority 客戶 ADFS 伺服器的 URL,用於簽署 WVD SSO 憑證。 字串
ssoClientId 用於發行 WVD SSO 憑證之已註冊信賴憑證者的 ClientId。 字串
ssoClientSecretKeyVaultPath 儲存用來與 ADFS 通訊之秘密的 Azure KeyVault 路徑。 字串
ssoSecretType 密碼類型上的單一登錄類型。 'Certificate'
'CertificateInKeyVault'
'SharedKey'
'SharedKeyInKeyVault'
startVMOnConnect 要開啟/關閉 StartVMOnConnect 功能的旗標。 bool
validationEnvironment 這是驗證環境。 bool
vmTemplate hostpool 中會話主機組態的 VM 範本。 字串

MigrationRequestProperties

名稱 描述
migrationPath 要移轉的舊版物件路徑。 字串
operation (作業) 移轉的作業類型。 'Complete'
'Hide'
'Revoke'
'Start'
'Unhide'

RegistrationInfo

名稱 描述
expirationTime 註冊令牌的到期時間。 字串
registrationTokenOperation 重設令牌的類型。 'Delete'
'None'
'Update'
token 註冊令牌 base64 編碼字串。 字串

ResourceModelWithAllowedPropertySetSku

名稱 描述
處理能力 如果 SKU 支援相應放大/縮小,則應該包含容量整數。 如果資源無法相應放大/縮小,則可能會省略此專案。 int
family 如果服務有不同層代的硬體,則針對相同的SKU,則可以在這裡擷取。 字串
NAME SKU 的名稱。 例如 - P3。 通常是字母+數字代碼 字串 (必要)
{1}size{2} SKU 大小。 當名稱欄位是階層和其他一些值的組合時,這會是獨立程序代碼。 字串
tier 如果服務有多個層級,但 PUT 上不需要,則資源提供者必須實作此字段。 'Basic'
'Free'
'Premium'
'Standard'

ARM 範本資源定義

hostPools 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄

資源格式

若要建立 Microsoft.DesktopVirtualization/hostPools 資源,請將下列 JSON 新增至您的範本。

{
  "type": "Microsoft.DesktopVirtualization/hostPools",
  "apiVersion": "2021-07-12",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
    "{customized property}": "string",
    "{customized property}": "string",
    "{customized property}": "string",
    "{customized property}": "string"
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "kind": "string",
  "identity": {
    "type": "SystemAssigned"
  },
  "managedBy": "string",
  "plan": {
    "name": "string",
    "product": "string",
    "promotionCode": "string",
    "publisher": "string",
    "version": "string"
  },
  "properties": {
    "customRdpProperty": "string",
    "description": "string",
    "friendlyName": "string",
    "hostPoolType": "string",
    "loadBalancerType": "string",
    "maxSessionLimit": "int",
    "migrationRequest": {
      "migrationPath": "string",
      "operation": "string"
    },
    "personalDesktopAssignmentType": "string",
    "preferredAppGroupType": "string",
    "registrationInfo": {
      "expirationTime": "string",
      "registrationTokenOperation": "string",
      "token": "string"
    },
    "ring": "int",
    "ssoadfsAuthority": "string",
    "ssoClientId": "string",
    "ssoClientSecretKeyVaultPath": "string",
    "ssoSecretType": "string",
    "startVMOnConnect": "bool",
    "validationEnvironment": "bool",
    "vmTemplate": "string"
  }
}

屬性值

hostPools

名稱 描述
類型 資源類型 'Microsoft.DesktopVirtualization/hostPools'
apiVersion 資源 API 版本 '2021-07-12'
NAME 資源名稱 字串 (必要)

字元限制:3-64

合法字元:
英數字元、底線、句號和連字號。

以字母或數字開頭。 以字母、數位或底線結尾。
location 資源所在的地理位置 字串
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標記
sku ResourceModelWithAllowedPropertySetSku
kind 入口網站/工具等用來轉譯相同類型資源的不同UX體驗的元數據;例如,ApiApps 是一種 Microsoft.Web/sites 類型。 如果支援,資源提供者必須驗證並保存此值。 字串

約束:
模式 = ^[-\w\._,\(\)]+$
身分識別 ResourceModelWithAllowedPropertySetIdentity
managedBy 管理此資源之資源的完整資源標識碼。 指出此資源是否由另一個 Azure 資源管理。 如果存在,如果從範本中移除,則完整模式部署將不會刪除該資源,因為該資源是由另一個資源管理。 字串
方案 ResourceModelWithAllowedPropertySetPlan
properties HostPool 的詳細屬性 HostPoolProperties (必要)

ResourceModelWithAllowedPropertySetIdentity

名稱 描述
類型 識別類型。 'SystemAssigned'

ResourceModelWithAllowedPropertySetPlan

名稱 描述
NAME 要購買的第三方成品的用戶定義名稱。 字串 (必要)
產品 要購買的第三方成品。 例如 NewRelic。 產品會對應至數據市場上線時為成品指定的 OfferID。 字串 (必要)
promotionCode 發行者針對上述產品/成品在數據市場中布建促銷碼。 字串
publisher 要購買的第三方成品發行者。 例如 NewRelic 需要字串 ()
version 所需產品/成品的版本。 字串

HostPoolProperties

名稱 描述
customRdpProperty HostPool 的自定義 rdp 屬性。 字串
description HostPool 的描述。 字串
friendlyName HostPool 的易記名稱。 字串
hostPoolType 桌面的 HostPool 類型。 'BYODesktop'
'Personal'
必要) 『Pooled』 (
loadBalancerType 負載平衡器的型別。 'BreadthFirst'
'DepthFirst'
需要 『Persistent』 ()
maxSessionLimit HostPool 的最大會話限制。 int
migrationRequest HostPool 的註冊資訊。 MigrationRequestProperties
personalDesktopAssignmentType HostPool 的 PersonalDesktopAssignment 類型。 'Automatic'
'Direct'
preferredAppGroupType 慣用應用程式群組類型的類型,預設為傳統型應用程式群組 'Desktop'
'None'
'RailApplications' (必要)
registrationInfo HostPool 的註冊資訊。 RegistrationInfo
響鈴 HostPool 的環形編號。 int
ssoadfsAuthority 用於簽署 WVD SSO 憑證的客戶 ADFS 伺服器的 URL。 字串
ssoClientId 用來發行 WVD SSO 憑證之已註冊信賴憑證者的 ClientId。 字串
ssoClientSecretKeyVaultPath 儲存用來與 ADFS 通訊之秘密的 Azure KeyVault 路徑。 字串
ssoSecretType 密碼類型的單一登錄類型。 'Certificate'
'CertificateInKeyVault'
'SharedKey'
'SharedKeyInKeyVault'
startVMOnConnect 要開啟/關閉 StartVMOnConnect 功能的旗標。 bool
validationEnvironment 這是驗證環境。 bool
vmTemplate hostpool 中會話主機組態的 VM 範本。 字串

MigrationRequestProperties

名稱 描述
migrationPath 要移轉的舊版物件路徑。 字串
operation (作業) 移轉的作業類型。 'Complete'
'Hide'
'Revoke'
'Start'
'Unhide'

RegistrationInfo

名稱 描述
expirationTime 註冊令牌的到期時間。 字串
registrationTokenOperation 重設令牌的類型。 'Delete'
'None'
'Update'
token 註冊令牌 base64 編碼字串。 字串

ResourceModelWithAllowedPropertySetSku

名稱 描述
處理能力 如果 SKU 支援相應放大/縮小,則應該包含容量整數。 如果資源無法相應放大/縮小,可能會省略此專案。 int
family 如果服務有不同的硬體世代,則針對相同的 SKU,則可以在這裡擷取。 字串
NAME SKU 的名稱。 例如 - P3。 通常是字母+數位碼 需要字串 ()
{1}size{2} SKU 大小。 當名稱欄位是階層和其他一些值的組合時,這會是獨立程序代碼。 字串
tier 如果服務有一個以上的層級,但在PUT上則不需要此欄位,才能由資源提供者實作。 'Basic'
'Free'
'Premium'
'Standard'

Terraform (AzAPI 提供者) 資源定義

hostPools 資源類型可以使用目標作業進行部署:

  • 資源群組

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DesktopVirtualization/hostPools 資源,請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DesktopVirtualization/hostPools@2021-07-12"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
    {customized property} = "string"
    {customized property} = "string"
    {customized property} = "string"
    {customized property} = "string"
  identity {
    type = "SystemAssigned"
  }
  body = jsonencode({
    properties = {
      customRdpProperty = "string"
      description = "string"
      friendlyName = "string"
      hostPoolType = "string"
      loadBalancerType = "string"
      maxSessionLimit = int
      migrationRequest = {
        migrationPath = "string"
        operation = "string"
      }
      personalDesktopAssignmentType = "string"
      preferredAppGroupType = "string"
      registrationInfo = {
        expirationTime = "string"
        registrationTokenOperation = "string"
        token = "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"
    }
    kind = "string"
    managedBy = "string"
    plan = {
      name = "string"
      product = "string"
      promotionCode = "string"
      publisher = "string"
      version = "string"
    }
  })
}

屬性值

hostPools

名稱 描述
類型 資源類型 “Microsoft.DesktopVirtualization/hostPools@2021-07-12”
NAME 資源名稱 需要字串 ()

字元限制:3-64

合法字元:
英數字元、底線、句號和連字號。

以字母或數字開頭。 以字母、數位或底線結尾。
location 資源所在的地理位置 字串
parent_id 若要部署至資源群組,請使用該資源群組的標識碼。 需要字串 ()
tags 資源標籤。 標記名稱和值的字典。
sku ResourceModelWithAllowedPropertySetSku
kind 入口網站/工具/等用來轉譯相同類型資源的不同UX體驗的元數據;例如,ApiApps 是一種 Microsoft.Web/sites 類型。 如果支援,資源提供者必須驗證並保存此值。 字串

約束:
模式 = ^[-\w\._,\(\)]+$
身分識別 ResourceModelWithAllowedPropertySetIdentity
managedBy 管理此資源之資源的完整資源標識碼。 指出此資源是否由另一個 Azure 資源管理。 如果存在,如果從範本中移除,則完整模式部署將不會刪除資源,因為該資源是由另一個資源所管理。 字串
方案 ResourceModelWithAllowedPropertySetPlan
properties HostPool 的詳細屬性 需要 HostPoolProperties ()

ResourceModelWithAllowedPropertySetIdentity

名稱 描述
類型 識別類型。 “SystemAssigned”

ResourceModelWithAllowedPropertySetPlan

名稱 描述
NAME 正在採購的第三方成品的用戶定義名稱。 需要字串 ()
產品 正在採購的第三方成品。 例如 NewRelic。 產品會對應至數據市場上線時為成品指定的 OfferID。 需要字串 ()
promotionCode 發行者在數據市場中針對上述產品/成品提供促銷碼。 字串
publisher 正在購買的第三方成品發行者。 例如 NewRelic 需要字串 ()
version 所需產品/成品的版本。 字串

HostPoolProperties

名稱 描述
customRdpProperty HostPool 的自定義 rdp 屬性。 字串
description HostPool 的描述。 字串
friendlyName HostPool 的易記名稱。 字串
hostPoolType 桌面的 HostPool 類型。 “BYODesktop”
“Personal”
“Pooled” (必要)
loadBalancerType 負載平衡器的型別。 “BreadthFirst”
“DepthFirst”
“Persistent” (必要)
maxSessionLimit HostPool 的最大會話限制。 int
migrationRequest HostPool 的註冊資訊。 MigrationRequestProperties
personalDesktopAssignmentType HostPool 的 PersonalDesktopAssignment 類型。 “Automatic”
“Direct”
preferredAppGroupType 慣用應用程式群組類型的類型,預設為傳統型應用程式群組 “Desktop”
"None"
“RailApplications” (必要)
registrationInfo HostPool 的註冊資訊。 RegistrationInfo
響鈴 HostPool 的環形編號。 int
ssoadfsAuthority 用於簽署 WVD SSO 憑證的客戶 ADFS 伺服器的 URL。 字串
ssoClientId 用來發行 WVD SSO 憑證之已註冊信賴憑證者的 ClientId。 字串
ssoClientSecretKeyVaultPath 儲存用來與 ADFS 通訊之秘密的 Azure KeyVault 路徑。 字串
ssoSecretType 密碼類型的單一登錄類型。 “憑證”
“CertificateInKeyVault”
“SharedKey”
“SharedKeyInKeyVault”
startVMOnConnect 要開啟/關閉 StartVMOnConnect 功能的旗標。 bool
validationEnvironment 這是驗證環境。 bool
vmTemplate hostpool 中會話主機組態的 VM 範本。 字串

MigrationRequestProperties

名稱 描述
migrationPath 要移轉的舊版物件路徑。 字串
operation (作業) 移轉的作業類型。 “Complete”
“隱藏”
“Revoke”
"Start"
“Unhide”

RegistrationInfo

名稱 描述
expirationTime 註冊令牌的到期時間。 字串
registrationTokenOperation 重設令牌的類型。 "Delete"
"None"
“Update”
token 註冊令牌 base64 編碼字串。 字串

ResourceModelWithAllowedPropertySetSku

名稱 描述
處理能力 如果 SKU 支援相應放大/縮小,則應該包含容量整數。 如果資源無法相應放大/縮小,則可能會省略此專案。 int
family 如果服務有不同層代的硬體,則針對相同的SKU,則可以在這裡擷取。 字串
NAME SKU 的名稱。 例如 - P3。 通常是字母+數字代碼 字串 (必要)
{1}size{2} SKU 大小。 當名稱欄位是階層和其他一些值的組合時,這會是獨立程序代碼。 字串
tier 如果服務有多個層級,但 PUT 上不需要,則資源提供者必須實作此字段。 "Basic"
“Free”
“Premium”
“Standard”