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

Servers - Update

参考

服务:: PostgreSQL

API 版本:: 2024-11-01-preview

更新现有服务器。请求正文可以包含普通服务器定义中存在的一对多属性。

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	资源组的名称。名称不区分大小写。
serverName	path	True	string	服务器的名称。正则表达式模式: `^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*`
subscriptionId	path	True	string uuid	目标订阅的 ID。该值必须是 UUID。
api-version	query	True	string	用于此操作的 API 版本。

请求正文

名称	类型	说明
parameters	ServerForUpdate	更新服务器所需的参数。

响应

名称	类型	说明
200 OK	Server	还行
202 Accepted		接受标头 Location: string
Other Status Codes	ErrorResponse	描述操作失败的原因的错误响应。

名称

类型

说明

200 OK

Server

还行

202 Accepted

接受

标头

Location: string

Other Status Codes

ErrorResponse

描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Promote a replica server as a Standalone server as forced, i.e. it will promote a replica server immediately without waiting for primary and replica to be in sync.

Promote a replica server as a Standalone server as planned, i.e. it will wait for replication to complete.

ServerUpdate

ServerUpdateWithAadAuthEnabled

ServerUpdateWithCustomerMaintenanceWindow

ServerUpdateWithDataEncryptionEnabled

ServerUpdateWithMajorVersionUpgrade

SwitchOver a replica server as forced, i.e. it will replica as Primary and original primary as replica immediately without waiting for primary and replica to be in sync.

SwitchOver a replica server as planned, i.e. it will wait for replication to complete before promoting replica as Primary and original primary as replica.

Promote a replica server as a Standalone server as forced, i.e. it will promote a replica server immediately without waiting for primary and replica to be in sync.

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testResourceGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica?api-version=2024-11-01-preview

{
  "properties": {
    "replica": {
      "promoteMode": "standalone",
      "promoteOption": "forced"
    }
  }
}

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python promote_replica_as_forced_standalone_server.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PostgreSQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.begin_update(
        resource_group_name="testResourceGroup",
        server_name="pgtestsvc4-replica",
        parameters={"properties": {"replica": {"promoteMode": "standalone", "promoteOption": "forced"}}},
    ).result()
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-11-01-preview/examples/PromoteReplicaAsForcedStandaloneServer.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "sku": {
    "name": "Standard_D8s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "pgtestsvc4-replica.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "storage": {
      "storageSizeGB": 1024,
      "autoGrow": "Enabled",
      "tier": "P30",
      "iops": 5000
    },
    "backup": {
      "backupRetentionDays": 20,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00"
    },
    "network": {
      "publicNetworkAccess": "Disabled",
      "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet",
      "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "2"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    },
    "replica": {
      "role": "None",
      "capacity": 0
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica",
  "name": "pgtestsvc4-replica",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

状态代码:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview

Promote a replica server as a Standalone server as planned, i.e. it will wait for replication to complete.

示例请求

HTTP
Python

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testResourceGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica?api-version=2024-11-01-preview

{
  "properties": {
    "replica": {
      "promoteMode": "standalone",
      "promoteOption": "planned"
    }
  }
}

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python promote_replica_as_planned_standalone_server.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PostgreSQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.begin_update(
        resource_group_name="testResourceGroup",
        server_name="pgtestsvc4-replica",
        parameters={"properties": {"replica": {"promoteMode": "standalone", "promoteOption": "planned"}}},
    ).result()
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-11-01-preview/examples/PromoteReplicaAsPlannedStandaloneServer.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "sku": {
    "name": "Standard_D8s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "pgtestsvc4-replica.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "storage": {
      "storageSizeGB": 1024,
      "autoGrow": "Enabled",
      "tier": "P30",
      "iops": 5000
    },
    "backup": {
      "backupRetentionDays": 20,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00"
    },
    "network": {
      "publicNetworkAccess": "Disabled",
      "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet",
      "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "2"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    },
    "replica": {
      "role": "None",
      "capacity": 0
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica",
  "name": "pgtestsvc4-replica",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

状态代码:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview

ServerUpdate

示例请求

HTTP
Python

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4?api-version=2024-11-01-preview

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python server_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PostgreSQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.begin_update(
        resource_group_name="TestGroup",
        server_name="pgtestsvc4",
        parameters={
            "properties": {
                "administratorLoginPassword": "newpassword",
                "backup": {"backupRetentionDays": 20},
                "createMode": "Update",
                "storage": {"autoGrow": "Enabled", "storageSizeGB": 1024, "tier": "P30"},
            },
            "sku": {"name": "Standard_D8s_v3", "tier": "GeneralPurpose"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-11-01-preview/examples/ServerUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "sku": {
    "name": "Standard_D8s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "storage": {
      "storageSizeGB": 1024,
      "autoGrow": "Enabled",
      "tier": "P30",
      "iops": 5000
    },
    "backup": {
      "backupRetentionDays": 20,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00"
    },
    "network": {
      "publicNetworkAccess": "Disabled",
      "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet",
      "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "2"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4",
  "name": "pgtestsvc4",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

状态代码:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview

ServerUpdateWithAadAuthEnabled

示例请求

HTTP
Python

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4?api-version=2024-11-01-preview

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python server_update_with_aad_auth_enabled.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PostgreSQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.begin_update(
        resource_group_name="TestGroup",
        server_name="pgtestsvc4",
        parameters={
            "properties": {
                "administratorLoginPassword": "newpassword",
                "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"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-11-01-preview/examples/ServerUpdateWithAadAuthEnabled.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "sku": {
    "name": "Standard_D8s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "authConfig": {
      "activeDirectoryAuth": "Enabled",
      "passwordAuth": "Enabled",
      "tenantId": "tttttt-tttt-tttt-tttt-tttttttttttt"
    },
    "storage": {
      "storageSizeGB": 1024,
      "autoGrow": "Disabled",
      "tier": "P30",
      "iops": 5000
    },
    "backup": {
      "backupRetentionDays": 20,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00"
    },
    "network": {
      "publicNetworkAccess": "Disabled",
      "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet",
      "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "2"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4",
  "name": "pgtestsvc4",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

状态代码:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview

ServerUpdateWithCustomerMaintenanceWindow

示例请求

HTTP
Python

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4?api-version=2024-11-01-preview

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python server_update_with_customer_maintenance_window.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PostgreSQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.begin_update(
        resource_group_name="testrg",
        server_name="pgtestsvc4",
        parameters={
            "properties": {
                "createMode": "Update",
                "maintenanceWindow": {"customWindow": "Enabled", "dayOfWeek": 0, "startHour": 8, "startMinute": 0},
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-11-01-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "sku": {
    "name": "Standard_D4s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "storage": {
      "storageSizeGB": 512,
      "autoGrow": "Disabled",
      "tier": "P20",
      "iops": 2300
    },
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "backup": {
      "backupRetentionDays": 7,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00"
    },
    "network": {
      "publicNetworkAccess": "Disabled",
      "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet",
      "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "2"
    },
    "maintenanceWindow": {
      "customWindow": "Enabled",
      "dayOfWeek": 0,
      "startHour": 8,
      "startMinute": 0
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4",
  "name": "pgtestsvc4",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

状态代码:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview

ServerUpdateWithDataEncryptionEnabled

示例请求

HTTP
Python

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4?api-version=2024-11-01-preview

{
  "sku": {
    "tier": "GeneralPurpose",
    "name": "Standard_D8s_v3"
  },
  "identity": {
    "userAssignedIdentities": {
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": {},
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity": {}
    },
    "type": "UserAssigned"
  },
  "properties": {
    "administratorLoginPassword": "newpassword",
    "createMode": "Update",
    "dataEncryption": {
      "type": "AzureKeyVault",
      "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787",
      "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity",
      "geoBackupKeyURI": "https://test-geo-kv.vault.azure.net/keys/test-key1/66f57315bab34b0189daa113fbc78787",
      "geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity"
    },
    "backup": {
      "backupRetentionDays": 20
    }
  }
}

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python server_update_with_data_encryption_enabled.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PostgreSQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.begin_update(
        resource_group_name="TestGroup",
        server_name="pgtestsvc4",
        parameters={
            "identity": {
                "type": "UserAssigned",
                "userAssignedIdentities": {
                    "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity": {},
                    "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": {},
                },
            },
            "properties": {
                "administratorLoginPassword": "newpassword",
                "backup": {"backupRetentionDays": 20},
                "createMode": "Update",
                "dataEncryption": {
                    "geoBackupKeyURI": "https://test-geo-kv.vault.azure.net/keys/test-key1/66f57315bab34b0189daa113fbc78787",
                    "geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity",
                    "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787",
                    "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity",
                    "type": "AzureKeyVault",
                },
            },
            "sku": {"name": "Standard_D8s_v3", "tier": "GeneralPurpose"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-11-01-preview/examples/ServerUpdateWithDataEncryptionEnabled.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "sku": {
    "name": "Standard_D8s_v3",
    "tier": "GeneralPurpose"
  },
  "identity": {
    "userAssignedIdentities": {
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": {
        "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9",
        "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
      },
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity-1": {
        "principalId": "90008082-e024-4cc3-8fcf-63bcdb9cf6b6",
        "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
      },
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity": {
        "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9",
        "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
      }
    },
    "type": "UserAssigned"
  },
  "properties": {
    "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "dataEncryption": {
      "type": "AzureKeyVault",
      "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787",
      "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity",
      "geoBackupKeyURI": "https://test-geo-kv.vault.azure.net/keys/test-key1/66f57315bab34b0189daa113fbc78787",
      "geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity",
      "primaryEncryptionKeyStatus": "Valid",
      "geoBackupEncryptionKeyStatus": "Valid"
    },
    "storage": {
      "storageSizeGB": 1024,
      "autoGrow": "Disabled",
      "tier": "P30",
      "iops": 5000
    },
    "backup": {
      "backupRetentionDays": 20,
      "geoRedundantBackup": "Enabled",
      "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00"
    },
    "network": {
      "publicNetworkAccess": "Disabled",
      "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet",
      "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "2"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4",
  "name": "pgtestsvc4",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

状态代码:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview

ServerUpdateWithMajorVersionUpgrade

示例请求

HTTP
Python

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4?api-version=2024-11-01-preview

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python server_update_with_major_version_upgrade.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PostgreSQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.begin_update(
        resource_group_name="testrg",
        server_name="pgtestsvc4",
        parameters={"properties": {"createMode": "Update", "version": "14"}},
    ).result()
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-11-01-preview/examples/ServerUpdateWithMajorVersionUpgrade.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "sku": {
    "name": "Standard_D4s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com",
    "version": "14",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "storage": {
      "storageSizeGB": 512,
      "autoGrow": "Enabled",
      "tier": "P20",
      "iops": 2300
    },
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "backup": {
      "backupRetentionDays": 7,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00"
    },
    "network": {
      "publicNetworkAccess": "Disabled",
      "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet",
      "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "2"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4",
  "name": "pgtestsvc4",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

状态代码:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview

SwitchOver a replica server as forced, i.e. it will replica as Primary and original primary as replica immediately without waiting for primary and replica to be in sync.

示例请求

HTTP
Python

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testResourceGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica?api-version=2024-11-01-preview

{
  "properties": {
    "replica": {
      "promoteMode": "switchover",
      "promoteOption": "forced"
    }
  }
}

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python promote_replica_as_forced_switchover.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PostgreSQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.begin_update(
        resource_group_name="testResourceGroup",
        server_name="pgtestsvc4-replica",
        parameters={"properties": {"replica": {"promoteMode": "switchover", "promoteOption": "forced"}}},
    ).result()
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-11-01-preview/examples/PromoteReplicaAsForcedSwitchover.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "sku": {
    "name": "Standard_D8s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "pgtestsvc4-replica.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "storage": {
      "storageSizeGB": 1024,
      "autoGrow": "Enabled",
      "tier": "P30",
      "iops": 5000
    },
    "backup": {
      "backupRetentionDays": 20,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00"
    },
    "network": {
      "publicNetworkAccess": "Disabled",
      "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet",
      "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "2"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    },
    "replica": {
      "role": "Primary",
      "capacity": 5
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica",
  "name": "pgtestsvc4-replica",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

状态代码:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview

SwitchOver a replica server as planned, i.e. it will wait for replication to complete before promoting replica as Primary and original primary as replica.

示例请求

HTTP
Python

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testResourceGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica?api-version=2024-11-01-preview

{
  "properties": {
    "replica": {
      "promoteMode": "switchover",
      "promoteOption": "planned"
    }
  }
}

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python promote_replica_as_planned_switchover.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PostgreSQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.begin_update(
        resource_group_name="testResourceGroup",
        server_name="pgtestsvc4-replica",
        parameters={"properties": {"replica": {"promoteMode": "switchover", "promoteOption": "planned"}}},
    ).result()
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-11-01-preview/examples/PromoteReplicaAsPlannedSwitchover.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "sku": {
    "name": "Standard_D8s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "pgtestsvc4-replica.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "storage": {
      "storageSizeGB": 1024,
      "autoGrow": "Enabled",
      "tier": "P30",
      "iops": 5000
    },
    "backup": {
      "backupRetentionDays": 20,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00"
    },
    "network": {
      "publicNetworkAccess": "Disabled",
      "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet",
      "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "2"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    },
    "replica": {
      "role": "Primary",
      "capacity": 5
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica",
  "name": "pgtestsvc4-replica",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

状态代码:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview

定义

名称	说明
activeDirectoryAuthEnum	如果已启用，则会启用 Azure Active Directory 身份验证。
ArmServerKeyType	用于描述其是否为系统托管与 Azure Key Vault 的数据加密类型。
AuthConfig	服务器的 AuthConfig 属性。
AzureManagedDiskPerformanceTiers	IOPS 的存储层的名称。
Backup	服务器的备份属性。
Cluster	服务器的群集属性。
createdByType	创建资源的标识的类型。
CreateMode	创建新的 PostgreSQL 服务器的模式。
CreateModeForUpdate	更新新 PostgreSQL 服务器的模式。
DataEncryption	服务器的数据加密属性。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
GeoRedundantBackupEnum	一个值，该值指示是否在服务器上启用 Geo-Redundant 备份。
HighAvailability	服务器的高可用性属性。
HighAvailabilityMode	服务器的 HA 模式。
IdentityType	与此资源关联的标识类型
keyStatusEnum	已启用数据加密的服务器的主加密密钥状态。
MaintenanceWindow	服务器的维护时段属性。
Network	服务器的网络属性。仅当希望服务器成为专用访问服务器时，才需要传递此网络属性。
passwordAuthEnum	如果已启用，则启用密码身份验证。
PrivateEndpoint	专用终结点资源。
PrivateEndpointConnection	与指定资源关联的专用终结点连接列表。
PrivateEndpointConnectionProvisioningState	专用终结点连接资源的预配状态。
PrivateEndpointServiceConnectionStatus	指示连接是否已被服务的所有者批准/拒绝/删除。
PrivateLinkServiceConnectionState	有关服务使用者与提供程序之间的连接状态的信息集合。
ReadReplicaPromoteMode	设置副本服务器的提升模式。这是一个仅写入属性。
Replica	服务器的副本属性。仅当想要升级服务器时，才需要传递这些副本属性。
ReplicationPromoteOption	设置副本服务器的提升选项。这是一个仅写入属性。
ReplicationRole	服务器的复制角色
ReplicationState	获取副本服务器的复制状态。此属性仅针对副本 API 调用返回。支持的值包括 Active、Catchup、Provisioning、Updateing、Broken、Reconfiguring
Server	表示服务器。
ServerForUpdate	更新服务器所需的参数。
ServerHAState	用户可见的 HA 服务器的状态。
ServerPublicNetworkAccessState	已启用或未启用公用网络访问
ServerState	用户可见的服务器的状态。
ServerVersion	PostgreSQL 服务器版本。
Sku	服务器的 SKU（定价层）。
SkuTier	特定 SKU 的层，例如可突发。
Storage	服务器的存储属性。
StorageAutoGrow	为灵活服务器启用/禁用存储自动增长的标志。
StorageType	服务器的存储类型。允许的值是Premium_LRS、PremiumV2_LRS和UltraSSD_LRS。如果未指定，则默认值为Premium_LRS
systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
UserAssignedIdentity	描述应用程序的标识。
UserIdentity	描述与应用程序关联的单个用户分配标识。

activeDirectoryAuthEnum

如果已启用，则会启用 Azure Active Directory 身份验证。

名称	类型	说明
Disabled	string
Enabled	string

ArmServerKeyType

用于描述其是否为系统托管与 Azure Key Vault 的数据加密类型。

名称	类型	说明
AzureKeyVault	string
SystemManaged	string

AuthConfig

服务器的 AuthConfig 属性。

名称	类型	默认值	说明
activeDirectoryAuth	activeDirectoryAuthEnum		如果已启用，则会启用 Azure Active Directory 身份验证。
passwordAuth	passwordAuthEnum	Enabled	如果已启用，则启用密码身份验证。
tenantId	string		服务器的租户 ID。

AzureManagedDiskPerformanceTiers

IOPS 的存储层的名称。

名称	类型	说明
P1	string
P10	string
P15	string
P2	string
P20	string
P3	string
P30	string
P4	string
P40	string
P50	string
P6	string
P60	string
P70	string
P80	string

Backup

服务器的备份属性。

名称	类型	默认值	说明
backupRetentionDays	integer	7	服务器的备份保留日。
earliestRestoreDate	string		服务器最早的还原点时间（ISO8601格式）。
geoRedundantBackup	GeoRedundantBackupEnum	Disabled	一个值，该值指示是否在服务器上启用 Geo-Redundant 备份。

Cluster

服务器的群集属性。

名称	类型	默认值	说明
clusterSize	integer	0	群集的节点计数。

createdByType

创建资源的标识的类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

创建新的 PostgreSQL 服务器的模式。

名称	类型	说明
Create	string
Default	string
GeoRestore	string
PointInTimeRestore	string
Replica	string
ReviveDropped	string
Update	string

CreateModeForUpdate

更新新 PostgreSQL 服务器的模式。

名称	类型	说明
Default	string
Update	string

DataEncryption

服务器的数据加密属性。

名称	类型	说明
geoBackupEncryptionKeyStatus	keyStatusEnum	已启用数据加密服务器的异地备份加密密钥状态。
geoBackupKeyURI	string	keyvault 中密钥的 URI，用于对服务器进行异地备份的数据加密。
geoBackupUserAssignedIdentityId	string	要用于服务器异地备份的数据加密的用户分配标识的资源 ID。
primaryEncryptionKeyStatus	keyStatusEnum	已启用数据加密的服务器的主加密密钥状态。
primaryKeyURI	string	keyvault 中密钥的 URI，用于主服务器的数据加密。
primaryUserAssignedIdentityId	string	要用于主服务器数据加密的用户分配标识的资源 ID。
type	ArmServerKeyType	用于描述其是否为系统托管与 Azure Key Vault 的数据加密类型。

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

GeoRedundantBackupEnum

一个值，该值指示是否在服务器上启用 Geo-Redundant 备份。

名称	类型	说明
Disabled	string
Enabled	string

HighAvailability

服务器的高可用性属性。

名称	类型	默认值	说明
mode	HighAvailabilityMode	Disabled	服务器的 HA 模式。
standbyAvailabilityZone	string		备用服务器的可用性区域信息。
state	ServerHAState		用户可见的 HA 服务器的状态。

HighAvailabilityMode

服务器的 HA 模式。

名称	类型	说明
Disabled	string
SameZone	string
ZoneRedundant	string

IdentityType

与此资源关联的标识类型

名称	类型	说明
None	string
SystemAssigned	string
UserAssigned	string

keyStatusEnum

已启用数据加密的服务器的主加密密钥状态。

名称	类型	说明
Invalid	string
Valid	string

MaintenanceWindow

服务器的维护时段属性。

名称	类型	默认值	说明
customWindow	string	Disabled	指示是启用还是禁用自定义窗口
dayOfWeek	integer	0	维护时段的星期几
startHour	integer	0	维护时段的开始时间
startMinute	integer	0	维护时段的开始时间

Network

服务器的网络属性。仅当希望服务器成为专用访问服务器时，才需要传递此网络属性。

名称	类型	说明
delegatedSubnetResourceId	string	委派的子网 arm 资源 ID。在创建过程中需要传递此项，以防我们希望服务器注入 VNET，即专用访问服务器。在更新期间，仅当我们想要更新专用 DNS 区域的值时，才传递此值。
privateDnsZoneArmResourceId	string	专用 dns 区域 arm 资源 ID。在创建过程中需要传递此项，以防我们希望服务器注入 VNET，即专用访问服务器。在更新期间，仅当我们想要更新专用 DNS 区域的值时，才传递此值。
publicNetworkAccess	ServerPublicNetworkAccessState	已启用或未启用公用网络访问

passwordAuthEnum

如果已启用，则启用密码身份验证。

名称	类型	说明
Disabled	string
Enabled	string

PrivateEndpoint

专用终结点资源。

名称	类型	说明
id	string	专用终结点的 ARM 标识符。

PrivateEndpointConnection

与指定资源关联的专用终结点连接列表。

名称	类型	说明
id	string	资源的完全限定资源 ID。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties.groupIds	string[]	专用终结点资源的组 ID。
properties.privateEndpoint	PrivateEndpoint	专用终结点资源。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	有关服务使用者与提供程序之间的连接状态的信息集合。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	专用终结点连接资源的预配状态。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

PrivateEndpointConnectionProvisioningState

专用终结点连接资源的预配状态。

名称	类型	说明
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

指示连接是否已被服务的所有者批准/拒绝/删除。

名称	类型	说明
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

有关服务使用者与提供程序之间的连接状态的信息集合。

名称	类型	说明
actionsRequired	string	一条消息，指示服务提供商上的更改是否需要对使用者进行任何更新。
description	string	批准/拒绝连接的原因。
status	PrivateEndpointServiceConnectionStatus	指示连接是否已被服务的所有者批准/拒绝/删除。

ReadReplicaPromoteMode

设置副本服务器的提升模式。这是一个仅写入属性。

名称	类型	说明
standalone	string
switchover	string

Replica

服务器的副本属性。仅当想要升级服务器时，才需要传递这些副本属性。

名称	类型	说明
capacity	integer	服务器允许的副本。
promoteMode	ReadReplicaPromoteMode	设置副本服务器的提升模式。这是一个仅写入属性。
promoteOption	ReplicationPromoteOption	设置副本服务器的提升选项。这是一个仅写入属性。
replicationState	ReplicationState	获取副本服务器的复制状态。此属性仅针对副本 API 调用返回。支持的值包括 Active、Catchup、Provisioning、Updateing、Broken、Reconfiguring
role	ReplicationRole	用于指示复制集中服务器的角色。

ReplicationPromoteOption

设置副本服务器的提升选项。这是一个仅写入属性。

名称	类型	说明
forced	string
planned	string

ReplicationRole

服务器的复制角色

名称	类型	说明
AsyncReplica	string
GeoAsyncReplica	string
None	string
Primary	string

ReplicationState

获取副本服务器的复制状态。此属性仅针对副本 API 调用返回。支持的值包括 Active、Catchup、Provisioning、Updateing、Broken、Reconfiguring

名称	类型	说明
Active	string
Broken	string
Catchup	string
Provisioning	string
Reconfiguring	string
Updating	string

Server

表示服务器。

名称	类型	说明
id	string	资源的完全限定资源 ID。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
identity	UserAssignedIdentity	描述应用程序的标识。
location	string	资源所在的地理位置
name	string	资源的名称
properties.administratorLogin	string	管理员的服务器登录名。只能在创建服务器时指定（并且是创建所必需的）。
properties.administratorLoginPassword	string	管理员登录密码（创建服务器时需要）。
properties.authConfig	AuthConfig	服务器的 AuthConfig 属性。
properties.availabilityZone	string	服务器的可用性区域信息。
properties.backup	Backup	服务器的备份属性。
properties.cluster	Cluster	服务器的群集属性。
properties.createMode	CreateMode	创建新的 PostgreSQL 服务器的模式。
properties.dataEncryption	DataEncryption	服务器的数据加密属性。
properties.fullyQualifiedDomainName	string	服务器的完全限定域名。
properties.highAvailability	HighAvailability	服务器的高可用性属性。
properties.maintenanceWindow	MaintenanceWindow	服务器的维护时段属性。
properties.minorVersion	string	服务器的次要版本。
properties.network	Network	服务器的网络属性。仅当希望服务器成为专用访问服务器时，才需要传递此网络属性。
properties.pointInTimeUTC	string	还原点创建时间（ISO8601格式），指定要从中还原的时间。当“createMode”为“PointInTimeRestore”或“GeoRestore”或“ReviveDropped”时，它是必需的。
properties.privateEndpointConnections	PrivateEndpointConnection[]	与指定资源关联的专用终结点连接列表。
properties.replica	Replica	服务器的副本属性。仅当想要升级服务器时，才需要传递这些副本属性。
properties.replicaCapacity	integer	服务器允许的副本。
properties.replicationRole	ReplicationRole	服务器的复制角色
properties.sourceServerResourceId	string	要从中还原的源服务器资源 ID。当“createMode”为“PointInTimeRestore”或“GeoRestore”或“Replica”或“ReviveDropped”时，它是必需的。此属性仅针对副本服务器返回
properties.state	ServerState	用户可见的服务器的状态。
properties.storage	Storage	服务器的存储属性。
properties.version	ServerVersion	PostgreSQL 服务器版本。
sku	Sku	服务器的 SKU（定价层）。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ServerForUpdate

更新服务器所需的参数。

名称	类型	说明
identity	UserAssignedIdentity	描述应用程序的标识。
properties.administratorLogin	string	管理员的服务器登录名。只能在服务器尝试切换到密码身份验证且没有默认管理员登录名时指定。
properties.administratorLoginPassword	string	管理员登录名的密码。
properties.authConfig	AuthConfig	服务器的 AuthConfig 属性。
properties.backup	Backup	服务器的备份属性。
properties.cluster	Cluster	服务器的群集属性。
properties.createMode	CreateModeForUpdate	更新新 PostgreSQL 服务器的模式。
properties.dataEncryption	DataEncryption	服务器的数据加密属性。
properties.highAvailability	HighAvailability	服务器的高可用性属性。
properties.maintenanceWindow	MaintenanceWindow	服务器的维护时段属性。
properties.network	Network	服务器的网络属性。仅当服务器是专用访问服务器时，才需要传递这些内容。
properties.replica	Replica	服务器的副本属性。仅当想要升级服务器时，才需要传递这些副本属性。
properties.replicationRole	ReplicationRole	服务器的复制角色
properties.storage	Storage	服务器的存储属性。
properties.version	ServerVersion	PostgreSQL 服务器版本。 MVU 目前不支持版本 16。
sku	Sku	服务器的 SKU（定价层）。
tags	object	键值对形式的特定于应用程序的元数据。

ServerHAState

用户可见的 HA 服务器的状态。

名称	类型	说明
CreatingStandby	string
FailingOver	string
Healthy	string
NotEnabled	string
RemovingStandby	string
ReplicatingData	string

ServerPublicNetworkAccessState

已启用或未启用公用网络访问

名称	类型	说明
Disabled	string
Enabled	string

ServerState

用户可见的服务器的状态。

名称	类型	说明
Disabled	string
Dropping	string
Ready	string
Starting	string
Stopped	string
Stopping	string
Updating	string

ServerVersion

PostgreSQL 服务器版本。

名称	类型	说明
11	string
12	string
13	string
14	string
15	string
16	string
17	string

Sku

服务器的 SKU（定价层）。

名称	类型	说明
name	string	SKU 的名称，通常为层 + 系列 + 核心，例如Standard_D4s_v3。
tier	SkuTier	特定 SKU 的层，例如可突发。

SkuTier

特定 SKU 的层，例如可突发。

名称	类型	说明
Burstable	string
GeneralPurpose	string
MemoryOptimized	string

Storage

服务器的存储属性。

名称	类型	说明
autoGrow	StorageAutoGrow	为灵活服务器启用/禁用存储自动增长的标志。
iops	integer	存储层 IOPS 数量。必须为存储类型PremiumV2_LRS和UltraSSD_LRS设置此属性。
storageSizeGB	integer	服务器允许的最大存储。
throughput	integer	服务器的存储吞吐量。这是为存储类型PremiumV2_LRS和UltraSSD_LRS设置所必需的。
tier	AzureManagedDiskPerformanceTiers	IOPS 的存储层的名称。
type	StorageType	服务器的存储类型。允许的值是Premium_LRS、PremiumV2_LRS和UltraSSD_LRS。如果未指定，则默认值为Premium_LRS

StorageAutoGrow

为灵活服务器启用/禁用存储自动增长的标志。

名称	类型	说明
Disabled	string
Enabled	string

StorageType

服务器的存储类型。允许的值是Premium_LRS、PremiumV2_LRS和UltraSSD_LRS。如果未指定，则默认值为Premium_LRS

名称	类型	说明
PremiumV2_LRS	string
Premium_LRS	string
UltraSSD_LRS	string

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

名称	类型	说明
createdAt	string	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

UserAssignedIdentity

描述应用程序的标识。

名称	类型	说明
tenantId	string	服务器的租户 ID。
type	IdentityType	与此资源关联的标识类型
userAssignedIdentities	<string, UserIdentity>	表示用户分配的标识映射。

UserIdentity

描述与应用程序关联的单个用户分配标识。

名称	类型	说明
clientId	string	此标识表示的服务主体的客户端标识符。
principalId	string	此标识表示的服务主体的对象标识符。

通过

Servers - Update

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

Promote a replica server as a Standalone server as forced, i.e. it will promote a replica server immediately without waiting for primary and replica to be in sync.

示例请求

示例响应

Promote a replica server as a Standalone server as planned, i.e. it will wait for replication to complete.

示例请求

示例响应

ServerUpdate

示例请求

示例响应

ServerUpdateWithAadAuthEnabled

示例请求

示例响应

ServerUpdateWithCustomerMaintenanceWindow

示例请求

示例响应

ServerUpdateWithDataEncryptionEnabled

示例请求

示例响应

ServerUpdateWithMajorVersionUpgrade

示例请求

示例响应

SwitchOver a replica server as forced, i.e. it will replica as Primary and original primary as replica immediately without waiting for primary and replica to be in sync.

示例请求

示例响应

SwitchOver a replica server as planned, i.e. it will wait for replication to complete before promoting replica as Primary and original primary as replica.

示例请求

示例响应

定义

activeDirectoryAuthEnum

ArmServerKeyType

AuthConfig

AzureManagedDiskPerformanceTiers

Backup

Cluster

createdByType

CreateMode

CreateModeForUpdate

DataEncryption

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoRedundantBackupEnum

HighAvailability

HighAvailabilityMode

IdentityType

keyStatusEnum

MaintenanceWindow

Network

passwordAuthEnum

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

ReadReplicaPromoteMode

Replica

ReplicationPromoteOption

ReplicationRole

ReplicationState

Server

ServerForUpdate

ServerHAState

ServerPublicNetworkAccessState

ServerState

ServerVersion

Sku

SkuTier

Storage

StorageAutoGrow

StorageType

systemData