az mongo-db atlas organization project cluster

Note

This reference is part of the mongo-db extension for the Azure CLI (version 2.70.0 or higher). The extension will automatically install the first time you run an az mongo-db atlas organization project cluster command. Learn more about extensions.

Manage Cluster.

Commands

Name	Description	Type	Status
az mongo-db atlas organization project cluster create	Create a Cluster.	Extension	GA
az mongo-db atlas organization project cluster delete	Delete a Cluster.	Extension	GA
az mongo-db atlas organization project cluster list	List Cluster resources by Project.	Extension	GA
az mongo-db atlas organization project cluster show	Get a Cluster.	Extension	GA
az mongo-db atlas organization project cluster update	Update a Cluster.	Extension	GA
az mongo-db atlas organization project cluster wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az mongo-db atlas organization project cluster create

Create a Cluster.

az mongo-db atlas organization project cluster create --cluster-name --name
                                                      --organization-name
                                                      --project-name
                                                      --resource-group
                                                      [--acquire-policy-token]
                                                      [--change-reference]
                                                      [--cluster-tier {FLEX, FREE, M10, M30}]
                                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--region-name]

Examples

Clusters_CreateOrUpdate_MaximumSet

az mongo-db atlas organization project cluster create --resource-group rgopenapi --organization-name myOrganization --project-name myProject --cluster-name myCluster --cluster-tier FREE --region-name eastus2

Required Parameters

--cluster-name --name -n

Name of the MongoDB Atlas Cluster resource.

--organization-name

Name of the Organization resource.

--project-name

Name of the MongoDB Atlas Project resource.

--resource-group -g

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

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--cluster-tier

Cluster tier (FREE, FLEX, M10, M30).

Property	Value
Parameter group:	Properties Arguments
Accepted values:	FLEX, FREE, M10, M30

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--region-name

Azure region where the cluster is deployed.

Property	Value
Parameter group:	Properties 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.

--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 mongo-db atlas organization project cluster delete

Delete a Cluster.

az mongo-db atlas organization project cluster delete [--acquire-policy-token]
                                                      [--change-reference]
                                                      [--cluster-name --name]
                                                      [--ids]
                                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--organization-name]
                                                      [--project-name]
                                                      [--resource-group]
                                                      [--subscription]
                                                      [--yes]

Examples

Clusters_Delete_MaximumSet

az mongo-db atlas organization project cluster delete --resource-group rgopenapi --organization-name myOrganization --project-name myProject --cluster-name myCluster

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--cluster-name --name -n

Name of the MongoDB Atlas Cluster resource.

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

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--organization-name

Name of the Organization resource.

Property	Value
Parameter group:	Resource Id Arguments

--project-name

Name of the MongoDB Atlas Project resource.

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

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

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

az mongo-db atlas organization project cluster list

List Cluster resources by Project.

az mongo-db atlas organization project cluster list --organization-name
                                                    --project-name
                                                    --resource-group
                                                    [--max-items]
                                                    [--next-token]

Examples

Clusters_List_MaximumSet

az mongo-db atlas organization project cluster list --resource-group rgopenapi --organization-name myOrganization --project-name myProject

Required Parameters

--organization-name

Name of the Organization resource.

--project-name

Name of the MongoDB Atlas Project resource.

--resource-group -g

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

Optional Parameters

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

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination 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.

--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 mongo-db atlas organization project cluster show

Get a Cluster.

az mongo-db atlas organization project cluster show [--cluster-name --name]
                                                    [--ids]
                                                    [--organization-name]
                                                    [--project-name]
                                                    [--resource-group]
                                                    [--subscription]

Examples

Clusters_Get_MaximumSet

az mongo-db atlas organization project cluster show --resource-group rgopenapi --organization-name myOrganization --project-name myProject --cluster-name myCluster

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 --name -n

Name of the MongoDB Atlas Cluster resource.

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

--organization-name

Name of the Organization resource.

Property	Value
Parameter group:	Resource Id Arguments

--project-name

Name of the MongoDB Atlas Project resource.

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

az mongo-db atlas organization project cluster update

Update a Cluster.

az mongo-db atlas organization project cluster update [--acquire-policy-token]
                                                      [--add]
                                                      [--change-reference]
                                                      [--cluster-name --name]
                                                      [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--ids]
                                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--organization-name]
                                                      [--project-name]
                                                      [--remove]
                                                      [--resource-group]
                                                      [--set]
                                                      [--subscription]

Examples

Clusters_CreateOrUpdate_MaximumSet

az mongo-db atlas organization project cluster update --resource-group rgopenapi --organization-name myOrganization --project-name myProject --cluster-name myCluster

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--cluster-name --name -n

Name of the MongoDB Atlas Cluster resource.

Property	Value
Parameter group:	Resource Id Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--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

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--organization-name

Name of the Organization resource.

Property	Value
Parameter group:	Resource Id Arguments

--project-name

Name of the MongoDB Atlas Project resource.

Property	Value
Parameter group:	Resource Id Arguments

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update 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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update 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

az mongo-db atlas organization project cluster wait

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

az mongo-db atlas organization project cluster wait [--acquire-policy-token]
                                                    [--change-reference]
                                                    [--cluster-name --name]
                                                    [--created]
                                                    [--custom]
                                                    [--deleted]
                                                    [--exists]
                                                    [--ids]
                                                    [--interval]
                                                    [--organization-name]
                                                    [--project-name]
                                                    [--resource-group]
                                                    [--subscription]
                                                    [--timeout]
                                                    [--updated]

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--cluster-name --name -n

Name of the MongoDB Atlas Cluster resource.

Property	Value
Parameter group:	Resource Id Arguments

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--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

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--organization-name

Name of the Organization resource.

Property	Value
Parameter group:	Resource Id Arguments

--project-name

Name of the MongoDB Atlas Project resource.

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

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

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