Microsoft.Kusto clusters/databases/principalAssignments 2020-06-14

• Latest
• 2023-08-15
• 2023-05-02
• 2022-12-29
• 2022-11-11
• 2022-07-07
• 2022-02-01
• 2021-08-27
• 2021-01-01
• 2020-09-18
• 2020-06-14
• 2020-02-15
• 2019-11-09

Bicep resource definition

The clusters/databases/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/databases/principalAssignments resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Kusto/clusters/databases/principalAssignments@2020-06-14' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    principalId: 'string'
    principalType: 'string'
    role: 'string'
    tenantId: 'string'
  }
}

Property values

clusters/databases/principalAssignments

Name	Description	Value
name	The resource name See how to set names and types for child resources in Bicep.	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: databases
properties	The database principal.	DatabasePrincipalProperties

DatabasePrincipalProperties

Name	Description	Value
principalId	The principal ID assigned to the database principal. It can be a user email, application ID, or security group name.	string (required)
principalType	Principal type.	'App' 'Group' 'User' (required)
role	Database principal role.	'Admin' 'Ingestor' 'Monitor' 'UnrestrictedViewers' 'User' 'Viewer' (required)
tenantId	The tenant id of the principal	string

Quickstart templates

The following quickstart templates deploy this resource type.

Template

Description

Azure Digital Twins with Time Data History Connection

This template creates an Azure Digital Twins instance configured with a time series data history connection. In order to create a connection, other resources must be created such as an Event Hubs namespace, an event hub, Azure Data Explorer cluster, and a database. Data is sent to an event hub which eventually forwards the data to the Azure Data Explorer cluster. Data is stored in a database table in the cluster

ARM template resource definition

The clusters/databases/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/databases/principalAssignments resource, add the following JSON to your template.

{
  "type": "Microsoft.Kusto/clusters/databases/principalAssignments",
  "apiVersion": "2020-06-14",
  "name": "string",
  "properties": {
    "principalId": "string",
    "principalType": "string",
    "role": "string",
    "tenantId": "string"
  }
}

Property values

clusters/databases/principalAssignments

Name	Description	Value
type	The resource type	'Microsoft.Kusto/clusters/databases/principalAssignments'
apiVersion	The resource api version	'2020-06-14'
name	The resource name See how to set names and types for child resources in JSON ARM templates.	string (required)
properties	The database principal.	DatabasePrincipalProperties

DatabasePrincipalProperties

Name	Description	Value
principalId	The principal ID assigned to the database principal. It can be a user email, application ID, or security group name.	string (required)
principalType	Principal type.	'App' 'Group' 'User' (required)
role	Database principal role.	'Admin' 'Ingestor' 'Monitor' 'UnrestrictedViewers' 'User' 'Viewer' (required)
tenantId	The tenant id of the principal	string

Quickstart templates

The following quickstart templates deploy this resource type.

Template

Description

Azure Digital Twins with Time Data History Connection

This template creates an Azure Digital Twins instance configured with a time series data history connection. In order to create a connection, other resources must be created such as an Event Hubs namespace, an event hub, Azure Data Explorer cluster, and a database. Data is sent to an event hub which eventually forwards the data to the Azure Data Explorer cluster. Data is stored in a database table in the cluster

Terraform (AzAPI provider) resource definition

The clusters/databases/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/databases/principalAssignments resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Kusto/clusters/databases/principalAssignments@2020-06-14"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      principalId = "string"
      principalType = "string"
      role = "string"
      tenantId = "string"
    }
  })
}

Property values

clusters/databases/principalAssignments

Name	Description	Value
type	The resource type	"Microsoft.Kusto/clusters/databases/principalAssignments@2020-06-14"
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: databases
properties	The database principal.	DatabasePrincipalProperties

DatabasePrincipalProperties

Name	Description	Value
principalId	The principal ID assigned to the database principal. It can be a user email, application ID, or security group name.	string (required)
principalType	Principal type.	"App" "Group" "User" (required)
role	Database principal role.	"Admin" "Ingestor" "Monitor" "UnrestrictedViewers" "User" "Viewer" (required)
tenantId	The tenant id of the principal	string