Skip to main content

sql_assessment_v2_operations

Creates, updates, deletes, gets or lists a sql_assessment_v2_operations resource.

Overview​

Namesql_assessment_v2_operations
TypeResource
Idazure.migration_assessment.sql_assessment_v2_operations

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
namestringThe name of the resource.
assessmentTypestringAssessment type of the assessment. Known values are: "Unknown", "MachineAssessment", "AvsAssessment", "SqlAssessment", and "WebAppAssessment".
asyncCommitModeIntentstringGets or sets user preference indicating intent of async commit mode. Known values are: "None", "HighAvailability", and "DisasterRecovery".
azureLocationstringAzure Location or Azure region where to which the machines will be migrated.
azureOfferCodestringAzure Offer Code. Known values are: "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", "MSAZR0243P", "SavingsPlan1Year", and "SavingsPlan3Year".
azureOfferCodeForVmstringGets or sets Azure Offer Code for VM. Known values are: "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", "MSAZR0243P", "SavingsPlan1Year", and "SavingsPlan3Year".
azureSecurityOfferingTypestringGets or sets a value indicating azure security offering type. Known values are: "NO" and "MDC".
azureSqlDatabaseSettingsobjectGets or sets user configurable SQL database settings.
azureSqlManagedInstanceSettingsobjectGets or sets user configurable SQL managed instance settings.
azureSqlVmSettingsobjectGets or sets user configurable SQL VM settings.
confidenceRatingInPercentagenumberConfidence Rating in Percentage.
createdTimestampstring (date-time)Date and Time when assessment was created.
currencystringCurrency in which prices should be reported. Known values are: "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", and "TRY".
disasterRecoveryLocationstringGets or sets the Azure Location or Azure region where to which the machines will be migrated. Known values are: "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", "FranceCentral", "AustraliaCentral", "SouthAfricaNorth", "FranceSouth", "AustraliaCentral2", "SouthAfricaWest", "GermanyNorth", "GermanyWestCentral", "NorwayEast", "NorwayWest", "ChinaEast2", "ChinaNorth2", "SwitzerlandNorth", "SwitzerlandWest", "UAENorth", "UAECentral", "UsNatEast", "UsNatWest", "UsSecEast", "UsSecCentral", "UsSecWest", "SwedenCentral", and "QatarCentral".
discountPercentagenumberCustom discount percentage.
eaSubscriptionIdstringGets or sets the Enterprise agreement subscription id.
enableHadrAssessmentbooleanGets or sets a value indicating whether HADR assessments needs to be created.
entityUptimeobjectGets or sets the duration for which the entity (SQL, VMs) are up in the on-premises environment.
environmentTypestringGets or sets user configurable setting to display the environment type. Known values are: "Production" and "Test".
groupTypestringGets the group type for the assessment. Known values are: "Default", "Import", and "Import".
isInternetAccessAvailablebooleanGets or sets a value indicating whether internet access is available.
multiSubnetIntentstringGets or sets user preference indicating intent of multi-subnet configuration. Known values are: "None", "HighAvailability", and "DisasterRecovery".
optimizationLogicstringGets or sets SQL optimization logic. Known values are: "MinimizeCost", "ModernizeToPaaS", "ModernizeToAzureSqlMi", and "ModernizeToAzureSqlDb".
osLicensestringGets or sets user configurable setting to display the azure hybrid use benefit. Known values are: "Unknown", "Yes", and "No".
percentilestringPercentile of the utilization data values to be considered while assessing machines. Known values are: "Percentile50", "Percentile90", "Percentile95", and "Percentile99".
perfDataEndTimestring (date-time)Gets or sets the end time to consider performance data for assessment.
perfDataStartTimestring (date-time)Gets or sets the start time to consider performance data for assessment.
pricesTimestampstring (date-time)Last time when rates were queried.
provisioningStatestringThe status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
reservedInstancestringReserved instance. Known values are: "None", "RI1Year", and "RI3Year".
reservedInstanceForVmstringGets or sets azure reserved instance for VM. Known values are: "None", "RI1Year", and "RI3Year".
scalingFactornumberPercentage of buffer that user wants on performance metrics when recommending Azure sizes.
schemaVersionstringSchema version.
sizingCriterionstringAssessment sizing criterion. Known values are: "PerformanceBased" and "AsOnPremises".
sqlServerLicensestringSQL server license. Known values are: "Unknown", "Yes", and "No".
stagestringUser configurable setting to display the Stage of Assessment. Known values are: "InProgress", "UnderReview", and "Approved".
statusstringWhether assessment is in valid state and all machines have been assessed. Known values are: "Created", "Updated", "Running", "Completed", "Invalid", "OutOfSync", "OutDated", and "Deleted".
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
timeRangestringTime Range for which the historic utilization data should be considered for assessment. Known values are: "Day", "Week", "Month", and "Custom".
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updatedTimestampstring (date-time)Date and Time when assessment was last updated.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectresource_group_name, project_name, group_name, assessment_name, subscription_idGet a SqlAssessmentV2.
list_by_groupselectresource_group_name, project_name, group_name, subscription_idList SqlAssessmentV2 resources by Group.
createinsertresource_group_name, project_name, group_name, assessment_name, subscription_idCreate a SqlAssessmentV2.
deletedeleteresource_group_name, project_name, group_name, assessment_name, subscription_idDelete a SqlAssessmentV2.
download_urlexecresource_group_name, project_name, group_name, assessment_name, subscription_idGet download URL for the assessment report. Get the URL for downloading the assessment in a report format.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
assessment_namestringSQL Assessment arm name. Required.
group_namestringGroup ARM name. Required.
project_namestringAssessment Project Name. Required.
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
subscription_idstring

SELECT examples​

Get a SqlAssessmentV2.

SELECT
id,
name,
assessmentType,
asyncCommitModeIntent,
azureLocation,
azureOfferCode,
azureOfferCodeForVm,
azureSecurityOfferingType,
azureSqlDatabaseSettings,
azureSqlManagedInstanceSettings,
azureSqlVmSettings,
confidenceRatingInPercentage,
createdTimestamp,
currency,
disasterRecoveryLocation,
discountPercentage,
eaSubscriptionId,
enableHadrAssessment,
entityUptime,
environmentType,
groupType,
isInternetAccessAvailable,
multiSubnetIntent,
optimizationLogic,
osLicense,
percentile,
perfDataEndTime,
perfDataStartTime,
pricesTimestamp,
provisioningState,
reservedInstance,
reservedInstanceForVm,
scalingFactor,
schemaVersion,
sizingCriterion,
sqlServerLicense,
stage,
status,
systemData,
timeRange,
type,
updatedTimestamp
FROM azure.migration_assessment.sql_assessment_v2_operations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND group_name = '{{ group_name }}' -- required
AND assessment_name = '{{ assessment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples​

Create a SqlAssessmentV2.

INSERT INTO azure.migration_assessment.sql_assessment_v2_operations (
properties,
resource_group_name,
project_name,
group_name,
assessment_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ project_name }}',
'{{ group_name }}',
'{{ assessment_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

DELETE examples​

Delete a SqlAssessmentV2.

DELETE FROM azure.migration_assessment.sql_assessment_v2_operations
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND project_name = '{{ project_name }}' --required
AND group_name = '{{ group_name }}' --required
AND assessment_name = '{{ assessment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods​

Get download URL for the assessment report. Get the URL for downloading the assessment in a report format.

EXEC azure.migration_assessment.sql_assessment_v2_operations.download_url 
@resource_group_name='{{ resource_group_name }}' --required, 
@project_name='{{ project_name }}' --required, 
@group_name='{{ group_name }}' --required, 
@assessment_name='{{ assessment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;