Get-ADFSEndpoint
Get-ADFSEndpoint
Gets the endpoints in the Federation Service.
Syntax
Get-ADFSEndpoint [[-Address] <string[]>] [<CommonParameters>]
Address
Get-ADFSEndpoint [-FullUrl] <Uri[]> []
FullUrl
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
Address
Specifies the relative address of the endpoint to retrieve.
Default Value: **
Data Type: string[]
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
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 |
FullUrl
Specifies the full URL of the endpoint to retrieve.
Default Value: **
Data Type: Uri[]
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 |
Input Type
None
Return Type
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 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 --------------------------
Command Prompt: C:\PS>
Enable-ADFSEndpoint -TargetAddress /adfs/services/trust/13/Windows
Description
-----------
Enables the WS-Trust 1.3 endpoint.
See Also
Reference
Set-ADFSEndpoint
Enable-ADFSEndpoint
Disable-ADFSEndpoint