Share via

az synapse kusto attached-database-configuration

  • Experimental

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

Manage kusto pool attached database configuration with synapse.

Commands

Name Description Type Status
az synapse kusto attached-database-configuration create

Create an attached database configuration.

 Core Experimental
az synapse kusto attached-database-configuration delete

Deletes the attached database configuration with the given name.

 Core Experimental
az synapse kusto attached-database-configuration list

Returns the list of attached database configurations of the given Kusto Pool.

 Core Experimental
az synapse kusto attached-database-configuration show

Returns an attached database configuration.

 Core Experimental
az synapse kusto attached-database-configuration update

Update an attached database configuration.

 Core Experimental
az synapse kusto attached-database-configuration wait

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

 Core Experimental

az synapse kusto attached-database-configuration create

Edit
Experimental

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

Create an attached database configuration.

az synapse kusto attached-database-configuration create --attached-database-configuration-name
                                                        --kusto-pool-name
                                                        --resource-group
                                                        --workspace-name
                                                        [--database-name]
                                                        [--default-principals-modification-kind {None, Replace, Union}]
                                                        [--kusto-pool-resource-id]
                                                        [--location]
                                                        [--no-wait]
                                                        [--table-level-sharing-properties]

Examples

KustoPoolAttachedDatabaseConfigurationsCreateOrUpdate

az synapse kusto attached-database-configuration create --attached-database-configuration-name "attachedDatabaseConfigurations1" --kusto-pool-name "kustoclusterrptest4" --location "westus" --kusto-pool-resource-id "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/Workspaces/kustorptest/KustoPools/kustoclusterrptest4" --database-name "kustodatabase" --default-principals-modification-kind "Union" --table-level-sharing-properties external-tables-to-exclude="ExternalTable2" external-tables-to-include="ExternalTable1" materialized-views-to-exclude="MaterializedViewTable2" materialized-views-to-include="MaterializedViewTable1" tables-to-exclude="Table2" tables-to-include="Table1" --resource-group "kustorptest" --workspace-name "kustorptest"

Required Parameters

--attached-database-configuration-name

The name of the attached database configuration.

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

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 which you would like to attach, use * if you want to follow all current and future databases.

--default-principals-modification-kind

The default principals modification kind.

Property Value
Accepted values: None, Replace, Union
--kusto-pool-resource-id

The resource id of the kusto pool where the databases you would like to attach reside.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

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

Property Value
Default value: False
--table-level-sharing-properties

Table level sharing specifications.

Usage: --table-level-sharing-properties tables-to-include=XX tables-to-exclude=XX external-tables-to-include=XX external-tables-to-exclude=XX materialized-views-to-include=XX materialized-views-to-exclude=XX

tables-to-include: List of tables to include in the follower database tables-to-exclude: List of tables to exclude from the follower database external-tables-to-include: List of external tables to include in the follower database external-tables-to-exclude: List of external tables exclude from the follower database materialized-views-to-include: List of materialized views to include in the follower database materialized-views-to-exclude: List of materialized views exclude from the follower database.

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 attached-database-configuration delete

Edit
Experimental

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

Deletes the attached database configuration with the given name.

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

Examples

KustoPoolAttachedDatabaseConfigurationsDelete

az synapse kusto attached-database-configuration delete --attached-database-configuration-name "attachedDatabaseConfigurations1" --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "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.

--attached-database-configuration-name

The name of the attached database configuration.

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
--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 attached-database-configuration list

Edit
Experimental

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

Returns the list of attached database configurations of the given Kusto Pool.

az synapse kusto attached-database-configuration list --kusto-pool-name
                                                      --resource-group
                                                      --workspace-name

Examples

KustoPoolAttachedDatabaseConfigurationsListByKustoPool

az synapse kusto attached-database-configuration list --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "kustorptest"

Required Parameters

--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 attached-database-configuration show

Edit
Experimental

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

Returns an attached database configuration.

az synapse kusto attached-database-configuration show [--attached-database-configuration-name]
                                                      [--ids]
                                                      [--kusto-pool-name]
                                                      [--resource-group]
                                                      [--subscription]
                                                      [--workspace-name]

Examples

KustoPoolAttachedDatabaseConfigurationsGet

az synapse kusto attached-database-configuration show --attached-database-configuration-name "attachedDatabaseConfigurations1" --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "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.

--attached-database-configuration-name

The name of the attached database configuration.

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
--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 attached-database-configuration update

Edit
Experimental

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

Update an attached database configuration.

az synapse kusto attached-database-configuration update [--add]
                                                        [--attached-database-configuration-name]
                                                        [--database-name]
                                                        [--default-principals-modification-kind {None, Replace, Union}]
                                                        [--force-string]
                                                        [--ids]
                                                        [--kusto-pool-name]
                                                        [--kusto-pool-resource-id]
                                                        [--location]
                                                        [--no-wait]
                                                        [--remove]
                                                        [--resource-group]
                                                        [--set]
                                                        [--subscription]
                                                        [--table-level-sharing-properties]
                                                        [--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: []
--attached-database-configuration-name

The name of the attached database configuration.

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

The name of the database which you would like to attach, use * if you want to follow all current and future databases.

--default-principals-modification-kind

The default principals modification kind.

Property Value
Accepted values: None, Replace, Union
--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
--kusto-pool-resource-id

The resource id of the kusto pool where the databases you would like to attach reside.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

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

Property Value
Default value: False
--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
--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
--table-level-sharing-properties

Table level sharing specifications.

Usage: --table-level-sharing-properties tables-to-include=XX tables-to-exclude=XX external-tables-to-include=XX external-tables-to-exclude=XX materialized-views-to-include=XX materialized-views-to-exclude=XX

tables-to-include: List of tables to include in the follower database tables-to-exclude: List of tables to exclude from the follower database external-tables-to-include: List of external tables to include in the follower database external-tables-to-exclude: List of external tables exclude from the follower database materialized-views-to-include: List of materialized views to include in the follower database materialized-views-to-exclude: List of materialized views exclude from the follower database.

--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 attached-database-configuration wait

Edit
Experimental

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

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

Examples

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

az synapse kusto attached-database-configuration wait --attached-database-configuration-name "attachedDatabaseConfigurations1" --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "kustorptest" --created

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

az synapse kusto attached-database-configuration wait --attached-database-configuration-name "attachedDatabaseConfigurations1" --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "kustorptest" --updated

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

az synapse kusto attached-database-configuration wait --attached-database-configuration-name "attachedDatabaseConfigurations1" --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "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.

--attached-database-configuration-name

The name of the attached database configuration.

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