Skip to content

[Cosmosdb] Add command examples #31554

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cxznmhdcxz wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

[Cosmosdb] Add command examples #31554

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e30d5bc
add examples
cxznmhdcxz May 26, 2025
9b3f4b2
Update _help.py
cxznmhdcxz May 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@
helps['cosmosdb cassandra keyspace create'] = """
type: command
short-summary: Create an Cassandra keyspace under an Azure Cosmos DB account.
examples:
- name: Create an Cassandra keyspace under an Azure Cosmos DB account.
text: az cosmosdb cassandra keyspace create -g rg -a myaccount -n mydb
"""

helps['cosmosdb cassandra keyspace delete'] = """
Expand Down Expand Up @@ -331,6 +334,9 @@
helps['cosmosdb gremlin database create'] = """
type: command
short-summary: Create an Gremlin database under an Azure Cosmos DB account.
examples:
- name: Create an Gremlin database under an Azure Cosmos DB account.
text: az cosmosdb gremlin database create -g rg -a myaccount -n mydb
"""

helps['cosmosdb gremlin database delete'] = """
Expand Down Expand Up @@ -577,6 +583,9 @@
helps['cosmosdb mongodb database create'] = """
type: command
short-summary: Create an MongoDB database under an Azure Cosmos DB account.
examples:
- name: Create an MongoDB database under an Azure Cosmos DB account.
text: az cosmosdb mongodb database create -g rg -a account -n dbname
"""

helps['cosmosdb mongodb database delete'] = """
Expand Down Expand Up @@ -632,6 +641,14 @@
short-summary: Manage Azure Cosmos DB network rules.
"""

helps['cosmosdb network-rule add'] = """
type: command
short-summary: Adds a virtual network rule to an existing Cosmos DB database account.
examples:
- name: Adds a virtual network rule to an existing Cosmos DB database account.
Comment on lines +646 to +648
Copy link
Copy Markdown
Member

@evelyn-ys evelyn-ys Jun 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
short-summary: Adds a virtual network rule to an existing Cosmos DB database account.
examples:
- name: Adds a virtual network rule to an existing Cosmos DB database account.
short-summary: Add a virtual network rule to an existing Cosmos DB database account.
examples:
- name: Add a virtual network rule to an existing Cosmos DB database account.

text: az cosmosdb network-rule add -n accountname -g rg --subnet subnet
"""

helps['cosmosdb private-endpoint-connection'] = """
type: group
short-summary: Manage Azure Cosmos DB private endpoint connections.
Expand Down Expand Up @@ -860,6 +877,9 @@
helps['cosmosdb sql database create'] = """
type: command
short-summary: Create an SQL database under an Azure Cosmos DB account.
examples:
- name: Create an Azure Cosmos DB SQL database.
text: az cosmosdb sql database create -g MyResourceGroup -a MyAccount -n MyDatabase
"""

helps['cosmosdb sql database delete'] = """
Expand Down Expand Up @@ -909,6 +929,9 @@
helps['cosmosdb table create'] = """
type: command
short-summary: Create an Table under an Azure Cosmos DB account.
examples:
- name: Create an Azure Cosmos DB Table.
text: az cosmosdb table create -g rg -a account -n mytable
"""

helps['cosmosdb table delete'] = """
Expand Down
Loading