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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
approvalId	string	The approvalId of the role eligibility schedule request.
condition	string	The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'.
conditionVersion	string	Version of the condition. Currently accepted value is '2.0'.
createdOn	string (date-time)	DateTime when role eligibility schedule request was created.
expandedProperties	object	Additional properties of principal, scope and role definition.
justification	string	Justification for the role eligibility.
principalId	string	The principal ID. Required.
principalType	string	The principal type of the assigned principal ID. Known values are: "User", "Group", "ServicePrincipal", "ForeignGroup", and "Device". (User, Group, ServicePrincipal, ForeignGroup, Device)
requestType	string	The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc. Required. Known values are: "AdminAssign", "AdminRemove", "AdminUpdate", "AdminExtend", "AdminRenew", "SelfActivate", "SelfDeactivate", "SelfExtend", and "SelfRenew". (AdminAssign, AdminRemove, AdminUpdate, AdminExtend, AdminRenew, SelfActivate, SelfDeactivate, SelfExtend, SelfRenew)
requestorId	string	Id of the user who created this request.
roleDefinitionId	string	The role definition ID. Required.
scheduleInfo	object	Schedule info of the role eligibility schedule.
scope	string	The role eligibility schedule request scope.
status	string	The status of the role eligibility schedule request. Known values are: "Accepted", "PendingEvaluation", "Granted", "Denied", "PendingProvisioning", "Provisioned", "PendingRevocation", "Revoked", "Canceled", "Failed", "PendingApprovalProvisioning", "PendingApproval", "FailedAsResourceIsLocked", "PendingAdminDecision", "AdminApproved", "AdminDenied", "TimedOut", "ProvisioningStarted", "Invalid", "PendingScheduleCreation", "ScheduleCreated", and "PendingExternalProvisioning". (Accepted, PendingEvaluation, Granted, Denied, PendingProvisioning, Provisioned, PendingRevocation, Revoked, Canceled, Failed, PendingApprovalProvisioning, PendingApproval, FailedAsResourceIsLocked, PendingAdminDecision, AdminApproved, AdminDenied, TimedOut, ProvisioningStarted, Invalid, PendingScheduleCreation, ScheduleCreated, PendingExternalProvisioning)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetRoleEligibilityScheduleId	string	The resultant role eligibility schedule id or the role eligibility schedule id being updated.
targetRoleEligibilityScheduleInstanceId	string	The role eligibility schedule instance id being updated.
ticketInfo	object	Ticket Info of the role eligibility.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_for_scope

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
approvalId	string	The approvalId of the role eligibility schedule request.
condition	string	The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'.
conditionVersion	string	Version of the condition. Currently accepted value is '2.0'.
createdOn	string (date-time)	DateTime when role eligibility schedule request was created.
expandedProperties	object	Additional properties of principal, scope and role definition.
justification	string	Justification for the role eligibility.
principalId	string	The principal ID. Required.
principalType	string	The principal type of the assigned principal ID. Known values are: "User", "Group", "ServicePrincipal", "ForeignGroup", and "Device". (User, Group, ServicePrincipal, ForeignGroup, Device)
requestType	string	The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc. Required. Known values are: "AdminAssign", "AdminRemove", "AdminUpdate", "AdminExtend", "AdminRenew", "SelfActivate", "SelfDeactivate", "SelfExtend", and "SelfRenew". (AdminAssign, AdminRemove, AdminUpdate, AdminExtend, AdminRenew, SelfActivate, SelfDeactivate, SelfExtend, SelfRenew)
requestorId	string	Id of the user who created this request.
roleDefinitionId	string	The role definition ID. Required.
scheduleInfo	object	Schedule info of the role eligibility schedule.
scope	string	The role eligibility schedule request scope.
status	string	The status of the role eligibility schedule request. Known values are: "Accepted", "PendingEvaluation", "Granted", "Denied", "PendingProvisioning", "Provisioned", "PendingRevocation", "Revoked", "Canceled", "Failed", "PendingApprovalProvisioning", "PendingApproval", "FailedAsResourceIsLocked", "PendingAdminDecision", "AdminApproved", "AdminDenied", "TimedOut", "ProvisioningStarted", "Invalid", "PendingScheduleCreation", "ScheduleCreated", and "PendingExternalProvisioning". (Accepted, PendingEvaluation, Granted, Denied, PendingProvisioning, Provisioned, PendingRevocation, Revoked, Canceled, Failed, PendingApprovalProvisioning, PendingApproval, FailedAsResourceIsLocked, PendingAdminDecision, AdminApproved, AdminDenied, TimedOut, ProvisioningStarted, Invalid, PendingScheduleCreation, ScheduleCreated, PendingExternalProvisioning)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetRoleEligibilityScheduleId	string	The resultant role eligibility schedule id or the role eligibility schedule id being updated.
targetRoleEligibilityScheduleInstanceId	string	The role eligibility schedule instance id being updated.
ticketInfo	object	Ticket Info of the role eligibility.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	scope, role_eligibility_schedule_request_name		Get the specified role eligibility schedule request.
list_for_scope	select	scope	$filter	Gets role eligibility schedule requests for a scope.
create	insert	scope, role_eligibility_schedule_request_name		Creates a role eligibility schedule request.
cancel	exec	scope, role_eligibility_schedule_request_name		Cancels a pending role eligibility schedule request.
validate	exec	scope, role_eligibility_schedule_request_name		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
role_eligibility_schedule_request_name	string	The name (guid) of the role eligibility schedule request to get. Required.
scope	string	The fully qualified Azure Resource manager identifier of the resource. Required.
$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. Default value is None.

SELECT examples

get

Get the specified role eligibility schedule request.

SELECT
id,
name,
approvalId,
condition,
conditionVersion,
createdOn,
expandedProperties,
justification,
principalId,
principalType,
requestType,
requestorId,
roleDefinitionId,
scheduleInfo,
scope,
status,
systemData,
targetRoleEligibilityScheduleId,
targetRoleEligibilityScheduleInstanceId,
ticketInfo,
type
FROM azure.authorization.role_eligibility_schedule_requests
WHERE scope = '{{ scope }}' -- required
AND role_eligibility_schedule_request_name = '{{ role_eligibility_schedule_request_name }}' -- required
;

list_for_scope

Gets role eligibility schedule requests for a scope.

SELECT
id,
name,
approvalId,
condition,
conditionVersion,
createdOn,
expandedProperties,
justification,
principalId,
principalType,
requestType,
requestorId,
roleDefinitionId,
scheduleInfo,
scope,
status,
systemData,
targetRoleEligibilityScheduleId,
targetRoleEligibilityScheduleInstanceId,
ticketInfo,
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 (
properties,
scope,
role_eligibility_schedule_request_name
)
SELECT 
'{{ properties }}',
'{{ scope }}',
'{{ role_eligibility_schedule_request_name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: role_eligibility_schedule_requests
props:
  - name: scope
    value: "{{ scope }}"
    description: Required parameter for the role_eligibility_schedule_requests resource.
  - name: role_eligibility_schedule_request_name
    value: "{{ role_eligibility_schedule_request_name }}"
    description: Required parameter for the role_eligibility_schedule_requests resource.
  - name: properties
    description: |
      Role eligibility schedule request properties.
    value:
      scope: "{{ scope }}"
      roleDefinitionId: "{{ roleDefinitionId }}"
      principalId: "{{ principalId }}"
      principalType: "{{ principalType }}"
      requestType: "{{ requestType }}"
      status: "{{ status }}"
      approvalId: "{{ approvalId }}"
      scheduleInfo:
        startDateTime: "{{ startDateTime }}"
        expiration:
          type: "{{ type }}"
          endDateTime: "{{ endDateTime }}"
          duration: "{{ duration }}"
      targetRoleEligibilityScheduleId: "{{ targetRoleEligibilityScheduleId }}"
      targetRoleEligibilityScheduleInstanceId: "{{ targetRoleEligibilityScheduleInstanceId }}"
      justification: "{{ justification }}"
      ticketInfo:
        ticketNumber: "{{ ticketNumber }}"
        ticketSystem: "{{ ticketSystem }}"
      condition: "{{ condition }}"
      conditionVersion: "{{ conditionVersion }}"
      createdOn: "{{ createdOn }}"
      requestorId: "{{ requestorId }}"
      expandedProperties:
        scope:
          id: "{{ id }}"
          displayName: "{{ displayName }}"
          type: "{{ type }}"
        roleDefinition:
          id: "{{ id }}"
          displayName: "{{ displayName }}"
          type: "{{ type }}"
        principal:
          id: "{{ id }}"
          displayName: "{{ displayName }}"
          email: "{{ email }}"
          type: "{{ type }}"

Lifecycle Methods

cancel

Cancels a pending role eligibility schedule request.

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

validate

Validates a new role eligibility schedule request.

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