Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The assessmentProjects/groups/sqlAssessments resource type can be deployed with operations that target:
- 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/sqlAssessments resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Migrate/assessmentProjects/groups/sqlAssessments@2024-01-15' = {
parent: resourceSymbolicName
name: 'string'
properties: {
assessmentType: 'string'
asyncCommitModeIntent: 'string'
azureLocation: 'string'
azureOfferCode: 'string'
azureOfferCodeForVm: 'string'
azureSecurityOfferingType: 'string'
azureSqlDatabaseSettings: {
azureSqlComputeTier: 'string'
azureSqlDataBaseType: 'string'
azureSqlPurchaseModel: 'string'
azureSqlServiceTier: 'string'
}
azureSqlManagedInstanceSettings: {
azureSqlInstanceType: 'string'
azureSqlServiceTier: 'string'
}
azureSqlVmSettings: {
instanceSeries: [
'string'
]
}
confidenceRatingInPercentage: int
currency: 'string'
disasterRecoveryLocation: 'string'
discountPercentage: int
eaSubscriptionId: 'string'
enableHadrAssessment: bool
entityUptime: {
daysPerMonth: int
hoursPerDay: int
}
environmentType: 'string'
groupType: 'string'
isInternetAccessAvailable: bool
multiSubnetIntent: 'string'
optimizationLogic: 'string'
osLicense: 'string'
percentile: 'string'
perfDataEndTime: 'string'
perfDataStartTime: 'string'
provisioningState: 'string'
reservedInstance: 'string'
reservedInstanceForVm: 'string'
scalingFactor: int
sizingCriterion: 'string'
sqlServerLicense: 'string'
timeRange: 'string'
}
}
Property Values
Microsoft.Migrate/assessmentProjects/groups/sqlAssessments
| 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. | SqlAssessmentV2Properties |
EntityUptime
| Name | Description | Value |
|---|---|---|
| daysPerMonth | Gets the days per month. | int |
| hoursPerDay | Gets the hours per day. | int |
SqlAssessmentV2Properties
| Name | Description | Value |
|---|---|---|
| assessmentType | Assessment type of the assessment. | 'AvsAssessment' 'MachineAssessment' 'SqlAssessment' 'Unknown' 'WebAppAssessment' |
| asyncCommitModeIntent | Gets or sets user preference indicating intent of async commit mode. | 'DisasterRecovery' 'HighAvailability' 'None' |
| 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' |
| azureOfferCodeForVm | Gets or sets Azure Offer Code for VM. | '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' |
| azureSecurityOfferingType | Gets or sets a value indicating azure security offering type. | 'MDC' 'NO' |
| azureSqlDatabaseSettings | Gets or sets user configurable SQL database settings. | SqlDbSettings |
| azureSqlManagedInstanceSettings | Gets or sets user configurable SQL managed instance settings. | SqlMiSettings |
| azureSqlVmSettings | Gets or sets user configurable SQL VM settings. | SqlVmSettings |
| confidenceRatingInPercentage | Confidence Rating in Percentage. | int |
| 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' |
| disasterRecoveryLocation | Gets or sets the Azure Location or Azure region where to which the machines will be migrated. |
'AustraliaCentral' 'AustraliaCentral2' 'AustraliaEast' 'AustraliaSoutheast' 'BrazilSouth' 'CanadaCentral' 'CanadaEast' 'CentralIndia' 'CentralUs' 'ChinaEast' 'ChinaEast2' 'ChinaNorth' 'ChinaNorth2' 'EastAsia' 'EastUs' 'EastUs2' 'FranceCentral' 'FranceSouth' 'GermanyCentral' 'GermanyNorth' 'GermanyNortheast' 'GermanyWestCentral' 'JapanEast' 'JapanWest' 'KoreaCentral' 'KoreaSouth' 'NorthCentralUs' 'NorthEurope' 'NorwayEast' 'NorwayWest' 'QatarCentral' 'SouthAfricaNorth' 'SouthAfricaWest' 'SouthCentralUs' 'SoutheastAsia' 'SouthIndia' 'SwedenCentral' 'SwitzerlandNorth' 'SwitzerlandWest' 'UAECentral' 'UAENorth' 'UkSouth' 'UkWest' 'Unknown' 'USDoDCentral' 'USDoDEast' 'USGovArizona' 'USGovIowa' 'USGovTexas' 'USGovVirginia' 'UsNatEast' 'UsNatWest' 'UsSecCentral' 'UsSecEast' 'UsSecWest' 'WestCentralUs' 'WestEurope' 'WestIndia' 'WestUs' 'WestUs2' |
| discountPercentage | Custom discount percentage. | int |
| eaSubscriptionId | Gets or sets the Enterprise agreement subscription id. | string |
| enableHadrAssessment | Gets or sets a value indicating whether HADR assessments needs to be created. | bool |
| entityUptime | Gets or sets the duration for which the entity (SQL, VMs) are up in the on-premises environment. |
EntityUptime |
| environmentType | Gets or sets user configurable setting to display the environment type. | 'Production' 'Test' |
| groupType | Gets the group type for the assessment. | 'Default' 'Import' |
| isInternetAccessAvailable | Gets or sets a value indicating whether internet access is available. | bool |
| multiSubnetIntent | Gets or sets user preference indicating intent of multi-subnet configuration. | 'DisasterRecovery' 'HighAvailability' 'None' |
| optimizationLogic | Gets or sets SQL optimization logic. | 'MinimizeCost' 'ModernizeToAzureSqlDb' 'ModernizeToAzureSqlMi' 'ModernizeToPaaS' |
| osLicense | Gets or sets user configurable setting to display the 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 | Reserved instance. | 'None' 'RI1Year' 'RI3Year' |
| reservedInstanceForVm | Gets or sets azure reserved instance for VM. | 'None' 'RI1Year' 'RI3Year' |
| scalingFactor | Percentage of buffer that user wants on performance metrics when recommending Azure sizes. |
int |
| sizingCriterion | Assessment sizing criterion. | 'AsOnPremises' 'PerformanceBased' |
| sqlServerLicense | SQL server license. | 'No' 'Unknown' 'Yes' |
| timeRange | Time Range for which the historic utilization data should be considered for assessment. |
'Custom' 'Day' 'Month' 'Week' |
SqlDbSettings
| Name | Description | Value |
|---|---|---|
| azureSqlComputeTier | Gets or sets the azure SQL compute tier. | 'Automatic' 'Provisioned' 'Serverless' 'Unknown' |
| azureSqlDataBaseType | Gets or sets the azure PAAS SQL instance type. | 'Automatic' 'ElasticPool' 'SingleDatabase' 'Unknown' |
| azureSqlPurchaseModel | Gets or sets the azure SQL purchase model. | 'DTU' 'Unknown' 'VCore' |
| azureSqlServiceTier | Gets or sets the azure SQL service tier. | 'Automatic' 'BusinessCritical' 'GeneralPurpose' 'HyperScale' 'Unknown' |
SqlMiSettings
| Name | Description | Value |
|---|---|---|
| azureSqlInstanceType | Gets or sets the azure PAAS SQL instance type. | 'Automatic' 'InstancePools' 'SingleInstance' 'Unknown' |
| azureSqlServiceTier | Gets or sets the azure SQL service tier. | 'Automatic' 'BusinessCritical' 'GeneralPurpose' 'HyperScale' 'Unknown' |
SqlVmSettings
| Name | Description | Value |
|---|---|---|
| instanceSeries | Gets or sets the Azure VM families (calling instance series to keep it consistent with other targets). |
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' |
ARM template resource definition
The assessmentProjects/groups/sqlAssessments resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands For a list of changed properties in each API version, see change log.
Usage Examples
Resource format
To create a Microsoft.Migrate/assessmentProjects/groups/sqlAssessments resource, add the following JSON to your template.
{
"type": "Microsoft.Migrate/assessmentProjects/groups/sqlAssessments",
"apiVersion": "2024-01-15",
"name": "string",
"properties": {
"assessmentType": "string",
"asyncCommitModeIntent": "string",
"azureLocation": "string",
"azureOfferCode": "string",
"azureOfferCodeForVm": "string",
"azureSecurityOfferingType": "string",
"azureSqlDatabaseSettings": {
"azureSqlComputeTier": "string",
"azureSqlDataBaseType": "string",
"azureSqlPurchaseModel": "string",
"azureSqlServiceTier": "string"
},
"azureSqlManagedInstanceSettings": {
"azureSqlInstanceType": "string",
"azureSqlServiceTier": "string"
},
"azureSqlVmSettings": {
"instanceSeries": [ "string" ]
},
"confidenceRatingInPercentage": "int",
"currency": "string",
"disasterRecoveryLocation": "string",
"discountPercentage": "int",
"eaSubscriptionId": "string",
"enableHadrAssessment": "bool",
"entityUptime": {
"daysPerMonth": "int",
"hoursPerDay": "int"
},
"environmentType": "string",
"groupType": "string",
"isInternetAccessAvailable": "bool",
"multiSubnetIntent": "string",
"optimizationLogic": "string",
"osLicense": "string",
"percentile": "string",
"perfDataEndTime": "string",
"perfDataStartTime": "string",
"provisioningState": "string",
"reservedInstance": "string",
"reservedInstanceForVm": "string",
"scalingFactor": "int",
"sizingCriterion": "string",
"sqlServerLicense": "string",
"timeRange": "string"
}
}
Property Values
Microsoft.Migrate/assessmentProjects/groups/sqlAssessments
| 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. | SqlAssessmentV2Properties |
| type | The resource type | 'Microsoft.Migrate/assessmentProjects/groups/sqlAssessments' |
EntityUptime
| Name | Description | Value |
|---|---|---|
| daysPerMonth | Gets the days per month. | int |
| hoursPerDay | Gets the hours per day. | int |
SqlAssessmentV2Properties
| Name | Description | Value |
|---|---|---|
| assessmentType | Assessment type of the assessment. | 'AvsAssessment' 'MachineAssessment' 'SqlAssessment' 'Unknown' 'WebAppAssessment' |
| asyncCommitModeIntent | Gets or sets user preference indicating intent of async commit mode. | 'DisasterRecovery' 'HighAvailability' 'None' |
| 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' |
| azureOfferCodeForVm | Gets or sets Azure Offer Code for VM. | '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' |
| azureSecurityOfferingType | Gets or sets a value indicating azure security offering type. | 'MDC' 'NO' |
| azureSqlDatabaseSettings | Gets or sets user configurable SQL database settings. | SqlDbSettings |
| azureSqlManagedInstanceSettings | Gets or sets user configurable SQL managed instance settings. | SqlMiSettings |
| azureSqlVmSettings | Gets or sets user configurable SQL VM settings. | SqlVmSettings |
| confidenceRatingInPercentage | Confidence Rating in Percentage. | int |
| 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' |
| disasterRecoveryLocation | Gets or sets the Azure Location or Azure region where to which the machines will be migrated. |
'AustraliaCentral' 'AustraliaCentral2' 'AustraliaEast' 'AustraliaSoutheast' 'BrazilSouth' 'CanadaCentral' 'CanadaEast' 'CentralIndia' 'CentralUs' 'ChinaEast' 'ChinaEast2' 'ChinaNorth' 'ChinaNorth2' 'EastAsia' 'EastUs' 'EastUs2' 'FranceCentral' 'FranceSouth' 'GermanyCentral' 'GermanyNorth' 'GermanyNortheast' 'GermanyWestCentral' 'JapanEast' 'JapanWest' 'KoreaCentral' 'KoreaSouth' 'NorthCentralUs' 'NorthEurope' 'NorwayEast' 'NorwayWest' 'QatarCentral' 'SouthAfricaNorth' 'SouthAfricaWest' 'SouthCentralUs' 'SoutheastAsia' 'SouthIndia' 'SwedenCentral' 'SwitzerlandNorth' 'SwitzerlandWest' 'UAECentral' 'UAENorth' 'UkSouth' 'UkWest' 'Unknown' 'USDoDCentral' 'USDoDEast' 'USGovArizona' 'USGovIowa' 'USGovTexas' 'USGovVirginia' 'UsNatEast' 'UsNatWest' 'UsSecCentral' 'UsSecEast' 'UsSecWest' 'WestCentralUs' 'WestEurope' 'WestIndia' 'WestUs' 'WestUs2' |
| discountPercentage | Custom discount percentage. | int |
| eaSubscriptionId | Gets or sets the Enterprise agreement subscription id. | string |
| enableHadrAssessment | Gets or sets a value indicating whether HADR assessments needs to be created. | bool |
| entityUptime | Gets or sets the duration for which the entity (SQL, VMs) are up in the on-premises environment. |
EntityUptime |
| environmentType | Gets or sets user configurable setting to display the environment type. | 'Production' 'Test' |
| groupType | Gets the group type for the assessment. | 'Default' 'Import' |
| isInternetAccessAvailable | Gets or sets a value indicating whether internet access is available. | bool |
| multiSubnetIntent | Gets or sets user preference indicating intent of multi-subnet configuration. | 'DisasterRecovery' 'HighAvailability' 'None' |
| optimizationLogic | Gets or sets SQL optimization logic. | 'MinimizeCost' 'ModernizeToAzureSqlDb' 'ModernizeToAzureSqlMi' 'ModernizeToPaaS' |
| osLicense | Gets or sets user configurable setting to display the 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 | Reserved instance. | 'None' 'RI1Year' 'RI3Year' |
| reservedInstanceForVm | Gets or sets azure reserved instance for VM. | 'None' 'RI1Year' 'RI3Year' |
| scalingFactor | Percentage of buffer that user wants on performance metrics when recommending Azure sizes. |
int |
| sizingCriterion | Assessment sizing criterion. | 'AsOnPremises' 'PerformanceBased' |
| sqlServerLicense | SQL server license. | 'No' 'Unknown' 'Yes' |
| timeRange | Time Range for which the historic utilization data should be considered for assessment. |
'Custom' 'Day' 'Month' 'Week' |
SqlDbSettings
| Name | Description | Value |
|---|---|---|
| azureSqlComputeTier | Gets or sets the azure SQL compute tier. | 'Automatic' 'Provisioned' 'Serverless' 'Unknown' |
| azureSqlDataBaseType | Gets or sets the azure PAAS SQL instance type. | 'Automatic' 'ElasticPool' 'SingleDatabase' 'Unknown' |
| azureSqlPurchaseModel | Gets or sets the azure SQL purchase model. | 'DTU' 'Unknown' 'VCore' |
| azureSqlServiceTier | Gets or sets the azure SQL service tier. | 'Automatic' 'BusinessCritical' 'GeneralPurpose' 'HyperScale' 'Unknown' |
SqlMiSettings
| Name | Description | Value |
|---|---|---|
| azureSqlInstanceType | Gets or sets the azure PAAS SQL instance type. | 'Automatic' 'InstancePools' 'SingleInstance' 'Unknown' |
| azureSqlServiceTier | Gets or sets the azure SQL service tier. | 'Automatic' 'BusinessCritical' 'GeneralPurpose' 'HyperScale' 'Unknown' |
SqlVmSettings
| Name | Description | Value |
|---|---|---|
| instanceSeries | Gets or sets the Azure VM families (calling instance series to keep it consistent with other targets). |
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' |
Terraform (AzAPI provider) resource definition
The assessmentProjects/groups/sqlAssessments 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/sqlAssessments resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Migrate/assessmentProjects/groups/sqlAssessments@2024-01-15"
name = "string"
parent_id = "string"
body = {
properties = {
assessmentType = "string"
asyncCommitModeIntent = "string"
azureLocation = "string"
azureOfferCode = "string"
azureOfferCodeForVm = "string"
azureSecurityOfferingType = "string"
azureSqlDatabaseSettings = {
azureSqlComputeTier = "string"
azureSqlDataBaseType = "string"
azureSqlPurchaseModel = "string"
azureSqlServiceTier = "string"
}
azureSqlManagedInstanceSettings = {
azureSqlInstanceType = "string"
azureSqlServiceTier = "string"
}
azureSqlVmSettings = {
instanceSeries = [
"string"
]
}
confidenceRatingInPercentage = int
currency = "string"
disasterRecoveryLocation = "string"
discountPercentage = int
eaSubscriptionId = "string"
enableHadrAssessment = bool
entityUptime = {
daysPerMonth = int
hoursPerDay = int
}
environmentType = "string"
groupType = "string"
isInternetAccessAvailable = bool
multiSubnetIntent = "string"
optimizationLogic = "string"
osLicense = "string"
percentile = "string"
perfDataEndTime = "string"
perfDataStartTime = "string"
provisioningState = "string"
reservedInstance = "string"
reservedInstanceForVm = "string"
scalingFactor = int
sizingCriterion = "string"
sqlServerLicense = "string"
timeRange = "string"
}
}
}
Property Values
Microsoft.Migrate/assessmentProjects/groups/sqlAssessments
| 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. | SqlAssessmentV2Properties |
| type | The resource type | "Microsoft.Migrate/assessmentProjects/groups/sqlAssessments@2024-01-15" |
EntityUptime
| Name | Description | Value |
|---|---|---|
| daysPerMonth | Gets the days per month. | int |
| hoursPerDay | Gets the hours per day. | int |
SqlAssessmentV2Properties
| Name | Description | Value |
|---|---|---|
| assessmentType | Assessment type of the assessment. | 'AvsAssessment' 'MachineAssessment' 'SqlAssessment' 'Unknown' 'WebAppAssessment' |
| asyncCommitModeIntent | Gets or sets user preference indicating intent of async commit mode. | 'DisasterRecovery' 'HighAvailability' 'None' |
| 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' |
| azureOfferCodeForVm | Gets or sets Azure Offer Code for VM. | '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' |
| azureSecurityOfferingType | Gets or sets a value indicating azure security offering type. | 'MDC' 'NO' |
| azureSqlDatabaseSettings | Gets or sets user configurable SQL database settings. | SqlDbSettings |
| azureSqlManagedInstanceSettings | Gets or sets user configurable SQL managed instance settings. | SqlMiSettings |
| azureSqlVmSettings | Gets or sets user configurable SQL VM settings. | SqlVmSettings |
| confidenceRatingInPercentage | Confidence Rating in Percentage. | int |
| 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' |
| disasterRecoveryLocation | Gets or sets the Azure Location or Azure region where to which the machines will be migrated. |
'AustraliaCentral' 'AustraliaCentral2' 'AustraliaEast' 'AustraliaSoutheast' 'BrazilSouth' 'CanadaCentral' 'CanadaEast' 'CentralIndia' 'CentralUs' 'ChinaEast' 'ChinaEast2' 'ChinaNorth' 'ChinaNorth2' 'EastAsia' 'EastUs' 'EastUs2' 'FranceCentral' 'FranceSouth' 'GermanyCentral' 'GermanyNorth' 'GermanyNortheast' 'GermanyWestCentral' 'JapanEast' 'JapanWest' 'KoreaCentral' 'KoreaSouth' 'NorthCentralUs' 'NorthEurope' 'NorwayEast' 'NorwayWest' 'QatarCentral' 'SouthAfricaNorth' 'SouthAfricaWest' 'SouthCentralUs' 'SoutheastAsia' 'SouthIndia' 'SwedenCentral' 'SwitzerlandNorth' 'SwitzerlandWest' 'UAECentral' 'UAENorth' 'UkSouth' 'UkWest' 'Unknown' 'USDoDCentral' 'USDoDEast' 'USGovArizona' 'USGovIowa' 'USGovTexas' 'USGovVirginia' 'UsNatEast' 'UsNatWest' 'UsSecCentral' 'UsSecEast' 'UsSecWest' 'WestCentralUs' 'WestEurope' 'WestIndia' 'WestUs' 'WestUs2' |
| discountPercentage | Custom discount percentage. | int |
| eaSubscriptionId | Gets or sets the Enterprise agreement subscription id. | string |
| enableHadrAssessment | Gets or sets a value indicating whether HADR assessments needs to be created. | bool |
| entityUptime | Gets or sets the duration for which the entity (SQL, VMs) are up in the on-premises environment. |
EntityUptime |
| environmentType | Gets or sets user configurable setting to display the environment type. | 'Production' 'Test' |
| groupType | Gets the group type for the assessment. | 'Default' 'Import' |
| isInternetAccessAvailable | Gets or sets a value indicating whether internet access is available. | bool |
| multiSubnetIntent | Gets or sets user preference indicating intent of multi-subnet configuration. | 'DisasterRecovery' 'HighAvailability' 'None' |
| optimizationLogic | Gets or sets SQL optimization logic. | 'MinimizeCost' 'ModernizeToAzureSqlDb' 'ModernizeToAzureSqlMi' 'ModernizeToPaaS' |
| osLicense | Gets or sets user configurable setting to display the 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 | Reserved instance. | 'None' 'RI1Year' 'RI3Year' |
| reservedInstanceForVm | Gets or sets azure reserved instance for VM. | 'None' 'RI1Year' 'RI3Year' |
| scalingFactor | Percentage of buffer that user wants on performance metrics when recommending Azure sizes. |
int |
| sizingCriterion | Assessment sizing criterion. | 'AsOnPremises' 'PerformanceBased' |
| sqlServerLicense | SQL server license. | 'No' 'Unknown' 'Yes' |
| timeRange | Time Range for which the historic utilization data should be considered for assessment. |
'Custom' 'Day' 'Month' 'Week' |
SqlDbSettings
| Name | Description | Value |
|---|---|---|
| azureSqlComputeTier | Gets or sets the azure SQL compute tier. | 'Automatic' 'Provisioned' 'Serverless' 'Unknown' |
| azureSqlDataBaseType | Gets or sets the azure PAAS SQL instance type. | 'Automatic' 'ElasticPool' 'SingleDatabase' 'Unknown' |
| azureSqlPurchaseModel | Gets or sets the azure SQL purchase model. | 'DTU' 'Unknown' 'VCore' |
| azureSqlServiceTier | Gets or sets the azure SQL service tier. | 'Automatic' 'BusinessCritical' 'GeneralPurpose' 'HyperScale' 'Unknown' |
SqlMiSettings
| Name | Description | Value |
|---|---|---|
| azureSqlInstanceType | Gets or sets the azure PAAS SQL instance type. | 'Automatic' 'InstancePools' 'SingleInstance' 'Unknown' |
| azureSqlServiceTier | Gets or sets the azure SQL service tier. | 'Automatic' 'BusinessCritical' 'GeneralPurpose' 'HyperScale' 'Unknown' |
SqlVmSettings
| Name | Description | Value |
|---|---|---|
| instanceSeries | Gets or sets the Azure VM families (calling instance series to keep it consistent with other targets). |
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' |