role_assignment_schedule_instances

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

Overview

Name	`role_assignment_schedule_instances`
Type	Resource
Id	`azure.authorization.role_assignment_schedule_instances`

Fields

The following fields are returned by SELECT queries:

get
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.
`assignmentType`	`string`	Assignment type of the role assignment schedule. Known values are: "Activated" and "Assigned". (Activated, Assigned)
`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 assignment schedule was created.
`endDateTime`	`string (date-time)`	The endDateTime of the role assignment schedule instance.
`expandedProperties`	`object`	Additional properties of principal, scope and role definition.
`linkedRoleEligibilityScheduleId`	`string`	roleEligibilityScheduleId used to activate.
`linkedRoleEligibilityScheduleInstanceId`	`string`	roleEligibilityScheduleInstanceId linked to this roleAssignmentScheduleInstance.
`memberType`	`string`	Membership type of the role assignment schedule. Known values are: "Inherited", "Direct", and "Group". (Inherited, Direct, Group)
`originRoleAssignmentId`	`string`	Role Assignment Id in external system.
`principalId`	`string`	The principal ID.
`principalType`	`string`	The principal type of the assigned principal ID. Known values are: "User", "Group", "ServicePrincipal", "ForeignGroup", and "Device". (User, Group, ServicePrincipal, ForeignGroup, Device)
`roleAssignmentScheduleId`	`string`	Id of the master role assignment schedule.
`roleDefinitionId`	`string`	The role definition ID.
`scope`	`string`	The role assignment schedule scope.
`startDateTime`	`string (date-time)`	The startDateTime of the role assignment schedule instance.
`status`	`string`	The status of the role assignment schedule instance. 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.
`type`	`string`	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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.
`assignmentType`	`string`	Assignment type of the role assignment schedule. Known values are: "Activated" and "Assigned". (Activated, Assigned)
`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 assignment schedule was created.
`endDateTime`	`string (date-time)`	The endDateTime of the role assignment schedule instance.
`expandedProperties`	`object`	Additional properties of principal, scope and role definition.
`linkedRoleEligibilityScheduleId`	`string`	roleEligibilityScheduleId used to activate.
`linkedRoleEligibilityScheduleInstanceId`	`string`	roleEligibilityScheduleInstanceId linked to this roleAssignmentScheduleInstance.
`memberType`	`string`	Membership type of the role assignment schedule. Known values are: "Inherited", "Direct", and "Group". (Inherited, Direct, Group)
`originRoleAssignmentId`	`string`	Role Assignment Id in external system.
`principalId`	`string`	The principal ID.
`principalType`	`string`	The principal type of the assigned principal ID. Known values are: "User", "Group", "ServicePrincipal", "ForeignGroup", and "Device". (User, Group, ServicePrincipal, ForeignGroup, Device)
`roleAssignmentScheduleId`	`string`	Id of the master role assignment schedule.
`roleDefinitionId`	`string`	The role definition ID.
`scope`	`string`	The role assignment schedule scope.
`startDateTime`	`string (date-time)`	The startDateTime of the role assignment schedule instance.
`status`	`string`	The status of the role assignment schedule instance. 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.
`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_assignment_schedule_instance_name`		Gets the specified role assignment schedule instance.
`list_for_scope`	`select`	`scope`	`$filter`	Gets role assignment schedule instances of a role assignment 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
`role_assignment_schedule_instance_name`	`string`	The name (hash of schedule name + time) of the role assignment schedule 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 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 assignment schedule instances for the user. Use $filter=asTarget() to return all role assignment schedule instances created for the current user. Default value is None.

`SELECT` examples

get
list_for_scope

Gets the specified role assignment schedule instance.

SELECT
id,
name,
assignmentType,
condition,
conditionVersion,
createdOn,
endDateTime,
expandedProperties,
linkedRoleEligibilityScheduleId,
linkedRoleEligibilityScheduleInstanceId,
memberType,
originRoleAssignmentId,
principalId,
principalType,
roleAssignmentScheduleId,
roleDefinitionId,
scope,
startDateTime,
status,
systemData,
type
FROM azure.authorization.role_assignment_schedule_instances
WHERE scope = '{{ scope }}' -- required
AND role_assignment_schedule_instance_name = '{{ role_assignment_schedule_instance_name }}' -- required
;

Gets role assignment schedule instances of a role assignment schedule.

SELECT
id,
name,
assignmentType,
condition,
conditionVersion,
createdOn,
endDateTime,
expandedProperties,
linkedRoleEligibilityScheduleId,
linkedRoleEligibilityScheduleInstanceId,
memberType,
originRoleAssignmentId,
principalId,
principalType,
roleAssignmentScheduleId,
roleDefinitionId,
scope,
startDateTime,
status,
systemData,
type
FROM azure.authorization.role_assignment_schedule_instances
WHERE scope = '{{ scope }}' -- required
AND $filter = '{{ $filter }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

Overview

Fields

Methods

Parameters

`SELECT` examples