entitlement_management_role_assignment_schedule_requests_target_schedule
Creates, updates, deletes, gets or lists an entitlement_management_role_assignment_schedule_requests_target_schedule resource.
Overview
| Name | entitlement_management_role_assignment_schedule_requests_target_schedule |
| Type | Resource |
| Id | entra_id.role_management.entitlement_management_role_assignment_schedule_requests_target_schedule |
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. |
activatedUsing | | If the request is from an eligible administrator to activate a role, this parameter shows the related eligible assignment for that activation. Otherwise, it's null. Supports $expand. |
appScope | | Read-only property with details of the app-specific scope when the role eligibility or assignment is scoped to an app. Nullable. |
appScopeId | string | Identifier of the app-specific scope when the assignment or eligibility is scoped to an app. The scope of an assignment or eligibility determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by this application only. Use / for tenant-wide app scopes. Use directoryScopeId to limit the scope to particular directory objects, for example, administrative units. |
assignmentType | string | The type of the assignment that can either be Assigned or Activated. Supports $filter (eq, ne). |
createdDateTime | string (date-time) | When the schedule was created. (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 | Identifier of the object through which this schedule was created. |
directoryScope | | The directory object that is the scope of the role eligibility or assignment. Read-only. |
directoryScopeId | string | Identifier of the directory object representing the scope of the assignment or eligibility. The scope of an assignment or eligibility determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications. Use / for tenant-wide scope. Use appScopeId to limit the scope to an application only. |
memberType | string | How the assignment is inherited. It can either be Inherited, Direct, or Group. It can further imply whether the unifiedRoleAssignmentSchedule can be managed by the caller. Supports $filter (eq, ne). |
modifiedDateTime | string (date-time) | When the schedule was last modified. (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 | | The principal that's getting a role assignment or that's eligible for a role through the request. |
principalId | string | Identifier of the principal that has been granted the role assignment or eligibility. |
roleDefinition | | Detailed information for the roleDefinition object that is referenced through the roleDefinitionId property. |
roleDefinitionId | string | Identifier of the unifiedRoleDefinition object that is being assigned to the principal or that a principal is eligible for. |
scheduleInfo | | The period of the role assignment. It can represent a single occurrence or multiple recurrences. |
status | string | The status of the role assignment or eligibility request. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | unified_role_assignment_schedule_request_id | The schedule for an eligible role assignment that is referenced through the targetScheduleId property. Supports $expand and $select nested in $expand. |
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 |
|---|---|---|
unified_role_assignment_schedule_request_id | string | The unique identifier of unifiedRoleAssignmentScheduleRequest |
SELECT examples
- get
The schedule for an eligible role assignment that is referenced through the targetScheduleId property. Supports $expand and $select nested in $expand.
SELECT
id,
activatedUsing,
appScope,
appScopeId,
assignmentType,
createdDateTime,
createdUsing,
directoryScope,
directoryScopeId,
memberType,
modifiedDateTime,
principal,
principalId,
roleDefinition,
roleDefinitionId,
scheduleInfo,
status
FROM entra_id.role_management.entitlement_management_role_assignment_schedule_requests_target_schedule
WHERE unified_role_assignment_schedule_request_id = '{{ unified_role_assignment_schedule_request_id }}' -- required
;