Share via


Replicas - List By Server

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/replicas?api-version=2017-12-01

URI 參數

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

string

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

serverName
path True

string

伺服器的名稱。

subscriptionId
path True

string

目標訂用帳戶的標識碼。

api-version
query True

string

用於此作業的 API 版本。

回應

名稱 類型 Description
200 OK

ServerListResult

確定

Other Status Codes

CloudError

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

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

範例

ReplicasListByServer

Sample Request

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-master/replicas?api-version=2017-12-01

Sample Response

{
  "value": [
    {
      "sku": {
        "name": "GP_Gen4_16",
        "tier": "GeneralPurpose",
        "family": "Gen4",
        "capacity": 16
      },
      "properties": {
        "administratorLogin": "postgres",
        "storageProfile": {
          "storageMB": 2048000,
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled"
        },
        "version": "9.6",
        "sslEnforcement": "Disabled",
        "userVisibleState": "Ready",
        "fullyQualifiedDomainName": "testserver-replica1.postgres.database.azure.com",
        "earliestRestoreDate": "2018-06-12T00:05:03.2695756+00:00",
        "replicationRole": "Replica",
        "masterServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-master",
        "replicaCapacity": 0
      },
      "location": "westcentralus",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-replica1",
      "name": "testserver-replica1",
      "type": "Microsoft.DBforPostgreSQL/servers"
    },
    {
      "sku": {
        "name": "GP_Gen4_16",
        "tier": "GeneralPurpose",
        "family": "Gen4",
        "capacity": 16
      },
      "properties": {
        "administratorLogin": "postgres",
        "storageProfile": {
          "storageMB": 2048000,
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled"
        },
        "version": "9.6",
        "sslEnforcement": "Disabled",
        "userVisibleState": "Ready",
        "fullyQualifiedDomainName": "testserver-replica2.postgres.database.azure.com",
        "earliestRestoreDate": "2018-06-12T00:05:03.2695756+00:00",
        "replicationRole": "Replica",
        "masterServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-master",
        "replicaCapacity": 0
      },
      "location": "westcentralus",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-replica2",
      "name": "testserver-replica2",
      "type": "Microsoft.DBforPostgreSQL/servers"
    },
    {
      "sku": {
        "name": "GP_Gen4_16",
        "tier": "GeneralPurpose",
        "family": "Gen4",
        "capacity": 16
      },
      "properties": {
        "administratorLogin": "postgres",
        "storageProfile": {
          "storageMB": 2048000,
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled"
        },
        "version": "9.6",
        "sslEnforcement": "Disabled",
        "userVisibleState": "Ready",
        "fullyQualifiedDomainName": "testserver-replica3.postgres.database.azure.com",
        "earliestRestoreDate": "2018-06-12T00:05:03.2695756+00:00",
        "replicationRole": "Replica",
        "masterServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-master",
        "replicaCapacity": 0
      },
      "location": "westcentralus",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-replica3",
      "name": "testserver-replica3",
      "type": "Microsoft.DBforPostgreSQL/servers"
    },
    {
      "sku": {
        "name": "GP_Gen4_16",
        "tier": "GeneralPurpose",
        "family": "Gen4",
        "capacity": 16
      },
      "properties": {
        "administratorLogin": "postgres",
        "storageProfile": {
          "storageMB": 2048000,
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled"
        },
        "version": "9.6",
        "sslEnforcement": "Disabled",
        "userVisibleState": "Ready",
        "fullyQualifiedDomainName": "testserver-replica4.postgres.database.azure.com",
        "earliestRestoreDate": "2018-06-12T00:05:03.2695756+00:00",
        "replicationRole": "Replica",
        "masterServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-master",
        "replicaCapacity": 0
      },
      "location": "westcentralus",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-replica4",
      "name": "testserver-replica4",
      "type": "Microsoft.DBforPostgreSQL/servers"
    },
    {
      "sku": {
        "name": "GP_Gen4_16",
        "tier": "GeneralPurpose",
        "family": "Gen4",
        "capacity": 16
      },
      "properties": {
        "administratorLogin": "postgres",
        "storageProfile": {
          "storageMB": 2048000,
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled"
        },
        "version": "9.6",
        "sslEnforcement": "Disabled",
        "userVisibleState": "Ready",
        "fullyQualifiedDomainName": "testserver-replica5.postgres.database.azure.com",
        "earliestRestoreDate": "2018-06-12T00:05:03.2695756+00:00",
        "replicationRole": "Replica",
        "masterServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-master",
        "replicaCapacity": 0
      },
      "location": "westcentralus",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-replica5",
      "name": "testserver-replica5",
      "type": "Microsoft.DBforPostgreSQL/servers"
    }
  ]
}

定義

名稱 Description
CloudError

Batch 服務的錯誤回應。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorResponse

錯誤回應

GeoRedundantBackup

針對伺服器備份啟用異地備援或不啟用。

IdentityType

識別類型。 將此設定為 『SystemAssigned』,以便自動建立並指派資源的 Azure Active Directory 主體。

InfrastructureEncryption

使用新的加密演算法為您的資料新增第二層加密,以提供額外的數據保護。 值是選擇性的,但如果傳入,則必須是 『Disabled』 或 'Enabled'。

MinimalTlsVersionEnum

為伺服器強制執行最低 Tls 版本。

PrivateEndpointProperty
PrivateEndpointProvisioningState

私人端點連線的狀態。

PrivateLinkServiceConnectionStateActionsRequire

私人鏈接服務連線所需的動作。

PrivateLinkServiceConnectionStateStatus

私人鏈接服務連線狀態。

PublicNetworkAccessEnum

是否允許此伺服器的公用網路存取。 值是選擇性的,但如果傳入,則必須是 'Enabled' 或 'Disabled'

ResourceIdentity

資源的 Azure Active Directory 身分識別設定。

Server

表示伺服器。

ServerListResult

伺服器清單。

ServerPrivateEndpointConnection

伺服器下的私人端點連線

ServerPrivateEndpointConnectionProperties

私人端點連線的屬性。

ServerPrivateLinkServiceConnectionStateProperty
ServerState

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

ServerVersion

伺服器的版本。

Sku

伺服器帳單相關信息屬性。

SkuTier

特定 SKU 的層,例如基本層。

SslEnforcementEnum

在連線到伺服器時啟用 SSL 強制。

StorageAutogrow

啟用記憶體自動成長。

StorageProfile

伺服器的記憶體配置檔屬性

CloudError

Batch 服務的錯誤回應。

名稱 類型 Description
error

ErrorResponse

錯誤回應
所有 Azure Resource Manager API 的常見錯誤回應,以傳回失敗作業的錯誤詳細數據。 (這也會遵循 OData 錯誤回應格式。)

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。

type

string

其他信息類型。

ErrorResponse

錯誤回應

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。

code

string

錯誤碼。

details

ErrorResponse[]

錯誤詳細資料。

message

string

錯誤訊息。

target

string

錯誤目標。

GeoRedundantBackup

針對伺服器備份啟用異地備援或不啟用。

名稱 類型 Description
Disabled

string

Enabled

string

IdentityType

識別類型。 將此設定為 『SystemAssigned』,以便自動建立並指派資源的 Azure Active Directory 主體。

名稱 類型 Description
SystemAssigned

string

InfrastructureEncryption

使用新的加密演算法為您的資料新增第二層加密,以提供額外的數據保護。 值是選擇性的,但如果傳入,則必須是 『Disabled』 或 'Enabled'。

名稱 類型 Description
Disabled

string

待用數據的額外 (第 2) 層加密

Enabled

string

待用數據單一加密層的預設值。

MinimalTlsVersionEnum

為伺服器強制執行最低 Tls 版本。

名稱 類型 Description
TLS1_0

string

TLS1_1

string

TLS1_2

string

TLSEnforcementDisabled

string

PrivateEndpointProperty

名稱 類型 Description
id

string

私人端點的資源標識碼。

PrivateEndpointProvisioningState

私人端點連線的狀態。

名稱 類型 Description
Approving

string

Dropping

string

Failed

string

Ready

string

Rejecting

string

PrivateLinkServiceConnectionStateActionsRequire

私人鏈接服務連線所需的動作。

名稱 類型 Description
None

string

PrivateLinkServiceConnectionStateStatus

私人鏈接服務連線狀態。

名稱 類型 Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

PublicNetworkAccessEnum

是否允許此伺服器的公用網路存取。 值是選擇性的,但如果傳入,則必須是 'Enabled' 或 'Disabled'

名稱 類型 Description
Disabled

string

Enabled

string

ResourceIdentity

資源的 Azure Active Directory 身分識別設定。

名稱 類型 Description
principalId

string

Azure Active Directory 主體標識符。

tenantId

string

Azure Active Directory 租用戶標識符。

type

IdentityType

識別類型。 將此設定為 『SystemAssigned』,以便自動建立並指派資源的 Azure Active Directory 主體。

Server

表示伺服器。

名稱 類型 Description
id

string

資源的完整資源識別碼。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

ResourceIdentity

伺服器的 Azure Active Directory 身分識別。

location

string

資源所在的地理位置

name

string

資源的名稱

properties.administratorLogin

string

伺服器的系統管理員登入名稱。 只有在建立伺服器 (且建立) 時才能指定。

properties.byokEnforcement

string

顯示伺服器數據加密是否已啟用客戶自控金鑰的狀態。

properties.earliestRestoreDate

string

最早的還原點建立時間 (ISO8601 格式)

properties.fullyQualifiedDomainName

string

伺服器的完整功能變數名稱。

properties.infrastructureEncryption

InfrastructureEncryption

顯示伺服器是否已啟用基礎結構加密的狀態。

properties.masterServerId

string

復本伺服器的主伺服器識別碼。

properties.minimalTlsVersion

MinimalTlsVersionEnum

為伺服器強制執行最低 Tls 版本。

properties.privateEndpointConnections

ServerPrivateEndpointConnection[]

伺服器上的私人端點連線清單

properties.publicNetworkAccess

PublicNetworkAccessEnum

是否允許此伺服器的公用網路存取。 值是選擇性的,但如果傳入,則必須是 'Enabled' 或 'Disabled'

properties.replicaCapacity

integer

主伺服器可以擁有的複本數目上限。

properties.replicationRole

string

伺服器的復寫角色。

properties.sslEnforcement

SslEnforcementEnum

在連線到伺服器時啟用 SSL 強制。

properties.storageProfile

StorageProfile

伺服器的記憶體配置檔。

properties.userVisibleState

ServerState

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

properties.version

ServerVersion

伺服器版本。

sku

Sku

伺服器的 SKU (定價層) 。

tags

object

資源標籤。

type

string

資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

ServerListResult

伺服器清單。

名稱 類型 Description
value

Server[]

伺服器清單

ServerPrivateEndpointConnection

伺服器下的私人端點連線

名稱 類型 Description
id

string

私人端點聯機的資源標識碼。

properties

ServerPrivateEndpointConnectionProperties

私人端點連線屬性

ServerPrivateEndpointConnectionProperties

私人端點連線的屬性。

名稱 類型 Description
privateEndpoint

PrivateEndpointProperty

線上所屬的私人端點。

privateLinkServiceConnectionState

ServerPrivateLinkServiceConnectionStateProperty

私人端點連線的連接狀態。

provisioningState

PrivateEndpointProvisioningState

私人端點連線的狀態。

ServerPrivateLinkServiceConnectionStateProperty

名稱 類型 Description
actionsRequired

PrivateLinkServiceConnectionStateActionsRequire

私人鏈接服務連線所需的動作。

description

string

私人鏈接服務連線描述。

status

PrivateLinkServiceConnectionStateStatus

私人鏈接服務連線狀態。

ServerState

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

名稱 類型 Description
Disabled

string

Dropping

string

Inaccessible

string

Ready

string

ServerVersion

伺服器的版本。

名稱 類型 Description
10

string

10.0

string

10.2

string

11

string

9.5

string

9.6

string

Sku

伺服器帳單相關信息屬性。

名稱 類型 Description
capacity

integer

相應增加/放大容量,代表伺服器的計算單位。

family

string

硬體系列。

name

string

sku 的名稱,通常是階層 + 系列 + 核心,例如B_Gen4_1、GP_Gen5_8。

size

string

要視需要由資源解譯的大小代碼。

tier

SkuTier

特定 SKU 的層,例如基本層。

SkuTier

特定 SKU 的層,例如基本層。

名稱 類型 Description
Basic

string

GeneralPurpose

string

MemoryOptimized

string

SslEnforcementEnum

在連線到伺服器時啟用 SSL 強制。

名稱 類型 Description
Disabled

string

Enabled

string

StorageAutogrow

啟用記憶體自動成長。

名稱 類型 Description
Disabled

string

Enabled

string

StorageProfile

伺服器的記憶體配置檔屬性

名稱 類型 Description
backupRetentionDays

integer

伺服器的備份保留天數。

geoRedundantBackup

GeoRedundantBackup

針對伺服器備份啟用異地備援或不啟用。

storageAutogrow

StorageAutogrow

啟用記憶體自動成長。

storageMB

integer

伺服器允許的最大記憶體。