Replicas - List By Server

List all the replicas for a given server.

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

URI Parameters

Name In Required Type Description
resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

serverName
path True

string

The name of the server.

subscriptionId
path True

string

The ID of the target subscription.

api-version
query True

string

The API version to use for this operation.

Responses

Name Type Description
200 OK

ServerListResult

OK

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ReplicasListByServer

Sample request

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

Sample response

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

Definitions

Name Description
CloudError

An error response from the Batch service.

ErrorAdditionalInfo

The resource management error additional info.

ErrorResponse

Error Response

GeoRedundantBackup

Enable Geo-redundant or not for server backup.

IdentityType

The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.

InfrastructureEncryption

Add a second layer of encryption for your data using new encryption algorithm which gives additional data protection. Value is optional but if passed in, must be 'Disabled' or 'Enabled'.

MinimalTlsVersionEnum

Enforce a minimal Tls version for the server.

PrivateEndpointProperty
PrivateEndpointProvisioningState

State of the private endpoint connection.

PrivateLinkServiceConnectionStateActionsRequire

The actions required for private link service connection.

PrivateLinkServiceConnectionStateStatus

The private link service connection status.

PublicNetworkAccessEnum

Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'

ResourceIdentity

Azure Active Directory identity configuration for a resource.

Server

Represents a server.

ServerListResult

A list of servers.

ServerPrivateEndpointConnection

A private endpoint connection under a server

ServerPrivateEndpointConnectionProperties

Properties of a private endpoint connection.

ServerPrivateLinkServiceConnectionStateProperty
ServerState

A state of a server that is visible to user.

ServerVersion

The version of a server.

Sku

Billing information related properties of a server.

SkuTier

The tier of the particular SKU, e.g. Basic.

SslEnforcementEnum

Enable ssl enforcement or not when connect to server.

StorageAutogrow

Enable Storage Auto Grow.

StorageProfile

Storage Profile properties of a server

CloudError

An error response from the Batch service.

Name Type Description
error

ErrorResponse

Error Response
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorResponse

Error Response

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorResponse[]

The error details.

message

string

The error message.

target

string

The error target.

GeoRedundantBackup

Enable Geo-redundant or not for server backup.

Name Type Description
Disabled

string

Enabled

string

IdentityType

The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.

Name Type Description
SystemAssigned

string

InfrastructureEncryption

Add a second layer of encryption for your data using new encryption algorithm which gives additional data protection. Value is optional but if passed in, must be 'Disabled' or 'Enabled'.

Name Type Description
Disabled

string

Additional (2nd) layer of encryption for data at rest

Enabled

string

Default value for single layer of encryption for data at rest.

MinimalTlsVersionEnum

Enforce a minimal Tls version for the server.

Name Type Description
TLS1_0

string

TLS1_1

string

TLS1_2

string

TLSEnforcementDisabled

string

PrivateEndpointProperty

Name Type Description
id

string

Resource id of the private endpoint.

PrivateEndpointProvisioningState

State of the private endpoint connection.

Name Type Description
Approving

string

Dropping

string

Failed

string

Ready

string

Rejecting

string

PrivateLinkServiceConnectionStateActionsRequire

The actions required for private link service connection.

Name Type Description
None

string

PrivateLinkServiceConnectionStateStatus

The private link service connection status.

Name Type Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

PublicNetworkAccessEnum

Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'

Name Type Description
Disabled

string

Enabled

string

ResourceIdentity

Azure Active Directory identity configuration for a resource.

Name Type Description
principalId

string

The Azure Active Directory principal id.

tenantId

string

The Azure Active Directory tenant id.

type

IdentityType

The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.

Server

Represents a server.

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

ResourceIdentity

The Azure Active Directory identity of the server.

location

string

The geo-location where the resource lives

name

string

The name of the resource

properties.administratorLogin

string

The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).

properties.byokEnforcement

string

Status showing whether the server data encryption is enabled with customer-managed keys.

properties.earliestRestoreDate

string

Earliest restore point creation time (ISO8601 format)

properties.fullyQualifiedDomainName

string

The fully qualified domain name of a server.

properties.infrastructureEncryption

InfrastructureEncryption

Status showing whether the server enabled infrastructure encryption.

properties.masterServerId

string

The master server id of a replica server.

properties.minimalTlsVersion

MinimalTlsVersionEnum

Enforce a minimal Tls version for the server.

properties.privateEndpointConnections

ServerPrivateEndpointConnection[]

List of private endpoint connections on a server

properties.publicNetworkAccess

PublicNetworkAccessEnum

Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'

properties.replicaCapacity

integer

The maximum number of replicas that a master server can have.

properties.replicationRole

string

The replication role of the server.

properties.sslEnforcement

SslEnforcementEnum

Enable ssl enforcement or not when connect to server.

properties.storageProfile

StorageProfile

Storage profile of a server.

properties.userVisibleState

ServerState

A state of a server that is visible to user.

properties.version

ServerVersion

Server version.

sku

Sku

The SKU (pricing tier) of the server.

tags

object

Resource tags.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ServerListResult

A list of servers.

Name Type Description
value

Server[]

The list of servers

ServerPrivateEndpointConnection

A private endpoint connection under a server

Name Type Description
id

string

Resource ID of the Private Endpoint Connection.

properties

ServerPrivateEndpointConnectionProperties

Private endpoint connection properties

ServerPrivateEndpointConnectionProperties

Properties of a private endpoint connection.

Name Type Description
privateEndpoint

PrivateEndpointProperty

Private endpoint which the connection belongs to.

privateLinkServiceConnectionState

ServerPrivateLinkServiceConnectionStateProperty

Connection state of the private endpoint connection.

provisioningState

PrivateEndpointProvisioningState

State of the private endpoint connection.

ServerPrivateLinkServiceConnectionStateProperty

Name Type Description
actionsRequired

PrivateLinkServiceConnectionStateActionsRequire

The actions required for private link service connection.

description

string

The private link service connection description.

status

PrivateLinkServiceConnectionStateStatus

The private link service connection status.

ServerState

A state of a server that is visible to user.

Name Type Description
Disabled

string

Dropping

string

Inaccessible

string

Ready

string

ServerVersion

The version of a server.

Name Type Description
10

string

10.0

string

10.2

string

11

string

9.5

string

9.6

string

Sku

Billing information related properties of a server.

Name Type Description
capacity

integer

The scale up/out capacity, representing server's compute units.

family

string

The family of hardware.

name

string

The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8.

size

string

The size code, to be interpreted by resource as appropriate.

tier

SkuTier

The tier of the particular SKU, e.g. Basic.

SkuTier

The tier of the particular SKU, e.g. Basic.

Name Type Description
Basic

string

GeneralPurpose

string

MemoryOptimized

string

SslEnforcementEnum

Enable ssl enforcement or not when connect to server.

Name Type Description
Disabled

string

Enabled

string

StorageAutogrow

Enable Storage Auto Grow.

Name Type Description
Disabled

string

Enabled

string

StorageProfile

Storage Profile properties of a server

Name Type Description
backupRetentionDays

integer

Backup retention days for the server.

geoRedundantBackup

GeoRedundantBackup

Enable Geo-redundant or not for server backup.

storageAutogrow

StorageAutogrow

Enable Storage Auto Grow.

storageMB

integer

Max storage allowed for a server.