Set-ADFSProxyConfiguration
Set-ADFSProxyConfiguration
Sets the configuration properties of the federation server proxy.
Syntax
Parameter Set: Default
Set-ADFSProxyConfiguration [-ForwardProxyUrl <Uri> ] [-HostName <String> ] [-HttpPort <Int32> ] [-HttpsPort <Int32> ] [-LogLevel <String[]> ] [-PassThru] [-ProxyTrustRenewPeriod <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-ADFSProxyConfiguration cmdlet changes the properties of a federation server proxy that has been previously configured.
Parameters
-ForwardProxyUrl<Uri>
Specifies the URL of a forward proxy to use for communication to the federation service, if any. By default, there is no forward proxy configured.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-HostName<String>
Specifies the network addressable host name of the Federation Service.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-HttpPort<Int32>
Specifies the HTTP port for the server. The default value is 80.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-HttpsPort<Int32>
Specifies the HTTPS port for the server. The default value is 443.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LogLevel<String[]>
Specifies the level of logging detail. The list defines which types of events are logged.
Possible values are Errors, Warnings, Information, SuccessAudits, and FailureAudits.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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 |
-ProxyTrustRenewPeriod<Int32>
Sets the interval (in minutes) that the federation server proxy uses to check with its associated federation server for updated trust tokens.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
- None
Notes
- This cmdlet may be used only on a computer that is configured in Active Directory Federation Services (AD FS) as a federation server proxy. It will not work on a federation server.
Examples
-------------------------- EXAMPLE 1 --------------------------
Sets the properties for the federation server proxy with the name "fs.fabrikam.com".
PS C:\> Set-ADFSProxyProperties -Hostname "fs.fabrikam.com"