Share via

az postgres server configuration

  • Reference

Manage configuration values for a server.

Commands

Name Description Type Status
az postgres server configuration list

List the configuration values for a server.

 Core GA
az postgres server configuration set

Update the configuration of a server.

 Core GA
az postgres server configuration show

Get the configuration for a server.".

 Core GA

az postgres server configuration list

List the configuration values for a server.

az postgres server configuration list [--ids]
                                      [--resource-group]
                                      [--server-name]
                                      [--subscription]

Examples

List the configuration values for a server. (autogenerated)

az postgres server configuration list --resource-group MyResourceGroup --server-name MyServer

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.

--resource-group -g

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

--server-name -s

Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.

--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 postgres server configuration set

Update the configuration of a server.

az postgres server configuration set [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--server-name]
                                     [--subscription]
                                     [--value]

Examples

Set a new configuration value.

az postgres server configuration set -g testgroup -s testsvr -n {config_name} --value {config_value}

Set a configuration value to its default.

az postgres server configuration set -g testgroup -s testsvr -n {config_name}

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.

--name -n

The name of the configuration.

--resource-group -g

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

--server-name -s

Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--value

Value of the configuration. If not provided, configuration value will be set to default.

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 postgres server configuration show

Get the configuration for a server.".

az postgres server configuration show [--ids]
                                      [--name]
                                      [--resource-group]
                                      [--server-name]
                                      [--subscription]

Examples

Get the configuration for a server." (autogenerated)

az postgres server configuration show --name MyServerConfiguration --resource-group MyResourceGroup --server-name MyServer

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.

--name -n

The name of the server configuration. Required.

--resource-group -g

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

--server-name -s

Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.

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