Package version:

Interface Workspaces

Interface representing a Workspaces.

Hierarchy

Workspaces

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait get list listByResourceGroup update

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, parameters: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Workspace>, Workspace>>
Create or update a workspace.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- parameters: Workspace
  
  The parameters required to create or update a workspace.
- Optional options: WorkspacesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<Workspace>, Workspace>>
- Defined in operationsInterfaces/workspaces.ts:51

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, parameters: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<Workspace>
Create or update a workspace.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- parameters: Workspace
  
  The parameters required to create or update a workspace.
- Optional options: WorkspacesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<Workspace>
- Defined in operationsInterfaces/workspaces.ts:69

beginDelete

beginDelete(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- Optional options: WorkspacesDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/workspaces.ts:83

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams): Promise<void>
Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- Optional options: WorkspacesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/workspaces.ts:96

get

get(resourceGroupName: string, workspaceName: string, options?: WorkspacesGetOptionalParams): Promise<Workspace>
Gets a workspace instance.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- Optional options: WorkspacesGetOptionalParams
  
  The options parameters.
Returns Promise<Workspace>
- Defined in operationsInterfaces/workspaces.ts:107

list

list(options?: WorkspacesListOptionalParams): PagedAsyncIterableIterator<Workspace>
Gets the workspaces in a subscription.
Parameters
- Optional options: WorkspacesListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Workspace>
- Defined in operationsInterfaces/workspaces.ts:32

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: WorkspacesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Workspace>
Gets workspaces in a resource group.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- Optional options: WorkspacesListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Workspace>
- Defined in operationsInterfaces/workspaces.ts:40

update

update(resourceGroupName: string, workspaceName: string, parameters: WorkspacePatch, options?: WorkspacesUpdateOptionalParams): Promise<Workspace>
Updates a workspace.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- parameters: WorkspacePatch
  
  The parameters required to patch a workspace.
- Optional options: WorkspacesUpdateOptionalParams
  
  The options parameters.
Returns Promise<Workspace>
- Defined in operationsInterfaces/workspaces.ts:119

Interface Workspaces

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

workspaceName: string

parameters: Workspace

Optional options: WorkspacesCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<Workspace>, Workspace>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

workspaceName: string

parameters: Workspace

Optional options: WorkspacesCreateOrUpdateOptionalParams

Returns Promise<Workspace>

beginDelete

Parameters

resourceGroupName: string

workspaceName: string

Optional options: WorkspacesDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

workspaceName: string

Optional options: WorkspacesDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

workspaceName: string

Optional options: WorkspacesGetOptionalParams

Returns Promise<Workspace>

list

Parameters

Optional options: WorkspacesListOptionalParams

Returns PagedAsyncIterableIterator<Workspace>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: WorkspacesListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<Workspace>

update

Parameters

resourceGroupName: string

workspaceName: string

parameters: WorkspacePatch

Optional options: WorkspacesUpdateOptionalParams

Returns Promise<Workspace>

Settings

Member Visibility

Theme

`Optional` options: WorkspacesCreateOrUpdateOptionalParams

`Optional` options: WorkspacesCreateOrUpdateOptionalParams

`Optional` options: WorkspacesDeleteOptionalParams

`Optional` options: WorkspacesDeleteOptionalParams

`Optional` options: WorkspacesGetOptionalParams

`Optional` options: WorkspacesListOptionalParams

`Optional` options: WorkspacesListByResourceGroupOptionalParams

`Optional` options: WorkspacesUpdateOptionalParams