Share via


GroupsOperations interface

Interface representing a GroupsOperations.

Methods

beginCreate(string, string, string, Group, GroupsOperationsCreateOptionalParams)

Create a Group

beginCreateAndWait(string, string, string, Group, GroupsOperationsCreateOptionalParams)

Create a Group

beginUpdateMachines(string, string, string, UpdateGroupBody, GroupsOperationsUpdateMachinesOptionalParams)

Update machines in group by adding or removing machines.

beginUpdateMachinesAndWait(string, string, string, UpdateGroupBody, GroupsOperationsUpdateMachinesOptionalParams)

Update machines in group by adding or removing machines.

delete(string, string, string, GroupsOperationsDeleteOptionalParams)

Delete a Group

get(string, string, string, GroupsOperationsGetOptionalParams)

Get a Group

listByAssessmentProject(string, string, GroupsOperationsListByAssessmentProjectOptionalParams)

List Group resources by AssessmentProject

Method Details

beginCreate(string, string, string, Group, GroupsOperationsCreateOptionalParams)

Create a Group

function beginCreate(resourceGroupName: string, projectName: string, groupName: string, resource: Group, options?: GroupsOperationsCreateOptionalParams): Promise<SimplePollerLike<OperationState<Group>, Group>>

Parameters

resourceGroupName

string

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

projectName

string

Assessment Project Name

groupName

string

Group ARM name

resource
Group

Resource create parameters.

options
GroupsOperationsCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, string, Group, GroupsOperationsCreateOptionalParams)

Create a Group

function beginCreateAndWait(resourceGroupName: string, projectName: string, groupName: string, resource: Group, options?: GroupsOperationsCreateOptionalParams): Promise<Group>

Parameters

resourceGroupName

string

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

projectName

string

Assessment Project Name

groupName

string

Group ARM name

resource
Group

Resource create parameters.

options
GroupsOperationsCreateOptionalParams

The options parameters.

Returns

Promise<Group>

beginUpdateMachines(string, string, string, UpdateGroupBody, GroupsOperationsUpdateMachinesOptionalParams)

Update machines in group by adding or removing machines.

function beginUpdateMachines(resourceGroupName: string, projectName: string, groupName: string, body: UpdateGroupBody, options?: GroupsOperationsUpdateMachinesOptionalParams): Promise<SimplePollerLike<OperationState<Group>, Group>>

Parameters

resourceGroupName

string

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

projectName

string

Assessment Project Name

groupName

string

Group ARM name

body
UpdateGroupBody

The content of the action request

options
GroupsOperationsUpdateMachinesOptionalParams

The options parameters.

Returns

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

beginUpdateMachinesAndWait(string, string, string, UpdateGroupBody, GroupsOperationsUpdateMachinesOptionalParams)

Update machines in group by adding or removing machines.

function beginUpdateMachinesAndWait(resourceGroupName: string, projectName: string, groupName: string, body: UpdateGroupBody, options?: GroupsOperationsUpdateMachinesOptionalParams): Promise<Group>

Parameters

resourceGroupName

string

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

projectName

string

Assessment Project Name

groupName

string

Group ARM name

body
UpdateGroupBody

The content of the action request

options
GroupsOperationsUpdateMachinesOptionalParams

The options parameters.

Returns

Promise<Group>

delete(string, string, string, GroupsOperationsDeleteOptionalParams)

Delete a Group

function delete(resourceGroupName: string, projectName: string, groupName: string, options?: GroupsOperationsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

projectName

string

Assessment Project Name

groupName

string

Group ARM name

options
GroupsOperationsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, GroupsOperationsGetOptionalParams)

Get a Group

function get(resourceGroupName: string, projectName: string, groupName: string, options?: GroupsOperationsGetOptionalParams): Promise<Group>

Parameters

resourceGroupName

string

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

projectName

string

Assessment Project Name

groupName

string

Group ARM name

options
GroupsOperationsGetOptionalParams

The options parameters.

Returns

Promise<Group>

listByAssessmentProject(string, string, GroupsOperationsListByAssessmentProjectOptionalParams)

List Group resources by AssessmentProject

function listByAssessmentProject(resourceGroupName: string, projectName: string, options?: GroupsOperationsListByAssessmentProjectOptionalParams): PagedAsyncIterableIterator<Group, Group[], PageSettings>

Parameters

resourceGroupName

string

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

projectName

string

Assessment Project Name

Returns