Skip to content

Commit 70ca13a

Browse files
samkabuesamkabue
authored
Merge branch 'main' into main
2 parents 07b7682 + 3f491e0 commit 70ca13a

File tree

5 files changed

+378
-0
lines changed

5 files changed

+378
-0
lines changed

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

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
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+
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).
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
35+
```powershell
36+
Add-SPOFileRequestBrandingProfile -AssetLibraryUrl "https://contoso.sharepoint.com/sites/branding/Assets" -LogoFileUrl "/sites/branding/Assets/LogoA.jpg" -BackgroundFileUrl "/sites/branding/Assets/BackgroundA.jpg" -IsPrimary $true
37+
```
38+
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
42+
43+
```powershell
44+
Add-SPOFileRequestBrandingProfile -AssetLibraryUrl "https://contoso.sharepoint.com/sites/branding/Assets" -LogoFileUrl "/sites/branding/Assets/LogoB.jpg" -BackgroundFileUrl "/sites/branding/Assets/BackgroundB.jpg" -IsPrimary $false
45+
```
46+
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+
49+
## PARAMETERS
50+
51+
### -AssetLibraryUrl
52+
53+
> Applicable: SharePoint Online
54+
55+
Specifies the absolute URL of the asset library containing the branding assets.
56+
57+
```yaml
58+
Type: System.String
59+
Parameter Sets: (All)
60+
Aliases:
61+
62+
Required: True
63+
Position: Named
64+
Default value: None
65+
Accept pipeline input: False
66+
Accept wildcard characters: False
67+
```
68+
69+
### -LogoFileUrl
70+
71+
Specifies the relative URL of the logo image file.
72+
73+
```yaml
74+
Type: System.String
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+
### -BackgroundFileUrl
86+
87+
Specifies the relative URL of the background image file.
88+
89+
```yaml
90+
Type: System.String
91+
Parameter Sets: (All)
92+
Aliases:
93+
94+
Required: False
95+
Position: Named
96+
Default value: None
97+
Accept pipeline input: False
98+
Accept wildcard characters: False
99+
```
100+
101+
### -IsPrimary
102+
Specifies if this branding profile configuration is the primary profile.
103+
104+
```yaml
105+
Type: System.Boolean
106+
Parameter Sets: (All)
107+
Aliases:
108+
109+
Required: False
110+
Position: Named
111+
Default value: None
112+
Accept pipeline input: False
113+
Accept wildcard characters: False
114+
```
115+
116+
### CommonParameters
117+
118+
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).
119+
120+
## INPUTS
121+
122+
### None
123+
124+
## OUTPUTS
125+
126+
### System.Object
127+
128+
## NOTES
129+
130+
## RELATED LINKS
131+
132+
[Get-SPOFileRequestBrandingProfiles](/powershell/module/sharepoint-online/get-spofilerequestbrandingprofiles)
133+
134+
[Remove-SPOFileRequestBrandingProfile](/powershell/module/sharepoint-online/remove-spofilerequestbrandingprofile)
135+
136+
[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+
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.
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
34+
```powershell
35+
Get-SPOFileRequestBrandingProfiles
36+
```
37+
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+
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/Microsoft.Online.SharePoint.PowerShell.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ Adds the mentioned billing profile details to a standard container type.
2121
### [Add-SPOContentSecurityPolicy](Add-SPOContentSecurityPolicy.md)
2222
Adds a source to the **Content Security Policy** configuration.
2323

24+
### [Add-SPOFileRequestBrandingProfile](Add-SPOFileRequestBrandingProfile.md)
25+
Adds a branding profile for the file request feature by specifying logo and background assets from an existing organization asset library.
26+
2427
### [Add-SPOGeoAdministrator](Add-SPOGeoAdministrator.md)
2528
Adds a new SharePoint user or security group as GeoAdministrator to a multi-geo tenant.
2629

@@ -192,6 +195,9 @@ This cmdlet enables the administrator to check status of all active and availabl
192195
### [Get-SPOExternalUser](Get-SPOExternalUser.md)
193196
Returns external users in the tenant.
194197

198+
### [Get-SPOFileRequestBrandingProfiles](Get-SPOFileRequestBrandingProfiles.md)
199+
Retrieves branding profiles configured for the file request feature, including details about logo and background assets.
200+
195201
### [Get-SPOGeoAdministrator](Get-SPOGeoAdministrator.md)
196202
This cmdlet returns the SharePoint Online user or security group accounts with Global Admin privileges in the current multi-geo tenant.
197203

@@ -489,6 +495,9 @@ Removes a SharePoint Online deleted site collection from the Recycle Bin.
489495
### [Remove-SPOExternalUser](Remove-SPOExternalUser.md)
490496
Removes a collection of external users from the tenancy's folder.
491497

498+
### [Remove-SPOFileRequestBrandingProfile](Remove-SPOFileRequestBrandingProfile.md)
499+
Removes a branding profile (either primary or secondary) configured for the file request feature across the tenant.
500+
492501
### [Remove-SPOGeoAdministrator](Remove-SPOGeoAdministrator.md)
493502
Removes a new SharePoint user or security Group in the current Multi-Geo Tenant.
494503

@@ -804,6 +813,9 @@ In a Multi-Geo company, stops the ability to move a user's content related objec
804813
### [Submit-SPOMigrationJob](Submit-SPOMigrationJob.md)
805814
**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.
806815

816+
### [Switch-SPOFileRequestBrandingProfiles](Switch-SPOFileRequestBrandingProfiles.md)
817+
Switches the primary and secondary file request branding profiles configured for the tenant.
818+
807819
### [Test-SPOSite](Test-SPOSite.md)
808820
Tests a SharePoint Online site collection.
809821

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

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
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+
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.
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+
```powershell
39+
Remove-SPOFileRequestBrandingProfile -Primary
40+
```
41+
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
45+
46+
```powershell
47+
Remove-SPOFileRequestBrandingProfile -Secondary
48+
```
49+
50+
This example removes the secondary branding profile that was previously configured for file request pages in the tenant.
51+
52+
## PARAMETERS
53+
54+
### -Primary
55+
56+
Specifies the absolute URL of the asset library containing the branding assets.
57+
58+
```yaml
59+
Type: SwitchParameter
60+
Parameter Sets: (All)
61+
Aliases:
62+
63+
Required: False
64+
Position: Named
65+
Default value: None
66+
Accept pipeline input: False
67+
Accept wildcard characters: False
68+
```
69+
70+
### -Secondary
71+
72+
Specifies the relative URL of the logo image file.
73+
74+
```yaml
75+
Type: SwitchParameter
76+
Parameter Sets: (All)
77+
Aliases:
78+
79+
Required: False
80+
Position: Named
81+
Default value: None
82+
Accept pipeline input: False
83+
Accept wildcard characters: False
84+
```
85+
86+
### CommonParameters
87+
88+
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).
89+
90+
## INPUTS
91+
92+
### None
93+
94+
## OUTPUTS
95+
96+
### System.Object
97+
98+
## NOTES
99+
100+
## RELATED LINKS
101+
102+
[Add-SPOFileRequestBrandingProfile](/powershell/module/sharepoint-online/add-spofilerequestbrandingprofile)
103+
104+
[Get-SPOFileRequestBrandingProfiles](/powershell/module/sharepoint-online/get-spofilerequestbrandingprofiles)
105+
106+
[Switch-SPOFileRequestBrandingProfiles](/powershell/module/sharepoint-online/switch-spofilerequestbrandingprofiles)

0 commit comments

Comments
 (0)