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

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 参数

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

响应

名称	类型	说明
200 OK	ServerListResult	确定
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

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

定义

名称	说明
activeDirectoryAuthEnum	如果已启用，则启用 Azure Active Directory 身份验证。
ArmServerKeyType	数据加密类型，用于描述它是系统托管还是 Azure Key Vault。
AuthConfig	服务器的身份验证配置属性
Backup	服务器的备份属性
createdByType	创建资源的标识类型。
CreateMode	创建新 PostgreSQL 服务器的模式。
DataEncryption	服务器的数据加密属性
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
GeoRedundantBackupEnum	一个值，该值指示服务器上是否启用了 Geo-Redundant 备份。
HighAvailability	服务器的高可用性属性
HighAvailabilityMode	服务器的 HA 模式。
IdentityType	与此资源关联的标识类型;当前限制为“None 和 UserAssigned”
MaintenanceWindow	服务器的维护时段属性。
Network	服务器的网络属性。
passwordAuthEnum	如果已启用，则启用密码身份验证。
ReplicationRole	用于指示服务器在复制集中的角色。
Server	表示服务器。
ServerHAState	对用户可见的 HA 服务器的状态。
ServerListResult	服务器列表。
ServerPublicNetworkAccessState	是否启用公用网络访问
ServerState	用户可见的服务器的状态。
ServerVersion	服务器的版本。
Sku	服务器的 SKU 信息相关属性。
SkuTier	特定 SKU 的层，例如可突发的。
Storage	服务器的存储属性
systemData	与资源的创建和上次修改相关的元数据。
UserAssignedIdentity	描述与此应用程序关联的标识的信息。
UserIdentity	描述与应用程序关联的单个用户分配标识。

activeDirectoryAuthEnum

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

名称	类型	说明
Disabled	string
Enabled	string

ArmServerKeyType

数据加密类型，用于描述它是系统托管还是 Azure Key Vault。

名称	类型	说明
AzureKeyVault	string
SystemManaged	string

AuthConfig

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

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

Backup

服务器的备份属性

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

createdByType

创建资源的标识类型。

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

CreateMode

创建新 PostgreSQL 服务器的模式。

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

DataEncryption

服务器的数据加密属性

名称	类型	说明
primaryKeyURI	string	主服务器数据加密密钥的 URI。
primaryUserAssignedIdentityId	string	要用于主服务器数据加密的用户分配标识的资源 ID。
type	ArmServerKeyType	用于描述它是系统托管还是 Azure 密钥保管库的数据加密类型。

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 和 UserAssigned”

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

ReplicationRole

用于指示服务器在复制集中的角色。

名称	类型	说明
AsyncReplica	string
GeoAsyncReplica	string
None	string
Primary	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.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	要从中还原的源服务器资源 ID。当“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 服务器的状态。

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

ServerListResult

服务器列表。

名称	类型	说明
nextLink	string	用于获取下一页操作的链接。
value	Server[]	灵活服务器列表

ServerPublicNetworkAccessState

是否启用公用网络访问

名称	类型	说明
Disabled	string
Enabled	string

ServerState

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

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

ServerVersion

服务器的版本。

名称	类型	说明
11	string
12	string
13	string
14	string

Sku

服务器的 SKU 信息相关属性。

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

SkuTier

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

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

Storage

服务器的存储属性

名称	类型	说明
storageSizeGB	integer	服务器允许的最大存储。

systemData

与资源的创建和上次修改相关的元数据。

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

UserAssignedIdentity

描述与此应用程序关联的标识的信息。

名称	类型	说明
tenantId	string	服务器的租户 ID。
type	IdentityType	与此资源关联的标识类型;当前限制为“None and UserAssigned”
userAssignedIdentities	<string, UserIdentity>	表示用户分配的标识映射。

UserIdentity

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

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

其他资源