Get-ADFSEndpoint

  • Article

Get-ADFSEndpoint

Gets the endpoints in the Federation Service.

Syntax

Parameter Set: Address
Get-ADFSEndpoint [[-AddressPath] <String[]> ] [ <CommonParameters>]

Parameter Set: FullUrl
Get-ADFSEndpoint [-FullUrl] <Uri[]> [ <CommonParameters>]

Detailed Description

The Get-ADFSEndpoint cmdlet retrieves a specified endpoint from the Federation Service. The collection of ADFSEndpoint objects is a list of all the supported endpoints that are on the server. You can use this list to view the configuration of endpoints and enable or disable them. To see the full list of endpoints, use this cmdlet with no parameters.

Parameters

-AddressPath<String[]>

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-FullUrl<Uri[]>

Specifies the full URL of the endpoint to retrieve.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

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.

  • None

Outputs

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

  • Microsoft.IdentityServer.PowerShell.Resources.Endpoint

    A class structure that represents the endpoints for the Federation Service.

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 publication 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.

Examples

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

Description

-----------

Enables the WS-Trust 1.3 endpoint.

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

Disable-ADFSEndpoint

Enable-ADFSEndpoint

Set-ADFSEndpoint