Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Disable-ADFSRelyingPartyTrust

Disable-ADFSRelyingPartyTrust

Disables a relying party trust of the Federation Service.

Syntax

Parameter Set: Identifier
Disable-ADFSRelyingPartyTrust -TargetIdentifier <String> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: IdentifierName
Disable-ADFSRelyingPartyTrust -TargetName <String> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: IdentifierObject
Disable-ADFSRelyingPartyTrust -TargetRelyingParty <RelyingPartyTrust> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Disable-ADFSRelyingPartyTrust cmdlet disables a relying party trust of the federation service.

Parameters

-PassThru

Passes an object to the pipeline. By default, this cmdlet does not generate any output.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TargetIdentifier<String>

Specifies the identifier of the relying party trust to disable.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-TargetName<String>

Specifies the name of the relying party trust to disable.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-TargetRelyingParty<RelyingPartyTrust>

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


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • Microsoft.IdentityServer.PowerShell.Resources.RelyingPartyTrust



    A class that represents a relying party trust for the Federation Service.



Outputs

The output type is the type of the objects that the cmdlet emits.

  • None

Notes

  • A relying party in Active Directory Federation Services (AD FS) 2.0 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 then be presented and ultimately consumed by the Web-based resources that are located in the relying party organization. When AD FS 2.0 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 at 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.


Examples

-------------------------- EXAMPLE 1 --------------------------

Description

-----------

Disables a relying party trust called "My application" on the federation server.


C:\PS>Disable-ADFSRelyingPartyTrust -TargetName "My application"

Related topics


Add-ADFSRelyingPartyTrust

Enable-ADFSRelyingPartyTrust

Get-ADFSRelyingPartyTrust

Remove-ADFSRelyingPartyTrust

Set-ADFSRelyingPartyTrust

Update-ADFSRelyingPartyTrust

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.