azure logo
Azure Classic v5.32.0, Jan 25 23

azure.desktopvirtualization.Workspace

Manages a Virtual Desktop Workspace.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Location = "West Europe",
    });

    var workspace = new Azure.DesktopVirtualization.Workspace("workspace", new()
    {
        Location = example.Location,
        ResourceGroupName = example.Name,
        FriendlyName = "FriendlyName",
        Description = "A description of my workspace",
    });

});
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"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 {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		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
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.desktopvirtualization.Workspace;
import com.pulumi.azure.desktopvirtualization.WorkspaceArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var workspace = new Workspace("workspace", WorkspaceArgs.builder()        
            .location(example.location())
            .resourceGroupName(example.name())
            .friendlyName("FriendlyName")
            .description("A description of my workspace")
            .build());

    }
}
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example", location="West Europe")
workspace = azure.desktopvirtualization.Workspace("workspace",
    location=example.location,
    resource_group_name=example.name,
    friendly_name="FriendlyName",
    description="A description of my workspace")
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {location: "West Europe"});
const workspace = new azure.desktopvirtualization.Workspace("workspace", {
    location: example.location,
    resourceGroupName: example.name,
    friendlyName: "FriendlyName",
    description: "A description of my workspace",
});
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  workspace:
    type: azure:desktopvirtualization:Workspace
    properties:
      location: ${example.location}
      resourceGroupName: ${example.name}
      friendlyName: FriendlyName
      description: A description of my workspace

Create Workspace Resource

new Workspace(name: string, args: WorkspaceArgs, opts?: CustomResourceOptions);
@overload
def Workspace(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              description: Optional[str] = None,
              friendly_name: Optional[str] = None,
              location: Optional[str] = None,
              name: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None)
@overload
def Workspace(resource_name: str,
              args: WorkspaceArgs,
              opts: Optional[ResourceOptions] = None)
func NewWorkspace(ctx *Context, name string, args WorkspaceArgs, opts ...ResourceOption) (*Workspace, error)
public Workspace(string name, WorkspaceArgs args, CustomResourceOptions? opts = null)
public Workspace(String name, WorkspaceArgs args)
public Workspace(String name, WorkspaceArgs args, CustomResourceOptions options)
type: azure:desktopvirtualization:Workspace
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args WorkspaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args WorkspaceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args WorkspaceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args WorkspaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args WorkspaceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Workspace Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Workspace resource accepts the following input properties:

ResourceGroupName string

The name of the resource group in which to create the Virtual Desktop Workspace. Changing this forces a new resource to be created.

Description string

A description for the Virtual Desktop Workspace.

FriendlyName string

A friendly name for the Virtual Desktop Workspace.

Location string

The location/region where the Virtual Desktop Workspace is located. Changing the location/region forces a new resource to be created.

Name string

The name of the Virtual Desktop Workspace. Changing this forces a new resource to be created.

Tags Dictionary<string, string>

A mapping of tags to assign to the resource.

ResourceGroupName string

The name of the resource group in which to create the Virtual Desktop Workspace. Changing this forces a new resource to be created.

Description string

A description for the Virtual Desktop Workspace.

FriendlyName string

A friendly name for the Virtual Desktop Workspace.

Location string

The location/region where the Virtual Desktop Workspace is located. Changing the location/region forces a new resource to be created.

Name string

The name of the Virtual Desktop Workspace. Changing this forces a new resource to be created.

Tags map[string]string

A mapping of tags to assign to the resource.

resourceGroupName String

The name of the resource group in which to create the Virtual Desktop Workspace. Changing this forces a new resource to be created.

description String

A description for the Virtual Desktop Workspace.

friendlyName String

A friendly name for the Virtual Desktop Workspace.

location String

The location/region where the Virtual Desktop Workspace is located. Changing the location/region forces a new resource to be created.

name String

The name of the Virtual Desktop Workspace. Changing this forces a new resource to be created.

tags Map<String,String>

A mapping of tags to assign to the resource.

resourceGroupName string

The name of the resource group in which to create the Virtual Desktop Workspace. Changing this forces a new resource to be created.

description string

A description for the Virtual Desktop Workspace.

friendlyName string

A friendly name for the Virtual Desktop Workspace.

location string

The location/region where the Virtual Desktop Workspace is located. Changing the location/region forces a new resource to be created.

name string

The name of the Virtual Desktop Workspace. Changing this forces a new resource to be created.

tags {[key: string]: string}

A mapping of tags to assign to the resource.

resource_group_name str

The name of the resource group in which to create the Virtual Desktop Workspace. Changing this forces a new resource to be created.

description str

A description for the Virtual Desktop Workspace.

friendly_name str

A friendly name for the Virtual Desktop Workspace.

location str

The location/region where the Virtual Desktop Workspace is located. Changing the location/region forces a new resource to be created.

name str

The name of the Virtual Desktop Workspace. Changing this forces a new resource to be created.

tags Mapping[str, str]

A mapping of tags to assign to the resource.

resourceGroupName String

The name of the resource group in which to create the Virtual Desktop Workspace. Changing this forces a new resource to be created.

description String

A description for the Virtual Desktop Workspace.

friendlyName String

A friendly name for the Virtual Desktop Workspace.

location String

The location/region where the Virtual Desktop Workspace is located. Changing the location/region forces a new resource to be created.

name String

The name of the Virtual Desktop Workspace. Changing this forces a new resource to be created.

tags Map<String>

A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Workspace resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing Workspace Resource

Get an existing Workspace resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: WorkspaceState, opts?: CustomResourceOptions): Workspace
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        friendly_name: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> Workspace
func GetWorkspace(ctx *Context, name string, id IDInput, state *WorkspaceState, opts ...ResourceOption) (*Workspace, error)
public static Workspace Get(string name, Input<string> id, WorkspaceState? state, CustomResourceOptions? opts = null)
public static Workspace get(String name, Output<String> id, WorkspaceState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Description string

A description for the Virtual Desktop Workspace.

FriendlyName string

A friendly name for the Virtual Desktop Workspace.

Location string

The location/region where the Virtual Desktop Workspace is located. Changing the location/region forces a new resource to be created.

Name string

The name of the Virtual Desktop Workspace. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the resource group in which to create the Virtual Desktop Workspace. Changing this forces a new resource to be created.

Tags Dictionary<string, string>

A mapping of tags to assign to the resource.

Description string

A description for the Virtual Desktop Workspace.

FriendlyName string

A friendly name for the Virtual Desktop Workspace.

Location string

The location/region where the Virtual Desktop Workspace is located. Changing the location/region forces a new resource to be created.

Name string

The name of the Virtual Desktop Workspace. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the resource group in which to create the Virtual Desktop Workspace. Changing this forces a new resource to be created.

Tags map[string]string

A mapping of tags to assign to the resource.

description String

A description for the Virtual Desktop Workspace.

friendlyName String

A friendly name for the Virtual Desktop Workspace.

location String

The location/region where the Virtual Desktop Workspace is located. Changing the location/region forces a new resource to be created.

name String

The name of the Virtual Desktop Workspace. Changing this forces a new resource to be created.

resourceGroupName String

The name of the resource group in which to create the Virtual Desktop Workspace. Changing this forces a new resource to be created.

tags Map<String,String>

A mapping of tags to assign to the resource.

description string

A description for the Virtual Desktop Workspace.

friendlyName string

A friendly name for the Virtual Desktop Workspace.

location string

The location/region where the Virtual Desktop Workspace is located. Changing the location/region forces a new resource to be created.

name string

The name of the Virtual Desktop Workspace. Changing this forces a new resource to be created.

resourceGroupName string

The name of the resource group in which to create the Virtual Desktop Workspace. Changing this forces a new resource to be created.

tags {[key: string]: string}

A mapping of tags to assign to the resource.

description str

A description for the Virtual Desktop Workspace.

friendly_name str

A friendly name for the Virtual Desktop Workspace.

location str

The location/region where the Virtual Desktop Workspace is located. Changing the location/region forces a new resource to be created.

name str

The name of the Virtual Desktop Workspace. Changing this forces a new resource to be created.

resource_group_name str

The name of the resource group in which to create the Virtual Desktop Workspace. Changing this forces a new resource to be created.

tags Mapping[str, str]

A mapping of tags to assign to the resource.

description String

A description for the Virtual Desktop Workspace.

friendlyName String

A friendly name for the Virtual Desktop Workspace.

location String

The location/region where the Virtual Desktop Workspace is located. Changing the location/region forces a new resource to be created.

name String

The name of the Virtual Desktop Workspace. Changing this forces a new resource to be created.

resourceGroupName String

The name of the resource group in which to create the Virtual Desktop Workspace. Changing this forces a new resource to be created.

tags Map<String>

A mapping of tags to assign to the resource.

Import

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

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

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.