Projects interface

Package:

@azure/arm-migrate

Interface representing a Projects.

Methods

assessmentOptions(string, string, string, ProjectsAssessmentOptionsOptionalParams)	Get all available options for the properties of an assessment on a project.
create(string, string, ProjectsCreateOptionalParams)	Create a project with specified name. If a project already exists, update it.
delete(string, string, ProjectsDeleteOptionalParams)	Delete the project. Deleting non-existent project is a no-operation.
get(string, string, ProjectsGetOptionalParams)	Get the project with the specified name.
list(string, ProjectsListOptionalParams)	Get all the projects in the resource group.
listAssessmentOptionsList(string, string, ProjectsAssessmentOptionsListOptionalParams)	Gets list of all available options for the properties of an assessment on a project.
listBySubscription(ProjectsListBySubscriptionOptionalParams)	Get all the projects in the subscription.
update(string, string, ProjectsUpdateOptionalParams)	Update a project with specified name. Supports partial updates, for example only tags can be provided.

Method Details

assessmentOptions(string, string, string, ProjectsAssessmentOptionsOptionalParams)

Get all available options for the properties of an assessment on a project.

function assessmentOptions(resourceGroupName: string, projectName: string, assessmentOptionsName: string, options?: ProjectsAssessmentOptionsOptionalParams): Promise<ProjectsAssessmentOptionsResponse>

Parameters

resourceGroupName

string

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

projectName

string

Name of the Azure Migrate project.

assessmentOptionsName

string

Name of the assessment options. The only name accepted in default.

options

ProjectsAssessmentOptionsOptionalParams

The options parameters.

Returns

Promise<ProjectsAssessmentOptionsResponse>

create(string, string, ProjectsCreateOptionalParams)

Create a project with specified name. If a project already exists, update it.

function create(resourceGroupName: string, projectName: string, options?: ProjectsCreateOptionalParams): Promise<ProjectsCreateResponse>

Parameters

resourceGroupName

string

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

projectName

string

Name of the Azure Migrate project.

options

ProjectsCreateOptionalParams

The options parameters.

Returns

Promise<ProjectsCreateResponse>

delete(string, string, ProjectsDeleteOptionalParams)

Delete the project. Deleting non-existent project is a no-operation.

function delete(resourceGroupName: string, projectName: string, options?: ProjectsDeleteOptionalParams): Promise<ProjectsDeleteHeaders>

Parameters

resourceGroupName

string

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

projectName

string

Name of the Azure Migrate project.

options

ProjectsDeleteOptionalParams

The options parameters.

Returns

Promise<ProjectsDeleteHeaders>

get(string, string, ProjectsGetOptionalParams)

Get the project with the specified name.

function get(resourceGroupName: string, projectName: string, options?: ProjectsGetOptionalParams): Promise<ProjectsGetResponse>

Parameters

resourceGroupName

string

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

projectName

string

Name of the Azure Migrate project.

options

ProjectsGetOptionalParams

The options parameters.

Returns

Promise<ProjectsGetResponse>

list(string, ProjectsListOptionalParams)

Get all the projects in the resource group.

function list(resourceGroupName: string, options?: ProjectsListOptionalParams): PagedAsyncIterableIterator<Project, Project[], PageSettings>

Parameters

resourceGroupName

string

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

options

ProjectsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Project, Project[], PageSettings>

listAssessmentOptionsList(string, string, ProjectsAssessmentOptionsListOptionalParams)

Gets list of all available options for the properties of an assessment on a project.

function listAssessmentOptionsList(resourceGroupName: string, projectName: string, options?: ProjectsAssessmentOptionsListOptionalParams): PagedAsyncIterableIterator<AssessmentOptions, AssessmentOptions[], PageSettings>

Parameters

resourceGroupName

string

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

projectName

string

Name of the Azure Migrate project.

options

ProjectsAssessmentOptionsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AssessmentOptions, AssessmentOptions[], PageSettings>

listBySubscription(ProjectsListBySubscriptionOptionalParams)

Get all the projects in the subscription.

function listBySubscription(options?: ProjectsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Project, Project[], PageSettings>

Parameters

options

ProjectsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Project, Project[], PageSettings>

update(string, string, ProjectsUpdateOptionalParams)

Update a project with specified name. Supports partial updates, for example only tags can be provided.

function update(resourceGroupName: string, projectName: string, options?: ProjectsUpdateOptionalParams): Promise<ProjectsUpdateResponse>

Parameters

resourceGroupName

string

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

projectName

string

Name of the Azure Migrate project.

options

ProjectsUpdateOptionalParams

The options parameters.

Returns

Promise<ProjectsUpdateResponse>