Notes
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
- dernière
- 2025-03-01-preview
- 2024-11-01-preview
- 2024-08-08-preview
- 2024-04-08-preview
- 2024-04-03
- 2024-03-06-preview
- 2024-01-16-preview
- 2023-11-01-preview
- 2023-10-04-preview
- 2023-09-05
- 2022-10-14-preview
- 2022-09-09
- 2022-04-01-preview
- 2022-02-10-preview
- 2021-09-03-preview
- 2021-07-12
- 2021-04-01-preview
- 2021-03-09-preview
- 2021-02-01-preview
- 2021-01-14-preview
- 2020-11-10-preview
- 2020-11-02-preview
- 2020-10-19-preview
- 2020-09-21-preview
- 2019-12-10-preview
- 2019-09-24-preview
- 2019-01-23-preview
Définition de ressource Bicep
Le type de ressource hostPools peut être déployé avec des opérations qui ciblent :
- groupes de ressources - Consultez commandes de déploiement de 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 bicep suivant à votre modèle.
resource symbolicname 'Microsoft.DesktopVirtualization/hostPools@2025-03-01-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'
}
}
Valeurs de propriété
Microsoft.DesktopVirtualization/hostPools
Nom | Descriptif | Valeur |
---|---|---|
identité | Identité de service managée (identités affectées par le système et/ou identités affectées par l’utilisateur) | ManagedServiceIdentity |
gentil | Métadonnées utilisées par le portail/l’outil/etc pour afficher différentes expériences d’expérience utilisateur pour les ressources du même type. Par exemple, ApiApps est un type de Microsoft.Web/sites. Si elle est prise en charge, le fournisseur de ressources doit valider et conserver cette valeur. | corde Contraintes: Modèle = ^[-\w\._,\(\)]+$ |
emplacement | Emplacement géographique où réside la ressource | chaîne (obligatoire) |
managedBy | ID de ressource complet de la ressource qui gère cette ressource. Indique si cette ressource est gérée par une autre ressource Azure. S’il est présent, le déploiement en mode complet ne supprime pas la ressource si elle est supprimée du modèle, car elle est gérée par une autre ressource. | corde |
nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 255 Modèle = ^[A-Za-z0-9@.\-_ ]*$ (obligatoire) |
Le plan | Planifiez la ressource. | planifier |
Propriétés | Propriétés détaillées pour HostPool | HostPoolProperties (obligatoire) |
Sku | Définition du modèle de ressource représentant la référence SKU | référence SKU |
étiquettes | Balises de ressource | Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles |
AgentUpdateProperties
Nom | Descriptif | Valeur |
---|---|---|
de maintenanceWindows | Liste des fenêtres de maintenance. Les fenêtres de maintenance sont longues de 2 heures. | MaintenanceWindowProperties[] |
maintenanceWindowTimeZone | Fuseau horaire pour la maintenance telle que définie dans /dotnet/api/system.timezoneinfo.findsystemtimezonebyid ?view=net-5.0. Doit être défini si useLocalTime a la valeur true. | corde |
type | Type de maintenance pour les composants hôtes de session. | Valeur par défaut 'Planifié' |
useSessionHostLocalTime | Indique s’il faut utiliser localTime de la machine virtuelle. | Bool |
HostPoolProperties
Nom | Descriptif | Valeur |
---|---|---|
agentUpdate | Configuration de l’hôte de session pour la mise à jour de l’agent, de l’agent de surveillance et du composant de pile. | AgentUpdateProperties |
customRdpProperty | Propriété rdp personnalisée de HostPool. | corde |
descriptif | Description de HostPool. | corde |
directUDP | Par défaut : les paramètres à l’échelle avD sont utilisés pour déterminer la disponibilité de la connexion, activé : UDP tente ce type de connexion lors de la création de connexions. Cela signifie que cette connexion est possible, mais n’est pas garantie, car il existe d’autres facteurs qui peuvent empêcher ce type de connexion, Désactivé : UDP n’essaie pas ce type de connexion lors de la création de connexions | Valeur par défaut 'Désactivé' 'Activé' |
nom convivial | Nom convivial de HostPool. | corde |
hostPoolType | Type HostPool pour le bureau. | 'BYODesktop' 'Personnel' 'Pooled' (obligatoire) |
loadBalancerType | Type de l’équilibreur de charge. | « L’ampleur d’abord » 'ProfondeurD’abord' 'MultiplePersistant' 'Persistent' (obligatoire) |
managedPrivateUDP | Par défaut : les paramètres à l’échelle avD sont utilisés pour déterminer la disponibilité de la connexion, activé : UDP tente ce type de connexion lors de la création de connexions. Cela signifie que cette connexion est possible, mais n’est pas garantie, car il existe d’autres facteurs qui peuvent empêcher ce type de connexion, Désactivé : UDP n’essaie pas ce type de connexion lors de la création de connexions | Valeur par défaut 'Désactivé' 'Activé' |
gestionType | Type de gestion pour ce pool d’hôtes, automatisé ou standard. La valeur par défaut est Automatisée. | 'Automatisé' « Standard » |
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) |
publicNetworkAccess | Activé permet à cette ressource d’être accessible à partir de réseaux publics et privés, désactivé permet d’accéder à cette ressource uniquement via des points de terminaison privés | 'Désactivé' 'Activé' 'EnabledForClientsOnly' 'EnabledForSessionHostsOnly' |
publicUDP | Par défaut : les paramètres à l’échelle avD sont utilisés pour déterminer la disponibilité de la connexion, activé : UDP tente ce type de connexion lors de la création de connexions. Cela signifie que cette connexion est possible, mais n’est pas garantie, car il existe d’autres facteurs qui peuvent empêcher ce type de connexion, Désactivé : UDP n’essaie pas ce type de connexion lors de la création de connexions | Valeur par défaut 'Désactivé' 'Activé' |
inscriptionInfos | Informations d’inscription de HostPool. Cette opération n’est pas retournée sur GET. Pour obtenir le jeton d’inscription, utilisez les appels retrieveRegistrationToken ou listRegistrationTokens POST. | Infos sur l’inscription |
relaisUDP | Par défaut : les paramètres à l’échelle avD sont utilisés pour déterminer la disponibilité de la connexion, activé : UDP tente ce type de connexion lors de la création de connexions. Cela signifie que cette connexion est possible, mais n’est pas garantie, car il existe d’autres facteurs qui peuvent empêcher ce type de connexion, Désactivé : UDP n’essaie pas ce type de connexion lors de la création de connexions | Valeur par défaut 'Désactivé' 'Activé' |
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 |
MaintenanceWindowProperties
Nom | Descriptif | Valeur |
---|---|---|
jourDeLaSemaine | Jour de la semaine. | 'Vendredi' 'Lundi' 'Samedi' 'Dimanche' 'jeudi' 'Mardi' 'Mercredi' |
heure | Heure de début de la mise à jour de la journée. (0 - 23) | Int |
Identité de Service Gérée (ManagedServiceIdentity)
Nom | Descriptif | Valeur |
---|---|---|
type | Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés). | « Aucun » 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (obligatoire) |
Identités attribuées par l'utilisateur | Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs de dictionnaire peuvent être des objets vides ({}) dans les requêtes. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
Nom | Descriptif | Valeur |
---|
Plan
Nom | Descriptif | Valeur |
---|---|---|
nom | Nom défini par l’utilisateur de l’artefact tiers en cours d’acquisition. | chaîne (obligatoire) |
produit | Artefact tiers en cours d’acquisition. Par exemple, NewRelic. Le produit est mappé à l’Id d’offre spécifié pour l’artefact au moment de l’intégration de Data Market. | chaîne (obligatoire) |
code promotionnel | Un éditeur a fourni un code de promotion comme provisionné dans Data Market pour le produit/artefact indiqué. | corde |
éditeur | Éditeur de l’artefact tiers acheté. Par exemple, NewRelic | chaîne (obligatoire) |
Version | Version du produit/artefact souhaité. | 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 |
Sku
Nom | Descriptif | Valeur |
---|---|---|
capacité | Si la référence SKU prend en charge le scale-out/in, l’entier de capacité doit être inclus. Si le scale-out/in n’est pas possible pour la ressource, cela peut être omis. | Int |
Famille | Si le service a différentes générations de matériel, pour la même référence SKU, vous pouvez le capturer ici. | corde |
nom | Nom de la référence SKU. Par exemple P3. Il s’agit généralement d’une lettre+code numérique | chaîne (obligatoire) |
taille | Taille de la référence SKU. Lorsque le champ de nom est la combinaison de niveau et d’une autre valeur, il s’agit du code autonome. | corde |
niveau | Ce champ doit être implémenté par le fournisseur de ressources si le service a plusieurs niveaux, mais n’est pas obligatoire sur un PUT. | 'De base' « Gratuit » « Haut de gamme » « Standard » |
TrackedResourceTags
Nom | Descriptif | Valeur |
---|
userAssignedIdentity
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 :
- groupes de ressources - Consultez commandes de déploiement de 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 code JSON suivant à votre modèle.
{
"type": "Microsoft.DesktopVirtualization/hostPools",
"apiVersion": "2025-03-01-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"
}
}
Valeurs de propriété
Microsoft.DesktopVirtualization/hostPools
Nom | Descriptif | Valeur |
---|---|---|
apiVersion | Version de l’API | '2025-03-01-preview' |
identité | Identité de service managée (identités affectées par le système et/ou identités affectées par l’utilisateur) | ManagedServiceIdentity |
gentil | Métadonnées utilisées par le portail/l’outil/etc pour afficher différentes expériences d’expérience utilisateur pour les ressources du même type. Par exemple, ApiApps est un type de Microsoft.Web/sites. Si elle est prise en charge, le fournisseur de ressources doit valider et conserver cette valeur. | corde Contraintes: Modèle = ^[-\w\._,\(\)]+$ |
emplacement | Emplacement géographique où réside la ressource | chaîne (obligatoire) |
managedBy | ID de ressource complet de la ressource qui gère cette ressource. Indique si cette ressource est gérée par une autre ressource Azure. S’il est présent, le déploiement en mode complet ne supprime pas la ressource si elle est supprimée du modèle, car elle est gérée par une autre ressource. | corde |
nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 255 Modèle = ^[A-Za-z0-9@.\-_ ]*$ (obligatoire) |
Le plan | Planifiez la ressource. | planifier |
Propriétés | Propriétés détaillées pour HostPool | HostPoolProperties (obligatoire) |
Sku | Définition du modèle de ressource représentant la référence SKU | référence SKU |
é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' |
AgentUpdateProperties
Nom | Descriptif | Valeur |
---|---|---|
de maintenanceWindows | Liste des fenêtres de maintenance. Les fenêtres de maintenance sont longues de 2 heures. | MaintenanceWindowProperties[] |
maintenanceWindowTimeZone | Fuseau horaire pour la maintenance telle que définie dans /dotnet/api/system.timezoneinfo.findsystemtimezonebyid ?view=net-5.0. Doit être défini si useLocalTime a la valeur true. | corde |
type | Type de maintenance pour les composants hôtes de session. | Valeur par défaut 'Planifié' |
useSessionHostLocalTime | Indique s’il faut utiliser localTime de la machine virtuelle. | Bool |
HostPoolProperties
Nom | Descriptif | Valeur |
---|---|---|
agentUpdate | Configuration de l’hôte de session pour la mise à jour de l’agent, de l’agent de surveillance et du composant de pile. | AgentUpdateProperties |
customRdpProperty | Propriété rdp personnalisée de HostPool. | corde |
descriptif | Description de HostPool. | corde |
directUDP | Par défaut : les paramètres à l’échelle avD sont utilisés pour déterminer la disponibilité de la connexion, activé : UDP tente ce type de connexion lors de la création de connexions. Cela signifie que cette connexion est possible, mais n’est pas garantie, car il existe d’autres facteurs qui peuvent empêcher ce type de connexion, Désactivé : UDP n’essaie pas ce type de connexion lors de la création de connexions | Valeur par défaut 'Désactivé' 'Activé' |
nom convivial | Nom convivial de HostPool. | corde |
hostPoolType | Type HostPool pour le bureau. | 'BYODesktop' 'Personnel' 'Pooled' (obligatoire) |
loadBalancerType | Type de l’équilibreur de charge. | « L’ampleur d’abord » 'ProfondeurD’abord' 'MultiplePersistant' 'Persistent' (obligatoire) |
managedPrivateUDP | Par défaut : les paramètres à l’échelle avD sont utilisés pour déterminer la disponibilité de la connexion, activé : UDP tente ce type de connexion lors de la création de connexions. Cela signifie que cette connexion est possible, mais n’est pas garantie, car il existe d’autres facteurs qui peuvent empêcher ce type de connexion, Désactivé : UDP n’essaie pas ce type de connexion lors de la création de connexions | Valeur par défaut 'Désactivé' 'Activé' |
gestionType | Type de gestion pour ce pool d’hôtes, automatisé ou standard. La valeur par défaut est Automatisée. | 'Automatisé' « Standard » |
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) |
publicNetworkAccess | Activé permet à cette ressource d’être accessible à partir de réseaux publics et privés, désactivé permet d’accéder à cette ressource uniquement via des points de terminaison privés | 'Désactivé' 'Activé' 'EnabledForClientsOnly' 'EnabledForSessionHostsOnly' |
publicUDP | Par défaut : les paramètres à l’échelle avD sont utilisés pour déterminer la disponibilité de la connexion, activé : UDP tente ce type de connexion lors de la création de connexions. Cela signifie que cette connexion est possible, mais n’est pas garantie, car il existe d’autres facteurs qui peuvent empêcher ce type de connexion, Désactivé : UDP n’essaie pas ce type de connexion lors de la création de connexions | Valeur par défaut 'Désactivé' 'Activé' |
inscriptionInfos | Informations d’inscription de HostPool. Cette opération n’est pas retournée sur GET. Pour obtenir le jeton d’inscription, utilisez les appels retrieveRegistrationToken ou listRegistrationTokens POST. | Infos sur l’inscription |
relaisUDP | Par défaut : les paramètres à l’échelle avD sont utilisés pour déterminer la disponibilité de la connexion, activé : UDP tente ce type de connexion lors de la création de connexions. Cela signifie que cette connexion est possible, mais n’est pas garantie, car il existe d’autres facteurs qui peuvent empêcher ce type de connexion, Désactivé : UDP n’essaie pas ce type de connexion lors de la création de connexions | Valeur par défaut 'Désactivé' 'Activé' |
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 |
MaintenanceWindowProperties
Nom | Descriptif | Valeur |
---|---|---|
jourDeLaSemaine | Jour de la semaine. | 'Vendredi' 'Lundi' 'Samedi' 'Dimanche' 'jeudi' 'Mardi' 'Mercredi' |
heure | Heure de début de la mise à jour de la journée. (0 - 23) | Int |
Identité de Service Gérée (ManagedServiceIdentity)
Nom | Descriptif | Valeur |
---|---|---|
type | Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés). | « Aucun » 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (obligatoire) |
Identités attribuées par l'utilisateur | Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs de dictionnaire peuvent être des objets vides ({}) dans les requêtes. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
Nom | Descriptif | Valeur |
---|
Plan
Nom | Descriptif | Valeur |
---|---|---|
nom | Nom défini par l’utilisateur de l’artefact tiers en cours d’acquisition. | chaîne (obligatoire) |
produit | Artefact tiers en cours d’acquisition. Par exemple, NewRelic. Le produit est mappé à l’Id d’offre spécifié pour l’artefact au moment de l’intégration de Data Market. | chaîne (obligatoire) |
code promotionnel | Un éditeur a fourni un code de promotion comme provisionné dans Data Market pour le produit/artefact indiqué. | corde |
éditeur | Éditeur de l’artefact tiers acheté. Par exemple, NewRelic | chaîne (obligatoire) |
Version | Version du produit/artefact souhaité. | 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 |
Sku
Nom | Descriptif | Valeur |
---|---|---|
capacité | Si la référence SKU prend en charge le scale-out/in, l’entier de capacité doit être inclus. Si le scale-out/in n’est pas possible pour la ressource, cela peut être omis. | Int |
Famille | Si le service a différentes générations de matériel, pour la même référence SKU, vous pouvez le capturer ici. | corde |
nom | Nom de la référence SKU. Par exemple P3. Il s’agit généralement d’une lettre+code numérique | chaîne (obligatoire) |
taille | Taille de la référence SKU. Lorsque le champ de nom est la combinaison de niveau et d’une autre valeur, il s’agit du code autonome. | corde |
niveau | Ce champ doit être implémenté par le fournisseur de ressources si le service a plusieurs niveaux, mais n’est pas obligatoire sur un PUT. | 'De base' « Gratuit » « Haut de gamme » « Standard » |
TrackedResourceTags
Nom | Descriptif | Valeur |
---|
userAssignedIdentity
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 |
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@2025-03-01-preview"
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 = {
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"
}
}
}
Valeurs de propriété
Microsoft.DesktopVirtualization/hostPools
Nom | Descriptif | Valeur |
---|---|---|
identité | Identité de service managée (identités affectées par le système et/ou identités affectées par l’utilisateur) | ManagedServiceIdentity |
gentil | Métadonnées utilisées par le portail/l’outil/etc pour afficher différentes expériences d’expérience utilisateur pour les ressources du même type. Par exemple, ApiApps est un type de Microsoft.Web/sites. Si elle est prise en charge, le fournisseur de ressources doit valider et conserver cette valeur. | corde Contraintes: Modèle = ^[-\w\._,\(\)]+$ |
emplacement | Emplacement géographique où réside la ressource | chaîne (obligatoire) |
managedBy | ID de ressource complet de la ressource qui gère cette ressource. Indique si cette ressource est gérée par une autre ressource Azure. S’il est présent, le déploiement en mode complet ne supprime pas la ressource si elle est supprimée du modèle, car elle est gérée par une autre ressource. | corde |
nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 255 Modèle = ^[A-Za-z0-9@.\-_ ]*$ (obligatoire) |
Le plan | Planifiez la ressource. | planifier |
Propriétés | Propriétés détaillées pour HostPool | HostPoolProperties (obligatoire) |
Sku | Définition du modèle de ressource représentant la référence SKU | référence SKU |
étiquettes | Balises de ressource | Dictionnaire de noms et de valeurs d’étiquettes. |
type | Type de ressource | « Microsoft.DesktopVirtualization/hostPools@2025-03-01-preview » |
AgentUpdateProperties
Nom | Descriptif | Valeur |
---|---|---|
de maintenanceWindows | Liste des fenêtres de maintenance. Les fenêtres de maintenance sont longues de 2 heures. | MaintenanceWindowProperties[] |
maintenanceWindowTimeZone | Fuseau horaire pour la maintenance telle que définie dans /dotnet/api/system.timezoneinfo.findsystemtimezonebyid ?view=net-5.0. Doit être défini si useLocalTime a la valeur true. | corde |
type | Type de maintenance pour les composants hôtes de session. | Valeur par défaut 'Planifié' |
useSessionHostLocalTime | Indique s’il faut utiliser localTime de la machine virtuelle. | Bool |
HostPoolProperties
Nom | Descriptif | Valeur |
---|---|---|
agentUpdate | Configuration de l’hôte de session pour la mise à jour de l’agent, de l’agent de surveillance et du composant de pile. | AgentUpdateProperties |
customRdpProperty | Propriété rdp personnalisée de HostPool. | corde |
descriptif | Description de HostPool. | corde |
directUDP | Par défaut : les paramètres à l’échelle avD sont utilisés pour déterminer la disponibilité de la connexion, activé : UDP tente ce type de connexion lors de la création de connexions. Cela signifie que cette connexion est possible, mais n’est pas garantie, car il existe d’autres facteurs qui peuvent empêcher ce type de connexion, Désactivé : UDP n’essaie pas ce type de connexion lors de la création de connexions | Valeur par défaut 'Désactivé' 'Activé' |
nom convivial | Nom convivial de HostPool. | corde |
hostPoolType | Type HostPool pour le bureau. | 'BYODesktop' 'Personnel' 'Pooled' (obligatoire) |
loadBalancerType | Type de l’équilibreur de charge. | « L’ampleur d’abord » 'ProfondeurD’abord' 'MultiplePersistant' 'Persistent' (obligatoire) |
managedPrivateUDP | Par défaut : les paramètres à l’échelle avD sont utilisés pour déterminer la disponibilité de la connexion, activé : UDP tente ce type de connexion lors de la création de connexions. Cela signifie que cette connexion est possible, mais n’est pas garantie, car il existe d’autres facteurs qui peuvent empêcher ce type de connexion, Désactivé : UDP n’essaie pas ce type de connexion lors de la création de connexions | Valeur par défaut 'Désactivé' 'Activé' |
gestionType | Type de gestion pour ce pool d’hôtes, automatisé ou standard. La valeur par défaut est Automatisée. | 'Automatisé' « Standard » |
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) |
publicNetworkAccess | Activé permet à cette ressource d’être accessible à partir de réseaux publics et privés, désactivé permet d’accéder à cette ressource uniquement via des points de terminaison privés | 'Désactivé' 'Activé' 'EnabledForClientsOnly' 'EnabledForSessionHostsOnly' |
publicUDP | Par défaut : les paramètres à l’échelle avD sont utilisés pour déterminer la disponibilité de la connexion, activé : UDP tente ce type de connexion lors de la création de connexions. Cela signifie que cette connexion est possible, mais n’est pas garantie, car il existe d’autres facteurs qui peuvent empêcher ce type de connexion, Désactivé : UDP n’essaie pas ce type de connexion lors de la création de connexions | Valeur par défaut 'Désactivé' 'Activé' |
inscriptionInfos | Informations d’inscription de HostPool. Cette opération n’est pas retournée sur GET. Pour obtenir le jeton d’inscription, utilisez les appels retrieveRegistrationToken ou listRegistrationTokens POST. | Infos sur l’inscription |
relaisUDP | Par défaut : les paramètres à l’échelle avD sont utilisés pour déterminer la disponibilité de la connexion, activé : UDP tente ce type de connexion lors de la création de connexions. Cela signifie que cette connexion est possible, mais n’est pas garantie, car il existe d’autres facteurs qui peuvent empêcher ce type de connexion, Désactivé : UDP n’essaie pas ce type de connexion lors de la création de connexions | Valeur par défaut 'Désactivé' 'Activé' |
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 |
MaintenanceWindowProperties
Nom | Descriptif | Valeur |
---|---|---|
jourDeLaSemaine | Jour de la semaine. | 'Vendredi' 'Lundi' 'Samedi' 'Dimanche' 'jeudi' 'Mardi' 'Mercredi' |
heure | Heure de début de la mise à jour de la journée. (0 - 23) | Int |
Identité de Service Gérée (ManagedServiceIdentity)
Nom | Descriptif | Valeur |
---|---|---|
type | Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés). | « Aucun » 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (obligatoire) |
Identités attribuées par l'utilisateur | Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs de dictionnaire peuvent être des objets vides ({}) dans les requêtes. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
Nom | Descriptif | Valeur |
---|
Plan
Nom | Descriptif | Valeur |
---|---|---|
nom | Nom défini par l’utilisateur de l’artefact tiers en cours d’acquisition. | chaîne (obligatoire) |
produit | Artefact tiers en cours d’acquisition. Par exemple, NewRelic. Le produit est mappé à l’Id d’offre spécifié pour l’artefact au moment de l’intégration de Data Market. | chaîne (obligatoire) |
code promotionnel | Un éditeur a fourni un code de promotion comme provisionné dans Data Market pour le produit/artefact indiqué. | corde |
éditeur | Éditeur de l’artefact tiers acheté. Par exemple, NewRelic | chaîne (obligatoire) |
Version | Version du produit/artefact souhaité. | 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 |
Sku
Nom | Descriptif | Valeur |
---|---|---|
capacité | Si la référence SKU prend en charge le scale-out/in, l’entier de capacité doit être inclus. Si le scale-out/in n’est pas possible pour la ressource, cela peut être omis. | Int |
Famille | Si le service a différentes générations de matériel, pour la même référence SKU, vous pouvez le capturer ici. | corde |
nom | Nom de la référence SKU. Par exemple P3. Il s’agit généralement d’une lettre+code numérique | chaîne (obligatoire) |
taille | Taille de la référence SKU. Lorsque le champ de nom est la combinaison de niveau et d’une autre valeur, il s’agit du code autonome. | corde |
niveau | Ce champ doit être implémenté par le fournisseur de ressources si le service a plusieurs niveaux, mais n’est pas obligatoire sur un PUT. | 'De base' « Gratuit » « Haut de gamme » « Standard » |
TrackedResourceTags
Nom | Descriptif | Valeur |
---|
userAssignedIdentity
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) |