Export (0) Print
Expand All

Set-WebApplicationProxyApplication

Windows Server 2012 R2 and Windows 8.1

Updated: April 7, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Set-WebApplicationProxyApplication

Modifies settings of a web application published through Web Application Proxy.

Syntax

Parameter Set: ID
Set-WebApplicationProxyApplication [-ID] <Guid> [-AsJob] [-BackendServerAuthenticationSPN <String> ] [-BackendServerCertificateValidation <String> ] [-BackendServerUrl <Uri> ] [-CimSession <CimSession[]> ] [-ClientCertificateAuthenticationBindingMode <String> ] [-ClientCertificatePreauthenticationThumbprint <String> ] [-DisableTranslateUrlInRequestHeaders] [-DisableTranslateUrlInResponseHeaders] [-ExternalCertificateThumbprint <String> ] [-ExternalUrl <Uri> ] [-InactiveTransactionsTimeoutSec <UInt32> ] [-Name <String> ] [-ThrottleLimit <Int32> ] [-UseOAuthAuthentication] [ <CommonParameters>]




Detailed Description

The Set-WebApplicationProxyApplication cmdlet modifies settings of a web application published through Web Application Proxy. Specify the web application to modify by using its ID. Note that the method of pre-authentication cannot be changed. The cmdlet ensures that no other applications are already configured to use any specified ExternalURL or BackendServerURL.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-BackendServerAuthenticationSPN<String>

Specifies the SPN of the backend server. Use this parameter if the application that the backend server hosts uses Integrated Windows authentication.


Aliases

SPN

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-BackendServerCertificateValidation<String>

Specifies whether Web Application Proxy validates the certificate that the backend server presents. The acceptable values for this parameter are: 

-- None
-- ValidateCertificate


Aliases

none

Required?

false

Position?

named

Default Value

None

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-BackendServerUrl<Uri>

Specifies the address of the web application. Specify the protocol and host name or IP address. Include the trailing slash (/). You can also include a port number and path. The following examples show the form of an address:

-- http://AccountingApp.Contoso.com/
-- http://Mail.Contoso.com/Remote/
-- http://Portal/

The cmdlet checks that no other applications are already configured to use this URL.


Aliases

BackendUrl

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-CimSession<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.


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ClientCertificateAuthenticationBindingMode<String>

Specifies whether Web Application Proxy verifies whether the certificate that authenticates the federation server authenticates future requests. The acceptable values for this parameter are: 

-- None
-- ValidateCertificate


Aliases

none

Required?

false

Position?

named

Default Value

None

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ClientCertificatePreauthenticationThumbprint<String>

Specifies the certificate thumbprint, as a string, of the certificate that a client supplies for the preauthentication feature. The thumbprint is 40 hexadecimal characters. This parameter is only relevant when you specify the value of ClientCertificate for the ExternalPreauthentication parameter.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DisableTranslateUrlInRequestHeaders

Indicates that Web Application Proxy does not translate HTTP host headers from public host headers to internal host headers when it forwards the request to the published application.

Specify this parameter if the application uses path-based information.


Aliases

none

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DisableTranslateUrlInResponseHeaders

Indicates that Web Application Proxy does not translate internal host names to public host names in Content-Location, Location, and Set-Cookie response headers in redirect responses.

If the proxy does not translate host names in the Content-Location or Location response headers, subsequent client requests resolve incorrectly. If the proxy does not translate the host name in the Set-Cookie response header, the published web application might not use cookies properly.


Aliases

none

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ExternalCertificateThumbprint<String>

Specifies the certificate thumbprint, as a string, of the certificate to use for the address specified by the ExternalUrl parameter. The thumbprint is 40 hexadecimal characters.

The certificate must exist in the Local Computer or Local Personal certificate store. You can use a simple certificate, a subject alternative name (SAN) certificate, or a wildcard certificate.


Aliases

ExternalCert

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ExternalUrl<Uri>

Specifies the external address, as a URL, for the web application. Include the trailing slash (/).

The cmdlet checks that no other applications are already configured to use this URL.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ID<Guid>

Specifies the GUID of a web application. To obtain the GUID of a web application, use the Get-WebApplicationProxyApplication cmdlet.


Aliases

ApplicationID

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-InactiveTransactionsTimeoutSec<UInt32>

Specifies the length of time, in seconds, until Web Application Proxy closes incomplete HTTP transactions.


Aliases

none

Required?

false

Position?

named

Default Value

300

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

Specifies a friendly name for the published web application.


Aliases

FriendlyName

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

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. Do not specify a value for this parameter greater than 1.


Aliases

none

Required?

false

Position?

named

Default Value

1

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UseOAuthAuthentication

Indicates that Web Application Proxy provides the URL of the federation server that performs Open Authorization (OAuth) when users connect to the application by using a Windows Store app.


Aliases

none

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

True (ByPropertyName)

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.

Outputs

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

Examples

Example 1: Change the extern URL for a web application

This command changes the external URL to https://sp.contoso.com/ for the web application that has the specified ID.


PS C:\> Set-WebApplicationProxyApplication -ID 874A4543-7983-77A3-1E6D-1163E7419AC1 -ExternalUrl https://SP.Contoso.com/

Example 2: Change the backend server URL and the external URL

This command modifies a web application that has the specified ID. The command changes the backend server to be https://Portal.Contoso.com/ and the external URL to be https://SP.Contoso.com/.


PS C:\> Set-WebApplicationProxyApplication -ID 874A4543-7983-77A3-1E6D-1163E7419AC1 -BackendServerUrl https://Portal.Contoso.com/ -ExternalUrl https://SP.Contoso.com/ 

Example 3: Change the name of a web application

This command changes the friendly name of an application that has the specified ID.


PS C:\> Set-WebApplicationProxyApplication -ID 874A4543-7983-77A3-1E6D-1163E7419AC1 -Name Test123

Example 4: Disable URL translation in headers

This command modifies the web application that has the specified ID. The command disables URL translation in both request and response headers.


PS C:\> Set-WebApplicationProxyApplication -ID 874A4543-7983-77A3-1E6D-1163E7419AC1 -DisableTranslateUrlInRequestHeaders -DisableTranslateUrlInResponseHeaders

Example 5: Change the certificate thumbprint for a web application

This command changes the external certificate thumbprint for the web application that has the specified ID.


PS C:\> Set-WebApplicationProxyApplication -ID 874A4543-7983-77A3-1E6D-1163E7419AC1 –ExternalCertificateThumbprint FFAFA2422D77BC784D1F48E08F6BDAE32CD109A2

Example 6: Change the timeout interval for web applications

This command changes the inactive transaction timeout for all web applications whose names begin with the string SharePoint.


PS C:\> Get-WebApplicationProxyApplication SharePoint* | Set-WebApplicationProxyApplication -InactiveTransactionsTimeoutSec 400

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft