This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
azure-native.authorization.getScopeAccessReviewScheduleDefinitionById
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
Get single access review definition Azure REST API version: 2021-12-01-preview.
Using getScopeAccessReviewScheduleDefinitionById
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getScopeAccessReviewScheduleDefinitionById(args: GetScopeAccessReviewScheduleDefinitionByIdArgs, opts?: InvokeOptions): Promise<GetScopeAccessReviewScheduleDefinitionByIdResult>
function getScopeAccessReviewScheduleDefinitionByIdOutput(args: GetScopeAccessReviewScheduleDefinitionByIdOutputArgs, opts?: InvokeOptions): Output<GetScopeAccessReviewScheduleDefinitionByIdResult>def get_scope_access_review_schedule_definition_by_id(schedule_definition_id: Optional[str] = None,
                                                      scope: Optional[str] = None,
                                                      opts: Optional[InvokeOptions] = None) -> GetScopeAccessReviewScheduleDefinitionByIdResult
def get_scope_access_review_schedule_definition_by_id_output(schedule_definition_id: Optional[pulumi.Input[str]] = None,
                                                      scope: Optional[pulumi.Input[str]] = None,
                                                      opts: Optional[InvokeOptions] = None) -> Output[GetScopeAccessReviewScheduleDefinitionByIdResult]func LookupScopeAccessReviewScheduleDefinitionById(ctx *Context, args *LookupScopeAccessReviewScheduleDefinitionByIdArgs, opts ...InvokeOption) (*LookupScopeAccessReviewScheduleDefinitionByIdResult, error)
func LookupScopeAccessReviewScheduleDefinitionByIdOutput(ctx *Context, args *LookupScopeAccessReviewScheduleDefinitionByIdOutputArgs, opts ...InvokeOption) LookupScopeAccessReviewScheduleDefinitionByIdResultOutput> Note: This function is named LookupScopeAccessReviewScheduleDefinitionById in the Go SDK.
public static class GetScopeAccessReviewScheduleDefinitionById 
{
    public static Task<GetScopeAccessReviewScheduleDefinitionByIdResult> InvokeAsync(GetScopeAccessReviewScheduleDefinitionByIdArgs args, InvokeOptions? opts = null)
    public static Output<GetScopeAccessReviewScheduleDefinitionByIdResult> Invoke(GetScopeAccessReviewScheduleDefinitionByIdInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetScopeAccessReviewScheduleDefinitionByIdResult> getScopeAccessReviewScheduleDefinitionById(GetScopeAccessReviewScheduleDefinitionByIdArgs args, InvokeOptions options)
public static Output<GetScopeAccessReviewScheduleDefinitionByIdResult> getScopeAccessReviewScheduleDefinitionById(GetScopeAccessReviewScheduleDefinitionByIdArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:authorization:getScopeAccessReviewScheduleDefinitionById
  arguments:
    # arguments dictionaryThe following arguments are supported:
- ScheduleDefinition stringId 
- The id of the access review schedule definition.
- Scope string
- The scope of the resource.
- ScheduleDefinition stringId 
- The id of the access review schedule definition.
- Scope string
- The scope of the resource.
- scheduleDefinition StringId 
- The id of the access review schedule definition.
- scope String
- The scope of the resource.
- scheduleDefinition stringId 
- The id of the access review schedule definition.
- scope string
- The scope of the resource.
- schedule_definition_ strid 
- The id of the access review schedule definition.
- scope str
- The scope of the resource.
- scheduleDefinition StringId 
- The id of the access review schedule definition.
- scope String
- The scope of the resource.
getScopeAccessReviewScheduleDefinitionById Result
The following output properties are available:
- AssignmentState string
- The role assignment state eligible/active to review
- Id string
- The access review schedule definition id.
- Name string
- The access review schedule definition unique id.
- PrincipalId string
- The identity id
- PrincipalName string
- The identity display name
- PrincipalType string
- The identity type user/servicePrincipal to review
- ResourceId string
- ResourceId in which this review is getting created
- ReviewersType string
- 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.
- RoleDefinition stringId 
- This is used to indicate the role being reviewed
- Status string
- This read-only field specifies the status of an accessReview.
- Type string
- The resource type.
- UserPrincipal stringName 
- The user principal name(if valid)
- AutoApply boolDecisions Enabled 
- 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.
- BackupReviewers List<Pulumi.Azure Native. Authorization. Outputs. Access Review Reviewer Response> 
- This is the collection of backup reviewers.
- DefaultDecision string
- This specifies the behavior for the autoReview feature when an access review completes.
- DefaultDecision boolEnabled 
- Flag to indicate whether reviewers are required to provide a justification when reviewing access.
- DescriptionFor stringAdmins 
- The description provided by the access review creator and visible to admins.
- DescriptionFor stringReviewers 
- The description provided by the access review creator to be shown to reviewers.
- DisplayName string
- The display name for the schedule definition.
- EndDate string
- The DateTime when the review is scheduled to end. Required if type is endDate
- ExcludeResource stringId 
- This is used to indicate the resource id(s) to exclude
- ExcludeRole stringDefinition Id 
- This is used to indicate the role definition id(s) to exclude
- ExpandNested boolMemberships 
- Flag to indicate whether to expand nested memberships or not.
- InactiveDuration string
- Duration users are inactive for. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))
- IncludeAccess boolBelow Resource 
- Flag to indicate whether to expand nested memberships or not.
- IncludeInherited boolAccess 
- Flag to indicate whether to expand nested memberships or not.
- InstanceDuration intIn Days 
- The duration in days for an instance.
- Instances
List<Pulumi.Azure Native. Authorization. Outputs. Access Review Instance Response> 
- This is the collection of instances returned when one does an expand on it.
- Interval int
- The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.
- JustificationRequired boolOn Approval 
- Flag to indicate whether the reviewer is required to pass justification when recording a decision.
- MailNotifications boolEnabled 
- Flag to indicate whether sending mails to reviewers and the review creator is enabled.
- NumberOf intOccurrences 
- The number of times to repeat the access review. Required and must be positive if type is numbered.
- RecommendationLook stringBack Duration 
- Recommendations for access reviews are calculated by looking back at 30 days of data(w.r.t the start date of the review) by default. However, in some scenarios, customers want to change how far back to look at and want to configure 60 days, 90 days, etc. instead. This setting allows customers to configure this duration. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))
- RecommendationsEnabled bool
- Flag to indicate whether showing recommendations to reviewers is enabled.
- ReminderNotifications boolEnabled 
- Flag to indicate whether sending reminder emails to reviewers are enabled.
- Reviewers
List<Pulumi.Azure Native. Authorization. Outputs. Access Review Reviewer Response> 
- This is the collection of reviewers.
- StartDate string
- The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
- AssignmentState string
- The role assignment state eligible/active to review
- Id string
- The access review schedule definition id.
- Name string
- The access review schedule definition unique id.
- PrincipalId string
- The identity id
- PrincipalName string
- The identity display name
- PrincipalType string
- The identity type user/servicePrincipal to review
- ResourceId string
- ResourceId in which this review is getting created
- ReviewersType string
- 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.
- RoleDefinition stringId 
- This is used to indicate the role being reviewed
- Status string
- This read-only field specifies the status of an accessReview.
- Type string
- The resource type.
- UserPrincipal stringName 
- The user principal name(if valid)
- AutoApply boolDecisions Enabled 
- 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.
- BackupReviewers []AccessReview Reviewer Response 
- This is the collection of backup reviewers.
- DefaultDecision string
- This specifies the behavior for the autoReview feature when an access review completes.
- DefaultDecision boolEnabled 
- Flag to indicate whether reviewers are required to provide a justification when reviewing access.
- DescriptionFor stringAdmins 
- The description provided by the access review creator and visible to admins.
- DescriptionFor stringReviewers 
- The description provided by the access review creator to be shown to reviewers.
- DisplayName string
- The display name for the schedule definition.
- EndDate string
- The DateTime when the review is scheduled to end. Required if type is endDate
- ExcludeResource stringId 
- This is used to indicate the resource id(s) to exclude
- ExcludeRole stringDefinition Id 
- This is used to indicate the role definition id(s) to exclude
- ExpandNested boolMemberships 
- Flag to indicate whether to expand nested memberships or not.
- InactiveDuration string
- Duration users are inactive for. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))
- IncludeAccess boolBelow Resource 
- Flag to indicate whether to expand nested memberships or not.
- IncludeInherited boolAccess 
- Flag to indicate whether to expand nested memberships or not.
- InstanceDuration intIn Days 
- The duration in days for an instance.
- Instances
[]AccessReview Instance Response 
- This is the collection of instances returned when one does an expand on it.
- Interval int
- The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.
- JustificationRequired boolOn Approval 
- Flag to indicate whether the reviewer is required to pass justification when recording a decision.
- MailNotifications boolEnabled 
- Flag to indicate whether sending mails to reviewers and the review creator is enabled.
- NumberOf intOccurrences 
- The number of times to repeat the access review. Required and must be positive if type is numbered.
- RecommendationLook stringBack Duration 
- Recommendations for access reviews are calculated by looking back at 30 days of data(w.r.t the start date of the review) by default. However, in some scenarios, customers want to change how far back to look at and want to configure 60 days, 90 days, etc. instead. This setting allows customers to configure this duration. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))
- RecommendationsEnabled bool
- Flag to indicate whether showing recommendations to reviewers is enabled.
- ReminderNotifications boolEnabled 
- Flag to indicate whether sending reminder emails to reviewers are enabled.
- Reviewers
[]AccessReview Reviewer Response 
- This is the collection of reviewers.
- StartDate string
- The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
- assignmentState String
- The role assignment state eligible/active to review
- id String
- The access review schedule definition id.
- name String
- The access review schedule definition unique id.
- principalId String
- The identity id
- principalName String
- The identity display name
- principalType String
- The identity type user/servicePrincipal to review
- resourceId String
- ResourceId in which this review is getting created
- reviewersType String
- 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.
- roleDefinition StringId 
- This is used to indicate the role being reviewed
- status String
- This read-only field specifies the status of an accessReview.
- type String
- The resource type.
- userPrincipal StringName 
- The user principal name(if valid)
- autoApply BooleanDecisions Enabled 
- 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.
- backupReviewers List<AccessReview Reviewer Response> 
- This is the collection of backup reviewers.
- defaultDecision String
- This specifies the behavior for the autoReview feature when an access review completes.
- defaultDecision BooleanEnabled 
- Flag to indicate whether reviewers are required to provide a justification when reviewing access.
- descriptionFor StringAdmins 
- The description provided by the access review creator and visible to admins.
- descriptionFor StringReviewers 
- The description provided by the access review creator to be shown to reviewers.
- displayName String
- The display name for the schedule definition.
- endDate String
- The DateTime when the review is scheduled to end. Required if type is endDate
- excludeResource StringId 
- This is used to indicate the resource id(s) to exclude
- excludeRole StringDefinition Id 
- This is used to indicate the role definition id(s) to exclude
- expandNested BooleanMemberships 
- Flag to indicate whether to expand nested memberships or not.
- inactiveDuration String
- Duration users are inactive for. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))
- includeAccess BooleanBelow Resource 
- Flag to indicate whether to expand nested memberships or not.
- includeInherited BooleanAccess 
- Flag to indicate whether to expand nested memberships or not.
- instanceDuration IntegerIn Days 
- The duration in days for an instance.
- instances
List<AccessReview Instance Response> 
- This is the collection of instances returned when one does an expand on it.
- interval Integer
- The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.
- justificationRequired BooleanOn Approval 
- Flag to indicate whether the reviewer is required to pass justification when recording a decision.
- mailNotifications BooleanEnabled 
- Flag to indicate whether sending mails to reviewers and the review creator is enabled.
- numberOf IntegerOccurrences 
- The number of times to repeat the access review. Required and must be positive if type is numbered.
- recommendationLook StringBack Duration 
- Recommendations for access reviews are calculated by looking back at 30 days of data(w.r.t the start date of the review) by default. However, in some scenarios, customers want to change how far back to look at and want to configure 60 days, 90 days, etc. instead. This setting allows customers to configure this duration. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))
- recommendationsEnabled Boolean
- Flag to indicate whether showing recommendations to reviewers is enabled.
- reminderNotifications BooleanEnabled 
- Flag to indicate whether sending reminder emails to reviewers are enabled.
- reviewers
List<AccessReview Reviewer Response> 
- This is the collection of reviewers.
- startDate String
- The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
- assignmentState string
- The role assignment state eligible/active to review
- id string
- The access review schedule definition id.
- name string
- The access review schedule definition unique id.
- principalId string
- The identity id
- principalName string
- The identity display name
- principalType string
- The identity type user/servicePrincipal to review
- resourceId string
- ResourceId in which this review is getting created
- reviewersType string
- 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.
- roleDefinition stringId 
- This is used to indicate the role being reviewed
- status string
- This read-only field specifies the status of an accessReview.
- type string
- The resource type.
- userPrincipal stringName 
- The user principal name(if valid)
- autoApply booleanDecisions Enabled 
- 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.
- backupReviewers AccessReview Reviewer Response[] 
- This is the collection of backup reviewers.
- defaultDecision string
- This specifies the behavior for the autoReview feature when an access review completes.
- defaultDecision booleanEnabled 
- Flag to indicate whether reviewers are required to provide a justification when reviewing access.
- descriptionFor stringAdmins 
- The description provided by the access review creator and visible to admins.
- descriptionFor stringReviewers 
- The description provided by the access review creator to be shown to reviewers.
- displayName string
- The display name for the schedule definition.
- endDate string
- The DateTime when the review is scheduled to end. Required if type is endDate
- excludeResource stringId 
- This is used to indicate the resource id(s) to exclude
- excludeRole stringDefinition Id 
- This is used to indicate the role definition id(s) to exclude
- expandNested booleanMemberships 
- Flag to indicate whether to expand nested memberships or not.
- inactiveDuration string
- Duration users are inactive for. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))
- includeAccess booleanBelow Resource 
- Flag to indicate whether to expand nested memberships or not.
- includeInherited booleanAccess 
- Flag to indicate whether to expand nested memberships or not.
- instanceDuration numberIn Days 
- The duration in days for an instance.
- instances
AccessReview Instance Response[] 
- This is the collection of instances returned when one does an expand on it.
- interval number
- The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.
- justificationRequired booleanOn Approval 
- Flag to indicate whether the reviewer is required to pass justification when recording a decision.
- mailNotifications booleanEnabled 
- Flag to indicate whether sending mails to reviewers and the review creator is enabled.
- numberOf numberOccurrences 
- The number of times to repeat the access review. Required and must be positive if type is numbered.
- recommendationLook stringBack Duration 
- Recommendations for access reviews are calculated by looking back at 30 days of data(w.r.t the start date of the review) by default. However, in some scenarios, customers want to change how far back to look at and want to configure 60 days, 90 days, etc. instead. This setting allows customers to configure this duration. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))
- recommendationsEnabled boolean
- Flag to indicate whether showing recommendations to reviewers is enabled.
- reminderNotifications booleanEnabled 
- Flag to indicate whether sending reminder emails to reviewers are enabled.
- reviewers
AccessReview Reviewer Response[] 
- This is the collection of reviewers.
- startDate string
- The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
- assignment_state str
- The role assignment state eligible/active to review
- id str
- The access review schedule definition id.
- name str
- The access review schedule definition unique id.
- principal_id str
- The identity id
- principal_name str
- The identity display name
- principal_type str
- The identity type user/servicePrincipal to review
- resource_id str
- ResourceId in which this review is getting created
- reviewers_type str
- 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.
- role_definition_ strid 
- This is used to indicate the role being reviewed
- status str
- This read-only field specifies the status of an accessReview.
- type str
- The resource type.
- user_principal_ strname 
- The user principal name(if valid)
- auto_apply_ booldecisions_ enabled 
- 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.
- backup_reviewers Sequence[AccessReview Reviewer Response] 
- This is the collection of backup reviewers.
- default_decision str
- This specifies the behavior for the autoReview feature when an access review completes.
- default_decision_ boolenabled 
- Flag to indicate whether reviewers are required to provide a justification when reviewing access.
- description_for_ stradmins 
- The description provided by the access review creator and visible to admins.
- description_for_ strreviewers 
- The description provided by the access review creator to be shown to reviewers.
- display_name str
- The display name for the schedule definition.
- end_date str
- The DateTime when the review is scheduled to end. Required if type is endDate
- exclude_resource_ strid 
- This is used to indicate the resource id(s) to exclude
- exclude_role_ strdefinition_ id 
- This is used to indicate the role definition id(s) to exclude
- expand_nested_ boolmemberships 
- Flag to indicate whether to expand nested memberships or not.
- inactive_duration str
- Duration users are inactive for. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))
- include_access_ boolbelow_ resource 
- Flag to indicate whether to expand nested memberships or not.
- include_inherited_ boolaccess 
- Flag to indicate whether to expand nested memberships or not.
- instance_duration_ intin_ days 
- The duration in days for an instance.
- instances
Sequence[AccessReview Instance Response] 
- This is the collection of instances returned when one does an expand on it.
- interval int
- The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.
- justification_required_ boolon_ approval 
- Flag to indicate whether the reviewer is required to pass justification when recording a decision.
- mail_notifications_ boolenabled 
- Flag to indicate whether sending mails to reviewers and the review creator is enabled.
- number_of_ intoccurrences 
- The number of times to repeat the access review. Required and must be positive if type is numbered.
- recommendation_look_ strback_ duration 
- Recommendations for access reviews are calculated by looking back at 30 days of data(w.r.t the start date of the review) by default. However, in some scenarios, customers want to change how far back to look at and want to configure 60 days, 90 days, etc. instead. This setting allows customers to configure this duration. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))
- recommendations_enabled bool
- Flag to indicate whether showing recommendations to reviewers is enabled.
- reminder_notifications_ boolenabled 
- Flag to indicate whether sending reminder emails to reviewers are enabled.
- reviewers
Sequence[AccessReview Reviewer Response] 
- This is the collection of reviewers.
- start_date str
- The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
- assignmentState String
- The role assignment state eligible/active to review
- id String
- The access review schedule definition id.
- name String
- The access review schedule definition unique id.
- principalId String
- The identity id
- principalName String
- The identity display name
- principalType String
- The identity type user/servicePrincipal to review
- resourceId String
- ResourceId in which this review is getting created
- reviewersType String
- 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.
- roleDefinition StringId 
- This is used to indicate the role being reviewed
- status String
- This read-only field specifies the status of an accessReview.
- type String
- The resource type.
- userPrincipal StringName 
- The user principal name(if valid)
- autoApply BooleanDecisions Enabled 
- 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.
- backupReviewers List<Property Map>
- This is the collection of backup reviewers.
- defaultDecision String
- This specifies the behavior for the autoReview feature when an access review completes.
- defaultDecision BooleanEnabled 
- Flag to indicate whether reviewers are required to provide a justification when reviewing access.
- descriptionFor StringAdmins 
- The description provided by the access review creator and visible to admins.
- descriptionFor StringReviewers 
- The description provided by the access review creator to be shown to reviewers.
- displayName String
- The display name for the schedule definition.
- endDate String
- The DateTime when the review is scheduled to end. Required if type is endDate
- excludeResource StringId 
- This is used to indicate the resource id(s) to exclude
- excludeRole StringDefinition Id 
- This is used to indicate the role definition id(s) to exclude
- expandNested BooleanMemberships 
- Flag to indicate whether to expand nested memberships or not.
- inactiveDuration String
- Duration users are inactive for. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))
- includeAccess BooleanBelow Resource 
- Flag to indicate whether to expand nested memberships or not.
- includeInherited BooleanAccess 
- Flag to indicate whether to expand nested memberships or not.
- instanceDuration NumberIn Days 
- The duration in days for an instance.
- instances List<Property Map>
- This is the collection of instances returned when one does an expand on it.
- interval Number
- The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.
- justificationRequired BooleanOn Approval 
- Flag to indicate whether the reviewer is required to pass justification when recording a decision.
- mailNotifications BooleanEnabled 
- Flag to indicate whether sending mails to reviewers and the review creator is enabled.
- numberOf NumberOccurrences 
- The number of times to repeat the access review. Required and must be positive if type is numbered.
- recommendationLook StringBack Duration 
- Recommendations for access reviews are calculated by looking back at 30 days of data(w.r.t the start date of the review) by default. However, in some scenarios, customers want to change how far back to look at and want to configure 60 days, 90 days, etc. instead. This setting allows customers to configure this duration. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))
- recommendationsEnabled Boolean
- Flag to indicate whether showing recommendations to reviewers is enabled.
- reminderNotifications BooleanEnabled 
- Flag to indicate whether sending reminder emails to reviewers are enabled.
- reviewers List<Property Map>
- This is the collection of reviewers.
- startDate String
- The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
Supporting Types
AccessReviewInstanceResponse   
- Id string
- The access review instance id.
- Name string
- The access review instance name.
- ReviewersType string
- 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.
- Status string
- This read-only field specifies the status of an access review instance.
- Type string
- The resource type.
- BackupReviewers List<Pulumi.Azure Native. Authorization. Inputs. Access Review Reviewer Response> 
- This is the collection of backup reviewers.
- EndDate stringTime 
- The DateTime when the review instance is scheduled to end.
- Reviewers
List<Pulumi.Azure Native. Authorization. Inputs. Access Review Reviewer Response> 
- This is the collection of reviewers.
- StartDate stringTime 
- The DateTime when the review instance is scheduled to be start.
- Id string
- The access review instance id.
- Name string
- The access review instance name.
- ReviewersType string
- 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.
- Status string
- This read-only field specifies the status of an access review instance.
- Type string
- The resource type.
- BackupReviewers []AccessReview Reviewer Response 
- This is the collection of backup reviewers.
- EndDate stringTime 
- The DateTime when the review instance is scheduled to end.
- Reviewers
[]AccessReview Reviewer Response 
- This is the collection of reviewers.
- StartDate stringTime 
- The DateTime when the review instance is scheduled to be start.
- id String
- The access review instance id.
- name String
- The access review instance name.
- reviewersType String
- 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.
- status String
- This read-only field specifies the status of an access review instance.
- type String
- The resource type.
- backupReviewers List<AccessReview Reviewer Response> 
- This is the collection of backup reviewers.
- endDate StringTime 
- The DateTime when the review instance is scheduled to end.
- reviewers
List<AccessReview Reviewer Response> 
- This is the collection of reviewers.
- startDate StringTime 
- The DateTime when the review instance is scheduled to be start.
- id string
- The access review instance id.
- name string
- The access review instance name.
- reviewersType string
- 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.
- status string
- This read-only field specifies the status of an access review instance.
- type string
- The resource type.
- backupReviewers AccessReview Reviewer Response[] 
- This is the collection of backup reviewers.
- endDate stringTime 
- The DateTime when the review instance is scheduled to end.
- reviewers
AccessReview Reviewer Response[] 
- This is the collection of reviewers.
- startDate stringTime 
- The DateTime when the review instance is scheduled to be start.
- id str
- The access review instance id.
- name str
- The access review instance name.
- reviewers_type str
- 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.
- status str
- This read-only field specifies the status of an access review instance.
- type str
- The resource type.
- backup_reviewers Sequence[AccessReview Reviewer Response] 
- This is the collection of backup reviewers.
- end_date_ strtime 
- The DateTime when the review instance is scheduled to end.
- reviewers
Sequence[AccessReview Reviewer Response] 
- This is the collection of reviewers.
- start_date_ strtime 
- The DateTime when the review instance is scheduled to be start.
- id String
- The access review instance id.
- name String
- The access review instance name.
- reviewersType String
- 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.
- status String
- This read-only field specifies the status of an access review instance.
- type String
- The resource type.
- backupReviewers List<Property Map>
- This is the collection of backup reviewers.
- endDate StringTime 
- The DateTime when the review instance is scheduled to end.
- reviewers List<Property Map>
- This is the collection of reviewers.
- startDate StringTime 
- The DateTime when the review instance is scheduled to be start.
AccessReviewReviewerResponse   
- PrincipalType string
- The identity type : user/servicePrincipal
- PrincipalId string
- The id of the reviewer(user/servicePrincipal)
- PrincipalType string
- The identity type : user/servicePrincipal
- PrincipalId string
- The id of the reviewer(user/servicePrincipal)
- principalType String
- The identity type : user/servicePrincipal
- principalId String
- The id of the reviewer(user/servicePrincipal)
- principalType string
- The identity type : user/servicePrincipal
- principalId string
- The id of the reviewer(user/servicePrincipal)
- principal_type str
- The identity type : user/servicePrincipal
- principal_id str
- The id of the reviewer(user/servicePrincipal)
- principalType String
- The identity type : user/servicePrincipal
- principalId String
- The id of the reviewer(user/servicePrincipal)
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi