Replicas - List By Server

參考

服務:: PostgreSQL

API 版本:: 2022-12-01

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

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	資源群組的名稱。名稱不區分大小寫。
serverName	path	True	string	伺服器的名稱。 Regex 模式: `^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*`
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
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=2022-12-01

/** Samples for Replicas ListByServer. */
public final class Main {
    /*
     * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2022-12-01/examples/ReplicasListByServer.json
     */
    /**
     * Sample code: ReplicasListByServer.
     *
     * @param manager Entry point to PostgreSqlManager.
     */
    public static void replicasListByServer(
        com.azure.resourcemanager.postgresqlflexibleserver.PostgreSqlManager manager) {
        manager.replicas().listByServer("testrg", "sourcepgservername", com.azure.core.util.Context.NONE);
    }
}

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

package armpostgresqlflexibleservers_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/postgresql/armpostgresqlflexibleservers/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/75ece9197dbac70ac0ba651c53a79c1841944be2/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2022-12-01/examples/ReplicasListByServer.json
func ExampleReplicasClient_NewListByServerPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpostgresqlflexibleservers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewReplicasClient().NewListByServerPager("testrg", "sourcepgservername", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ServerListResult = armpostgresqlflexibleservers.ServerListResult{
		// 	Value: []*armpostgresqlflexibleservers.Server{
		// 		{
		// 			Name: to.Ptr("pgtestsvc5rep"),
		// 			Type: to.Ptr("Microsoft.DBforPostgreSQL/flexibleServers"),
		// 			ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5rep"),
		// 			Location: to.Ptr("westus"),
		// 			Tags: map[string]*string{
		// 				"ElasticServer": to.Ptr("1"),
		// 			},
		// 			Properties: &armpostgresqlflexibleservers.ServerProperties{
		// 				AdministratorLogin: to.Ptr("cloudsa"),
		// 				AuthConfig: &armpostgresqlflexibleservers.AuthConfig{
		// 					ActiveDirectoryAuth: to.Ptr(armpostgresqlflexibleservers.ActiveDirectoryAuthEnumDisabled),
		// 					PasswordAuth: to.Ptr(armpostgresqlflexibleservers.PasswordAuthEnumEnabled),
		// 				},
		// 				AvailabilityZone: to.Ptr("2"),
		// 				Backup: &armpostgresqlflexibleservers.Backup{
		// 					BackupRetentionDays: to.Ptr[int32](7),
		// 					EarliestRestoreDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-27T00:28:17.727Z"); return t}()),
		// 					GeoRedundantBackup: to.Ptr(armpostgresqlflexibleservers.GeoRedundantBackupEnumDisabled),
		// 				},
		// 				DataEncryption: &armpostgresqlflexibleservers.DataEncryption{
		// 					Type: to.Ptr(armpostgresqlflexibleservers.ArmServerKeyTypeSystemManaged),
		// 				},
		// 				FullyQualifiedDomainName: to.Ptr("pgtestsvc5rep.postgres.database.azure.com"),
		// 				HighAvailability: &armpostgresqlflexibleservers.HighAvailability{
		// 					Mode: to.Ptr(armpostgresqlflexibleservers.HighAvailabilityModeDisabled),
		// 					State: to.Ptr(armpostgresqlflexibleservers.ServerHAStateNotEnabled),
		// 				},
		// 				MaintenanceWindow: &armpostgresqlflexibleservers.MaintenanceWindow{
		// 					CustomWindow: to.Ptr("Disabled"),
		// 					DayOfWeek: to.Ptr[int32](0),
		// 					StartHour: to.Ptr[int32](0),
		// 					StartMinute: to.Ptr[int32](0),
		// 				},
		// 				MinorVersion: to.Ptr("6"),
		// 				Network: &armpostgresqlflexibleservers.Network{
		// 					PublicNetworkAccess: to.Ptr(armpostgresqlflexibleservers.ServerPublicNetworkAccessStateEnabled),
		// 				},
		// 				ReplicaCapacity: to.Ptr[int32](0),
		// 				ReplicationRole: to.Ptr(armpostgresqlflexibleservers.ReplicationRoleAsyncReplica),
		// 				State: to.Ptr(armpostgresqlflexibleservers.ServerStateReady),
		// 				Storage: &armpostgresqlflexibleservers.Storage{
		// 					StorageSizeGB: to.Ptr[int32](512),
		// 				},
		// 				Version: to.Ptr(armpostgresqlflexibleservers.ServerVersionTwelve),
		// 			},
		// 			SKU: &armpostgresqlflexibleservers.SKU{
		// 				Name: to.Ptr("Standard_D4s_v3"),
		// 				Tier: to.Ptr(armpostgresqlflexibleservers.SKUTierGeneralPurpose),
		// 			},
		// 	}},
		// }
	}
}

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

const { PostgreSQLManagementFlexibleServerClient } = require("@azure/arm-postgresql-flexible");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List all the replicas for a given server.
 *
 * @summary List all the replicas for a given server.
 * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2022-12-01/examples/ReplicasListByServer.json
 */
async function replicasListByServer() {
  const subscriptionId =
    process.env["POSTGRESQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["POSTGRESQL_RESOURCE_GROUP"] || "testrg";
  const serverName = "sourcepgservername";
  const credential = new DefaultAzureCredential();
  const client = new PostgreSQLManagementFlexibleServerClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.replicas.listByServer(resourceGroupName, serverName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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
        },
        "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
      },
      "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 金鑰保存庫的數據加密類型。
AuthConfig	伺服器的驗證組態屬性
Backup	伺服器的備份屬性
createdByType	建立資源的身分識別類型。
CreateMode	建立新 PostgreSQL 伺服器的模式。
DataEncryption	伺服器的數據加密屬性
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
GeoRedundantBackupEnum	值，指出伺服器上是否啟用 Geo-Redundant 備份。
HighAvailability	伺服器的高可用性屬性
HighAvailabilityMode	伺服器的HA模式。
IdentityType	與此資源相關聯的身分識別類型;目前限制為「無」和「UserAssigned」
MaintenanceWindow	伺服器的維護視窗屬性。
Network	伺服器的網路屬性。
passwordAuthEnum	如果已啟用，則會啟用密碼驗證。
ReplicationRole	用來指出複寫集中伺服器的角色。
Server	表示伺服器。
ServerHAState	使用者可以看到的HA伺服器狀態。
ServerListResult	伺服器清單。
ServerPublicNetworkAccessState	公用網路存取已啟用或未啟用
ServerState	使用者看得見的伺服器狀態。
ServerVersion	伺服器的版本。
Sku	伺服器的 Sku 資訊相關屬性。
SkuTier	特定 SKU 的層級，例如高載。
Storage	伺服器的記憶體屬性
systemData	與建立和上次修改資源相關的元數據。
UserAssignedIdentity	描述與此應用程式相關聯之身分識別的資訊。
UserIdentity	描述與應用程式相關聯的單一使用者指派身分識別。

activeDirectoryAuthEnum

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

名稱	類型	Description
Disabled	string
Enabled	string

ArmServerKeyType

要描述其是否為系統管理與 Azure 金鑰保存庫的數據加密類型。

名稱	類型	Description
AzureKeyVault	string
SystemManaged	string

AuthConfig

伺服器的驗證組態屬性

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

Backup

伺服器的備份屬性

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

createdByType

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

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

CreateMode

建立新 PostgreSQL 伺服器的模式。

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

DataEncryption

伺服器的數據加密屬性

名稱	類型	Description
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	錯誤物件。

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

與此資源相關聯的身分識別類型;目前限制為「無」和「UserAssigned」

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

ReplicationRole

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

名稱	類型	Description
AsyncReplica	string
GeoAsyncReplica	string
None	string
Primary	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.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' 時，這是必要的。
properties.replicaCapacity	integer	伺服器允許的複本。
properties.replicationRole	ReplicationRole	伺服器的復寫角色
properties.sourceServerResourceId	string	要從中還原的來源伺服器資源標識碼。當 'createMode' 是 'PointInTimeRestore' 或 'GeoRestore' 或 'Replica' 時，這是必要的。此屬性只會針對復本伺服器傳回
properties.state	ServerState	使用者看得見的伺服器狀態。
properties.storage	Storage	伺服器的儲存屬性。
properties.version	ServerVersion	PostgreSQL 伺服器版本。
sku	Sku	SKU (伺服器) 定價層。
systemData	systemData	與此資源相關的系統元數據。
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

Sku

伺服器的 Sku 資訊相關屬性。

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

SkuTier

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

名稱	類型	Description
Burstable	string
GeneralPurpose	string
MemoryOptimized	string

Storage

伺服器的記憶體屬性

名稱	類型	Description
storageSizeGB	integer	伺服器允許的最大記憶體。

systemData

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

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

UserAssignedIdentity

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

名稱	類型	Description
tenantId	string	伺服器的租用戶標識碼。
type	IdentityType	與此資源相關聯的身分識別類型;目前限制為「無」和「UserAssigned」
userAssignedIdentities	<string, UserIdentity>	代表使用者指派的身分識別對應。

UserIdentity

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

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

共用方式為

Replicas - List By Server

URI 參數

回應

安全性

azure_auth

範圍

範例

ReplicasListByServer

範例要求

範例回覆

定義

activeDirectoryAuthEnum

ArmServerKeyType

AuthConfig

Backup

createdByType

CreateMode

DataEncryption

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoRedundantBackupEnum

HighAvailability

HighAvailabilityMode

IdentityType

MaintenanceWindow

Network

passwordAuthEnum

ReplicationRole

Server

ServerHAState

ServerListResult

ServerPublicNetworkAccessState

ServerState

ServerVersion

Sku

SkuTier

Storage

systemData

UserAssignedIdentity

UserIdentity

其他資源