Share via


New-MgBetaDeviceManagementDeviceCompliancePolicy

Create new navigation property to deviceCompliancePolicies for deviceManagement

Note

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

Syntax

CreateExpanded (Default)

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>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Create

New-MgBetaDeviceManagementDeviceCompliancePolicy
    -BodyParameter <IMicrosoftGraphDeviceCompliancePolicy>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Create new navigation property to deviceCompliancePolicies for deviceManagement

Permissions

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

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

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

Parameter sets

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

-Assignments

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

Parameter properties

Type:

IMicrosoftGraphDeviceCompliancePolicyAssignment[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

Parameter properties

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

Parameter sets

Create
Position:Named
Mandatory:True
Value from pipeline:True
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

DateTime the object was created.

Parameter properties

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

Parameter sets

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

-Description

Admin provided description of the Device Configuration.

Parameter properties

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

Parameter sets

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

-DeviceSettingStateSummaries

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

Parameter properties

Type:

IMicrosoftGraphSettingStateDeviceSummary[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-DeviceStatuses

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

Parameter properties

Type:

IMicrosoftGraphDeviceComplianceDeviceStatus[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-DeviceStatusOverview

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

Parameter properties

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

Parameter sets

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

-DisplayName

Admin provided name of the device configuration.

Parameter properties

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

Parameter sets

CreateExpanded
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

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

-LastModifiedDateTime

DateTime the object was last modified.

Parameter properties

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

Parameter sets

CreateExpanded
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: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

-RoleScopeTagIds

List of Scope Tags for this Entity instance.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

Parameter properties

Type:

IMicrosoftGraphDeviceComplianceScheduledActionForRule[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-UserStatuses

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

Parameter properties

Type:

IMicrosoftGraphDeviceComplianceUserStatus[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-UserStatusOverview

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

Parameter properties

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

Parameter sets

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

-Version

Version of the device configuration.

Parameter properties

Type:Int32
Default value:0
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
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.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