Share via

Update-MgBetaDirectoryRecommendation

Module:
Microsoft.Graph.Beta.Identity.DirectoryManagement Module

Update the navigation property recommendations in directory

Syntax

UpdateExpanded (Default) 

Update-MgBetaDirectoryRecommendation
    -RecommendationId <String>
    [-ResponseHeadersVariable <String>]
    [-ActionSteps <IMicrosoftGraphActionStep[]>]
    [-AdditionalProperties <Hashtable>]
    [-Benefits <String>]
    [-Category <String>]
    [-CreatedDateTime <DateTime>]
    [-CurrentScore <Double>]
    [-DisplayName <String>]
    [-FeatureAreas <String[]>]
    [-Id <String>]
    [-ImpactStartDateTime <DateTime>]
    [-ImpactType <String>]
    [-ImpactedResources <IMicrosoftGraphImpactedResource[]>]
    [-Insights <String>]
    [-LastCheckedDateTime <DateTime>]
    [-LastModifiedBy <String>]
    [-LastModifiedDateTime <DateTime>]
    [-MaxScore <Double>]
    [-PostponeUntilDateTime <DateTime>]
    [-Priority <String>]
    [-RecommendationType <String>]
    [-ReleaseType <String>]
    [-RemediationImpact <String>]
    [-RequiredLicenses <String>]
    [-Status <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update 

Update-MgBetaDirectoryRecommendation
    -RecommendationId <String>
    -BodyParameter <Hashtable>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentityExpanded 

Update-MgBetaDirectoryRecommendation
    -InputObject <IIdentityDirectoryManagementIdentity>
    [-ResponseHeadersVariable <String>]
    [-ActionSteps <IMicrosoftGraphActionStep[]>]
    [-AdditionalProperties <Hashtable>]
    [-Benefits <String>]
    [-Category <String>]
    [-CreatedDateTime <DateTime>]
    [-CurrentScore <Double>]
    [-DisplayName <String>]
    [-FeatureAreas <String[]>]
    [-Id <String>]
    [-ImpactStartDateTime <DateTime>]
    [-ImpactType <String>]
    [-ImpactedResources <IMicrosoftGraphImpactedResource[]>]
    [-Insights <String>]
    [-LastCheckedDateTime <DateTime>]
    [-LastModifiedBy <String>]
    [-LastModifiedDateTime <DateTime>]
    [-MaxScore <Double>]
    [-PostponeUntilDateTime <DateTime>]
    [-Priority <String>]
    [-RecommendationType <String>]
    [-ReleaseType <String>]
    [-RemediationImpact <String>]
    [-RequiredLicenses <String>]
    [-Status <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentity 

Update-MgBetaDirectoryRecommendation
    -InputObject <IIdentityDirectoryManagementIdentity>
    -BodyParameter <Hashtable>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Update the navigation property recommendations in directory

Parameters

-ActionSteps

List of actions to take to complete a recommendation. To construct, see NOTES section for ACTIONSTEPS properties and create a hash table.

Parameter properties

Type:

IMicrosoftGraphActionStep[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AdditionalProperties

Additional Parameters

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Benefits

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BodyParameter

recommendation

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Update
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Category

recommendationCategory

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CreatedDateTime

The date and time when the recommendation was detected as applicable to your directory.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CurrentScore

The number of points the tenant has attained. Only applies to recommendations with category set to identitySecureScore.

Parameter properties

Type:Double
Default value:0
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisplayName

The title of the recommendation.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FeatureAreas

The directory feature that the recommendation is related to.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:IDictionary
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

The unique identifier for an entity. Read-only.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ImpactedResources

The list of directory objects associated with the recommendation. To construct, see NOTES section for IMPACTEDRESOURCES properties and create a hash table.

Parameter properties

Type:

IMicrosoftGraphImpactedResource[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ImpactStartDateTime

The future date and time when a recommendation should be completed.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ImpactType

Indicates the scope of impact of a recommendation. Tenant level indicates that the recommendation impacts the whole tenant. Other possible values include users, applications.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:IIdentityDirectoryManagementIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Insights

Describes why a recommendation uniquely applies to your directory. Corresponds to the Description section of a recommendation shown in the Microsoft Entra admin center.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LastCheckedDateTime

The most recent date and time a recommendation was deemed applicable to your directory.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LastModifiedBy

Name of the user who last updated the status of the recommendation.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LastModifiedDateTime

The date and time the status of a recommendation was last updated.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaxScore

The maximum number of points attainable. Only applies to recommendations with category set to identitySecureScore.

Parameter properties

Type:Double
Default value:0
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PostponeUntilDateTime

The future date and time when the status of a postponed recommendation will be active again.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Priority

recommendationPriority

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RecommendationId

The unique identifier of recommendation

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Update
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RecommendationType

recommendationType

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ReleaseType

The current release type of the recommendation. The possible values are: preview, generallyAvailable, unknownFutureValue.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RemediationImpact

Description of the impact on users of the remediation. Only applies to recommendations with category set to identitySecureScore.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RequiredLicenses

requiredLicenses

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:RHV

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Status

recommendationStatus

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IIdentityDirectoryManagementIdentity

System.Collections.Hashtable

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphRecommendation

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

ACTIONSTEPS <IMicrosoftGraphActionStep- []>: List of actions to take to complete a recommendation.

  • [ActionUrl <IMicrosoftGraphActionUrl>]: actionUrl
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DisplayName <String>]: Brief title for the page that the links directs to.
    • [Url <String>]: The URL to the documentation or Microsoft Entra admin center page.
  • [StepNumber <Int64?>]: Indicates the position for this action in the order of the collection of actions to be taken.
  • [Text <String>]: Friendly description of the action to take.

IMPACTEDRESOURCES <IMicrosoftGraphImpactedResource- []>: The list of directory objects associated with the recommendation.

  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [AddedDateTime <DateTime?>]: The date and time when the impactedResource object was initially associated with the recommendation.
  • [AdditionalDetails <IMicrosoftGraphKeyValue- []>]: Additional information unique to the impactedResource to help contextualize the recommendation.
    • [Key <String>]: Key.
    • [Value <String>]: Value.
  • [ApiUrl <String>]: The URL link to the corresponding Microsoft Entra resource.
  • [DisplayName <String>]: Friendly name of the Microsoft Entra resource.
  • [LastModifiedBy <String>]: Name of the user or service that last updated the status.
  • [LastModifiedDateTime <String>]: The date and time when the status was last updated.
  • [Owner <String>]: The user responsible for maintaining the resource.
  • [PortalUrl <String>]: The URL link to the corresponding Microsoft Entra admin center page of the resource.
  • [PostponeUntilDateTime <DateTime?>]: The future date and time when the status of a postponed impactedResource will be active again.
  • [Rank <Int32?>]: Indicates the importance of the resource. A resource with a rank equal to 1 is of the highest importance.
  • [RecommendationId <String>]: The unique identifier of the recommendation that the resource is associated with.
  • [ResourceType <String>]: Indicates the type of Microsoft Entra resource. Examples include user, application.
  • [Status <String>]: recommendationStatus
  • [SubjectId <String>]: The related unique identifier, depending on the resourceType. For example, this property is set to the applicationId if the resourceType is an application.

INPUTOBJECT <IIdentityDirectoryManagementIdentity>: Identity Parameter

  • [AdministrativeUnitId <String>]: The unique identifier of administrativeUnit
  • [AllowedValueId <String>]: The unique identifier of allowedValue
  • [AttributeSetId <String>]: The unique identifier of attributeSet
  • [CertificateAuthorityAsEntityId <String>]: The unique identifier of certificateAuthorityAsEntity
  • [CertificateAuthorityDetailId <String>]: The unique identifier of certificateAuthorityDetail
  • [CertificateBasedApplicationConfigurationId <String>]: The unique identifier of certificateBasedApplicationConfiguration
  • [CertificateBasedAuthPkiId <String>]: The unique identifier of certificateBasedAuthPki
  • [CommandId <String>]: The unique identifier of command
  • [CommerceSubscriptionId <String>]: Alternate key of companySubscription
  • [CompanySubscriptionId <String>]: The unique identifier of companySubscription
  • [ContractId <String>]: The unique identifier of contract
  • [CustomSecurityAttributeDefinitionId <String>]: The unique identifier of customSecurityAttributeDefinition
  • [DeviceId <String>]: The unique identifier of device
  • [DeviceLocalCredentialInfoId <String>]: The unique identifier of deviceLocalCredentialInfo
  • [DeviceTemplateId <String>]: The unique identifier of deviceTemplate
  • [DirectoryObjectId <String>]: The unique identifier of directoryObject
  • [DirectoryRoleId <String>]: The unique identifier of directoryRole
  • [DirectoryRoleTemplateId <String>]: The unique identifier of directoryRoleTemplate
  • [DirectorySettingId <String>]: The unique identifier of directorySetting
  • [DirectorySettingTemplateId <String>]: The unique identifier of directorySettingTemplate
  • [DomainDnsRecordId <String>]: The unique identifier of domainDnsRecord
  • [DomainId <String>]: The unique identifier of ___domain
  • [DomainName <String>]: Usage: domainName='{domainName}'
  • [ExtensionId <String>]: The unique identifier of extension
  • [ExternalUserProfileId <String>]: The unique identifier of externalUserProfile
  • [FeatureRolloutPolicyId <String>]: The unique identifier of featureRolloutPolicy
  • [HardwareOathTokenAuthenticationMethodDeviceId <String>]: The unique identifier of hardwareOathTokenAuthenticationMethodDevice
  • [IdentityProviderBaseId <String>]: The unique identifier of identityProviderBase
  • [ImpactedResourceId <String>]: The unique identifier of impactedResource
  • [InboundSharedUserProfileUserId <String>]: The unique identifier of inboundSharedUserProfile
  • [InternalDomainFederationId <String>]: The unique identifier of internalDomainFederation
  • [MutualTlsOauthConfigurationId <String>]: The unique identifier of mutualTlsOauthConfiguration
  • [OcpSubscriptionId <String>]: Alternate key of companySubscription
  • [OnPremisesDirectorySynchronizationId <String>]: The unique identifier of onPremisesDirectorySynchronization
  • [OrgContactId <String>]: The unique identifier of orgContact
  • [OrganizationId <String>]: The unique identifier of organization
  • [OrganizationalBrandingLocalizationId <String>]: The unique identifier of organizationalBrandingLocalization
  • [OutboundSharedUserProfileUserId <String>]: The unique identifier of outboundSharedUserProfile
  • [PendingExternalUserProfileId <String>]: The unique identifier of pendingExternalUserProfile
  • [ProfileCardPropertyId <String>]: The unique identifier of profileCardProperty
  • [RecommendationId <String>]: The unique identifier of recommendation
  • [RoleTemplateId <String>]: Alternate key of directoryRole
  • [ScopedRoleMembershipId <String>]: The unique identifier of scopedRoleMembership
  • [SharedEmailDomainId <String>]: The unique identifier of sharedEmailDomain
  • [SharedEmailDomainInvitationId <String>]: The unique identifier of sharedEmailDomainInvitation
  • [SubscribedSkuId <String>]: The unique identifier of subscribedSku
  • [TenantId <String>]: Usage: tenantId='{tenantId}'
  • [TenantReferenceTenantId <String>]: The unique identifier of tenantReference
  • [UsageRightId <String>]: The unique identifier of usageRight
  • [UserId <String>]: The unique identifier of user