Microsoft Azure

Azure Cosmos DB: Notebook

Azure Cosmos DB Database Service Resource Provider 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 Database Service Resource Provider REST API

Endpoints 7

NotebookWorkspacesResource

  • GETNotebookWorkspaces_ListByDatabaseAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/:accountName/notebookWorkspacesGets the notebook workspace resources of an existing Cosmos DB account.
  • GETNotebookWorkspaces_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/:accountName/notebookWorkspaces/:notebookWorkspaceNameGets the notebook workspace for a Cosmos DB account.
  • PUTNotebookWorkspaces_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/:accountName/notebookWorkspaces/:notebookWorkspaceNameCreates the notebook workspace for a Cosmos DB account.
  • DELETENotebookWorkspaces_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/:accountName/notebookWorkspaces/:notebookWorkspaceNameDeletes the notebook workspace for a Cosmos DB account.
  • POSTNotebookWorkspaces_ListConnectionInfo/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/:accountName/notebookWorkspaces/:notebookWorkspaceName/listConnectionInfoRetrieves the connection info for the notebook workspace
  • POSTNotebookWorkspaces_RegenerateAuthToken/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/:accountName/notebookWorkspaces/:notebookWorkspaceName/regenerateAuthTokenRegenerates the auth token for the notebook workspace
  • POSTNotebookWorkspaces_Start/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/:accountName/notebookWorkspaces/:notebookWorkspaceName/startStarts the notebook workspace

API details

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

How to test the Azure Cosmos DB: Notebook 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: Notebook 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 “NotebookWorkspaces_ListByDatabaseAccount” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/:accountName/notebookWorkspaces), 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: Notebook?

Azure Cosmos DB Database Service Resource Provider REST API It is listed under Data & analytics and has 7 endpoints.

Who publishes the Azure Cosmos DB: Notebook?

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: Notebook?

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

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

With OAuth 2.0 (implicit flow) with 1 scope.

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

7 operations on 5 paths (3 POST, 2 GET, 1 PUT, 1 DELETE). The largest groups are NotebookWorkspacesResource.

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