az postgres server
Manage Azure Database for PostgreSQL Single Server. Is scheduled to retire by March 28, 2025. You can migrate to the Azure Database for PostgreSQL flexible server.
Commands
Name | Description | Type | Status |
---|---|---|---|
az postgres server ad-admin |
Manage a postgres server's Active Directory administrator. |
Core | GA |
az postgres server ad-admin create |
Create an Active Directory Administrator for PostgreSQL server. |
Core | GA |
az postgres server ad-admin delete |
Delete an Active Directory Administrator for PostgreSQL server. |
Core | GA |
az postgres server ad-admin list |
List all Active Directory Administrators for PostgreSQL server. |
Core | GA |
az postgres server ad-admin show |
Get Active Directory Administrator information for a PostgreSQL server. |
Core | GA |
az postgres server ad-admin wait |
Place the CLI in a waiting state until a condition of the PostgreSQL server Active Directory Administrator is met. |
Core | GA |
az postgres server configuration |
Manage configuration values for a server. |
Core | GA |
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 create |
Create a server. Azure Database for PostgreSQL Flexible Server is the next generation of the service. Please use 'az postgres flexible-server create' for new deployments. |
Core | GA |
az postgres server delete |
Delete a server. |
Core | GA |
az postgres server firewall-rule |
Manage firewall rules for a server. |
Core | GA |
az postgres server firewall-rule create |
Create a new firewall rule for a server. |
Core | GA |
az postgres server firewall-rule delete |
Delete a firewall rule. |
Core | GA |
az postgres server firewall-rule list |
List all firewall rules for a server. |
Core | GA |
az postgres server firewall-rule show |
Get the details of a firewall rule. |
Core | GA |
az postgres server firewall-rule update |
Update a firewall rule. |
Core | GA |
az postgres server georestore |
Geo-restore a server from backup. |
Core | GA |
az postgres server key |
Manage PostgreSQL server keys. |
Core | GA |
az postgres server key create |
Create server key. |
Core | GA |
az postgres server key delete |
Delete server key. |
Core | GA |
az postgres server key list |
Gets a list of Server keys. |
Core | GA |
az postgres server key show |
Show server key. |
Core | GA |
az postgres server list |
List available servers. |
Core | GA |
az postgres server list-skus |
List available sku's in the given region. |
Core | GA |
az postgres server private-endpoint-connection |
Manage PostgreSQL server private endpoint connections. |
Core | GA |
az postgres server private-endpoint-connection approve |
Approve the specified private endpoint connection associated with a PostgreSQL server. |
Core | GA |
az postgres server private-endpoint-connection delete |
Delete the specified private endpoint connection associated with a PostgreSQL server. |
Core | GA |
az postgres server private-endpoint-connection reject |
Reject the specified private endpoint connection associated with a PostgreSQL server. |
Core | GA |
az postgres server private-endpoint-connection show |
Show details of a private endpoint connection associated with a PostgreSQL server. |
Core | GA |
az postgres server private-link-resource |
Manage PostgreSQL server private link resources. |
Core | GA |
az postgres server private-link-resource list |
List the private link resources supported for a PostgreSQL server. |
Core | GA |
az postgres server replica |
Manage read replicas. |
Core | GA |
az postgres server replica create |
Create a read replica for a server. |
Core | GA |
az postgres server replica list |
List all read replicas for a given server. |
Core | GA |
az postgres server replica stop |
Stop replication to a read replica and make it a read/write server. |
Core | GA |
az postgres server restart |
Restart a server. |
Core | GA |
az postgres server restore |
Restore a server from backup. |
Core | GA |
az postgres server show |
Get the details of a server. |
Core | GA |
az postgres server show-connection-string |
Show the connection strings for a PostgreSQL server database. |
Core | GA |
az postgres server update |
Update a server. |
Core | GA |
az postgres server vnet-rule |
Manage a server's virtual network rules. |
Core | GA |
az postgres server vnet-rule create |
Create a virtual network rule to allows access to a PostgreSQL server. |
Core | GA |
az postgres server vnet-rule delete |
Deletes the virtual network rule with the given name. |
Core | GA |
az postgres server vnet-rule list |
Gets a list of virtual network rules in a server. |
Core | GA |
az postgres server vnet-rule show |
Gets a virtual network rule. |
Core | GA |
az postgres server vnet-rule update |
Update a virtual network rule. |
Core | GA |
az postgres server wait |
Wait for server to satisfy certain conditions. |
Core | GA |
az postgres server create
Create a server. Azure Database for PostgreSQL Flexible Server is the next generation of the service. Please use 'az postgres flexible-server create' for new deployments.
az postgres server create [--admin-password]
[--admin-user]
[--assign-identity]
[--auto-grow {Disabled, Enabled}]
[--backup-retention]
[--geo-redundant-backup {Disabled, Enabled}]
[--infrastructure-encryption {Disabled, Enabled}]
[--location]
[--minimal-tls-version {TLS1_0, TLS1_1, TLS1_2, TLSEnforcementDisabled}]
[--name]
[--public --public-network-access]
[--resource-group]
[--sku-name]
[--ssl-enforcement {Disabled, Enabled}]
[--storage-size]
[--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 --minimal-tls-version TLS1_0 --public-network-access Disabled \
--backup-retention 10 --geo-redundant-backup Enabled --storage-size 51200 \
--tags "key=value" --version 11
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
Property | Value |
---|---|
Parameter group: | Authentication Arguments |
Administrator username for the server. Once set, it cannot be changed.
Property | Value |
---|---|
Parameter group: | Authentication Arguments |
Default value: | lovingorange6 |
Generate and assign an Microsoft Entra Identity for this server for use with key management services like Azure KeyVault.
Property | Value |
---|---|
Default value: | False |
Enable or disable autogrow of the storage. Default value is Enabled.
Property | Value |
---|---|
Default value: | Enabled |
Accepted values: | Disabled, Enabled |
The number of days a backup is retained. Range of 7 to 35 days. Default is 7 days.
Enable or disable geo-redundant backups. Default value is Disabled. Not supported in Basic pricing tier.
Property | Value |
---|---|
Accepted values: | Disabled, Enabled |
Add an optional second layer of encryption for data using new encryption algorithm. Default value is Disabled.
Property | Value |
---|---|
Accepted values: | Disabled, Enabled |
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Set the minimal TLS version for connections to server when SSL is enabled. Default is TLSEnforcementDisabled.
Property | Value |
---|---|
Accepted values: | TLS1_0, TLS1_1, TLS1_2, TLSEnforcementDisabled |
Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.
Enable or disable public network access to server. When disabled, only connections made through Private Links can reach this server. Allowed values are : Enabled
, Disabled
, all
, 0.0.0.0
, <SingleIP>
, <StartIP-DestinationIP>
. Default is Enabled
.
Name of resource group. You can configure the default group using az configure --defaults group=<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.
Property | Value |
---|---|
Default value: | GP_Gen5_2 |
Enable or disable ssl enforcement for connections to server. Default is Enabled.
Property | Value |
---|---|
Accepted values: | Disabled, Enabled |
The storage capacity of the server (unit is megabytes). Minimum 5120 and increases in 1024 increments. Default is 5120.
Property | Value |
---|---|
Default value: | 5120 |
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Server major version. https://learn.microsoft.com/en-us/azure/postgresql/single-server/concepts-supported-versions.
Property | Value |
---|---|
Default value: | 11 |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az postgres server delete
Delete a server.
az postgres server delete [--ids]
[--name]
[--resource-group]
[--subscription]
[--yes]
Examples
Delete a server.
az postgres server delete -g testgroup -n 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.
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 |
Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
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]
[--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. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
The name or ID of the source server to restore from.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The number of days a backup is retained. Range of 7 to 35 days. Default is 7 days.
Enable or disable geo-redundant backups. Default value is Disabled. Not supported in Basic pricing tier.
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 |
Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Default value: | False |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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.
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az postgres server list
List available servers.
az postgres server list [--resource-group]
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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az postgres server list-skus
List available sku's in the given region.
az postgres server list-skus --location
Examples
List available sku's in the given region.
az postgres server list-skus -l eastus
Required Parameters
The name of the location. Required.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az postgres server restart
Restart a server.
az postgres server restart [--ids]
[--name]
[--resource-group]
[--subscription]
Examples
Restart a server.
az postgres server restart -g testgroup -n 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.
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 |
Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az postgres server restore
Restore a server from backup.
az postgres server restore --pitr-time --restore-point-in-time
--source-server
[--ids]
[--name]
[--no-wait]
[--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
The point in time in UTC to restore from (ISO8601 format), e.g., 2017-04-26T02:10:00+08:00.
The name or resource ID of the source server to restore from.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Default value: | False |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az postgres server show
Get the details of a server.
az postgres server show [--ids]
[--name]
[--resource-group]
[--subscription]
Examples
Get the details of a server. (autogenerated)
az postgres server show --name MyServer --resource-group MyResourceGroup
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az postgres server show-connection-string
Show the connection strings for a PostgreSQL server database.
az postgres server show-connection-string [--admin-password]
[--admin-user]
[--database-name]
[--ids]
[--server-name]
[--subscription]
Examples
Show connection strings for cmd and programming languages.
az postgres server show-connection-string -s testServer -u username -p password -d databasename
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The login password of the administrator.
Property | Value |
---|---|
Default value: | {password} |
The login username of the administrator.
Property | Value |
---|---|
Default value: | {username} |
The name of a database.
Property | Value |
---|---|
Default value: | {database} |
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 |
Name of the server.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Default value: | {server} |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
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]
[--minimal-tls-version {TLS1_0, TLS1_1, TLS1_2, TLSEnforcementDisabled}]
[--name]
[--public --public-network-access]
[--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 --minimal-tls-version TLS1_0
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Default value: | [] |
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.
Generate and assign an Microsoft Entra Identity for this server for use with key management services like Azure KeyVault.
Property | Value |
---|---|
Default value: | False |
Enable or disable autogrow of the storage. Default value is Enabled.
Property | Value |
---|---|
Accepted values: | Disabled, Enabled |
The number of days a backup is retained. Range of 7 to 35 days. Default is 7 days.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Default value: | False |
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 |
Set the minimal TLS version for connections to server when SSL is enabled. Default is TLSEnforcementDisabled.
Property | Value |
---|---|
Accepted values: | TLS1_0, TLS1_1, TLS1_2, TLSEnforcementDisabled |
Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Enable or disable public network access to server. When disabled, only connections made through Private Links can reach this server. Allowed values are : Enabled
, Disabled
, all
, 0.0.0.0
, <SingleIP>
, <StartIP-DestinationIP>
. Default is Enabled
.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Default value: | [] |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Default value: | [] |
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.
Enable or disable ssl enforcement for connections to server. Default is Enabled.
Property | Value |
---|---|
Accepted values: | Disabled, Enabled |
The storage capacity of the server (unit is megabytes). Minimum 5120 and increases in 1024 increments. Default is 5120.
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 |
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az postgres server wait
Wait for server to satisfy certain conditions.
az postgres server wait [--custom]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Wait until the resource exists.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
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 |
Polling interval in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 30 |
Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Maximum wait in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 3600 |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |