en-US/about_SPWebAppSuiteBar.help.txt
|
.NAME SPWebAppSuiteBar # Description **Type:** Distributed **Requires CredSSP:** No This resource is used to set the Suite Bar branding for web applications. It supports both the SharePoint 2013 and SharePoint 2016/2019 ways of branding the suite bar. Requirements: For SharePoint 2013, only the SuiteBarBrandingElementHtml should be specified, whereas for SharePoint 2016/2019, all properties are supported. Note that SuiteBarBrandingElementHtml has no effect unless using a SharePoint 2013 master page. .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 1 This example sets the branding for the suite bar of a given Web Application in SharePoint 2016/2019. 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 2 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 } } } |