privileged_access_group_assignment_schedule_instances_activated_using
Creates, updates, deletes, gets or lists a privileged_access_group_assignment_schedule_instances_activated_using resource.
Overview
| Name | privileged_access_group_assignment_schedule_instances_activated_using |
| Type | Resource |
| Id | entra_id.identity_governance.privileged_access_group_assignment_schedule_instances_activated_using |
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])$) |
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 | 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. |
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 |
SELECT examples
- get
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.
SELECT
id,
accessId,
eligibilityScheduleId,
endDateTime,
group,
groupId,
memberType,
principal,
principalId,
startDateTime
FROM entra_id.identity_governance.privileged_access_group_assignment_schedule_instances_activated_using
WHERE privileged_access_group_assignment_schedule_instance_id = '{{ privileged_access_group_assignment_schedule_instance_id }}' -- required
;