NotebookWorkspaces interface
Interface representing a NotebookWorkspaces.
Methods
Method Details
beginCreateOrUpdate(string, string, string, NotebookWorkspaceCreateUpdateParameters, NotebookWorkspacesCreateOrUpdateOptionalParams)
Creates the notebook workspace for a Cosmos DB account.
function beginCreateOrUpdate(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, notebookCreateUpdateParameters: NotebookWorkspaceCreateUpdateParameters, options?: NotebookWorkspacesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<NotebookWorkspace>, NotebookWorkspace>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- notebookWorkspaceName
-
string
The name of the notebook workspace resource.
- notebookCreateUpdateParameters
- NotebookWorkspaceCreateUpdateParameters
The notebook workspace to create for the current database account.
The options parameters.
Returns
beginCreateOrUpdateAndWait(string, string, string, NotebookWorkspaceCreateUpdateParameters, NotebookWorkspacesCreateOrUpdateOptionalParams)
Creates the notebook workspace for a Cosmos DB account.
function beginCreateOrUpdateAndWait(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, notebookCreateUpdateParameters: NotebookWorkspaceCreateUpdateParameters, options?: NotebookWorkspacesCreateOrUpdateOptionalParams): Promise<NotebookWorkspace>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- notebookWorkspaceName
-
string
The name of the notebook workspace resource.
- notebookCreateUpdateParameters
- NotebookWorkspaceCreateUpdateParameters
The notebook workspace to create for the current database account.
The options parameters.
Returns
Promise<NotebookWorkspace>
beginDelete(string, string, string, NotebookWorkspacesDeleteOptionalParams)
Deletes the notebook workspace for a Cosmos DB account.
function beginDelete(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- notebookWorkspaceName
-
string
The name of the notebook workspace resource.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, NotebookWorkspacesDeleteOptionalParams)
Deletes the notebook workspace for a Cosmos DB account.
function beginDeleteAndWait(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- notebookWorkspaceName
-
string
The name of the notebook workspace resource.
The options parameters.
Returns
Promise<void>
beginRegenerateAuthToken(string, string, string, NotebookWorkspacesRegenerateAuthTokenOptionalParams)
Regenerates the auth token for the notebook workspace
function beginRegenerateAuthToken(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesRegenerateAuthTokenOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- notebookWorkspaceName
-
string
The name of the notebook workspace resource.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<void>, void>>
beginRegenerateAuthTokenAndWait(string, string, string, NotebookWorkspacesRegenerateAuthTokenOptionalParams)
Regenerates the auth token for the notebook workspace
function beginRegenerateAuthTokenAndWait(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesRegenerateAuthTokenOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- notebookWorkspaceName
-
string
The name of the notebook workspace resource.
The options parameters.
Returns
Promise<void>
beginStart(string, string, string, NotebookWorkspacesStartOptionalParams)
Starts the notebook workspace
function beginStart(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesStartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- notebookWorkspaceName
-
string
The name of the notebook workspace resource.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<void>, void>>
beginStartAndWait(string, string, string, NotebookWorkspacesStartOptionalParams)
Starts the notebook workspace
function beginStartAndWait(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesStartOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- notebookWorkspaceName
-
string
The name of the notebook workspace resource.
The options parameters.
Returns
Promise<void>
get(string, string, string, NotebookWorkspacesGetOptionalParams)
Gets the notebook workspace for a Cosmos DB account.
function get(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesGetOptionalParams): Promise<NotebookWorkspace>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- notebookWorkspaceName
-
string
The name of the notebook workspace resource.
The options parameters.
Returns
Promise<NotebookWorkspace>
listByDatabaseAccount(string, string, NotebookWorkspacesListByDatabaseAccountOptionalParams)
Gets the notebook workspace resources of an existing Cosmos DB account.
function listByDatabaseAccount(resourceGroupName: string, accountName: string, options?: NotebookWorkspacesListByDatabaseAccountOptionalParams): PagedAsyncIterableIterator<NotebookWorkspace, NotebookWorkspace[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
The options parameters.
Returns
listConnectionInfo(string, string, string, NotebookWorkspacesListConnectionInfoOptionalParams)
Retrieves the connection info for the notebook workspace
function listConnectionInfo(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesListConnectionInfoOptionalParams): Promise<NotebookWorkspaceConnectionInfoResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- notebookWorkspaceName
-
string
The name of the notebook workspace resource.
The options parameters.
Returns
Azure SDK for JavaScript
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for