Share via

az cosmosdb fleetspace account

  • Preview

Note

This reference is part of the cosmosdb-preview extension for the Azure CLI (version 2.17.1 or higher). The extension will automatically install the first time you run an az cosmosdb fleetspace account command. Learn more about extensions.

Command group 'cosmosdb fleetspace' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage database accounts within a Cosmos DB Fleetspace.

Commands

Name Description Type Status
az cosmosdb fleetspace account create

Register an existing Cosmos DB database account to a Fleetspace.

 Extension Preview
az cosmosdb fleetspace account delete

Unregister a database account from a Fleetspace.

 Extension Preview
az cosmosdb fleetspace account list

List all database accounts associated with a Fleetspace.

 Extension Preview
az cosmosdb fleetspace account show

Show details of a registered database account in a Fleetspace.

 Extension Preview

az cosmosdb fleetspace account create

Preview

Command group 'cosmosdb fleetspace account' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Register an existing Cosmos DB database account to a Fleetspace.

az cosmosdb fleetspace account create --body
                                      --fleet-name
                                      --fleetspace-account-name
                                      --fleetspace-name
                                      --resource-group

Examples

Register a database account to a fleetspace

az cosmosdb fleetspace account create \
  --resource-group MyResourceGroup \
  --fleet-name MyFleet \
  --fleetspace-name MyFleetspace \
  --fleetspace-account-name MyAccount \
  --body @fleetspaceAccount.json

Required Parameters

--body -b

Fleetspace Account body with properties.globalDatabaseAccountProperties (fields: armLocation, resourceId). You can enter it as a string or as a file, e.g., --body @fleetspaceAccount.json or --body "{ "properties": { "globalDatabaseAccountProperties": { "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-rg/providers/Microsoft.DocumentDB/databaseAccounts/example-account", "armLocation": "East US" } } }".

--fleet-name

Name of the Cosmos DB Fleet.

--fleetspace-account-name -n

Name of the Fleetspace Account resource.

--fleetspace-name

Name of the Fleetspace resource.

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az cosmosdb fleetspace account delete

Preview

Command group 'cosmosdb fleetspace account' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Unregister a database account from a Fleetspace.

az cosmosdb fleetspace account delete --fleet-name
                                      --fleetspace-account-name
                                      --fleetspace-name
                                      --resource-group
                                      [--yes]

Required Parameters

--fleet-name

Name of the Cosmos DB Fleet.

--fleetspace-account-name -n

Name of the Fleetspace Account resource.

--fleetspace-name

Name of the Fleetspace resource.

--resource-group -g

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

Optional Parameters

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az cosmosdb fleetspace account list

Preview

Command group 'cosmosdb fleetspace account' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all database accounts associated with a Fleetspace.

az cosmosdb fleetspace account list --fleet-name
                                    --fleetspace-name
                                    --resource-group

Required Parameters

--fleet-name

Name of the Cosmos DB Fleet.

--fleetspace-name

Name of the Fleetspace resource.

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az cosmosdb fleetspace account show

Preview

Command group 'cosmosdb fleetspace account' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show details of a registered database account in a Fleetspace.

az cosmosdb fleetspace account show --fleet-name
                                    --fleetspace-account-name
                                    --fleetspace-name
                                    --resource-group

Required Parameters

--fleet-name

Name of the Cosmos DB Fleet.

--fleetspace-account-name -n

Name of the Fleetspace Account resource.

--fleetspace-name

Name of the Fleetspace resource.

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.