Microsoft Azure

Azure Mongocluster

The Microsoft Azure management API provides create, read, update, and delete functionality for Azure DocumentDB resources including clusters and firewall rules.

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Microsoft Azure management API provides create, read, update, and delete functionality for Azure DocumentDB resources including clusters and firewall rules.

Endpoints 24

Operations

  • GETOperations_List/providers/Microsoft.DocumentDB/operationsList the operations for the provider

MongoClusters

  • POSTMongoClusters_CheckNameAvailability/subscriptions/:subscriptionId/providers/Microsoft.DocumentDB/locations/:location/checkMongoClusterNameAvailabilityCheck if DocumentDB cluster name is available for use.
  • GETMongoClusters_List/subscriptions/:subscriptionId/providers/Microsoft.DocumentDB/mongoClustersList all the DocumentDB clusters in a given subscription.
  • GETMongoClusters_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/mongoClustersList all the DocumentDB clusters in a given resource group.
  • GETMongoClusters_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/mongoClusters/:mongoClusterNameGets information about a DocumentDB cluster.
  • PUTMongoClusters_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/mongoClusters/:mongoClusterNameCreate or update a DocumentDB cluster. Update overwrites all properties for the resource. To only modify some of the properties, use PATCH.
  • DELETEMongoClusters_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/mongoClusters/:mongoClusterNameDeletes a DocumentDB cluster.
  • PATCHMongoClusters_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/mongoClusters/:mongoClusterNameUpdates an existing DocumentDB cluster. The request body can contain one to many of the properties present in the normal DocumentDB cluster definition.
  • POSTMongoClusters_ListConnectionStrings/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/mongoClusters/:mongoClusterName/listConnectionStringsList DocumentDB cluster connection strings. This includes the default connection string using SCRAM-SHA-256, as well as other connection strings supported by…
  • POSTMongoClusters_Promote/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/mongoClusters/:mongoClusterName/promotePromotes a replica DocumentDB cluster to a primary role.

FirewallRules

  • GETFirewallRules_ListByMongoCluster/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/mongoClusters/:mongoClusterName/firewallRulesList all the firewall rules in a given DocumentDB cluster.
  • GETFirewallRules_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/mongoClusters/:mongoClusterName/firewallRules/:firewallRuleNameGets information about a DocumentDB cluster firewall rule.
  • PUTFirewallRules_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/mongoClusters/:mongoClusterName/firewallRules/:firewallRuleNameCreates a new firewall rule or updates an existing firewall rule on a DocumentDB cluster.
  • DELETEFirewallRules_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/mongoClusters/:mongoClusterName/firewallRules/:firewallRuleNameDeletes a DocumentDB cluster firewall rule.

PrivateEndpointConnections

  • GETPrivateEndpointConnections_ListByMongoCluster/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/mongoClusters/:mongoClusterName/privateEndpointConnectionsList existing private connections
  • GETPrivateEndpointConnections_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/mongoClusters/:mongoClusterName/privateEndpointConnections/:privateEndpointConnectionNameGet a specific private connection
  • PUTPrivateEndpointConnections_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/mongoClusters/:mongoClusterName/privateEndpointConnections/:privateEndpointConnectionNameCreate a Private endpoint connection
  • DELETEPrivateEndpointConnections_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/mongoClusters/:mongoClusterName/privateEndpointConnections/:privateEndpointConnectionNameDelete the private endpoint connection

PrivateLinks

  • GETPrivateLinks_ListByMongoCluster/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/mongoClusters/:mongoClusterName/privateLinkResourceslist private links on the given resource

Replicas

  • GETReplicas_ListByParent/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/mongoClusters/:mongoClusterName/replicasList all the replicas for the DocumentDB cluster.

Users

  • GETUsers_ListByMongoCluster/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/mongoClusters/:mongoClusterName/usersList all the users on a DocumentDB cluster.
  • GETUsers_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/mongoClusters/:mongoClusterName/users/:userNameGets the defintion of a DocumentDB cluster user.
  • PUTUsers_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/mongoClusters/:mongoClusterName/users/:userNameCreates a new user or updates an existing user on a DocumentDB cluster.
  • DELETEUsers_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/mongoClusters/:mongoClusterName/users/:userNameDeletes a DocumentDB cluster user.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
24 operations on 15 pathsGET 12PUT 4DELETE 4POST 3PATCH 1
Main resources
MongoClusters 9FirewallRules 4PrivateEndpointConnections 4Users 4Operations 1PrivateLinks 1Replicas 1
Response formats
application/json
Description format
Swagger 2.0, API version 2026-06-01

How to test the Azure Mongocluster in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Mongocluster collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Operations_List” (GET /providers/Microsoft.DocumentDB/operations), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Mongocluster?

The Microsoft Azure management API provides create, read, update, and delete functionality for Azure DocumentDB resources including clusters and firewall rules. It is listed under Developer tools and has 24 endpoints.

Who publishes the Azure Mongocluster?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure Mongocluster?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Mongocluster?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Mongocluster have?

24 operations on 15 paths (12 GET, 4 PUT, 4 DELETE, 3 POST, 1 PATCH). The largest groups are MongoClusters, FirewallRules, PrivateEndpointConnections, Users.

Is forking the Azure Mongocluster free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.