notebook_workspaces

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

Overview

Name	notebook_workspaces
Type	Resource
Id	azure.cosmos_db.notebook_workspaces

Fields

vw_notebook_workspaces

Name	Datatype	Description
id	text	The unique resource identifier of the database account.
name	text	The name of the database account.
accountName	text	field from the properties object
notebookWorkspaceName	text	field from the properties object
notebook_server_endpoint	text	field from the properties object
resourceGroupName	text	field from the properties object
status	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	The type of Azure resource.

notebook_workspaces

Name	Datatype	Description
id	string	The unique resource identifier of the database account.
name	string	The name of the database account.
properties	object	Properties of a notebook workspace resource.
type	string	The type of Azure resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	accountName, notebookWorkspaceName, resourceGroupName, subscriptionId	Gets the notebook workspace for a Cosmos DB account.
list_by_database_account	SELECT	accountName, resourceGroupName, subscriptionId	Gets the notebook workspace resources of an existing Cosmos DB account.
create_or_update	INSERT	accountName, notebookWorkspaceName, resourceGroupName, subscriptionId	Creates the notebook workspace for a Cosmos DB account.
delete	DELETE	accountName, notebookWorkspaceName, resourceGroupName, subscriptionId	Deletes the notebook workspace for a Cosmos DB account.
regenerate_auth_token	EXEC	accountName, notebookWorkspaceName, resourceGroupName, subscriptionId	Regenerates the auth token for the notebook workspace
start	EXEC	accountName, notebookWorkspaceName, resourceGroupName, subscriptionId	Starts the notebook workspace

SELECT examples

Gets the notebook workspace resources of an existing Cosmos DB account.

vw_notebook_workspaces

SELECT
id,
name,
accountName,
notebookWorkspaceName,
notebook_server_endpoint,
resourceGroupName,
status,
subscriptionId,
type
FROM azure.cosmos_db.vw_notebook_workspaces
WHERE accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

notebook_workspaces

SELECT
id,
name,
properties,
type
FROM azure.cosmos_db.notebook_workspaces
WHERE accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new notebook_workspaces resource.

All Properties

/*+ create */
INSERT INTO azure.cosmos_db.notebook_workspaces (
accountName,
notebookWorkspaceName,
resourceGroupName,
subscriptionId
)
SELECT 
'{{ accountName }}',
'{{ notebookWorkspaceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string

DELETE example

Deletes the specified notebook_workspaces resource.

/*+ delete */
DELETE FROM azure.cosmos_db.notebook_workspaces
WHERE accountName = '{{ accountName }}'
AND notebookWorkspaceName = '{{ notebookWorkspaceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';