directory_role_assignment_schedule_instances

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

Overview

Name	`directory_role_assignment_schedule_instances`
Type	Resource
Id	`entra_id.role_management.directory_role_assignment_schedule_instances`

Fields

The following fields are returned by SELECT queries:

get
list

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 and $select nested in $expand.
`appScope`		Read-only property with details of the app-specific scope when the assignment or role eligibility is scoped to an app. Nullable.
`appScopeId`	`string`	Identifier of the app-specific scope when the assignment or role eligibility is scoped to an app. The scope of an assignment or role 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).
`directoryScope`		The directory object that is the scope of the assignment or role eligibility. Read-only.
`directoryScopeId`	`string`	Identifier of the directory object representing the scope of the assignment or role eligibility. The scope of an assignment or role 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.
`endDateTime`	`string (date-time)`	The end date of the schedule instance. (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])$`)
`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).
`principal`		The principal that's getting a role assignment or role eligibility through the request.
`principalId`	`string`	Identifier of the principal that has been granted the role assignment or that's eligible for a role.
`roleAssignmentOriginId`	`string`	The identifier of the role assignment in Microsoft Entra. Supports $filter (eq, ne).
`roleAssignmentScheduleId`	`string`	The identifier of the unifiedRoleAssignmentSchedule object from which this instance was created. Supports $filter (eq, ne).
`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 the principal is eligible for.
`startDateTime`	`string (date-time)`	When this instance starts. (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])$`)

Retrieved collection

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 and $select nested in $expand.
`appScope`		Read-only property with details of the app-specific scope when the assignment or role eligibility is scoped to an app. Nullable.
`appScopeId`	`string`	Identifier of the app-specific scope when the assignment or role eligibility is scoped to an app. The scope of an assignment or role 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).
`directoryScope`		The directory object that is the scope of the assignment or role eligibility. Read-only.
`directoryScopeId`	`string`	Identifier of the directory object representing the scope of the assignment or role eligibility. The scope of an assignment or role 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.
`endDateTime`	`string (date-time)`	The end date of the schedule instance. (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])$`)
`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).
`principal`		The principal that's getting a role assignment or role eligibility through the request.
`principalId`	`string`	Identifier of the principal that has been granted the role assignment or that's eligible for a role.
`roleAssignmentOriginId`	`string`	The identifier of the role assignment in Microsoft Entra. Supports $filter (eq, ne).
`roleAssignmentScheduleId`	`string`	The identifier of the unifiedRoleAssignmentSchedule object from which this instance was created. Supports $filter (eq, ne).
`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 the principal is eligible for.
`startDateTime`	`string (date-time)`	When this instance starts. (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`	`unified_role_assignment_schedule_instance_id`		Get the instance of an active role assignment.
`list`	`select`			Get the instances of active role assignments in your tenant. The active assignments include those made through assignments and activation requests, and directly through the role assignments API.
`insert`	`insert`
`update`	`update`	`unified_role_assignment_schedule_instance_id`
`delete`	`delete`	`unified_role_assignment_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
`unified_role_assignment_schedule_instance_id`	`string`	The unique identifier of unifiedRoleAssignmentScheduleInstance
`If-Match`	`string`	ETag

`SELECT` examples

get
list

Get the instance of an active role assignment.

SELECT
id,
activatedUsing,
appScope,
appScopeId,
assignmentType,
directoryScope,
directoryScopeId,
endDateTime,
memberType,
principal,
principalId,
roleAssignmentOriginId,
roleAssignmentScheduleId,
roleDefinition,
roleDefinitionId,
startDateTime
FROM entra_id.role_management.directory_role_assignment_schedule_instances
WHERE unified_role_assignment_schedule_instance_id = '{{ unified_role_assignment_schedule_instance_id }}' -- required
;

Get the instances of active role assignments in your tenant. The active assignments include those made through assignments and activation requests, and directly through the role assignments API.

SELECT
id,
activatedUsing,
appScope,
appScopeId,
assignmentType,
directoryScope,
directoryScopeId,
endDateTime,
memberType,
principal,
principalId,
roleAssignmentOriginId,
roleAssignmentScheduleId,
roleDefinition,
roleDefinitionId,
startDateTime
FROM entra_id.role_management.directory_role_assignment_schedule_instances
;

`INSERT` examples

insert
Manifest

No description available.

INSERT INTO entra_id.role_management.directory_role_assignment_schedule_instances (
id,
appScopeId,
directoryScopeId,
principalId,
roleDefinitionId,
appScope,
directoryScope,
principal,
roleDefinition,
assignmentType,
endDateTime,
memberType,
roleAssignmentOriginId,
roleAssignmentScheduleId,
startDateTime,
activatedUsing
)
SELECT 
'{{ id }}',
'{{ appScopeId }}',
'{{ directoryScopeId }}',
'{{ principalId }}',
'{{ roleDefinitionId }}',
'{{ appScope }}',
'{{ directoryScope }}',
'{{ principal }}',
'{{ roleDefinition }}',
'{{ assignmentType }}',
'{{ endDateTime }}',
'{{ memberType }}',
'{{ roleAssignmentOriginId }}',
'{{ roleAssignmentScheduleId }}',
'{{ startDateTime }}',
'{{ activatedUsing }}'
RETURNING
id,
activatedUsing,
appScope,
appScopeId,
assignmentType,
directoryScope,
directoryScopeId,
endDateTime,
memberType,
principal,
principalId,
roleAssignmentOriginId,
roleAssignmentScheduleId,
roleDefinition,
roleDefinitionId,
startDateTime
;

# Description fields are for documentation purposes
- name: directory_role_assignment_schedule_instances
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 role eligibility is scoped to an app. The scope of an assignment or role 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: directoryScopeId
    value: "{{ directoryScopeId }}"
    description: |
      Identifier of the directory object representing the scope of the assignment or role eligibility. The scope of an assignment or role 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: principalId
    value: "{{ principalId }}"
    description: |
      Identifier of the principal that has been granted the role assignment or that's eligible for a role.
  - name: roleDefinitionId
    value: "{{ roleDefinitionId }}"
    description: |
      Identifier of the unifiedRoleDefinition object that is being assigned to the principal or that the principal is eligible for.
  - name: appScope
    value: "{{ appScope }}"
    description: |
      Read-only property with details of the app-specific scope when the assignment or role eligibility is scoped to an app. Nullable.
  - name: directoryScope
    value: "{{ directoryScope }}"
    description: |
      The directory object that is the scope of the assignment or role eligibility. Read-only.
  - name: principal
    value: "{{ principal }}"
    description: |
      The principal that's getting a role assignment or role eligibility through the request.
  - name: roleDefinition
    value: "{{ roleDefinition }}"
    description: |
      Detailed information for the roleDefinition object that is referenced through the roleDefinitionId property.
  - name: assignmentType
    value: "{{ assignmentType }}"
    description: |
      The type of the assignment that can either be Assigned or Activated. Supports $filter (eq, ne).
  - name: endDateTime
    value: "{{ endDateTime }}"
    description: |
      The end date of the schedule instance.
  - name: memberType
    value: "{{ memberType }}"
    description: |
      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).
  - name: roleAssignmentOriginId
    value: "{{ roleAssignmentOriginId }}"
    description: |
      The identifier of the role assignment in Microsoft Entra. Supports $filter (eq, ne).
  - name: roleAssignmentScheduleId
    value: "{{ roleAssignmentScheduleId }}"
    description: |
      The identifier of the unifiedRoleAssignmentSchedule object from which this instance was created. Supports $filter (eq, ne).
  - name: startDateTime
    value: "{{ startDateTime }}"
    description: |
      When this instance starts.
  - name: activatedUsing
    value: "{{ activatedUsing }}"
    description: |
      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 and $select nested in $expand.

`UPDATE` examples

update

No description available.

UPDATE entra_id.role_management.directory_role_assignment_schedule_instances
SET 
id = '{{ id }}',
appScopeId = '{{ appScopeId }}',
directoryScopeId = '{{ directoryScopeId }}',
principalId = '{{ principalId }}',
roleDefinitionId = '{{ roleDefinitionId }}',
appScope = '{{ appScope }}',
directoryScope = '{{ directoryScope }}',
principal = '{{ principal }}',
roleDefinition = '{{ roleDefinition }}',
assignmentType = '{{ assignmentType }}',
endDateTime = '{{ endDateTime }}',
memberType = '{{ memberType }}',
roleAssignmentOriginId = '{{ roleAssignmentOriginId }}',
roleAssignmentScheduleId = '{{ roleAssignmentScheduleId }}',
startDateTime = '{{ startDateTime }}',
activatedUsing = '{{ activatedUsing }}'
WHERE 
unified_role_assignment_schedule_instance_id = '{{ unified_role_assignment_schedule_instance_id }}' --required
RETURNING
id,
activatedUsing,
appScope,
appScopeId,
assignmentType,
directoryScope,
directoryScopeId,
endDateTime,
memberType,
principal,
principalId,
roleAssignmentOriginId,
roleAssignmentScheduleId,
roleDefinition,
roleDefinitionId,
startDateTime;

`DELETE` examples

delete

No description available.

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

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Overview

Fields

Methods

Parameters

`SELECT` examples

`INSERT` examples

`UPDATE` examples

`DELETE` examples