IntuneCustomizationBrandingProfile

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
CompanyPortalBlockedActions	Write	MSFT_MicrosoftGraphcompanyPortalBlockedAction[]	Collection of blocked actions on the company portal as per platform and device ownership types.
ContactITEmailAddress	Write	String	E-mail address of the person/organization responsible for IT support
ContactITName	Write	String	Name of the person/organization responsible for IT support
ContactITNotes	Write	String	Text comments regarding the person/organization responsible for IT support
ContactITPhoneNumber	Write	String	Phone number of the person/organization responsible for IT support
CustomCanSeePrivacyMessage	Write	String	Text comments regarding what the admin has access to on the device
CustomCantSeePrivacyMessage	Write	String	Text comments regarding what the admin doesn't have access to on the device
DisableDeviceCategorySelection	Write	Boolean	Boolean that indicates if Device Category Selection will be shown in Company Portal
DisplayName	Required	String	Company/organization name that is displayed to end users
EnrollmentAvailability	Write	String	Customized device enrollment flow displayed to the end user . Possible values are: availableWithPrompts, availableWithoutPrompts, unavailable.	availableWithPrompts, availableWithoutPrompts, unavailable
LandingPageCustomizedImage	Write	MSFT_MicrosoftGraphmimeContent	Customized image displayed in Company Portal apps landing page
LightBackgroundLogo	Write	MSFT_MicrosoftGraphmimeContent	Logo image displayed in Company Portal apps which have a light background behind the logo
OnlineSupportSiteName	Write	String	Display name of the company/organizations IT helpdesk site
OnlineSupportSiteUrl	Write	String	URL to the company/organizations IT helpdesk site
PrivacyUrl	Write	String	URL to the company/organizations privacy policy
ProfileDescription	Write	String	Description of the profile
ProfileName	Key	String	Name of the profile
RoleScopeTagIds	Write	StringArray[]	List of scope tags assigned to the branding profile
ShowAzureADEnterpriseApps	Write	Boolean	Boolean that indicates if AzureAD Enterprise Apps will be shown in Company Portal
ShowConfigurationManagerApps	Write	Boolean	Boolean that indicates if Configuration Manager Apps will be shown in Company Portal
ShowDisplayNameNextToLogo	Write	Boolean	Boolean that represents whether the administrator-supplied display name will be shown next to the logo image or not
ShowLogo	Write	Boolean	Boolean that represents whether the administrator-supplied logo images are shown or not
ShowOfficeWebApps	Write	Boolean	Boolean that indicates if Office WebApps will be shown in Company Portal
ThemeColor	Write	MSFT_MicrosoftGraphrgbColor	Primary theme color used in the Company Portal applications and web portal
ThemeColorLogo	Write	MSFT_MicrosoftGraphmimeContent	Logo image displayed in Company Portal apps which have a theme color background behind the logo
Id	Write	String	The unique identifier for an entity. Read-only.
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.

Embedded Instances

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)

MSFT_MicrosoftGraphCompanyPortalBlockedAction

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Action	Write	String	Device Action. Possible values are: unknown, remove, reset.	unknown, remove, reset
OwnerType	Write	String	Device ownership type. Possible values are: unknown, company, personal.	unknown, company, personal
Platform	Write	String	Device OS/Platform. Possible values are: android, androidForWork, iOS, macOS, windowsPhone81, windows81AndLater, windows10AndLater, androidWorkProfile, unknown.	android, androidForWork, iOS, macOS, windowsPhone81, windows81AndLater, windows10AndLater, androidWorkProfile, unknown, androidAOSP, androidMobileApplicationManagement, iOSMobileApplicationManagement, unknownFutureValue, windowsMobileApplicationManagement

MSFT_MicrosoftGraphMimeContent

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Type	Write	String	Indicates the content mime type.
Value	Write	String	The Base64 encoded string content.

MSFT_MicrosoftGraphRgbColor

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
B	Write	String	Blue value
G	Write	String	Green value
R	Write	String	Red value

Description

Intune Customization Branding Profile

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

• DeviceManagementApps.Read.All, Group.Read.All

• Update

• DeviceManagementApps.ReadWrite.All, Group.Read.All

Application permissions

• Read

• DeviceManagementApps.Read.All, Group.Read.All

• Update

• DeviceManagementApps.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
    {
        IntuneCustomizationBrandingProfile "IntuneCustomizationBrandingProfile-Company"
        {
            ApplicationId                  = $ApplicationId;
            Assignments                    = @(
                MSFT_DeviceManagementConfigurationPolicyAssignments{
                    dataType = "#microsoft.graph.groupAssignmentTarget"
                    groupId = "00000000-0000-0000-0000-000000000000"
                    deviceAndAppManagementAssignmentFilterType = "none"
                    groupDisplayName = "Include"
                }
            );
            CertificateThumbprint          = $CertificateThumbprint;
            CompanyPortalBlockedActions    = @(
                MSFT_MicrosoftGraphcompanyPortalBlockedAction{
                    Action = "remove"
                    OwnerType = "company"
                    Platform = "windows10AndLater"
                }
            );
            ContactITEmailAddress          = "test@company.com";
            ContactITName                  = "Contact_Name";
            ContactITNotes                 = "Additional information";
            ContactITPhoneNumber           = "+10000000";
            CustomCanSeePrivacyMessage     = "**Bold subhead example with some *emphasis*** and [a link](http://microsoft.com)";
            CustomCantSeePrivacyMessage    = "**Bold subhead example with some *emphasis*** and [a link](http://microsoft.com)";
            DisableDeviceCategorySelection = $False;
            DisplayName                    = "Company";
            EnrollmentAvailability         = "availableWithPrompts";
            Ensure                         = "Present";
            LandingPageCustomizedImage     = MSFT_MicrosoftGraphMimeContent{
                Type = "image/jpeg"
                Value = "Base64EncodedString"
            };
            LightBackgroundLogo            = MSFT_MicrosoftGraphMimeContent{
                Type = "image/png"
                Value = "Base64EncodedString"
            };
            OnlineSupportSiteName          = "Website";
            OnlineSupportSiteUrl           = "https://website.com";
            PrivacyUrl                     = "https://www.example.com";
            ProfileDescription             = "";
            ProfileName                    = "IntuneCustomizationBrandingProfile_1";
            RoleScopeTagIds                = @("0");
            ShowAzureADEnterpriseApps      = $True;
            ShowConfigurationManagerApps   = $True;
            ShowDisplayNameNextToLogo      = $True;
            ShowLogo                       = $True;
            ShowOfficeWebApps              = $True;
            TenantId                       = $TenantId;
            ThemeColor                     = MSFT_MicrosoftGraphRgbColor{
                B = 198
                G = 114
                R = 0
            };
            ThemeColorLogo                 = MSFT_MicrosoftGraphMimeContent{
                Type = "image/png"
                Value = "Base64EncodedString"
            };
        }
    }
}

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(Mandatory = $true)]
        [PSCredential]
        $Credscredential
    )
    Import-DscResource -ModuleName Microsoft365DSC

    node localhost
    {
        IntuneCustomizationBrandingProfile "IntuneCustomizationBrandingProfile-Company"
        {
            ApplicationId                  = $ApplicationId;
            Assignments                    = @(
                MSFT_DeviceManagementConfigurationPolicyAssignments{
                    dataType = "#microsoft.graph.groupAssignmentTarget"
                    groupId = "00000000-0000-0000-0000-000000000000"
                    deviceAndAppManagementAssignmentFilterType = "none"
                    groupDisplayName = "Include"
                }
            );
            CertificateThumbprint          = $CertificateThumbprint;
            CompanyPortalBlockedActions    = @(
                MSFT_MicrosoftGraphcompanyPortalBlockedAction{
                    Action = "remove"
                    OwnerType = "company"
                    Platform = "windows10AndLater"
                }
            );
            ContactITEmailAddress          = "test@company.com";
            ContactITName                  = "Contact_Name";
            ContactITNotes                 = "Additional information";
            ContactITPhoneNumber           = "+10000000";
            CustomCanSeePrivacyMessage     = "**Bold subhead example with some *emphasis*** and [a link](http://microsoft.com)";
            CustomCantSeePrivacyMessage    = "**Bold subhead example with some *emphasis*** and [a link](http://microsoft.com)";
            DisableDeviceCategorySelection = $False;
            DisplayName                    = "Company";
            EnrollmentAvailability         = "availableWithPrompts";
            Ensure                         = "Present";
            LandingPageCustomizedImage     = MSFT_MicrosoftGraphMimeContent{
                Type = "image/jpeg"
                Value = "Base64EncodedString"
            };
            LightBackgroundLogo            = MSFT_MicrosoftGraphMimeContent{
                Type = "image/png"
                Value = "Base64EncodedString"
            };
            OnlineSupportSiteName          = "Website";
            OnlineSupportSiteUrl           = "https://website.com";
            PrivacyUrl                     = "https://www.example.com";
            ProfileDescription             = "";
            ProfileName                    = "IntuneCustomizationBrandingProfile_1";
            RoleScopeTagIds                = @("0");
            ShowAzureADEnterpriseApps      = $True;
            ShowConfigurationManagerApps   = $True;
            ShowDisplayNameNextToLogo      = $True;
            ShowLogo                       = $True;
            ShowOfficeWebApps              = $True;
            TenantId                       = $TenantId;
            ThemeColor                     = MSFT_MicrosoftGraphRgbColor{
                B = 198
                G = 114
                R = 0
            };
            ThemeColorLogo                 = MSFT_MicrosoftGraphMimeContent{
                Type = "image/png"
                Value = "Base64EncodedString"
            };
        }
    }
}

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(Mandatory = $true)]
        [PSCredential]
        $Credscredential
    )
    Import-DscResource -ModuleName Microsoft365DSC

    node localhost
    {
        IntuneCustomizationBrandingProfile "IntuneCustomizationBrandingProfile-Company"
        {
            ApplicationId                  = $ApplicationId;
            CertificateThumbprint          = $CertificateThumbprint;
            DisplayName                    = "Company";
            ProfileName                    = "IntuneCustomizationBrandingProfile_1";
            Ensure                         = "Absent";
            TenantId                       = $TenantId;
        }
    }
}