az kusto attached-database-configuration

Kusto attached-database-configuration.

Commands

az kusto attached-database-configuration create

Creates or updates an attached database configuration.

az kusto attached-database-configuration delete

Deletes the attached database configuration with the given name.

az kusto attached-database-configuration list

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

az kusto attached-database-configuration show

Returns an attached database configuration.

az kusto attached-database-configuration update

Creates or updates an attached database configuration.

az kusto attached-database-configuration wait

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

az kusto attached-database-configuration create

Creates or updates an attached database configuration.

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

Examples

AttachedDatabaseConfigurationsCreateOrUpdate

az kusto attached-database-configuration create --attached-database-configuration-name "attachedDatabaseConfigurations1" --cluster-name "kustoclusterrptest4" --location "westus" --cluster-resource-id "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader" --database-name "kustodatabase" --default-principals-modification-kind "Union" --resource-group "kustorptest"

Required Parameters

--attached-database-configuration-name

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

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

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.

az kusto attached-database-configuration delete

Deletes the attached database configuration with the given name.

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

Examples

AttachedDatabaseConfigurationsDelete

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

Required Parameters

--attached-database-configuration-name

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

--no-wait

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

az kusto attached-database-configuration list

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

az kusto attached-database-configuration show

Returns an attached database configuration.

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

Examples

AttachedDatabaseConfigurationsGet

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

Required Parameters

--attached-database-configuration-name

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

az kusto attached-database-configuration update

Creates or updates an attached database configuration.

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

Examples

AttachedDatabaseConfigurationsCreateOrUpdate

az kusto attached-database-configuration update --attached-database-configuration-name "attachedDatabaseConfigurations1" --cluster-name "kustoclusterrptest4" --location "westus" --cluster-resource-id "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader" --database-name "kustodatabase" --default-principals-modification-kind "Union" --resource-group "kustorptest"

Required Parameters

--attached-database-configuration-name

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

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

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.

az kusto attached-database-configuration wait

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
                                              --cluster-name
                                              --resource-group
                                              [--created]
                                              [--custom]
                                              [--deleted]
                                              [--exists]
                                              [--interval]
                                              [--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 --attached-database-configuration-name "attachedDatabaseConfigurations1" --cluster-name "kustoclusterrptest4" --resource-group "kustorptest" --created

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

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

Required Parameters

--attached-database-configuration-name

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

--created

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

default value: 30
--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.