Notebook Workspaces - List Connection Info

Reference

Service:: Cosmos DB Resource Provider

API Version:: 2024-11-15

Retrieves the connection info for the notebook workspace

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/default/listConnectionInfo?api-version=2024-11-15

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string	Cosmos DB database account name. Regex pattern: `^[a-z0-9]+(-[a-z0-9]+)*`
notebookWorkspaceName	path	True	NotebookWorkspaceName	The name of the notebook workspace resource.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	NotebookWorkspaceConnectionInfoResult	The operation completed successfully.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Impersonate your user account

Examples

CosmosDBNotebookWorkspaceListConnectionInfo

Sample request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/notebookWorkspaces/default/listConnectionInfo?api-version=2024-11-15

Sample response

Status code:: 200

{
  "authToken": "auth-token",
  "notebookServerEndpoint": "notebook endpoint"
}

Definitions

Name	Description
ErrorResponse	Error Response.
NotebookWorkspaceConnectionInfoResult	The connection info for the given notebook workspace
NotebookWorkspaceName	The name of the notebook workspace resource.

ErrorResponse

Error Response.

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.

NotebookWorkspaceConnectionInfoResult

The connection info for the given notebook workspace

Name	Type	Description
authToken	string	Specifies auth token used for connecting to Notebook server (uses token-based auth).
notebookServerEndpoint	string	Specifies the endpoint of Notebook server.

NotebookWorkspaceName

The name of the notebook workspace resource.

Name	Type	Description
default	string

Share via