Disable-ADFSRelyingPartyTrust
Disable-ADFSRelyingPartyTrust
Disables a relying party trust of the Federation Service.
Syntax
Disable-ADFSRelyingPartyTrust [[-TargetName] <string>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
TargetName
PassThru
Confirm
WhatIf
Disable-ADFSRelyingPartyTrust [-TargetRelyingParty] <RelyingParty[]> [-PassThru] [-Confirm] [-WhatIf] []
TargetRelyingParty
PassThru
Confirm
WhatIf
Disable-ADFSRelyingPartyTrust [-TargetIdentifier] [-PassThru] [-Confirm] [-WhatIf] []
TargetIdentifier
PassThru
Confirm
WhatIf
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.
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 |
TargetIdentifier
Specifies the identifier of the relying party trust to disable.
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? |
1 |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
TargetName
Specifies the name of the relying party trust to disable.
Default Value: **
Data Type: string
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
true (ByValue) |
pipelineInput |
Position? |
1 |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
TargetRelyingParty
Specifies the relying party trust to disable. This value is typically taken from the pipeline.
Default Value: **
Data Type: RelyingParty[]
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
true |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
true (ByValue) |
pipelineInput |
Position? |
1 |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
true |
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.RelyingPartyTrust
A class that represents a relying party trust for the Federation Service.
Return Type
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 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 --------------------------
Command Prompt: C:\PS>
Disable-ADFSRelyingPartyTrust -TargetName "My application"
Description
-----------
Disables a relying party trust called "My application" on the federation server.
See Also
Reference
Add-ADFSRelyingPartyTrust
Get-ADFSRelyingPartyTrust
Remove-ADFSRelyingPartyTrust
Set-ADFSRelyingPartyTrust
Enable-ADFSRelyingPartyTrust
Update-ADFSRelyingPartyTrust