NotebookWorkspacesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CosmosDBManagementClient's

<xref:notebook_workspaces> attribute.

Inheritance

builtins.object

NotebookWorkspacesOperations

Constructor

NotebookWorkspacesOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates the notebook workspace for a Cosmos DB account.
begin_delete	Deletes the notebook workspace for a Cosmos DB account.
begin_regenerate_auth_token	Regenerates the auth token for the notebook workspace.
begin_start	Starts the notebook workspace.
get	Gets the notebook workspace for a Cosmos DB account.
list_by_database_account	Gets the notebook workspace resources of an existing Cosmos DB account.
list_connection_info	Retrieves the connection info for the notebook workspace.

begin_create_or_update

Creates the notebook workspace for a Cosmos DB account.

async begin_create_or_update(resource_group_name: str, account_name: str, notebook_workspace_name: str | _models.NotebookWorkspaceName, notebook_create_update_parameters: _models.NotebookWorkspaceCreateUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.NotebookWorkspace]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
notebook_workspace_name Required	str or NotebookWorkspaceName The name of the notebook workspace resource. "default" Required.
notebook_create_update_parameters Required	NotebookWorkspaceCreateUpdateParameters or IO[bytes] The notebook workspace to create for the current database account. Is either a NotebookWorkspaceCreateUpdateParameters type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[NotebookWorkspace]	An instance of AsyncLROPoller that returns either NotebookWorkspace or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the notebook workspace for a Cosmos DB account.

async begin_delete(resource_group_name: str, account_name: str, notebook_workspace_name: str | NotebookWorkspaceName, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
notebook_workspace_name Required	str or NotebookWorkspaceName The name of the notebook workspace resource. "default" Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_regenerate_auth_token

Regenerates the auth token for the notebook workspace.

async begin_regenerate_auth_token(resource_group_name: str, account_name: str, notebook_workspace_name: str | NotebookWorkspaceName, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
notebook_workspace_name Required	str or NotebookWorkspaceName The name of the notebook workspace resource. "default" Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_start

Starts the notebook workspace.

async begin_start(resource_group_name: str, account_name: str, notebook_workspace_name: str | NotebookWorkspaceName, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
notebook_workspace_name Required	str or NotebookWorkspaceName The name of the notebook workspace resource. "default" Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets the notebook workspace for a Cosmos DB account.

async get(resource_group_name: str, account_name: str, notebook_workspace_name: str | NotebookWorkspaceName, **kwargs: Any) -> NotebookWorkspace

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
notebook_workspace_name Required	str or NotebookWorkspaceName The name of the notebook workspace resource. "default" Required.

Returns

Type	Description
NotebookWorkspace	NotebookWorkspace or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_database_account

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

list_by_database_account(resource_group_name: str, account_name: str, **kwargs: Any) -> AsyncIterable[NotebookWorkspace]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.

Returns

Type	Description
AsyncItemPaged[NotebookWorkspace]	An iterator like instance of either NotebookWorkspace or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_connection_info

Retrieves the connection info for the notebook workspace.

async list_connection_info(resource_group_name: str, account_name: str, notebook_workspace_name: str | NotebookWorkspaceName, **kwargs: Any) -> NotebookWorkspaceConnectionInfoResult

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
notebook_workspace_name Required	str or NotebookWorkspaceName The name of the notebook workspace resource. "default" Required.

Returns

Type	Description
NotebookWorkspaceConnectionInfoResult	NotebookWorkspaceConnectionInfoResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.cosmosdb.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\cosmosdb\\models\\__init__.py'>