Share via

New-MgBetaDeviceManagementDeviceCompliancePolicy

  • Reference
Module:
Microsoft.Graph.Beta.DeviceManagement

Create new navigation property to deviceCompliancePolicies for deviceManagement

Note

To view the v1.0 release of this cmdlet, view New-MgDeviceManagementDeviceCompliancePolicy

Syntax

New-MgBetaDeviceManagementDeviceCompliancePolicy
   [-ResponseHeadersVariable <String>]
   [-AdditionalProperties <Hashtable>]
   [-Assignments <IMicrosoftGraphDeviceCompliancePolicyAssignment[]>]
   [-CreatedDateTime <DateTime>]
   [-Description <String>]
   [-DeviceSettingStateSummaries <IMicrosoftGraphSettingStateDeviceSummary[]>]
   [-DeviceStatusOverview <IMicrosoftGraphDeviceComplianceDeviceOverview>]
   [-DeviceStatuses <IMicrosoftGraphDeviceComplianceDeviceStatus[]>]
   [-DisplayName <String>]
   [-Id <String>]
   [-LastModifiedDateTime <DateTime>]
   [-RoleScopeTagIds <String[]>]
   [-ScheduledActionsForRule <IMicrosoftGraphDeviceComplianceScheduledActionForRule[]>]
   [-UserStatusOverview <IMicrosoftGraphDeviceComplianceUserOverview>]
   [-UserStatuses <IMicrosoftGraphDeviceComplianceUserStatus[]>]
   [-Version <Int32>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-MgBetaDeviceManagementDeviceCompliancePolicy
   -BodyParameter <IMicrosoftGraphDeviceCompliancePolicy>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Create new navigation property to deviceCompliancePolicies for deviceManagement

Parameters

-AdditionalProperties

Additional Parameters

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Assignments

The collection of assignments for this compliance policy. To construct, see NOTES section for ASSIGNMENTS properties and create a hash table.

Type:IMicrosoftGraphDeviceCompliancePolicyAssignment[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-BodyParameter

This is the base class for Compliance policy. Compliance policies are platform specific and individual per-platform compliance policies inherit from here.

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

Type:IMicrosoftGraphDeviceCompliancePolicy
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

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

-CreatedDateTime

DateTime the object was created.

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Admin provided description of the Device Configuration.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DeviceSettingStateSummaries

Compliance Setting State Device Summary To construct, see NOTES section for DEVICESETTINGSTATESUMMARIES properties and create a hash table.

Type:IMicrosoftGraphSettingStateDeviceSummary[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DeviceStatuses

List of DeviceComplianceDeviceStatus. To construct, see NOTES section for DEVICESTATUSES properties and create a hash table.

Type:IMicrosoftGraphDeviceComplianceDeviceStatus[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DeviceStatusOverview

deviceComplianceDeviceOverview To construct, see NOTES section for DEVICESTATUSOVERVIEW properties and create a hash table.

Type:IMicrosoftGraphDeviceComplianceDeviceOverview
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisplayName

Admin provided name of the device configuration.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Headers

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

-Id

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

-LastModifiedDateTime

DateTime the object was last modified.

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProgressAction

{{ Fill ProgressAction Description }}

Type:ActionPreference
Aliases:proga
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:String
Aliases:RHV
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RoleScopeTagIds

List of Scope Tags for this Entity instance.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ScheduledActionsForRule

The list of scheduled action per rule for this compliance policy. This is a required property when creating any individual per-platform compliance policies. To construct, see NOTES section for SCHEDULEDACTIONSFORRULE properties and create a hash table.

Type:IMicrosoftGraphDeviceComplianceScheduledActionForRule[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UserStatuses

List of DeviceComplianceUserStatus. To construct, see NOTES section for USERSTATUSES properties and create a hash table.

Type:IMicrosoftGraphDeviceComplianceUserStatus[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UserStatusOverview

deviceComplianceUserOverview To construct, see NOTES section for USERSTATUSOVERVIEW properties and create a hash table.

Type:IMicrosoftGraphDeviceComplianceUserOverview
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Version

Version of the device configuration.

Type:Int32
Position:Named
Default value:0
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphDeviceCompliancePolicy

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphDeviceCompliancePolicy

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.

ASSIGNMENTS <IMicrosoftGraphDeviceCompliancePolicyAssignment- []>: The collection of assignments for this compliance policy.

  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [Source <DeviceAndAppManagementAssignmentSource?>]: Represents source of assignment.
  • [SourceId <String>]: The identifier of the source of the assignment.
  • [Target <IMicrosoftGraphDeviceAndAppManagementAssignmentTarget>]: Base type for assignment targets.
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DeviceAndAppManagementAssignmentFilterId <String>]: The Id of the filter for the target assignment.
    • [DeviceAndAppManagementAssignmentFilterType <DeviceAndAppManagementAssignmentFilterType?>]: Represents type of the assignment filter.

BODYPARAMETER <IMicrosoftGraphDeviceCompliancePolicy>: This is the base class for Compliance policy. Compliance policies are platform specific and individual per-platform compliance policies inherit from here.

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [Assignments <IMicrosoftGraphDeviceCompliancePolicyAssignment- []>]: The collection of assignments for this compliance policy.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [Source <DeviceAndAppManagementAssignmentSource?>]: Represents source of assignment.
    • [SourceId <String>]: The identifier of the source of the assignment.
    • [Target <IMicrosoftGraphDeviceAndAppManagementAssignmentTarget>]: Base type for assignment targets.
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [DeviceAndAppManagementAssignmentFilterId <String>]: The Id of the filter for the target assignment.
      • [DeviceAndAppManagementAssignmentFilterType <DeviceAndAppManagementAssignmentFilterType?>]: Represents type of the assignment filter.
  • [CreatedDateTime <DateTime?>]: DateTime the object was created.
  • [Description <String>]: Admin provided description of the Device Configuration.
  • [DeviceSettingStateSummaries <IMicrosoftGraphSettingStateDeviceSummary- []>]: Compliance Setting State Device Summary
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [CompliantDeviceCount <Int32?>]: Device Compliant count for the setting
    • [ConflictDeviceCount <Int32?>]: Device conflict error count for the setting
    • [ErrorDeviceCount <Int32?>]: Device error count for the setting
    • [InstancePath <String>]: Name of the InstancePath for the setting
    • [NonCompliantDeviceCount <Int32?>]: Device NonCompliant count for the setting
    • [NotApplicableDeviceCount <Int32?>]: Device Not Applicable count for the setting
    • [RemediatedDeviceCount <Int32?>]: Device Compliant count for the setting
    • [SettingName <String>]: Name of the setting
    • [UnknownDeviceCount <Int32?>]: Device Unkown count for the setting
  • [DeviceStatusOverview <IMicrosoftGraphDeviceComplianceDeviceOverview>]: deviceComplianceDeviceOverview
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [ConfigurationVersion <Int32?>]: Version of the policy for that overview
    • [ConflictCount <Int32?>]: Number of devices in conflict
    • [ErrorCount <Int32?>]: Number of error devices
    • [FailedCount <Int32?>]: Number of failed devices
    • [LastUpdateDateTime <DateTime?>]: Last update time
    • [NotApplicableCount <Int32?>]: Number of not applicable devices
    • [NotApplicablePlatformCount <Int32?>]: Number of not applicable devices due to mismatch platform and policy
    • [PendingCount <Int32?>]: Number of pending devices
    • [SuccessCount <Int32?>]: Number of succeeded devices
  • [DeviceStatuses <IMicrosoftGraphDeviceComplianceDeviceStatus- []>]: List of DeviceComplianceDeviceStatus.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [ComplianceGracePeriodExpirationDateTime <DateTime?>]: The DateTime when device compliance grace period expires
    • [DeviceDisplayName <String>]: Device name of the DevicePolicyStatus.
    • [DeviceModel <String>]: The device model that is being reported
    • [LastReportedDateTime <DateTime?>]: Last modified date time of the policy report.
    • [Platform <Int32?>]: Platform of the device that is being reported
    • [Status <String>]: complianceStatus
    • [UserName <String>]: The User Name that is being reported
    • [UserPrincipalName <String>]: UserPrincipalName.
  • [DisplayName <String>]: Admin provided name of the device configuration.
  • [LastModifiedDateTime <DateTime?>]: DateTime the object was last modified.
  • [RoleScopeTagIds <String- []>]: List of Scope Tags for this Entity instance.
  • [ScheduledActionsForRule <IMicrosoftGraphDeviceComplianceScheduledActionForRule- []>]: The list of scheduled action per rule for this compliance policy. This is a required property when creating any individual per-platform compliance policies.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [RuleName <String>]: Name of the rule which this scheduled action applies to. Currently scheduled actions are created per policy instead of per rule, thus RuleName is always set to default value PasswordRequired.
    • [ScheduledActionConfigurations <IMicrosoftGraphDeviceComplianceActionItem- []>]: The list of scheduled action configurations for this compliance policy. Compliance policy must have one and only one block scheduled action.
      • [Id <String>]: The unique identifier for an entity. Read-only.
      • [ActionType <DeviceComplianceActionType?>]: Scheduled Action Type Enum
      • [GracePeriodHours <Int32?>]: Number of hours to wait till the action will be enforced. Valid values 0 to 8760
      • [NotificationMessageCcList <String- []>]: A list of group IDs to speicify who to CC this notification message to.
      • [NotificationTemplateId <String>]: What notification Message template to use
  • [UserStatusOverview <IMicrosoftGraphDeviceComplianceUserOverview>]: deviceComplianceUserOverview
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [ConfigurationVersion <Int32?>]: Version of the policy for that overview
    • [ConflictCount <Int32?>]: Number of users in conflict
    • [ErrorCount <Int32?>]: Number of error Users
    • [FailedCount <Int32?>]: Number of failed Users
    • [LastUpdateDateTime <DateTime?>]: Last update time
    • [NotApplicableCount <Int32?>]: Number of not applicable users
    • [PendingCount <Int32?>]: Number of pending Users
    • [SuccessCount <Int32?>]: Number of succeeded Users
  • [UserStatuses <IMicrosoftGraphDeviceComplianceUserStatus- []>]: List of DeviceComplianceUserStatus.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [DevicesCount <Int32?>]: Devices count for that user.
    • [LastReportedDateTime <DateTime?>]: Last modified date time of the policy report.
    • [Status <String>]: complianceStatus
    • [UserDisplayName <String>]: User name of the DevicePolicyStatus.
    • [UserPrincipalName <String>]: UserPrincipalName.
  • [Version <Int32?>]: Version of the device configuration.

DEVICESETTINGSTATESUMMARIES <IMicrosoftGraphSettingStateDeviceSummary- []>: Compliance Setting State Device Summary

  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [CompliantDeviceCount <Int32?>]: Device Compliant count for the setting
  • [ConflictDeviceCount <Int32?>]: Device conflict error count for the setting
  • [ErrorDeviceCount <Int32?>]: Device error count for the setting
  • [InstancePath <String>]: Name of the InstancePath for the setting
  • [NonCompliantDeviceCount <Int32?>]: Device NonCompliant count for the setting
  • [NotApplicableDeviceCount <Int32?>]: Device Not Applicable count for the setting
  • [RemediatedDeviceCount <Int32?>]: Device Compliant count for the setting
  • [SettingName <String>]: Name of the setting
  • [UnknownDeviceCount <Int32?>]: Device Unkown count for the setting

DEVICESTATUSES <IMicrosoftGraphDeviceComplianceDeviceStatus- []>: List of DeviceComplianceDeviceStatus.

  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [ComplianceGracePeriodExpirationDateTime <DateTime?>]: The DateTime when device compliance grace period expires
  • [DeviceDisplayName <String>]: Device name of the DevicePolicyStatus.
  • [DeviceModel <String>]: The device model that is being reported
  • [LastReportedDateTime <DateTime?>]: Last modified date time of the policy report.
  • [Platform <Int32?>]: Platform of the device that is being reported
  • [Status <String>]: complianceStatus
  • [UserName <String>]: The User Name that is being reported
  • [UserPrincipalName <String>]: UserPrincipalName.

DEVICESTATUSOVERVIEW <IMicrosoftGraphDeviceComplianceDeviceOverview>: deviceComplianceDeviceOverview

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [ConfigurationVersion <Int32?>]: Version of the policy for that overview
  • [ConflictCount <Int32?>]: Number of devices in conflict
  • [ErrorCount <Int32?>]: Number of error devices
  • [FailedCount <Int32?>]: Number of failed devices
  • [LastUpdateDateTime <DateTime?>]: Last update time
  • [NotApplicableCount <Int32?>]: Number of not applicable devices
  • [NotApplicablePlatformCount <Int32?>]: Number of not applicable devices due to mismatch platform and policy
  • [PendingCount <Int32?>]: Number of pending devices
  • [SuccessCount <Int32?>]: Number of succeeded devices

SCHEDULEDACTIONSFORRULE <IMicrosoftGraphDeviceComplianceScheduledActionForRule- []>: The list of scheduled action per rule for this compliance policy. This is a required property when creating any individual per-platform compliance policies.

  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [RuleName <String>]: Name of the rule which this scheduled action applies to. Currently scheduled actions are created per policy instead of per rule, thus RuleName is always set to default value PasswordRequired.
  • [ScheduledActionConfigurations <IMicrosoftGraphDeviceComplianceActionItem- []>]: The list of scheduled action configurations for this compliance policy. Compliance policy must have one and only one block scheduled action.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [ActionType <DeviceComplianceActionType?>]: Scheduled Action Type Enum
    • [GracePeriodHours <Int32?>]: Number of hours to wait till the action will be enforced. Valid values 0 to 8760
    • [NotificationMessageCcList <String- []>]: A list of group IDs to speicify who to CC this notification message to.
    • [NotificationTemplateId <String>]: What notification Message template to use

USERSTATUSES <IMicrosoftGraphDeviceComplianceUserStatus- []>: List of DeviceComplianceUserStatus.

  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [DevicesCount <Int32?>]: Devices count for that user.
  • [LastReportedDateTime <DateTime?>]: Last modified date time of the policy report.
  • [Status <String>]: complianceStatus
  • [UserDisplayName <String>]: User name of the DevicePolicyStatus.
  • [UserPrincipalName <String>]: UserPrincipalName.

USERSTATUSOVERVIEW <IMicrosoftGraphDeviceComplianceUserOverview>: deviceComplianceUserOverview

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [ConfigurationVersion <Int32?>]: Version of the policy for that overview
  • [ConflictCount <Int32?>]: Number of users in conflict
  • [ErrorCount <Int32?>]: Number of error Users
  • [FailedCount <Int32?>]: Number of failed Users
  • [LastUpdateDateTime <DateTime?>]: Last update time
  • [NotApplicableCount <Int32?>]: Number of not applicable users
  • [PendingCount <Int32?>]: Number of pending Users
  • [SuccessCount <Int32?>]: Number of succeeded Users

https://learn.microsoft.com/powershell/module/microsoft.graph.beta.devicemanagement/new-mgbetadevicemanagementdevicecompliancepolicy