Azure Classic

v5.24.0 published on Wednesday, Nov 9, 2022 by Pulumi

Cluster

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 System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleCluster = new Azure.LogAnalytics.Cluster("exampleCluster", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
        Identity = new Azure.LogAnalytics.Inputs.ClusterIdentityArgs
        {
            Type = "SystemAssigned",
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/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
	})
}
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.loganalytics.Cluster;
import com.pulumi.azure.loganalytics.ClusterArgs;
import com.pulumi.azure.loganalytics.inputs.ClusterIdentityArgs;
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleCluster = new Cluster("exampleCluster", ClusterArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .identity(ClusterIdentityArgs.builder()
                .type("SystemAssigned")
                .build())
            .build());

    }
}
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",
    ))
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",
    },
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleCluster:
    type: azure:loganalytics:Cluster
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      identity:
        type: SystemAssigned

Create Cluster Resource

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = 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)
@overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = 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.

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.

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

The Cluster resource accepts the following input properties:

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 is specified in GB/day. Possible values include 500, 1000, 2000 or 5000. 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 is specified in GB/day. Possible values include 500, 1000, 2000 or 5000. Defaults to 1000.

Tags map[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 Integer

The capacity of the Log Analytics Cluster is specified in GB/day. Possible values include 500, 1000, 2000 or 5000. Defaults to 1000.

tags Map<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 number

The capacity of the Log Analytics Cluster is specified in GB/day. Possible values include 500, 1000, 2000 or 5000. 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 is specified in GB/day. Possible values include 500, 1000, 2000 or 5000. 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 is specified in GB/day. Possible values include 500, 1000, 2000 or 5000. 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)
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:
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 is specified in GB/day. Possible values include 500, 1000, 2000 or 5000. 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 is specified in GB/day. Possible values include 500, 1000, 2000 or 5000. 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 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 Integer

The capacity of the Log Analytics Cluster is specified in GB/day. Possible values include 500, 1000, 2000 or 5000. 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 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 number

The capacity of the Log Analytics Cluster is specified in GB/day. Possible values include 500, 1000, 2000 or 5000. 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 is specified in GB/day. Possible values include 500, 1000, 2000 or 5000. 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 is specified in GB/day. Possible values include 500, 1000, 2000 or 5000. Defaults to 1000.

tags Map<String>

A mapping of tags which should be assigned to the Log Analytics Cluster.

Supporting Types

ClusterIdentity

Type string

Specifies the type of Managed Service Identity that should be configured on this Log Analytics Cluster. The only possible value is SystemAssigned.

PrincipalId string

The Principal ID associated with this Managed Service Identity.

TenantId string

The Tenant ID associated with this Managed Service Identity.

Type string

Specifies the type of Managed Service Identity that should be configured on this Log Analytics Cluster. The only possible value is SystemAssigned.

PrincipalId string

The Principal ID associated with this Managed Service Identity.

TenantId string

The Tenant ID associated with this Managed Service Identity.

type String

Specifies the type of Managed Service Identity that should be configured on this Log Analytics Cluster. The only possible value is SystemAssigned.

principalId String

The Principal ID associated with this Managed Service Identity.

tenantId String

The Tenant ID associated with this Managed Service Identity.

type string

Specifies the type of Managed Service Identity that should be configured on this Log Analytics Cluster. The only possible value is SystemAssigned.

principalId string

The Principal ID associated with this Managed Service Identity.

tenantId string

The Tenant ID associated with this Managed Service Identity.

type str

Specifies the type of Managed Service Identity that should be configured on this Log Analytics Cluster. The only possible value is SystemAssigned.

principal_id str

The Principal ID associated with this Managed Service Identity.

tenant_id str

The Tenant ID associated with this Managed Service Identity.

type String

Specifies the type of Managed Service Identity that should be configured on this Log Analytics Cluster. The only possible value is SystemAssigned.

principalId String

The Principal ID associated with this Managed Service Identity.

tenantId String

The Tenant ID associated with this Managed Service Identity.

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

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.