你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Servers - Update

更新现有服务器。 请求正文可以包含常规服务器定义中存在的一个或多个属性。

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

URI 参数

名称 必需 类型 说明
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)

目标订阅的 ID。 该值必须是 UUID。

api-version
query True

string

minLength: 1

要用于此操作的 API 版本。

请求正文

名称 类型 说明
identity

UserAssignedIdentity

描述应用程序的标识。

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

键值对形式的应用程序特定元数据。

响应

名称 类型 说明
202 Accepted

已接受资源作。

标头

  • Azure-AsyncOperation: string
  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

意外错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
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

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

示例响应

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

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

示例响应

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

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

示例响应

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

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

示例响应

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

定义

名称 说明
AuthConfigForPatch

服务器的身份验证配置属性。

AzureManagedDiskPerformanceTier

服务器的存储层。

BackupForPatch

服务器的备份属性。

Cluster

服务器的群集属性。

CreateModeForPatch

现有服务器的更新模式。

DataEncryption

服务器的数据加密属性。

DataEncryptionType

服务器使用的数据加密类型。

EncryptionKeyStatus

配置了基于客户管理密钥的数据加密的服务器使用的密钥状态,用于加密与服务器关联的主存储。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

GeographicallyRedundantBackup

指示是否将 服务器配置为创建地理位置冗余的备份。

HighAvailabilityForPatch

服务器的高可用性属性。

HighAvailabilityState

当高可用性设置为 SameZone 或 ZoneRedundant 时创建的备用服务器的可能状态。

IdentityType

与服务器关联的标识类型。

MaintenanceWindowForPatch

服务器的维护时段属性。

MicrosoftEntraAuth

指示服务器是否支持 Microsoft Entra 身份验证。

Network

服务器的网络属性。

PasswordBasedAuth

指示服务器是否支持基于密码的身份验证。

PostgresMajorVersion

PostgreSQL 数据库引擎的主要版本。

PostgreSqlFlexibleServerHighAvailabilityMode

此计算支持的高可用性模式。

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

服务器的身份验证配置属性。

名称 类型 说明
activeDirectoryAuth

MicrosoftEntraAuth

指示服务器是否支持 Microsoft Entra 身份验证。

passwordAuth

PasswordBasedAuth

指示服务器是否支持基于密码的身份验证。

tenantId

string

委托资源的租户的标识符。

AzureManagedDiskPerformanceTier

服务器的存储层。

说明
P1
P2
P3
P4
P6
P10
P15
P20
P30
P40
P50
P60
P70
P80

BackupForPatch

服务器的备份属性。

名称 类型 说明
backupRetentionDays

integer (int32)

服务器的备份保留日。

earliestRestoreDate

string (date-time)

服务器的最早还原点时间(ISO8601格式)。

geoRedundantBackup

GeographicallyRedundantBackup

指示是否将 服务器配置为创建地理位置冗余的备份。

Cluster

服务器的群集属性。

名称 类型 默认值 说明
clusterSize

integer (int32)

0

分配给 Elastic Cluster 的节点数。

defaultDatabaseName

string

弹性群集的默认数据库名称。

CreateModeForPatch

现有服务器的更新模式。

说明
Default
Update

DataEncryption

服务器的数据加密属性。

名称 类型 说明
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

服务器使用的数据加密类型。

说明
SystemManaged
AzureKeyVault

EncryptionKeyStatus

配置了基于客户管理密钥的数据加密的服务器使用的密钥状态,用于加密与服务器关联的主存储。

说明
Valid
Invalid

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

附加信息。

type

string

附加信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

GeographicallyRedundantBackup

指示是否将 服务器配置为创建地理位置冗余的备份。

说明
Enabled
Disabled

HighAvailabilityForPatch

服务器的高可用性属性。

名称 类型 说明
mode

PostgreSqlFlexibleServerHighAvailabilityMode

服务器的高可用性模式。

standbyAvailabilityZone

string

与高可用性设置为 SameZone 或 ZoneRedundant 时创建的备用服务器关联的可用区。

state

HighAvailabilityState

当高可用性设置为 SameZone 或 ZoneRedundant 时创建的备用服务器的可能状态。

HighAvailabilityState

当高可用性设置为 SameZone 或 ZoneRedundant 时创建的备用服务器的可能状态。

说明
NotEnabled
CreatingStandby
ReplicatingData
FailingOver
Healthy
RemovingStandby

IdentityType

与服务器关联的标识类型。

说明
None
UserAssigned
SystemAssigned
SystemAssigned,UserAssigned

MaintenanceWindowForPatch

服务器的维护时段属性。

名称 类型 说明
customWindow

string

指示自定义窗口是启用还是禁用。

dayOfWeek

integer (int32)

用于维护时段的星期几。

startHour

integer (int32)

用于维护时段的开始时间。

startMinute

integer (int32)

用于维护时段的开始分钟。

MicrosoftEntraAuth

指示服务器是否支持 Microsoft Entra 身份验证。

说明
Enabled
Disabled

Network

服务器的网络属性。

名称 类型 说明
delegatedSubnetResourceId

string (arm-id)

委托子网的资源标识符。 在创建新服务器期间是必需的,以防您希望将服务器集成到您自己的虚拟网络中。 对于更新作,如果要更改为私有 DNS 区域分配的值,则只需提供此属性。

privateDnsZoneArmResourceId

string (arm-id)

私有 DNS 区域的标识符。 在创建新服务器期间是必需的,以防您希望将服务器集成到您自己的虚拟网络中。 对于更新作,如果要更改为私有 DNS 区域分配的值,则只需提供此属性。

publicNetworkAccess

ServerPublicNetworkAccessState

指示是否启用公共网络访问。 仅适用于未集成到部署服务器时由客户拥有和提供的虚拟网络的服务器。

PasswordBasedAuth

指示服务器是否支持基于密码的身份验证。

说明
Enabled
Disabled

PostgresMajorVersion

PostgreSQL 数据库引擎的主要版本。

说明
18
17
16
15
14
13
12
11

PostgreSqlFlexibleServerHighAvailabilityMode

此计算支持的高可用性模式。

说明
Disabled
ZoneRedundant
SameZone

ReadReplicaPromoteMode

要应用于只读副本的作类型。 此属性是 write only。 Standalone 意味着只读副本将被提升为独立服务器,并将成为完全独立于复制集的实体。 切换意味着只读副本将与主服务器一起扮演角色。

说明
Standalone

只读副本将成为独立服务器。

Switchover

只读副本将与主服务器交换角色。

ReadReplicaPromoteOption

处理 promoteMode 属性中指定的作时使用的数据同步选项。 此属性是 write only。

说明
Planned

该作将等待只读副本中的数据与其源服务器完全同步,然后再启动作。

Forced

该作不会等待只读副本中的数据与其源服务器同步,然后再启动作。

Replica

服务器的副本属性。

名称 类型 说明
capacity

integer (int32)

服务器允许的最大只读副本数。

promoteMode

ReadReplicaPromoteMode

要应用于只读副本的作类型。 此属性是 write only。 Standalone 意味着只读副本将被提升为独立服务器,并将成为完全独立于复制集的实体。 切换意味着只读副本将与主服务器一起扮演角色。

promoteOption

ReadReplicaPromoteOption

处理 promoteMode 属性中指定的作时使用的数据同步选项。 此属性是 write only。

replicationState

ReplicationState

指示只读副本的复制状态。 仅当目标服务器是只读副本时,才会返回此属性。 可能的值包括 Active、Broken、Catchup、Provisioning、Reconfiguring 和 Updating

role

ReplicationRole

服务器在复制集中的角色。

ReplicationRole

服务器在复制集中的角色。

说明
None
Primary
AsyncReplica
GeoAsyncReplica

ReplicationState

指示只读副本的复制状态。 仅当目标服务器是只读副本时,才会返回此属性。 可能的值包括 Active、Broken、Catchup、Provisioning、Reconfiguring 和 Updating

说明
Active

读副本服务器完全同步,并主动复制主服务器的数据。

Catchup

读副本服务器位于主服务器后面,目前正在处理待处理的变更。

Provisioning

读取副本服务器正在创建中,正在进行初始化。

Updating

读副本服务器正在经历一些变化,可能会调整计算量,升级为主服务器。

Broken

复制失败或中断。

Reconfiguring

读取副本服务器正在重新配置,可能是源代码或设置的更改。

ServerForPatch

表示要更新的服务器。

名称 类型 说明
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

指示是否启用公共网络访问。

说明
Enabled
Disabled

SkuForPatch

计算服务器的信息。

名称 类型 说明
name

string

名称是分配给服务器的给定计算大小。

tier

SkuTier

分配给服务器的计算层。

SkuTier

分配给服务器的计算层。

说明
Burstable
GeneralPurpose
MemoryOptimized

Storage

服务器的存储属性。

名称 类型 说明
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

当可用空间接近零且条件允许自动增加存储大小时,标志以启用或禁用服务器存储大小的自动增长。

说明
Enabled
Disabled

StorageType

分配给服务器的存储类型。 允许的值为 Premium_LRS、PremiumV2_LRS 或 UltraSSD_LRS。 如果未指定,则默认为 Premium_LRS。

说明
Premium_LRS
PremiumV2_LRS
UltraSSD_LRS

UserAssignedIdentity

与服务器关联的标识。

名称 类型 说明
principalId

string

与用户分配的托管标识关联的服务主体的对象的标识符。

tenantId

string

服务器租户的标识符。

type

IdentityType

与服务器关联的标识类型。

userAssignedIdentities

<string,  UserIdentity>

用户分配的托管标识的映射。

UserIdentity

与服务器关联的用户分配的托管标识。

名称 类型 说明
clientId

string

与用户分配的托管标识关联的服务主体的客户端的标识符。

principalId

string

与用户分配的托管标识关联的服务主体的对象的标识符。