Edit

Disable-ADFSEndpoint

  • Reference
Module:
ADFS

Disables an endpoint of the Federation Service.

Syntax

Disable-ADFSEndpoint
       [[-TargetAddressPath] <String>]
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Disable-ADFSEndpoint
       [-TargetEndpoint] <Endpoint>
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Disable-ADFSEndpoint
       [-TargetFullUrl] <Uri>
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

The Disable-ADFSEndpoint cmdlet disables an endpoint of the Federation Service.

Examples

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

C:\PS>Disable-ADFSEndpoint -TargetAddress /adfs/services/trust/13/Windows

Description

Disables the WS-Trust 1.3 endpoint on the current federation server.

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

Passes an object to the pipeline. 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

-TargetAddressPath

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

-TargetEndpoint

Specifies the endpoint to disable. This value is typically taken from the pipeline.

Type:Endpoint
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-TargetFullUrl

Specifies the full URL of the endpoint to disable.

Type:Uri
Position:0
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

Microsoft.IdentityServer.PowerShell.Resources.Endpoint

A class that represents an endpoint for the Federation Service.

Outputs

None

Notes

  • Endpoints provide access to the federation server functionality of Active Directory Federation Services (AD FS) 2.0, such as token issuance, Information Card issuance, and the publishing of federation metadata. Depending on the type of endpoint, you can enable or disable the endpoint or control whether the endpoint is published to AD FS 2.0 proxies.