Remove-AdfsRelyingPartyTrust
Removes a relying party trust from the Federation Service.
Syntax
Identifier
Remove-AdfsRelyingPartyTrust
-TargetIdentifier <String>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
IdentifierObject
Remove-AdfsRelyingPartyTrust
-TargetRelyingParty <RelyingPartyTrust>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
IdentifierName
Remove-AdfsRelyingPartyTrust
-TargetName <String>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-AdfsRelyingPartyTrust cmdlet removes a relying party trust from the Federation Service.
Examples
Example 1: Remove a relying party trust
PS C:\> Remove-AdfsRelyingPartyTrust -TargetName "FabrikamApp"
This command removes the relying party trust named FabrikamApp.
Parameters
-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 |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetIdentifier
Specifies the identifier of the relying party trust to remove.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Identifier
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetName
Specifies the name of the relying party trust to remove.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
IdentifierName
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetRelyingParty
Specifies a RelyingPartyTrust object. The cmdlet removes the relying party trust that you specify. To obtain a RelyingPartyTrust object, use the Get-AdfsRelyingPartyTrust cmdlet.
Parameter properties
| Type: | RelyingPartyTrust |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
IdentifierObject
| 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
String
String objects are received by the TargetIdentifier and TargetName parameters.
Microsoft.IdentityServer.PowerShell.Resources.RelyingPartyTrust
RelyingPartytrust objects are received by the TargetRelyingParty parameter.
Outputs
Microsoft.IdentityServer.PowerShell.Resources.RelyingPartyTrust
Returns the removed RelyingPartyTrust object when the PassThru parameter is specified. By default, this cmdlet does not generate any output.
Notes
- A relying party in Active Directory Federation Services (AD FS) is an organization in which Web servers that host one or more Web-based applications reside. Tokens and Information Cards that originate from a claims provider can be presented and ultimately consumed by the Web-based resources that are located in the relying party organization. When AD FS is configured in the role of the relying party, it acts as a partner that trusts a claims provider to authenticate users. Therefore, the relying party consumes the claims that are packaged in security tokens that come from users in the claims provider. In other words, a relying party is the organization whose Web servers are protected by the resource-side federation server. The federation server in the relying party uses the security tokens that the claims provider produces to issue tokens to the Web servers that are located in the relying party.