pulumi-azure-native-kotlin/com.pulumi.azurenative.desktopvirtualization.kotlin/HostPoolArgs

HostPoolArgs

data class HostPoolArgs(val customRdpProperty: Output<String>? = null, val description: Output<String>? = null, val friendlyName: Output<String>? = null, val hostPoolName: Output<String>? = null, val hostPoolType: Output<Either<String, HostPoolType>>? = null, val identity: Output<ResourceModelWithAllowedPropertySetIdentityArgs>? = null, val kind: Output<String>? = null, val loadBalancerType: Output<Either<String, LoadBalancerType>>? = null, val location: Output<String>? = null, val managedBy: Output<String>? = null, val maxSessionLimit: Output<Int>? = null, val migrationRequest: Output<MigrationRequestPropertiesArgs>? = null, val personalDesktopAssignmentType: Output<Either<String, PersonalDesktopAssignmentType>>? = null, val plan: Output<ResourceModelWithAllowedPropertySetPlanArgs>? = null, val preferredAppGroupType: Output<Either<String, PreferredAppGroupType>>? = null, val registrationInfo: Output<RegistrationInfoArgs>? = null, val resourceGroupName: Output<String>? = null, val ring: Output<Int>? = null, val sku: Output<ResourceModelWithAllowedPropertySetSkuArgs>? = null, val ssoClientId: Output<String>? = null, val ssoClientSecretKeyVaultPath: Output<String>? = null, val ssoSecretType: Output<Either<String, SSOSecretType>>? = null, val ssoadfsAuthority: Output<String>? = null, val startVMOnConnect: Output<Boolean>? = null, val tags: Output<Map<String, String>>? = null, val validationEnvironment: Output<Boolean>? = null, val vmTemplate: Output<String>? = null) : ConvertibleToJava<HostPoolArgs>

Represents a HostPool definition. API Version: 2021-02-01-preview.

Example Usage

HostPool_Create

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var hostPool = new AzureNative.DesktopVirtualization.HostPool("hostPool", new()
    {
        Description = "des1",
        FriendlyName = "friendly",
        HostPoolName = "hostPool1",
        HostPoolType = "Pooled",
        LoadBalancerType = "BreadthFirst",
        Location = "centralus",
        MaxSessionLimit = 999999,
        MigrationRequest = new AzureNative.DesktopVirtualization.Inputs.MigrationRequestPropertiesArgs
        {
            MigrationPath = "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}",
            Operation = "Start",
        },
        PersonalDesktopAssignmentType = "Automatic",
        PreferredAppGroupType = "Desktop",
        RegistrationInfo = new AzureNative.DesktopVirtualization.Inputs.RegistrationInfoArgs
        {
            ExpirationTime = "2020-10-01T14:01:54.9571247Z",
            RegistrationTokenOperation = "Update",
        },
        ResourceGroupName = "resourceGroup1",
        SsoClientId = "client",
        SsoClientSecretKeyVaultPath = "https://keyvault/secret",
        SsoSecretType = "SharedKey",
        SsoadfsAuthority = "https://adfs",
        StartVMOnConnect = false,
        Tags =
        {
            { "tag1", "value1" },
            { "tag2", "value2" },
        },
        VmTemplate = "{json:json}",
    });
});
Content copied to clipboard
package main
import (
	desktopvirtualization "github.com/pulumi/pulumi-azure-native-sdk/desktopvirtualization"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := desktopvirtualization.NewHostPool(ctx, "hostPool", &desktopvirtualization.HostPoolArgs{
			Description:      pulumi.String("des1"),
			FriendlyName:     pulumi.String("friendly"),
			HostPoolName:     pulumi.String("hostPool1"),
			HostPoolType:     pulumi.String("Pooled"),
			LoadBalancerType: pulumi.String("BreadthFirst"),
			Location:         pulumi.String("centralus"),
			MaxSessionLimit:  pulumi.Int(999999),
			MigrationRequest: &desktopvirtualization.MigrationRequestPropertiesArgs{
				MigrationPath: pulumi.String("TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}"),
				Operation:     pulumi.String("Start"),
			},
			PersonalDesktopAssignmentType: pulumi.String("Automatic"),
			PreferredAppGroupType:         pulumi.String("Desktop"),
			RegistrationInfo: &desktopvirtualization.RegistrationInfoArgs{
				ExpirationTime:             pulumi.String("2020-10-01T14:01:54.9571247Z"),
				RegistrationTokenOperation: pulumi.String("Update"),
			},
			ResourceGroupName:           pulumi.String("resourceGroup1"),
			SsoClientId:                 pulumi.String("client"),
			SsoClientSecretKeyVaultPath: pulumi.String("https://keyvault/secret"),
			SsoSecretType:               pulumi.String("SharedKey"),
			SsoadfsAuthority:            pulumi.String("https://adfs"),
			StartVMOnConnect:            pulumi.Bool(false),
			Tags: pulumi.StringMap{
				"tag1": pulumi.String("value1"),
				"tag2": pulumi.String("value2"),
			},
			VmTemplate: pulumi.String("{json:json}"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.desktopvirtualization.HostPool;
import com.pulumi.azurenative.desktopvirtualization.HostPoolArgs;
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) {
        var hostPool = new HostPool("hostPool", HostPoolArgs.builder()
            .description("des1")
            .friendlyName("friendly")
            .hostPoolName("hostPool1")
            .hostPoolType("Pooled")
            .loadBalancerType("BreadthFirst")
            .location("centralus")
            .maxSessionLimit(999999)
            .migrationRequest(Map.ofEntries(
                Map.entry("migrationPath", "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}"),
                Map.entry("operation", "Start")
            ))
            .personalDesktopAssignmentType("Automatic")
            .preferredAppGroupType("Desktop")
            .registrationInfo(Map.ofEntries(
                Map.entry("expirationTime", "2020-10-01T14:01:54.9571247Z"),
                Map.entry("registrationTokenOperation", "Update")
            ))
            .resourceGroupName("resourceGroup1")
            .ssoClientId("client")
            .ssoClientSecretKeyVaultPath("https://keyvault/secret")
            .ssoSecretType("SharedKey")
            .ssoadfsAuthority("https://adfs")
            .startVMOnConnect(false)
            .tags(Map.ofEntries(
                Map.entry("tag1", "value1"),
                Map.entry("tag2", "value2")
            ))
            .vmTemplate("{json:json}")
            .build());
    }
}
Content copied to clipboard

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:desktopvirtualization:HostPool hostPool1 /subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1
Content copied to clipboard

Constructors

Link copied to clipboard
fun HostPoolArgs(customRdpProperty: Output<String>? = null, description: Output<String>? = null, friendlyName: Output<String>? = null, hostPoolName: Output<String>? = null, hostPoolType: Output<Either<String, HostPoolType>>? = null, identity: Output<ResourceModelWithAllowedPropertySetIdentityArgs>? = null, kind: Output<String>? = null, loadBalancerType: Output<Either<String, LoadBalancerType>>? = null, location: Output<String>? = null, managedBy: Output<String>? = null, maxSessionLimit: Output<Int>? = null, migrationRequest: Output<MigrationRequestPropertiesArgs>? = null, personalDesktopAssignmentType: Output<Either<String, PersonalDesktopAssignmentType>>? = null, plan: Output<ResourceModelWithAllowedPropertySetPlanArgs>? = null, preferredAppGroupType: Output<Either<String, PreferredAppGroupType>>? = null, registrationInfo: Output<RegistrationInfoArgs>? = null, resourceGroupName: Output<String>? = null, ring: Output<Int>? = null, sku: Output<ResourceModelWithAllowedPropertySetSkuArgs>? = null, ssoClientId: Output<String>? = null, ssoClientSecretKeyVaultPath: Output<String>? = null, ssoSecretType: Output<Either<String, SSOSecretType>>? = null, ssoadfsAuthority: Output<String>? = null, startVMOnConnect: Output<Boolean>? = null, tags: Output<Map<String, String>>? = null, validationEnvironment: Output<Boolean>? = null, vmTemplate: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): HostPoolArgs

Properties

Link copied to clipboard
val customRdpProperty: Output<String>? = null

Custom rdp property of HostPool.

Link copied to clipboard
val description: Output<String>? = null

Description of HostPool.

Link copied to clipboard
val friendlyName: Output<String>? = null

Friendly name of HostPool.

Link copied to clipboard
val hostPoolName: Output<String>? = null

The name of the host pool within the specified resource group

Link copied to clipboard
val hostPoolType: Output<Either<String, HostPoolType>>? = null

HostPool type for desktop.

Link copied to clipboard
Link copied to clipboard
val kind: Output<String>? = null

Metadata 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.

Link copied to clipboard
val loadBalancerType: Output<Either<String, LoadBalancerType>>? = null

The type of the load balancer.

Link copied to clipboard
val location: Output<String>? = null

The geo-location where the resource lives

Link copied to clipboard
val managedBy: Output<String>? = null

The 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.

Link copied to clipboard
val maxSessionLimit: Output<Int>? = null

The max session limit of HostPool.

Link copied to clipboard
val migrationRequest: Output<MigrationRequestPropertiesArgs>? = null

The registration info of HostPool.

Link copied to clipboard
val personalDesktopAssignmentType: Output<Either<String, PersonalDesktopAssignmentType>>? = null

PersonalDesktopAssignment type for HostPool.

Link copied to clipboard
Link copied to clipboard
val preferredAppGroupType: Output<Either<String, PreferredAppGroupType>>? = null

The type of preferred application group type, default to Desktop Application Group

Link copied to clipboard
val registrationInfo: Output<RegistrationInfoArgs>? = null

The registration info of HostPool.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group. The name is case insensitive.

Link copied to clipboard
val ring: Output<Int>? = null

The ring number of HostPool.

Link copied to clipboard
Link copied to clipboard
val ssoadfsAuthority: Output<String>? = null

URL to customer ADFS server for signing WVD SSO certificates.

Link copied to clipboard
val ssoClientId: Output<String>? = null

ClientId for the registered Relying Party used to issue WVD SSO certificates.

Link copied to clipboard
val ssoClientSecretKeyVaultPath: Output<String>? = null

Path to Azure KeyVault storing the secret used for communication to ADFS.

Link copied to clipboard
val ssoSecretType: Output<Either<String, SSOSecretType>>? = null

The type of single sign on Secret Type.

Link copied to clipboard
val startVMOnConnect: Output<Boolean>? = null

The flag to turn on/off StartVMOnConnect feature.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

Resource tags.

Link copied to clipboard
val validationEnvironment: Output<Boolean>? = null

Is validation environment.

Link copied to clipboard
val vmTemplate: Output<String>? = null

VM template for sessionhosts configuration within hostpool.