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.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
azure-native.authorization.getAccessReviewHistoryDefinitionById
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.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
Get access review history definition by definition Id Azure REST API version: 2021-12-01-preview.
Using getAccessReviewHistoryDefinitionById
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 getAccessReviewHistoryDefinitionById(args: GetAccessReviewHistoryDefinitionByIdArgs, opts?: InvokeOptions): Promise<GetAccessReviewHistoryDefinitionByIdResult>
function getAccessReviewHistoryDefinitionByIdOutput(args: GetAccessReviewHistoryDefinitionByIdOutputArgs, opts?: InvokeOptions): Output<GetAccessReviewHistoryDefinitionByIdResult>
def get_access_review_history_definition_by_id(history_definition_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetAccessReviewHistoryDefinitionByIdResult
def get_access_review_history_definition_by_id_output(history_definition_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetAccessReviewHistoryDefinitionByIdResult]
func LookupAccessReviewHistoryDefinitionById(ctx *Context, args *LookupAccessReviewHistoryDefinitionByIdArgs, opts ...InvokeOption) (*LookupAccessReviewHistoryDefinitionByIdResult, error)
func LookupAccessReviewHistoryDefinitionByIdOutput(ctx *Context, args *LookupAccessReviewHistoryDefinitionByIdOutputArgs, opts ...InvokeOption) LookupAccessReviewHistoryDefinitionByIdResultOutput
> Note: This function is named LookupAccessReviewHistoryDefinitionById
in the Go SDK.
public static class GetAccessReviewHistoryDefinitionById
{
public static Task<GetAccessReviewHistoryDefinitionByIdResult> InvokeAsync(GetAccessReviewHistoryDefinitionByIdArgs args, InvokeOptions? opts = null)
public static Output<GetAccessReviewHistoryDefinitionByIdResult> Invoke(GetAccessReviewHistoryDefinitionByIdInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAccessReviewHistoryDefinitionByIdResult> getAccessReviewHistoryDefinitionById(GetAccessReviewHistoryDefinitionByIdArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:authorization:getAccessReviewHistoryDefinitionById
arguments:
# arguments dictionary
The following arguments are supported:
- History
Definition stringId - The id of the access review history definition.
- History
Definition stringId - The id of the access review history definition.
- history
Definition StringId - The id of the access review history definition.
- history
Definition stringId - The id of the access review history definition.
- history_
definition_ strid - The id of the access review history definition.
- history
Definition StringId - The id of the access review history definition.
getAccessReviewHistoryDefinitionById Result
The following output properties are available:
- Created
Date stringTime - Date time when history definition was created
- Id string
- The access review history definition id.
- Name string
- The access review history definition unique id.
- Principal
Id string - The identity id
- Principal
Name string - The identity display name
- Principal
Type string - The identity type : user/servicePrincipal
- Review
History stringPeriod End Date Time - Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports.
- Review
History stringPeriod Start Date Time - Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports.
- Status string
- This read-only field specifies the of the requested review history data. This is either requested, in-progress, done or error.
- Type string
- The resource type.
- User
Principal stringName - The user principal name(if valid)
- Decisions List<string>
- Collection of review decisions which the history data should be filtered on. For example if Approve and Deny are supplied the data will only contain review results in which the decision maker approved or denied a review request.
- Display
Name string - The display name for the history definition.
- End
Date string - The DateTime when the review is scheduled to end. Required if type is endDate
- Instances
List<Pulumi.
Azure Native. Authorization. Outputs. Access Review History Instance Response> - Set of access review history instances for this history definition.
- Interval int
- The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.
- Number
Of intOccurrences - The number of times to repeat the access review. Required and must be positive if type is numbered.
- Scopes
List<Pulumi.
Azure Native. Authorization. Outputs. Access Review Scope Response> - A collection of scopes used when selecting review history data
- Start
Date string - The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
- Created
Date stringTime - Date time when history definition was created
- Id string
- The access review history definition id.
- Name string
- The access review history definition unique id.
- Principal
Id string - The identity id
- Principal
Name string - The identity display name
- Principal
Type string - The identity type : user/servicePrincipal
- Review
History stringPeriod End Date Time - Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports.
- Review
History stringPeriod Start Date Time - Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports.
- Status string
- This read-only field specifies the of the requested review history data. This is either requested, in-progress, done or error.
- Type string
- The resource type.
- User
Principal stringName - The user principal name(if valid)
- Decisions []string
- Collection of review decisions which the history data should be filtered on. For example if Approve and Deny are supplied the data will only contain review results in which the decision maker approved or denied a review request.
- Display
Name string - The display name for the history definition.
- End
Date string - The DateTime when the review is scheduled to end. Required if type is endDate
- Instances
[]Access
Review History Instance Response - Set of access review history instances for this history definition.
- Interval int
- The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.
- Number
Of intOccurrences - The number of times to repeat the access review. Required and must be positive if type is numbered.
- Scopes
[]Access
Review Scope Response - A collection of scopes used when selecting review history data
- Start
Date string - The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
- created
Date StringTime - Date time when history definition was created
- id String
- The access review history definition id.
- name String
- The access review history definition unique id.
- principal
Id String - The identity id
- principal
Name String - The identity display name
- principal
Type String - The identity type : user/servicePrincipal
- review
History StringPeriod End Date Time - Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports.
- review
History StringPeriod Start Date Time - Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports.
- status String
- This read-only field specifies the of the requested review history data. This is either requested, in-progress, done or error.
- type String
- The resource type.
- user
Principal StringName - The user principal name(if valid)
- decisions List<String>
- Collection of review decisions which the history data should be filtered on. For example if Approve and Deny are supplied the data will only contain review results in which the decision maker approved or denied a review request.
- display
Name String - The display name for the history definition.
- end
Date String - The DateTime when the review is scheduled to end. Required if type is endDate
- instances
List<Access
Review History Instance Response> - Set of access review history instances for this history definition.
- interval Integer
- The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.
- number
Of IntegerOccurrences - The number of times to repeat the access review. Required and must be positive if type is numbered.
- scopes
List<Access
Review Scope Response> - A collection of scopes used when selecting review history data
- start
Date String - The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
- created
Date stringTime - Date time when history definition was created
- id string
- The access review history definition id.
- name string
- The access review history definition unique id.
- principal
Id string - The identity id
- principal
Name string - The identity display name
- principal
Type string - The identity type : user/servicePrincipal
- review
History stringPeriod End Date Time - Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports.
- review
History stringPeriod Start Date Time - Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports.
- status string
- This read-only field specifies the of the requested review history data. This is either requested, in-progress, done or error.
- type string
- The resource type.
- user
Principal stringName - The user principal name(if valid)
- decisions string[]
- Collection of review decisions which the history data should be filtered on. For example if Approve and Deny are supplied the data will only contain review results in which the decision maker approved or denied a review request.
- display
Name string - The display name for the history definition.
- end
Date string - The DateTime when the review is scheduled to end. Required if type is endDate
- instances
Access
Review History Instance Response[] - Set of access review history instances for this history definition.
- interval number
- The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.
- number
Of numberOccurrences - The number of times to repeat the access review. Required and must be positive if type is numbered.
- scopes
Access
Review Scope Response[] - A collection of scopes used when selecting review history data
- start
Date string - The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
- created_
date_ strtime - Date time when history definition was created
- id str
- The access review history definition id.
- name str
- The access review history definition unique id.
- principal_
id str - The identity id
- principal_
name str - The identity display name
- principal_
type str - The identity type : user/servicePrincipal
- review_
history_ strperiod_ end_ date_ time - Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports.
- review_
history_ strperiod_ start_ date_ time - Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports.
- status str
- This read-only field specifies the of the requested review history data. This is either requested, in-progress, done or error.
- type str
- The resource type.
- user_
principal_ strname - The user principal name(if valid)
- decisions Sequence[str]
- Collection of review decisions which the history data should be filtered on. For example if Approve and Deny are supplied the data will only contain review results in which the decision maker approved or denied a review request.
- display_
name str - The display name for the history definition.
- end_
date str - The DateTime when the review is scheduled to end. Required if type is endDate
- instances
Sequence[Access
Review History Instance Response] - Set of access review history instances for this history definition.
- interval int
- The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.
- number_
of_ intoccurrences - The number of times to repeat the access review. Required and must be positive if type is numbered.
- scopes
Sequence[Access
Review Scope Response] - A collection of scopes used when selecting review history data
- start_
date str - The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
- created
Date StringTime - Date time when history definition was created
- id String
- The access review history definition id.
- name String
- The access review history definition unique id.
- principal
Id String - The identity id
- principal
Name String - The identity display name
- principal
Type String - The identity type : user/servicePrincipal
- review
History StringPeriod End Date Time - Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports.
- review
History StringPeriod Start Date Time - Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports.
- status String
- This read-only field specifies the of the requested review history data. This is either requested, in-progress, done or error.
- type String
- The resource type.
- user
Principal StringName - The user principal name(if valid)
- decisions List<String>
- Collection of review decisions which the history data should be filtered on. For example if Approve and Deny are supplied the data will only contain review results in which the decision maker approved or denied a review request.
- display
Name String - The display name for the history definition.
- end
Date String - The DateTime when the review is scheduled to end. Required if type is endDate
- instances List<Property Map>
- Set of access review history instances for this history definition.
- interval Number
- The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.
- number
Of NumberOccurrences - The number of times to repeat the access review. Required and must be positive if type is numbered.
- scopes List<Property Map>
- A collection of scopes used when selecting review history data
- 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
AccessReviewHistoryInstanceResponse
- Download
Uri string - Uri which can be used to retrieve review history data. To generate this Uri, generateDownloadUri() must be called for a specific accessReviewHistoryDefinitionInstance. The link expires after a 24 hour period. Callers can see the expiration date time by looking at the 'se' parameter in the generated uri.
- Id string
- The access review history definition instance id.
- Name string
- The access review history definition instance unique id.
- Status string
- Status of the requested review history instance data. This is either requested, in-progress, done or error. The state transitions are as follows - Requested -> InProgress -> Done -> Expired
- Type string
- The resource type.
- Display
Name string - The display name for the parent history definition.
- Expiration string
- Date time when history data report expires and the associated data is deleted.
- Fulfilled
Date stringTime - Date time when the history data report is scheduled to be generated.
- Review
History stringPeriod End Date Time - Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports.
- Review
History stringPeriod Start Date Time - Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports.
- Run
Date stringTime - Date time when the history data report is scheduled to be generated.
- Download
Uri string - Uri which can be used to retrieve review history data. To generate this Uri, generateDownloadUri() must be called for a specific accessReviewHistoryDefinitionInstance. The link expires after a 24 hour period. Callers can see the expiration date time by looking at the 'se' parameter in the generated uri.
- Id string
- The access review history definition instance id.
- Name string
- The access review history definition instance unique id.
- Status string
- Status of the requested review history instance data. This is either requested, in-progress, done or error. The state transitions are as follows - Requested -> InProgress -> Done -> Expired
- Type string
- The resource type.
- Display
Name string - The display name for the parent history definition.
- Expiration string
- Date time when history data report expires and the associated data is deleted.
- Fulfilled
Date stringTime - Date time when the history data report is scheduled to be generated.
- Review
History stringPeriod End Date Time - Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports.
- Review
History stringPeriod Start Date Time - Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports.
- Run
Date stringTime - Date time when the history data report is scheduled to be generated.
- download
Uri String - Uri which can be used to retrieve review history data. To generate this Uri, generateDownloadUri() must be called for a specific accessReviewHistoryDefinitionInstance. The link expires after a 24 hour period. Callers can see the expiration date time by looking at the 'se' parameter in the generated uri.
- id String
- The access review history definition instance id.
- name String
- The access review history definition instance unique id.
- status String
- Status of the requested review history instance data. This is either requested, in-progress, done or error. The state transitions are as follows - Requested -> InProgress -> Done -> Expired
- type String
- The resource type.
- display
Name String - The display name for the parent history definition.
- expiration String
- Date time when history data report expires and the associated data is deleted.
- fulfilled
Date StringTime - Date time when the history data report is scheduled to be generated.
- review
History StringPeriod End Date Time - Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports.
- review
History StringPeriod Start Date Time - Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports.
- run
Date StringTime - Date time when the history data report is scheduled to be generated.
- download
Uri string - Uri which can be used to retrieve review history data. To generate this Uri, generateDownloadUri() must be called for a specific accessReviewHistoryDefinitionInstance. The link expires after a 24 hour period. Callers can see the expiration date time by looking at the 'se' parameter in the generated uri.
- id string
- The access review history definition instance id.
- name string
- The access review history definition instance unique id.
- status string
- Status of the requested review history instance data. This is either requested, in-progress, done or error. The state transitions are as follows - Requested -> InProgress -> Done -> Expired
- type string
- The resource type.
- display
Name string - The display name for the parent history definition.
- expiration string
- Date time when history data report expires and the associated data is deleted.
- fulfilled
Date stringTime - Date time when the history data report is scheduled to be generated.
- review
History stringPeriod End Date Time - Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports.
- review
History stringPeriod Start Date Time - Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports.
- run
Date stringTime - Date time when the history data report is scheduled to be generated.
- download_
uri str - Uri which can be used to retrieve review history data. To generate this Uri, generateDownloadUri() must be called for a specific accessReviewHistoryDefinitionInstance. The link expires after a 24 hour period. Callers can see the expiration date time by looking at the 'se' parameter in the generated uri.
- id str
- The access review history definition instance id.
- name str
- The access review history definition instance unique id.
- status str
- Status of the requested review history instance data. This is either requested, in-progress, done or error. The state transitions are as follows - Requested -> InProgress -> Done -> Expired
- type str
- The resource type.
- display_
name str - The display name for the parent history definition.
- expiration str
- Date time when history data report expires and the associated data is deleted.
- fulfilled_
date_ strtime - Date time when the history data report is scheduled to be generated.
- review_
history_ strperiod_ end_ date_ time - Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports.
- review_
history_ strperiod_ start_ date_ time - Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports.
- run_
date_ strtime - Date time when the history data report is scheduled to be generated.
- download
Uri String - Uri which can be used to retrieve review history data. To generate this Uri, generateDownloadUri() must be called for a specific accessReviewHistoryDefinitionInstance. The link expires after a 24 hour period. Callers can see the expiration date time by looking at the 'se' parameter in the generated uri.
- id String
- The access review history definition instance id.
- name String
- The access review history definition instance unique id.
- status String
- Status of the requested review history instance data. This is either requested, in-progress, done or error. The state transitions are as follows - Requested -> InProgress -> Done -> Expired
- type String
- The resource type.
- display
Name String - The display name for the parent history definition.
- expiration String
- Date time when history data report expires and the associated data is deleted.
- fulfilled
Date StringTime - Date time when the history data report is scheduled to be generated.
- review
History StringPeriod End Date Time - Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports.
- review
History StringPeriod Start Date Time - Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports.
- run
Date StringTime - Date time when the history data report is scheduled to be generated.
AccessReviewScopeResponse
- Assignment
State string - The role assignment state eligible/active to review
- Principal
Type string - The identity type user/servicePrincipal to review
- Resource
Id string - ResourceId in which this review is getting created
- Role
Definition stringId - This is used to indicate the role being reviewed
- Exclude
Resource stringId - This is used to indicate the resource id(s) to exclude
- Exclude
Role stringDefinition 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 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))
- 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.
- Assignment
State string - The role assignment state eligible/active to review
- Principal
Type string - The identity type user/servicePrincipal to review
- Resource
Id string - ResourceId in which this review is getting created
- Role
Definition stringId - This is used to indicate the role being reviewed
- Exclude
Resource stringId - This is used to indicate the resource id(s) to exclude
- Exclude
Role stringDefinition 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 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))
- 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.
- assignment
State String - The role assignment state eligible/active to review
- principal
Type String - The identity type user/servicePrincipal to review
- resource
Id String - ResourceId in which this review is getting created
- role
Definition StringId - This is used to indicate the role being reviewed
- exclude
Resource StringId - This is used to indicate the resource id(s) to exclude
- exclude
Role StringDefinition Id - This is used to indicate the role definition id(s) to exclude
- expand
Nested BooleanMemberships - Flag to indicate whether to expand nested memberships or not.
- 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))
- include
Access BooleanBelow Resource - Flag to indicate whether to expand nested memberships or not.
- include
Inherited BooleanAccess - Flag to indicate whether to expand nested memberships or not.
- assignment
State string - The role assignment state eligible/active to review
- principal
Type string - The identity type user/servicePrincipal to review
- resource
Id string - ResourceId in which this review is getting created
- role
Definition stringId - This is used to indicate the role being reviewed
- exclude
Resource stringId - This is used to indicate the resource id(s) to exclude
- exclude
Role stringDefinition Id - This is used to indicate the role definition id(s) to exclude
- expand
Nested booleanMemberships - Flag to indicate whether to expand nested memberships or not.
- 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))
- include
Access booleanBelow Resource - Flag to indicate whether to expand nested memberships or not.
- include
Inherited booleanAccess - Flag to indicate whether to expand nested memberships or not.
- assignment_
state str - The role assignment state eligible/active to review
- principal_
type str - The identity type user/servicePrincipal to review
- resource_
id str - ResourceId in which this review is getting created
- role_
definition_ strid - This is used to indicate the role being reviewed
- 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.
- assignment
State String - The role assignment state eligible/active to review
- principal
Type String - The identity type user/servicePrincipal to review
- resource
Id String - ResourceId in which this review is getting created
- role
Definition StringId - This is used to indicate the role being reviewed
- exclude
Resource StringId - This is used to indicate the resource id(s) to exclude
- exclude
Role StringDefinition Id - This is used to indicate the role definition id(s) to exclude
- expand
Nested BooleanMemberships - Flag to indicate whether to expand nested memberships or not.
- 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))
- include
Access BooleanBelow Resource - Flag to indicate whether to expand nested memberships or not.
- include
Inherited BooleanAccess - Flag to indicate whether to expand nested memberships or not.
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.63.0 published on Tuesday, Sep 24, 2024 by Pulumi