Replicas - List By Server

參考

服務:: PostgreSQL

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

列出指定伺服器的所有複本。

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	資源群組的名稱。名稱不區分大小寫。
serverName	path	True	string	伺服器的名稱。 Regex 模式: `^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*`
subscriptionId	path	True	string uuid	目標訂用帳戶的標識碼。此值必須是 UUID。
api-version	query	True	string	要用於這項作業的 API 版本。

回應

名稱	類型	Description
200 OK	ServerListResult	還行
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

ReplicasListByServer

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python replicas_list_by_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.replicas.list_by_server(
        resource_group_name="testrg",
        server_name="sourcepgservername",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-11-01-preview/examples/ReplicasListByServer.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

{
  "value": [
    {
      "sku": {
        "name": "Standard_D4s_v3",
        "tier": "GeneralPurpose"
      },
      "properties": {
        "fullyQualifiedDomainName": "pgtestsvc5rep.postgres.database.azure.com",
        "version": "12",
        "minorVersion": "6",
        "administratorLogin": "cloudsa",
        "state": "Ready",
        "availabilityZone": "2",
        "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-27T00:28:17.7279547+00:00"
        },
        "network": {
          "publicNetworkAccess": "Enabled"
        },
        "highAvailability": {
          "mode": "Disabled",
          "state": "NotEnabled"
        },
        "maintenanceWindow": {
          "customWindow": "Disabled",
          "dayOfWeek": 0,
          "startHour": 0,
          "startMinute": 0
        },
        "replicationRole": "AsyncReplica",
        "replicaCapacity": 0,
        "replica": {
          "role": "AsyncReplica",
          "capacity": 0,
          "replicationState": "Active"
        }
      },
      "location": "westus",
      "tags": {
        "ElasticServer": "1"
      },
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5rep",
      "name": "pgtestsvc5rep",
      "type": "Microsoft.DBforPostgreSQL/flexibleServers"
    }
  ]
}

定義

名稱	Description
activeDirectoryAuthEnum	如果已啟用，則會啟用 Azure Active Directory 驗證。
ArmServerKeyType	描述其是否為系統管理與 Azure Key Vault 的數據加密類型。
AuthConfig	伺服器的驗證組態屬性
AzureManagedDiskPerformanceTiers	IOPS 的儲存層名稱。
Backup	伺服器的備份屬性
Cluster	伺服器的叢集屬性。
createdByType	建立資源的身分識別類型。
CreateMode	建立新 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	表示伺服器。
ServerHAState	使用者可以看到的HA伺服器狀態。
ServerListResult	伺服器清單。
ServerPublicNetworkAccessState	公用網路存取已啟用或未啟用
ServerState	用戶可看見之伺服器的狀態。
ServerVersion	伺服器的版本。
Sku	伺服器的 Sku 資訊相關信息。
SkuTier	特定 SKU 的層級，例如高載。
Storage	伺服器的儲存屬性
StorageAutoGrow	啟用/停用彈性伺服器的記憶體自動成長旗標。
StorageType	伺服器的儲存類型。允許的值是Premium_LRS、PremiumV2_LRS和UltraSSD_LRS。如果未指定，預設值為Premium_LRS
systemData	與建立和上次修改資源相關的元數據。
UserAssignedIdentity	描述與此應用程式相關聯之身分識別的資訊。
UserIdentity	描述與應用程式相關聯的單一使用者指派身分識別。

activeDirectoryAuthEnum

如果已啟用，則會啟用 Azure Active Directory 驗證。

名稱	類型	Description
Disabled	string
Enabled	string

ArmServerKeyType

描述其是否為系統管理與 Azure Key Vault 的數據加密類型。

名稱	類型	Description
AzureKeyVault	string
SystemManaged	string

AuthConfig

伺服器的驗證組態屬性

名稱	類型	預設值	Description
activeDirectoryAuth	activeDirectoryAuthEnum		如果已啟用，則會啟用 Azure Active Directory 驗證。
passwordAuth	passwordAuthEnum	Enabled	如果已啟用，則會啟用密碼驗證。
tenantId	string		伺服器的租用戶標識碼。

AzureManagedDiskPerformanceTiers

IOPS 的儲存層名稱。

名稱	類型	Description
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

伺服器的備份屬性

名稱	類型	預設值	Description
backupRetentionDays	integer	7	伺服器的備份保留天數。
earliestRestoreDate	string		伺服器最早的還原時間點時間（ISO8601格式）。
geoRedundantBackup	GeoRedundantBackupEnum	Disabled	值，指出伺服器上是否啟用 Geo-Redundant 備份。

Cluster

伺服器的叢集屬性。

名稱	類型	預設值	Description
clusterSize	integer	0	叢集的節點計數。

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

建立新 PostgreSQL 伺服器的模式。

名稱	類型	Description
Create	string
Default	string
GeoRestore	string
PointInTimeRestore	string
Replica	string
ReviveDropped	string
Update	string

DataEncryption

伺服器的數據加密屬性

名稱	類型	Description
geoBackupEncryptionKeyStatus	keyStatusEnum	已啟用資料加密伺服器的異地備份加密金鑰狀態。
geoBackupKeyURI	string	金鑰保存庫中金鑰的 URI，用於伺服器異地備份的數據加密。
geoBackupUserAssignedIdentityId	string	要用於伺服器異地備份之數據加密的使用者指派身分識別的資源標識碼。
primaryEncryptionKeyStatus	keyStatusEnum	已啟用資料加密伺服器的主要加密金鑰狀態。
primaryKeyURI	string	金鑰保存庫中金鑰的 URI，用於主伺服器的數據加密。
primaryUserAssignedIdentityId	string	要用於主伺服器數據加密之使用者指派身分識別的資源識別碼。
type	ArmServerKeyType	描述其是否為系統管理與 Azure Key Vault 的數據加密類型。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

GeoRedundantBackupEnum

值，指出伺服器上是否啟用 Geo-Redundant 備份。

名稱	類型	Description
Disabled	string
Enabled	string

HighAvailability

伺服器的高可用性屬性

名稱	類型	預設值	Description
mode	HighAvailabilityMode	Disabled	伺服器的HA模式。
standbyAvailabilityZone	string		待命的可用性區域資訊。
state	ServerHAState		使用者可以看到的HA伺服器狀態。

HighAvailabilityMode

伺服器的HA模式。

名稱	類型	Description
Disabled	string
SameZone	string
ZoneRedundant	string

IdentityType

與此資源相關聯的身分識別類型

名稱	類型	Description
None	string
SystemAssigned	string
UserAssigned	string

keyStatusEnum

已啟用資料加密伺服器的主要加密金鑰狀態。

名稱	類型	Description
Invalid	string
Valid	string

MaintenanceWindow

伺服器的維護時段屬性。

名稱	類型	預設值	Description
customWindow	string	Disabled	指出是否啟用或停用自定義視窗
dayOfWeek	integer	0	維護時段的星期數
startHour	integer	0	維護時段的開始時間
startMinute	integer	0	維護時段的開始分鐘

Network

伺服器的網路屬性。

名稱	類型	Description
delegatedSubnetResourceId	string	委派的子網 arm 資源標識符。這是在建立期間傳遞的必要條件，以防我們想要將伺服器插入 VNET，也就是私人存取伺服器。在更新期間，只有在我們想要更新私人 DNS 區域的值時，才會傳遞此值。
privateDnsZoneArmResourceId	string	私人 DNS 區域 arm 資源識別碼。這是在建立期間傳遞的必要條件，以防我們想要將伺服器插入 VNET，也就是私人存取伺服器。在更新期間，只有在我們想要更新私人 DNS 區域的值時，才會傳遞此值。
publicNetworkAccess	ServerPublicNetworkAccessState	公用網路存取已啟用或未啟用

passwordAuthEnum

如果已啟用，則會啟用密碼驗證。

名稱	類型	Description
Disabled	string
Enabled	string

PrivateEndpoint

私人端點資源。

名稱	類型	Description
id	string	私人端點的ARM標識碼。

PrivateEndpointConnection

私人端點聯機資源。

名稱	類型	Description
id	string	資源的完整資源標識碼。例如 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	資源的名稱
properties.groupIds	string[]	私人端點資源的群組標識碼。
properties.privateEndpoint	PrivateEndpoint	私人端點資源。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	服務取用者與提供者之間連線狀態的相關信息集合。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	私人端點聯機資源的布建狀態。
systemData	systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
type	string	資源的型別。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

PrivateEndpointConnectionProvisioningState

目前的布建狀態。

名稱	類型	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

私人端點連線狀態。

名稱	類型	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

服務取用者與提供者之間連線狀態的相關信息集合。

名稱	類型	Description
actionsRequired	string	訊息，指出服務提供者上的變更是否需要取用者的任何更新。
description	string	核准/拒絕連線的原因。
status	PrivateEndpointServiceConnectionStatus	指出服務擁有者是否已核准/拒絕/移除連線。

ReadReplicaPromoteMode

設定複本伺服器的升階模式。這是唯寫屬性。

名稱	類型	Description
standalone	string
switchover	string

Replica

伺服器的復本屬性

名稱	類型	Description
capacity	integer	伺服器允許的複本。
promoteMode	ReadReplicaPromoteMode	設定複本伺服器的升階模式。這是唯寫屬性。
promoteOption	ReplicationPromoteOption	設定複本伺服器的升級選項。這是唯寫屬性。
replicationState	ReplicationState	取得複本伺服器的復寫狀態。此屬性只會針對複本 API 呼叫傳回。支援的值為 Active、Catchup、Provisioning、Updateing、Broken、Reconfiguring
role	ReplicationRole	用來指出複寫集中伺服器的角色。

ReplicationPromoteOption

設定複本伺服器的升級選項。這是唯寫屬性。

名稱	類型	Description
forced	string
planned	string

ReplicationRole

用來指出複寫集中伺服器的角色。

名稱	類型	Description
AsyncReplica	string
GeoAsyncReplica	string
None	string
Primary	string

ReplicationState

取得複本伺服器的復寫狀態。此屬性只會針對複本 API 呼叫傳回。支援的值為 Active、Catchup、Provisioning、Updateing、Broken、Reconfiguring

名稱	類型	Description
Active	string
Broken	string
Catchup	string
Provisioning	string
Reconfiguring	string
Updating	string

Server

表示伺服器。

名稱	類型	Description
id	string	資源的完整資源標識碼。例如 “/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	伺服器的網路屬性。只有在您想要伺服器成為私人存取伺服器時，才需要傳遞此 Network 屬性。
properties.pointInTimeUTC	string	還原點建立時間（ISO8601格式），指定要還原的時間。當 'createMode' 是 'PointInTimeRestore' 或 'GeoRestore' 或 'ReviveDropped' 時，這是必要的。
properties.privateEndpointConnections	PrivateEndpointConnection[]	與指定資源相關聯的私人端點連線清單。
properties.replica	Replica	伺服器的復本屬性。只有在您想要升級伺服器時，才需要傳遞這些複本屬性。
properties.replicaCapacity	integer	伺服器允許的複本。
properties.replicationRole	ReplicationRole	伺服器的復寫角色
properties.sourceServerResourceId	string	要從中還原的來源伺服器資源標識碼。當 'createMode' 是 'PointInTimeRestore' 或 'GeoRestore' 或 'Replica' 或 'ReviveDropped' 時，這是必要的。此屬性只會針對復本伺服器傳回
properties.state	ServerState	用戶可看見之伺服器的狀態。
properties.storage	Storage	伺服器的儲存屬性。
properties.version	ServerVersion	PostgreSQL Server 版本。
sku	Sku	伺服器的 SKU（定價層）。
systemData	systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
tags	object	資源標籤。
type	string	資源的型別。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

ServerHAState

使用者可以看到的HA伺服器狀態。

名稱	類型	Description
CreatingStandby	string
FailingOver	string
Healthy	string
NotEnabled	string
RemovingStandby	string
ReplicatingData	string

ServerListResult

伺服器清單。

名稱	類型	Description
nextLink	string	用來取得下一頁作業的連結。
value	Server[]	彈性伺服器清單

ServerPublicNetworkAccessState

公用網路存取已啟用或未啟用

名稱	類型	Description
Disabled	string
Enabled	string

ServerState

用戶可看見之伺服器的狀態。

名稱	類型	Description
Disabled	string
Dropping	string
Ready	string
Starting	string
Stopped	string
Stopping	string
Updating	string

ServerVersion

伺服器的版本。

名稱	類型	Description
11	string
12	string
13	string
14	string
15	string
16	string
17	string

Sku

伺服器的 Sku 資訊相關信息。

名稱	類型	Description
name	string	sku 的名稱，通常是階層 + 系列 + 核心，例如Standard_D4s_v3。
tier	SkuTier	特定 SKU 的層級，例如高載。

SkuTier

特定 SKU 的層級，例如高載。

名稱	類型	Description
Burstable	string
GeneralPurpose	string
MemoryOptimized	string

Storage

伺服器的儲存屬性

名稱	類型	Description
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

啟用/停用彈性伺服器的記憶體自動成長旗標。

名稱	類型	Description
Disabled	string
Enabled	string

StorageType

伺服器的儲存類型。允許的值是Premium_LRS、PremiumV2_LRS和UltraSSD_LRS。如果未指定，預設值為Premium_LRS

名稱	類型	Description
PremiumV2_LRS	string
Premium_LRS	string
UltraSSD_LRS	string

systemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

UserAssignedIdentity

描述與此應用程式相關聯之身分識別的資訊。

名稱	類型	Description
tenantId	string	伺服器的租用戶標識碼。
type	IdentityType	與此資源相關聯的身分識別類型
userAssignedIdentities	<string, UserIdentity>	代表使用者指派的身分識別對應。

UserIdentity

描述與應用程式相關聯的單一使用者指派身分識別。

名稱	類型	Description
clientId	string	此身分識別所代表之服務主體的用戶端標識碼。
principalId	string	此身分識別所代表之服務主體的物件標識碼。

共用方式為