Set-AdfsEndpoint
Sets the endpoint on a Web Application Proxy.
Syntax
Address
Set-AdfsEndpoint
[[-TargetAddressPath] <String>]
-Proxy <Boolean>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
TargetObject
Set-AdfsEndpoint
-TargetEndpoint <Endpoint>
-Proxy <Boolean>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
FullUrl
Set-AdfsEndpoint
[-TargetFullUrl] <Uri>
-Proxy <Boolean>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-AdfsEndpoint cmdlet sets endpoints on a Web Application Proxy.
Examples
Example 1: Set an endpoint
PS C:\> Set-AdfsEndpoint -TargetAddressPath "/adfs/services/trust/13/Windows" -Proxy $True
This command sets the WS-Trust 1.3 endpoint for proxy use.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Proxy
Indicates whether the endpoint is available on the federation server proxy. This is the only field of the endpoint that can be set.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetAddressPath
Specifies the address path of the endpoint. The cmdlet makes the endpoint that you specify available to the extranet.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Address
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetEndpoint
Specifies the endpoint that the cmdlet modifies. This value is typically taken from the pipeline.
Parameter properties
| Type: | Endpoint |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
TargetObject
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetFullUrl
Specifies the full URL of the endpoint that the cmdlet modifies.
Parameter properties
| Type: | Uri |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FullUrl
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.IdentityServer.PowerShell.Resources.Endpoint
This cmdlet returns a class structure that represents an endpoint.
Outputs
None
Notes
This cmdlet has three parameter-sets. You can use the Address, FullUrl, or TargetEndpoint parameter set, over the pipeline, to identify the endpoint. This cmdlet only allows you to modify the Proxy property of the endpoint.
Endpoints provide access to the federation server functionality of AD FS, 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 Web Application Proxy.