Skip to content

Commit 724bb66

Browse files
nabeelnaiyernabeelnaiyer
committed
add docs for new file request commands
1 parent 04eec0e commit 724bb66

File tree

4 files changed

+364
-0
lines changed

4 files changed

+364
-0
lines changed

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

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
---
2+
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/add-spofilerequestbrandingprofile
5+
applicable: SharePoint Online
6+
title: Add-SPOFileRequestBrandingProfile
7+
author: nabeelnaiyer
8+
ms.author: nabeelnaiyer
9+
ms.reviewer:
10+
manager: ahackett
11+
schema: 2.0.0
12+
---
13+
14+
# Add-SPOFileRequestBrandingProfile
15+
16+
## SYNOPSIS
17+
18+
Adds a branding profile for the file request feature by specifying logo and background assets from an existing organization asset library.
19+
20+
## SYNTAX
21+
22+
```
23+
Add-SPOFileRequestBrandingProfile -AssetLibraryUrl <String> -IsPrimary <Boolean> [-LogoFileUrl <String>] [-BackgroundFileUrl <String>]
24+
[<CommonParameters>]
25+
```
26+
27+
## DESCRIPTION
28+
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).
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
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+
37+
```powershell
38+
Add-SPOFileRequestBrandingProfile -AssetLibraryUrl "https://contoso.sharepoint.com/sites/branding/Assets" -LogoFileUrl "/sites/branding/Assets/LogoA.jpg" -BackgroundFileUrl "/sites/branding/Assets/BackgroundA.jpg" -IsPrimary $true
39+
```
40+
### Example 2
41+
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.
43+
44+
```powershell
45+
Add-SPOFileRequestBrandingProfile -AssetLibraryUrl "https://contoso.sharepoint.com/sites/branding/Assets" -LogoFileUrl "/sites/branding/Assets/LogoB.jpg" -BackgroundFileUrl "/sites/branding/Assets/BackgroundB.jpg" -IsPrimary $false
46+
```
47+
48+
## PARAMETERS
49+
50+
### -AssetLibraryUrl
51+
52+
> Applicable: SharePoint Online
53+
54+
Specifies the absolute URL of the asset library containing the branding assets.
55+
56+
```yaml
57+
Type: System.String
58+
Parameter Sets: (All)
59+
Aliases:
60+
61+
Required: True
62+
Position: Named
63+
Default value: None
64+
Accept pipeline input: False
65+
Accept wildcard characters: False
66+
```
67+
68+
### -LogoFileUrl
69+
70+
Specifies the relative URL of the logo image file.
71+
72+
```yaml
73+
Type: System.String
74+
Parameter Sets: (All)
75+
Aliases:
76+
77+
Required: False
78+
Position: Named
79+
Default value: None
80+
Accept pipeline input: False
81+
Accept wildcard characters: False
82+
```
83+
84+
### -BackgroundFileUrl
85+
86+
Specifies the relative URL of the background image file.
87+
88+
```yaml
89+
Type: System.String
90+
Parameter Sets: (All)
91+
Aliases:
92+
93+
Required: False
94+
Position: Named
95+
Default value: None
96+
Accept pipeline input: False
97+
Accept wildcard characters: False
98+
```
99+
100+
### -IsPrimary
101+
Specifies if this branding profile configuration is the primary profile.
102+
103+
```yaml
104+
Type: System.Boolean
105+
Parameter Sets: (All)
106+
Aliases:
107+
108+
Required: False
109+
Position: Named
110+
Default value: None
111+
Accept pipeline input: False
112+
Accept wildcard characters: False
113+
```
114+
115+
### CommonParameters
116+
117+
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).
118+
119+
## INPUTS
120+
121+
### None
122+
123+
## OUTPUTS
124+
125+
### System.Object
126+
127+
## NOTES
128+
129+
## RELATED LINKS
130+
131+
[Get-SPOFileRequestBrandingProfiles](/powershell/module/sharepoint-online/get-spofilerequestbrandingprofiles)
132+
133+
[Remove-SPOFileRequestBrandingProfile](/powershell/module/sharepoint-online/remove-spofilerequestbrandingprofile)
134+
135+
[Switch-SPOFileRequestBrandingProfiles](/powershell/module/sharepoint-online/switch-spofilerequestbrandingprofiles)

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

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/get-spofilerequestbrandingprofiles
5+
applicable: SharePoint Online
6+
title: Get-SPOFileRequestBrandingProfiles
7+
author: nabeelnaiyer
8+
ms.author: nabeelnaiyer
9+
ms.reviewer:
10+
manager: ahackett
11+
schema: 2.0.0
12+
---
13+
14+
# Get-SPOFileRequestBrandingProfiles
15+
16+
## SYNOPSIS
17+
18+
Retrieves branding profiles configured for the file request feature, including details about logo and background assets.
19+
20+
## SYNTAX
21+
22+
```
23+
Get-SPOFileRequestBrandingProfiles [<CommonParameters>]
24+
```
25+
26+
## DESCRIPTION
27+
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.
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
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+
36+
```powershell
37+
Get-SPOFileRequestBrandingProfiles
38+
```
39+
40+
## PARAMETERS
41+
42+
### CommonParameters
43+
44+
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).
45+
46+
## INPUTS
47+
48+
### None
49+
50+
## OUTPUTS
51+
52+
### System.Object
53+
54+
## NOTES
55+
56+
## RELATED LINKS
57+
58+
[Add-SPOFileRequestBrandingProfile](/powershell/module/sharepoint-online/add-spofilerequestbrandingprofile)
59+
60+
[Remove-SPOFileRequestBrandingProfile](/powershell/module/sharepoint-online/remove-spofilerequestbrandingprofile)
61+
62+
[Switch-SPOFileRequestBrandingProfiles](/powershell/module/sharepoint-online/switch-spofilerequestbrandingprofiles)

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

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
---
2+
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/remove-spofilerequestbrandingprofile
5+
applicable: SharePoint Online
6+
title: Remove-SPOFileRequestBrandingProfile
7+
author: nabeelnaiyer
8+
ms.author: nabeelnaiyer
9+
ms.reviewer:
10+
manager: ahackett
11+
schema: 2.0.0
12+
---
13+
14+
# Remove-SPOFileRequestBrandingProfile
15+
16+
## SYNOPSIS
17+
18+
Removes a branding profile (either primary or secondary) configured for the file request feature across the tenant.
19+
20+
## SYNTAX
21+
22+
```
23+
Remove-SPOFileRequestBrandingProfile [-Primary] [-Secondary]
24+
[<CommonParameters>]
25+
```
26+
27+
## DESCRIPTION
28+
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.
30+
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.
33+
34+
## EXAMPLES
35+
36+
### Example 1
37+
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+
40+
```powershell
41+
Remove-SPOFileRequestBrandingProfile -Primary
42+
```
43+
### Example 2
44+
45+
This example removes the secondary branding profile that was previously configured for file request pages in the tenant.
46+
47+
```powershell
48+
Remove-SPOFileRequestBrandingProfile -Secondary
49+
```
50+
51+
## PARAMETERS
52+
53+
### -Primary
54+
55+
Specifies the absolute URL of the asset library containing the branding assets.
56+
57+
```yaml
58+
Type: SwitchParameter
59+
Parameter Sets: (All)
60+
Aliases:
61+
62+
Required: False
63+
Position: Named
64+
Default value: None
65+
Accept pipeline input: False
66+
Accept wildcard characters: False
67+
```
68+
69+
### -Secondary
70+
71+
Specifies the relative URL of the logo image file.
72+
73+
```yaml
74+
Type: SwitchParameter
75+
Parameter Sets: (All)
76+
Aliases:
77+
78+
Required: False
79+
Position: Named
80+
Default value: None
81+
Accept pipeline input: False
82+
Accept wildcard characters: False
83+
```
84+
85+
### CommonParameters
86+
87+
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).
88+
89+
## INPUTS
90+
91+
### None
92+
93+
## OUTPUTS
94+
95+
### System.Object
96+
97+
## NOTES
98+
99+
## RELATED LINKS
100+
101+
[Add-SPOFileRequestBrandingProfile](/powershell/module/sharepoint-online/add-spofilerequestbrandingprofile)
102+
103+
[Get-SPOFileRequestBrandingProfiles](/powershell/module/sharepoint-online/get-spofilerequestbrandingprofiles)
104+
105+
[Switch-SPOFileRequestBrandingProfiles](/powershell/module/sharepoint-online/switch-spofilerequestbrandingprofiles)

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

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/switch-spofilerequestbrandingprofiles
5+
applicable: SharePoint Online
6+
title: Switch-SPOFileRequestBrandingProfiles
7+
author: nabeelnaiyer
8+
ms.author: nabeelnaiyer
9+
ms.reviewer:
10+
manager: ahackett
11+
schema: 2.0.0
12+
---
13+
14+
# Switch-SPOFileRequestBrandingProfiles
15+
16+
## SYNOPSIS
17+
18+
Switches the primary and secondary file request branding profiles configured for the tenant.
19+
20+
## SYNTAX
21+
22+
```
23+
Switch-SPOFileRequestBrandingProfiles [<CommonParameters>]
24+
```
25+
26+
## DESCRIPTION
27+
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.
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
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+
36+
```powershell
37+
Switch-SPOFileRequestBrandingProfiles
38+
```
39+
40+
## PARAMETERS
41+
42+
### CommonParameters
43+
44+
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).
45+
46+
## INPUTS
47+
48+
### None
49+
50+
## OUTPUTS
51+
52+
### System.Object
53+
54+
## NOTES
55+
56+
## RELATED LINKS
57+
58+
[Add-SPOFileRequestBrandingProfile](/powershell/module/sharepoint-online/add-spofilerequestbrandingprofile)
59+
60+
[Get-SPOFileRequestBrandingProfiles](/powershell/module/sharepoint-online/get-spofilerequestbrandingprofiles)
61+
62+
[Remove-SPOFileRequestBrandingProfile](/powershell/module/sharepoint-online/remove-spofilerequestbrandingprofile)

0 commit comments

Comments
 (0)