Share via

Servers interface

  • Reference
Package:
@azure/arm-cosmosdbforpostgresql

Interface representing a Servers.

Methods

get(string, string, string, ServersGetOptionalParams)

Gets information about a server in cluster.
listByCluster(string, string, ServersListByClusterOptionalParams)

Lists servers of a cluster.

Method Details

get(string, string, string, ServersGetOptionalParams)

Gets information about a server in cluster.

function get(resourceGroupName: string, clusterName: string, serverName: string, options?: ServersGetOptionalParams): Promise<ClusterServer>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

serverName

string

The name of the server.

options
ServersGetOptionalParams

The options parameters.

Returns

Promise<ClusterServer>

listByCluster(string, string, ServersListByClusterOptionalParams)

Lists servers of a cluster.

function listByCluster(resourceGroupName: string, clusterName: string, options?: ServersListByClusterOptionalParams): PagedAsyncIterableIterator<ClusterServer, ClusterServer[], PageSettings>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

options
ServersListByClusterOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ClusterServer, ClusterServer[], PageSettings>