Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Set-ADFSEndpoint

Set-ADFSEndpoint

Sets the properties of a Federation Service endpoint.

Syntax

Set-ADFSEndpoint [[-TargetAddress] <string[]>] -Proxy <Boolean> [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
  • TargetAddress

  • Proxy

  • PassThru

  • Confirm

  • WhatIf

Set-ADFSEndpoint [-TargetFullUrl] <Uri[]> -Proxy <Boolean> [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
  • TargetFullUrl

  • Proxy

  • PassThru

  • Confirm

  • WhatIf

Set-ADFSEndpoint -Proxy <Boolean> -TargetEndpoint <Endpoint[]> [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
  • Proxy

  • TargetEndpoint

  • PassThru

  • Confirm

  • WhatIf

Detailed Description

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

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

Proxy

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

Default Value:

Data Type: Boolean

Attributes

Name Value PSMAML Attribute

Required?

true

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?

true

required

Variable Length?

false

variableLength

TargetAddress

Specifies the relative address of the endpoint that will be modified by the cmdlet.

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 that will be modified by the cmdlet. 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 that will be modified by the cmdlet.

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 an endpoint.

Return Type

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 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>
 
Set-ADFSEndpoint -TargetAddress /adfs/services/trust/13/Windows -Proxy $true                        

Description

-----------

Enables the WS-Trust 1.3 endpoint for proxy use.

See Also

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.