1. Packages
  2. Azure Native
  3. API Docs
  4. authorization
  5. ScopeAccessReviewHistoryDefinitionById
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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

azure-native.authorization.ScopeAccessReviewHistoryDefinitionById

Explore with Pulumi AI

azure-native logo
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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

    Access Review History Definition. Azure REST API version: 2021-12-01-preview. Prior API version in Azure Native 1.x: 2021-12-01-preview.

    Example Usage

    PutAccessReviewHistoryDefinition

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var scopeAccessReviewHistoryDefinitionById = new AzureNative.Authorization.ScopeAccessReviewHistoryDefinitionById("scopeAccessReviewHistoryDefinitionById", new()
        {
            HistoryDefinitionId = "44724910-d7a5-4c29-b28f-db73e717165a",
            Scope = "subscriptions/129a304b-4aea-4b86-a9f7-ba7e2b23737a",
        });
    
    });
    
    package main
    
    import (
    	authorization "github.com/pulumi/pulumi-azure-native-sdk/authorization/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := authorization.NewScopeAccessReviewHistoryDefinitionById(ctx, "scopeAccessReviewHistoryDefinitionById", &authorization.ScopeAccessReviewHistoryDefinitionByIdArgs{
    			HistoryDefinitionId: pulumi.String("44724910-d7a5-4c29-b28f-db73e717165a"),
    			Scope:               pulumi.String("subscriptions/129a304b-4aea-4b86-a9f7-ba7e2b23737a"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.authorization.ScopeAccessReviewHistoryDefinitionById;
    import com.pulumi.azurenative.authorization.ScopeAccessReviewHistoryDefinitionByIdArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var scopeAccessReviewHistoryDefinitionById = new ScopeAccessReviewHistoryDefinitionById("scopeAccessReviewHistoryDefinitionById", ScopeAccessReviewHistoryDefinitionByIdArgs.builder()
                .historyDefinitionId("44724910-d7a5-4c29-b28f-db73e717165a")
                .scope("subscriptions/129a304b-4aea-4b86-a9f7-ba7e2b23737a")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    scope_access_review_history_definition_by_id = azure_native.authorization.ScopeAccessReviewHistoryDefinitionById("scopeAccessReviewHistoryDefinitionById",
        history_definition_id="44724910-d7a5-4c29-b28f-db73e717165a",
        scope="subscriptions/129a304b-4aea-4b86-a9f7-ba7e2b23737a")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const scopeAccessReviewHistoryDefinitionById = new azure_native.authorization.ScopeAccessReviewHistoryDefinitionById("scopeAccessReviewHistoryDefinitionById", {
        historyDefinitionId: "44724910-d7a5-4c29-b28f-db73e717165a",
        scope: "subscriptions/129a304b-4aea-4b86-a9f7-ba7e2b23737a",
    });
    
    resources:
      scopeAccessReviewHistoryDefinitionById:
        type: azure-native:authorization:ScopeAccessReviewHistoryDefinitionById
        properties:
          historyDefinitionId: 44724910-d7a5-4c29-b28f-db73e717165a
          scope: subscriptions/129a304b-4aea-4b86-a9f7-ba7e2b23737a
    

    Create ScopeAccessReviewHistoryDefinitionById Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ScopeAccessReviewHistoryDefinitionById(name: string, args: ScopeAccessReviewHistoryDefinitionByIdArgs, opts?: CustomResourceOptions);
    @overload
    def ScopeAccessReviewHistoryDefinitionById(resource_name: str,
                                               args: ScopeAccessReviewHistoryDefinitionByIdArgs,
                                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def ScopeAccessReviewHistoryDefinitionById(resource_name: str,
                                               opts: Optional[ResourceOptions] = None,
                                               scope: Optional[str] = None,
                                               decisions: Optional[Sequence[Union[str, AccessReviewResult]]] = None,
                                               display_name: Optional[str] = None,
                                               end_date: Optional[str] = None,
                                               history_definition_id: Optional[str] = None,
                                               instances: Optional[Sequence[AccessReviewHistoryInstanceArgs]] = None,
                                               interval: Optional[int] = None,
                                               number_of_occurrences: Optional[int] = None,
                                               scopes: Optional[Sequence[AccessReviewScopeArgs]] = None,
                                               start_date: Optional[str] = None,
                                               type: Optional[Union[str, AccessReviewRecurrenceRangeType]] = None)
    func NewScopeAccessReviewHistoryDefinitionById(ctx *Context, name string, args ScopeAccessReviewHistoryDefinitionByIdArgs, opts ...ResourceOption) (*ScopeAccessReviewHistoryDefinitionById, error)
    public ScopeAccessReviewHistoryDefinitionById(string name, ScopeAccessReviewHistoryDefinitionByIdArgs args, CustomResourceOptions? opts = null)
    public ScopeAccessReviewHistoryDefinitionById(String name, ScopeAccessReviewHistoryDefinitionByIdArgs args)
    public ScopeAccessReviewHistoryDefinitionById(String name, ScopeAccessReviewHistoryDefinitionByIdArgs args, CustomResourceOptions options)
    
    type: azure-native:authorization:ScopeAccessReviewHistoryDefinitionById
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ScopeAccessReviewHistoryDefinitionByIdArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ScopeAccessReviewHistoryDefinitionByIdArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ScopeAccessReviewHistoryDefinitionByIdArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScopeAccessReviewHistoryDefinitionByIdArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScopeAccessReviewHistoryDefinitionByIdArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var scopeAccessReviewHistoryDefinitionByIdResource = new AzureNative.Authorization.ScopeAccessReviewHistoryDefinitionById("scopeAccessReviewHistoryDefinitionByIdResource", new()
    {
        Scope = "string",
        Decisions = new[]
        {
            "string",
        },
        DisplayName = "string",
        EndDate = "string",
        HistoryDefinitionId = "string",
        Instances = new[]
        {
            new AzureNative.Authorization.Inputs.AccessReviewHistoryInstanceArgs
            {
                DisplayName = "string",
                Expiration = "string",
                FulfilledDateTime = "string",
                ReviewHistoryPeriodEndDateTime = "string",
                ReviewHistoryPeriodStartDateTime = "string",
                RunDateTime = "string",
            },
        },
        Interval = 0,
        NumberOfOccurrences = 0,
        Scopes = new[]
        {
            new AzureNative.Authorization.Inputs.AccessReviewScopeArgs
            {
                ExcludeResourceId = "string",
                ExcludeRoleDefinitionId = "string",
                ExpandNestedMemberships = false,
                InactiveDuration = "string",
                IncludeAccessBelowResource = false,
                IncludeInheritedAccess = false,
            },
        },
        StartDate = "string",
        Type = "string",
    });
    
    example, err := authorization.NewScopeAccessReviewHistoryDefinitionById(ctx, "scopeAccessReviewHistoryDefinitionByIdResource", &authorization.ScopeAccessReviewHistoryDefinitionByIdArgs{
    	Scope: pulumi.String("string"),
    	Decisions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	DisplayName:         pulumi.String("string"),
    	EndDate:             pulumi.String("string"),
    	HistoryDefinitionId: pulumi.String("string"),
    	Instances: authorization.AccessReviewHistoryInstanceArray{
    		&authorization.AccessReviewHistoryInstanceArgs{
    			DisplayName:                      pulumi.String("string"),
    			Expiration:                       pulumi.String("string"),
    			FulfilledDateTime:                pulumi.String("string"),
    			ReviewHistoryPeriodEndDateTime:   pulumi.String("string"),
    			ReviewHistoryPeriodStartDateTime: pulumi.String("string"),
    			RunDateTime:                      pulumi.String("string"),
    		},
    	},
    	Interval:            pulumi.Int(0),
    	NumberOfOccurrences: pulumi.Int(0),
    	Scopes: authorization.AccessReviewScopeArray{
    		&authorization.AccessReviewScopeArgs{
    			ExcludeResourceId:          pulumi.String("string"),
    			ExcludeRoleDefinitionId:    pulumi.String("string"),
    			ExpandNestedMemberships:    pulumi.Bool(false),
    			InactiveDuration:           pulumi.String("string"),
    			IncludeAccessBelowResource: pulumi.Bool(false),
    			IncludeInheritedAccess:     pulumi.Bool(false),
    		},
    	},
    	StartDate: pulumi.String("string"),
    	Type:      pulumi.String("string"),
    })
    
    var scopeAccessReviewHistoryDefinitionByIdResource = new ScopeAccessReviewHistoryDefinitionById("scopeAccessReviewHistoryDefinitionByIdResource", ScopeAccessReviewHistoryDefinitionByIdArgs.builder()
        .scope("string")
        .decisions("string")
        .displayName("string")
        .endDate("string")
        .historyDefinitionId("string")
        .instances(AccessReviewHistoryInstanceArgs.builder()
            .displayName("string")
            .expiration("string")
            .fulfilledDateTime("string")
            .reviewHistoryPeriodEndDateTime("string")
            .reviewHistoryPeriodStartDateTime("string")
            .runDateTime("string")
            .build())
        .interval(0)
        .numberOfOccurrences(0)
        .scopes(AccessReviewScopeArgs.builder()
            .excludeResourceId("string")
            .excludeRoleDefinitionId("string")
            .expandNestedMemberships(false)
            .inactiveDuration("string")
            .includeAccessBelowResource(false)
            .includeInheritedAccess(false)
            .build())
        .startDate("string")
        .type("string")
        .build());
    
    scope_access_review_history_definition_by_id_resource = azure_native.authorization.ScopeAccessReviewHistoryDefinitionById("scopeAccessReviewHistoryDefinitionByIdResource",
        scope="string",
        decisions=["string"],
        display_name="string",
        end_date="string",
        history_definition_id="string",
        instances=[{
            "display_name": "string",
            "expiration": "string",
            "fulfilled_date_time": "string",
            "review_history_period_end_date_time": "string",
            "review_history_period_start_date_time": "string",
            "run_date_time": "string",
        }],
        interval=0,
        number_of_occurrences=0,
        scopes=[{
            "exclude_resource_id": "string",
            "exclude_role_definition_id": "string",
            "expand_nested_memberships": False,
            "inactive_duration": "string",
            "include_access_below_resource": False,
            "include_inherited_access": False,
        }],
        start_date="string",
        type="string")
    
    const scopeAccessReviewHistoryDefinitionByIdResource = new azure_native.authorization.ScopeAccessReviewHistoryDefinitionById("scopeAccessReviewHistoryDefinitionByIdResource", {
        scope: "string",
        decisions: ["string"],
        displayName: "string",
        endDate: "string",
        historyDefinitionId: "string",
        instances: [{
            displayName: "string",
            expiration: "string",
            fulfilledDateTime: "string",
            reviewHistoryPeriodEndDateTime: "string",
            reviewHistoryPeriodStartDateTime: "string",
            runDateTime: "string",
        }],
        interval: 0,
        numberOfOccurrences: 0,
        scopes: [{
            excludeResourceId: "string",
            excludeRoleDefinitionId: "string",
            expandNestedMemberships: false,
            inactiveDuration: "string",
            includeAccessBelowResource: false,
            includeInheritedAccess: false,
        }],
        startDate: "string",
        type: "string",
    });
    
    type: azure-native:authorization:ScopeAccessReviewHistoryDefinitionById
    properties:
        decisions:
            - string
        displayName: string
        endDate: string
        historyDefinitionId: string
        instances:
            - displayName: string
              expiration: string
              fulfilledDateTime: string
              reviewHistoryPeriodEndDateTime: string
              reviewHistoryPeriodStartDateTime: string
              runDateTime: string
        interval: 0
        numberOfOccurrences: 0
        scope: string
        scopes:
            - excludeResourceId: string
              excludeRoleDefinitionId: string
              expandNestedMemberships: false
              inactiveDuration: string
              includeAccessBelowResource: false
              includeInheritedAccess: false
        startDate: string
        type: string
    

    ScopeAccessReviewHistoryDefinitionById Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ScopeAccessReviewHistoryDefinitionById resource accepts the following input properties:

    Scope string
    The scope of the resource.
    Decisions List<Union<string, Pulumi.AzureNative.Authorization.AccessReviewResult>>
    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
    HistoryDefinitionId string
    The id of the access review history definition.
    Instances List<Pulumi.AzureNative.Authorization.Inputs.AccessReviewHistoryInstance>
    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.Inputs.AccessReviewScope>
    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.
    Type string | Pulumi.AzureNative.Authorization.AccessReviewRecurrenceRangeType
    The recurrence range type. The possible values are: endDate, noEnd, numbered.
    Scope string
    The scope of the resource.
    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
    HistoryDefinitionId string
    The id of the access review history definition.
    Instances []AccessReviewHistoryInstanceArgs
    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 []AccessReviewScopeArgs
    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.
    Type string | AccessReviewRecurrenceRangeType
    The recurrence range type. The possible values are: endDate, noEnd, numbered.
    scope String
    The scope of the resource.
    decisions List<Either<String,AccessReviewResult>>
    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
    historyDefinitionId String
    The id of the access review history definition.
    instances List<AccessReviewHistoryInstance>
    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<AccessReviewScope>
    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.
    type String | AccessReviewRecurrenceRangeType
    The recurrence range type. The possible values are: endDate, noEnd, numbered.
    scope string
    The scope of the resource.
    decisions (string | AccessReviewResult)[]
    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
    historyDefinitionId string
    The id of the access review history definition.
    instances AccessReviewHistoryInstance[]
    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 AccessReviewScope[]
    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.
    type string | AccessReviewRecurrenceRangeType
    The recurrence range type. The possible values are: endDate, noEnd, numbered.
    scope str
    The scope of the resource.
    decisions Sequence[Union[str, AccessReviewResult]]
    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
    history_definition_id str
    The id of the access review history definition.
    instances Sequence[AccessReviewHistoryInstanceArgs]
    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[AccessReviewScopeArgs]
    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.
    type str | AccessReviewRecurrenceRangeType
    The recurrence range type. The possible values are: endDate, noEnd, numbered.
    scope String
    The scope of the resource.
    decisions List<String | "Approve" | "Deny" | "NotReviewed" | "DontKnow" | "NotNotified">
    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
    historyDefinitionId String
    The id of the access review history definition.
    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.
    type String | "endDate" | "noEnd" | "numbered"
    The recurrence range type. The possible values are: endDate, noEnd, numbered.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ScopeAccessReviewHistoryDefinitionById resource produces the following output properties:

    CreatedDateTime string
    Date time when history definition was created
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    UserPrincipalName string
    The user principal name(if valid)
    CreatedDateTime string
    Date time when history definition was created
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    UserPrincipalName string
    The user principal name(if valid)
    createdDateTime String
    Date time when history definition was created
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    userPrincipalName String
    The user principal name(if valid)
    createdDateTime string
    Date time when history definition was created
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    userPrincipalName string
    The user principal name(if valid)
    created_date_time str
    Date time when history definition was created
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    user_principal_name str
    The user principal name(if valid)
    createdDateTime String
    Date time when history definition was created
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    userPrincipalName String
    The user principal name(if valid)

    Supporting Types

    AccessReviewHistoryInstance, AccessReviewHistoryInstanceArgs

    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.
    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.
    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.
    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.
    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.
    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.

    AccessReviewHistoryInstanceResponse, AccessReviewHistoryInstanceResponseArgs

    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.

    AccessReviewRecurrenceRangeType, AccessReviewRecurrenceRangeTypeArgs

    EndDate
    endDate
    NoEnd
    noEnd
    Numbered
    numbered
    AccessReviewRecurrenceRangeTypeEndDate
    endDate
    AccessReviewRecurrenceRangeTypeNoEnd
    noEnd
    AccessReviewRecurrenceRangeTypeNumbered
    numbered
    EndDate
    endDate
    NoEnd
    noEnd
    Numbered
    numbered
    EndDate
    endDate
    NoEnd
    noEnd
    Numbered
    numbered
    END_DATE
    endDate
    NO_END
    noEnd
    NUMBERED
    numbered
    "endDate"
    endDate
    "noEnd"
    noEnd
    "numbered"
    numbered

    AccessReviewResult, AccessReviewResultArgs

    Approve
    Approve
    Deny
    Deny
    NotReviewed
    NotReviewed
    DontKnow
    DontKnow
    NotNotified
    NotNotified
    AccessReviewResultApprove
    Approve
    AccessReviewResultDeny
    Deny
    AccessReviewResultNotReviewed
    NotReviewed
    AccessReviewResultDontKnow
    DontKnow
    AccessReviewResultNotNotified
    NotNotified
    Approve
    Approve
    Deny
    Deny
    NotReviewed
    NotReviewed
    DontKnow
    DontKnow
    NotNotified
    NotNotified
    Approve
    Approve
    Deny
    Deny
    NotReviewed
    NotReviewed
    DontKnow
    DontKnow
    NotNotified
    NotNotified
    APPROVE
    Approve
    DENY
    Deny
    NOT_REVIEWED
    NotReviewed
    DONT_KNOW
    DontKnow
    NOT_NOTIFIED
    NotNotified
    "Approve"
    Approve
    "Deny"
    Deny
    "NotReviewed"
    NotReviewed
    "DontKnow"
    DontKnow
    "NotNotified"
    NotNotified

    AccessReviewScope, AccessReviewScopeArgs

    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.
    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.
    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.
    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.
    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.
    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.

    AccessReviewScopeResponse, AccessReviewScopeResponseArgs

    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.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:authorization:ScopeAccessReviewHistoryDefinitionById 44724910-d7a5-4c29-b28f-db73e717165a /{scope}/providers/Microsoft.Authorization/accessReviewHistoryDefinitions/{historyDefinitionId} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi