Remove-ADFSCertificate
Remove-ADFSCertificate
Removes a certificate from the Federation Service.
Syntax
Parameter Set: TargetCertificate
Remove-ADFSCertificate [-TargetCertificate] <ServiceCertificate> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ByProperties
Remove-ADFSCertificate -CertificateType <String> -Thumbprint <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-ADFSCertificate cmdlet removes a certificate from the Federation Service.
Parameters
-CertificateType<String>
Specifies the type of the certificate to remove. Possible certificate types are
Token-Signing, Token-Encryption, Service-Communications, or Infocard-Signing.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-TargetCertificate<ServiceCertificate>
Specifies the certificate to remove. This value is typically taken from the pipeline.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Thumbprint<String>
Specifies the thumbprint of the certificate to remove.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Microsoft.IdentityServer.PowerShell.Resources.ServiceCertificate
A class structure that represents the service certificates for the Federation Service.
Outputs
The output type is the type of the objects that the cmdlet emits.
- None
Notes
- Removing a certificate removes it only from the Active Directory Federation Services (AD FS) 2.0 configuration data. It does not remove or delete the certificate from the local certificate store on the server computer.
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
Removes a token-signing certificate from the Federation Service.
C:\PS>Remove-ADFSCertificate -CertificateType Token-Signing -Thumbprint fedd995b45e633d4ef30fcbc8f3a48b627e9a28b
Related topics
Add-ADFSCertificate
Update-ADFSCertificate