privileged_access_group_assignment_schedule_instances

Creates, updates, deletes, gets or lists a privileged_access_group_assignment_schedule_instances resource.

Overview

Name	privileged_access_group_assignment_schedule_instances
Type	Resource
Id	entra_id.identity_governance.privileged_access_group_assignment_schedule_instances

Fields

The following fields are returned by SELECT queries:

get

Retrieved navigation property

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
accessId		The identifier of the membership or ownership assignment relationship to the group. Required. The possible values are: owner, member, unknownFutureValue. Supports $filter (eq).
activatedUsing		When the request activates a membership or ownership in PIM for Groups, this object represents the eligibility request for the group. Otherwise, it is null.
assignmentScheduleId	string	The identifier of the privilegedAccessGroupAssignmentSchedule from which this instance was created. Required. Supports $filter (eq, ne).
assignmentType		Indicates whether the membership or ownership assignment is granted through activation of an eligibility or through direct assignment. Required. The possible values are: assigned, activated, unknownFutureValue. Supports $filter (eq).
endDateTime	string (date-time)	When the schedule instance ends. Required. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
group		References the group that is the scope of the membership or ownership assignment through PIM for Groups. Supports $expand.
groupId	string	The identifier of the group representing the scope of the membership or ownership assignment through PIM for Groups. Optional. Supports $filter (eq).
memberType		Indicates whether the assignment is derived from a group assignment. It can further imply whether the caller can manage the assignment schedule. Required. The possible values are: direct, group, unknownFutureValue. Supports $filter (eq).
principal		References the principal that's in the scope of the membership or ownership assignment request through the group that's governed by PIM. Supports $expand.
principalId	string	The identifier of the principal whose membership or ownership assignment to the group is managed through PIM for Groups. Required. Supports $filter (eq).
startDateTime	string (date-time)	When this instance starts. Required. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
accessId		The identifier of the membership or ownership assignment relationship to the group. Required. The possible values are: owner, member, unknownFutureValue. Supports $filter (eq).
activatedUsing		When the request activates a membership or ownership in PIM for Groups, this object represents the eligibility request for the group. Otherwise, it is null.
assignmentScheduleId	string	The identifier of the privilegedAccessGroupAssignmentSchedule from which this instance was created. Required. Supports $filter (eq, ne).
assignmentType		Indicates whether the membership or ownership assignment is granted through activation of an eligibility or through direct assignment. Required. The possible values are: assigned, activated, unknownFutureValue. Supports $filter (eq).
endDateTime	string (date-time)	When the schedule instance ends. Required. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
group		References the group that is the scope of the membership or ownership assignment through PIM for Groups. Supports $expand.
groupId	string	The identifier of the group representing the scope of the membership or ownership assignment through PIM for Groups. Optional. Supports $filter (eq).
memberType		Indicates whether the assignment is derived from a group assignment. It can further imply whether the caller can manage the assignment schedule. Required. The possible values are: direct, group, unknownFutureValue. Supports $filter (eq).
principal		References the principal that's in the scope of the membership or ownership assignment request through the group that's governed by PIM. Supports $expand.
principalId	string	The identifier of the principal whose membership or ownership assignment to the group is managed through PIM for Groups. Required. Supports $filter (eq).
startDateTime	string (date-time)	When this instance starts. Required. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	privileged_access_group_assignment_schedule_instance_id		Read the properties and relationships of a privilegedAccessGroupAssignmentScheduleInstance object.
list	select			Get a list of the privilegedAccessGroupAssignmentScheduleInstance objects and their properties.
insert	insert
update	update	privileged_access_group_assignment_schedule_instance_id
delete	delete	privileged_access_group_assignment_schedule_instance_id	If-Match

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
privileged_access_group_assignment_schedule_instance_id	string	The unique identifier of privilegedAccessGroupAssignmentScheduleInstance
If-Match	string	ETag

SELECT examples

get

Read the properties and relationships of a privilegedAccessGroupAssignmentScheduleInstance object.

SELECT
id,
accessId,
activatedUsing,
assignmentScheduleId,
assignmentType,
endDateTime,
group,
groupId,
memberType,
principal,
principalId,
startDateTime
FROM entra_id.identity_governance.privileged_access_group_assignment_schedule_instances
WHERE privileged_access_group_assignment_schedule_instance_id = '{{ privileged_access_group_assignment_schedule_instance_id }}' -- required
;

list

Get a list of the privilegedAccessGroupAssignmentScheduleInstance objects and their properties.

SELECT
id,
accessId,
activatedUsing,
assignmentScheduleId,
assignmentType,
endDateTime,
group,
groupId,
memberType,
principal,
principalId,
startDateTime
FROM entra_id.identity_governance.privileged_access_group_assignment_schedule_instances
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.identity_governance.privileged_access_group_assignment_schedule_instances (
id,
endDateTime,
startDateTime,
accessId,
assignmentScheduleId,
assignmentType,
groupId,
memberType,
principalId,
activatedUsing,
group,
principal
)
SELECT 
'{{ id }}',
'{{ endDateTime }}',
'{{ startDateTime }}',
'{{ accessId }}',
'{{ assignmentScheduleId }}',
'{{ assignmentType }}',
'{{ groupId }}',
'{{ memberType }}',
'{{ principalId }}',
'{{ activatedUsing }}',
'{{ group }}',
'{{ principal }}'
RETURNING
id,
accessId,
activatedUsing,
assignmentScheduleId,
assignmentType,
endDateTime,
group,
groupId,
memberType,
principal,
principalId,
startDateTime
;

Manifest

# Description fields are for documentation purposes
- name: privileged_access_group_assignment_schedule_instances
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: endDateTime
    value: "{{ endDateTime }}"
    description: |
      When the schedule instance ends. Required.
  - name: startDateTime
    value: "{{ startDateTime }}"
    description: |
      When this instance starts. Required.
  - name: accessId
    value: "{{ accessId }}"
    description: |
      The identifier of the membership or ownership assignment relationship to the group. Required. The possible values are: owner, member,  unknownFutureValue. Supports $filter (eq).
  - name: assignmentScheduleId
    value: "{{ assignmentScheduleId }}"
    description: |
      The identifier of the privilegedAccessGroupAssignmentSchedule from which this instance was created. Required. Supports $filter (eq, ne).
  - name: assignmentType
    value: "{{ assignmentType }}"
    description: |
      Indicates whether the membership or ownership assignment is granted through activation of an eligibility or through direct assignment. Required. The possible values are: assigned, activated, unknownFutureValue. Supports $filter (eq).
  - name: groupId
    value: "{{ groupId }}"
    description: |
      The identifier of the group representing the scope of the membership or ownership assignment through PIM for Groups. Optional. Supports $filter (eq).
  - name: memberType
    value: "{{ memberType }}"
    description: |
      Indicates whether the assignment is derived from a group assignment. It can further imply whether the caller can manage the assignment schedule. Required. The possible values are: direct, group, unknownFutureValue. Supports $filter (eq).
  - name: principalId
    value: "{{ principalId }}"
    description: |
      The identifier of the principal whose membership or ownership assignment to the group is managed through PIM for Groups. Required. Supports $filter (eq).
  - name: activatedUsing
    value: "{{ activatedUsing }}"
    description: |
      When the request activates a membership or ownership in PIM for Groups, this object represents the eligibility request for the group. Otherwise, it is null.
  - name: group
    value: "{{ group }}"
    description: |
      References the group that is the scope of the membership or ownership assignment through PIM for Groups. Supports $expand.
  - name: principal
    value: "{{ principal }}"
    description: |
      References the principal that's in the scope of the membership or ownership assignment request through the group that's governed by PIM. Supports $expand.

UPDATE examples

update

No description available.

UPDATE entra_id.identity_governance.privileged_access_group_assignment_schedule_instances
SET 
id = '{{ id }}',
endDateTime = '{{ endDateTime }}',
startDateTime = '{{ startDateTime }}',
accessId = '{{ accessId }}',
assignmentScheduleId = '{{ assignmentScheduleId }}',
assignmentType = '{{ assignmentType }}',
groupId = '{{ groupId }}',
memberType = '{{ memberType }}',
principalId = '{{ principalId }}',
activatedUsing = '{{ activatedUsing }}',
group = '{{ group }}',
principal = '{{ principal }}'
WHERE 
privileged_access_group_assignment_schedule_instance_id = '{{ privileged_access_group_assignment_schedule_instance_id }}' --required
RETURNING
id,
accessId,
activatedUsing,
assignmentScheduleId,
assignmentType,
endDateTime,
group,
groupId,
memberType,
principal,
principalId,
startDateTime;

DELETE examples

delete

No description available.

DELETE FROM entra_id.identity_governance.privileged_access_group_assignment_schedule_instances
WHERE privileged_access_group_assignment_schedule_instance_id = '{{ privileged_access_group_assignment_schedule_instance_id }}' --required
AND If-Match = '{{ If-Match }}'
;