New-MgSecurityLabelRetentionLabel

New-MgSecurityLabelRetentionLabel
    [-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>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

New-MgSecurityLabelRetentionLabel
    -BodyParameter <IMicrosoftGraphSecurityRetentionLabel>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<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.

{{ Fill in the Description }}

{{ Fill in the Description }}

{{ Fill in the Description }}

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.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta. [Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review. [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. [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. [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. [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. [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. [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. [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.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta. [Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review. [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.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta. [Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review. [Device <IMicrosoftGraphIdentity>]: identity [User <IMicrosoftGraphIdentity>]: identity [CreatedDateTime <DateTime?>]: Represents the date and time in which the filePlanDescriptorTemplate is created. [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. [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. [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. [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. [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. [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.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta. [Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review. [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.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta. [Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review. [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.