Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Assessments

Package version

Class representing a Assessments.

Hierarchy

  • Assessments

Index

Constructors

Methods

Constructors

constructor

Methods

create

  • create(resourceGroupName: string, projectName: string, groupName: string, assessmentName: string, options?: Models.AssessmentsCreateOptionalParams): Promise<Models.AssessmentsCreateResponse>
  • create(resourceGroupName: string, projectName: string, groupName: string, assessmentName: string, callback: msRest.ServiceCallback<Assessment>): void
  • create(resourceGroupName: string, projectName: string, groupName: string, assessmentName: string, options: AssessmentsCreateOptionalParams, callback: msRest.ServiceCallback<Assessment>): void

  • Create a new assessment with the given name and the specified settings. Since name of an assessment in a project is a unique identiefier, 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.

    summary

    Create or Update assessment.

    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.

    • Optional options: Models.AssessmentsCreateOptionalParams

    Returns Promise<Models.AssessmentsCreateResponse>

    Promise<Models.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.

    • callback: msRest.ServiceCallback<Assessment>

      The callback

    Returns void

  • 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 optional parameters

    • callback: msRest.ServiceCallback<Assessment>

      The callback

    Returns void

deleteMethod

  • deleteMethod(resourceGroupName: string, projectName: string, groupName: string, assessmentName: string, options?: msRest.RequestOptionsBase): Promise<Models.AssessmentsDeleteResponse>
  • deleteMethod(resourceGroupName: string, projectName: string, groupName: string, assessmentName: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(resourceGroupName: string, projectName: string, groupName: string, assessmentName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • 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.

    summary

    Deletes an assessment from the project.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.AssessmentsDeleteResponse>

    Promise<Models.AssessmentsDeleteResponse>

  • 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.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

get

  • get(resourceGroupName: string, projectName: string, groupName: string, assessmentName: string, options?: msRest.RequestOptionsBase): Promise<Models.AssessmentsGetResponse>
  • get(resourceGroupName: string, projectName: string, groupName: string, assessmentName: string, callback: msRest.ServiceCallback<Assessment>): void
  • get(resourceGroupName: string, projectName: string, groupName: string, assessmentName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Assessment>): void

  • Get an existing assessment with the specified name. Returns a json object of type 'assessment' as specified in Models section.

    summary

    Get an assessment.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.AssessmentsGetResponse>

    Promise<Models.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.

    • callback: msRest.ServiceCallback<Assessment>

      The callback

    Returns void

  • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Assessment>

      The callback

    Returns void

getReportDownloadUrl

  • getReportDownloadUrl(resourceGroupName: string, projectName: string, groupName: string, assessmentName: string, options?: msRest.RequestOptionsBase): Promise<Models.AssessmentsGetReportDownloadUrlResponse>
  • getReportDownloadUrl(resourceGroupName: string, projectName: string, groupName: string, assessmentName: string, callback: msRest.ServiceCallback<DownloadUrl>): void
  • getReportDownloadUrl(resourceGroupName: string, projectName: string, groupName: string, assessmentName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<DownloadUrl>): void

  • Get the URL for downloading the assessment in a report format.

    summary

    Get download URL for the assessment report.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.AssessmentsGetReportDownloadUrlResponse>

    Promise<Models.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.

    • callback: msRest.ServiceCallback<DownloadUrl>

      The callback

    Returns void

  • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<DownloadUrl>

      The callback

    Returns void

listByGroup

  • listByGroup(resourceGroupName: string, projectName: string, groupName: string, options?: msRest.RequestOptionsBase): Promise<Models.AssessmentsListByGroupResponse>
  • listByGroup(resourceGroupName: string, projectName: string, groupName: string, callback: msRest.ServiceCallback<AssessmentResultList>): void
  • listByGroup(resourceGroupName: string, projectName: string, groupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AssessmentResultList>): void

  • Get all assessments created for the specified group.

    Returns a json array of objects of type 'assessment' as specified in Models section.

    summary

    Get all assessments created for the specified group.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.AssessmentsListByGroupResponse>

    Promise<Models.AssessmentsListByGroupResponse>

  • 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.

    • callback: msRest.ServiceCallback<AssessmentResultList>

      The callback

    Returns void

  • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AssessmentResultList>

      The callback

    Returns void

listByProject

  • listByProject(resourceGroupName: string, projectName: string, options?: msRest.RequestOptionsBase): Promise<Models.AssessmentsListByProjectResponse>
  • listByProject(resourceGroupName: string, projectName: string, callback: msRest.ServiceCallback<AssessmentResultList>): void
  • listByProject(resourceGroupName: string, projectName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AssessmentResultList>): void

  • Get all assessments created in the project.

    Returns a json array of objects of type 'assessment' as specified in Models section.

    summary

    Get all assessments created in the project.

    Parameters

    • resourceGroupName: string

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

    • projectName: string

      Name of the Azure Migrate project.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.AssessmentsListByProjectResponse>

    Promise<Models.AssessmentsListByProjectResponse>

  • Parameters

    • resourceGroupName: string

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

    • projectName: string

      Name of the Azure Migrate project.

    • callback: msRest.ServiceCallback<AssessmentResultList>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

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

    • projectName: string

      Name of the Azure Migrate project.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AssessmentResultList>

      The callback

    Returns void

Generated using TypeDoc