Azure Native v2.90.0, Mar 27 25

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.90.0 published on Thursday, Mar 27, 2025 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.90.0 published on Thursday, Mar 27, 2025 by Pulumi

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.

TypeScript
Python
Go
C#
Java
YAML

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)
public static Output<GetAccessReviewHistoryDefinitionByIdResult> getAccessReviewHistoryDefinitionById(GetAccessReviewHistoryDefinitionByIdArgs args, InvokeOptions options)

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

The following arguments are supported:

HistoryDefinitionId string: The id of the access review history definition.

HistoryDefinitionId string: The id of the access review history definition.

historyDefinitionId String: The id of the access review history definition.

historyDefinitionId string: The id of the access review history definition.

history_definition_id str: The id of the access review history definition.

historyDefinitionId String: The id of the access review history definition.

getAccessReviewHistoryDefinitionById Result

The following output properties are available:

CreatedDateTime string: Date time when history definition was created
Id string: The access review history definition id.
Name string: The access review history definition unique id.
PrincipalId string: The identity id
PrincipalName string: The identity display name
PrincipalType string: The identity type : user/servicePrincipal
ReviewHistoryPeriodEndDateTime string: 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.
ReviewHistoryPeriodStartDateTime string: 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.
UserPrincipalName string: 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.
DisplayName string: The display name for the history definition.
EndDate string: The DateTime when the review is scheduled to end. Required if type is endDate
Instances List<Pulumi.AzureNative.Authorization.Outputs.AccessReviewHistoryInstanceResponse>: 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.
NumberOfOccurrences int: The number of times to repeat the access review. Required and must be positive if type is numbered.
Scopes List<Pulumi.AzureNative.Authorization.Outputs.AccessReviewScopeResponse>: A collection of scopes used when selecting review history data
StartDate string: The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.

CreatedDateTime string: Date time when history definition was created
Id string: The access review history definition id.
Name string: The access review history definition unique id.
PrincipalId string: The identity id
PrincipalName string: The identity display name
PrincipalType string: The identity type : user/servicePrincipal
ReviewHistoryPeriodEndDateTime string: 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.
ReviewHistoryPeriodStartDateTime string: 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.
UserPrincipalName string: 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.
DisplayName string: The display name for the history definition.
EndDate string: The DateTime when the review is scheduled to end. Required if type is endDate
Instances []AccessReviewHistoryInstanceResponse: 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.
NumberOfOccurrences int: The number of times to repeat the access review. Required and must be positive if type is numbered.
Scopes []AccessReviewScopeResponse: A collection of scopes used when selecting review history data
StartDate string: The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.

createdDateTime String: Date time when history definition was created
id String: The access review history definition id.
name String: The access review history definition unique id.
principalId String: The identity id
principalName String: The identity display name
principalType String: The identity type : user/servicePrincipal
reviewHistoryPeriodEndDateTime String: 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.
reviewHistoryPeriodStartDateTime String: 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.
userPrincipalName String: 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.
displayName String: The display name for the history definition.
endDate String: The DateTime when the review is scheduled to end. Required if type is endDate
instances List<AccessReviewHistoryInstanceResponse>: 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.
numberOfOccurrences Integer: The number of times to repeat the access review. Required and must be positive if type is numbered.
scopes List<AccessReviewScopeResponse>: A collection of scopes used when selecting review history data
startDate String: The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.

createdDateTime string: Date time when history definition was created
id string: The access review history definition id.
name string: The access review history definition unique id.
principalId string: The identity id
principalName string: The identity display name
principalType string: The identity type : user/servicePrincipal
reviewHistoryPeriodEndDateTime string: 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.
reviewHistoryPeriodStartDateTime string: 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.
userPrincipalName string: 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.
displayName string: The display name for the history definition.
endDate string: The DateTime when the review is scheduled to end. Required if type is endDate
instances AccessReviewHistoryInstanceResponse[]: 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.
numberOfOccurrences number: The number of times to repeat the access review. Required and must be positive if type is numbered.
scopes AccessReviewScopeResponse[]: A collection of scopes used when selecting review history data
startDate string: The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.

created_date_time str: 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_period_end_date_time str: 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_period_start_date_time str: 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_name str: 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[AccessReviewHistoryInstanceResponse]: 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_occurrences int: The number of times to repeat the access review. Required and must be positive if type is numbered.
scopes Sequence[AccessReviewScopeResponse]: 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.

createdDateTime String: Date time when history definition was created
id String: The access review history definition id.
name String: The access review history definition unique id.
principalId String: The identity id
principalName String: The identity display name
principalType String: The identity type : user/servicePrincipal
reviewHistoryPeriodEndDateTime String: 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.
reviewHistoryPeriodStartDateTime String: 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.
userPrincipalName String: 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.
displayName String: The display name for the history definition.
endDate 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.
numberOfOccurrences Number: 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
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

AccessReviewHistoryInstanceResponse

DownloadUri 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.
DisplayName string: The display name for the parent history definition.
Expiration string: Date time when history data report expires and the associated data is deleted.
FulfilledDateTime string: Date time when the history data report is scheduled to be generated.
ReviewHistoryPeriodEndDateTime string: 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.
ReviewHistoryPeriodStartDateTime string: 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.
RunDateTime string: Date time when the history data report is scheduled to be generated.

DownloadUri 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.
DisplayName string: The display name for the parent history definition.
Expiration string: Date time when history data report expires and the associated data is deleted.
FulfilledDateTime string: Date time when the history data report is scheduled to be generated.
ReviewHistoryPeriodEndDateTime string: 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.
ReviewHistoryPeriodStartDateTime string: 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.
RunDateTime string: Date time when the history data report is scheduled to be generated.

downloadUri 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.
displayName String: The display name for the parent history definition.
expiration String: Date time when history data report expires and the associated data is deleted.
fulfilledDateTime String: Date time when the history data report is scheduled to be generated.
reviewHistoryPeriodEndDateTime String: 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.
reviewHistoryPeriodStartDateTime String: 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.
runDateTime String: Date time when the history data report is scheduled to be generated.

downloadUri 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.
displayName string: The display name for the parent history definition.
expiration string: Date time when history data report expires and the associated data is deleted.
fulfilledDateTime string: Date time when the history data report is scheduled to be generated.
reviewHistoryPeriodEndDateTime string: 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.
reviewHistoryPeriodStartDateTime string: 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.
runDateTime string: 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_time str: Date time when the history data report is scheduled to be generated.
review_history_period_end_date_time str: 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_period_start_date_time str: 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_time str: Date time when the history data report is scheduled to be generated.

downloadUri 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.
displayName String: The display name for the parent history definition.
expiration String: Date time when history data report expires and the associated data is deleted.
fulfilledDateTime String: Date time when the history data report is scheduled to be generated.
reviewHistoryPeriodEndDateTime String: 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.
reviewHistoryPeriodStartDateTime String: 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.
runDateTime String: Date time when the history data report is scheduled to be generated.

AccessReviewScopeResponse

AssignmentState string: The role assignment state eligible/active to review
PrincipalType string: The identity type user/servicePrincipal to review
ResourceId string: ResourceId in which this review is getting created
RoleDefinitionId string: This is used to indicate the role being reviewed
ExcludeResourceId string: This is used to indicate the resource id(s) to exclude
ExcludeRoleDefinitionId string: This is used to indicate the role definition id(s) to exclude
ExpandNestedMemberships bool: Flag to indicate whether to expand nested memberships or not.
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))
IncludeAccessBelowResource bool: Flag to indicate whether to expand nested memberships or not.
IncludeInheritedAccess bool: Flag to indicate whether to expand nested memberships or not.

AssignmentState string: The role assignment state eligible/active to review
PrincipalType string: The identity type user/servicePrincipal to review
ResourceId string: ResourceId in which this review is getting created
RoleDefinitionId string: This is used to indicate the role being reviewed
ExcludeResourceId string: This is used to indicate the resource id(s) to exclude
ExcludeRoleDefinitionId string: This is used to indicate the role definition id(s) to exclude
ExpandNestedMemberships bool: Flag to indicate whether to expand nested memberships or not.
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))
IncludeAccessBelowResource bool: Flag to indicate whether to expand nested memberships or not.
IncludeInheritedAccess bool: Flag to indicate whether to expand nested memberships or not.

assignmentState String: The role assignment state eligible/active to review
principalType String: The identity type user/servicePrincipal to review
resourceId String: ResourceId in which this review is getting created
roleDefinitionId String: This is used to indicate the role being reviewed
excludeResourceId String: This is used to indicate the resource id(s) to exclude
excludeRoleDefinitionId String: This is used to indicate the role definition id(s) to exclude
expandNestedMemberships Boolean: Flag to indicate whether to expand nested memberships or not.
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))
includeAccessBelowResource Boolean: Flag to indicate whether to expand nested memberships or not.
includeInheritedAccess Boolean: Flag to indicate whether to expand nested memberships or not.

assignmentState string: The role assignment state eligible/active to review
principalType string: The identity type user/servicePrincipal to review
resourceId string: ResourceId in which this review is getting created
roleDefinitionId string: This is used to indicate the role being reviewed
excludeResourceId string: This is used to indicate the resource id(s) to exclude
excludeRoleDefinitionId string: This is used to indicate the role definition id(s) to exclude
expandNestedMemberships boolean: Flag to indicate whether to expand nested memberships or not.
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))
includeAccessBelowResource boolean: Flag to indicate whether to expand nested memberships or not.
includeInheritedAccess boolean: 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_id str: This is used to indicate the role being reviewed
exclude_resource_id str: This is used to indicate the resource id(s) to exclude
exclude_role_definition_id str: This is used to indicate the role definition id(s) to exclude
expand_nested_memberships bool: 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_below_resource bool: Flag to indicate whether to expand nested memberships or not.
include_inherited_access bool: Flag to indicate whether to expand nested memberships or not.

assignmentState String: The role assignment state eligible/active to review
principalType String: The identity type user/servicePrincipal to review
resourceId String: ResourceId in which this review is getting created
roleDefinitionId String: This is used to indicate the role being reviewed
excludeResourceId String: This is used to indicate the resource id(s) to exclude
excludeRoleDefinitionId String: This is used to indicate the role definition id(s) to exclude
expandNestedMemberships Boolean: Flag to indicate whether to expand nested memberships or not.
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))
includeAccessBelowResource Boolean: Flag to indicate whether to expand nested memberships or not.
includeInheritedAccess Boolean: 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.90.0 published on Thursday, Mar 27, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.authorization.getAccessReviewHistoryDefinitionById

On this page

On this page

Using getAccessReviewHistoryDefinitionById

getAccessReviewHistoryDefinitionById Result

Supporting Types

AccessReviewHistoryInstanceResponse

AccessReviewScopeResponse

Package Details

On this page

On this page