azure-native.kusto.ClusterPrincipalAssignment
Explore with Pulumi AI
Class representing a cluster principal assignment. Azure REST API version: 2022-12-29. Prior API version in Azure Native 1.x: 2021-01-01.
Other available API versions: 2023-05-02, 2023-08-15, 2024-04-13.
Example Usage
KustoClusterPrincipalAssignmentsCreateOrUpdate
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() => 
{
    var clusterPrincipalAssignment = new AzureNative.Kusto.ClusterPrincipalAssignment("clusterPrincipalAssignment", new()
    {
        ClusterName = "kustoCluster",
        PrincipalAssignmentName = "kustoprincipal1",
        PrincipalId = "87654321-1234-1234-1234-123456789123",
        PrincipalType = AzureNative.Kusto.PrincipalType.App,
        ResourceGroupName = "kustorptest",
        Role = AzureNative.Kusto.ClusterPrincipalRole.AllDatabasesAdmin,
        TenantId = "12345678-1234-1234-1234-123456789123",
    });
});
package main
import (
	kusto "github.com/pulumi/pulumi-azure-native-sdk/kusto/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kusto.NewClusterPrincipalAssignment(ctx, "clusterPrincipalAssignment", &kusto.ClusterPrincipalAssignmentArgs{
			ClusterName:             pulumi.String("kustoCluster"),
			PrincipalAssignmentName: pulumi.String("kustoprincipal1"),
			PrincipalId:             pulumi.String("87654321-1234-1234-1234-123456789123"),
			PrincipalType:           pulumi.String(kusto.PrincipalTypeApp),
			ResourceGroupName:       pulumi.String("kustorptest"),
			Role:                    pulumi.String(kusto.ClusterPrincipalRoleAllDatabasesAdmin),
			TenantId:                pulumi.String("12345678-1234-1234-1234-123456789123"),
		})
		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.azurenative.kusto.ClusterPrincipalAssignment;
import com.pulumi.azurenative.kusto.ClusterPrincipalAssignmentArgs;
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 clusterPrincipalAssignment = new ClusterPrincipalAssignment("clusterPrincipalAssignment", ClusterPrincipalAssignmentArgs.builder()
            .clusterName("kustoCluster")
            .principalAssignmentName("kustoprincipal1")
            .principalId("87654321-1234-1234-1234-123456789123")
            .principalType("App")
            .resourceGroupName("kustorptest")
            .role("AllDatabasesAdmin")
            .tenantId("12345678-1234-1234-1234-123456789123")
            .build());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const clusterPrincipalAssignment = new azure_native.kusto.ClusterPrincipalAssignment("clusterPrincipalAssignment", {
    clusterName: "kustoCluster",
    principalAssignmentName: "kustoprincipal1",
    principalId: "87654321-1234-1234-1234-123456789123",
    principalType: azure_native.kusto.PrincipalType.App,
    resourceGroupName: "kustorptest",
    role: azure_native.kusto.ClusterPrincipalRole.AllDatabasesAdmin,
    tenantId: "12345678-1234-1234-1234-123456789123",
});
import pulumi
import pulumi_azure_native as azure_native
cluster_principal_assignment = azure_native.kusto.ClusterPrincipalAssignment("clusterPrincipalAssignment",
    cluster_name="kustoCluster",
    principal_assignment_name="kustoprincipal1",
    principal_id="87654321-1234-1234-1234-123456789123",
    principal_type=azure_native.kusto.PrincipalType.APP,
    resource_group_name="kustorptest",
    role=azure_native.kusto.ClusterPrincipalRole.ALL_DATABASES_ADMIN,
    tenant_id="12345678-1234-1234-1234-123456789123")
resources:
  clusterPrincipalAssignment:
    type: azure-native:kusto:ClusterPrincipalAssignment
    properties:
      clusterName: kustoCluster
      principalAssignmentName: kustoprincipal1
      principalId: 87654321-1234-1234-1234-123456789123
      principalType: App
      resourceGroupName: kustorptest
      role: AllDatabasesAdmin
      tenantId: 12345678-1234-1234-1234-123456789123
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[Union[str, PrincipalType]] = None,
                               resource_group_name: Optional[str] = None,
                               role: Optional[Union[str, ClusterPrincipalRole]] = None,
                               principal_assignment_name: Optional[str] = None,
                               tenant_id: 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-native: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 AzureNative.Kusto.ClusterPrincipalAssignment("clusterPrincipalAssignmentResource", new()
{
    ClusterName = "string",
    PrincipalId = "string",
    PrincipalType = "string",
    ResourceGroupName = "string",
    Role = "string",
    PrincipalAssignmentName = "string",
    TenantId = "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"),
	PrincipalAssignmentName: pulumi.String("string"),
	TenantId:                pulumi.String("string"),
})
var clusterPrincipalAssignmentResource = new ClusterPrincipalAssignment("clusterPrincipalAssignmentResource", ClusterPrincipalAssignmentArgs.builder()
    .clusterName("string")
    .principalId("string")
    .principalType("string")
    .resourceGroupName("string")
    .role("string")
    .principalAssignmentName("string")
    .tenantId("string")
    .build());
cluster_principal_assignment_resource = azure_native.kusto.ClusterPrincipalAssignment("clusterPrincipalAssignmentResource",
    cluster_name="string",
    principal_id="string",
    principal_type="string",
    resource_group_name="string",
    role="string",
    principal_assignment_name="string",
    tenant_id="string")
const clusterPrincipalAssignmentResource = new azure_native.kusto.ClusterPrincipalAssignment("clusterPrincipalAssignmentResource", {
    clusterName: "string",
    principalId: "string",
    principalType: "string",
    resourceGroupName: "string",
    role: "string",
    principalAssignmentName: "string",
    tenantId: "string",
});
type: azure-native:kusto:ClusterPrincipalAssignment
properties:
    clusterName: string
    principalAssignmentName: 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 Kusto cluster.
- PrincipalId string
- The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name.
- PrincipalType string | Pulumi.Azure Native. Kusto. Principal Type 
- Principal type.
- ResourceGroup stringName 
- The name of the resource group containing the Kusto cluster.
- Role
string | Pulumi.Azure Native. Kusto. Cluster Principal Role 
- Cluster principal role.
- PrincipalAssignment stringName 
- The name of the Kusto principalAssignment.
- TenantId string
- The tenant id of the principal
- ClusterName string
- The name of the Kusto cluster.
- PrincipalId string
- The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name.
- PrincipalType string | PrincipalType 
- Principal type.
- ResourceGroup stringName 
- The name of the resource group containing the Kusto cluster.
- Role
string | ClusterPrincipal Role 
- Cluster principal role.
- PrincipalAssignment stringName 
- The name of the Kusto principalAssignment.
- TenantId string
- The tenant id of the principal
- clusterName String
- The name of the Kusto cluster.
- principalId String
- The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name.
- principalType String | PrincipalType 
- Principal type.
- resourceGroup StringName 
- The name of the resource group containing the Kusto cluster.
- role
String | ClusterPrincipal Role 
- Cluster principal role.
- principalAssignment StringName 
- The name of the Kusto principalAssignment.
- tenantId String
- The tenant id of the principal
- clusterName string
- The name of the Kusto cluster.
- principalId string
- The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name.
- principalType string | PrincipalType 
- Principal type.
- resourceGroup stringName 
- The name of the resource group containing the Kusto cluster.
- role
string | ClusterPrincipal Role 
- Cluster principal role.
- principalAssignment stringName 
- The name of the Kusto principalAssignment.
- tenantId string
- The tenant id of the principal
- cluster_name str
- The name of the Kusto cluster.
- principal_id str
- The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name.
- principal_type str | PrincipalType 
- Principal type.
- resource_group_ strname 
- The name of the resource group containing the Kusto cluster.
- role
str | ClusterPrincipal Role 
- Cluster principal role.
- principal_assignment_ strname 
- The name of the Kusto principalAssignment.
- tenant_id str
- The tenant id of the principal
- clusterName String
- The name of the Kusto cluster.
- principalId String
- The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name.
- principalType String | "App" | "Group" | "User"
- Principal type.
- resourceGroup StringName 
- The name of the resource group containing the Kusto cluster.
- role
String | "AllDatabases Admin" | "All Databases Viewer" 
- Cluster principal role.
- principalAssignment StringName 
- The name of the Kusto principalAssignment.
- tenantId String
- The tenant id of the principal
Outputs
All input properties are implicitly available as output properties. Additionally, the ClusterPrincipalAssignment resource produces the following output properties:
- AadObject stringId 
- The service principal object id in AAD (Azure active directory)
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- PrincipalName string
- The principal name
- ProvisioningState string
- The provisioned state of the resource.
- TenantName string
- The tenant name of the principal
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- AadObject stringId 
- The service principal object id in AAD (Azure active directory)
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- PrincipalName string
- The principal name
- ProvisioningState string
- The provisioned state of the resource.
- TenantName string
- The tenant name of the principal
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- aadObject StringId 
- The service principal object id in AAD (Azure active directory)
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- principalName String
- The principal name
- provisioningState String
- The provisioned state of the resource.
- tenantName String
- The tenant name of the principal
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- aadObject stringId 
- The service principal object id in AAD (Azure active directory)
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- principalName string
- The principal name
- provisioningState string
- The provisioned state of the resource.
- tenantName string
- The tenant name of the principal
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- aad_object_ strid 
- The service principal object id in AAD (Azure active directory)
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- principal_name str
- The principal name
- provisioning_state str
- The provisioned state of the resource.
- tenant_name str
- The tenant name of the principal
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- aadObject StringId 
- The service principal object id in AAD (Azure active directory)
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- principalName String
- The principal name
- provisioningState String
- The provisioned state of the resource.
- tenantName String
- The tenant name of the principal
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Supporting Types
ClusterPrincipalRole, ClusterPrincipalRoleArgs      
- AllDatabases Admin 
- AllDatabasesAdmin
- AllDatabases Viewer 
- AllDatabasesViewer
- ClusterPrincipal Role All Databases Admin 
- AllDatabasesAdmin
- ClusterPrincipal Role All Databases Viewer 
- AllDatabasesViewer
- AllDatabases Admin 
- AllDatabasesAdmin
- AllDatabases Viewer 
- AllDatabasesViewer
- AllDatabases Admin 
- AllDatabasesAdmin
- AllDatabases Viewer 
- AllDatabasesViewer
- ALL_DATABASES_ADMIN
- AllDatabasesAdmin
- ALL_DATABASES_VIEWER
- AllDatabasesViewer
- "AllDatabases Admin" 
- AllDatabasesAdmin
- "AllDatabases Viewer" 
- AllDatabasesViewer
PrincipalType, PrincipalTypeArgs    
- App
- App
- Group
- Group
- User
- User
- PrincipalType App 
- App
- PrincipalType Group 
- Group
- PrincipalType User 
- User
- App
- App
- Group
- Group
- User
- User
- App
- App
- Group
- Group
- User
- User
- APP
- App
- GROUP
- Group
- USER
- User
- "App"
- App
- "Group"
- Group
- "User"
- User
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:kusto:ClusterPrincipalAssignment kustoCluster/kustoprincipal1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/principalAssignments/{principalAssignmentName} 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0