Share via

az sql mi server-configuration-option

  • Reference

Server configuration option management commands.

Commands

Name Description Type Status
az sql mi server-configuration-option list

List a list of managed instance server configuration options.

 Core GA
az sql mi server-configuration-option set

Set managed instance server configuration option.

 Core GA
az sql mi server-configuration-option show

Get managed instance server configuration option.

 Core GA
az sql mi server-configuration-option wait

Place the CLI in a waiting state until a condition is met.

 Core GA

az sql mi server-configuration-option list

Edit

List a list of managed instance server configuration options.

az sql mi server-configuration-option list --instance-name
                                           --resource-group

Examples

List server configuration options on ManagedInstance_1 in ResourceGroup_1

az sql mi server-configuration-option list -g 'ResourceGroup_1' --mi 'ManagedInstance_1'

Required Parameters

--instance-name --managed-instance --managed-instance-name --mi

Name of the managed instance.

--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 sql mi server-configuration-option set

Edit

Set managed instance server configuration option.

az sql mi server-configuration-option set [--ids]
                                          [--instance-name]
                                          [--name {allowPolybaseExport}]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--resource-group]
                                          [--server-configuration-option-value]
                                          [--subscription]

Examples

Create server configuration option on ManagedInstance_1 in ResourceGroup_1

az mi server-configuration-option set -g 'ResourceGroup_1' --mi 'ManagedInstance_1' --name 'allowPolybaseExport' --value '1'

Optional Parameters

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

--instance-name --managed-instance --managed-instance-name --mi

Name of the managed instance.

--name --server-configuration-option-name -n

Name of the server configuration option.

Accepted values: allowPolybaseExport
--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--server-configuration-option-value --value

Value of the server configuration option.

--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 sql mi server-configuration-option show

Edit

Get managed instance server configuration option.

az sql mi server-configuration-option show [--ids]
                                           [--instance-name]
                                           [--name {allowPolybaseExport}]
                                           [--resource-group]
                                           [--subscription]

Examples

Show server configuration option allowPolybaseExport on ManagedInstance_1 in ResourceGroup_1

az sql mi server-configuration-option show -g 'ResourceGroup_1' --mi 'ManagedInstance_1' --name allowPolybaseExport

Optional Parameters

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

--instance-name --managed-instance --managed-instance-name --mi

Name of the managed instance.

--name --server-configuration-option-name -n

Name of the server configuration option.

Accepted values: allowPolybaseExport
--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 sql mi server-configuration-option wait

Edit

Place the CLI in a waiting state until a condition is met.

az sql mi server-configuration-option wait [--created]
                                           [--custom]
                                           [--deleted]
                                           [--exists]
                                           [--ids]
                                           [--instance-name]
                                           [--interval]
                                           [--name {allowPolybaseExport}]
                                           [--resource-group]
                                           [--subscription]
                                           [--timeout]
                                           [--updated]

Optional Parameters

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

--instance-name --managed-instance --managed-instance-name --mi

Name of the managed instance.

--interval

Polling interval in seconds.

Default value: 30
--name --server-configuration-option-name -n

Name of the server configuration option.

Accepted values: allowPolybaseExport
--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.