Stop-MgBetaIdentityGovernanceAccessReviewDefinitionInstance
Stop a currently active accessReviewInstance. After the access review instance stops, the instance status will be Completed, the reviewers can no longer give input, and the access review decisions can be applied. Stopping an instance will not effect future instances. To prevent a recurring access review from starting future instances, update the schedule definition to change its scheduled end date.
Note
To view the v1.0 release of this cmdlet, view Stop-MgIdentityGovernanceAccessReviewDefinitionInstance
Syntax
Stop (Default)
Stop-MgBetaIdentityGovernanceAccessReviewDefinitionInstance
-AccessReviewInstanceId <String>
-AccessReviewScheduleDefinitionId <String>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
StopViaIdentity
Stop-MgBetaIdentityGovernanceAccessReviewDefinitionInstance
-InputObject <IIdentityGovernanceIdentity>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Stop a currently active accessReviewInstance. After the access review instance stops, the instance status will be Completed, the reviewers can no longer give input, and the access review decisions can be applied. Stopping an instance will not effect future instances. To prevent a recurring access review from starting future instances, update the schedule definition to change its scheduled end date.
Permissions
| Permission type | Permissions (from least to most privileged) |
|---|---|
| Delegated (work or school account) | AccessReview.ReadWrite.All, |
| Delegated (personal Microsoft account) | Not supported |
| Application | AccessReview.ReadWrite.All, |
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Beta.Identity.Governance
Stop-MgBetaIdentityGovernanceAccessReviewDefinitionInstance -AccessReviewScheduleDefinitionId $accessReviewScheduleDefinitionId -AccessReviewInstanceId $accessReviewInstanceId
This example shows how to use the Stop-MgBetaIdentityGovernanceAccessReviewDefinitionInstance Cmdlet.
Parameters
-AccessReviewInstanceId
The unique identifier of accessReviewInstance
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Stop
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-AccessReviewScheduleDefinitionId
The unique identifier of accessReviewScheduleDefinition
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Stop
| Position: | Named |
| Mandatory: | True |
| 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 |
-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 |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Parameter properties
| Type: | IIdentityGovernanceIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
StopViaIdentity
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PassThru
Returns true when the command succeeds
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| 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 |
-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.IIdentityGovernanceIdentity
System.Collections.IDictionary
Outputs
System.Boolean
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