Update-ADFSCertificate
Updates the certificates of the Federation Service.
Syntax
Update-ADFSCertificate
[[-CertificateType] <String>]
[-Urgent]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Update-ADFSCertificate cmdlet creates new certificates for the Federation Service. When automatic certificate rollover is enabled and Active Directory Federation Services (AD FS) 2.0 is managing the certificates that are used for signing, this update cmdlet can be used to initiate a rollover.
Examples
-------------------------- EXAMPLE 1 --------------------------
C:\PS>Update-ADFSCertificate -CertificateType Token-Signing
Description
Updates the token-signing certificate.
Parameters
-CertificateType
Indicates the type of certificate to rollover. Valid types include Token-Encryption and 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
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Urgent
Specifies 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
None
Notes
- The Urgent parameter option is useful for emergency rollover situations in which a key might be compromised.
Related Links
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for