RoleEligibilitySchedule Class

Role eligibility schedule.

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

Constructor

RoleEligibilitySchedule(*, scope: str | None = None, role_definition_id: str | None = None, principal_id: str | None = None, principal_type: str | _models.PrincipalType | None = None, role_eligibility_schedule_request_id: str | None = None, member_type: str | _models.MemberType | None = None, status: str | _models.Status | None = None, start_date_time: datetime | None = None, end_date_time: datetime | None = None, condition: str | None = None, condition_version: str | None = None, created_on: datetime | None = None, updated_on: datetime | None = None, expanded_properties: _models.ExpandedProperties | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
scope
str

The role eligibility 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

The principal type of the assigned principal ID. Known values are: "User", "Group", "ServicePrincipal", "ForeignGroup", and "Device".

Default value: None
role_eligibility_schedule_request_id
str

The id of roleEligibilityScheduleRequest used to create this roleAssignmentSchedule.

Default value: None
member_type

Membership type of the role eligibility schedule. Known values are: "Inherited", "Direct", and "Group".

Default value: None
status
str or Status

The status of the role eligibility schedule. 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

Start DateTime when role eligibility schedule.

Default value: None
end_date_time

End DateTime when role eligibility schedule.

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 when role eligibility schedule was created.

Default value: None
updated_on

DateTime when role eligibility schedule was modified.

Default value: None
expanded_properties

Additional properties of principal, scope and role definition.

Default value: None

Variables

Name Description
id
str

The role eligibility schedule Id.

name
str

The role eligibility schedule name.

type
str

The role eligibility schedule type.

scope
str

The role eligibility schedule scope.

role_definition_id
str

The role definition ID.

principal_id
str

The principal ID.

principal_type

The principal type of the assigned principal ID. Known values are: "User", "Group", "ServicePrincipal", "ForeignGroup", and "Device".

role_eligibility_schedule_request_id
str

The id of roleEligibilityScheduleRequest used to create this roleAssignmentSchedule.

member_type

Membership type of the role eligibility schedule. Known values are: "Inherited", "Direct", and "Group".

status
str or Status

The status of the role eligibility schedule. 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

Start DateTime when role eligibility schedule.

end_date_time

End DateTime when role eligibility schedule.

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 when role eligibility schedule was created.

updated_on

DateTime when role eligibility schedule was modified.

expanded_properties

Additional properties of principal, scope and role definition.