共用方式為


Servers - Update

更新現有伺服器。 請求正文可以包含常規伺服器定義中存在的一個或多個屬性。

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

URI 參數

名稱 位於 必要 類型 Description
resourceGroupName
path True

string

minLength: 1
maxLength: 90

資源群組的名稱。 名稱不區分大小寫。

serverName
path True

string

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

伺服器的名稱。

subscriptionId
path True

string (uuid)

目標訂用帳戶的標識碼。 此值必須是 UUID。

api-version
query True

string

minLength: 1

用於此作業的 API 版本。

要求本文

名稱 類型 Description
identity

UserAssignedIdentity

描述應用程式的身分識別。

properties.administratorLogin

string

指定為分配給 PostgreSQL 實例的第一個基於密碼的管理員的登錄名。 首次在伺服器上啟用基於密碼的身份驗證時,必須指定此參數。 一旦設置為給定值,則在伺服器的其餘生命週期內無法更改。 如果在啟用了基於密碼的身份驗證的伺服器上禁用基於密碼的身份驗證,則不會刪除此基於密碼的角色。

properties.administratorLoginPassword

string (password)

分配給管理員登錄名的密碼。 只要啟用了密碼身份驗證,就可以隨時更改此密碼。

properties.authConfig

AuthConfigForPatch

伺服器的身份驗證配置屬性。

properties.availabilityZone

string

伺服器的可用性區域。

properties.backup

BackupForPatch

伺服器的備份屬性。

properties.cluster

Cluster

伺服器的叢集屬性。

properties.createMode

CreateModeForPatch

現有伺服器的更新模式。

properties.dataEncryption

DataEncryption

伺服器的數據加密屬性。

properties.highAvailability

HighAvailabilityForPatch

伺服器的高可用性屬性。

properties.maintenanceWindow

MaintenanceWindowForPatch

伺服器的維護時段屬性。

properties.network

Network

伺服器的網路屬性。 僅當您希望將伺服器集成到客戶提供的虛擬網路中時,才需要。

properties.replica

Replica

伺服器的唯讀副本屬性。 僅在您想要升級伺服器時才需要。

properties.replicationRole

ReplicationRole

伺服器在複製集中的角色。

properties.storage

Storage

伺服器的儲存屬性。

properties.version

PostgresMajorVersion

PostgreSQL 資料庫引擎的主要版本。

sku

SkuForPatch

伺服器的計算層和大小。

tags

object

索引鍵/值組形式的應用程式特有中繼資料。

回應

名稱 類型 Description
202 Accepted

Accepted.

標題

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

ErrorResponse

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Microsoft Entra OAuth2 流

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 冒充您的使用者帳戶

範例

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.

範例要求

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

範例回覆

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.

範例要求

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

範例回覆

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.

範例要求

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

範例回覆

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.

範例要求

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

範例回覆

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.

範例要求

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

範例回覆

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.

範例要求

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

範例回覆

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.

範例要求

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

範例回覆

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.

範例要求

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

範例回覆

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.

範例要求

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

範例回覆

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.

範例要求

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

範例回覆

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

定義

名稱 Description
AuthConfigForPatch

伺服器的身份驗證配置屬性。

AzureManagedDiskPerformanceTier

伺服器的存儲層。

BackupForPatch

伺服器的備份屬性。

Cluster

伺服器的叢集屬性。

CreateModeForPatch

現有伺服器的更新模式。

DataEncryption

伺服器的數據加密屬性。

DataEncryptionType

伺服器使用的數據加密類型。

EncryptionKeyStatus

配置了基於客戶管理金鑰的數據加密的伺服器使用的金鑰狀態,用於加密與伺服器關聯的主存儲。

ErrorAdditionalInfo

資源管理錯誤附加資訊。

ErrorDetail

錯誤詳細資料。

ErrorResponse

錯誤回應

GeographicallyRedundantBackup

指示是否將 伺服器配置為創建地理位置冗餘的備份。

HighAvailabilityForPatch

伺服器的高可用性屬性。

HighAvailabilityMode

伺服器的高可用性模式。

HighAvailabilityState

當高可用性設置為 SameZone 或 ZoneRedundant 時創建的備用伺服器的可能狀態。

IdentityType

與伺服器關聯的標識類型。

MaintenanceWindowForPatch

伺服器的維護時段屬性。

MicrosoftEntraAuth

指示伺服器是否支援 Microsoft Entra 身份驗證。

Network

伺服器的網路屬性。

PasswordBasedAuth

指示伺服器是否支援基於密碼的身份驗證。

PostgresMajorVersion

PostgreSQL 資料庫引擎的主要版本。

ReadReplicaPromoteMode

要應用於唯讀複本的作類型。 此屬性是 write only。 Standalone 意味著只讀副本將被提升為獨立伺服器,並將成為完全獨立於複製集的實體。 切換意味著唯讀副本將與主伺服器一起扮演角色。

ReadReplicaPromoteOption

處理 promoteMode 屬性中指定的作時使用的數據同步選項。 此屬性是 write only。

Replica

伺服器的復本屬性。

ReplicationRole

伺服器在複製集中的角色。

ReplicationState

指示只讀複本的複製狀態。 僅當目標伺服器是唯讀副本時,才會返回此屬性。 可能的值包括 Active、Broken、Catchup、Provisioning、Reconfiguring 和 Updating

ServerForPatch

表示要更新的伺服器。

ServerPublicNetworkAccessState

指示是否啟用公共網路訪問。 這僅適用於未整合至部署伺服器時由客戶擁有和提供的虛擬網路的伺服器。

SkuForPatch

計算伺服器的資訊。

SkuTier

分配給伺服器的計算層。

Storage

伺服器的儲存屬性。

StorageAutoGrow

當可用空間接近零且條件允許自動增加存儲大小時,標誌以啟用或禁用伺服器存儲大小的自動增長。

StorageType

分配給伺服器的存儲類型。 允許的值為 Premium_LRS、PremiumV2_LRS 或 UltraSSD_LRS。 如果未指定,則預設為 Premium_LRS。

UserAssignedIdentity

與伺服器關聯的標識。

UserIdentity

與伺服器關聯的使用者分配的託管標識。

AuthConfigForPatch

伺服器的身份驗證配置屬性。

名稱 類型 Description
activeDirectoryAuth

MicrosoftEntraAuth

指示伺服器是否支援 Microsoft Entra 身份驗證。

passwordAuth

PasswordBasedAuth

指示伺服器是否支援基於密碼的身份驗證。

tenantId

string

委託資源的租戶的標識碼。

AzureManagedDiskPerformanceTier

伺服器的存儲層。

Description
P1

入門級 SSD,IOPS 最低,非常適合輕度開發或測試工作負載。

P2

對於需要一致低延遲的小型應用程式,IOPS 略高。

P3

具有中等輸送量的基本生產工作負載的平衡效能。

P4

增強的 IOPS,適用於具有可預測效能需求的成長應用程式。

P6

中階 SSD 適用於需要可靠輸送量和延遲的穩定工作負載。

P10

具有可擴展效能的一般用途生產工作負載的熱門選擇。

P15

高 IOPS 層,適用於具有頻繁讀取/寫入操作的苛刻應用程式。

P20

高效能固態硬碟 (SSD) 的入口點,適用於小規模 I/O 密集型工作負載。

P30

平衡層,適用於中等輸送量和延遲敏感型應用程式。

P40

增強效能,適用於具有一致 IOPS 需求的不斷增長的生產工作負載。

P50

針對需要持續高吞吐量的企業級應用進行了優化。

P60

適用於具有提升 IOPS 的大型資料庫和分析工作負載的高容量層。

P70

專為需要超低延遲和高並發的關鍵任務系統而設計。

P80

頂級 SSD 可實現最大 IOPS 和吞吐量,非常適合要求最苛刻的工作負載。

BackupForPatch

伺服器的備份屬性。

名稱 類型 Description
backupRetentionDays

integer (int32)

伺服器的備份保留天數。

earliestRestoreDate

string (date-time)

伺服器的最早還原點時間(ISO8601格式)。

geoRedundantBackup

GeographicallyRedundantBackup

指示是否將 伺服器配置為創建地理位置冗餘的備份。

Cluster

伺服器的叢集屬性。

名稱 類型 預設值 Description
clusterSize

integer (int32)

0

分配給 Elastic Cluster 的節點數。

defaultDatabaseName

string

彈性群集的預設資料庫名稱。

CreateModeForPatch

現有伺服器的更新模式。

Description
Default

它相當於“更新”。

Update

作業會更新現有的伺服器。

DataEncryption

伺服器的數據加密屬性。

名稱 類型 Description
geoBackupEncryptionKeyStatus

EncryptionKeyStatus

配置了基於客戶管理的金鑰的數據加密的伺服器使用的金鑰的狀態,用於在伺服器配置為支援地理冗餘備份時加密與伺服器關聯的地理冗餘存儲。

geoBackupKeyURI

string

使用者分配的託管標識的標識碼,用於訪問 Azure Key Vault 中的密鑰,以便對與配置為支援地理冗餘備份的伺服器關聯的地理冗餘存儲進行數據加密。

geoBackupUserAssignedIdentityId

string

使用者分配的託管標識的標識碼,用於訪問 Azure Key Vault 中的密鑰,以便對與配置為支援地理冗餘備份的伺服器關聯的地理冗餘存儲進行數據加密。

primaryEncryptionKeyStatus

EncryptionKeyStatus

配置了基於客戶管理金鑰的數據加密的伺服器使用的金鑰狀態,用於加密與伺服器關聯的主存儲。

primaryKeyURI

string

Azure Key Vault 中用於對與伺服器關聯的主存儲進行數據加密的金鑰的 URI。

primaryUserAssignedIdentityId

string

使用者分配的託管標識的標識碼,用於訪問 Azure Key Vault 中的密鑰,以便對與伺服器關聯的主存儲進行數據加密。

type

DataEncryptionType

伺服器使用的數據加密類型。

DataEncryptionType

伺服器使用的數據加密類型。

Description
SystemManaged

由 Azure 使用平台受控金鑰管理的加密,以實現簡單性和合規性。

AzureKeyVault

使用儲存在 Azure 金鑰保存庫中的客戶自控金鑰進行加密,以增強控制和安全性。

EncryptionKeyStatus

配置了基於客戶管理金鑰的數據加密的伺服器使用的金鑰狀態,用於加密與伺服器關聯的主存儲。

Description
Valid

金鑰有效,可用於加密。

Invalid

金鑰無效,無法用於加密。 可能的原因包括金鑰刪除、權限變更、金鑰被停用、金鑰類型不受支援,或目前日期超出與金鑰相關聯的有效期間。

ErrorAdditionalInfo

資源管理錯誤附加資訊。

名稱 類型 Description
info

object

附加資訊。

type

string

其他資訊類型。

ErrorDetail

錯誤詳細資料。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤附加資訊。

code

string

錯誤碼。

details

ErrorDetail[]

錯誤詳細資料。

message

string

錯誤訊息。

target

string

錯誤目標。

ErrorResponse

錯誤回應

名稱 類型 Description
error

ErrorDetail

錯誤物件。

GeographicallyRedundantBackup

指示是否將 伺服器配置為創建地理位置冗餘的備份。

Description
Enabled

伺服器設定為建立地理備援備份。

Disabled

伺服器未設定為建立地理備援備份。

HighAvailabilityForPatch

伺服器的高可用性屬性。

名稱 類型 Description
mode

HighAvailabilityMode

伺服器的高可用性模式。

standbyAvailabilityZone

string

與高可用性設置為 SameZone 或 ZoneRedundant 時創建的備用伺服器關聯的可用區。

state

HighAvailabilityState

當高可用性設置為 SameZone 或 ZoneRedundant 時創建的備用伺服器的可能狀態。

HighAvailabilityMode

伺服器的高可用性模式。

Description
Disabled

伺服器已停用高可用性。

ZoneRedundant

伺服器已啟用高可用性,且待命伺服器位於與主要伺服器不同的可用性區域中。

SameZone

伺服器已啟用高可用性,待命伺服器與主要伺服器位於相同的可用性區域中。

HighAvailabilityState

當高可用性設置為 SameZone 或 ZoneRedundant 時創建的備用伺服器的可能狀態。

Description
NotEnabled

伺服器未啟用高可用性。

CreatingStandby

正在建立待命伺服器。

ReplicatingData

資料正在抄寫至待命伺服器。

FailingOver

對待命伺服器的失效接手作業正在進行中。

Healthy

待命伺服器狀況良好,並準備好在容錯移轉時接管。

RemovingStandby

正在移除待命伺服器。

IdentityType

與伺服器關聯的標識類型。

Description
None

不會將受控識別指派給伺服器。

UserAssigned

使用者提供的一或多個受控識別會指派給伺服器。

SystemAssigned

Azure 會自動建立和管理與伺服器生命週期相關聯的身分識別。

SystemAssigned,UserAssigned

系統指派和使用者指派的身分都會指派給伺服器。

MaintenanceWindowForPatch

伺服器的維護時段屬性。

名稱 類型 Description
customWindow

string

指示自定義視窗是啟用還是禁用。

dayOfWeek

integer (int32)

用於維護時段的星期幾。

startHour

integer (int32)

用於維護時段的開始時間。

startMinute

integer (int32)

用於維護時段的開始分鐘。

MicrosoftEntraAuth

指示伺服器是否支援 Microsoft Entra 身份驗證。

Description
Enabled

伺服器支援 Microsoft Entra 驗證。

Disabled

伺服器不支援 Microsoft Entra 驗證。

Network

伺服器的網路屬性。

名稱 類型 Description
delegatedSubnetResourceId

string

委託子網的資源標識碼。 在創建新伺服器期間是必需的,以防您希望將伺服器集成到您自己的虛擬網路中。 對於更新作,如果要更改為私有 DNS 區域分配的值,則只需提供此屬性。

privateDnsZoneArmResourceId

string

私有 DNS 區域的識別碼。 在創建新伺服器期間是必需的,以防您希望將伺服器集成到您自己的虛擬網路中。 對於更新作,如果要更改為私有 DNS 區域分配的值,則只需提供此屬性。

publicNetworkAccess

ServerPublicNetworkAccessState

指示是否啟用公共網路訪問。 這僅適用於未整合至部署伺服器時由客戶擁有和提供的虛擬網路的伺服器。

PasswordBasedAuth

指示伺服器是否支援基於密碼的身份驗證。

Description
Enabled

伺服器支援以密碼為基礎的鑑別。

Disabled

伺服器不支援以密碼為基礎的驗證。

PostgresMajorVersion

PostgreSQL 資料庫引擎的主要版本。

Description
18

PostgreSQL 18.

17

PostgreSQL 17.

16

PostgreSQL 16.

15

PostgreSQL 15.

14

PostgreSQL 14.

13

PostgreSQL 13 的 13.

12

PostgreSQL 12 的 12.

11

PostgreSQL 11.

ReadReplicaPromoteMode

要應用於唯讀複本的作類型。 此屬性是 write only。 Standalone 意味著只讀副本將被提升為獨立伺服器,並將成為完全獨立於複製集的實體。 切換意味著唯讀副本將與主伺服器一起扮演角色。

Description
Standalone

唯讀副本將成為獨立伺服器。

Switchover

唯讀副本將與主伺服器交換角色。

ReadReplicaPromoteOption

處理 promoteMode 屬性中指定的作時使用的數據同步選項。 此屬性是 write only。

Description
Planned

該作將等待只讀副本中的數據與其源伺服器完全同步,然後再啟動作。

Forced

該作不會等待只讀副本中的數據與其源伺服器同步,然後再啟動作。

Replica

伺服器的復本屬性。

名稱 類型 Description
capacity

integer (int32)

伺服器允許的最大只讀複本數。

promoteMode

ReadReplicaPromoteMode

要應用於唯讀複本的作類型。 此屬性是 write only。 Standalone 意味著只讀副本將被提升為獨立伺服器,並將成為完全獨立於複製集的實體。 切換意味著唯讀副本將與主伺服器一起扮演角色。

promoteOption

ReadReplicaPromoteOption

處理 promoteMode 屬性中指定的作時使用的數據同步選項。 此屬性是 write only。

replicationState

ReplicationState

指示只讀複本的複製狀態。 僅當目標伺服器是唯讀副本時,才會返回此屬性。 可能的值包括 Active、Broken、Catchup、Provisioning、Reconfiguring 和 Updating

role

ReplicationRole

伺服器在複製集中的角色。

ReplicationRole

伺服器在複製集中的角色。

Description
None

未指派複寫角色;伺服器獨立運作。

Primary

作為複製到一或多個複本的來源伺服器。

AsyncReplica

從相同區域內的主要伺服器以非同步方式接收資料。

GeoAsyncReplica

從不同區域的主要伺服器以非同步方式接收資料,以實現地理備援。

ReplicationState

指示只讀複本的複製狀態。 僅當目標伺服器是唯讀副本時,才會返回此屬性。 可能的值包括 Active、Broken、Catchup、Provisioning、Reconfiguring 和 Updating

Description
Active

僅供讀取複本已完全同步,並主動從主要伺服器複寫資料。

Catchup

僅供讀取複本位於主要伺服器後面,目前正在趕上擱置的變更。

Provisioning

正在建立僅供讀取複本,並正在初始化中。

Updating

僅供讀取複本正在進行一些變更,可能會變更將其升級至主要伺服器的運算大小。

Broken

複製失敗或中斷。

Reconfiguring

僅供讀取複本正在重新設定中,可能是因為來源或設定的變更。

ServerForPatch

表示要更新的伺服器。

名稱 類型 Description
identity

UserAssignedIdentity

描述應用程式的身分識別。

properties.administratorLogin

string

指定為分配給 PostgreSQL 實例的第一個基於密碼的管理員的登錄名。 首次在伺服器上啟用基於密碼的身份驗證時,必須指定此參數。 一旦設置為給定值,則在伺服器的其餘生命週期內無法更改。 如果在啟用了基於密碼的身份驗證的伺服器上禁用基於密碼的身份驗證,則不會刪除此基於密碼的角色。

properties.administratorLoginPassword

string (password)

分配給管理員登錄名的密碼。 只要啟用了密碼身份驗證,就可以隨時更改此密碼。

properties.authConfig

AuthConfigForPatch

伺服器的身份驗證配置屬性。

properties.availabilityZone

string

伺服器的可用性區域。

properties.backup

BackupForPatch

伺服器的備份屬性。

properties.cluster

Cluster

伺服器的叢集屬性。

properties.createMode

CreateModeForPatch

現有伺服器的更新模式。

properties.dataEncryption

DataEncryption

伺服器的數據加密屬性。

properties.highAvailability

HighAvailabilityForPatch

伺服器的高可用性屬性。

properties.maintenanceWindow

MaintenanceWindowForPatch

伺服器的維護時段屬性。

properties.network

Network

伺服器的網路屬性。 僅當您希望將伺服器集成到客戶提供的虛擬網路中時,才需要。

properties.replica

Replica

伺服器的唯讀副本屬性。 僅在您想要升級伺服器時才需要。

properties.replicationRole

ReplicationRole

伺服器在複製集中的角色。

properties.storage

Storage

伺服器的儲存屬性。

properties.version

PostgresMajorVersion

PostgreSQL 資料庫引擎的主要版本。

sku

SkuForPatch

伺服器的計算層和大小。

tags

object

索引鍵/值組形式的應用程式特有中繼資料。

ServerPublicNetworkAccessState

指示是否啟用公共網路訪問。 這僅適用於未整合至部署伺服器時由客戶擁有和提供的虛擬網路的伺服器。

Description
Enabled

已啟用公用網路存取。 這允許從公共網際網路存取伺服器,前提是允許來自連接用戶端的傳入流量的必要防火牆規則已到位。 這與使用專用端點連線到此伺服器相容。

Disabled

公用網路存取已停用。 這意味著無法從公共網際網路存取伺服器,而只能透過專用端點存取伺服器。

SkuForPatch

計算伺服器的資訊。

名稱 類型 Description
name

string

名稱是分配給伺服器的給定計算大小。

tier

SkuTier

分配給伺服器的計算層。

SkuTier

分配給伺服器的計算層。

Description
Burstable

符合成本效益的層,適用於不頻繁的 CPU 使用量,非常適合效能需求較低的開發和測試工作負載。

GeneralPurpose

為大多數工作負載平衡運算和記憶體,提供可擴展的效能和 I/O 輸送量。

MemoryOptimized

高記憶體與核心比率,適用於需要快速記憶體處理和高並發的嚴苛工作負載。

Storage

伺服器的儲存屬性。

名稱 類型 Description
autoGrow

StorageAutoGrow

當可用空間接近零且條件允許自動增加存儲大小時,標誌以啟用或禁用伺服器存儲大小的自動增長。

iops

integer (int32)

存儲支援的最大 IOPS。 當存儲類型為 PremiumV2_LRS 或 UltraSSD_LRS 時是必需的。

storageSizeGB

integer (int32)

分配給伺服器的儲存大小。

throughput

integer (int32)

存儲支援的最大輸送量。 當存儲類型為 PremiumV2_LRS 或 UltraSSD_LRS 時是必需的。

tier

AzureManagedDiskPerformanceTier

伺服器的存儲層。

type

StorageType

分配給伺服器的存儲類型。 允許的值為 Premium_LRS、PremiumV2_LRS 或 UltraSSD_LRS。 如果未指定,則預設為 Premium_LRS。

StorageAutoGrow

當可用空間接近零且條件允許自動增加存儲大小時,標誌以啟用或禁用伺服器存儲大小的自動增長。

Description
Enabled

當可用空間接近零且條件允許自動增加儲存體大小時,伺服器應該會自動增加儲存體大小。

Disabled

當可用空間接近零時,伺服器不應自動增加儲存體大小。

StorageType

分配給伺服器的存儲類型。 允許的值為 Premium_LRS、PremiumV2_LRS 或 UltraSSD_LRS。 如果未指定,則預設為 Premium_LRS。

Description
Premium_LRS

標準固態磁碟 (SSD) 支援的儲存設備,為一般用途工作負載提供一致的效能。

PremiumV2_LRS

下一代固態硬碟 (SSD) 儲存設備具有更高的可擴展性和效能,適用於要求苛刻的企業工作負載。

UltraSSD_LRS

高階固態硬碟 (SSD) 儲存設備,專為極端 IOPS 和延遲敏感型應用程式而設計。

UserAssignedIdentity

與伺服器關聯的標識。

名稱 類型 Description
principalId

string

與使用者分配的託管標識關聯的服務主體的對象的標識碼。

tenantId

string

伺服器租戶的標識碼。

type

IdentityType

與伺服器關聯的標識類型。

userAssignedIdentities

<string,  UserIdentity>

使用者分配的託管標識的映射。

UserIdentity

與伺服器關聯的使用者分配的託管標識。

名稱 類型 Description
clientId

string

與使用者分配的託管標識關聯的服務主體的用戶端的標識碼。

principalId

string

與使用者分配的託管標識關聯的服務主體的對象的標識碼。