Skip to content

recommendationbase.md

Latest commit

 

History

History
94 lines (86 loc) · 8.07 KB

recommendationbase.md

File metadata and controls

94 lines (86 loc) · 8.07 KB
title recommendationBase resource type
description An abstract type that exposes the properties for a recommendation.
author ddeeps2610
ms.localizationpriority medium
ms.subservice entra-monitoring-health
doc_type resourcePageType
ms.date 04/09/2024

recommendationBase resource type

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

An abstract type that exposes the properties for the recommendation resource type.

Methods

None.

Properties

Property Type Description
actionSteps actionStep collection List of actions to take to complete a recommendation.
benefits String An explanation of why completing the recommendation will benefit you. Corresponds to the Value section of a recommendation shown in the Microsoft Entra admin center.
category recommendationCategory Indicates the category of intelligent guidance that the recommendation falls under. The possible values are: identityBestPractice, identitySecureScore, unknownFutureValue, mdiSecureScore. Use the Prefer: include-unknown-enum-members request header to get the following values from this evolvable enum: mdiSecureScore.
createdDateTime DateTimeOffset The date and time when the recommendation was detected as applicable to your directory.
currentScore Double The number of points the tenant has attained. Only applies to recommendations with category set to identitySecureScore.
displayName String The title of the recommendation.
featureAreas recommendationFeatureAreas collection The directory feature that the recommendation is related to.
id String The unique identifier for the recommendation object generated for your tenant. This is a concatenation of your tenant ID and a Microsoft Entra ID-assigned nickname for the recommendation. For example, 7918d4b5-0442-4a97-be2d-36f9f9962ece_Microsoft.Identity.IAM.Insights.ThirdPartyApps
impactStartDateTime DateTimeOffset The future date and time when a recommendation should be completed.
impactType String Indicates the scope of impact of a recommendation. tenantLevel indicates that the recommendation impacts the whole tenant. Other possible values include users, apps.
insights String Describes why a recommendation uniquely applies to your directory. Corresponds to the Description section of a recommendation shown in the Microsoft Entra admin center.
lastCheckedDateTime DateTimeOffset The most recent date and time a recommendation was deemed applicable to your directory.
lastModifiedBy String Name of the user who last updated the status of the recommendation.
lastModifiedDateTime DateTimeOffset The date and time the status of a recommendation was last updated.
maxScore Double The maximum number of points attainable. Only applies to recommendations with category set to identitySecureScore.
postponeUntilDateTime DateTimeOffset The future date and time when the status of a postponed recommendation will be active again.
priority recommendationPriority Indicates the time sensitivity for a recommendation to be completed. Microsoft auto assigns this value. The possible values are: low, medium, high.
recommendationType recommendationType Friendly shortname to identify the recommendation. The possible values are: adfsAppsMigration, enableDesktopSSO, enablePHS, enableProvisioning, switchFromPerUserMFA, tenantMFA, thirdPartyApps, turnOffPerUserMFA, useAuthenticatorApp, useMyApps, staleApps, staleAppCreds, applicationCredentialExpiry, servicePrincipalKeyExpiry, adminMFAV2, blockLegacyAuthentication, integratedApps, mfaRegistrationV2, pwagePolicyNew, passwordHashSync, oneAdmin, roleOverlap, selfServicePasswordReset, signinRiskPolicy, userRiskPolicy, verifyAppPublisher, privateLinkForAAD, appRoleAssignmentsGroups, appRoleAssignmentsUsers, managedIdentity, overprivilegedApps, unknownFutureValue, longLivedCredentials, aadConnectDeprecated, adalToMsalMigration, ownerlessApps, inactiveGuests, aadGraphDeprecationApplication, aadGraphDeprecationServicePrincipal, mfaServerDeprecation. Use the Prefer: include-unknown-enum-members request header to get the following members in this evolvable enum: longLivedCredentials , aadConnectDeprecated , adalToMsalMigration , ownerlessApps , inactiveGuests , aadGraphDeprecationApplication , aadGraphDeprecationServicePrincipal , mfaServerDeprecation.
releaseType releaseType The current release type of the recommendation. The possible values are: preview, generallyAvailable, unknownFutureValue.
remediationImpact String Description of the impact on users of the remediation. Only applies to recommendations with category set to identitySecureScore.
requiredLicenses requiredLicenses The required licenses to view the recommendation. The possible values are: notApplicable, microsoftEntraIdFree, microsoftEntraIdP1, microsoftEntraIdP2, microsoftEntraIdGovernance, microsoftEntraWorkloadId, unknownFutureValue, aatp. Use the Prefer: include-unknown-enum-members request header to get the following values from this evolvable enum: aatp.
status recommendationStatus Indicates the status of the recommendation based on user or system action. The possible values are: active, completedBySystem, completedByUser, dismissed, postponed, unknownFutureValue, riskAccepted, thirdParty, planned, alternateMitigation. Use the Prefer: include-unknown-enum-members request header to get the following values from this evolvable enum: riskAccepted , thirdParty , planned , alternateMitigation. By default, a recommendation's status is set to active when the recommendation is first generated. Status is set to completedBySystem when our service detects that a recommendation which was previously active no longer applies.

Relationships

Relationship Type Description
impactedResources impactedResource collection The list of directory objects associated with the recommendation.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.recommendationBase",
  "id": "String (identifier)",
  "actionSteps": [
    {
      "@odata.type": "microsoft.graph.actionStep"
    }
  ],
  "benefits": "String",
  "category": "String",
  "createdDateTime": "String (timestamp)",
  "currentScore": "Double",
  "displayName": "String",
  "featureAreas": [
    "String"
  ],
  "releaseType": "String",
  "requiredLicenses": "String",
  "impactType": "String",
  "impactStartDateTime": "String (timestamp)",
  "insights": "String",
  "lastCheckedDateTime": "String (timestamp)",
  "lastModifiedDateTime": "String (timestamp)",
  "lastModifiedBy": "String",
  "maxScore": "Double",
  "postponeUntilDateTime": "String (timestamp)",
  "priority": "String",
  "status": "String",
  "remediationImpact": "String",
  "recommendationType": "String"
}