Skip to content

Latest commit

 

History

History
540 lines (432 loc) · 12.9 KB

New-MgBetaDirectoryRecommendation.md

File metadata and controls

540 lines (432 loc) · 12.9 KB
Raw
external help file Module Name online version schema
Microsoft.Graph.Beta.Identity.DirectoryManagement-help.xml
Microsoft.Graph.Beta.Identity.DirectoryManagement
2.0.0

New-MgBetaDirectoryRecommendation

SYNOPSIS

Create new navigation property to recommendations for directory

SYNTAX

CreateExpanded (Default)

New-MgBetaDirectoryRecommendation [-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>] [-Status <String>] [-Headers <IDictionary>]
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

Create

New-MgBetaDirectoryRecommendation -BodyParameter <Hashtable> [-ResponseHeadersVariable <String>]
 [-Headers <IDictionary>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Create new navigation property to recommendations for 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.

Type: IMicrosoftGraphActionStep[]
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AdditionalProperties

Additional Parameters

Type: Hashtable
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: 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.

Type: String
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-BodyParameter

recommendation

Type: Hashtable
Parameter Sets: Create
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Category

recommendationCategory

Type: String
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CreatedDateTime

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

Type: DateTime
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CurrentScore

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

Type: Double
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-DisplayName

The title of the recommendation.

Type: String
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-FeatureAreas

The directory feature that the recommendation is related to.

Type: String[]
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Headers

Optional headers that will be added to the request.

Type: IDictionary
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Id

The unique identifier for an entity. Read-only.

Type: String
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ImpactedResources

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

Type: IMicrosoftGraphImpactedResource[]
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ImpactStartDateTime

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

Type: DateTime
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: 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.

Type: String
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: 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.

Type: String
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LastCheckedDateTime

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

Type: DateTime
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LastModifiedBy

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

Type: String
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LastModifiedDateTime

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

Type: DateTime
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MaxScore

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

Type: Double
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-PostponeUntilDateTime

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

Type: DateTime
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Priority

recommendationPriority

Type: String
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RecommendationType

recommendationType

Type: String
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ReleaseType

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

Type: String
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RemediationImpact

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

Type: String
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type: String
Parameter Sets: (All)
Aliases: RHV

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Status

recommendationStatus

Type: String
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

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.

RELATED LINKS

https://learn.microsoft.com/powershell/module/microsoft.graph.beta.identity.directorymanagement/new-mgbetadirectoryrecommendation