IntuneWindowsAutopilotDeploymentProfileAzureADJoined¶

Parameters¶

Parameter	Attribute	DataType	Description	Allowed Values
Description	Write	String	Description of the profile
DeviceNameTemplate	Write	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.
DeviceType	Write	String	The AutoPilot device type that this profile is applicable to. Possible values are: windowsPc, surfaceHub2.	`windowsPc`, `surfaceHub2`, `holoLens`, `surfaceHub2S`, `virtualMachine`, `unknownFutureValue`
DisplayName	Key	String	Name of the profile
PreprovisioningAllowed	Write	Boolean	Whether the profile allows pre-provisioned deployment.
EnrollmentStatusScreenSettings	Write	MSFT_MicrosoftGraphwindowsEnrollmentStatusScreenSettings1	Enrollment status screen setting
HardwareHashExtractionEnabled	Write	Boolean	Whether the profile extracts the hardware hash of the device.
Locale	Write	String	Locale configured on the device
ManagementServiceAppId	Write	String	AzureAD management app ID used during client device-based enrollment discovery
OutOfBoxExperienceSetting	Write	MSFT_MicrosoftGraphoutOfBoxExperienceSetting	The Windows Autopilot Deployment Profile settings used by the device for the out of box experience.
Id	Write	String	The unique identifier for an entity. Read-only.
RoleScopeTagIds	Write	String[]	List of Scope Tags for this Entity instance.
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	String[]	Access token used for authentication.

Embedded Instances¶

MSFT_MicrosoftGraphwindowsEnrollmentStatusScreenSettings1¶

Parameters¶

Parameter	Attribute	DataType	Description
AllowDeviceUseBeforeProfileAndAppInstallComplete	Write	Boolean	Allow or block user to use device before profile and app installation complete
AllowDeviceUseOnInstallFailure	Write	Boolean	Allow the user to continue using the device on installation failure
AllowLogCollectionOnInstallFailure	Write	Boolean	Allow or block log collection on installation failure
BlockDeviceSetupRetryByUser	Write	Boolean	Allow the user to retry the setup on installation failure
CustomErrorMessage	Write	String	Set custom error message to show upon installation failure
HideInstallationProgress	Write	Boolean	Show or hide installation progress to user
InstallProgressTimeoutInMinutes	Write	UInt32	Set installation progress timeout in minutes

MSFT_MicrosoftGraphoutOfBoxExperienceSetting¶

Parameters¶

Parameter	Attribute	DataType	Description	Allowed Values
DeviceUsageType	Write	String	AAD join authentication type. Possible values are: shared, singleUser.	`shared`, `singleUser`
EscapeLinkHidden	Write	Boolean	If set to true, then the user can't start over with different account, on company sign-in
EulaHidden	Write	Boolean	Show or hide EULA to user
KeyboardSelectionPageSkipped	Write	Boolean	If set, then skip the keyboard selection page if Language and Region are set
PrivacySettingsHidden	Write	Boolean	Show or hide privacy settings to user
UserType	Write	String	Type of user. Possible values are: administrator, standard.	`administrator`, `standard`

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 Deployment Profile Azure AD Joined

Permissions¶

Graph¶

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

Delegated permissions¶

Read
GroupMember.Read.All, DeviceManagementServiceConfig.Read.All, DeviceManagementRBAC.Read.All
Update
GroupMember.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementRBAC.Read.All

Application permissions¶

Read
GroupMember.Read.All, DeviceManagementServiceConfig.Read.All, DeviceManagementRBAC.Read.All
Update
GroupMember.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementRBAC.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
    {
        IntuneWindowsAutopilotDeploymentProfileAzureADJoined 'IntuneWindowsAutopilotDeploymentProfileAzureADJoined-Example'
        {
            Assignments                    = @(
                MSFT_DeviceManagementConfigurationPolicyAssignments{
                    dataType                                   = "#microsoft.graph.allDevicesAssignmentTarget"
                    deviceAndAppManagementAssignmentFilterType = "none"
                }
                MSFT_DeviceManagementConfigurationPolicyAssignments{
                    dataType         = "#microsoft.graph.exclusionGroupAssignmentTarget"
                    groupDisplayName = "Autopilot Provisioning Exclusions"
                }
            );
            Description                    = "User-driven provisioning for Entra joined laptops";
            DeviceNameTemplate             = "CONTOSO-%RAND:6%";
            DeviceType                     = "windowsPc";
            DisplayName                    = "AAD";
            PreprovisioningAllowed               = $true;
            EnrollmentStatusScreenSettings = MSFT_MicrosoftGraphwindowsEnrollmentStatusScreenSettings1{
                AllowDeviceUseBeforeProfileAndAppInstallComplete = $false
                AllowDeviceUseOnInstallFailure                   = $true
                AllowLogCollectionOnInstallFailure               = $true
                BlockDeviceSetupRetryByUser                      = $false
                CustomErrorMessage                               = "Setup could not be completed. Please contact the service desk on extension 4500."
                HideInstallationProgress                         = $false
                InstallProgressTimeoutInMinutes                  = 60
            };
            Ensure                         = "Present";
            HardwareHashExtractionEnabled  = $true;
            Locale                         = "en-US";
            ManagementServiceAppId         = "<application-id>";
            OutOfBoxExperienceSetting     = MSFT_MicrosoftGraphoutOfBoxExperienceSetting{
                DeviceUsageType           = "singleUser"
                EulaHidden                  = $false
                EscapeLinkHidden            = $true
                PrivacySettingsHidden       = $true
                KeyboardSelectionPageSkipped = $true
                UserType                  = "administrator"
            };
            RoleScopeTagIds                = @("0");
            ApplicationId                  = $ApplicationId;
            TenantId                       = $TenantId;
            CertificateThumbprint          = $CertificateThumbprint;
        }
    }
}

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
    {
        IntuneWindowsAutopilotDeploymentProfileAzureADJoined 'IntuneWindowsAutopilotDeploymentProfileAzureADJoined-Example'
        {
            Assignments                    = @(
                MSFT_DeviceManagementConfigurationPolicyAssignments{
                    dataType                                   = "#microsoft.graph.allDevicesAssignmentTarget"
                    deviceAndAppManagementAssignmentFilterType = "none"
                }
                MSFT_DeviceManagementConfigurationPolicyAssignments{
                    dataType         = "#microsoft.graph.exclusionGroupAssignmentTarget"
                    groupDisplayName = "Autopilot Provisioning Exclusions"
                }
            );
            Description                    = "User-driven provisioning for Entra joined laptops";
            DeviceNameTemplate             = "CONTOSO-%RAND:6%";
            DeviceType                     = "windowsPc";
            DisplayName                    = "AAD";
            PreprovisioningAllowed         = $false; # Updated Property
            EnrollmentStatusScreenSettings = MSFT_MicrosoftGraphwindowsEnrollmentStatusScreenSettings1{
                AllowDeviceUseBeforeProfileAndAppInstallComplete = $false
                AllowDeviceUseOnInstallFailure                   = $true
                AllowLogCollectionOnInstallFailure               = $true
                BlockDeviceSetupRetryByUser                      = $false
                CustomErrorMessage                               = "Setup could not be completed. Please contact the service desk on extension 4500."
                HideInstallationProgress                         = $false
                InstallProgressTimeoutInMinutes                  = 60
            };
            Ensure                         = "Present";
            HardwareHashExtractionEnabled  = $true;
            Locale                         = "en-US";
            ManagementServiceAppId         = "<application-id>";
            OutOfBoxExperienceSetting     = MSFT_MicrosoftGraphoutOfBoxExperienceSetting{
                DeviceUsageType           = "singleUser"
                EulaHidden                  = $false
                EscapeLinkHidden            = $true
                PrivacySettingsHidden       = $true
                KeyboardSelectionPageSkipped = $true
                UserType                  = "administrator"
            };
            RoleScopeTagIds                = @("0");
            ApplicationId                  = $ApplicationId;
            TenantId                       = $TenantId;
            CertificateThumbprint          = $CertificateThumbprint;
        }
    }
}

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
    {
        IntuneWindowsAutopilotDeploymentProfileAzureADJoined 'IntuneWindowsAutopilotDeploymentProfileAzureADJoined-Example'
        {
            DisplayName           = "AAD";
            Ensure                = "Absent";
            ApplicationId         = $ApplicationId;
            TenantId              = $TenantId;
            CertificateThumbprint = $CertificateThumbprint;
        }
    }
}