Azure-cli: `az cosmosdb list-connection-strings` documentation difference

Created on 7 Dec 2018  Â·  2Comments  Â·  Source: Azure/azure-cli

When you run az cosmosdb list-connection-strings --account-name blahblahblah as suggested by the documentation, the following error will result:

$ az cosmosdb list-connection-strings -g blahblahblah --account-name testing
az: error: unrecognized arguments: --account-name testing
usage: az [-h] [--verbose] [--debug] [--output {json,jsonc,table,tsv,yaml}]
          [--query JMESPATH]
          {cosmosdb} ...

Additionally, if you try to run az cosmosdb list-connection-strings -g blahblahblah without the account name (to see what complains), it returns an error:

$ az cosmosdb list-connection-strings -g blahblahblah
(--name | --ids) are required

Two problem here:

  1. This error would sort of suggest that these two things are interchangeable and they are not
$ az cosmosdb list-connection-strings -g blahblahblah --ids testing
option '--resource-group' will be ignored due to use of '--ids'.
  1. The --name argument is not in the documentation, which will lead to confusion.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Documentation

Most helpful comment

This has been fixed.

All 2 comments

See #8023.

This has been fixed.

Was this page helpful?
0 / 5 - 0 ratings