Microsoft.Desktop仮想化アプリケーショングループ 2021-07-12

Bicep リソース定義

applicationGroups リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.DesktopVirtualization/applicationGroups リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.DesktopVirtualization/applicationGroups@2021-07-12' = {
  identity: {
    type: 'SystemAssigned'
  }
  kind: 'string'
  location: 'string'
  managedBy: 'string'
  name: 'string'
  plan: {
    name: 'string'
    product: 'string'
    promotionCode: 'string'
    publisher: 'string'
    version: 'string'
  }
  properties: {
    applicationGroupType: 'string'
    description: 'string'
    friendlyName: 'string'
    hostPoolArmPath: 'string'
    migrationRequest: {
      migrationPath: 'string'
      operation: 'string'
    }
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

Microsoft.DesktopVirtualization/applicationGroups

名前 形容 価値
ID ResourceModelWithAllowedPropertySetIdentity (英語)
種類 同じ種類のリソースに対して異なる UX エクスペリエンスをレンダリングするためにポータル/ツール/etc によって使用されるメタデータ。たとえば、ApiApps は Microsoft.Web/sites の種類の一種です。 サポートされている場合、リソース プロバイダーはこの値を検証して保持する必要があります。

制約:
パターン = ^[-\w\._,\(\)]+$
位置 リソースが存在する地理的な場所 文字列
管理されている このリソースを管理するリソースの完全修飾リソース ID。 このリソースが別の Azure リソースによって管理されているかどうかを示します。 これが存在する場合、完全モードのデプロイでは、別のリソースによって管理されているため、テンプレートから削除された場合、リソースは削除されません。 文字列
名前 リソース名

制約:
最小長 = 3
最大長 = 64 (必須)
プラン ResourceModelWithAllowedPropertySetPlan
プロパティ ApplicationGroup の詳細なプロパティ ApplicationGroupProperties (必須)
エスケーユー ResourceModelWithAllowedPropertySetSku
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください

アプリケーショングループプロパティ

名前 形容 価値
アプリケーショングループタイプ ApplicationGroup のリソースの種類。 「デスクトップ」
'RemoteApp' (必須)
形容 ApplicationGroup の説明。 文字列
フレンドリーネーム ApplicationGroup のフレンドリ名。 文字列
ホストプールアームパス ApplicationGroup の HostPool arm パス。 string (必須)
migrationRequest(移行リクエスト) HostPool の登録情報。 MigrationRequestProperties の

MigrationRequestProperties (英語)

名前 形容 価値
マイグレーションパス 移行するレガシ オブジェクトへのパス。 文字列
操作 移行の操作の種類。 「コンプリート」
「隠れる」
「取り消す」
「スタート」
'再表示'

ResourceModelWithAllowedPropertySetIdentity (英語)

名前 形容 価値
ID の種類。 'システム割り当て'

ResourceModelWithAllowedPropertySetPlan

名前 形容 価値
名前 調達中のサード パーティ成果物のユーザー定義名。 string (必須)
調達中のサード パーティの成果物。 例: NewRelic。 製品は、Data Market のオンボード時に成果物に指定された OfferID にマップされます。 string (必須)
プロモーションコード パブリッシャーは、その製品/成果物に対して Data Market でプロビジョニングされたプロモーション コードを提供しました。 文字列
パブリッシャ 購入中のサード パーティ成果物の発行元。 例: NewRelic string (必須)
バージョン 目的の製品/成果物のバージョン。 文字列

ResourceModelWithAllowedPropertySetSku

名前 形容 価値
キャパシティ SKU でスケールアウト/インがサポートされている場合は、容量の整数を含める必要があります。 リソースに対してスケールアウト/インができない場合は、これを省略できます。 整数 (int)
家族 同じ SKU に対して、サービスの世代が異なるハードウェアがある場合は、ここでキャプチャできます。 文字列
名前 SKU の名前。 例 - P3。 通常は文字 + 数字のコードです string (必須)
大きさ SKU サイズ。 名前フィールドが層と他の値の組み合わせである場合、これはスタンドアロン コードになります。 文字列
レベル このフィールドは、サービスに複数のレベルがあるが PUT では必要ない場合に、リソース プロバイダーによって実装される必要があります。 「ベーシック」
「無料」
「プレミアム」
「スタンダード」

ResourceModelWithAllowedPropertySetタグ

名前 形容 価値

使用例

Bicep サンプル

仮想デスクトップ アプリケーション グループの展開の基本的な例。

param resourceName string = 'acctest0001'
param location string = 'westus'

resource applicationGroup 'Microsoft.DesktopVirtualization/applicationGroups@2024-04-03' = {
  name: '${resourceName}-ag'
  location: location
  properties: {
    applicationGroupType: 'Desktop'
    description: ''
    friendlyName: ''
    hostPoolArmPath: hostPool.id
  }
}

resource hostPool 'Microsoft.DesktopVirtualization/hostPools@2024-04-03' = {
  name: '${resourceName}-hp'
  location: location
  properties: {
    customRdpProperty: ''
    description: ''
    friendlyName: ''
    hostPoolType: 'Pooled'
    loadBalancerType: 'BreadthFirst'
    maxSessionLimit: 999999
    personalDesktopAssignmentType: ''
    preferredAppGroupType: 'Desktop'
    publicNetworkAccess: 'Enabled'
    startVMOnConnect: false
    validationEnvironment: false
    vmTemplate: ''
  }
}

Azure 検証済みモジュール

次の Azure 検証済みモジュール を使用して、このリソースの種類をデプロイできます。

モジュール 形容
Azure Virtual Desktop (AVD) アプリケーション グループ Azure Virtual Desktop (AVD) アプリケーション グループ用 AVM リソース モジュール

Azure クイック スタートのサンプル

Azure クイック スタート テンプレート、このリソースの種類をデプロイするための Bicep サンプルが含まれています。

Bicep ファイル 形容
Microsoft Entra ID Join を使用して AVD を作成する このテンプレートを使用すると、ホスト プール、アプリケーション グループ、ワークスペース、テスト セッション ホスト、Microsoft Entra ID 参加を使用した拡張機能などの Azure Virtual Desktop リソースを作成できます。

ARM テンプレート リソース定義

applicationGroups リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.DesktopVirtualization/applicationGroups リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.DesktopVirtualization/applicationGroups",
  "apiVersion": "2021-07-12",
  "name": "string",
  "identity": {
    "type": "SystemAssigned"
  },
  "kind": "string",
  "location": "string",
  "managedBy": "string",
  "plan": {
    "name": "string",
    "product": "string",
    "promotionCode": "string",
    "publisher": "string",
    "version": "string"
  },
  "properties": {
    "applicationGroupType": "string",
    "description": "string",
    "friendlyName": "string",
    "hostPoolArmPath": "string",
    "migrationRequest": {
      "migrationPath": "string",
      "operation": "string"
    }
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

Microsoft.DesktopVirtualization/applicationGroups

名前 形容 価値
apiVersion (英語) API のバージョン '2021-07-12'
ID ResourceModelWithAllowedPropertySetIdentity (英語)
種類 同じ種類のリソースに対して異なる UX エクスペリエンスをレンダリングするためにポータル/ツール/etc によって使用されるメタデータ。たとえば、ApiApps は Microsoft.Web/sites の種類の一種です。 サポートされている場合、リソース プロバイダーはこの値を検証して保持する必要があります。

制約:
パターン = ^[-\w\._,\(\)]+$
位置 リソースが存在する地理的な場所 文字列
管理されている このリソースを管理するリソースの完全修飾リソース ID。 このリソースが別の Azure リソースによって管理されているかどうかを示します。 これが存在する場合、完全モードのデプロイでは、別のリソースによって管理されているため、テンプレートから削除された場合、リソースは削除されません。 文字列
名前 リソース名

制約:
最小長 = 3
最大長 = 64 (必須)
プラン ResourceModelWithAllowedPropertySetPlan
プロパティ ApplicationGroup の詳細なプロパティ ApplicationGroupProperties (必須)
エスケーユー ResourceModelWithAllowedPropertySetSku
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください
リソースの種類 'Microsoft.DesktopVirtualization/applicationGroups'

アプリケーショングループプロパティ

名前 形容 価値
アプリケーショングループタイプ ApplicationGroup のリソースの種類。 「デスクトップ」
'RemoteApp' (必須)
形容 ApplicationGroup の説明。 文字列
フレンドリーネーム ApplicationGroup のフレンドリ名。 文字列
ホストプールアームパス ApplicationGroup の HostPool arm パス。 string (必須)
migrationRequest(移行リクエスト) HostPool の登録情報。 MigrationRequestProperties の

MigrationRequestProperties (英語)

名前 形容 価値
マイグレーションパス 移行するレガシ オブジェクトへのパス。 文字列
操作 移行の操作の種類。 「コンプリート」
「隠れる」
「取り消す」
「スタート」
'再表示'

ResourceModelWithAllowedPropertySetIdentity (英語)

名前 形容 価値
ID の種類。 'システム割り当て'

ResourceModelWithAllowedPropertySetPlan

名前 形容 価値
名前 調達中のサード パーティ成果物のユーザー定義名。 string (必須)
調達中のサード パーティの成果物。 例: NewRelic。 製品は、Data Market のオンボード時に成果物に指定された OfferID にマップされます。 string (必須)
プロモーションコード パブリッシャーは、その製品/成果物に対して Data Market でプロビジョニングされたプロモーション コードを提供しました。 文字列
パブリッシャ 購入中のサード パーティ成果物の発行元。 例: NewRelic string (必須)
バージョン 目的の製品/成果物のバージョン。 文字列

ResourceModelWithAllowedPropertySetSku

名前 形容 価値
キャパシティ SKU でスケールアウト/インがサポートされている場合は、容量の整数を含める必要があります。 リソースに対してスケールアウト/インができない場合は、これを省略できます。 整数 (int)
家族 同じ SKU に対して、サービスの世代が異なるハードウェアがある場合は、ここでキャプチャできます。 文字列
名前 SKU の名前。 例 - P3。 通常は文字 + 数字のコードです string (必須)
大きさ SKU サイズ。 名前フィールドが層と他の値の組み合わせである場合、これはスタンドアロン コードになります。 文字列
レベル このフィールドは、サービスに複数のレベルがあるが PUT では必要ない場合に、リソース プロバイダーによって実装される必要があります。 「ベーシック」
「無料」
「プレミアム」
「スタンダード」

ResourceModelWithAllowedPropertySetタグ

名前 形容 価値

使用例

Azure クイック スタート テンプレート

このリソースの種類 デプロイする Azure クイック スタート テンプレート 次に示します。

テンプレート 形容
Microsoft Entra ID Join を使用して AVD を作成する

Azure にデプロイする
このテンプレートを使用すると、ホスト プール、アプリケーション グループ、ワークスペース、テスト セッション ホスト、Microsoft Entra ID 参加を使用した拡張機能などの Azure Virtual Desktop リソースを作成できます。

Terraform (AzAPI プロバイダー) リソース定義

applicationGroups リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループ

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.DesktopVirtualization/applicationGroups リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DesktopVirtualization/applicationGroups@2021-07-12"
  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 = {
      applicationGroupType = "string"
      description = "string"
      friendlyName = "string"
      hostPoolArmPath = "string"
      migrationRequest = {
        migrationPath = "string"
        operation = "string"
      }
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
  }
}

プロパティ値

Microsoft.DesktopVirtualization/applicationGroups

名前 形容 価値
ID ResourceModelWithAllowedPropertySetIdentity (英語)
種類 同じ種類のリソースに対して異なる UX エクスペリエンスをレンダリングするためにポータル/ツール/etc によって使用されるメタデータ。たとえば、ApiApps は Microsoft.Web/sites の種類の一種です。 サポートされている場合、リソース プロバイダーはこの値を検証して保持する必要があります。

制約:
パターン = ^[-\w\._,\(\)]+$
位置 リソースが存在する地理的な場所 文字列
管理されている このリソースを管理するリソースの完全修飾リソース ID。 このリソースが別の Azure リソースによって管理されているかどうかを示します。 これが存在する場合、完全モードのデプロイでは、別のリソースによって管理されているため、テンプレートから削除された場合、リソースは削除されません。 文字列
名前 リソース名

制約:
最小長 = 3
最大長 = 64 (必須)
プラン ResourceModelWithAllowedPropertySetPlan
プロパティ ApplicationGroup の詳細なプロパティ ApplicationGroupProperties (必須)
エスケーユー ResourceModelWithAllowedPropertySetSku
タグ リソース タグ タグ名と値のディクショナリ。
リソースの種類 "Microsoft.DesktopVirtualization/applicationGroups@2021-07-12" (英語)

アプリケーショングループプロパティ

名前 形容 価値
アプリケーショングループタイプ ApplicationGroup のリソースの種類。 「デスクトップ」
'RemoteApp' (必須)
形容 ApplicationGroup の説明。 文字列
フレンドリーネーム ApplicationGroup のフレンドリ名。 文字列
ホストプールアームパス ApplicationGroup の HostPool arm パス。 string (必須)
migrationRequest(移行リクエスト) HostPool の登録情報。 MigrationRequestProperties の

MigrationRequestProperties (英語)

名前 形容 価値
マイグレーションパス 移行するレガシ オブジェクトへのパス。 文字列
操作 移行の操作の種類。 「コンプリート」
「隠れる」
「取り消す」
「スタート」
'再表示'

ResourceModelWithAllowedPropertySetIdentity (英語)

名前 形容 価値
ID の種類。 'システム割り当て'

ResourceModelWithAllowedPropertySetPlan

名前 形容 価値
名前 調達中のサード パーティ成果物のユーザー定義名。 string (必須)
調達中のサード パーティの成果物。 例: NewRelic。 製品は、Data Market のオンボード時に成果物に指定された OfferID にマップされます。 string (必須)
プロモーションコード パブリッシャーは、その製品/成果物に対して Data Market でプロビジョニングされたプロモーション コードを提供しました。 文字列
パブリッシャ 購入中のサード パーティ成果物の発行元。 例: NewRelic string (必須)
バージョン 目的の製品/成果物のバージョン。 文字列

ResourceModelWithAllowedPropertySetSku

名前 形容 価値
キャパシティ SKU でスケールアウト/インがサポートされている場合は、容量の整数を含める必要があります。 リソースに対してスケールアウト/インができない場合は、これを省略できます。 整数 (int)
家族 同じ SKU に対して、サービスの世代が異なるハードウェアがある場合は、ここでキャプチャできます。 文字列
名前 SKU の名前。 例 - P3。 通常は文字 + 数字のコードです string (必須)
大きさ SKU サイズ。 名前フィールドが層と他の値の組み合わせである場合、これはスタンドアロン コードになります。 文字列
レベル このフィールドは、サービスに複数のレベルがあるが PUT では必要ない場合に、リソース プロバイダーによって実装される必要があります。 「ベーシック」
「無料」
「プレミアム」
「スタンダード」

ResourceModelWithAllowedPropertySetタグ

名前 形容 価値

使用例

Terraformサンプル

仮想デスクトップ アプリケーション グループの展開の基本的な例。

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westus"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "hostPool" {
  type      = "Microsoft.DesktopVirtualization/hostPools@2024-04-03"
  parent_id = azapi_resource.resourceGroup.id
  name      = "${var.resource_name}-hp"
  location  = var.location
  body = {
    properties = {
      customRdpProperty             = ""
      description                   = ""
      friendlyName                  = ""
      hostPoolType                  = "Pooled"
      loadBalancerType              = "BreadthFirst"
      maxSessionLimit               = 999999
      personalDesktopAssignmentType = ""
      preferredAppGroupType         = "Desktop"
      publicNetworkAccess           = "Enabled"
      startVMOnConnect              = false
      validationEnvironment         = false
      vmTemplate                    = ""
    }
  }
}

resource "azapi_resource" "applicationGroup" {
  type      = "Microsoft.DesktopVirtualization/applicationGroups@2024-04-03"
  parent_id = azapi_resource.resourceGroup.id
  name      = "${var.resource_name}-ag"
  location  = var.location
  body = {
    properties = {
      applicationGroupType = "Desktop"
      description          = ""
      friendlyName         = ""
      hostPoolArmPath      = azapi_resource.hostPool.id
    }
  }
}

Azure 検証済みモジュール

次の Azure 検証済みモジュール を使用して、このリソースの種類をデプロイできます。

モジュール 形容
Azure Virtual Desktop (AVD) アプリケーション グループ Azure Virtual Desktop (AVD) アプリケーション グループ用 AVM リソース モジュール