Enable-ADFSEndpoint
Enable-ADFSEndpoint
Enables an endpoint in the Federation Service.
Syntax
Enable-ADFSEndpoint [[-TargetAddress] <string[]>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
TargetAddress
PassThru
Confirm
WhatIf
Enable-ADFSEndpoint [-TargetFullUrl] <Uri[]> [-PassThru] [-Confirm] [-WhatIf] []
TargetFullUrl
PassThru
Confirm
WhatIf
Enable-ADFSEndpoint -TargetEndpoint <Endpoint[]> [-PassThru] [-Confirm] [-WhatIf] []
TargetEndpoint
PassThru
Confirm
WhatIf
Detailed Description
The Enable-ADFSEndpoint cmdlet enables an endpoint in the Federation Service.
Parameters
PassThru
Passes an object to the pipeline. By default, this cmdlet does not generate any output.
Default Value: **
Data Type: SwitchParameter
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
TargetAddress
Specifies the relative address of the endpoint to enable.
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 |
TargetEndpoint
Specifies the endpoint to enable. This value is typically taken from the pipeline.
Default Value: **
Data Type: Endpoint[]
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
true |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
true (ByValue) |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
true |
variableLength |
TargetFullUrl
Specifies the full URL of the endpoint to enable.
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 |
Confirm
Prompts you for confirmation before executing the command.
Default Value: **
Data Type: SwitchParameter
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
true |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
WhatIf
Describes what would happen if you executed the command without actually executing the command.
Default Value: **
Data Type: SwitchParameter
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
true |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Input Type
Microsoft.IdentityServer.PowerShell.Resources.Endpoint
A class structure that represents the endpoints for the Federation Service.
Return Type
None
Notes
- Endpoints provide access to the federation server functionality of Active Directory Federation Services (AD FS) 2.0, such as token 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.
Examples
-------------------------- EXAMPLE 1 --------------------------
Command Prompt: C:\PS>
Enable-ADFSEndpoint -TargetAddress /adfs/services/trust/13/Windows
Description
-----------
Enables the WS-Trust 1.3 endpoint for the Federation Service.
See Also
Reference
Get-ADFSEndpoint
Set-ADFSEndpoint
Disable-ADFSEndpoint