Desktop Virtualization Host Pool

This table represents the desktop_virtualization_host_pool resource from Microsoft Azure.

azure.desktop_virtualization_host_pool

Fields

TitleIDTypeData TypeDescription
_keycorestring
agent_updatecorejsonThe session host configuration for updating agent, monitoring agent, and stack component.
app_attach_package_referencescorearray<string>List of App Attach Package links.
application_group_referencescorearray<string>List of applicationGroup links.
cloud_pc_resourcecoreboolIs cloud pc resource.
custom_rdp_propertycorestringCustom rdp property of HostPool.
descriptioncorestringDescription of HostPool.
etagcorestringThe etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
friendly_namecorestringFriendly name of HostPool.
host_pool_typecorestringHostPool type for desktop.
idcorestringFully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identitycorejson
kindcorestringMetadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
load_balancer_typecorestringThe type of the load balancer.
locationcorestringThe geo-location where the resource lives
managed_bycorestringThe fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
max_session_limitcoreint64The max session limit of HostPool.
namecorestringThe name of the resource
object_idcorestringObjectId of HostPool. (internal use)
personal_desktop_assignment_typecorestringPersonalDesktopAssignment type for HostPool.
plancorejson
preferred_app_group_typecorestringThe type of preferred application group type, default to Desktop Application Group
private_endpoint_connectionscorejsonList of private endpoint connection associated with the specified resource
public_network_accesscorestringEnabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints
registration_infocorejsonThe registration info of HostPool.
resource_groupcorestring
ringcoreint64The ring number of HostPool.
skucorejson
sso_client_idcorestringClientId for the registered Relying Party used to issue WVD SSO certificates.
sso_client_secret_key_vault_pathcorestringPath to Azure KeyVault storing the secret used for communication to ADFS.
sso_secret_typecorestringThe type of single sign on Secret Type.
ssoadfs_authoritycorestringURL to customer ADFS server for signing WVD SSO certificates.
start_vm_on_connectcoreboolThe flag to turn on/off StartVMOnConnect feature.
subscription_idcorestring
subscription_namecorestring
system_datacorejsonMetadata pertaining to creation and last modification of the resource.
tagscorehstore_csv
typecorestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
validation_environmentcoreboolIs validation environment.
vm_templatecorestringVM template for sessionhosts configuration within hostpool.