Azure Classic v5.58.0, Dec 2 23

We recommend using Azure Native.

Azure Classic v5.58.0 published on Saturday, Dec 2, 2023 by Pulumi

pulumi/pulumi-azure

azure.desktopvirtualization.getHostPool

Explore with Pulumi AI

We recommend using Azure Native.

Azure Classic v5.58.0 published on Saturday, Dec 2, 2023 by Pulumi

pulumi/pulumi-azure

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.DesktopVirtualization.GetHostPool.Invoke(new()
    {
        Name = "example-pool",
        ResourceGroupName = "example-resources",
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/desktopvirtualization"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := desktopvirtualization.LookupHostPool(ctx, &desktopvirtualization.LookupHostPoolArgs{
			Name:              "example-pool",
			ResourceGroupName: "example-resources",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.desktopvirtualization.DesktopvirtualizationFunctions;
import com.pulumi.azure.desktopvirtualization.inputs.GetHostPoolArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = DesktopvirtualizationFunctions.getHostPool(GetHostPoolArgs.builder()
            .name("example-pool")
            .resourceGroupName("example-resources")
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example = azure.desktopvirtualization.get_host_pool(name="example-pool",
    resource_group_name="example-resources")

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.desktopvirtualization.getHostPool({
    name: "example-pool",
    resourceGroupName: "example-resources",
});

variables:
  example:
    fn::invoke:
      Function: azure:desktopvirtualization:getHostPool
      Arguments:
        name: example-pool
        resourceGroupName: example-resources

Using getHostPool

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getHostPool(args: GetHostPoolArgs, opts?: InvokeOptions): Promise<GetHostPoolResult>
function getHostPoolOutput(args: GetHostPoolOutputArgs, opts?: InvokeOptions): Output<GetHostPoolResult>

def get_host_pool(name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetHostPoolResult
def get_host_pool_output(name: Optional[pulumi.Input[str]] = None,
                  resource_group_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetHostPoolResult]

func LookupHostPool(ctx *Context, args *LookupHostPoolArgs, opts ...InvokeOption) (*LookupHostPoolResult, error)
func LookupHostPoolOutput(ctx *Context, args *LookupHostPoolOutputArgs, opts ...InvokeOption) LookupHostPoolResultOutput

> Note: This function is named LookupHostPool in the Go SDK.

public static class GetHostPool 
{
    public static Task<GetHostPoolResult> InvokeAsync(GetHostPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetHostPoolResult> Invoke(GetHostPoolInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetHostPoolResult> getHostPool(GetHostPoolArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure:desktopvirtualization/getHostPool:getHostPool
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The name of the Virtual Desktop Host Pool to retrieve.
ResourceGroupName string: The name of the resource group where the Virtual Desktop Host Pool exists.

Name string: The name of the Virtual Desktop Host Pool to retrieve.
ResourceGroupName string: The name of the resource group where the Virtual Desktop Host Pool exists.

name String: The name of the Virtual Desktop Host Pool to retrieve.
resourceGroupName String: The name of the resource group where the Virtual Desktop Host Pool exists.

name string: The name of the Virtual Desktop Host Pool to retrieve.
resourceGroupName string: The name of the resource group where the Virtual Desktop Host Pool exists.

name str: The name of the Virtual Desktop Host Pool to retrieve.
resource_group_name str: The name of the resource group where the Virtual Desktop Host Pool exists.

name String: The name of the Virtual Desktop Host Pool to retrieve.
resourceGroupName String: The name of the resource group where the Virtual Desktop Host Pool exists.

getHostPool Result

The following output properties are available:

CustomRdpProperties string: The custom RDP properties string for the Virtual Desktop Host Pool.
Description string: The description for the Virtual Desktop Host Pool.
FriendlyName string: The friendly name for the Virtual Desktop Host Pool.
Id string: The provider-assigned unique ID for this managed resource.
LoadBalancerType string: The type of load balancing performed by the Host Pool
Location string: The location/region where the Virtual Desktop Host Pool is located.
MaximumSessionsAllowed int: The maximum number of users that can have concurrent sessions on a session host.
Name string
PersonalDesktopAssignmentType string: The type of personal desktop assignment in use by the Host Pool
PreferredAppGroupType string: The preferred Application Group type for the Virtual Desktop Host Pool.
ResourceGroupName string
ScheduledAgentUpdates List<GetHostPoolScheduledAgentUpdate>: A scheduled_agent_updates block as defined below.
StartVmOnConnect bool: Returns true if the Start VM on Connection Feature is enabled.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
Type string: The type of the Virtual Desktop Host Pool.
ValidateEnvironment bool: Returns true if the Host Pool is in Validation mode.

CustomRdpProperties string: The custom RDP properties string for the Virtual Desktop Host Pool.
Description string: The description for the Virtual Desktop Host Pool.
FriendlyName string: The friendly name for the Virtual Desktop Host Pool.
Id string: The provider-assigned unique ID for this managed resource.
LoadBalancerType string: The type of load balancing performed by the Host Pool
Location string: The location/region where the Virtual Desktop Host Pool is located.
MaximumSessionsAllowed int: The maximum number of users that can have concurrent sessions on a session host.
Name string
PersonalDesktopAssignmentType string: The type of personal desktop assignment in use by the Host Pool
PreferredAppGroupType string: The preferred Application Group type for the Virtual Desktop Host Pool.
ResourceGroupName string
ScheduledAgentUpdates []GetHostPoolScheduledAgentUpdate: A scheduled_agent_updates block as defined below.
StartVmOnConnect bool: Returns true if the Start VM on Connection Feature is enabled.
Tags map[string]string: A mapping of tags to assign to the resource.
Type string: The type of the Virtual Desktop Host Pool.
ValidateEnvironment bool: Returns true if the Host Pool is in Validation mode.

customRdpProperties String: The custom RDP properties string for the Virtual Desktop Host Pool.
description String: The description for the Virtual Desktop Host Pool.
friendlyName String: The friendly name for the Virtual Desktop Host Pool.
id String: The provider-assigned unique ID for this managed resource.
loadBalancerType String: The type of load balancing performed by the Host Pool
location String: The location/region where the Virtual Desktop Host Pool is located.
maximumSessionsAllowed Integer: The maximum number of users that can have concurrent sessions on a session host.
name String
personalDesktopAssignmentType String: The type of personal desktop assignment in use by the Host Pool
preferredAppGroupType String: The preferred Application Group type for the Virtual Desktop Host Pool.
resourceGroupName String
scheduledAgentUpdates List<GetHostPoolScheduledAgentUpdate>: A scheduled_agent_updates block as defined below.
startVmOnConnect Boolean: Returns true if the Start VM on Connection Feature is enabled.
tags Map<String,String>: A mapping of tags to assign to the resource.
type String: The type of the Virtual Desktop Host Pool.
validateEnvironment Boolean: Returns true if the Host Pool is in Validation mode.

customRdpProperties string: The custom RDP properties string for the Virtual Desktop Host Pool.
description string: The description for the Virtual Desktop Host Pool.
friendlyName string: The friendly name for the Virtual Desktop Host Pool.
id string: The provider-assigned unique ID for this managed resource.
loadBalancerType string: The type of load balancing performed by the Host Pool
location string: The location/region where the Virtual Desktop Host Pool is located.
maximumSessionsAllowed number: The maximum number of users that can have concurrent sessions on a session host.
name string
personalDesktopAssignmentType string: The type of personal desktop assignment in use by the Host Pool
preferredAppGroupType string: The preferred Application Group type for the Virtual Desktop Host Pool.
resourceGroupName string
scheduledAgentUpdates GetHostPoolScheduledAgentUpdate[]: A scheduled_agent_updates block as defined below.
startVmOnConnect boolean: Returns true if the Start VM on Connection Feature is enabled.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
type string: The type of the Virtual Desktop Host Pool.
validateEnvironment boolean: Returns true if the Host Pool is in Validation mode.

custom_rdp_properties str: The custom RDP properties string for the Virtual Desktop Host Pool.
description str: The description for the Virtual Desktop Host Pool.
friendly_name str: The friendly name for the Virtual Desktop Host Pool.
id str: The provider-assigned unique ID for this managed resource.
load_balancer_type str: The type of load balancing performed by the Host Pool
location str: The location/region where the Virtual Desktop Host Pool is located.
maximum_sessions_allowed int: The maximum number of users that can have concurrent sessions on a session host.
name str
personal_desktop_assignment_type str: The type of personal desktop assignment in use by the Host Pool
preferred_app_group_type str: The preferred Application Group type for the Virtual Desktop Host Pool.
resource_group_name str
scheduled_agent_updates Sequence[GetHostPoolScheduledAgentUpdate]: A scheduled_agent_updates block as defined below.
start_vm_on_connect bool: Returns true if the Start VM on Connection Feature is enabled.
tags Mapping[str, str]: A mapping of tags to assign to the resource.
type str: The type of the Virtual Desktop Host Pool.
validate_environment bool: Returns true if the Host Pool is in Validation mode.

customRdpProperties String: The custom RDP properties string for the Virtual Desktop Host Pool.
description String: The description for the Virtual Desktop Host Pool.
friendlyName String: The friendly name for the Virtual Desktop Host Pool.
id String: The provider-assigned unique ID for this managed resource.
loadBalancerType String: The type of load balancing performed by the Host Pool
location String: The location/region where the Virtual Desktop Host Pool is located.
maximumSessionsAllowed Number: The maximum number of users that can have concurrent sessions on a session host.
name String
personalDesktopAssignmentType String: The type of personal desktop assignment in use by the Host Pool
preferredAppGroupType String: The preferred Application Group type for the Virtual Desktop Host Pool.
resourceGroupName String
scheduledAgentUpdates List<Property Map>: A scheduled_agent_updates block as defined below.
startVmOnConnect Boolean: Returns true if the Start VM on Connection Feature is enabled.
tags Map<String>: A mapping of tags to assign to the resource.
type String: The type of the Virtual Desktop Host Pool.
validateEnvironment Boolean: Returns true if the Host Pool is in Validation mode.

Supporting Types

GetHostPoolScheduledAgentUpdate

Enabled bool: Are scheduled updates of the AVD agent components (RDAgent, Geneva Monitoring agent, and side-by-side stack) enabled on session hosts.
Schedules List<GetHostPoolScheduledAgentUpdateSchedule>: A schedule block as defined below.
Timezone string: The time zone in which the agent update schedule will apply.
UseSessionHostTimezone bool: Specifies whether scheduled agent updates should be applied based on the timezone of the affected session host.

Enabled bool: Are scheduled updates of the AVD agent components (RDAgent, Geneva Monitoring agent, and side-by-side stack) enabled on session hosts.
Schedules []GetHostPoolScheduledAgentUpdateSchedule: A schedule block as defined below.
Timezone string: The time zone in which the agent update schedule will apply.
UseSessionHostTimezone bool: Specifies whether scheduled agent updates should be applied based on the timezone of the affected session host.

enabled Boolean: Are scheduled updates of the AVD agent components (RDAgent, Geneva Monitoring agent, and side-by-side stack) enabled on session hosts.
schedules List<GetHostPoolScheduledAgentUpdateSchedule>: A schedule block as defined below.
timezone String: The time zone in which the agent update schedule will apply.
useSessionHostTimezone Boolean: Specifies whether scheduled agent updates should be applied based on the timezone of the affected session host.

enabled boolean: Are scheduled updates of the AVD agent components (RDAgent, Geneva Monitoring agent, and side-by-side stack) enabled on session hosts.
schedules GetHostPoolScheduledAgentUpdateSchedule[]: A schedule block as defined below.
timezone string: The time zone in which the agent update schedule will apply.
useSessionHostTimezone boolean: Specifies whether scheduled agent updates should be applied based on the timezone of the affected session host.

enabled bool: Are scheduled updates of the AVD agent components (RDAgent, Geneva Monitoring agent, and side-by-side stack) enabled on session hosts.
schedules Sequence[GetHostPoolScheduledAgentUpdateSchedule]: A schedule block as defined below.
timezone str: The time zone in which the agent update schedule will apply.
use_session_host_timezone bool: Specifies whether scheduled agent updates should be applied based on the timezone of the affected session host.

enabled Boolean: Are scheduled updates of the AVD agent components (RDAgent, Geneva Monitoring agent, and side-by-side stack) enabled on session hosts.
schedules List<Property Map>: A schedule block as defined below.
timezone String: The time zone in which the agent update schedule will apply.
useSessionHostTimezone Boolean: Specifies whether scheduled agent updates should be applied based on the timezone of the affected session host.

GetHostPoolScheduledAgentUpdateSchedule

DayOfWeek string: The day of the week on which agent updates should be performed.
HourOfDay int: The hour of day the update window should start.

DayOfWeek string: The day of the week on which agent updates should be performed.
HourOfDay int: The hour of day the update window should start.

dayOfWeek String: The day of the week on which agent updates should be performed.
hourOfDay Integer: The hour of day the update window should start.

dayOfWeek string: The day of the week on which agent updates should be performed.
hourOfDay number: The hour of day the update window should start.

day_of_week str: The day of the week on which agent updates should be performed.
hour_of_day int: The hour of day the update window should start.

dayOfWeek String: The day of the week on which agent updates should be performed.
hourOfDay Number: The hour of day the update window should start.

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure Classic v5.58.0 published on Saturday, Dec 2, 2023 by Pulumi

pulumi/pulumi-azure

azure.desktopvirtualization.getHostPool

On this page

On this page

Example Usage

Using getHostPool

getHostPool Result

Supporting Types

GetHostPoolScheduledAgentUpdate

GetHostPoolScheduledAgentUpdateSchedule

Package Details

On this page

On this page