Share via

az cosmosdb fleet

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

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

Manage Azure Cosmos DB Fleet resources.

Commands

Name Description Type Status
az cosmosdb fleet analytics

Manage Azure Cosmos DB Fleet Analytics resources.

 Extension Preview
az cosmosdb fleet analytics create

Create a new Fleet Analytics resource under a Cosmos DB Fleet.

 Extension Preview
az cosmosdb fleet analytics delete

Delete a Fleet Analytics resource from a Fleet.

 Extension Preview
az cosmosdb fleet analytics list

List all Fleet Analytics resources under a Fleet.

 Extension Preview
az cosmosdb fleet analytics show

Show details of a specific Fleet Analytics resource.

 Extension Preview
az cosmosdb fleet create

Create a new Cosmos DB Fleet.

 Extension Preview
az cosmosdb fleet delete

Delete a specific Cosmos DB Fleet.

 Extension Preview
az cosmosdb fleet list

List Cosmos DB Fleets in a subscription or resource group.

 Extension Preview
az cosmosdb fleet show

Show details of a specific Cosmos DB Fleet.

 Extension Preview

az cosmosdb fleet create

Preview

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

Create a new Cosmos DB Fleet.

az cosmosdb fleet create --fleet-name
                         --location
                         --resource-group
                         [--tags]

Examples

Create a fleet

az cosmosdb fleet create \
  --resource-group MyResourceGroup \
  --fleet-name MyFleet \
  --location westus

Required Parameters

--fleet-name -n

Name of the Fleet resource.

--location -l

Location of the Fleet.

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

--tags

Tags in 'key=value key2=value2' format.

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

Preview

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

Delete a specific Cosmos DB Fleet.

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

Required Parameters

--fleet-name -n

Name of the Fleet 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.

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

Preview

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

List Cosmos DB Fleets in a subscription or resource group.

az cosmosdb fleet list [--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.

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

Preview

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

Show details of a specific Cosmos DB Fleet.

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

Required Parameters

--fleet-name -n

Name of the Fleet 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