In the Microsoft Entra access reviews feature, create a new accessReview object.
Before making this request, the caller must have previously retrieved the list of business flow templates, to have the value of businessFlowTemplateId to include in the request.
After making this request, the caller should create a programControl, to link the access review to a program.
In the Microsoft Entra access reviews feature, create a new accessReview object.
Before making this request, the caller must have previously retrieved the list of business flow templates, to have the value of businessFlowTemplateId to include in the request.
After making this request, the caller should create a programControl, to link the access review to a program.
This example shows how to use the New-MgBetaAccessReview Cmdlet.
Parameters
-AdditionalProperties
Additional Parameters
Parameter properties
Type:
Hashtable
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-BodyParameter
accessReview
To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Parameter properties
Type:
IMicrosoftGraphAccessReview
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
Create
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
-BusinessFlowTemplateId
The business flow template identifier.
Required on create.
This value is case sensitive.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
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
-CreatedBy
userIdentity
To construct, see NOTES section for CREATEDBY properties and create a hash table.
Parameter properties
Type:
IMicrosoftGraphUserIdentity
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Decisions
The collection of decisions for this access review.
To construct, see NOTES section for DECISIONS properties and create a hash table.
Parameter properties
Type:
IMicrosoftGraphAccessReviewDecision[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Description
The description provided by the access review creator, to show to the reviewers.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-DisplayName
The access review name.
Required on create.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-EndDateTime
The DateTime when the review is scheduled to end.
This must be at least one day later than the start date.
Required on create.
Parameter properties
Type:
DateTime
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
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
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Instances
The collection of access reviews instances past, present, and future, if this object is a recurring access review.
To construct, see NOTES section for INSTANCES properties and create a hash table.
Parameter properties
Type:
IMicrosoftGraphAccessReview[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-MyDecisions
The collection of decisions for the caller, if the caller is a reviewer.
To construct, see NOTES section for MYDECISIONS properties and create a hash table.
Parameter properties
Type:
IMicrosoftGraphAccessReviewDecision[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
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
-ReviewedEntity
identity
To construct, see NOTES section for REVIEWEDENTITY properties and create a hash table.
Parameter properties
Type:
IMicrosoftGraphIdentity
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Reviewers
The collection of reviewers for an access review, if access review reviewerType is of type delegated.
To construct, see NOTES section for REVIEWERS properties and create a hash table.
Parameter properties
Type:
IMicrosoftGraphAccessReviewReviewer[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ReviewerType
The relationship type of reviewer to the target object, one of: self, delegated, entityOwners.
Required on create.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Settings
accessReviewSettings
To construct, see NOTES section for SETTINGS properties and create a hash table.
Parameter properties
Type:
IMicrosoftGraphAccessReviewSettings
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-StartDateTime
The date and time when the review is scheduled to be start.
This date can be in the future.
Required on create.
Parameter properties
Type:
DateTime
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Status
This read-only field specifies the status of an accessReview.
The typical states include Initializing, NotStarted, Starting,InProgress, Completing, Completed, AutoReviewing, and AutoReviewed.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
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.
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.
[Description <String>]: The description provided by the access review creator, to show to the reviewers.
[DisplayName <String>]: The access review name.
Required on create.
[EndDateTime <DateTime?>]: The DateTime when the review is scheduled to end.
This must be at least one day later than the start date.
Required on create.
[Instances <IMicrosoftGraphAccessReview- []>]: The collection of access reviews instances past, present, and future, if this object is a recurring access review.
[MyDecisions <IMicrosoftGraphAccessReviewDecision- []>]: The collection of decisions for the caller, if the caller is a reviewer.
[(Any) <Object>]: This indicates any property can be added to this object.
[DisplayName <String>]: The display name of the identity.
This property is read-only.
[Id <String>]: The identifier of the identity.
This property is read-only.
[ReviewerType <String>]: The relationship type of reviewer to the target object, one of: self, delegated, entityOwners.
Required on create.
[Reviewers <IMicrosoftGraphAccessReviewReviewer- []>]: The collection of reviewers for an access review, if access review reviewerType is of type delegated.
[Id <String>]: The unique identifier for an entity.
Read-only.
[CreatedDateTime <DateTime?>]: The date when the reviewer was added for the access review.
[DisplayName <String>]: Name of reviewer.
[UserPrincipalName <String>]: User principal name of the user.
[(Any) <Object>]: This indicates any property can be added to this object.
[AccessRecommendationsEnabled <Boolean?>]: Indicates whether showing recommendations to reviewers is enabled.
[ActivityDurationInDays <Int32?>]: The number of days of user activities to show to reviewers.
[AutoApplyReviewResultsEnabled <Boolean?>]: Indicates whether the auto-apply capability, to automatically change the target object access resource, is enabled.
If not enabled, a user must, after the review completes, apply the access review.
[AutoReviewEnabled <Boolean?>]: Indicates whether a decision should be set if the reviewer didn't supply one.
For use when, auto-apply is enabled.
If you don't want to have a review decision recorded unless the reviewer makes an explicit choice, set it to false.
[(Any) <Object>]: This indicates any property can be added to this object.
[NotReviewedResult <String>]: Possible values: Approve, Deny, or Recommendation.
If Recommendation, then accessRecommendationsEnabled in the accessReviewSettings resource should also be set to true.
If you want to have the system provide a decision even if the reviewer does not make a choice, set the autoReviewEnabled property in the accessReviewSettings resource to true and include an autoReviewSettings object with the notReviewedResult property.
Then, when a review completes, based on the notReviewedResult property, the decision is recorded as either Approve or Deny.
[JustificationRequiredOnApproval <Boolean?>]: Indicates whether reviewers are required to provide a justification when reviewing access.
[MailNotificationsEnabled <Boolean?>]: Indicates whether sending mails to reviewers and the review creator is enabled.
[(Any) <Object>]: This indicates any property can be added to this object.
[DurationInDays <Int32?>]: The duration in days for recurrence.
[RecurrenceCount <Int32?>]: The count of recurrences, if the value of recurrenceEndType is occurrences, or 0 otherwise.
[RecurrenceEndType <String>]: How the recurrence ends.
Possible values: never, endBy, occurrences, or recurrenceCount.
If it's never, then there's no explicit end of the recurrence series.
If it's endBy, then the recurrence ends at a certain date.
If it's occurrences, then the series ends after recurrenceCount instances of the review have completed.
[RecurrenceType <String>]: The recurrence interval.
Possible values: onetime, weekly, monthly, quarterly, halfyearly or annual.
[RemindersEnabled <Boolean?>]: Indicates whether sending reminder emails to reviewers is enabled.
[StartDateTime <DateTime?>]: The date and time when the review is scheduled to be start.
This date can be in the future.
Required on create.
[Status <String>]: This read-only field specifies the status of an accessReview.
The typical states include Initializing, NotStarted, Starting,InProgress, Completing, Completed, AutoReviewing, and AutoReviewed.
INSTANCES <IMicrosoftGraphAccessReview- []>: The collection of access reviews instances past, present, and future, if this object is a recurring access review.
[Id <String>]: The unique identifier for an entity.
Read-only.
[BusinessFlowTemplateId <String>]: The business flow template identifier.
Required on create.
This value is case sensitive.
[Description <String>]: The description provided by the access review creator, to show to the reviewers.
[DisplayName <String>]: The access review name.
Required on create.
[EndDateTime <DateTime?>]: The DateTime when the review is scheduled to end.
This must be at least one day later than the start date.
Required on create.
[Instances <IMicrosoftGraphAccessReview- []>]: The collection of access reviews instances past, present, and future, if this object is a recurring access review.
[MyDecisions <IMicrosoftGraphAccessReviewDecision- []>]: The collection of decisions for the caller, if the caller is a reviewer.
[(Any) <Object>]: This indicates any property can be added to this object.
[DisplayName <String>]: The display name of the identity.
This property is read-only.
[Id <String>]: The identifier of the identity.
This property is read-only.
[ReviewerType <String>]: The relationship type of reviewer to the target object, one of: self, delegated, entityOwners.
Required on create.
[Reviewers <IMicrosoftGraphAccessReviewReviewer- []>]: The collection of reviewers for an access review, if access review reviewerType is of type delegated.
[Id <String>]: The unique identifier for an entity.
Read-only.
[CreatedDateTime <DateTime?>]: The date when the reviewer was added for the access review.
[DisplayName <String>]: Name of reviewer.
[UserPrincipalName <String>]: User principal name of the user.
[(Any) <Object>]: This indicates any property can be added to this object.
[AccessRecommendationsEnabled <Boolean?>]: Indicates whether showing recommendations to reviewers is enabled.
[ActivityDurationInDays <Int32?>]: The number of days of user activities to show to reviewers.
[AutoApplyReviewResultsEnabled <Boolean?>]: Indicates whether the auto-apply capability, to automatically change the target object access resource, is enabled.
If not enabled, a user must, after the review completes, apply the access review.
[AutoReviewEnabled <Boolean?>]: Indicates whether a decision should be set if the reviewer didn't supply one.
For use when, auto-apply is enabled.
If you don't want to have a review decision recorded unless the reviewer makes an explicit choice, set it to false.
[(Any) <Object>]: This indicates any property can be added to this object.
[NotReviewedResult <String>]: Possible values: Approve, Deny, or Recommendation.
If Recommendation, then accessRecommendationsEnabled in the accessReviewSettings resource should also be set to true.
If you want to have the system provide a decision even if the reviewer does not make a choice, set the autoReviewEnabled property in the accessReviewSettings resource to true and include an autoReviewSettings object with the notReviewedResult property.
Then, when a review completes, based on the notReviewedResult property, the decision is recorded as either Approve or Deny.
[JustificationRequiredOnApproval <Boolean?>]: Indicates whether reviewers are required to provide a justification when reviewing access.
[MailNotificationsEnabled <Boolean?>]: Indicates whether sending mails to reviewers and the review creator is enabled.
[(Any) <Object>]: This indicates any property can be added to this object.
[DurationInDays <Int32?>]: The duration in days for recurrence.
[RecurrenceCount <Int32?>]: The count of recurrences, if the value of recurrenceEndType is occurrences, or 0 otherwise.
[RecurrenceEndType <String>]: How the recurrence ends.
Possible values: never, endBy, occurrences, or recurrenceCount.
If it's never, then there's no explicit end of the recurrence series.
If it's endBy, then the recurrence ends at a certain date.
If it's occurrences, then the series ends after recurrenceCount instances of the review have completed.
[RecurrenceType <String>]: The recurrence interval.
Possible values: onetime, weekly, monthly, quarterly, halfyearly or annual.
[RemindersEnabled <Boolean?>]: Indicates whether sending reminder emails to reviewers is enabled.
[StartDateTime <DateTime?>]: The date and time when the review is scheduled to be start.
This date can be in the future.
Required on create.
[Status <String>]: This read-only field specifies the status of an accessReview.
The typical states include Initializing, NotStarted, Starting,InProgress, Completing, Completed, AutoReviewing, and AutoReviewed.
MYDECISIONS <IMicrosoftGraphAccessReviewDecision- []>: The collection of decisions for the caller, if the caller is a reviewer.
[Id <String>]: The unique identifier for an entity.
Read-only.
[AccessRecommendation <String>]: The feature- generated recommendation shown to the reviewer, one of: Approve, Deny, NotAvailable.
[AccessReviewId <String>]: The feature-generated ID of the access review.
[(Any) <Object>]: This indicates any property can be added to this object.
[DisplayName <String>]: The display name of the identity.
This property is read-only.
[Id <String>]: The identifier of the identity.
This property is read-only.
REVIEWERS <IMicrosoftGraphAccessReviewReviewer- []>: The collection of reviewers for an access review, if access review reviewerType is of type delegated.
[Id <String>]: The unique identifier for an entity.
Read-only.
[CreatedDateTime <DateTime?>]: The date when the reviewer was added for the access review.
[DisplayName <String>]: Name of reviewer.
[UserPrincipalName <String>]: User principal name of the user.
[(Any) <Object>]: This indicates any property can be added to this object.
[AccessRecommendationsEnabled <Boolean?>]: Indicates whether showing recommendations to reviewers is enabled.
[ActivityDurationInDays <Int32?>]: The number of days of user activities to show to reviewers.
[AutoApplyReviewResultsEnabled <Boolean?>]: Indicates whether the auto-apply capability, to automatically change the target object access resource, is enabled.
If not enabled, a user must, after the review completes, apply the access review.
[AutoReviewEnabled <Boolean?>]: Indicates whether a decision should be set if the reviewer didn't supply one.
For use when, auto-apply is enabled.
If you don't want to have a review decision recorded unless the reviewer makes an explicit choice, set it to false.
[(Any) <Object>]: This indicates any property can be added to this object.
[NotReviewedResult <String>]: Possible values: Approve, Deny, or Recommendation.
If Recommendation, then accessRecommendationsEnabled in the accessReviewSettings resource should also be set to true.
If you want to have the system provide a decision even if the reviewer does not make a choice, set the autoReviewEnabled property in the accessReviewSettings resource to true and include an autoReviewSettings object with the notReviewedResult property.
Then, when a review completes, based on the notReviewedResult property, the decision is recorded as either Approve or Deny.
[JustificationRequiredOnApproval <Boolean?>]: Indicates whether reviewers are required to provide a justification when reviewing access.
[MailNotificationsEnabled <Boolean?>]: Indicates whether sending mails to reviewers and the review creator is enabled.
[(Any) <Object>]: This indicates any property can be added to this object.
[DurationInDays <Int32?>]: The duration in days for recurrence.
[RecurrenceCount <Int32?>]: The count of recurrences, if the value of recurrenceEndType is occurrences, or 0 otherwise.
[RecurrenceEndType <String>]: How the recurrence ends.
Possible values: never, endBy, occurrences, or recurrenceCount.
If it's never, then there's no explicit end of the recurrence series.
If it's endBy, then the recurrence ends at a certain date.
If it's occurrences, then the series ends after recurrenceCount instances of the review have completed.
[RecurrenceType <String>]: The recurrence interval.
Possible values: onetime, weekly, monthly, quarterly, halfyearly or annual.
[RemindersEnabled <Boolean?>]: Indicates whether sending reminder emails to reviewers is enabled.