notebook_workspaces_connection_info

Creates, updates, deletes, gets or lists a notebook_workspaces_connection_info resource.

Overview

Name	notebook_workspaces_connection_info
Type	Resource
Id	azure.cosmos_db.notebook_workspaces_connection_info

Fields

The following fields are returned by SELECT queries:

list

The operation completed successfully.

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	subscriptionId, resourceGroupName, accountName, notebookWorkspaceName		Retrieves the connection info for the notebook workspace

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
accountName	string	Cosmos DB database account name.
notebookWorkspaceName	string	The name of the notebook workspace resource.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

list

Retrieves the connection info for the notebook workspace

SELECT
authToken,
notebookServerEndpoint
FROM azure.cosmos_db.notebook_workspaces_connection_info
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND notebookWorkspaceName = '{{ notebookWorkspaceName }}' -- required
;