role_assignment_schedule_requests

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

Overview

Name	role_assignment_schedule_requests
Type	Resource
Id	azure.authorization.role_assignment_schedule_requests

Fields

The following fields are returned by SELECT queries:

get

OK - Returns information about the role assignment schedule request.

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

list_for_scope

OK - Returns an array of role assignments schedule requests.

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	scope, roleAssignmentScheduleRequestName		Get the specified role assignment schedule request.
list_for_scope	select	scope	$filter	Gets role assignment schedule requests for a scope.
create	insert	scope, roleAssignmentScheduleRequestName		Creates a role assignment schedule request.
cancel	exec	scope, roleAssignmentScheduleRequestName		Cancels a pending role assignment schedule request.
validate	exec	scope, roleAssignmentScheduleRequestName		Validates a new role assignment 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
roleAssignmentScheduleRequestName	string	The name of the role assignment request to validate.
scope	string	The scope of the role assignment request to validate.
$filter	string	The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedule requests at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedule requests at, above or below the scope for the specified principal. Use $filter=asRequestor() to return all role assignment schedule requests requested by the current user. Use $filter=asTarget() to return all role assignment schedule requests created for the current user. Use $filter=asApprover() to return all role assignment schedule requests where the current user is an approver.

SELECT examples

get

Get the specified role assignment schedule request.

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

list_for_scope

Gets role assignment schedule requests for a scope.

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

INSERT examples

create

Creates a role assignment schedule request.

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

Manifest

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

Lifecycle Methods

cancel

Cancels a pending role assignment schedule request.

EXEC azure.authorization.role_assignment_schedule_requests.cancel 
@scope='{{ scope }}' --required, 
@roleAssignmentScheduleRequestName='{{ roleAssignmentScheduleRequestName }}' --required
;

validate

Validates a new role assignment schedule request.

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