Share via

az cosmosdb fleet analytics

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

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

Manage Azure Cosmos DB Fleet Analytics resources.

Commands

Name Description Type Status
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 analytics create

Preview

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

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

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

Examples

Create a Fleet Analytics resource

az cosmosdb fleet analytics create \
  --resource-group MyResourceGroup \
  --fleet-name MyFleet \
  --fleet-analytics-name MyFleetAnalytics \
  --body @fleetAnalytics.json

Required Parameters

--body -b

Fleet Analytics body with properties (fields: storageLocationType, storageLocationUri). You can enter it as a string or as a file, e.g., --body @fleetAnalytics.json or --body "{ "properties": { "storageLocationType": "StorageAccount", "storageLocationUri": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-rg/providers/Microsoft.Storage/storageAccounts/exampleaccount" } }".

--fleet-analytics-name -n

Name of the Fleet Analytics resource.

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

Preview

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

Delete a Fleet Analytics resource from a Fleet.

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

Required Parameters

--fleet-analytics-name -n

Name of the Fleet Analytics resource.

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

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

Preview

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

List all Fleet Analytics resources under a Fleet.

az cosmosdb fleet analytics 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 fleet analytics show

Preview

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

Show details of a specific Fleet Analytics resource.

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

Required Parameters

--fleet-analytics-name -n

Name of the Fleet Analytics resource.

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