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. ClusterPrincipalAssignment

We recommend using Azure Native.

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

azure.kusto.ClusterPrincipalAssignment

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 Kusto Cluster Principal Assignment.

    Create ClusterPrincipalAssignment Resource

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

    Constructor syntax

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

@overload
def ClusterPrincipalAssignment(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               cluster_name: Optional[str] = None,
                               principal_id: Optional[str] = None,
                               principal_type: Optional[str] = None,
                               resource_group_name: Optional[str] = None,
                               role: Optional[str] = None,
                               tenant_id: Optional[str] = None,
                               name: Optional[str] = None)
    func NewClusterPrincipalAssignment(ctx *Context, name string, args ClusterPrincipalAssignmentArgs, opts ...ResourceOption) (*ClusterPrincipalAssignment, error)
    public ClusterPrincipalAssignment(string name, ClusterPrincipalAssignmentArgs args, CustomResourceOptions? opts = null)
    public ClusterPrincipalAssignment(String name, ClusterPrincipalAssignmentArgs args)
public ClusterPrincipalAssignment(String name, ClusterPrincipalAssignmentArgs args, CustomResourceOptions options)

    type: azure:kusto:ClusterPrincipalAssignment
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 ClusterPrincipalAssignmentArgs
    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 ClusterPrincipalAssignmentArgs
    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 ClusterPrincipalAssignmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterPrincipalAssignmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterPrincipalAssignmentArgs
    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 clusterPrincipalAssignmentResource = new Azure.Kusto.ClusterPrincipalAssignment("clusterPrincipalAssignmentResource", new()
{
    ClusterName = "string",
    PrincipalId = "string",
    PrincipalType = "string",
    ResourceGroupName = "string",
    Role = "string",
    TenantId = "string",
    Name = "string",
});

    example, err := kusto.NewClusterPrincipalAssignment(ctx, "clusterPrincipalAssignmentResource", &kusto.ClusterPrincipalAssignmentArgs{
	ClusterName:       pulumi.String("string"),
	PrincipalId:       pulumi.String("string"),
	PrincipalType:     pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	Role:              pulumi.String("string"),
	TenantId:          pulumi.String("string"),
	Name:              pulumi.String("string"),
})

    var clusterPrincipalAssignmentResource = new ClusterPrincipalAssignment("clusterPrincipalAssignmentResource", ClusterPrincipalAssignmentArgs.builder()
    .clusterName("string")
    .principalId("string")
    .principalType("string")
    .resourceGroupName("string")
    .role("string")
    .tenantId("string")
    .name("string")
    .build());

    cluster_principal_assignment_resource = azure.kusto.ClusterPrincipalAssignment("clusterPrincipalAssignmentResource",
    cluster_name="string",
    principal_id="string",
    principal_type="string",
    resource_group_name="string",
    role="string",
    tenant_id="string",
    name="string")

    const clusterPrincipalAssignmentResource = new azure.kusto.ClusterPrincipalAssignment("clusterPrincipalAssignmentResource", {
    clusterName: "string",
    principalId: "string",
    principalType: "string",
    resourceGroupName: "string",
    role: "string",
    tenantId: "string",
    name: "string",
});

    type: azure:kusto:ClusterPrincipalAssignment
properties:
    clusterName: string
    name: string
    principalId: string
    principalType: string
    resourceGroupName: string
    role: string
    tenantId: string

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

    ClusterName string
    The name of the cluster in which to create the resource. Changing this forces a new resource to be created.
    PrincipalId string
    The object id of the principal. Changing this forces a new resource to be created.
    PrincipalType string
    The type of the principal. Valid values include App, Group, User. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which to create the resource. Changing this forces a new resource to be created.
    Role string
    The cluster role assigned to the principal. Valid values include AllDatabasesAdmin, AllDatabasesViewer, and AllDatabasesMonitor. Changing this forces a new resource to be created.
    TenantId string
    The tenant id in which the principal resides. Changing this forces a new resource to be created.
    Name string
    The name of the Kusto cluster principal assignment. Changing this forces a new resource to be created.
    ClusterName string
    The name of the cluster in which to create the resource. Changing this forces a new resource to be created.
    PrincipalId string
    The object id of the principal. Changing this forces a new resource to be created.
    PrincipalType string
    The type of the principal. Valid values include App, Group, User. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which to create the resource. Changing this forces a new resource to be created.
    Role string
    The cluster role assigned to the principal. Valid values include AllDatabasesAdmin, AllDatabasesViewer, and AllDatabasesMonitor. Changing this forces a new resource to be created.
    TenantId string
    The tenant id in which the principal resides. Changing this forces a new resource to be created.
    Name string
    The name of the Kusto cluster principal assignment. Changing this forces a new resource to be created.
    clusterName String
    The name of the cluster in which to create the resource. Changing this forces a new resource to be created.
    principalId String
    The object id of the principal. Changing this forces a new resource to be created.
    principalType String
    The type of the principal. Valid values include App, Group, User. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which to create the resource. Changing this forces a new resource to be created.
    role String
    The cluster role assigned to the principal. Valid values include AllDatabasesAdmin, AllDatabasesViewer, and AllDatabasesMonitor. Changing this forces a new resource to be created.
    tenantId String
    The tenant id in which the principal resides. Changing this forces a new resource to be created.
    name String
    The name of the Kusto cluster principal assignment. Changing this forces a new resource to be created.
    clusterName string
    The name of the cluster in which to create the resource. Changing this forces a new resource to be created.
    principalId string
    The object id of the principal. Changing this forces a new resource to be created.
    principalType string
    The type of the principal. Valid values include App, Group, User. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group in which to create the resource. Changing this forces a new resource to be created.
    role string
    The cluster role assigned to the principal. Valid values include AllDatabasesAdmin, AllDatabasesViewer, and AllDatabasesMonitor. Changing this forces a new resource to be created.
    tenantId string
    The tenant id in which the principal resides. Changing this forces a new resource to be created.
    name string
    The name of the Kusto cluster principal assignment. Changing this forces a new resource to be created.
    cluster_name str
    The name of the cluster in which to create the resource. Changing this forces a new resource to be created.
    principal_id str
    The object id of the principal. Changing this forces a new resource to be created.
    principal_type str
    The type of the principal. Valid values include App, Group, User. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group in which to create the resource. Changing this forces a new resource to be created.
    role str
    The cluster role assigned to the principal. Valid values include AllDatabasesAdmin, AllDatabasesViewer, and AllDatabasesMonitor. Changing this forces a new resource to be created.
    tenant_id str
    The tenant id in which the principal resides. Changing this forces a new resource to be created.
    name str
    The name of the Kusto cluster principal assignment. Changing this forces a new resource to be created.
    clusterName String
    The name of the cluster in which to create the resource. Changing this forces a new resource to be created.
    principalId String
    The object id of the principal. Changing this forces a new resource to be created.
    principalType String
    The type of the principal. Valid values include App, Group, User. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which to create the resource. Changing this forces a new resource to be created.
    role String
    The cluster role assigned to the principal. Valid values include AllDatabasesAdmin, AllDatabasesViewer, and AllDatabasesMonitor. Changing this forces a new resource to be created.
    tenantId String
    The tenant id in which the principal resides. Changing this forces a new resource to be created.
    name String
    The name of the Kusto cluster principal assignment. Changing this forces a new resource to be created.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    PrincipalName string
    The name of the principal.
    TenantName string
    The name of the tenant.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrincipalName string
    The name of the principal.
    TenantName string
    The name of the tenant.
    id String
    The provider-assigned unique ID for this managed resource.
    principalName String
    The name of the principal.
    tenantName String
    The name of the tenant.
    id string
    The provider-assigned unique ID for this managed resource.
    principalName string
    The name of the principal.
    tenantName string
    The name of the tenant.
    id str
    The provider-assigned unique ID for this managed resource.
    principal_name str
    The name of the principal.
    tenant_name str
    The name of the tenant.
    id String
    The provider-assigned unique ID for this managed resource.
    principalName String
    The name of the principal.
    tenantName String
    The name of the tenant.

    Look up Existing ClusterPrincipalAssignment Resource

    Get an existing ClusterPrincipalAssignment 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?: ClusterPrincipalAssignmentState, opts?: CustomResourceOptions): ClusterPrincipalAssignment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_name: Optional[str] = None,
        name: Optional[str] = None,
        principal_id: Optional[str] = None,
        principal_name: Optional[str] = None,
        principal_type: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        role: Optional[str] = None,
        tenant_id: Optional[str] = None,
        tenant_name: Optional[str] = None) -> ClusterPrincipalAssignment
    func GetClusterPrincipalAssignment(ctx *Context, name string, id IDInput, state *ClusterPrincipalAssignmentState, opts ...ResourceOption) (*ClusterPrincipalAssignment, error)
    public static ClusterPrincipalAssignment Get(string name, Input<string> id, ClusterPrincipalAssignmentState? state, CustomResourceOptions? opts = null)
    public static ClusterPrincipalAssignment get(String name, Output<String> id, ClusterPrincipalAssignmentState state, CustomResourceOptions options)
    resources:  _:    type: azure:kusto:ClusterPrincipalAssignment    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:
    ClusterName string
    The name of the cluster in which to create the resource. Changing this forces a new resource to be created.
    Name string
    The name of the Kusto cluster principal assignment. Changing this forces a new resource to be created.
    PrincipalId string
    The object id of the principal. Changing this forces a new resource to be created.
    PrincipalName string
    The name of the principal.
    PrincipalType string
    The type of the principal. Valid values include App, Group, User. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which to create the resource. Changing this forces a new resource to be created.
    Role string
    The cluster role assigned to the principal. Valid values include AllDatabasesAdmin, AllDatabasesViewer, and AllDatabasesMonitor. Changing this forces a new resource to be created.
    TenantId string
    The tenant id in which the principal resides. Changing this forces a new resource to be created.
    TenantName string
    The name of the tenant.
    ClusterName string
    The name of the cluster in which to create the resource. Changing this forces a new resource to be created.
    Name string
    The name of the Kusto cluster principal assignment. Changing this forces a new resource to be created.
    PrincipalId string
    The object id of the principal. Changing this forces a new resource to be created.
    PrincipalName string
    The name of the principal.
    PrincipalType string
    The type of the principal. Valid values include App, Group, User. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which to create the resource. Changing this forces a new resource to be created.
    Role string
    The cluster role assigned to the principal. Valid values include AllDatabasesAdmin, AllDatabasesViewer, and AllDatabasesMonitor. Changing this forces a new resource to be created.
    TenantId string
    The tenant id in which the principal resides. Changing this forces a new resource to be created.
    TenantName string
    The name of the tenant.
    clusterName String
    The name of the cluster in which to create the resource. Changing this forces a new resource to be created.
    name String
    The name of the Kusto cluster principal assignment. Changing this forces a new resource to be created.
    principalId String
    The object id of the principal. Changing this forces a new resource to be created.
    principalName String
    The name of the principal.
    principalType String
    The type of the principal. Valid values include App, Group, User. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which to create the resource. Changing this forces a new resource to be created.
    role String
    The cluster role assigned to the principal. Valid values include AllDatabasesAdmin, AllDatabasesViewer, and AllDatabasesMonitor. Changing this forces a new resource to be created.
    tenantId String
    The tenant id in which the principal resides. Changing this forces a new resource to be created.
    tenantName String
    The name of the tenant.
    clusterName string
    The name of the cluster in which to create the resource. Changing this forces a new resource to be created.
    name string
    The name of the Kusto cluster principal assignment. Changing this forces a new resource to be created.
    principalId string
    The object id of the principal. Changing this forces a new resource to be created.
    principalName string
    The name of the principal.
    principalType string
    The type of the principal. Valid values include App, Group, User. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group in which to create the resource. Changing this forces a new resource to be created.
    role string
    The cluster role assigned to the principal. Valid values include AllDatabasesAdmin, AllDatabasesViewer, and AllDatabasesMonitor. Changing this forces a new resource to be created.
    tenantId string
    The tenant id in which the principal resides. Changing this forces a new resource to be created.
    tenantName string
    The name of the tenant.
    cluster_name str
    The name of the cluster in which to create the resource. Changing this forces a new resource to be created.
    name str
    The name of the Kusto cluster principal assignment. Changing this forces a new resource to be created.
    principal_id str
    The object id of the principal. Changing this forces a new resource to be created.
    principal_name str
    The name of the principal.
    principal_type str
    The type of the principal. Valid values include App, Group, User. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group in which to create the resource. Changing this forces a new resource to be created.
    role str
    The cluster role assigned to the principal. Valid values include AllDatabasesAdmin, AllDatabasesViewer, and AllDatabasesMonitor. Changing this forces a new resource to be created.
    tenant_id str
    The tenant id in which the principal resides. Changing this forces a new resource to be created.
    tenant_name str
    The name of the tenant.
    clusterName String
    The name of the cluster in which to create the resource. Changing this forces a new resource to be created.
    name String
    The name of the Kusto cluster principal assignment. Changing this forces a new resource to be created.
    principalId String
    The object id of the principal. Changing this forces a new resource to be created.
    principalName String
    The name of the principal.
    principalType String
    The type of the principal. Valid values include App, Group, User. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which to create the resource. Changing this forces a new resource to be created.
    role String
    The cluster role assigned to the principal. Valid values include AllDatabasesAdmin, AllDatabasesViewer, and AllDatabasesMonitor. Changing this forces a new resource to be created.
    tenantId String
    The tenant id in which the principal resides. Changing this forces a new resource to be created.
    tenantName String
    The name of the tenant.

    Import

    Data Explorer Cluster Principal Assignments can be imported using the resource id, e.g.

    $ pulumi import azure:kusto/clusterPrincipalAssignment:ClusterPrincipalAssignment example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Kusto/clusters/cluster1/principalAssignments/assignment1

    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