Groups interface

Package:

@azure/arm-migrate

Interface representing a Groups.

Methods

create(string, string, string, GroupsCreateOptionalParams)	Create a new group by sending a json object of type 'group' as given in Models section as part of the Request Body. The group name in a project is unique. This operation is Idempotent.
delete(string, string, string, GroupsDeleteOptionalParams)	Delete the group from the project. The machines remain in the project. Deleting a non-existent group results in a no-operation. A group is an aggregation mechanism for machines in a project. Therefore, deleting group does not delete machines in it.
get(string, string, string, GroupsGetOptionalParams)	Get information related to a specific group in the project. Returns a json object of type 'group' as specified in the models section.
listByProject(string, string, GroupsListByProjectOptionalParams)	Get all groups created in the project. Returns a json array of objects of type 'group' as specified in the Models section.
updateMachines(string, string, string, GroupsUpdateMachinesOptionalParams)	Update machines in group by adding or removing machines.

Method Details

create(string, string, string, GroupsCreateOptionalParams)

Create a new group by sending a json object of type 'group' as given in Models section as part of the Request Body. The group name in a project is unique.

This operation is Idempotent.

function create(resourceGroupName: string, projectName: string, groupName: string, options?: GroupsCreateOptionalParams): Promise<GroupsCreateResponse>

Parameters

resourceGroupName

string

Name of the Azure Resource Group that project is part of.

projectName

string

Name of the Azure Migrate project.

groupName

string

Unique name of a group within a project.

options

GroupsCreateOptionalParams

The options parameters.

Returns

Promise<GroupsCreateResponse>

delete(string, string, string, GroupsDeleteOptionalParams)

Delete the group from the project. The machines remain in the project. Deleting a non-existent group results in a no-operation.

A group is an aggregation mechanism for machines in a project. Therefore, deleting group does not delete machines in it.

function delete(resourceGroupName: string, projectName: string, groupName: string, options?: GroupsDeleteOptionalParams): Promise<GroupsDeleteHeaders>

Parameters

resourceGroupName

string

Name of the Azure Resource Group that project is part of.

projectName

string

Name of the Azure Migrate project.

groupName

string

Unique name of a group within a project.

options

GroupsDeleteOptionalParams

The options parameters.

Returns

Promise<GroupsDeleteHeaders>

get(string, string, string, GroupsGetOptionalParams)

Get information related to a specific group in the project. Returns a json object of type 'group' as specified in the models section.

function get(resourceGroupName: string, projectName: string, groupName: string, options?: GroupsGetOptionalParams): Promise<GroupsGetResponse>

Parameters

resourceGroupName

string

Name of the Azure Resource Group that project is part of.

projectName

string

Name of the Azure Migrate project.

groupName

string

Unique name of a group within a project.

options

GroupsGetOptionalParams

The options parameters.

Returns

Promise<GroupsGetResponse>

listByProject(string, string, GroupsListByProjectOptionalParams)

Get all groups created in the project. Returns a json array of objects of type 'group' as specified in the Models section.

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

Parameters

resourceGroupName

string

Name of the Azure Resource Group that project is part of.

projectName

string

Name of the Azure Migrate project.

options

GroupsListByProjectOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Group, Group[], PageSettings>

updateMachines(string, string, string, GroupsUpdateMachinesOptionalParams)

Update machines in group by adding or removing machines.

function updateMachines(resourceGroupName: string, projectName: string, groupName: string, options?: GroupsUpdateMachinesOptionalParams): Promise<GroupsUpdateMachinesResponse>

Parameters

resourceGroupName

string

Name of the Azure Resource Group that project is part of.

projectName

string

Name of the Azure Migrate project.

groupName

string

Unique name of a group within a project.

options

GroupsUpdateMachinesOptionalParams

The options parameters.

Returns

Promise<GroupsUpdateMachinesResponse>