Configurations interface

Package:

@azure/arm-cosmosdbforpostgresql

Interface representing a Configurations.

Methods

beginUpdateOnCoordinator(string, string, string, ServerConfiguration, ConfigurationsUpdateOnCoordinatorOptionalParams)	Updates configuration of coordinator in a cluster
beginUpdateOnCoordinatorAndWait(string, string, string, ServerConfiguration, ConfigurationsUpdateOnCoordinatorOptionalParams)	Updates configuration of coordinator in a cluster
beginUpdateOnNode(string, string, string, ServerConfiguration, ConfigurationsUpdateOnNodeOptionalParams)	Updates configuration of worker nodes in a cluster
beginUpdateOnNodeAndWait(string, string, string, ServerConfiguration, ConfigurationsUpdateOnNodeOptionalParams)	Updates configuration of worker nodes in a cluster
get(string, string, string, ConfigurationsGetOptionalParams)	Gets information of a configuration for coordinator and nodes.
getCoordinator(string, string, string, ConfigurationsGetCoordinatorOptionalParams)	Gets information of a configuration for coordinator.
getNode(string, string, string, ConfigurationsGetNodeOptionalParams)	Gets information of a configuration for worker nodes.
listByCluster(string, string, ConfigurationsListByClusterOptionalParams)	List all the configurations of a cluster.
listByServer(string, string, string, ConfigurationsListByServerOptionalParams)	List all the configurations of a server in cluster.

Method Details

beginUpdateOnCoordinator(string, string, string, ServerConfiguration, ConfigurationsUpdateOnCoordinatorOptionalParams)

Updates configuration of coordinator in a cluster

function beginUpdateOnCoordinator(resourceGroupName: string, clusterName: string, configurationName: string, parameters: ServerConfiguration, options?: ConfigurationsUpdateOnCoordinatorOptionalParams): Promise<SimplePollerLike<OperationState<ServerConfiguration>, ServerConfiguration>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

configurationName

string

The name of the cluster configuration.

parameters

ServerConfiguration

The required parameters for updating a cluster configuration.

options

ConfigurationsUpdateOnCoordinatorOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ServerConfiguration>, ServerConfiguration>>

beginUpdateOnCoordinatorAndWait(string, string, string, ServerConfiguration, ConfigurationsUpdateOnCoordinatorOptionalParams)

Updates configuration of coordinator in a cluster

function beginUpdateOnCoordinatorAndWait(resourceGroupName: string, clusterName: string, configurationName: string, parameters: ServerConfiguration, options?: ConfigurationsUpdateOnCoordinatorOptionalParams): Promise<ServerConfiguration>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

configurationName

string

The name of the cluster configuration.

parameters

ServerConfiguration

The required parameters for updating a cluster configuration.

options

ConfigurationsUpdateOnCoordinatorOptionalParams

The options parameters.

Returns

Promise<ServerConfiguration>

beginUpdateOnNode(string, string, string, ServerConfiguration, ConfigurationsUpdateOnNodeOptionalParams)

Updates configuration of worker nodes in a cluster

function beginUpdateOnNode(resourceGroupName: string, clusterName: string, configurationName: string, parameters: ServerConfiguration, options?: ConfigurationsUpdateOnNodeOptionalParams): Promise<SimplePollerLike<OperationState<ServerConfiguration>, ServerConfiguration>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

configurationName

string

The name of the cluster configuration.

parameters

ServerConfiguration

The required parameters for updating a cluster configuration.

options

ConfigurationsUpdateOnNodeOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ServerConfiguration>, ServerConfiguration>>

beginUpdateOnNodeAndWait(string, string, string, ServerConfiguration, ConfigurationsUpdateOnNodeOptionalParams)

Updates configuration of worker nodes in a cluster

function beginUpdateOnNodeAndWait(resourceGroupName: string, clusterName: string, configurationName: string, parameters: ServerConfiguration, options?: ConfigurationsUpdateOnNodeOptionalParams): Promise<ServerConfiguration>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

configurationName

string

The name of the cluster configuration.

parameters

ServerConfiguration

The required parameters for updating a cluster configuration.

options

ConfigurationsUpdateOnNodeOptionalParams

The options parameters.

Returns

Promise<ServerConfiguration>

get(string, string, string, ConfigurationsGetOptionalParams)

Gets information of a configuration for coordinator and nodes.

function get(resourceGroupName: string, clusterName: string, configurationName: string, options?: ConfigurationsGetOptionalParams): Promise<Configuration>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

configurationName

string

The name of the cluster configuration.

options

ConfigurationsGetOptionalParams

The options parameters.

Returns

Promise<Configuration>

getCoordinator(string, string, string, ConfigurationsGetCoordinatorOptionalParams)

Gets information of a configuration for coordinator.

function getCoordinator(resourceGroupName: string, clusterName: string, configurationName: string, options?: ConfigurationsGetCoordinatorOptionalParams): Promise<ServerConfiguration>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

configurationName

string

The name of the cluster configuration.

options

ConfigurationsGetCoordinatorOptionalParams

The options parameters.

Returns

Promise<ServerConfiguration>

getNode(string, string, string, ConfigurationsGetNodeOptionalParams)

Gets information of a configuration for worker nodes.

function getNode(resourceGroupName: string, clusterName: string, configurationName: string, options?: ConfigurationsGetNodeOptionalParams): Promise<ServerConfiguration>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

configurationName

string

The name of the cluster configuration.

options

ConfigurationsGetNodeOptionalParams

The options parameters.

Returns

Promise<ServerConfiguration>

listByCluster(string, string, ConfigurationsListByClusterOptionalParams)

List all the configurations of a cluster.

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

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

options

ConfigurationsListByClusterOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Configuration, Configuration[], PageSettings>

listByServer(string, string, string, ConfigurationsListByServerOptionalParams)

List all the configurations of a server in cluster.

function listByServer(resourceGroupName: string, clusterName: string, serverName: string, options?: ConfigurationsListByServerOptionalParams): PagedAsyncIterableIterator<ServerConfiguration, ServerConfiguration[], PageSettings>

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

ConfigurationsListByServerOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ServerConfiguration, ServerConfiguration[], PageSettings>