Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
---
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
Module Name: Microsoft.Online.SharePoint.PowerShell
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/add-spofilerequestbrandingprofile
applicable: SharePoint Online
title: Add-SPOFileRequestBrandingProfile
author: nabeelnaiyer
ms.author: nabeelnaiyer
ms.reviewer:
manager: ahackett
schema: 2.0.0
---

# Add-SPOFileRequestBrandingProfile

## SYNOPSIS

Adds a branding profile for the file request feature by specifying logo and background assets from an existing organization asset library.

## SYNTAX

```
Add-SPOFileRequestBrandingProfile -AssetLibraryUrl <String> -IsPrimary <Boolean> [-LogoFileUrl <String>] [-BackgroundFileUrl <String>]
[<CommonParameters>]
```

## DESCRIPTION

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](/powershell/module/sharepoint-online/add-spoorgassetslibrary) for more info).

## EXAMPLES

### Example 1

```powershell
Add-SPOFileRequestBrandingProfile -AssetLibraryUrl "https://contoso.sharepoint.com/sites/branding/Assets" -LogoFileUrl "/sites/branding/Assets/LogoA.jpg" -BackgroundFileUrl "/sites/branding/Assets/BackgroundA.jpg" -IsPrimary $true
```

This 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.

### Example 2

```powershell
Add-SPOFileRequestBrandingProfile -AssetLibraryUrl "https://contoso.sharepoint.com/sites/branding/Assets" -LogoFileUrl "/sites/branding/Assets/LogoB.jpg" -BackgroundFileUrl "/sites/branding/Assets/BackgroundB.jpg" -IsPrimary $false
```

This 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.

## PARAMETERS

### -AssetLibraryUrl

> Applicable: SharePoint Online

Specifies the absolute URL of the asset library containing the branding assets.

```yaml
Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -LogoFileUrl

Specifies the relative URL of the logo image file.

```yaml
Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -BackgroundFileUrl

Specifies the relative URL of the background image file.

```yaml
Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -IsPrimary
Specifies if this branding profile configuration is the primary profile.

```yaml
Type: System.Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216).

## INPUTS

### None

## OUTPUTS

### System.Object

## NOTES

## RELATED LINKS

[Get-SPOFileRequestBrandingProfiles](/powershell/module/sharepoint-online/get-spofilerequestbrandingprofiles)

[Remove-SPOFileRequestBrandingProfile](/powershell/module/sharepoint-online/remove-spofilerequestbrandingprofile)

[Switch-SPOFileRequestBrandingProfiles](/powershell/module/sharepoint-online/switch-spofilerequestbrandingprofiles)
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
Module Name: Microsoft.Online.SharePoint.PowerShell
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/get-spofilerequestbrandingprofiles
applicable: SharePoint Online
title: Get-SPOFileRequestBrandingProfiles
author: nabeelnaiyer
ms.author: nabeelnaiyer
ms.reviewer:
manager: ahackett
schema: 2.0.0
---

# Get-SPOFileRequestBrandingProfiles

## SYNOPSIS

Retrieves branding profiles configured for the file request feature, including details about logo and background assets.

## SYNTAX

```
Get-SPOFileRequestBrandingProfiles [<CommonParameters>]
```

## DESCRIPTION

This cmdlet returns the branding profiles currently configured for the file request feature in the tenant. Each profile contains metadata about the logo and background image assets, such as file name and file URL. The cmdlet will output the asset library URL being used, along with information for both the primary and secondary branding profiles (if present). Each tenant can have at most one primary and one secondary branding profile.

## EXAMPLES

### Example 1

```powershell
Get-SPOFileRequestBrandingProfiles
```

This example retrieves the branding profiles configured for the file request feature. If profiles have been added using Add-SPOFileRequestBrandingProfile, the output will include the asset library URL and details abou the branding profiles such as file names and URLs for primary and secondary profiles if present.
Copy link
Contributor

@samkabue samkabue Jul 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add-SPOFileRequestBrandingProfile

back tick #Closed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added back tick


## PARAMETERS

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216).

## INPUTS

### None

## OUTPUTS

### System.Object

## NOTES

## RELATED LINKS

[Add-SPOFileRequestBrandingProfile](/powershell/module/sharepoint-online/add-spofilerequestbrandingprofile)

[Remove-SPOFileRequestBrandingProfile](/powershell/module/sharepoint-online/remove-spofilerequestbrandingprofile)

[Switch-SPOFileRequestBrandingProfiles](/powershell/module/sharepoint-online/switch-spofilerequestbrandingprofiles)
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
---
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
Module Name: Microsoft.Online.SharePoint.PowerShell
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/remove-spofilerequestbrandingprofile
applicable: SharePoint Online
title: Remove-SPOFileRequestBrandingProfile
author: nabeelnaiyer
ms.author: nabeelnaiyer
ms.reviewer:
manager: ahackett
schema: 2.0.0
---

# Remove-SPOFileRequestBrandingProfile

## SYNOPSIS

Removes a branding profile (either primary or secondary) configured for the file request feature across the tenant.

## SYNTAX

```
Remove-SPOFileRequestBrandingProfile [-Primary] [-Secondary]
[<CommonParameters>]
```

## DESCRIPTION

This cmdlet deletes either the primary or secondary branding profile associated with the file request feature. You must specify exactly one of the `-Primary` or `-Secondary` switches to indicate which profile to remove. If both switches are used or neither is specified, the cmdlet will throw an error.

> [!NOTE]
> If you remove the primary profile and a secondary profile exists, the secondary profile will automatically be promoted to primary. This ensures that the file request feature always has a primary branding profile if one is available.

Copy link
Contributor

@samkabue samkabue Jul 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use this format:

> [!NOTE]
> <your text goes here>
``` #Closed

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(see other files in this repo for example usage)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Modified to use [!] format

## EXAMPLES

### Example 1

```powershell
Remove-SPOFileRequestBrandingProfile -Primary
```

This example removes the primary branding profile that was previously configured for file request pages in the tenant. If a secondary branding profile exists, it will automatically be promoted to primary after this command completes.

### Example 2

```powershell
Remove-SPOFileRequestBrandingProfile -Secondary
```

This example removes the secondary branding profile that was previously configured for file request pages in the tenant.

## PARAMETERS

### -Primary

Specifies the absolute URL of the asset library containing the branding assets.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Secondary

Specifies the relative URL of the logo image file.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216).

## INPUTS

### None

## OUTPUTS

### System.Object

## NOTES

## RELATED LINKS

[Add-SPOFileRequestBrandingProfile](/powershell/module/sharepoint-online/add-spofilerequestbrandingprofile)

[Get-SPOFileRequestBrandingProfiles](/powershell/module/sharepoint-online/get-spofilerequestbrandingprofiles)

[Switch-SPOFileRequestBrandingProfiles](/powershell/module/sharepoint-online/switch-spofilerequestbrandingprofiles)
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
Module Name: Microsoft.Online.SharePoint.PowerShell
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/switch-spofilerequestbrandingprofiles
applicable: SharePoint Online
title: Switch-SPOFileRequestBrandingProfiles
author: nabeelnaiyer
ms.author: nabeelnaiyer
ms.reviewer:
manager: ahackett
schema: 2.0.0
---

# Switch-SPOFileRequestBrandingProfiles

## SYNOPSIS

Switches the primary and secondary file request branding profiles configured for the tenant.

## SYNTAX

```
Switch-SPOFileRequestBrandingProfiles [<CommonParameters>]
```

## DESCRIPTION

This cmdlet exchanges the current primary and secondary branding profiles used for the file request feature. This allows administrators to quickly change which profile is active without re-uploading or modifying assets. To use this cmdlet, both a primary and a secondary branding profile must already exist. The primary will become the secondary, and vice versa. If only one profile is present, the switch operation will fail.

## EXAMPLES

### Example 1

```powershell
Switch-SPOFileRequestBrandingProfiles
```

This example switches the current primary and secondary branding profiles used for file request pages. After running this command, the existing secondary profile will become the new primary, and the current primary will become secondary.

## PARAMETERS

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216).

## INPUTS

### None

## OUTPUTS

### System.Object

## NOTES

## RELATED LINKS

[Add-SPOFileRequestBrandingProfile](/powershell/module/sharepoint-online/add-spofilerequestbrandingprofile)

[Get-SPOFileRequestBrandingProfiles](/powershell/module/sharepoint-online/get-spofilerequestbrandingprofiles)

[Remove-SPOFileRequestBrandingProfile](/powershell/module/sharepoint-online/remove-spofilerequestbrandingprofile)