DocumentDB for VS Code
Learn More — Back to Learn More Index
Azure VMs (DocumentDB) Service Discovery Plugin
The Azure VMs (DocumentDB) plugin is available as part of the Service Discovery feature in DocumentDB for VS Code. This plugin helps you locate and connect to your virtual machines hosted in Azure that are running self-hosted DocumentDB or MongoDB instances.
How to Access
You can access this plugin in two ways:
- Through the
Service Discoverypanel in the extension sidebar. - When adding a new connection, select the
Azure VMs (DocumentDB)option.
How It Works
When you use the Azure VMs (DocumentDB) plugin, the following steps are performed:
-
Authentication: The plugin authenticates you with Azure using your credentials.
-
Subscription Discovery: All available Azure subscriptions are listed.
Tip: You can
filterwhich subscriptions are shown in theService Discoverypanel. Click the funnel icon next to the service discovery provider name, wait for the list to populate, and select the subscriptions you want to include.
-
VM Filtering by Tag: The plugin searches for virtual machines within your selected subscriptions that have a specific tag assigned. By default, the tag is set to
DocumentDB, but you can change this in the filter function as needed.Tip: When using Service Discovery from within the
DocumentDB Connectionsarea, you’ll always be asked to confirm thetagused. TheService Discoveryarea works with the defaultDocumentDBtag. Changing it is possible using thefilterfeature. -
Connection Options:
- You can connect to a VM by expanding its entry in the tree view.
- You can save a VM to your
DocumentDB Connectionslist using the context menu or by clicking the save icon next to its name.
Additional Notes
- Tag-based filtering helps you focus on relevant virtual machines, especially if you have many resources in your Azure environment.
- All authentication and discovery steps are handled within the extension, so you do not need to manually gather connection strings or VM details.
- You can change the tag used for filtering in the filter function if your environment uses a different tagging convention.
Feedback and Contributions
If you have suggestions for improving this plugin or would like to see support for additional VM filtering options, please join the discussion board and share your feedback.