Remove-AdfsCertificate
Removes a certificate from AD FS.
Syntax
TargetCertificate (Default)
Remove-AdfsCertificate
[-TargetCertificate] <ServiceCertificate>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByProperties
Remove-AdfsCertificate
-CertificateType <String>
-Thumbprint <String>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-AdfsCertificate cmdlet removes a certificate from Active Directory Federation Services (AD FS).
Examples
Example 1: Remove a token-signing certificate
PS C:\> Remove-AdfsCertificate -CertificateType "Token-Signing" -Thumbprint "fedd995b45e633d4ef30fcbc8f3a48b627e9a28b"
This command removes a token-signing certificate from AD FS.
Parameters
-CertificateType
Specifies the type of the certificate to remove. The acceptable values for this parameter are:
- Infocard-Signing
- Service-Communications
- Token-Encryption
- Token-Signing
Parameter properties
| Type: | String |
| Default value: | None |
| Accepted values: | Token-Decrypting, Token-Signing |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByProperties
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetCertificate
Specifies the certificate to remove. This value is typically taken from the pipeline.
Parameter properties
| Type: | ServiceCertificate |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
TargetCertificate
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Thumbprint
Specifies the thumbprint of the certificate to remove.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByProperties
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.IdentityServer.PowerShell.Resources.ServiceCertificate
A ServiceCertificate object is received by the TargetCertificate parameter.
String
A string object is received by the Thumbprint parameter.
Outputs
None
Notes
- Removing a certificate removes it only from the AD FS configuration data. It does not remove or delete the certificate from the local certificate store on the server computer.