az cosmosdb fleetspace

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage Cosmos DB Fleetspace resources.

Commands

Name Description Type Status
az cosmosdb fleetspace account

Manage database accounts within a Cosmos DB Fleetspace.

 Core and Extension GA
az cosmosdb fleetspace account create

Register an existing Cosmos DB database account to a Fleetspace.

 Core GA
az cosmosdb fleetspace account create (cosmosdb-preview extension)

Register an existing Cosmos DB database account to a Fleetspace.

 Extension Preview
az cosmosdb fleetspace account delete

Unregister a database account from a Fleetspace.

 Core GA
az cosmosdb fleetspace account delete (cosmosdb-preview extension)

Unregister a database account from a Fleetspace.

 Extension Preview
az cosmosdb fleetspace account list

List all database accounts associated with a Fleetspace.

 Core GA
az cosmosdb fleetspace account list (cosmosdb-preview extension)

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.

 Core GA
az cosmosdb fleetspace account show (cosmosdb-preview extension)

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.

 Core GA
az cosmosdb fleetspace create (cosmosdb-preview extension)

Create a new Fleetspace under a Cosmos DB Fleet.

 Extension Preview
az cosmosdb fleetspace delete

Delete a Fleetspace from a Fleet.

 Core GA
az cosmosdb fleetspace delete (cosmosdb-preview extension)

Delete a Fleetspace from a Fleet.

 Extension Preview
az cosmosdb fleetspace list

List all Fleetspaces under a Fleet.

 Core GA
az cosmosdb fleetspace list (cosmosdb-preview extension)

List all Fleetspaces under a Fleet.

 Extension Preview
az cosmosdb fleetspace show

Show details of a specific Fleetspace.

 Core GA
az cosmosdb fleetspace show (cosmosdb-preview extension)

Show details of a specific Fleetspace.

 Extension Preview
az cosmosdb fleetspace update

Update an existing Cosmos DB Fleetspace.

 Core GA
az cosmosdb fleetspace update (cosmosdb-preview extension)

Update an existing Cosmos DB Fleetspace.

 Extension Preview

az cosmosdb fleetspace create

Edit

Create a new Fleetspace under a Cosmos DB Fleet.

az cosmosdb fleetspace create --body
                              --fleet-name
                              --fleetspace-name
                              --resource-group
                              [--acquire-policy-token]
                              [--change-reference]

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.serviceTier (required), properties.dataRegions (required), and properties.throughputPoolConfiguration (fields: minThroughput, maxThroughput). You can enter it as a string or as a file, e.g., --body @fleetspace.json or --body "{ "properties": { "serviceTier": "GeneralPurpose", "dataRegions": ["West US 2"], "throughputPoolConfiguration": { "minThroughput": 100000, "maxThroughput": 300000 } } }".

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

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
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 cosmosdb fleetspace create (cosmosdb-preview extension)

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.

Creates a NoSQL fleetspace. serviceTier and nonempty dataRegions are required creation settings. Omit throughputPoolConfiguration, or set it to null or {}, for non-pooled creation. Pooling requires both positive integer throughput bounds with maxThroughput >= minThroughput. Additional throughput constraints and supported tiers and regions are service-configured.

az cosmosdb fleetspace create --body
                              --fleet-name
                              --fleetspace-name
                              --resource-group
                              [--acquire-policy-token]
                              [--change-reference]

Examples

Create a fleetspace

az cosmosdb fleetspace create \
  --resource-group MyResourceGroup \
  --fleet-name myfleet \
  --fleetspace-name myspace \
  --body @fleetspace.json

Create a non-pooled fleetspace

az cosmosdb fleetspace create \
  --resource-group MyResourceGroup \
  --fleet-name myfleet \
  --fleetspace-name myspace \
  --body '{"properties":{"serviceTier":"GeneralPurpose","dataRegions":["West US 2"]}}'

Required Parameters

--body -b

NoSQL fleetspace JSON body with required properties.serviceTier and nonempty properties.dataRegions. Omit throughputPoolConfiguration, or use null or {}, for non-pooled creation. Pooled creation requires positive integer minThroughput and maxThroughput, with max >= min; additional limits are service-configured. Use inline JSON or --body @fleetspace.json. Example: --body "{ "properties": { "serviceTier": "GeneralPurpose", "dataRegions": ["West US 2"], "throughputPoolConfiguration": { "minThroughput": 100000, "maxThroughput": 300000 } } }".

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

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
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 cosmosdb fleetspace delete

Edit

Delete a Fleetspace from a Fleet.

az cosmosdb fleetspace delete --fleet-name
                              --fleetspace-name
                              --resource-group
                              [--acquire-policy-token]
                              [--change-reference]
                              [--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

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

--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 cosmosdb fleetspace delete (cosmosdb-preview extension)

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
                              [--acquire-policy-token]
                              [--change-reference]
                              [--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

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

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

Edit

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.

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 cosmosdb fleetspace list (cosmosdb-preview extension)

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.

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

Edit

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.

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 cosmosdb fleetspace show (cosmosdb-preview extension)

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.

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 cosmosdb fleetspace update

Edit

Update an existing Cosmos DB Fleetspace.

az cosmosdb fleetspace update --body
                              --fleet-name
                              --fleetspace-name
                              --resource-group
                              [--acquire-policy-token]
                              [--change-reference]

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.serviceTier (optional), properties.dataRegions (optional), and properties.throughputPoolConfiguration (fields: minThroughput, maxThroughput). You can enter it as a string or as a file, e.g., --body @fleetspace.json or --body "{ "properties": { "serviceTier": "GeneralPurpose", "dataRegions": ["West US 2"], "throughputPoolConfiguration": { "minThroughput": 100000, "maxThroughput": 300000 } } }".

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

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
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 cosmosdb fleetspace update (cosmosdb-preview extension)

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.

Both positive integer minThroughput and maxThroughput are required in throughputPoolConfiguration, with maxThroughput >= minThroughput. Additional constraints are service-configured. Partial updates and omitted, null or empty configurations are not supported by this CLI. serviceTier and dataRegions are creation settings; supplied update values cannot change them. Do not omit configuration in a raw service request to preserve pooling: omission can disable pooling. Fleetspaces use the NoSQL API; this command does not change the API kind.

az cosmosdb fleetspace update --body
                              --fleet-name
                              --fleetspace-name
                              --resource-group
                              [--acquire-policy-token]
                              [--change-reference]

Examples

Update fleetspace throughput settings

az cosmosdb fleetspace update \
  --resource-group MyResourceGroup \
  --fleet-name myfleet \
  --fleetspace-name myspace \
  --body '{"properties":{"throughputPoolConfiguration":{"minThroughput":100000,"maxThroughput":300000}}}'

Required Parameters

--body -b

Fleetspace JSON body requiring properties.throughputPoolConfiguration with both positive integer minThroughput and maxThroughput, with max >= min. Additional limits are service-configured. Partial updates and omitted/null/empty configurations are not supported. serviceTier and dataRegions are creation settings and cannot change existing settings. Use inline JSON or --body @fleetspace.json. Example: --body "{ "properties": { "throughputPoolConfiguration": { "minThroughput": 100000, "maxThroughput": 300000 } } }".

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

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