privileged_access_group_eligibility_schedules

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

Overview

Name	privileged_access_group_eligibility_schedules
Type	Resource
Id	entra_id.identity_governance.privileged_access_group_eligibility_schedules

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 to the group that is governed by PIM. Required. The possible values are: owner, member. Supports $filter (eq).
createdDateTime	string (date-time)	When the schedule was created. Optional. (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])$)
createdUsing	string	The identifier of the access assignment or eligibility request that created this schedule. Optional.
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 caller can manage the schedule. Required. The possible values are: direct, group, unknownFutureValue. Supports $filter (eq).
modifiedDateTime	string (date-time)	When the schedule was last modified. Optional. (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])$)
principal		References the principal that's in the scope of this membership or ownership eligibility request to the group that's governed by PIM. Supports $expand.
principalId	string	The identifier of the principal whose membership or ownership eligibility is granted through PIM for Groups. Required. Supports $filter (eq).
scheduleInfo		Represents the period of the access assignment or eligibility. The scheduleInfo can represent a single occurrence or multiple recurring instances. Required.
status	string	The status of the access assignment or eligibility request. The possible values are: Canceled, Denied, Failed, Granted, PendingAdminDecision, PendingApproval, PendingProvisioning, PendingScheduleCreation, Provisioned, Revoked, and ScheduleCreated. Not nullable. Optional.

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 to the group that is governed by PIM. Required. The possible values are: owner, member. Supports $filter (eq).
createdDateTime	string (date-time)	When the schedule was created. Optional. (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])$)
createdUsing	string	The identifier of the access assignment or eligibility request that created this schedule. Optional.
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 caller can manage the schedule. Required. The possible values are: direct, group, unknownFutureValue. Supports $filter (eq).
modifiedDateTime	string (date-time)	When the schedule was last modified. Optional. (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])$)
principal		References the principal that's in the scope of this membership or ownership eligibility request to the group that's governed by PIM. Supports $expand.
principalId	string	The identifier of the principal whose membership or ownership eligibility is granted through PIM for Groups. Required. Supports $filter (eq).
scheduleInfo		Represents the period of the access assignment or eligibility. The scheduleInfo can represent a single occurrence or multiple recurring instances. Required.
status	string	The status of the access assignment or eligibility request. The possible values are: Canceled, Denied, Failed, Granted, PendingAdminDecision, PendingApproval, PendingProvisioning, PendingScheduleCreation, Provisioned, Revoked, and ScheduleCreated. Not nullable. Optional.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	privileged_access_group_eligibility_schedule_id		Read the properties and relationships of a privilegedAccessGroupEligibilitySchedule object.
list	select			Get a list of the privilegedAccessGroupEligibilitySchedule objects and their properties.
insert	insert
update	update	privileged_access_group_eligibility_schedule_id
delete	delete	privileged_access_group_eligibility_schedule_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_id	string	The unique identifier of privilegedAccessGroupEligibilitySchedule
If-Match	string	ETag

SELECT examples

get

Read the properties and relationships of a privilegedAccessGroupEligibilitySchedule object.

SELECT
id,
accessId,
createdDateTime,
createdUsing,
group,
groupId,
memberType,
modifiedDateTime,
principal,
principalId,
scheduleInfo,
status
FROM entra_id.identity_governance.privileged_access_group_eligibility_schedules
WHERE privileged_access_group_eligibility_schedule_id = '{{ privileged_access_group_eligibility_schedule_id }}' -- required
;

list

Get a list of the privilegedAccessGroupEligibilitySchedule objects and their properties.

SELECT
id,
accessId,
createdDateTime,
createdUsing,
group,
groupId,
memberType,
modifiedDateTime,
principal,
principalId,
scheduleInfo,
status
FROM entra_id.identity_governance.privileged_access_group_eligibility_schedules
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.identity_governance.privileged_access_group_eligibility_schedules (
id,
createdDateTime,
createdUsing,
modifiedDateTime,
scheduleInfo,
status,
accessId,
groupId,
memberType,
principalId,
group,
principal
)
SELECT 
'{{ id }}',
'{{ createdDateTime }}',
'{{ createdUsing }}',
'{{ modifiedDateTime }}',
'{{ scheduleInfo }}',
'{{ status }}',
'{{ accessId }}',
'{{ groupId }}',
'{{ memberType }}',
'{{ principalId }}',
'{{ group }}',
'{{ principal }}'
RETURNING
id,
accessId,
createdDateTime,
createdUsing,
group,
groupId,
memberType,
modifiedDateTime,
principal,
principalId,
scheduleInfo,
status
;

Manifest

# Description fields are for documentation purposes
- name: privileged_access_group_eligibility_schedules
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: createdDateTime
    value: "{{ createdDateTime }}"
    description: |
      When the schedule was created. Optional.
  - name: createdUsing
    value: "{{ createdUsing }}"
    description: |
      The identifier of the access assignment or eligibility request that created this schedule. Optional.
  - name: modifiedDateTime
    value: "{{ modifiedDateTime }}"
    description: |
      When the schedule was last modified. Optional.
  - name: scheduleInfo
    value: "{{ scheduleInfo }}"
    description: |
      Represents the period of the access assignment or eligibility. The scheduleInfo can represent a single occurrence or multiple recurring instances. Required.
  - name: status
    value: "{{ status }}"
    description: |
      The status of the access assignment or eligibility request. The possible values are: Canceled, Denied, Failed, Granted, PendingAdminDecision, PendingApproval, PendingProvisioning, PendingScheduleCreation, Provisioned, Revoked, and ScheduleCreated. Not nullable. Optional.
  - name: accessId
    value: "{{ accessId }}"
    description: |
      The identifier of the membership or ownership eligibility to the group that is governed by PIM. Required. The possible values are: owner, member. Supports $filter (eq).
  - 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 caller can manage the 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 is granted 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 this membership or ownership eligibility request to the group that's governed by PIM. Supports $expand.

UPDATE examples

update

No description available.

UPDATE entra_id.identity_governance.privileged_access_group_eligibility_schedules
SET 
id = '{{ id }}',
createdDateTime = '{{ createdDateTime }}',
createdUsing = '{{ createdUsing }}',
modifiedDateTime = '{{ modifiedDateTime }}',
scheduleInfo = '{{ scheduleInfo }}',
status = '{{ status }}',
accessId = '{{ accessId }}',
groupId = '{{ groupId }}',
memberType = '{{ memberType }}',
principalId = '{{ principalId }}',
group = '{{ group }}',
principal = '{{ principal }}'
WHERE 
privileged_access_group_eligibility_schedule_id = '{{ privileged_access_group_eligibility_schedule_id }}' --required
RETURNING
id,
accessId,
createdDateTime,
createdUsing,
group,
groupId,
memberType,
modifiedDateTime,
principal,
principalId,
scheduleInfo,
status;

DELETE examples

delete

No description available.

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