NotebookWorkspacesImpl | @azure/arm-cosmosdb

Class containing NotebookWorkspaces operations.

Hierarchy

NotebookWorkspacesImpl

Implements

NotebookWorkspaces

Index

Constructors

constructor

Methods

Constructors

constructor

new NotebookWorkspacesImpl(client: CosmosDBManagementClient): NotebookWorkspacesImpl

- Defined in operations/notebookWorkspaces.ts:37
Initialize a new instance of the class NotebookWorkspaces class.

Parameters
- client: CosmosDBManagementClient
  
  Reference to the service client
Returns NotebookWorkspacesImpl

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, accountName: string, notebookWorkspaceName: NotebookWorkspaceName, notebookCreateUpdateParameters: NotebookWorkspaceCreateUpdateParameters, options?: NotebookWorkspacesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<NotebookWorkspacesCreateOrUpdateResponse>, NotebookWorkspacesCreateOrUpdateResponse>>

Implementation of NotebookWorkspaces.beginCreateOrUpdate
- Defined in operations/notebookWorkspaces.ts:152
Creates the notebook workspace for a Cosmos DB account.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- notebookWorkspaceName: NotebookWorkspaceName
  
  The name of the notebook workspace resource.
- notebookCreateUpdateParameters: NotebookWorkspaceCreateUpdateParameters
  
  The notebook workspace to create for the current database account.
- Optional options: NotebookWorkspacesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<NotebookWorkspacesCreateOrUpdateResponse>, NotebookWorkspacesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

Implementation of NotebookWorkspaces.beginCreateOrUpdateAndWait
- Defined in operations/notebookWorkspaces.ts:231
Creates the notebook workspace for a Cosmos DB account.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- notebookWorkspaceName: NotebookWorkspaceName
  
  The name of the notebook workspace resource.
- notebookCreateUpdateParameters: NotebookWorkspaceCreateUpdateParameters
  
  The notebook workspace to create for the current database account.
- Optional options: NotebookWorkspacesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<NotebookWorkspacesCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, accountName: string, notebookWorkspaceName: NotebookWorkspaceName, options?: NotebookWorkspacesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of NotebookWorkspaces.beginDelete
- Defined in operations/notebookWorkspaces.ts:255
Deletes the notebook workspace for a Cosmos DB account.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- notebookWorkspaceName: NotebookWorkspaceName
  
  The name of the notebook workspace resource.
- Optional options: NotebookWorkspacesDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

Implementation of NotebookWorkspaces.beginDeleteAndWait
- Defined in operations/notebookWorkspaces.ts:320
Deletes the notebook workspace for a Cosmos DB account.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- notebookWorkspaceName: NotebookWorkspaceName
  
  The name of the notebook workspace resource.
- Optional options: NotebookWorkspacesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginRegenerateAuthToken

beginRegenerateAuthToken(resourceGroupName: string, accountName: string, notebookWorkspaceName: NotebookWorkspaceName, options?: NotebookWorkspacesRegenerateAuthTokenOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of NotebookWorkspaces.beginRegenerateAuthToken
- Defined in operations/notebookWorkspaces.ts:361
Regenerates the auth token for the notebook workspace

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- notebookWorkspaceName: NotebookWorkspaceName
  
  The name of the notebook workspace resource.
- Optional options: NotebookWorkspacesRegenerateAuthTokenOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRegenerateAuthTokenAndWait

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

Implementation of NotebookWorkspaces.beginRegenerateAuthTokenAndWait
- Defined in operations/notebookWorkspaces.ts:426
Regenerates the auth token for the notebook workspace

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- notebookWorkspaceName: NotebookWorkspaceName
  
  The name of the notebook workspace resource.
- Optional options: NotebookWorkspacesRegenerateAuthTokenOptionalParams
  
  The options parameters.
Returns Promise<void>

beginStart

beginStart(resourceGroupName: string, accountName: string, notebookWorkspaceName: NotebookWorkspaceName, options?: NotebookWorkspacesStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of NotebookWorkspaces.beginStart
- Defined in operations/notebookWorkspaces.ts:448
Starts the notebook workspace

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- notebookWorkspaceName: NotebookWorkspaceName
  
  The name of the notebook workspace resource.
- Optional options: NotebookWorkspacesStartOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginStartAndWait

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

Implementation of NotebookWorkspaces.beginStartAndWait
- Defined in operations/notebookWorkspaces.ts:513
Starts the notebook workspace

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- notebookWorkspaceName: NotebookWorkspaceName
  
  The name of the notebook workspace resource.
- Optional options: NotebookWorkspacesStartOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, accountName: string, notebookWorkspaceName: NotebookWorkspaceName, options?: NotebookWorkspacesGetOptionalParams): Promise<NotebookWorkspacesGetResponse>

Implementation of NotebookWorkspaces.get
- Defined in operations/notebookWorkspaces.ts:131
Gets the notebook workspace for a Cosmos DB account.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- notebookWorkspaceName: NotebookWorkspaceName
  
  The name of the notebook workspace resource.
- Optional options: NotebookWorkspacesGetOptionalParams
  
  The options parameters.
Returns Promise<NotebookWorkspacesGetResponse>

listByDatabaseAccount

listByDatabaseAccount(resourceGroupName: string, accountName: string, options?: NotebookWorkspacesListByDatabaseAccountOptionalParams): PagedAsyncIterableIterator<NotebookWorkspace>

Implementation of NotebookWorkspaces.listByDatabaseAccount
- Defined in operations/notebookWorkspaces.ts:53
Gets the notebook workspace resources of an existing Cosmos DB account.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- Optional options: NotebookWorkspacesListByDatabaseAccountOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<NotebookWorkspace>

listConnectionInfo

listConnectionInfo(resourceGroupName: string, accountName: string, notebookWorkspaceName: NotebookWorkspaceName, options?: NotebookWorkspacesListConnectionInfoOptionalParams): Promise<NotebookWorkspacesListConnectionInfoResponse>

Implementation of NotebookWorkspaces.listConnectionInfo
- Defined in operations/notebookWorkspaces.ts:342
Retrieves the connection info for the notebook workspace

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- notebookWorkspaceName: NotebookWorkspaceName
  
  The name of the notebook workspace resource.
- Optional options: NotebookWorkspacesListConnectionInfoOptionalParams
  
  The options parameters.
Returns Promise<NotebookWorkspacesListConnectionInfoResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: CosmosDBManagementClient

Returns NotebookWorkspacesImpl

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

accountName: string

notebookWorkspaceName: NotebookWorkspaceName

notebookCreateUpdateParameters: NotebookWorkspaceCreateUpdateParameters

Optional options: NotebookWorkspacesCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<NotebookWorkspacesCreateOrUpdateResponse>, NotebookWorkspacesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

accountName: string

notebookWorkspaceName: NotebookWorkspaceName

notebookCreateUpdateParameters: NotebookWorkspaceCreateUpdateParameters

Optional options: NotebookWorkspacesCreateOrUpdateOptionalParams

Returns Promise<NotebookWorkspacesCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

accountName: string

notebookWorkspaceName: NotebookWorkspaceName

Optional options: NotebookWorkspacesDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

accountName: string

notebookWorkspaceName: NotebookWorkspaceName

Optional options: NotebookWorkspacesDeleteOptionalParams

Returns Promise<void>

beginRegenerateAuthToken

Parameters

resourceGroupName: string

accountName: string

notebookWorkspaceName: NotebookWorkspaceName

Optional options: NotebookWorkspacesRegenerateAuthTokenOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRegenerateAuthTokenAndWait

Parameters

resourceGroupName: string

accountName: string

notebookWorkspaceName: NotebookWorkspaceName

Optional options: NotebookWorkspacesRegenerateAuthTokenOptionalParams

Returns Promise<void>

beginStart

Parameters

resourceGroupName: string

accountName: string

notebookWorkspaceName: NotebookWorkspaceName

Optional options: NotebookWorkspacesStartOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginStartAndWait

Parameters

resourceGroupName: string

accountName: string

notebookWorkspaceName: NotebookWorkspaceName

Optional options: NotebookWorkspacesStartOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

accountName: string

notebookWorkspaceName: NotebookWorkspaceName

Optional options: NotebookWorkspacesGetOptionalParams

Returns Promise<NotebookWorkspacesGetResponse>

listByDatabaseAccount

Parameters

resourceGroupName: string

accountName: string