entitlement_management_role_eligibility_schedules

Creates, updates, deletes, gets or lists an entitlement_management_role_eligibility_schedules resource.

Overview

Name	entitlement_management_role_eligibility_schedules
Type	Resource
Id	entra_id.role_management.entitlement_management_role_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.
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.
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 role eligibility is inherited. It can either be Inherited, Direct, or Group. It can further imply whether the unifiedRoleEligibilitySchedule 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 eligibility.
status	string	The status of the role assignment or eligibility request.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
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.
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 role eligibility is inherited. It can either be Inherited, Direct, or Group. It can further imply whether the unifiedRoleEligibilitySchedule 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 eligibility.
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_eligibility_schedule_id		Schedules for role eligibility operations.
list	select			Schedules for role eligibility operations.
insert	insert
update	update	unified_role_eligibility_schedule_id
delete	delete	unified_role_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
unified_role_eligibility_schedule_id	string	The unique identifier of unifiedRoleEligibilitySchedule
If-Match	string	ETag

SELECT examples

get

Schedules for role eligibility operations.

SELECT
id,
appScope,
appScopeId,
createdDateTime,
createdUsing,
directoryScope,
directoryScopeId,
memberType,
modifiedDateTime,
principal,
principalId,
roleDefinition,
roleDefinitionId,
scheduleInfo,
status
FROM entra_id.role_management.entitlement_management_role_eligibility_schedules
WHERE unified_role_eligibility_schedule_id = '{{ unified_role_eligibility_schedule_id }}' -- required
;

list

Schedules for role eligibility operations.

SELECT
id,
appScope,
appScopeId,
createdDateTime,
createdUsing,
directoryScope,
directoryScopeId,
memberType,
modifiedDateTime,
principal,
principalId,
roleDefinition,
roleDefinitionId,
scheduleInfo,
status
FROM entra_id.role_management.entitlement_management_role_eligibility_schedules
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.role_management.entitlement_management_role_eligibility_schedules (
id,
appScopeId,
createdDateTime,
createdUsing,
directoryScopeId,
modifiedDateTime,
principalId,
roleDefinitionId,
status,
appScope,
directoryScope,
principal,
roleDefinition,
memberType,
scheduleInfo
)
SELECT 
'{{ id }}',
'{{ appScopeId }}',
'{{ createdDateTime }}',
'{{ createdUsing }}',
'{{ directoryScopeId }}',
'{{ modifiedDateTime }}',
'{{ principalId }}',
'{{ roleDefinitionId }}',
'{{ status }}',
'{{ appScope }}',
'{{ directoryScope }}',
'{{ principal }}',
'{{ roleDefinition }}',
'{{ memberType }}',
'{{ scheduleInfo }}'
RETURNING
id,
appScope,
appScopeId,
createdDateTime,
createdUsing,
directoryScope,
directoryScopeId,
memberType,
modifiedDateTime,
principal,
principalId,
roleDefinition,
roleDefinitionId,
scheduleInfo,
status
;

Manifest

# Description fields are for documentation purposes
- name: entitlement_management_role_eligibility_schedules
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: appScopeId
    value: "{{ appScopeId }}"
    description: |
      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.
  - name: createdDateTime
    value: "{{ createdDateTime }}"
    description: |
      When the schedule was created.
  - name: createdUsing
    value: "{{ createdUsing }}"
    description: |
      Identifier of the object through which this schedule was created.
  - name: directoryScopeId
    value: "{{ directoryScopeId }}"
    description: |
      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.
  - name: modifiedDateTime
    value: "{{ modifiedDateTime }}"
    description: |
      When the schedule was last modified.
  - name: principalId
    value: "{{ principalId }}"
    description: |
      Identifier of the principal that has been granted the role assignment or eligibility.
  - name: roleDefinitionId
    value: "{{ roleDefinitionId }}"
    description: |
      Identifier of the unifiedRoleDefinition object that is being assigned to the principal or that a principal is eligible for.
  - name: status
    value: "{{ status }}"
    description: |
      The status of the role assignment or eligibility request.
  - name: appScope
    value: "{{ appScope }}"
    description: |
      Read-only property with details of the app-specific scope when the role eligibility or assignment is scoped to an app. Nullable.
  - name: directoryScope
    value: "{{ directoryScope }}"
    description: |
      The directory object that is the scope of the role eligibility or assignment. Read-only.
  - name: principal
    value: "{{ principal }}"
    description: |
      The principal that's getting a role assignment or that's eligible for a role through the request.
  - name: roleDefinition
    value: "{{ roleDefinition }}"
    description: |
      Detailed information for the roleDefinition object that is referenced through the roleDefinitionId property.
  - name: memberType
    value: "{{ memberType }}"
    description: |
      How the role eligibility is inherited. It can either be Inherited, Direct, or Group. It can further imply whether the unifiedRoleEligibilitySchedule can be managed by the caller. Supports $filter (eq, ne).
  - name: scheduleInfo
    value: "{{ scheduleInfo }}"
    description: |
      The period of the role eligibility.

UPDATE examples

update

No description available.

UPDATE entra_id.role_management.entitlement_management_role_eligibility_schedules
SET 
id = '{{ id }}',
appScopeId = '{{ appScopeId }}',
createdDateTime = '{{ createdDateTime }}',
createdUsing = '{{ createdUsing }}',
directoryScopeId = '{{ directoryScopeId }}',
modifiedDateTime = '{{ modifiedDateTime }}',
principalId = '{{ principalId }}',
roleDefinitionId = '{{ roleDefinitionId }}',
status = '{{ status }}',
appScope = '{{ appScope }}',
directoryScope = '{{ directoryScope }}',
principal = '{{ principal }}',
roleDefinition = '{{ roleDefinition }}',
memberType = '{{ memberType }}',
scheduleInfo = '{{ scheduleInfo }}'
WHERE 
unified_role_eligibility_schedule_id = '{{ unified_role_eligibility_schedule_id }}' --required
RETURNING
id,
appScope,
appScopeId,
createdDateTime,
createdUsing,
directoryScope,
directoryScopeId,
memberType,
modifiedDateTime,
principal,
principalId,
roleDefinition,
roleDefinitionId,
scheduleInfo,
status;

DELETE examples

delete

No description available.

DELETE FROM entra_id.role_management.entitlement_management_role_eligibility_schedules
WHERE unified_role_eligibility_schedule_id = '{{ unified_role_eligibility_schedule_id }}' --required
AND If-Match = '{{ If-Match }}'
;