Update-MgBetaSecurityTriggerRetentionEvent
Update the navigation property retentionEvents in security
Note
To view the v1.0 release of this cmdlet, view Update-MgSecurityTriggerRetentionEvent
PowerShell
Update-MgBetaSecurityTriggerRetentionEvent
-RetentionEventId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-CreatedBy <IMicrosoftGraphIdentitySet>]
[-CreatedDateTime <DateTime>]
[-Description <String>]
[-DisplayName <String>]
[-EventPropagationResults <IMicrosoftGraphSecurityEventPropagationResult[]>]
[-EventQueries <IMicrosoftGraphSecurityEventQuery[]>]
[-EventStatus <IMicrosoftGraphSecurityRetentionEventStatus>]
[-EventTriggerDateTime <DateTime>]
[-Id <String>]
[-LastModifiedBy <IMicrosoftGraphIdentitySet>]
[-LastModifiedDateTime <DateTime>]
[-LastStatusUpdateDateTime <DateTime>]
[-RetentionEventType <IMicrosoftGraphSecurityRetentionEventType>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]PowerShell
Update-MgBetaSecurityTriggerRetentionEvent
-RetentionEventId <String>
-BodyParameter <IMicrosoftGraphSecurityRetentionEvent>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]PowerShell
Update-MgBetaSecurityTriggerRetentionEvent
-InputObject <ISecurityIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-CreatedBy <IMicrosoftGraphIdentitySet>]
[-CreatedDateTime <DateTime>]
[-Description <String>]
[-DisplayName <String>]
[-EventPropagationResults <IMicrosoftGraphSecurityEventPropagationResult[]>]
[-EventQueries <IMicrosoftGraphSecurityEventQuery[]>]
[-EventStatus <IMicrosoftGraphSecurityRetentionEventStatus>]
[-EventTriggerDateTime <DateTime>]
[-Id <String>]
[-LastModifiedBy <IMicrosoftGraphIdentitySet>]
[-LastModifiedDateTime <DateTime>]
[-LastStatusUpdateDateTime <DateTime>]
[-RetentionEventType <IMicrosoftGraphSecurityRetentionEventType>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]PowerShell
Update-MgBetaSecurityTriggerRetentionEvent
-InputObject <ISecurityIdentity>
-BodyParameter <IMicrosoftGraphSecurityRetentionEvent>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Update the navigation property retentionEvents in security
Additional Parameters
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
retentionEvent To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
| Type: | IMicrosoftGraphSecurityRetentionEvent |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
identitySet To construct, see NOTES section for CREATEDBY properties and create a hash table.
| Type: | IMicrosoftGraphIdentitySet |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The date time when the retentionEvent was created.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Optional information about the event.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Name of the event.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Represents the success status of a created event and additional information. To construct, see NOTES section for EVENTPROPAGATIONRESULTS properties and create a hash table.
| Type: | IMicrosoftGraphSecurityEventPropagationResult[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event. To construct, see NOTES section for EVENTQUERIES properties and create a hash table.
| Type: | IMicrosoftGraphSecurityEventQuery[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
retentionEventStatus To construct, see NOTES section for EVENTSTATUS properties and create a hash table.
| Type: | IMicrosoftGraphSecurityRetentionEventStatus |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Optional time when the event should be triggered.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Optional headers that will be added to the request.
| Type: | IDictionary |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
The unique identifier for an entity. Read-only.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | ISecurityIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
identitySet To construct, see NOTES section for LASTMODIFIEDBY properties and create a hash table.
| Type: | IMicrosoftGraphIdentitySet |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The latest date time when the retentionEvent was modified.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Last time the status of the event was updated.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
{{ Fill ProgressAction Description }}
| Type: | ActionPreference |
| Aliases: | proga |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Optional Response Headers Variable.
| Type: | String |
| Aliases: | RHV |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The unique identifier of retentionEvent
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
retentionEventType To construct, see NOTES section for RETENTIONEVENTTYPE properties and create a hash table.
| Type: | IMicrosoftGraphSecurityRetentionEventType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphSecurityRetentionEvent
Microsoft.Graph.Beta.PowerShell.Models.ISecurityIdentity
System.Collections.IDictionary
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphSecurityRetentionEvent
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 <IMicrosoftGraphSecurityRetentionEvent>: retentionEvent
[(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 retentionEvent was created.[Description <String>]: Optional information about the event.[DisplayName <String>]: Name of the event.[EventPropagationResults <IMicrosoftGraphSecurityEventPropagationResult-[]>]: Represents the success status of a created event and additional information.[Location <String>]: The name of the specific location in the workload associated with the event.[ServiceName <String>]: The name of the workload associated with the event.[Status <String>]: eventPropagationStatus[StatusInformation <String>]: Additional information about the status of the event creation request.
[EventQueries <IMicrosoftGraphSecurityEventQuery-[]>]: Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.[Query <String>]: Represents unique identification for the query. 'Asset ID' for SharePoint Online and OneDrive for Business, 'keywords' for Exchange Online.[QueryType <String>]: queryType
[EventStatus <IMicrosoftGraphSecurityRetentionEventStatus>]: retentionEventStatus[(Any) <Object>]: This indicates any property can be added to this object.[Error <IMicrosoftGraphPublicError>]: publicError[(Any) <Object>]: This indicates any property can be added to this object.[Code <String>]: Represents the error code.[Details <IMicrosoftGraphPublicErrorDetail-[]>]: Details of the error.[Code <String>]: The error code.[Message <String>]: The error message.[Target <String>]: The target of the error.
[InnerError <IMicrosoftGraphPublicInnerError>]: publicInnerError[(Any) <Object>]: This indicates any property can be added to this object.[Code <String>]: The error code.[Details <IMicrosoftGraphPublicErrorDetail-[]>]: A collection of error details.[Message <String>]: The error message.[Target <String>]: The target of the error.
[Message <String>]: A non-localized message for the developer.[Target <String>]: The target of the error.
[Status <String>]: eventStatusType
[EventTriggerDateTime <DateTime?>]: Optional time when the event should be triggered.[LastModifiedBy <IMicrosoftGraphIdentitySet>]: identitySet[LastModifiedDateTime <DateTime?>]: The latest date time when the retentionEvent was modified.[LastStatusUpdateDateTime <DateTime?>]: Last time the status of the event was updated.[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.
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
EVENTPROPAGATIONRESULTS <IMicrosoftGraphSecurityEventPropagationResult- []>: Represents the success status of a created event and additional information.
[Location <String>]: The name of the specific location in the workload associated with the event.[ServiceName <String>]: The name of the workload associated with the event.[Status <String>]: eventPropagationStatus[StatusInformation <String>]: Additional information about the status of the event creation request.
EVENTQUERIES <IMicrosoftGraphSecurityEventQuery- []>: Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.
[Query <String>]: Represents unique identification for the query. 'Asset ID' for SharePoint Online and OneDrive for Business, 'keywords' for Exchange Online.[QueryType <String>]: queryType
EVENTSTATUS <IMicrosoftGraphSecurityRetentionEventStatus>: retentionEventStatus
[(Any) <Object>]: This indicates any property can be added to this object.[Error <IMicrosoftGraphPublicError>]: publicError[(Any) <Object>]: This indicates any property can be added to this object.[Code <String>]: Represents the error code.[Details <IMicrosoftGraphPublicErrorDetail-[]>]: Details of the error.[Code <String>]: The error code.[Message <String>]: The error message.[Target <String>]: The target of the error.
[InnerError <IMicrosoftGraphPublicInnerError>]: publicInnerError[(Any) <Object>]: This indicates any property can be added to this object.[Code <String>]: The error code.[Details <IMicrosoftGraphPublicErrorDetail-[]>]: A collection of error details.[Message <String>]: The error message.[Target <String>]: The target of the error.
[Message <String>]: A non-localized message for the developer.[Target <String>]: The target of the error.
[Status <String>]: eventStatusType
INPUTOBJECT <ISecurityIdentity>: Identity Parameter
[AlertId <String>]: The unique identifier of alert[AnalyzedEmailId <String>]: The unique identifier of analyzedEmail[ArticleId <String>]: The unique identifier of article[ArticleIndicatorId <String>]: The unique identifier of articleIndicator[AttackSimulationOperationId <String>]: The unique identifier of attackSimulationOperation[AuditLogQueryId <String>]: The unique identifier of auditLogQuery[AuditLogRecordId <String>]: The unique identifier of auditLogRecord[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[CloudAppSecurityProfileId <String>]: The unique identifier of cloudAppSecurityProfile[CustomerInsightTenantId <String>]: The unique identifier of customerInsight[DataSourceId <String>]: The unique identifier of dataSource[DepartmentTemplateId <String>]: The unique identifier of departmentTemplate[DetectionRuleId <String>]: The unique identifier of detectionRule[DispositionReviewStageNumber <String>]: The unique identifier of dispositionReviewStage[DomainSecurityProfileId <String>]: The unique identifier of domainSecurityProfile[EdiscoveryCaseId <String>]: The unique identifier of ediscoveryCase[EdiscoveryCustodianId <String>]: The unique identifier of ediscoveryCustodian[EdiscoveryFileId <String>]: The unique identifier of ediscoveryFile[EdiscoveryHoldPolicyId <String>]: The unique identifier of ediscoveryHoldPolicy[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[EmailThreatSubmissionId <String>]: The unique identifier of emailThreatSubmission[EmailThreatSubmissionPolicyId <String>]: The unique identifier of emailThreatSubmissionPolicy[EndUserNotificationDetailId <String>]: The unique identifier of endUserNotificationDetail[EndUserNotificationId <String>]: The unique identifier of endUserNotification[FilePlanReferenceTemplateId <String>]: The unique identifier of filePlanReferenceTemplate[FileSecurityProfileId <String>]: The unique identifier of fileSecurityProfile[FileThreatSubmissionId <String>]: The unique identifier of fileThreatSubmission[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[HostSecurityProfileId <String>]: The unique identifier of hostSecurityProfile[HostSslCertificateId <String>]: The unique identifier of hostSslCertificate[HostTrackerId <String>]: The unique identifier of hostTracker[IPSecurityProfileId <String>]: The unique identifier of ipSecurityProfile[IncidentId <String>]: The unique identifier of incident[IntelligenceProfileId <String>]: The unique identifier of intelligenceProfile[IntelligenceProfileIndicatorId <String>]: The unique identifier of intelligenceProfileIndicator[LandingPageDetailId <String>]: The unique identifier of landingPageDetail[LandingPageId <String>]: The unique identifier of landingPage[LoginPageId <String>]: The unique identifier of loginPage[PartnerSecurityAlertId <String>]: The unique identifier of partnerSecurityAlert[PassiveDnsRecordId <String>]: The unique identifier of passiveDnsRecord[PayloadId <String>]: The unique identifier of payload[ProviderTenantSettingId <String>]: The unique identifier of providerTenantSetting[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[SecurityActionId <String>]: The unique identifier of securityAction[SecurityRequirementId <String>]: The unique identifier of securityRequirement[SecurityScoreHistoryId <String>]: The unique identifier of securityScoreHistory[SensitivityLabelId <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[TiIndicatorId <String>]: The unique identifier of tiIndicator[TrainingCampaignId <String>]: The unique identifier of trainingCampaign[TrainingId <String>]: The unique identifier of training[TrainingLanguageDetailId <String>]: The unique identifier of trainingLanguageDetail[UnifiedGroupSourceId <String>]: The unique identifier of unifiedGroupSource[UrlThreatSubmissionId <String>]: The unique identifier of urlThreatSubmission[UserId <String>]: The unique identifier of user[UserSecurityProfileId <String>]: The unique identifier of userSecurityProfile[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.