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

Set-ADFSEndpoint

Windows Server 2012 and Windows 8

Set-ADFSEndpoint

Sets the properties of a Federation Service endpoint.

Syntax

Parameter Set: Address
Set-ADFSEndpoint [[-AddressPath] <String[]> ] [[-TargetAddressPath] <String> ] -Proxy <Boolean> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: FullUrl
Set-ADFSEndpoint [-FullUrl] <Uri[]> [-TargetFullUrl] <Uri> -Proxy <Boolean> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: TargetObject
Set-ADFSEndpoint -Proxy <Boolean> -TargetEndpoint <Endpoint> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

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

Parameters

-AddressPath<String[]>

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-FullUrl<Uri[]>

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-PassThru

Passes an object to the pipeline. By default, this cmdlet does not generate any output.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Proxy<Boolean>

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


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TargetAddressPath<String>

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-TargetEndpoint<Endpoint>

Specifies the endpoint that will be modified by the cmdlet. his value is typically taken from the pipeline.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-TargetFullUrl<Uri>

Specifies the full URL of the endpoint that will be modified by the cmdlet.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

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.

  • Microsoft.IdentityServer.PowerShell.Resources.Endpoint



    A class structure that represents an endpoint.



Outputs

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

  • 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, Information Card 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 --------------------------

Description

-----------

Enables the WS-Trust 1.3 endpoint for proxy use.


C:\PS>Set-ADFSEndpoint -TargetAddress /adfs/services/trust/13/Windows -Proxy $true

Related topics

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