IntuneDiskEncryptionFileVaultPolicyMacOS

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.
Defer	Write	String	Defer (true: Enabled)	true
DeferDontAskAtUserLogout	Write	String	Defer Dont Ask At User Logout (false: Disabled, true: Enabled)	false, true
DeferForceAtUserLoginMaxBypassAttempts	Write	SInt32	Defer Force At User Login Max Bypass Attempts
Enable	Write	String	Enable (0: On, 1: Off)	On, Off
RecoveryKeyRotationInMonths	Write	SInt32	Recovery Key Rotation In Months (0: 0, 1: 1, 2: 2, 3: 3, 4: 4, 5: 5, 6: 6, 7: 7, 8: 8, 9: 9, 10: 10, 11: 11, 12: 12)	0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
UseRecoveryKey	Write	String	Use Recovery Key (true: Enabled)	true
Location	Write	String	Location where the key should be escrowed to.
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.
ManagedIdentity	Write	Boolean	Managed ID being used for authentication.
AccessTokens	Write	StringArray[]	Access token used for authentication.

MSFT_DeviceManagementConfigurationPolicyAssignments

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
dataType	Write	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 Disk Encryption File Vault Policy for macOS

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
    {
        IntuneDiskEncryptionFileVaultPolicyMacOS "IntuneDiskEncryptionFileVaultPolicyMacOS-IntuneDiskEncryptionFileVaultPolicyMacOS_1"
        {
            ApplicationId                          = $ApplicationId;
            Assignments                            = @(
                MSFT_DeviceManagementConfigurationPolicyAssignments{
                    deviceAndAppManagementAssignmentFilterType = "none"
                    groupDisplayName = "Exclude"
                    dataType = "#microsoft.graph.exclusionGroupAssignmentTarget"
                }
                MSFT_DeviceManagementConfigurationPolicyAssignments{
                    deviceAndAppManagementAssignmentFilterType = "none"
                    groupDisplayName = "Include"
                    dataType = "#microsoft.graph.groupAssignmentTarget"
                }
            );
            CertificateThumbprint                  = $CertificateThumbprint;
            Defer                                  = "true";
            DeferDontAskAtUserLogout               = "false";
            DeferForceAtUserLoginMaxBypassAttempts = 5;
            Description                            = "";
            Enable                                 = "On";
            Ensure                                 = "Present";
            Location                               = "Sample Location";
            DisplayName                            = "IntuneDiskEncryptionFileVaultPolicyMacOS_1";
            RecoveryKeyRotationInMonths            = 1;
            RoleScopeTagIds                        = @("0");
            TenantId                               = $TenantId;
            UseRecoveryKey                         = "true";
        }
    }
}

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
    {
        IntuneDiskEncryptionFileVaultPolicyMacOS "IntuneDiskEncryptionFileVaultPolicyMacOS-IntuneDiskEncryptionFileVaultPolicyMacOS_1"
        {
            ApplicationId                          = $ApplicationId;
            Assignments                            = @(
                MSFT_DeviceManagementConfigurationPolicyAssignments{
                    deviceAndAppManagementAssignmentFilterType = "none"
                    groupDisplayName = "Exclude"
                    dataType = "#microsoft.graph.exclusionGroupAssignmentTarget"
                }
                MSFT_DeviceManagementConfigurationPolicyAssignments{
                    deviceAndAppManagementAssignmentFilterType = "none"
                    groupDisplayName = "Include"
                    dataType = "#microsoft.graph.groupAssignmentTarget"
                }
            );
            CertificateThumbprint                  = $CertificateThumbprint;
            Defer                                  = "true";
            DeferDontAskAtUserLogout               = "false";
            DeferForceAtUserLoginMaxBypassAttempts = 5;
            Description                            = "";
            Enable                                 = "Off"; # Updated property
            Ensure                                 = "Present";
            Location                               = "Sample Location";
            DisplayName                            = "IntuneDiskEncryptionFileVaultPolicyMacOS_1";
            RecoveryKeyRotationInMonths            = 12; # Updated property
            RoleScopeTagIds                        = @("0");
            TenantId                               = $TenantId;
            UseRecoveryKey                         = "true";
        }
    }
}

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
    {
        IntuneDiskEncryptionFileVaultPolicyMacOS "IntuneDiskEncryptionFileVaultPolicyMacOS-IntuneDiskEncryptionFileVaultPolicyMacOS_1"
        {
            ApplicationId                          = $ApplicationId;
            CertificateThumbprint                  = $CertificateThumbprint;
            Ensure                                 = "Absent";
            DisplayName                            = "IntuneDiskEncryptionFileVaultPolicyMacOS_1";
            TenantId                               = $TenantId;
        }
    }
}