Поделиться через


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

Имя В Обязательно Тип Описание
resourceGroupName
path True

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serverName
path True

string

Имя сервера.

subscriptionId
path True

string

Идентификатор целевой подписки.

api-version
query True

string

Версия API, используемая для данной операции.

Ответы

Имя Тип Описание
200 OK

ServerListResult

ОК

Other Status Codes

CloudError

Ответ об ошибке, описывающий причину сбоя операции.

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

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/TestGroup_WestCentralUS/providers/Microsoft.DBforPostgreSQL/servers/testserver-master/replicas?api-version=2017-12-01

Пример ответа

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

Определения

Имя Описание
CloudError

Ответ об ошибке от пакетной службы.

ErrorAdditionalInfo

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

ErrorResponse

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

GeoRedundantBackup

Включите геоизбыточное или нет для резервного копирования сервера.

IdentityType

Тип удостоверения. Задайте для этого параметра значение SystemAssigned, чтобы автоматически создать и назначить субъект Azure Active Directory для ресурса.

InfrastructureEncryption

Добавьте второй уровень шифрования данных с помощью нового алгоритма шифрования, который обеспечивает дополнительную защиту данных. Значение является необязательным, но при передаче должно быть "Disabled" или "Enabled".

MinimalTlsVersionEnum

Примените минимальную версию TLS для сервера.

PrivateEndpointProperty
PrivateEndpointProvisioningState

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

PrivateLinkServiceConnectionStateActionsRequire

Действия, необходимые для подключения службы приватного канала.

PrivateLinkServiceConnectionStateStatus

Состояние подключения службы приватного канала.

PublicNetworkAccessEnum

Разрешен ли доступ к общедоступной сети для этого сервера. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено".

ResourceIdentity

Конфигурация удостоверения Azure Active Directory для ресурса.

Server

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

ServerListResult

Список серверов.

ServerPrivateEndpointConnection

Подключение к частной конечной точке на сервере

ServerPrivateEndpointConnectionProperties

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

ServerPrivateLinkServiceConnectionStateProperty
ServerState

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

ServerVersion

Версия сервера.

Sku

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

SkuTier

Уровень конкретного номера SKU, например Базовый.

SslEnforcementEnum

Включите принудительное применение ssl или нет при подключении к серверу.

StorageAutogrow

Включите автоматическое увеличение хранилища.

StorageProfile

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

CloudError

Ответ об ошибке от пакетной службы.

Имя Тип Описание
error

ErrorResponse

Сообщение об ошибке
Общие ответы об ошибках для всех API Azure Resource Manager, возвращающие сведения об ошибке для неудачных операций. (Он также соответствует формату ответа об ошибке OData.)

ErrorAdditionalInfo

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

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Тип дополнительных сведений.

ErrorResponse

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

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

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

code

string

Код ошибки.

details

ErrorResponse[]

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

message

string

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

target

string

Целевой объект ошибки.

GeoRedundantBackup

Включите геоизбыточное или нет для резервного копирования сервера.

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

string

Enabled

string

IdentityType

Тип удостоверения. Задайте для этого параметра значение SystemAssigned, чтобы автоматически создать и назначить субъект Azure Active Directory для ресурса.

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

string

InfrastructureEncryption

Добавьте второй уровень шифрования данных с помощью нового алгоритма шифрования, который обеспечивает дополнительную защиту данных. Значение является необязательным, но при передаче должно быть "Disabled" или "Enabled".

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

string

Дополнительный (второй) уровень шифрования для неактивных данных

Enabled

string

Значение по умолчанию для одного уровня шифрования неактивных данных.

MinimalTlsVersionEnum

Примените минимальную версию TLS для сервера.

Имя Тип Описание
TLS1_0

string

TLS1_1

string

TLS1_2

string

TLSEnforcementDisabled

string

PrivateEndpointProperty

Имя Тип Описание
id

string

Идентификатор ресурса частной конечной точки.

PrivateEndpointProvisioningState

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

Имя Тип Описание
Approving

string

Dropping

string

Failed

string

Ready

string

Rejecting

string

PrivateLinkServiceConnectionStateActionsRequire

Действия, необходимые для подключения службы приватного канала.

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

string

PrivateLinkServiceConnectionStateStatus

Состояние подключения службы приватного канала.

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

string

Disconnected

string

Pending

string

Rejected

string

PublicNetworkAccessEnum

Разрешен ли доступ к общедоступной сети для этого сервера. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено".

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

string

Enabled

string

ResourceIdentity

Конфигурация удостоверения Azure Active Directory для ресурса.

Имя Тип Описание
principalId

string

Идентификатор субъекта Azure Active Directory.

tenantId

string

Идентификатор клиента Azure Active Directory.

type

IdentityType

Тип удостоверения. Задайте для этого параметра значение SystemAssigned, чтобы автоматически создать и назначить субъект Azure Active Directory для ресурса.

Server

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

Имя Тип Описание
id

string

Полный идентификатор ресурса. Например: /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

Идентификатор master сервера реплика.

properties.minimalTlsVersion

MinimalTlsVersionEnum

Примените минимальную версию TLS для сервера.

properties.privateEndpointConnections

ServerPrivateEndpointConnection[]

Список подключений к частной конечной точке на сервере

properties.publicNetworkAccess

PublicNetworkAccessEnum

Разрешен ли доступ к общедоступной сети для этого сервера. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено".

properties.replicaCapacity

integer

Максимальное количество реплик, которое может иметь сервер master.

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

Список серверов.

Имя Тип Описание
value

Server[]

Список серверов

ServerPrivateEndpointConnection

Подключение к частной конечной точке на сервере

Имя Тип Описание
id

string

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

properties

ServerPrivateEndpointConnectionProperties

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

ServerPrivateEndpointConnectionProperties

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

Имя Тип Описание
privateEndpoint

PrivateEndpointProperty

Частная конечная точка, к которой принадлежит подключение.

privateLinkServiceConnectionState

ServerPrivateLinkServiceConnectionStateProperty

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

provisioningState

PrivateEndpointProvisioningState

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

ServerPrivateLinkServiceConnectionStateProperty

Имя Тип Описание
actionsRequired

PrivateLinkServiceConnectionStateActionsRequire

Действия, необходимые для подключения службы приватного канала.

description

string

Описание подключения к службе приватного канала.

status

PrivateLinkServiceConnectionStateStatus

Состояние подключения службы приватного канала.

ServerState

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

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

string

Dropping

string

Inaccessible

string

Ready

string

ServerVersion

Версия сервера.

Имя Тип Описание
10

string

10.0

string

10.2

string

11

string

9.5

string

9.6

string

Sku

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

Имя Тип Описание
capacity

integer

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

family

string

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

name

string

Имя SKU, как правило, уровень + семейство + ядра, например B_Gen4_1, GP_Gen5_8.

size

string

Код размера, который будет интерпретироваться ресурсом соответствующим образом.

tier

SkuTier

Уровень конкретного номера SKU, например Базовый.

SkuTier

Уровень конкретного номера SKU, например Базовый.

Имя Тип Описание
Basic

string

GeneralPurpose

string

MemoryOptimized

string

SslEnforcementEnum

Включите принудительное применение ssl или нет при подключении к серверу.

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

string

Enabled

string

StorageAutogrow

Включите автоматическое увеличение хранилища.

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

string

Enabled

string

StorageProfile

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

Имя Тип Описание
backupRetentionDays

integer

Дни хранения резервных копий для сервера.

geoRedundantBackup

GeoRedundantBackup

Включите геоизбыточное или нет для резервного копирования сервера.

storageAutogrow

StorageAutogrow

Включите автоматическое увеличение хранилища.

storageMB

integer

Максимальный объем хранилища, разрешенный для сервера.