Edit

Share via


Set-WebApplicationProxyConfiguration

Modifies the configuration settings of a Web Application Proxy server.

Syntax

Default (Default)

Set-WebApplicationProxyConfiguration
    [-ADFSUrl <Uri>]
    [-ADFSTokenSigningCertificatePublicKey <String>]
    [-ADFSWebApplicationProxyRelyingPartyUri <Uri>]
    [-RegenerateAccessCookiesEncryptionKey]
    [-ConnectedServersName <String[]>]
    [-OAuthAuthenticationURL <Uri>]
    [-ConfigurationChangesPollingIntervalSec <UInt32>]
    [-UpgradeConfigurationVersion]
    [-ADFSTokenAcceptanceDurationSec <UInt32>]
    [-ADFSSignOutURL <Uri>]
    [-UserIdleTimeoutSec <UInt32>]
    [-UserIdleTimeoutAction <String>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

Description

The Set-WebApplicationProxyConfiguration cmdlet modifies the configuration settings of a Web Application Proxy server. The settings include the Active Directory Federation Services (AD FS) URL, the token signing certificate, and the edge server URI.

Examples

Example 1: Modify the proxy to check for configuration changes

PS C:\> Set-WebApplicationProxyConfiguration -ConfigurationChangesPollingIntervalSec 300

This command modifies the Web Application Proxy to query the federation server every 300 seconds for configuration changes.

Parameters

-ADFSSignOutURL

Specifies the sign out URL for Web Application Proxy.

Parameter properties

Type:Uri
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:True
Value from remaining arguments:False

-ADFSTokenAcceptanceDurationSec

Specifies the maximum duration in seconds until when the Web Application Proxy server accepts the edge token issued by the AD FS server.

Parameter properties

Type:UInt32
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:True
Value from remaining arguments:False

-ADFSTokenSigningCertificatePublicKey

Specifies the thumbprint of the certificate that the federation server uses to sign the edge token. The thumbprint is the SHA-1 hash of the certificate and consists of 40 hexadecimal characters. Specify this parameter only when the AD FS token signing certificate changes.

Parameter properties

Type:String
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:True
Value from remaining arguments:False

-ADFSUrl

Specifies the URL for the federation server that is used by the Web Application Proxy. The Web Application Proxy Configuration Wizard populates this setting, and there is no requirement that you manually change it.

Parameter properties

Type:Uri
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:True
Value from remaining arguments:False

-ADFSWebApplicationProxyRelyingPartyUri

Specifies the URI for the Web Application Proxy server.

Parameter properties

Type:Uri
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:True
Value from remaining arguments:False

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

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

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Session

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ConfigurationChangesPollingIntervalSec

Specifies the time interval, in seconds, that elapses before the Web Application Proxy servers query a federation server for configuration changes.

Parameter properties

Type:UInt32
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:True
Value from remaining arguments:False

-ConnectedServersName

Specifies an array of Web Application Proxy servers that are connected to a federation server.

Parameter properties

Type:

String[]

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:True
Value from remaining arguments:False

-OAuthAuthenticationURL

Specifies the URL of the federation server that performs Open Authorization (OAuth) authentication when end users connect to a published web application using a Windows Store app.

Parameter properties

Type:Uri
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:True
Value from remaining arguments:False

-RegenerateAccessCookiesEncryptionKey

Specifies whether to create a new encryption key to be used by Web Application Proxy servers to encrypt proxy cookies. All Web Application Proxy servers use the encryption key to validate the access cookie, even if the cookie was issued by another Web Application Proxy server.

You should specify this parameter whenever you want to change the encryption key that is used to encrypt the proxy cookies.

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

-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Parameter properties

Type:Int32
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

-UpgradeConfigurationVersion

Indicates whether this cmdlet uses the upgrade configuration version setting.

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

-UserIdleTimeoutAction

Specifies whether inactive user will be redirected to the AD FS for signout or reauthentication.

Parameter properties

Type:String
Default value:None
Accepted values:Signout, Reauthenticate
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

-UserIdleTimeoutSec

Specifies the inactivity time interval, in seconds, after which Web Application Proxy will redirect users to AD FS.

Parameter properties

Type:UInt32
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

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

Uri

String

String

UInt32

Outputs

Object