Microsoft Azure

Azure Cosmos DB: Fleet

Azure Cosmos DB Fleet feature REST API

Data & analytics#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

Azure Cosmos DB Fleet feature REST API

Endpoints 15

Fleets

  • GETFleet_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/fleetsLists all the fleets under the specified subscription and resource group.
  • GETFleet_List/subscriptions/:subscriptionId/providers/Microsoft.DocumentDB/fleetsLists all the fleets under the subscription.
  • GETFleet_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/fleets/:fleetNameRetrieves the properties of an existing Azure Cosmos DB fleet under a subscription
  • PUTFleet_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/fleets/:fleetNameCreates an Azure Cosmos DB fleet under a subscription.
  • DELETEFleet_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/fleets/:fleetNameDeletes an existing Azure Cosmos DB Fleet.
  • PATCHFleet_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/fleets/:fleetNameUpdates the properties of an existing Azure Cosmos DB Fleet.
  • GETFleetspace_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/fleets/:fleetName/fleetspacesLists all the fleetspaces under a fleet.
  • GETFleetspace_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/fleets/:fleetName/fleetspaces/:fleetspaceNameRetrieves the properties of an existing Azure Cosmos DB fleetspace under a fleet
  • PUTFleetspace_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/fleets/:fleetName/fleetspaces/:fleetspaceNameCreates an Azure Cosmos DB fleetspace under a fleet.
  • DELETEFleetspace_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/fleets/:fleetName/fleetspaces/:fleetspaceNameDeletes an existing Azure Cosmos DB Fleetspace.
  • PATCHFleetspace_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/fleets/:fleetName/fleetspaces/:fleetspaceNameUpdate the properties of an existing Azure Cosmos DB fleetspace under a fleet.
  • GETFleetspaceAccount_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/fleets/:fleetName/fleetspaces/:fleetspaceName/fleetspaceAccountsLists all the fleetspaces accounts under a fleetspace.
  • GETFleetspaceAccount_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/fleets/:fleetName/fleetspaces/:fleetspaceName/fleetspaceAccounts/:fleetspaceAccountNameRetrieves the properties of an existing Azure Cosmos DB fleetspace account under a fleetspace
  • PUTFleetspaceAccount_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/fleets/:fleetName/fleetspaces/:fleetspaceName/fleetspaceAccounts/:fleetspaceAccountNameCreates an Azure Cosmos DB fleetspace account under a fleetspace.
  • DELETEFleetspaceAccount_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/fleets/:fleetName/fleetspaces/:fleetspaceName/fleetspaceAccounts/:fleetspaceAccountNameRemoves an existing Azure Cosmos DB fleetspace account from a fleetspace.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
15 operations on 7 pathsGET 7PUT 3DELETE 3PATCH 2
Main resources
Fleets 1
Response formats
application/json
Description format
Swagger 2.0, API version 2025-10-15

How to test the Azure Cosmos DB: Fleet 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 Cosmos DB: Fleet 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 “Fleet_ListByResourceGroup” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/fleets), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Cosmos DB: Fleet?

Azure Cosmos DB Fleet feature REST API It is listed under Data & analytics and has 15 endpoints.

Who publishes the Azure Cosmos DB: Fleet?

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 Cosmos DB: Fleet?

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

How do I authenticate with the Azure Cosmos DB: Fleet?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Cosmos DB: Fleet have?

15 operations on 7 paths (7 GET, 3 PUT, 3 DELETE, 2 PATCH). The largest groups are Fleets.

Is forking the Azure Cosmos DB: Fleet 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.