Share via

Update-MgBetaReportHealthMonitoringAlertConfiguration

Module:
Microsoft.Graph.Beta.Reports Module

Update the properties of a Microsoft Entra health monitoring alertConfiguration object. You can use alertConfiguration settings to specify the distribution groups where alert notifications are to be sent. This API doesn't currently support group validation.

Syntax

UpdateExpanded (Default) 

Update-MgBetaReportHealthMonitoringAlertConfiguration
    -AlertConfigurationId <string>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-EmailNotificationConfigurations <IMicrosoftGraphHealthMonitoringEmailNotificationConfiguration[]>]
    [-Id <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update 

Update-MgBetaReportHealthMonitoringAlertConfiguration
    -AlertConfigurationId <string>
    -BodyParameter <IMicrosoftGraphHealthMonitoringAlertConfiguration>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentityExpanded 

Update-MgBetaReportHealthMonitoringAlertConfiguration
    -InputObject <IReportsIdentity>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-EmailNotificationConfigurations <IMicrosoftGraphHealthMonitoringEmailNotificationConfiguration[]>]
    [-Id <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentity 

Update-MgBetaReportHealthMonitoringAlertConfiguration
    -InputObject <IReportsIdentity>
    -BodyParameter <IMicrosoftGraphHealthMonitoringAlertConfiguration>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Update the properties of a Microsoft Entra health monitoring alertConfiguration object. You can use alertConfiguration settings to specify the distribution groups where alert notifications are to be sent. This API doesn't currently support group validation.

Examples

Example 1: Code snippet


Import-Module Microsoft.Graph.Beta.Reports

$params = @{
	emailNotificationConfigurations = @(
		@{
			groupId = "c5140914-9507-4180-b60c-04d5ec5eddcb"
			isEnabled = $true
		}
	)
}

Update-MgBetaReportHealthMonitoringAlertConfiguration -AlertConfigurationId $alertConfigurationId -BodyParameter $params

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

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:System.Collections.Hashtable
Supports wildcards:False
DontShow:False

Parameter sets

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

-AlertConfigurationId

The unique identifier of alertConfiguration

Parameter properties

Type:System.String
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

-BodyParameter

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

Parameter properties

Type:Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphHealthMonitoringAlertConfiguration
Supports wildcards:False
DontShow:False

Parameter sets

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

-Break

Wait for .NET debugger to attach

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
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:System.Management.Automation.SwitchParameter
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

-EmailNotificationConfigurations

Defines the recipients of email notifications for an alert type. Currently, only one email notification configuration is supported for an alert configuration, meaning only one group can receive notifications for an alert type. To construct, see NOTES section for EMAILNOTIFICATIONCONFIGURATIONS properties and create a hash table.

Parameter properties

Type:

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphHealthMonitoringEmailNotificationConfiguration[]

Supports wildcards:False
DontShow:False

Parameter sets

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

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

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

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

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

-Id

The unique identifier for an entity. Read-only.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
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:Microsoft.Graph.Beta.PowerShell.Models.IReportsIdentity
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

-Proxy

The URI for the proxy server to use

Parameter properties

Type:System.Uri
Supports wildcards:False
DontShow:False

Parameter sets

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

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:System.Management.Automation.PSCredential
Supports wildcards:False
DontShow:False

Parameter sets

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

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
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:System.String
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

-WhatIf

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.

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphHealthMonitoringAlertConfiguration

{{ Fill in the Description }}

Microsoft.Graph.Beta.PowerShell.Models.IReportsIdentity

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphHealthMonitoringAlertConfiguration

{{ Fill in the Description }}

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 <IMicrosoftGraphHealthMonitoringAlertConfiguration>: alertConfiguration [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [EmailNotificationConfigurations <IMicrosoftGraphHealthMonitoringEmailNotificationConfiguration[]>]: Defines the recipients of email notifications for an alert type. Currently, only one email notification configuration is supported for an alert configuration, meaning only one group can receive notifications for an alert type. [GroupId <String>]: The identifier of the group to send an email to. All group types with configured email addresses are supported. [IsEnabled <Boolean?>]: Indicates whether email notifications are enabled on the alert type.

EMAILNOTIFICATIONCONFIGURATIONS <IMicrosoftGraphHealthMonitoringEmailNotificationConfiguration[]>: Defines the recipients of email notifications for an alert type. Currently, only one email notification configuration is supported for an alert configuration, meaning only one group can receive notifications for an alert type. [GroupId <String>]: The identifier of the group to send an email to. All group types with configured email addresses are supported. [IsEnabled <Boolean?>]: Indicates whether email notifications are enabled on the alert type.

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 [UserEventsSummaryId <String>]: The unique identifier of userEventsSummary [UserId <String>]: Usage: userId='{userId}' [UserMfaSignInSummaryId <String>]: The unique identifier of userMfaSignInSummary [UserPasswordResetsAndChangesSummaryId <String>]: The unique identifier of userPasswordResetsAndChangesSummary [UserRegistrationDetailsId <String>]: The unique identifier of userRegistrationDetails [UserRequestsMetricId <String>]: The unique identifier of userRequestsMetric [UserSignUpMetricId <String>]: The unique identifier of userSignUpMetric