role_eligibility_schedule_requests

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

Overview

Name	role_eligibility_schedule_requests
Type	Resource
Id	azure.authorization.role_eligibility_schedule_requests

Fields

The following fields are returned by SELECT queries:

get

OK - Returns information about the role eligibility schedule request.

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

list_for_scope

OK - Returns an array of role eligibility schedule requests.

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	scope, roleEligibilityScheduleRequestName		Get the specified role eligibility schedule request.
list_for_scope	select	scope	$filter	Gets role eligibility schedule requests for a scope.
create	insert	scope, roleEligibilityScheduleRequestName		Creates a role eligibility schedule request.
cancel	exec	scope, roleEligibilityScheduleRequestName		Cancels a pending role eligibility schedule request.
validate	exec	scope, roleEligibilityScheduleRequestName		Validates a new role eligibility schedule request.

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
roleEligibilityScheduleRequestName	string	The name of the role eligibility request to validate.
scope	string	The scope of the role eligibility request to validate.
$filter	string	The filter to apply on the operation. Use $filter=atScope() to return all role eligibility schedule requests at or above the scope. Use $filter=principalId eq {id} to return all role eligibility schedule requests at, above or below the scope for the specified principal. Use $filter=asRequestor() to return all role eligibility schedule requests requested by the current user. Use $filter=asTarget() to return all role eligibility schedule requests created for the current user. Use $filter=asApprover() to return all role eligibility schedule requests where the current user is an approver.

SELECT examples

get

Get the specified role eligibility schedule request.

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

list_for_scope

Gets role eligibility schedule requests for a scope.

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

INSERT examples

create

Creates a role eligibility schedule request.

INSERT INTO azure.authorization.role_eligibility_schedule_requests (
data__properties,
scope,
roleEligibilityScheduleRequestName
)
SELECT 
'{{ properties }}',
'{{ scope }}',
'{{ roleEligibilityScheduleRequestName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: role_eligibility_schedule_requests
  props:
    - name: scope
      value: string
      description: Required parameter for the role_eligibility_schedule_requests resource.
    - name: roleEligibilityScheduleRequestName
      value: string
      description: Required parameter for the role_eligibility_schedule_requests resource.
    - name: properties
      value: object
      description: |
        Role eligibility schedule request properties.

Lifecycle Methods

cancel

Cancels a pending role eligibility schedule request.

EXEC azure.authorization.role_eligibility_schedule_requests.cancel 
@scope='{{ scope }}' --required, 
@roleEligibilityScheduleRequestName='{{ roleEligibilityScheduleRequestName }}' --required
;

validate

Validates a new role eligibility schedule request.

EXEC azure.authorization.role_eligibility_schedule_requests.validate 
@scope='{{ scope }}' --required, 
@roleEligibilityScheduleRequestName='{{ roleEligibilityScheduleRequestName }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;