Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. monitoring
  5. getWorkspace

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.monitoring.getWorkspace

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Use this data source to access information about an existing Workspace.

Example Usage

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

const example = azure.monitoring.getWorkspace({
    name: "example-workspace",
    resourceGroupName: exampleAzurermResourceGroup.name,
});
export const queryEndpoint = example.then(example => example.queryEndpoint);
Copy
import pulumi
import pulumi_azure as azure

example = azure.monitoring.get_workspace(name="example-workspace",
    resource_group_name=example_azurerm_resource_group["name"])
pulumi.export("queryEndpoint", example.query_endpoint)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/monitoring"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := monitoring.LookupWorkspace(ctx, &monitoring.LookupWorkspaceArgs{
			Name:              "example-workspace",
			ResourceGroupName: exampleAzurermResourceGroup.Name,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("queryEndpoint", example.QueryEndpoint)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.Monitoring.GetWorkspace.Invoke(new()
    {
        Name = "example-workspace",
        ResourceGroupName = exampleAzurermResourceGroup.Name,
    });

    return new Dictionary<string, object?>
    {
        ["queryEndpoint"] = example.Apply(getWorkspaceResult => getWorkspaceResult.QueryEndpoint),
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.monitoring.MonitoringFunctions;
import com.pulumi.azure.monitoring.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 = MonitoringFunctions.getWorkspace(GetWorkspaceArgs.builder()
            .name("example-workspace")
            .resourceGroupName(exampleAzurermResourceGroup.name())
            .build());

        ctx.export("queryEndpoint", example.applyValue(getWorkspaceResult -> getWorkspaceResult.queryEndpoint()));
    }
}
Copy
variables:
  example:
    fn::invoke:
      function: azure:monitoring:getWorkspace
      arguments:
        name: example-workspace
        resourceGroupName: ${exampleAzurermResourceGroup.name}
outputs:
  queryEndpoint: ${example.queryEndpoint}
Copy

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>
Copy
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]
Copy
func LookupWorkspace(ctx *Context, args *LookupWorkspaceArgs, opts ...InvokeOption) (*LookupWorkspaceResult, error)
func LookupWorkspaceOutput(ctx *Context, args *LookupWorkspaceOutputArgs, opts ...InvokeOption) LookupWorkspaceResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)
public static Output<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure:monitoring/getWorkspace:getWorkspace
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Specifies the name of the Workspace.
ResourceGroupName This property is required. string
Specifies the name of the resource group the Workspace is located in.
Name This property is required. string
Specifies the name of the Workspace.
ResourceGroupName This property is required. string
Specifies the name of the resource group the Workspace is located in.
name This property is required. String
Specifies the name of the Workspace.
resourceGroupName This property is required. String
Specifies the name of the resource group the Workspace is located in.
name This property is required. string
Specifies the name of the Workspace.
resourceGroupName This property is required. string
Specifies the name of the resource group the Workspace is located in.
name This property is required. str
Specifies the name of the Workspace.
resource_group_name This property is required. str
Specifies the name of the resource group the Workspace is located in.
name This property is required. String
Specifies the name of the Workspace.
resourceGroupName This property is required. String
Specifies the name of the resource group the Workspace is located in.

getWorkspace Result

The following output properties are available:

DefaultDataCollectionEndpointId string
The ID of the managed default Data Collection Endpoint created with the Azure Monitor Workspace.
DefaultDataCollectionRuleId string
The ID of the managed default Data Collection Rule created with the Azure Monitor Workspace.
Id string
The provider-assigned unique ID for this managed resource.
Location string
The Azure Region where the Workspace is located.
Name string
PublicNetworkAccessEnabled bool
Whether network access from public internet to the Workspace are allowed.
QueryEndpoint string
The query endpoint for the Azure Monitor Workspace.
ResourceGroupName string
Tags Dictionary<string, string>
A mapping of tags that are assigned to the Workspace.
DefaultDataCollectionEndpointId string
The ID of the managed default Data Collection Endpoint created with the Azure Monitor Workspace.
DefaultDataCollectionRuleId string
The ID of the managed default Data Collection Rule created with the Azure Monitor Workspace.
Id string
The provider-assigned unique ID for this managed resource.
Location string
The Azure Region where the Workspace is located.
Name string
PublicNetworkAccessEnabled bool
Whether network access from public internet to the Workspace are allowed.
QueryEndpoint string
The query endpoint for the Azure Monitor Workspace.
ResourceGroupName string
Tags map[string]string
A mapping of tags that are assigned to the Workspace.
defaultDataCollectionEndpointId String
The ID of the managed default Data Collection Endpoint created with the Azure Monitor Workspace.
defaultDataCollectionRuleId String
The ID of the managed default Data Collection Rule created with the Azure Monitor Workspace.
id String
The provider-assigned unique ID for this managed resource.
location String
The Azure Region where the Workspace is located.
name String
publicNetworkAccessEnabled Boolean
Whether network access from public internet to the Workspace are allowed.
queryEndpoint String
The query endpoint for the Azure Monitor Workspace.
resourceGroupName String
tags Map<String,String>
A mapping of tags that are assigned to the Workspace.
defaultDataCollectionEndpointId string
The ID of the managed default Data Collection Endpoint created with the Azure Monitor Workspace.
defaultDataCollectionRuleId string
The ID of the managed default Data Collection Rule created with the Azure Monitor Workspace.
id string
The provider-assigned unique ID for this managed resource.
location string
The Azure Region where the Workspace is located.
name string
publicNetworkAccessEnabled boolean
Whether network access from public internet to the Workspace are allowed.
queryEndpoint string
The query endpoint for the Azure Monitor Workspace.
resourceGroupName string
tags {[key: string]: string}
A mapping of tags that are assigned to the Workspace.
default_data_collection_endpoint_id str
The ID of the managed default Data Collection Endpoint created with the Azure Monitor Workspace.
default_data_collection_rule_id str
The ID of the managed default Data Collection Rule created with the Azure Monitor Workspace.
id str
The provider-assigned unique ID for this managed resource.
location str
The Azure Region where the Workspace is located.
name str
public_network_access_enabled bool
Whether network access from public internet to the Workspace are allowed.
query_endpoint str
The query endpoint for the Azure Monitor Workspace.
resource_group_name str
tags Mapping[str, str]
A mapping of tags that are assigned to the Workspace.
defaultDataCollectionEndpointId String
The ID of the managed default Data Collection Endpoint created with the Azure Monitor Workspace.
defaultDataCollectionRuleId String
The ID of the managed default Data Collection Rule created with the Azure Monitor Workspace.
id String
The provider-assigned unique ID for this managed resource.
location String
The Azure Region where the Workspace is located.
name String
publicNetworkAccessEnabled Boolean
Whether network access from public internet to the Workspace are allowed.
queryEndpoint String
The query endpoint for the Azure Monitor Workspace.
resourceGroupName String
tags Map<String>
A mapping of tags that are assigned to the Workspace.

Package Details

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

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure