role_eligibility_schedule_instances

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

Overview

Name	role_eligibility_schedule_instances
Type	Resource
Id	azure.authorization.role_eligibility_schedule_instances

Fields

The following fields are returned by SELECT queries:

get

OK - Returns information about the role eligibility schedule instance.

Name	Datatype	Description
id	string	The role eligibility schedule instance ID.
name	string	The role eligibility schedule instance name.
properties	object	Role eligibility schedule instance properties.
type	string	The role eligibility schedule instance type.

list_for_scope

OK - Returns array of role eligibility schedule instances.

Name	Datatype	Description
id	string	The role eligibility schedule instance ID.
name	string	The role eligibility schedule instance name.
properties	object	Role eligibility schedule instance properties.
type	string	The role eligibility schedule instance type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	scope, roleEligibilityScheduleInstanceName		Gets the specified role eligibility schedule instance.
list_for_scope	select	scope	$filter	Gets role eligibility schedule instances of a role eligibility schedule.

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
roleEligibilityScheduleInstanceName	string	The name (hash of schedule name + time) of the role eligibility schedule to get.
scope	string	The scope of the role eligibility schedule.
$filter	string	The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. Use $filter=assignedTo('{userId}') to return all role eligibility schedules for the user. Use $filter=asTarget() to return all role eligibility schedules created for the current user.

SELECT examples

get

Gets the specified role eligibility schedule instance.

SELECT
id,
name,
properties,
type
FROM azure.authorization.role_eligibility_schedule_instances
WHERE scope = '{{ scope }}' -- required
AND roleEligibilityScheduleInstanceName = '{{ roleEligibilityScheduleInstanceName }}' -- required
;

list_for_scope

Gets role eligibility schedule instances of a role eligibility schedule.

SELECT
id,
name,
properties,
type
FROM azure.authorization.role_eligibility_schedule_instances
WHERE scope = '{{ scope }}' -- required
AND $filter = '{{ $filter }}'
;