Share via

Microsoft.Kusto clusters/principalAssignments 2023-08-15

  • Article

Bicep resource definition

The clusters/principalAssignments resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Kusto/clusters/principalAssignments resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Kusto/clusters/principalAssignments@2023-08-15' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    principalId: 'string'
    principalType: 'string'
    role: 'string'
    tenantId: 'string'
  }
}

Property values

ClusterPrincipalProperties

Name Description Value
principalId The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. string (required)
principalType Principal type. 'App'
'Group'
'User' (required)
role Cluster principal role. 'AllDatabasesAdmin'
'AllDatabasesViewer' (required)
tenantId The tenant id of the principal string

Microsoft.Kusto/clusters/principalAssignments

Name Description Value
name The resource name string

Constraints:
Pattern = ^.*$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: clusters
properties The cluster principal. ClusterPrincipalProperties

ARM template resource definition

The clusters/principalAssignments resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Kusto/clusters/principalAssignments resource, add the following JSON to your template.

{
  "type": "Microsoft.Kusto/clusters/principalAssignments",
  "apiVersion": "2023-08-15",
  "name": "string",
  "properties": {
    "principalId": "string",
    "principalType": "string",
    "role": "string",
    "tenantId": "string"
  }
}

Property values

ClusterPrincipalProperties

Name Description Value
principalId The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. string (required)
principalType Principal type. 'App'
'Group'
'User' (required)
role Cluster principal role. 'AllDatabasesAdmin'
'AllDatabasesViewer' (required)
tenantId The tenant id of the principal string

Microsoft.Kusto/clusters/principalAssignments

Name Description Value
apiVersion The api version '2023-08-15'
name The resource name string

Constraints:
Pattern = ^.*$ (required)
properties The cluster principal. ClusterPrincipalProperties
type The resource type 'Microsoft.Kusto/clusters/principalAssignments'

Terraform (AzAPI provider) resource definition

The clusters/principalAssignments resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Kusto/clusters/principalAssignments resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Kusto/clusters/principalAssignments@2023-08-15"
  name = "string"
  body = jsonencode({
    properties = {
      principalId = "string"
      principalType = "string"
      role = "string"
      tenantId = "string"
    }
  })
}

Property values

ClusterPrincipalProperties

Name Description Value
principalId The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. string (required)
principalType Principal type. 'App'
'Group'
'User' (required)
role Cluster principal role. 'AllDatabasesAdmin'
'AllDatabasesViewer' (required)
tenantId The tenant id of the principal string

Microsoft.Kusto/clusters/principalAssignments

Name Description Value
name The resource name string

Constraints:
Pattern = ^.*$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: clusters
properties The cluster principal. ClusterPrincipalProperties
type The resource type "Microsoft.Kusto/clusters/principalAssignments@2023-08-15"