Microsoft.Migrate assessmentProjects/groups/assessments

Bicep resource definition

The assessmentProjects/groups/assessments resource type can be deployed with operations that target:

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@2024-01-15' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    azureDiskTypes: [
      'string'
    ]
    azureHybridUseBenefit: 'string'
    azureLocation: 'string'
    azureOfferCode: 'string'
    azurePricingTier: 'string'
    azureStorageRedundancy: 'string'
    azureVmFamilies: [
      'string'
    ]
    currency: 'string'
    discountPercentage: int
    eaSubscriptionId: 'string'
    linuxAzureHybridUseBenefit: 'string'
    percentile: 'string'
    perfDataEndTime: 'string'
    perfDataStartTime: 'string'
    provisioningState: 'string'
    reservedInstance: 'string'
    scalingFactor: int
    sizingCriterion: 'string'
    timeRange: 'string'
    vmUptime: {
      daysPerMonth: int
      hoursPerDay: int
    }
  }
}

Property Values

Microsoft.Migrate/assessmentProjects/groups/assessments

Name Description Value
name The resource name string

Constraints:
Pattern = ^[^<>&:\?/#]{1,260}$ (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: assessmentProjects/groups
properties The resource-specific properties for this resource. MachineAssessmentProperties

MachineAssessmentProperties

Name Description Value
azureDiskTypes Gets or sets the azure storage type. Premium, Standard etc. String array containing any of:
'Premium'
'PremiumV2'
'Standard'
'StandardOrPremium'
'StandardSSD'
'Ultra'
'Unknown'
azureHybridUseBenefit Gets or sets the user configurable setting to display the azure hybrid use
benefit.		 'No'
'Unknown'
'Yes'
azureLocation Azure Location or Azure region where to which the machines will be migrated. string
azureOfferCode Azure Offer Code. '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'
'MSAZR0243P'
'MSAZRDE0003P'
'MSAZRDE0044P'
'MSAZRUSGOV0003P'
'MSMCAZR0044P'
'MSMCAZR0059P'
'MSMCAZR0060P'
'MSMCAZR0063P'
'MSMCAZR0120P'
'MSMCAZR0121P'
'MSMCAZR0125P'
'MSMCAZR0128P'
'SavingsPlan1Year'
'SavingsPlan3Year'
'Unknown'
azurePricingTier Gets or sets Azure Pricing Tier - Free, Basic, etc. 'Basic'
'Standard'
azureStorageRedundancy Gets or sets the Azure Storage Redundancy. Example: Locally Redundant Storage. 'GeoRedundant'
'LocallyRedundant'
'ReadAccessGeoRedundant'
'Unknown'
'ZoneRedundant'
azureVmFamilies Gets or sets the Azure VM families. String array containing any of:
'Av2_series'
'Basic_A0_A4'
'Dadsv5_series'
'Dasv4_series'
'Dasv5_series'
'Dav4_series'
'DC_Series'
'Ddsv4_series'
'Ddsv5_series'
'Ddv4_series'
'Ddv5_series'
'DSv2_series'
'Dsv3_series'
'Dsv4_series'
'Dsv5_series'
'DS_series'
'Dv2_series'
'Dv3_series'
'Dv4_series'
'Dv5_series'
'D_series'
'Eadsv5_series'
'Easv4_series'
'Easv5_series'
'Eav4_series'
'Ebdsv5_series'
'Ebsv5_series'
'Edsv4_series'
'Edsv5_series'
'Edv4_series'
'Edv5_series'
'Esv3_series'
'Esv4_series'
'Esv5_series'
'Ev3_series'
'Ev4_series'
'Ev5_series'
'Fsv2_series'
'Fs_series'
'F_series'
'GS_series'
'G_series'
'H_series'
'Lsv2_series'
'Ls_series'
'Mdsv2_series'
'Msv2_series'
'Mv2_series'
'M_series'
'Standard_A0_A7'
'Standard_A8_A11'
'Unknown'
currency Currency in which prices should be reported. 'ARS'
'AUD'
'BRL'
'CAD'
'CHF'
'CNY'
'DKK'
'EUR'
'GBP'
'HKD'
'IDR'
'INR'
'JPY'
'KRW'
'MXN'
'MYR'
'NOK'
'NZD'
'RUB'
'SAR'
'SEK'
'TRY'
'TWD'
'Unknown'
'USD'
'ZAR'
discountPercentage Custom discount percentage. int
eaSubscriptionId Gets or sets enterprise agreement subscription id. string
linuxAzureHybridUseBenefit Gets or sets the user configurable setting to display the linux azure hybrid use
benefit.		 'No'
'Unknown'
'Yes'
percentile Percentile of the utilization data values to be considered while assessing
machines.		 'Percentile50'
'Percentile90'
'Percentile95'
'Percentile99'
perfDataEndTime Gets or sets the end time to consider performance data for assessment. string
perfDataStartTime Gets or sets the start time to consider performance data for assessment. string
provisioningState The status of the last operation. 'Accepted'
'Canceled'
'Deleting'
'Failed'
'Provisioning'
'Succeeded'
'Updating'
reservedInstance Gets or sets the Azure Reserved Instance - 1-Year, 3-Year. 'None'
'RI1Year'
'RI3Year'
scalingFactor Percentage of buffer that user wants on performance metrics when recommending
Azure sizes.		 int
sizingCriterion Assessment sizing criterion. 'AsOnPremises'
'PerformanceBased'
timeRange Time Range for which the historic utilization data should be considered for
assessment.		 'Custom'
'Day'
'Month'
'Week'
vmUptime Gets or sets the duration for which the VMs are up in the on-premises
environment.		 VmUptime

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 with operations that target:

Usage Examples

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": "2024-01-15",
  "name": "string",
  "properties": {
    "azureDiskTypes": [ "string" ],
    "azureHybridUseBenefit": "string",
    "azureLocation": "string",
    "azureOfferCode": "string",
    "azurePricingTier": "string",
    "azureStorageRedundancy": "string",
    "azureVmFamilies": [ "string" ],
    "currency": "string",
    "discountPercentage": "int",
    "eaSubscriptionId": "string",
    "linuxAzureHybridUseBenefit": "string",
    "percentile": "string",
    "perfDataEndTime": "string",
    "perfDataStartTime": "string",
    "provisioningState": "string",
    "reservedInstance": "string",
    "scalingFactor": "int",
    "sizingCriterion": "string",
    "timeRange": "string",
    "vmUptime": {
      "daysPerMonth": "int",
      "hoursPerDay": "int"
    }
  }
}

Property Values

Microsoft.Migrate/assessmentProjects/groups/assessments

Name Description Value
apiVersion The api version '2024-01-15'
name The resource name string

Constraints:
Pattern = ^[^<>&:\?/#]{1,260}$ (required)
properties The resource-specific properties for this resource. MachineAssessmentProperties
type The resource type 'Microsoft.Migrate/assessmentProjects/groups/assessments'

MachineAssessmentProperties

Name Description Value
azureDiskTypes Gets or sets the azure storage type. Premium, Standard etc. String array containing any of:
'Premium'
'PremiumV2'
'Standard'
'StandardOrPremium'
'StandardSSD'
'Ultra'
'Unknown'
azureHybridUseBenefit Gets or sets the user configurable setting to display the azure hybrid use
benefit.		 'No'
'Unknown'
'Yes'
azureLocation Azure Location or Azure region where to which the machines will be migrated. string
azureOfferCode Azure Offer Code. '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'
'MSAZR0243P'
'MSAZRDE0003P'
'MSAZRDE0044P'
'MSAZRUSGOV0003P'
'MSMCAZR0044P'
'MSMCAZR0059P'
'MSMCAZR0060P'
'MSMCAZR0063P'
'MSMCAZR0120P'
'MSMCAZR0121P'
'MSMCAZR0125P'
'MSMCAZR0128P'
'SavingsPlan1Year'
'SavingsPlan3Year'
'Unknown'
azurePricingTier Gets or sets Azure Pricing Tier - Free, Basic, etc. 'Basic'
'Standard'
azureStorageRedundancy Gets or sets the Azure Storage Redundancy. Example: Locally Redundant Storage. 'GeoRedundant'
'LocallyRedundant'
'ReadAccessGeoRedundant'
'Unknown'
'ZoneRedundant'
azureVmFamilies Gets or sets the Azure VM families. String array containing any of:
'Av2_series'
'Basic_A0_A4'
'Dadsv5_series'
'Dasv4_series'
'Dasv5_series'
'Dav4_series'
'DC_Series'
'Ddsv4_series'
'Ddsv5_series'
'Ddv4_series'
'Ddv5_series'
'DSv2_series'
'Dsv3_series'
'Dsv4_series'
'Dsv5_series'
'DS_series'
'Dv2_series'
'Dv3_series'
'Dv4_series'
'Dv5_series'
'D_series'
'Eadsv5_series'
'Easv4_series'
'Easv5_series'
'Eav4_series'
'Ebdsv5_series'
'Ebsv5_series'
'Edsv4_series'
'Edsv5_series'
'Edv4_series'
'Edv5_series'
'Esv3_series'
'Esv4_series'
'Esv5_series'
'Ev3_series'
'Ev4_series'
'Ev5_series'
'Fsv2_series'
'Fs_series'
'F_series'
'GS_series'
'G_series'
'H_series'
'Lsv2_series'
'Ls_series'
'Mdsv2_series'
'Msv2_series'
'Mv2_series'
'M_series'
'Standard_A0_A7'
'Standard_A8_A11'
'Unknown'
currency Currency in which prices should be reported. 'ARS'
'AUD'
'BRL'
'CAD'
'CHF'
'CNY'
'DKK'
'EUR'
'GBP'
'HKD'
'IDR'
'INR'
'JPY'
'KRW'
'MXN'
'MYR'
'NOK'
'NZD'
'RUB'
'SAR'
'SEK'
'TRY'
'TWD'
'Unknown'
'USD'
'ZAR'
discountPercentage Custom discount percentage. int
eaSubscriptionId Gets or sets enterprise agreement subscription id. string
linuxAzureHybridUseBenefit Gets or sets the user configurable setting to display the linux azure hybrid use
benefit.		 'No'
'Unknown'
'Yes'
percentile Percentile of the utilization data values to be considered while assessing
machines.		 'Percentile50'
'Percentile90'
'Percentile95'
'Percentile99'
perfDataEndTime Gets or sets the end time to consider performance data for assessment. string
perfDataStartTime Gets or sets the start time to consider performance data for assessment. string
provisioningState The status of the last operation. 'Accepted'
'Canceled'
'Deleting'
'Failed'
'Provisioning'
'Succeeded'
'Updating'
reservedInstance Gets or sets the Azure Reserved Instance - 1-Year, 3-Year. 'None'
'RI1Year'
'RI3Year'
scalingFactor Percentage of buffer that user wants on performance metrics when recommending
Azure sizes.		 int
sizingCriterion Assessment sizing criterion. 'AsOnPremises'
'PerformanceBased'
timeRange Time Range for which the historic utilization data should be considered for
assessment.		 'Custom'
'Day'
'Month'
'Week'
vmUptime Gets or sets the duration for which the VMs are up in the on-premises
environment.		 VmUptime

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 with operations that target:

  • 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@2024-01-15"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      azureDiskTypes = [
        "string"
      ]
      azureHybridUseBenefit = "string"
      azureLocation = "string"
      azureOfferCode = "string"
      azurePricingTier = "string"
      azureStorageRedundancy = "string"
      azureVmFamilies = [
        "string"
      ]
      currency = "string"
      discountPercentage = int
      eaSubscriptionId = "string"
      linuxAzureHybridUseBenefit = "string"
      percentile = "string"
      perfDataEndTime = "string"
      perfDataStartTime = "string"
      provisioningState = "string"
      reservedInstance = "string"
      scalingFactor = int
      sizingCriterion = "string"
      timeRange = "string"
      vmUptime = {
        daysPerMonth = int
        hoursPerDay = int
      }
    }
  }
}

Property Values

Microsoft.Migrate/assessmentProjects/groups/assessments

Name Description Value
name The resource name string

Constraints:
Pattern = ^[^<>&:\?/#]{1,260}$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: assessmentProjects/groups
properties The resource-specific properties for this resource. MachineAssessmentProperties
type The resource type "Microsoft.Migrate/assessmentProjects/groups/assessments@2024-01-15"

MachineAssessmentProperties

Name Description Value
azureDiskTypes Gets or sets the azure storage type. Premium, Standard etc. String array containing any of:
'Premium'
'PremiumV2'
'Standard'
'StandardOrPremium'
'StandardSSD'
'Ultra'
'Unknown'
azureHybridUseBenefit Gets or sets the user configurable setting to display the azure hybrid use
benefit.		 'No'
'Unknown'
'Yes'
azureLocation Azure Location or Azure region where to which the machines will be migrated. string
azureOfferCode Azure Offer Code. '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'
'MSAZR0243P'
'MSAZRDE0003P'
'MSAZRDE0044P'
'MSAZRUSGOV0003P'
'MSMCAZR0044P'
'MSMCAZR0059P'
'MSMCAZR0060P'
'MSMCAZR0063P'
'MSMCAZR0120P'
'MSMCAZR0121P'
'MSMCAZR0125P'
'MSMCAZR0128P'
'SavingsPlan1Year'
'SavingsPlan3Year'
'Unknown'
azurePricingTier Gets or sets Azure Pricing Tier - Free, Basic, etc. 'Basic'
'Standard'
azureStorageRedundancy Gets or sets the Azure Storage Redundancy. Example: Locally Redundant Storage. 'GeoRedundant'
'LocallyRedundant'
'ReadAccessGeoRedundant'
'Unknown'
'ZoneRedundant'
azureVmFamilies Gets or sets the Azure VM families. String array containing any of:
'Av2_series'
'Basic_A0_A4'
'Dadsv5_series'
'Dasv4_series'
'Dasv5_series'
'Dav4_series'
'DC_Series'
'Ddsv4_series'
'Ddsv5_series'
'Ddv4_series'
'Ddv5_series'
'DSv2_series'
'Dsv3_series'
'Dsv4_series'
'Dsv5_series'
'DS_series'
'Dv2_series'
'Dv3_series'
'Dv4_series'
'Dv5_series'
'D_series'
'Eadsv5_series'
'Easv4_series'
'Easv5_series'
'Eav4_series'
'Ebdsv5_series'
'Ebsv5_series'
'Edsv4_series'
'Edsv5_series'
'Edv4_series'
'Edv5_series'
'Esv3_series'
'Esv4_series'
'Esv5_series'
'Ev3_series'
'Ev4_series'
'Ev5_series'
'Fsv2_series'
'Fs_series'
'F_series'
'GS_series'
'G_series'
'H_series'
'Lsv2_series'
'Ls_series'
'Mdsv2_series'
'Msv2_series'
'Mv2_series'
'M_series'
'Standard_A0_A7'
'Standard_A8_A11'
'Unknown'
currency Currency in which prices should be reported. 'ARS'
'AUD'
'BRL'
'CAD'
'CHF'
'CNY'
'DKK'
'EUR'
'GBP'
'HKD'
'IDR'
'INR'
'JPY'
'KRW'
'MXN'
'MYR'
'NOK'
'NZD'
'RUB'
'SAR'
'SEK'
'TRY'
'TWD'
'Unknown'
'USD'
'ZAR'
discountPercentage Custom discount percentage. int
eaSubscriptionId Gets or sets enterprise agreement subscription id. string
linuxAzureHybridUseBenefit Gets or sets the user configurable setting to display the linux azure hybrid use
benefit.		 'No'
'Unknown'
'Yes'
percentile Percentile of the utilization data values to be considered while assessing
machines.		 'Percentile50'
'Percentile90'
'Percentile95'
'Percentile99'
perfDataEndTime Gets or sets the end time to consider performance data for assessment. string
perfDataStartTime Gets or sets the start time to consider performance data for assessment. string
provisioningState The status of the last operation. 'Accepted'
'Canceled'
'Deleting'
'Failed'
'Provisioning'
'Succeeded'
'Updating'
reservedInstance Gets or sets the Azure Reserved Instance - 1-Year, 3-Year. 'None'
'RI1Year'
'RI3Year'
scalingFactor Percentage of buffer that user wants on performance metrics when recommending
Azure sizes.		 int
sizingCriterion Assessment sizing criterion. 'AsOnPremises'
'PerformanceBased'
timeRange Time Range for which the historic utilization data should be considered for
assessment.		 'Custom'
'Day'
'Month'
'Week'
vmUptime Gets or sets the duration for which the VMs are up in the on-premises
environment.		 VmUptime

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
  • Last updated on