Assessments - List By Project

Reference

Service:: Azure Migrate

API Version:: 2019-10-01

Get all assessments created in the project.

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessments?api-version=2019-10-01

URI Parameters

Name	In	Required	Type	Description
projectName	path	True	string	Name of the Azure Migrate project.
resourceGroupName	path	True	string	Name of the Azure Resource Group that project is part of.
subscriptionId	path	True	string	Azure Subscription Id in which project was created.
api-version	query	True	string	Standard request header. Used by service to identify API version used by client.

Responses

Name	Type	Description
200 OK	AssessmentResultList	OK. Returns list of Assessment objects. Headers x-ms-request-id: string
Other Status Codes	CloudError	Error response describing why the operation failed.

Name

Type

Description

200 OK

AssessmentResultList

OK. Returns list of Assessment objects.

Headers

x-ms-request-id: string

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Assessments_ListByProject

Sample Request

HTTP

GET https://management.azure.com/subscriptions/6393a73f-8d55-47ef-b6dd-179b3e0c7910/resourceGroups/abgoyal-westEurope/providers/Microsoft.Migrate/assessmentProjects/abgoyalWEselfhostb72bproject/assessments?api-version=2019-10-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/6393a73f-8d55-47ef-b6dd-179b3e0c7910/resourceGroups/abgoyal-westeurope/providers/Microsoft.Migrate/assessmentprojects/abgoyalWEselfhostb72bproject/groups/Test1/assessments/assessment_5_9_2019_16_22_14",
      "name": "assessment_5_9_2019_16_22_14",
      "eTag": "\"21009c31-0000-0d00-0000-5cd585ad0000\"",
      "type": "Microsoft.Migrate/assessmentprojects/groups/assessments",
      "properties": {
        "azureLocation": "NorthEurope",
        "azureOfferCode": "MSAZR0003P",
        "eaSubscriptionId": null,
        "azurePricingTier": "Standard",
        "azureStorageRedundancy": "LocallyRedundant",
        "scalingFactor": 1,
        "percentile": "Percentile95",
        "timeRange": "Day",
        "perfDataStartTime": "2019-05-08T10:52:14.4896347Z",
        "perfDataEndTime": "2019-05-09T10:52:14.4896347Z",
        "stage": "InProgress",
        "currency": "USD",
        "reservedInstance": "RI3Year",
        "azureHybridUseBenefit": "Yes",
        "discountPercentage": 0,
        "confidenceRatingInPercentage": 0,
        "sizingCriterion": "PerformanceBased",
        "azureDiskType": "StandardOrPremium",
        "azureVmFamilies": [
          "Dv2_series",
          "F_series",
          "Dv3_series",
          "DS_series",
          "DSv2_series",
          "Fs_series",
          "Dsv3_series",
          "Ev3_series",
          "Esv3_series",
          "D_series",
          "M_series",
          "Fsv2_series",
          "H_series"
        ],
        "vmUptime": {
          "daysPerMonth": 31,
          "hoursPerDay": 24
        },
        "pricesTimestamp": "2019-03-26T11:07:37.139768Z",
        "createdTimestamp": "2019-05-09T10:52:14.4896347Z",
        "updatedTimestamp": "2019-05-09T10:52:14.4896347Z",
        "monthlyComputeCost": 2588.830584,
        "monthlyBandwidthCost": 0,
        "monthlyStorageCost": 238.016,
        "monthlyPremiumStorageCost": 0,
        "monthlyStandardSSDStorageCost": 0,
        "status": "OutDated",
        "numberOfMachines": 26
      }
    },
    {
      "id": "/subscriptions/6393a73f-8d55-47ef-b6dd-179b3e0c7910/resourceGroups/abgoyal-westeurope/providers/Microsoft.Migrate/assessmentprojects/abgoyalWEselfhostb72bproject/groups/Group2/assessments/assessment_5_9_2019_17_0_56",
      "name": "assessment_5_9_2019_17_0_56",
      "eTag": "\"1e000c2c-0000-0d00-0000-5cdaa4190000\"",
      "type": "Microsoft.Migrate/assessmentprojects/groups/assessments",
      "properties": {
        "azureLocation": "NorthEurope",
        "azureOfferCode": "MSAZR0003P",
        "eaSubscriptionId": null,
        "azurePricingTier": "Standard",
        "azureStorageRedundancy": "LocallyRedundant",
        "scalingFactor": 1,
        "percentile": "Percentile95",
        "timeRange": "Day",
        "perfDataStartTime": "2019-05-08T11:30:57.0035869Z",
        "perfDataEndTime": "2019-05-09T11:30:57.0035869Z",
        "stage": "InProgress",
        "currency": "USD",
        "reservedInstance": "RI3Year",
        "azureHybridUseBenefit": "Yes",
        "discountPercentage": 0,
        "confidenceRatingInPercentage": 0,
        "sizingCriterion": "PerformanceBased",
        "azureDiskType": "StandardOrPremium",
        "azureVmFamilies": [
          "Dv2_series",
          "F_series",
          "Dv3_series",
          "DS_series",
          "DSv2_series",
          "Fs_series",
          "Dsv3_series",
          "Ev3_series",
          "Esv3_series",
          "D_series",
          "M_series",
          "Fsv2_series",
          "H_series"
        ],
        "vmUptime": {
          "daysPerMonth": 31,
          "hoursPerDay": 24
        },
        "pricesTimestamp": "2019-03-26T11:07:37.139768Z",
        "createdTimestamp": "2019-05-09T11:30:57.0035869Z",
        "updatedTimestamp": "2019-05-09T11:30:57.0035869Z",
        "monthlyComputeCost": 607.443264,
        "monthlyBandwidthCost": 0,
        "monthlyStorageCost": 111.36,
        "monthlyPremiumStorageCost": 0,
        "monthlyStandardSSDStorageCost": 0,
        "status": "Completed",
        "numberOfMachines": 5
      }
    },
    {
      "id": "/subscriptions/6393a73f-8d55-47ef-b6dd-179b3e0c7910/resourceGroups/abgoyal-westeurope/providers/Microsoft.Migrate/assessmentprojects/abgoyalWEselfhostb72bproject/groups/Group2/assessments/assessment_5_14_2019_16_48_47",
      "name": "assessment_5_14_2019_16_48_47",
      "eTag": "\"1e000c2c-0000-0d00-0000-5cdaa4190000\"",
      "type": "Microsoft.Migrate/assessmentprojects/groups/assessments",
      "properties": {
        "azureLocation": "NorthEurope",
        "azureOfferCode": "MSAZR0003P",
        "eaSubscriptionId": null,
        "azurePricingTier": "Standard",
        "azureStorageRedundancy": "LocallyRedundant",
        "scalingFactor": 1,
        "percentile": "Percentile95",
        "timeRange": "Day",
        "perfDataStartTime": "2019-05-13T11:18:47.7893715Z",
        "perfDataEndTime": "2019-05-14T11:18:47.7893715Z",
        "stage": "InProgress",
        "currency": "USD",
        "reservedInstance": "RI3Year",
        "azureHybridUseBenefit": "Yes",
        "discountPercentage": 0,
        "confidenceRatingInPercentage": 0,
        "sizingCriterion": "PerformanceBased",
        "azureDiskType": "StandardOrPremium",
        "azureVmFamilies": [
          "Dv2_series",
          "F_series",
          "Dv3_series",
          "DS_series",
          "DSv2_series",
          "Fs_series",
          "Dsv3_series",
          "Ev3_series",
          "Esv3_series",
          "D_series",
          "M_series",
          "Fsv2_series",
          "H_series"
        ],
        "vmUptime": {
          "daysPerMonth": 31,
          "hoursPerDay": 24
        },
        "pricesTimestamp": "2019-03-26T11:07:37.139768Z",
        "createdTimestamp": "2019-05-14T11:18:47.7893715Z",
        "updatedTimestamp": "2019-05-14T11:18:47.7893715Z",
        "monthlyComputeCost": 607.443264,
        "monthlyBandwidthCost": 0,
        "monthlyStorageCost": 111.36,
        "monthlyPremiumStorageCost": 0,
        "monthlyStandardSSDStorageCost": 0,
        "status": "Completed",
        "numberOfMachines": 5
      }
    }
  ]
}

Definitions

Name	Description
Assessment	An assessment created for a group in the Migration project.
AssessmentProperties	Properties of an assessment.
AssessmentResultList	List of assessments.
AssessmentSizingCriterion	Assessment sizing criterion.
AssessmentStage	User configurable setting that describes the status of the assessment.
AssessmentStatus	Whether the assessment has been created and is valid.
AzureDiskType	Storage type selected for this disk.
AzureHybridUseBenefit	AHUB discount on windows virtual machines.
AzureLocation	Target Azure location for which the machines should be assessed. These enums are the same as used by Compute API.
AzureOfferCode	Offer code according to which cost estimation is done.
AzurePricingTier	Pricing tier for Size evaluation.
AzureStorageRedundancy	Storage Redundancy type offered by Azure.
AzureVmFamily	List of azure VM families.
CloudError	An error response from the Azure Migrate service.
CloudErrorBody	An error response from the Azure Migrate service.
Currency	Currency to report prices in.
Percentile	Percentile of performance data used to recommend Azure size.
ReservedInstance	Azure reserved instance.
TimeRange	Time range of performance data used to recommend a size.
VmUptime

Assessment

An assessment created for a group in the Migration project.

Name	Type	Description
eTag	string	For optimistic concurrency control.
id	string	Path reference to this assessment. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessment/{assessmentName}
name	string	Unique name of an assessment.
properties	AssessmentProperties	Properties of the assessment.
type	string	Type of the object = [Microsoft.Migrate/assessmentProjects/groups/assessments].

AssessmentProperties

Properties of an assessment.

Name	Type	Description
azureDiskType	AzureDiskType	Storage type selected for this disk.
azureHybridUseBenefit	AzureHybridUseBenefit	AHUB discount on windows virtual machines.
azureLocation	AzureLocation	Target Azure location for which the machines should be assessed. These enums are the same as used by Compute API.
azureOfferCode	AzureOfferCode	Offer code according to which cost estimation is done.
azurePricingTier	AzurePricingTier	Pricing tier for Size evaluation.
azureStorageRedundancy	AzureStorageRedundancy	Storage Redundancy type offered by Azure.
azureVmFamilies	AzureVmFamily[]	List of azure VM families.
confidenceRatingInPercentage	number	Confidence rating percentage for assessment. Can be in the range [0, 100].
createdTimestamp	string	Time when this project was created. Date-Time represented in ISO-8601 format.
currency	Currency	Currency to report prices in.
discountPercentage	number	Custom discount percentage to be applied on final costs. Can be in the range [0, 100].
eaSubscriptionId	string	Enterprise agreement subscription arm id.
monthlyBandwidthCost	number	Monthly network cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
monthlyComputeCost	number	Monthly compute cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
monthlyPremiumStorageCost	number	Monthly premium storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
monthlyStandardSSDStorageCost	number	Monthly standard SSD storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
monthlyStorageCost	number	Monthly storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
numberOfMachines	integer	Number of assessed machines part of this assessment.
percentile	Percentile	Percentile of performance data used to recommend Azure size.
perfDataEndTime	string	End time to consider performance data for assessment
perfDataStartTime	string	Start time to consider performance data for assessment
pricesTimestamp	string	Time when the Azure Prices were queried. Date-Time represented in ISO-8601 format.
reservedInstance	ReservedInstance	Azure reserved instance.
scalingFactor	number	Scaling factor used over utilization data to add a performance buffer for new machines to be created in Azure. Min Value = 1.0, Max value = 1.9, Default = 1.3.
sizingCriterion	AssessmentSizingCriterion	Assessment sizing criterion.
stage	AssessmentStage	User configurable setting that describes the status of the assessment.
status	AssessmentStatus	Whether the assessment has been created and is valid.
timeRange	TimeRange	Time range of performance data used to recommend a size.
updatedTimestamp	string	Time when this project was last updated. Date-Time represented in ISO-8601 format.
vmUptime	VmUptime	Specify the duration for which the VMs are up in the on-premises environment.

AssessmentResultList

List of assessments.

Name	Type	Description
value	Assessment[]	List of assessments.

AssessmentSizingCriterion

Assessment sizing criterion.

Name	Type	Description
AsOnPremises	string
PerformanceBased	string

AssessmentStage

User configurable setting that describes the status of the assessment.

Name	Type	Description
Approved	string
InProgress	string
UnderReview	string

AssessmentStatus

Whether the assessment has been created and is valid.

Name	Type	Description
Completed	string
Created	string
Invalid	string
OutDated	string
OutOfSync	string
Running	string
Updated	string

AzureDiskType

Storage type selected for this disk.

Name	Type	Description
Premium	string
Standard	string
StandardOrPremium	string
StandardSSD	string
Unknown	string

AzureHybridUseBenefit

AHUB discount on windows virtual machines.

Name	Type	Description
No	string
Unknown	string
Yes	string

AzureLocation

Target Azure location for which the machines should be assessed. These enums are the same as used by Compute API.

Name	Type	Description
AustraliaEast	string
AustraliaSoutheast	string
BrazilSouth	string
CanadaCentral	string
CanadaEast	string
CentralIndia	string
CentralUs	string
ChinaEast	string
ChinaNorth	string
EastAsia	string
EastUs	string
EastUs2	string
GermanyCentral	string
GermanyNortheast	string
JapanEast	string
JapanWest	string
KoreaCentral	string
KoreaSouth	string
NorthCentralUs	string
NorthEurope	string
SouthCentralUs	string
SouthIndia	string
SoutheastAsia	string
USDoDCentral	string
USDoDEast	string
USGovArizona	string
USGovIowa	string
USGovTexas	string
USGovVirginia	string
UkSouth	string
UkWest	string
Unknown	string
WestCentralUs	string
WestEurope	string
WestIndia	string
WestUs	string
WestUs2	string

AzureOfferCode

Offer code according to which cost estimation is done.

Name	Type	Description
EA	string
MSAZR0003P	string
MSAZR0022P	string
MSAZR0023P	string
MSAZR0025P	string
MSAZR0029P	string
MSAZR0036P	string
MSAZR0044P	string
MSAZR0059P	string
MSAZR0060P	string
MSAZR0062P	string
MSAZR0063P	string
MSAZR0064P	string
MSAZR0111P	string
MSAZR0120P	string
MSAZR0121P	string
MSAZR0122P	string
MSAZR0123P	string
MSAZR0124P	string
MSAZR0125P	string
MSAZR0126P	string
MSAZR0127P	string
MSAZR0128P	string
MSAZR0129P	string
MSAZR0130P	string
MSAZR0144P	string
MSAZR0148P	string
MSAZR0149P	string
MSAZRDE0003P	string
MSAZRDE0044P	string
MSAZRUSGOV0003P	string
MSMCAZR0044P	string
MSMCAZR0059P	string
MSMCAZR0060P	string
MSMCAZR0063P	string
MSMCAZR0120P	string
MSMCAZR0121P	string
MSMCAZR0125P	string
MSMCAZR0128P	string
Unknown	string

AzurePricingTier

Pricing tier for Size evaluation.

Name	Type	Description
Basic	string
Standard	string

AzureStorageRedundancy

Storage Redundancy type offered by Azure.

Name	Type	Description
GeoRedundant	string
LocallyRedundant	string
ReadAccessGeoRedundant	string
Unknown	string
ZoneRedundant	string

AzureVmFamily

List of azure VM families.

Name	Type	Description
Av2_series	string
Basic_A0_A4	string
DC_Series	string
DS_series	string
DSv2_series	string
D_series	string
Dsv3_series	string
Dv2_series	string
Dv3_series	string
Esv3_series	string
Ev3_series	string
F_series	string
Fs_series	string
Fsv2_series	string
GS_series	string
G_series	string
H_series	string
Ls_series	string
M_series	string
Standard_A0_A7	string
Standard_A8_A11	string
Unknown	string

CloudError

An error response from the Azure Migrate service.

Name	Type	Description
error	CloudErrorBody	An error response from the Azure Migrate service.

CloudErrorBody

An error response from the Azure Migrate service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

Currency

Currency to report prices in.

Name	Type	Description
ARS	string
AUD	string
BRL	string
CAD	string
CHF	string
CNY	string
DKK	string
EUR	string
GBP	string
HKD	string
IDR	string
INR	string
JPY	string
KRW	string
MXN	string
MYR	string
NOK	string
NZD	string
RUB	string
SAR	string
SEK	string
TRY	string
TWD	string
USD	string
Unknown	string
ZAR	string

Percentile

Percentile of performance data used to recommend Azure size.

Name	Type	Description
Percentile50	string
Percentile90	string
Percentile95	string
Percentile99	string

ReservedInstance

Azure reserved instance.

Name	Type	Description
None	string
RI1Year	string
RI3Year	string

TimeRange

Time range of performance data used to recommend a size.

Name	Type	Description
Custom	string
Day	string
Month	string
Week	string

VmUptime

Name	Type	Description
daysPerMonth	number	Number of days in a month for VM uptime.
hoursPerDay	number	Number of hours per day for VM uptime.

Assessments - List By Project

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Assessments_ListByProject

Sample Request

Sample Response

Definitions

Assessment

AssessmentProperties

AssessmentResultList

AssessmentSizingCriterion

AssessmentStage

AssessmentStatus

AzureDiskType

AzureHybridUseBenefit

AzureLocation

AzureOfferCode

AzurePricingTier

AzureStorageRedundancy

AzureVmFamily

CloudError

CloudErrorBody

Currency

Percentile

ReservedInstance

TimeRange

VmUptime

Additional resources