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

The following fields are returned by SELECT queries:

get

Successfully retrieved a specified notebook workspace resource.

Name	Datatype	Description
id	string	The unique resource identifier of the database account.
name	string	The name of the database account.
properties	object	Resource properties.
type	string	The type of Azure resource.

list_by_database_account

Successfully retrieved notebook workspace resources.

Name	Datatype	Description
id	string	The unique resource identifier of the database account.
name	string	The name of the database account.
properties	object	Resource properties.
type	string	The type of Azure resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, notebookWorkspaceName		Gets the notebook workspace for a Cosmos DB account.
list_by_database_account	select	subscriptionId, resourceGroupName, accountName		Gets the notebook workspace resources of an existing Cosmos DB account.
create_or_update	insert	subscriptionId, resourceGroupName, accountName, notebookWorkspaceName		Creates the notebook workspace for a Cosmos DB account.
delete	delete	subscriptionId, resourceGroupName, accountName, notebookWorkspaceName		Deletes the notebook workspace for a Cosmos DB account.
regenerate_auth_token	exec	subscriptionId, resourceGroupName, accountName, notebookWorkspaceName		Regenerates the auth token for the notebook workspace
start	exec	subscriptionId, resourceGroupName, accountName, notebookWorkspaceName		Starts 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

get

Gets the notebook workspace for a Cosmos DB account.

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

list_by_database_account

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

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

INSERT examples

create_or_update

Creates the notebook workspace for a Cosmos DB account.

INSERT INTO azure.cosmos_db.notebook_workspaces (
subscriptionId,
resourceGroupName,
accountName,
notebookWorkspaceName
)
SELECT 
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ notebookWorkspaceName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: notebook_workspaces
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the notebook_workspaces resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the notebook_workspaces resource.
    - name: accountName
      value: string
      description: Required parameter for the notebook_workspaces resource.
    - name: notebookWorkspaceName
      value: string
      description: Required parameter for the notebook_workspaces resource.

DELETE examples

delete

Deletes the notebook workspace for a Cosmos DB account.

DELETE FROM azure.cosmos_db.notebook_workspaces
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND notebookWorkspaceName = '{{ notebookWorkspaceName }}' --required
;

Lifecycle Methods

regenerate_auth_token

Regenerates the auth token for the notebook workspace

EXEC azure.cosmos_db.notebook_workspaces.regenerate_auth_token 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@notebookWorkspaceName='{{ notebookWorkspaceName }}' --required
;

start

Starts the notebook workspace

EXEC azure.cosmos_db.notebook_workspaces.start 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@notebookWorkspaceName='{{ notebookWorkspaceName }}' --required
;