Assessments - Get

Service:: Azure Migrate

API Version:: 2019-10-01

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

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

URI Parameters

Name	In	Required	Type	Description
assessmentName	path	True	string	Unique name of an assessment within a project.
groupName	path	True	string	Unique name of a group within a project.
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	Assessment	OK. Returns Assessment object. Headers x-ms-request-id: string
Other Status Codes	CloudError	Error response describing why the operation failed.

Name

Type

Description

200 OK

Assessment

OK. Returns Assessment object.

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_Get

Sample request

HTTP

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

Sample response

Status code:: 200

{
  "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
  }
}

Definitions

Name	Description
Assessment	An assessment created for a group in the Migration project.
AssessmentProperties	Properties of an assessment.
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

Object

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

Object

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 (double)	Confidence rating percentage for assessment. Can be in the range [0, 100].
createdTimestamp	string (date-time)	Time when this project was created. Date-Time represented in ISO-8601 format.
currency	Currency	Currency to report prices in.
discountPercentage	number (double)	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 (double)	Monthly network cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
monthlyComputeCost	number (double)	Monthly compute cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
monthlyPremiumStorageCost	number (double)	Monthly premium storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
monthlyStandardSSDStorageCost	number (double)	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 (double)	Monthly storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month.
numberOfMachines	integer (int32)	Number of assessed machines part of this assessment.
percentile	Percentile	Percentile of performance data used to recommend Azure size.
perfDataEndTime	string (date-time)	End time to consider performance data for assessment
perfDataStartTime	string (date-time)	Start time to consider performance data for assessment
pricesTimestamp	string (date-time)	Time when the Azure Prices were queried. Date-Time represented in ISO-8601 format.
reservedInstance	ReservedInstance	Azure reserved instance.
scalingFactor	number (double)	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 (date-time)	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.

AssessmentSizingCriterion

Enumeration

Assessment sizing criterion.

Value	Description
PerformanceBased
AsOnPremises

AssessmentStage

Enumeration

User configurable setting that describes the status of the assessment.

Value	Description
InProgress
UnderReview
Approved

AssessmentStatus

Enumeration

Whether the assessment has been created and is valid.

Value	Description
Created
Updated
Running
Completed
Invalid
OutOfSync
OutDated

AzureDiskType

Enumeration

Storage type selected for this disk.

Value	Description
Unknown
Standard
Premium
StandardSSD
StandardOrPremium

AzureHybridUseBenefit

Enumeration

AHUB discount on windows virtual machines.

Value	Description
Unknown
Yes
No

AzureLocation

Enumeration

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

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

AzureOfferCode

Enumeration

Offer code according to which cost estimation is done.

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

AzurePricingTier

Enumeration

Pricing tier for Size evaluation.

Value	Description
Standard
Basic

AzureStorageRedundancy

Enumeration

Storage Redundancy type offered by Azure.

Value	Description
Unknown
LocallyRedundant
ZoneRedundant
GeoRedundant
ReadAccessGeoRedundant

AzureVmFamily

Enumeration

List of azure VM families.

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

CloudError

Object

An error response from the Azure Migrate service.

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

CloudErrorBody

Object

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

Enumeration

Currency to report prices in.

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

Percentile

Enumeration

Percentile of performance data used to recommend Azure size.

Value	Description
Percentile50
Percentile90
Percentile95
Percentile99

ReservedInstance

Enumeration

Azure reserved instance.

Value	Description
None
RI1Year
RI3Year

TimeRange

Enumeration

Time range of performance data used to recommend a size.

Value	Description
Day
Week
Month
Custom

VmUptime

Object

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

Share via

Assessments - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Assessments_Get

Sample request

Sample response

Definitions

Assessment

AssessmentProperties

AssessmentSizingCriterion

AssessmentStage

AssessmentStatus

AzureDiskType

AzureHybridUseBenefit

AzureLocation

AzureOfferCode

AzurePricingTier

AzureStorageRedundancy

AzureVmFamily

CloudError

CloudErrorBody

Currency

Percentile

ReservedInstance

TimeRange

VmUptime