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

We recommend using Azure Native.

Azure Classic v5.74.0 published on Monday, Apr 29, 2024 by Pulumi
pulumi/pulumi-azure

azure.monitoring.Workspace

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.74.0 published on Monday, Apr 29, 2024 by Pulumi
pulumi/pulumi-azure

    Manages an Azure Monitor Workspace.

    Example Usage

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

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleWorkspace = new azure.monitoring.Workspace("example", {
    name: "example-mamw",
    resourceGroupName: example.name,
    location: "West Europe",
    tags: {
        key: "value",
    },
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_workspace = azure.monitoring.Workspace("example",
    name="example-mamw",
    resource_group_name=example.name,
    location="West Europe",
    tags={
        "key": "value",
    })

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"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 := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = monitoring.NewWorkspace(ctx, "example", &monitoring.WorkspaceArgs{
			Name:              pulumi.String("example-mamw"),
			ResourceGroupName: example.Name,
			Location:          pulumi.String("West Europe"),
			Tags: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
		})
		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 = "example-resources",
        Location = "West Europe",
    });

    var exampleWorkspace = new Azure.Monitoring.Workspace("example", new()
    {
        Name = "example-mamw",
        ResourceGroupName = example.Name,
        Location = "West Europe",
        Tags = 
        {
            { "key", "value" },
        },
    });

});

    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.monitoring.Workspace;
import com.pulumi.azure.monitoring.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("example-resources")
            .location("West Europe")
            .build());

        var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()        
            .name("example-mamw")
            .resourceGroupName(example.name())
            .location("West Europe")
            .tags(Map.of("key", "value"))
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleWorkspace:
    type: azure:monitoring:Workspace
    name: example
    properties:
      name: example-mamw
      resourceGroupName: ${example.name}
      location: West Europe
      tags:
        key: value

    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,
              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:monitoring: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.

    Example

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

    var exampleworkspaceResourceResourceFromMonitoringworkspace = new Azure.Monitoring.Workspace("exampleworkspaceResourceResourceFromMonitoringworkspace", new()
{
    ResourceGroupName = "string",
    Location = "string",
    Name = "string",
    PublicNetworkAccessEnabled = false,
    Tags = 
    {
        { "string", "string" },
    },
});

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

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

    exampleworkspace_resource_resource_from_monitoringworkspace = azure.monitoring.Workspace("exampleworkspaceResourceResourceFromMonitoringworkspace",
    resource_group_name="string",
    location="string",
    name="string",
    public_network_access_enabled=False,
    tags={
        "string": "string",
    })

    const exampleworkspaceResourceResourceFromMonitoringworkspace = new azure.monitoring.Workspace("exampleworkspaceResourceResourceFromMonitoringworkspace", {
    resourceGroupName: "string",
    location: "string",
    name: "string",
    publicNetworkAccessEnabled: false,
    tags: {
        string: "string",
    },
});

    type: azure:monitoring:Workspace
properties:
    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

    The Workspace resource accepts the following input properties:

    ResourceGroupName string
    Specifies the name of the Resource Group where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    Location string
    Specifies the Azure Region where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    Name string
    Specifies the name which should be used for this Azure Monitor Workspace. Changing this forces a new resource to be created.
    PublicNetworkAccessEnabled bool
    Is public network access enabled? Defaults to true.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Azure Monitor Workspace.
    ResourceGroupName string
    Specifies the name of the Resource Group where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    Location string
    Specifies the Azure Region where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    Name string
    Specifies the name which should be used for this Azure Monitor Workspace. Changing this forces a new resource to be created.
    PublicNetworkAccessEnabled bool
    Is public network access enabled? Defaults to true.
    Tags map[string]string
    A mapping of tags which should be assigned to the Azure Monitor Workspace.
    resourceGroupName String
    Specifies the name of the Resource Group where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    location String
    Specifies the Azure Region where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    name String
    Specifies the name which should be used for this Azure Monitor Workspace. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled Boolean
    Is public network access enabled? Defaults to true.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Azure Monitor Workspace.
    resourceGroupName string
    Specifies the name of the Resource Group where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    location string
    Specifies the Azure Region where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    name string
    Specifies the name which should be used for this Azure Monitor Workspace. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled boolean
    Is public network access enabled? Defaults to true.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Azure Monitor Workspace.
    resource_group_name str
    Specifies the name of the Resource Group where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    location str
    Specifies the Azure Region where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    name str
    Specifies the name which should be used for this Azure Monitor Workspace. Changing this forces a new resource to be created.
    public_network_access_enabled bool
    Is public network access enabled? Defaults to true.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Azure Monitor Workspace.
    resourceGroupName String
    Specifies the name of the Resource Group where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    location String
    Specifies the Azure Region where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    name String
    Specifies the name which should be used for this Azure Monitor Workspace. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled Boolean
    Is public network access enabled? Defaults to true.
    tags Map<String>
    A mapping of tags which should be assigned to the Azure Monitor Workspace.

    Outputs

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

    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.
    QueryEndpoint string
    The query endpoint for the Azure Monitor 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.
    QueryEndpoint string
    The query endpoint for the Azure Monitor 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.
    queryEndpoint String
    The query endpoint for the Azure Monitor 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.
    queryEndpoint string
    The query endpoint for the Azure Monitor 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.
    query_endpoint str
    The query endpoint for the Azure Monitor 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.
    queryEndpoint String
    The query endpoint for the Azure Monitor Workspace.

    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,
        default_data_collection_endpoint_id: Optional[str] = None,
        default_data_collection_rule_id: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        public_network_access_enabled: Optional[bool] = None,
        query_endpoint: 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:
    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.
    Location string
    Specifies the Azure Region where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    Name string
    Specifies the name which should be used for this Azure Monitor Workspace. Changing this forces a new resource to be created.
    PublicNetworkAccessEnabled bool
    Is public network access enabled? Defaults to true.
    QueryEndpoint string
    The query endpoint for the Azure Monitor Workspace.
    ResourceGroupName string
    Specifies the name of the Resource Group where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Azure Monitor 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.
    Location string
    Specifies the Azure Region where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    Name string
    Specifies the name which should be used for this Azure Monitor Workspace. Changing this forces a new resource to be created.
    PublicNetworkAccessEnabled bool
    Is public network access enabled? Defaults to true.
    QueryEndpoint string
    The query endpoint for the Azure Monitor Workspace.
    ResourceGroupName string
    Specifies the name of the Resource Group where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Azure Monitor 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.
    location String
    Specifies the Azure Region where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    name String
    Specifies the name which should be used for this Azure Monitor Workspace. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled Boolean
    Is public network access enabled? Defaults to true.
    queryEndpoint String
    The query endpoint for the Azure Monitor Workspace.
    resourceGroupName String
    Specifies the name of the Resource Group where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Azure Monitor 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.
    location string
    Specifies the Azure Region where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    name string
    Specifies the name which should be used for this Azure Monitor Workspace. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled boolean
    Is public network access enabled? Defaults to true.
    queryEndpoint string
    The query endpoint for the Azure Monitor Workspace.
    resourceGroupName string
    Specifies the name of the Resource Group where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Azure Monitor 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.
    location str
    Specifies the Azure Region where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    name str
    Specifies the name which should be used for this Azure Monitor Workspace. Changing this forces a new resource to be created.
    public_network_access_enabled bool
    Is public network access enabled? Defaults to true.
    query_endpoint str
    The query endpoint for the Azure Monitor Workspace.
    resource_group_name str
    Specifies the name of the Resource Group where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Azure Monitor 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.
    location String
    Specifies the Azure Region where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    name String
    Specifies the name which should be used for this Azure Monitor Workspace. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled Boolean
    Is public network access enabled? Defaults to true.
    queryEndpoint String
    The query endpoint for the Azure Monitor Workspace.
    resourceGroupName String
    Specifies the name of the Resource Group where the Azure Monitor Workspace should exist. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Azure Monitor Workspace.

    Import

    Azure Monitor Workspace can be imported using the resource id, e.g.

    $ pulumi import azure:monitoring/workspace:Workspace example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Monitor/accounts/azureMonitorWorkspace1

    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 Classic v5.74.0 published on Monday, Apr 29, 2024 by Pulumi
    pulumi/pulumi-azure