List all server parameters

APPLIES TO: Azure Database for PostgreSQL - Flexible Server

This article provides step-by-step instructions to list all server parameters of an Azure Database for PostgreSQL flexible server.

Steps to list all server parameters

Portal

Using the Azure portal:

1. Select your Azure Database for PostgreSQL flexible server instance.

2. In the resource menu, under the Settings section, select Server parameters. The page shows a list of parameters, their configured values, optional units, whether they're read-only/dynamic/static, and their descriptions.

   

3. Select or hover over the i (information) icon to see which values are allowed for each parameter. Depending on the data type of the parameter, which can be string, enumeration, integer, boolean, numeric, set, the allowed values vary. And it can be regular expression, list of values, range of integers, on/off, range of decimals, list of values, respectively.

   

4. The list of server parameters supported by the instance consists of several hundred items, which are rendered in pages of 20 items each. At the bottom of the page, there's a control to inform you of the position you're at. There's also a paging control which you can use to navigate through the whole set of pages.

   

5. If needed, use the Search to filter items... text box to narrow down the list to those parameters containing the search term in their name or in their description.

   

The Parameter type column can show any of the following values for each parameter:

Parameter type	Description
Static	Requires a server restart to make the change effective.
Dynamic	Can be altered without the need to restart the server instance. However, changes will apply only to new connections established after the modification.
Read-only	Isn't user configurable, because of their critical role in maintaining reliability, security, or other operational aspects of the service.

CLI

You can list all server parameters in a server via the az postgres flexible-server parameter list command.

az postgres flexible-server parameter list --resource-group <resource_group> --server-name <server>

Each parameter has the following attributes:

Attribute name	Description	Possible values
allowedValues	Describes the values that are allowed for the parameter.	Depending on the value of dataType, can be a regular expression (string), list of values (enumeration), range of integers (integer), on/off (boolean), range of decimals (numeric), list of values (set).
dataType	Type of data used for the parameter.	Can be any of boolean, enumeration, integer, numeric, set, string.
defaultValue	Value assigned to the parameter when a new server is deployed.	Varies, depending on the data type and allowed values of the parameter.
description	Brief explanation of what the parameter controls.	Textual description which is different for each parameter.
documentationLink	URL address of the page pointing to the documentation of the parameter.	Some form of URL.
id	Resource identifier that uniquely refers to the server parameter in this particular instance of flexible server.	A string that follows the pattern /subscriptions/<subscription_identifier>/resourceGroups/<resource_group_name>/providers/Microsoft.DBforPostgreSQL/flexibleServers/<server_name>/configurations/<parameter_name>.
isConfigPendingRestart	Indicates whether a server restart is required for the value currently set in the value attribute to take effect.	true: for parameters whose value was changed and, because they aren't dynamic (that is, they're static), require a server restart for the change to take effect. false: for parameters whose value currently set in the value attribute is in effect, and aren't waiting for a server restart to take effect.
isDynamicConfig	Indicates whether a change in the value assigned to the parameter doesn't require or requires a server restart, for the change to take effect.	true: for parameters that, when their value changes, the change takes effect immediately. false: for parameters that, when their value changes, require a server restart for the change to take effect.
isReadOnly	Indicates if the user can or can't override the default value assigned to the parameter.	true: for parameters that are designated as read-only and the user can't change. false: for parameters that are designated as read-write and the user can set to a different value than their default.
name	Name of the parameter.	Any valid name for a server parameter.
resourceGroup	Name of the resource group in which the server is deployed.	Any valid name for a resource group in Azure.
source	Source from which the value currently set for the parameter originates.	system-default or user-override, depending on whether value is set to the system default or the user override it.
unit	Optional text describing the units in which the parameter is expressed.	When set to something, it can be any of 8KB, bytes, days, KB, megabytes, microseconds, milliseconds, minutes, percentage, seconds.
value	Value currently assigned to the parameter.	Varies, depending on the data type and allowed values of the parameter.

Related contents

• List server parameters with modified values.
• List read-write static server parameters.
• List read-write dynamic server parameters.
• List read-only server parameters.
• Set the value of one or more server parameters.
• Revert one server parameter to its default.
• Revert all server parameters to their default.