CustomRecommendation interface

Custom Recommendation

Extends

Properties

assessmentKey

The assessment metadata key used when an assessment is generated for this Recommendation.

cloudProviders

List of all standard supported clouds.

description

The description to relate to the assessments generated by this Recommendation.

displayName

The display name of the assessments generated by this Recommendation.

query

KQL query representing the Recommendation results required.

remediationDescription

The remediation description to relate to the assessments generated by this Recommendation.

securityIssue

The severity to relate to the assessments generated by this Recommendation.

severity

The severity to relate to the assessments generated by this Recommendation.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

The name of the resource

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

assessmentKey

The assessment metadata key used when an assessment is generated for this Recommendation.

assessmentKey?: string

Property Value

string

cloudProviders

List of all standard supported clouds.

cloudProviders?: string[]

Property Value

string[]

description

The description to relate to the assessments generated by this Recommendation.

description?: string

Property Value

string

displayName

The display name of the assessments generated by this Recommendation.

displayName?: string

Property Value

string

query

KQL query representing the Recommendation results required.

query?: string

Property Value

string

remediationDescription

The remediation description to relate to the assessments generated by this Recommendation.

remediationDescription?: string

Property Value

string

securityIssue

The severity to relate to the assessments generated by this Recommendation.

securityIssue?: string

Property Value

string

severity

The severity to relate to the assessments generated by this Recommendation.

severity?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ExtensionResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ExtensionResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

Inherited From ExtensionResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ExtensionResource.type