Nota
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare ad accedere o modificare le directory.
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare a modificare le directory.
- più recenti
- 2026-04-01-anteprima
- 2026-03-01-anteprima
- Anteprima 2026-01-01-
- 2025-11-01-anteprima
- 2025-10-10
- 2025-09-01-anteprima
- 2025-08-01-preview
- 2025-04-01-preview
- 2025-03-01-anteprima
- 2024-11-01-anteprima
- 2024-08-08-anteprima
- 2024-04-08-anteprima
- 2024-04-03
- Anteprima 2024-03-06
- 2024-01-16-anteprima
- 11-01-preview 2023
- 2023-10-04-anteprima
- 2023-09-05
- Anteprima 2022-10-14
- 2022-09-09
- 2022-04-01-anteprima
- Anteprima 2022-02-10
- Anteprima 2021-09-03
- 2021-07-12
- 2021-04-01-anteprima
-
03-03-09-preview 2021 - Anteprima 2021-02-01
-
2021-01-14-preview - Anteprima 2020-11-10
- Anteprima 2020-11-02-preview
- Anteprima 2020-10-19
- Anteprima 2020-09-21
- 12-10-preview 2019
- 24-09-2019
- Anteprima 2019-01-23
Definizione di risorsa Bicep
Il tipo di risorsa hostPools può essere distribuito con operazioni destinate a:
Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.
Esempi di utilizzo
Moduli verificati di Azure
Per distribuire questo tipo di risorsa, è possibile usare moduli verificati di Azure.
| Modulo | Descrizione |
|---|---|
| pool di host di Desktop virtuale Azure (AVD) | Modulo di risorse AVM per il pool di host di Desktop virtuale Azure (AVD) |
Esempi di avvio rapido di Azure
I modelli di avvio rapido di Azure seguenti contengono esempi Bicep per la distribuzione di questo tipo di risorsa.
| File bicipite | Descrizione |
|---|---|
| crea AVD con microsoft Entra ID Join | Questo modello consente di creare risorse di Desktop virtuale Azure, ad esempio pool di host, gruppo di applicazioni, area di lavoro, host di sessione di test e relative estensioni con aggiunta all'ID Microsoft Entra |
Formato risorsa
Per creare una risorsa Microsoft.DesktopVirtualization/hostPools, aggiungere il bicep seguente al modello.
resource symbolicname 'Microsoft.DesktopVirtualization/hostPools@2026-04-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
}
allowRDPShortPathWithPrivateLink: 'string'
conditionalRdpProperty: 'string'
customRdpProperty: 'string'
deploymentScope: 'string'
description: 'string'
directUDP: 'string'
friendlyName: 'string'
hostPoolType: 'string'
loadBalancerType: 'string'
managedPrivateUDP: 'string'
managementType: 'string'
maxSessionLimit: int
oboTenantId: 'string'
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'
}
}
Valori delle proprietà
Microsoft.DesktopVirtualization/hostPools
| Nome | Descrizione | Valore |
|---|---|---|
| identità | Identità del servizio gestito assegnate a questa risorsa. | ManagedServiceIdentity |
| gentile | Metadati usati dal portale/strumenti/ecc per eseguire il rendering di esperienze utente diverse per le risorse dello stesso tipo; Ad esempio, ApiApps è un tipo di tipo Microsoft.Web/sites. Se supportato, il provider di risorse deve convalidare e rendere persistente questo valore. | corda Vincoli: Modello = ^[-\w\._,\(\)]+$ |
| ubicazione | Posizione geografica in cui risiede la risorsa | stringa (obbligatorio) |
| managedBy | ID risorsa completo della risorsa che gestisce questa risorsa. Indica se questa risorsa è gestita da un'altra risorsa di Azure. Se presente, la distribuzione in modalità completa non eliminerà la risorsa se viene rimossa dal modello perché è gestita da un'altra risorsa. | corda |
| nome | Nome della risorsa | corda Vincoli: Lunghezza minima = 3 Lunghezza massima = 64 Pattern = ^[A-Za-z0-9@.\-_ ]*$ (obbligatorio) |
| piano | Dettagli del piano di risorse. | Pianificare |
| proprietà | Proprietà dettagliate per HostPool | HostPoolProperties (obbligatorio) |
| Sku | SKU (stock keeping unit) assegnato a questa risorsa. | sku |
| Tag | Tag delle risorse | Dizionario di nomi e valori di tag. Vedere tag nei modelli |
Proprietà di Aggiornamento dell'agente
| Nome | Descrizione | Valore |
|---|---|---|
| manutenzioneWindows | Elenco delle finestre di manutenzione. Le finestre di manutenzione sono lunghe 2 ore. | ManutenzioneWindowProperties[] |
| maintenanceWindowTimeZone | Fuso orario per la manutenzione come definito in /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Deve essere impostato se useLocalTime è true. | corda |
| digitare | Tipo di manutenzione per i componenti host di sessione. | Impostazione predefinita 'Programmato' |
| useSessionHostLocalTime | Indica se usare localTime della macchina virtuale. | Bool |
Proprietà HostPoolProperties
| Nome | Descrizione | Valore |
|---|---|---|
| agentUpdate | Configurazione dell'host di sessione per l'aggiornamento dell'agente, dell'agente di monitoraggio e del componente stack. | Proprietà di Aggiornamento dell'agente |
| allowRDPShortPathWithPrivateLink | Controlla se l'uso del trasporto RDPShortPath è consentito, possibilmente ignorando le route di collegamento privato. | 'Disabilitato' 'Abilitato' |
| condizionaleRdpProprietà | Le proprietà RDP condizionate del pool host, serializzate come una stringa nel formato di <rdpPropertyName>:<type>:<value>:<conditionType>:<conditionValue>. |
corda |
| customRdpProprietà | Proprietà rdp personalizzata di HostPool. | corda |
| deploymentScope | Tipo DeploymentScope per HostPool. | 'Geografico' 'Regionale' |
| descrizione | Descrizione di HostPool. | corda |
| direttoUDP | Impostazione predefinita: le impostazioni a livello di AVD vengono usate per determinare la disponibilità della connessione, Abilitata: UDP tenterà questo tipo di connessione durante l'esecuzione delle connessioni. Ciò significa che questa connessione è possibile, ma non è garantita, poiché esistono altri fattori che possono impedire questo tipo di connessione, Disabilitato: UDP non tenterà questo tipo di connessione quando si effettuano connessioni | Impostazione predefinita 'Disabilitato' 'Abilitato' |
| nome amichevole | Nome descrittivo di HostPool. | corda |
| hostPoolType | Tipo HostPool per desktop. | 'BYODesktop' 'Personale' 'In pool' (obbligatorio) |
| loadBalancerType | Tipo del servizio di bilanciamento del carico. | 'L'ampiezza prima di tutto' 'La profondità prima di tutto' 'MultiplePersistent' 'Persistent' (obbligatorio) |
| managedPrivateUDP | Impostazione predefinita: le impostazioni a livello di AVD vengono usate per determinare la disponibilità della connessione, Abilitata: UDP tenterà questo tipo di connessione durante l'esecuzione delle connessioni. Ciò significa che questa connessione è possibile, ma non è garantita, poiché esistono altri fattori che possono impedire questo tipo di connessione, Disabilitato: UDP non tenterà questo tipo di connessione quando si effettuano connessioni | Impostazione predefinita 'Disabilitato' 'Abilitato' |
| tipo di gestione | Tipo di gestione per questo pool di host, automatizzato o standard. Il valore predefinito è Automated. | 'Automatizzato' 'Standard' |
| maxSessionLimit | Limite massimo di sessioni di HostPool. | Int |
| oboTenantId | Tenant per conto del quale viene richiesta la risorsa. | corda |
| personalDesktopAssignmentType | Tipo PersonalDesktopAssignment per HostPool. | 'Automatico' 'Diretto' |
| preferredAppGroupType | Tipo di gruppo di applicazioni preferito, impostazione predefinita gruppo di applicazioni desktop | 'Desktop' 'Nessuno' 'RailApplications' (obbligatorio) |
| pubblicoAccesso alla rete | Abilitato consente l'accesso a questa risorsa da reti sia pubbliche che private. Disabilitato consente l'accesso a questa risorsa solo tramite endpoint privati | 'Disabilitato' 'Abilitato' 'EnabledForClientsOnly' 'EnabledForSessionHostsOnly' |
| publicUDP | Impostazione predefinita: le impostazioni a livello di AVD vengono usate per determinare la disponibilità della connessione, Abilitata: UDP tenterà questo tipo di connessione durante l'esecuzione delle connessioni. Ciò significa che questa connessione è possibile, ma non è garantita, poiché esistono altri fattori che possono impedire questo tipo di connessione, Disabilitato: UDP non tenterà questo tipo di connessione quando si effettuano connessioni | Impostazione predefinita 'Disabilitato' 'Abilitato' |
| registrazioneInfo | Informazioni di registrazione di HostPool. | Informazioni di registrazione |
| relèUDP | Impostazione predefinita: le impostazioni a livello di AVD vengono usate per determinare la disponibilità della connessione, Abilitata: UDP tenterà questo tipo di connessione durante l'esecuzione delle connessioni. Ciò significa che questa connessione è possibile, ma non è garantita, poiché esistono altri fattori che possono impedire questo tipo di connessione, Disabilitato: UDP non tenterà questo tipo di connessione quando si effettuano connessioni | Impostazione predefinita 'Disabilitato' 'Abilitato' |
| anello | Numero di anello di HostPool. | Int |
| ssoadfsAutorità | URL del server ADFS del cliente per la firma dei certificati SSO WVD. | corda |
| ssoClientId | ClientId per la relying party registrata usata per rilasciare certificati SSO WVD. | corda |
| ssoClientSecretKeyVaultPath | Percorso di Azure KeyVault che archivia il segreto usato per la comunicazione con ADFS. | corda |
| ssoSecretType | Tipo di single sign-on Secret Type. | «Certificato» 'CertificateInKeyVault' 'Chiave condivisa' 'SharedKeyInKeyVault' |
| startVMOnConnect | Flag per attivare/disattivare la funzionalità StartVMOnConnect. | Bool |
| validationEnvironment | Ambiente di convalida. | Bool |
| Modello vm | Modello di macchina virtuale per la configurazione di sessionhosts all'interno del pool di host. | corda |
Proprietà della finestra di manutenzione
| Nome | Descrizione | Valore |
|---|---|---|
| giornoDiSettimana | Giorno della settimana. | 'Venerdì' 'Lunedì' 'Sabato' 'Domenica' 'Giovedì' 'Martedì' 'Mercoledì' |
| ora | Ora di inizio dell'aggiornamento del giorno. (0 - 23) | Int |
Identità dei Servizi Gestiti
| Nome | Descrizione | Valore |
|---|---|---|
| digitare | Tipo di identità del servizio gestito (in cui sono consentiti sia i tipi SystemAssigned che UserAssigned). | 'Nessuno' 'Assegnato dal sistema' 'SystemAssigned,UserAssigned' 'UserAssigned' (obbligatorio) |
| userAssignedIdentities | Set di identità assegnate dall'utente associate alla risorsa. Le chiavi del dizionario userAssignedIdentities saranno ID risorsa ARM nel formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. I valori del dizionario possono essere oggetti vuoti ({}) nelle richieste. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nome | Descrizione | Valore |
|---|
Piano
| Nome | Descrizione | Valore |
|---|---|---|
| nome | Nome definito dall'utente dell'artefatto di terze parti che viene acquistato. | stringa (obbligatorio) |
| prodotto | Artefatto di terze parti che viene acquistato. Ad esempio NewRelic. Il prodotto esegue il mapping all'OfferID specificato per l'artefatto al momento dell'onboarding di Data Market. | stringa (obbligatorio) |
| Codice promozionale | Un editore ha fornito il codice promozionale di cui è stato effettuato il provisioning in Data Market per il prodotto o l'artefatto specificato. | corda |
| editore | Autore dell'artefatto di terze parti acquistato. Ad esempio, NewRelic | stringa (obbligatorio) |
| Versione | Versione del prodotto/artefatto desiderato. | corda |
Informazioni di registrazione
| Nome | Descrizione | Valore |
|---|---|---|
| tempo di scadenza | Scadenza del token di registrazione. | corda |
| registrationTokenOperation | Tipo di reimpostazione del token. | 'Elimina' 'Nessuno' 'Aggiornamento' |
| token | Stringa con codifica base64 del token di registrazione. | corda |
Sku
| Nome | Descrizione | Valore |
|---|---|---|
| capacità | Se lo SKU supporta l'aumento o l'aumento del numero di istanze, è necessario includere l'intero della capacità. Se non è possibile aumentare o ridurre il numero di istanze per la risorsa, potrebbe essere omesso. | Int |
| famiglia | Se il servizio ha generazioni diverse di hardware, per lo stesso SKU, è possibile acquisire qui. | corda |
| nome | Nome dello SKU. Ad esempio P3. Si tratta in genere di un codice lettera+numero | stringa (obbligatorio) |
| grandezza | Dimensioni dello SKU. Quando il campo nome è la combinazione di livello e un altro valore, si tratta del codice autonomo. | corda |
| livello | Questo campo deve essere implementato dal provider di risorse se il servizio ha più di un livello, ma non è necessario in un PUT. | 'Di base' 'Libero' 'Premium' 'Standard' |
TrackedResourceTags
| Nome | Descrizione | Valore |
|---|
Identità Assegnata dall'Utente
| Nome | Descrizione | Valore |
|---|
Definizione di risorsa del modello di Resource Manager
Il tipo di risorsa hostPools può essere distribuito con operazioni destinate a:
- Gruppi di risorse - Vedi comandi di distribuzione dei gruppi di risorse Per un elenco delle proprietà modificate in ciascuna versione API, vedi registro delle modifiche.
Esempi di utilizzo
Modelli di avvio rapido di Azure
I modelli di avvio rapido di Azure seguenti distribuire questo tipo di risorsa.
| Sagoma | Descrizione |
|---|---|
|
crea AVD con microsoft Entra ID Join |
Questo modello consente di creare risorse di Desktop virtuale Azure, ad esempio pool di host, gruppo di applicazioni, area di lavoro, host di sessione di test e relative estensioni con aggiunta all'ID Microsoft Entra |
Formato risorsa
Per creare una risorsa Microsoft.DesktopVirtualization/hostPools, aggiungere il codice JSON seguente al modello.
{
"type": "Microsoft.DesktopVirtualization/hostPools",
"apiVersion": "2026-04-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"
},
"allowRDPShortPathWithPrivateLink": "string",
"conditionalRdpProperty": "string",
"customRdpProperty": "string",
"deploymentScope": "string",
"description": "string",
"directUDP": "string",
"friendlyName": "string",
"hostPoolType": "string",
"loadBalancerType": "string",
"managedPrivateUDP": "string",
"managementType": "string",
"maxSessionLimit": "int",
"oboTenantId": "string",
"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"
}
}
Valori delle proprietà
Microsoft.DesktopVirtualization/hostPools
| Nome | Descrizione | Valore |
|---|---|---|
| versione dell'API | Versione dell'API | 'Anteprima 2026-04-01' |
| identità | Identità del servizio gestito assegnate a questa risorsa. | ManagedServiceIdentity |
| gentile | Metadati usati dal portale/strumenti/ecc per eseguire il rendering di esperienze utente diverse per le risorse dello stesso tipo; Ad esempio, ApiApps è un tipo di tipo Microsoft.Web/sites. Se supportato, il provider di risorse deve convalidare e rendere persistente questo valore. | corda Vincoli: Modello = ^[-\w\._,\(\)]+$ |
| ubicazione | Posizione geografica in cui risiede la risorsa | stringa (obbligatorio) |
| managedBy | ID risorsa completo della risorsa che gestisce questa risorsa. Indica se questa risorsa è gestita da un'altra risorsa di Azure. Se presente, la distribuzione in modalità completa non eliminerà la risorsa se viene rimossa dal modello perché è gestita da un'altra risorsa. | corda |
| nome | Nome della risorsa | corda Vincoli: Lunghezza minima = 3 Lunghezza massima = 64 Pattern = ^[A-Za-z0-9@.\-_ ]*$ (obbligatorio) |
| piano | Dettagli del piano di risorse. | Pianificare |
| proprietà | Proprietà dettagliate per HostPool | HostPoolProperties (obbligatorio) |
| Sku | SKU (stock keeping unit) assegnato a questa risorsa. | sku |
| Tag | Tag delle risorse | Dizionario di nomi e valori di tag. Vedere tag nei modelli |
| digitare | Tipo di risorsa | 'Microsoft.DesktopVirtualization/hostPools' |
Proprietà di Aggiornamento dell'agente
| Nome | Descrizione | Valore |
|---|---|---|
| manutenzioneWindows | Elenco delle finestre di manutenzione. Le finestre di manutenzione sono lunghe 2 ore. | ManutenzioneWindowProperties[] |
| maintenanceWindowTimeZone | Fuso orario per la manutenzione come definito in /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Deve essere impostato se useLocalTime è true. | corda |
| digitare | Tipo di manutenzione per i componenti host di sessione. | Impostazione predefinita 'Programmato' |
| useSessionHostLocalTime | Indica se usare localTime della macchina virtuale. | Bool |
Proprietà HostPoolProperties
| Nome | Descrizione | Valore |
|---|---|---|
| agentUpdate | Configurazione dell'host di sessione per l'aggiornamento dell'agente, dell'agente di monitoraggio e del componente stack. | Proprietà di Aggiornamento dell'agente |
| allowRDPShortPathWithPrivateLink | Controlla se l'uso del trasporto RDPShortPath è consentito, possibilmente ignorando le route di collegamento privato. | 'Disabilitato' 'Abilitato' |
| condizionaleRdpProprietà | Le proprietà RDP condizionate del pool host, serializzate come una stringa nel formato di <rdpPropertyName>:<type>:<value>:<conditionType>:<conditionValue>. |
corda |
| customRdpProprietà | Proprietà rdp personalizzata di HostPool. | corda |
| deploymentScope | Tipo DeploymentScope per HostPool. | 'Geografico' 'Regionale' |
| descrizione | Descrizione di HostPool. | corda |
| direttoUDP | Impostazione predefinita: le impostazioni a livello di AVD vengono usate per determinare la disponibilità della connessione, Abilitata: UDP tenterà questo tipo di connessione durante l'esecuzione delle connessioni. Ciò significa che questa connessione è possibile, ma non è garantita, poiché esistono altri fattori che possono impedire questo tipo di connessione, Disabilitato: UDP non tenterà questo tipo di connessione quando si effettuano connessioni | Impostazione predefinita 'Disabilitato' 'Abilitato' |
| nome amichevole | Nome descrittivo di HostPool. | corda |
| hostPoolType | Tipo HostPool per desktop. | 'BYODesktop' 'Personale' 'In pool' (obbligatorio) |
| loadBalancerType | Tipo del servizio di bilanciamento del carico. | 'L'ampiezza prima di tutto' 'La profondità prima di tutto' 'MultiplePersistent' 'Persistent' (obbligatorio) |
| managedPrivateUDP | Impostazione predefinita: le impostazioni a livello di AVD vengono usate per determinare la disponibilità della connessione, Abilitata: UDP tenterà questo tipo di connessione durante l'esecuzione delle connessioni. Ciò significa che questa connessione è possibile, ma non è garantita, poiché esistono altri fattori che possono impedire questo tipo di connessione, Disabilitato: UDP non tenterà questo tipo di connessione quando si effettuano connessioni | Impostazione predefinita 'Disabilitato' 'Abilitato' |
| tipo di gestione | Tipo di gestione per questo pool di host, automatizzato o standard. Il valore predefinito è Automated. | 'Automatizzato' 'Standard' |
| maxSessionLimit | Limite massimo di sessioni di HostPool. | Int |
| oboTenantId | Tenant per conto del quale viene richiesta la risorsa. | corda |
| personalDesktopAssignmentType | Tipo PersonalDesktopAssignment per HostPool. | 'Automatico' 'Diretto' |
| preferredAppGroupType | Tipo di gruppo di applicazioni preferito, impostazione predefinita gruppo di applicazioni desktop | 'Desktop' 'Nessuno' 'RailApplications' (obbligatorio) |
| pubblicoAccesso alla rete | Abilitato consente l'accesso a questa risorsa da reti sia pubbliche che private. Disabilitato consente l'accesso a questa risorsa solo tramite endpoint privati | 'Disabilitato' 'Abilitato' 'EnabledForClientsOnly' 'EnabledForSessionHostsOnly' |
| publicUDP | Impostazione predefinita: le impostazioni a livello di AVD vengono usate per determinare la disponibilità della connessione, Abilitata: UDP tenterà questo tipo di connessione durante l'esecuzione delle connessioni. Ciò significa che questa connessione è possibile, ma non è garantita, poiché esistono altri fattori che possono impedire questo tipo di connessione, Disabilitato: UDP non tenterà questo tipo di connessione quando si effettuano connessioni | Impostazione predefinita 'Disabilitato' 'Abilitato' |
| registrazioneInfo | Informazioni di registrazione di HostPool. | Informazioni di registrazione |
| relèUDP | Impostazione predefinita: le impostazioni a livello di AVD vengono usate per determinare la disponibilità della connessione, Abilitata: UDP tenterà questo tipo di connessione durante l'esecuzione delle connessioni. Ciò significa che questa connessione è possibile, ma non è garantita, poiché esistono altri fattori che possono impedire questo tipo di connessione, Disabilitato: UDP non tenterà questo tipo di connessione quando si effettuano connessioni | Impostazione predefinita 'Disabilitato' 'Abilitato' |
| anello | Numero di anello di HostPool. | Int |
| ssoadfsAutorità | URL del server ADFS del cliente per la firma dei certificati SSO WVD. | corda |
| ssoClientId | ClientId per la relying party registrata usata per rilasciare certificati SSO WVD. | corda |
| ssoClientSecretKeyVaultPath | Percorso di Azure KeyVault che archivia il segreto usato per la comunicazione con ADFS. | corda |
| ssoSecretType | Tipo di single sign-on Secret Type. | «Certificato» 'CertificateInKeyVault' 'Chiave condivisa' 'SharedKeyInKeyVault' |
| startVMOnConnect | Flag per attivare/disattivare la funzionalità StartVMOnConnect. | Bool |
| validationEnvironment | Ambiente di convalida. | Bool |
| Modello vm | Modello di macchina virtuale per la configurazione di sessionhosts all'interno del pool di host. | corda |
Proprietà della finestra di manutenzione
| Nome | Descrizione | Valore |
|---|---|---|
| giornoDiSettimana | Giorno della settimana. | 'Venerdì' 'Lunedì' 'Sabato' 'Domenica' 'Giovedì' 'Martedì' 'Mercoledì' |
| ora | Ora di inizio dell'aggiornamento del giorno. (0 - 23) | Int |
Identità dei Servizi Gestiti
| Nome | Descrizione | Valore |
|---|---|---|
| digitare | Tipo di identità del servizio gestito (in cui sono consentiti sia i tipi SystemAssigned che UserAssigned). | 'Nessuno' 'Assegnato dal sistema' 'SystemAssigned,UserAssigned' 'UserAssigned' (obbligatorio) |
| userAssignedIdentities | Set di identità assegnate dall'utente associate alla risorsa. Le chiavi del dizionario userAssignedIdentities saranno ID risorsa ARM nel formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. I valori del dizionario possono essere oggetti vuoti ({}) nelle richieste. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nome | Descrizione | Valore |
|---|
Piano
| Nome | Descrizione | Valore |
|---|---|---|
| nome | Nome definito dall'utente dell'artefatto di terze parti che viene acquistato. | stringa (obbligatorio) |
| prodotto | Artefatto di terze parti che viene acquistato. Ad esempio NewRelic. Il prodotto esegue il mapping all'OfferID specificato per l'artefatto al momento dell'onboarding di Data Market. | stringa (obbligatorio) |
| Codice promozionale | Un editore ha fornito il codice promozionale di cui è stato effettuato il provisioning in Data Market per il prodotto o l'artefatto specificato. | corda |
| editore | Autore dell'artefatto di terze parti acquistato. Ad esempio, NewRelic | stringa (obbligatorio) |
| Versione | Versione del prodotto/artefatto desiderato. | corda |
Informazioni di registrazione
| Nome | Descrizione | Valore |
|---|---|---|
| tempo di scadenza | Scadenza del token di registrazione. | corda |
| registrationTokenOperation | Tipo di reimpostazione del token. | 'Elimina' 'Nessuno' 'Aggiornamento' |
| token | Stringa con codifica base64 del token di registrazione. | corda |
Sku
| Nome | Descrizione | Valore |
|---|---|---|
| capacità | Se lo SKU supporta l'aumento o l'aumento del numero di istanze, è necessario includere l'intero della capacità. Se non è possibile aumentare o ridurre il numero di istanze per la risorsa, potrebbe essere omesso. | Int |
| famiglia | Se il servizio ha generazioni diverse di hardware, per lo stesso SKU, è possibile acquisire qui. | corda |
| nome | Nome dello SKU. Ad esempio P3. Si tratta in genere di un codice lettera+numero | stringa (obbligatorio) |
| grandezza | Dimensioni dello SKU. Quando il campo nome è la combinazione di livello e un altro valore, si tratta del codice autonomo. | corda |
| livello | Questo campo deve essere implementato dal provider di risorse se il servizio ha più di un livello, ma non è necessario in un PUT. | 'Di base' 'Libero' 'Premium' 'Standard' |
TrackedResourceTags
| Nome | Descrizione | Valore |
|---|
Identità Assegnata dall'Utente
| Nome | Descrizione | Valore |
|---|
Definizione di risorsa Terraform (provider AzAPI)
Il tipo di risorsa hostPools può essere distribuito con operazioni destinate a:
- Gruppi di risorse Per un elenco delle proprietà modificate in ogni versione dell'API, vedi il registro modifiche.
Esempi di utilizzo
Moduli verificati di Azure
Per distribuire questo tipo di risorsa, è possibile usare moduli verificati di Azure.
| Modulo | Descrizione |
|---|---|
| pool di host di Desktop virtuale Azure (AVD) | Modulo di risorse AVM per il pool di host di Desktop virtuale Azure (AVD) |
Formato risorsa
Per creare una risorsa Microsoft.DesktopVirtualization/hostPools, aggiungere il file Terraform seguente al modello.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DesktopVirtualization/hostPools@2026-04-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
}
allowRDPShortPathWithPrivateLink = "string"
conditionalRdpProperty = "string"
customRdpProperty = "string"
deploymentScope = "string"
description = "string"
directUDP = "string"
friendlyName = "string"
hostPoolType = "string"
loadBalancerType = "string"
managedPrivateUDP = "string"
managementType = "string"
maxSessionLimit = int
oboTenantId = "string"
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"
}
}
}
Valori delle proprietà
Microsoft.DesktopVirtualization/hostPools
| Nome | Descrizione | Valore |
|---|---|---|
| identità | Identità del servizio gestito assegnate a questa risorsa. | ManagedServiceIdentity |
| gentile | Metadati usati dal portale/strumenti/ecc per eseguire il rendering di esperienze utente diverse per le risorse dello stesso tipo; Ad esempio, ApiApps è un tipo di tipo Microsoft.Web/sites. Se supportato, il provider di risorse deve convalidare e rendere persistente questo valore. | corda Vincoli: Modello = ^[-\w\._,\(\)]+$ |
| ubicazione | Posizione geografica in cui risiede la risorsa | stringa (obbligatorio) |
| managedBy | ID risorsa completo della risorsa che gestisce questa risorsa. Indica se questa risorsa è gestita da un'altra risorsa di Azure. Se presente, la distribuzione in modalità completa non eliminerà la risorsa se viene rimossa dal modello perché è gestita da un'altra risorsa. | corda |
| nome | Nome della risorsa | corda Vincoli: Lunghezza minima = 3 Lunghezza massima = 64 Pattern = ^[A-Za-z0-9@.\-_ ]*$ (obbligatorio) |
| piano | Dettagli del piano di risorse. | Pianificare |
| proprietà | Proprietà dettagliate per HostPool | HostPoolProperties (obbligatorio) |
| Sku | SKU (stock keeping unit) assegnato a questa risorsa. | sku |
| Tag | Tag delle risorse | Dizionario di nomi e valori di tag. |
| digitare | Tipo di risorsa | "Microsoft. DesktopVirtualization/hostPools@2026-04-01-preview" |
Proprietà di Aggiornamento dell'agente
| Nome | Descrizione | Valore |
|---|---|---|
| manutenzioneWindows | Elenco delle finestre di manutenzione. Le finestre di manutenzione sono lunghe 2 ore. | ManutenzioneWindowProperties[] |
| maintenanceWindowTimeZone | Fuso orario per la manutenzione come definito in /dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Deve essere impostato se useLocalTime è true. | corda |
| digitare | Tipo di manutenzione per i componenti host di sessione. | Impostazione predefinita 'Programmato' |
| useSessionHostLocalTime | Indica se usare localTime della macchina virtuale. | Bool |
Proprietà HostPoolProperties
| Nome | Descrizione | Valore |
|---|---|---|
| agentUpdate | Configurazione dell'host di sessione per l'aggiornamento dell'agente, dell'agente di monitoraggio e del componente stack. | Proprietà di Aggiornamento dell'agente |
| allowRDPShortPathWithPrivateLink | Controlla se l'uso del trasporto RDPShortPath è consentito, possibilmente ignorando le route di collegamento privato. | 'Disabilitato' 'Abilitato' |
| condizionaleRdpProprietà | Le proprietà RDP condizionate del pool host, serializzate come una stringa nel formato di <rdpPropertyName>:<type>:<value>:<conditionType>:<conditionValue>. |
corda |
| customRdpProprietà | Proprietà rdp personalizzata di HostPool. | corda |
| deploymentScope | Tipo DeploymentScope per HostPool. | 'Geografico' 'Regionale' |
| descrizione | Descrizione di HostPool. | corda |
| direttoUDP | Impostazione predefinita: le impostazioni a livello di AVD vengono usate per determinare la disponibilità della connessione, Abilitata: UDP tenterà questo tipo di connessione durante l'esecuzione delle connessioni. Ciò significa che questa connessione è possibile, ma non è garantita, poiché esistono altri fattori che possono impedire questo tipo di connessione, Disabilitato: UDP non tenterà questo tipo di connessione quando si effettuano connessioni | Impostazione predefinita 'Disabilitato' 'Abilitato' |
| nome amichevole | Nome descrittivo di HostPool. | corda |
| hostPoolType | Tipo HostPool per desktop. | 'BYODesktop' 'Personale' 'In pool' (obbligatorio) |
| loadBalancerType | Tipo del servizio di bilanciamento del carico. | 'L'ampiezza prima di tutto' 'La profondità prima di tutto' 'MultiplePersistent' 'Persistent' (obbligatorio) |
| managedPrivateUDP | Impostazione predefinita: le impostazioni a livello di AVD vengono usate per determinare la disponibilità della connessione, Abilitata: UDP tenterà questo tipo di connessione durante l'esecuzione delle connessioni. Ciò significa che questa connessione è possibile, ma non è garantita, poiché esistono altri fattori che possono impedire questo tipo di connessione, Disabilitato: UDP non tenterà questo tipo di connessione quando si effettuano connessioni | Impostazione predefinita 'Disabilitato' 'Abilitato' |
| tipo di gestione | Tipo di gestione per questo pool di host, automatizzato o standard. Il valore predefinito è Automated. | 'Automatizzato' 'Standard' |
| maxSessionLimit | Limite massimo di sessioni di HostPool. | Int |
| oboTenantId | Tenant per conto del quale viene richiesta la risorsa. | corda |
| personalDesktopAssignmentType | Tipo PersonalDesktopAssignment per HostPool. | 'Automatico' 'Diretto' |
| preferredAppGroupType | Tipo di gruppo di applicazioni preferito, impostazione predefinita gruppo di applicazioni desktop | 'Desktop' 'Nessuno' 'RailApplications' (obbligatorio) |
| pubblicoAccesso alla rete | Abilitato consente l'accesso a questa risorsa da reti sia pubbliche che private. Disabilitato consente l'accesso a questa risorsa solo tramite endpoint privati | 'Disabilitato' 'Abilitato' 'EnabledForClientsOnly' 'EnabledForSessionHostsOnly' |
| publicUDP | Impostazione predefinita: le impostazioni a livello di AVD vengono usate per determinare la disponibilità della connessione, Abilitata: UDP tenterà questo tipo di connessione durante l'esecuzione delle connessioni. Ciò significa che questa connessione è possibile, ma non è garantita, poiché esistono altri fattori che possono impedire questo tipo di connessione, Disabilitato: UDP non tenterà questo tipo di connessione quando si effettuano connessioni | Impostazione predefinita 'Disabilitato' 'Abilitato' |
| registrazioneInfo | Informazioni di registrazione di HostPool. | Informazioni di registrazione |
| relèUDP | Impostazione predefinita: le impostazioni a livello di AVD vengono usate per determinare la disponibilità della connessione, Abilitata: UDP tenterà questo tipo di connessione durante l'esecuzione delle connessioni. Ciò significa che questa connessione è possibile, ma non è garantita, poiché esistono altri fattori che possono impedire questo tipo di connessione, Disabilitato: UDP non tenterà questo tipo di connessione quando si effettuano connessioni | Impostazione predefinita 'Disabilitato' 'Abilitato' |
| anello | Numero di anello di HostPool. | Int |
| ssoadfsAutorità | URL del server ADFS del cliente per la firma dei certificati SSO WVD. | corda |
| ssoClientId | ClientId per la relying party registrata usata per rilasciare certificati SSO WVD. | corda |
| ssoClientSecretKeyVaultPath | Percorso di Azure KeyVault che archivia il segreto usato per la comunicazione con ADFS. | corda |
| ssoSecretType | Tipo di single sign-on Secret Type. | «Certificato» 'CertificateInKeyVault' 'Chiave condivisa' 'SharedKeyInKeyVault' |
| startVMOnConnect | Flag per attivare/disattivare la funzionalità StartVMOnConnect. | Bool |
| validationEnvironment | Ambiente di convalida. | Bool |
| Modello vm | Modello di macchina virtuale per la configurazione di sessionhosts all'interno del pool di host. | corda |
Proprietà della finestra di manutenzione
| Nome | Descrizione | Valore |
|---|---|---|
| giornoDiSettimana | Giorno della settimana. | 'Venerdì' 'Lunedì' 'Sabato' 'Domenica' 'Giovedì' 'Martedì' 'Mercoledì' |
| ora | Ora di inizio dell'aggiornamento del giorno. (0 - 23) | Int |
Identità dei Servizi Gestiti
| Nome | Descrizione | Valore |
|---|---|---|
| digitare | Tipo di identità del servizio gestito (in cui sono consentiti sia i tipi SystemAssigned che UserAssigned). | 'Nessuno' 'Assegnato dal sistema' 'SystemAssigned,UserAssigned' 'UserAssigned' (obbligatorio) |
| userAssignedIdentities | Set di identità assegnate dall'utente associate alla risorsa. Le chiavi del dizionario userAssignedIdentities saranno ID risorsa ARM nel formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. I valori del dizionario possono essere oggetti vuoti ({}) nelle richieste. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nome | Descrizione | Valore |
|---|
Piano
| Nome | Descrizione | Valore |
|---|---|---|
| nome | Nome definito dall'utente dell'artefatto di terze parti che viene acquistato. | stringa (obbligatorio) |
| prodotto | Artefatto di terze parti che viene acquistato. Ad esempio NewRelic. Il prodotto esegue il mapping all'OfferID specificato per l'artefatto al momento dell'onboarding di Data Market. | stringa (obbligatorio) |
| Codice promozionale | Un editore ha fornito il codice promozionale di cui è stato effettuato il provisioning in Data Market per il prodotto o l'artefatto specificato. | corda |
| editore | Autore dell'artefatto di terze parti acquistato. Ad esempio, NewRelic | stringa (obbligatorio) |
| Versione | Versione del prodotto/artefatto desiderato. | corda |
Informazioni di registrazione
| Nome | Descrizione | Valore |
|---|---|---|
| tempo di scadenza | Scadenza del token di registrazione. | corda |
| registrationTokenOperation | Tipo di reimpostazione del token. | 'Elimina' 'Nessuno' 'Aggiornamento' |
| token | Stringa con codifica base64 del token di registrazione. | corda |
Sku
| Nome | Descrizione | Valore |
|---|---|---|
| capacità | Se lo SKU supporta l'aumento o l'aumento del numero di istanze, è necessario includere l'intero della capacità. Se non è possibile aumentare o ridurre il numero di istanze per la risorsa, potrebbe essere omesso. | Int |
| famiglia | Se il servizio ha generazioni diverse di hardware, per lo stesso SKU, è possibile acquisire qui. | corda |
| nome | Nome dello SKU. Ad esempio P3. Si tratta in genere di un codice lettera+numero | stringa (obbligatorio) |
| grandezza | Dimensioni dello SKU. Quando il campo nome è la combinazione di livello e un altro valore, si tratta del codice autonomo. | corda |
| livello | Questo campo deve essere implementato dal provider di risorse se il servizio ha più di un livello, ma non è necessario in un PUT. | 'Di base' 'Libero' 'Premium' 'Standard' |
TrackedResourceTags
| Nome | Descrizione | Valore |
|---|
Identità Assegnata dall'Utente
| Nome | Descrizione | Valore |
|---|