From 724bb66eda769518e9cb6cb97c6b6f8b884b977f Mon Sep 17 00:00:00 2001 From: Nabeel Naiyer <222511173+nabeelnaiyer@users.noreply.github.com> Date: Fri, 25 Jul 2025 16:08:26 -0500 Subject: [PATCH 1/3] add docs for new file request commands --- .../Add-SPOFileRequestBrandingProfile.md | 135 ++++++++++++++++++ .../Get-SPOFileRequestBrandingProfiles.md | 62 ++++++++ .../Remove-SPOFileRequestBrandingProfile.md | 105 ++++++++++++++ .../Switch-SPOFileRequestBrandingProfiles.md | 62 ++++++++ 4 files changed, 364 insertions(+) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOFileRequestBrandingProfile.md create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFileRequestBrandingProfiles.md create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOFileRequestBrandingProfile.md create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Switch-SPOFileRequestBrandingProfiles.md diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOFileRequestBrandingProfile.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOFileRequestBrandingProfile.md new file mode 100644 index 000000000..f6b2331b2 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOFileRequestBrandingProfile.md @@ -0,0 +1,135 @@ +--- +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 -IsPrimary [-LogoFileUrl ] [-BackgroundFileUrl ] + [] +``` + +## DESCRIPTION + +The Add-SPOFileRequestBrandingProfile 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 + +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. + +```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 +``` +### Example 2 + +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. + +```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 +``` + +## 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) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFileRequestBrandingProfiles.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFileRequestBrandingProfiles.md new file mode 100644 index 000000000..ee5e6b2ee --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFileRequestBrandingProfiles.md @@ -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 [] +``` + +## DESCRIPTION + +The Get-SPOFileRequestBrandingProfiles 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 + +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. + +```powershell +Get-SPOFileRequestBrandingProfiles +``` + +## 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) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOFileRequestBrandingProfile.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOFileRequestBrandingProfile.md new file mode 100644 index 000000000..df7a79045 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOFileRequestBrandingProfile.md @@ -0,0 +1,105 @@ +--- +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] +[] +``` + +## DESCRIPTION + +The Remove-SPOFileRequestBrandingProfile 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. + +## EXAMPLES + +### Example 1 + +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. + +```powershell +Remove-SPOFileRequestBrandingProfile -Primary +``` +### Example 2 + +This example removes the secondary branding profile that was previously configured for file request pages in the tenant. + +```powershell +Remove-SPOFileRequestBrandingProfile -Secondary +``` + +## 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) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Switch-SPOFileRequestBrandingProfiles.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Switch-SPOFileRequestBrandingProfiles.md new file mode 100644 index 000000000..ac3d6376e --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Switch-SPOFileRequestBrandingProfiles.md @@ -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 [] +``` + +## DESCRIPTION + +The Switch-SPOFileRequestBrandingProfiles 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 + +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. + +```powershell +Switch-SPOFileRequestBrandingProfiles +``` + +## 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) From 7f97d5f4af209a6ac2efac50b03e24025b54b206 Mon Sep 17 00:00:00 2001 From: Nabeel Naiyer <222511173+nabeelnaiyer@users.noreply.github.com> Date: Mon, 28 Jul 2025 15:40:19 -0500 Subject: [PATCH 2/3] address PR feedback --- .../Add-SPOFileRequestBrandingProfile.md | 11 ++++++----- .../Get-SPOFileRequestBrandingProfiles.md | 6 +++--- .../Remove-SPOFileRequestBrandingProfile.md | 15 ++++++++------- .../Switch-SPOFileRequestBrandingProfiles.md | 6 +++--- 4 files changed, 20 insertions(+), 18 deletions(-) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOFileRequestBrandingProfile.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOFileRequestBrandingProfile.md index f6b2331b2..f0bc9cd5d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOFileRequestBrandingProfile.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOFileRequestBrandingProfile.md @@ -26,25 +26,26 @@ Add-SPOFileRequestBrandingProfile -AssetLibraryUrl -IsPrimary ## DESCRIPTION -The Add-SPOFileRequestBrandingProfile 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). +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 -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. - ```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 ``` -### Example 2 -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. +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 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFileRequestBrandingProfiles.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFileRequestBrandingProfiles.md index ee5e6b2ee..fea1d9b99 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFileRequestBrandingProfiles.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFileRequestBrandingProfiles.md @@ -25,18 +25,18 @@ Get-SPOFileRequestBrandingProfiles [] ## DESCRIPTION -The Get-SPOFileRequestBrandingProfiles 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. +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 -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. - ```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. + ## PARAMETERS ### CommonParameters diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOFileRequestBrandingProfile.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOFileRequestBrandingProfile.md index df7a79045..e9048de90 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOFileRequestBrandingProfile.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOFileRequestBrandingProfile.md @@ -26,28 +26,29 @@ Remove-SPOFileRequestBrandingProfile [-Primary] [-Secondary] ## DESCRIPTION -The Remove-SPOFileRequestBrandingProfile 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. +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. +> [!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. ## EXAMPLES ### Example 1 -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. - ```powershell Remove-SPOFileRequestBrandingProfile -Primary ``` -### Example 2 -This example removes the secondary branding profile that was previously configured for file request pages in the tenant. +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 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Switch-SPOFileRequestBrandingProfiles.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Switch-SPOFileRequestBrandingProfiles.md index ac3d6376e..542fdfdfd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Switch-SPOFileRequestBrandingProfiles.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Switch-SPOFileRequestBrandingProfiles.md @@ -25,18 +25,18 @@ Switch-SPOFileRequestBrandingProfiles [] ## DESCRIPTION -The Switch-SPOFileRequestBrandingProfiles 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. +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 -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. - ```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 From bbcd890bc7263b3f349f06f507c52589b0ed71ad Mon Sep 17 00:00:00 2001 From: Nabeel Naiyer <222511173+nabeelnaiyer@users.noreply.github.com> Date: Tue, 29 Jul 2025 15:53:32 -0500 Subject: [PATCH 3/3] add new commands to powershell.md --- .../Get-SPOFileRequestBrandingProfiles.md | 2 +- .../Microsoft.Online.SharePoint.PowerShell.md | 12 ++++++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFileRequestBrandingProfiles.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFileRequestBrandingProfiles.md index fea1d9b99..152d3e097 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFileRequestBrandingProfiles.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFileRequestBrandingProfiles.md @@ -35,7 +35,7 @@ This cmdlet returns the branding profiles currently configured for the file requ 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. +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. ## PARAMETERS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md index eea1a3750..fe2ee5d96 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md @@ -21,6 +21,9 @@ Adds the mentioned billing profile details to a standard container type. ### [Add-SPOContentSecurityPolicy](Add-SPOContentSecurityPolicy.md) Adds a source to the **Content Security Policy** configuration. +### [Add-SPOFileRequestBrandingProfile](Add-SPOFileRequestBrandingProfile.md) +Adds a branding profile for the file request feature by specifying logo and background assets from an existing organization asset library. + ### [Add-SPOGeoAdministrator](Add-SPOGeoAdministrator.md) Adds a new SharePoint user or security group as GeoAdministrator to a multi-geo tenant. @@ -192,6 +195,9 @@ This cmdlet enables the administrator to check status of all active and availabl ### [Get-SPOExternalUser](Get-SPOExternalUser.md) Returns external users in the tenant. +### [Get-SPOFileRequestBrandingProfiles](Get-SPOFileRequestBrandingProfiles.md) +Retrieves branding profiles configured for the file request feature, including details about logo and background assets. + ### [Get-SPOGeoAdministrator](Get-SPOGeoAdministrator.md) This cmdlet returns the SharePoint Online user or security group accounts with Global Admin privileges in the current multi-geo tenant. @@ -489,6 +495,9 @@ Removes a SharePoint Online deleted site collection from the Recycle Bin. ### [Remove-SPOExternalUser](Remove-SPOExternalUser.md) Removes a collection of external users from the tenancy's folder. +### [Remove-SPOFileRequestBrandingProfile](Remove-SPOFileRequestBrandingProfile.md) +Removes a branding profile (either primary or secondary) configured for the file request feature across the tenant. + ### [Remove-SPOGeoAdministrator](Remove-SPOGeoAdministrator.md) Removes a new SharePoint user or security Group in the current Multi-Geo Tenant. @@ -804,6 +813,9 @@ In a Multi-Geo company, stops the ability to move a user's content related objec ### [Submit-SPOMigrationJob](Submit-SPOMigrationJob.md) **Note**: This cmdlet has been deprecated. To migrate to SharePoint and Microsoft 365 using PowerShell, see [Migrate to SharePoint using PowerShell](/sharepointmigration/overview-spmt-ps-cmdlets). Cmdlet to submit a new migration job referenced to a previously uploaded package in Azure Blob storage into to a site collection. +### [Switch-SPOFileRequestBrandingProfiles](Switch-SPOFileRequestBrandingProfiles.md) +Switches the primary and secondary file request branding profiles configured for the tenant. + ### [Test-SPOSite](Test-SPOSite.md) Tests a SharePoint Online site collection.