Edit

Update-AdfsCertificate

  • Reference
Module:
ADFS

Updates the certificates of AD FS.

Syntax

Update-AdfsCertificate
      [[-CertificateType] <String>]
      [-Urgent]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Update-AdfsCertificate cmdlet creates new certificates for Active Directory Federation Services (AD FS). When automatic certificate rollover is enabled and AD FS is managing the certificates that are used for signing, this update cmdlet can be used to initiate a rollover.

Examples

Example 1: Update a token-signing certificate

PS C:\> Update-AdfsCertificate -CertificateType "Token-Signing"

This command updates the token-signing certificate.

Parameters

-CertificateType

Specifies the type of certificate to rollover. The acceptable values for this parameter are:

  • Token-Decrypting
  • Token-Signing
Type:String
Accepted values:Token-Decrypting, Token-Signing
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Urgent

Indicates that the certificate rollover should happen immediately. An urgent rollover removes older certificates immediately. It might result in a service outage as trusts update to use the new certificates.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

Microsoft.IdentityServer.PowerShell.Resources.ServiceCertificate

Returns the updated ServiceCertificate object when the PassThru parameter is specified. By default, this cmdlet does not generate any output.

Notes

  • The Urgent parameter option is useful for emergency rollover situations in which a key might be compromised.