Workspaces interface

  • Reference
Package:
@azure/arm-defendereasm

Interface representing a Workspaces.

Methods

beginCreateAndUpdate(string, string, WorkspacesCreateAndUpdateOptionalParams)

Create or update a Workspace.
beginCreateAndUpdateAndWait(string, string, WorkspacesCreateAndUpdateOptionalParams)

Create or update a Workspace.
beginDelete(string, string, WorkspacesDeleteOptionalParams)

Delete a Workspace.
beginDeleteAndWait(string, string, WorkspacesDeleteOptionalParams)

Delete a Workspace.
get(string, string, WorkspacesGetOptionalParams)

Returns a workspace with the given name.
listByResourceGroup(string, WorkspacesListByResourceGroupOptionalParams)

Returns a list of workspaces in the given resource group.
listBySubscription(WorkspacesListBySubscriptionOptionalParams)

Returns a list of workspaces under the given subscription.
update(string, string, WorkspacesUpdateOptionalParams)

Update a Workspace.

Method Details

beginCreateAndUpdate(string, string, WorkspacesCreateAndUpdateOptionalParams)

Create or update a Workspace.

function beginCreateAndUpdate(resourceGroupName: string, workspaceName: string, options?: WorkspacesCreateAndUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkspaceResource>, WorkspaceResource>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the Workspace.

options
WorkspacesCreateAndUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<WorkspaceResource>, WorkspaceResource>>

beginCreateAndUpdateAndWait(string, string, WorkspacesCreateAndUpdateOptionalParams)

Create or update a Workspace.

function beginCreateAndUpdateAndWait(resourceGroupName: string, workspaceName: string, options?: WorkspacesCreateAndUpdateOptionalParams): Promise<WorkspaceResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the Workspace.

options
WorkspacesCreateAndUpdateOptionalParams

The options parameters.

Returns

Promise<WorkspaceResource>

beginDelete(string, string, WorkspacesDeleteOptionalParams)

Delete a Workspace.

function beginDelete(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the Workspace.

options
WorkspacesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, WorkspacesDeleteOptionalParams)

Delete a Workspace.

function beginDeleteAndWait(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the Workspace.

options
WorkspacesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, WorkspacesGetOptionalParams)

Returns a workspace with the given name.

function get(resourceGroupName: string, workspaceName: string, options?: WorkspacesGetOptionalParams): Promise<WorkspaceResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the Workspace.

options
WorkspacesGetOptionalParams

The options parameters.

Returns

Promise<WorkspaceResource>

listByResourceGroup(string, WorkspacesListByResourceGroupOptionalParams)

Returns a list of workspaces in the given resource group.

function listByResourceGroup(resourceGroupName: string, options?: WorkspacesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<WorkspaceResource, WorkspaceResource[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options
WorkspacesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<WorkspaceResource, WorkspaceResource[], PageSettings>

listBySubscription(WorkspacesListBySubscriptionOptionalParams)

Returns a list of workspaces under the given subscription.

function listBySubscription(options?: WorkspacesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<WorkspaceResource, WorkspaceResource[], PageSettings>

Parameters

options
WorkspacesListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<WorkspaceResource, WorkspaceResource[], PageSettings>

update(string, string, WorkspacesUpdateOptionalParams)

Update a Workspace.

function update(resourceGroupName: string, workspaceName: string, options?: WorkspacesUpdateOptionalParams): Promise<WorkspaceResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the Workspace.

options
WorkspacesUpdateOptionalParams

The options parameters.

Returns

Promise<WorkspaceResource>