Azure Native v1.102.0, May 2 23
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:
- Schedule
Definition stringId The id of the access review schedule definition.
- Schedule
Definition stringId The id of the access review schedule definition.
- schedule
Definition StringId The id of the access review schedule definition.
- schedule
Definition stringId The id of the access review schedule definition.
- schedule_
definition_ strid The id of the access review schedule definition.
- schedule
Definition StringId The id of the access review schedule definition.
getAccessReviewScheduleDefinitionById Result
The following output properties are available:
- Assignment
State 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.
- Principal
Id string The identity id
- Principal
Name string The identity display name
- Principal
Type string The identity type user/servicePrincipal to review
- Resource
Id string ResourceId in which this review is getting created
- Reviewers
Type 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.
- Role
Definition 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.
- User
Principal stringName 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 List<Pulumi.Azure Native. Authorization. Outputs. Access Review Reviewer Response> This is the collection of backup reviewers.
- Default
Decision string 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 stringAdmins The description provided by the access review creator and visible to admins.
- Description
For stringReviewers The description provided by the access review creator to be shown to reviewers.
- Display
Name string The display name for the schedule definition.
- End
Date string The DateTime when the review is scheduled to end. Required if type is endDate
- Inactive
Duration 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))
- Instance
Duration 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.
- 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.
- 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
List<Pulumi.
Azure Native. Authorization. Outputs. Access Review Reviewer Response> This is the collection of reviewers.
- Start
Date string The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
- Assignment
State 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.
- Principal
Id string The identity id
- Principal
Name string The identity display name
- Principal
Type string The identity type user/servicePrincipal to review
- Resource
Id string ResourceId in which this review is getting created
- Reviewers
Type 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.
- Role
Definition 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.
- User
Principal stringName 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 []AccessReview Reviewer Response This is the collection of backup reviewers.
- Default
Decision string 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 stringAdmins The description provided by the access review creator and visible to admins.
- Description
For stringReviewers The description provided by the access review creator to be shown to reviewers.
- Display
Name string The display name for the schedule definition.
- End
Date string The DateTime when the review is scheduled to end. Required if type is endDate
- Inactive
Duration 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))
- Instance
Duration intIn Days The duration in days for an instance.
- Instances
[]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.
- 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.
- 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
[]Access
Review Reviewer Response This is the collection of reviewers.
- Start
Date string The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
- assignment
State 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.
- principal
Id String The identity id
- principal
Name String The identity display name
- principal
Type String The identity type user/servicePrincipal to review
- resource
Id String ResourceId in which this review is getting created
- reviewers
Type 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.
- role
Definition 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.
- user
Principal StringName The user principal name(if valid)
- auto
Apply 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.
- backup
Reviewers List<AccessReview Reviewer Response> This is the collection of backup reviewers.
- default
Decision String This specifies the behavior for the autoReview feature when an access review completes.
- default
Decision BooleanEnabled Flag to indicate whether reviewers are required to provide a justification when reviewing access.
- description
For StringAdmins The description provided by the access review creator and visible to admins.
- description
For StringReviewers The description provided by the access review creator to be shown to reviewers.
- display
Name String The display name for the schedule definition.
- end
Date String The DateTime when the review is scheduled to end. Required if type is endDate
- inactive
Duration 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))
- instance
Duration IntegerIn Days The duration in days for an instance.
- instances
List<Access
Review 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.
- justification
Required BooleanOn Approval Flag to indicate whether the reviewer is required to pass justification when recording a decision.
- mail
Notifications BooleanEnabled Flag to indicate whether sending mails to reviewers and the review creator is enabled.
- number
Of IntegerOccurrences The number of times to repeat the access review. Required and must be positive if type is numbered.
- recommendations
Enabled Boolean Flag to indicate whether showing recommendations to reviewers is enabled.
- reminder
Notifications BooleanEnabled Flag to indicate whether sending reminder emails to reviewers are enabled.
- reviewers
List<Access
Review Reviewer Response> This is the collection of reviewers.
- start
Date String The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
- assignment
State 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.
- principal
Id string The identity id
- principal
Name string The identity display name
- principal
Type string The identity type user/servicePrincipal to review
- resource
Id string ResourceId in which this review is getting created
- reviewers
Type 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.
- role
Definition 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.
- user
Principal stringName The user principal name(if valid)
- auto
Apply 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.
- backup
Reviewers AccessReview Reviewer Response[] This is the collection of backup reviewers.
- default
Decision string This specifies the behavior for the autoReview feature when an access review completes.
- default
Decision booleanEnabled Flag to indicate whether reviewers are required to provide a justification when reviewing access.
- description
For stringAdmins The description provided by the access review creator and visible to admins.
- description
For stringReviewers The description provided by the access review creator to be shown to reviewers.
- display
Name string The display name for the schedule definition.
- end
Date string The DateTime when the review is scheduled to end. Required if type is endDate
- inactive
Duration 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))
- instance
Duration numberIn Days The duration in days for an instance.
- instances
Access
Review 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.
- justification
Required booleanOn Approval Flag to indicate whether the reviewer is required to pass justification when recording a decision.
- mail
Notifications booleanEnabled Flag to indicate whether sending mails to reviewers and the review creator is enabled.
- number
Of numberOccurrences The number of times to repeat the access review. Required and must be positive if type is numbered.
- recommendations
Enabled boolean Flag to indicate whether showing recommendations to reviewers is enabled.
- reminder
Notifications booleanEnabled Flag to indicate whether sending reminder emails to reviewers are enabled.
- reviewers
Access
Review Reviewer Response[] This is the collection of reviewers.
- start
Date 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
- 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_ intin_ days The duration in days for an instance.
- instances
Sequence[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.
- 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.
- 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[Access
Review 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.
- assignment
State 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.
- principal
Id String The identity id
- principal
Name String The identity display name
- principal
Type String The identity type user/servicePrincipal to review
- resource
Id String ResourceId in which this review is getting created
- reviewers
Type 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.
- role
Definition 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.
- user
Principal StringName The user principal name(if valid)
- auto
Apply 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.
- backup
Reviewers List<Property Map> This is the collection of backup reviewers.
- default
Decision String This specifies the behavior for the autoReview feature when an access review completes.
- default
Decision BooleanEnabled Flag to indicate whether reviewers are required to provide a justification when reviewing access.
- description
For StringAdmins The description provided by the access review creator and visible to admins.
- description
For StringReviewers The description provided by the access review creator to be shown to reviewers.
- display
Name String The display name for the schedule definition.
- end
Date String The DateTime when the review is scheduled to end. Required if type is endDate
- inactive
Duration 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))
- instance
Duration 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.
- justification
Required BooleanOn Approval Flag to indicate whether the reviewer is required to pass justification when recording a decision.
- mail
Notifications BooleanEnabled Flag to indicate whether sending mails to reviewers and the review creator is enabled.
- number
Of NumberOccurrences The number of times to repeat the access review. Required and must be positive if type is numbered.
- recommendations
Enabled Boolean Flag to indicate whether showing recommendations to reviewers is enabled.
- reminder
Notifications BooleanEnabled Flag to indicate whether sending reminder emails to reviewers are enabled.
- reviewers List<Property Map>
This is the collection of reviewers.
- start
Date 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.
- Reviewers
Type 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.
- Backup
Reviewers List<Pulumi.Azure Native. Authorization. Inputs. Access Review Reviewer Response> This is the collection of backup reviewers.
- End
Date 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.
- Start
Date 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.
- Reviewers
Type 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.
- Backup
Reviewers []AccessReview Reviewer Response This is the collection of backup reviewers.
- End
Date stringTime The DateTime when the review instance is scheduled to end.
- Reviewers
[]Access
Review Reviewer Response This is the collection of reviewers.
- Start
Date 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.
- reviewers
Type 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.
- backup
Reviewers List<AccessReview Reviewer Response> This is the collection of backup reviewers.
- end
Date StringTime The DateTime when the review instance is scheduled to end.
- reviewers
List<Access
Review Reviewer Response> This is the collection of reviewers.
- start
Date 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.
- reviewers
Type 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.
- backup
Reviewers AccessReview Reviewer Response[] This is the collection of backup reviewers.
- end
Date stringTime The DateTime when the review instance is scheduled to end.
- reviewers
Access
Review Reviewer Response[] This is the collection of reviewers.
- start
Date 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[Access
Review 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.
- reviewers
Type 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.
- backup
Reviewers List<Property Map> This is the collection of backup reviewers.
- end
Date StringTime The DateTime when the review instance is scheduled to end.
- reviewers List<Property Map>
This is the collection of reviewers.
- start
Date StringTime The DateTime when the review instance is scheduled to be start.
AccessReviewReviewerResponse
- Principal
Type string The identity type : user/servicePrincipal
- Principal
Id string The id of the reviewer(user/servicePrincipal)
- Principal
Type string The identity type : user/servicePrincipal
- Principal
Id string The id of the reviewer(user/servicePrincipal)
- principal
Type String The identity type : user/servicePrincipal
- principal
Id String The id of the reviewer(user/servicePrincipal)
- principal
Type string The identity type : user/servicePrincipal
- principal
Id 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)
- principal
Type String The identity type : user/servicePrincipal
- principal
Id String The id of the reviewer(user/servicePrincipal)
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0