azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewScheduleDefinitionProperties.yml

### YamlMime:PythonClass
uid: azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewScheduleDefinitionProperties
name: AccessReviewScheduleDefinitionProperties
fullName: azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewScheduleDefinitionProperties
module: azure.mgmt.authorization.v2018_05_01_preview.models
inheritances:
- azure.mgmt.authorization._serialization.Model
summary: 'Access Review.


  Variables are only populated by the server, and will be ignored when sending a request.'
constructor:
  syntax: 'AccessReviewScheduleDefinitionProperties(*, display_name: str | None =
    None, description_for_admins: str | None = None, description_for_reviewers: str
    | None = None, reviewers: List[_models.AccessReviewReviewer] | None = None, instances:
    List[_models.AccessReviewInstance] | None = None, mail_notifications_enabled:
    bool | None = None, reminder_notifications_enabled: bool | None = None, default_decision_enabled:
    bool | None = None, justification_required_on_approval: bool | None = None, default_decision:
    str | _models.DefaultDecisionType | None = None, auto_apply_decisions_enabled:
    bool | None = None, recommendations_enabled: bool | None = None, instance_duration_in_days:
    int | None = None, type_settings_recurrence_range_type: str | _models.AccessReviewRecurrenceRangeType
    | None = None, number_of_occurrences: int | None = None, start_date: datetime
    | None = None, end_date: datetime | None = None, type_settings_recurrence_pattern_type:
    str | _models.AccessReviewRecurrencePatternType | None = None, interval: int |
    None = None, **kwargs: Any)'
  keywordOnlyParameters:
  - name: display_name
    description: The display name for the schedule definition.
    types:
    - <xref:str>
  - name: description_for_admins
    description: 'The description provided by the access review creator and

      visible to admins.'
    types:
    - <xref:str>
  - name: description_for_reviewers
    description: 'The description provided by the access review creator to be

      shown to reviewers.'
    types:
    - <xref:str>
  - name: reviewers
    description: This is the collection of reviewers.
    types:
    - <xref:list>[<xref:azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewReviewer>]
  - name: instances
    description: This is the collection of instances returned when one does an expand
      on it.
    types:
    - <xref:list>[<xref:azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewInstance>]
  - name: mail_notifications_enabled
    description: 'Flag to indicate whether sending mails to reviewers and

      the review creator is enabled.'
    types:
    - <xref:bool>
  - name: reminder_notifications_enabled
    description: 'Flag to indicate whether sending reminder emails to

      reviewers are enabled.'
    types:
    - <xref:bool>
  - name: default_decision_enabled
    description: 'Flag to indicate whether reviewers are required to provide a

      justification when reviewing access.'
    types:
    - <xref:bool>
  - name: justification_required_on_approval
    description: 'Flag to indicate whether the reviewer is required

      to pass justification when recording a decision.'
    types:
    - <xref:bool>
  - name: default_decision
    description: 'This specifies the behavior for the autoReview feature when an

      access review completes. Known values are: "Approve", "Deny", and "Recommendation".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.authorization.v2018_05_01_preview.models.DefaultDecisionType>
  - name: auto_apply_decisions_enabled
    description: 'Flag to indicate whether auto-apply capability, to

      automatically change the target object access resource, is enabled. If not enabled,
      a user

      must, after the review completes, apply the access review.'
    types:
    - <xref:bool>
  - name: recommendations_enabled
    description: 'Flag to indicate whether showing recommendations to reviewers

      is enabled.'
    types:
    - <xref:bool>
  - name: instance_duration_in_days
    description: The duration in days for an instance.
    types:
    - <xref:int>
  - name: type_settings_recurrence_range_type
    description: 'The recurrence range type. The possible values

      are: endDate, noEnd, numbered. Known values are: "endDate", "noEnd", and "numbered".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewRecurrenceRangeType>
  - name: number_of_occurrences
    description: 'The number of times to repeat the access review. Required and

      must be positive if type is numbered.'
    types:
    - <xref:int>
  - name: start_date
    description: 'The DateTime when the review is scheduled to be start. This could
      be a

      date in the future. Required on create.'
    types:
    - <xref:datetime.datetime>
  - name: end_date
    description: 'The DateTime when the review is scheduled to end. Required if type
      is

      endDate.'
    types:
    - <xref:datetime.datetime>
  - name: type_settings_recurrence_pattern_type
    description: 'The recurrence type : weekly, monthly, etc.

      Known values are: "weekly" and "absoluteMonthly".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewRecurrencePatternType>
  - name: interval
    description: 'The interval for recurrence. For a quarterly review, the interval
      is 3 for

      type : absoluteMonthly.'
    types:
    - <xref:int>
variables:
- description: The display name for the schedule definition.
  name: display_name
  types:
  - <xref:str>
- description: 'This read-only field specifies the status of an accessReview. Known
    values are:

    "NotStarted", "InProgress", "Completed", "Applied", "Initializing", "Applying",
    "Completing",

    "Scheduled", "AutoReviewing", "AutoReviewed", and "Starting".'
  name: status
  types:
  - <xref:str>
  - <xref:azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewScheduleDefinitionStatus>
- description: 'The description provided by the access review creator and visible

    to admins.'
  name: description_for_admins
  types:
  - <xref:str>
- description: 'The description provided by the access review creator to be

    shown to reviewers.'
  name: description_for_reviewers
  types:
  - <xref:str>
- description: This is the collection of reviewers.
  name: reviewers
  types:
  - <xref:list>[<xref:azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewReviewer>]
- description: 'This field specifies the type of reviewers for a review. Usually for
    a

    review, reviewers are explicitly assigned. However, in some cases, the reviewers
    may not be

    assigned and instead be chosen dynamically. For example managers review or self
    review. Known

    values are: "Assigned", "Self", and "Managers".'
  name: reviewers_type
  types:
  - <xref:str>
  - <xref:azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewScheduleDefinitionReviewersType>
- description: This is the collection of instances returned when one does an expand
    on it.
  name: instances
  types:
  - <xref:list>[<xref:azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewInstance>]
- description: ResourceId in which this review is getting created.
  name: resource_id
  types:
  - <xref:str>
- description: This is used to indicate the role being reviewed.
  name: role_definition_id
  types:
  - <xref:str>
- description: 'The identity type user/servicePrincipal to review.

    Known values are: "user" and "servicePrincipal".'
  name: principal_type_scope_principal_type
  types:
  - <xref:str>
  - <xref:azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewScopePrincipalType>
- description: 'Flag to indicate whether sending mails to reviewers and the

    review creator is enabled.'
  name: mail_notifications_enabled
  types:
  - <xref:bool>
- description: 'Flag to indicate whether sending reminder emails to

    reviewers are enabled.'
  name: reminder_notifications_enabled
  types:
  - <xref:bool>
- description: 'Flag to indicate whether reviewers are required to provide a

    justification when reviewing access.'
  name: default_decision_enabled
  types:
  - <xref:bool>
- description: 'Flag to indicate whether the reviewer is required to

    pass justification when recording a decision.'
  name: justification_required_on_approval
  types:
  - <xref:bool>
- description: 'This specifies the behavior for the autoReview feature when an access

    review completes. Known values are: "Approve", "Deny", and "Recommendation".'
  name: default_decision
  types:
  - <xref:str>
  - <xref:azure.mgmt.authorization.v2018_05_01_preview.models.DefaultDecisionType>
- description: 'Flag to indicate whether auto-apply capability, to

    automatically change the target object access resource, is enabled. If not enabled,
    a user

    must, after the review completes, apply the access review.'
  name: auto_apply_decisions_enabled
  types:
  - <xref:bool>
- description: 'Flag to indicate whether showing recommendations to reviewers is

    enabled.'
  name: recommendations_enabled
  types:
  - <xref:bool>
- description: The duration in days for an instance.
  name: instance_duration_in_days
  types:
  - <xref:int>
- description: 'The recurrence range type. The possible values are:

    endDate, noEnd, numbered. Known values are: "endDate", "noEnd", and "numbered".'
  name: type_settings_recurrence_range_type
  types:
  - <xref:str>
  - <xref:azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewRecurrenceRangeType>
- description: 'The number of times to repeat the access review. Required and must

    be positive if type is numbered.'
  name: number_of_occurrences
  types:
  - <xref:int>
- description: 'The DateTime when the review is scheduled to be start. This could
    be a date

    in the future. Required on create.'
  name: start_date
  types:
  - <xref:datetime.datetime>
- description: The DateTime when the review is scheduled to end. Required if type
    is endDate.
  name: end_date
  types:
  - <xref:datetime.datetime>
- description: 'The recurrence type : weekly, monthly, etc. Known

    values are: "weekly" and "absoluteMonthly".'
  name: type_settings_recurrence_pattern_type
  types:
  - <xref:str>
  - <xref:azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewRecurrencePatternType>
- description: 'The interval for recurrence. For a quarterly review, the interval
    is 3 for type

    : absoluteMonthly.'
  name: interval
  types:
  - <xref:int>
- description: The identity id.
  name: principal_id
  types:
  - <xref:str>
- description: 'The identity type : user/servicePrincipal.

    Known values are: "user" and "servicePrincipal".'
  name: principal_type_created_by_principal_type
  types:
  - <xref:str>
  - <xref:azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewActorIdentityType>
- description: The identity display name.
  name: principal_name
  types:
  - <xref:str>
- description: The user principal name(if valid).
  name: user_principal_name
  types:
  - <xref:str>