az postgres server

Manage PostgreSQL servers.

Commands

az postgres server configuration Manage configuration values for a server.
az postgres server configuration list List the configuration values for a server.
az postgres server configuration set Update the configuration of a server.
az postgres server configuration show Get the configuration for a server.".
az postgres server create Create a server.
az postgres server delete Delete a server.
az postgres server firewall-rule Manage firewall rules for a server.
az postgres server firewall-rule create Create a new firewall rule for a server.
az postgres server firewall-rule delete Delete a firewall rule.
az postgres server firewall-rule list List all firewall rules for a server.
az postgres server firewall-rule show Get the details of a firewall rule.
az postgres server firewall-rule update Update a firewall rule.
az postgres server georestore Geo-restore a server from backup.
az postgres server key Manage PostgreSQL server keys.
az postgres server key create Create server key.
az postgres server key delete Delete server key.
az postgres server key list Gets a list of Server keys.
az postgres server key show Show server key.
az postgres server list List available servers.
az postgres server private-endpoint-connection Manage PostgreSQL server private endpoint connections.
az postgres server private-endpoint-connection approve Approve the specified private endpoint connection associated with a PostgreSQL server.
az postgres server private-endpoint-connection delete Delete the specified private endpoint connection associated with a PostgreSQL server.
az postgres server private-endpoint-connection reject Reject the specified private endpoint connection associated with a PostgreSQL server.
az postgres server private-endpoint-connection show Show details of a private endpoint connection associated with a PostgreSQL server.
az postgres server private-link-resource Manage PostgreSQL server private link resources.
az postgres server private-link-resource list List the private link resources supported for a PostgreSQL server.
az postgres server replica Manage read replicas.
az postgres server replica create Create a read replica for a server.
az postgres server replica list List all read replicas for a given server.
az postgres server replica stop Stop replication to a read replica and make it a read/write server.
az postgres server restart Restart a server.
az postgres server restore Restore a server from backup.
az postgres server show Get the details of a server.
az postgres server update Update a server.
az postgres server vnet-rule Manage a server's virtual network rules.
az postgres server vnet-rule create Create a virtual network rule to allows access to a PostgreSQL server.
az postgres server vnet-rule delete Deletes the virtual network rule with the given name.
az postgres server vnet-rule list Gets a list of virtual network rules in a server.
az postgres server vnet-rule show Gets a virtual network rule.
az postgres server vnet-rule update Update a virtual network rule.
az postgres server wait Wait for server to satisfy certain conditions.

az postgres server create

Create a server.

az postgres server create --admin-password
--admin-user
--name
--resource-group
--sku-name
[--assign-identity]
[--auto-grow {Disabled, Enabled}]
[--backup-retention]
[--geo-redundant-backup {Disabled, Enabled}]
[--location]
[--only-show-errors]
[--public-network-access {Disabled, Enabled}]
[--ssl-enforcement {Disabled, Enabled}]
[--storage-size]
[--subscription]
[--tags]
[--version]

Examples

Create a PostgreSQL server in North Europe with sku GP_Gen5_2 (General Purpose, Gen 5 hardware, 2 vCores).

az postgres server create -l northeurope -g testgroup -n testsvr -u username -p password \ --sku-name GP_Gen5_2

Create a PostgreSQL server with all paramaters set.

az postgres server create -l northeurope -g testgroup -n testsvr -u username -p password \ --sku-name B_Gen5_1 --ssl-enforcement Enabled --public-network-access Disabled \ --backup-retention 10 --geo-redundant-backup Enabled --storage-size 51200 --tags "key=value" --version {server-version}

Required Parameters

--admin-password -p

The password of the administrator. Minimum 8 characters and maximum 128 characters. Password must contain characters from three of the following categories: English uppercase letters, English lowercase letters, numbers, and non-alphanumeric characters.

--admin-user -u

Administrator username for the server. Once set, it cannot be changed.

--name -n

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

--resource-group -g

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

--sku-name

The name of the sku. Follows the convention {pricing tier}{compute generation}{vCores} in shorthand. Examples: B_Gen5_1, GP_Gen5_4, MO_Gen5_16.

Optional Parameters

--assign-identity

Generate and assign an Azure Active Directory Identity for this server for use with key management services like Azure KeyVault.

--auto-grow

Enable or disable autogrow of the storage. Default value is Enabled.

accepted values: Disabled, Enabled
default value: Enabled
--backup-retention

The number of days a backup is retained. Range of 7 to 35 days. Default is 7 days.

--geo-redundant-backup

Enable or disable geo-redundant backups. Default value is Disabled. Not supported in Basic pricing tier.

accepted values: Disabled, Enabled
--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--only-show-errors

Only show errors, suppressing warnings.

--public-network-access

Set whether public network access to server is allowed or not. When false, only connections made through Private Links can reach this server.

accepted values: Disabled, Enabled
--ssl-enforcement

Enable or disable ssl enforcement for connections to server. Default is Enabled.

accepted values: Disabled, Enabled
--storage-size

The storage capacity of the server (unit is megabytes). Minimum 5120 and increases in 1024 increments. Default is 51200.

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--version

Server major version.

az postgres server delete

Delete a server.

az postgres server delete [--ids]
[--name]
[--only-show-errors]
[--resource-group]
[--subscription]
[--yes]

Examples

Delete a server.

az postgres server delete -g testgroup -n testsvr

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. If provided, no other 'Resource Id' arguments should be specified.

--name -n

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

--only-show-errors

Only show errors, suppressing warnings.

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

--yes -y

Do not prompt for confirmation.

az postgres server georestore

Geo-restore a server from backup.

az postgres server georestore --location
--source-server
[--backup-retention]
[--geo-redundant-backup]
[--ids]
[--name]
[--no-wait]
[--only-show-errors]
[--resource-group]
[--sku-name]
[--subscription]

Examples

Geo-restore 'testsvr' into a new server 'testsvrnew' located in West US 2.

az postgres server georestore -g testgroup -n testsvrnew --source-server testsvr -l westus2

Geo-restore 'testsvr' into a new server 'testsvrnew' located in West US 2 with sku GP_Gen5_2.

az postgres server georestore -g testgroup -n testsvrnew --source-server testsvr -l westus2 --sku-name GP_Gen5_2

Geo-restore 'testsvr2' into a new server 'testsvrnew', where 'testsvrnew' is in a different resource group from 'testsvr2'.

az postgres server georestore -g testgroup -n testsvrnew \
    -s "/subscriptions/${SubID}/resourceGroups/${ResourceGroup}/providers/Microsoft.DBforPostgreSQL/servers/testsvr2" \
    -l westus2

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--source-server -s

The name or ID of the source server to restore from.

Optional Parameters

--backup-retention

The number of days a backup is retained. Range of 7 to 35 days. Default is 7 days.

--geo-redundant-backup

Enable or disable geo-redundant backups. Default value is Disabled. Not supported in Basic pricing tier.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. If provided, no other 'Resource Id' arguments should be specified.

--name -n

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

--no-wait

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

--only-show-errors

Only show errors, suppressing warnings.

--resource-group -g

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

--sku-name

The name of the sku. Defaults to sku of the source server. Follows the convention {pricing tier}{compute generation}{vCores} in shorthand. Examples: B_Gen5_1, GP_Gen5_4, MO_Gen5_16.

--subscription

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

az postgres server list

List available servers.

az postgres server list [--only-show-errors]
[--resource-group]
[--subscription]

Examples

List all PostgreSQL servers in a subscription.

az postgres server list

List all PostgreSQL servers in a resource group.

az postgres server list -g testgroup

Optional Parameters

--only-show-errors

Only show errors, suppressing warnings.

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

az postgres server restart

Restart a server.

az postgres server restart [--ids]
[--name]
[--only-show-errors]
[--resource-group]
[--subscription]

Examples

Restart a server.

az postgres server restart -g testgroup -n testsvr

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. If provided, no other 'Resource Id' arguments should be specified.

--name -n

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

--only-show-errors

Only show errors, suppressing warnings.

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

az postgres server restore

Restore a server from backup.

az postgres server restore --restore-point-in-time
--source-server
[--ids]
[--name]
[--no-wait]
[--only-show-errors]
[--resource-group]
[--subscription]

Examples

Restore 'testsvr' to a specific point-in-time as a new server 'testsvrnew'.

az postgres server restore -g testgroup -n testsvrnew --source-server testsvr --restore-point-in-time "2017-06-15T13:10:00Z"

Restore 'testsvr2' to 'testsvrnew', where 'testsvrnew' is in a different resource group from 'testsvr2'.

az postgres server restore -g testgroup -n testsvrnew \
    -s "/subscriptions/${SubID}/resourceGroups/${ResourceGroup}/providers/Microsoft.DBforPostgreSQL/servers/testsvr2" \
    --restore-point-in-time "2017-06-15T13:10:00Z"

Required Parameters

--restore-point-in-time

The point in time to restore from (ISO8601 format), e.g., 2017-04-26T02:10:00+08:00.

--source-server -s

The name or resource ID of the source server to restore from.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. If provided, no other 'Resource Id' arguments should be specified.

--name -n

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

--no-wait

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

--only-show-errors

Only show errors, suppressing warnings.

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

az postgres server show

Get the details of a server.

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

Examples

Get the details of a server. (autogenerated)

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

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. If provided, no other 'Resource Id' arguments should be specified.

--name -n

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

--only-show-errors

Only show errors, suppressing warnings.

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

az postgres server update

Update a server.

az postgres server update [--add]
[--admin-password]
[--assign-identity]
[--auto-grow {Disabled, Enabled}]
[--backup-retention]
[--force-string]
[--ids]
[--name]
[--only-show-errors]
[--public-network-access {Disabled, Enabled}]
[--remove]
[--resource-group]
[--set]
[--sku-name]
[--ssl-enforcement {Disabled, Enabled}]
[--storage-size]
[--subscription]
[--tags]

Examples

Update a server's sku.

az postgres server update -g testgroup -n testsvrnew --sku-name GP_Gen5_4

Update a server's tags.

az postgres server update -g testgroup -n testsvrnew --tags "k1=v1" "k2=v2"

Update a server. (autogenerated)

az postgres server update --name testsvrnew --resource-group testgroup --ssl-enforcement Enabled

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--admin-password -p

The password of the administrator. Minimum 8 characters and maximum 128 characters. Password must contain characters from three of the following categories: English uppercase letters, English lowercase letters, numbers, and non-alphanumeric characters.

--assign-identity

Generate and assign an Azure Active Directory Identity for this server for use with key management services like Azure KeyVault.

--auto-grow

Enable or disable autogrow of the storage. Default value is Enabled.

accepted values: Disabled, Enabled
--backup-retention

The number of days a backup is retained. Range of 7 to 35 days. Default is 7 days.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. If provided, no other 'Resource Id' arguments should be specified.

--name -n

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

--only-show-errors

Only show errors, suppressing warnings.

--public-network-access

Set whether public network access to server is allowed or not. When false, only connections made through Private Links can reach this server.

accepted values: Disabled, Enabled
--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--sku-name

The name of the sku. Follows the convention {pricing tier}{compute generation}{vCores} in shorthand. Examples: B_Gen5_1, GP_Gen5_4, MO_Gen5_16.

--ssl-enforcement

Enable or disable ssl enforcement for connections to server. Default is Enabled.

accepted values: Disabled, Enabled
--storage-size

The storage capacity of the server (unit is megabytes). Minimum 5120 and increases in 1024 increments. Default is 51200.

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az postgres server wait

Wait for server to satisfy certain conditions.

az postgres server wait [--custom]
[--exists]
[--ids]
[--interval]
[--name]
[--only-show-errors]
[--resource-group]
[--subscription]
[--timeout]

Optional Parameters

--custom

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

--exists

Wait until the resource exists.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. If provided, no other 'Resource Id' arguments should be specified.

--interval

Polling interval in seconds.

default value: 30
--name -n

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

--only-show-errors

Only show errors, suppressing warnings.

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