Skip to main content

assessments_operations

Creates, updates, deletes, gets or lists an assessments_operations resource.

Overview​

Nameassessments_operations
TypeResource
Idazure.migration_assessment.assessments_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.
assessmentErrorSummaryobjectGets or sets the assessment error summary. This is the number of machines affected by each type of error in this assessment.
assessmentTypestringAssessment type of the assessment. Known values are: "Unknown", "MachineAssessment", "AvsAssessment", "SqlAssessment", and "WebAppAssessment".
azureDiskTypesarrayGets or sets the azure storage type. Premium, Standard etc.
azureHybridUseBenefitstringGets or sets the user configurable setting to display the azure hybrid use benefit. Known values are: "Unknown", "Yes", and "No".
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".
azurePricingTierstringGets or sets Azure Pricing Tier - Free, Basic, etc. Known values are: "Standard" and "Basic".
azureStorageRedundancystringGets or sets the Azure Storage Redundancy. Example: Locally Redundant Storage. Known values are: "Unknown", "LocallyRedundant", "ZoneRedundant", "GeoRedundant", and "ReadAccessGeoRedundant".
azureVmFamiliesarrayGets or sets the Azure VM families.
confidenceRatingInPercentagenumberConfidence Rating in Percentage.
costComponentsarrayGets the collection of cost components.
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".
discountPercentagenumberCustom discount percentage.
distributionByOsNameobjectGets the distribution by os name.
distributionByServicePackInsightobjectGets the distribution distribution of sqlInstances by service pack insight.
distributionBySupportStatusobjectGets the distribution of sqlInstances by support status.
eaSubscriptionIdstringGets or sets enterprise agreement subscription id.
groupTypestringGets the group type for the assessment. Known values are: "Default", "Import", and "Import".
monthlyBandwidthCostnumberGets or sets the aggregate Bandwidth Cost for all machines in the assessment.
monthlyComputeCostnumberGets or sets the aggregate Compute Cost for all machines in the assessment.
monthlyPremiumStorageCostnumberGets or sets the aggregate premium storage cost for all machines in the assessment.
monthlyStandardSsdStorageCostnumberGets or sets the aggregate standard SSD storage cost for all the machines in the assessment.
monthlyStorageCostnumberGets or sets the aggregate Storage Cost for all machines in the assessment.
monthlyUltraStorageCostnumberGets or sets the aggregate ultra storage cost for all machines in the assessment.
numberOfMachinesintegerGets or sets the Number of machines part of the assessment.
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".
reservedInstancestringGets or sets the Azure Reserved Instance - 1-Year, 3-Year. 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".
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".
suitabilitySummaryobjectGets or sets the Cloud suitability summary for all the machines in the assessment.
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.
vmUptimeobjectGets or sets the duration for which the VMs are up in the on-premises environment.

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 Assessment.
list_by_groupselectresource_group_name, project_name, group_name, subscription_idList Assessment resources by Group.
createinsertresource_group_name, project_name, group_name, assessment_name, subscription_idCreate a Assessment.
deletedeleteresource_group_name, project_name, group_name, assessment_name, subscription_idDelete a Assessment.
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_namestringMachine 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 Assessment.

SELECT
id,
name,
assessmentErrorSummary,
assessmentType,
azureDiskTypes,
azureHybridUseBenefit,
azureLocation,
azureOfferCode,
azurePricingTier,
azureStorageRedundancy,
azureVmFamilies,
confidenceRatingInPercentage,
costComponents,
createdTimestamp,
currency,
discountPercentage,
distributionByOsName,
distributionByServicePackInsight,
distributionBySupportStatus,
eaSubscriptionId,
groupType,
monthlyBandwidthCost,
monthlyComputeCost,
monthlyPremiumStorageCost,
monthlyStandardSsdStorageCost,
monthlyStorageCost,
monthlyUltraStorageCost,
numberOfMachines,
percentile,
perfDataEndTime,
perfDataStartTime,
pricesTimestamp,
provisioningState,
reservedInstance,
scalingFactor,
schemaVersion,
sizingCriterion,
stage,
status,
suitabilitySummary,
systemData,
timeRange,
type,
updatedTimestamp,
vmUptime
FROM azure.migration_assessment.assessments_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 Assessment.

INSERT INTO azure.migration_assessment.assessments_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 Assessment.

DELETE FROM azure.migration_assessment.assessments_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.assessments_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
;