Share via

Update-MgBetaReportHealthMonitoringAlert

Module:
Microsoft.Graph.Beta.Reports Module

Update the properties of a Microsoft Entra health monitoring alert object. For example, change an alert's state from active to resolved.

Syntax

UpdateExpanded (Default) 

Update-MgBetaReportHealthMonitoringAlert
    -AlertId <String>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-AlertType <String>]
    [-Category <String>]
    [-CreatedDateTime <DateTime>]
    [-Documentation <Hashtable>]
    [-Enrichment <IMicrosoftGraphHealthMonitoringEnrichment>]
    [-Id <String>]
    [-Scenario <String>]
    [-Signals <Hashtable>]
    [-State <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update 

Update-MgBetaReportHealthMonitoringAlert
    -AlertId <String>
    -BodyParameter <IMicrosoftGraphHealthMonitoringAlert>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentityExpanded 

Update-MgBetaReportHealthMonitoringAlert
    -InputObject <IReportsIdentity>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-AlertType <String>]
    [-Category <String>]
    [-CreatedDateTime <DateTime>]
    [-Documentation <Hashtable>]
    [-Enrichment <IMicrosoftGraphHealthMonitoringEnrichment>]
    [-Id <String>]
    [-Scenario <String>]
    [-Signals <Hashtable>]
    [-State <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentity 

Update-MgBetaReportHealthMonitoringAlert
    -InputObject <IReportsIdentity>
    -BodyParameter <IMicrosoftGraphHealthMonitoringAlert>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Update the properties of a Microsoft Entra health monitoring alert object. For example, change an alert's state from active to resolved.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) HealthMonitoringAlert.ReadWrite.All,
Delegated (personal Microsoft account) Not supported
Application HealthMonitoringAlert.ReadWrite.All,

Examples

Example 1: Code snippet


Import-Module Microsoft.Graph.Beta.Reports

$params = @{
	state = "resolved"
}

Update-MgBetaReportHealthMonitoringAlert -AlertId $alertId -BodyParameter $params

This example shows how to use the Update-MgBetaReportHealthMonitoringAlert Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

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

Parameter sets

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

-AlertId

The unique identifier of alert

Parameter properties

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

Parameter sets

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

-AlertType

alertType

Parameter properties

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

Parameter sets

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

-BodyParameter

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

Parameter properties

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

Parameter sets

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

-Category

category

Parameter properties

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

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
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

-CreatedDateTime

The time when Microsoft Entra Health monitoring generated the alert. Supports $orderby.

Parameter properties

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

Parameter sets

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

-Documentation

documentation

Parameter properties

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

Parameter sets

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

-Enrichment

enrichment To construct, see NOTES section for ENRICHMENT properties and create a hash table.

Parameter properties

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

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
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

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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

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

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
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

-Scenario

scenario

Parameter properties

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

Parameter sets

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

-Signals

signals

Parameter properties

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

Parameter sets

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

-State

alertState

Parameter properties

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

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
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.IMicrosoftGraphHealthMonitoringAlert

Microsoft.Graph.Beta.PowerShell.Models.IReportsIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphHealthMonitoringAlert

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 <IMicrosoftGraphHealthMonitoringAlert>: alert

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [AlertType <String>]: alertType
  • [Category <String>]: category
  • [CreatedDateTime <DateTime?>]: The time when Microsoft Entra Health monitoring generated the alert. Supports $orderby.
  • [Documentation <IMicrosoftGraphHealthMonitoringDocumentation>]: documentation
    • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Enrichment <IMicrosoftGraphHealthMonitoringEnrichment>]: enrichment
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Impacts <IMicrosoftGraphHealthMonitoringResourceImpactSummary- []>]: A collection of resource impact summaries that gives a high level view of the kind of resources that were impacted and to what degree.
      • [ImpactedCount <String>]: The number of resources impacted. The number could be an exhaustive count or a sampling count.
      • [ImpactedCountLimitExceeded <Boolean?>]: Indicates whether impactedCount is exhaustive or a sampling. When this value is true, the limit was exceeded and impactedCount represents a sampling; otherwise, impactedCount represents the true number of impacts.
      • [ResourceType <String>]: The type of resource that was impacted. Examples include user, group, application, servicePrincipal, device.
    • [State <String>]: enrichmentState
    • [SupportingData <IMicrosoftGraphHealthMonitoringSupportingData>]: supportingData
      • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Scenario <String>]: scenario
  • [Signals <IMicrosoftGraphHealthMonitoringSignals>]: signals
    • [(Any) <Object>]: This indicates any property can be added to this object.
  • [State <String>]: alertState

ENRICHMENT <IMicrosoftGraphHealthMonitoringEnrichment>: enrichment

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Impacts <IMicrosoftGraphHealthMonitoringResourceImpactSummary- []>]: A collection of resource impact summaries that gives a high level view of the kind of resources that were impacted and to what degree.
    • [ImpactedCount <String>]: The number of resources impacted. The number could be an exhaustive count or a sampling count.
    • [ImpactedCountLimitExceeded <Boolean?>]: Indicates whether impactedCount is exhaustive or a sampling. When this value is true, the limit was exceeded and impactedCount represents a sampling; otherwise, impactedCount represents the true number of impacts.
    • [ResourceType <String>]: The type of resource that was impacted. Examples include user, group, application, servicePrincipal, device.
  • [State <String>]: enrichmentState
  • [SupportingData <IMicrosoftGraphHealthMonitoringSupportingData>]: supportingData
    • [(Any) <Object>]: This indicates any property can be added to this object.

INPUTOBJECT <IReportsIdentity>: Identity Parameter

  • [ActiveUsersMetricId <String>]: The unique identifier of activeUsersMetric
  • [AlertConfigurationId <String>]: The unique identifier of alertConfiguration
  • [AlertId <String>]: The unique identifier of alert
  • [AppCredentialSignInActivityId <String>]: The unique identifier of appCredentialSignInActivity
  • [ApplicationSignInDetailedSummaryId <String>]: The unique identifier of applicationSignInDetailedSummary
  • [AuthenticationsMetricId <String>]: The unique identifier of authenticationsMetric
  • [CredentialUserRegistrationDetailsId <String>]: The unique identifier of credentialUserRegistrationDetails
  • [CustomSecurityAttributeAuditId <String>]: The unique identifier of customSecurityAttributeAudit
  • [DailyInactiveUsersByApplicationMetricId <String>]: The unique identifier of dailyInactiveUsersByApplicationMetric
  • [DailyInactiveUsersMetricId <String>]: The unique identifier of dailyInactiveUsersMetric
  • [Date <DateTime?>]: Usage: date={date}
  • [DeviceManagementCachedReportConfigurationId <String>]: The unique identifier of deviceManagementCachedReportConfiguration
  • [DeviceManagementExportJobId <String>]: The unique identifier of deviceManagementExportJob
  • [DirectoryAuditId <String>]: The unique identifier of directoryAudit
  • [EndDateTime <DateTime?>]: Usage: endDateTime={endDateTime}
  • [ExclusiveIntervalEndDateTime <DateTime?>]: Usage: exclusiveIntervalEndDateTime={exclusiveIntervalEndDateTime}
  • [Filter <String>]: Usage: filter='{filter}'
  • [GroupId <String>]: Usage: groupId='{groupId}'
  • [IncludedUserRoles <String>]: Usage: includedUserRoles='{includedUserRoles}'
  • [IncludedUserTypes <String>]: Usage: includedUserTypes='{includedUserTypes}'
  • [InclusiveIntervalStartDateTime <DateTime?>]: Usage: inclusiveIntervalStartDateTime={inclusiveIntervalStartDateTime}
  • [InsightSummaryId <String>]: The unique identifier of insightSummary
  • [ManifestId <String>]: The unique identifier of manifest
  • [MfaCompletionMetricId <String>]: The unique identifier of mfaCompletionMetric
  • [MfaTelecomFraudMetricId <String>]: The unique identifier of mfaTelecomFraudMetric
  • [MfaUserCountMetricId <String>]: The unique identifier of mfaUserCountMetric
  • [MonthlyInactiveUsersByApplicationMetricId <String>]: The unique identifier of monthlyInactiveUsersByApplicationMetric
  • [MonthlyInactiveUsersMetricId <String>]: The unique identifier of monthlyInactiveUsersMetric
  • [OperationId <String>]: The unique identifier of operation
  • [Period <String>]: Usage: period='{period}'
  • [PrintUsageByPrinterId <String>]: The unique identifier of printUsageByPrinter
  • [PrintUsageByUserId <String>]: The unique identifier of printUsageByUser
  • [PrintUsageId <String>]: The unique identifier of printUsage
  • [PrinterId <String>]: Usage: printerId='{printerId}'
  • [ProvisioningObjectSummaryId <String>]: The unique identifier of provisioningObjectSummary
  • [SelfServiceSignUpId <String>]: The unique identifier of selfServiceSignUp
  • [ServicePrincipalSignInActivityId <String>]: The unique identifier of servicePrincipalSignInActivity
  • [SignInId <String>]: The unique identifier of signIn
  • [Skip <Int32?>]: Usage: skip={skip}
  • [SkipToken <String>]: Usage: skipToken='{skipToken}'
  • [StartDateTime <DateTime?>]: Usage: startDateTime={startDateTime}
  • [Top <Int32?>]: Usage: top={top}
  • [UserCountMetricId <String>]: The unique identifier of userCountMetric
  • [UserCredentialUsageDetailsId <String>]: The unique identifier of userCredentialUsageDetails
  • [UserId <String>]: Usage: userId='{userId}'
  • [UserRegistrationDetailsId <String>]: The unique identifier of userRegistrationDetails
  • [UserRequestsMetricId <String>]: The unique identifier of userRequestsMetric
  • [UserSignUpMetricId <String>]: The unique identifier of userSignUpMetric