RoleAssignmentScheduleInstance Class

Information about current or upcoming role assignment schedule instance.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

RoleAssignmentScheduleInstance(*, scope: str | None = None, role_definition_id: str | None = None, principal_id: str | None = None, principal_type: str | _models.PrincipalType | None = None, role_assignment_schedule_id: str | None = None, origin_role_assignment_id: str | None = None, status: str | _models.Status | None = None, start_date_time: datetime | None = None, end_date_time: datetime | None = None, linked_role_eligibility_schedule_id: str | None = None, linked_role_eligibility_schedule_instance_id: str | None = None, assignment_type: str | _models.AssignmentType | None = None, member_type: str | _models.MemberType | None = None, condition: str | None = None, condition_version: str | None = None, created_on: datetime | None = None, expanded_properties: _models.ExpandedProperties | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
scope	str The role assignment schedule scope. Default value: None
role_definition_id	str The role definition ID. Default value: None
principal_id	str The principal ID. Default value: None
principal_type	str or PrincipalType The principal type of the assigned principal ID. Known values are: "User", "Group", "ServicePrincipal", "ForeignGroup", and "Device". Default value: None
role_assignment_schedule_id	str Id of the master role assignment schedule. Default value: None
origin_role_assignment_id	str Role Assignment Id in external system. Default value: None
status	str or Status 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". Default value: None
start_date_time	datetime The startDateTime of the role assignment schedule instance. Default value: None
end_date_time	datetime The endDateTime of the role assignment schedule instance. Default value: None
linked_role_eligibility_schedule_id	str roleEligibilityScheduleId used to activate. Default value: None
linked_role_eligibility_schedule_instance_id	str roleEligibilityScheduleInstanceId linked to this roleAssignmentScheduleInstance. Default value: None
assignment_type	str or AssignmentType Assignment type of the role assignment schedule. Known values are: "Activated" and "Assigned". Default value: None
member_type	str or MemberType Membership type of the role assignment schedule. Known values are: "Inherited", "Direct", and "Group". Default value: None
condition	str 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'. Default value: None
condition_version	str Version of the condition. Currently accepted value is '2.0'. Default value: None
created_on	datetime DateTime when role assignment schedule was created. Default value: None
expanded_properties	ExpandedProperties Additional properties of principal, scope and role definition. Default value: None

Variables

Name	Description
id	str The role assignment schedule instance ID.
name	str The role assignment schedule instance name.
type	str The role assignment schedule instance type.
scope	str The role assignment schedule scope.
role_definition_id	str The role definition ID.
principal_id	str The principal ID.
principal_type	str or PrincipalType The principal type of the assigned principal ID. Known values are: "User", "Group", "ServicePrincipal", "ForeignGroup", and "Device".
role_assignment_schedule_id	str Id of the master role assignment schedule.
origin_role_assignment_id	str Role Assignment Id in external system.
status	str or Status 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".
start_date_time	datetime The startDateTime of the role assignment schedule instance.
end_date_time	datetime The endDateTime of the role assignment schedule instance.
linked_role_eligibility_schedule_id	str roleEligibilityScheduleId used to activate.
linked_role_eligibility_schedule_instance_id	str roleEligibilityScheduleInstanceId linked to this roleAssignmentScheduleInstance.
assignment_type	str or AssignmentType Assignment type of the role assignment schedule. Known values are: "Activated" and "Assigned".
member_type	str or MemberType Membership type of the role assignment schedule. Known values are: "Inherited", "Direct", and "Group".
condition	str 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'.
condition_version	str Version of the condition. Currently accepted value is '2.0'.
created_on	datetime DateTime when role assignment schedule was created.
expanded_properties	ExpandedProperties Additional properties of principal, scope and role definition.