az postgres flexible-server autonomous-tuning

Autonomous tuning analyzes read queries captured in query store and recommends operations on tables or index changes to optimize these queries.

Commands

Name	Description	Type	Status
az postgres flexible-server autonomous-tuning list-index-recommendations	Get available autonomous tuning index recommendations associated with a PostgreSQL flexible server.	Core	GA
az postgres flexible-server autonomous-tuning list-settings	Get autonomous tuning settings associated to a PostgreSQL flexible server.	Core	GA
az postgres flexible-server autonomous-tuning list-table-recommendations	Get available autonomous tuning table recommendations associated with a PostgreSQL flexible server.	Core	GA
az postgres flexible-server autonomous-tuning set-settings	Update an autonomous tuning setting for a PostgreSQL flexible server.	Core	GA
az postgres flexible-server autonomous-tuning show	Show state of autonomous tuning for a PostgreSQL flexible server.	Core	GA
az postgres flexible-server autonomous-tuning show-settings	Get an autonomous tuning setting for a PostgreSQL flexible server.	Core	GA
az postgres flexible-server autonomous-tuning update	Update autonomous tuning to be enabled/disabled for a PostgreSQL flexible server.	Core	GA

az postgres flexible-server autonomous-tuning list-index-recommendations

Get available autonomous tuning index recommendations associated with a PostgreSQL flexible server.

az postgres flexible-server autonomous-tuning list-index-recommendations [--ids]
                                                                         [--recommendation-type {CreateIndex, DropIndex, ReIndex}]
                                                                         [--resource-group]
                                                                         [--server-name]
                                                                         [--subscription]

Examples

Get autonomous tuning index recommendations for a PostgreSQL flexible server. Filter by selected type.

az postgres flexible-server autonomous-tuning list-index-recommendations -g testgroup -s testsvr --recommendation-type CreateIndex

Optional Parameters

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

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

--recommendation-type -r

Retrieve recommendations based on type.

Property	Value
Accepted values:	CreateIndex, DropIndex, ReIndex

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

--server-name -s

Name of the server.

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 postgres flexible-server autonomous-tuning list-settings

Get autonomous tuning settings associated to a PostgreSQL flexible server.

az postgres flexible-server autonomous-tuning list-settings [--ids]
                                                            [--resource-group]
                                                            [--server-name]
                                                            [--subscription]

Examples

Get autonomous tuning settings for a PostgreSQL flexible server.

az postgres flexible-server autonomous-tuning list-settings -g testgroup -s testsvr

Optional Parameters

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

--ids

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

--server-name -s

Name of the server.

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 postgres flexible-server autonomous-tuning list-table-recommendations

Get available autonomous tuning table recommendations associated with a PostgreSQL flexible server.

az postgres flexible-server autonomous-tuning list-table-recommendations [--ids]
                                                                         [--recommendation-type {AnalyzeTable, VacuumTable}]
                                                                         [--resource-group]
                                                                         [--server-name]
                                                                         [--subscription]

Examples

Get autonomous tuning table recommendations for a PostgreSQL flexible server. Filter by selected type.

az postgres flexible-server autonomous-tuning list-table-recommendations -g testgroup -s testsvr --recommendation-type AnalyzeTable

Optional Parameters

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

--ids

Property	Value
Parameter group:	Resource Id Arguments

--recommendation-type -r

Retrieve recommendations based on type.

Property	Value
Accepted values:	AnalyzeTable, VacuumTable

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

--server-name -s

Name of the server.

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 postgres flexible-server autonomous-tuning set-settings

Update an autonomous tuning setting for a PostgreSQL flexible server.

az postgres flexible-server autonomous-tuning set-settings --name {analysis_interval, max_columns_per_index, max_index_count, max_indexes_per_table, max_queries_per_database, max_regression_factor, max_total_size_factor, min_improvement_factor, mode, unused_dml_per_table, unused_min_period, unused_reads_per_table}
                                                           [--ids]
                                                           [--resource-group]
                                                           [--server-name]
                                                           [--subscription]
                                                           [--value]

Examples

Update an autonomous tuning setting for a PostgreSQL flexible server.

az postgres flexible-server autonomous-tuning set-settings -g testgroup -s testsvr --name setting-name --value setting-value

Required Parameters

--name -n

The name of the tuning setting.

Property	Value
Accepted values:	analysis_interval, max_columns_per_index, max_index_count, max_indexes_per_table, max_queries_per_database, max_regression_factor, max_total_size_factor, min_improvement_factor, mode, unused_dml_per_table, unused_min_period, unused_reads_per_table

Optional Parameters

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

--ids

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

--server-name -s

Name of the server.

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

--value -v

Value of the tuning setting.

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 postgres flexible-server autonomous-tuning show

Show state of autonomous tuning for a PostgreSQL flexible server.

az postgres flexible-server autonomous-tuning show [--ids]
                                                   [--resource-group]
                                                   [--server-name]
                                                   [--subscription]

Examples

Show state of autonomous tuning for a PostgreSQL flexible server.

az postgres flexible-server autonomous-tuning show -g testgroup -s testsvr

Optional Parameters

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

--ids

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

--server-name -s

Name of the server.

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 postgres flexible-server autonomous-tuning show-settings

Get an autonomous tuning setting for a PostgreSQL flexible server.

az postgres flexible-server autonomous-tuning show-settings --name {analysis_interval, max_columns_per_index, max_index_count, max_indexes_per_table, max_queries_per_database, max_regression_factor, max_total_size_factor, min_improvement_factor, mode, unused_dml_per_table, unused_min_period, unused_reads_per_table}
                                                            [--ids]
                                                            [--resource-group]
                                                            [--server-name]
                                                            [--subscription]

Examples

Get an autonomous tuning setting for a PostgreSQL flexible server.

az postgres flexible-server autonomous-tuning show-settings -g testgroup -s testsvr --name setting-name

Required Parameters

--name -n

The name of the tuning setting.

Property	Value
Accepted values:	analysis_interval, max_columns_per_index, max_index_count, max_indexes_per_table, max_queries_per_database, max_regression_factor, max_total_size_factor, min_improvement_factor, mode, unused_dml_per_table, unused_min_period, unused_reads_per_table

Optional Parameters

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

--ids

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

--server-name -s

Name of the server.

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 postgres flexible-server autonomous-tuning update

Update autonomous tuning to be enabled/disabled for a PostgreSQL flexible server.

az postgres flexible-server autonomous-tuning update --enabled {False, True}
                                                     [--ids]
                                                     [--resource-group]
                                                     [--server-name]
                                                     [--subscription]

Examples

Update autonomous tuning to be enabled for a PostgreSQL flexible server.

az postgres flexible-server autonomous-tuning update -g testgroup -s testsvr --enabled True

Update autonomous tuning to be disabled for a PostgreSQL flexible server.

az postgres flexible-server autonomous-tuning update -g testgroup -s testsvr --enabled False

Required Parameters

--enabled

Enable or disable autonomous tuning feature.

Property	Value
Accepted values:	False, True

Optional Parameters

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

--ids

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

--server-name -s

Name of the server.

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

Feedback

Was this page helpful?

Share via

az postgres flexible-server autonomous-tuning

Commands

az postgres flexible-server autonomous-tuning list-index-recommendations

Examples

Optional Parameters

az postgres flexible-server autonomous-tuning list-settings

Examples

Optional Parameters

az postgres flexible-server autonomous-tuning list-table-recommendations

Examples

Optional Parameters

az postgres flexible-server autonomous-tuning set-settings

Examples

Required Parameters

Optional Parameters

az postgres flexible-server autonomous-tuning show

Examples

Optional Parameters

az postgres flexible-server autonomous-tuning show-settings

Examples

Required Parameters

Optional Parameters

az postgres flexible-server autonomous-tuning update

Examples

Required Parameters

Optional Parameters

Feedback