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

We recommend using Azure Native.

Azure v6.23.0 published on Thursday, May 22, 2025 by Pulumi
pulumi/pulumi-azure

azure.kusto.ClusterCustomerManagedKey

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.23.0 published on Thursday, May 22, 2025 by Pulumi
pulumi/pulumi-azure

    Manages a Customer Managed Key for a Kusto Cluster.

    Example Usage

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

const current = azure.core.getClientConfig({});
const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleKeyVault = new azure.keyvault.KeyVault("example", {
    name: "examplekv",
    location: example.location,
    resourceGroupName: example.name,
    tenantId: current.then(current => current.tenantId),
    skuName: "standard",
    purgeProtectionEnabled: true,
});
const exampleCluster = new azure.kusto.Cluster("example", {
    name: "kustocluster",
    location: example.location,
    resourceGroupName: example.name,
    sku: {
        name: "Standard_D13_v2",
        capacity: 2,
    },
    identity: {
        type: "SystemAssigned",
    },
});
const cluster = new azure.keyvault.AccessPolicy("cluster", {
    keyVaultId: exampleKeyVault.id,
    tenantId: current.then(current => current.tenantId),
    objectId: exampleCluster.identity.apply(identity => identity?.principalId),
    keyPermissions: [
        "Get",
        "UnwrapKey",
        "WrapKey",
    ],
});
const client = new azure.keyvault.AccessPolicy("client", {
    keyVaultId: exampleKeyVault.id,
    tenantId: current.then(current => current.tenantId),
    objectId: current.then(current => current.objectId),
    keyPermissions: [
        "Get",
        "List",
        "Create",
        "Delete",
        "Recover",
        "GetRotationPolicy",
    ],
});
const exampleKey = new azure.keyvault.Key("example", {
    name: "tfex-key",
    keyVaultId: exampleKeyVault.id,
    keyType: "RSA",
    keySize: 2048,
    keyOpts: [
        "decrypt",
        "encrypt",
        "sign",
        "unwrapKey",
        "verify",
        "wrapKey",
    ],
}, {
    dependsOn: [
        client,
        cluster,
    ],
});
const exampleClusterCustomerManagedKey = new azure.kusto.ClusterCustomerManagedKey("example", {
    clusterId: exampleCluster.id,
    keyVaultId: exampleKeyVault.id,
    keyName: exampleKey.name,
    keyVersion: exampleKey.version,
});

    import pulumi
import pulumi_azure as azure

current = azure.core.get_client_config()
example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_key_vault = azure.keyvault.KeyVault("example",
    name="examplekv",
    location=example.location,
    resource_group_name=example.name,
    tenant_id=current.tenant_id,
    sku_name="standard",
    purge_protection_enabled=True)
example_cluster = azure.kusto.Cluster("example",
    name="kustocluster",
    location=example.location,
    resource_group_name=example.name,
    sku={
        "name": "Standard_D13_v2",
        "capacity": 2,
    },
    identity={
        "type": "SystemAssigned",
    })
cluster = azure.keyvault.AccessPolicy("cluster",
    key_vault_id=example_key_vault.id,
    tenant_id=current.tenant_id,
    object_id=example_cluster.identity.principal_id,
    key_permissions=[
        "Get",
        "UnwrapKey",
        "WrapKey",
    ])
client = azure.keyvault.AccessPolicy("client",
    key_vault_id=example_key_vault.id,
    tenant_id=current.tenant_id,
    object_id=current.object_id,
    key_permissions=[
        "Get",
        "List",
        "Create",
        "Delete",
        "Recover",
        "GetRotationPolicy",
    ])
example_key = azure.keyvault.Key("example",
    name="tfex-key",
    key_vault_id=example_key_vault.id,
    key_type="RSA",
    key_size=2048,
    key_opts=[
        "decrypt",
        "encrypt",
        "sign",
        "unwrapKey",
        "verify",
        "wrapKey",
    ],
    opts = pulumi.ResourceOptions(depends_on=[
            client,
            cluster,
        ]))
example_cluster_customer_managed_key = azure.kusto.ClusterCustomerManagedKey("example",
    cluster_id=example_cluster.id,
    key_vault_id=example_key_vault.id,
    key_name=example_key.name,
    key_version=example_key.version)

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/keyvault"
	"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 {
		current, err := core.GetClientConfig(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleKeyVault, err := keyvault.NewKeyVault(ctx, "example", &keyvault.KeyVaultArgs{
			Name:                   pulumi.String("examplekv"),
			Location:               example.Location,
			ResourceGroupName:      example.Name,
			TenantId:               pulumi.String(current.TenantId),
			SkuName:                pulumi.String("standard"),
			PurgeProtectionEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		exampleCluster, err := kusto.NewCluster(ctx, "example", &kusto.ClusterArgs{
			Name:              pulumi.String("kustocluster"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Sku: &kusto.ClusterSkuArgs{
				Name:     pulumi.String("Standard_D13_v2"),
				Capacity: pulumi.Int(2),
			},
			Identity: &kusto.ClusterIdentityArgs{
				Type: pulumi.String("SystemAssigned"),
			},
		})
		if err != nil {
			return err
		}
		cluster, err := keyvault.NewAccessPolicy(ctx, "cluster", &keyvault.AccessPolicyArgs{
			KeyVaultId: exampleKeyVault.ID(),
			TenantId:   pulumi.String(current.TenantId),
			ObjectId: pulumi.String(exampleCluster.Identity.ApplyT(func(identity kusto.ClusterIdentity) (*string, error) {
				return &identity.PrincipalId, nil
			}).(pulumi.StringPtrOutput)),
			KeyPermissions: pulumi.StringArray{
				pulumi.String("Get"),
				pulumi.String("UnwrapKey"),
				pulumi.String("WrapKey"),
			},
		})
		if err != nil {
			return err
		}
		client, err := keyvault.NewAccessPolicy(ctx, "client", &keyvault.AccessPolicyArgs{
			KeyVaultId: exampleKeyVault.ID(),
			TenantId:   pulumi.String(current.TenantId),
			ObjectId:   pulumi.String(current.ObjectId),
			KeyPermissions: pulumi.StringArray{
				pulumi.String("Get"),
				pulumi.String("List"),
				pulumi.String("Create"),
				pulumi.String("Delete"),
				pulumi.String("Recover"),
				pulumi.String("GetRotationPolicy"),
			},
		})
		if err != nil {
			return err
		}
		exampleKey, err := keyvault.NewKey(ctx, "example", &keyvault.KeyArgs{
			Name:       pulumi.String("tfex-key"),
			KeyVaultId: exampleKeyVault.ID(),
			KeyType:    pulumi.String("RSA"),
			KeySize:    pulumi.Int(2048),
			KeyOpts: pulumi.StringArray{
				pulumi.String("decrypt"),
				pulumi.String("encrypt"),
				pulumi.String("sign"),
				pulumi.String("unwrapKey"),
				pulumi.String("verify"),
				pulumi.String("wrapKey"),
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			client,
			cluster,
		}))
		if err != nil {
			return err
		}
		_, err = kusto.NewClusterCustomerManagedKey(ctx, "example", &kusto.ClusterCustomerManagedKeyArgs{
			ClusterId:  exampleCluster.ID(),
			KeyVaultId: exampleKeyVault.ID(),
			KeyName:    exampleKey.Name,
			KeyVersion: exampleKey.Version,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var current = Azure.Core.GetClientConfig.Invoke();

    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleKeyVault = new Azure.KeyVault.KeyVault("example", new()
    {
        Name = "examplekv",
        Location = example.Location,
        ResourceGroupName = example.Name,
        TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
        SkuName = "standard",
        PurgeProtectionEnabled = true,
    });

    var exampleCluster = new Azure.Kusto.Cluster("example", new()
    {
        Name = "kustocluster",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Sku = new Azure.Kusto.Inputs.ClusterSkuArgs
        {
            Name = "Standard_D13_v2",
            Capacity = 2,
        },
        Identity = new Azure.Kusto.Inputs.ClusterIdentityArgs
        {
            Type = "SystemAssigned",
        },
    });

    var cluster = new Azure.KeyVault.AccessPolicy("cluster", new()
    {
        KeyVaultId = exampleKeyVault.Id,
        TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
        ObjectId = exampleCluster.Identity.Apply(identity => identity?.PrincipalId),
        KeyPermissions = new[]
        {
            "Get",
            "UnwrapKey",
            "WrapKey",
        },
    });

    var client = new Azure.KeyVault.AccessPolicy("client", new()
    {
        KeyVaultId = exampleKeyVault.Id,
        TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
        ObjectId = current.Apply(getClientConfigResult => getClientConfigResult.ObjectId),
        KeyPermissions = new[]
        {
            "Get",
            "List",
            "Create",
            "Delete",
            "Recover",
            "GetRotationPolicy",
        },
    });

    var exampleKey = new Azure.KeyVault.Key("example", new()
    {
        Name = "tfex-key",
        KeyVaultId = exampleKeyVault.Id,
        KeyType = "RSA",
        KeySize = 2048,
        KeyOpts = new[]
        {
            "decrypt",
            "encrypt",
            "sign",
            "unwrapKey",
            "verify",
            "wrapKey",
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            client,
            cluster,
        },
    });

    var exampleClusterCustomerManagedKey = new Azure.Kusto.ClusterCustomerManagedKey("example", new()
    {
        ClusterId = exampleCluster.Id,
        KeyVaultId = exampleKeyVault.Id,
        KeyName = exampleKey.Name,
        KeyVersion = exampleKey.Version,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.CoreFunctions;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.keyvault.KeyVault;
import com.pulumi.azure.keyvault.KeyVaultArgs;
import com.pulumi.azure.kusto.Cluster;
import com.pulumi.azure.kusto.ClusterArgs;
import com.pulumi.azure.kusto.inputs.ClusterSkuArgs;
import com.pulumi.azure.kusto.inputs.ClusterIdentityArgs;
import com.pulumi.azure.keyvault.AccessPolicy;
import com.pulumi.azure.keyvault.AccessPolicyArgs;
import com.pulumi.azure.keyvault.Key;
import com.pulumi.azure.keyvault.KeyArgs;
import com.pulumi.azure.kusto.ClusterCustomerManagedKey;
import com.pulumi.azure.kusto.ClusterCustomerManagedKeyArgs;
import com.pulumi.resources.CustomResourceOptions;
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 current = CoreFunctions.getClientConfig(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference);

        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleKeyVault = new KeyVault("exampleKeyVault", KeyVaultArgs.builder()
            .name("examplekv")
            .location(example.location())
            .resourceGroupName(example.name())
            .tenantId(current.tenantId())
            .skuName("standard")
            .purgeProtectionEnabled(true)
            .build());

        var exampleCluster = new Cluster("exampleCluster", ClusterArgs.builder()
            .name("kustocluster")
            .location(example.location())
            .resourceGroupName(example.name())
            .sku(ClusterSkuArgs.builder()
                .name("Standard_D13_v2")
                .capacity(2)
                .build())
            .identity(ClusterIdentityArgs.builder()
                .type("SystemAssigned")
                .build())
            .build());

        var cluster = new AccessPolicy("cluster", AccessPolicyArgs.builder()
            .keyVaultId(exampleKeyVault.id())
            .tenantId(current.tenantId())
            .objectId(exampleCluster.identity().applyValue(_identity -> _identity.principalId()))
            .keyPermissions(            
                "Get",
                "UnwrapKey",
                "WrapKey")
            .build());

        var client = new AccessPolicy("client", AccessPolicyArgs.builder()
            .keyVaultId(exampleKeyVault.id())
            .tenantId(current.tenantId())
            .objectId(current.objectId())
            .keyPermissions(            
                "Get",
                "List",
                "Create",
                "Delete",
                "Recover",
                "GetRotationPolicy")
            .build());

        var exampleKey = new Key("exampleKey", KeyArgs.builder()
            .name("tfex-key")
            .keyVaultId(exampleKeyVault.id())
            .keyType("RSA")
            .keySize(2048)
            .keyOpts(            
                "decrypt",
                "encrypt",
                "sign",
                "unwrapKey",
                "verify",
                "wrapKey")
            .build(), CustomResourceOptions.builder()
                .dependsOn(                
                    client,
                    cluster)
                .build());

        var exampleClusterCustomerManagedKey = new ClusterCustomerManagedKey("exampleClusterCustomerManagedKey", ClusterCustomerManagedKeyArgs.builder()
            .clusterId(exampleCluster.id())
            .keyVaultId(exampleKeyVault.id())
            .keyName(exampleKey.name())
            .keyVersion(exampleKey.version())
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleKeyVault:
    type: azure:keyvault:KeyVault
    name: example
    properties:
      name: examplekv
      location: ${example.location}
      resourceGroupName: ${example.name}
      tenantId: ${current.tenantId}
      skuName: standard
      purgeProtectionEnabled: true
  cluster:
    type: azure:keyvault:AccessPolicy
    properties:
      keyVaultId: ${exampleKeyVault.id}
      tenantId: ${current.tenantId}
      objectId: ${exampleCluster.identity.principalId}
      keyPermissions:
        - Get
        - UnwrapKey
        - WrapKey
  client:
    type: azure:keyvault:AccessPolicy
    properties:
      keyVaultId: ${exampleKeyVault.id}
      tenantId: ${current.tenantId}
      objectId: ${current.objectId}
      keyPermissions:
        - Get
        - List
        - Create
        - Delete
        - Recover
        - GetRotationPolicy
  exampleKey:
    type: azure:keyvault:Key
    name: example
    properties:
      name: tfex-key
      keyVaultId: ${exampleKeyVault.id}
      keyType: RSA
      keySize: 2048
      keyOpts:
        - decrypt
        - encrypt
        - sign
        - unwrapKey
        - verify
        - wrapKey
    options:
      dependsOn:
        - ${client}
        - ${cluster}
  exampleCluster:
    type: azure:kusto:Cluster
    name: example
    properties:
      name: kustocluster
      location: ${example.location}
      resourceGroupName: ${example.name}
      sku:
        name: Standard_D13_v2
        capacity: 2
      identity:
        type: SystemAssigned
  exampleClusterCustomerManagedKey:
    type: azure:kusto:ClusterCustomerManagedKey
    name: example
    properties:
      clusterId: ${exampleCluster.id}
      keyVaultId: ${exampleKeyVault.id}
      keyName: ${exampleKey.name}
      keyVersion: ${exampleKey.version}
variables:
  current:
    fn::invoke:
      function: azure:core:getClientConfig
      arguments: {}

    API Providers

    This resource uses the following Azure API Providers:

    • Microsoft.Kusto: 2024-04-13

    Create ClusterCustomerManagedKey Resource

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

    Constructor syntax

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

@overload
def ClusterCustomerManagedKey(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              cluster_id: Optional[str] = None,
                              key_name: Optional[str] = None,
                              key_vault_id: Optional[str] = None,
                              key_version: Optional[str] = None,
                              user_identity: Optional[str] = None)
    func NewClusterCustomerManagedKey(ctx *Context, name string, args ClusterCustomerManagedKeyArgs, opts ...ResourceOption) (*ClusterCustomerManagedKey, error)
    public ClusterCustomerManagedKey(string name, ClusterCustomerManagedKeyArgs args, CustomResourceOptions? opts = null)
    public ClusterCustomerManagedKey(String name, ClusterCustomerManagedKeyArgs args)
public ClusterCustomerManagedKey(String name, ClusterCustomerManagedKeyArgs args, CustomResourceOptions options)

    type: azure:kusto:ClusterCustomerManagedKey
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 ClusterCustomerManagedKeyArgs
    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 ClusterCustomerManagedKeyArgs
    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 ClusterCustomerManagedKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterCustomerManagedKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterCustomerManagedKeyArgs
    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 clusterCustomerManagedKeyResource = new Azure.Kusto.ClusterCustomerManagedKey("clusterCustomerManagedKeyResource", new()
{
    ClusterId = "string",
    KeyName = "string",
    KeyVaultId = "string",
    KeyVersion = "string",
    UserIdentity = "string",
});

    example, err := kusto.NewClusterCustomerManagedKey(ctx, "clusterCustomerManagedKeyResource", &kusto.ClusterCustomerManagedKeyArgs{
	ClusterId:    pulumi.String("string"),
	KeyName:      pulumi.String("string"),
	KeyVaultId:   pulumi.String("string"),
	KeyVersion:   pulumi.String("string"),
	UserIdentity: pulumi.String("string"),
})

    var clusterCustomerManagedKeyResource = new com.pulumi.azure.kusto.ClusterCustomerManagedKey("clusterCustomerManagedKeyResource", com.pulumi.azure.kusto.ClusterCustomerManagedKeyArgs.builder()
    .clusterId("string")
    .keyName("string")
    .keyVaultId("string")
    .keyVersion("string")
    .userIdentity("string")
    .build());

    cluster_customer_managed_key_resource = azure.kusto.ClusterCustomerManagedKey("clusterCustomerManagedKeyResource",
    cluster_id="string",
    key_name="string",
    key_vault_id="string",
    key_version="string",
    user_identity="string")

    const clusterCustomerManagedKeyResource = new azure.kusto.ClusterCustomerManagedKey("clusterCustomerManagedKeyResource", {
    clusterId: "string",
    keyName: "string",
    keyVaultId: "string",
    keyVersion: "string",
    userIdentity: "string",
});

    type: azure:kusto:ClusterCustomerManagedKey
properties:
    clusterId: string
    keyName: string
    keyVaultId: string
    keyVersion: string
    userIdentity: string

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

    ClusterId string
    The ID of the Kusto Cluster. Changing this forces a new resource to be created.
    KeyName string
    The name of Key Vault Key.
    KeyVaultId string
    The ID of the Key Vault.
    KeyVersion string
    The version of Key Vault Key.
    UserIdentity string
    The user assigned identity that has access to the Key Vault Key. If not specified, system assigned identity will be used.
    ClusterId string
    The ID of the Kusto Cluster. Changing this forces a new resource to be created.
    KeyName string
    The name of Key Vault Key.
    KeyVaultId string
    The ID of the Key Vault.
    KeyVersion string
    The version of Key Vault Key.
    UserIdentity string
    The user assigned identity that has access to the Key Vault Key. If not specified, system assigned identity will be used.
    clusterId String
    The ID of the Kusto Cluster. Changing this forces a new resource to be created.
    keyName String
    The name of Key Vault Key.
    keyVaultId String
    The ID of the Key Vault.
    keyVersion String
    The version of Key Vault Key.
    userIdentity String
    The user assigned identity that has access to the Key Vault Key. If not specified, system assigned identity will be used.
    clusterId string
    The ID of the Kusto Cluster. Changing this forces a new resource to be created.
    keyName string
    The name of Key Vault Key.
    keyVaultId string
    The ID of the Key Vault.
    keyVersion string
    The version of Key Vault Key.
    userIdentity string
    The user assigned identity that has access to the Key Vault Key. If not specified, system assigned identity will be used.
    cluster_id str
    The ID of the Kusto Cluster. Changing this forces a new resource to be created.
    key_name str
    The name of Key Vault Key.
    key_vault_id str
    The ID of the Key Vault.
    key_version str
    The version of Key Vault Key.
    user_identity str
    The user assigned identity that has access to the Key Vault Key. If not specified, system assigned identity will be used.
    clusterId String
    The ID of the Kusto Cluster. Changing this forces a new resource to be created.
    keyName String
    The name of Key Vault Key.
    keyVaultId String
    The ID of the Key Vault.
    keyVersion String
    The version of Key Vault Key.
    userIdentity String
    The user assigned identity that has access to the Key Vault Key. If not specified, system assigned identity will be used.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ClusterCustomerManagedKey Resource

    Get an existing ClusterCustomerManagedKey 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?: ClusterCustomerManagedKeyState, opts?: CustomResourceOptions): ClusterCustomerManagedKey
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        key_name: Optional[str] = None,
        key_vault_id: Optional[str] = None,
        key_version: Optional[str] = None,
        user_identity: Optional[str] = None) -> ClusterCustomerManagedKey
    func GetClusterCustomerManagedKey(ctx *Context, name string, id IDInput, state *ClusterCustomerManagedKeyState, opts ...ResourceOption) (*ClusterCustomerManagedKey, error)
    public static ClusterCustomerManagedKey Get(string name, Input<string> id, ClusterCustomerManagedKeyState? state, CustomResourceOptions? opts = null)
    public static ClusterCustomerManagedKey get(String name, Output<String> id, ClusterCustomerManagedKeyState state, CustomResourceOptions options)
    resources:  _:    type: azure:kusto:ClusterCustomerManagedKey    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 ID of the Kusto Cluster. Changing this forces a new resource to be created.
    KeyName string
    The name of Key Vault Key.
    KeyVaultId string
    The ID of the Key Vault.
    KeyVersion string
    The version of Key Vault Key.
    UserIdentity string
    The user assigned identity that has access to the Key Vault Key. If not specified, system assigned identity will be used.
    ClusterId string
    The ID of the Kusto Cluster. Changing this forces a new resource to be created.
    KeyName string
    The name of Key Vault Key.
    KeyVaultId string
    The ID of the Key Vault.
    KeyVersion string
    The version of Key Vault Key.
    UserIdentity string
    The user assigned identity that has access to the Key Vault Key. If not specified, system assigned identity will be used.
    clusterId String
    The ID of the Kusto Cluster. Changing this forces a new resource to be created.
    keyName String
    The name of Key Vault Key.
    keyVaultId String
    The ID of the Key Vault.
    keyVersion String
    The version of Key Vault Key.
    userIdentity String
    The user assigned identity that has access to the Key Vault Key. If not specified, system assigned identity will be used.
    clusterId string
    The ID of the Kusto Cluster. Changing this forces a new resource to be created.
    keyName string
    The name of Key Vault Key.
    keyVaultId string
    The ID of the Key Vault.
    keyVersion string
    The version of Key Vault Key.
    userIdentity string
    The user assigned identity that has access to the Key Vault Key. If not specified, system assigned identity will be used.
    cluster_id str
    The ID of the Kusto Cluster. Changing this forces a new resource to be created.
    key_name str
    The name of Key Vault Key.
    key_vault_id str
    The ID of the Key Vault.
    key_version str
    The version of Key Vault Key.
    user_identity str
    The user assigned identity that has access to the Key Vault Key. If not specified, system assigned identity will be used.
    clusterId String
    The ID of the Kusto Cluster. Changing this forces a new resource to be created.
    keyName String
    The name of Key Vault Key.
    keyVaultId String
    The ID of the Key Vault.
    keyVersion String
    The version of Key Vault Key.
    userIdentity String
    The user assigned identity that has access to the Key Vault Key. If not specified, system assigned identity will be used.

    Import

    Customer Managed Keys for a Kusto Cluster can be imported using the resource id, e.g.

    $ pulumi import azure:kusto/clusterCustomerManagedKey:ClusterCustomerManagedKey example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Kusto/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.

    Azure v6.23.0 published on Thursday, May 22, 2025 by Pulumi
    pulumi/pulumi-azure