Skip to content

Commit c98d133

Browse files
KoenZomersKoenZomers
committed
Added new cmdlets
1 parent ffa7cba commit c98d133

18 files changed

+850
-8
lines changed

‎CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
6464
- Added `-Transitive` parameter to `Get-PnPAzureADGroupMember` cmdlet to allow members of groups inside groups to be retrieved [#4799](https://github.com/pnp/powershell/pull/4799)
6565
- Added the ability to `Get-PnPPage` to return all site pages in the site by omitting the `-Identity` parameter [#4805](https://github.com/pnp/powershell/pull/4805)
6666
- Added `Copy-PnPPage`, `Move-PnPPage` and `Get-PnPPageCopyProgress` cmdlets to allow for copying and moving site pages between sites [#4806](https://github.com/pnp/powershell/pull/4806)
67+
- Added `Get-PnPBrandCenterConfig` to retrieve the configuration of the Brand Center on the tenant
68+
- Added `Get-PnPBrandCenterFont` to retrieve the available fonts from the various Brand Centers
69+
- Added `Set-PnPBrandCenterFont` to apply the specified font from the Brand Center to the current site
70+
- Added `Add-PnPBrandCenterFont` to upload a font to the tenant Brand Center
6771

6872
### Changed
6973

‎documentation/Add-PnPBrandCenterFont.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
Module Name: PnP.PowerShell
3+
schema: 2.0.0
4+
applicable: SharePoint Online
5+
online version: https://pnp.github.io/powershell/cmdlets/Add-PnPBrandCenterFont.html
6+
external help file: PnP.PowerShell.dll-Help.xml
7+
title: Add-PnPBrandCenterFont
8+
---
9+
10+
# Add-PnPBrandCenterFont
11+
12+
## SYNOPSIS
13+
Allows a font to be uploaded to the tenant Brand Center
14+
15+
## SYNTAX
16+
17+
```powershell
18+
Add-PnPBrandCenterFont -Path <String> [-Visible <Boolean>] [-Connection <PnPConnection>] [-Verbose]
19+
```
20+
21+
## DESCRIPTION
22+
This cmdlet allows a font to be uploaded to the tenant Brand Center. The font will be available for use in the tenant and site collection Brand Center.
23+
24+
## EXAMPLES
25+
26+
### EXAMPLE 1
27+
```powershell
28+
Add-PnPBrandCenterFont -Path c:\temp\MyAwesomeFont.ttf
29+
```
30+
31+
This will upload the font MyAwesomeFont.ttf to the tenant Brand Center and will make it visible
32+
33+
### EXAMPLE 2
34+
```powershell
35+
Add-PnPBrandCenterFont -Path c:\temp\MyAwesomeFont.ttf -Visible:$false
36+
```
37+
38+
This will upload the font MyAwesomeFont.ttf to the tenant Brand Center and will hide it from being used
39+
40+
## PARAMETERS
41+
42+
### -Connection
43+
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing [Get-PnPConnection](Get-PnPConnection.md).
44+
45+
```yaml
46+
Type: PnPConnection
47+
Parameter Sets: (All)
48+
49+
Required: False
50+
Position: Named
51+
Default value: None
52+
Accept pipeline input: False
53+
Accept wildcard characters: False
54+
```
55+
56+
### -Path
57+
The local file path to where the font is stored that needs to be uploaded
58+
59+
```yaml
60+
Type: String
61+
Parameter Sets: (All)
62+
63+
Required: True
64+
Position: Named
65+
Default value: None
66+
Accept pipeline input: False
67+
Accept wildcard characters: False
68+
```
69+
70+
### -Visible
71+
Indicates if the font should be visible in the Brand Center. The default is true.
72+
73+
```yaml
74+
Type: Boolean
75+
Parameter Sets: (All)
76+
77+
Required: False
78+
Position: Named
79+
Default value: True
80+
Accept pipeline input: False
81+
Accept wildcard characters: False
82+
```
83+
84+
## RELATED LINKS
85+
86+
[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)

‎documentation/Get-PnPBrandCenterConfig.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
Module Name: PnP.PowerShell
3+
schema: 2.0.0
4+
applicable: SharePoint Online
5+
online version: https://pnp.github.io/powershell/cmdlets/Get-PnPBrandCenterConfig.html
6+
external help file: PnP.PowerShell.dll-Help.xml
7+
title: Get-PnPBrandCenterConfig
8+
---
9+
10+
# Get-PnPBrandCenterConfig
11+
12+
## SYNOPSIS
13+
Returns the Brand Center configuration for the current tenant
14+
15+
## SYNTAX
16+
17+
```powershell
18+
Get-PnPBrandCenterConfig
19+
```
20+
21+
## DESCRIPTION
22+
Allows retrieval of the Brand Center configuration for the current tenant. The Brand Center is a centralized location for managing and sharing branding assets, such as logos, colors, and fonts, across Microsoft 365 applications.
23+
24+
## EXAMPLES
25+
26+
### EXAMPLE 1
27+
```powershell
28+
Get-PnPBrandCenterConfig
29+
```
30+
31+
Returns the configuration of the Brand Center for the current tenant.
32+
33+
## PARAMETERS
34+
35+
### -Connection
36+
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing [Get-PnPConnection](Get-PnPConnection.md).
37+
38+
```yaml
39+
Type: PnPConnection
40+
Parameter Sets: (All)
41+
42+
Required: False
43+
Position: Named
44+
Default value: None
45+
Accept pipeline input: False
46+
Accept wildcard characters: False
47+
```
48+
49+
## RELATED LINKS
50+
51+
[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)

‎documentation/Get-PnPBrandCenterFont.md‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
---
2+
Module Name: PnP.PowerShell
3+
schema: 2.0.0
4+
applicable: SharePoint Online
5+
online version: https://pnp.github.io/powershell/cmdlets/Get-PnPBrandCenterFont.html
6+
external help file: PnP.PowerShell.dll-Help.xml
7+
title: Get-PnPBrandCenterFont
8+
---
9+
10+
# Get-PnPBrandCenterFont
11+
12+
## SYNOPSIS
13+
Returns the available fonts configured throught heBrand Center
14+
15+
## SYNTAX
16+
17+
### All
18+
```powershell
19+
Get-PnPBrandCenterFont [-Store <Tenant|OutOfBox|Site|All>] [-Connection <PnPConnection>]
20+
```
21+
22+
### Single
23+
```powershell
24+
Get-PnPBrandCenterFont -Identity <BrandCenterFontPipeBind> [-Store <Tenant|OutOfBox|Site|All>] [-Connection <PnPConnection>]
25+
```
26+
27+
## DESCRIPTION
28+
Allows retrieval of the available fonts from the various Brand Centers.
29+
30+
## EXAMPLES
31+
32+
### EXAMPLE 1
33+
```powershell
34+
Get-PnPBrandCenterFont
35+
```
36+
37+
Returns all the available fonts
38+
39+
### EXAMPLE 2
40+
```powershell
41+
Get-PnPBrandCenterFont -Store Site
42+
```
43+
44+
Returns the available fonts from the site collection Brand Center
45+
46+
### EXAMPLE 3
47+
```powershell
48+
Get-PnPBrandCenterFont -Identity "My awesome font"
49+
```
50+
51+
Looks up and returns the font with the name "My awesome font" from any of the Brand Centers
52+
53+
### EXAMPLE 4
54+
```powershell
55+
Get-PnPBrandCenterFont -Identity "2812cbd8-7176-4e45-8911-6a063f89a1f1"
56+
```
57+
58+
Looks up and returns the font with the Identity "2812cbd8-7176-4e45-8911-6a063f89a1f1" from any of the Brand Centers
59+
60+
## PARAMETERS
61+
62+
### -Connection
63+
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing [Get-PnPConnection](Get-PnPConnection.md).
64+
65+
```yaml
66+
Type: PnPConnection
67+
Parameter Sets: (All)
68+
69+
Required: False
70+
Position: Named
71+
Default value: None
72+
Accept pipeline input: False
73+
Accept wildcard characters: False
74+
```
75+
76+
### -Identity
77+
Unique identifier of the font to be retrieved. This can be its guid, name or a BrandCenterFont object. If not specified, all the available fonts will be returned.
78+
79+
```yaml
80+
Type: BrandCenterFontPipeBind
81+
Parameter Sets: Single
82+
83+
Required: True
84+
Position: Named
85+
Default value: None
86+
Accept pipeline input: True
87+
Accept wildcard characters: False
88+
```
89+
90+
### -Store
91+
Indicates the source of the fonts to be retrieved. The following values are available:
92+
- Tenant: The fonts configured in the tenant Brand Center
93+
- Site: The fonts configured in the site collection Brand Center
94+
- OutOfBox: The out of box fonts available in the tenant
95+
- All: All the fonts available in the tenant, including the ones configured in the tenant and site collection Brand Center and the out of box fonts.
96+
97+
```yaml
98+
Type: Store
99+
Parameter Sets: (All)
100+
101+
Required: False
102+
Position: Named
103+
Default value: All
104+
Accept pipeline input: False
105+
Accept wildcard characters: False
106+
```
107+
108+
## RELATED LINKS
109+
110+
[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)

‎documentation/Set-PnPBrandCenterFont.md‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
---
2+
Module Name: PnP.PowerShell
3+
schema: 2.0.0
4+
applicable: SharePoint Online
5+
online version: https://pnp.github.io/powershell/cmdlets/Set-PnPBrandCenterFont.html
6+
external help file: PnP.PowerShell.dll-Help.xml
7+
title: Set-PnPBrandCenterFont
8+
---
9+
10+
# Set-PnPBrandCenterFont
11+
12+
## SYNOPSIS
13+
Applies the specified font from the Brand Center to the current site.
14+
15+
## SYNTAX
16+
17+
```powershell
18+
Set-PnPBrandCenterFont -Identity <BrandCenterFontPipeBind> [-Store <Tenant|OutOfBox|Site|All>] [-Connection <PnPConnection>]
19+
```
20+
21+
## DESCRIPTION
22+
Applies the specified font from the Brand Center to the current site.
23+
24+
## EXAMPLES
25+
26+
### EXAMPLE 1
27+
```powershell
28+
Set-PnPBrandCenterFont -Identity "2812cbd8-7176-4e45-8911-6a063f89a1f1"
29+
```
30+
31+
Looks up and applies the font with the identity "2812cbd8-7176-4e45-8911-6a063f89a1f1" from any of the Brand Centers to the current site
32+
33+
### EXAMPLE 2
34+
```powershell
35+
Set-PnPBrandCenterFont -Identity "My awesome font" -Store Tenant
36+
```
37+
38+
Looks up and applies the font with the title "My awesome font" from the tenant Brand Center
39+
40+
## PARAMETERS
41+
42+
### -Connection
43+
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing [Get-PnPConnection](Get-PnPConnection.md).
44+
45+
```yaml
46+
Type: PnPConnection
47+
Parameter Sets: (All)
48+
49+
Required: False
50+
Position: Named
51+
Default value: None
52+
Accept pipeline input: False
53+
Accept wildcard characters: False
54+
```
55+
56+
### -Identity
57+
Unique identifier of the font to be applied. This can be its guid, name or a BrandCenterFont object.
58+
59+
```yaml
60+
Type: BrandCenterFontPipeBind
61+
Parameter Sets: (All)
62+
63+
Required: True
64+
Position: Named
65+
Default value: None
66+
Accept pipeline input: True
67+
Accept wildcard characters: False
68+
```
69+
70+
### -Store
71+
Indicates the source of the fonts to be looked in to try to locate the font to apply. The following values are available:
72+
- Tenant: The fonts configured in the tenant Brand Center
73+
- Site: The fonts configured in the site collection Brand Center
74+
- OutOfBox: The out of box fonts available in the tenant
75+
- All: All the fonts available in the tenant, including the ones configured in the tenant and site collection Brand Center and the out of box fonts.
76+
77+
```yaml
78+
Type: Store
79+
Parameter Sets: (All)
80+
81+
Required: False
82+
Position: Named
83+
Default value: All
84+
Accept pipeline input: False
85+
Accept wildcard characters: False
86+
```
87+
88+
## RELATED LINKS
89+
90+
[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)

0 commit comments

Comments
 (0)