Edit

Disable-AdfsRelyingPartyTrust

  • Reference
Module:
ADFS

Disables a relying party trust of the Federation Service.

Syntax

Disable-AdfsRelyingPartyTrust
       -TargetIdentifier <String>
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Disable-AdfsRelyingPartyTrust
       -TargetRelyingParty <RelyingPartyTrust>
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
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.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TargetIdentifier

Specifies the identifier of the relying party trust to disable.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-TargetName

Specifies the name of the relying party trust to disable.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-TargetRelyingParty

Specifies the relying party trust to disable. This value is typically taken from the pipeline.

Type:RelyingPartyTrust
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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.