Partager via


Microsoft.DesktopVirtualizationHostPools 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 de l’API, consultez journal des modifications.

Format de ressource

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

resource symbolicname 'Microsoft.DesktopVirtualization/hostPools@2020-11-10-preview' = {
  location: 'string'
  name: 'string'
  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'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

Microsoft.DesktopVirtualization/hostPools

Nom Descriptif Valeur
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 24 (obligatoire)
Propriétés Propriétés détaillées pour HostPool HostPoolProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

HostPoolProperties

Nom Descriptif Valeur
customRdpProperty Propriété rdp personnalisée de HostPool. corde
descriptif Description de HostPool. corde
nom convivial Nom convivial de HostPool. corde
hostPoolType Type HostPool pour le bureau. 'Personnel'
'Pooled' (obligatoire)
loadBalancerType Type de l’équilibreur de charge. « L’ampleur d’abord »
'ProfondeurD’abord'
'Persistent' (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 pour le groupe d’applications de bureau 'Ordinateur de bureau'
« Aucun »
'RailApplications' (obligatoire)
inscriptionInfos Informations d’inscription de HostPool. Infos sur l’inscription
bague Numéro d’anneau de HostPool. Int
ssoadfsAutorité URL du serveur ADFS client pour la signature de certificats WVD SSO. corde
ssoClientId ClientId pour la partie de confiance inscrite utilisée pour émettre des certificats WVD SSO. corde
ssoClientSecretKeyVaultPath Chemin d’accès à Azure KeyVault stockant le secret utilisé pour la communication avec ADFS. corde
ssoSecretType Type d’authentification unique Secret Type. 'Certificat'
'CertificateInKeyVault'
'Clé partagée'
'SharedKeyInKeyVault'
startVMOnConnect Indicateur permettant d’activer/désactiver la fonctionnalité StartVMOnConnect. Bool
validationEnvironnement Environnement de validation. Bool
vmTemplate Modèle de machine virtuelle pour la configuration de sessionhosts dans le pool d’hôtes. corde

Infos sur l’inscription

Nom Descriptif Valeur
temps d'expiration Délai d’expiration du jeton d’inscription. corde
registrationTokenOperation Type de réinitialisation du jeton. 'Supprimer'
« Aucun »
'Mise à jour'
jeton Chaîne encodée en base64 du jeton d’inscription. corde

TrackedResourceTags

Nom Descriptif Valeur

Exemples d’utilisation

Modules vérifiés Azure

Les modules vérifiés Azure suivants peuvent être utilisés pour déployer ce type de ressource.

Module Descriptif
pool d’hôtes Azure Virtual Desktop (AVD) Module de ressources AVM pour le pool d’hôtes Azure Virtual Desktop (AVD)

Exemples de démarrage rapide Azure

Les modèles de démarrage rapide Azure suivants contiennent des exemples Bicep pour le déploiement de ce type de ressource.

Fichier Bicep Descriptif
crée AVD avec microsoft Entra ID Join Ce modèle vous permet de créer des ressources Azure Virtual Desktop telles que le pool d’hôtes, le groupe d’applications, l’espace de travail, un hôte de session de test et ses extensions avec jointure d’ID Microsoft Entra

Définition de ressource 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 de l’API, consultez journal des modifications.

Format de ressource

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",
  "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

Microsoft.DesktopVirtualization/hostPools

Nom Descriptif Valeur
apiVersion Version de l’API '2020-11-10-preview'
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 24 (obligatoire)
Propriétés Propriétés détaillées pour HostPool HostPoolProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.DesktopVirtualization/hostPools'

HostPoolProperties

Nom Descriptif Valeur
customRdpProperty Propriété rdp personnalisée de HostPool. corde
descriptif Description de HostPool. corde
nom convivial Nom convivial de HostPool. corde
hostPoolType Type HostPool pour le bureau. 'Personnel'
'Pooled' (obligatoire)
loadBalancerType Type de l’équilibreur de charge. « L’ampleur d’abord »
'ProfondeurD’abord'
'Persistent' (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 pour le groupe d’applications de bureau 'Ordinateur de bureau'
« Aucun »
'RailApplications' (obligatoire)
inscriptionInfos Informations d’inscription de HostPool. Infos sur l’inscription
bague Numéro d’anneau de HostPool. Int
ssoadfsAutorité URL du serveur ADFS client pour la signature de certificats WVD SSO. corde
ssoClientId ClientId pour la partie de confiance inscrite utilisée pour émettre des certificats WVD SSO. corde
ssoClientSecretKeyVaultPath Chemin d’accès à Azure KeyVault stockant le secret utilisé pour la communication avec ADFS. corde
ssoSecretType Type d’authentification unique Secret Type. 'Certificat'
'CertificateInKeyVault'
'Clé partagée'
'SharedKeyInKeyVault'
startVMOnConnect Indicateur permettant d’activer/désactiver la fonctionnalité StartVMOnConnect. Bool
validationEnvironnement Environnement de validation. Bool
vmTemplate Modèle de machine virtuelle pour la configuration de sessionhosts dans le pool d’hôtes. corde

Infos sur l’inscription

Nom Descriptif Valeur
temps d'expiration Délai d’expiration du jeton d’inscription. corde
registrationTokenOperation Type de réinitialisation du jeton. 'Supprimer'
« Aucun »
'Mise à jour'
jeton Chaîne encodée en base64 du jeton d’inscription. corde

TrackedResourceTags

Nom Descriptif Valeur

Exemples d’utilisation

Modèles de démarrage rapide Azure

Les modèles de démarrage rapide Azure suivants déployer ce type de ressource.

Modèle Descriptif
crée AVD avec microsoft Entra ID Join

Déployer sur Azure
Ce modèle vous permet de créer des ressources Azure Virtual Desktop telles que le pool d’hôtes, le groupe d’applications, l’espace de travail, un hôte de session de test et ses extensions avec jointure d’ID Microsoft Entra

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 de ressource

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"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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é

Microsoft.DesktopVirtualization/hostPools

Nom Descriptif Valeur
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 24 (obligatoire)
Propriétés Propriétés détaillées pour HostPool HostPoolProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.DesktopVirtualization/hostPools@2020-11-10-preview »

HostPoolProperties

Nom Descriptif Valeur
customRdpProperty Propriété rdp personnalisée de HostPool. corde
descriptif Description de HostPool. corde
nom convivial Nom convivial de HostPool. corde
hostPoolType Type HostPool pour le bureau. 'Personnel'
'Pooled' (obligatoire)
loadBalancerType Type de l’équilibreur de charge. « L’ampleur d’abord »
'ProfondeurD’abord'
'Persistent' (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 pour le groupe d’applications de bureau 'Ordinateur de bureau'
« Aucun »
'RailApplications' (obligatoire)
inscriptionInfos Informations d’inscription de HostPool. Infos sur l’inscription
bague Numéro d’anneau de HostPool. Int
ssoadfsAutorité URL du serveur ADFS client pour la signature de certificats WVD SSO. corde
ssoClientId ClientId pour la partie de confiance inscrite utilisée pour émettre des certificats WVD SSO. corde
ssoClientSecretKeyVaultPath Chemin d’accès à Azure KeyVault stockant le secret utilisé pour la communication avec ADFS. corde
ssoSecretType Type d’authentification unique Secret Type. 'Certificat'
'CertificateInKeyVault'
'Clé partagée'
'SharedKeyInKeyVault'
startVMOnConnect Indicateur permettant d’activer/désactiver la fonctionnalité StartVMOnConnect. Bool
validationEnvironnement Environnement de validation. Bool
vmTemplate Modèle de machine virtuelle pour la configuration de sessionhosts dans le pool d’hôtes. corde

Infos sur l’inscription

Nom Descriptif Valeur
temps d'expiration Délai d’expiration du jeton d’inscription. corde
registrationTokenOperation Type de réinitialisation du jeton. 'Supprimer'
« Aucun »
'Mise à jour'
jeton Chaîne encodée en base64 du jeton d’inscription. corde

TrackedResourceTags

Nom Descriptif Valeur

Exemples d’utilisation

Modules vérifiés Azure

Les modules vérifiés Azure suivants peuvent être utilisés pour déployer ce type de ressource.

Module Descriptif
pool d’hôtes Azure Virtual Desktop (AVD) Module de ressources AVM pour le pool d’hôtes Azure Virtual Desktop (AVD)