@pulumi/azure-native/authorization/getScopeAccessReviewScheduleDefinitionById.d.ts

[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [![Python version](https://badge.fury.io/py/pu

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Get single access review definition
 *
 * Uses Azure REST API version 2021-12-01-preview.
 */
export declare function getScopeAccessReviewScheduleDefinitionById(args: GetScopeAccessReviewScheduleDefinitionByIdArgs, opts?: pulumi.InvokeOptions): Promise<GetScopeAccessReviewScheduleDefinitionByIdResult>;
export interface GetScopeAccessReviewScheduleDefinitionByIdArgs {
    /**
     * The id of the access review schedule definition.
     */
    scheduleDefinitionId: string;
    /**
     * The scope of the resource.
     */
    scope: string;
}
/**
 * Access Review Schedule Definition.
 */
export interface GetScopeAccessReviewScheduleDefinitionByIdResult {
    /**
     * 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.
     */
    readonly autoApplyDecisionsEnabled?: boolean;
    /**
     * The Azure API version of the resource.
     */
    readonly azureApiVersion: string;
    /**
     * This is the collection of backup reviewers.
     */
    readonly backupReviewers?: outputs.authorization.AccessReviewReviewerResponse[];
    /**
     * This specifies the behavior for the autoReview feature when an access review completes.
     */
    readonly defaultDecision?: string;
    /**
     * Flag to indicate whether reviewers are required to provide a justification when reviewing access.
     */
    readonly defaultDecisionEnabled?: boolean;
    /**
     * The description provided by the access review creator and visible to admins.
     */
    readonly descriptionForAdmins?: string;
    /**
     * The description provided by the access review creator to be shown to reviewers.
     */
    readonly descriptionForReviewers?: string;
    /**
     * The display name for the schedule definition.
     */
    readonly displayName?: string;
    /**
     * The access review schedule definition id.
     */
    readonly id: string;
    /**
     * The duration in days for an instance.
     */
    readonly instanceDurationInDays?: number;
    /**
     * This is the collection of instances returned when one does an expand on it.
     */
    readonly instances?: outputs.authorization.AccessReviewInstanceResponse[];
    /**
     * The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.
     */
    readonly interval?: number;
    /**
     * Flag to indicate whether the reviewer is required to pass justification when recording a decision.
     */
    readonly justificationRequiredOnApproval?: boolean;
    /**
     * Flag to indicate whether sending mails to reviewers and the review creator is enabled.
     */
    readonly mailNotificationsEnabled?: boolean;
    /**
     * The access review schedule definition unique id.
     */
    readonly name: string;
    /**
     * The identity id
     */
    readonly principalId: string;
    /**
     * The identity display name
     */
    readonly principalName: string;
    /**
     * The identity type : user/servicePrincipal
     */
    readonly principalType: string;
    /**
     * Access Review schedule definition recurrence range.
     */
    readonly range?: outputs.authorization.AccessReviewRecurrenceRangeResponse;
    /**
     * 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))
     */
    readonly recommendationLookBackDuration?: string;
    /**
     * Flag to indicate whether showing recommendations to reviewers is enabled.
     */
    readonly recommendationsEnabled?: boolean;
    /**
     * Flag to indicate whether sending reminder emails to reviewers are enabled.
     */
    readonly reminderNotificationsEnabled?: boolean;
    /**
     * This is the collection of reviewers.
     */
    readonly reviewers?: outputs.authorization.AccessReviewReviewerResponse[];
    /**
     * 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.
     */
    readonly reviewersType: string;
    /**
     * This is used to define what to include in scope of the review. The scope definition includes the resourceId and roleDefinitionId.
     */
    readonly scope: outputs.authorization.AccessReviewScopeResponse;
    /**
     * This read-only field specifies the status of an accessReview.
     */
    readonly status: string;
    /**
     * The resource type.
     */
    readonly type: string;
    /**
     * The user principal name(if valid)
     */
    readonly userPrincipalName: string;
}
/**
 * Get single access review definition
 *
 * Uses Azure REST API version 2021-12-01-preview.
 */
export declare function getScopeAccessReviewScheduleDefinitionByIdOutput(args: GetScopeAccessReviewScheduleDefinitionByIdOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetScopeAccessReviewScheduleDefinitionByIdResult>;
export interface GetScopeAccessReviewScheduleDefinitionByIdOutputArgs {
    /**
     * The id of the access review schedule definition.
     */
    scheduleDefinitionId: pulumi.Input<string>;
    /**
     * The scope of the resource.
     */
    scope: pulumi.Input<string>;
}