Share via

az cosmosdb fleetspace

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

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Cosmos DB Fleetspace resources.

Commands

Name Description Type Status
az cosmosdb fleetspace account

Manage database accounts within a Cosmos DB Fleetspace.

 Extension Preview
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 create

Create a new Fleetspace under a Cosmos DB Fleet.

 Extension Preview
az cosmosdb fleetspace delete

Delete a Fleetspace from a Fleet.

 Extension Preview
az cosmosdb fleetspace list

List all Fleetspaces under a Fleet.

 Extension Preview
az cosmosdb fleetspace show

Show details of a specific Fleetspace.

 Extension Preview
az cosmosdb fleetspace update

Update an existing Cosmos DB Fleetspace.

 Extension Preview

az cosmosdb fleetspace create

Preview

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

Create a new Fleetspace under a Cosmos DB Fleet.

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

Examples

Create a fleetspace

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

Required Parameters

--body -b

Fleetspace body with properties.throughputPoolConfiguration (fields: minThroughput, maxThroughput, serviceTier, dataRegions). You can enter it as a string or as a file, e.g., --body @fleetspace.json or --body "{ "properties": { "throughputPoolConfiguration": { "minThroughput": 100000, "maxThroughput": 300000, "serviceTier": "GeneralPurpose", "dataRegions": ["West US 2"] }, } }".

--fleet-name

Name of the Cosmos DB Fleet.

--fleetspace-name -n

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 delete

Preview

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

Delete a Fleetspace from a Fleet.

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

Required Parameters

--fleet-name

Name of the Cosmos DB Fleet.

--fleetspace-name -n

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 list

Preview

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

List all Fleetspaces under a Fleet.

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

Required Parameters

--fleet-name

Name of the Cosmos DB Fleet.

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

Preview

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

Show details of a specific Fleetspace.

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

Required Parameters

--fleet-name

Name of the Cosmos DB Fleet.

--fleetspace-name -n

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 update

Preview

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

Update an existing Cosmos DB Fleetspace.

az cosmosdb fleetspace update --body
                              --fleet-name
                              --fleetspace-name
                              --resource-group

Examples

Update fleetspace throughput settings

az cosmosdb fleetspace update \
  --resource-group MyResourceGroup \
  --fleet-name MyFleet \
  --fleetspace-name MyFleetspace \
  --body @fleetspace.json

Required Parameters

--body -b

Fleetspace body with properties.throughputPoolConfiguration (fields: minThroughput, maxThroughput, serviceTier, dataRegions). You can enter it as a string or as a file, e.g., --body @fleetspace.json or --body "{ "properties": { "throughputPoolConfiguration": { "minThroughput": 100000, "maxThroughput": 300000, "serviceTier": "GeneralPurpose", "dataRegions": ["West US 2"] }, } }".

--fleet-name

Name of the Cosmos DB Fleet.

--fleetspace-name -n

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.