notebook_workspaces

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

Overview

Name	notebook_workspaces
Type	Resource
Id	azure.cosmosdb.notebook_workspaces

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
notebookServerEndpoint	string	Specifies the endpoint of Notebook server.
status	string	Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_database_account

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
notebookServerEndpoint	string	Specifies the endpoint of Notebook server.
status	string	Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, notebook_workspace_name, subscription_id		Gets the notebook workspace for a Cosmos DB account.
list_by_database_account	select	resource_group_name, account_name, subscription_id		Gets the notebook workspace resources of an existing Cosmos DB account.
create_or_update	insert	resource_group_name, account_name, notebook_workspace_name, subscription_id		Creates the notebook workspace for a Cosmos DB account.
create_or_update	replace	resource_group_name, account_name, notebook_workspace_name, subscription_id		Creates the notebook workspace for a Cosmos DB account.
delete	delete	resource_group_name, account_name, notebook_workspace_name, subscription_id		Deletes the notebook workspace for a Cosmos DB account.
list_connection_info	exec	resource_group_name, account_name, notebook_workspace_name, subscription_id		Retrieves the connection info for the notebook workspace.
regenerate_auth_token	exec	resource_group_name, account_name, notebook_workspace_name, subscription_id		Regenerates the auth token for the notebook workspace.
start	exec	resource_group_name, account_name, notebook_workspace_name, subscription_id		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
account_name	string	Cosmos DB database account name. Required.
notebook_workspace_name	string	The name of the notebook workspace resource. "default" Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the notebook workspace for a Cosmos DB account.

SELECT
id,
name,
notebookServerEndpoint,
status,
systemData,
type
FROM azure.cosmosdb.notebook_workspaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND notebook_workspace_name = '{{ notebook_workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_database_account

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

SELECT
id,
name,
notebookServerEndpoint,
status,
systemData,
type
FROM azure.cosmosdb.notebook_workspaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates the notebook workspace for a Cosmos DB account.

INSERT INTO azure.cosmosdb.notebook_workspaces (
id,
name,
type,
resource_group_name,
account_name,
notebook_workspace_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ name }}',
'{{ type }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ notebook_workspace_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: notebook_workspaces
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the notebook_workspaces resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the notebook_workspaces resource.
  - name: notebook_workspace_name
    value: "{{ notebook_workspace_name }}"
    description: Required parameter for the notebook_workspaces resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the notebook_workspaces resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique resource identifier of the database account.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the database account.
  - name: type
    value: "{{ type }}"
    description: |
      The type of Azure resource.

REPLACE examples

create_or_update

Creates the notebook workspace for a Cosmos DB account.

REPLACE azure.cosmosdb.notebook_workspaces
SET 
id = '{{ id }}',
name = '{{ name }}',
type = '{{ type }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND notebook_workspace_name = '{{ notebook_workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the notebook workspace for a Cosmos DB account.

DELETE FROM azure.cosmosdb.notebook_workspaces
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND notebook_workspace_name = '{{ notebook_workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_connection_info

Retrieves the connection info for the notebook workspace.

EXEC azure.cosmosdb.notebook_workspaces.list_connection_info 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@notebook_workspace_name='{{ notebook_workspace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

regenerate_auth_token

Regenerates the auth token for the notebook workspace.

EXEC azure.cosmosdb.notebook_workspaces.regenerate_auth_token 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@notebook_workspace_name='{{ notebook_workspace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

start

Starts the notebook workspace.

EXEC azure.cosmosdb.notebook_workspaces.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@notebook_workspace_name='{{ notebook_workspace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;