NotebookWorkspacesOperations interface

Package:

@azure/arm-cosmosdb

Interface representing a NotebookWorkspaces operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginRegenerateAuthToken
beginRegenerateAuthTokenAndWait
beginStart
beginStartAndWait
createOrUpdate	Creates the notebook workspace for a Cosmos DB account.
delete
get	Gets the notebook workspace for a Cosmos DB account.
listByDatabaseAccount	Gets the notebook workspace resources of an existing Cosmos DB account.
listConnectionInfo	Retrieves the connection info for the notebook workspace
regenerateAuthToken	Regenerates the auth token for the notebook workspace
start	Starts the notebook workspace

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, accountName: string, notebookWorkspaceName: string, notebookCreateUpdateParameters: NotebookWorkspaceCreateUpdateParameters, options?: NotebookWorkspacesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<NotebookWorkspace>, NotebookWorkspace>>

Property Value

(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, notebookCreateUpdateParameters: NotebookWorkspaceCreateUpdateParameters, options?: NotebookWorkspacesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<NotebookWorkspace>, NotebookWorkspace>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, accountName: string, notebookWorkspaceName: string, notebookCreateUpdateParameters: NotebookWorkspaceCreateUpdateParameters, options?: NotebookWorkspacesCreateOrUpdateOptionalParams) => Promise<NotebookWorkspace>

Property Value

(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, notebookCreateUpdateParameters: NotebookWorkspaceCreateUpdateParameters, options?: NotebookWorkspacesCreateOrUpdateOptionalParams) => Promise<NotebookWorkspace>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesDeleteOptionalParams) => Promise<void>

beginRegenerateAuthToken

Warning

This API is now deprecated.

use regenerateAuthToken instead

beginRegenerateAuthToken: (resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesRegenerateAuthTokenOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesRegenerateAuthTokenOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginRegenerateAuthTokenAndWait

Warning

This API is now deprecated.

use regenerateAuthToken instead

beginRegenerateAuthTokenAndWait: (resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesRegenerateAuthTokenOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesRegenerateAuthTokenOptionalParams) => Promise<void>

beginStart

Warning

This API is now deprecated.

use start instead

beginStart: (resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesStartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesStartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginStartAndWait

Warning

This API is now deprecated.

use start instead

beginStartAndWait: (resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesStartOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesStartOptionalParams) => Promise<void>

createOrUpdate

Creates the notebook workspace for a Cosmos DB account.

createOrUpdate: (resourceGroupName: string, accountName: string, notebookWorkspaceName: string, notebookCreateUpdateParameters: NotebookWorkspaceCreateUpdateParameters, options?: NotebookWorkspacesCreateOrUpdateOptionalParams) => PollerLike<OperationState<NotebookWorkspace>, NotebookWorkspace>

Property Value

(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, notebookCreateUpdateParameters: NotebookWorkspaceCreateUpdateParameters, options?: NotebookWorkspacesCreateOrUpdateOptionalParams) => PollerLike<OperationState<NotebookWorkspace>, NotebookWorkspace>

delete

delete: (resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets the notebook workspace for a Cosmos DB account.

get: (resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesGetOptionalParams) => Promise<NotebookWorkspace>

Property Value

(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesGetOptionalParams) => Promise<NotebookWorkspace>

listByDatabaseAccount

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

listByDatabaseAccount: (resourceGroupName: string, accountName: string, options?: NotebookWorkspacesListByDatabaseAccountOptionalParams) => PagedAsyncIterableIterator<NotebookWorkspace, NotebookWorkspace[], PageSettings>

Property Value

(resourceGroupName: string, accountName: string, options?: NotebookWorkspacesListByDatabaseAccountOptionalParams) => PagedAsyncIterableIterator<NotebookWorkspace, NotebookWorkspace[], PageSettings>

listConnectionInfo

Retrieves the connection info for the notebook workspace

listConnectionInfo: (resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesListConnectionInfoOptionalParams) => Promise<NotebookWorkspaceConnectionInfoResult>

Property Value

(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesListConnectionInfoOptionalParams) => Promise<NotebookWorkspaceConnectionInfoResult>

regenerateAuthToken

Regenerates the auth token for the notebook workspace

regenerateAuthToken: (resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesRegenerateAuthTokenOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesRegenerateAuthTokenOptionalParams) => PollerLike<OperationState<void>, void>

start

Starts the notebook workspace

start: (resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesStartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, notebookWorkspaceName: string, options?: NotebookWorkspacesStartOptionalParams) => PollerLike<OperationState<void>, void>