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	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	ServerListResult	ОК
Other Status Codes	ErrorResponse	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: 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.
AuthConfig	Свойства конфигурации проверки подлинности сервера
Backup	Свойства резервного копирования сервера
createdByType	Тип удостоверения, создавшего ресурс.
CreateMode	Режим для создания нового сервера PostgreSQL.
DataEncryption	Свойства шифрования данных сервера
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
GeoRedundantBackupEnum	Значение , указывающее, включено ли на сервере резервное копирование Geo-Redundant.
HighAvailability	Свойства высокого уровня доступности сервера
HighAvailabilityMode	Режим высокого уровня доступности для сервера.
IdentityType	типы удостоверений, связанных с этим ресурсом; в настоящее время ограничено "None and UserAssigned"
MaintenanceWindow	Свойства периода обслуживания сервера.
Network	Сетевые свойства сервера.
passwordAuthEnum	Если включено, проверка подлинности по паролю включена.
ReplicationRole	Используется для указания роли сервера в наборе репликации.
Server	Представляет сервер.
ServerHAState	Состояние сервера высокого уровня доступности, видимое пользователю.
ServerListResult	Список серверов.
ServerPublicNetworkAccessState	Доступ к общедоступной сети включен или не включен
ServerState	Состояние сервера, видимое пользователю.
ServerVersion	Версия сервера.
Sku	Сведения о SKU, связанные с свойствами сервера.
SkuTier	Уровень конкретного номера SKU, например Увеличиваемый.
Storage	Свойства хранилища сервера
systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.
UserAssignedIdentity	Сведения, описывающие удостоверения, связанные с этим приложением.
UserIdentity	Описывает одно назначаемое пользователем удостоверение, связанное с приложением.

activeDirectoryAuthEnum

Если включена, проверка подлинности Azure Active Directory включена.

Имя	Тип	Описание
Disabled	string
Enabled	string

ArmServerKeyType

Тип шифрования данных, чтобы указать, является ли оно управляемым системой и хранилищем ключей Azure.

Имя	Тип	Описание
AzureKeyVault	string
SystemManaged	string

AuthConfig

Свойства конфигурации проверки подлинности сервера

Имя	Тип	Default value	Описание
activeDirectoryAuth	activeDirectoryAuthEnum		Если включено, проверка подлинности Azure Active Directory включена.
passwordAuth	passwordAuthEnum	Enabled	Если включено, проверка подлинности по паролю включена.
tenantId	string		Идентификатор клиента сервера.

Backup

Свойства резервного копирования сервера

Имя	Тип	Default value	Описание
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	Идентификатор ресурса для удостоверения, назначаемого пользователем, которое будет использоваться для шифрования данных на сервере-источнике.
type	ArmServerKeyType	Тип шифрования данных, чтобы указать, является ли оно управляемым системой и хранилищем ключей Azure.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя	Тип	Описание
error	ErrorDetail	Объект error.

GeoRedundantBackupEnum

Значение , указывающее, включено ли на сервере резервное копирование Geo-Redundant.

Имя	Тип	Описание
Disabled	string
Enabled	string

HighAvailability

Свойства высокого уровня доступности сервера

Имя	Тип	Default value	Описание
mode	HighAvailabilityMode	Disabled	Режим высокой доступности для сервера.
standbyAvailabilityZone	string		сведения о зоне доступности резервного сервера.
state	ServerHAState		Состояние сервера высокой доступности, видимое пользователю.

HighAvailabilityMode

Режим высокого уровня доступности для сервера.

Имя	Тип	Описание
Disabled	string
SameZone	string
ZoneRedundant	string

IdentityType

типы удостоверений, связанных с этим ресурсом; в настоящее время ограничено "None and UserAssigned"

Имя	Тип	Описание
None	string
UserAssigned	string

MaintenanceWindow

Свойства периода обслуживания сервера.

Имя	Тип	Default value	Описание
customWindow	string	Disabled	указывает, включено или отключено пользовательское окно.
dayOfWeek	integer	0	день недели для периода обслуживания
startHour	integer	0	время начала периода обслуживания
startMinute	integer	0	начальная минута для периода обслуживания

Network

Сетевые свойства сервера.

Имя	Тип	Описание
delegatedSubnetResourceId	string	Идентификатор ресурса arm делегированной подсети. Его необходимо передать во время создания, если требуется внедрить сервер виртуальной сети, т. е. сервер частного доступа. Во время обновления передайте это значение, только если нужно обновить значение для Частная зона DNS зоны.
privateDnsZoneArmResourceId	string	Идентификатор ресурса arm частной зоны DNS. Его необходимо передать во время создания, если требуется внедрить сервер виртуальной сети, т. е. сервер частного доступа. Во время обновления передайте это значение, только если нужно обновить значение для Частная зона DNS зоны.
publicNetworkAccess	ServerPublicNetworkAccessState	доступ к общедоступной сети включен или не включен

passwordAuthEnum

Если включено, проверка подлинности по паролю включена.

Имя	Тип	Описание
Disabled	string
Enabled	string

ReplicationRole

Используется для указания роли сервера в наборе репликации.

Имя	Тип	Описание
AsyncReplica	string
GeoAsyncReplica	string
None	string
Primary	string

Server

Представляет сервер.

Имя	Тип	Описание
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

Состояние сервера высокого уровня доступности, видимое пользователю.

Имя	Тип	Описание
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	Идентификатор клиента сервера.
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

Дополнительные ресурсы