Share via

az synapse kusto database-principal-assignment

  • Experimental

This command group is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage kusto pool database principal assignment with synapse.

Commands

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

Creates a Kusto pool database principalAssignment.

 Core Experimental
az synapse kusto database-principal-assignment delete

Deletes a Kusto pool principalAssignment.

 Core Experimental
az synapse kusto database-principal-assignment list

Lists all Kusto pool database principalAssignments.

 Core Experimental
az synapse kusto database-principal-assignment show

Gets a Kusto pool database principalAssignment.

 Core Experimental
az synapse kusto database-principal-assignment update

Update a Kusto pool database principalAssignment.

 Core Experimental
az synapse kusto database-principal-assignment wait

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

 Core Experimental

az synapse kusto database-principal-assignment create

Edit
Experimental

Command group 'synapse kusto database-principal-assignment' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Creates a Kusto pool database principalAssignment.

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

Examples

KustoPoolDatabasePrincipalAssignmentsCreateOrUpdate

az synapse kusto database-principal-assignment create --database-name "Kustodatabase8" --kusto-pool-name "kustoclusterrptest4" --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" --workspace-name "synapseWorkspaceName"

Required Parameters

--database-name

The name of the database in the Kusto pool.

--kusto-pool-name

The name of the Kusto pool.

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

--workspace-name

The name of the workspace.

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 synapse kusto database-principal-assignment delete

Edit
Experimental

Command group 'synapse kusto database-principal-assignment' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Deletes a Kusto pool principalAssignment.

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

Examples

KustoPoolDatabasePrincipalAssignmentsDelete

az synapse kusto database-principal-assignment delete --database-name "Kustodatabase8" --kusto-pool-name "kustoclusterrptest4" --principal-assignment-name "kustoprincipal1" --resource-group "kustorptest" --workspace-name "synapseWorkspaceName"

Optional Parameters

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

--database-name

The name of the database in the Kusto pool.

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
--kusto-pool-name

The name of the Kusto pool.

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
--workspace-name

The name of the workspace.

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 synapse kusto database-principal-assignment list

Edit
Experimental

Command group 'synapse kusto database-principal-assignment' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Lists all Kusto pool database principalAssignments.

az synapse kusto database-principal-assignment list --database-name
                                                    --kusto-pool-name
                                                    --resource-group
                                                    --workspace-name

Examples

KustoPoolDatabasePrincipalAssignmentsList

az synapse kusto database-principal-assignment list --database-name "Kustodatabase8" --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "synapseWorkspaceName"

Required Parameters

--database-name

The name of the database in the Kusto pool.

--kusto-pool-name

The name of the Kusto pool.

--resource-group -g

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

--workspace-name

The name of the workspace.

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 synapse kusto database-principal-assignment show

Edit
Experimental

Command group 'synapse kusto database-principal-assignment' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Gets a Kusto pool database principalAssignment.

az synapse kusto database-principal-assignment show [--database-name]
                                                    [--ids]
                                                    [--kusto-pool-name]
                                                    [--principal-assignment-name]
                                                    [--resource-group]
                                                    [--subscription]
                                                    [--workspace-name]

Examples

KustoPoolDatabasePrincipalAssignmentsGet

az synapse kusto database-principal-assignment show --database-name "Kustodatabase8" --kusto-pool-name "kustoclusterrptest4" --principal-assignment-name "kustoprincipal1" --resource-group "kustorptest" --workspace-name "synapseWorkspaceName"

Optional Parameters

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

--database-name

The name of the database in the Kusto pool.

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
--kusto-pool-name

The name of the Kusto pool.

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
--workspace-name

The name of the workspace.

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 synapse kusto database-principal-assignment update

Edit
Experimental

Command group 'synapse kusto database-principal-assignment' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a Kusto pool database principalAssignment.

az synapse kusto database-principal-assignment update [--add]
                                                      [--database-name]
                                                      [--force-string]
                                                      [--ids]
                                                      [--kusto-pool-name]
                                                      [--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]
                                                      [--workspace-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.

--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: []
--database-name

The name of the database in the Kusto pool.

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
--kusto-pool-name

The name of the Kusto pool.

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.

--workspace-name

The name of the workspace.

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 synapse kusto database-principal-assignment wait

Edit
Experimental

Command group 'synapse kusto database-principal-assignment' 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 synapse kusto database-principal-assignment is met.

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

Examples

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

az synapse kusto database-principal-assignment wait --database-name "Kustodatabase8" --kusto-pool-name "kustoclusterrptest4" --principal-assignment-name "kustoprincipal1" --resource-group "kustorptest" --workspace-name "synapseWorkspaceName" --created

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

az synapse kusto database-principal-assignment wait --database-name "Kustodatabase8" --kusto-pool-name "kustoclusterrptest4" --principal-assignment-name "kustoprincipal1" --resource-group "kustorptest" --workspace-name "synapseWorkspaceName" --updated

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

az synapse kusto database-principal-assignment wait --database-name "Kustodatabase8" --kusto-pool-name "kustoclusterrptest4" --principal-assignment-name "kustoprincipal1" --resource-group "kustorptest" --workspace-name "synapseWorkspaceName" --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.

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

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
--kusto-pool-name

The name of the Kusto pool.

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
--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
--workspace-name

The name of the workspace.

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