PostgreSqlFlexibleServerCollection.GetReplicasAsync Method

Definition

Namespace:

Azure.ResourceManager.PostgreSql.FlexibleServers

Assembly:

Azure.ResourceManager.PostgreSql.dll

Package:

Azure.ResourceManager.PostgreSql v1.1.3

Source:

PostgreSqlFlexibleServerCollection.cs

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: 2023-03-01-preview

public virtual Azure.AsyncPageable<Azure.ResourceManager.PostgreSql.FlexibleServers.PostgreSqlFlexibleServerResource> GetReplicasAsync (string serverName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetReplicasAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.PostgreSql.FlexibleServers.PostgreSqlFlexibleServerResource>
override this.GetReplicasAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.PostgreSql.FlexibleServers.PostgreSqlFlexibleServerResource>

Public Overridable Function GetReplicasAsync (serverName As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of PostgreSqlFlexibleServerResource)

Parameters

serverName

String

The name of the server.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

AsyncPageable<PostgreSqlFlexibleServerResource>

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

Exceptions

ArgumentException

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

ArgumentNullException

serverName is null.