role_eligibility_schedules

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

Overview

Name	role_eligibility_schedules
Type	Resource
Id	azure.authorization.role_eligibility_schedules

Fields

The following fields are returned by SELECT queries:

get

OK - Returns information about the role eligibility schedule.

Name	Datatype	Description
id	string	The role eligibility schedule Id.
name	string	The role eligibility schedule name.
properties	object	role eligibility schedule properties.
type	string	The role eligibility schedule type.

list_for_scope

OK - Returns an array of role eligibility schedules.

Name	Datatype	Description
id	string	The role eligibility schedule Id.
name	string	The role eligibility schedule name.
properties	object	role eligibility schedule properties.
type	string	The role eligibility schedule type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	scope, roleEligibilityScheduleName		Get the specified role eligibility schedule for a resource scope
list_for_scope	select	scope	$filter	Gets role eligibility schedules for a resource scope.

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
roleEligibilityScheduleName	string	The name (guid) of the role eligibility schedule to get.
scope	string	The scope of the role eligibility schedules.
$filter	string	The filter to apply on the operation. Use $filter=atScope() to return all role eligibility schedules at or above the scope. Use $filter=principalId eq {id} to return all role eligibility 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

Get the specified role eligibility schedule for a resource scope

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

list_for_scope

Gets role eligibility schedules for a resource scope.

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