Edit

Set-ADFSEndpoint

  • Reference
Module:
ADFS

Sets the properties of a Federation Service endpoint.

Syntax

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

Description

The Set-ADFSEndpoint cmdlet can be used to enable and disable endpoints on the federation server proxy.

Examples

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

C:\PS>Set-ADFSEndpoint -TargetAddress /adfs/services/trust/13/Windows -Proxy $true

Description

Enables the WS-Trust 1.3 endpoint for proxy use.

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

-Proxy

Specifies whether the endpoint is available on the federation server proxy. This is the only field of the endpoint that can be set.

Type:Boolean
Position:Named
Default value:None
Required:True
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 that will be modified by the cmdlet. his value is typically taken from the pipeline.

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

-TargetFullUrl

Specifies the full URL of the endpoint that will be modified by the cmdlet.

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 structure that represents an endpoint.

Outputs

None

Notes

  • This cmdlet has three parameter-sets. You can use Address, FullUrl, or TargetEndpoint (over the pipeline) to identify the endpoint. Set-ADFSEndpoint only allows you to modify the Proxy property of the endpoint.

    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.