Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. desktopvirtualization
  5. Workspace

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.desktopvirtualization.Workspace

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Virtual Desktop Workspace.

    Example Usage

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

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

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="rg-example-virtualdesktop",
    location="West Europe")
workspace = azure.desktopvirtualization.Workspace("workspace",
    name="workspace",
    location=example.location,
    resource_group_name=example.name,
    friendly_name="FriendlyName",
    description="A description of my workspace")

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/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{
			Name:     pulumi.String("rg-example-virtualdesktop"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = desktopvirtualization.NewWorkspace(ctx, "workspace", &desktopvirtualization.WorkspaceArgs{
			Name:              pulumi.String("workspace"),
			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
	})
}

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

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

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

});

    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()
            .name("rg-example-virtualdesktop")
            .location("West Europe")
            .build());

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

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: rg-example-virtualdesktop
      location: West Europe
  workspace:
    type: azure:desktopvirtualization:Workspace
    properties:
      name: workspace
      location: ${example.location}
      resourceGroupName: ${example.name}
      friendlyName: FriendlyName
      description: A description of my workspace

    Create Workspace Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Workspace(name: string, args: WorkspaceArgs, opts?: CustomResourceOptions);
    @overload
def Workspace(resource_name: str,
              args: WorkspaceArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Workspace(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              resource_group_name: Optional[str] = None,
              description: Optional[str] = None,
              friendly_name: Optional[str] = None,
              location: Optional[str] = None,
              name: Optional[str] = None,
              public_network_access_enabled: Optional[bool] = None,
              tags: Optional[Mapping[str, str]] = 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.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var azureWorkspaceResource = new Azure.DesktopVirtualization.Workspace("azureWorkspaceResource", new()
{
    ResourceGroupName = "string",
    Description = "string",
    FriendlyName = "string",
    Location = "string",
    Name = "string",
    PublicNetworkAccessEnabled = false,
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := desktopvirtualization.NewWorkspace(ctx, "azureWorkspaceResource", &desktopvirtualization.WorkspaceArgs{
	ResourceGroupName:          pulumi.String("string"),
	Description:                pulumi.String("string"),
	FriendlyName:               pulumi.String("string"),
	Location:                   pulumi.String("string"),
	Name:                       pulumi.String("string"),
	PublicNetworkAccessEnabled: pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var azureWorkspaceResource = new Workspace("azureWorkspaceResource", WorkspaceArgs.builder()
    .resourceGroupName("string")
    .description("string")
    .friendlyName("string")
    .location("string")
    .name("string")
    .publicNetworkAccessEnabled(false)
    .tags(Map.of("string", "string"))
    .build());

    azure_workspace_resource = azure.desktopvirtualization.Workspace("azureWorkspaceResource",
    resource_group_name="string",
    description="string",
    friendly_name="string",
    location="string",
    name="string",
    public_network_access_enabled=False,
    tags={
        "string": "string",
    })

    const azureWorkspaceResource = new azure.desktopvirtualization.Workspace("azureWorkspaceResource", {
    resourceGroupName: "string",
    description: "string",
    friendlyName: "string",
    location: "string",
    name: "string",
    publicNetworkAccessEnabled: false,
    tags: {
        string: "string",
    },
});

    type: azure:desktopvirtualization:Workspace
properties:
    description: string
    friendlyName: string
    location: string
    name: string
    publicNetworkAccessEnabled: false
    resourceGroupName: string
    tags:
        string: string

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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.
    PublicNetworkAccessEnabled bool
    Whether public network access is allowed for this Virtual Desktop Workspace. Defaults to true.
    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.
    PublicNetworkAccessEnabled bool
    Whether public network access is allowed for this Virtual Desktop Workspace. Defaults to true.
    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.
    publicNetworkAccessEnabled Boolean
    Whether public network access is allowed for this Virtual Desktop Workspace. Defaults to true.
    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.
    publicNetworkAccessEnabled boolean
    Whether public network access is allowed for this Virtual Desktop Workspace. Defaults to true.
    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.
    public_network_access_enabled bool
    Whether public network access is allowed for this Virtual Desktop Workspace. Defaults to true.
    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.
    publicNetworkAccessEnabled Boolean
    Whether public network access is allowed for this Virtual Desktop Workspace. Defaults to true.
    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,
        public_network_access_enabled: Optional[bool] = 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.
    PublicNetworkAccessEnabled bool
    Whether public network access is allowed for this Virtual Desktop Workspace. Defaults to true.
    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.
    PublicNetworkAccessEnabled bool
    Whether public network access is allowed for this Virtual Desktop Workspace. Defaults to true.
    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.
    publicNetworkAccessEnabled Boolean
    Whether public network access is allowed for this Virtual Desktop Workspace. Defaults to true.
    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.
    publicNetworkAccessEnabled boolean
    Whether public network access is allowed for this Virtual Desktop Workspace. Defaults to true.
    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.
    public_network_access_enabled bool
    Whether public network access is allowed for this Virtual Desktop Workspace. Defaults to true.
    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.
    publicNetworkAccessEnabled Boolean
    Whether public network access is allowed for this Virtual Desktop Workspace. Defaults to true.
    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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

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

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure