Disable-AdfsRelyingPartyTrust
Disables a relying party trust of the Federation Service.
Syntax
Identifier
Disable-AdfsRelyingPartyTrust
-TargetIdentifier <String>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
IdentifierObject
Disable-AdfsRelyingPartyTrust
-TargetRelyingParty <RelyingPartyTrust>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
IdentifierName
Disable-AdfsRelyingPartyTrust
-TargetName <String>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Disable-AdfsRelyingPartyTrust cmdlet disables a relying party trust of the Federation Service. When disabled, AD FS does not issue tokens when users attempt to access this relying party.
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 disable.
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 disable.
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 the relying party trust to disable. This value is typically taken from the pipeline.
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 disabled RelyingPartyTrust object when the PassThru parameter is specified. By default, this cmdlet does not generate any output.