Skip to content

Commit 7f97d5f

Browse files
committed
address PR feedback
1 parent 724bb66 commit 7f97d5f

File tree

4 files changed

+20
-18
lines changed

4 files changed

+20
-18
lines changed

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOFileRequestBrandingProfile.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,25 +26,26 @@ Add-SPOFileRequestBrandingProfile -AssetLibraryUrl <String> -IsPrimary <Boolean>
2626

2727
## DESCRIPTION
2828

29-
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).
29+
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).
3030

3131
## EXAMPLES
3232

3333
### Example 1
3434

35-
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.
36-
3735
```powershell
3836
Add-SPOFileRequestBrandingProfile -AssetLibraryUrl "https://contoso.sharepoint.com/sites/branding/Assets" -LogoFileUrl "/sites/branding/Assets/LogoA.jpg" -BackgroundFileUrl "/sites/branding/Assets/BackgroundA.jpg" -IsPrimary $true
3937
```
40-
### Example 2
4138

42-
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.
39+
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.
40+
41+
### Example 2
4342

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

47+
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.
48+
4849
## PARAMETERS
4950

5051
### -AssetLibraryUrl

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFileRequestBrandingProfiles.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,18 @@ Get-SPOFileRequestBrandingProfiles [<CommonParameters>]
2525

2626
## DESCRIPTION
2727

28-
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.
28+
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.
2929

3030
## EXAMPLES
3131

3232
### Example 1
3333

34-
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.
35-
3634
```powershell
3735
Get-SPOFileRequestBrandingProfiles
3836
```
3937

38+
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.
39+
4040
## PARAMETERS
4141

4242
### CommonParameters

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOFileRequestBrandingProfile.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,28 +26,29 @@ Remove-SPOFileRequestBrandingProfile [-Primary] [-Secondary]
2626

2727
## DESCRIPTION
2828

29-
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.
29+
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.
3030

31-
Note:
32-
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.
31+
> [!NOTE]
32+
> 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.
3333
3434
## EXAMPLES
3535

3636
### Example 1
3737

38-
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.
39-
4038
```powershell
4139
Remove-SPOFileRequestBrandingProfile -Primary
4240
```
43-
### Example 2
4441

45-
This example removes the secondary branding profile that was previously configured for file request pages in the tenant.
42+
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.
43+
44+
### Example 2
4645

4746
```powershell
4847
Remove-SPOFileRequestBrandingProfile -Secondary
4948
```
5049

50+
This example removes the secondary branding profile that was previously configured for file request pages in the tenant.
51+
5152
## PARAMETERS
5253

5354
### -Primary

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Switch-SPOFileRequestBrandingProfiles.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,18 @@ Switch-SPOFileRequestBrandingProfiles [<CommonParameters>]
2525

2626
## DESCRIPTION
2727

28-
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.
28+
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.
2929

3030
## EXAMPLES
3131

3232
### Example 1
3333

34-
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.
35-
3634
```powershell
3735
Switch-SPOFileRequestBrandingProfiles
3836
```
3937

38+
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.
39+
4040
## PARAMETERS
4141

4242
### CommonParameters

0 commit comments

Comments
 (0)