Get-MgBetaIdentityGovernanceAccessReviewDefinition
Retrieve an accessReviewScheduleDefinition object by ID. This returns all properties of the scheduled access review series except for the associated accessReviewInstances. Each accessReviewScheduleDefinition has at least one instance. An instance represents a review for a specific resource (such as a particular group's members), during one occurrence (for example, March 2021) of a recurring review. To retrieve the instances of the access review series, use the list accessReviewInstance API.
Note
To view the v1.0 release of this cmdlet, view Get-MgIdentityGovernanceAccessReviewDefinition
Syntax
Get-MgBetaIdentityGovernanceAccessReviewDefinition
[-ExpandProperty <String[]>]
[-Property <String[]>]
[-Filter <String>]
[-Search <String>]
[-Skip <Int32>]
[-Sort <String[]>]
[-Top <Int32>]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PageSize <Int32>]
[-All]
[-CountVariable <String>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Get-MgBetaIdentityGovernanceAccessReviewDefinition
-AccessReviewScheduleDefinitionId <String>
[-ExpandProperty <String[]>]
[-Property <String[]>]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Get-MgBetaIdentityGovernanceAccessReviewDefinition
-InputObject <IIdentityGovernanceIdentity>
[-ExpandProperty <String[]>]
[-Property <String[]>]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Description
Retrieve an accessReviewScheduleDefinition object by ID. This returns all properties of the scheduled access review series except for the associated accessReviewInstances. Each accessReviewScheduleDefinition has at least one instance. An instance represents a review for a specific resource (such as a particular group's members), during one occurrence (for example, March 2021) of a recurring review. To retrieve the instances of the access review series, use the list accessReviewInstance API.
Permissions
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | AccessReview.Read.All | AccessReview.ReadWrite.All |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | AccessReview.Read.All | AccessReview.ReadWrite.All |
Permissions
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | AccessReview.Read.All | AccessReview.ReadWrite.All |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | AccessReview.Read.All | AccessReview.ReadWrite.All |
Examples
Example 1: List the first one hundred access review definitions
Import-Module Microsoft.Graph.Beta.Identity.Governance
Get-MgBetaIdentityGovernanceAccessReviewDefinition -Top 100 -Skip 0This example will list the first one hundred access review definitions
Example 2: Retrieve all access review definitions scoped to all Microsoft 365 groups in a tenant
Import-Module Microsoft.Graph.Beta.Identity.Governance
Get-MgBetaIdentityGovernanceAccessReviewDefinition -Filter "contains(scope/microsoft.graph.accessReviewQueryScope/query, './members')"This example will retrieve all access review definitions scoped to all microsoft 365 groups in a tenant
Parameters
-AccessReviewScheduleDefinitionId
The unique identifier of accessReviewScheduleDefinition
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-All
List all pages.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CountVariable
Specifies a count of the total number of items in a collection. By default, this variable will be set in the global scope.
| Type: | String |
| Aliases: | CV |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExpandProperty
Expand related entities
| Type: | String[] |
| Aliases: | Expand |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Filter
Filter items by property values
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Headers
Optional headers that will be added to the request.
| Type: | IDictionary |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | IIdentityGovernanceIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PageSize
Sets the page size of results.
| Type: | Int32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProgressAction
{{ Fill ProgressAction Description }}
| Type: | ActionPreference |
| Aliases: | proga |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Property
Select properties to be returned
| Type: | String[] |
| Aliases: | Select |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
| Type: | String |
| Aliases: | RHV |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Search
Search items by search phrases
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Skip
Skip the first n items
| Type: | Int32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Sort
Order items by property values
| Type: | String[] |
| Aliases: | OrderBy |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Top
Show only the first n items
| Type: | Int32 |
| Aliases: | Limit |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.Graph.Beta.PowerShell.Models.IIdentityGovernanceIdentity
System.Collections.IDictionary
Outputs
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphAccessReviewScheduleDefinition
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.
INPUTOBJECT <IIdentityGovernanceIdentity>: Identity Parameter
[AccessPackageAssignmentId <String>]: The unique identifier of accessPackageAssignment[AccessPackageAssignmentPolicyId <String>]: The unique identifier of accessPackageAssignmentPolicy[AccessPackageAssignmentRequestId <String>]: The unique identifier of accessPackageAssignmentRequest[AccessPackageAssignmentResourceRoleId <String>]: The unique identifier of accessPackageAssignmentResourceRole[AccessPackageCatalogId <String>]: The unique identifier of accessPackageCatalog[AccessPackageId <String>]: The unique identifier of accessPackage[AccessPackageId1 <String>]: The unique identifier of accessPackage[AccessPackageResourceEnvironmentId <String>]: The unique identifier of accessPackageResourceEnvironment[AccessPackageResourceId <String>]: The unique identifier of accessPackageResource[AccessPackageResourceRequestId <String>]: The unique identifier of accessPackageResourceRequest[AccessPackageResourceRoleId <String>]: The unique identifier of accessPackageResourceRole[AccessPackageResourceRoleScopeId <String>]: The unique identifier of accessPackageResourceRoleScope[AccessPackageResourceScopeId <String>]: The unique identifier of accessPackageResourceScope[AccessPackageSubjectId <String>]: The unique identifier of accessPackageSubject[AccessReviewDecisionId <String>]: The unique identifier of accessReviewDecision[AccessReviewHistoryDefinitionId <String>]: The unique identifier of accessReviewHistoryDefinition[AccessReviewHistoryInstanceId <String>]: The unique identifier of accessReviewHistoryInstance[AccessReviewId <String>]: The unique identifier of accessReview[AccessReviewId1 <String>]: The unique identifier of accessReview[AccessReviewInstanceDecisionItemId <String>]: The unique identifier of accessReviewInstanceDecisionItem[AccessReviewInstanceDecisionItemId1 <String>]: The unique identifier of accessReviewInstanceDecisionItem[AccessReviewInstanceId <String>]: The unique identifier of accessReviewInstance[AccessReviewReviewerId <String>]: The unique identifier of accessReviewReviewer[AccessReviewScheduleDefinitionId <String>]: The unique identifier of accessReviewScheduleDefinition[AccessReviewStageId <String>]: The unique identifier of accessReviewStage[AgreementAcceptanceId <String>]: The unique identifier of agreementAcceptance[AgreementFileLocalizationId <String>]: The unique identifier of agreementFileLocalization[AgreementFileVersionId <String>]: The unique identifier of agreementFileVersion[AgreementId <String>]: The unique identifier of agreement[AppConsentRequestId <String>]: The unique identifier of appConsentRequest[ApprovalId <String>]: The unique identifier of approval[ApprovalStepId <String>]: The unique identifier of approvalStep[BusinessFlowTemplateId <String>]: The unique identifier of businessFlowTemplate[ConnectedOrganizationId <String>]: The unique identifier of connectedOrganization[CustomAccessPackageWorkflowExtensionId <String>]: The unique identifier of customAccessPackageWorkflowExtension[CustomCalloutExtensionId <String>]: The unique identifier of customCalloutExtension[CustomExtensionHandlerId <String>]: The unique identifier of customExtensionHandler[CustomExtensionStageSettingId <String>]: The unique identifier of customExtensionStageSetting[CustomTaskExtensionId <String>]: The unique identifier of customTaskExtension[DirectoryObjectId <String>]: The unique identifier of directoryObject[EndDateTime <DateTime?>]: Usage: endDateTime={endDateTime}[FindingId <String>]: The unique identifier of finding[GovernanceInsightId <String>]: The unique identifier of governanceInsight[GovernanceResourceId <String>]: The unique identifier of governanceResource[GovernanceRoleAssignmentId <String>]: The unique identifier of governanceRoleAssignment[GovernanceRoleAssignmentRequestId <String>]: The unique identifier of governanceRoleAssignmentRequest[GovernanceRoleDefinitionId <String>]: The unique identifier of governanceRoleDefinition[GovernanceRoleSettingId <String>]: The unique identifier of governanceRoleSetting[IncompatibleAccessPackageId <String>]: Usage: incompatibleAccessPackageId='{incompatibleAccessPackageId}'[LongRunningOperationId <String>]: The unique identifier of longRunningOperation[ObjectId <String>]: Alternate key of accessPackageSubject[On <String>]: Usage: on='{on}'[PermissionsCreepIndexDistributionId <String>]: The unique identifier of permissionsCreepIndexDistribution[PermissionsRequestChangeId <String>]: The unique identifier of permissionsRequestChange[PrivilegedAccessGroupAssignmentScheduleId <String>]: The unique identifier of privilegedAccessGroupAssignmentSchedule[PrivilegedAccessGroupAssignmentScheduleInstanceId <String>]: The unique identifier of privilegedAccessGroupAssignmentScheduleInstance[PrivilegedAccessGroupAssignmentScheduleRequestId <String>]: The unique identifier of privilegedAccessGroupAssignmentScheduleRequest[PrivilegedAccessGroupEligibilityScheduleId <String>]: The unique identifier of privilegedAccessGroupEligibilitySchedule[PrivilegedAccessGroupEligibilityScheduleInstanceId <String>]: The unique identifier of privilegedAccessGroupEligibilityScheduleInstance[PrivilegedAccessGroupEligibilityScheduleRequestId <String>]: The unique identifier of privilegedAccessGroupEligibilityScheduleRequest[PrivilegedAccessId <String>]: The unique identifier of privilegedAccess[PrivilegedApprovalId <String>]: The unique identifier of privilegedApproval[PrivilegedOperationEventId <String>]: The unique identifier of privilegedOperationEvent[PrivilegedRoleAssignmentId <String>]: The unique identifier of privilegedRoleAssignment[PrivilegedRoleAssignmentId1 <String>]: The unique identifier of privilegedRoleAssignment[PrivilegedRoleAssignmentRequestId <String>]: The unique identifier of privilegedRoleAssignmentRequest[PrivilegedRoleId <String>]: The unique identifier of privilegedRole[ProgramControlId <String>]: The unique identifier of programControl[ProgramControlId1 <String>]: The unique identifier of programControl[ProgramControlTypeId <String>]: The unique identifier of programControlType[ProgramId <String>]: The unique identifier of program[RbacApplicationId <String>]: The unique identifier of rbacApplication[RunId <String>]: The unique identifier of run[StartDateTime <DateTime?>]: Usage: startDateTime={startDateTime}[TaskDefinitionId <String>]: The unique identifier of taskDefinition[TaskId <String>]: The unique identifier of task[TaskProcessingResultId <String>]: The unique identifier of taskProcessingResult[TaskReportId <String>]: The unique identifier of taskReport[UnifiedRbacResourceActionId <String>]: The unique identifier of unifiedRbacResourceAction[UnifiedRbacResourceNamespaceId <String>]: The unique identifier of unifiedRbacResourceNamespace[UnifiedRoleAssignmentId <String>]: The unique identifier of unifiedRoleAssignment[UnifiedRoleAssignmentScheduleId <String>]: The unique identifier of unifiedRoleAssignmentSchedule[UnifiedRoleAssignmentScheduleInstanceId <String>]: The unique identifier of unifiedRoleAssignmentScheduleInstance[UnifiedRoleAssignmentScheduleRequestId <String>]: The unique identifier of unifiedRoleAssignmentScheduleRequest[UnifiedRoleDefinitionId <String>]: The unique identifier of unifiedRoleDefinition[UnifiedRoleDefinitionId1 <String>]: The unique identifier of unifiedRoleDefinition[UnifiedRoleEligibilityScheduleId <String>]: The unique identifier of unifiedRoleEligibilitySchedule[UnifiedRoleEligibilityScheduleInstanceId <String>]: The unique identifier of unifiedRoleEligibilityScheduleInstance[UnifiedRoleEligibilityScheduleRequestId <String>]: The unique identifier of unifiedRoleEligibilityScheduleRequest[UnifiedRoleManagementAlertConfigurationId <String>]: The unique identifier of unifiedRoleManagementAlertConfiguration[UnifiedRoleManagementAlertDefinitionId <String>]: The unique identifier of unifiedRoleManagementAlertDefinition[UnifiedRoleManagementAlertId <String>]: The unique identifier of unifiedRoleManagementAlert[UnifiedRoleManagementAlertIncidentId <String>]: The unique identifier of unifiedRoleManagementAlertIncident[UniqueName <String>]: Alternate key of accessPackageCatalog[UserConsentRequestId <String>]: The unique identifier of userConsentRequest[UserId <String>]: The unique identifier of user[UserProcessingResultId <String>]: The unique identifier of userProcessingResult[WorkflowId <String>]: The unique identifier of workflow[WorkflowTemplateId <String>]: The unique identifier of workflowTemplate[WorkflowVersionNumber <Int32?>]: The unique identifier of workflowVersion
Related Links
- https://video2.skills-academy.com/powershell/module/microsoft.graph.beta.identity.governance/get-mgbetaidentitygovernanceaccessreviewdefinition
- https://video2.skills-academy.com/graph/api/accessreviewscheduledefinition-get?view=graph-rest-beta
- https://video2.skills-academy.com/graph/api/accessreviewset-list-definitions?view=graph-rest-beta