Skip to content

Commit 7597867

Browse files
padmagit77padmagit77
authored
Merge pull request #987 from JQ1u/MicrosoftDocs/update-set-font-package
Add docs for font package cmdlets
2 parents 8205648 + 416118e commit 7597867

File tree

6 files changed

+513
-1
lines changed

6 files changed

+513
-1
lines changed

‎.openpublishing.redirection.ms-ol-sp-ps.json‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,11 @@
3030
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/add-spocontentsecuritypolicy",
3131
"redirect_document_id": true
3232
},
33+
{
34+
"source_path": "sharepoint/sharepoint-ps/sharepoint-online/Add-SPOFontPackage.md",
35+
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/add-spofontpackage",
36+
"redirect_document_id": true
37+
},
3338
{
3439
"source_path": "sharepoint/sharepoint-ps/sharepoint-online/Add-SPOGeoAdministrator.md",
3540
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/add-spogeoadministrator",
@@ -310,6 +315,11 @@
310315
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/get-spoexternaluser",
311316
"redirect_document_id": true
312317
},
318+
{
319+
"source_path": "sharepoint/sharepoint-ps/sharepoint-online/Get-SPOFontPackage.md",
320+
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/get-spofontpackage",
321+
"redirect_document_id": true
322+
},
313323
{
314324
"source_path": "sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoAdministrator.md",
315325
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/get-spogeoadministrator",
@@ -815,6 +825,11 @@
815825
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/remove-spoexternaluser",
816826
"redirect_document_id": true
817827
},
828+
{
829+
"source_path": "sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOFontPackage.md",
830+
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/remove-spofontpackage",
831+
"redirect_document_id": true
832+
},
818833
{
819834
"source_path": "sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOGeoAdministrator.md",
820835
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/remove-spogeoadministrator",
@@ -1085,6 +1100,11 @@
10851100
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/set-spodisablespacesactivation",
10861101
"redirect_document_id": true
10871102
},
1103+
{
1104+
"source_path": "sharepoint/sharepoint-ps/sharepoint-online/Set-SPOFontPackage.md",
1105+
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/set-spofontpackage",
1106+
"redirect_document_id": true
1107+
},
10881108
{
10891109
"source_path": "sharepoint/sharepoint-ps/sharepoint-online/Set-SPOGeoStorageQuota.md",
10901110
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/set-spogeostoragequota",

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

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
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-spofontpackage
5+
applicable: SharePoint Online
6+
title: Add-SPOFontPackage
7+
schema: 2.0.0
8+
author: JQ1u
9+
ms.author: luchaoqiu
10+
ms.reviewer:
11+
---
12+
13+
# Add-SPOFontPackage
14+
15+
## SYNOPSIS
16+
17+
Creates a new custom font package with fonts in the brand fonts library.
18+
19+
## SYNTAX
20+
21+
```
22+
Add-SPOFontPackage -Title <String> -PackageJson <String> [-IsHidden <Boolean>] [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
27+
This cmdlet creates a new brand font package for the tenant. Each font package must have a unique name. The font file must be added to the SharePoint Brand Center before creating a font package. For more information, see [Brand Fonts](/sharepoint/brand-fonts).
28+
29+
## EXAMPLES
30+
31+
### EXAMPLE 1
32+
33+
```powershell
34+
$packageJson = @'
35+
{
36+
"fontFaces": [
37+
{
38+
"fontFamily": "Tahoma",
39+
"path": "Tahoma.ttf",
40+
"fontType": "contentFont"
41+
}
42+
],
43+
"fontSlots": {
44+
"title": {
45+
"fontFamily": "Tahoma",
46+
"fontFace": "Regular",
47+
"fontVariationSettings": {
48+
"wght": 100,
49+
"wdth": 100
50+
}
51+
},
52+
"heading": {
53+
"fontFamily": "Tahoma",
54+
"fontFace": "Regular",
55+
"fontVariationSettings": {
56+
"wght": 100,
57+
"wdth": 100
58+
}
59+
},
60+
"body": {
61+
"fontFamily": "Tahoma",
62+
"fontFace": "Regular",
63+
"fontVariationSettings": {
64+
"wght": 100,
65+
"wdth": 100
66+
}
67+
},
68+
"label": {
69+
"fontFamily": "Tahoma",
70+
"fontFace": "Regular",
71+
"fontVariationSettings": {
72+
"wght": 100,
73+
"wdth": 100
74+
}
75+
}
76+
}
77+
}
78+
'@
79+
80+
Add-SPOFontPackage -Title "Tahoma" -PackageJson $packageJson
81+
```
82+
83+
This example creates a new font package named "Tahoma" with specified JSON configuration.
84+
85+
### EXAMPLE 2
86+
87+
```powershell
88+
# With $packageJson from EXAMPLE 1
89+
Add-SPOFontPackage -Title "Contoso Font Package" -PackageJson $packageJson -IsHidden $true
90+
```
91+
92+
This example creates a hidden font package with specified JSON configuration.
93+
94+
## PARAMETERS
95+
96+
### -Title
97+
98+
> Applicable: SharePoint Online
99+
100+
Specifies the display name of the new font package.
101+
102+
```yaml
103+
Type: System.String
104+
Parameter Sets: (All)
105+
Aliases:
106+
107+
Required: True
108+
Position: Named
109+
Default value: None
110+
Accept pipeline input: False
111+
Accept wildcard characters: False
112+
```
113+
114+
### -PackageJson
115+
116+
> Applicable: SharePoint Online
117+
118+
Specifies the JSON configuration for the font package.
119+
120+
```yaml
121+
Type: System.String
122+
Parameter Sets: (All)
123+
Aliases:
124+
125+
Required: True
126+
Position: Named
127+
Default value: None
128+
Accept pipeline input: False
129+
Accept wildcard characters: False
130+
```
131+
132+
### -IsHidden
133+
134+
> Applicable: SharePoint Online
135+
136+
Specifies whether the font package should be hidden from users. When set to `$true`, the font package will not be visible in the **Change the look** options, but can still be applied using the `Set-SPOFontPackage` cmdlet.
137+
138+
```yaml
139+
Type: System.Boolean
140+
Parameter Sets: (All)
141+
Aliases:
142+
143+
Required: False
144+
Position: Named
145+
Default value: False
146+
Accept pipeline input: True (ByValue)
147+
Accept wildcard characters: False
148+
```
149+
150+
### CommonParameters
151+
152+
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/?LinkID=113216).
153+
154+
## OUTPUTS
155+
156+
### System.Object
157+
158+
## NOTES
159+
160+
## RELATED LINKS
161+
162+
[Get-SPOFontPackage](Get-SPOFontPackage.md)
163+
164+
[Set-SPOFontPackage](Set-SPOFontPackage.md)
165+
166+
[Remove-SPOFontPackage](Remove-SPOFontPackage.md)

‎sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFontPackage.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/get-spofontpackage
5+
applicable: SharePoint Online
6+
title: Get-SPOFontPackage
7+
schema: 2.0.0
8+
author: JQ1u
9+
ms.author: luchaoqiu
10+
ms.reviewer:
11+
---
12+
13+
# Get-SPOFontPackage
14+
15+
## SYNOPSIS
16+
17+
Returns one or all custom font packages in the tenant.
18+
19+
## SYNTAX
20+
21+
```
22+
Get-SPOFontPackage [[-Identity] <SPOFontPackagePipeBind>] [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
27+
This cmdlet retrieves one or more custom font packages in the tenant. Custom font packages include those created through the SharePoint Brand Center app or by using the `Add-SPOFontPackage` cmdlet. You can retrieve a specific font package by providing its identity, or retrieve all font packages if no identity is specified.
28+
29+
Font packages contain custom typography definitions that can be applied to SharePoint sites and Viva Connections for branding purposes.
30+
31+
## EXAMPLES
32+
33+
### EXAMPLE 1
34+
35+
```powershell
36+
Get-SPOFontPackage
37+
```
38+
39+
This example returns all font packages in the tenant.
40+
41+
### EXAMPLE 2
42+
43+
```powershell
44+
Get-SPOFontPackage -Identity 12345678-1234-1234-1234-123456789012
45+
```
46+
47+
This example returns the font package with the specified GUID.
48+
49+
### EXAMPLE 3
50+
51+
```powershell
52+
Get-SPOFontPackage | Where-Object {$_.IsHidden -eq $false}
53+
```
54+
55+
This example returns all visible font packages (not hidden).
56+
57+
### EXAMPLE 4
58+
59+
```powershell
60+
$fontPackage = Get-SPOFontPackage -Identity 12345678-1234-1234-1234-123456789012
61+
$fontPackage.PackageJson
62+
```
63+
64+
This example retrieves a specific font package and displays its JSON configuration.
65+
66+
## PARAMETERS
67+
68+
### -Identity
69+
70+
> Applicable: SharePoint Online
71+
72+
Specifies the identity of the font package to retrieve. This can be the ID (GUID) of the font package, or a font package object. If not specified, all font packages will be retrieved.
73+
74+
```yaml
75+
Type: Microsoft.Online.SharePoint.PowerShell.SPOFontPackagePipeBind
76+
Parameter Sets: (All)
77+
Aliases:
78+
79+
Required: False
80+
Position: 0
81+
Default value: None
82+
Accept pipeline input: True (ByValue)
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/?LinkID=113216).
89+
90+
## INPUTS
91+
92+
### Microsoft.Online.SharePoint.PowerShell.SPOFontPackagePipeBind
93+
94+
## OUTPUTS
95+
96+
### System.Object
97+
98+
## NOTES
99+
100+
## RELATED LINKS
101+
102+
[Add-SPOFontPackage](Add-SPOFontPackage.md)
103+
104+
[Set-SPOFontPackage](Set-SPOFontPackage.md)
105+
106+
[Remove-SPOFontPackage](Remove-SPOFontPackage.md)

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

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ Adds a source to the **Content Security Policy** configuration.
2424
### [Add-SPOFileRequestBrandingProfile](Add-SPOFileRequestBrandingProfile.md)
2525
Adds a branding profile for the file request feature by specifying logo and background assets from an existing organization asset library.
2626

27+
### [Add-SPOFontPackage](Add-SPOFontPackage.md)
28+
Creates a new custom font package with fonts in the brand fonts library.
29+
2730
### [Add-SPOGeoAdministrator](Add-SPOGeoAdministrator.md)
2831
Adds a new SharePoint user or security group as GeoAdministrator to a multi-geo tenant.
2932

@@ -198,6 +201,9 @@ Returns external users in the tenant.
198201
### [Get-SPOFileRequestBrandingProfiles](Get-SPOFileRequestBrandingProfiles.md)
199202
Retrieves branding profiles configured for the file request feature, including details about logo and background assets.
200203

204+
### [Get-SPOFontPackage](Get-SPOFontPackage.md)
205+
Returns one or all custom font packages in the tenant.
206+
201207
### [Get-SPOGeoAdministrator](Get-SPOGeoAdministrator.md)
202208
This cmdlet returns the SharePoint Online user or security group accounts with Global Admin privileges in the current multi-geo tenant.
203209

@@ -385,7 +391,7 @@ Returns the current configuration status.
385391
Get the replication parameters to manage Multi-Geo taxonomy replication.
386392

387393
### [Get-SPOTheme](Get-SPOTheme.md)
388-
{{Placeholder}}
394+
Returns one or all theme settings from the tenant.
389395

390396
### [Get-SPOUnifiedGroup](Get-SPOUnifiedGroup.md)
391397
Retrieves the Preferred Data Location for the specified Office 365 Group.
@@ -498,6 +504,9 @@ Removes a collection of external users from the tenancy's folder.
498504
### [Remove-SPOFileRequestBrandingProfile](Remove-SPOFileRequestBrandingProfile.md)
499505
Removes a branding profile (either primary or secondary) configured for the file request feature across the tenant.
500506

507+
### [Remove-SPOFontPackage](Remove-SPOFontPackage.md)
508+
Removes a brand font package from the tenant.
509+
501510
### [Remove-SPOGeoAdministrator](Remove-SPOGeoAdministrator.md)
502511
Removes a new SharePoint user or security Group in the current Multi-Geo Tenant.
503512

@@ -660,6 +669,9 @@ This cmdlet sends a trust request to the tenant with whom you want to establish
660669
### [Set-SPODisableSpacesActivation](Set-SPODisableSpacesActivation.md)
661670
Disables the SharePoint Spaces activation.
662671

672+
### [Set-SPOFontPackage](Set-SPOFontPackage.md)
673+
Applies a brand font package to a SharePoint site or Viva Connections.
674+
663675
### [Set-SPOGeoStorageQuota](Set-SPOGeoStorageQuota.md)
664676
This cmdlet sets the storage quota on a multi-geo tenant.
665677

0 commit comments

Comments
 (0)