Remove-ADFSCertificate
Remove-ADFSCertificate
Removes a certificate from the Federation Service.
Syntax
Remove-ADFSCertificate -CertificateType <string> -Thumbprint <string> [-PassThru] [-TargetCertificate <ADFSCertificate>] [-Confirm] [-WhatIf] [<CommonParameters>]
CertificateType
Thumbprint
PassThru
TargetCertificate
Confirm
WhatIf
Detailed Description
The Remove-ADFSCertificate cmdlet removes a certificate from the Federation Service.
Parameters
CertificateType
Specifies the type of the certificate to remove. Possible certificate types are
Token-Signing, Token-Encryption, or Service-Communications.
Default Value: **
Data Type: string
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
PassThru
Passes an object to the pipeline. By default, this cmdlet does not generate any output.
Default Value: **
Data Type: SwitchParameter
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
TargetCertificate
Specifies the certificate to remove. This value is typically taken from the pipeline.
Default Value: **
Data Type: ADFSCertificate
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
Thumbprint
Specifies the thumbprint of the certificate to remove.
Default Value: **
Data Type: string
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
true (ByValue) |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
Confirm
Prompts you for confirmation before executing the command.
Default Value: **
Data Type: SwitchParameter
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
true |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
WhatIf
Describes what would happen if you executed the command without actually executing the command.
Default Value: **
Data Type: SwitchParameter
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
true |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Input Type
Microsoft.IdentityServer.PowerShell.Resources.ServiceCertificate
A class structure that represents the service certificates for the Federation Service.
Return Type
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 --------------------------
Command Prompt: C:\PS>
Remove-ADFSCertificate -CertificateType Token-Signing -Thumbprint fedd995b45e633d4ef30fcbc8f3a48b627e9a28b
Description
-----------
Removes a token-signing certificate from the Federation Service.
See Also
Reference
Add-ADFSCertificate
Update-ADFSCertificate