Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. synapse
  5. KustoPoolPrincipalAssignment
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.synapse.KustoPoolPrincipalAssignment

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Class representing a cluster principal assignment.

Uses Azure REST API version 2021-06-01-preview. In version 2.x of the Azure Native provider, it used API version 2021-06-01-preview.

Other available API versions: 2021-04-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native synapse [ApiVersion]. See the version guide for details.

Example Usage

KustoPoolPrincipalAssignmentsCreateOrUpdate

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

return await Deployment.RunAsync(() => 
{
    var kustoPoolPrincipalAssignment = new AzureNative.Synapse.KustoPoolPrincipalAssignment("kustoPoolPrincipalAssignment", new()
    {
        KustoPoolName = "kustoclusterrptest4",
        PrincipalAssignmentName = "kustoprincipal1",
        PrincipalId = "87654321-1234-1234-1234-123456789123",
        PrincipalType = AzureNative.Synapse.PrincipalType.App,
        ResourceGroupName = "kustorptest",
        Role = AzureNative.Synapse.ClusterPrincipalRole.AllDatabasesAdmin,
        TenantId = "12345678-1234-1234-1234-123456789123",
        WorkspaceName = "synapseWorkspaceName",
    });

});
Copy
package main

import (
	synapse "github.com/pulumi/pulumi-azure-native-sdk/synapse/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := synapse.NewKustoPoolPrincipalAssignment(ctx, "kustoPoolPrincipalAssignment", &synapse.KustoPoolPrincipalAssignmentArgs{
			KustoPoolName:           pulumi.String("kustoclusterrptest4"),
			PrincipalAssignmentName: pulumi.String("kustoprincipal1"),
			PrincipalId:             pulumi.String("87654321-1234-1234-1234-123456789123"),
			PrincipalType:           pulumi.String(synapse.PrincipalTypeApp),
			ResourceGroupName:       pulumi.String("kustorptest"),
			Role:                    pulumi.String(synapse.ClusterPrincipalRoleAllDatabasesAdmin),
			TenantId:                pulumi.String("12345678-1234-1234-1234-123456789123"),
			WorkspaceName:           pulumi.String("synapseWorkspaceName"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.synapse.KustoPoolPrincipalAssignment;
import com.pulumi.azurenative.synapse.KustoPoolPrincipalAssignmentArgs;
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 kustoPoolPrincipalAssignment = new KustoPoolPrincipalAssignment("kustoPoolPrincipalAssignment", KustoPoolPrincipalAssignmentArgs.builder()
            .kustoPoolName("kustoclusterrptest4")
            .principalAssignmentName("kustoprincipal1")
            .principalId("87654321-1234-1234-1234-123456789123")
            .principalType("App")
            .resourceGroupName("kustorptest")
            .role("AllDatabasesAdmin")
            .tenantId("12345678-1234-1234-1234-123456789123")
            .workspaceName("synapseWorkspaceName")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const kustoPoolPrincipalAssignment = new azure_native.synapse.KustoPoolPrincipalAssignment("kustoPoolPrincipalAssignment", {
    kustoPoolName: "kustoclusterrptest4",
    principalAssignmentName: "kustoprincipal1",
    principalId: "87654321-1234-1234-1234-123456789123",
    principalType: azure_native.synapse.PrincipalType.App,
    resourceGroupName: "kustorptest",
    role: azure_native.synapse.ClusterPrincipalRole.AllDatabasesAdmin,
    tenantId: "12345678-1234-1234-1234-123456789123",
    workspaceName: "synapseWorkspaceName",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

kusto_pool_principal_assignment = azure_native.synapse.KustoPoolPrincipalAssignment("kustoPoolPrincipalAssignment",
    kusto_pool_name="kustoclusterrptest4",
    principal_assignment_name="kustoprincipal1",
    principal_id="87654321-1234-1234-1234-123456789123",
    principal_type=azure_native.synapse.PrincipalType.APP,
    resource_group_name="kustorptest",
    role=azure_native.synapse.ClusterPrincipalRole.ALL_DATABASES_ADMIN,
    tenant_id="12345678-1234-1234-1234-123456789123",
    workspace_name="synapseWorkspaceName")
Copy
resources:
  kustoPoolPrincipalAssignment:
    type: azure-native:synapse:KustoPoolPrincipalAssignment
    properties:
      kustoPoolName: kustoclusterrptest4
      principalAssignmentName: kustoprincipal1
      principalId: 87654321-1234-1234-1234-123456789123
      principalType: App
      resourceGroupName: kustorptest
      role: AllDatabasesAdmin
      tenantId: 12345678-1234-1234-1234-123456789123
      workspaceName: synapseWorkspaceName
Copy

Create KustoPoolPrincipalAssignment Resource

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

Constructor syntax

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

@overload
def KustoPoolPrincipalAssignment(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 kusto_pool_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,
                                 workspace_name: Optional[str] = None,
                                 principal_assignment_name: Optional[str] = None,
                                 tenant_id: Optional[str] = None)
func NewKustoPoolPrincipalAssignment(ctx *Context, name string, args KustoPoolPrincipalAssignmentArgs, opts ...ResourceOption) (*KustoPoolPrincipalAssignment, error)
public KustoPoolPrincipalAssignment(string name, KustoPoolPrincipalAssignmentArgs args, CustomResourceOptions? opts = null)
public KustoPoolPrincipalAssignment(String name, KustoPoolPrincipalAssignmentArgs args)
public KustoPoolPrincipalAssignment(String name, KustoPoolPrincipalAssignmentArgs args, CustomResourceOptions options)

type: azure-native:synapse:KustoPoolPrincipalAssignment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. KustoPoolPrincipalAssignmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. KustoPoolPrincipalAssignmentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. KustoPoolPrincipalAssignmentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. KustoPoolPrincipalAssignmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. KustoPoolPrincipalAssignmentArgs
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 kustoPoolPrincipalAssignmentResource = new AzureNative.Synapse.KustoPoolPrincipalAssignment("kustoPoolPrincipalAssignmentResource", new()
{
    KustoPoolName = "string",
    PrincipalId = "string",
    PrincipalType = "string",
    ResourceGroupName = "string",
    Role = "string",
    WorkspaceName = "string",
    PrincipalAssignmentName = "string",
    TenantId = "string",
});
Copy
example, err := synapse.NewKustoPoolPrincipalAssignment(ctx, "kustoPoolPrincipalAssignmentResource", &synapse.KustoPoolPrincipalAssignmentArgs{
	KustoPoolName:           pulumi.String("string"),
	PrincipalId:             pulumi.String("string"),
	PrincipalType:           pulumi.String("string"),
	ResourceGroupName:       pulumi.String("string"),
	Role:                    pulumi.String("string"),
	WorkspaceName:           pulumi.String("string"),
	PrincipalAssignmentName: pulumi.String("string"),
	TenantId:                pulumi.String("string"),
})
Copy
var kustoPoolPrincipalAssignmentResource = new KustoPoolPrincipalAssignment("kustoPoolPrincipalAssignmentResource", KustoPoolPrincipalAssignmentArgs.builder()
    .kustoPoolName("string")
    .principalId("string")
    .principalType("string")
    .resourceGroupName("string")
    .role("string")
    .workspaceName("string")
    .principalAssignmentName("string")
    .tenantId("string")
    .build());
Copy
kusto_pool_principal_assignment_resource = azure_native.synapse.KustoPoolPrincipalAssignment("kustoPoolPrincipalAssignmentResource",
    kusto_pool_name="string",
    principal_id="string",
    principal_type="string",
    resource_group_name="string",
    role="string",
    workspace_name="string",
    principal_assignment_name="string",
    tenant_id="string")
Copy
const kustoPoolPrincipalAssignmentResource = new azure_native.synapse.KustoPoolPrincipalAssignment("kustoPoolPrincipalAssignmentResource", {
    kustoPoolName: "string",
    principalId: "string",
    principalType: "string",
    resourceGroupName: "string",
    role: "string",
    workspaceName: "string",
    principalAssignmentName: "string",
    tenantId: "string",
});
Copy
type: azure-native:synapse:KustoPoolPrincipalAssignment
properties:
    kustoPoolName: string
    principalAssignmentName: string
    principalId: string
    principalType: string
    resourceGroupName: string
    role: string
    tenantId: string
    workspaceName: string
Copy

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

KustoPoolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto pool.
PrincipalId This property is required. string
The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name.
PrincipalType This property is required. string | Pulumi.AzureNative.Synapse.PrincipalType
Principal type.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Role This property is required. string | Pulumi.AzureNative.Synapse.ClusterPrincipalRole
Cluster principal role.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
PrincipalAssignmentName Changes to this property will trigger replacement. string
The name of the Kusto principalAssignment.
TenantId string
The tenant id of the principal
KustoPoolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto pool.
PrincipalId This property is required. string
The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name.
PrincipalType This property is required. string | PrincipalType
Principal type.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Role This property is required. string | ClusterPrincipalRole
Cluster principal role.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
PrincipalAssignmentName Changes to this property will trigger replacement. string
The name of the Kusto principalAssignment.
TenantId string
The tenant id of the principal
kustoPoolName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto pool.
principalId This property is required. String
The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name.
principalType This property is required. String | PrincipalType
Principal type.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
role This property is required. String | ClusterPrincipalRole
Cluster principal role.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
principalAssignmentName Changes to this property will trigger replacement. String
The name of the Kusto principalAssignment.
tenantId String
The tenant id of the principal
kustoPoolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto pool.
principalId This property is required. string
The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name.
principalType This property is required. string | PrincipalType
Principal type.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
role This property is required. string | ClusterPrincipalRole
Cluster principal role.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
principalAssignmentName Changes to this property will trigger replacement. string
The name of the Kusto principalAssignment.
tenantId string
The tenant id of the principal
kusto_pool_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Kusto pool.
principal_id This property is required. str
The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name.
principal_type This property is required. str | PrincipalType
Principal type.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
role This property is required. str | ClusterPrincipalRole
Cluster principal role.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workspace.
principal_assignment_name Changes to this property will trigger replacement. str
The name of the Kusto principalAssignment.
tenant_id str
The tenant id of the principal
kustoPoolName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto pool.
principalId This property is required. String
The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name.
principalType This property is required. String | "App" | "Group" | "User"
Principal type.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
role This property is required. String | "AllDatabasesAdmin" | "AllDatabasesViewer"
Cluster principal role.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
principalAssignmentName Changes to this property will trigger replacement. String
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 KustoPoolPrincipalAssignment resource produces the following output properties:

AadObjectId string
The service principal object id in AAD (Azure active directory)
AzureApiVersion string
The Azure API version of the resource.
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.
SystemData Pulumi.AzureNative.Synapse.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
TenantName string
The tenant name of the principal
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AadObjectId string
The service principal object id in AAD (Azure active directory)
AzureApiVersion string
The Azure API version of the resource.
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.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
TenantName string
The tenant name of the principal
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
aadObjectId String
The service principal object id in AAD (Azure active directory)
azureApiVersion String
The Azure API version of the resource.
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.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantName String
The tenant name of the principal
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
aadObjectId string
The service principal object id in AAD (Azure active directory)
azureApiVersion string
The Azure API version of the resource.
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.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
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_id str
The service principal object id in AAD (Azure active directory)
azure_api_version str
The Azure API version of the resource.
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.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
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"
aadObjectId String
The service principal object id in AAD (Azure active directory)
azureApiVersion String
The Azure API version of the resource.
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.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
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

AllDatabasesAdmin
AllDatabasesAdmin
AllDatabasesViewer
AllDatabasesViewer
ClusterPrincipalRoleAllDatabasesAdmin
AllDatabasesAdmin
ClusterPrincipalRoleAllDatabasesViewer
AllDatabasesViewer
AllDatabasesAdmin
AllDatabasesAdmin
AllDatabasesViewer
AllDatabasesViewer
AllDatabasesAdmin
AllDatabasesAdmin
AllDatabasesViewer
AllDatabasesViewer
ALL_DATABASES_ADMIN
AllDatabasesAdmin
ALL_DATABASES_VIEWER
AllDatabasesViewer
"AllDatabasesAdmin"
AllDatabasesAdmin
"AllDatabasesViewer"
AllDatabasesViewer

PrincipalType
, PrincipalTypeArgs

App
App
Group
Group
User
User
PrincipalTypeApp
App
PrincipalTypeGroup
Group
PrincipalTypeUser
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

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:synapse:KustoPoolPrincipalAssignment synapseWorkspaceName/kustoclusterrptest4/kustoprincipal1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/principalAssignments/{principalAssignmentName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native