Partager via


Microsoft.DesktopVirtualization hostPools 2021-07-12

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@2021-07-12' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
    {customized property}: 'string'
    {customized property}: 'string'
    {customized property}: 'string'
    {customized property}: 'string'
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  kind: 'string'
  identity: {
    type: 'SystemAssigned'
  }
  managedBy: 'string'
  plan: {
    name: 'string'
    product: 'string'
    promotionCode: 'string'
    publisher: 'string'
    version: 'string'
  }
  properties: {
    customRdpProperty: 'string'
    description: 'string'
    friendlyName: 'string'
    hostPoolType: 'string'
    loadBalancerType: 'string'
    maxSessionLimit: int
    migrationRequest: {
      migrationPath: 'string'
      operation: 'string'
    }
    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
tags Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
sku ResourceModelWithAllowedPropertySetSku
kind Métadonnées utilisées par le portail/les outils/etc pour afficher différentes expériences d’expérience utilisateur pour des ressources du même type ; Par exemple, ApiApps est une sorte de type Microsoft.Web/sites. Si elle est prise en charge, le fournisseur de ressources doit valider et conserver cette valeur. string

Contraintes :
Modèle = ^[-\w\._,\(\)]+$
identité ResourceModelWithAllowedPropertySetIdentity
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. Si cela 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. string
Plan ResourceModelWithAllowedPropertySetPlan
properties Propriétés détaillées pour HostPool HostPoolProperties (obligatoire)

ResourceModelWithAllowedPropertySetIdentity

Nom Description Valeur
type Type d’identité. 'SystemAssigned'

ResourceModelWithAllowedPropertySetPlan

Nom Description Valeur
name Nom défini par l’utilisateur de l’artefact tiers en cours d’obtention. string (obligatoire)
product Artefact tiers en cours d’acquisition. Par exemple, NewRelic. Le produit est mappé à l’OfferID spécifié pour l’artefact au moment de l’intégration du marché des données. string (obligatoire)
promotionCode Un éditeur a fourni le code de promotion tel qu’il a été provisionné dans Data Market pour le produit/artefact en cours. string
publisher Éditeur de l’artefact tiers acheté. Par exemple, NewRelic string (obligatoire)
version Version du produit/artefact souhaité. string

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. 'BYODesktop'
'Personnel'
'Pooled' (obligatoire)
loadBalancerType Type de l’équilibreur de charge. 'BreadthFirst'
'DepthFirst'
'Persistent' (obligatoire)
maxSessionLimit Limite de session maximale de HostPool. int
migrationRequest Informations d’inscription de HostPool. MigrationRequestProperties
personalDesktopAssignmentType Type PersonalDesktopAssignment pour HostPool. 'Automatique'
'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

MigrationRequestProperties

Nom Description Valeur
migrationPath Chemin d’accès à l’objet hérité à migrer. string
opération Type d’opération pour la migration. 'Terminé'
'Masquer'
'Revoke'
'Démarrer'
'Unhide'

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

ResourceModelWithAllowedPropertySetSku

Nom Description 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, cela peut être capturé ici. string
name Nom de la référence SKU. Ex - P3. Il s’agit généralement d’un code lettre+nombre chaîne (obligatoire)
taille Taille de la référence SKU. Lorsque le champ de nom est la combinaison du niveau et d’une autre valeur, il s’agit du code autonome. string
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'
'Premium'
'Standard'

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 de l’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": "2021-07-12",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
    "{customized property}": "string",
    "{customized property}": "string",
    "{customized property}": "string",
    "{customized property}": "string"
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "kind": "string",
  "identity": {
    "type": "SystemAssigned"
  },
  "managedBy": "string",
  "plan": {
    "name": "string",
    "product": "string",
    "promotionCode": "string",
    "publisher": "string",
    "version": "string"
  },
  "properties": {
    "customRdpProperty": "string",
    "description": "string",
    "friendlyName": "string",
    "hostPoolType": "string",
    "loadBalancerType": "string",
    "maxSessionLimit": "int",
    "migrationRequest": {
      "migrationPath": "string",
      "operation": "string"
    },
    "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 '2021-07-12'
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 string
tags Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
sku ResourceModelWithAllowedPropertySetSku
kind Métadonnées utilisées par le portail/les outils/etc pour afficher différentes expériences d’expérience utilisateur pour des ressources du même type ; Par exemple, ApiApps est une sorte de type Microsoft.Web/sites. S’il est pris en charge, le fournisseur de ressources doit valider et conserver cette valeur. string

Contraintes :
Modèle = ^[-\w\._,\(\)]+$
identité ResourceModelWithAllowedPropertySetIdentity
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. Si cela est présent, le déploiement en mode complet ne supprimera pas la ressource si elle est supprimée du modèle, car elle est gérée par une autre ressource. string
Plan ResourceModelWithAllowedPropertySetPlan
properties Propriétés détaillées pour HostPool HostPoolProperties (obligatoire)

ResourceModelWithAllowedPropertySetIdentity

Nom Description Valeur
type Type d’identité. 'SystemAssigned'

ResourceModelWithAllowedPropertySetPlan

Nom Description Valeur
name Nom défini par l’utilisateur de l’artefact tiers en cours d’acquisition. chaîne (obligatoire)
product Artefact tiers en cours d’acquisition. Par exemple, NewRelic. Le produit correspond à l’Id d’offre spécifié pour l’artefact au moment de l’intégration du marché des données. chaîne (obligatoire)
promotionCode Un éditeur a fourni le code de promotion tel qu’il a été provisionné dans Data Market pour le produit/artefact en cours. string
publisher Éditeur de l’artefact tiers en cours d’achat. Par exemple, NewRelic string (obligatoire)
version Version du produit/artefact souhaité. string

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. 'BYODesktop'
'Personnel'
'Pooled' (obligatoire)
loadBalancerType Type de l’équilibreur de charge. 'BreadthFirst'
'DepthFirst'
'Persistent' (obligatoire)
maxSessionLimit Limite de session maximale de HostPool. int
migrationRequest Informations d’inscription de HostPool. MigrationRequestProperties
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

MigrationRequestProperties

Nom Description Valeur
migrationPath Chemin d’accès à l’objet hérité à migrer. string
opération Type d’opération pour la migration. 'Complete'
'Masquer'
'Revoke'
'Start'
'Afficher'

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

ResourceModelWithAllowedPropertySetSku

Nom Description Valeur
capacité Si la référence SKU prend en charge le scale-out/in, l’entier de capacité doit être inclus. Si un scale-out/scale-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, cela peut être capturé ici. string
name Nom de la référence SKU. Ex - P3. Il s’agit généralement d’un code lettre+nombre string (obligatoire)
taille Taille de la référence SKU. Lorsque le champ name est la combinaison du niveau et d’une autre valeur, il s’agit du code autonome. string
Niveau Ce champ doit être implémenté par le fournisseur de ressources si le service a plusieurs niveaux, mais n’est pas requis sur un PUT. 'De base'
'Gratuit'
'Premium'
'Standard'

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 d’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@2021-07-12"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
    {customized property} = "string"
    {customized property} = "string"
    {customized property} = "string"
    {customized property} = "string"
  identity {
    type = "SystemAssigned"
  }
  body = jsonencode({
    properties = {
      customRdpProperty = "string"
      description = "string"
      friendlyName = "string"
      hostPoolType = "string"
      loadBalancerType = "string"
      maxSessionLimit = int
      migrationRequest = {
        migrationPath = "string"
        operation = "string"
      }
      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"
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
    kind = "string"
    managedBy = "string"
    plan = {
      name = "string"
      product = "string"
      promotionCode = "string"
      publisher = "string"
      version = "string"
    }
  })
}

Valeurs de propriétés

hostPools

Nom Description Valeur
type Type de ressource « Microsoft.DesktopVirtualization/hostPools@2021-07-12 »
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
parent_id Pour effectuer un déploiement dans un groupe de ressources, utilisez l’ID de ce groupe de ressources. string (obligatoire)
tags Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes.
sku ResourceModelWithAllowedPropertySetSku
kind Métadonnées utilisées par le portail/les outils/etc pour afficher différentes expériences d’expérience utilisateur pour des ressources du même type ; Par exemple, ApiApps est une sorte de type Microsoft.Web/sites. Si elle est prise en charge, le fournisseur de ressources doit valider et conserver cette valeur. string

Contraintes :
Modèle = ^[-\w\._,\(\)]+$
identité ResourceModelWithAllowedPropertySetIdentity
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. Si cela 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. string
Plan ResourceModelWithAllowedPropertySetPlan
properties Propriétés détaillées pour HostPool HostPoolProperties (obligatoire)

ResourceModelWithAllowedPropertySetIdentity

Nom Description Valeur
type Type d’identité. « SystemAssigned »

ResourceModelWithAllowedPropertySetPlan

Nom Description Valeur
name Nom défini par l’utilisateur de l’artefact tiers en cours d’obtention. string (obligatoire)
product Artefact tiers en cours d’acquisition. Par exemple, NewRelic. Le produit est mappé à l’OfferID spécifié pour l’artefact au moment de l’intégration du marché des données. string (obligatoire)
promotionCode Un éditeur a fourni le code de promotion tel qu’il a été provisionné dans Data Market pour le produit/artefact en cours. string
publisher Éditeur de l’artefact tiers acheté. Par exemple, NewRelic string (obligatoire)
version Version du produit/artefact souhaité. string

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. « BYODesktop »
« Personnel »
« Mis en pool » (obligatoire)
loadBalancerType Type de l’équilibreur de charge. « BreadthFirst »
« DepthFirst »
« Persistant » (obligatoire)
maxSessionLimit Limite de session maximale de HostPool. int
migrationRequest Informations d’inscription de HostPool. MigrationRequestProperties
personalDesktopAssignmentType Type PersonalDesktopAssignment pour HostPool. « Automatique »
« 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. « Certificat »
« 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

MigrationRequestProperties

Nom Description Valeur
migrationPath Chemin d’accès à l’objet hérité à migrer. string
opération Type d’opération pour la migration. « Complete »
« Masquer »
« Revoke »
« Démarrer »
« Afficher »

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

ResourceModelWithAllowedPropertySetSku

Nom Description Valeur
capacité Si la référence SKU prend en charge le scale-out/in, l’entier de capacité doit être inclus. Si un scale-out/scale-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, cela peut être capturé ici. string
name Nom de la référence SKU. Ex - P3. Il s’agit généralement d’un code lettre+nombre string (obligatoire)
taille Taille de la référence SKU. Lorsque le champ name est la combinaison du niveau et d’une autre valeur, il s’agit du code autonome. string
Niveau Ce champ doit être implémenté par le fournisseur de ressources si le service a plusieurs niveaux, mais n’est pas requis sur un PUT. "Basic"
« Gratuit »
« Premium »
« Standard »