-
Notifications
You must be signed in to change notification settings - Fork 1.5k
{Mongo-db} CLI extension initial release #8781
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.
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
Conversation
|
Validation for Breaking Change Starting...
Thanks for your contribution! |
|
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces a new Azure CLI extension for managing MongoDB Atlas organizations, providing commands for creating, showing, deleting, listing, and waiting on organization resources. Key changes include auto-generated command implementations using AAZ, metadata updates specifying preview status and minimum CLI core version, and documentation updates with usage examples.
Reviewed Changes
Copilot reviewed 27 out of 27 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/mongodb/azext_mongodb/tests/init.py | Added the test module initialization (auto-generated). |
| src/mongodb/azext_mongodb/custom.py | Introduced custom module with logger setup. |
| src/mongodb/azext_mongodb/commands.py | Added a stub for command table loading. |
| src/mongodb/azext_mongodb/azext_metadata.json | Metadata file marking the extension as preview. |
| src/mongodb/azext_mongodb/aaz/latest/... | Multiple files adding commands (_wait.py, _show.py, _delete.py, etc.) with auto-generated AAZ command implementations. |
| src/mongodb/README.md | Provided installation and usage guidance. |
| src/mongodb/HISTORY.rst | Initial release history entry. |
| Other files | Various auto-generated initialization, parameter, and helper files for organizing and grouping CLI commands. |
Comments suppressed due to low confidence (1)
src/mongodb/README.md:41
- The command example appears to have formatting issues such as a missing space between the subscription flag and the --user flag, as well as an extra quote after the email address. Please revise the example for clarity and correctness.
mongo-db atlas organization create -name MyOrganizationResourceName --resource-group MyResourceGroup --location "eastus" --subscription "abcd1234-5678-90ab-cdef-12345678abcd"--user {"first-name":"John","last-name":"Doe","email-address":"[email protected]"}" --marketplace "{...
CodeGen Tools Feedback CollectionThank you for using our CodeGen tool. We value your feedback, and we would like to know how we can improve our product. Please take a few minutes to fill our codegen survey |
|
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
|
|
||
|
|
||
| class MongodbScenario(ScenarioTest): | ||
| # TODO: add tests here |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add some tests here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added
src/mongodb/README.md
Outdated
| az mongo-db atlas organization create --resource-group {resource_group} --name {resource_name} --user '{{"first-name": "{user_first_name}", "last-name": "{user_last_name}", "email-address": "{user_email}", "company-name": "{user_company_name}", "upn": "{user_upn}", "phone-number": "{user_phone}"}}' --marketplace '{{"subscription-id": "{subscription_id}", "offer-details": {{"publisher-id": "{publisher_id}", "offer-id": "{offer_id}", "plan-id": "{plan_id}", "plan-name": "{plan_name}", "term-unit": "{term_unit}", "term-id": "{term_id}"}}}}' --partner-properties '{"organization-name": "{partner_org_name}"}' --tags "{key:value}" --location {location} | ||
| ``` | ||
|
|
||
| mongo-db atlas organization create -name MyOrganizationResourceName --resource-group MyResourceGroup --location "eastus" --subscription "abcd1234-5678-90ab-cdef-12345678abcd"--user {"first-name":"John","last-name":"Doe","email-address":"[email protected]"}" --marketplace "{"subscription-id":"abcd1234-5678-90ab-cdef-12345678abcd","subscription-status":"PendingFulfillmentStart","offer-details":{"publisher-id":"mongodb","offer-id":"mongodb_atlas_azure_native_prod","plan-id":"private_plan","plan-name":"Pay as You Go (Free) (Private)","term-unit":"P1M","term-id":"gmz7xq9ge3py"}}" --partner-properties "{"organization-name":"partner-org-name"}" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
dup cmd line?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated
src/mongodb/README.md
Outdated
| #### Delete a MongoDB Atlas Organization. This deletes the MongoDB Atlas resource in Azure. #### | ||
|
|
||
| ``` | ||
| az mongo-db atlas organization delete --resource-group {resource_group} --name {resource_name}``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| az mongo-db atlas organization delete --resource-group {resource_group} --name {resource_name}``` | |
| az mongo-db atlas organization delete --resource-group {resource_group} --name {resource_name} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
|
aaz pr: Azure/aaz#767 |
|
[Release] Update index.json for extension [ mongo-db-1.0.0b1 ] : https://dev.azure.com/msazure/One/_build/results?buildId=125137833&view=results |
* mongdo-db cli * adding tests and addressing comments * updating extension name to mongo-db * Update src/mongo-db/azext_mongo_db/tests/latest/test_mongo_db.py --------- Co-authored-by: Gaurav Bang <[email protected]> Co-authored-by: AllyW <[email protected]>
This checklist is used to make sure that common guidelines for a pull request are followed.
Related command
General Guidelines
azdev style <YOUR_EXT>locally? (pip install azdevrequired)python scripts/ci/test_index.py -qlocally? (pip install wheel==0.30.0required)For new extensions:
About Extension Publish
There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update
src/index.jsonautomatically.You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify
src/index.json.