IntuneWindowsAutopilotDevicePreparationUserDrivenPolicy

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Description	Write	String	Policy description
DisplayName	Key	String	Policy name
RoleScopeTagIds	Write	StringArray[]	List of Scope Tags for this Entity instance.
Id	Write	String	The unique identifier for an entity. Read-only.
DeploymentMode	Write	SInt32	Deployment mode (0: UserDriven)	0
DeploymentType	Write	SInt32	Deployment type (0: SingleUser)	0
JoinType	Write	SInt32	Join type (0: EntraIdJoined)	0
AccountType	Write	SInt32	User account type (0: Administrator, 1: StandardUser)	0, 1
Timeout	Write	SInt32	Minutes allowed before showing installation error
CustomErrorMessage	Write	String	Custom error message
AllowSkip	Write	String	Allow users to skip setup after multiple attempts (false: No, true: Yes)	false, true
AllowDiagnostics	Write	String	Show link to diagnostics (false: No, true: Yes)	false, true
AllowedApplications	Write	StringArray[]	Allowed applications
AllowedScripts	Write	StringArray[]	Allowed scripts
AssignmentTarget	Write	String	Device security group
Assignments	Write	MSFT_DeviceManagementConfigurationPolicyAssignments[]	Represents the assignment to the Intune policy.
Ensure	Write	String	Present ensures the policy exists, absent ensures it is removed.	Present, Absent
Credential	Write	PSCredential	Credentials of the Admin
ApplicationId	Write	String	Id of the Azure Active Directory application to authenticate with.
TenantId	Write	String	Id of the Azure Active Directory tenant used for authentication.
ApplicationSecret	Write	PSCredential	Secret of the Azure Active Directory tenant used for authentication.
CertificateThumbprint	Write	String	Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication.
CertificatePassword	Write	PSCredential	Username can be made up to anything but password will be used for CertificatePassword
CertificatePath	Write	String	Path to certificate used in service principal usually a PFX file.
ManagedIdentity	Write	Boolean	Managed ID being used for authentication.
AccessTokens	Write	StringArray[]	Access token used for authentication.

Embedded Instances

MSFT_DeviceManagementConfigurationPolicyAssignments

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
dataType	Required	String	The type of the target assignment.	#microsoft.graph.cloudPcManagementGroupAssignmentTarget, #microsoft.graph.groupAssignmentTarget, #microsoft.graph.allLicensedUsersAssignmentTarget, #microsoft.graph.allDevicesAssignmentTarget, #microsoft.graph.exclusionGroupAssignmentTarget, #microsoft.graph.configurationManagerCollectionAssignmentTarget
deviceAndAppManagementAssignmentFilterType	Write	String	The type of filter of the target assignment i.e. Exclude or Include. Possible values are:none, include, exclude.	none, include, exclude
deviceAndAppManagementAssignmentFilterId	Write	String	The Id of the filter for the target assignment.
deviceAndAppManagementAssignmentFilterDisplayName	Write	String	The display name of the filter for the target assignment.
groupId	Write	String	The group Id that is the target of the assignment.
groupDisplayName	Write	String	The group Display Name that is the target of the assignment.
collectionId	Write	String	The collection Id that is the target of the assignment.(ConfigMgr)

Description

Intune Windows Autopilot Device Preparation User Driven Policy

Attention: Can only be updated using the delegated Credentials authentication method.

Permissions

Microsoft Graph

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

Delegated permissions

• Read

• DeviceManagementConfiguration.Read.All, Group.Read.All

• Update

• DeviceManagementConfiguration.ReadWrite.All, Group.Read.All

Application permissions

• Read

• DeviceManagementConfiguration.Read.All, Group.Read.All

• Update

• DeviceManagementConfiguration.ReadWrite.All, Group.Read.All

Examples

Example 1

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

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

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

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

    Import-DscResource -ModuleName Microsoft365DSC

    node localhost
    {
        IntuneWindowsAutopilotDevicePreparationUserDrivenPolicy 'Example'
        {
            AccountType           = "1";
            AllowDiagnostics      = "true";
            AllowedApplications   = @("IntuneMobileAppsMicrosoftEdge_Windows","IntuneMobileAppsWindowsOfficeSuiteApp_1");
            AllowedScripts        = @("IntuneDeviceConfigurationPlatformScriptWindows_1");
            AllowSkip             = "true";
            ApplicationId         = $ApplicationId;
            Assignments           = @(
                MSFT_DeviceManagementConfigurationPolicyAssignments{
                    dataType = "#microsoft.graph.groupAssignmentTarget"
                    deviceAndAppManagementAssignmentFilterType = "none"
                    groupDisplayName = "Include"
                }
            );
            AssignmentTarget      = "Include";
            CertificateThumbprint = $CertificateThumbprint;
            CustomErrorMessage    = "Contact your organization’s support person for help.";
            DeploymentMode        = "0";
            DeploymentType        = "0";
            Description           = "";
            DisplayName           = "IntuneWindowsAutopilotDevicePreparationPolicy_1";
            Ensure                = "Present";
            JoinType              = "0";
            RoleScopeTagIds       = @("0");
            TenantId              = $TenantId;
            Timeout               = 60;
        }
    }
}

Example 2

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

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

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

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

    Import-DscResource -ModuleName Microsoft365DSC

    node localhost
    {
        IntuneWindowsAutopilotDevicePreparationUserDrivenPolicy 'Example'
        {
            AccountType           = "1";
            AllowDiagnostics      = "true";
            AllowedApplications   = @("IntuneMobileAppsMicrosoftEdge_Windows","IntuneMobileAppsWindowsOfficeSuiteApp_1");
            AllowedScripts        = @("IntuneDeviceConfigurationPlatformScriptWindows_1");
            AllowSkip             = "true";
            ApplicationId         = $ApplicationId;
            Assignments           = @(
                MSFT_DeviceManagementConfigurationPolicyAssignments{
                    dataType = "#microsoft.graph.groupAssignmentTarget"
                    deviceAndAppManagementAssignmentFilterType = "none"
                    groupDisplayName = "Include"
                }
            );
            AssignmentTarget      = "Exclude"; # Updated property
            CertificateThumbprint = $CertificateThumbprint;
            CustomErrorMessage    = "Contact your organization’s support person for help.";
            DeploymentMode        = "0";
            DeploymentType        = "0";
            Description           = "";
            DisplayName           = "IntuneWindowsAutopilotDevicePreparationPolicy_1";
            Ensure                = "Present";
            JoinType              = "0";
            RoleScopeTagIds       = @("0");
            TenantId              = $TenantId;
            Timeout               = 60;
        }
    }
}

Example 3

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

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

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

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

    Import-DscResource -ModuleName Microsoft365DSC

    node localhost
    {
        IntuneWindowsAutopilotDevicePreparationUserDrivenPolicy 'Example'
        {
            ApplicationId         = $ApplicationId;
            CertificateThumbprint = $CertificateThumbprint;
            DisplayName           = "IntuneWindowsAutopilotDevicePreparationPolicy_1";
            Ensure                = "Absent";
            TenantId              = $TenantId;
        }
    }
}