Replicas - List By Server

Service:

PostgreSQL

API Version:

2024-11-01-preview

List all the replicas for a given server.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/replicas?api-version=2024-11-01-preview

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. Regex pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ServerListResult	OK
Other Status Codes	ErrorResponse	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

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

Sample response

Status code:

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

Definitions

Name	Description
activeDirectoryAuthEnum	If Enabled, Azure Active Directory authentication is enabled.
ArmServerKeyType	Data encryption type to depict if it is System Managed vs Azure Key vault.
AuthConfig	Authentication configuration properties of a server
AzureManagedDiskPerformanceTiers	Name of storage tier for IOPS.
Backup	Backup properties of a server
Cluster	Cluster properties of a server.
createdByType	The type of identity that created the resource.
CreateMode	The mode to create a new PostgreSQL server.
DataEncryption	Data encryption properties of a server
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
GeoRedundantBackupEnum	A value indicating whether Geo-Redundant backup is enabled on the server.
HighAvailability	High availability properties of a server
HighAvailabilityMode	The HA mode for the server.
IdentityType	the types of identities associated with this resource
keyStatusEnum	Primary encryption key status for Data encryption enabled server.
MaintenanceWindow	Maintenance window properties of a server.
Network	Network properties of a server.
passwordAuthEnum	If Enabled, Password authentication is enabled.
PrivateEndpoint	The private endpoint resource.
PrivateEndpointConnection	The private endpoint connection resource.
PrivateEndpointConnectionProvisioningState	The current provisioning state.
PrivateEndpointServiceConnectionStatus	The private endpoint connection status.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
ReadReplicaPromoteMode	Sets the promote mode for a replica server. This is a write only property.
Replica	Replica properties of a server
ReplicationPromoteOption	Sets the promote options for a replica server. This is a write only property.
ReplicationRole	Used to indicate role of the server in replication set.
ReplicationState	Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring
Server	Represents a server.
ServerHAState	A state of a HA server that is visible to user.
ServerListResult	A list of servers.
ServerPublicNetworkAccessState	public network access is enabled or not
ServerState	A state of a server that is visible to user.
ServerVersion	The version of a server.
Sku	Sku information related properties of a server.
SkuTier	The tier of the particular SKU, e.g. Burstable.
Storage	Storage properties of a server
StorageAutoGrow	Flag to enable / disable Storage Auto grow for flexible server.
StorageType	Storage type for the server. Allowed values are Premium_LRS, PremiumV2_LRS, and UltraSSD_LRS. Default is Premium_LRS if not specified
systemData	Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentity	Information describing the identities associated with this application.
UserIdentity	Describes a single user-assigned identity associated with the application.

activeDirectoryAuthEnum

If Enabled, Azure Active Directory authentication is enabled.

Name	Type	Description
Disabled	string
Enabled	string

ArmServerKeyType

Data encryption type to depict if it is System Managed vs Azure Key vault.

Name	Type	Description
AzureKeyVault	string
SystemManaged	string

AuthConfig

Authentication configuration properties of a server

Name	Type	Default value	Description
activeDirectoryAuth	activeDirectoryAuthEnum		If Enabled, Azure Active Directory authentication is enabled.
passwordAuth	passwordAuthEnum	Enabled	If Enabled, Password authentication is enabled.
tenantId	string		Tenant id of the server.

AzureManagedDiskPerformanceTiers

Name of storage tier for IOPS.

Name	Type	Description
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

Backup properties of a server

Name	Type	Default value	Description
backupRetentionDays	integer	7	Backup retention days for the server.
earliestRestoreDate	string		The earliest restore point time (ISO8601 format) for server.
geoRedundantBackup	GeoRedundantBackupEnum	Disabled	A value indicating whether Geo-Redundant backup is enabled on the server.

Cluster

Cluster properties of a server.

Name	Type	Default value	Description
clusterSize	integer	0	The node count for the cluster.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

The mode to create a new PostgreSQL server.

Name	Type	Description
Create	string
Default	string
GeoRestore	string
PointInTimeRestore	string
Replica	string
ReviveDropped	string
Update	string

DataEncryption

Data encryption properties of a server

Name	Type	Description
geoBackupEncryptionKeyStatus	keyStatusEnum	Geo-backup encryption key status for Data encryption enabled server.
geoBackupKeyURI	string	URI for the key in keyvault for data encryption for geo-backup of server.
geoBackupUserAssignedIdentityId	string	Resource Id for the User assigned identity to be used for data encryption for geo-backup of server.
primaryEncryptionKeyStatus	keyStatusEnum	Primary encryption key status for Data encryption enabled server.
primaryKeyURI	string	URI for the key in keyvault for data encryption of the primary server.
primaryUserAssignedIdentityId	string	Resource Id for the User assigned identity to be used for data encryption of the primary server.
type	ArmServerKeyType	Data encryption type to depict if it is System Managed vs Azure Key vault.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

GeoRedundantBackupEnum

A value indicating whether Geo-Redundant backup is enabled on the server.

Name	Type	Description
Disabled	string
Enabled	string

HighAvailability

High availability properties of a server

Name	Type	Default value	Description
mode	HighAvailabilityMode	Disabled	The HA mode for the server.
standbyAvailabilityZone	string		availability zone information of the standby.
state	ServerHAState		A state of a HA server that is visible to user.

HighAvailabilityMode

The HA mode for the server.

Name	Type	Description
Disabled	string
SameZone	string
ZoneRedundant	string

IdentityType

the types of identities associated with this resource

Name	Type	Description
None	string
SystemAssigned	string
UserAssigned	string

keyStatusEnum

Primary encryption key status for Data encryption enabled server.

Name	Type	Description
Invalid	string
Valid	string

MaintenanceWindow

Maintenance window properties of a server.

Name	Type	Default value	Description
customWindow	string	Disabled	indicates whether custom window is enabled or disabled
dayOfWeek	integer	0	day of week for maintenance window
startHour	integer	0	start hour for maintenance window
startMinute	integer	0	start minute for maintenance window

Network

Network properties of a server.

Name	Type	Description
delegatedSubnetResourceId	string	Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone.
privateDnsZoneArmResourceId	string	Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone.
publicNetworkAccess	ServerPublicNetworkAccessState	public network access is enabled or not

passwordAuthEnum

If Enabled, Password authentication is enabled.

Name	Type	Description
Disabled	string
Enabled	string

PrivateEndpoint

The private endpoint resource.

Name	Type	Description
id	string	The ARM identifier for private endpoint.

PrivateEndpointConnection

The private endpoint connection resource.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.groupIds	string[]	The group ids for the private endpoint resource.
properties.privateEndpoint	PrivateEndpoint	The private endpoint resource.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	The provisioning state of the private endpoint connection resource.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

The current provisioning state.

Name	Type	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.

Name	Type	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

Name	Type	Description
actionsRequired	string	A message indicating if changes on the service provider require any updates on the consumer.
description	string	The reason for approval/rejection of the connection.
status	PrivateEndpointServiceConnectionStatus	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

ReadReplicaPromoteMode

Sets the promote mode for a replica server. This is a write only property.

Name	Type	Description
standalone	string
switchover	string

Replica

Replica properties of a server

Name	Type	Description
capacity	integer	Replicas allowed for a server.
promoteMode	ReadReplicaPromoteMode	Sets the promote mode for a replica server. This is a write only property.
promoteOption	ReplicationPromoteOption	Sets the promote options for a replica server. This is a write only property.
replicationState	ReplicationState	Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring
role	ReplicationRole	Used to indicate role of the server in replication set.

ReplicationPromoteOption

Sets the promote options for a replica server. This is a write only property.

Name	Type	Description
forced	string
planned	string

ReplicationRole

Used to indicate role of the server in replication set.

Name	Type	Description
AsyncReplica	string
GeoAsyncReplica	string
None	string
Primary	string

ReplicationState

Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring

Name	Type	Description
Active	string
Broken	string
Catchup	string
Provisioning	string
Reconfiguring	string
Updating	string

Server

Represents a server.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	UserAssignedIdentity	Describes the identity of the application.
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.administratorLoginPassword	string	The administrator login password (required for server creation).
properties.authConfig	AuthConfig	AuthConfig properties of a server.
properties.availabilityZone	string	availability zone information of the server.
properties.backup	Backup	Backup properties of a server.
properties.cluster	Cluster	Cluster properties of a server.
properties.createMode	CreateMode	The mode to create a new PostgreSQL server.
properties.dataEncryption	DataEncryption	Data encryption properties of a server.
properties.fullyQualifiedDomainName	string	The fully qualified domain name of a server.
properties.highAvailability	HighAvailability	High availability properties of a server.
properties.maintenanceWindow	MaintenanceWindow	Maintenance window properties of a server.
properties.minorVersion	string	The minor version of the server.
properties.network	Network	Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server.
properties.pointInTimeUTC	string	Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'ReviveDropped'.
properties.privateEndpointConnections	PrivateEndpointConnection[]	List of private endpoint connections associated with the specified resource.
properties.replica	Replica	Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server.
properties.replicaCapacity	integer	Replicas allowed for a server.
properties.replicationRole	ReplicationRole	Replication role of the server
properties.sourceServerResourceId	string	The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server
properties.state	ServerState	A state of a server that is visible to user.
properties.storage	Storage	Storage properties of a server.
properties.version	ServerVersion	PostgreSQL Server version.
sku	Sku	The SKU (pricing tier) of the server.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ServerHAState

A state of a HA server that is visible to user.

Name	Type	Description
CreatingStandby	string
FailingOver	string
Healthy	string
NotEnabled	string
RemovingStandby	string
ReplicatingData	string

ServerListResult

A list of servers.

Name	Type	Description
nextLink	string	The link used to get the next page of operations.
value	Server[]	The list of flexible servers

ServerPublicNetworkAccessState

public network access is enabled or not

Name	Type	Description
Disabled	string
Enabled	string

ServerState

A state of a server that is visible to user.

Name	Type	Description
Disabled	string
Dropping	string
Ready	string
Starting	string
Stopped	string
Stopping	string
Updating	string

ServerVersion

The version of a server.

Name	Type	Description
11	string
12	string
13	string
14	string
15	string
16	string
17	string

Sku

Sku information related properties of a server.

Name	Type	Description
name	string	The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3.
tier	SkuTier	The tier of the particular SKU, e.g. Burstable.

SkuTier

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

Name	Type	Description
Burstable	string
GeneralPurpose	string
MemoryOptimized	string

Storage

Storage properties of a server

Name	Type	Description
autoGrow	StorageAutoGrow	Flag to enable / disable Storage Auto grow for flexible server.
iops	integer	Storage tier IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS.
storageSizeGB	integer	Max storage allowed for a server.
throughput	integer	Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS.
tier	AzureManagedDiskPerformanceTiers	Name of storage tier for IOPS.
type	StorageType	Storage type for the server. Allowed values are Premium_LRS, PremiumV2_LRS, and UltraSSD_LRS. Default is Premium_LRS if not specified

StorageAutoGrow

Flag to enable / disable Storage Auto grow for flexible server.

Name	Type	Description
Disabled	string
Enabled	string

StorageType

Storage type for the server. Allowed values are Premium_LRS, PremiumV2_LRS, and UltraSSD_LRS. Default is Premium_LRS if not specified

Name	Type	Description
PremiumV2_LRS	string
Premium_LRS	string
UltraSSD_LRS	string

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserAssignedIdentity

Information describing the identities associated with this application.

Name	Type	Description
tenantId	string	Tenant id of the server.
type	IdentityType	the types of identities associated with this resource
userAssignedIdentities	<string,  UserIdentity>	represents user assigned identities map.

UserIdentity

Describes a single user-assigned identity associated with the application.

Name	Type	Description
clientId	string	the client identifier of the Service Principal which this identity represents.
principalId	string	the object identifier of the Service Principal which this identity represents.