Update the properties of a retentionLabel object.
To update a disposition review stage, include the actionAfterRetentionPeriod property in the request body with one of the possible values specified.
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.
Runs the command in a mode that only reports what would happen without performing the actions.
Parameter properties
Type:
System.Management.Automation.SwitchParameter
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.
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.
INPUTOBJECT <ISecurityIdentity>: Identity Parameter
[AlertId <String>]: The unique identifier of alert
[ArticleId <String>]: The unique identifier of article
[ArticleIndicatorId <String>]: The unique identifier of articleIndicator
[AttackSimulationOperationId <String>]: The unique identifier of attackSimulationOperation
[AuthoredNoteId <String>]: The unique identifier of authoredNote
[AuthorityTemplateId <String>]: The unique identifier of authorityTemplate
[CaseOperationId <String>]: The unique identifier of caseOperation
[CategoryTemplateId <String>]: The unique identifier of categoryTemplate
[CitationTemplateId <String>]: The unique identifier of citationTemplate
[ContentFormats <String[]>]: Usage: contentFormats={contentFormats}
[DataSourceId <String>]: The unique identifier of dataSource
[DepartmentTemplateId <String>]: The unique identifier of departmentTemplate
[DispositionReviewStageNumber <String>]: The unique identifier of dispositionReviewStage
[EdiscoveryCaseId <String>]: The unique identifier of ediscoveryCase
[EdiscoveryCustodianId <String>]: The unique identifier of ediscoveryCustodian
[EdiscoveryNoncustodialDataSourceId <String>]: The unique identifier of ediscoveryNoncustodialDataSource
[EdiscoveryReviewSetId <String>]: The unique identifier of ediscoveryReviewSet
[EdiscoveryReviewSetQueryId <String>]: The unique identifier of ediscoveryReviewSetQuery
[EdiscoveryReviewTagId <String>]: The unique identifier of ediscoveryReviewTag
[EdiscoveryReviewTagId1 <String>]: The unique identifier of ediscoveryReviewTag
[EdiscoverySearchId <String>]: The unique identifier of ediscoverySearch
[EndUserNotificationDetailId <String>]: The unique identifier of endUserNotificationDetail
[EndUserNotificationId <String>]: The unique identifier of endUserNotification
[FilePlanReferenceTemplateId <String>]: The unique identifier of filePlanReferenceTemplate
[HealthIssueId <String>]: The unique identifier of healthIssue
[HostComponentId <String>]: The unique identifier of hostComponent
[HostCookieId <String>]: The unique identifier of hostCookie
[HostId <String>]: The unique identifier of host
[HostPairId <String>]: The unique identifier of hostPair
[HostPortId <String>]: The unique identifier of hostPort
[HostSslCertificateId <String>]: The unique identifier of hostSslCertificate
[HostTrackerId <String>]: The unique identifier of hostTracker
[IncidentId <String>]: The unique identifier of incident
[IntelligenceProfileId <String>]: The unique identifier of intelligenceProfile
[IntelligenceProfileIndicatorId <String>]: The unique identifier of intelligenceProfileIndicator
[LabelIds <String[]>]: Usage: labelIds={labelIds}
[LandingPageDetailId <String>]: The unique identifier of landingPageDetail
[LandingPageId <String>]: The unique identifier of landingPage
[Locale <String>]: Usage: locale='{locale}'
[LoginPageId <String>]: The unique identifier of loginPage
[PassiveDnsRecordId <String>]: The unique identifier of passiveDnsRecord
[PayloadId <String>]: The unique identifier of payload
[RetentionEventId <String>]: The unique identifier of retentionEvent
[RetentionEventTypeId <String>]: The unique identifier of retentionEventType
[RetentionLabelId <String>]: The unique identifier of retentionLabel
[SecureScoreControlProfileId <String>]: The unique identifier of secureScoreControlProfile
[SecureScoreId <String>]: The unique identifier of secureScore
[SensitivityLabelId <String>]: The unique identifier of sensitivityLabel
[SensitivityLabelId1 <String>]: The unique identifier of sensitivityLabel
[SensorId <String>]: The unique identifier of sensor
[SimulationAutomationId <String>]: The unique identifier of simulationAutomation
[SimulationAutomationRunId <String>]: The unique identifier of simulationAutomationRun
[SimulationId <String>]: The unique identifier of simulation
[SiteSourceId <String>]: The unique identifier of siteSource
[SslCertificateId <String>]: The unique identifier of sslCertificate
[SubcategoryTemplateId <String>]: The unique identifier of subcategoryTemplate
[SubdomainId <String>]: The unique identifier of subdomain
[SubjectRightsRequestId <String>]: The unique identifier of subjectRightsRequest
[TrainingId <String>]: The unique identifier of training
[TrainingLanguageDetailId <String>]: The unique identifier of trainingLanguageDetail
[UnifiedGroupSourceId <String>]: The unique identifier of unifiedGroupSource
[UserId <String>]: The unique identifier of user
[UserPrincipalName <String>]: Alternate key of user
[UserSourceId <String>]: The unique identifier of userSource
[VulnerabilityComponentId <String>]: The unique identifier of vulnerabilityComponent
[VulnerabilityId <String>]: The unique identifier of vulnerability
[WhoisHistoryRecordId <String>]: The unique identifier of whoisHistoryRecord
[WhoisRecordId <String>]: The unique identifier of whoisRecord
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.