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

We recommend using Azure Native.

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

azure.kusto.getCluster

Explore with Pulumi AI

We recommend using Azure Native.

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

Use this data source to access information about an existing Kusto (also known as Azure Data Explorer) Cluster

Example Usage

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

const example = azure.kusto.getCluster({
    name: "kustocluster",
    resourceGroupName: "test_resource_group",
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.kusto.get_cluster(name="kustocluster",
    resource_group_name="test_resource_group")
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/kusto"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kusto.LookupCluster(ctx, &kusto.LookupClusterArgs{
			Name:              "kustocluster",
			ResourceGroupName: "test_resource_group",
		}, nil)
		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 = Azure.Kusto.GetCluster.Invoke(new()
    {
        Name = "kustocluster",
        ResourceGroupName = "test_resource_group",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.kusto.KustoFunctions;
import com.pulumi.azure.kusto.inputs.GetClusterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = KustoFunctions.getCluster(GetClusterArgs.builder()
            .name("kustocluster")
            .resourceGroupName("test_resource_group")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: azure:kusto:getCluster
      arguments:
        name: kustocluster
        resourceGroupName: test_resource_group
Copy

Using getCluster

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
Copy
def get_cluster(name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
Copy
func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput
Copy

> Note: This function is named LookupCluster in the Go SDK.

public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure:kusto/getCluster:getCluster
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Specifies the name of the Kusto Cluster.
ResourceGroupName This property is required. string
The name of the Resource Group where the Kusto Cluster exists.
Name This property is required. string
Specifies the name of the Kusto Cluster.
ResourceGroupName This property is required. string
The name of the Resource Group where the Kusto Cluster exists.
name This property is required. String
Specifies the name of the Kusto Cluster.
resourceGroupName This property is required. String
The name of the Resource Group where the Kusto Cluster exists.
name This property is required. string
Specifies the name of the Kusto Cluster.
resourceGroupName This property is required. string
The name of the Resource Group where the Kusto Cluster exists.
name This property is required. str
Specifies the name of the Kusto Cluster.
resource_group_name This property is required. str
The name of the Resource Group where the Kusto Cluster exists.
name This property is required. String
Specifies the name of the Kusto Cluster.
resourceGroupName This property is required. String
The name of the Resource Group where the Kusto Cluster exists.

getCluster Result

The following output properties are available:

DataIngestionUri string
The Kusto Cluster URI to be used for data ingestion.
Id string
The provider-assigned unique ID for this managed resource.
Identities List<GetClusterIdentity>
An identity block as defined below.
Location string
Name string
ResourceGroupName string
Tags Dictionary<string, string>
Uri string
The FQDN of the Azure Kusto Cluster.
DataIngestionUri string
The Kusto Cluster URI to be used for data ingestion.
Id string
The provider-assigned unique ID for this managed resource.
Identities []GetClusterIdentity
An identity block as defined below.
Location string
Name string
ResourceGroupName string
Tags map[string]string
Uri string
The FQDN of the Azure Kusto Cluster.
dataIngestionUri String
The Kusto Cluster URI to be used for data ingestion.
id String
The provider-assigned unique ID for this managed resource.
identities List<GetClusterIdentity>
An identity block as defined below.
location String
name String
resourceGroupName String
tags Map<String,String>
uri String
The FQDN of the Azure Kusto Cluster.
dataIngestionUri string
The Kusto Cluster URI to be used for data ingestion.
id string
The provider-assigned unique ID for this managed resource.
identities GetClusterIdentity[]
An identity block as defined below.
location string
name string
resourceGroupName string
tags {[key: string]: string}
uri string
The FQDN of the Azure Kusto Cluster.
data_ingestion_uri str
The Kusto Cluster URI to be used for data ingestion.
id str
The provider-assigned unique ID for this managed resource.
identities Sequence[GetClusterIdentity]
An identity block as defined below.
location str
name str
resource_group_name str
tags Mapping[str, str]
uri str
The FQDN of the Azure Kusto Cluster.
dataIngestionUri String
The Kusto Cluster URI to be used for data ingestion.
id String
The provider-assigned unique ID for this managed resource.
identities List<Property Map>
An identity block as defined below.
location String
name String
resourceGroupName String
tags Map<String>
uri String
The FQDN of the Azure Kusto Cluster.

Supporting Types

GetClusterIdentity

IdentityIds This property is required. List<string>
A list of User Assigned Managed Identity IDs to be assigned to this Kusto Cluster.
PrincipalId This property is required. string
The Principal ID associated with this System Assigned Managed Service Identity.
TenantId This property is required. string
The Tenant ID associated with this System Assigned Managed Service Identity.
Type This property is required. string
The type of Managed Service Identity that is configured on this Kusto Cluster.
IdentityIds This property is required. []string
A list of User Assigned Managed Identity IDs to be assigned to this Kusto Cluster.
PrincipalId This property is required. string
The Principal ID associated with this System Assigned Managed Service Identity.
TenantId This property is required. string
The Tenant ID associated with this System Assigned Managed Service Identity.
Type This property is required. string
The type of Managed Service Identity that is configured on this Kusto Cluster.
identityIds This property is required. List<String>
A list of User Assigned Managed Identity IDs to be assigned to this Kusto Cluster.
principalId This property is required. String
The Principal ID associated with this System Assigned Managed Service Identity.
tenantId This property is required. String
The Tenant ID associated with this System Assigned Managed Service Identity.
type This property is required. String
The type of Managed Service Identity that is configured on this Kusto Cluster.
identityIds This property is required. string[]
A list of User Assigned Managed Identity IDs to be assigned to this Kusto Cluster.
principalId This property is required. string
The Principal ID associated with this System Assigned Managed Service Identity.
tenantId This property is required. string
The Tenant ID associated with this System Assigned Managed Service Identity.
type This property is required. string
The type of Managed Service Identity that is configured on this Kusto Cluster.
identity_ids This property is required. Sequence[str]
A list of User Assigned Managed Identity IDs to be assigned to this Kusto Cluster.
principal_id This property is required. str
The Principal ID associated with this System Assigned Managed Service Identity.
tenant_id This property is required. str
The Tenant ID associated with this System Assigned Managed Service Identity.
type This property is required. str
The type of Managed Service Identity that is configured on this Kusto Cluster.
identityIds This property is required. List<String>
A list of User Assigned Managed Identity IDs to be assigned to this Kusto Cluster.
principalId This property is required. String
The Principal ID associated with this System Assigned Managed Service Identity.
tenantId This property is required. String
The Tenant ID associated with this System Assigned Managed Service Identity.
type This property is required. String
The type of Managed Service Identity that is configured on this Kusto Cluster.

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