desktopvirtualization

package
v3.33.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 8, 2020 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApplicationGroup 

type ApplicationGroup struct {
	pulumi.CustomResourceState

	// Option to set a description for the Virtual Desktop Application Group.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Option to set a friendly name for the Virtual Desktop Application Group.
	FriendlyName pulumi.StringPtrOutput `pulumi:"friendlyName"`
	// Resource ID for a Virtual Desktop Host Pool to associate with the
	// Virtual Desktop Application Group.
	HostPoolId pulumi.StringOutput `pulumi:"hostPoolId"`
	// The location/region where the Virtual Desktop Application Group is
	// located. Changing the location/region forces a new resource to be created.
	Location pulumi.StringOutput `pulumi:"location"`
	// The name of the Virtual Desktop Application Group. Changing the name forces a new resource to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// The name of the resource group in which to
	// create the Virtual Desktop Application Group. Changing the resource group name forces
	// a new resource to be created.
	ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"`
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// Type of Virtual Desktop Application Group.
	// Valid options are `RemoteApp` or `Desktop` application groups.
	Type pulumi.StringOutput `pulumi:"type"`
}

Manages a Virtual Desktop Application Group.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/desktopvirtualization"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Location: pulumi.String("eastus"),
		})
		if err != nil {
			return err
		}
		pooledbreadthfirst, err := desktopvirtualization.NewHostPool(ctx, "pooledbreadthfirst", &desktopvirtualization.HostPoolArgs{
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Type:              pulumi.String("Pooled"),
			LoadBalancerType:  pulumi.String("BreadthFirst"),
		})
		if err != nil {
			return err
		}
		personalautomatic, err := desktopvirtualization.NewHostPool(ctx, "personalautomatic", &desktopvirtualization.HostPoolArgs{
			Location:                      example.Location,
			ResourceGroupName:             example.Name,
			Type:                          pulumi.String("Personal"),
			PersonalDesktopAssignmentType: pulumi.String("Automatic"),
		})
		if err != nil {
			return err
		}
		_, err = desktopvirtualization.NewApplicationGroup(ctx, "remoteapp", &desktopvirtualization.ApplicationGroupArgs{
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Type:              pulumi.String("RemoteApp"),
			HostPoolId:        pooledbreadthfirst.ID(),
			FriendlyName:      pulumi.String("TestAppGroup"),
			Description:       pulumi.String("Acceptance Test: An application group"),
		})
		if err != nil {
			return err
		}
		_, err = desktopvirtualization.NewApplicationGroup(ctx, "desktopapp", &desktopvirtualization.ApplicationGroupArgs{
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Type:              pulumi.String("Desktop"),
			HostPoolId:        personalautomatic.ID(),
			FriendlyName:      pulumi.String("TestAppGroup"),
			Description:       pulumi.String("Acceptance Test: An application group"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Virtual Desktop Application Groups can be imported using the `resource id`, e.g.

```sh 

$ pulumi import azure:desktopvirtualization/applicationGroup:ApplicationGroup example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/myapplicationgroup

```

func GetApplicationGroup 

func GetApplicationGroup(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApplicationGroupState, opts ...pulumi.ResourceOption) (*ApplicationGroup, error)

GetApplicationGroup gets an existing ApplicationGroup resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewApplicationGroup 

func NewApplicationGroup(ctx *pulumi.Context,
	name string, args *ApplicationGroupArgs, opts ...pulumi.ResourceOption) (*ApplicationGroup, error)

NewApplicationGroup registers a new resource with the given unique name, arguments, and options.

func (ApplicationGroup) ElementType added in v3.31.1 

func (ApplicationGroup) ElementType() reflect.Type

func (ApplicationGroup) ToApplicationGroupOutput added in v3.31.1 

func (i ApplicationGroup) ToApplicationGroupOutput() ApplicationGroupOutput

func (ApplicationGroup) ToApplicationGroupOutputWithContext added in v3.31.1 

func (i ApplicationGroup) ToApplicationGroupOutputWithContext(ctx context.Context) ApplicationGroupOutput

type ApplicationGroupArgs 

type ApplicationGroupArgs struct {
	// Option to set a description for the Virtual Desktop Application Group.
	Description pulumi.StringPtrInput
	// Option to set a friendly name for the Virtual Desktop Application Group.
	FriendlyName pulumi.StringPtrInput
	// Resource ID for a Virtual Desktop Host Pool to associate with the
	// Virtual Desktop Application Group.
	HostPoolId pulumi.StringInput
	// The location/region where the Virtual Desktop Application Group is
	// located. Changing the location/region forces a new resource to be created.
	Location pulumi.StringPtrInput
	// The name of the Virtual Desktop Application Group. Changing the name forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The name of the resource group in which to
	// create the Virtual Desktop Application Group. Changing the resource group name forces
	// a new resource to be created.
	ResourceGroupName pulumi.StringInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
	// Type of Virtual Desktop Application Group.
	// Valid options are `RemoteApp` or `Desktop` application groups.
	Type pulumi.StringInput
}

The set of arguments for constructing a ApplicationGroup resource.

func (ApplicationGroupArgs) ElementType 

func (ApplicationGroupArgs) ElementType() reflect.Type

type ApplicationGroupInput added in v3.31.1 

type ApplicationGroupInput interface {
	pulumi.Input

	ToApplicationGroupOutput() ApplicationGroupOutput
	ToApplicationGroupOutputWithContext(ctx context.Context) ApplicationGroupOutput
}

type ApplicationGroupOutput added in v3.31.1 

type ApplicationGroupOutput struct {
	*pulumi.OutputState
}

func (ApplicationGroupOutput) ElementType added in v3.31.1 

func (ApplicationGroupOutput) ElementType() reflect.Type

func (ApplicationGroupOutput) ToApplicationGroupOutput added in v3.31.1 

func (o ApplicationGroupOutput) ToApplicationGroupOutput() ApplicationGroupOutput

func (ApplicationGroupOutput) ToApplicationGroupOutputWithContext added in v3.31.1 

func (o ApplicationGroupOutput) ToApplicationGroupOutputWithContext(ctx context.Context) ApplicationGroupOutput

type ApplicationGroupState 

type ApplicationGroupState struct {
	// Option to set a description for the Virtual Desktop Application Group.
	Description pulumi.StringPtrInput
	// Option to set a friendly name for the Virtual Desktop Application Group.
	FriendlyName pulumi.StringPtrInput
	// Resource ID for a Virtual Desktop Host Pool to associate with the
	// Virtual Desktop Application Group.
	HostPoolId pulumi.StringPtrInput
	// The location/region where the Virtual Desktop Application Group is
	// located. Changing the location/region forces a new resource to be created.
	Location pulumi.StringPtrInput
	// The name of the Virtual Desktop Application Group. Changing the name forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The name of the resource group in which to
	// create the Virtual Desktop Application Group. Changing the resource group name forces
	// a new resource to be created.
	ResourceGroupName pulumi.StringPtrInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
	// Type of Virtual Desktop Application Group.
	// Valid options are `RemoteApp` or `Desktop` application groups.
	Type pulumi.StringPtrInput
}

func (ApplicationGroupState) ElementType 

func (ApplicationGroupState) ElementType() reflect.Type

type HostPool 

type HostPool struct {
	pulumi.CustomResourceState

	// A description for the Virtual Desktop Host Pool.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// A friendly name for the Virtual Desktop Host Pool.
	FriendlyName pulumi.StringPtrOutput `pulumi:"friendlyName"`
	// `BreadthFirst` load balancing distributes new user sessions across all available session hosts in the host pool.
	// `DepthFirst` load balancing distributes new user sessions to an available session host with the highest number of connections but has not reached its maximum session limit threshold.
	// `Persistent` should be used if the host pool type is `Personal`
	LoadBalancerType pulumi.StringOutput `pulumi:"loadBalancerType"`
	// The location/region where the Virtual Desktop Host Pool is
	// located. Changing the location/region forces a new resource to be created.
	Location pulumi.StringOutput `pulumi:"location"`
	// A valid integer value from 0 to 999999 for the maximum number of users that have concurrent sessions on a session host.
	// Should only be set if the `type` of your Virtual Desktop Host Pool is `Pooled`.
	MaximumSessionsAllowed pulumi.IntPtrOutput `pulumi:"maximumSessionsAllowed"`
	// The name of the Virtual Desktop Host Pool. Changing the name
	// forces a new resource to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// `Automatic` assignment – The service will select an available host and assign it to an user.
	// `Direct` Assignment – Admin selects a specific host to assign to an user.
	PersonalDesktopAssignmentType pulumi.StringPtrOutput `pulumi:"personalDesktopAssignmentType"`
	// Option to specify the preferred Application Group type for the Virtual Desktop Host Pool.
	// Valid options are `None`, `Desktop` or `RailApplications`. Default is `None`.
	PreferredAppGroupType pulumi.StringPtrOutput `pulumi:"preferredAppGroupType"`
	// A `registrationInfo` block which is documented below. Specifies configuration on the registration information of the Virtual Desktop Host Pool.
	RegistrationInfo HostPoolRegistrationInfoPtrOutput `pulumi:"registrationInfo"`
	// The name of the resource group in which to
	// create the Virtual Desktop Host Pool. Changing the resource group name forces
	// a new resource to be created.
	ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"`
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// The type of the Virtual Desktop Host Pool. Valid options are
	// `Personal` or `Pooled`. Changing the type forces a new resource to be created.
	Type                pulumi.StringOutput  `pulumi:"type"`
	ValidateEnvironment pulumi.BoolPtrOutput `pulumi:"validateEnvironment"`
}

Manages a Virtual Desktop Host Pool.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/desktopvirtualization"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = desktopvirtualization.NewHostPool(ctx, "exampleHostPool", &desktopvirtualization.HostPoolArgs{
			Location:               exampleResourceGroup.Location,
			ResourceGroupName:      exampleResourceGroup.Name,
			FriendlyName:           pulumi.String("pooleddepthfirst"),
			ValidateEnvironment:    pulumi.Bool(true),
			Description:            pulumi.String("Acceptance Test: A pooled host pool - pooleddepthfirst"),
			Type:                   pulumi.String("Pooled"),
			MaximumSessionsAllowed: pulumi.Int(50),
			LoadBalancerType:       pulumi.String("DepthFirst"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Virtual Desktop Host Pools can be imported using the `resource id`, e.g.

```sh 

$ pulumi import azure:desktopvirtualization/hostPool:HostPool example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup1/providers/Microsoft.DesktopVirtualization/hostpools/myhostpool

```

func GetHostPool 

func GetHostPool(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *HostPoolState, opts ...pulumi.ResourceOption) (*HostPool, error)

GetHostPool gets an existing HostPool resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewHostPool 

func NewHostPool(ctx *pulumi.Context,
	name string, args *HostPoolArgs, opts ...pulumi.ResourceOption) (*HostPool, error)

NewHostPool registers a new resource with the given unique name, arguments, and options.

func (HostPool) ElementType added in v3.31.1 

func (HostPool) ElementType() reflect.Type

func (HostPool) ToHostPoolOutput added in v3.31.1 

func (i HostPool) ToHostPoolOutput() HostPoolOutput

func (HostPool) ToHostPoolOutputWithContext added in v3.31.1 

func (i HostPool) ToHostPoolOutputWithContext(ctx context.Context) HostPoolOutput

type HostPoolArgs 

type HostPoolArgs struct {
	// A description for the Virtual Desktop Host Pool.
	Description pulumi.StringPtrInput
	// A friendly name for the Virtual Desktop Host Pool.
	FriendlyName pulumi.StringPtrInput
	// `BreadthFirst` load balancing distributes new user sessions across all available session hosts in the host pool.
	// `DepthFirst` load balancing distributes new user sessions to an available session host with the highest number of connections but has not reached its maximum session limit threshold.
	// `Persistent` should be used if the host pool type is `Personal`
	LoadBalancerType pulumi.StringInput
	// The location/region where the Virtual Desktop Host Pool is
	// located. Changing the location/region forces a new resource to be created.
	Location pulumi.StringPtrInput
	// A valid integer value from 0 to 999999 for the maximum number of users that have concurrent sessions on a session host.
	// Should only be set if the `type` of your Virtual Desktop Host Pool is `Pooled`.
	MaximumSessionsAllowed pulumi.IntPtrInput
	// The name of the Virtual Desktop Host Pool. Changing the name
	// forces a new resource to be created.
	Name pulumi.StringPtrInput
	// `Automatic` assignment – The service will select an available host and assign it to an user.
	// `Direct` Assignment – Admin selects a specific host to assign to an user.
	PersonalDesktopAssignmentType pulumi.StringPtrInput
	// Option to specify the preferred Application Group type for the Virtual Desktop Host Pool.
	// Valid options are `None`, `Desktop` or `RailApplications`. Default is `None`.
	PreferredAppGroupType pulumi.StringPtrInput
	// A `registrationInfo` block which is documented below. Specifies configuration on the registration information of the Virtual Desktop Host Pool.
	RegistrationInfo HostPoolRegistrationInfoPtrInput
	// The name of the resource group in which to
	// create the Virtual Desktop Host Pool. Changing the resource group name forces
	// a new resource to be created.
	ResourceGroupName pulumi.StringInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
	// The type of the Virtual Desktop Host Pool. Valid options are
	// `Personal` or `Pooled`. Changing the type forces a new resource to be created.
	Type                pulumi.StringInput
	ValidateEnvironment pulumi.BoolPtrInput
}

The set of arguments for constructing a HostPool resource.

func (HostPoolArgs) ElementType 

func (HostPoolArgs) ElementType() reflect.Type

type HostPoolInput added in v3.31.1 

type HostPoolInput interface {
	pulumi.Input

	ToHostPoolOutput() HostPoolOutput
	ToHostPoolOutputWithContext(ctx context.Context) HostPoolOutput
}

type HostPoolOutput added in v3.31.1 

type HostPoolOutput struct {
	*pulumi.OutputState
}

func (HostPoolOutput) ElementType added in v3.31.1 

func (HostPoolOutput) ElementType() reflect.Type

func (HostPoolOutput) ToHostPoolOutput added in v3.31.1 

func (o HostPoolOutput) ToHostPoolOutput() HostPoolOutput

func (HostPoolOutput) ToHostPoolOutputWithContext added in v3.31.1 

func (o HostPoolOutput) ToHostPoolOutputWithContext(ctx context.Context) HostPoolOutput

type HostPoolRegistrationInfo 

type HostPoolRegistrationInfo struct {
	// A valid `RFC3339Time` for the expiration of the token.
	ExpirationDate string `pulumi:"expirationDate"`
	ResetToken     *bool  `pulumi:"resetToken"`
	// The registration token generated by the Virtual Desktop Host Pool.
	Token *string `pulumi:"token"`
}

type HostPoolRegistrationInfoArgs 

type HostPoolRegistrationInfoArgs struct {
	// A valid `RFC3339Time` for the expiration of the token.
	ExpirationDate pulumi.StringInput  `pulumi:"expirationDate"`
	ResetToken     pulumi.BoolPtrInput `pulumi:"resetToken"`
	// The registration token generated by the Virtual Desktop Host Pool.
	Token pulumi.StringPtrInput `pulumi:"token"`
}

func (HostPoolRegistrationInfoArgs) ElementType 

func (HostPoolRegistrationInfoArgs) ElementType() reflect.Type

func (HostPoolRegistrationInfoArgs) ToHostPoolRegistrationInfoOutput 

func (i HostPoolRegistrationInfoArgs) ToHostPoolRegistrationInfoOutput() HostPoolRegistrationInfoOutput

func (HostPoolRegistrationInfoArgs) ToHostPoolRegistrationInfoOutputWithContext 

func (i HostPoolRegistrationInfoArgs) ToHostPoolRegistrationInfoOutputWithContext(ctx context.Context) HostPoolRegistrationInfoOutput

func (HostPoolRegistrationInfoArgs) ToHostPoolRegistrationInfoPtrOutput 

func (i HostPoolRegistrationInfoArgs) ToHostPoolRegistrationInfoPtrOutput() HostPoolRegistrationInfoPtrOutput

func (HostPoolRegistrationInfoArgs) ToHostPoolRegistrationInfoPtrOutputWithContext 

func (i HostPoolRegistrationInfoArgs) ToHostPoolRegistrationInfoPtrOutputWithContext(ctx context.Context) HostPoolRegistrationInfoPtrOutput

type HostPoolRegistrationInfoInput 

type HostPoolRegistrationInfoInput interface {
	pulumi.Input

	ToHostPoolRegistrationInfoOutput() HostPoolRegistrationInfoOutput
	ToHostPoolRegistrationInfoOutputWithContext(context.Context) HostPoolRegistrationInfoOutput
}

HostPoolRegistrationInfoInput is an input type that accepts HostPoolRegistrationInfoArgs and HostPoolRegistrationInfoOutput values. You can construct a concrete instance of `HostPoolRegistrationInfoInput` via: 

HostPoolRegistrationInfoArgs{...}

type HostPoolRegistrationInfoOutput 

type HostPoolRegistrationInfoOutput struct{ *pulumi.OutputState }

func (HostPoolRegistrationInfoOutput) ElementType 

func (HostPoolRegistrationInfoOutput) ElementType() reflect.Type

func (HostPoolRegistrationInfoOutput) ExpirationDate 

func (o HostPoolRegistrationInfoOutput) ExpirationDate() pulumi.StringOutput

A valid `RFC3339Time` for the expiration of the token.

func (HostPoolRegistrationInfoOutput) ResetToken 

func (o HostPoolRegistrationInfoOutput) ResetToken() pulumi.BoolPtrOutput

func (HostPoolRegistrationInfoOutput) ToHostPoolRegistrationInfoOutput 

func (o HostPoolRegistrationInfoOutput) ToHostPoolRegistrationInfoOutput() HostPoolRegistrationInfoOutput

func (HostPoolRegistrationInfoOutput) ToHostPoolRegistrationInfoOutputWithContext 

func (o HostPoolRegistrationInfoOutput) ToHostPoolRegistrationInfoOutputWithContext(ctx context.Context) HostPoolRegistrationInfoOutput

func (HostPoolRegistrationInfoOutput) ToHostPoolRegistrationInfoPtrOutput 

func (o HostPoolRegistrationInfoOutput) ToHostPoolRegistrationInfoPtrOutput() HostPoolRegistrationInfoPtrOutput

func (HostPoolRegistrationInfoOutput) ToHostPoolRegistrationInfoPtrOutputWithContext 

func (o HostPoolRegistrationInfoOutput) ToHostPoolRegistrationInfoPtrOutputWithContext(ctx context.Context) HostPoolRegistrationInfoPtrOutput

func (HostPoolRegistrationInfoOutput) Token 

func (o HostPoolRegistrationInfoOutput) Token() pulumi.StringPtrOutput

The registration token generated by the Virtual Desktop Host Pool.

type HostPoolRegistrationInfoPtrInput 

type HostPoolRegistrationInfoPtrInput interface {
	pulumi.Input

	ToHostPoolRegistrationInfoPtrOutput() HostPoolRegistrationInfoPtrOutput
	ToHostPoolRegistrationInfoPtrOutputWithContext(context.Context) HostPoolRegistrationInfoPtrOutput
}

HostPoolRegistrationInfoPtrInput is an input type that accepts HostPoolRegistrationInfoArgs, HostPoolRegistrationInfoPtr and HostPoolRegistrationInfoPtrOutput values. You can construct a concrete instance of `HostPoolRegistrationInfoPtrInput` via: 

        HostPoolRegistrationInfoArgs{...}

or:

        nil

func HostPoolRegistrationInfoPtr 

func HostPoolRegistrationInfoPtr(v *HostPoolRegistrationInfoArgs) HostPoolRegistrationInfoPtrInput

type HostPoolRegistrationInfoPtrOutput 

type HostPoolRegistrationInfoPtrOutput struct{ *pulumi.OutputState }

func (HostPoolRegistrationInfoPtrOutput) Elem 

func (o HostPoolRegistrationInfoPtrOutput) Elem() HostPoolRegistrationInfoOutput

func (HostPoolRegistrationInfoPtrOutput) ElementType 

func (HostPoolRegistrationInfoPtrOutput) ElementType() reflect.Type

func (HostPoolRegistrationInfoPtrOutput) ExpirationDate 

func (o HostPoolRegistrationInfoPtrOutput) ExpirationDate() pulumi.StringPtrOutput

A valid `RFC3339Time` for the expiration of the token.

func (HostPoolRegistrationInfoPtrOutput) ResetToken 

func (o HostPoolRegistrationInfoPtrOutput) ResetToken() pulumi.BoolPtrOutput

func (HostPoolRegistrationInfoPtrOutput) ToHostPoolRegistrationInfoPtrOutput 

func (o HostPoolRegistrationInfoPtrOutput) ToHostPoolRegistrationInfoPtrOutput() HostPoolRegistrationInfoPtrOutput

func (HostPoolRegistrationInfoPtrOutput) ToHostPoolRegistrationInfoPtrOutputWithContext 

func (o HostPoolRegistrationInfoPtrOutput) ToHostPoolRegistrationInfoPtrOutputWithContext(ctx context.Context) HostPoolRegistrationInfoPtrOutput

func (HostPoolRegistrationInfoPtrOutput) Token 

func (o HostPoolRegistrationInfoPtrOutput) Token() pulumi.StringPtrOutput

The registration token generated by the Virtual Desktop Host Pool.

type HostPoolState 

type HostPoolState struct {
	// A description for the Virtual Desktop Host Pool.
	Description pulumi.StringPtrInput
	// A friendly name for the Virtual Desktop Host Pool.
	FriendlyName pulumi.StringPtrInput
	// `BreadthFirst` load balancing distributes new user sessions across all available session hosts in the host pool.
	// `DepthFirst` load balancing distributes new user sessions to an available session host with the highest number of connections but has not reached its maximum session limit threshold.
	// `Persistent` should be used if the host pool type is `Personal`
	LoadBalancerType pulumi.StringPtrInput
	// The location/region where the Virtual Desktop Host Pool is
	// located. Changing the location/region forces a new resource to be created.
	Location pulumi.StringPtrInput
	// A valid integer value from 0 to 999999 for the maximum number of users that have concurrent sessions on a session host.
	// Should only be set if the `type` of your Virtual Desktop Host Pool is `Pooled`.
	MaximumSessionsAllowed pulumi.IntPtrInput
	// The name of the Virtual Desktop Host Pool. Changing the name
	// forces a new resource to be created.
	Name pulumi.StringPtrInput
	// `Automatic` assignment – The service will select an available host and assign it to an user.
	// `Direct` Assignment – Admin selects a specific host to assign to an user.
	PersonalDesktopAssignmentType pulumi.StringPtrInput
	// Option to specify the preferred Application Group type for the Virtual Desktop Host Pool.
	// Valid options are `None`, `Desktop` or `RailApplications`. Default is `None`.
	PreferredAppGroupType pulumi.StringPtrInput
	// A `registrationInfo` block which is documented below. Specifies configuration on the registration information of the Virtual Desktop Host Pool.
	RegistrationInfo HostPoolRegistrationInfoPtrInput
	// The name of the resource group in which to
	// create the Virtual Desktop Host Pool. Changing the resource group name forces
	// a new resource to be created.
	ResourceGroupName pulumi.StringPtrInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
	// The type of the Virtual Desktop Host Pool. Valid options are
	// `Personal` or `Pooled`. Changing the type forces a new resource to be created.
	Type                pulumi.StringPtrInput
	ValidateEnvironment pulumi.BoolPtrInput
}

func (HostPoolState) ElementType 

func (HostPoolState) ElementType() reflect.Type

type Workspace 

type Workspace struct {
	pulumi.CustomResourceState

	// A description for the Virtual Desktop Workspace.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// A friendly name for the Virtual Desktop Workspace.
	FriendlyName pulumi.StringPtrOutput `pulumi:"friendlyName"`
	// The location/region where the Virtual Desktop Workspace is located. Changing the location/region forces a new resource to be created.
	Location pulumi.StringOutput `pulumi:"location"`
	// The name of the Virtual Desktop Workspace. Changing the name
	// forces a new resource to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// The name of the resource group in which to
	// create the Virtual Desktop Workspace. Changing the resource group name forces
	// a new resource to be created.
	ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"`
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
}

Manages a Virtual Desktop Workspace.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/desktopvirtualization"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Location: pulumi.String("eastus"),
		})
		if err != nil {
			return err
		}
		_, err = desktopvirtualization.NewWorkspace(ctx, "workspace", &desktopvirtualization.WorkspaceArgs{
			Location:          example.Location,
			ResourceGroupName: example.Name,
			FriendlyName:      pulumi.String("FriendlyName"),
			Description:       pulumi.String("A description of my workspace"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Virtual Desktop Workspaces can be imported using the `resource id`, e.g.

```sh 

$ pulumi import azure:desktopvirtualization/workspace:Workspace example /subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myGroup1/providers/Microsoft.DesktopVirtualization/workspaces/myworkspace

```

func GetWorkspace 

func GetWorkspace(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *WorkspaceState, opts ...pulumi.ResourceOption) (*Workspace, error)

GetWorkspace gets an existing Workspace resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewWorkspace 

func NewWorkspace(ctx *pulumi.Context,
	name string, args *WorkspaceArgs, opts ...pulumi.ResourceOption) (*Workspace, error)

NewWorkspace registers a new resource with the given unique name, arguments, and options.

func (Workspace) ElementType added in v3.31.1 

func (Workspace) ElementType() reflect.Type

func (Workspace) ToWorkspaceOutput added in v3.31.1 

func (i Workspace) ToWorkspaceOutput() WorkspaceOutput

func (Workspace) ToWorkspaceOutputWithContext added in v3.31.1 

func (i Workspace) ToWorkspaceOutputWithContext(ctx context.Context) WorkspaceOutput

type WorkspaceApplicationGroupAssociation 

type WorkspaceApplicationGroupAssociation struct {
	pulumi.CustomResourceState

	// The resource ID for the Virtual Desktop Application Group.
	ApplicationGroupId pulumi.StringOutput `pulumi:"applicationGroupId"`
	// The resource ID for the Virtual Desktop Workspace.
	WorkspaceId pulumi.StringOutput `pulumi:"workspaceId"`
}

Manages a Virtual Desktop Workspace Application Group Association.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/desktopvirtualization"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Location: pulumi.String("eastus"),
		})
		if err != nil {
			return err
		}
		pooledbreadthfirst, err := desktopvirtualization.NewHostPool(ctx, "pooledbreadthfirst", &desktopvirtualization.HostPoolArgs{
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Type:              pulumi.String("Pooled"),
			LoadBalancerType:  pulumi.String("BreadthFirst"),
		})
		if err != nil {
			return err
		}
		remoteapp, err := desktopvirtualization.NewApplicationGroup(ctx, "remoteapp", &desktopvirtualization.ApplicationGroupArgs{
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Type:              pulumi.String("RemoteApp"),
			HostPoolId:        pooledbreadthfirst.ID(),
		})
		if err != nil {
			return err
		}
		workspace, err := desktopvirtualization.NewWorkspace(ctx, "workspace", &desktopvirtualization.WorkspaceArgs{
			Location:          example.Location,
			ResourceGroupName: example.Name,
		})
		if err != nil {
			return err
		}
		_, err = desktopvirtualization.NewWorkspaceApplicationGroupAssociation(ctx, "workspaceremoteapp", &desktopvirtualization.WorkspaceApplicationGroupAssociationArgs{
			WorkspaceId:        workspace.ID(),
			ApplicationGroupId: remoteapp.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Associations between Virtual Desktop Workspaces and Virtual Desktop Application Groups can be imported using the `resource id`, e.g.

```sh 

$ pulumi import azure:desktopvirtualization/workspaceApplicationGroupAssociation:WorkspaceApplicationGroupAssociation association1 "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myGroup1/providers/Microsoft.DesktopVirtualization/workspaces/myworkspace|/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/myapplicationgroup"

```

func GetWorkspaceApplicationGroupAssociation 

func GetWorkspaceApplicationGroupAssociation(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *WorkspaceApplicationGroupAssociationState, opts ...pulumi.ResourceOption) (*WorkspaceApplicationGroupAssociation, error)

GetWorkspaceApplicationGroupAssociation gets an existing WorkspaceApplicationGroupAssociation resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewWorkspaceApplicationGroupAssociation 

func NewWorkspaceApplicationGroupAssociation(ctx *pulumi.Context,
	name string, args *WorkspaceApplicationGroupAssociationArgs, opts ...pulumi.ResourceOption) (*WorkspaceApplicationGroupAssociation, error)

NewWorkspaceApplicationGroupAssociation registers a new resource with the given unique name, arguments, and options.

func (WorkspaceApplicationGroupAssociation) ElementType added in v3.31.1 

func (WorkspaceApplicationGroupAssociation) ElementType() reflect.Type

func (WorkspaceApplicationGroupAssociation) ToWorkspaceApplicationGroupAssociationOutput added in v3.31.1 

func (i WorkspaceApplicationGroupAssociation) ToWorkspaceApplicationGroupAssociationOutput() WorkspaceApplicationGroupAssociationOutput

func (WorkspaceApplicationGroupAssociation) ToWorkspaceApplicationGroupAssociationOutputWithContext added in v3.31.1 

func (i WorkspaceApplicationGroupAssociation) ToWorkspaceApplicationGroupAssociationOutputWithContext(ctx context.Context) WorkspaceApplicationGroupAssociationOutput

type WorkspaceApplicationGroupAssociationArgs 

type WorkspaceApplicationGroupAssociationArgs struct {
	// The resource ID for the Virtual Desktop Application Group.
	ApplicationGroupId pulumi.StringInput
	// The resource ID for the Virtual Desktop Workspace.
	WorkspaceId pulumi.StringInput
}

The set of arguments for constructing a WorkspaceApplicationGroupAssociation resource.

func (WorkspaceApplicationGroupAssociationArgs) ElementType 

func (WorkspaceApplicationGroupAssociationArgs) ElementType() reflect.Type

type WorkspaceApplicationGroupAssociationInput added in v3.31.1 

type WorkspaceApplicationGroupAssociationInput interface {
	pulumi.Input

	ToWorkspaceApplicationGroupAssociationOutput() WorkspaceApplicationGroupAssociationOutput
	ToWorkspaceApplicationGroupAssociationOutputWithContext(ctx context.Context) WorkspaceApplicationGroupAssociationOutput
}

type WorkspaceApplicationGroupAssociationOutput added in v3.31.1 

type WorkspaceApplicationGroupAssociationOutput struct {
	*pulumi.OutputState
}

func (WorkspaceApplicationGroupAssociationOutput) ElementType added in v3.31.1 

func (WorkspaceApplicationGroupAssociationOutput) ElementType() reflect.Type

func (WorkspaceApplicationGroupAssociationOutput) ToWorkspaceApplicationGroupAssociationOutput added in v3.31.1 

func (o WorkspaceApplicationGroupAssociationOutput) ToWorkspaceApplicationGroupAssociationOutput() WorkspaceApplicationGroupAssociationOutput

func (WorkspaceApplicationGroupAssociationOutput) ToWorkspaceApplicationGroupAssociationOutputWithContext added in v3.31.1 

func (o WorkspaceApplicationGroupAssociationOutput) ToWorkspaceApplicationGroupAssociationOutputWithContext(ctx context.Context) WorkspaceApplicationGroupAssociationOutput

type WorkspaceApplicationGroupAssociationState 

type WorkspaceApplicationGroupAssociationState struct {
	// The resource ID for the Virtual Desktop Application Group.
	ApplicationGroupId pulumi.StringPtrInput
	// The resource ID for the Virtual Desktop Workspace.
	WorkspaceId pulumi.StringPtrInput
}

func (WorkspaceApplicationGroupAssociationState) ElementType 

func (WorkspaceApplicationGroupAssociationState) ElementType() reflect.Type

type WorkspaceArgs 

type WorkspaceArgs struct {
	// A description for the Virtual Desktop Workspace.
	Description pulumi.StringPtrInput
	// A friendly name for the Virtual Desktop Workspace.
	FriendlyName pulumi.StringPtrInput
	// The location/region where the Virtual Desktop Workspace is located. Changing the location/region forces a new resource to be created.
	Location pulumi.StringPtrInput
	// The name of the Virtual Desktop Workspace. Changing the name
	// forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The name of the resource group in which to
	// create the Virtual Desktop Workspace. Changing the resource group name forces
	// a new resource to be created.
	ResourceGroupName pulumi.StringInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Workspace resource.

func (WorkspaceArgs) ElementType 

func (WorkspaceArgs) ElementType() reflect.Type

type WorkspaceInput added in v3.31.1 

type WorkspaceInput interface {
	pulumi.Input

	ToWorkspaceOutput() WorkspaceOutput
	ToWorkspaceOutputWithContext(ctx context.Context) WorkspaceOutput
}

type WorkspaceOutput added in v3.31.1 

type WorkspaceOutput struct {
	*pulumi.OutputState
}

func (WorkspaceOutput) ElementType added in v3.31.1 

func (WorkspaceOutput) ElementType() reflect.Type

func (WorkspaceOutput) ToWorkspaceOutput added in v3.31.1 

func (o WorkspaceOutput) ToWorkspaceOutput() WorkspaceOutput

func (WorkspaceOutput) ToWorkspaceOutputWithContext added in v3.31.1 

func (o WorkspaceOutput) ToWorkspaceOutputWithContext(ctx context.Context) WorkspaceOutput

type WorkspaceState 

type WorkspaceState struct {
	// A description for the Virtual Desktop Workspace.
	Description pulumi.StringPtrInput
	// A friendly name for the Virtual Desktop Workspace.
	FriendlyName pulumi.StringPtrInput
	// The location/region where the Virtual Desktop Workspace is located. Changing the location/region forces a new resource to be created.
	Location pulumi.StringPtrInput
	// The name of the Virtual Desktop Workspace. Changing the name
	// forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The name of the resource group in which to
	// create the Virtual Desktop Workspace. Changing the resource group name forces
	// a new resource to be created.
	ResourceGroupName pulumi.StringPtrInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
}

func (WorkspaceState) ElementType 

func (WorkspaceState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.