Partager via


Microsoft.DesktopVirtualization hostPools 2020-11-10-preview

Définition de ressource Bicep

Le type de ressource hostPools peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.DesktopVirtualization/hostPools, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.DesktopVirtualization/hostPools@2020-11-10-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    customRdpProperty: 'string'
    description: 'string'
    friendlyName: 'string'
    hostPoolType: 'string'
    loadBalancerType: 'string'
    maxSessionLimit: int
    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'
  }
}

Valeurs de propriétés

hostPools

Nom Description Valeur
name Nom de la ressource string (obligatoire)

Limite de caractères : 3-64

Caractères valides :
Caractères alphanumériques, traits de soulignement, points et traits d’union.

Doit commencer par une lettre ou un chiffre. Terminez par une lettre, un chiffre ou un trait de soulignement.
location Emplacement géographique où réside la ressource string (obligatoire)
tags Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties Propriétés détaillées pour HostPool HostPoolProperties (obligatoire)

HostPoolProperties

Nom Description Valeur
customRdpProperty Propriété rdp personnalisée de HostPool. string
description Description de HostPool. string
friendlyName Nom convivial de HostPool. string
hostPoolType Type de pool d’hôtes pour le bureau. 'Personnel'
'Pooled' (obligatoire)
loadBalancerType Type de l’équilibreur de charge. 'BreadthFirst'
'DepthFirst'
'Persistent' (obligatoire)
maxSessionLimit Limite de session maximale de HostPool. int
personalDesktopAssignmentType Type PersonalDesktopAssignment pour HostPool. 'Automatic'
'Direct'
preferredAppGroupType Type de groupe d’applications préféré, par défaut groupe d’applications de bureau 'Desktop'
'None'
'RailApplications' (obligatoire)
registrationInfo Informations d’inscription de HostPool. RegistrationInfo
Anneau Numéro d’anneau de HostPool. int
ssoadfsAuthority URL du serveur ADFS du client pour la signature des certificats WVD SSO. string
ssoClientId ClientId pour la partie de confiance inscrite utilisée pour émettre des certificats DSO WVD. string
ssoClientSecretKeyVaultPath Chemin d’accès à Azure KeyVault stockant le secret utilisé pour la communication avec ADFS. string
ssoSecretType Type de secret d’authentification unique. 'Certificate'
'CertificateInKeyVault'
'SharedKey'
'SharedKeyInKeyVault'
startVMOnConnect Indicateur permettant d’activer/désactiver la fonctionnalité StartVMOnConnect. bool
validationEnvironment Est un environnement de validation. bool
vmTemplate Modèle de machine virtuelle pour la configuration sessionhosts dans le pool d’hôtes. string

RegistrationInfo

Nom Description Valeur
expirationTime Heure d’expiration du jeton d’inscription. string
registrationTokenOperation Type de réinitialisation du jeton. 'Delete'
'None'
'Update'
token Chaîne encodée en base64 du jeton d’inscription. string

Définition de ressources de modèle ARM

Le type de ressource hostPools peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.DesktopVirtualization/hostPools, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.DesktopVirtualization/hostPools",
  "apiVersion": "2020-11-10-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "customRdpProperty": "string",
    "description": "string",
    "friendlyName": "string",
    "hostPoolType": "string",
    "loadBalancerType": "string",
    "maxSessionLimit": "int",
    "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"
  }
}

Valeurs de propriétés

hostPools

Nom Description Valeur
type Type de ressource « Microsoft.DesktopVirtualization/hostPools »
apiVersion Version de l’API de ressource '2020-11-10-preview'
name Nom de la ressource string (obligatoire)

Limite de caractères : 3-64

Caractères valides :
Caractères alphanumériques, traits de soulignement, points et traits d’union.

Doit commencer par une lettre ou un chiffre. Terminez par une lettre, un chiffre ou un trait de soulignement.
location Emplacement géographique où réside la ressource string (obligatoire)
tags Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties Propriétés détaillées pour HostPool HostPoolProperties (obligatoire)

HostPoolProperties

Nom Description Valeur
customRdpProperty Propriété rdp personnalisée de HostPool. string
description Description de HostPool. string
friendlyName Nom convivial de HostPool. string
hostPoolType Type de pool d’hôtes pour le bureau. 'Personnel'
'Pooled' (obligatoire)
loadBalancerType Type de l’équilibreur de charge. 'BreadthFirst'
'DepthFirst'
'Persistent' (obligatoire)
maxSessionLimit Limite de session maximale de HostPool. int
personalDesktopAssignmentType Type PersonalDesktopAssignment pour HostPool. 'Automatic'
'Direct'
preferredAppGroupType Type de groupe d’applications préféré, par défaut groupe d’applications de bureau 'Desktop'
'None'
'RailApplications' (obligatoire)
registrationInfo Informations d’inscription de HostPool. RegistrationInfo
Anneau Numéro d’anneau de HostPool. int
ssoadfsAuthority URL vers le serveur ADFS du client pour la signature de certificats DSO WVD. string
ssoClientId ClientId pour la partie de confiance inscrite utilisée pour émettre des certificats DSO WVD. string
ssoClientSecretKeyVaultPath Chemin d’accès à Azure KeyVault stockant le secret utilisé pour la communication avec ADFS. string
ssoSecretType Type de secret d’authentification unique. 'Certificat'
'CertificateInKeyVault'
'SharedKey'
'SharedKeyInKeyVault'
startVMOnConnect Indicateur pour activer/désactiver la fonctionnalité StartVMOnConnect. bool
validationEnvironnement Environnement de validation. bool
vmTemplate Modèle de machine virtuelle pour la configuration sessionhosts dans hostpool. string

RegistrationInfo

Nom Description Valeur
expirationTime Heure d’expiration du jeton d’inscription. string
registrationTokenOperation Type de réinitialisation du jeton. 'Delete'
'None'
'Mettre à jour'
token Chaîne encodée en base64 du jeton d’inscription. string

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource hostPools peut être déployé avec des opérations qui ciblent :

  • Groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.DesktopVirtualization/hostPools, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DesktopVirtualization/hostPools@2020-11-10-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      customRdpProperty = "string"
      description = "string"
      friendlyName = "string"
      hostPoolType = "string"
      loadBalancerType = "string"
      maxSessionLimit = int
      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"
    }
  })
}

Valeurs de propriétés

hostPools

Nom Description Valeur
type Type de ressource « Microsoft.DesktopVirtualization/hostPools@2020-11-10-preview »
name Nom de la ressource chaîne (obligatoire)

Limite de caractères : 3-64

Caractères valides :
Caractères alphanumériques, traits de soulignement, points et traits d’union.

Doit commencer par une lettre ou un chiffre. Terminez par une lettre, un chiffre ou un trait de soulignement.
location Emplacement géographique où réside la ressource chaîne (obligatoire)
parent_id Pour effectuer un déploiement sur un groupe de ressources, utilisez l’ID de ce groupe de ressources. chaîne (obligatoire)
tags Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes.
properties Propriétés détaillées pour HostPool HostPoolProperties (obligatoire)

HostPoolProperties

Nom Description Valeur
customRdpProperty Propriété rdp personnalisée de HostPool. string
description Description de HostPool. string
friendlyName Nom convivial de HostPool. string
hostPoolType Type HostPool pour le bureau. « Personnel »
« Mis en pool » (obligatoire)
loadBalancerType Type de l’équilibreur de charge. « BreadthFirst »
« DepthFirst »
« Persistant » (obligatoire)
maxSessionLimit Limite de session maximale de HostPool. int
personalDesktopAssignmentType Type PersonalDesktopAssignment pour HostPool. « Automatique »
« Direct »
preferredAppGroupType Type de groupe d’applications préféré, par défaut groupe d’applications de bureau « Bureau »
"None"
« RailApplications » (obligatoire)
registrationInfo Informations d’inscription de HostPool. RegistrationInfo
Anneau Numéro d’anneau de HostPool. int
ssoadfsAuthority URL vers le serveur ADFS du client pour la signature de certificats DSO WVD. string
ssoClientId ClientId pour la partie de confiance inscrite utilisée pour émettre des certificats DSO WVD. string
ssoClientSecretKeyVaultPath Chemin d’accès à Azure KeyVault stockant le secret utilisé pour la communication avec ADFS. string
ssoSecretType Type de secret d’authentification unique. « Certificat »
« CertificateInKeyVault »
« SharedKey »
« SharedKeyInKeyVault »
startVMOnConnect Indicateur pour activer/désactiver la fonctionnalité StartVMOnConnect. bool
validationEnvironnement Environnement de validation. bool
vmTemplate Modèle de machine virtuelle pour la configuration sessionhosts dans hostpool. string

RegistrationInfo

Nom Description Valeur
expirationTime Heure d’expiration du jeton d’inscription. string
registrationTokenOperation Type de réinitialisation du jeton. "Delete"
"None"
« Mise à jour »
token Chaîne encodée en base64 du jeton d’inscription. string