Microsoft.DBforPostgreSQL (stable:2025-08-01)

2025/11/10 • 1 updated methods

Servers_Update (updated)
Description :  Updates an existing server. The request body can contain one or multiple of the properties present in the normal server definition.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "@added_9b69ebc367b541abbd998c41229146ea": {
              "#name": "availabilityZone",
              "Description": "Availability zone of a server.",
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters required to update a server. ,
Required: True ,
}
{
sku:
{
Description: Compute tier and size of a server. ,
Required: False ,
}
{
name:
{
Description: Name by which is known a given compute size assigned to a server. ,
Required: False ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a server. ,
Enum:
{
Burstable: Cost-effective tier for infrequent CPU usage, ideal for development and testing workloads with low performance requirements. ,
GeneralPurpose: Balanced compute and memory for most workloads, offering scalable performance and I/O throughput. ,
MemoryOptimized: High memory-to-core ratio for demanding workloads needing fast in-memory processing and high concurrency. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Describes the identity of the application. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: Map of user assigned managed identities. ,
Required: False ,
}
object ,
principalId:
{
Description: Identifier of the object of the service principal associated to the user assigned managed identity. ,
Required: False ,
}
string ,
type:
{
Description: Types of identities associated with a server. ,
Enum:
{
None: No managed identity is assigned to the server. ,
UserAssigned: One or more managed identities provided by the user are assigned to the server. ,
SystemAssigned: Azure automatically creates and manages the identity associated to the lifecycle of the server. ,
SystemAssigned,UserAssigned: Both system-assigned and user-assigned identities are assigned to the server. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of a server. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server. ,
Required: False ,
}
{
administratorLogin:
{
Description: Name of the login designated as the first password based administrator assigned to your instance of PostgreSQL. Must be specified the first time that you enable password based authentication on a server. Once set to a given value, it cannot be changed for the rest of the life of a server. If you disable password based authentication on a server which had it enabled, this password based role isn't deleted. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time. ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: Major version of PostgreSQL database engine. ,
Enum:
{
18: PostgreSQL 18. ,
17: PostgreSQL 17. ,
16: PostgreSQL 16. ,
15: PostgreSQL 15. ,
14: PostgreSQL 14. ,
13: PostgreSQL 13. ,
12: PostgreSQL 12. ,
11: PostgreSQL 11. ,
}
,
Required: False ,
}
enum ,
storage:
{
Description: Storage properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Size of storage assigned to a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Flag to enable or disable the automatic growth of storage size of a server when available space is nearing zero and conditions allow for automatically growing storage size. ,
Enum:
{
Enabled: Server should automatically grow storage size when available space is nearing zero and conditions allow for automatically growing storage size. ,
Disabled: Server should not automatically grow storage size when available space is nearing zero. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Storage tier of a server. ,
Enum:
{
P1: Entry-level SSD for minimal IOPS, ideal for light development or testing workloads. ,
P2: Slightly higher IOPS for small-scale applications needing consistent low latency. ,
P3: Balanced performance for basic production workloads with moderate throughput. ,
P4: Enhanced IOPS for growing apps with predictable performance needs. ,
P6: Mid-tier SSD for steady workloads requiring reliable throughput and latency. ,
P10: Popular choice for general-purpose production workloads with scalable performance. ,
P15: High IOPS tier for demanding apps with frequent read/write operations. ,
P20: Entry point for high-performance Solid State Disks (SSDs), suitable for small-scale I/O-intensive workloads. ,
P30: Balanced tier for moderate throughput and latency-sensitive applications. ,
P40: Enhanced performance for growing production workloads with consistent IOPS demands. ,
P50: Optimized for enterprise-grade applications needing sustained high throughput. ,
P60: High-capacity tier for large databases and analytics workloads with elevated IOPS. ,
P70: Designed for mission-critical systems requiring ultra-low latency and high concurrency. ,
P80: Top-tier SSD for maximum IOPS and throughput, ideal for the most demanding workloads. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: Maximum IOPS supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
throughput:
{
Description: Maximum throughput supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: Type of storage assigned to a server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS. ,
Enum:
{
Premium_LRS: Standard Solid State Disk (SSD) backed storage offering consistent performance for general purpose workloads. ,
PremiumV2_LRS: Next generation Solid State Disk (SSD) storage with improved scalability and performance for demanding enterprise workloads. ,
UltraSSD_LRS: High-end Solid State Disk (SSD) storage designed for extreme IOPS and latency-sensitive applications. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: Indicates if the server is configured to create geographically redundant backups. ,
Enum:
{
Enabled: Server is configured to create geographically redundant backups. ,
Disabled: Server is not configured to create geographically redundant backups. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point time (ISO8601 format) for a server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability properties of a server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a server. ,
Enum:
{
Disabled: High availability is disabled for the server. ,
ZoneRedundant: High availability is enabled for the server, with standby server in a different availability zone than that of the primary. ,
SameZone: High availability is enabled for the server, with standby server in the same availability zone as the primary. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant. ,
Enum:
{
NotEnabled: High availability is not enabled for the server. ,
CreatingStandby: Standby server is being created. ,
ReplicatingData: Data is being replicated to the standby server. ,
FailingOver: Failover operation to the standby server is in progress. ,
Healthy: Standby server is healthy and ready to take over in case of a failover. ,
RemovingStandby: Standby server is being removed. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant. ,
Required: False ,
}
string ,
}
,
maintenanceWindow:
{
Description: Maintenance window properties of a server. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom window is enabled or disabled. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour to be used for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute to be used for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Day of the week to be used for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
authConfig:
{
Description: Authentication configuration properties of a server. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Description: Indicates if the server supports Microsoft Entra authentication. ,
Enum:
{
Enabled: Server supports Microsoft Entra authentication. ,
Disabled: Server doesn't support Microsoft Entra authentication. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Description: Indicates if the server supports password based authentication. ,
Enum:
{
Enabled: Server supports password based authentication. ,
Disabled: Server doesn't support password based authentication. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of the delegated resource. ,
Required: False ,
}
string ,
}
,
dataEncryption:
{
Description: Data encryption properties of a server. ,
Required: False ,
}
{
primaryKeyURI:
{
Description: URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a server. ,
Required: False ,
}
string ,
primaryUserAssignedIdentityId:
{
Description: Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a server. ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups. ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups. ,
Required: False ,
}
string ,
type:
{
Description: Data encryption type used by a server. ,
Enum:
{
SystemManaged: Encryption managed by Azure using platform managed keys for simplicity and compliance. ,
AzureKeyVault: Encryption using customer managed keys stored in Azure Key Vault for enhanced control and security. ,
}
,
Required: False ,
}
enum ,
primaryEncryptionKeyStatus:
{
Description: Status of key used by a server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server. ,
Enum:
{
Valid: Key is valid and can be used for encryption. ,
Invalid: Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key. ,
}
,
Required: False ,
}
enum ,
geoBackupEncryptionKeyStatus:
{
Description: Status of key used by a server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups. ,
Enum:
{
Valid: Key is valid and can be used for encryption. ,
Invalid: Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key. ,
}
,
Required: False ,
}
enum ,
}
,
availabilityZone:
{
Description: Availability zone of a server. ,
Required: False ,
}
string ,
createMode:
{
Description: Update mode of an existing server. ,
Enum:
{
Default: It's equivalent to 'Update'. ,
Update: Operation updates an existing server. ,
}
,
Required: False ,
}
enum ,
replicationRole:
{
Description: Role of the server in a replication set. ,
Enum:
{
None: No replication role assigned; the server operates independently. ,
Primary: Acts as the source server for replication to one or more replicas. ,
AsyncReplica: Receives data asynchronously from a primary server within the same region. ,
GeoAsyncReplica: Receives data asynchronously from a primary server in a different region for geographical redundancy. ,
}
,
Required: False ,
}
enum ,
replica:
{
Description: Read replica properties of a server. Required only in case that you want to promote a server. ,
Required: False ,
}
{
role:
{
Description: Role of the server in a replication set. ,
Enum:
{
None: No replication role assigned; the server operates independently. ,
Primary: Acts as the source server for replication to one or more replicas. ,
AsyncReplica: Receives data asynchronously from a primary server within the same region. ,
GeoAsyncReplica: Receives data asynchronously from a primary server in a different region for geographical redundancy. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Maximum number of read replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replicationState:
{
Description: Indicates the replication state of a read replica. This property is returned only when the target server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating ,
Enum:
{
Active: Read replica is fully synchronized and actively replicating data from the primary server. ,
Catchup: Read replica is behind the primary server and is currently catching up with pending changes. ,
Provisioning: Read replica is being created and is in process of getting initialized. ,
Updating: Read replica is undergoing some changes it can be changing compute size of promoting it to primary server. ,
Broken: Replication has failed or been interrupted. ,
Reconfiguring: Read replica is being reconfigured, possibly due to changes in source or settings. ,
}
,
Required: False ,
}
enum ,
promoteMode:
{
Description: Type of operation to apply on the read replica. This property is write only. Standalone means that the read replica will be promoted to a standalone server, and will become a completely independent entity from the replication set. Switchover means that the read replica will roles with the primary server. ,
Enum:
{
Standalone: Read replica will become an independent server. ,
Switchover: Read replica will swap roles with primary server. ,
}
,
Required: False ,
}
enum ,
promoteOption:
{
Description: Data synchronization option to use when processing the operation specified in the promoteMode property. This property is write only. ,
Enum:
{
Planned: The operation will wait for data in the read replica to be fully synchronized with its source server, before it initiates the operation. ,
Forced: The operation will not wait for data in the read replica to be synchronized with its source server, before it initiates the operation. ,
}
,
Required: False ,
}
enum ,
}
,
network:
{
Description: Network properties of a server. Only required if you want your server to be integrated into a virtual network provided by customer. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates if public network access is enabled or not. This is only supported for servers that are not integrated into a virtual network which is owned and provided by customer when server is deployed. ,
Enum:
{
Enabled: Public network access is enabled. This allows the server to be accessed from the public internet, provided the necessary firewall rule that allows incoming traffic originating from the connecting client is in place. This is compatible with the use of private endpoints to connect to this server. ,
Disabled: Public network access is disabled. This means the server cannot be accessed from the public internet, but only via private endpoints. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Resource identifier of the delegated subnet. Required during creation of a new server, in case you want the server to be integrated into your own virtual network. For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. ,
Required: False ,
}
string ,
privateDnsZoneArmResourceId:
{
Description: Identifier of the private DNS zone. Required during creation of a new server, in case you want the server to be integrated into your own virtual network. For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. ,
Required: False ,
}
string ,
}
,
cluster:
{
Description: Cluster properties of a server. ,
Required: False ,
}
{
clusterSize:
{
Description: Number of nodes assigned to the elastic cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDatabaseName:
{
Description: Default database name for the elastic cluster. ,
Required: False ,
}
string ,
}
,
}
,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}