en-US/about_SPWebAppSuiteBar.help.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
.NAME
    SPWebAppSuiteBar

# Description
    
    **Type:** Distributed
    
    This resource is used to set the Suite Bar branding for web
    applications. It supports both the SharePoint 2013 and SharePoint
    2016 ways of branding the suite bar.
    
    Requirements:
    For SharePoint 2013, only the SuiteBarBrandingElementHtml
    should be specified, whereas for SharePoint 2016, only one
    or all of SuiteNavBrandingLogoNavigationUrl,
    SuiteNavBrandingLogoTitle, SuiteNavBrandingLogoUrl or
    SuiteNavBrandingText should be.
    
.PARAMETER WebAppUrl
    Key - string
    The URL of the web application

.PARAMETER SuiteNavBrandingLogoNavigationUrl
    Write - String
    SP2016+: Url to take the users to when the suite bar logo is clicked

.PARAMETER SuiteNavBrandingLogoTitle
    Write - String
    SP2016+: Alternative text for the Suite Bar Logo

.PARAMETER SuiteNavBrandingLogoUrl
    Write - String
    SP2016+: URL of the logo for the Suite Bar

.PARAMETER SuiteNavBrandingText
    Write - String
    SP2016+: Text to display at the left hand side of the suite bar

.PARAMETER SuiteBarBrandingElementHtml
    Write - String
    SP2013: HTML to inject in the left hand-side of the Suite Bar

.PARAMETER InstallAccount
    Write - String
    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5


.EXAMPLE
    This example sets the branding for the suite bar of a given
    Web Application in SharePoint 2016.


    Configuration Example 
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPWebAppSuiteBar SP2016Branding
            {
                WebAppUrl                               = "https://intranet.sharepoint.contoso.com"
                SuiteNavBrandingLogoNavigationUrl       = "http://sites.sharepoint.com"
                SuiteNavBrandingLogoTitle               = "This is my logo"
                SuiteNavBrandingLogoUrl                 = "http://sites.sharepoint.com/images/logo.gif"
                SuiteNavBrandingText                    = "SharePointDSC WebApp"
                PsDscRunAsCredential                    = $SetupAccount
            }
        }
    }


.EXAMPLE
    This example sets the branding for the suite bar of a given
    Web Application in SharePoint 2013.


    Configuration Example 
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPWebAppSuiteBar SP2013Branding
            {
                WebAppUrl                               = "https://intranet.sharepoint.contoso.com"
                SuiteBarBrandingElementHtml             = "<div>SharePointDSC WebApp</div>"
                PsDscRunAsCredential                    = $SetupAccount
            }
        }
    }