Share via

Assessment interface

Package:
@azure/arm-migrationassessment

Machine assessment resource.

Extends
ProxyResource

Properties

assessmentErrorSummary

Gets or sets the assessment error summary. This is the number of machines affected by each type of error in this assessment. NOTE: This property will not be serialized. It can only be populated by the server.
assessmentType

Assessment type of the assessment. NOTE: This property will not be serialized. It can only be populated by the server.
azureDiskTypes

Gets or sets the azure storage type. Premium, Standard etc.
azureHybridUseBenefit

Gets or sets the user configurable setting to display the azure hybrid use benefit.
azureLocation

Azure Location or Azure region where to which the machines will be migrated.
azureOfferCode

Azure Offer Code.
azurePricingTier

Gets or sets Azure Pricing Tier - Free, Basic, etc.
azureStorageRedundancy

Gets or sets the Azure Storage Redundancy. Example: Locally Redundant Storage.
azureVmFamilies

Gets or sets the Azure VM families.
confidenceRatingInPercentage

Confidence Rating in Percentage. NOTE: This property will not be serialized. It can only be populated by the server.
costComponents

Gets the collection of cost components. NOTE: This property will not be serialized. It can only be populated by the server.
createdTimestamp

Date and Time when assessment was created. NOTE: This property will not be serialized. It can only be populated by the server.
currency

Currency in which prices should be reported.
discountPercentage

Custom discount percentage.
distributionByOsName

Gets the distribution by os name. NOTE: This property will not be serialized. It can only be populated by the server.
distributionByServicePackInsight

Gets the distribution distribution of sqlInstances by service pack insight. NOTE: This property will not be serialized. It can only be populated by the server.
distributionBySupportStatus

Gets the distribution of sqlInstances by support status. NOTE: This property will not be serialized. It can only be populated by the server.
eaSubscriptionId

Gets or sets enterprise agreement subscription id.
groupType

Gets the group type for the assessment. NOTE: This property will not be serialized. It can only be populated by the server.
monthlyBandwidthCost

Gets or sets the aggregate Bandwidth Cost for all machines in the assessment. NOTE: This property will not be serialized. It can only be populated by the server.
monthlyComputeCost

Gets or sets the aggregate Compute Cost for all machines in the assessment. NOTE: This property will not be serialized. It can only be populated by the server.
monthlyPremiumStorageCost

Gets or sets the aggregate premium storage cost for all machines in the assessment. NOTE: This property will not be serialized. It can only be populated by the server.
monthlyStandardSsdStorageCost

Gets or sets the aggregate standard SSD storage cost for all the machines in the assessment. NOTE: This property will not be serialized. It can only be populated by the server.
monthlyStorageCost

Gets or sets the aggregate Storage Cost for all machines in the assessment. NOTE: This property will not be serialized. It can only be populated by the server.
monthlyUltraStorageCost

Gets or sets the aggregate ultra storage cost for all machines in the assessment. NOTE: This property will not be serialized. It can only be populated by the server.
numberOfMachines

Gets or sets the Number of machines part of the assessment. NOTE: This property will not be serialized. It can only be populated by the server.
percentile

Percentile of the utilization data values to be considered while assessing machines.
perfDataEndTime

Gets or sets the end time to consider performance data for assessment.
perfDataStartTime

Gets or sets the start time to consider performance data for assessment.
pricesTimestamp

Last time when rates were queried. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

The status of the last operation.
reservedInstance

Gets or sets the Azure Reserved Instance - 1-Year, 3-Year.
scalingFactor

Percentage of buffer that user wants on performance metrics when recommending Azure sizes.
schemaVersion

Schema version. NOTE: This property will not be serialized. It can only be populated by the server.
sizingCriterion

Assessment sizing criterion.
stage

User configurable setting to display the Stage of Assessment. NOTE: This property will not be serialized. It can only be populated by the server.
status

Whether assessment is in valid state and all machines have been assessed. NOTE: This property will not be serialized. It can only be populated by the server.
suitabilitySummary

Gets or sets the Cloud suitability summary for all the machines in the assessment. NOTE: This property will not be serialized. It can only be populated by the server.
timeRange

Time Range for which the historic utilization data should be considered for assessment.
updatedTimestamp

Date and Time when assessment was last updated. NOTE: This property will not be serialized. It can only be populated by the server.
vmUptime

Gets or sets the duration for which the VMs are up in the on-premises environment.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

assessmentErrorSummary

Gets or sets the assessment error summary. This is the number of machines affected by each type of error in this assessment. NOTE: This property will not be serialized. It can only be populated by the server.

assessmentErrorSummary?: {[propertyName: string]: number}

Property Value

{[propertyName: string]: number}

assessmentType

Assessment type of the assessment. NOTE: This property will not be serialized. It can only be populated by the server.

assessmentType?: string

Property Value

string

azureDiskTypes

Gets or sets the azure storage type. Premium, Standard etc.

azureDiskTypes?: string[]

Property Value

string[]

azureHybridUseBenefit

Gets or sets the user configurable setting to display the azure hybrid use benefit.

azureHybridUseBenefit?: string

Property Value

string

azureLocation

Azure Location or Azure region where to which the machines will be migrated.

azureLocation?: string

Property Value

string

azureOfferCode

Azure Offer Code.

azureOfferCode?: string

Property Value

string

azurePricingTier

Gets or sets Azure Pricing Tier - Free, Basic, etc.

azurePricingTier?: string

Property Value

string

azureStorageRedundancy

Gets or sets the Azure Storage Redundancy. Example: Locally Redundant Storage.

azureStorageRedundancy?: string

Property Value

string

azureVmFamilies

Gets or sets the Azure VM families.

azureVmFamilies?: string[]

Property Value

string[]

confidenceRatingInPercentage

Confidence Rating in Percentage. NOTE: This property will not be serialized. It can only be populated by the server.

confidenceRatingInPercentage?: number

Property Value

number

costComponents

Gets the collection of cost components. NOTE: This property will not be serialized. It can only be populated by the server.

costComponents?: CostComponent[]

Property Value

CostComponent[]

createdTimestamp

Date and Time when assessment was created. NOTE: This property will not be serialized. It can only be populated by the server.

createdTimestamp?: Date

Property Value

Date

currency

Currency in which prices should be reported.

currency?: string

Property Value

string

discountPercentage

Custom discount percentage.

discountPercentage?: number

Property Value

number

distributionByOsName

Gets the distribution by os name. NOTE: This property will not be serialized. It can only be populated by the server.

distributionByOsName?: {[propertyName: string]: number}

Property Value

{[propertyName: string]: number}

distributionByServicePackInsight

Gets the distribution distribution of sqlInstances by service pack insight. NOTE: This property will not be serialized. It can only be populated by the server.

distributionByServicePackInsight?: {[propertyName: string]: number}

Property Value

{[propertyName: string]: number}

distributionBySupportStatus

Gets the distribution of sqlInstances by support status. NOTE: This property will not be serialized. It can only be populated by the server.

distributionBySupportStatus?: {[propertyName: string]: number}

Property Value

{[propertyName: string]: number}

eaSubscriptionId

Gets or sets enterprise agreement subscription id.

eaSubscriptionId?: string

Property Value

string

groupType

Gets the group type for the assessment. NOTE: This property will not be serialized. It can only be populated by the server.

groupType?: string

Property Value

string

monthlyBandwidthCost

Gets or sets the aggregate Bandwidth Cost for all machines in the assessment. NOTE: This property will not be serialized. It can only be populated by the server.

monthlyBandwidthCost?: number

Property Value

number

monthlyComputeCost

Gets or sets the aggregate Compute Cost for all machines in the assessment. NOTE: This property will not be serialized. It can only be populated by the server.

monthlyComputeCost?: number

Property Value

number

monthlyPremiumStorageCost

Gets or sets the aggregate premium storage cost for all machines in the assessment. NOTE: This property will not be serialized. It can only be populated by the server.

monthlyPremiumStorageCost?: number

Property Value

number

monthlyStandardSsdStorageCost

Gets or sets the aggregate standard SSD storage cost for all the machines in the assessment. NOTE: This property will not be serialized. It can only be populated by the server.

monthlyStandardSsdStorageCost?: number

Property Value

number

monthlyStorageCost

Gets or sets the aggregate Storage Cost for all machines in the assessment. NOTE: This property will not be serialized. It can only be populated by the server.

monthlyStorageCost?: number

Property Value

number

monthlyUltraStorageCost

Gets or sets the aggregate ultra storage cost for all machines in the assessment. NOTE: This property will not be serialized. It can only be populated by the server.

monthlyUltraStorageCost?: number

Property Value

number

numberOfMachines

Gets or sets the Number of machines part of the assessment. NOTE: This property will not be serialized. It can only be populated by the server.

numberOfMachines?: number

Property Value

number

percentile

Percentile of the utilization data values to be considered while assessing machines.

percentile?: string

Property Value

string

perfDataEndTime

Gets or sets the end time to consider performance data for assessment.

perfDataEndTime?: Date

Property Value

Date

perfDataStartTime

Gets or sets the start time to consider performance data for assessment.

perfDataStartTime?: Date

Property Value

Date

pricesTimestamp

Last time when rates were queried. NOTE: This property will not be serialized. It can only be populated by the server.

pricesTimestamp?: Date

Property Value

Date

provisioningState

The status of the last operation.

provisioningState?: string

Property Value

string

reservedInstance

Gets or sets the Azure Reserved Instance - 1-Year, 3-Year.

reservedInstance?: string

Property Value

string

scalingFactor

Percentage of buffer that user wants on performance metrics when recommending Azure sizes.

scalingFactor?: number

Property Value

number

schemaVersion

Schema version. NOTE: This property will not be serialized. It can only be populated by the server.

schemaVersion?: string

Property Value

string

sizingCriterion

Assessment sizing criterion.

sizingCriterion?: string

Property Value

string

stage

User configurable setting to display the Stage of Assessment. NOTE: This property will not be serialized. It can only be populated by the server.

stage?: string

Property Value

string

status

Whether assessment is in valid state and all machines have been assessed. NOTE: This property will not be serialized. It can only be populated by the server.

status?: string

Property Value

string

suitabilitySummary

Gets or sets the Cloud suitability summary for all the machines in the assessment. NOTE: This property will not be serialized. It can only be populated by the server.

suitabilitySummary?: {[propertyName: string]: number}

Property Value

{[propertyName: string]: number}

timeRange

Time Range for which the historic utilization data should be considered for assessment.

timeRange?: string

Property Value

string

updatedTimestamp

Date and Time when assessment was last updated. NOTE: This property will not be serialized. It can only be populated by the server.

updatedTimestamp?: Date

Property Value

Date

vmUptime

Gets or sets the duration for which the VMs are up in the on-premises environment.

vmUptime?: VmUptime

Property Value

VmUptime

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type