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

We recommend using Azure Native.

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

azure.operationalinsights.AnalyticsWorkspace

Explore with Pulumi AI

We recommend using Azure Native.

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

Manages a Log Analytics (formally Operational Insights) 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 exampleAnalyticsWorkspace = new azure.operationalinsights.AnalyticsWorkspace("example", {
    name: "example",
    location: example.location,
    resourceGroupName: example.name,
    sku: "PerGB2018",
    retentionInDays: 30,
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_analytics_workspace = azure.operationalinsights.AnalyticsWorkspace("example",
    name="example",
    location=example.location,
    resource_group_name=example.name,
    sku="PerGB2018",
    retention_in_days=30)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/operationalinsights"
	"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 = operationalinsights.NewAnalyticsWorkspace(ctx, "example", &operationalinsights.AnalyticsWorkspaceArgs{
			Name:              pulumi.String("example"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Sku:               pulumi.String("PerGB2018"),
			RetentionInDays:   pulumi.Int(30),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 exampleAnalyticsWorkspace = new Azure.OperationalInsights.AnalyticsWorkspace("example", new()
    {
        Name = "example",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Sku = "PerGB2018",
        RetentionInDays = 30,
    });

});
Copy
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.operationalinsights.AnalyticsWorkspace;
import com.pulumi.azure.operationalinsights.AnalyticsWorkspaceArgs;
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 exampleAnalyticsWorkspace = new AnalyticsWorkspace("exampleAnalyticsWorkspace", AnalyticsWorkspaceArgs.builder()
            .name("example")
            .location(example.location())
            .resourceGroupName(example.name())
            .sku("PerGB2018")
            .retentionInDays(30)
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleAnalyticsWorkspace:
    type: azure:operationalinsights:AnalyticsWorkspace
    name: example
    properties:
      name: example
      location: ${example.location}
      resourceGroupName: ${example.name}
      sku: PerGB2018
      retentionInDays: 30
Copy

Create AnalyticsWorkspace Resource

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

Constructor syntax

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

@overload
def AnalyticsWorkspace(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       resource_group_name: Optional[str] = None,
                       identity: Optional[AnalyticsWorkspaceIdentityArgs] = None,
                       location: Optional[str] = None,
                       data_collection_rule_id: Optional[str] = None,
                       allow_resource_only_permissions: Optional[bool] = None,
                       immediate_data_purge_on30_days_enabled: Optional[bool] = None,
                       internet_ingestion_enabled: Optional[bool] = None,
                       daily_quota_gb: Optional[float] = None,
                       local_authentication_disabled: Optional[bool] = None,
                       internet_query_enabled: Optional[bool] = None,
                       name: Optional[str] = None,
                       reservation_capacity_in_gb_per_day: Optional[int] = None,
                       cmk_for_query_forced: Optional[bool] = None,
                       retention_in_days: Optional[int] = None,
                       sku: Optional[str] = None,
                       tags: Optional[Mapping[str, str]] = None)
func NewAnalyticsWorkspace(ctx *Context, name string, args AnalyticsWorkspaceArgs, opts ...ResourceOption) (*AnalyticsWorkspace, error)
public AnalyticsWorkspace(string name, AnalyticsWorkspaceArgs args, CustomResourceOptions? opts = null)
public AnalyticsWorkspace(String name, AnalyticsWorkspaceArgs args)
public AnalyticsWorkspace(String name, AnalyticsWorkspaceArgs args, CustomResourceOptions options)

type: azure:operationalinsights:AnalyticsWorkspace
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AnalyticsWorkspaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AnalyticsWorkspaceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AnalyticsWorkspaceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AnalyticsWorkspaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AnalyticsWorkspaceArgs
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 analyticsWorkspaceResource = new Azure.OperationalInsights.AnalyticsWorkspace("analyticsWorkspaceResource", new()
{
    ResourceGroupName = "string",
    Identity = new Azure.OperationalInsights.Inputs.AnalyticsWorkspaceIdentityArgs
    {
        Type = "string",
        IdentityIds = new[]
        {
            "string",
        },
        PrincipalId = "string",
        TenantId = "string",
    },
    Location = "string",
    DataCollectionRuleId = "string",
    AllowResourceOnlyPermissions = false,
    ImmediateDataPurgeOn30DaysEnabled = false,
    InternetIngestionEnabled = false,
    DailyQuotaGb = 0,
    LocalAuthenticationDisabled = false,
    InternetQueryEnabled = false,
    Name = "string",
    ReservationCapacityInGbPerDay = 0,
    CmkForQueryForced = false,
    RetentionInDays = 0,
    Sku = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := operationalinsights.NewAnalyticsWorkspace(ctx, "analyticsWorkspaceResource", &operationalinsights.AnalyticsWorkspaceArgs{
	ResourceGroupName: pulumi.String("string"),
	Identity: &operationalinsights.AnalyticsWorkspaceIdentityArgs{
		Type: pulumi.String("string"),
		IdentityIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	Location:                          pulumi.String("string"),
	DataCollectionRuleId:              pulumi.String("string"),
	AllowResourceOnlyPermissions:      pulumi.Bool(false),
	ImmediateDataPurgeOn30DaysEnabled: pulumi.Bool(false),
	InternetIngestionEnabled:          pulumi.Bool(false),
	DailyQuotaGb:                      pulumi.Float64(0),
	LocalAuthenticationDisabled:       pulumi.Bool(false),
	InternetQueryEnabled:              pulumi.Bool(false),
	Name:                              pulumi.String("string"),
	ReservationCapacityInGbPerDay:     pulumi.Int(0),
	CmkForQueryForced:                 pulumi.Bool(false),
	RetentionInDays:                   pulumi.Int(0),
	Sku:                               pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var analyticsWorkspaceResource = new AnalyticsWorkspace("analyticsWorkspaceResource", AnalyticsWorkspaceArgs.builder()
    .resourceGroupName("string")
    .identity(AnalyticsWorkspaceIdentityArgs.builder()
        .type("string")
        .identityIds("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .location("string")
    .dataCollectionRuleId("string")
    .allowResourceOnlyPermissions(false)
    .immediateDataPurgeOn30DaysEnabled(false)
    .internetIngestionEnabled(false)
    .dailyQuotaGb(0)
    .localAuthenticationDisabled(false)
    .internetQueryEnabled(false)
    .name("string")
    .reservationCapacityInGbPerDay(0)
    .cmkForQueryForced(false)
    .retentionInDays(0)
    .sku("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
analytics_workspace_resource = azure.operationalinsights.AnalyticsWorkspace("analyticsWorkspaceResource",
    resource_group_name="string",
    identity={
        "type": "string",
        "identity_ids": ["string"],
        "principal_id": "string",
        "tenant_id": "string",
    },
    location="string",
    data_collection_rule_id="string",
    allow_resource_only_permissions=False,
    immediate_data_purge_on30_days_enabled=False,
    internet_ingestion_enabled=False,
    daily_quota_gb=0,
    local_authentication_disabled=False,
    internet_query_enabled=False,
    name="string",
    reservation_capacity_in_gb_per_day=0,
    cmk_for_query_forced=False,
    retention_in_days=0,
    sku="string",
    tags={
        "string": "string",
    })
Copy
const analyticsWorkspaceResource = new azure.operationalinsights.AnalyticsWorkspace("analyticsWorkspaceResource", {
    resourceGroupName: "string",
    identity: {
        type: "string",
        identityIds: ["string"],
        principalId: "string",
        tenantId: "string",
    },
    location: "string",
    dataCollectionRuleId: "string",
    allowResourceOnlyPermissions: false,
    immediateDataPurgeOn30DaysEnabled: false,
    internetIngestionEnabled: false,
    dailyQuotaGb: 0,
    localAuthenticationDisabled: false,
    internetQueryEnabled: false,
    name: "string",
    reservationCapacityInGbPerDay: 0,
    cmkForQueryForced: false,
    retentionInDays: 0,
    sku: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure:operationalinsights:AnalyticsWorkspace
properties:
    allowResourceOnlyPermissions: false
    cmkForQueryForced: false
    dailyQuotaGb: 0
    dataCollectionRuleId: string
    identity:
        identityIds:
            - string
        principalId: string
        tenantId: string
        type: string
    immediateDataPurgeOn30DaysEnabled: false
    internetIngestionEnabled: false
    internetQueryEnabled: false
    localAuthenticationDisabled: false
    location: string
    name: string
    reservationCapacityInGbPerDay: 0
    resourceGroupName: string
    retentionInDays: 0
    sku: string
    tags:
        string: string
Copy

AnalyticsWorkspace 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 AnalyticsWorkspace resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.
AllowResourceOnlyPermissions bool
Specifies if the log Analytics Workspace allow users accessing to data associated with resources they have permission to view, without permission to workspace. Defaults to true.
CmkForQueryForced bool
Is Customer Managed Storage mandatory for query management?
DailyQuotaGb double
The workspace daily quota for ingestion in GB. Defaults to -1 (unlimited) if omitted.
DataCollectionRuleId string
The ID of the Data Collection Rule to use for this workspace.
Identity AnalyticsWorkspaceIdentity
An identity block as defined below.
ImmediateDataPurgeOn30DaysEnabled bool
Whether to remove the data in the Log Analytics Workspace immediately after 30 days.
InternetIngestionEnabled bool
Should the Log Analytics Workspace support ingestion over the Public Internet? Defaults to true.
InternetQueryEnabled bool
Should the Log Analytics Workspace support querying over the Public Internet? Defaults to true.
LocalAuthenticationDisabled bool
Specifies if the log Analytics workspace should enforce authentication using Azure AD. Defaults to false.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Log Analytics Workspace. Workspace name should include 4-63 letters, digits or '-'. The '-' shouldn't be the first or the last symbol. Changing this forces a new resource to be created.
ReservationCapacityInGbPerDay int

The capacity reservation level in GB for this workspace. Possible values are 100, 200, 300, 400, 500, 1000, 2000 and 5000.

Note: reservation_capacity_in_gb_per_day can only be used when the sku is set to CapacityReservation.

RetentionInDays int
The workspace data retention in days. Possible values are between 30 and 730.
Sku string

Specifies the SKU of the Log Analytics Workspace. Possible values are PerNode, Premium, Standard, Standalone, Unlimited, CapacityReservation, PerGB2018, and LACluster. Defaults to PerGB2018.

Note: sku should only be set to LACluster when the Log Analytics Workspace is linked to a Log Analytics Cluster. Additionally, sku cannot be modified while linked.

Note: Changing sku forces a new Log Analytics Workspace to be created, except when changing between PerGB2018 and CapacityReservation. Changing sku to CapacityReservation or changing reservation_capacity_in_gb_per_day to a higher tier will lead to a 31-days commitment period, during which the SKU cannot be changed to a lower one. Please refer to official documentation for further information.

Note: A new pricing model took effect on 2018-04-03, which requires the SKU PerGB2018. If you've provisioned resources before this date you have the option of remaining with the previous Pricing SKU and using the other SKUs defined above. More information about the Pricing SKUs is available at the following URI.

Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.
AllowResourceOnlyPermissions bool
Specifies if the log Analytics Workspace allow users accessing to data associated with resources they have permission to view, without permission to workspace. Defaults to true.
CmkForQueryForced bool
Is Customer Managed Storage mandatory for query management?
DailyQuotaGb float64
The workspace daily quota for ingestion in GB. Defaults to -1 (unlimited) if omitted.
DataCollectionRuleId string
The ID of the Data Collection Rule to use for this workspace.
Identity AnalyticsWorkspaceIdentityArgs
An identity block as defined below.
ImmediateDataPurgeOn30DaysEnabled bool
Whether to remove the data in the Log Analytics Workspace immediately after 30 days.
InternetIngestionEnabled bool
Should the Log Analytics Workspace support ingestion over the Public Internet? Defaults to true.
InternetQueryEnabled bool
Should the Log Analytics Workspace support querying over the Public Internet? Defaults to true.
LocalAuthenticationDisabled bool
Specifies if the log Analytics workspace should enforce authentication using Azure AD. Defaults to false.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Log Analytics Workspace. Workspace name should include 4-63 letters, digits or '-'. The '-' shouldn't be the first or the last symbol. Changing this forces a new resource to be created.
ReservationCapacityInGbPerDay int

The capacity reservation level in GB for this workspace. Possible values are 100, 200, 300, 400, 500, 1000, 2000 and 5000.

Note: reservation_capacity_in_gb_per_day can only be used when the sku is set to CapacityReservation.

RetentionInDays int
The workspace data retention in days. Possible values are between 30 and 730.
Sku string

Specifies the SKU of the Log Analytics Workspace. Possible values are PerNode, Premium, Standard, Standalone, Unlimited, CapacityReservation, PerGB2018, and LACluster. Defaults to PerGB2018.

Note: sku should only be set to LACluster when the Log Analytics Workspace is linked to a Log Analytics Cluster. Additionally, sku cannot be modified while linked.

Note: Changing sku forces a new Log Analytics Workspace to be created, except when changing between PerGB2018 and CapacityReservation. Changing sku to CapacityReservation or changing reservation_capacity_in_gb_per_day to a higher tier will lead to a 31-days commitment period, during which the SKU cannot be changed to a lower one. Please refer to official documentation for further information.

Note: A new pricing model took effect on 2018-04-03, which requires the SKU PerGB2018. If you've provisioned resources before this date you have the option of remaining with the previous Pricing SKU and using the other SKUs defined above. More information about the Pricing SKUs is available at the following URI.

Tags map[string]string
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.
allowResourceOnlyPermissions Boolean
Specifies if the log Analytics Workspace allow users accessing to data associated with resources they have permission to view, without permission to workspace. Defaults to true.
cmkForQueryForced Boolean
Is Customer Managed Storage mandatory for query management?
dailyQuotaGb Double
The workspace daily quota for ingestion in GB. Defaults to -1 (unlimited) if omitted.
dataCollectionRuleId String
The ID of the Data Collection Rule to use for this workspace.
identity AnalyticsWorkspaceIdentity
An identity block as defined below.
immediateDataPurgeOn30DaysEnabled Boolean
Whether to remove the data in the Log Analytics Workspace immediately after 30 days.
internetIngestionEnabled Boolean
Should the Log Analytics Workspace support ingestion over the Public Internet? Defaults to true.
internetQueryEnabled Boolean
Should the Log Analytics Workspace support querying over the Public Internet? Defaults to true.
localAuthenticationDisabled Boolean
Specifies if the log Analytics workspace should enforce authentication using Azure AD. Defaults to false.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Log Analytics Workspace. Workspace name should include 4-63 letters, digits or '-'. The '-' shouldn't be the first or the last symbol. Changing this forces a new resource to be created.
reservationCapacityInGbPerDay Integer

The capacity reservation level in GB for this workspace. Possible values are 100, 200, 300, 400, 500, 1000, 2000 and 5000.

Note: reservation_capacity_in_gb_per_day can only be used when the sku is set to CapacityReservation.

retentionInDays Integer
The workspace data retention in days. Possible values are between 30 and 730.
sku String

Specifies the SKU of the Log Analytics Workspace. Possible values are PerNode, Premium, Standard, Standalone, Unlimited, CapacityReservation, PerGB2018, and LACluster. Defaults to PerGB2018.

Note: sku should only be set to LACluster when the Log Analytics Workspace is linked to a Log Analytics Cluster. Additionally, sku cannot be modified while linked.

Note: Changing sku forces a new Log Analytics Workspace to be created, except when changing between PerGB2018 and CapacityReservation. Changing sku to CapacityReservation or changing reservation_capacity_in_gb_per_day to a higher tier will lead to a 31-days commitment period, during which the SKU cannot be changed to a lower one. Please refer to official documentation for further information.

Note: A new pricing model took effect on 2018-04-03, which requires the SKU PerGB2018. If you've provisioned resources before this date you have the option of remaining with the previous Pricing SKU and using the other SKUs defined above. More information about the Pricing SKUs is available at the following URI.

tags Map<String,String>
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.
allowResourceOnlyPermissions boolean
Specifies if the log Analytics Workspace allow users accessing to data associated with resources they have permission to view, without permission to workspace. Defaults to true.
cmkForQueryForced boolean
Is Customer Managed Storage mandatory for query management?
dailyQuotaGb number
The workspace daily quota for ingestion in GB. Defaults to -1 (unlimited) if omitted.
dataCollectionRuleId string
The ID of the Data Collection Rule to use for this workspace.
identity AnalyticsWorkspaceIdentity
An identity block as defined below.
immediateDataPurgeOn30DaysEnabled boolean
Whether to remove the data in the Log Analytics Workspace immediately after 30 days.
internetIngestionEnabled boolean
Should the Log Analytics Workspace support ingestion over the Public Internet? Defaults to true.
internetQueryEnabled boolean
Should the Log Analytics Workspace support querying over the Public Internet? Defaults to true.
localAuthenticationDisabled boolean
Specifies if the log Analytics workspace should enforce authentication using Azure AD. Defaults to false.
location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the Log Analytics Workspace. Workspace name should include 4-63 letters, digits or '-'. The '-' shouldn't be the first or the last symbol. Changing this forces a new resource to be created.
reservationCapacityInGbPerDay number

The capacity reservation level in GB for this workspace. Possible values are 100, 200, 300, 400, 500, 1000, 2000 and 5000.

Note: reservation_capacity_in_gb_per_day can only be used when the sku is set to CapacityReservation.

retentionInDays number
The workspace data retention in days. Possible values are between 30 and 730.
sku string

Specifies the SKU of the Log Analytics Workspace. Possible values are PerNode, Premium, Standard, Standalone, Unlimited, CapacityReservation, PerGB2018, and LACluster. Defaults to PerGB2018.

Note: sku should only be set to LACluster when the Log Analytics Workspace is linked to a Log Analytics Cluster. Additionally, sku cannot be modified while linked.

Note: Changing sku forces a new Log Analytics Workspace to be created, except when changing between PerGB2018 and CapacityReservation. Changing sku to CapacityReservation or changing reservation_capacity_in_gb_per_day to a higher tier will lead to a 31-days commitment period, during which the SKU cannot be changed to a lower one. Please refer to official documentation for further information.

Note: A new pricing model took effect on 2018-04-03, which requires the SKU PerGB2018. If you've provisioned resources before this date you have the option of remaining with the previous Pricing SKU and using the other SKUs defined above. More information about the Pricing SKUs is available at the following URI.

tags {[key: string]: string}
A mapping of tags to assign to the resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.
allow_resource_only_permissions bool
Specifies if the log Analytics Workspace allow users accessing to data associated with resources they have permission to view, without permission to workspace. Defaults to true.
cmk_for_query_forced bool
Is Customer Managed Storage mandatory for query management?
daily_quota_gb float
The workspace daily quota for ingestion in GB. Defaults to -1 (unlimited) if omitted.
data_collection_rule_id str
The ID of the Data Collection Rule to use for this workspace.
identity AnalyticsWorkspaceIdentityArgs
An identity block as defined below.
immediate_data_purge_on30_days_enabled bool
Whether to remove the data in the Log Analytics Workspace immediately after 30 days.
internet_ingestion_enabled bool
Should the Log Analytics Workspace support ingestion over the Public Internet? Defaults to true.
internet_query_enabled bool
Should the Log Analytics Workspace support querying over the Public Internet? Defaults to true.
local_authentication_disabled bool
Specifies if the log Analytics workspace should enforce authentication using Azure AD. Defaults to false.
location Changes to this property will trigger replacement. str
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the Log Analytics Workspace. Workspace name should include 4-63 letters, digits or '-'. The '-' shouldn't be the first or the last symbol. Changing this forces a new resource to be created.
reservation_capacity_in_gb_per_day int

The capacity reservation level in GB for this workspace. Possible values are 100, 200, 300, 400, 500, 1000, 2000 and 5000.

Note: reservation_capacity_in_gb_per_day can only be used when the sku is set to CapacityReservation.

retention_in_days int
The workspace data retention in days. Possible values are between 30 and 730.
sku str

Specifies the SKU of the Log Analytics Workspace. Possible values are PerNode, Premium, Standard, Standalone, Unlimited, CapacityReservation, PerGB2018, and LACluster. Defaults to PerGB2018.

Note: sku should only be set to LACluster when the Log Analytics Workspace is linked to a Log Analytics Cluster. Additionally, sku cannot be modified while linked.

Note: Changing sku forces a new Log Analytics Workspace to be created, except when changing between PerGB2018 and CapacityReservation. Changing sku to CapacityReservation or changing reservation_capacity_in_gb_per_day to a higher tier will lead to a 31-days commitment period, during which the SKU cannot be changed to a lower one. Please refer to official documentation for further information.

Note: A new pricing model took effect on 2018-04-03, which requires the SKU PerGB2018. If you've provisioned resources before this date you have the option of remaining with the previous Pricing SKU and using the other SKUs defined above. More information about the Pricing SKUs is available at the following URI.

tags Mapping[str, str]
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.
allowResourceOnlyPermissions Boolean
Specifies if the log Analytics Workspace allow users accessing to data associated with resources they have permission to view, without permission to workspace. Defaults to true.
cmkForQueryForced Boolean
Is Customer Managed Storage mandatory for query management?
dailyQuotaGb Number
The workspace daily quota for ingestion in GB. Defaults to -1 (unlimited) if omitted.
dataCollectionRuleId String
The ID of the Data Collection Rule to use for this workspace.
identity Property Map
An identity block as defined below.
immediateDataPurgeOn30DaysEnabled Boolean
Whether to remove the data in the Log Analytics Workspace immediately after 30 days.
internetIngestionEnabled Boolean
Should the Log Analytics Workspace support ingestion over the Public Internet? Defaults to true.
internetQueryEnabled Boolean
Should the Log Analytics Workspace support querying over the Public Internet? Defaults to true.
localAuthenticationDisabled Boolean
Specifies if the log Analytics workspace should enforce authentication using Azure AD. Defaults to false.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Log Analytics Workspace. Workspace name should include 4-63 letters, digits or '-'. The '-' shouldn't be the first or the last symbol. Changing this forces a new resource to be created.
reservationCapacityInGbPerDay Number

The capacity reservation level in GB for this workspace. Possible values are 100, 200, 300, 400, 500, 1000, 2000 and 5000.

Note: reservation_capacity_in_gb_per_day can only be used when the sku is set to CapacityReservation.

retentionInDays Number
The workspace data retention in days. Possible values are between 30 and 730.
sku String

Specifies the SKU of the Log Analytics Workspace. Possible values are PerNode, Premium, Standard, Standalone, Unlimited, CapacityReservation, PerGB2018, and LACluster. Defaults to PerGB2018.

Note: sku should only be set to LACluster when the Log Analytics Workspace is linked to a Log Analytics Cluster. Additionally, sku cannot be modified while linked.

Note: Changing sku forces a new Log Analytics Workspace to be created, except when changing between PerGB2018 and CapacityReservation. Changing sku to CapacityReservation or changing reservation_capacity_in_gb_per_day to a higher tier will lead to a 31-days commitment period, during which the SKU cannot be changed to a lower one. Please refer to official documentation for further information.

Note: A new pricing model took effect on 2018-04-03, which requires the SKU PerGB2018. If you've provisioned resources before this date you have the option of remaining with the previous Pricing SKU and using the other SKUs defined above. More information about the Pricing SKUs is available at the following URI.

tags Map<String>
A mapping of tags to assign to the resource.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
PrimarySharedKey string
The Primary shared key for the Log Analytics Workspace.
SecondarySharedKey string
The Secondary shared key for the Log Analytics Workspace.
WorkspaceId string
The Workspace (or Customer) ID for the Log Analytics Workspace.
Id string
The provider-assigned unique ID for this managed resource.
PrimarySharedKey string
The Primary shared key for the Log Analytics Workspace.
SecondarySharedKey string
The Secondary shared key for the Log Analytics Workspace.
WorkspaceId string
The Workspace (or Customer) ID for the Log Analytics Workspace.
id String
The provider-assigned unique ID for this managed resource.
primarySharedKey String
The Primary shared key for the Log Analytics Workspace.
secondarySharedKey String
The Secondary shared key for the Log Analytics Workspace.
workspaceId String
The Workspace (or Customer) ID for the Log Analytics Workspace.
id string
The provider-assigned unique ID for this managed resource.
primarySharedKey string
The Primary shared key for the Log Analytics Workspace.
secondarySharedKey string
The Secondary shared key for the Log Analytics Workspace.
workspaceId string
The Workspace (or Customer) ID for the Log Analytics Workspace.
id str
The provider-assigned unique ID for this managed resource.
primary_shared_key str
The Primary shared key for the Log Analytics Workspace.
secondary_shared_key str
The Secondary shared key for the Log Analytics Workspace.
workspace_id str
The Workspace (or Customer) ID for the Log Analytics Workspace.
id String
The provider-assigned unique ID for this managed resource.
primarySharedKey String
The Primary shared key for the Log Analytics Workspace.
secondarySharedKey String
The Secondary shared key for the Log Analytics Workspace.
workspaceId String
The Workspace (or Customer) ID for the Log Analytics Workspace.

Look up Existing AnalyticsWorkspace Resource

Get an existing AnalyticsWorkspace 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?: AnalyticsWorkspaceState, opts?: CustomResourceOptions): AnalyticsWorkspace
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_resource_only_permissions: Optional[bool] = None,
        cmk_for_query_forced: Optional[bool] = None,
        daily_quota_gb: Optional[float] = None,
        data_collection_rule_id: Optional[str] = None,
        identity: Optional[AnalyticsWorkspaceIdentityArgs] = None,
        immediate_data_purge_on30_days_enabled: Optional[bool] = None,
        internet_ingestion_enabled: Optional[bool] = None,
        internet_query_enabled: Optional[bool] = None,
        local_authentication_disabled: Optional[bool] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        primary_shared_key: Optional[str] = None,
        reservation_capacity_in_gb_per_day: Optional[int] = None,
        resource_group_name: Optional[str] = None,
        retention_in_days: Optional[int] = None,
        secondary_shared_key: Optional[str] = None,
        sku: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        workspace_id: Optional[str] = None) -> AnalyticsWorkspace
func GetAnalyticsWorkspace(ctx *Context, name string, id IDInput, state *AnalyticsWorkspaceState, opts ...ResourceOption) (*AnalyticsWorkspace, error)
public static AnalyticsWorkspace Get(string name, Input<string> id, AnalyticsWorkspaceState? state, CustomResourceOptions? opts = null)
public static AnalyticsWorkspace get(String name, Output<String> id, AnalyticsWorkspaceState state, CustomResourceOptions options)
resources:  _:    type: azure:operationalinsights:AnalyticsWorkspace    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AllowResourceOnlyPermissions bool
Specifies if the log Analytics Workspace allow users accessing to data associated with resources they have permission to view, without permission to workspace. Defaults to true.
CmkForQueryForced bool
Is Customer Managed Storage mandatory for query management?
DailyQuotaGb double
The workspace daily quota for ingestion in GB. Defaults to -1 (unlimited) if omitted.
DataCollectionRuleId string
The ID of the Data Collection Rule to use for this workspace.
Identity AnalyticsWorkspaceIdentity
An identity block as defined below.
ImmediateDataPurgeOn30DaysEnabled bool
Whether to remove the data in the Log Analytics Workspace immediately after 30 days.
InternetIngestionEnabled bool
Should the Log Analytics Workspace support ingestion over the Public Internet? Defaults to true.
InternetQueryEnabled bool
Should the Log Analytics Workspace support querying over the Public Internet? Defaults to true.
LocalAuthenticationDisabled bool
Specifies if the log Analytics workspace should enforce authentication using Azure AD. Defaults to false.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Log Analytics Workspace. Workspace name should include 4-63 letters, digits or '-'. The '-' shouldn't be the first or the last symbol. Changing this forces a new resource to be created.
PrimarySharedKey string
The Primary shared key for the Log Analytics Workspace.
ReservationCapacityInGbPerDay int

The capacity reservation level in GB for this workspace. Possible values are 100, 200, 300, 400, 500, 1000, 2000 and 5000.

Note: reservation_capacity_in_gb_per_day can only be used when the sku is set to CapacityReservation.

ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.
RetentionInDays int
The workspace data retention in days. Possible values are between 30 and 730.
SecondarySharedKey string
The Secondary shared key for the Log Analytics Workspace.
Sku string

Specifies the SKU of the Log Analytics Workspace. Possible values are PerNode, Premium, Standard, Standalone, Unlimited, CapacityReservation, PerGB2018, and LACluster. Defaults to PerGB2018.

Note: sku should only be set to LACluster when the Log Analytics Workspace is linked to a Log Analytics Cluster. Additionally, sku cannot be modified while linked.

Note: Changing sku forces a new Log Analytics Workspace to be created, except when changing between PerGB2018 and CapacityReservation. Changing sku to CapacityReservation or changing reservation_capacity_in_gb_per_day to a higher tier will lead to a 31-days commitment period, during which the SKU cannot be changed to a lower one. Please refer to official documentation for further information.

Note: A new pricing model took effect on 2018-04-03, which requires the SKU PerGB2018. If you've provisioned resources before this date you have the option of remaining with the previous Pricing SKU and using the other SKUs defined above. More information about the Pricing SKUs is available at the following URI.

Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
WorkspaceId string
The Workspace (or Customer) ID for the Log Analytics Workspace.
AllowResourceOnlyPermissions bool
Specifies if the log Analytics Workspace allow users accessing to data associated with resources they have permission to view, without permission to workspace. Defaults to true.
CmkForQueryForced bool
Is Customer Managed Storage mandatory for query management?
DailyQuotaGb float64
The workspace daily quota for ingestion in GB. Defaults to -1 (unlimited) if omitted.
DataCollectionRuleId string
The ID of the Data Collection Rule to use for this workspace.
Identity AnalyticsWorkspaceIdentityArgs
An identity block as defined below.
ImmediateDataPurgeOn30DaysEnabled bool
Whether to remove the data in the Log Analytics Workspace immediately after 30 days.
InternetIngestionEnabled bool
Should the Log Analytics Workspace support ingestion over the Public Internet? Defaults to true.
InternetQueryEnabled bool
Should the Log Analytics Workspace support querying over the Public Internet? Defaults to true.
LocalAuthenticationDisabled bool
Specifies if the log Analytics workspace should enforce authentication using Azure AD. Defaults to false.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Log Analytics Workspace. Workspace name should include 4-63 letters, digits or '-'. The '-' shouldn't be the first or the last symbol. Changing this forces a new resource to be created.
PrimarySharedKey string
The Primary shared key for the Log Analytics Workspace.
ReservationCapacityInGbPerDay int

The capacity reservation level in GB for this workspace. Possible values are 100, 200, 300, 400, 500, 1000, 2000 and 5000.

Note: reservation_capacity_in_gb_per_day can only be used when the sku is set to CapacityReservation.

ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.
RetentionInDays int
The workspace data retention in days. Possible values are between 30 and 730.
SecondarySharedKey string
The Secondary shared key for the Log Analytics Workspace.
Sku string

Specifies the SKU of the Log Analytics Workspace. Possible values are PerNode, Premium, Standard, Standalone, Unlimited, CapacityReservation, PerGB2018, and LACluster. Defaults to PerGB2018.

Note: sku should only be set to LACluster when the Log Analytics Workspace is linked to a Log Analytics Cluster. Additionally, sku cannot be modified while linked.

Note: Changing sku forces a new Log Analytics Workspace to be created, except when changing between PerGB2018 and CapacityReservation. Changing sku to CapacityReservation or changing reservation_capacity_in_gb_per_day to a higher tier will lead to a 31-days commitment period, during which the SKU cannot be changed to a lower one. Please refer to official documentation for further information.

Note: A new pricing model took effect on 2018-04-03, which requires the SKU PerGB2018. If you've provisioned resources before this date you have the option of remaining with the previous Pricing SKU and using the other SKUs defined above. More information about the Pricing SKUs is available at the following URI.

Tags map[string]string
A mapping of tags to assign to the resource.
WorkspaceId string
The Workspace (or Customer) ID for the Log Analytics Workspace.
allowResourceOnlyPermissions Boolean
Specifies if the log Analytics Workspace allow users accessing to data associated with resources they have permission to view, without permission to workspace. Defaults to true.
cmkForQueryForced Boolean
Is Customer Managed Storage mandatory for query management?
dailyQuotaGb Double
The workspace daily quota for ingestion in GB. Defaults to -1 (unlimited) if omitted.
dataCollectionRuleId String
The ID of the Data Collection Rule to use for this workspace.
identity AnalyticsWorkspaceIdentity
An identity block as defined below.
immediateDataPurgeOn30DaysEnabled Boolean
Whether to remove the data in the Log Analytics Workspace immediately after 30 days.
internetIngestionEnabled Boolean
Should the Log Analytics Workspace support ingestion over the Public Internet? Defaults to true.
internetQueryEnabled Boolean
Should the Log Analytics Workspace support querying over the Public Internet? Defaults to true.
localAuthenticationDisabled Boolean
Specifies if the log Analytics workspace should enforce authentication using Azure AD. Defaults to false.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Log Analytics Workspace. Workspace name should include 4-63 letters, digits or '-'. The '-' shouldn't be the first or the last symbol. Changing this forces a new resource to be created.
primarySharedKey String
The Primary shared key for the Log Analytics Workspace.
reservationCapacityInGbPerDay Integer

The capacity reservation level in GB for this workspace. Possible values are 100, 200, 300, 400, 500, 1000, 2000 and 5000.

Note: reservation_capacity_in_gb_per_day can only be used when the sku is set to CapacityReservation.

resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.
retentionInDays Integer
The workspace data retention in days. Possible values are between 30 and 730.
secondarySharedKey String
The Secondary shared key for the Log Analytics Workspace.
sku String

Specifies the SKU of the Log Analytics Workspace. Possible values are PerNode, Premium, Standard, Standalone, Unlimited, CapacityReservation, PerGB2018, and LACluster. Defaults to PerGB2018.

Note: sku should only be set to LACluster when the Log Analytics Workspace is linked to a Log Analytics Cluster. Additionally, sku cannot be modified while linked.

Note: Changing sku forces a new Log Analytics Workspace to be created, except when changing between PerGB2018 and CapacityReservation. Changing sku to CapacityReservation or changing reservation_capacity_in_gb_per_day to a higher tier will lead to a 31-days commitment period, during which the SKU cannot be changed to a lower one. Please refer to official documentation for further information.

Note: A new pricing model took effect on 2018-04-03, which requires the SKU PerGB2018. If you've provisioned resources before this date you have the option of remaining with the previous Pricing SKU and using the other SKUs defined above. More information about the Pricing SKUs is available at the following URI.

tags Map<String,String>
A mapping of tags to assign to the resource.
workspaceId String
The Workspace (or Customer) ID for the Log Analytics Workspace.
allowResourceOnlyPermissions boolean
Specifies if the log Analytics Workspace allow users accessing to data associated with resources they have permission to view, without permission to workspace. Defaults to true.
cmkForQueryForced boolean
Is Customer Managed Storage mandatory for query management?
dailyQuotaGb number
The workspace daily quota for ingestion in GB. Defaults to -1 (unlimited) if omitted.
dataCollectionRuleId string
The ID of the Data Collection Rule to use for this workspace.
identity AnalyticsWorkspaceIdentity
An identity block as defined below.
immediateDataPurgeOn30DaysEnabled boolean
Whether to remove the data in the Log Analytics Workspace immediately after 30 days.
internetIngestionEnabled boolean
Should the Log Analytics Workspace support ingestion over the Public Internet? Defaults to true.
internetQueryEnabled boolean
Should the Log Analytics Workspace support querying over the Public Internet? Defaults to true.
localAuthenticationDisabled boolean
Specifies if the log Analytics workspace should enforce authentication using Azure AD. Defaults to false.
location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the Log Analytics Workspace. Workspace name should include 4-63 letters, digits or '-'. The '-' shouldn't be the first or the last symbol. Changing this forces a new resource to be created.
primarySharedKey string
The Primary shared key for the Log Analytics Workspace.
reservationCapacityInGbPerDay number

The capacity reservation level in GB for this workspace. Possible values are 100, 200, 300, 400, 500, 1000, 2000 and 5000.

Note: reservation_capacity_in_gb_per_day can only be used when the sku is set to CapacityReservation.

resourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.
retentionInDays number
The workspace data retention in days. Possible values are between 30 and 730.
secondarySharedKey string
The Secondary shared key for the Log Analytics Workspace.
sku string

Specifies the SKU of the Log Analytics Workspace. Possible values are PerNode, Premium, Standard, Standalone, Unlimited, CapacityReservation, PerGB2018, and LACluster. Defaults to PerGB2018.

Note: sku should only be set to LACluster when the Log Analytics Workspace is linked to a Log Analytics Cluster. Additionally, sku cannot be modified while linked.

Note: Changing sku forces a new Log Analytics Workspace to be created, except when changing between PerGB2018 and CapacityReservation. Changing sku to CapacityReservation or changing reservation_capacity_in_gb_per_day to a higher tier will lead to a 31-days commitment period, during which the SKU cannot be changed to a lower one. Please refer to official documentation for further information.

Note: A new pricing model took effect on 2018-04-03, which requires the SKU PerGB2018. If you've provisioned resources before this date you have the option of remaining with the previous Pricing SKU and using the other SKUs defined above. More information about the Pricing SKUs is available at the following URI.

tags {[key: string]: string}
A mapping of tags to assign to the resource.
workspaceId string
The Workspace (or Customer) ID for the Log Analytics Workspace.
allow_resource_only_permissions bool
Specifies if the log Analytics Workspace allow users accessing to data associated with resources they have permission to view, without permission to workspace. Defaults to true.
cmk_for_query_forced bool
Is Customer Managed Storage mandatory for query management?
daily_quota_gb float
The workspace daily quota for ingestion in GB. Defaults to -1 (unlimited) if omitted.
data_collection_rule_id str
The ID of the Data Collection Rule to use for this workspace.
identity AnalyticsWorkspaceIdentityArgs
An identity block as defined below.
immediate_data_purge_on30_days_enabled bool
Whether to remove the data in the Log Analytics Workspace immediately after 30 days.
internet_ingestion_enabled bool
Should the Log Analytics Workspace support ingestion over the Public Internet? Defaults to true.
internet_query_enabled bool
Should the Log Analytics Workspace support querying over the Public Internet? Defaults to true.
local_authentication_disabled bool
Specifies if the log Analytics workspace should enforce authentication using Azure AD. Defaults to false.
location Changes to this property will trigger replacement. str
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the Log Analytics Workspace. Workspace name should include 4-63 letters, digits or '-'. The '-' shouldn't be the first or the last symbol. Changing this forces a new resource to be created.
primary_shared_key str
The Primary shared key for the Log Analytics Workspace.
reservation_capacity_in_gb_per_day int

The capacity reservation level in GB for this workspace. Possible values are 100, 200, 300, 400, 500, 1000, 2000 and 5000.

Note: reservation_capacity_in_gb_per_day can only be used when the sku is set to CapacityReservation.

resource_group_name Changes to this property will trigger replacement. str
The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.
retention_in_days int
The workspace data retention in days. Possible values are between 30 and 730.
secondary_shared_key str
The Secondary shared key for the Log Analytics Workspace.
sku str

Specifies the SKU of the Log Analytics Workspace. Possible values are PerNode, Premium, Standard, Standalone, Unlimited, CapacityReservation, PerGB2018, and LACluster. Defaults to PerGB2018.

Note: sku should only be set to LACluster when the Log Analytics Workspace is linked to a Log Analytics Cluster. Additionally, sku cannot be modified while linked.

Note: Changing sku forces a new Log Analytics Workspace to be created, except when changing between PerGB2018 and CapacityReservation. Changing sku to CapacityReservation or changing reservation_capacity_in_gb_per_day to a higher tier will lead to a 31-days commitment period, during which the SKU cannot be changed to a lower one. Please refer to official documentation for further information.

Note: A new pricing model took effect on 2018-04-03, which requires the SKU PerGB2018. If you've provisioned resources before this date you have the option of remaining with the previous Pricing SKU and using the other SKUs defined above. More information about the Pricing SKUs is available at the following URI.

tags Mapping[str, str]
A mapping of tags to assign to the resource.
workspace_id str
The Workspace (or Customer) ID for the Log Analytics Workspace.
allowResourceOnlyPermissions Boolean
Specifies if the log Analytics Workspace allow users accessing to data associated with resources they have permission to view, without permission to workspace. Defaults to true.
cmkForQueryForced Boolean
Is Customer Managed Storage mandatory for query management?
dailyQuotaGb Number
The workspace daily quota for ingestion in GB. Defaults to -1 (unlimited) if omitted.
dataCollectionRuleId String
The ID of the Data Collection Rule to use for this workspace.
identity Property Map
An identity block as defined below.
immediateDataPurgeOn30DaysEnabled Boolean
Whether to remove the data in the Log Analytics Workspace immediately after 30 days.
internetIngestionEnabled Boolean
Should the Log Analytics Workspace support ingestion over the Public Internet? Defaults to true.
internetQueryEnabled Boolean
Should the Log Analytics Workspace support querying over the Public Internet? Defaults to true.
localAuthenticationDisabled Boolean
Specifies if the log Analytics workspace should enforce authentication using Azure AD. Defaults to false.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Log Analytics Workspace. Workspace name should include 4-63 letters, digits or '-'. The '-' shouldn't be the first or the last symbol. Changing this forces a new resource to be created.
primarySharedKey String
The Primary shared key for the Log Analytics Workspace.
reservationCapacityInGbPerDay Number

The capacity reservation level in GB for this workspace. Possible values are 100, 200, 300, 400, 500, 1000, 2000 and 5000.

Note: reservation_capacity_in_gb_per_day can only be used when the sku is set to CapacityReservation.

resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.
retentionInDays Number
The workspace data retention in days. Possible values are between 30 and 730.
secondarySharedKey String
The Secondary shared key for the Log Analytics Workspace.
sku String

Specifies the SKU of the Log Analytics Workspace. Possible values are PerNode, Premium, Standard, Standalone, Unlimited, CapacityReservation, PerGB2018, and LACluster. Defaults to PerGB2018.

Note: sku should only be set to LACluster when the Log Analytics Workspace is linked to a Log Analytics Cluster. Additionally, sku cannot be modified while linked.

Note: Changing sku forces a new Log Analytics Workspace to be created, except when changing between PerGB2018 and CapacityReservation. Changing sku to CapacityReservation or changing reservation_capacity_in_gb_per_day to a higher tier will lead to a 31-days commitment period, during which the SKU cannot be changed to a lower one. Please refer to official documentation for further information.

Note: A new pricing model took effect on 2018-04-03, which requires the SKU PerGB2018. If you've provisioned resources before this date you have the option of remaining with the previous Pricing SKU and using the other SKUs defined above. More information about the Pricing SKUs is available at the following URI.

tags Map<String>
A mapping of tags to assign to the resource.
workspaceId String
The Workspace (or Customer) ID for the Log Analytics Workspace.

Supporting Types

AnalyticsWorkspaceIdentity
, AnalyticsWorkspaceIdentityArgs

Type This property is required. string

Specifies the identity type of the Log Analytics Workspace. Possible values are SystemAssigned (where Azure will generate a Service Principal for you) and UserAssigned where you can specify the Service Principal IDs in the identity_ids field.

Note: When type is set to SystemAssigned, The assigned principal_id and tenant_id can be retrieved after the Log Analytics Workspace has been created.

IdentityIds List<string>
Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned.
PrincipalId string
TenantId string
Type This property is required. string

Specifies the identity type of the Log Analytics Workspace. Possible values are SystemAssigned (where Azure will generate a Service Principal for you) and UserAssigned where you can specify the Service Principal IDs in the identity_ids field.

Note: When type is set to SystemAssigned, The assigned principal_id and tenant_id can be retrieved after the Log Analytics Workspace has been created.

IdentityIds []string
Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned.
PrincipalId string
TenantId string
type This property is required. String

Specifies the identity type of the Log Analytics Workspace. Possible values are SystemAssigned (where Azure will generate a Service Principal for you) and UserAssigned where you can specify the Service Principal IDs in the identity_ids field.

Note: When type is set to SystemAssigned, The assigned principal_id and tenant_id can be retrieved after the Log Analytics Workspace has been created.

identityIds List<String>
Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned.
principalId String
tenantId String
type This property is required. string

Specifies the identity type of the Log Analytics Workspace. Possible values are SystemAssigned (where Azure will generate a Service Principal for you) and UserAssigned where you can specify the Service Principal IDs in the identity_ids field.

Note: When type is set to SystemAssigned, The assigned principal_id and tenant_id can be retrieved after the Log Analytics Workspace has been created.

identityIds string[]
Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned.
principalId string
tenantId string
type This property is required. str

Specifies the identity type of the Log Analytics Workspace. Possible values are SystemAssigned (where Azure will generate a Service Principal for you) and UserAssigned where you can specify the Service Principal IDs in the identity_ids field.

Note: When type is set to SystemAssigned, The assigned principal_id and tenant_id can be retrieved after the Log Analytics Workspace has been created.

identity_ids Sequence[str]
Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned.
principal_id str
tenant_id str
type This property is required. String

Specifies the identity type of the Log Analytics Workspace. Possible values are SystemAssigned (where Azure will generate a Service Principal for you) and UserAssigned where you can specify the Service Principal IDs in the identity_ids field.

Note: When type is set to SystemAssigned, The assigned principal_id and tenant_id can be retrieved after the Log Analytics Workspace has been created.

identityIds List<String>
Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned.
principalId String
tenantId String

Import

Log Analytics Workspaces can be imported using the resource id, e.g.

$ pulumi import azure:operationalinsights/analyticsWorkspace:AnalyticsWorkspace workspace1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.OperationalInsights/workspaces/workspace1
Copy

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.

We recommend using Azure Native.

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