IntuneAlertRuleWindows365

Parameters

Parameter Attribute DataType Description Allowed Values
AlertRuleTemplate Key String The rule template of the alert event. The possible values are: cloudPcProvisionScenario, cloudPcImageUploadScenario, cloudPcOnPremiseNetworkConnectionCheckScenario, cloudPcInGracePeriodScenario, cloudPcFrontlineInsufficientLicensesScenario, cloudPcInaccessibleScenario, cloudPcFrontlineConcurrencyScenario, cloudPcUserSettingsPersistenceScenario, cloudPcDeprovisionFailedScenario. cloudPcProvisionScenario, cloudPcImageUploadScenario, cloudPcOnPremiseNetworkConnectionCheckScenario, cloudPcInGracePeriodScenario, cloudPcFrontlineInsufficientLicensesScenario, cloudPcInaccessibleScenario, cloudPcFrontlineConcurrencyScenario, cloudPcUserSettingsPersistenceScenario, cloudPcDeprovisionFailedScenario
Conditions Write MSFT_IntuneAlertRuleCondition[] The conditions that determine when to send alerts. For example, you can configure a condition to send an alert when provisioning fails for six or more Cloud PCs.
Enabled Write Boolean The status of the rule that indicates whether the rule is enabled or disabled. If true, the rule is enabled otherwise, the rule is disabled.
NotificationChannels Write MSFT_IntuneAlertRuleNotificationChannel[] The notification channels of the rule selected by the user.
Severity Write String The severity of the rule. The possible values are: informational, warning, critical. Critical, Warning, Informational
Ensure Write String Present ensures the rule exists. Alert rules for Windows365 cannot be removed. Present
Credential Write PSCredential Credentials of the Admin
ApplicationId Write String Id of the Azure Active Directory application to authenticate with.
TenantId Write String Id of the Azure Active Directory tenant used for authentication.
ApplicationSecret Write PSCredential Secret of the Azure Active Directory tenant used for authentication.
CertificateThumbprint Write String Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication.
ManagedIdentity Write Boolean Managed ID being used for authentication.
AccessTokens Write StringArray[] Access token used for authentication.

MSFT_IntuneAlertRuleNotificationChannelReceiver

Parameters

Parameter Attribute DataType Description Allowed Values
ContactInformation Write String The email address of the receiver.
Locale Write String The locale of the email. en-us, cs-cz, de-de, es-es, fr-fr, hu-hu, it-it, ja-jp, ko-kr, nl-nl, pl-pl, pt-br, pt-pt, ru-ru, sv-se, tr-tr, zh-cn, zh-tw

MSFT_IntuneAlertRuleNotificationChannel

Parameters

Parameter Attribute DataType Description Allowed Values
NotificationChannelType Write String The notification channel type. portal, email
NotificationReceivers Write MSFT_IntuneAlertRuleNotificationChannelReceiver[] The receivers of the notification. Only applicable if the NotificationChannelType is 'email'.

MSFT_IntuneAlertRuleCondition

Parameters

Parameter Attribute DataType Description Allowed Values
Aggregation Write String The built-in aggregation method for the rule condition. The possible values are: count, percentage, affectedCloudPcCount, affectedCloudPcPercentage, durationInMinutes. count, percentage, affectedCloudPcCount, affectedCloudPcPercentage, durationInMinutes
ConditionCategory Write String The property that the rule condition monitors. Possible values are: provisionFailures, imageUploadFailures, azureNetworkConnectionCheckFailures, cloudPcInGracePeriod, frontlineInsufficientLicenses, cloudPcConnectionErrors, cloudPcHostHealthCheckFailures, cloudPcZoneOutage, unknownFutureValue, frontlineBufferUsageDuration, frontlineBufferUsageThreshold, cloudPcUserSettingsPersistenceUsageThreshold, cloudPcDeprovisionedThreshold, cloudPcReserveDeprovisionFailedThreshold. provisionFailures, imageUploadFailures, azureNetworkConnectionCheckFailures, cloudPcInGracePeriod, frontlineInsufficientLicenses, cloudPcConnectionErrors, cloudPcHostHealthCheckFailures, cloudPcZoneOutage, unknownFutureValue, frontlineBufferUsageDuration, frontlineBufferUsageThreshold, cloudPcUserSettingsPersistenceUsageThreshold, cloudPcDeprovisionedThreshold, cloudPcReserveDeprovisionFailedThreshold
Operator Write String The built-in operator for the rule condition. The possible values are: greaterOrEqual, equal, greater, less, lessOrEqual, notEqual. greaterOrEqual, greater, equal, less, lessOrEqual
RelationshipType Write String The relationship type. Possible values are: and, or. and, or
ThresholdValue Write String The threshold value of the alert condition. The threshold value can be a number in string form or string like 'WestUS'.

Description

Intune Alert Rule Windows365

Permissions

Microsoft Graph

To authenticate with the Microsoft Graph API, this resource required the following permissions:

Delegated permissions

  • Read

    • CloudPC.Read.All
  • Update

    • CloudPC.ReadWrite.All

Application permissions

  • Read

    • CloudPC.Read.All
  • Update

    • CloudPC.ReadWrite.All

Examples

Example 1

This example is used to test new resources and showcase the usage of new resources being worked on. It is not meant to use as a production baseline.

Configuration Example
{
    param(
        [Parameter()]
        [System.String]
        $ApplicationId,

        [Parameter()]
        [System.String]
        $TenantId,

        [Parameter()]
        [System.String]
        $CertificateThumbprint
    )

    Import-DscResource -ModuleName Microsoft365DSC
    node localhost
    {
        IntuneAlertRuleWindows365 "IntuneAlertRuleWindows365-cloudPcProvisionScenario"
        {
            AlertRuleTemplate     = "cloudPcProvisionScenario";
            Conditions            = @(
                MSFT_IntuneAlertRuleCondition{
                    Aggregation = "affectedCloudPcCount"
                    ConditionCategory = "provisionFailures"
                    ThresholdValue = "1"
                    RelationshipType = "or"
                    Operator = "greaterOrEqual"
                }
            );
            Enabled               = $True; # Updated property
            NotificationChannels  = @(
                MSFT_IntuneAlertRuleNotificationChannel{
                    NotificationChannelType = "portal"
                }
            );
            Severity              = "warning";
            Ensure                = "Present";
            ApplicationId         = $ApplicationId;
            TenantId              = $TenantId;
            CertificateThumbprint = $CertificateThumbprint;
        }
    }
}