@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 11.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Access Review Schedule Definition.
*
* Uses Azure REST API version 2021-12-01-preview. In version 2.x of the Azure Native provider, it used API version 2021-12-01-preview.
*
* Other available API versions: 2021-03-01-preview, 2021-07-01-preview, 2021-11-16-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native authorization [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class AccessReviewScheduleDefinitionById extends pulumi.CustomResource {
/**
* Get an existing AccessReviewScheduleDefinitionById resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): AccessReviewScheduleDefinitionById;
/**
* Returns true if the given object is an instance of AccessReviewScheduleDefinitionById. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is AccessReviewScheduleDefinitionById;
/**
* 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: pulumi.Output<boolean | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* This is the collection of backup reviewers.
*/
readonly backupReviewers: pulumi.Output<outputs.authorization.AccessReviewReviewerResponse[] | undefined>;
/**
* This specifies the behavior for the autoReview feature when an access review completes.
*/
readonly defaultDecision: pulumi.Output<string | undefined>;
/**
* Flag to indicate whether reviewers are required to provide a justification when reviewing access.
*/
readonly defaultDecisionEnabled: pulumi.Output<boolean | undefined>;
/**
* The description provided by the access review creator and visible to admins.
*/
readonly descriptionForAdmins: pulumi.Output<string | undefined>;
/**
* The description provided by the access review creator to be shown to reviewers.
*/
readonly descriptionForReviewers: pulumi.Output<string | undefined>;
/**
* The display name for the schedule definition.
*/
readonly displayName: pulumi.Output<string | undefined>;
/**
* The duration in days for an instance.
*/
readonly instanceDurationInDays: pulumi.Output<number | undefined>;
/**
* This is the collection of instances returned when one does an expand on it.
*/
readonly instances: pulumi.Output<outputs.authorization.AccessReviewInstanceResponse[] | undefined>;
/**
* The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.
*/
readonly interval: pulumi.Output<number | undefined>;
/**
* Flag to indicate whether the reviewer is required to pass justification when recording a decision.
*/
readonly justificationRequiredOnApproval: pulumi.Output<boolean | undefined>;
/**
* Flag to indicate whether sending mails to reviewers and the review creator is enabled.
*/
readonly mailNotificationsEnabled: pulumi.Output<boolean | undefined>;
/**
* The access review schedule definition unique id.
*/
readonly name: pulumi.Output<string>;
/**
* The identity id
*/
readonly principalId: pulumi.Output<string>;
/**
* The identity display name
*/
readonly principalName: pulumi.Output<string>;
/**
* The identity type : user/servicePrincipal
*/
readonly principalType: pulumi.Output<string>;
/**
* Access Review schedule definition recurrence range.
*/
readonly range: pulumi.Output<outputs.authorization.AccessReviewRecurrenceRangeResponse | undefined>;
/**
* 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: pulumi.Output<string | undefined>;
/**
* Flag to indicate whether showing recommendations to reviewers is enabled.
*/
readonly recommendationsEnabled: pulumi.Output<boolean | undefined>;
/**
* Flag to indicate whether sending reminder emails to reviewers are enabled.
*/
readonly reminderNotificationsEnabled: pulumi.Output<boolean | undefined>;
/**
* This is the collection of reviewers.
*/
readonly reviewers: pulumi.Output<outputs.authorization.AccessReviewReviewerResponse[] | undefined>;
/**
* 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: pulumi.Output<string>;
/**
* This is used to define what to include in scope of the review. The scope definition includes the resourceId and roleDefinitionId.
*/
readonly scope: pulumi.Output<outputs.authorization.AccessReviewScopeResponse>;
/**
* This read-only field specifies the status of an accessReview.
*/
readonly status: pulumi.Output<string>;
/**
* The resource type.
*/
readonly type: pulumi.Output<string>;
/**
* The user principal name(if valid)
*/
readonly userPrincipalName: pulumi.Output<string>;
/**
* Create a AccessReviewScheduleDefinitionById resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: AccessReviewScheduleDefinitionByIdArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a AccessReviewScheduleDefinitionById resource.
*/
export interface AccessReviewScheduleDefinitionByIdArgs {
/**
* 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.
*/
autoApplyDecisionsEnabled?: pulumi.Input<boolean>;
/**
* This is the collection of backup reviewers.
*/
backupReviewers?: pulumi.Input<pulumi.Input<inputs.authorization.AccessReviewReviewerArgs>[]>;
/**
* This specifies the behavior for the autoReview feature when an access review completes.
*/
defaultDecision?: pulumi.Input<string | enums.authorization.DefaultDecisionType>;
/**
* Flag to indicate whether reviewers are required to provide a justification when reviewing access.
*/
defaultDecisionEnabled?: pulumi.Input<boolean>;
/**
* The description provided by the access review creator and visible to admins.
*/
descriptionForAdmins?: pulumi.Input<string>;
/**
* The description provided by the access review creator to be shown to reviewers.
*/
descriptionForReviewers?: pulumi.Input<string>;
/**
* The display name for the schedule definition.
*/
displayName?: pulumi.Input<string>;
/**
* This is used to indicate the resource id(s) to exclude
*/
excludeResourceId?: pulumi.Input<string>;
/**
* This is used to indicate the role definition id(s) to exclude
*/
excludeRoleDefinitionId?: pulumi.Input<string>;
/**
* Flag to indicate whether to expand nested memberships or not.
*/
expandNestedMemberships?: pulumi.Input<boolean>;
/**
* 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))
*/
inactiveDuration?: pulumi.Input<string>;
/**
* Flag to indicate whether to expand nested memberships or not.
*/
includeAccessBelowResource?: pulumi.Input<boolean>;
/**
* Flag to indicate whether to expand nested memberships or not.
*/
includeInheritedAccess?: pulumi.Input<boolean>;
/**
* The duration in days for an instance.
*/
instanceDurationInDays?: pulumi.Input<number>;
/**
* This is the collection of instances returned when one does an expand on it.
*/
instances?: pulumi.Input<pulumi.Input<inputs.authorization.AccessReviewInstanceArgs>[]>;
/**
* The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.
*/
interval?: pulumi.Input<number>;
/**
* Flag to indicate whether the reviewer is required to pass justification when recording a decision.
*/
justificationRequiredOnApproval?: pulumi.Input<boolean>;
/**
* Flag to indicate whether sending mails to reviewers and the review creator is enabled.
*/
mailNotificationsEnabled?: pulumi.Input<boolean>;
/**
* Access Review schedule definition recurrence range.
*/
range?: pulumi.Input<inputs.authorization.AccessReviewRecurrenceRangeArgs>;
/**
* 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))
*/
recommendationLookBackDuration?: pulumi.Input<string>;
/**
* Flag to indicate whether showing recommendations to reviewers is enabled.
*/
recommendationsEnabled?: pulumi.Input<boolean>;
/**
* Flag to indicate whether sending reminder emails to reviewers are enabled.
*/
reminderNotificationsEnabled?: pulumi.Input<boolean>;
/**
* This is the collection of reviewers.
*/
reviewers?: pulumi.Input<pulumi.Input<inputs.authorization.AccessReviewReviewerArgs>[]>;
/**
* The id of the access review schedule definition.
*/
scheduleDefinitionId?: pulumi.Input<string>;
/**
* The recurrence type : weekly, monthly, etc.
*/
type?: pulumi.Input<string | enums.authorization.AccessReviewRecurrencePatternType>;
}