NotebookWorkspacesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:notebook_workspaces> attribute.
- Inheritance
-
builtins.objectNotebookWorkspacesOperations
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.
begin_create_or_update(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, azure.mgmt.cosmosdb.models._cosmos_db_management_client_enums.NotebookWorkspaceName], notebook_create_update_parameters: azure.mgmt.cosmosdb.models._models_py3.NotebookWorkspaceCreateUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.NotebookWorkspace]Parameters
- notebook_workspace_name
- str or NotebookWorkspaceName
The name of the notebook workspace resource.
- notebook_create_update_parameters
- NotebookWorkspaceCreateUpdateParameters
The notebook workspace to create for the current database account.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either NotebookWorkspace or the result of cls(response)
Return type
Exceptions
begin_delete
Deletes the notebook workspace for a Cosmos DB account.
begin_delete(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, azure.mgmt.cosmosdb.models._cosmos_db_management_client_enums.NotebookWorkspaceName], **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]Parameters
- notebook_workspace_name
- str or NotebookWorkspaceName
The name of the notebook workspace resource.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_regenerate_auth_token
Regenerates the auth token for the notebook workspace.
begin_regenerate_auth_token(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, azure.mgmt.cosmosdb.models._cosmos_db_management_client_enums.NotebookWorkspaceName], **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]Parameters
- notebook_workspace_name
- str or NotebookWorkspaceName
The name of the notebook workspace resource.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_start
Starts the notebook workspace.
begin_start(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, azure.mgmt.cosmosdb.models._cosmos_db_management_client_enums.NotebookWorkspaceName], **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]Parameters
- notebook_workspace_name
- str or NotebookWorkspaceName
The name of the notebook workspace resource.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
get
Gets the notebook workspace for a Cosmos DB account.
get(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, azure.mgmt.cosmosdb.models._cosmos_db_management_client_enums.NotebookWorkspaceName], **kwargs: Any) -> azure.mgmt.cosmosdb.models._models_py3.NotebookWorkspaceParameters
- notebook_workspace_name
- str or NotebookWorkspaceName
The name of the notebook workspace resource.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
NotebookWorkspace, or the result of cls(response)
Return type
Exceptions
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) -> Iterable[azure.mgmt.cosmosdb.models._models_py3.NotebookWorkspaceListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either NotebookWorkspaceListResult or the result of cls(response)
Return type
Exceptions
list_connection_info
Retrieves the connection info for the notebook workspace.
list_connection_info(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, azure.mgmt.cosmosdb.models._cosmos_db_management_client_enums.NotebookWorkspaceName], **kwargs: Any) -> azure.mgmt.cosmosdb.models._models_py3.NotebookWorkspaceConnectionInfoResultParameters
- notebook_workspace_name
- str or NotebookWorkspaceName
The name of the notebook workspace resource.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
NotebookWorkspaceConnectionInfoResult, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.cosmosdb.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\cosmosdb\\models\\__init__.py'>Feedback
Submit and view feedback for