Set-AdfsRelyingPartyWebContent
Set-AdfsRelyingPartyWebContent
Sets properties for the relying party web content objects.
Syntax
Parameter Set: IdentifierName
Set-AdfsRelyingPartyWebContent [[-Locale] <CultureInfo> ] -Name <String> [-ErrorPageAuthorizationErrorMessage <String> ] [-ErrorPageDeviceAuthenticationErrorMessage <String> ] [-ErrorPageGenericErrorMessage <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: IdentifierObject
Set-AdfsRelyingPartyWebContent [-TargetWebContent] <AdfsRelyingPartyWebContent> [-ErrorPageAuthorizationErrorMessage <String> ] [-ErrorPageDeviceAuthenticationErrorMessage <String> ] [-ErrorPageGenericErrorMessage <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-AdfsRelyingPartyWebContent cmdlet sets properties for a relying party web content object. These properties override equivalent values set by using the Set-AdfsGlobalWebContent cmdlet to obtain a web content object. Specify a relying party web content object by using a name and locale, or use the Get-AdfsRelyingPartyWebContent cmdlet. If you do not specify a locale, the cmdlet uses the invariant locale.
Parameters
-ErrorPageAuthorizationErrorMessage<String>
Specifies an error message to display when a user encounters any authorization errors that occur for a token request. This string can be an HTML fragment.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ErrorPageDeviceAuthenticationErrorMessage<String>
Specifies an error message to display for any device authentication errors that occur for a token request. Device authentication errors occur when the user presents an expired user@device certificate to Active Directory Federation Services (AD FS), a certificate that is not found in Active Directory® Domain Services, or a certificate that is disabled in Active Directory Domain Services. This string can be an HTML fragment.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ErrorPageGenericErrorMessage<String>
Specifies an error message to display for any generic errors that occur for a token request. This string can be an HTML fragment.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Locale<CultureInfo>
Specifies a locale. The cmdlet sets relying party web content for the locale that you specify.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies a name. The cmdlet modifies content for the relying party that you specify by name.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
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 |
-TargetWebContent<AdfsRelyingPartyWebContent>
Specifies a relying party web content object. The cmdlet modifies content for the object that you specify. To obtain a relying party web content object, use Get-AdfsRelyingPartyWebContent.
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 (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.
System.IdentityServer.Management.Resources.AdfsRelyingPartyWebContent
This cmdlet generates a System.IdentityServer.Management.Resources.AdfsRelyingPartyWebContent object that represents web content of a relying party, or an array of such objects. The object includes the following properties:
Locale: System.Globalization.CultureInfo
Name: System.String
ErrorPageGenericErrorMessage: System.String
ErrorPageAuthorizationErrorMessage: System.String
ErrorPageDeviceAuthenticationErrorMessage: System.String
Examples
Example 1: Specify a generic error message
This command specifies a generic error message to display to users for the relying party named RelyingParty01.
PS C:\> Set-AdfsRelyingPartyWebContent -Name "RelyingParty01" -ErrorPageGenericErrorMessage "There is an error."
Example 2: Specify multiple error messages
This command assigns multiple error messages to display to users for the relying party named RelyingParty01 with the specified locale.
PS C:\> Set-AdfsRelyingPartyWebContent -Locale en-us -Name "RelyingParty02" -ErrorPageAuthorizationErrorMessage "There is an authorization error." -ErrorPageDeviceAuthenticationErrorMessage "There is a device authentication error." -ErrorPageGenericErrorMessage "There is an error."