Share via

AvsAssessment interface

Package:
@azure/arm-migrationassessment

AVS assessment resource.

Extends
ProxyResource

Properties

assessmentErrorSummary

Gets 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.
azureLocation

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

Azure Offer code according to which cost estimation is done.
confidenceRatingInPercentage

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

Predicted CPU utilization. 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.
dedupeCompression

De-duplication compression.
discountPercentage

Custom discount percentage.
failuresToTolerateAndRaidLevel

Failures to tolerate and RAID level in a common property.
groupType

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

Is Stretch Cluster Enabled.
limitingFactor

Limiting factor. NOTE: This property will not be serialized. It can only be populated by the server.
memOvercommit

Memory overcommit.
nodeType

AVS node type.
numberOfMachines

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

Recommended number of nodes. 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

Time when the Azure Prices were queried. Date-Time represented in ISO-8601 format. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

The status of the last operation.
ramUtilization

Predicted RAM utilization. NOTE: This property will not be serialized. It can only be populated by the server.
reservedInstance

Reserved instance.
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.
storageUtilization

Predicted storage utilization. NOTE: This property will not be serialized. It can only be populated by the server.
suitability

Gets or sets the Assessment cloud suitability. NOTE: This property will not be serialized. It can only be populated by the server.
suitabilityExplanation

Gets or sets the Assessment suitability explanation. NOTE: This property will not be serialized. It can only be populated by the server.
suitabilitySummary

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.
totalCpuCores

Predicted total CPU cores used. NOTE: This property will not be serialized. It can only be populated by the server.
totalMonthlyCost

Total monthly cost. NOTE: This property will not be serialized. It can only be populated by the server.
totalRamInGB

Predicted total RAM used in GB. NOTE: This property will not be serialized. It can only be populated by the server.
totalStorageInGB

Predicted total Storage used in GB. NOTE: This property will not be serialized. It can only be populated by the server.
updatedTimestamp

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

VCPU over subscription.

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 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

azureLocation

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

azureLocation?: string

Property Value

string

azureOfferCode

Azure Offer code according to which cost estimation is done.

azureOfferCode?: 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

cpuUtilization

Predicted CPU utilization. NOTE: This property will not be serialized. It can only be populated by the server.

cpuUtilization?: number

Property Value

number

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

dedupeCompression

De-duplication compression.

dedupeCompression?: number

Property Value

number

discountPercentage

Custom discount percentage.

discountPercentage?: number

Property Value

number

failuresToTolerateAndRaidLevel

Failures to tolerate and RAID level in a common property.

failuresToTolerateAndRaidLevel?: 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

isStretchClusterEnabled

Is Stretch Cluster Enabled.

isStretchClusterEnabled?: boolean

Property Value

boolean

limitingFactor

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

limitingFactor?: string

Property Value

string

memOvercommit

Memory overcommit.

memOvercommit?: number

Property Value

number

nodeType

AVS node type.

nodeType?: string

Property Value

string

numberOfMachines

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

numberOfNodes

Recommended number of nodes. NOTE: This property will not be serialized. It can only be populated by the server.

numberOfNodes?: 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

Time when the Azure Prices were queried. Date-Time represented in ISO-8601 format. 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

ramUtilization

Predicted RAM utilization. NOTE: This property will not be serialized. It can only be populated by the server.

ramUtilization?: number

Property Value

number

reservedInstance

Reserved instance.

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

storageUtilization

Predicted storage utilization. NOTE: This property will not be serialized. It can only be populated by the server.

storageUtilization?: number

Property Value

number

suitability

Gets or sets the Assessment cloud suitability. NOTE: This property will not be serialized. It can only be populated by the server.

suitability?: string

Property Value

string

suitabilityExplanation

Gets or sets the Assessment suitability explanation. NOTE: This property will not be serialized. It can only be populated by the server.

suitabilityExplanation?: string

Property Value

string

suitabilitySummary

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

totalCpuCores

Predicted total CPU cores used. NOTE: This property will not be serialized. It can only be populated by the server.

totalCpuCores?: number

Property Value

number

totalMonthlyCost

Total monthly cost. NOTE: This property will not be serialized. It can only be populated by the server.

totalMonthlyCost?: number

Property Value

number

totalRamInGB

Predicted total RAM used in GB. NOTE: This property will not be serialized. It can only be populated by the server.

totalRamInGB?: number

Property Value

number

totalStorageInGB

Predicted total Storage used in GB. NOTE: This property will not be serialized. It can only be populated by the server.

totalStorageInGB?: number

Property Value

number

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

vcpuOversubscription

VCPU over subscription.

vcpuOversubscription?: number

Property Value

number

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