Share via


New-MgBetaSecurityLabelRetentionLabel

Create a new retentionLabel object. To create a disposition review stage, include the actionAfterRetentionPeriod property in the request body with one of the possible values specified.

Note

To view the v1.0 release of this cmdlet, view New-MgSecurityLabelRetentionLabel

Syntax

CreateExpanded (Default)

New-MgBetaSecurityLabelRetentionLabel
    [-ResponseHeadersVariable <String>]
    [-ActionAfterRetentionPeriod <String>]
    [-AdditionalProperties <Hashtable>]
    [-BehaviorDuringRetentionPeriod <String>]
    [-CreatedBy <IMicrosoftGraphIdentitySet>]
    [-CreatedDateTime <DateTime>]
    [-DefaultRecordBehavior <String>]
    [-DescriptionForAdmins <String>]
    [-DescriptionForUsers <String>]
    [-Descriptors <IMicrosoftGraphSecurityFilePlanDescriptor>]
    [-DisplayName <String>]
    [-DispositionReviewStages <IMicrosoftGraphSecurityDispositionReviewStage[]>]
    [-Id <String>]
    [-IsInUse]
    [-LabelToBeApplied <String>]
    [-LastModifiedBy <IMicrosoftGraphIdentitySet>]
    [-LastModifiedDateTime <DateTime>]
    [-RetentionDuration <Hashtable>]
    [-RetentionEventType <IMicrosoftGraphSecurityRetentionEventType>]
    [-RetentionTrigger <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Create

New-MgBetaSecurityLabelRetentionLabel
    -BodyParameter <IMicrosoftGraphSecurityRetentionLabel>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Create a new retentionLabel object. To create a disposition review stage, include the actionAfterRetentionPeriod property in the request body with one of the possible values specified.

Examples

Example 1: Code snippet


Import-Module Microsoft.Graph.Beta.Security

$params = @{
	"@odata.type" = "#microsoft.graph.security.retentionLabel"
	displayName = "String"
	behaviorDuringRetentionPeriod = "String"
	actionAfterRetentionPeriod = "String"
	retentionTrigger = "String"
	retentionDuration = @{
		"@odata.type" = "microsoft.graph.security.retentionDuration"
	}
	isInUse = "Boolean"
	descriptionForAdmins = "String"
	descriptionForUsers = "String"
	createdBy = @{
		"@odata.type" = "microsoft.graph.identitySet"
	}
	labelToBeApplied = "String"
	defaultRecordBehavior = "String"
	descriptors = @{
		"authorityTemplate@odata.bind" = "https://graph.microsoft.com/beta/security/labels/authorities('fie3f4fc-b966-4c40-94de-fb8a383658e4')"
		"categoryTemplate@odata.bind" = "https://graph.microsoft.com/beta/security/labels/categories('0bjk8-b966-4c40-94de-fb8a383658e4')"
		"citationTemplate@odata.bind" = "https://graph.microsoft.com/beta/security/labels/citations('0e23f4fc-b966-4c40-94de-fb8a383658e4')"
		"departmentTemplate@odata.bind" = "https://graph.microsoft.com/beta/security/labels/departments('p99ef4fc-b966-4c40-94de-fb8a383658e4')"
		"filePlanReferenceTemplate@odata.bind" = "https://graph.microsoft.com/beta/security/labels/filePlanReferences('e095f4fc-b966-4c40-94de-fb8a383658e4')"
	}
}

New-MgBetaSecurityLabelRetentionLabel -BodyParameter $params

This example shows how to use the New-MgBetaSecurityLabelRetentionLabel Cmdlet.

Parameters

-ActionAfterRetentionPeriod

actionAfterRetentionPeriod

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AdditionalProperties

Additional Parameters

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BehaviorDuringRetentionPeriod

behaviorDuringRetentionPeriod

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BodyParameter

retentionLabel To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Parameter properties

Type:IMicrosoftGraphSecurityRetentionLabel
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Create
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CreatedBy

identitySet To construct, see NOTES section for CREATEDBY properties and create a hash table.

Parameter properties

Type:IMicrosoftGraphIdentitySet
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CreatedDateTime

Represents the date and time in which the retentionLabel is created.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultRecordBehavior

defaultRecordBehavior

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DescriptionForAdmins

Provides label information for the admin. Optional.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DescriptionForUsers

Provides the label information for the user. Optional.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Descriptors

filePlanDescriptor To construct, see NOTES section for DESCRIPTORS properties and create a hash table.

Parameter properties

Type:IMicrosoftGraphSecurityFilePlanDescriptor
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisplayName

Unique string that defines a label name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DispositionReviewStages

When action at the end of retention is chosen as 'dispositionReview', dispositionReviewStages specifies a sequential set of stages with at least one reviewer in each stage. To construct, see NOTES section for DISPOSITIONREVIEWSTAGES properties and create a hash table.

Parameter properties

Type:

IMicrosoftGraphSecurityDispositionReviewStage[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:IDictionary
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

The unique identifier for an entity. Read-only.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IsInUse

Specifies whether the label is currently being used.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LabelToBeApplied

Specifies the replacement label to be applied automatically after the retention period of the current label ends.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LastModifiedBy

identitySet To construct, see NOTES section for LASTMODIFIEDBY properties and create a hash table.

Parameter properties

Type:IMicrosoftGraphIdentitySet
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LastModifiedDateTime

The latest date time when the retentionLabel was modified.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:RHV

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RetentionDuration

retentionDuration

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RetentionEventType

retentionEventType To construct, see NOTES section for RETENTIONEVENTTYPE properties and create a hash table.

Parameter properties

Type:IMicrosoftGraphSecurityRetentionEventType
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RetentionTrigger

retentionTrigger

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphSecurityRetentionLabel

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphSecurityRetentionLabel

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

BODYPARAMETER <IMicrosoftGraphSecurityRetentionLabel>: retentionLabel

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [ActionAfterRetentionPeriod <String>]: actionAfterRetentionPeriod
  • [BehaviorDuringRetentionPeriod <String>]: behaviorDuringRetentionPeriod
  • [CreatedBy <IMicrosoftGraphIdentitySet>]: identitySet
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Application <IMicrosoftGraphIdentity>]: identity
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [DisplayName <String>]: The display name of the identity. This property is read-only.
      • [Id <String>]: The identifier of the identity. This property is read-only.
    • [Device <IMicrosoftGraphIdentity>]: identity
    • [User <IMicrosoftGraphIdentity>]: identity
  • [CreatedDateTime <DateTime?>]: Represents the date and time in which the retentionLabel is created.
  • [DefaultRecordBehavior <String>]: defaultRecordBehavior
  • [DescriptionForAdmins <String>]: Provides label information for the admin. Optional.
  • [DescriptionForUsers <String>]: Provides the label information for the user. Optional.
  • [Descriptors <IMicrosoftGraphSecurityFilePlanDescriptor>]: filePlanDescriptor
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [Authority <IMicrosoftGraphSecurityFilePlanAuthority>]: filePlanAuthority
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [DisplayName <String>]: Unique string that defines the name for the file plan descriptor associated with a particular retention label.
    • [AuthorityTemplate <IMicrosoftGraphSecurityAuthorityTemplate>]: authorityTemplate
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [CreatedBy <IMicrosoftGraphIdentitySet>]: identitySet
      • [CreatedDateTime <DateTime?>]: Represents the date and time in which the filePlanDescriptorTemplate is created. Read-only.
      • [DisplayName <String>]: Unique string that defines a filePlanDescriptorTemplate name.
      • [Id <String>]: The unique identifier for an entity. Read-only.
    • [Category <IMicrosoftGraphSecurityFilePlanAppliedCategory>]: filePlanAppliedCategory
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [DisplayName <String>]: Unique string that defines the name for the file plan descriptor associated with a particular retention label.
      • [Subcategory <IMicrosoftGraphSecurityFilePlanSubcategory>]: filePlanSubcategory
        • [(Any) <Object>]: This indicates any property can be added to this object.
        • [DisplayName <String>]: Unique string that defines the name for the file plan descriptor associated with a particular retention label.
    • [CategoryTemplate <IMicrosoftGraphSecurityCategoryTemplate>]: categoryTemplate
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [CreatedBy <IMicrosoftGraphIdentitySet>]: identitySet
      • [CreatedDateTime <DateTime?>]: Represents the date and time in which the filePlanDescriptorTemplate is created. Read-only.
      • [DisplayName <String>]: Unique string that defines a filePlanDescriptorTemplate name.
      • [Id <String>]: The unique identifier for an entity. Read-only.
      • [Subcategories <IMicrosoftGraphSecuritySubcategoryTemplate- []>]: Represents all subcategories under a particular category.
        • [CreatedBy <IMicrosoftGraphIdentitySet>]: identitySet
        • [CreatedDateTime <DateTime?>]: Represents the date and time in which the filePlanDescriptorTemplate is created. Read-only.
        • [DisplayName <String>]: Unique string that defines a filePlanDescriptorTemplate name.
        • [Id <String>]: The unique identifier for an entity. Read-only.
    • [Citation <IMicrosoftGraphSecurityFilePlanCitation>]: filePlanCitation
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [DisplayName <String>]: Unique string that defines the name for the file plan descriptor associated with a particular retention label.
      • [CitationJurisdiction <String>]: Represents the jurisdiction or agency that published the filePlanCitation.
      • [CitationUrl <String>]: Represents the URL to the published filePlanCitation.
    • [CitationTemplate <IMicrosoftGraphSecurityCitationTemplate>]: citationTemplate
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [CreatedBy <IMicrosoftGraphIdentitySet>]: identitySet
      • [CreatedDateTime <DateTime?>]: Represents the date and time in which the filePlanDescriptorTemplate is created. Read-only.
      • [DisplayName <String>]: Unique string that defines a filePlanDescriptorTemplate name.
      • [Id <String>]: The unique identifier for an entity. Read-only.
      • [CitationJurisdiction <String>]: Represents the jurisdiction or agency that published the citation.
      • [CitationUrl <String>]: Represents the URL to the published citation.
    • [Department <IMicrosoftGraphSecurityFilePlanDepartment>]: filePlanDepartment
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [DisplayName <String>]: Unique string that defines the name for the file plan descriptor associated with a particular retention label.
    • [DepartmentTemplate <IMicrosoftGraphSecurityDepartmentTemplate>]: departmentTemplate
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [CreatedBy <IMicrosoftGraphIdentitySet>]: identitySet
      • [CreatedDateTime <DateTime?>]: Represents the date and time in which the filePlanDescriptorTemplate is created. Read-only.
      • [DisplayName <String>]: Unique string that defines a filePlanDescriptorTemplate name.
      • [Id <String>]: The unique identifier for an entity. Read-only.
    • [FilePlanReference <IMicrosoftGraphSecurityFilePlanReference>]: filePlanReference
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [DisplayName <String>]: Unique string that defines the name for the file plan descriptor associated with a particular retention label.
    • [FilePlanReferenceTemplate <IMicrosoftGraphSecurityFilePlanReferenceTemplate>]: filePlanReferenceTemplate
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [CreatedBy <IMicrosoftGraphIdentitySet>]: identitySet
      • [CreatedDateTime <DateTime?>]: Represents the date and time in which the filePlanDescriptorTemplate is created. Read-only.
      • [DisplayName <String>]: Unique string that defines a filePlanDescriptorTemplate name.
      • [Id <String>]: The unique identifier for an entity. Read-only.
  • [DisplayName <String>]: Unique string that defines a label name.
  • [DispositionReviewStages <IMicrosoftGraphSecurityDispositionReviewStage- []>]: When action at the end of retention is chosen as 'dispositionReview', dispositionReviewStages specifies a sequential set of stages with at least one reviewer in each stage.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [Name <String>]: Name representing each stage within a collection.
    • [ReviewersEmailAddresses <String- []>]: A collection of reviewers at each stage.
    • [StageNumber <String>]: The unique sequence number for each stage of the disposition review.
  • [IsInUse <Boolean?>]: Specifies whether the label is currently being used.
  • [LabelToBeApplied <String>]: Specifies the replacement label to be applied automatically after the retention period of the current label ends.
  • [LastModifiedBy <IMicrosoftGraphIdentitySet>]: identitySet
  • [LastModifiedDateTime <DateTime?>]: The latest date time when the retentionLabel was modified.
  • [RetentionDuration <IMicrosoftGraphSecurityRetentionDuration>]: retentionDuration
    • [(Any) <Object>]: This indicates any property can be added to this object.
  • [RetentionEventType <IMicrosoftGraphSecurityRetentionEventType>]: retentionEventType
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [CreatedBy <IMicrosoftGraphIdentitySet>]: identitySet
    • [CreatedDateTime <DateTime?>]: The date time when the retentionEventType was created.
    • [Description <String>]: Optional information about the event type.
    • [DisplayName <String>]: Name of the event type.
    • [LastModifiedBy <IMicrosoftGraphIdentitySet>]: identitySet
    • [LastModifiedDateTime <DateTime?>]: The latest date time when the retentionEventType was modified.
  • [RetentionTrigger <String>]: retentionTrigger

CREATEDBY <IMicrosoftGraphIdentitySet>: identitySet

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Application <IMicrosoftGraphIdentity>]: identity
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DisplayName <String>]: The display name of the identity. This property is read-only.
    • [Id <String>]: The identifier of the identity. This property is read-only.
  • [Device <IMicrosoftGraphIdentity>]: identity
  • [User <IMicrosoftGraphIdentity>]: identity

DESCRIPTORS <IMicrosoftGraphSecurityFilePlanDescriptor>: filePlanDescriptor

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [Authority <IMicrosoftGraphSecurityFilePlanAuthority>]: filePlanAuthority
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DisplayName <String>]: Unique string that defines the name for the file plan descriptor associated with a particular retention label.
  • [AuthorityTemplate <IMicrosoftGraphSecurityAuthorityTemplate>]: authorityTemplate
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [CreatedBy <IMicrosoftGraphIdentitySet>]: identitySet
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [Application <IMicrosoftGraphIdentity>]: identity
        • [(Any) <Object>]: This indicates any property can be added to this object.
        • [DisplayName <String>]: The display name of the identity. This property is read-only.
        • [Id <String>]: The identifier of the identity. This property is read-only.
      • [Device <IMicrosoftGraphIdentity>]: identity
      • [User <IMicrosoftGraphIdentity>]: identity
    • [CreatedDateTime <DateTime?>]: Represents the date and time in which the filePlanDescriptorTemplate is created. Read-only.
    • [DisplayName <String>]: Unique string that defines a filePlanDescriptorTemplate name.
    • [Id <String>]: The unique identifier for an entity. Read-only.
  • [Category <IMicrosoftGraphSecurityFilePlanAppliedCategory>]: filePlanAppliedCategory
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DisplayName <String>]: Unique string that defines the name for the file plan descriptor associated with a particular retention label.
    • [Subcategory <IMicrosoftGraphSecurityFilePlanSubcategory>]: filePlanSubcategory
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [DisplayName <String>]: Unique string that defines the name for the file plan descriptor associated with a particular retention label.
  • [CategoryTemplate <IMicrosoftGraphSecurityCategoryTemplate>]: categoryTemplate
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [CreatedBy <IMicrosoftGraphIdentitySet>]: identitySet
    • [CreatedDateTime <DateTime?>]: Represents the date and time in which the filePlanDescriptorTemplate is created. Read-only.
    • [DisplayName <String>]: Unique string that defines a filePlanDescriptorTemplate name.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [Subcategories <IMicrosoftGraphSecuritySubcategoryTemplate- []>]: Represents all subcategories under a particular category.
      • [CreatedBy <IMicrosoftGraphIdentitySet>]: identitySet
      • [CreatedDateTime <DateTime?>]: Represents the date and time in which the filePlanDescriptorTemplate is created. Read-only.
      • [DisplayName <String>]: Unique string that defines a filePlanDescriptorTemplate name.
      • [Id <String>]: The unique identifier for an entity. Read-only.
  • [Citation <IMicrosoftGraphSecurityFilePlanCitation>]: filePlanCitation
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DisplayName <String>]: Unique string that defines the name for the file plan descriptor associated with a particular retention label.
    • [CitationJurisdiction <String>]: Represents the jurisdiction or agency that published the filePlanCitation.
    • [CitationUrl <String>]: Represents the URL to the published filePlanCitation.
  • [CitationTemplate <IMicrosoftGraphSecurityCitationTemplate>]: citationTemplate
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [CreatedBy <IMicrosoftGraphIdentitySet>]: identitySet
    • [CreatedDateTime <DateTime?>]: Represents the date and time in which the filePlanDescriptorTemplate is created. Read-only.
    • [DisplayName <String>]: Unique string that defines a filePlanDescriptorTemplate name.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [CitationJurisdiction <String>]: Represents the jurisdiction or agency that published the citation.
    • [CitationUrl <String>]: Represents the URL to the published citation.
  • [Department <IMicrosoftGraphSecurityFilePlanDepartment>]: filePlanDepartment
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DisplayName <String>]: Unique string that defines the name for the file plan descriptor associated with a particular retention label.
  • [DepartmentTemplate <IMicrosoftGraphSecurityDepartmentTemplate>]: departmentTemplate
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [CreatedBy <IMicrosoftGraphIdentitySet>]: identitySet
    • [CreatedDateTime <DateTime?>]: Represents the date and time in which the filePlanDescriptorTemplate is created. Read-only.
    • [DisplayName <String>]: Unique string that defines a filePlanDescriptorTemplate name.
    • [Id <String>]: The unique identifier for an entity. Read-only.
  • [FilePlanReference <IMicrosoftGraphSecurityFilePlanReference>]: filePlanReference
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DisplayName <String>]: Unique string that defines the name for the file plan descriptor associated with a particular retention label.
  • [FilePlanReferenceTemplate <IMicrosoftGraphSecurityFilePlanReferenceTemplate>]: filePlanReferenceTemplate
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [CreatedBy <IMicrosoftGraphIdentitySet>]: identitySet
    • [CreatedDateTime <DateTime?>]: Represents the date and time in which the filePlanDescriptorTemplate is created. Read-only.
    • [DisplayName <String>]: Unique string that defines a filePlanDescriptorTemplate name.
    • [Id <String>]: The unique identifier for an entity. Read-only.

DISPOSITIONREVIEWSTAGES <IMicrosoftGraphSecurityDispositionReviewStage- []>: When action at the end of retention is chosen as 'dispositionReview', dispositionReviewStages specifies a sequential set of stages with at least one reviewer in each stage.

  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [Name <String>]: Name representing each stage within a collection.
  • [ReviewersEmailAddresses <String- []>]: A collection of reviewers at each stage.
  • [StageNumber <String>]: The unique sequence number for each stage of the disposition review.

LASTMODIFIEDBY <IMicrosoftGraphIdentitySet>: identitySet

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Application <IMicrosoftGraphIdentity>]: identity
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DisplayName <String>]: The display name of the identity. This property is read-only.
    • [Id <String>]: The identifier of the identity. This property is read-only.
  • [Device <IMicrosoftGraphIdentity>]: identity
  • [User <IMicrosoftGraphIdentity>]: identity

RETENTIONEVENTTYPE <IMicrosoftGraphSecurityRetentionEventType>: retentionEventType

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [CreatedBy <IMicrosoftGraphIdentitySet>]: identitySet
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Application <IMicrosoftGraphIdentity>]: identity
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [DisplayName <String>]: The display name of the identity. This property is read-only.
      • [Id <String>]: The identifier of the identity. This property is read-only.
    • [Device <IMicrosoftGraphIdentity>]: identity
    • [User <IMicrosoftGraphIdentity>]: identity
  • [CreatedDateTime <DateTime?>]: The date time when the retentionEventType was created.
  • [Description <String>]: Optional information about the event type.
  • [DisplayName <String>]: Name of the event type.
  • [LastModifiedBy <IMicrosoftGraphIdentitySet>]: identitySet
  • [LastModifiedDateTime <DateTime?>]: The latest date time when the retentionEventType was modified.