Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The clusters/principalAssignments resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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@2022-07-07' = {
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 (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 |
Usage Examples
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | Description |
|---|---|
| FinOps hub | This template creates a new FinOps hub instance, including Data Explorer, Data Lake storage, and Data Factory. |
ARM template resource definition
The clusters/principalAssignments resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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": "2022-07-07",
"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 | '2022-07-07' |
| name | The resource name | string (required) |
| properties | The cluster principal. | ClusterPrincipalProperties |
| type | The resource type | 'Microsoft.Kusto/clusters/principalAssignments' |
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
FinOps hub |
This template creates a new FinOps hub instance, including Data Explorer, Data Lake storage, and Data Factory. |
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@2022-07-07"
name = "string"
parent_id = "string"
body = {
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 (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@2022-07-07" |