Set-AdfsRelyingPartyWebTheme

Set-AdfsRelyingPartyWebTheme is accessible with the help of adfs module. To install adfs on your system please refer to this adfs.

Synopsis

Applies a web theme to a relying party.

Description

The Set-AdfsRelyingPartyWebTheme cmdlet applies a web theme to a relying party. A web theme includes logo, illustration, stylesheets, and custom onload.js files.

Parameters

-Illustration
Specifies an illustration as a hash table.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Logo <Hashtable[]>
    Specifies a logo as a hash table.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-OnLoadScriptPath <String>
    Specifies the path of an onload script.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-RTLStyleSheetPath <String>
    Specifies the path of the RTL style sheet.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-SourceRelyingPartyName <String>
    Specifies the name of the source relying party.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-SourceWebThemeName <String>
    Specifies the name of the source web theme.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-StyleSheet <Hashtable[]>
    Specifies a style sheet as a hash table.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-TargetRelyingPartyName <String>
    Specifies the name of the target relying party.

    Required?                    true
    Position?                    1
    Default value                none
    Accept pipeline input?       true(ByValue)
    Accept wildcard characters?  false

-TargetRelyingPartyWebTheme <AdfsRelyingPartyWebTheme>
    Specifies the name of the target web theme.

    Required?                    true
    Position?                    1
    Default value                none
    Accept pipeline input?       true(ByValue)
    Accept wildcard characters?  false

-Confirm <SwitchParameter>
    Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.

    Required?                    false
    Position?                    named
    Default value                false
    Accept pipeline input?       false
    Accept wildcard characters?  false

-WhatIf <SwitchParameter>
    Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.

    Required?                    false
    Position?                    named
    Default value                false
    Accept pipeline input?       false
    Accept wildcard characters?  false

Syntax

Set-AdfsRelyingPartyWebTheme [-StyleSheet <Hashtable[]>] [-RTLStyleSheetPath <String>] [-OnLoadScriptPath <String>] [-Logo <Hashtable[]>] [-Illustration <Hashtable[]>] [-SourceWebThemeName <String>] [-SourceRelyingPartyName <String>] [-TargetRelyingPartyName] <String> [-WhatIf] [-Confirm] [<CommonParameters>]

Set-AdfsRelyingPartyWebTheme [-StyleSheet <Hashtable[]>] [-RTLStyleSheetPath <String>] [-OnLoadScriptPath <String>] [-Logo <Hashtable[]>] [-Illustration <Hashtable[]>] [-SourceWebThemeName <String>] [-SourceRelyingPartyName <String>] [-TargetRelyingPartyWebTheme] <AdfsRelyingPartyWebTheme> [-WhatIf] [-Confirm] [<CommonParameters>]

—————–Example 1—————–
Create a custom theme and assign it to the Office 365 relying party trust
PS C:>New-AdfsWebTheme -Name “Office365Theme” -SourceName “default”
PS C:> Set-AdfsWebTheme -TargetName “Office365Theme” -Illustration @{Path=”C:\localpath\illustration22.jpg”}
PS C:> Set-AdfsRelyingPartyWebTheme -TargetRelyingPartyName “Microsoft Office 365 Identity Platform” -SourceWebThemeName “Office365Theme”
The first command creates an AD FS web theme by using the New-AdfsWebTheme cmdlet. The theme is named Office365Theme.
The second command modifies Office365Theme by using the Set-AdfsWebTheme cmdlet.
The final command assigns the custom theme to the Office 365 relying party trust.

—————–Example 2—————–
Create an advanced per application custom theme and assign it to a relying party
PS C:>New-AdfsWebTheme -Name “AppSpecificTheme” -SourceName “default”
PS C:> Export-AdfsWebTheme -Name “AppSpecificTheme” -DirectoryPath “C:\AppSpecificTheme”
PS C:> Set-AdfsWebTheme -TargetName “AppSpecificTheme” -AdditionalFileResource @{Uri=’/adfs/portal/script/onload.js’;Path=”C:\AppSpecificTheme\script\onload.js”}
PS C:> Set-AdfsRelyingPartyWebTheme -TargetRelyingPartyName “urn:app1” -SourceWebThemeName “AppSpecificTheme”
The first command creates a theme as a copy of the default global theme in AD FS by using New-AdfsWebTheme.
The second command exports the theme for customization by using the Export-AdfsWebTheme cmdlet.
The third command customizes the theme by specifying files by using Set-AdfsWebTheme.
The final command applies the customized theme to a relying party.

You can check the Version, CommandType and Source of this cmdlet by giving below command.

Get-Command Set-AdfsRelyingPartyWebTheme

Get-Command Set-AdfsRelyingPartyWebTheme powershell script command cmdlet adfs

You can also read about

  • Export-AdfsWebTheme
  • Get-AdfsRelyingPartyWebTheme
  • New-AdfsWebTheme
  • Remove-AdfsRelyingPartyWebTheme
  • Set-AdfsWebTheme

To know more PowerShell cmdlets(Commands) on Active Directory Federation Services(ADFS) click here

Click on this Link for an Single place where you get all the PowerShell cmdlet sorted based on the modules.

You can also refer other blogs on PowerShell at link

You can also refer other blogs on Microsoft at link

And also if you required any technology you want to learn, let us know below we will publish them in our site http://tossolution.com/

Like our page in Facebook and follow us for New technical information.

References are taken from Microsoft

Leave a Reply

Your email address will not be published. Required fields are marked *