Share via


New-MgBetaDeviceManagementIntent

Create new navigation property to intents for deviceManagement

Syntax

CreateExpanded (Default)

New-MgBetaDeviceManagementIntent
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-Assignments <IMicrosoftGraphDeviceManagementIntentAssignment[]>]
    [-Categories <IMicrosoftGraphDeviceManagementIntentSettingCategory[]>]
    [-Description <String>]
    [-DeviceSettingStateSummaries <IMicrosoftGraphDeviceManagementIntentDeviceSettingStateSummary[]>]
    [-DeviceStateSummary <IMicrosoftGraphDeviceManagementIntentDeviceStateSummary>]
    [-DeviceStates <IMicrosoftGraphDeviceManagementIntentDeviceState[]>]
    [-DisplayName <String>]
    [-Id <String>]
    [-IsAssigned]
    [-IsMigratingToConfigurationPolicy]
    [-LastModifiedDateTime <DateTime>]
    [-RoleScopeTagIds <String[]>]
    [-Settings <IMicrosoftGraphDeviceManagementSettingInstance[]>]
    [-TemplateId <String>]
    [-UserStateSummary <IMicrosoftGraphDeviceManagementIntentUserStateSummary>]
    [-UserStates <IMicrosoftGraphDeviceManagementIntentUserState[]>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Create

New-MgBetaDeviceManagementIntent
    -BodyParameter <IMicrosoftGraphDeviceManagementIntent>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Create new navigation property to intents 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

Collection of assignments To construct, see NOTES section for ASSIGNMENTS properties and create a hash table.

Parameter properties

Type:

IMicrosoftGraphDeviceManagementIntentAssignment[]

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

Entity that represents an intent to apply settings to a device To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Parameter properties

Type:IMicrosoftGraphDeviceManagementIntent
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

-Categories

Collection of setting categories within the intent To construct, see NOTES section for CATEGORIES properties and create a hash table.

Parameter properties

Type:

IMicrosoftGraphDeviceManagementIntentSettingCategory[]

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

-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

-Description

The user given description

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

Collection of settings and their states and counts of devices that belong to corresponding state for all settings within the intent To construct, see NOTES section for DEVICESETTINGSTATESUMMARIES properties and create a hash table.

Parameter properties

Type:

IMicrosoftGraphDeviceManagementIntentDeviceSettingStateSummary[]

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

-DeviceStates

Collection of states of all devices that the intent is applied to To construct, see NOTES section for DEVICESTATES properties and create a hash table.

Parameter properties

Type:

IMicrosoftGraphDeviceManagementIntentDeviceState[]

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

-DeviceStateSummary

Entity that represents device state summary for an intent To construct, see NOTES section for DEVICESTATESUMMARY properties and create a hash table.

Parameter properties

Type:IMicrosoftGraphDeviceManagementIntentDeviceStateSummary
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

The user given display name

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

-IsAssigned

Signifies whether or not the intent is assigned to users

Parameter properties

Type:SwitchParameter
Default value:False
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

-IsMigratingToConfigurationPolicy

Signifies whether or not the intent is being migrated to the configurationPolicies endpoint

Parameter properties

Type:SwitchParameter
Default value:False
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

When the intent 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

-Settings

Collection of all settings to be applied To construct, see NOTES section for SETTINGS properties and create a hash table.

Parameter properties

Type:

IMicrosoftGraphDeviceManagementSettingInstance[]

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

-TemplateId

The ID of the template this intent was created from (if any)

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

-UserStates

Collection of states of all users that the intent is applied to To construct, see NOTES section for USERSTATES properties and create a hash table.

Parameter properties

Type:

IMicrosoftGraphDeviceManagementIntentUserState[]

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

-UserStateSummary

Entity that represents user state summary for an intent To construct, see NOTES section for USERSTATESUMMARY properties and create a hash table.

Parameter properties

Type:IMicrosoftGraphDeviceManagementIntentUserStateSummary
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

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

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphDeviceManagementIntent

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 <IMicrosoftGraphDeviceManagementIntentAssignment- []>: Collection of assignments

  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [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 <IMicrosoftGraphDeviceManagementIntent>: Entity that represents an intent to apply settings to a device

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [Assignments <IMicrosoftGraphDeviceManagementIntentAssignment- []>]: Collection of assignments
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [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.
  • [Categories <IMicrosoftGraphDeviceManagementIntentSettingCategory- []>]: Collection of setting categories within the intent
    • [DisplayName <String>]: The category name
    • [HasRequiredSetting <Boolean?>]: The category contains top level required setting
    • [SettingDefinitions <IMicrosoftGraphDeviceManagementSettingDefinition- []>]: The setting definitions this category contains
      • [Id <String>]: The unique identifier for an entity. Read-only.
      • [Constraints <IMicrosoftGraphDeviceManagementConstraint- []>]: Collection of constraints for the setting value
      • [Dependencies <IMicrosoftGraphDeviceManagementSettingDependency- []>]: Collection of dependencies on other settings
        • [Constraints <IMicrosoftGraphDeviceManagementConstraint- []>]: Collection of constraints for the dependency setting value
        • [DefinitionId <String>]: The setting definition ID of the setting depended on
      • [Description <String>]: The setting's description
      • [DisplayName <String>]: The setting's display name
      • [DocumentationUrl <String>]: Url to setting documentation
      • [HeaderSubtitle <String>]: subtitle of the setting header for more details about the category/section
      • [HeaderTitle <String>]: title of the setting header represents a category/section of a setting/settings
      • [IsTopLevel <Boolean?>]: If the setting is top level, it can be configured without the need to be wrapped in a collection or complex setting
      • [Keywords <String- []>]: Keywords associated with the setting
      • [PlaceholderText <String>]: Placeholder text as an example of valid input
      • [ValueType <DeviceManangementIntentValueType?>]: deviceManangementIntentValueType
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [Settings <IMicrosoftGraphDeviceManagementSettingInstance- []>]: The settings this category contains
      • [Id <String>]: The unique identifier for an entity. Read-only.
      • [DefinitionId <String>]: The ID of the setting definition for this instance
      • [ValueJson <String>]: JSON representation of the value
  • [Description <String>]: The user given description
  • [DeviceSettingStateSummaries <IMicrosoftGraphDeviceManagementIntentDeviceSettingStateSummary- []>]: Collection of settings and their states and counts of devices that belong to corresponding state for all settings within the intent
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [CompliantCount <Int32?>]: Number of compliant devices
    • [ConflictCount <Int32?>]: Number of devices in conflict
    • [ErrorCount <Int32?>]: Number of error devices
    • [NonCompliantCount <Int32?>]: Number of non compliant devices
    • [NotApplicableCount <Int32?>]: Number of not applicable devices
    • [RemediatedCount <Int32?>]: Number of remediated devices
    • [SettingName <String>]: Name of a setting
  • [DeviceStateSummary <IMicrosoftGraphDeviceManagementIntentDeviceStateSummary>]: Entity that represents device state summary for an intent
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [ConflictCount <Int32?>]: Number of devices in conflict
    • [ErrorCount <Int32?>]: Number of error devices
    • [FailedCount <Int32?>]: Number of failed devices
    • [NotApplicableCount <Int32?>]: Number of not applicable devices
    • [NotApplicablePlatformCount <Int32?>]: Number of not applicable devices due to mismatch platform and policy
    • [SuccessCount <Int32?>]: Number of succeeded devices
  • [DeviceStates <IMicrosoftGraphDeviceManagementIntentDeviceState- []>]: Collection of states of all devices that the intent is applied to
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [DeviceDisplayName <String>]: Device name that is being reported
    • [DeviceId <String>]: Device id that is being reported
    • [LastReportedDateTime <DateTime?>]: Last modified date time of an intent report
    • [State <String>]: complianceStatus
    • [UserName <String>]: The user name that is being reported on a device
    • [UserPrincipalName <String>]: The user principal name that is being reported on a device
  • [DisplayName <String>]: The user given display name
  • [IsAssigned <Boolean?>]: Signifies whether or not the intent is assigned to users
  • [IsMigratingToConfigurationPolicy <Boolean?>]: Signifies whether or not the intent is being migrated to the configurationPolicies endpoint
  • [LastModifiedDateTime <DateTime?>]: When the intent was last modified
  • [RoleScopeTagIds <String- []>]: List of Scope Tags for this Entity instance.
  • [Settings <IMicrosoftGraphDeviceManagementSettingInstance- []>]: Collection of all settings to be applied
  • [TemplateId <String>]: The ID of the template this intent was created from (if any)
  • [UserStateSummary <IMicrosoftGraphDeviceManagementIntentUserStateSummary>]: Entity that represents user state summary for an intent
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [ConflictCount <Int32?>]: Number of users in conflict
    • [ErrorCount <Int32?>]: Number of error users
    • [FailedCount <Int32?>]: Number of failed users
    • [NotApplicableCount <Int32?>]: Number of not applicable users
    • [SuccessCount <Int32?>]: Number of succeeded users
  • [UserStates <IMicrosoftGraphDeviceManagementIntentUserState- []>]: Collection of states of all users that the intent is applied to
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [DeviceCount <Int32?>]: Count of Devices that belongs to a user for an intent
    • [LastReportedDateTime <DateTime?>]: Last modified date time of an intent report
    • [State <String>]: complianceStatus
    • [UserName <String>]: The user name that is being reported on a device
    • [UserPrincipalName <String>]: The user principal name that is being reported on a device

CATEGORIES <IMicrosoftGraphDeviceManagementIntentSettingCategory- []>: Collection of setting categories within the intent

  • [DisplayName <String>]: The category name
  • [HasRequiredSetting <Boolean?>]: The category contains top level required setting
  • [SettingDefinitions <IMicrosoftGraphDeviceManagementSettingDefinition- []>]: The setting definitions this category contains
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [Constraints <IMicrosoftGraphDeviceManagementConstraint- []>]: Collection of constraints for the setting value
    • [Dependencies <IMicrosoftGraphDeviceManagementSettingDependency- []>]: Collection of dependencies on other settings
      • [Constraints <IMicrosoftGraphDeviceManagementConstraint- []>]: Collection of constraints for the dependency setting value
      • [DefinitionId <String>]: The setting definition ID of the setting depended on
    • [Description <String>]: The setting's description
    • [DisplayName <String>]: The setting's display name
    • [DocumentationUrl <String>]: Url to setting documentation
    • [HeaderSubtitle <String>]: subtitle of the setting header for more details about the category/section
    • [HeaderTitle <String>]: title of the setting header represents a category/section of a setting/settings
    • [IsTopLevel <Boolean?>]: If the setting is top level, it can be configured without the need to be wrapped in a collection or complex setting
    • [Keywords <String- []>]: Keywords associated with the setting
    • [PlaceholderText <String>]: Placeholder text as an example of valid input
    • [ValueType <DeviceManangementIntentValueType?>]: deviceManangementIntentValueType
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [Settings <IMicrosoftGraphDeviceManagementSettingInstance- []>]: The settings this category contains
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [DefinitionId <String>]: The ID of the setting definition for this instance
    • [ValueJson <String>]: JSON representation of the value

DEVICESETTINGSTATESUMMARIES <IMicrosoftGraphDeviceManagementIntentDeviceSettingStateSummary- []>: Collection of settings and their states and counts of devices that belong to corresponding state for all settings within the intent

  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [CompliantCount <Int32?>]: Number of compliant devices
  • [ConflictCount <Int32?>]: Number of devices in conflict
  • [ErrorCount <Int32?>]: Number of error devices
  • [NonCompliantCount <Int32?>]: Number of non compliant devices
  • [NotApplicableCount <Int32?>]: Number of not applicable devices
  • [RemediatedCount <Int32?>]: Number of remediated devices
  • [SettingName <String>]: Name of a setting

DEVICESTATES <IMicrosoftGraphDeviceManagementIntentDeviceState- []>: Collection of states of all devices that the intent is applied to

  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [DeviceDisplayName <String>]: Device name that is being reported
  • [DeviceId <String>]: Device id that is being reported
  • [LastReportedDateTime <DateTime?>]: Last modified date time of an intent report
  • [State <String>]: complianceStatus
  • [UserName <String>]: The user name that is being reported on a device
  • [UserPrincipalName <String>]: The user principal name that is being reported on a device

DEVICESTATESUMMARY <IMicrosoftGraphDeviceManagementIntentDeviceStateSummary>: Entity that represents device state summary for an intent

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

SETTINGS <IMicrosoftGraphDeviceManagementSettingInstance- []>: Collection of all settings to be applied

  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [DefinitionId <String>]: The ID of the setting definition for this instance
  • [ValueJson <String>]: JSON representation of the value

USERSTATES <IMicrosoftGraphDeviceManagementIntentUserState- []>: Collection of states of all users that the intent is applied to

  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [DeviceCount <Int32?>]: Count of Devices that belongs to a user for an intent
  • [LastReportedDateTime <DateTime?>]: Last modified date time of an intent report
  • [State <String>]: complianceStatus
  • [UserName <String>]: The user name that is being reported on a device
  • [UserPrincipalName <String>]: The user principal name that is being reported on a device

USERSTATESUMMARY <IMicrosoftGraphDeviceManagementIntentUserStateSummary>: Entity that represents user state summary for an intent

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [ConflictCount <Int32?>]: Number of users in conflict
  • [ErrorCount <Int32?>]: Number of error users
  • [FailedCount <Int32?>]: Number of failed users
  • [NotApplicableCount <Int32?>]: Number of not applicable users
  • [SuccessCount <Int32?>]: Number of succeeded users