Add docs for font package cmdlets by JQ1u · Pull Request #987 · MicrosoftDocs/OfficeDocs-SharePoint-PowerShell

JQ1u · 2025-08-14T02:57:05Z

No description provided.

github-actions · 2025-08-14T02:57:34Z

Too many files - PR blocked

This public repo applies limits on the number of files that can be merged in a single pull request (PR):

Warning Warning message and ability to unblock PR using the Merge large pull request^* label - 30
Block Block message and PR is blocked - 100

This pull request will change 108 files, which exceeds the block limit of 100. This PR will not be merged.

To merge this pull request

You must either reduce the number of files being changed to below the 100 file limit or split the changes into multiple PRs. PRs must not have more than 100 files and fewer than 30 files if possible.

To reject this pull request

If you want to abandon these changes and not merge this PR, click Close pull request at the bottom of this page to close it without merging. Work with your team to revert any changes that aren't correct.

^* You must have write or triage access to this repo to add labels.

learn-build-service-prod · 2025-08-14T02:57:36Z

Learn Build status updates of commit 7deeb2c:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File	Status	Preview URL	Details
	❌Error		Details

[Error: CannotMergeCommit] Cannot merge commit 7deeb2c7b3c80b49af19aa0847c19e3086b3562c in branch MicrosoftDocs/update-set-font-package of repository https://github.com/JQ1u/OfficeDocs-SharePoint-PowerShell into branch main (commit 82056481ee0dfec09b087f750b4b2bba47bd44a0). Please follow this documentation: https://help.github.com/articles/resolving-a-merge-conflict-using-the-command-line/ to use git.exe to resolve you content conflicts locally and then push to remote.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

learn-build-service-prod · 2025-08-14T03:29:24Z

PoliCheck Scan Report

The following reports lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a comment that you post to the PR. The feedback helps reduce false positive instances in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

learn-build-service-prod · 2025-08-14T03:30:12Z

Learn Build status updates of commit 2daf794:

⚠️ Validation status: warnings

File	Status	Preview URL	Details
sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOFontPackage.md	⚠️Warning	View (sharepoint-ps)	Details
sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFontPackage.md	⚠️Warning	View (sharepoint-ps)	Details
sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md	⚠️Warning	View (sharepoint-ps)	Details
sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOFontPackage.md	⚠️Warning	View (sharepoint-ps)	Details
sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOFontPackage.md	⚠️Warning	View (sharepoint-ps)	Details

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

Line 0, Column 0: [Warning: author-not-found - See documentation] Invalid value for author: 'luchaoqiu' is not a valid GitHub ID.

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

Line 0, Column 0: [Warning: author-not-found - See documentation] Invalid value for author: 'luchaoqiu' is not a valid GitHub ID.

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

Line 0, Column 0: [Warning: PSMD2Yaml_InconsistentCmdletsInModule] Inconsistent cmdlets found in module: Microsoft.Online.SharePoint.PowerShell. 4 cmdlets in the module folder but not listed in the module file: Add-SPOFontPackage, Get-SPOFontPackage, Remove-SPOFontPackage, Set-SPOFontPackage.

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

Line 0, Column 0: [Warning: author-not-found - See documentation] Invalid value for author: 'luchaoqiu' is not a valid GitHub ID.

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOFontPackage.md

Line 0, Column 0: [Warning: author-not-found - See documentation] Invalid value for author: 'luchaoqiu' is not a valid GitHub ID.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

samkabue · 2025-08-14T04:38:36Z

+
+## DESCRIPTION
+
+The `Add-SPOFontPackage` cmdlet creates a new brand font package for the SharePoint 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](https://learn.microsoft.com/sharepoint/brand-fonts).


The Add-SPOFontPackage cmdlet

to avoid repeating the cmdlet name in the description, we just say "This cmdlet ..." #Closed

(applies to here and other cmdlets)

Hey Sam, fixed all your comments

samkabue · 2025-08-14T04:39:37Z

+
+## DESCRIPTION
+
+The `Add-SPOFontPackage` cmdlet creates a new brand font package for the SharePoint 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](https://learn.microsoft.com/sharepoint/brand-fonts).


SharePoint

remove "SharePoint" since the cmdlet is already for the SharePoint tenant #Closed

samkabue · 2025-08-14T04:40:24Z

+
+## DESCRIPTION
+
+The `Add-SPOFontPackage` cmdlet creates a new brand font package for the SharePoint 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](https://learn.microsoft.com/sharepoint/brand-fonts).


https://learn.microsoft.com/sharepoint/brand-fonts

we prefer to use relative paths, so in this case it's /sharepoint/brand-fonts #Closed

samkabue · 2025-08-14T04:41:48Z

+
+> Applicable: SharePoint Online
+
+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.


$true

add backticks when referencing param names or param inputs.

`$true` ``` #Closed

samkabue · 2025-08-14T04:43:17Z

+
+## SYNOPSIS
+
+Returns one or all custom font packages from the SharePoint tenant.


from the SharePoint tenant

"in the tenant" #Closed

samkabue · 2025-08-14T04:43:34Z

+
+## DESCRIPTION
+
+The `Get-SPOFontPackage` cmdlet retrieves one or more custom font packages from the SharePoint 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.


The Get-SPOFontPackage

This #Closed

samkabue · 2025-08-14T04:43:47Z

+
+## DESCRIPTION
+
+The `Get-SPOFontPackage` cmdlet retrieves one or more custom font packages from the SharePoint 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.


the SharePoint

in the #Closed

samkabue · 2025-08-14T04:45:00Z

+| Title       | string | The display name of the font package.                   |
+| IsHidden    | bool   | Whether the font package is hidden from the SharePointUI. |
+| IsValid     | bool   | Whether the font package is valid and can be applied.   |
+| PackageJson | string | The JSON specifying the settings of the font package.   |


we don't document these output properties since they usually change, and we don't want to keep updating this. The description you have is sufficient, then users can follow the examples #Closed

samkabue · 2025-08-14T04:50:35Z

+### EXAMPLE 3
+
+```powershell
+Get-SPOFontPackage | Where-Object {$_.IsHidden -eq $false}


| Where-Object {$_.IsHidden -eq $false}

for future work: consider adding a param -IsHidden to the cmdlet itself, this way the filtering happens server-side instead of client-side. Otherwise if a tenant has too many font packages this might not be as fast, since it returns everything to the client first.

Get-SPOFontPackage -IsHidden $true
Get-SPOFontPackage -IsHidden $false

samkabue · 2025-08-14T05:00:30Z

+
+## SYNOPSIS
+
+Removes a brand font package from the SharePoint tenant.


the SharePoint tenant

"the tenant" #Closed

samkabue · 2025-08-14T05:00:45Z

+
+## DESCRIPTION
+
+The `Remove-SPOFontPackage` cmdlet removes a custom font package from the SharePoint tenant. After removal, the font package will no longer be available for use on SharePoint sites or Viva Connections.


The Remove-SPOFontPackage cmdlet

This cmdlet #Closed

samkabue · 2025-08-14T05:01:12Z

+
+## DESCRIPTION
+
+The `Remove-SPOFontPackage` cmdlet removes a custom font package from the SharePoint tenant. After removal, the font package will no longer be available for use on SharePoint sites or Viva Connections.


the SharePoint tenant

change all occurrences of "the SharePoint tenant" to just "the tenant" #Closed

samkabue · 2025-08-14T05:02:32Z

+
+## DESCRIPTION
+
+The `Set-SPOFontPackage` cmdlet applies a brand font package to a specified SharePoint site or Viva Connections. Use this cmdlet to customize the typography and branding of SharePoint sites by applying predefined font packages.


The Set-SPOFontPackage cmdlet

"This cmdlet" #Closed

samkabue · 2025-08-14T05:03:58Z

+$fontPackage = Get-SPOFontPackage -Identity 12345678-1234-1234-1234-123456789012
+foreach ($site in $sites) {
+    Set-SPOFontPackage -Identity $fontPackage -WebUrl $site
+}


future improvement: consider updating WebUrl param to be a string array, this way you can directly pass all the urls to it, instead of iterating one by one :)

samkabue · 2025-08-14T05:04:49Z

Also update the TOC file Microsoft.Online.SharePoint.PowerShell.md

samkabue · 2025-08-14T05:05:18Z

+applicable: SharePoint Online
+title: Add-SPOFontPackage
+schema: 2.0.0
+author: luchaoqiu


luchaoqiu

the "author" value needs to be your GitHub alias #Closed

learn-build-service-prod · 2025-08-14T07:40:55Z

PoliCheck Scan Report

The following reports lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a comment that you post to the PR. The feedback helps reduce false positive instances in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

learn-build-service-prod · 2025-08-14T07:41:38Z

Learn Build status updates of commit 71dd2f1:

💡 Validation status: suggestions

File	Status	Preview URL	Details
.openpublishing.redirection.ms-ol-sp-ps.json	💡Suggestion	View (sharepoint-ps)	Details
sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOFontPackage.md	✅Succeeded	View (sharepoint-ps)
sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFontPackage.md	✅Succeeded	View (sharepoint-ps)
sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md	✅Succeeded	View (sharepoint-ps)
sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOFontPackage.md	✅Succeeded	View (sharepoint-ps)
sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOFontPackage.md	✅Succeeded	View (sharepoint-ps)

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

Line 960, Column 131: [Suggestion: redirect-url-invalid - See documentation] Can't redirect document ID for redirected file 'sharepoint-ps/sharepoint-online/Remove-SPOTenantRestrictedSearchAllowedList.md' because redirect URL '/powershell/module/microsoft.online.sharepoint.powershell/remove-spotenantrestrictedsearchallowedlist' is invalid or is in a different docset. Specify a redirect_url in the same docset, or set redirect_document_id to false in .openpublishing.redirection.json.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

samkabue · 2025-08-14T07:58:51Z


 ### [Get-SPOTheme](Get-SPOTheme.md)
-{{Placeholder}}
+Returns one or all themes settings from the tenant.


themes

"theme" (singular) #Closed

learn-build-service-prod · 2025-08-14T08:10:17Z

Learn Build status updates of commit 416118e:

💡 Validation status: suggestions

File	Status	Preview URL	Details
.openpublishing.redirection.ms-ol-sp-ps.json	💡Suggestion	View (sharepoint-ps)	Details
sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOFontPackage.md	✅Succeeded	View (sharepoint-ps)
sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFontPackage.md	✅Succeeded	View (sharepoint-ps)
sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md	✅Succeeded	View (sharepoint-ps)
sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOFontPackage.md	✅Succeeded	View (sharepoint-ps)
sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOFontPackage.md	✅Succeeded	View (sharepoint-ps)

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

Line 960, Column 131: [Suggestion: redirect-url-invalid - See documentation] Can't redirect document ID for redirected file 'sharepoint-ps/sharepoint-online/Remove-SPOTenantRestrictedSearchAllowedList.md' because redirect URL '/powershell/module/microsoft.online.sharepoint.powershell/remove-spotenantrestrictedsearchallowedlist' is invalid or is in a different docset. Specify a redirect_url in the same docset, or set redirect_document_id to false in .openpublishing.redirection.json.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

learn-build-service-prod · 2025-08-14T08:10:59Z

PoliCheck Scan Report

The following reports lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a comment that you post to the PR. The feedback helps reduce false positive instances in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

samkabue

github-actions Bot added the Microsoft submitter label Aug 14, 2025

github-actions Bot assigned nabeelnaiyer, trent-green and vgaddam-pm Aug 14, 2025

Add cmdlet docs for font package operations

2daf794

JQ1u force-pushed the MicrosoftDocs/update-set-font-package branch from 7deeb2c to 2daf794 Compare August 14, 2025 03:28

samkabue reviewed Aug 14, 2025

View reviewed changes

samkabue unassigned trent-green, vgaddam-pm and nabeelnaiyer Aug 14, 2025

Updates

71dd2f1

github-actions Bot assigned JQ1u and trent-green Aug 14, 2025

samkabue reviewed Aug 14, 2025

View reviewed changes

Fix

416118e

samkabue approved these changes Aug 14, 2025

View reviewed changes

samkabue added the Sign off The pull request is ready to be reviewed and merged by PubOps label Aug 14, 2025

JQ1u marked this pull request as ready for review August 14, 2025 08:50

padmagit77 self-assigned this Aug 14, 2025

padmagit77 added the In review PubOps is reviewing the pull request label Aug 14, 2025

padmagit77 merged commit 7597867 into MicrosoftDocs:main Aug 14, 2025
9 checks passed


		## DESCRIPTION

		The `Add-SPOFontPackage` cmdlet creates a new brand font package for the SharePoint 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](https://learn.microsoft.com/sharepoint/brand-fonts).


		> Applicable: SharePoint Online

		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.


		## SYNOPSIS

		Returns one or all custom font packages from the SharePoint tenant.


		## DESCRIPTION

		The `Get-SPOFontPackage` cmdlet retrieves one or more custom font packages from the SharePoint 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.


		## SYNOPSIS

		Removes a brand font package from the SharePoint tenant.


		## DESCRIPTION

		The `Remove-SPOFontPackage` cmdlet removes a custom font package from the SharePoint tenant. After removal, the font package will no longer be available for use on SharePoint sites or Viva Connections.


		## DESCRIPTION

		The `Set-SPOFontPackage` cmdlet applies a brand font package to a specified SharePoint site or Viva Connections. Use this cmdlet to customize the typography and branding of SharePoint sites by applying predefined font packages.

Conversation

JQ1u commented Aug 14, 2025

Uh oh!

github-actions Bot commented Aug 14, 2025

Too many files - PR blocked

To merge this pull request

To reject this pull request

Uh oh!

learn-build-service-prod Bot commented Aug 14, 2025

❌ Validation status: errors

Uh oh!

learn-build-service-prod Bot commented Aug 14, 2025

PoliCheck Scan Report

✅ No issues found

More information about PoliCheck

Uh oh!

learn-build-service-prod Bot commented Aug 14, 2025

⚠️ Validation status: warnings

Uh oh!

samkabue Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue commented Aug 14, 2025

Uh oh!

samkabue Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

samkabue Aug 14, 2025 •

edited

Loading

samkabue Aug 14, 2025 •

edited

Loading

samkabue Aug 14, 2025 •

edited

Loading

samkabue Aug 14, 2025 •

edited

Loading

samkabue Aug 14, 2025 •

edited

Loading

samkabue Aug 14, 2025 •

edited

Loading

samkabue Aug 14, 2025 •

edited

Loading

samkabue Aug 14, 2025 •

edited

Loading

samkabue Aug 14, 2025 •

edited

Loading

samkabue Aug 14, 2025 •

edited

Loading

samkabue Aug 14, 2025 •

edited

Loading

samkabue Aug 14, 2025 •

edited

Loading

samkabue Aug 14, 2025 •

edited

Loading

samkabue Aug 14, 2025 •

edited

Loading

samkabue Aug 14, 2025 •

edited

Loading