1. Packages
  2. Azure Classic
  3. API Docs
  4. monitoring
  5. getWorkspace

We recommend using Azure Native.

Azure Classic v5.67.0 published on Wednesday, Feb 21, 2024 by Pulumi

azure.monitoring.getWorkspace

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.67.0 published on Wednesday, Feb 21, 2024 by Pulumi

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

    Example Usage

    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 = azurerm_resource_group.Example.Name,
        });
    
        return new Dictionary<string, object?>
        {
            ["queryEndpoint"] = example.Apply(getWorkspaceResult => getWorkspaceResult.QueryEndpoint),
        };
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/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: azurerm_resource_group.Example.Name,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("queryEndpoint", example.QueryEndpoint)
    		return nil
    	})
    }
    
    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(azurerm_resource_group.example().name())
                .build());
    
            ctx.export("queryEndpoint", example.applyValue(getWorkspaceResult -> getWorkspaceResult.queryEndpoint()));
        }
    }
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.monitoring.get_workspace(name="example-workspace",
        resource_group_name=azurerm_resource_group["example"]["name"])
    pulumi.export("queryEndpoint", example.query_endpoint)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = azure.monitoring.getWorkspace({
        name: "example-workspace",
        resourceGroupName: azurerm_resource_group.example.name,
    });
    export const queryEndpoint = example.then(example => example.queryEndpoint);
    
    variables:
      example:
        fn::invoke:
          Function: azure:monitoring:getWorkspace
          Arguments:
            name: example-workspace
            resourceGroupName: ${azurerm_resource_group.example.name}
    outputs:
      queryEndpoint: ${example.queryEndpoint}
    

    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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure:monitoring/getWorkspace:getWorkspace
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Specifies the name of the Workspace.
    ResourceGroupName string
    Specifies the name of the resource group the Workspace is located in.
    Name string
    Specifies the name of the Workspace.
    ResourceGroupName string
    Specifies the name of the resource group the Workspace is located in.
    name String
    Specifies the name of the Workspace.
    resourceGroupName String
    Specifies the name of the resource group the Workspace is located in.
    name string
    Specifies the name of the Workspace.
    resourceGroupName string
    Specifies the name of the resource group the Workspace is located in.
    name str
    Specifies the name of the Workspace.
    resource_group_name str
    Specifies the name of the resource group the Workspace is located in.
    name String
    Specifies the name of the Workspace.
    resourceGroupName 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.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.67.0 published on Wednesday, Feb 21, 2024 by Pulumi