Azure Native v1.102.0, May 2 23

azure-native.authorization.getAccessReviewScheduleDefinitionById

Explore with Pulumi AI

Get single access review definition API Version: 2021-03-01-preview.

Using getAccessReviewScheduleDefinitionById

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 getAccessReviewScheduleDefinitionById(args: GetAccessReviewScheduleDefinitionByIdArgs, opts?: InvokeOptions): Promise<GetAccessReviewScheduleDefinitionByIdResult>
function getAccessReviewScheduleDefinitionByIdOutput(args: GetAccessReviewScheduleDefinitionByIdOutputArgs, opts?: InvokeOptions): Output<GetAccessReviewScheduleDefinitionByIdResult>

def get_access_review_schedule_definition_by_id(schedule_definition_id: Optional[str] = None,
                                                opts: Optional[InvokeOptions] = None) -> GetAccessReviewScheduleDefinitionByIdResult
def get_access_review_schedule_definition_by_id_output(schedule_definition_id: Optional[pulumi.Input[str]] = None,
                                                opts: Optional[InvokeOptions] = None) -> Output[GetAccessReviewScheduleDefinitionByIdResult]

func LookupAccessReviewScheduleDefinitionById(ctx *Context, args *LookupAccessReviewScheduleDefinitionByIdArgs, opts ...InvokeOption) (*LookupAccessReviewScheduleDefinitionByIdResult, error)
func LookupAccessReviewScheduleDefinitionByIdOutput(ctx *Context, args *LookupAccessReviewScheduleDefinitionByIdOutputArgs, opts ...InvokeOption) LookupAccessReviewScheduleDefinitionByIdResultOutput

> Note: This function is named LookupAccessReviewScheduleDefinitionById in the Go SDK.

public static class GetAccessReviewScheduleDefinitionById 
{
    public static Task<GetAccessReviewScheduleDefinitionByIdResult> InvokeAsync(GetAccessReviewScheduleDefinitionByIdArgs args, InvokeOptions? opts = null)
    public static Output<GetAccessReviewScheduleDefinitionByIdResult> Invoke(GetAccessReviewScheduleDefinitionByIdInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAccessReviewScheduleDefinitionByIdResult> getAccessReviewScheduleDefinitionById(GetAccessReviewScheduleDefinitionByIdArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:authorization:getAccessReviewScheduleDefinitionById
  arguments:
    # arguments dictionary

The following arguments are supported:

ScheduleDefinitionId string: The id of the access review schedule definition.

ScheduleDefinitionId string: The id of the access review schedule definition.

scheduleDefinitionId String: The id of the access review schedule definition.

scheduleDefinitionId string: The id of the access review schedule definition.

schedule_definition_id str: The id of the access review schedule definition.

scheduleDefinitionId String: The id of the access review schedule definition.

getAccessReviewScheduleDefinitionById 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.
RoleDefinitionId string: 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.
UserPrincipalName string: The user principal name(if valid)
AutoApplyDecisionsEnabled bool: 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.AzureNative.Authorization.Outputs.AccessReviewReviewerResponse>: This is the collection of backup reviewers.
DefaultDecision string: This specifies the behavior for the autoReview feature when an access review completes.
DefaultDecisionEnabled bool: Flag to indicate whether reviewers are required to provide a justification when reviewing access.
DescriptionForAdmins string: The description provided by the access review creator and visible to admins.
DescriptionForReviewers string: 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
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))
InstanceDurationInDays int: The duration in days for an instance.
Instances List<Pulumi.AzureNative.Authorization.Outputs.AccessReviewInstanceResponse>: 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.
JustificationRequiredOnApproval bool: Flag to indicate whether the reviewer is required to pass justification when recording a decision.
MailNotificationsEnabled bool: Flag to indicate whether sending mails to reviewers and the review creator is enabled.
NumberOfOccurrences int: The number of times to repeat the access review. Required and must be positive if type is numbered.
RecommendationsEnabled bool: Flag to indicate whether showing recommendations to reviewers is enabled.
ReminderNotificationsEnabled bool: Flag to indicate whether sending reminder emails to reviewers are enabled.
Reviewers List<Pulumi.AzureNative.Authorization.Outputs.AccessReviewReviewerResponse>: 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.
RoleDefinitionId string: 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.
UserPrincipalName string: The user principal name(if valid)
AutoApplyDecisionsEnabled bool: 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 []AccessReviewReviewerResponse: This is the collection of backup reviewers.
DefaultDecision string: This specifies the behavior for the autoReview feature when an access review completes.
DefaultDecisionEnabled bool: Flag to indicate whether reviewers are required to provide a justification when reviewing access.
DescriptionForAdmins string: The description provided by the access review creator and visible to admins.
DescriptionForReviewers string: 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
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))
InstanceDurationInDays int: The duration in days for an instance.
Instances []AccessReviewInstanceResponse: 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.
JustificationRequiredOnApproval bool: Flag to indicate whether the reviewer is required to pass justification when recording a decision.
MailNotificationsEnabled bool: Flag to indicate whether sending mails to reviewers and the review creator is enabled.
NumberOfOccurrences int: The number of times to repeat the access review. Required and must be positive if type is numbered.
RecommendationsEnabled bool: Flag to indicate whether showing recommendations to reviewers is enabled.
ReminderNotificationsEnabled bool: Flag to indicate whether sending reminder emails to reviewers are enabled.
Reviewers []AccessReviewReviewerResponse: 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.
roleDefinitionId String: 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.
userPrincipalName String: The user principal name(if valid)
autoApplyDecisionsEnabled Boolean: 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<AccessReviewReviewerResponse>: This is the collection of backup reviewers.
defaultDecision String: This specifies the behavior for the autoReview feature when an access review completes.
defaultDecisionEnabled Boolean: Flag to indicate whether reviewers are required to provide a justification when reviewing access.
descriptionForAdmins String: The description provided by the access review creator and visible to admins.
descriptionForReviewers String: 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
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))
instanceDurationInDays Integer: The duration in days for an instance.
instances List<AccessReviewInstanceResponse>: 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.
justificationRequiredOnApproval Boolean: Flag to indicate whether the reviewer is required to pass justification when recording a decision.
mailNotificationsEnabled Boolean: Flag to indicate whether sending mails to reviewers and the review creator is enabled.
numberOfOccurrences Integer: The number of times to repeat the access review. Required and must be positive if type is numbered.
recommendationsEnabled Boolean: Flag to indicate whether showing recommendations to reviewers is enabled.
reminderNotificationsEnabled Boolean: Flag to indicate whether sending reminder emails to reviewers are enabled.
reviewers List<AccessReviewReviewerResponse>: 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.
roleDefinitionId string: 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.
userPrincipalName string: The user principal name(if valid)
autoApplyDecisionsEnabled boolean: 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 AccessReviewReviewerResponse[]: This is the collection of backup reviewers.
defaultDecision string: This specifies the behavior for the autoReview feature when an access review completes.
defaultDecisionEnabled boolean: Flag to indicate whether reviewers are required to provide a justification when reviewing access.
descriptionForAdmins string: The description provided by the access review creator and visible to admins.
descriptionForReviewers string: 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
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))
instanceDurationInDays number: The duration in days for an instance.
instances AccessReviewInstanceResponse[]: 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.
justificationRequiredOnApproval boolean: Flag to indicate whether the reviewer is required to pass justification when recording a decision.
mailNotificationsEnabled boolean: Flag to indicate whether sending mails to reviewers and the review creator is enabled.
numberOfOccurrences number: The number of times to repeat the access review. Required and must be positive if type is numbered.
recommendationsEnabled boolean: Flag to indicate whether showing recommendations to reviewers is enabled.
reminderNotificationsEnabled boolean: Flag to indicate whether sending reminder emails to reviewers are enabled.
reviewers AccessReviewReviewerResponse[]: 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_id str: 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_name str: The user principal name(if valid)
auto_apply_decisions_enabled bool: 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[AccessReviewReviewerResponse]: 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_enabled bool: Flag to indicate whether reviewers are required to provide a justification when reviewing access.
description_for_admins str: The description provided by the access review creator and visible to admins.
description_for_reviewers str: 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
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))
instance_duration_in_days int: The duration in days for an instance.
instances Sequence[AccessReviewInstanceResponse]: 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_on_approval bool: Flag to indicate whether the reviewer is required to pass justification when recording a decision.
mail_notifications_enabled bool: Flag to indicate whether sending mails to reviewers and the review creator is enabled.
number_of_occurrences int: The number of times to repeat the access review. Required and must be positive if type is numbered.
recommendations_enabled bool: Flag to indicate whether showing recommendations to reviewers is enabled.
reminder_notifications_enabled bool: Flag to indicate whether sending reminder emails to reviewers are enabled.
reviewers Sequence[AccessReviewReviewerResponse]: 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.
roleDefinitionId String: 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.
userPrincipalName String: The user principal name(if valid)
autoApplyDecisionsEnabled Boolean: 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.
defaultDecisionEnabled Boolean: Flag to indicate whether reviewers are required to provide a justification when reviewing access.
descriptionForAdmins String: The description provided by the access review creator and visible to admins.
descriptionForReviewers String: 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
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))
instanceDurationInDays Number: 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.
justificationRequiredOnApproval Boolean: Flag to indicate whether the reviewer is required to pass justification when recording a decision.
mailNotificationsEnabled Boolean: Flag to indicate whether sending mails to reviewers and the review creator is enabled.
numberOfOccurrences Number: The number of times to repeat the access review. Required and must be positive if type is numbered.
recommendationsEnabled Boolean: Flag to indicate whether showing recommendations to reviewers is enabled.
reminderNotificationsEnabled Boolean: 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.AzureNative.Authorization.Inputs.AccessReviewReviewerResponse>: This is the collection of backup reviewers.
EndDateTime string: The DateTime when the review instance is scheduled to end.
Reviewers List<Pulumi.AzureNative.Authorization.Inputs.AccessReviewReviewerResponse>: This is the collection of reviewers.
StartDateTime string: 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 []AccessReviewReviewerResponse: This is the collection of backup reviewers.
EndDateTime string: The DateTime when the review instance is scheduled to end.
Reviewers []AccessReviewReviewerResponse: This is the collection of reviewers.
StartDateTime string: 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<AccessReviewReviewerResponse>: This is the collection of backup reviewers.
endDateTime String: The DateTime when the review instance is scheduled to end.
reviewers List<AccessReviewReviewerResponse>: This is the collection of reviewers.
startDateTime String: 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 AccessReviewReviewerResponse[]: This is the collection of backup reviewers.
endDateTime string: The DateTime when the review instance is scheduled to end.
reviewers AccessReviewReviewerResponse[]: This is the collection of reviewers.
startDateTime string: 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[AccessReviewReviewerResponse]: This is the collection of backup reviewers.
end_date_time str: The DateTime when the review instance is scheduled to end.
reviewers Sequence[AccessReviewReviewerResponse]: This is the collection of reviewers.
start_date_time str: 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.
endDateTime String: The DateTime when the review instance is scheduled to end.
reviewers List<Property Map>: This is the collection of reviewers.
startDateTime String: 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