1. Packages
  2. Azure Classic
  3. API Docs
  4. loganalytics
  5. Cluster

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.loganalytics.Cluster

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    !> Important Due to capacity constraints, Microsoft requires you to pre-register your subscription IDs before you are allowed to create a Log Analytics cluster. Contact Microsoft, or open a support request to register your subscription IDs.

    Note: Log Analytics Clusters are subject to 14-day soft delete policy. Clusters created with the same resource group & name as a previously deleted cluster will be recovered rather than creating anew.

    Manages a Log Analytics Cluster.

    Example Usage

    using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleCluster = new Azure.LogAnalytics.Cluster("exampleCluster", new Azure.LogAnalytics.ClusterArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            Identity = new Azure.LogAnalytics.Inputs.ClusterIdentityArgs
            {
                Type = "SystemAssigned",
            },
        });
    }

}

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/loganalytics"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = loganalytics.NewCluster(ctx, "exampleCluster", &loganalytics.ClusterArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
			Identity: &loganalytics.ClusterIdentityArgs{
				Type: pulumi.String("SystemAssigned"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleCluster = new azure.loganalytics.Cluster("exampleCluster", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    identity: {
        type: "SystemAssigned",
    },
});

    import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_cluster = azure.loganalytics.Cluster("exampleCluster",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    identity=azure.loganalytics.ClusterIdentityArgs(
        type="SystemAssigned",
    ))

    Example coming soon!

    Create Cluster Resource

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

    Constructor syntax

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

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            identity: Optional[ClusterIdentityArgs] = None,
            resource_group_name: Optional[str] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            size_gb: Optional[int] = None,
            tags: Optional[Mapping[str, str]] = None)
    func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
    public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
    public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)

    type: azure:loganalytics:Cluster
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 ClusterArgs
    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 ClusterArgs
    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 ClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterArgs
    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 exampleclusterResourceResourceFromLoganalyticscluster = new Azure.LogAnalytics.Cluster("exampleclusterResourceResourceFromLoganalyticscluster", new()
{
    Identity = new Azure.LogAnalytics.Inputs.ClusterIdentityArgs
    {
        Type = "string",
        PrincipalId = "string",
        TenantId = "string",
    },
    ResourceGroupName = "string",
    Location = "string",
    Name = "string",
    SizeGb = 0,
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := loganalytics.NewCluster(ctx, "exampleclusterResourceResourceFromLoganalyticscluster", &loganalytics.ClusterArgs{
	Identity: &loganalytics.ClusterIdentityArgs{
		Type:        pulumi.String("string"),
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	ResourceGroupName: pulumi.String("string"),
	Location:          pulumi.String("string"),
	Name:              pulumi.String("string"),
	SizeGb:            pulumi.Int(0),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var exampleclusterResourceResourceFromLoganalyticscluster = new com.pulumi.azure.loganalytics.Cluster("exampleclusterResourceResourceFromLoganalyticscluster", com.pulumi.azure.loganalytics.ClusterArgs.builder()
    .identity(ClusterIdentityArgs.builder()
        .type("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .resourceGroupName("string")
    .location("string")
    .name("string")
    .sizeGb(0)
    .tags(Map.of("string", "string"))
    .build());

    examplecluster_resource_resource_from_loganalyticscluster = azure.loganalytics.Cluster("exampleclusterResourceResourceFromLoganalyticscluster",
    identity={
        "type": "string",
        "principal_id": "string",
        "tenant_id": "string",
    },
    resource_group_name="string",
    location="string",
    name="string",
    size_gb=0,
    tags={
        "string": "string",
    })

    const exampleclusterResourceResourceFromLoganalyticscluster = new azure.loganalytics.Cluster("exampleclusterResourceResourceFromLoganalyticscluster", {
    identity: {
        type: "string",
        principalId: "string",
        tenantId: "string",
    },
    resourceGroupName: "string",
    location: "string",
    name: "string",
    sizeGb: 0,
    tags: {
        string: "string",
    },
});

    type: azure:loganalytics:Cluster
properties:
    identity:
        principalId: string
        tenantId: string
        type: string
    location: string
    name: string
    resourceGroupName: string
    sizeGb: 0
    tags:
        string: string

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

    Identity ClusterIdentity
    An identity block as defined below. Changing this forces a new Log Analytics Cluster to be created.
    ResourceGroupName string
    The name of the Resource Group where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    Location string
    The Azure Region where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    Name string
    The name which should be used for this Log Analytics Cluster. Changing this forces a new Log Analytics Cluster to be created.
    SizeGb int
    The capacity of the Log Analytics Cluster specified in GB/day. Defaults to 1000.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Log Analytics Cluster.
    Identity ClusterIdentityArgs
    An identity block as defined below. Changing this forces a new Log Analytics Cluster to be created.
    ResourceGroupName string
    The name of the Resource Group where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    Location string
    The Azure Region where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    Name string
    The name which should be used for this Log Analytics Cluster. Changing this forces a new Log Analytics Cluster to be created.
    SizeGb int
    The capacity of the Log Analytics Cluster specified in GB/day. Defaults to 1000.
    Tags map[string]string
    A mapping of tags which should be assigned to the Log Analytics Cluster.
    identity ClusterIdentity
    An identity block as defined below. Changing this forces a new Log Analytics Cluster to be created.
    resourceGroupName String
    The name of the Resource Group where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    location String
    The Azure Region where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    name String
    The name which should be used for this Log Analytics Cluster. Changing this forces a new Log Analytics Cluster to be created.
    sizeGb Integer
    The capacity of the Log Analytics Cluster specified in GB/day. Defaults to 1000.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Log Analytics Cluster.
    identity ClusterIdentity
    An identity block as defined below. Changing this forces a new Log Analytics Cluster to be created.
    resourceGroupName string
    The name of the Resource Group where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    location string
    The Azure Region where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    name string
    The name which should be used for this Log Analytics Cluster. Changing this forces a new Log Analytics Cluster to be created.
    sizeGb number
    The capacity of the Log Analytics Cluster specified in GB/day. Defaults to 1000.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Log Analytics Cluster.
    identity ClusterIdentityArgs
    An identity block as defined below. Changing this forces a new Log Analytics Cluster to be created.
    resource_group_name str
    The name of the Resource Group where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    location str
    The Azure Region where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    name str
    The name which should be used for this Log Analytics Cluster. Changing this forces a new Log Analytics Cluster to be created.
    size_gb int
    The capacity of the Log Analytics Cluster specified in GB/day. Defaults to 1000.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Log Analytics Cluster.
    identity Property Map
    An identity block as defined below. Changing this forces a new Log Analytics Cluster to be created.
    resourceGroupName String
    The name of the Resource Group where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    location String
    The Azure Region where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    name String
    The name which should be used for this Log Analytics Cluster. Changing this forces a new Log Analytics Cluster to be created.
    sizeGb Number
    The capacity of the Log Analytics Cluster specified in GB/day. Defaults to 1000.
    tags Map<String>
    A mapping of tags which should be assigned to the Log Analytics Cluster.

    Outputs

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

    ClusterId string
    The GUID of the cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    ClusterId string
    The GUID of the cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    clusterId String
    The GUID of the cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    clusterId string
    The GUID of the cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    cluster_id str
    The GUID of the cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    clusterId String
    The GUID of the cluster.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Cluster Resource

    Get an existing Cluster 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?: ClusterState, opts?: CustomResourceOptions): Cluster
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        identity: Optional[ClusterIdentityArgs] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        size_gb: Optional[int] = None,
        tags: Optional[Mapping[str, str]] = None) -> Cluster
    func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
    public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
    public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)
    resources:  _:    type: azure:loganalytics:Cluster    get:      id: ${id}
    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:
    ClusterId string
    The GUID of the cluster.
    Identity ClusterIdentity
    An identity block as defined below. Changing this forces a new Log Analytics Cluster to be created.
    Location string
    The Azure Region where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    Name string
    The name which should be used for this Log Analytics Cluster. Changing this forces a new Log Analytics Cluster to be created.
    ResourceGroupName string
    The name of the Resource Group where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    SizeGb int
    The capacity of the Log Analytics Cluster specified in GB/day. Defaults to 1000.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Log Analytics Cluster.
    ClusterId string
    The GUID of the cluster.
    Identity ClusterIdentityArgs
    An identity block as defined below. Changing this forces a new Log Analytics Cluster to be created.
    Location string
    The Azure Region where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    Name string
    The name which should be used for this Log Analytics Cluster. Changing this forces a new Log Analytics Cluster to be created.
    ResourceGroupName string
    The name of the Resource Group where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    SizeGb int
    The capacity of the Log Analytics Cluster specified in GB/day. Defaults to 1000.
    Tags map[string]string
    A mapping of tags which should be assigned to the Log Analytics Cluster.
    clusterId String
    The GUID of the cluster.
    identity ClusterIdentity
    An identity block as defined below. Changing this forces a new Log Analytics Cluster to be created.
    location String
    The Azure Region where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    name String
    The name which should be used for this Log Analytics Cluster. Changing this forces a new Log Analytics Cluster to be created.
    resourceGroupName String
    The name of the Resource Group where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    sizeGb Integer
    The capacity of the Log Analytics Cluster specified in GB/day. Defaults to 1000.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Log Analytics Cluster.
    clusterId string
    The GUID of the cluster.
    identity ClusterIdentity
    An identity block as defined below. Changing this forces a new Log Analytics Cluster to be created.
    location string
    The Azure Region where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    name string
    The name which should be used for this Log Analytics Cluster. Changing this forces a new Log Analytics Cluster to be created.
    resourceGroupName string
    The name of the Resource Group where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    sizeGb number
    The capacity of the Log Analytics Cluster specified in GB/day. Defaults to 1000.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Log Analytics Cluster.
    cluster_id str
    The GUID of the cluster.
    identity ClusterIdentityArgs
    An identity block as defined below. Changing this forces a new Log Analytics Cluster to be created.
    location str
    The Azure Region where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    name str
    The name which should be used for this Log Analytics Cluster. Changing this forces a new Log Analytics Cluster to be created.
    resource_group_name str
    The name of the Resource Group where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    size_gb int
    The capacity of the Log Analytics Cluster specified in GB/day. Defaults to 1000.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Log Analytics Cluster.
    clusterId String
    The GUID of the cluster.
    identity Property Map
    An identity block as defined below. Changing this forces a new Log Analytics Cluster to be created.
    location String
    The Azure Region where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    name String
    The name which should be used for this Log Analytics Cluster. Changing this forces a new Log Analytics Cluster to be created.
    resourceGroupName String
    The name of the Resource Group where the Log Analytics Cluster should exist. Changing this forces a new Log Analytics Cluster to be created.
    sizeGb Number
    The capacity of the Log Analytics Cluster specified in GB/day. Defaults to 1000.
    tags Map<String>
    A mapping of tags which should be assigned to the Log Analytics Cluster.

    Supporting Types

    ClusterIdentity, ClusterIdentityArgs

    Type string
    Specifies the identity type of the Log Analytics Cluster. At this time the only allowed value is SystemAssigned.
    PrincipalId string
    The Principal ID for the Service Principal associated with the Identity of this Log Analytics Cluster.
    TenantId string
    The Tenant ID for the Service Principal associated with the Identity of this Log Analytics Cluster.
    Type string
    Specifies the identity type of the Log Analytics Cluster. At this time the only allowed value is SystemAssigned.
    PrincipalId string
    The Principal ID for the Service Principal associated with the Identity of this Log Analytics Cluster.
    TenantId string
    The Tenant ID for the Service Principal associated with the Identity of this Log Analytics Cluster.
    type String
    Specifies the identity type of the Log Analytics Cluster. At this time the only allowed value is SystemAssigned.
    principalId String
    The Principal ID for the Service Principal associated with the Identity of this Log Analytics Cluster.
    tenantId String
    The Tenant ID for the Service Principal associated with the Identity of this Log Analytics Cluster.
    type string
    Specifies the identity type of the Log Analytics Cluster. At this time the only allowed value is SystemAssigned.
    principalId string
    The Principal ID for the Service Principal associated with the Identity of this Log Analytics Cluster.
    tenantId string
    The Tenant ID for the Service Principal associated with the Identity of this Log Analytics Cluster.
    type str
    Specifies the identity type of the Log Analytics Cluster. At this time the only allowed value is SystemAssigned.
    principal_id str
    The Principal ID for the Service Principal associated with the Identity of this Log Analytics Cluster.
    tenant_id str
    The Tenant ID for the Service Principal associated with the Identity of this Log Analytics Cluster.
    type String
    Specifies the identity type of the Log Analytics Cluster. At this time the only allowed value is SystemAssigned.
    principalId String
    The Principal ID for the Service Principal associated with the Identity of this Log Analytics Cluster.
    tenantId String
    The Tenant ID for the Service Principal associated with the Identity of this Log Analytics Cluster.

    Import

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

     $ pulumi import azure:loganalytics/cluster:Cluster example /subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/group1/providers/Microsoft.OperationalInsights/clusters/cluster1

    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.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure
      Try Pulumi Cloud free. Your team will thank you.