az mongo-db atlas organization

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 command. Learn more about extensions.

Manage Organization.

Commands

Name	Description	Type	Status
az mongo-db atlas organization create	Create a OrganizationResource.	Extension	GA
az mongo-db atlas organization delete	Delete a OrganizationResource.	Extension	GA
az mongo-db atlas organization list	List OrganizationResource resources by subscription ID.	Extension	GA
az mongo-db atlas organization project	Manage Project.	Extension	GA
az mongo-db atlas organization project cluster	Manage Cluster.	Extension	GA
az mongo-db atlas organization project cluster-tier-region	List available regions by cluster tier for the project.	Extension	GA
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 create	Create a Project.	Extension	GA
az mongo-db atlas organization project delete	Delete a Project.	Extension	GA
az mongo-db atlas organization project list	List Project resources by OrganizationResource.	Extension	GA
az mongo-db atlas organization project show	Get a Project.	Extension	GA
az mongo-db atlas organization project tier-limit-reached	Check if tier limit is reached for the project.	Extension	GA
az mongo-db atlas organization project update	Update a Project.	Extension	GA
az mongo-db atlas organization project wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az mongo-db atlas organization show	Get a OrganizationResource.	Extension	GA
az mongo-db atlas organization wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az mongo-db atlas organization create

Create a OrganizationResource.

az mongo-db atlas organization create --name --organization-name
                                      --resource-group
                                      [--acquire-policy-token]
                                      [--change-reference]
                                      [--location]
                                      [--marketplace]
                                      [--mi-system-assigned --system-assigned]
                                      [--mi-user-assigned --user-assigned]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--partner-properties]
                                      [--tags]
                                      [--user]

Examples

Organizations_CreateOrUpdate_MaximumSet

az mongo-db atlas organization create \ --resource-group {resource_group} \ --name MongoDBCLITestOrg2 \ --location eastus2 \ --subscription {subscription} \ --marketplace '{"subscription-id": "<marketplace_sub_id>", "offer-details": {"publisher-id": "mongodb", "offer-id": "mongodb_atlas_azure_native_prod", "plan-id": "private_plan", "plan-name": "Pay as You Go (Free) (Private)", "term-unit": "P1M", "term-id": "gmz7xq9ge3py"}}' \ --user '{"first-name": "dummy", "last-name": "dummy", "email-address": "test@example.com"}' \ --partner-properties '{"organization-name": "MongoDBCLITestOrg2"}'

Required Parameters

--name --organization-name -n

Name of the MongoDB Atlas Organization.

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

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property	Value
Parameter group:	Resource Arguments

--marketplace

Marketplace details of the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--mi-system-assigned --system-assigned

Set the system managed identity.

Property	Value
Parameter group:	Identity Arguments

--mi-user-assigned --user-assigned

Set the user managed identities Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--partner-properties

Properties for MongoDB Atlas Organization Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--tags

MongoDB Atlas Azure Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Resource Arguments

--user

Details of the user. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 delete

Delete a OrganizationResource.

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

Examples

Organizations_Delete_MaximumSet

az mongo-db atlas organization delete \ --subscription {subscription} \ --resource-group {resource_group} \ --name MongoDBCLITestOrg2 \ --yes

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

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

--name --organization-name -n

Name of the MongoDB Atlas Organization.

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

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

List OrganizationResource resources by subscription ID.

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

Examples

Organizations_ListBySubscription_MaximumSet

az mongo-db atlas organization list \ --subscription {subscription} \ --resource-group {resource_group}

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

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

Get a OrganizationResource.

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

Examples

Organizations_Get_MaximumSet

az mongo-db atlas organization show \ --subscription {subscription} \ --resource-group {resource_group} \ --name MongoDBCLITestOrg2

Optional Parameters

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

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

--name --organization-name -n

Name of the MongoDB Atlas Organization.

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 wait

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

az mongo-db atlas organization wait [--acquire-policy-token]
                                    [--change-reference]
                                    [--created]
                                    [--custom]
                                    [--deleted]
                                    [--exists]
                                    [--ids]
                                    [--interval]
                                    [--name --organization-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

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

--name --organization-name -n

Name of the MongoDB Atlas Organization.

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