Assessments interface
Interface representing a Assessments.
Methods
| create(string, string, string, string, Assessments |
Create a new assessment with the given name and the specified settings. Since name of an assessment in a project is a unique identifier, if an assessment with the name provided already exists, then the existing assessment is updated. Any PUT operation, resulting in either create or update on an assessment, will cause the assessment to go in a "InProgress" state. This will be indicated by the field 'computationState' on the Assessment object. During this time no other PUT operation will be allowed on that assessment object, nor will a Delete operation. Once the computation for the assessment is complete, the field 'computationState' will be updated to 'Ready', and then other PUT or DELETE operations can happen on the assessment. When assessment is under computation, any PUT will lead to a 400 - Bad Request error. |
| delete(string, string, string, string, Assessments |
Delete an assessment from the project. The machines remain in the assessment. Deleting a non-existent assessment results in a no-operation. When an assessment is under computation, as indicated by the 'computationState' field, it cannot be deleted. Any such attempt will return a 400 - Bad Request. |
| get(string, string, string, string, Assessments |
Get an existing assessment with the specified name. Returns a json object of type 'assessment' as specified in Models section. |
| get |
Get the URL for downloading the assessment in a report format. |
| list |
Get all assessments created for the specified group. Returns a json array of objects of type 'assessment' as specified in Models section. |
| list |
Get all assessments created in the project. Returns a json array of objects of type 'assessment' as specified in Models section. |
Method Details
create(string, string, string, string, AssessmentsCreateOptionalParams)
Create a new assessment with the given name and the specified settings. Since name of an assessment in a project is a unique identifier, if an assessment with the name provided already exists, then the existing assessment is updated.
Any PUT operation, resulting in either create or update on an assessment, will cause the assessment to go in a "InProgress" state. This will be indicated by the field 'computationState' on the Assessment object. During this time no other PUT operation will be allowed on that assessment object, nor will a Delete operation. Once the computation for the assessment is complete, the field 'computationState' will be updated to 'Ready', and then other PUT or DELETE operations can happen on the assessment.
When assessment is under computation, any PUT will lead to a 400 - Bad Request error.
function create(resourceGroupName: string, projectName: string, groupName: string, assessmentName: string, options?: AssessmentsCreateOptionalParams): Promise<AssessmentsCreateResponse>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.
- assessmentName
-
string
Unique name of an assessment within a project.
- options
- AssessmentsCreateOptionalParams
The options parameters.
Returns
Promise<AssessmentsCreateResponse>
delete(string, string, string, string, AssessmentsDeleteOptionalParams)
Delete an assessment from the project. The machines remain in the assessment. Deleting a non-existent assessment results in a no-operation.
When an assessment is under computation, as indicated by the 'computationState' field, it cannot be deleted. Any such attempt will return a 400 - Bad Request.
function delete(resourceGroupName: string, projectName: string, groupName: string, assessmentName: string, options?: AssessmentsDeleteOptionalParams): Promise<AssessmentsDeleteHeaders>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.
- assessmentName
-
string
Unique name of an assessment within a project.
- options
- AssessmentsDeleteOptionalParams
The options parameters.
Returns
Promise<AssessmentsDeleteHeaders>
get(string, string, string, string, AssessmentsGetOptionalParams)
Get an existing assessment with the specified name. Returns a json object of type 'assessment' as specified in Models section.
function get(resourceGroupName: string, projectName: string, groupName: string, assessmentName: string, options?: AssessmentsGetOptionalParams): Promise<AssessmentsGetResponse>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.
- assessmentName
-
string
Unique name of an assessment within a project.
- options
- AssessmentsGetOptionalParams
The options parameters.
Returns
Promise<AssessmentsGetResponse>
getReportDownloadUrl(string, string, string, string, AssessmentsGetReportDownloadUrlOptionalParams)
Get the URL for downloading the assessment in a report format.
function getReportDownloadUrl(resourceGroupName: string, projectName: string, groupName: string, assessmentName: string, options?: AssessmentsGetReportDownloadUrlOptionalParams): Promise<AssessmentsGetReportDownloadUrlResponse>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.
- assessmentName
-
string
Unique name of an assessment within a project.
The options parameters.
Returns
listByGroup(string, string, string, AssessmentsListByGroupOptionalParams)
Get all assessments created for the specified group.
Returns a json array of objects of type 'assessment' as specified in Models section.
function listByGroup(resourceGroupName: string, projectName: string, groupName: string, options?: AssessmentsListByGroupOptionalParams): PagedAsyncIterableIterator<Assessment, Assessment[], PageSettings>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.
The options parameters.
Returns
listByProject(string, string, AssessmentsListByProjectOptionalParams)
Get all assessments created in the project.
Returns a json array of objects of type 'assessment' as specified in Models section.
function listByProject(resourceGroupName: string, projectName: string, options?: AssessmentsListByProjectOptionalParams): PagedAsyncIterableIterator<Assessment, Assessment[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the Azure Resource Group that project is part of.
- projectName
-
string
Name of the Azure Migrate project.
The options parameters.