Share via

az cosmosdb postgres configuration

Manage Azure Cosmos DB for PostgreSQL configurations.

Commands

Name Description Type Status
az cosmosdb postgres configuration coordinator

Manage Azure Cosmos DB for PostgreSQL coordinator configurations.

 Core GA
az cosmosdb postgres configuration coordinator show

Get information of a configuration for coordinator.

 Core GA
az cosmosdb postgres configuration coordinator update

Updates configuration of coordinator in a cluster.

 Core GA
az cosmosdb postgres configuration coordinator wait

Place the CLI in a waiting state until a condition is met.

 Core GA
az cosmosdb postgres configuration list

List all the configurations of a cluster.

 Core GA
az cosmosdb postgres configuration node

Manage Azure Cosmos DB for PostgreSQL node configurations.

 Core GA
az cosmosdb postgres configuration node show

Get information of a configuration for worker nodes.

 Core GA
az cosmosdb postgres configuration node update

Updates configuration of worker nodes in a cluster.

 Core GA
az cosmosdb postgres configuration node wait

Place the CLI in a waiting state until a condition is met.

 Core GA
az cosmosdb postgres configuration server

Manage Azure Cosmos DB for PostgreSQL server configurations.

 Core GA
az cosmosdb postgres configuration server list

List all the configurations of a server in cluster.

 Core GA
az cosmosdb postgres configuration show

Get information of a configuration for coordinator and nodes.

 Core GA

az cosmosdb postgres configuration list

Edit

List all the configurations of a cluster.

az cosmosdb postgres configuration list --cluster-name
                                        --resource-group

Examples

List configurations of the cluster

az cosmosdb postgres configuration list --cluster-name "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff"

Required Parameters

--cluster-name

The name of the cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az cosmosdb postgres configuration show

Edit

Get information of a configuration for coordinator and nodes.

az cosmosdb postgres configuration show [--cluster-name]
                                        [--configuration-name --name]
                                        [--ids]
                                        [--resource-group]
                                        [--subscription]

Examples

Get configuration details

az cosmosdb postgres configuration show -n "array-nulls" --cluster-name "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name

The name of the cluster.

Property Value
Parameter group: Resource Id Arguments
--configuration-name --name -n

The name of the cluster configuration.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False