diff --git a/.openpublishing.redirection.ms-ol-sp-ps.json b/.openpublishing.redirection.ms-ol-sp-ps.json index a5867bdbd..23712c62e 100644 --- a/.openpublishing.redirection.ms-ol-sp-ps.json +++ b/.openpublishing.redirection.ms-ol-sp-ps.json @@ -30,6 +30,11 @@ "redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/add-spocontentsecuritypolicy", "redirect_document_id": true }, + { + "source_path": "sharepoint/sharepoint-ps/sharepoint-online/Add-SPOFontPackage.md", + "redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/add-spofontpackage", + "redirect_document_id": true + }, { "source_path": "sharepoint/sharepoint-ps/sharepoint-online/Add-SPOGeoAdministrator.md", "redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/add-spogeoadministrator", @@ -310,6 +315,11 @@ "redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/get-spoexternaluser", "redirect_document_id": true }, + { + "source_path": "sharepoint/sharepoint-ps/sharepoint-online/Get-SPOFontPackage.md", + "redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/get-spofontpackage", + "redirect_document_id": true + }, { "source_path": "sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoAdministrator.md", "redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/get-spogeoadministrator", @@ -815,6 +825,11 @@ "redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/remove-spoexternaluser", "redirect_document_id": true }, + { + "source_path": "sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOFontPackage.md", + "redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/remove-spofontpackage", + "redirect_document_id": true + }, { "source_path": "sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOGeoAdministrator.md", "redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/remove-spogeoadministrator", @@ -1085,6 +1100,11 @@ "redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/set-spodisablespacesactivation", "redirect_document_id": true }, + { + "source_path": "sharepoint/sharepoint-ps/sharepoint-online/Set-SPOFontPackage.md", + "redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/set-spofontpackage", + "redirect_document_id": true + }, { "source_path": "sharepoint/sharepoint-ps/sharepoint-online/Set-SPOGeoStorageQuota.md", "redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/set-spogeostoragequota", diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOFontPackage.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOFontPackage.md new file mode 100644 index 000000000..36f94eae5 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOFontPackage.md @@ -0,0 +1,166 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: https://learn.microsoft.com/powershell/module/sharepoint-online/add-spofontpackage +applicable: SharePoint Online +title: Add-SPOFontPackage +schema: 2.0.0 +author: JQ1u +ms.author: luchaoqiu +ms.reviewer: +--- + +# Add-SPOFontPackage + +## SYNOPSIS + +Creates a new custom font package with fonts in the brand fonts library. + +## SYNTAX + +``` +Add-SPOFontPackage -Title -PackageJson [-IsHidden ] [] +``` + +## DESCRIPTION + +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). + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +$packageJson = @' +{ + "fontFaces": [ + { + "fontFamily": "Tahoma", + "path": "Tahoma.ttf", + "fontType": "contentFont" + } + ], + "fontSlots": { + "title": { + "fontFamily": "Tahoma", + "fontFace": "Regular", + "fontVariationSettings": { + "wght": 100, + "wdth": 100 + } + }, + "heading": { + "fontFamily": "Tahoma", + "fontFace": "Regular", + "fontVariationSettings": { + "wght": 100, + "wdth": 100 + } + }, + "body": { + "fontFamily": "Tahoma", + "fontFace": "Regular", + "fontVariationSettings": { + "wght": 100, + "wdth": 100 + } + }, + "label": { + "fontFamily": "Tahoma", + "fontFace": "Regular", + "fontVariationSettings": { + "wght": 100, + "wdth": 100 + } + } + } +} +'@ + +Add-SPOFontPackage -Title "Tahoma" -PackageJson $packageJson +``` + +This example creates a new font package named "Tahoma" with specified JSON configuration. + +### EXAMPLE 2 + +```powershell +# With $packageJson from EXAMPLE 1 +Add-SPOFontPackage -Title "Contoso Font Package" -PackageJson $packageJson -IsHidden $true +``` + +This example creates a hidden font package with specified JSON configuration. + +## PARAMETERS + +### -Title + +> Applicable: SharePoint Online + +Specifies the display name of the new font package. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageJson + +> Applicable: SharePoint Online + +Specifies the JSON configuration for the font package. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsHidden + +> 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. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters + +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). + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-SPOFontPackage](Get-SPOFontPackage.md) + +[Set-SPOFontPackage](Set-SPOFontPackage.md) + +[Remove-SPOFontPackage](Remove-SPOFontPackage.md) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFontPackage.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFontPackage.md new file mode 100644 index 000000000..0126d833e --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFontPackage.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: https://learn.microsoft.com/powershell/module/sharepoint-online/get-spofontpackage +applicable: SharePoint Online +title: Get-SPOFontPackage +schema: 2.0.0 +author: JQ1u +ms.author: luchaoqiu +ms.reviewer: +--- + +# Get-SPOFontPackage + +## SYNOPSIS + +Returns one or all custom font packages in the tenant. + +## SYNTAX + +``` +Get-SPOFontPackage [[-Identity] ] [] +``` + +## DESCRIPTION + +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. + +Font packages contain custom typography definitions that can be applied to SharePoint sites and Viva Connections for branding purposes. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-SPOFontPackage +``` + +This example returns all font packages in the tenant. + +### EXAMPLE 2 + +```powershell +Get-SPOFontPackage -Identity 12345678-1234-1234-1234-123456789012 +``` + +This example returns the font package with the specified GUID. + +### EXAMPLE 3 + +```powershell +Get-SPOFontPackage | Where-Object {$_.IsHidden -eq $false} +``` + +This example returns all visible font packages (not hidden). + +### EXAMPLE 4 + +```powershell +$fontPackage = Get-SPOFontPackage -Identity 12345678-1234-1234-1234-123456789012 +$fontPackage.PackageJson +``` + +This example retrieves a specific font package and displays its JSON configuration. + +## PARAMETERS + +### -Identity + +> Applicable: SharePoint Online + +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. + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.SPOFontPackagePipeBind +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters + +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). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SPOFontPackagePipeBind + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Add-SPOFontPackage](Add-SPOFontPackage.md) + +[Set-SPOFontPackage](Set-SPOFontPackage.md) + +[Remove-SPOFontPackage](Remove-SPOFontPackage.md) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md index fe2ee5d96..ad4d75029 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md @@ -24,6 +24,9 @@ Adds a source to the **Content Security Policy** configuration. ### [Add-SPOFileRequestBrandingProfile](Add-SPOFileRequestBrandingProfile.md) Adds a branding profile for the file request feature by specifying logo and background assets from an existing organization asset library. +### [Add-SPOFontPackage](Add-SPOFontPackage.md) +Creates a new custom font package with fonts in the brand fonts library. + ### [Add-SPOGeoAdministrator](Add-SPOGeoAdministrator.md) Adds a new SharePoint user or security group as GeoAdministrator to a multi-geo tenant. @@ -198,6 +201,9 @@ Returns external users in the tenant. ### [Get-SPOFileRequestBrandingProfiles](Get-SPOFileRequestBrandingProfiles.md) Retrieves branding profiles configured for the file request feature, including details about logo and background assets. +### [Get-SPOFontPackage](Get-SPOFontPackage.md) +Returns one or all custom font packages in the tenant. + ### [Get-SPOGeoAdministrator](Get-SPOGeoAdministrator.md) This cmdlet returns the SharePoint Online user or security group accounts with Global Admin privileges in the current multi-geo tenant. @@ -385,7 +391,7 @@ Returns the current configuration status. Get the replication parameters to manage Multi-Geo taxonomy replication. ### [Get-SPOTheme](Get-SPOTheme.md) -{{Placeholder}} +Returns one or all theme settings from the tenant. ### [Get-SPOUnifiedGroup](Get-SPOUnifiedGroup.md) 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. ### [Remove-SPOFileRequestBrandingProfile](Remove-SPOFileRequestBrandingProfile.md) Removes a branding profile (either primary or secondary) configured for the file request feature across the tenant. +### [Remove-SPOFontPackage](Remove-SPOFontPackage.md) +Removes a brand font package from the tenant. + ### [Remove-SPOGeoAdministrator](Remove-SPOGeoAdministrator.md) Removes a new SharePoint user or security Group in the current Multi-Geo Tenant. @@ -660,6 +669,9 @@ This cmdlet sends a trust request to the tenant with whom you want to establish ### [Set-SPODisableSpacesActivation](Set-SPODisableSpacesActivation.md) Disables the SharePoint Spaces activation. +### [Set-SPOFontPackage](Set-SPOFontPackage.md) +Applies a brand font package to a SharePoint site or Viva Connections. + ### [Set-SPOGeoStorageQuota](Set-SPOGeoStorageQuota.md) This cmdlet sets the storage quota on a multi-geo tenant. diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOFontPackage.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOFontPackage.md new file mode 100644 index 000000000..d09ac4b80 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOFontPackage.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: https://learn.microsoft.com/powershell/module/sharepoint-online/remove-spofontpackage +applicable: SharePoint Online +title: Remove-SPOFontPackage +schema: 2.0.0 +author: JQ1u +ms.author: luchaoqiu +ms.reviewer: +--- + +# Remove-SPOFontPackage + +## SYNOPSIS + +Removes a brand font package from the tenant. + +## SYNTAX + +``` +Remove-SPOFontPackage [-Identity] [] +``` + +## DESCRIPTION + +This cmdlet removes a custom font package from the tenant. After removal, the font package will no longer be available for use on SharePoint sites or Viva Connections. + +> [!NOTE] +> Removing a font package does not delete the associated brand font files. Pages that already use the removed font package will continue to display the configured fonts, but you will no longer be able to modify the font package settings. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Remove-SPOFontPackage -Identity 12345678-1234-1234-1234-123456789012 +``` + +This example removes the font package with the specified GUID. + +### EXAMPLE 2 + +```powershell +$fontPackage = Get-SPOFontPackage -Identity 12345678-1234-1234-1234-123456789012 +Remove-SPOFontPackage -Identity $fontPackage +``` + +This example retrieves a font package and then removes it. + +### EXAMPLE 3 + +```powershell +Get-SPOFontPackage | Where-Object {$_.IsHidden -eq $true} | Remove-SPOFontPackage +``` + +This example removes all hidden font packages from the SharePoint tenant. + +## PARAMETERS + +### -Identity + +> Applicable: SharePoint Online + +Specifies the identity of the font package to remove. This can be the ID (GUID) of the font package, or a font package object. + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.SPOFontPackagePipeBind +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters + +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). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SPOFontPackagePipeBind + +## OUTPUTS + +### None + +## NOTES + +## RELATED LINKS + +[Add-SPOFontPackage](Add-SPOFontPackage.md) + +[Get-SPOFontPackage](Get-SPOFontPackage.md) + +[Set-SPOFontPackage](Set-SPOFontPackage.md) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOFontPackage.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOFontPackage.md new file mode 100644 index 000000000..128b3c922 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOFontPackage.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: https://learn.microsoft.com/powershell/module/sharepoint-online/set-spofontpackage +applicable: SharePoint Online +title: Set-SPOFontPackage +schema: 2.0.0 +author: JQ1u +ms.author: luchaoqiu +ms.reviewer: +--- + +# Set-SPOFontPackage + +## SYNOPSIS + +Applies a brand font package to a SharePoint site or Viva Connections. + +## SYNTAX + +``` +Set-SPOFontPackage [-Identity] [-WebUrl] [] +``` + +## DESCRIPTION + +This 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. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Set-SPOFontPackage -Identity 12345678-1234-1234-1234-123456789012 -WebUrl "https://contoso.sharepoint.com/sites/marketing" +``` + +This example applies the font package with the specified GUID to the marketing site. + +### EXAMPLE 2 + +```powershell +$sites = @("https://contoso.sharepoint.com/sites/hr", "https://contoso.sharepoint.com/sites/finance") +$fontPackage = Get-SPOFontPackage -Identity 12345678-1234-1234-1234-123456789012 +foreach ($site in $sites) { + Set-SPOFontPackage -Identity $fontPackage -WebUrl $site +} +``` + +This example retrieves a font package and applies it to multiple sites. + +## PARAMETERS + +### -Identity + +> Applicable: SharePoint Online + +Specifies the identity of the font package to apply. This can be the ID (GUID) of the font package, or a font package object. + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.SPOFontPackagePipeBind +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WebUrl + +> Applicable: SharePoint Online + +Specifies the URL of the SharePoint site or Viva Connections where the font package will be applied. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +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). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SPOFontPackagePipeBind + +## OUTPUTS + +### None + +## NOTES + +## RELATED LINKS + +[Add-SPOFontPackage](Add-SPOFontPackage.md) + +[Get-SPOFontPackage](Get-SPOFontPackage.md) + +[Remove-SPOFontPackage](Remove-SPOFontPackage.md)