[Cosmosdb] Add command examples #31554
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
️✔️AzureCLI-FullTest
|
|
Hi @cxznmhdcxz, |
️✔️AzureCLI-BreakingChangeTest
|
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
There was a problem hiding this comment.
Pull Request Overview
This pull request adds example usage help strings to several Cosmos DB commands to improve user guidance.
- Added examples for Cassandra keyspace create
- Added examples for Gremlin, MongoDB, SQL database creation and table creation commands
- Added an examples block for the network rule add command
Comments suppressed due to low confidence (2)
src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py:336
- Consider changing 'an Gremlin' to 'a Gremlin' for grammatical correctness.
short-summary: Create an Gremlin database under an Azure Cosmos DB account.
src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py:585
- Consider changing 'an MongoDB' to 'a MongoDB' to correct the article usage.
short-summary: Create an MongoDB database under an Azure Cosmos DB account.
| helps['cosmosdb network-rule add'] = """ | ||
| type: command | ||
| short-summary: Adds a virtual network rule to an existing Cosmos DB database account. | ||
| example: |
There was a problem hiding this comment.
Change the key 'example:' to 'examples:' for consistency with the other command help entries.
Copilot uses AI. Check for mistakes.
microsoft-github-policy-service
bot
added
CosmosDB
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related command
Description
Testing Guide
History Notes
[Component Name 1] BREAKING CHANGE:
az command a: Make some customer-facing breaking change[Component Name 2]
az command b: Add some customer-facing featureThis checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.