Share via

az kusto database-principal-assignment

  • Experimental

Note

This reference is part of the kusto extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az kusto database-principal-assignment command. Learn more about extensions.

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage database principal assignment with kusto.

Commands

Name Description Type Status
az kusto database-principal-assignment create

Creates a Kusto cluster database principalAssignment.

 Extension Experimental
az kusto database-principal-assignment delete

Deletes a Kusto principalAssignment.

 Extension Experimental
az kusto database-principal-assignment list

Lists all Kusto cluster database principalAssignments.

 Extension Experimental
az kusto database-principal-assignment show

Gets a Kusto cluster database principalAssignment.

 Extension Experimental
az kusto database-principal-assignment update

Update a Kusto cluster database principalAssignment.

 Extension Experimental
az kusto database-principal-assignment wait

Place the CLI in a waiting state until a condition of the kusto database-principal-assignment is met.

 Extension Experimental

az kusto database-principal-assignment create

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Creates a Kusto cluster database principalAssignment.

az kusto database-principal-assignment create --cluster-name
                                              --database-name
                                              --principal-assignment-name
                                              --resource-group
                                              [--no-wait]
                                              [--principal-id]
                                              [--principal-type {App, Group, User}]
                                              [--role {Admin, Ingestor, Monitor, UnrestrictedViewer, User, Viewer}]
                                              [--tenant-id]

Examples

KustoDatabasePrincipalAssignmentsCreateOrUpdate

az kusto database-principal-assignment create --cluster-name "kustoclusterrptest4" --database-name "Kustodatabase8" --principal-id "87654321-1234-1234-1234-123456789123" --principal-type "App" --role "Admin" --tenant-id "12345678-1234-1234-1234-123456789123" --principal-assignment-name "kustoprincipal1" --resource-group "kustorptest"

Required Parameters

--cluster-name

The name of the Kusto cluster.

--database-name

The name of the database in the Kusto cluster.

--principal-assignment-name

The name of the Kusto principalAssignment.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--principal-id

The principal ID assigned to the database principal. It can be a user email, application ID, or security group name.

--principal-type

Principal type.

Property Value
Accepted values: App, Group, User
--role

Database principal role.

Property Value
Accepted values: Admin, Ingestor, Monitor, UnrestrictedViewer, User, Viewer
--tenant-id

The tenant id of the principal.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az kusto database-principal-assignment delete

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Deletes a Kusto principalAssignment.

az kusto database-principal-assignment delete [--cluster-name]
                                              [--database-name]
                                              [--ids]
                                              [--no-wait]
                                              [--principal-assignment-name]
                                              [--resource-group]
                                              [--subscription]
                                              [--yes]

Examples

KustoDatabasePrincipalAssignmentsDelete

az kusto database-principal-assignment delete --cluster-name "kustoclusterrptest4" --database-name "Kustodatabase8" --principal-assignment-name "kustoprincipal1" --resource-group "kustorptest"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name

The name of the Kusto cluster.

Property Value
Parameter group: Resource Id Arguments
--database-name

The name of the database in the Kusto cluster.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--principal-assignment-name

The name of the Kusto principalAssignment.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az kusto database-principal-assignment list

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Lists all Kusto cluster database principalAssignments.

az kusto database-principal-assignment list --cluster-name
                                            --database-name
                                            --resource-group

Examples

KustoPrincipalAssignmentsList

az kusto database-principal-assignment list --cluster-name "kustoclusterrptest4" --database-name "Kustodatabase8" --resource-group "kustorptest"

Required Parameters

--cluster-name

The name of the Kusto cluster.

--database-name

The name of the database in the Kusto cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az kusto database-principal-assignment show

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Gets a Kusto cluster database principalAssignment.

az kusto database-principal-assignment show [--cluster-name]
                                            [--database-name]
                                            [--ids]
                                            [--principal-assignment-name]
                                            [--resource-group]
                                            [--subscription]

Examples

KustoDatabasePrincipalAssignmentsGet

az kusto database-principal-assignment show --cluster-name "kustoclusterrptest4" --database-name "Kustodatabase8" --principal-assignment-name "kustoprincipal1" --resource-group "kustorptest"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name

The name of the Kusto cluster.

Property Value
Parameter group: Resource Id Arguments
--database-name

The name of the database in the Kusto cluster.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--principal-assignment-name

The name of the Kusto principalAssignment.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az kusto database-principal-assignment update

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a Kusto cluster database principalAssignment.

az kusto database-principal-assignment update [--add]
                                              [--cluster-name]
                                              [--database-name]
                                              [--force-string]
                                              [--ids]
                                              [--no-wait]
                                              [--principal-assignment-name]
                                              [--principal-id]
                                              [--principal-type {App, Group, User}]
                                              [--remove]
                                              [--resource-group]
                                              [--role {Admin, Ingestor, Monitor, UnrestrictedViewer, User, Viewer}]
                                              [--set]
                                              [--subscription]
                                              [--tenant-id]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property Value
Parameter group: Generic Update Arguments
Default value: []
--cluster-name

The name of the Kusto cluster.

Property Value
Parameter group: Resource Id Arguments
--database-name

The name of the database in the Kusto cluster.

Property Value
Parameter group: Resource Id Arguments
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--principal-assignment-name

The name of the Kusto principalAssignment.

Property Value
Parameter group: Resource Id Arguments
--principal-id

The principal ID assigned to the database principal. It can be a user email, application ID, or security group name.

--principal-type

Principal type.

Property Value
Accepted values: App, Group, User
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update Arguments
Default value: []
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--role

Database principal role.

Property Value
Accepted values: Admin, Ingestor, Monitor, UnrestrictedViewer, User, Viewer
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property Value
Parameter group: Generic Update Arguments
Default value: []
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--tenant-id

The tenant id of the principal.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az kusto database-principal-assignment wait

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Place the CLI in a waiting state until a condition of the kusto database-principal-assignment is met.

az kusto database-principal-assignment wait [--cluster-name]
                                            [--created]
                                            [--custom]
                                            [--database-name]
                                            [--deleted]
                                            [--exists]
                                            [--ids]
                                            [--interval]
                                            [--principal-assignment-name]
                                            [--resource-group]
                                            [--subscription]
                                            [--timeout]
                                            [--updated]

Examples

Pause executing next line of CLI script until the kusto database-principal-assignment is successfully created.

az kusto database-principal-assignment wait --cluster-name "kustoclusterrptest4" --database-name "Kustodatabase8" --principal-assignment-name "kustoprincipal1" --resource-group "kustorptest" --created

Pause executing next line of CLI script until the kusto database-principal-assignment is successfully updated.

az kusto database-principal-assignment wait --cluster-name "kustoclusterrptest4" --database-name "Kustodatabase8" --principal-assignment-name "kustoprincipal1" --resource-group "kustorptest" --updated

Pause executing next line of CLI script until the kusto database-principal-assignment is successfully deleted.

az kusto database-principal-assignment wait --cluster-name "kustoclusterrptest4" --database-name "Kustodatabase8" --principal-assignment-name "kustoprincipal1" --resource-group "kustorptest" --deleted

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name

The name of the Kusto cluster.

Property Value
Parameter group: Resource Id Arguments
--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--database-name

The name of the database in the Kusto cluster.

Property Value
Parameter group: Resource Id Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--principal-assignment-name

The name of the Kusto principalAssignment.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False