New-MgBetaDeviceManagementWindowsAutopilotDeploymentProfile

Module:

Microsoft.Graph.Beta.DeviceManagement.Enrollment Module

Create new navigation property to windowsAutopilotDeploymentProfiles for deviceManagement

Syntax

CreateExpanded (Default)

New-MgBetaDeviceManagementWindowsAutopilotDeploymentProfile
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-AssignedDevices <IMicrosoftGraphWindowsAutopilotDeviceIdentity[]>]
    [-Assignments <IMicrosoftGraphWindowsAutopilotDeploymentProfileAssignment[]>]
    [-CreatedDateTime <DateTime>]
    [-Description <String>]
    [-DeviceNameTemplate <String>]
    [-DeviceType <WindowsAutopilotDeviceType>]
    [-DisplayName <String>]
    [-EnableWhiteGlove]
    [-EnrollmentStatusScreenSettings <IMicrosoftGraphWindowsEnrollmentStatusScreenSettings>]
    [-ExtractHardwareHash]
    [-HardwareHashExtractionEnabled]
    [-Id <String>]
    [-Language <String>]
    [-LastModifiedDateTime <DateTime>]
    [-Locale <String>]
    [-ManagementServiceAppId <String>]
    [-OutOfBoxExperienceSetting <IMicrosoftGraphOutOfBoxExperienceSetting>]
    [-OutOfBoxExperienceSettings <IMicrosoftGraphOutOfBoxExperienceSettings>]
    [-PreprovisioningAllowed]
    [-RoleScopeTagIds <String[]>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Create

New-MgBetaDeviceManagementWindowsAutopilotDeploymentProfile

    -BodyParameter <IMicrosoftGraphWindowsAutopilotDeploymentProfile>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Create new navigation property to windowsAutopilotDeploymentProfiles for deviceManagement

Permissions

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	DeviceManagementServiceConfig.ReadWrite.All,
Delegated (personal Microsoft account)	Not supported
Application	DeviceManagementServiceConfig.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

-AssignedDevices

The list of assigned devices for the profile. To construct, see NOTES section for ASSIGNEDDEVICES properties and create a hash table.

Parameter properties

Type:	IMicrosoftGraphWindowsAutopilotDeviceIdentity[]
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 list of group assignments for the profile. To construct, see NOTES section for ASSIGNMENTS properties and create a hash table.

Parameter properties

Type:	IMicrosoftGraphWindowsAutopilotDeploymentProfileAssignment[]
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

Windows Autopilot Deployment Profile To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Parameter properties

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

The date and time of when the deployment profile was created. The value cannot be modified and is automatically populated when the profile was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only.

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

A description of the deployment profile. Max allowed length is 1500 chars. Supports: $select, $top, $skip, $orderBy. $Search and $filter are not supported.

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

-DeviceNameTemplate

The template used to name the Autopilot device. This can be a custom text and can also contain either the serial number of the device, or a randomly generated number. The total length of the text generated by the template can be no more than 15 characters. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported.

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

-DeviceType

windowsAutopilotDeviceType

Parameter properties

Type:	WindowsAutopilotDeviceType
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 display name of the deployment profile. Max allowed length is 200 chars. Returned by default. Supports: $select, $top, $skip, $orderby. $Search and $filter are not supported.

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

-EnableWhiteGlove

Indicates whether the user is allowed to use Windows Autopilot for pre-provisioned deployment mode during Out of Box experience (OOBE). When TRUE, indicates that Windows Autopilot for pre-provisioned deployment mode is allowed. When false, Windows Autopilot for pre-provisioned deployment mode is not allowed. The default is FALSE. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use preprovisioningAllowed instead.

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

-EnrollmentStatusScreenSettings

Enrollment status screen setting To construct, see NOTES section for ENROLLMENTSTATUSSCREENSETTINGS properties and create a hash table.

Parameter properties

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

-ExtractHardwareHash

Indicates whether the profile supports the extraction of hardware hash values and registration of the device into Windows Autopilot. When TRUE, indicates if hardware extraction and Windows Autopilot registration will happen on the next successful check-in. When FALSE, hardware hash extraction and Windows Autopilot registration will not happen. Default value is FALSE. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use hardwareHashExtractionEnabled instead.

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

-HardwareHashExtractionEnabled

Indicates whether the profile supports the extraction of hardware hash values and registration of the device into Windows Autopilot. When TRUE, indicates if hardware extraction and Windows Autopilot registration will happen on the next successful check-in. When FALSE, hardware hash extraction and Windows Autopilot registration will not happen. Default value is FALSE. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported.

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

-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

-Language

The language code to be used when configuring the device. E.g. en-US. The default value is os-default. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use locale instead.

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

The date and time of when the deployment profile was last modified. The value cannot be updated manually and is automatically populated when any changes are made to the profile. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported Read-Only.

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

-Locale

The locale (language) to be used when configuring the device. E.g. en-US. The default value is os-default. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported.

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

-ManagementServiceAppId

The Entra management service App ID which gets used during client device-based enrollment discovery. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported.

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

-OutOfBoxExperienceSetting

The Windows Autopilot Deployment Profile settings used by the device for the out-of-box experience. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. To construct, see NOTES section for OUTOFBOXEXPERIENCESETTING properties and create a hash table.

Parameter properties

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

-OutOfBoxExperienceSettings

The Windows Autopilot Deployment Profile settings used by the Autopilot device for out-of-box experience. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use outOfBoxExperienceSetting instead. To construct, see NOTES section for OUTOFBOXEXPERIENCESETTINGS properties and create a hash table.

Parameter properties

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

-PreprovisioningAllowed

Indicates whether the user is allowed to use Windows Autopilot for pre-provisioned deployment mode during Out of Box experience (OOBE). When TRUE, indicates that Windows Autopilot for pre-provisioned deployment mode for OOBE is allowed to be used. When false, Windows Autopilot for pre-provisioned deployment mode for OOBE is not allowed. The default is FALSE.

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

-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 role scope tags for the deployment profile.

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

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

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphWindowsAutopilotDeploymentProfile

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.

ASSIGNEDDEVICES <IMicrosoftGraphWindowsAutopilotDeviceIdentity- []>: The list of assigned devices for the profile.

• [Id <String>]: The unique identifier for an entity. Read-only.
• [AddressableUserName <String>]: Addressable user name.
• [AzureActiveDirectoryDeviceId <String>]: AAD Device ID - to be deprecated
• [AzureAdDeviceId <String>]: AAD Device ID
• [DeploymentProfile <IMicrosoftGraphWindowsAutopilotDeploymentProfile>]: Windows Autopilot Deployment Profile
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [AssignedDevices <IMicrosoftGraphWindowsAutopilotDeviceIdentity- []>]: The list of assigned devices for the profile.
  • [Assignments <IMicrosoftGraphWindowsAutopilotDeploymentProfileAssignment- []>]: The list of group assignments for the profile.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [Source <DeviceAndAppManagementAssignmentSource?>]: Represents source of assignment.
    • [SourceId <String>]: Identifier for resource used for deployment to a group
    • [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?>]: The date and time of when the deployment profile was created. The value cannot be modified and is automatically populated when the profile was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only.
  • [Description <String>]: A description of the deployment profile. Max allowed length is 1500 chars. Supports: $select, $top, $skip, $orderBy. $Search and $filter are not supported.
  • [DeviceNameTemplate <String>]: The template used to name the Autopilot device. This can be a custom text and can also contain either the serial number of the device, or a randomly generated number. The total length of the text generated by the template can be no more than 15 characters. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported.
  • [DeviceType <WindowsAutopilotDeviceType?>]: windowsAutopilotDeviceType
  • [DisplayName <String>]: The display name of the deployment profile. Max allowed length is 200 chars. Returned by default. Supports: $select, $top, $skip, $orderby. $Search and $filter are not supported.
  • [EnableWhiteGlove <Boolean?>]: Indicates whether the user is allowed to use Windows Autopilot for pre-provisioned deployment mode during Out of Box experience (OOBE). When TRUE, indicates that Windows Autopilot for pre-provisioned deployment mode is allowed. When false, Windows Autopilot for pre-provisioned deployment mode is not allowed. The default is FALSE. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use preprovisioningAllowed instead.
  • [EnrollmentStatusScreenSettings <IMicrosoftGraphWindowsEnrollmentStatusScreenSettings>]: Enrollment status screen setting
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [AllowDeviceUseBeforeProfileAndAppInstallComplete <Boolean?>]: Allow or block user to use device before profile and app installation complete
    • [AllowDeviceUseOnInstallFailure <Boolean?>]: Allow the user to continue using the device on installation failure
    • [AllowLogCollectionOnInstallFailure <Boolean?>]: Allow or block log collection on installation failure
    • [BlockDeviceSetupRetryByUser <Boolean?>]: Allow the user to retry the setup on installation failure
    • [CustomErrorMessage <String>]: Set custom error message to show upon installation failure
    • [HideInstallationProgress <Boolean?>]: Show or hide installation progress to user
    • [InstallProgressTimeoutInMinutes <Int32?>]: Set installation progress timeout in minutes
  • [ExtractHardwareHash <Boolean?>]: Indicates whether the profile supports the extraction of hardware hash values and registration of the device into Windows Autopilot. When TRUE, indicates if hardware extraction and Windows Autopilot registration will happen on the next successful check-in. When FALSE, hardware hash extraction and Windows Autopilot registration will not happen. Default value is FALSE. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use hardwareHashExtractionEnabled instead.
  • [HardwareHashExtractionEnabled <Boolean?>]: Indicates whether the profile supports the extraction of hardware hash values and registration of the device into Windows Autopilot. When TRUE, indicates if hardware extraction and Windows Autopilot registration will happen on the next successful check-in. When FALSE, hardware hash extraction and Windows Autopilot registration will not happen. Default value is FALSE. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported.
  • [Language <String>]: The language code to be used when configuring the device. E.g. en-US. The default value is os-default. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use locale instead.
  • [LastModifiedDateTime <DateTime?>]: The date and time of when the deployment profile was last modified. The value cannot be updated manually and is automatically populated when any changes are made to the profile. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported Read-Only.
  • [Locale <String>]: The locale (language) to be used when configuring the device. E.g. en-US. The default value is os-default. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported.
  • [ManagementServiceAppId <String>]: The Entra management service App ID which gets used during client device-based enrollment discovery. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported.
  • [OutOfBoxExperienceSetting <IMicrosoftGraphOutOfBoxExperienceSetting>]: The Windows Autopilot Deployment Profile settings used by the device for the out-of-box experience. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported.
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DeviceUsageType <WindowsDeviceUsageType?>]: windowsDeviceUsageType
    • [EscapeLinkHidden <Boolean?>]: When TRUE, the link that allows user to start over with a different account on company sign-in is hidden. When false, the link that allows user to start over with a different account on company sign-in is available. Default value is FALSE.
    • [EulaHidden <Boolean?>]: When TRUE, EULA is hidden to the end user during OOBE. When FALSE, EULA is shown to the end user during OOBE. Default value is FALSE.
    • [KeyboardSelectionPageSkipped <Boolean?>]: When TRUE, the keyboard selection page is hidden to the end user during OOBE if Language and Region are set. When FALSE, the keyboard selection page is skipped during OOBE.
    • [PrivacySettingsHidden <Boolean?>]: When TRUE, privacy settings is hidden to the end user during OOBE. When FALSE, privacy settings is shown to the end user during OOBE. Default value is FALSE.
    • [UserType <WindowsUserType?>]: windowsUserType
  • [OutOfBoxExperienceSettings <IMicrosoftGraphOutOfBoxExperienceSettings>]: The Windows Autopilot Deployment Profile settings used by the Autopilot device for out-of-box experience. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use outOfBoxExperienceSetting instead.
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DeviceUsageType <WindowsDeviceUsageType?>]: windowsDeviceUsageType
    • [HideEscapeLink <Boolean?>]: If set to true, then the user can't start over with different account, on company sign-in
    • [HideEula <Boolean?>]: Show or hide EULA to user
    • [HidePrivacySettings <Boolean?>]: Show or hide privacy settings to user
    • [SkipKeyboardSelectionPage <Boolean?>]: If set, then skip the keyboard selection page if Language and Region are set
    • [UserType <WindowsUserType?>]: windowsUserType
  • [PreprovisioningAllowed <Boolean?>]: Indicates whether the user is allowed to use Windows Autopilot for pre-provisioned deployment mode during Out of Box experience (OOBE). When TRUE, indicates that Windows Autopilot for pre-provisioned deployment mode for OOBE is allowed to be used. When false, Windows Autopilot for pre-provisioned deployment mode for OOBE is not allowed. The default is FALSE.
  • [RoleScopeTagIds <String- []>]: List of role scope tags for the deployment profile.
• [DeploymentProfileAssignedDateTime <DateTime?>]: Profile set time of the Windows autopilot device.
• [DeploymentProfileAssignmentDetailedStatus <WindowsAutopilotProfileAssignmentDetailedStatus?>]: windowsAutopilotProfileAssignmentDetailedStatus
• [DeploymentProfileAssignmentStatus <WindowsAutopilotProfileAssignmentStatus?>]: windowsAutopilotProfileAssignmentStatus
• [DeviceAccountPassword <String>]: Surface Hub Device Account Password
• [DeviceAccountUpn <String>]: Surface Hub Device Account Upn
• [DeviceFriendlyName <String>]: Surface Hub Device Friendly Name
• [DisplayName <String>]: Display Name
• [EnrollmentState <EnrollmentState?>]: enrollmentState
• [GroupTag <String>]: Group Tag of the Windows autopilot device.
• [IntendedDeploymentProfile <IMicrosoftGraphWindowsAutopilotDeploymentProfile>]: Windows Autopilot Deployment Profile
• [LastContactedDateTime <DateTime?>]: Intune Last Contacted Date Time of the Windows autopilot device.
• [ManagedDeviceId <String>]: Managed Device ID
• [Manufacturer <String>]: Oem manufacturer of the Windows autopilot device.
• [Model <String>]: Model name of the Windows autopilot device.
• [ProductKey <String>]: Product Key of the Windows autopilot device.
• [PurchaseOrderIdentifier <String>]: Purchase Order Identifier of the Windows autopilot device.
• [RemediationState <WindowsAutopilotDeviceRemediationState?>]: Device remediation status, indicating whether or not hardware has been changed for an Autopilot-registered device.
• [RemediationStateLastModifiedDateTime <DateTime?>]: RemediationState set time of Autopilot device.
• [ResourceName <String>]: Resource Name.
• [SerialNumber <String>]: Serial number of the Windows autopilot device.
• [SkuNumber <String>]: SKU Number
• [SystemFamily <String>]: System Family
• [UserPrincipalName <String>]: User Principal Name.
• [UserlessEnrollmentStatus <WindowsAutopilotUserlessEnrollmentStatus?>]: Userless enrollment block status, indicating whether the next device enrollment will be blocked.

ASSIGNMENTS <IMicrosoftGraphWindowsAutopilotDeploymentProfileAssignment- []>: The list of group assignments for the profile.

• [Id <String>]: The unique identifier for an entity. Read-only.
• [Source <DeviceAndAppManagementAssignmentSource?>]: Represents source of assignment.
• [SourceId <String>]: Identifier for resource used for deployment to a group
• [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 <IMicrosoftGraphWindowsAutopilotDeploymentProfile>: Windows Autopilot Deployment Profile

• [(Any) <Object>]: This indicates any property can be added to this object.
• [Id <String>]: The unique identifier for an entity. Read-only.
• [AssignedDevices <IMicrosoftGraphWindowsAutopilotDeviceIdentity- []>]: The list of assigned devices for the profile.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [AddressableUserName <String>]: Addressable user name.
  • [AzureActiveDirectoryDeviceId <String>]: AAD Device ID - to be deprecated
  • [AzureAdDeviceId <String>]: AAD Device ID
  • [DeploymentProfile <IMicrosoftGraphWindowsAutopilotDeploymentProfile>]: Windows Autopilot Deployment Profile
  • [DeploymentProfileAssignedDateTime <DateTime?>]: Profile set time of the Windows autopilot device.
  • [DeploymentProfileAssignmentDetailedStatus <WindowsAutopilotProfileAssignmentDetailedStatus?>]: windowsAutopilotProfileAssignmentDetailedStatus
  • [DeploymentProfileAssignmentStatus <WindowsAutopilotProfileAssignmentStatus?>]: windowsAutopilotProfileAssignmentStatus
  • [DeviceAccountPassword <String>]: Surface Hub Device Account Password
  • [DeviceAccountUpn <String>]: Surface Hub Device Account Upn
  • [DeviceFriendlyName <String>]: Surface Hub Device Friendly Name
  • [DisplayName <String>]: Display Name
  • [EnrollmentState <EnrollmentState?>]: enrollmentState
  • [GroupTag <String>]: Group Tag of the Windows autopilot device.
  • [IntendedDeploymentProfile <IMicrosoftGraphWindowsAutopilotDeploymentProfile>]: Windows Autopilot Deployment Profile
  • [LastContactedDateTime <DateTime?>]: Intune Last Contacted Date Time of the Windows autopilot device.
  • [ManagedDeviceId <String>]: Managed Device ID
  • [Manufacturer <String>]: Oem manufacturer of the Windows autopilot device.
  • [Model <String>]: Model name of the Windows autopilot device.
  • [ProductKey <String>]: Product Key of the Windows autopilot device.
  • [PurchaseOrderIdentifier <String>]: Purchase Order Identifier of the Windows autopilot device.
  • [RemediationState <WindowsAutopilotDeviceRemediationState?>]: Device remediation status, indicating whether or not hardware has been changed for an Autopilot-registered device.
  • [RemediationStateLastModifiedDateTime <DateTime?>]: RemediationState set time of Autopilot device.
  • [ResourceName <String>]: Resource Name.
  • [SerialNumber <String>]: Serial number of the Windows autopilot device.
  • [SkuNumber <String>]: SKU Number
  • [SystemFamily <String>]: System Family
  • [UserPrincipalName <String>]: User Principal Name.
  • [UserlessEnrollmentStatus <WindowsAutopilotUserlessEnrollmentStatus?>]: Userless enrollment block status, indicating whether the next device enrollment will be blocked.
• [Assignments <IMicrosoftGraphWindowsAutopilotDeploymentProfileAssignment- []>]: The list of group assignments for the profile.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [Source <DeviceAndAppManagementAssignmentSource?>]: Represents source of assignment.
  • [SourceId <String>]: Identifier for resource used for deployment to a group
  • [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?>]: The date and time of when the deployment profile was created. The value cannot be modified and is automatically populated when the profile was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only.
• [Description <String>]: A description of the deployment profile. Max allowed length is 1500 chars. Supports: $select, $top, $skip, $orderBy. $Search and $filter are not supported.
• [DeviceNameTemplate <String>]: The template used to name the Autopilot device. This can be a custom text and can also contain either the serial number of the device, or a randomly generated number. The total length of the text generated by the template can be no more than 15 characters. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported.
• [DeviceType <WindowsAutopilotDeviceType?>]: windowsAutopilotDeviceType
• [DisplayName <String>]: The display name of the deployment profile. Max allowed length is 200 chars. Returned by default. Supports: $select, $top, $skip, $orderby. $Search and $filter are not supported.
• [EnableWhiteGlove <Boolean?>]: Indicates whether the user is allowed to use Windows Autopilot for pre-provisioned deployment mode during Out of Box experience (OOBE). When TRUE, indicates that Windows Autopilot for pre-provisioned deployment mode is allowed. When false, Windows Autopilot for pre-provisioned deployment mode is not allowed. The default is FALSE. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use preprovisioningAllowed instead.
• [EnrollmentStatusScreenSettings <IMicrosoftGraphWindowsEnrollmentStatusScreenSettings>]: Enrollment status screen setting
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [AllowDeviceUseBeforeProfileAndAppInstallComplete <Boolean?>]: Allow or block user to use device before profile and app installation complete
  • [AllowDeviceUseOnInstallFailure <Boolean?>]: Allow the user to continue using the device on installation failure
  • [AllowLogCollectionOnInstallFailure <Boolean?>]: Allow or block log collection on installation failure
  • [BlockDeviceSetupRetryByUser <Boolean?>]: Allow the user to retry the setup on installation failure
  • [CustomErrorMessage <String>]: Set custom error message to show upon installation failure
  • [HideInstallationProgress <Boolean?>]: Show or hide installation progress to user
  • [InstallProgressTimeoutInMinutes <Int32?>]: Set installation progress timeout in minutes
• [ExtractHardwareHash <Boolean?>]: Indicates whether the profile supports the extraction of hardware hash values and registration of the device into Windows Autopilot. When TRUE, indicates if hardware extraction and Windows Autopilot registration will happen on the next successful check-in. When FALSE, hardware hash extraction and Windows Autopilot registration will not happen. Default value is FALSE. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use hardwareHashExtractionEnabled instead.
• [HardwareHashExtractionEnabled <Boolean?>]: Indicates whether the profile supports the extraction of hardware hash values and registration of the device into Windows Autopilot. When TRUE, indicates if hardware extraction and Windows Autopilot registration will happen on the next successful check-in. When FALSE, hardware hash extraction and Windows Autopilot registration will not happen. Default value is FALSE. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported.
• [Language <String>]: The language code to be used when configuring the device. E.g. en-US. The default value is os-default. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use locale instead.
• [LastModifiedDateTime <DateTime?>]: The date and time of when the deployment profile was last modified. The value cannot be updated manually and is automatically populated when any changes are made to the profile. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported Read-Only.
• [Locale <String>]: The locale (language) to be used when configuring the device. E.g. en-US. The default value is os-default. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported.
• [ManagementServiceAppId <String>]: The Entra management service App ID which gets used during client device-based enrollment discovery. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported.
• [OutOfBoxExperienceSetting <IMicrosoftGraphOutOfBoxExperienceSetting>]: The Windows Autopilot Deployment Profile settings used by the device for the out-of-box experience. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported.
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [DeviceUsageType <WindowsDeviceUsageType?>]: windowsDeviceUsageType
  • [EscapeLinkHidden <Boolean?>]: When TRUE, the link that allows user to start over with a different account on company sign-in is hidden. When false, the link that allows user to start over with a different account on company sign-in is available. Default value is FALSE.
  • [EulaHidden <Boolean?>]: When TRUE, EULA is hidden to the end user during OOBE. When FALSE, EULA is shown to the end user during OOBE. Default value is FALSE.
  • [KeyboardSelectionPageSkipped <Boolean?>]: When TRUE, the keyboard selection page is hidden to the end user during OOBE if Language and Region are set. When FALSE, the keyboard selection page is skipped during OOBE.
  • [PrivacySettingsHidden <Boolean?>]: When TRUE, privacy settings is hidden to the end user during OOBE. When FALSE, privacy settings is shown to the end user during OOBE. Default value is FALSE.
  • [UserType <WindowsUserType?>]: windowsUserType
• [OutOfBoxExperienceSettings <IMicrosoftGraphOutOfBoxExperienceSettings>]: The Windows Autopilot Deployment Profile settings used by the Autopilot device for out-of-box experience. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use outOfBoxExperienceSetting instead.
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [DeviceUsageType <WindowsDeviceUsageType?>]: windowsDeviceUsageType
  • [HideEscapeLink <Boolean?>]: If set to true, then the user can't start over with different account, on company sign-in
  • [HideEula <Boolean?>]: Show or hide EULA to user
  • [HidePrivacySettings <Boolean?>]: Show or hide privacy settings to user
  • [SkipKeyboardSelectionPage <Boolean?>]: If set, then skip the keyboard selection page if Language and Region are set
  • [UserType <WindowsUserType?>]: windowsUserType
• [PreprovisioningAllowed <Boolean?>]: Indicates whether the user is allowed to use Windows Autopilot for pre-provisioned deployment mode during Out of Box experience (OOBE). When TRUE, indicates that Windows Autopilot for pre-provisioned deployment mode for OOBE is allowed to be used. When false, Windows Autopilot for pre-provisioned deployment mode for OOBE is not allowed. The default is FALSE.
• [RoleScopeTagIds <String- []>]: List of role scope tags for the deployment profile.

ENROLLMENTSTATUSSCREENSETTINGS <IMicrosoftGraphWindowsEnrollmentStatusScreenSettings>: Enrollment status screen setting

• [(Any) <Object>]: This indicates any property can be added to this object.
• [AllowDeviceUseBeforeProfileAndAppInstallComplete <Boolean?>]: Allow or block user to use device before profile and app installation complete
• [AllowDeviceUseOnInstallFailure <Boolean?>]: Allow the user to continue using the device on installation failure
• [AllowLogCollectionOnInstallFailure <Boolean?>]: Allow or block log collection on installation failure
• [BlockDeviceSetupRetryByUser <Boolean?>]: Allow the user to retry the setup on installation failure
• [CustomErrorMessage <String>]: Set custom error message to show upon installation failure
• [HideInstallationProgress <Boolean?>]: Show or hide installation progress to user
• [InstallProgressTimeoutInMinutes <Int32?>]: Set installation progress timeout in minutes

OUTOFBOXEXPERIENCESETTING <IMicrosoftGraphOutOfBoxExperienceSetting>: The Windows Autopilot Deployment Profile settings used by the device for the out-of-box experience. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported.

• [(Any) <Object>]: This indicates any property can be added to this object.
• [DeviceUsageType <WindowsDeviceUsageType?>]: windowsDeviceUsageType
• [EscapeLinkHidden <Boolean?>]: When TRUE, the link that allows user to start over with a different account on company sign-in is hidden. When false, the link that allows user to start over with a different account on company sign-in is available. Default value is FALSE.
• [EulaHidden <Boolean?>]: When TRUE, EULA is hidden to the end user during OOBE. When FALSE, EULA is shown to the end user during OOBE. Default value is FALSE.
• [KeyboardSelectionPageSkipped <Boolean?>]: When TRUE, the keyboard selection page is hidden to the end user during OOBE if Language and Region are set. When FALSE, the keyboard selection page is skipped during OOBE.
• [PrivacySettingsHidden <Boolean?>]: When TRUE, privacy settings is hidden to the end user during OOBE. When FALSE, privacy settings is shown to the end user during OOBE. Default value is FALSE.
• [UserType <WindowsUserType?>]: windowsUserType

OUTOFBOXEXPERIENCESETTINGS <IMicrosoftGraphOutOfBoxExperienceSettings>: The Windows Autopilot Deployment Profile settings used by the Autopilot device for out-of-box experience. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use outOfBoxExperienceSetting instead.

• [(Any) <Object>]: This indicates any property can be added to this object.
• [DeviceUsageType <WindowsDeviceUsageType?>]: windowsDeviceUsageType
• [HideEscapeLink <Boolean?>]: If set to true, then the user can't start over with different account, on company sign-in
• [HideEula <Boolean?>]: Show or hide EULA to user
• [HidePrivacySettings <Boolean?>]: Show or hide privacy settings to user
• [SkipKeyboardSelectionPage <Boolean?>]: If set, then skip the keyboard selection page if Language and Region are set
• [UserType <WindowsUserType?>]: windowsUserType

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.beta.devicemanagement.enrollment/new-mgbetadevicemanagementwindowsautopilotdeploymentprofile