az cosmosdb postgres

Manage Azure Cosmos DB for PostgreSQL resources.

Commands

Name	Description	Type	Status
az cosmosdb postgres check-name-availability	Checks availability of a cluster name. Cluster names should be globally unique; at least 3 characters and at most 40 characters long; they must only contain lowercase letters, numbers, and hyphens; and must not start or end with a hyphen.	Core	GA
az cosmosdb postgres cluster	Manage Azure Cosmos DB for PostgreSQL clusters.	Core	GA
az cosmosdb postgres cluster create	Create a new cluster with nodes.	Core	GA
az cosmosdb postgres cluster delete	Delete a cluster together with nodes in it.	Core	GA
az cosmosdb postgres cluster list	List all clusters in a subscription or a resource group.	Core	GA
az cosmosdb postgres cluster promote	Promotes read replica cluster to an independent read-write cluster.	Core	GA
az cosmosdb postgres cluster restart	Restarts all nodes in the cluster.	Core	GA
az cosmosdb postgres cluster server	Manage Azure Cosmos DB for PostgreSQL cluster servers.	Core	GA
az cosmosdb postgres cluster server list	List nodes of a cluster.	Core	GA
az cosmosdb postgres cluster server show	Get information about a node in cluster.	Core	GA
az cosmosdb postgres cluster show	Get information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time.	Core	GA
az cosmosdb postgres cluster start	Starts stopped compute on all cluster nodes.	Core	GA
az cosmosdb postgres cluster stop	Stops compute on all cluster nodes.	Core	GA
az cosmosdb postgres cluster update	Update an existing cluster. The request body can contain one or several properties from the cluster definition.	Core	GA
az cosmosdb postgres cluster wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az cosmosdb postgres configuration	Manage Azure Cosmos DB for PostgreSQL configurations.	Core	GA
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 firewall-rule	Manage Azure Cosmos DB for PostgreSQL firewall rules.	Core	GA
az cosmosdb postgres firewall-rule create	Create a new cluster firewall rule or updates an existing cluster firewall rule.	Core	GA
az cosmosdb postgres firewall-rule delete	Delete a cluster firewall rule.	Core	GA
az cosmosdb postgres firewall-rule list	List all the firewall rules on cluster.	Core	GA
az cosmosdb postgres firewall-rule show	Get information about a cluster firewall rule.	Core	GA
az cosmosdb postgres firewall-rule update	Update an existing cluster firewall rule.	Core	GA
az cosmosdb postgres firewall-rule wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az cosmosdb postgres role	Manage Azure Cosmos DB for PostgreSQL roles.	Core	GA
az cosmosdb postgres role create	Create a new role or updates an existing role.	Core	GA
az cosmosdb postgres role delete	Delete a cluster role.	Core	GA
az cosmosdb postgres role list	List all the roles in a given cluster.	Core	GA
az cosmosdb postgres role show	Get information about a cluster role.	Core	GA
az cosmosdb postgres role update	Update an existing role.	Core	GA
az cosmosdb postgres role wait	Place the CLI in a waiting state until a condition is met.	Core	GA

az cosmosdb postgres check-name-availability

Edit

Checks availability of a cluster name. Cluster names should be globally unique; at least 3 characters and at most 40 characters long; they must only contain lowercase letters, numbers, and hyphens; and must not start or end with a hyphen.

az cosmosdb postgres check-name-availability --name
                                             --type {Microsoft.DBforPostgreSQL/serverGroupsv2}

Required Parameters

--name

Cluster name to verify.

Property	Value
Parameter group:	NameAvailabilityRequest Arguments

--type

Resource type used for verification.

Property	Value
Parameter group:	NameAvailabilityRequest Arguments
Accepted values:	Microsoft.DBforPostgreSQL/serverGroupsv2

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

Share via

az cosmosdb postgres

Commands

az cosmosdb postgres check-name-availability

Required Parameters

Feedback