azure.mgmt.cosmosdb.aio.operations.NotebookWorkspacesOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.cosmosdb.aio.operations.NotebookWorkspacesOperations
name: NotebookWorkspacesOperations
fullName: azure.mgmt.cosmosdb.aio.operations.NotebookWorkspacesOperations
module: azure.mgmt.cosmosdb.aio.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.cosmosdb.aio.CosmosDBManagementClient>'s\n\
  >\n> <xref:notebook_workspaces> attribute.\n>"
constructor:
  syntax: NotebookWorkspacesOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.cosmosdb.aio.operations.NotebookWorkspacesOperations.begin_create_or_update
  name: begin_create_or_update
  summary: Creates the notebook workspace for a Cosmos DB account.
  signature: '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: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: notebook_workspace_name
    description: 'The name of the notebook workspace resource. "default"

      Required.'
    isRequired: true
    types:
    - <xref:str>
    - <xref:azure.mgmt.cosmosdb.models.NotebookWorkspaceName>
  - name: notebook_create_update_parameters
    description: 'The notebook workspace to create for the current

      database account. Is either a NotebookWorkspaceCreateUpdateParameters type or
      a IO[bytes] type.

      Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.cosmosdb.models.NotebookWorkspaceCreateUpdateParameters>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: 'An instance of AsyncLROPoller that returns either NotebookWorkspace
      or the result of

      cls(response)'
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:azure.mgmt.cosmosdb.models.NotebookWorkspace>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.NotebookWorkspacesOperations.begin_delete
  name: begin_delete
  summary: Deletes the notebook workspace for a Cosmos DB account.
  signature: 'async begin_delete(resource_group_name: str, account_name: str, notebook_workspace_name:
    str | NotebookWorkspaceName, **kwargs: Any) -> AsyncLROPoller[None]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: notebook_workspace_name
    description: 'The name of the notebook workspace resource. "default"

      Required.'
    isRequired: true
    types:
    - <xref:str>
    - <xref:azure.mgmt.cosmosdb.models.NotebookWorkspaceName>
  return:
    description: An instance of AsyncLROPoller that returns either None or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.NotebookWorkspacesOperations.begin_regenerate_auth_token
  name: begin_regenerate_auth_token
  summary: Regenerates the auth token for the notebook workspace.
  signature: 'async begin_regenerate_auth_token(resource_group_name: str, account_name:
    str, notebook_workspace_name: str | NotebookWorkspaceName, **kwargs: Any) -> AsyncLROPoller[None]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: notebook_workspace_name
    description: 'The name of the notebook workspace resource. "default"

      Required.'
    isRequired: true
    types:
    - <xref:str>
    - <xref:azure.mgmt.cosmosdb.models.NotebookWorkspaceName>
  return:
    description: An instance of AsyncLROPoller that returns either None or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.NotebookWorkspacesOperations.begin_start
  name: begin_start
  summary: Starts the notebook workspace.
  signature: 'async begin_start(resource_group_name: str, account_name: str, notebook_workspace_name:
    str | NotebookWorkspaceName, **kwargs: Any) -> AsyncLROPoller[None]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: notebook_workspace_name
    description: 'The name of the notebook workspace resource. "default"

      Required.'
    isRequired: true
    types:
    - <xref:str>
    - <xref:azure.mgmt.cosmosdb.models.NotebookWorkspaceName>
  return:
    description: An instance of AsyncLROPoller that returns either None or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.NotebookWorkspacesOperations.get
  name: get
  summary: Gets the notebook workspace for a Cosmos DB account.
  signature: 'async get(resource_group_name: str, account_name: str, notebook_workspace_name:
    str | NotebookWorkspaceName, **kwargs: Any) -> NotebookWorkspace'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: notebook_workspace_name
    description: 'The name of the notebook workspace resource. "default"

      Required.'
    isRequired: true
    types:
    - <xref:str>
    - <xref:azure.mgmt.cosmosdb.models.NotebookWorkspaceName>
  return:
    description: NotebookWorkspace or the result of cls(response)
    types:
    - <xref:azure.mgmt.cosmosdb.models.NotebookWorkspace>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.NotebookWorkspacesOperations.list_by_database_account
  name: list_by_database_account
  summary: Gets the notebook workspace resources of an existing Cosmos DB account.
  signature: 'list_by_database_account(resource_group_name: str, account_name: str,
    **kwargs: Any) -> AsyncIterable[NotebookWorkspace]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An iterator like instance of either NotebookWorkspace or the result
      of cls(response)
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.cosmosdb.models.NotebookWorkspace>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.NotebookWorkspacesOperations.list_connection_info
  name: list_connection_info
  summary: Retrieves the connection info for the notebook workspace.
  signature: 'async list_connection_info(resource_group_name: str, account_name: str,
    notebook_workspace_name: str | NotebookWorkspaceName, **kwargs: Any) -> NotebookWorkspaceConnectionInfoResult'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: notebook_workspace_name
    description: 'The name of the notebook workspace resource. "default"

      Required.'
    isRequired: true
    types:
    - <xref:str>
    - <xref:azure.mgmt.cosmosdb.models.NotebookWorkspaceName>
  return:
    description: NotebookWorkspaceConnectionInfoResult or the result of cls(response)
    types:
    - <xref:azure.mgmt.cosmosdb.models.NotebookWorkspaceConnectionInfoResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.cosmosdb.aio.operations.NotebookWorkspacesOperations.models
  name: models
  signature: models = <module 'azure.mgmt.cosmosdb.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\cosmosdb\\models\\__init__.py'>