Add-AdfsWebApplicationProxyRelyingPartyTrust
Add-AdfsWebApplicationProxyRelyingPartyTrust
Adds a relying party trust for the Web Application Proxy.
Syntax
Parameter Set: Default
Add-AdfsWebApplicationProxyRelyingPartyTrust [-Name] <String> [-Identifier] <String[]> [-AdditionalAuthenticationRules <String> ] [-AdditionalAuthenticationRulesFile <String> ] [-AlwaysRequireAuthentication] [-Enabled <Boolean> ] [-NotBeforeSkew <Int32> ] [-Notes <String> ] [-PassThru] [-TokenLifetime <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Add-AdfsWebApplicationProxyRelyingPartyTrust cmdlet adds a relying party trust for Web Application Proxy. Authentication and authorization policies for access to internal web applications through the proxy require Web Application Proxy relying party trust. By default, when you deploy Web Application Proxy, a relying party trust exists.
The Web Application Proxy relying party trust is useful to manage global network access from outside the corporate network. By setting authentication and authorization policies, an administrator can restrict access to internal web applications and services that are published through the Web Application Proxy.
Parameters
-AdditionalAuthenticationRules<String>
Specifies rules for additional authentication on the proxy. For more information about the claims language for rules, see Understanding Claim Rule Language in AD FS 2.0 & Higher (https://social.technet.microsoft.com/wiki/contents/articles/4792.understanding-claim-rule-language-in-ad-fs-2-0-higher.aspx) on TechNet.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-AdditionalAuthenticationRulesFile<String>
Specifies a file that contains rules for additional authentication for this relying party.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-AlwaysRequireAuthentication
Indicates that the proxy requires authentication for access, even if the proxy has previously authenticated credentials for access. Specify this parameter to require users to always supply credentials to access sensitive resources.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Enabled<Boolean>
Indicates whether to enable this relying party trust. Specify a value of $True for this parameter to allow authentication and authorization to the proxy.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Identifier<String[]>
Specifies an array of unique identifiers. The proxy uses the identifiers that you specify to specify its corresponding relying party trust when it initiates sign-in requests to obtain tokens for itself. No other trust can use an identifier from this list. As common practice, you can use Uniform Resource Identifiers (URIs) as unique identifiers for a relying party trust, or use any string.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies a name. The cmdlet adds the Web Application Proxy relying party trust that has the friendly name that you specify.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-NotBeforeSkew<Int32>
Specifies the skew, as an integer, for the time stamp that marks the beginning of the validity period. The higher this number is, the further back in time the validity period begins with respect to the time that the claims are issued for the relying party. By default, this value is 0. Specify a positive value if validation fails on the Web Application Proxy relying party because the validity period has not yet begun.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Notes<String>
Specifies notes. The cmdlet stores the notes that you specify for the Web Application Proxy relying party trust.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PassThru
Returns an object representing the item with which you are working. 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 |
-TokenLifetime<Int32>
Specifies the duration, in minutes, for which the claims that are issued to the relying party are valid.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
60 |
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.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Add a relying party trust
This command adds the Web Application Proxy relying party trust. When you first deploy the Web Application Proxy role service, the trust exists by default. Use this example only if you deleted the Web Application Proxy relying party trust.
PS C:\> Add-AdfsWebApplicationProxyRelyingPartyTrust
Related topics
Disable-AdfsWebApplicationProxyRelyingPartyTrust
Enable-AdfsWebApplicationProxyRelyingPartyTrust
Get-AdfsWebApplicationProxyRelyingPartyTrust