COMMAND EVERYTHING.

Set-HgsKeyProtectionConfiguration

Modifies the configuration of the Key Protection Service.

PowerShell · Risk: High · Documentation Verified

Last verified: 2026-10-26

Microsoft HgsKeyProtection reference: Modifies the configuration of the Key Protection Service. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.

Set-HgsKeyProtectionConfiguration -CommunicationsCertificateThumbprint <String>
 [-NoCommunicationsCertificateReplication] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

Copied 0 times

Required permissions

Use an account with the target resource permissions documented for Set-HgsKeyProtectionConfiguration. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.

Supported environments

Windows / HgsKeyProtection · Windows Server 2025 documentation; feature/module prerequisites apply

Parameters

-CommunicationsCertificatePassword: Specifies the password which protects a certificate file. If the certificate file is protected by a password, you must specify this value.
-CommunicationsCertificatePath (required): Specifies the path to the certificate which will be added to the Key Protection Service as the communications certificate.
-CommunicationsCertificateThumbprint (required): Specifies the thumbprint of the new communications certificate. Before you run this cmdlet, the certificate that this parameter specifies needs to already be in the LocalMachine\My certificate store.
-Confirm: Prompts you for confirmation before running the cmdlet.
-Force: Forces the command to run without asking for user confirmation.
-WhatIf: Shows what would happen if the cmdlet runs. The cmdlet is not run.

Prerequisites

Windows with the HgsKeyProtection module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.

Security considerations

This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.

Examples

Example 1: Assign a certificate to be the communication certificate

Set-HgsKeyProtectionConfiguration -CommunicationsCertificateThumbprint "d39203a3b3544743ad552afe0615dc1f" -Force

This command assigns the certificate that has the specified thumbprint to be the communication certificate for the Key Protection Service. The command specifies the Force, and so, it does not prompt you for confirmation. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.

Sources

https://github.com/MicrosoftDocs/windows-powershell-docs/blob/b7645dd8c687139b28e845119da30ec670526507/docset/winserver2025-ps/HgsKeyProtection/Set-HgsKeyProtectionConfiguration.md

https://learn.microsoft.com/powershell/module/hgskeyprotection/set-hgskeyprotectionconfiguration?view=windowsserver2025-ps

Personal collections

Explain or customize this command with AI

Related commands