Share via

az kusto attached-database-configuration

  • 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 attached-database-configuration command. Learn more about extensions.

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

Manage attached database configuration with kusto.

Commands

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

Create an attached database configuration.

 Extension Experimental
az kusto attached-database-configuration delete

Deletes the attached database configuration with the given name.

 Extension Experimental
az kusto attached-database-configuration list

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

 Extension Experimental
az kusto attached-database-configuration show

Returns an attached database configuration.

 Extension Experimental
az kusto attached-database-configuration update

Update an attached database configuration.

 Extension Experimental
az kusto attached-database-configuration wait

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

 Extension Experimental

az kusto attached-database-configuration create

Experimental

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

Create an attached database configuration.

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

Required Parameters

--attached-database-configuration-name --name -n

The name of the attached database configuration.

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

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

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

--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
--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 --table-level-sharing-properties

Table level sharing specifications.

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

Experimental

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

Deletes the attached database configuration with the given name.

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

Examples

AttachedDatabaseConfigurationsDelete

az kusto attached-database-configuration delete --name "attachedDatabaseConfigurations1" --cluster-name "kustoclusterrptest4" --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.

--attached-database-configuration-name --name -n

The name of the attached database configuration.

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

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

Experimental

Command group 'kusto' 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 cluster.

az kusto attached-database-configuration list --cluster-name
                                              --resource-group

Examples

KustoAttachedDatabaseConfigurationsListByCluster

az kusto attached-database-configuration 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.

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

Experimental

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

Returns an attached database configuration.

az kusto attached-database-configuration show [--attached-database-configuration-name --name]
                                              [--cluster-name]
                                              [--ids]
                                              [--resource-group]
                                              [--subscription]

Examples

AttachedDatabaseConfigurationsGet

az kusto attached-database-configuration show --name "attachedDatabaseConfigurations1" --cluster-name "kustoclusterrptest4" --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.

--attached-database-configuration-name --name -n

The name of the attached database configuration.

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

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

Experimental

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

Update an attached database configuration.

az kusto attached-database-configuration update [--add]
                                                [--attached-database-configuration-name --name]
                                                [--cluster-name]
                                                [--cluster-resource-id]
                                                [--database-name]
                                                [--default-principals-modification-kind {None, Replace, Union}]
                                                [--force-string]
                                                [--ids]
                                                [--location]
                                                [--no-wait]
                                                [--remove]
                                                [--resource-group]
                                                [--set]
                                                [--subscription]
                                                [--table-level --table-level-sharing-properties]

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

The name of the attached database configuration.

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

The name of the Kusto cluster.

Property Value
Parameter group: Resource Id Arguments
--cluster-resource-id

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

--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
--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 --table-level-sharing-properties

Table level sharing specifications.

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 attached-database-configuration 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 attached-database-configuration is met.

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

Examples

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

az kusto attached-database-configuration wait --name "attachedDatabaseConfigurations1" --cluster-name "kustoclusterrptest4" --resource-group "kustorptest" --created

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

az kusto attached-database-configuration wait --name "attachedDatabaseConfigurations1" --cluster-name "kustoclusterrptest4" --resource-group "kustorptest" --updated

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

az kusto attached-database-configuration wait --name "attachedDatabaseConfigurations1" --cluster-name "kustoclusterrptest4" --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.

--attached-database-configuration-name --name -n

The name of the attached database configuration.

Property Value
Parameter group: Resource Id Arguments
--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
--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
--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