Replicas - List By Server

Reference

Service:: PostgreSQL

API Version:: 2022-12-01

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=2022-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. Regex pattern: `^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*`
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	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

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

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

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
Backup	Backup 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; currently restricted to 'None and UserAssigned'
MaintenanceWindow	Maintenance window properties of a server.
Network	Network properties of a server.
passwordAuthEnum	If Enabled, Password authentication is enabled.
ReplicationRole	Used to indicate role of the server in replication set.
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
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.

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.

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
Update	string

DataEncryption

Data encryption properties of a server

Name	Type	Description
primaryKeyURI	string	URI for the key for data encryption for primary server.
primaryUserAssignedIdentityId	string	Resource Id for the User assigned identity to be used for data encryption for 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; currently restricted to 'None and UserAssigned'

Name	Type	Description
None	string
UserAssigned	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

ReplicationRole

Used to indicate role of the server in replication set.

Name	Type	Description
AsyncReplica	string
GeoAsyncReplica	string
None	string
Primary	string

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	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.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'.
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'. 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	The system metadata relating to this resource.
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

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
storageSizeGB	integer	Max storage allowed for a server.

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; currently restricted to 'None and UserAssigned'
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.

Share via

Replicas - List By Server

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

ReplicasListByServer

Sample request

Sample response

Definitions

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

Additional resources