New-MgIdentityGovernancePrivilegedAccessGroupAssignmentScheduleRequest

Reference

Module:: Microsoft.Graph.Identity.Governance

Create a new privilegedAccessGroupAssignmentScheduleRequest object.

Note

To view the beta release of this cmdlet, view New-MgBetaIdentityGovernancePrivilegedAccessGroupAssignmentScheduleRequest

Syntax

New-MgIdentityGovernancePrivilegedAccessGroupAssignmentScheduleRequest
   [-ResponseHeadersVariable <String>]
   [-AccessId <String>]
   [-Action <String>]
   [-ActivatedUsing <IMicrosoftGraphPrivilegedAccessGroupEligibilitySchedule>]
   [-AdditionalProperties <Hashtable>]
   [-ApprovalId <String>]
   [-CompletedDateTime <DateTime>]
   [-CreatedBy <IMicrosoftGraphIdentitySet>]
   [-CreatedDateTime <DateTime>]
   [-CustomData <String>]
   [-Group <IMicrosoftGraphGroup>]
   [-GroupId <String>]
   [-Id <String>]
   [-IsValidationOnly]
   [-Justification <String>]
   [-Principal <IMicrosoftGraphDirectoryObject>]
   [-PrincipalId <String>]
   [-ScheduleInfo <IMicrosoftGraphRequestSchedule>]
   [-Status <String>]
   [-TargetSchedule <IMicrosoftGraphPrivilegedAccessGroupEligibilitySchedule>]
   [-TargetScheduleId <String>]
   [-TicketInfo <IMicrosoftGraphTicketInfo>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

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

Description

Create a new privilegedAccessGroupAssignmentScheduleRequest object.

Permissions

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	PrivilegedAssignmentSchedule.ReadWrite.AzureADGroup	PrivilegedAssignmentSchedule.Remove.AzureADGroup
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	PrivilegedAssignmentSchedule.ReadWrite.AzureADGroup	PrivilegedAssignmentSchedule.Remove.AzureADGroup

Examples

Example 1: Create an assignment schedule request

Import-Module Microsoft.Graph.Identity.Governance

$params = @{
	accessId = "member"
	principalId = "3cce9d87-3986-4f19-8335-7ed075408ca2"
	groupId = "68e55cce-cf7e-4a2d-9046-3e4e75c4bfa7"
	action = "adminAssign"
	scheduleInfo = @{
		startDateTime = [System.DateTime]::Parse("2022-12-08T07:43:00.000Z")
		expiration = @{
			type = "afterDuration"
			duration = "PT2H"
		}
	}
	justification = "Assign active member access."
}

New-MgIdentityGovernancePrivilegedAccessGroupAssignmentScheduleRequest -BodyParameter $params

This example will create an assignment schedule request

Example 2: User activates their eligible assignment for PIM for Groups

Import-Module Microsoft.Graph.Identity.Governance

$params = @{
	accessId = "member"
	principalId = "3cce9d87-3986-4f19-8335-7ed075408ca2"
	groupId = "2b5ed229-4072-478d-9504-a047ebd4b07d"
	action = "selfActivate"
	scheduleInfo = @{
		startDateTime = [System.DateTime]::Parse("2023-02-08T07:43:00.000Z")
		expiration = @{
			type = "afterDuration"
			duration = "PT2H"
		}
	}
	justification = "Activate assignment."
}

New-MgIdentityGovernancePrivilegedAccessGroupAssignmentScheduleRequest -BodyParameter $params

This example will user activates their eligible assignment for pim for groups

Parameters

-AccessId

privilegedAccessGroupRelationships

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

-Action

scheduleRequestActions

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

-ActivatedUsing

privilegedAccessGroupEligibilitySchedule To construct, see NOTES section for ACTIVATEDUSING properties and create a hash table.

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

-AdditionalProperties

Additional Parameters

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

-ApprovalId

The identifier of the approval of the request.

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

-BodyParameter

privilegedAccessGroupAssignmentScheduleRequest To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

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

-CompletedDateTime

The request completion date time.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CreatedBy

identitySet To construct, see NOTES section for CREATEDBY properties and create a hash table.

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

-CreatedDateTime

The request creation date time.

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

-CustomData

Free text field to define any custom data for the request. Not used.

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

-Group

group To construct, see NOTES section for GROUP properties and create a hash table.

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

-GroupId

The identifier of the group representing the scope of the membership or ownership assignment through PIM for groups. Required.

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

-Id

The unique identifier for an entity. Read-only.

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

-IsValidationOnly

Determines whether the call is a validation or an actual call. Only set this property if you want to check whether an activation is subject to additional rules like MFA before actually submitting the request.

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

-Justification

A message provided by users and administrators when create they create the privilegedAccessGroupAssignmentScheduleRequest object.

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

-Principal

directoryObject To construct, see NOTES section for PRINCIPAL properties and create a hash table.

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

-PrincipalId

The identifier of the principal whose membership or ownership assignment to the group is managed through PIM for groups. Supports $filter (eq, ne).

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

-ProgressAction

Type:	ActionPreference
Aliases:	proga
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

-ScheduleInfo

requestSchedule To construct, see NOTES section for SCHEDULEINFO properties and create a hash table.

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

-Status

The status of the request. Not nullable. The possible values are: Canceled, Denied, Failed, Granted, PendingAdminDecision, PendingApproval, PendingProvisioning, PendingScheduleCreation, Provisioned, Revoked, and ScheduleCreated. Not nullable.

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

-TargetSchedule

privilegedAccessGroupEligibilitySchedule To construct, see NOTES section for TARGETSCHEDULE properties and create a hash table.

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

-TargetScheduleId

The identifier of the schedule that's created from the membership or ownership assignment request. Supports $filter (eq, ne).

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

-TicketInfo

ticketInfo To construct, see NOTES section for TICKETINFO properties and create a hash table.

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

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphPrivilegedAccessGroupAssignmentScheduleRequest

System.Collections.IDictionary

Outputs