Microsoft.Migrate assessmentProjects/groups/assessments
Bicep resource definition
The assessmentProjects/groups/assessments resource type can be deployed to:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Migrate/assessmentProjects/groups/assessments resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Migrate/assessmentProjects/groups/assessments@2019-10-01' = {
name: 'string'
parent: resourceSymbolicName
eTag: 'string'
properties: {
azureDiskType: 'string'
azureHybridUseBenefit: 'string'
azureLocation: 'string'
azureOfferCode: 'string'
azurePricingTier: 'string'
azureStorageRedundancy: 'string'
azureVmFamilies: [
'string'
]
currency: 'string'
discountPercentage: int
percentile: 'string'
reservedInstance: 'string'
scalingFactor: int
sizingCriterion: 'string'
stage: 'string'
timeRange: 'string'
vmUptime: {
daysPerMonth: int
hoursPerDay: int
}
}
}
Property values
assessmentProjects/groups/assessments
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: groups |
| eTag | For optimistic concurrency control. | string |
| properties | Properties of the assessment. | AssessmentProperties (required) |
AssessmentProperties
| Name | Description | Value |
|---|---|---|
| azureDiskType | Storage type selected for this disk. | 'Premium' 'Standard' 'StandardOrPremium' 'StandardSSD' 'Unknown' (required) |
| azureHybridUseBenefit | AHUB discount on windows virtual machines. | 'No' 'Unknown' 'Yes' (required) |
| azureLocation | Target Azure location for which the machines should be assessed. These enums are the same as used by Compute API. | 'AustraliaEast' 'AustraliaSoutheast' 'BrazilSouth' 'CanadaCentral' 'CanadaEast' 'CentralIndia' 'CentralUs' 'ChinaEast' 'ChinaNorth' 'EastAsia' 'EastUs' 'EastUs2' 'GermanyCentral' 'GermanyNortheast' 'JapanEast' 'JapanWest' 'KoreaCentral' 'KoreaSouth' 'NorthCentralUs' 'NorthEurope' 'SouthCentralUs' 'SouthIndia' 'SoutheastAsia' 'USDoDCentral' 'USDoDEast' 'USGovArizona' 'USGovIowa' 'USGovTexas' 'USGovVirginia' 'UkSouth' 'UkWest' 'Unknown' 'WestCentralUs' 'WestEurope' 'WestIndia' 'WestUs' 'WestUs2' (required) |
| azureOfferCode | Offer code according to which cost estimation is done. | 'EA' 'MSAZR0003P' 'MSAZR0022P' 'MSAZR0023P' 'MSAZR0025P' 'MSAZR0029P' 'MSAZR0036P' 'MSAZR0044P' 'MSAZR0059P' 'MSAZR0060P' 'MSAZR0062P' 'MSAZR0063P' 'MSAZR0064P' 'MSAZR0111P' 'MSAZR0120P' 'MSAZR0121P' 'MSAZR0122P' 'MSAZR0123P' 'MSAZR0124P' 'MSAZR0125P' 'MSAZR0126P' 'MSAZR0127P' 'MSAZR0128P' 'MSAZR0129P' 'MSAZR0130P' 'MSAZR0144P' 'MSAZR0148P' 'MSAZR0149P' 'MSAZRDE0003P' 'MSAZRDE0044P' 'MSAZRUSGOV0003P' 'MSMCAZR0044P' 'MSMCAZR0059P' 'MSMCAZR0060P' 'MSMCAZR0063P' 'MSMCAZR0120P' 'MSMCAZR0121P' 'MSMCAZR0125P' 'MSMCAZR0128P' 'Unknown' (required) |
| azurePricingTier | Pricing tier for Size evaluation. | 'Basic' 'Standard' (required) |
| azureStorageRedundancy | Storage Redundancy type offered by Azure. | 'GeoRedundant' 'LocallyRedundant' 'ReadAccessGeoRedundant' 'Unknown' 'ZoneRedundant' (required) |
| azureVmFamilies | List of azure VM families. | String array containing any of: 'Av2_series' 'Basic_A0_A4' 'DC_Series' 'DS_series' 'DSv2_series' 'D_series' 'Dsv3_series' 'Dv2_series' 'Dv3_series' 'Esv3_series' 'Ev3_series' 'F_series' 'Fs_series' 'Fsv2_series' 'GS_series' 'G_series' 'H_series' 'Ls_series' 'M_series' 'Standard_A0_A7' 'Standard_A8_A11' 'Unknown' (required) |
| currency | Currency to report prices in. | 'ARS' 'AUD' 'BRL' 'CAD' 'CHF' 'CNY' 'DKK' 'EUR' 'GBP' 'HKD' 'IDR' 'INR' 'JPY' 'KRW' 'MXN' 'MYR' 'NOK' 'NZD' 'RUB' 'SAR' 'SEK' 'TRY' 'TWD' 'USD' 'Unknown' 'ZAR' (required) |
| discountPercentage | Custom discount percentage to be applied on final costs. Can be in the range [0, 100]. | int (required) |
| percentile | Percentile of performance data used to recommend Azure size. | 'Percentile50' 'Percentile90' 'Percentile95' 'Percentile99' (required) |
| reservedInstance | Azure reserved instance. | 'None' 'RI1Year' 'RI3Year' (required) |
| scalingFactor | 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. | int (required) |
| sizingCriterion | Assessment sizing criterion. | 'AsOnPremises' 'PerformanceBased' (required) |
| stage | User configurable setting that describes the status of the assessment. | 'Approved' 'InProgress' 'UnderReview' (required) |
| timeRange | Time range of performance data used to recommend a size. | 'Custom' 'Day' 'Month' 'Week' (required) |
| vmUptime | Specify the duration for which the VMs are up in the on-premises environment. | VmUptime (required) |
VmUptime
| Name | Description | Value |
|---|---|---|
| daysPerMonth | Number of days in a month for VM uptime. | int |
| hoursPerDay | Number of hours per day for VM uptime. | int |
ARM template resource definition
The assessmentProjects/groups/assessments resource type can be deployed to:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Migrate/assessmentProjects/groups/assessments resource, add the following JSON to your template.
{
"type": "Microsoft.Migrate/assessmentProjects/groups/assessments",
"apiVersion": "2019-10-01",
"name": "string",
"eTag": "string",
"properties": {
"azureDiskType": "string",
"azureHybridUseBenefit": "string",
"azureLocation": "string",
"azureOfferCode": "string",
"azurePricingTier": "string",
"azureStorageRedundancy": "string",
"azureVmFamilies": [ "string" ],
"currency": "string",
"discountPercentage": "int",
"percentile": "string",
"reservedInstance": "string",
"scalingFactor": "int",
"sizingCriterion": "string",
"stage": "string",
"timeRange": "string",
"vmUptime": {
"daysPerMonth": "int",
"hoursPerDay": "int"
}
}
}
Property values
assessmentProjects/groups/assessments
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Migrate/assessmentProjects/groups/assessments' |
| apiVersion | The resource api version | '2019-10-01' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| eTag | For optimistic concurrency control. | string |
| properties | Properties of the assessment. | AssessmentProperties (required) |
AssessmentProperties
| Name | Description | Value |
|---|---|---|
| azureDiskType | Storage type selected for this disk. | 'Premium' 'Standard' 'StandardOrPremium' 'StandardSSD' 'Unknown' (required) |
| azureHybridUseBenefit | AHUB discount on windows virtual machines. | 'No' 'Unknown' 'Yes' (required) |
| azureLocation | Target Azure location for which the machines should be assessed. These enums are the same as used by Compute API. | 'AustraliaEast' 'AustraliaSoutheast' 'BrazilSouth' 'CanadaCentral' 'CanadaEast' 'CentralIndia' 'CentralUs' 'ChinaEast' 'ChinaNorth' 'EastAsia' 'EastUs' 'EastUs2' 'GermanyCentral' 'GermanyNortheast' 'JapanEast' 'JapanWest' 'KoreaCentral' 'KoreaSouth' 'NorthCentralUs' 'NorthEurope' 'SouthCentralUs' 'SouthIndia' 'SoutheastAsia' 'USDoDCentral' 'USDoDEast' 'USGovArizona' 'USGovIowa' 'USGovTexas' 'USGovVirginia' 'UkSouth' 'UkWest' 'Unknown' 'WestCentralUs' 'WestEurope' 'WestIndia' 'WestUs' 'WestUs2' (required) |
| azureOfferCode | Offer code according to which cost estimation is done. | 'EA' 'MSAZR0003P' 'MSAZR0022P' 'MSAZR0023P' 'MSAZR0025P' 'MSAZR0029P' 'MSAZR0036P' 'MSAZR0044P' 'MSAZR0059P' 'MSAZR0060P' 'MSAZR0062P' 'MSAZR0063P' 'MSAZR0064P' 'MSAZR0111P' 'MSAZR0120P' 'MSAZR0121P' 'MSAZR0122P' 'MSAZR0123P' 'MSAZR0124P' 'MSAZR0125P' 'MSAZR0126P' 'MSAZR0127P' 'MSAZR0128P' 'MSAZR0129P' 'MSAZR0130P' 'MSAZR0144P' 'MSAZR0148P' 'MSAZR0149P' 'MSAZRDE0003P' 'MSAZRDE0044P' 'MSAZRUSGOV0003P' 'MSMCAZR0044P' 'MSMCAZR0059P' 'MSMCAZR0060P' 'MSMCAZR0063P' 'MSMCAZR0120P' 'MSMCAZR0121P' 'MSMCAZR0125P' 'MSMCAZR0128P' 'Unknown' (required) |
| azurePricingTier | Pricing tier for Size evaluation. | 'Basic' 'Standard' (required) |
| azureStorageRedundancy | Storage Redundancy type offered by Azure. | 'GeoRedundant' 'LocallyRedundant' 'ReadAccessGeoRedundant' 'Unknown' 'ZoneRedundant' (required) |
| azureVmFamilies | List of azure VM families. | String array containing any of: 'Av2_series' 'Basic_A0_A4' 'DC_Series' 'DS_series' 'DSv2_series' 'D_series' 'Dsv3_series' 'Dv2_series' 'Dv3_series' 'Esv3_series' 'Ev3_series' 'F_series' 'Fs_series' 'Fsv2_series' 'GS_series' 'G_series' 'H_series' 'Ls_series' 'M_series' 'Standard_A0_A7' 'Standard_A8_A11' 'Unknown' (required) |
| currency | Currency to report prices in. | 'ARS' 'AUD' 'BRL' 'CAD' 'CHF' 'CNY' 'DKK' 'EUR' 'GBP' 'HKD' 'IDR' 'INR' 'JPY' 'KRW' 'MXN' 'MYR' 'NOK' 'NZD' 'RUB' 'SAR' 'SEK' 'TRY' 'TWD' 'USD' 'Unknown' 'ZAR' (required) |
| discountPercentage | Custom discount percentage to be applied on final costs. Can be in the range [0, 100]. | int (required) |
| percentile | Percentile of performance data used to recommend Azure size. | 'Percentile50' 'Percentile90' 'Percentile95' 'Percentile99' (required) |
| reservedInstance | Azure reserved instance. | 'None' 'RI1Year' 'RI3Year' (required) |
| scalingFactor | 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. | int (required) |
| sizingCriterion | Assessment sizing criterion. | 'AsOnPremises' 'PerformanceBased' (required) |
| stage | User configurable setting that describes the status of the assessment. | 'Approved' 'InProgress' 'UnderReview' (required) |
| timeRange | Time range of performance data used to recommend a size. | 'Custom' 'Day' 'Month' 'Week' (required) |
| vmUptime | Specify the duration for which the VMs are up in the on-premises environment. | VmUptime (required) |
VmUptime
| Name | Description | Value |
|---|---|---|
| daysPerMonth | Number of days in a month for VM uptime. | int |
| hoursPerDay | Number of hours per day for VM uptime. | int |
Terraform (AzAPI provider) resource definition
The assessmentProjects/groups/assessments resource type can be deployed to:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Migrate/assessmentProjects/groups/assessments resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Migrate/assessmentProjects/groups/assessments@2019-10-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
azureDiskType = "string"
azureHybridUseBenefit = "string"
azureLocation = "string"
azureOfferCode = "string"
azurePricingTier = "string"
azureStorageRedundancy = "string"
azureVmFamilies = [
"string"
]
currency = "string"
discountPercentage = int
percentile = "string"
reservedInstance = "string"
scalingFactor = int
sizingCriterion = "string"
stage = "string"
timeRange = "string"
vmUptime = {
daysPerMonth = int
hoursPerDay = int
}
}
eTag = "string"
})
}
Property values
assessmentProjects/groups/assessments
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Migrate/assessmentProjects/groups/assessments@2019-10-01" |
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: groups |
| eTag | For optimistic concurrency control. | string |
| properties | Properties of the assessment. | AssessmentProperties (required) |
AssessmentProperties
| Name | Description | Value |
|---|---|---|
| azureDiskType | Storage type selected for this disk. | "Premium" "Standard" "StandardOrPremium" "StandardSSD" "Unknown" (required) |
| azureHybridUseBenefit | AHUB discount on windows virtual machines. | "No" "Unknown" "Yes" (required) |
| azureLocation | Target Azure location for which the machines should be assessed. These enums are the same as used by Compute API. | "AustraliaEast" "AustraliaSoutheast" "BrazilSouth" "CanadaCentral" "CanadaEast" "CentralIndia" "CentralUs" "ChinaEast" "ChinaNorth" "EastAsia" "EastUs" "EastUs2" "GermanyCentral" "GermanyNortheast" "JapanEast" "JapanWest" "KoreaCentral" "KoreaSouth" "NorthCentralUs" "NorthEurope" "SouthCentralUs" "SouthIndia" "SoutheastAsia" "USDoDCentral" "USDoDEast" "USGovArizona" "USGovIowa" "USGovTexas" "USGovVirginia" "UkSouth" "UkWest" "Unknown" "WestCentralUs" "WestEurope" "WestIndia" "WestUs" "WestUs2" (required) |
| azureOfferCode | Offer code according to which cost estimation is done. | "EA" "MSAZR0003P" "MSAZR0022P" "MSAZR0023P" "MSAZR0025P" "MSAZR0029P" "MSAZR0036P" "MSAZR0044P" "MSAZR0059P" "MSAZR0060P" "MSAZR0062P" "MSAZR0063P" "MSAZR0064P" "MSAZR0111P" "MSAZR0120P" "MSAZR0121P" "MSAZR0122P" "MSAZR0123P" "MSAZR0124P" "MSAZR0125P" "MSAZR0126P" "MSAZR0127P" "MSAZR0128P" "MSAZR0129P" "MSAZR0130P" "MSAZR0144P" "MSAZR0148P" "MSAZR0149P" "MSAZRDE0003P" "MSAZRDE0044P" "MSAZRUSGOV0003P" "MSMCAZR0044P" "MSMCAZR0059P" "MSMCAZR0060P" "MSMCAZR0063P" "MSMCAZR0120P" "MSMCAZR0121P" "MSMCAZR0125P" "MSMCAZR0128P" "Unknown" (required) |
| azurePricingTier | Pricing tier for Size evaluation. | "Basic" "Standard" (required) |
| azureStorageRedundancy | Storage Redundancy type offered by Azure. | "GeoRedundant" "LocallyRedundant" "ReadAccessGeoRedundant" "Unknown" "ZoneRedundant" (required) |
| azureVmFamilies | List of azure VM families. | String array containing any of: "Av2_series" "Basic_A0_A4" "DC_Series" "DS_series" "DSv2_series" "D_series" "Dsv3_series" "Dv2_series" "Dv3_series" "Esv3_series" "Ev3_series" "F_series" "Fs_series" "Fsv2_series" "GS_series" "G_series" "H_series" "Ls_series" "M_series" "Standard_A0_A7" "Standard_A8_A11" "Unknown" (required) |
| currency | Currency to report prices in. | "ARS" "AUD" "BRL" "CAD" "CHF" "CNY" "DKK" "EUR" "GBP" "HKD" "IDR" "INR" "JPY" "KRW" "MXN" "MYR" "NOK" "NZD" "RUB" "SAR" "SEK" "TRY" "TWD" "USD" "Unknown" "ZAR" (required) |
| discountPercentage | Custom discount percentage to be applied on final costs. Can be in the range [0, 100]. | int (required) |
| percentile | Percentile of performance data used to recommend Azure size. | "Percentile50" "Percentile90" "Percentile95" "Percentile99" (required) |
| reservedInstance | Azure reserved instance. | "None" "RI1Year" "RI3Year" (required) |
| scalingFactor | 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. | int (required) |
| sizingCriterion | Assessment sizing criterion. | "AsOnPremises" "PerformanceBased" (required) |
| stage | User configurable setting that describes the status of the assessment. | "Approved" "InProgress" "UnderReview" (required) |
| timeRange | Time range of performance data used to recommend a size. | "Custom" "Day" "Month" "Week" (required) |
| vmUptime | Specify the duration for which the VMs are up in the on-premises environment. | VmUptime (required) |
VmUptime
| Name | Description | Value |
|---|---|---|
| daysPerMonth | Number of days in a month for VM uptime. | int |
| hoursPerDay | Number of hours per day for VM uptime. | int |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for