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

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов. Имя не учитывает регистр.
serverName	path	True	string	Имя сервера. Шаблон регулярного выражения: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*
subscriptionId	path	True	string uuid	Идентификатор целевой подписки. Значение должно быть UUID.
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

Образец запроса

HTTP

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

Python

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"
    }
  ]
}

Определения

Имя	Описание
activeDirectoryAuthEnum	Если включена проверка подлинности Azure Active Directory, включена.
ArmServerKeyType	Тип шифрования данных для изображения, если это управляемое системой хранилище ключей и Хранилище ключей Azure.
AuthConfig	Свойства конфигурации проверки подлинности сервера
AzureManagedDiskPerformanceTiers	Имя уровня хранилища для операций ввода-вывода в секунду.
Backup	Свойства резервного копирования сервера
Cluster	Свойства кластера сервера.
createdByType	Тип удостоверения, создавшего ресурс.
CreateMode	Режим создания нового сервера PostgreSQL.
DataEncryption	Свойства шифрования данных сервера
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
GeoRedundantBackupEnum	Значение, указывающее, включена ли Geo-Redundant резервное копирование на сервере.
HighAvailability	Свойства высокого уровня доступности сервера
HighAvailabilityMode	Режим высокого уровня доступности для сервера.
IdentityType	типы удостоверений, связанных с этим ресурсом
keyStatusEnum	Состояние первичного ключа шифрования для сервера с поддержкой шифрования данных.
MaintenanceWindow	Свойства периода обслуживания сервера.
Network	Сетевые свойства сервера.
passwordAuthEnum	Если включена проверка подлинности паролей, включена проверка подлинности паролей.
PrivateEndpoint	Ресурс частной конечной точки.
PrivateEndpointConnection	Ресурс подключения к частной конечной точке.
PrivateEndpointConnectionProvisioningState	Текущее состояние подготовки.
PrivateEndpointServiceConnectionStatus	Состояние подключения к частной конечной точке.
PrivateLinkServiceConnectionState	Коллекция сведений о состоянии подключения между потребителем службы и поставщиком.
ReadReplicaPromoteMode	Задает режим повышения уровня для сервера-реплики. Это только свойство записи.
Replica	Свойства реплики сервера
ReplicationPromoteOption	Задает параметры повышения уровня сервера реплики. Это только свойство записи.
ReplicationRole	Используется для указания роли сервера в наборе репликации.
ReplicationState	Возвращает состояние репликации сервера-реплики. Это свойство возвращается только для вызова API реплик. Поддерживаемые значения: Активные, Catchup, Подготовка, Обновление, Сломанный, Перенастройка
Server	Представляет сервер.
ServerHAState	Состояние сервера высокого уровня доступности, видимого пользователю.
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, включена.

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

ArmServerKeyType

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

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

AuthConfig

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

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

AzureManagedDiskPerformanceTiers

Имя уровня хранилища для операций ввода-вывода в секунду.

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

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

Имя	Тип	Default value	Описание
backupRetentionDays	integer	7	Дни хранения резервных копий для сервера.
earliestRestoreDate	string		Самое раннее время восстановления (ISO8601 формат) для сервера.
geoRedundantBackup	GeoRedundantBackupEnum	Disabled	Значение, указывающее, включена ли Geo-Redundant резервное копирование на сервере.

Cluster

Свойства кластера сервера.

Имя	Тип	Default value	Описание
clusterSize	integer	0	Число узлов для кластера.

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

Режим создания нового сервера PostgreSQL.

Имя	Тип	Описание
Create	string
Default	string
GeoRestore	string
PointInTimeRestore	string
Replica	string
ReviveDropped	string
Update	string

DataEncryption

Свойства шифрования данных сервера

Имя	Тип	Описание
geoBackupEncryptionKeyStatus	keyStatusEnum	Состояние ключа шифрования гео резервного копирования для сервера с поддержкой шифрования данных.
geoBackupKeyURI	string	Универсальный код ресурса (URI) для ключа в keyvault для шифрования данных для геозахвата сервера.
geoBackupUserAssignedIdentityId	string	Идентификатор ресурса для удостоверения, назначаемого пользователем, который будет использоваться для шифрования данных для гео резервного копирования сервера.
primaryEncryptionKeyStatus	keyStatusEnum	Состояние первичного ключа шифрования для сервера с поддержкой шифрования данных.
primaryKeyURI	string	Универсальный код ресурса (URI) для ключа в keyvault для шифрования данных первичного сервера.
primaryUserAssignedIdentityId	string	Идентификатор ресурса для удостоверения, назначаемого пользователем, для шифрования данных первичного сервера.
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

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

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

HighAvailabilityMode

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

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

IdentityType

типы удостоверений, связанных с этим ресурсом

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

keyStatusEnum

Состояние первичного ключа шифрования для сервера с поддержкой шифрования данных.

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

PrivateEndpoint

Ресурс частной конечной точки.

Имя	Тип	Описание
id	string	Идентификатор ARM для частной конечной точки.

PrivateEndpointConnection

Ресурс подключения к частной конечной точке.

Имя	Тип	Описание
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	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Текущее состояние подготовки.

Имя	Тип	Описание
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

Состояние подключения к частной конечной точке.

Имя	Тип	Описание
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Коллекция сведений о состоянии подключения между потребителем службы и поставщиком.

Имя	Тип	Описание
actionsRequired	string	Сообщение, указывающее, требуются ли изменения в поставщике услуг, требуются какие-либо обновления для потребителя.
description	string	Причина утверждения или отклонения подключения.
status	PrivateEndpointServiceConnectionStatus	Указывает, утверждено ли подключение, отклонено или удалено владельцем службы.

ReadReplicaPromoteMode

Задает режим повышения уровня для сервера-реплики. Это только свойство записи.

Имя	Тип	Описание
standalone	string
switchover	string

Replica

Свойства реплики сервера

Имя	Тип	Описание
capacity	integer	Реплики, разрешенные для сервера.
promoteMode	ReadReplicaPromoteMode	Задает режим повышения уровня для сервера-реплики. Это только свойство записи.
promoteOption	ReplicationPromoteOption	Задает параметры повышения уровня сервера реплики. Это только свойство записи.
replicationState	ReplicationState	Возвращает состояние репликации сервера-реплики. Это свойство возвращается только для вызова API реплик. Поддерживаемые значения: Активные, Catchup, Подготовка, Обновление, Сломанный, Перенастройка
role	ReplicationRole	Используется для указания роли сервера в наборе репликации.

ReplicationPromoteOption

Задает параметры повышения уровня сервера реплики. Это только свойство записи.

Имя	Тип	Описание
forced	string
planned	string

ReplicationRole

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

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

ReplicationState

Возвращает состояние репликации сервера-реплики. Это свойство возвращается только для вызова API реплик. Поддерживаемые значения: Активные, Catchup, Подготовка, Обновление, Сломанный, Перенастройка

Имя	Тип	Описание
Active	string
Broken	string
Catchup	string
Provisioning	string
Reconfiguring	string
Updating	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.cluster	Cluster	Свойства кластера сервера.
properties.createMode	CreateMode	Режим создания нового сервера PostgreSQL.
properties.dataEncryption	DataEncryption	Свойства шифрования данных сервера.
properties.fullyQualifiedDomainName	string	Полное доменное имя сервера.
properties.highAvailability	HighAvailability	Свойства высокого уровня доступности сервера.
properties.maintenanceWindow	MaintenanceWindow	Свойства периода обслуживания сервера.
properties.minorVersion	string	Дополнительная версия сервера.
properties.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 или "Реплика" или "ReviveDropped". Это свойство возвращается только для сервера реплики
properties.state	ServerState	Состояние сервера, видимого пользователю.
properties.storage	Storage	Свойства хранилища сервера.
properties.version	ServerVersion	Версия сервера PostgreSQL.
sku	Sku	Номер SKU (ценовая категория) сервера.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
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
15	string
16	string
17	string

Sku

Сведения о номере SKU, связанные с свойствами сервера.

Имя	Тип	Описание
name	string	Имя SKU, как правило, уровня + семейства и ядер, например Standard_D4s_v3.
tier	SkuTier	Уровень конкретного номера SKU, например с возможностью ускорения.

SkuTier

Уровень конкретного номера SKU, например с возможностью ускорения.

Имя	Тип	Описание
Burstable	string
GeneralPurpose	string
MemoryOptimized	string

Storage

Свойства хранилища сервера

Имя	Тип	Описание
autoGrow	StorageAutoGrow	Флаг включения и отключения автоматического увеличения хранилища для гибкого сервера.
iops	integer	Количество операций ввода-вывода в секунду уровня хранилища. Это свойство необходимо задать для типа хранилища PremiumV2_LRS и UltraSSD_LRS.
storageSizeGB	integer	Максимально допустимое хранилище для сервера.
throughput	integer	Пропускная способность хранилища для сервера. Это необходимо для PremiumV2_LRS типа хранилища и UltraSSD_LRS.
tier	AzureManagedDiskPerformanceTiers	Имя уровня хранилища для операций ввода-вывода в секунду.
type	StorageType	Тип хранилища для сервера. Допустимые значения: Premium_LRS, PremiumV2_LRS и UltraSSD_LRS. Значение по умолчанию Premium_LRS, если не указано

StorageAutoGrow

Флаг включения и отключения автоматического увеличения хранилища для гибкого сервера.

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

StorageType

Тип хранилища для сервера. Допустимые значения: Premium_LRS, PremiumV2_LRS и UltraSSD_LRS. Значение по умолчанию Premium_LRS, если не указано

Имя	Тип	Описание
PremiumV2_LRS	string
Premium_LRS	string
UltraSSD_LRS	string

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

UserAssignedIdentity

Сведения, описывающие удостоверения, связанные с этим приложением.

Имя	Тип	Описание
tenantId	string	Идентификатор клиента сервера.
type	IdentityType	типы удостоверений, связанных с этим ресурсом
userAssignedIdentities	<string,  UserIdentity>	представляет карту назначенных пользователем удостоверений.

UserIdentity

Описывает одно назначаемое пользователем удостоверение, связанное с приложением.

Имя	Тип	Описание
clientId	string	идентификатор клиента субъекта-службы, который представляет это удостоверение.
principalId	string	идентификатор объекта субъекта-службы, который представляет это удостоверение.