Share via

Servers - Update

Service:
PostgreSQL
API Version:
2025-08-01

Updates an existing server. The request body can contain one or multiple of the properties present in the normal server definition.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}?api-version=2025-08-01

URI Parameters

Name In Required Type Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
serverName
 path True

string

minLength: 3
maxLength: 63
pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*

The name of the server.
subscriptionId
 path True

string (uuid)

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Request Body

Name Type Description
identity

UserAssignedIdentity

Describes the identity of the application.
properties.administratorLogin

string

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

string (password)

Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time.
properties.authConfig

AuthConfigForPatch

Authentication configuration properties of a server.
properties.backup

BackupForPatch

Backup properties of a server.
properties.cluster

Cluster

Cluster properties of a server.
properties.createMode

CreateModeForPatch

Update mode of an existing server.
properties.dataEncryption

DataEncryption

Data encryption properties of a server.
properties.highAvailability

HighAvailabilityForPatch

High availability properties of a server.
properties.maintenanceWindow

MaintenanceWindowForPatch

Maintenance window properties of a server.
properties.network

Network

Network properties of a server. Only required if you want your server to be integrated into a virtual network provided by customer.
properties.replica

Replica

Read replica properties of a server. Required only in case that you want to promote a server.
properties.replicationRole

ReplicationRole

Role of the server in a replication set.
properties.storage

Storage

Storage properties of a server.
properties.version

PostgresMajorVersion

Major version of PostgreSQL database engine.
sku

SkuForPatch

Compute tier and size of a server.
tags

object

Application-specific metadata in the form of key-value pairs.

Responses

Name Type Description
202 Accepted

Accepted.

Headers

  • Location: string
  • Azure-AsyncOperation: string
Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Microsoft Entra OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Promote a read replica to a standalone server with forced data synchronization. Meaning that it doesn't wait for data in the read replica to be synchronized with its source server before it initiates the promotion to a standalone server.
Promote a read replica to a standalone server with planned data synchronization. Meaning that it waits for data in the read replica to be fully synchronized with its source server before it initiates the promotion to a standalone server.
Switch over a read replica to primary server with forced data synchronization. Meaning that it doesn't wait for data in the read replica to be synchronized with its source server before it initiates the switching of roles between the read replica and the primary server.
Switch over a read replica to primary server with planned data synchronization. Meaning that it waits for data in the read replica to be fully synchronized with its source server before it initiates the switching of roles between the read replica and the primary server.
Update an existing server to upgrade the major version of PostgreSQL database engine.
Update an existing server with custom maintenance window.
Update an existing server with data encryption based on customer managed key with automatic key version update.
Update an existing server with data encryption based on customer managed key.
Update an existing server with Microsoft Entra authentication enabled.
Update an existing server.

Promote a read replica to a standalone server with forced data synchronization. Meaning that it doesn't wait for data in the read replica to be synchronized with its source server before it initiates the promotion to a standalone server.

Sample request

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver?api-version=2025-08-01

{
  "properties": {
    "replica": {
      "promoteMode": "Standalone",
      "promoteOption": "Forced"
    }
  }
}

Sample response

Status code:
202 
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2025-06-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2025-06-01-preview

Promote a read replica to a standalone server with planned data synchronization. Meaning that it waits for data in the read replica to be fully synchronized with its source server before it initiates the promotion to a standalone server.

Sample request

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver?api-version=2025-08-01

{
  "properties": {
    "replica": {
      "promoteMode": "Standalone",
      "promoteOption": "Planned"
    }
  }
}

Sample response

Status code:
202 
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2025-06-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2025-06-01-preview

Switch over a read replica to primary server with forced data synchronization. Meaning that it doesn't wait for data in the read replica to be synchronized with its source server before it initiates the switching of roles between the read replica and the primary server.

Sample request

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver?api-version=2025-08-01

{
  "properties": {
    "replica": {
      "promoteMode": "Switchover",
      "promoteOption": "Forced"
    }
  }
}

Sample response

Status code:
202 
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2025-06-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2025-06-01-preview

Switch over a read replica to primary server with planned data synchronization. Meaning that it waits for data in the read replica to be fully synchronized with its source server before it initiates the switching of roles between the read replica and the primary server.

Sample request

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver?api-version=2025-08-01

{
  "properties": {
    "replica": {
      "promoteMode": "Switchover",
      "promoteOption": "Planned"
    }
  }
}

Sample response

Status code:
202 
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2025-06-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2025-06-01-preview

Update an existing server to upgrade the major version of PostgreSQL database engine.

Sample request

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver?api-version=2025-08-01

{
  "properties": {
    "createMode": "Update",
    "version": "17"
  }
}

Sample response

Status code:
202 
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2025-06-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2025-06-01-preview

Update an existing server with custom maintenance window.

Sample request

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver?api-version=2025-08-01

{
  "properties": {
    "createMode": "Update",
    "maintenanceWindow": {
      "customWindow": "Enabled",
      "dayOfWeek": 0,
      "startHour": 8,
      "startMinute": 0
    }
  }
}

Sample response

Status code:
202 
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2025-06-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2025-06-01-preview

Update an existing server with data encryption based on customer managed key with automatic key version update.

Sample request

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver?api-version=2025-08-01

{
  "sku": {
    "tier": "GeneralPurpose",
    "name": "Standard_D8s_v3"
  },
  "identity": {
    "userAssignedIdentities": {
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleprimaryidentity": {},
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplegeoredundantidentity": {}
    },
    "type": "UserAssigned"
  },
  "properties": {
    "administratorLoginPassword": "examplenewpassword",
    "createMode": "Update",
    "dataEncryption": {
      "type": "AzureKeyVault",
      "primaryKeyURI": "https://exampleprimarykeyvault.vault.azure.net/keys/examplekey",
      "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleprimaryidentity",
      "geoBackupKeyURI": "https://examplegeoredundantkeyvault.vault.azure.net/keys/examplekey",
      "geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplegeoredundantidentity"
    },
    "backup": {
      "backupRetentionDays": 20
    }
  }
}

Sample response

Status code:
202 
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2025-06-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2025-06-01-preview

Update an existing server with data encryption based on customer managed key.

Sample request

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver?api-version=2025-08-01

{
  "sku": {
    "tier": "GeneralPurpose",
    "name": "Standard_D8s_v3"
  },
  "identity": {
    "userAssignedIdentities": {
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleprimaryidentity": {},
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplegeoredundantidentity": {}
    },
    "type": "UserAssigned"
  },
  "properties": {
    "administratorLoginPassword": "examplenewpassword",
    "createMode": "Update",
    "dataEncryption": {
      "type": "AzureKeyVault",
      "primaryKeyURI": "https://exampleprimarykeyvault.vault.azure.net/keys/examplekey/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleprimaryidentity",
      "geoBackupKeyURI": "https://examplegeoredundantkeyvault.vault.azure.net/keys/examplekey/yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy",
      "geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplegeoredundantidentity"
    },
    "backup": {
      "backupRetentionDays": 20
    }
  }
}

Sample response

Status code:
202 
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2025-06-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2025-06-01-preview

Update an existing server with Microsoft Entra authentication enabled.

Sample request

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver?api-version=2025-08-01

{
  "sku": {
    "tier": "GeneralPurpose",
    "name": "Standard_D8s_v3"
  },
  "properties": {
    "administratorLoginPassword": "examplenewpassword",
    "createMode": "Update",
    "authConfig": {
      "activeDirectoryAuth": "Enabled",
      "passwordAuth": "Enabled",
      "tenantId": "tttttt-tttt-tttt-tttt-tttttttttttt"
    },
    "storage": {
      "storageSizeGB": 1024,
      "autoGrow": "Disabled",
      "tier": "P30"
    },
    "backup": {
      "backupRetentionDays": 20
    }
  }
}

Sample response

Status code:
202 
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2025-06-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2025-06-01-preview

Update an existing server.

Sample request

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver?api-version=2025-08-01

{
  "sku": {
    "tier": "GeneralPurpose",
    "name": "Standard_D8s_v3"
  },
  "properties": {
    "administratorLoginPassword": "examplenewpassword",
    "createMode": "Update",
    "storage": {
      "storageSizeGB": 1024,
      "autoGrow": "Enabled",
      "tier": "P30"
    },
    "backup": {
      "backupRetentionDays": 20
    }
  }
}

Sample response

Status code:
202 
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2025-06-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2025-06-01-preview

Definitions

Name Description
AuthConfigForPatch

Authentication configuration properties of a server.
AzureManagedDiskPerformanceTier

Storage tier of a server.
BackupForPatch

Backup properties of a server.
Cluster

Cluster properties of a server.
CreateModeForPatch

Update mode of an existing server.
DataEncryption

Data encryption properties of a server.
DataEncryptionType

Data encryption type used by a server.
EncryptionKeyStatus

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

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
GeographicallyRedundantBackup

Indicates if the server is configured to create geographically redundant backups.
HighAvailabilityForPatch

High availability properties of a server.
HighAvailabilityMode

High availability mode for a server.
HighAvailabilityState

Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant.
IdentityType

Types of identities associated with a server.
MaintenanceWindowForPatch

Maintenance window properties of a server.
MicrosoftEntraAuth

Indicates if the server supports Microsoft Entra authentication.
Network

Network properties of a server.
PasswordBasedAuth

Indicates if the server supports password based authentication.
PostgresMajorVersion

Major version of PostgreSQL database engine.
ReadReplicaPromoteMode

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

Data synchronization option to use when processing the operation specified in the promoteMode property. This property is write only.
Replica

Replica properties of a server.
ReplicationRole

Role of the server in a replication set.
ReplicationState

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
ServerForPatch

Represents a server to be updated.
ServerPublicNetworkAccessState

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

Compute information of a server.
SkuTier

Tier of the compute assigned to a server.
Storage

Storage properties of a server.
StorageAutoGrow

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

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

Identities associated with a server.
UserIdentity

User assigned managed identity associated with a server.

AuthConfigForPatch

Object

Authentication configuration properties of a server.

Name Type Description
activeDirectoryAuth

MicrosoftEntraAuth

Indicates if the server supports Microsoft Entra authentication.
passwordAuth

PasswordBasedAuth

Indicates if the server supports password based authentication.
tenantId

string

Identifier of the tenant of the delegated resource.

AzureManagedDiskPerformanceTier

Enumeration

Storage tier of a server.

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

BackupForPatch

Object

Backup properties of a server.

Name Type Description
backupRetentionDays

integer (int32)

Backup retention days for the server.
earliestRestoreDate

string (date-time)

Earliest restore point time (ISO8601 format) for a server.
geoRedundantBackup

GeographicallyRedundantBackup

Indicates if the server is configured to create geographically redundant backups.

Cluster

Object

Cluster properties of a server.

Name Type Default value Description
clusterSize

integer (int32)

0

Number of nodes assigned to the elastic cluster.
defaultDatabaseName

string

Default database name for the elastic cluster.

CreateModeForPatch

Enumeration

Update mode of an existing server.

Value Description
Default

It's equivalent to 'Update'.
Update

Operation updates an existing server.

DataEncryption

Object

Data encryption properties of a server.

Name Type Description
geoBackupEncryptionKeyStatus

EncryptionKeyStatus

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

string

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

string

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

EncryptionKeyStatus

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

string

URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a server.
primaryUserAssignedIdentityId

string

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

DataEncryptionType

Data encryption type used by a server.

DataEncryptionType

Enumeration

Data encryption type used by a server.

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

EncryptionKeyStatus

Enumeration

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.

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

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Object

Error response

Name Type Description
error

ErrorDetail

The error object.

GeographicallyRedundantBackup

Enumeration

Indicates if the server is configured to create geographically redundant backups.

Value Description
Enabled

Server is configured to create geographically redundant backups.
Disabled

Server is not configured to create geographically redundant backups.

HighAvailabilityForPatch

Object

High availability properties of a server.

Name Type Description
mode

HighAvailabilityMode

High availability mode for a server.
standbyAvailabilityZone

string

Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant.
state

HighAvailabilityState

Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant.

HighAvailabilityMode

Enumeration

High availability mode for a server.

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

HighAvailabilityState

Enumeration

Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant.

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

IdentityType

Enumeration

Types of identities associated with a server.

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

MaintenanceWindowForPatch

Object

Maintenance window properties of a server.

Name Type Description
customWindow

string

Indicates whether custom window is enabled or disabled.
dayOfWeek

integer (int32)

Day of the week to be used for maintenance window.
startHour

integer (int32)

Start hour to be used for maintenance window.
startMinute

integer (int32)

Start minute to be used for maintenance window.

MicrosoftEntraAuth

Enumeration

Indicates if the server supports Microsoft Entra authentication.

Value Description
Enabled

Server supports Microsoft Entra authentication.
Disabled

Server doesn't support Microsoft Entra authentication.

Network

Object

Network properties of a server.

Name Type Description
delegatedSubnetResourceId

string

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

string

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

ServerPublicNetworkAccessState

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.

PasswordBasedAuth

Enumeration

Indicates if the server supports password based authentication.

Value Description
Enabled

Server supports password based authentication.
Disabled

Server doesn't support password based authentication.

PostgresMajorVersion

Enumeration

Major version of PostgreSQL database engine.

Value Description
18

PostgreSQL 18.
17

PostgreSQL 17.
16

PostgreSQL 16.
15

PostgreSQL 15.
14

PostgreSQL 14.
13

PostgreSQL 13.
12

PostgreSQL 12.
11

PostgreSQL 11.

ReadReplicaPromoteMode

Enumeration

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.

Value Description
Standalone

Read replica will become an independent server.
Switchover

Read replica will swap roles with primary server.

ReadReplicaPromoteOption

Enumeration

Data synchronization option to use when processing the operation specified in the promoteMode property. This property is write only.

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

Replica

Object

Replica properties of a server.

Name Type Description
capacity

integer (int32)

Maximum number of read replicas allowed for a server.
promoteMode

ReadReplicaPromoteMode

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

ReadReplicaPromoteOption

Data synchronization option to use when processing the operation specified in the promoteMode property. This property is write only.
replicationState

ReplicationState

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
role

ReplicationRole

Role of the server in a replication set.

ReplicationRole

Enumeration

Role of the server in a replication set.

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

ReplicationState

Enumeration

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

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

ServerForPatch

Object

Represents a server to be updated.

Name Type Description
identity

UserAssignedIdentity

Describes the identity of the application.
properties.administratorLogin

string

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

string (password)

Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time.
properties.authConfig

AuthConfigForPatch

Authentication configuration properties of a server.
properties.backup

BackupForPatch

Backup properties of a server.
properties.cluster

Cluster

Cluster properties of a server.
properties.createMode

CreateModeForPatch

Update mode of an existing server.
properties.dataEncryption

DataEncryption

Data encryption properties of a server.
properties.highAvailability

HighAvailabilityForPatch

High availability properties of a server.
properties.maintenanceWindow

MaintenanceWindowForPatch

Maintenance window properties of a server.
properties.network

Network

Network properties of a server. Only required if you want your server to be integrated into a virtual network provided by customer.
properties.replica

Replica

Read replica properties of a server. Required only in case that you want to promote a server.
properties.replicationRole

ReplicationRole

Role of the server in a replication set.
properties.storage

Storage

Storage properties of a server.
properties.version

PostgresMajorVersion

Major version of PostgreSQL database engine.
sku

SkuForPatch

Compute tier and size of a server.
tags

object

Application-specific metadata in the form of key-value pairs.

ServerPublicNetworkAccessState

Enumeration

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.

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

SkuForPatch

Object

Compute information of a server.

Name Type Description
name

string

Name by which is known a given compute size assigned to a server.
tier

SkuTier

Tier of the compute assigned to a server.

SkuTier

Enumeration

Tier of the compute assigned to a server.

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

Storage

Object

Storage properties of a server.

Name Type Description
autoGrow

StorageAutoGrow

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

integer (int32)

Maximum IOPS supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS.
storageSizeGB

integer (int32)

Size of storage assigned to a server.
throughput

integer (int32)

Maximum throughput supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS.
tier

AzureManagedDiskPerformanceTier

Storage tier of a server.
type

StorageType

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.

StorageAutoGrow

Enumeration

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.

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

StorageType

Enumeration

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.

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

UserAssignedIdentity

Object

Identities associated with a server.

Name Type Description
principalId

string

Identifier of the object of the service principal associated to the user assigned managed identity.
tenantId

string

Identifier of the tenant of a server.
type

IdentityType

Types of identities associated with a server.
userAssignedIdentities

<string,  UserIdentity>

Map of user assigned managed identities.

UserIdentity

Object

User assigned managed identity associated with a server.

Name Type Description
clientId

string

Identifier of the client of the service principal associated to the user assigned managed identity.
principalId

string

Identifier of the object of the service principal associated to the user assigned managed identity.