Modifier

Partager via

Disable-AdfsClaimsProviderTrust

  • Reference
Module:
ADFS

Disables a claims provider trust in the Federation Service.

Syntax

Disable-AdfsClaimsProviderTrust
       -TargetClaimsProviderTrust <ClaimsProviderTrust>
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Disable-AdfsClaimsProviderTrust
       -TargetCertificate <X509Certificate2>
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Disable-AdfsClaimsProviderTrust
       -TargetIdentifier <String>
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Disable-AdfsClaimsProviderTrust
       -TargetName <String>
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

The Disable-AdfsClaimsProviderTrust cmdlet disables a claims provider trust in the Federation Service. When disabled all tokens issued by this claims provider are not accepted by the AD FS service.

Examples

Example 1: Disable a claims provider trust

PS C:\> Disable-AdfsClaimsProviderTrust -TargetName "Fabrikam claims provider"

This command disables the claims provider trust named Fabrikam claims provider.

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

-TargetCertificate

Specifies the token-signing certificate of the claims provider trust to disable.

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

-TargetClaimsProviderTrust

Specifies a ClaimsProviderTrust object. The cmdlet enables the claims provider trust that you specify. To obtain a ClaimsProviderTrust object, use the Get-AdfsClaimsProviderTrust cmdlet.

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

-TargetIdentifier

Specifies the identifier of the claims provider 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 claims provider trust to disable.

Type:String
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

System.Security.Cryptography.X509Certificates.X509Certificate.X509Certificate2

X509Certificate2 objects are received by the TargetCertificate parameter.

Microsoft.IdentityServer.PowerShell.Resources.ClaimsProviderTrust

ClaimsProviderTrust objects are received by the TargetClaimsProviderTrust parameter.

String

String objects are received by the TargetIdentifier and TargetName parameters.

Outputs

Microsoft.IdentityServer.PowerShell.Resources.ClaimsProviderTrust

Returns the disabled ClaimsProviderTrust object when the PassThru parameter is specified. By default, this cmdlet does not generate any output.