privileged_access_group_eligibility_schedule_instances

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

Overview

Name	privileged_access_group_eligibility_schedule_instances
Type	Resource
Id	entra_id.identity_governance.privileged_access_group_eligibility_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 eligibility relationship to the group. Required. The possible values are: owner, member. Supports $filter (eq).
eligibilityScheduleId	string	The identifier of the privilegedAccessGroupEligibilitySchedule from which this instance was created. Required. Supports $filter (eq, ne).
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 eligibility through PIM for Groups. Supports $expand.
groupId	string	The identifier of the group representing the scope of the membership or ownership eligibility through PIM for Groups. Required. Supports $filter (eq).
memberType		Indicates whether the assignment is derived from a group assignment. It can further imply whether the calling principal 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 eligibility request through the group that's governed by PIM. Supports $expand.
principalId	string	The identifier of the principal whose membership or ownership eligibility 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 eligibility relationship to the group. Required. The possible values are: owner, member. Supports $filter (eq).
eligibilityScheduleId	string	The identifier of the privilegedAccessGroupEligibilitySchedule from which this instance was created. Required. Supports $filter (eq, ne).
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 eligibility through PIM for Groups. Supports $expand.
groupId	string	The identifier of the group representing the scope of the membership or ownership eligibility through PIM for Groups. Required. Supports $filter (eq).
memberType		Indicates whether the assignment is derived from a group assignment. It can further imply whether the calling principal 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 eligibility request through the group that's governed by PIM. Supports $expand.
principalId	string	The identifier of the principal whose membership or ownership eligibility 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_eligibility_schedule_instance_id		Read the properties and relationships of a privilegedAccessGroupEligibilityScheduleInstance object.
list	select			Get a list of the privilegedAccessGroupEligibilityScheduleInstance objects and their properties.
insert	insert
update	update	privileged_access_group_eligibility_schedule_instance_id
delete	delete	privileged_access_group_eligibility_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_eligibility_schedule_instance_id	string	The unique identifier of privilegedAccessGroupEligibilityScheduleInstance
If-Match	string	ETag

SELECT examples

get

Read the properties and relationships of a privilegedAccessGroupEligibilityScheduleInstance object.

SELECT
id,
accessId,
eligibilityScheduleId,
endDateTime,
group,
groupId,
memberType,
principal,
principalId,
startDateTime
FROM entra_id.identity_governance.privileged_access_group_eligibility_schedule_instances
WHERE privileged_access_group_eligibility_schedule_instance_id = '{{ privileged_access_group_eligibility_schedule_instance_id }}' -- required
;

list

Get a list of the privilegedAccessGroupEligibilityScheduleInstance objects and their properties.

SELECT
id,
accessId,
eligibilityScheduleId,
endDateTime,
group,
groupId,
memberType,
principal,
principalId,
startDateTime
FROM entra_id.identity_governance.privileged_access_group_eligibility_schedule_instances
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.identity_governance.privileged_access_group_eligibility_schedule_instances (
id,
endDateTime,
startDateTime,
accessId,
eligibilityScheduleId,
groupId,
memberType,
principalId,
group,
principal
)
SELECT 
'{{ id }}',
'{{ endDateTime }}',
'{{ startDateTime }}',
'{{ accessId }}',
'{{ eligibilityScheduleId }}',
'{{ groupId }}',
'{{ memberType }}',
'{{ principalId }}',
'{{ group }}',
'{{ principal }}'
RETURNING
id,
accessId,
eligibilityScheduleId,
endDateTime,
group,
groupId,
memberType,
principal,
principalId,
startDateTime
;

Manifest

# Description fields are for documentation purposes
- name: privileged_access_group_eligibility_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 eligibility relationship to the group. Required. The possible values are: owner, member. Supports $filter (eq).
  - name: eligibilityScheduleId
    value: "{{ eligibilityScheduleId }}"
    description: |
      The identifier of the privilegedAccessGroupEligibilitySchedule from which this instance was created. Required. Supports $filter (eq, ne).
  - name: groupId
    value: "{{ groupId }}"
    description: |
      The identifier of the group representing the scope of the membership or ownership eligibility through PIM for Groups. Required. Supports $filter (eq).
  - name: memberType
    value: "{{ memberType }}"
    description: |
      Indicates whether the assignment is derived from a group assignment. It can further imply whether the calling principal 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 eligibility to the group is managed through PIM for Groups. Required. Supports $filter (eq).
  - name: group
    value: "{{ group }}"
    description: |
      References the group that is the scope of the membership or ownership eligibility through PIM for Groups. Supports $expand.
  - name: principal
    value: "{{ principal }}"
    description: |
      References the principal that's in the scope of the membership or ownership eligibility 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_eligibility_schedule_instances
SET 
id = '{{ id }}',
endDateTime = '{{ endDateTime }}',
startDateTime = '{{ startDateTime }}',
accessId = '{{ accessId }}',
eligibilityScheduleId = '{{ eligibilityScheduleId }}',
groupId = '{{ groupId }}',
memberType = '{{ memberType }}',
principalId = '{{ principalId }}',
group = '{{ group }}',
principal = '{{ principal }}'
WHERE 
privileged_access_group_eligibility_schedule_instance_id = '{{ privileged_access_group_eligibility_schedule_instance_id }}' --required
RETURNING
id,
accessId,
eligibilityScheduleId,
endDateTime,
group,
groupId,
memberType,
principal,
principalId,
startDateTime;

DELETE examples

delete

No description available.

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