| external help file | Microsoft.Online.SharePoint.PowerShell.dll-Help.xml |
|---|---|
| Module Name | Microsoft.Online.SharePoint.PowerShell |
| online version | https://learn.microsoft.com/powershell/module/microsoft.online.sharepoint.powershell/add-spofilerequestbrandingprofile |
| applicable | SharePoint Online |
| title | Add-SPOFileRequestBrandingProfile |
| author | nabeelnaiyer |
| ms.author | nabeelnaiyer |
| ms.reviewer | |
| manager | ahackett |
| schema | 2.0.0 |
Adds a branding profile for the file request feature by specifying logo and background assets from an existing organization asset library.
Add-SPOFileRequestBrandingProfile -AssetLibraryUrl <String> -IsPrimary <Boolean> [-LogoFileUrl <String>] [-BackgroundFileUrl <String>]
[<CommonParameters>]
This cmdlet registers a branding profile to be used for the file request feature across the tenant. You must specify an existing organization asset library URL where the branding assets are stored and indicate whether the profile should be designated as primary. Each tenant can have one primary and one secondary profile. The organization asset library being used must be configured with the CdnType being "Public" (see Add-SPOOrgAssetsLibrary for more info).
Add-SPOFileRequestBrandingProfile -AssetLibraryUrl "https://contoso.sharepoint.com/sites/branding/Assets" -LogoFileUrl "/sites/branding/Assets/LogoA.jpg" -BackgroundFileUrl "/sites/branding/Assets/BackgroundA.jpg" -IsPrimary $trueThis example sets https://contoso.sharepoint.com/sites/branding/Assets/ as the organization asset library containing branding images for file request pages. It adds a branding profile using LogoA.jpg and BackgroundA.jpg, whose server-relative paths are provided via the LogoFileUrl and BackgroundFileUrl parameters. The -IsPrimary flag indicates whether this profile should be treated as the primary branding profile for the tenant. In this example, the profile is being set as the primary profile.
Add-SPOFileRequestBrandingProfile -AssetLibraryUrl "https://contoso.sharepoint.com/sites/branding/Assets" -LogoFileUrl "/sites/branding/Assets/LogoB.jpg" -BackgroundFileUrl "/sites/branding/Assets/BackgroundB.jpg" -IsPrimary $falseThis example sets https://contoso.sharepoint.com/sites/branding/Assets/ as the organization asset library containing branding images for file request pages. It adds a branding profile using LogoB.jpg and BackgroundB.jpg, whose server-relative paths are provided via the LogoFileUrl and BackgroundFileUrl parameters. The -IsPrimary flag indicates whether this profile should be treated as the primary branding profile for the tenant. In this example, the profile is NOT being set as the primary profile.
Applicable: SharePoint Online
Specifies the absolute URL of the asset library containing the branding assets.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the relative URL of the logo image file.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the relative URL of the background image file.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies if this branding profile configuration is the primary profile.
Type: System.Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Get-SPOFileRequestBrandingProfiles