ResourceRecommendationBase interface

Package:

@azure/arm-advisor

Advisor Recommendation.

Extends

Resource

Properties

actions	The list of recommended actions to implement recommendation.
category	The category of the recommendation.
description	The detailed description of recommendation.
exposedMetadataProperties	The recommendation metadata properties exposed to customer to provide additional information.
extendedProperties	Extended properties
impact	The business impact of the recommendation.
impactedField	The resource type identified by Advisor.
impactedValue	The resource identified by Advisor.
label	The label of recommendation.
lastUpdated	The most recent time that Advisor checked the validity of the recommendation.
learnMoreLink	The link to learn more about recommendation and generation logic.
metadata	The recommendation metadata.
potentialBenefits	The potential benefit of implementing recommendation.
recommendationTypeId	The recommendation-type GUID.
remediation	The automated way to apply recommendation.
resourceMetadata	Metadata of resource that was assessed
risk	The potential risk of not implementing the recommendation.
shortDescription	A summary of the recommendation.
suppressionIds	The list of snoozed and dismissed rules for the recommendation.

Inherited Properties

id	The resource ID. 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.
type	The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

actions

The list of recommended actions to implement recommendation.

actions?: {[propertyName: string]: Record<string, unknown>}[]

Property Value

{[propertyName: string]: Record<string, unknown>}[]

category

The category of the recommendation.

category?: string

Property Value

string

description

The detailed description of recommendation.

description?: string

Property Value

string

exposedMetadataProperties

The recommendation metadata properties exposed to customer to provide additional information.

exposedMetadataProperties?: {[propertyName: string]: Record<string, unknown>}

Property Value

{[propertyName: string]: Record<string, unknown>}

extendedProperties

Extended properties

extendedProperties?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

impact

The business impact of the recommendation.

impact?: string

Property Value

string

impactedField

The resource type identified by Advisor.

impactedField?: string

Property Value

string

impactedValue

The resource identified by Advisor.

impactedValue?: string

Property Value

string

label

The label of recommendation.

label?: string

Property Value

string

lastUpdated

The most recent time that Advisor checked the validity of the recommendation.

lastUpdated?: Date

Property Value

Date

learnMoreLink

The link to learn more about recommendation and generation logic.

learnMoreLink?: string

Property Value

string

metadata

The recommendation metadata.

metadata?: {[propertyName: string]: Record<string, unknown>}

Property Value

{[propertyName: string]: Record<string, unknown>}

potentialBenefits

The potential benefit of implementing recommendation.

potentialBenefits?: string

Property Value

string

recommendationTypeId

The recommendation-type GUID.

recommendationTypeId?: string

Property Value

string

remediation

The automated way to apply recommendation.

remediation?: {[propertyName: string]: Record<string, unknown>}

Property Value

{[propertyName: string]: Record<string, unknown>}

resourceMetadata

Metadata of resource that was assessed

resourceMetadata?: ResourceMetadata

Property Value

ResourceMetadata

risk

The potential risk of not implementing the recommendation.

risk?: string

Property Value

string

shortDescription

A summary of the recommendation.

shortDescription?: ShortDescription

Property Value

ShortDescription

suppressionIds

The list of snoozed and dismissed rules for the recommendation.

suppressionIds?: string[]

Property Value

string[]

Inherited Property Details

id

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

id?: string

Property Value

string

Inherited From Resource.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 Resource.name

type

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

type?: string

Property Value

string

Inherited From Resource.type