PostgreSqlFlexibleServerCollection.GetReplicas Method

Definition

List all the replicas for a given server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/replicas
  • Operation Id: Replicas_ListByServer
  • Default Api Version: 2024-08-01
public virtual Azure.Pageable<Azure.ResourceManager.PostgreSql.FlexibleServers.PostgreSqlFlexibleServerResource> GetReplicas (string serverName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetReplicas : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.PostgreSql.FlexibleServers.PostgreSqlFlexibleServerResource>
override this.GetReplicas : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.PostgreSql.FlexibleServers.PostgreSqlFlexibleServerResource>
Public Overridable Function GetReplicas (serverName As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of PostgreSqlFlexibleServerResource)

Parameters

serverName
String

The name of the server.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

A collection of PostgreSqlFlexibleServerResource that may take multiple service requests to iterate over.

Exceptions

serverName is an empty string, and was expected to be non-empty.

serverName is null.

Applies to