ConfigurationsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CosmosdbForPostgresqlMgmtClient's

<xref:configurations> attribute.

Constructor

ConfigurationsOperations(*args, **kwargs)

Methods

begin_update_on_coordinator	Updates configuration of coordinator in a cluster.
begin_update_on_node	Updates configuration of worker nodes in a cluster.
get	Gets information of a configuration for coordinator and nodes.
get_coordinator	Gets information of a configuration for coordinator.
get_node	Gets information of a configuration for worker nodes.
list_by_cluster	List all the configurations of a cluster.
list_by_server	List all the configurations of a server in cluster.

begin_update_on_coordinator

Updates configuration of coordinator in a cluster.

begin_update_on_coordinator(resource_group_name: str, cluster_name: str, configuration_name: str, parameters: _models.ServerConfiguration, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ServerConfiguration]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cluster_name Required	str The name of the cluster. Required.
configuration_name Required	str The name of the cluster configuration. Required.
parameters Required	ServerConfiguration or IO The required parameters for updating a cluster configuration. Is either a ServerConfiguration type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[ServerConfiguration]	An instance of LROPoller that returns either ServerConfiguration or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update_on_node

Updates configuration of worker nodes in a cluster.

begin_update_on_node(resource_group_name: str, cluster_name: str, configuration_name: str, parameters: _models.ServerConfiguration, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ServerConfiguration]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cluster_name Required	str The name of the cluster. Required.
configuration_name Required	str The name of the cluster configuration. Required.
parameters Required	ServerConfiguration or IO The required parameters for updating a cluster configuration. Is either a ServerConfiguration type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[ServerConfiguration]	An instance of LROPoller that returns either ServerConfiguration or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets information of a configuration for coordinator and nodes.

get(resource_group_name: str, cluster_name: str, configuration_name: str, **kwargs: Any) -> Configuration

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cluster_name Required	str The name of the cluster. Required.
configuration_name Required	str The name of the cluster configuration. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
Configuration	Configuration or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_coordinator

Gets information of a configuration for coordinator.

get_coordinator(resource_group_name: str, cluster_name: str, configuration_name: str, **kwargs: Any) -> ServerConfiguration

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cluster_name Required	str The name of the cluster. Required.
configuration_name Required	str The name of the cluster configuration. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ServerConfiguration	ServerConfiguration or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_node

Gets information of a configuration for worker nodes.

get_node(resource_group_name: str, cluster_name: str, configuration_name: str, **kwargs: Any) -> ServerConfiguration

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cluster_name Required	str The name of the cluster. Required.
configuration_name Required	str The name of the cluster configuration. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ServerConfiguration	ServerConfiguration or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_cluster

List all the configurations of a cluster.

list_by_cluster(resource_group_name: str, cluster_name: str, **kwargs: Any) -> Iterable[Configuration]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cluster_name Required	str The name of the cluster. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[Configuration]	An iterator like instance of either Configuration or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_server

List all the configurations of a server in cluster.

list_by_server(resource_group_name: str, cluster_name: str, server_name: str, **kwargs: Any) -> Iterable[ServerConfiguration]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cluster_name Required	str The name of the cluster. Required.
server_name Required	str The name of the server. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[ServerConfiguration]	An iterator like instance of either ServerConfiguration or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.cosmosdbforpostgresql.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv102\\Lib\\site-packages\\azure\\mgmt\\cosmosdbforpostgresql\\models\\__init__.py'>