Share via


Microsoft.DesktopVirtualization hostPools

Bicep resource definition

The hostPools resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DesktopVirtualization/hostPools resource, add the following Bicep to your template.

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

Property values

AgentUpdateProperties

Name Description Value
maintenanceWindows List of maintenance windows. Maintenance windows are 2 hours long. MaintenanceWindowProperties[]
maintenanceWindowTimeZone Time zone for maintenance as defined in /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true. string
type The type of maintenance for session host components. 'Default'
'Scheduled'
useSessionHostLocalTime Whether to use localTime of the virtual machine. bool

HostPoolProperties

Name Description Value
agentUpdate The session host configuration for updating agent, monitoring agent, and stack component. AgentUpdateProperties
customRdpProperty Custom rdp property of HostPool. string
description Description of HostPool. string
directUDP Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections 'Default'
'Disabled'
'Enabled'
friendlyName Friendly name of HostPool. string
hostPoolType HostPool type for desktop. 'BYODesktop'
'Personal'
'Pooled' (required)
loadBalancerType The type of the load balancer. 'BreadthFirst'
'DepthFirst'
'MultiplePersistent'
'Persistent' (required)
managedPrivateUDP Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections 'Default'
'Disabled'
'Enabled'
managementType The type of management for this hostpool, Automated or Standard. The default value is Automated. 'Automated'
'Standard'
maxSessionLimit The max session limit of HostPool. int
personalDesktopAssignmentType PersonalDesktopAssignment type for HostPool. 'Automatic'
'Direct'
preferredAppGroupType The type of preferred application group type, default to Desktop Application Group 'Desktop'
'None'
'RailApplications' (required)
publicNetworkAccess Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints 'Disabled'
'Enabled'
'EnabledForClientsOnly'
'EnabledForSessionHostsOnly'
publicUDP Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections 'Default'
'Disabled'
'Enabled'
registrationInfo The registration info of HostPool. This is not returned on GET. In order to get the registration token use the retrieveRegistrationToken or listRegistrationTokens POST calls. RegistrationInfo
relayUDP Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections 'Default'
'Disabled'
'Enabled'
ring The ring number of HostPool. int
ssoadfsAuthority URL to customer ADFS server for signing WVD SSO certificates. string
ssoClientId ClientId for the registered Relying Party used to issue WVD SSO certificates. string
ssoClientSecretKeyVaultPath Path to Azure KeyVault storing the secret used for communication to ADFS. string
ssoSecretType The type of single sign on Secret Type. 'Certificate'
'CertificateInKeyVault'
'SharedKey'
'SharedKeyInKeyVault'
startVMOnConnect The flag to turn on/off StartVMOnConnect feature. bool
validationEnvironment Is validation environment. bool
vmTemplate VM template for sessionhosts configuration within hostpool. string

MaintenanceWindowProperties

Name Description Value
dayOfWeek Day of the week. 'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
hour The update start hour of the day. (0 - 23) int

ManagedServiceIdentity

Name Description Value
type Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (required)
userAssignedIdentities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

Microsoft.DesktopVirtualization/hostPools

Name Description Value
identity Managed service identity (system assigned and/or user assigned identities) ManagedServiceIdentity
kind Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. string

Constraints:
Pattern = ^[-\w\._,\(\)]+$
location The geo-location where the resource lives string (required)
managedBy The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource. string
name The resource name string

Constraints:
Min length = 1
Max length = 255
Pattern = ^[A-Za-z0-9@.\-_ ]*$ (required)
plan Plan for the resource. Plan
properties Detailed properties for HostPool HostPoolProperties (required)
sku The resource model definition representing SKU Sku
tags Resource tags Dictionary of tag names and values. See Tags in templates

Plan

Name Description Value
name A user defined name of the 3rd Party Artifact that is being procured. string (required)
product The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. string (required)
promotionCode A publisher provided promotion code as provisioned in Data Market for the said product/artifact. string
publisher The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic string (required)
version The version of the desired product/artifact. string

RegistrationInfo

Name Description Value
expirationTime Expiration time of registration token. string
registrationTokenOperation The type of resetting the token. 'Delete'
'None'
'Update'
token The registration token base64 encoded string. string

Sku

Name Description Value
capacity If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. int
family If the service has different generations of hardware, for the same SKU, then that can be captured here. string
name The name of the SKU. E.g. P3. It is typically a letter+number code string (required)
size The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. string
tier This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. 'Basic'
'Free'
'Premium'
'Standard'

TrackedResourceTags

Name Description Value

UserAssignedIdentity

Name Description Value

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File Description
Creates AVD with Microsoft Entra ID Join This template allows you to create Azure Virtual Desktop resources such as host pool, application group, workspace, a test session host and its extensions with Microsoft Entra ID join

ARM template resource definition

The hostPools resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DesktopVirtualization/hostPools resource, add the following JSON to your template.

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

Property values

AgentUpdateProperties

Name Description Value
maintenanceWindows List of maintenance windows. Maintenance windows are 2 hours long. MaintenanceWindowProperties[]
maintenanceWindowTimeZone Time zone for maintenance as defined in /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true. string
type The type of maintenance for session host components. 'Default'
'Scheduled'
useSessionHostLocalTime Whether to use localTime of the virtual machine. bool

HostPoolProperties

Name Description Value
agentUpdate The session host configuration for updating agent, monitoring agent, and stack component. AgentUpdateProperties
customRdpProperty Custom rdp property of HostPool. string
description Description of HostPool. string
directUDP Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections 'Default'
'Disabled'
'Enabled'
friendlyName Friendly name of HostPool. string
hostPoolType HostPool type for desktop. 'BYODesktop'
'Personal'
'Pooled' (required)
loadBalancerType The type of the load balancer. 'BreadthFirst'
'DepthFirst'
'MultiplePersistent'
'Persistent' (required)
managedPrivateUDP Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections 'Default'
'Disabled'
'Enabled'
managementType The type of management for this hostpool, Automated or Standard. The default value is Automated. 'Automated'
'Standard'
maxSessionLimit The max session limit of HostPool. int
personalDesktopAssignmentType PersonalDesktopAssignment type for HostPool. 'Automatic'
'Direct'
preferredAppGroupType The type of preferred application group type, default to Desktop Application Group 'Desktop'
'None'
'RailApplications' (required)
publicNetworkAccess Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints 'Disabled'
'Enabled'
'EnabledForClientsOnly'
'EnabledForSessionHostsOnly'
publicUDP Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections 'Default'
'Disabled'
'Enabled'
registrationInfo The registration info of HostPool. This is not returned on GET. In order to get the registration token use the retrieveRegistrationToken or listRegistrationTokens POST calls. RegistrationInfo
relayUDP Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections 'Default'
'Disabled'
'Enabled'
ring The ring number of HostPool. int
ssoadfsAuthority URL to customer ADFS server for signing WVD SSO certificates. string
ssoClientId ClientId for the registered Relying Party used to issue WVD SSO certificates. string
ssoClientSecretKeyVaultPath Path to Azure KeyVault storing the secret used for communication to ADFS. string
ssoSecretType The type of single sign on Secret Type. 'Certificate'
'CertificateInKeyVault'
'SharedKey'
'SharedKeyInKeyVault'
startVMOnConnect The flag to turn on/off StartVMOnConnect feature. bool
validationEnvironment Is validation environment. bool
vmTemplate VM template for sessionhosts configuration within hostpool. string

MaintenanceWindowProperties

Name Description Value
dayOfWeek Day of the week. 'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
hour The update start hour of the day. (0 - 23) int

ManagedServiceIdentity

Name Description Value
type Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (required)
userAssignedIdentities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

Microsoft.DesktopVirtualization/hostPools

Name Description Value
apiVersion The api version '2024-08-08-preview'
identity Managed service identity (system assigned and/or user assigned identities) ManagedServiceIdentity
kind Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. string

Constraints:
Pattern = ^[-\w\._,\(\)]+$
location The geo-location where the resource lives string (required)
managedBy The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource. string
name The resource name string

Constraints:
Min length = 1
Max length = 255
Pattern = ^[A-Za-z0-9@.\-_ ]*$ (required)
plan Plan for the resource. Plan
properties Detailed properties for HostPool HostPoolProperties (required)
sku The resource model definition representing SKU Sku
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DesktopVirtualization/hostPools'

Plan

Name Description Value
name A user defined name of the 3rd Party Artifact that is being procured. string (required)
product The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. string (required)
promotionCode A publisher provided promotion code as provisioned in Data Market for the said product/artifact. string
publisher The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic string (required)
version The version of the desired product/artifact. string

RegistrationInfo

Name Description Value
expirationTime Expiration time of registration token. string
registrationTokenOperation The type of resetting the token. 'Delete'
'None'
'Update'
token The registration token base64 encoded string. string

Sku

Name Description Value
capacity If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. int
family If the service has different generations of hardware, for the same SKU, then that can be captured here. string
name The name of the SKU. E.g. P3. It is typically a letter+number code string (required)
size The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. string
tier This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. 'Basic'
'Free'
'Premium'
'Standard'

TrackedResourceTags

Name Description Value

UserAssignedIdentity

Name Description Value

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Creates AVD with Microsoft Entra ID Join

Deploy to Azure
This template allows you to create Azure Virtual Desktop resources such as host pool, application group, workspace, a test session host and its extensions with Microsoft Entra ID join

Terraform (AzAPI provider) resource definition

The hostPools resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DesktopVirtualization/hostPools resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DesktopVirtualization/hostPools@2024-08-08-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"
  }
  sku = {
    capacity = int
    family = "string"
    name = "string"
    size = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    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"
    }
  })
}

Property values

AgentUpdateProperties

Name Description Value
maintenanceWindows List of maintenance windows. Maintenance windows are 2 hours long. MaintenanceWindowProperties[]
maintenanceWindowTimeZone Time zone for maintenance as defined in /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true. string
type The type of maintenance for session host components. 'Default'
'Scheduled'
useSessionHostLocalTime Whether to use localTime of the virtual machine. bool

HostPoolProperties

Name Description Value
agentUpdate The session host configuration for updating agent, monitoring agent, and stack component. AgentUpdateProperties
customRdpProperty Custom rdp property of HostPool. string
description Description of HostPool. string
directUDP Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections 'Default'
'Disabled'
'Enabled'
friendlyName Friendly name of HostPool. string
hostPoolType HostPool type for desktop. 'BYODesktop'
'Personal'
'Pooled' (required)
loadBalancerType The type of the load balancer. 'BreadthFirst'
'DepthFirst'
'MultiplePersistent'
'Persistent' (required)
managedPrivateUDP Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections 'Default'
'Disabled'
'Enabled'
managementType The type of management for this hostpool, Automated or Standard. The default value is Automated. 'Automated'
'Standard'
maxSessionLimit The max session limit of HostPool. int
personalDesktopAssignmentType PersonalDesktopAssignment type for HostPool. 'Automatic'
'Direct'
preferredAppGroupType The type of preferred application group type, default to Desktop Application Group 'Desktop'
'None'
'RailApplications' (required)
publicNetworkAccess Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints 'Disabled'
'Enabled'
'EnabledForClientsOnly'
'EnabledForSessionHostsOnly'
publicUDP Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections 'Default'
'Disabled'
'Enabled'
registrationInfo The registration info of HostPool. This is not returned on GET. In order to get the registration token use the retrieveRegistrationToken or listRegistrationTokens POST calls. RegistrationInfo
relayUDP Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections 'Default'
'Disabled'
'Enabled'
ring The ring number of HostPool. int
ssoadfsAuthority URL to customer ADFS server for signing WVD SSO certificates. string
ssoClientId ClientId for the registered Relying Party used to issue WVD SSO certificates. string
ssoClientSecretKeyVaultPath Path to Azure KeyVault storing the secret used for communication to ADFS. string
ssoSecretType The type of single sign on Secret Type. 'Certificate'
'CertificateInKeyVault'
'SharedKey'
'SharedKeyInKeyVault'
startVMOnConnect The flag to turn on/off StartVMOnConnect feature. bool
validationEnvironment Is validation environment. bool
vmTemplate VM template for sessionhosts configuration within hostpool. string

MaintenanceWindowProperties

Name Description Value
dayOfWeek Day of the week. 'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
hour The update start hour of the day. (0 - 23) int

ManagedServiceIdentity

Name Description Value
type Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (required)
userAssignedIdentities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

Microsoft.DesktopVirtualization/hostPools

Name Description Value
identity Managed service identity (system assigned and/or user assigned identities) ManagedServiceIdentity
kind Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. string

Constraints:
Pattern = ^[-\w\._,\(\)]+$
location The geo-location where the resource lives string (required)
managedBy The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource. string
name The resource name string

Constraints:
Min length = 1
Max length = 255
Pattern = ^[A-Za-z0-9@.\-_ ]*$ (required)
plan Plan for the resource. Plan
properties Detailed properties for HostPool HostPoolProperties (required)
sku The resource model definition representing SKU Sku
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DesktopVirtualization/hostPools@2024-08-08-preview"

Plan

Name Description Value
name A user defined name of the 3rd Party Artifact that is being procured. string (required)
product The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. string (required)
promotionCode A publisher provided promotion code as provisioned in Data Market for the said product/artifact. string
publisher The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic string (required)
version The version of the desired product/artifact. string

RegistrationInfo

Name Description Value
expirationTime Expiration time of registration token. string
registrationTokenOperation The type of resetting the token. 'Delete'
'None'
'Update'
token The registration token base64 encoded string. string

Sku

Name Description Value
capacity If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. int
family If the service has different generations of hardware, for the same SKU, then that can be captured here. string
name The name of the SKU. E.g. P3. It is typically a letter+number code string (required)
size The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. string
tier This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. 'Basic'
'Free'
'Premium'
'Standard'

TrackedResourceTags

Name Description Value

UserAssignedIdentity

Name Description Value