az kusto cluster-principal-assignment

  • Experimental
  • Reference

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 cluster-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 cluster principal assignment with kusto.

Commands

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

Create a Kusto cluster principalAssignment.

 Extension Experimental
az kusto cluster-principal-assignment delete

Deletes a Kusto cluster principalAssignment.

 Extension Experimental
az kusto cluster-principal-assignment list

Lists all Kusto cluster principalAssignments.

 Extension Experimental
az kusto cluster-principal-assignment show

Gets a Kusto cluster principalAssignment.

 Extension Experimental
az kusto cluster-principal-assignment update

Update a Kusto cluster principalAssignment.

 Extension Experimental
az kusto cluster-principal-assignment wait

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

 Extension Experimental

az kusto cluster-principal-assignment create

Experimental

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

Create a Kusto cluster principalAssignment.

az kusto cluster-principal-assignment create --cluster-name
                                             --principal-assignment-name
                                             --resource-group
                                             [--no-wait]
                                             [--principal-id]
                                             [--principal-type {App, Group, User}]
                                             [--role {AllDatabasesAdmin, AllDatabasesViewer}]
                                             [--tenant-id]

Examples

KustoClusterPrincipalAssignmentsCreateOrUpdate

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

Required Parameters

--cluster-name

The name of 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

--no-wait

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

default value: False
--principal-id

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

--principal-type

Principal type.

accepted values: App, Group, User
--role

Cluster principal role.

accepted values: AllDatabasesAdmin, AllDatabasesViewer
--tenant-id

The tenant id of the principal.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az kusto cluster-principal-assignment delete

Experimental

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

Deletes a Kusto cluster principalAssignment.

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

Examples

KustoClusterPrincipalAssignmentsDelete

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

Optional Parameters

--cluster-name

The name of the Kusto cluster.

--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.

--no-wait

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

default value: False
--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>.

--subscription

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

--yes -y

Do not prompt for confirmation.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az kusto cluster-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 principalAssignments.

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

Examples

KustoPrincipalAssignmentsList

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

Required Parameters

--cluster-name

The name of 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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az kusto cluster-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 principalAssignment.

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

Examples

KustoClusterPrincipalAssignmentsGet

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

Optional Parameters

--cluster-name

The name of the Kusto cluster.

--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.

--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>.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az kusto cluster-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 principalAssignment.

az kusto cluster-principal-assignment update [--add]
                                             [--cluster-name]
                                             [--force-string]
                                             [--ids]
                                             [--no-wait]
                                             [--principal-assignment-name]
                                             [--principal-id]
                                             [--principal-type {App, Group, User}]
                                             [--remove]
                                             [--resource-group]
                                             [--role {AllDatabasesAdmin, AllDatabasesViewer}]
                                             [--set]
                                             [--subscription]
                                             [--tenant-id]

Optional Parameters

--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>.

default value: []
--cluster-name

The name of the Kusto cluster.

--force-string

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

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.

--no-wait

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

default value: False
--principal-assignment-name

The name of the Kusto principalAssignment.

--principal-id

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

--principal-type

Principal type.

accepted values: App, Group, User
--remove

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

default value: []
--resource-group -g

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

--role

Cluster principal role.

accepted values: AllDatabasesAdmin, AllDatabasesViewer
--set

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

default value: []
--subscription

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

--tenant-id

The tenant id of the principal.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az kusto cluster-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 cluster-principal-assignment is met.

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

Examples

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

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

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

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

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

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

Optional Parameters

--cluster-name

The name of the Kusto cluster.

--created

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

default value: False
--custom

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

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

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.

--interval

Polling interval in seconds.

default value: 30
--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>.

--subscription

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

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.