Skip to main content

avs_assessments_operations

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

Overview​

Nameavs_assessments_operations
TypeResource
Idazure.migration_assessment.avs_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 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".
azureLocationstringAzure 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".
azureOfferCodestringAzure Offer code according to which cost estimation is done. 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".
confidenceRatingInPercentagenumberConfidence Rating in Percentage.
cpuUtilizationnumberPredicted CPU utilization.
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".
dedupeCompressionnumberDe-duplication compression.
discountPercentagenumberCustom discount percentage.
failuresToTolerateAndRaidLevelstringFailures to tolerate and RAID level in a common property. Known values are: "Unknown", "Ftt1Raid1", "Ftt1Raid5", "Ftt2Raid1", "Ftt2Raid6", and "Ftt3Raid1".
groupTypestringGets the group type for the assessment. Known values are: "Default", "Import", and "Import".
isStretchClusterEnabledbooleanIs Stretch Cluster Enabled.
limitingFactorstringLimiting factor.
memOvercommitnumberMemory overcommit.
nodeTypestringAVS node type. Known values are: "Unknown" and "AV36".
numberOfMachinesintegerNumber of machines part of the assessment.
numberOfNodesintegerRecommended number of nodes.
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)Time when the Azure Prices were queried. Date-Time represented in ISO-8601 format.
provisioningStatestringThe status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
ramUtilizationnumberPredicted RAM utilization.
reservedInstancestringReserved instance. 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".
storageUtilizationnumberPredicted storage utilization.
suitabilitystringGets or sets the Assessment cloud suitability. Known values are: "Unknown", "NotSuitable", "Suitable", "ConditionallySuitable", and "ReadinessUnknown".
suitabilityExplanationstringGets or sets the Assessment suitability explanation. Known values are: "Unknown", "NotApplicable", and "UnsupportedLocationForSelectedNode".
suitabilitySummaryobjectCloud 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".
totalCpuCoresnumberPredicted total CPU cores used.
totalMonthlyCostnumberTotal monthly cost.
totalRamInGBnumberPredicted total RAM used in GB.
totalStorageInGBnumberPredicted total Storage used in GB.
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.
vcpuOversubscriptionnumberVCPU over subscription.

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

SELECT
id,
name,
assessmentErrorSummary,
assessmentType,
azureLocation,
azureOfferCode,
confidenceRatingInPercentage,
cpuUtilization,
createdTimestamp,
currency,
dedupeCompression,
discountPercentage,
failuresToTolerateAndRaidLevel,
groupType,
isStretchClusterEnabled,
limitingFactor,
memOvercommit,
nodeType,
numberOfMachines,
numberOfNodes,
percentile,
perfDataEndTime,
perfDataStartTime,
pricesTimestamp,
provisioningState,
ramUtilization,
reservedInstance,
scalingFactor,
schemaVersion,
sizingCriterion,
stage,
status,
storageUtilization,
suitability,
suitabilityExplanation,
suitabilitySummary,
systemData,
timeRange,
totalCpuCores,
totalMonthlyCost,
totalRamInGB,
totalStorageInGB,
type,
updatedTimestamp,
vcpuOversubscription
FROM azure.migration_assessment.avs_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 AvsAssessment.

INSERT INTO azure.migration_assessment.avs_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 AvsAssessment.

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