We recommend using Azure Native.
Azure v6.28.0 published on Friday, Oct 3, 2025 by Pulumi
azure.desktopvirtualization.getWorkspace
Start a Neo task
Explain and create an azure.desktopvirtualization.getWorkspace resource
Use this data source to access information about an existing Virtual Desktop Workspace.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.desktopvirtualization.getWorkspace({
name: "existing",
resourceGroupName: "existing",
});
export const id = example.then(example => example.id);
import pulumi
import pulumi_azure as azure
example = azure.desktopvirtualization.get_workspace(name="existing",
resource_group_name="existing")
pulumi.export("id", example.id)
package main
import (
"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 := desktopvirtualization.LookupWorkspace(ctx, &desktopvirtualization.LookupWorkspaceArgs{
Name: "existing",
ResourceGroupName: "existing",
}, nil)
if err != nil {
return err
}
ctx.Export("id", example.Id)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = Azure.DesktopVirtualization.GetWorkspace.Invoke(new()
{
Name = "existing",
ResourceGroupName = "existing",
});
return new Dictionary<string, object?>
{
["id"] = example.Apply(getWorkspaceResult => getWorkspaceResult.Id),
};
});
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.GetWorkspaceArgs;
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.getWorkspace(GetWorkspaceArgs.builder()
.name("existing")
.resourceGroupName("existing")
.build());
ctx.export("id", example.id());
}
}
variables:
example:
fn::invoke:
function: azure:desktopvirtualization:getWorkspace
arguments:
name: existing
resourceGroupName: existing
outputs:
id: ${example.id}
API Providers
This data source uses the following Azure API Providers:
Microsoft.DesktopVirtualization- 2024-04-03
Using getWorkspace
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 getWorkspace(args: GetWorkspaceArgs, opts?: InvokeOptions): Promise<GetWorkspaceResult>
function getWorkspaceOutput(args: GetWorkspaceOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceResult>def get_workspace(name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetWorkspaceResult
def get_workspace_output(name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceResult]func LookupWorkspace(ctx *Context, args *LookupWorkspaceArgs, opts ...InvokeOption) (*LookupWorkspaceResult, error)
func LookupWorkspaceOutput(ctx *Context, args *LookupWorkspaceOutputArgs, opts ...InvokeOption) LookupWorkspaceResultOutput> Note: This function is named LookupWorkspace in the Go SDK.
public static class GetWorkspace
{
public static Task<GetWorkspaceResult> InvokeAsync(GetWorkspaceArgs args, InvokeOptions? opts = null)
public static Output<GetWorkspaceResult> Invoke(GetWorkspaceInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)
public static Output<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)
fn::invoke:
function: azure:desktopvirtualization/getWorkspace:getWorkspace
arguments:
# arguments dictionaryThe following arguments are supported:
- Name string
- The name of this Virtual Desktop Workspace to retrieve.
- Resource
Group stringName - The name of the Resource Group where the Virtual Desktop Workspace exists.
- Name string
- The name of this Virtual Desktop Workspace to retrieve.
- Resource
Group stringName - The name of the Resource Group where the Virtual Desktop Workspace exists.
- name String
- The name of this Virtual Desktop Workspace to retrieve.
- resource
Group StringName - The name of the Resource Group where the Virtual Desktop Workspace exists.
- name string
- The name of this Virtual Desktop Workspace to retrieve.
- resource
Group stringName - The name of the Resource Group where the Virtual Desktop Workspace exists.
- name str
- The name of this Virtual Desktop Workspace to retrieve.
- resource_
group_ strname - The name of the Resource Group where the Virtual Desktop Workspace exists.
- name String
- The name of this Virtual Desktop Workspace to retrieve.
- resource
Group StringName - The name of the Resource Group where the Virtual Desktop Workspace exists.
getWorkspace Result
The following output properties are available:
- Description string
- The description for the Virtual Desktop Workspace.
- Friendly
Name string - The friendly name for the Virtual Desktop Workspace.
- Id string
- The provider-assigned unique ID for this managed resource.
- Location string
- The Azure Region where the Virtual Desktop Workspace exists.
- Name string
- Public
Network boolAccess Enabled - Is public network access enabled?
- Resource
Group stringName - Dictionary<string, string>
- A mapping of tags assigned to the Virtual Desktop Workspace.
- Description string
- The description for the Virtual Desktop Workspace.
- Friendly
Name string - The friendly name for the Virtual Desktop Workspace.
- Id string
- The provider-assigned unique ID for this managed resource.
- Location string
- The Azure Region where the Virtual Desktop Workspace exists.
- Name string
- Public
Network boolAccess Enabled - Is public network access enabled?
- Resource
Group stringName - map[string]string
- A mapping of tags assigned to the Virtual Desktop Workspace.
- description String
- The description for the Virtual Desktop Workspace.
- friendly
Name String - The friendly name for the Virtual Desktop Workspace.
- id String
- The provider-assigned unique ID for this managed resource.
- location String
- The Azure Region where the Virtual Desktop Workspace exists.
- name String
- public
Network BooleanAccess Enabled - Is public network access enabled?
- resource
Group StringName - Map<String,String>
- A mapping of tags assigned to the Virtual Desktop Workspace.
- description string
- The description for the Virtual Desktop Workspace.
- friendly
Name string - The friendly name for the Virtual Desktop Workspace.
- id string
- The provider-assigned unique ID for this managed resource.
- location string
- The Azure Region where the Virtual Desktop Workspace exists.
- name string
- public
Network booleanAccess Enabled - Is public network access enabled?
- resource
Group stringName - {[key: string]: string}
- A mapping of tags assigned to the Virtual Desktop Workspace.
- description str
- The description for the Virtual Desktop Workspace.
- friendly_
name str - The friendly name for the Virtual Desktop Workspace.
- id str
- The provider-assigned unique ID for this managed resource.
- location str
- The Azure Region where the Virtual Desktop Workspace exists.
- name str
- public_
network_ boolaccess_ enabled - Is public network access enabled?
- resource_
group_ strname - Mapping[str, str]
- A mapping of tags assigned to the Virtual Desktop Workspace.
- description String
- The description for the Virtual Desktop Workspace.
- friendly
Name String - The friendly name for the Virtual Desktop Workspace.
- id String
- The provider-assigned unique ID for this managed resource.
- location String
- The Azure Region where the Virtual Desktop Workspace exists.
- name String
- public
Network BooleanAccess Enabled - Is public network access enabled?
- resource
Group StringName - Map<String>
- A mapping of tags assigned to the Virtual Desktop Workspace.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurermTerraform Provider.
