Skip to content

Latest commit

 

History

History
204 lines (159 loc) · 5.16 KB

Set-AdfsAuthenticationProviderWebContent.md

File metadata and controls

204 lines (159 loc) · 5.16 KB
description external help file Module Name ms.date online version schema title
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
Microsoft.IdentityServer.Management.dll-Help.xml
ADFS
12/20/2016
2.0.0
Set-AdfsAuthenticationProviderWebContent

Set-AdfsAuthenticationProviderWebContent

SYNOPSIS

Modifies a display name and description.

SYNTAX

IdentifierName (Default)

Set-AdfsAuthenticationProviderWebContent [-DisplayName <String>] [-Description <String>]
 [-UserNotProvisionedErrorMessage <String>] [-PassThru] [[-Locale] <CultureInfo>] -Name <String> [-WhatIf]
 [-Confirm] [<CommonParameters>]

IdentifierObject

Set-AdfsAuthenticationProviderWebContent [-DisplayName <String>] [-Description <String>]
 [-UserNotProvisionedErrorMessage <String>] [-PassThru] [-TargetWebContent] <AdfsAuthProviderWebContent>
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Set-AdfsAuthenticationProviderWebContent cmdlet modifies a display name and description. Use this cmdlet to customize the name of the authentication provider to a user friendly and intuitive name. You can choose to specify a locale, or use an empty string for the Locale parameter to specify an invariant locale.

EXAMPLES

Example 1: Modify the authentication provider web content

PS C:\> Set-AdfsAuthenticationProviderWebContent -Name MultiFactorAuthentication -DisplayName "User Friendly Name for Multifactor Authentication" -Description "Description of your choice"

This command modifies the display name and description for the authentication provider that the user sees in the Active Directory Federation Services (AD FS) logon pages.

PARAMETERS

-Description

Specifies a description. The cmdlet modifies the provider web content with the description that you specify.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DisplayName

Specifies a display name. The cmdlet modifies the provider web content with the display name that you specify.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Locale

Specifies a locale. The cmdlet modifies the provider web content associated with the locale that you specify.

Type: CultureInfo
Parameter Sets: IdentifierName
Aliases: 

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specifies the name of the authentication provider whose web content is being modified. To find a list of available authentication providers, run the command Get-AdfsAuthenticationProvider. Each returned provider has a Name property, and that value can be used with this parameter.

Type: String
Parameter Sets: IdentifierName
Aliases: 

Required: True
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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TargetWebContent

Specifies an AdfsAuthenticationProviderWebContent object that is used by the pipeline.

Type: AdfsAuthProviderWebContent
Parameter Sets: IdentifierObject
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-UserNotProvisionedErrorMessage

Specifies an error message for a user not provisioned result.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS

Get-AdfsAuthenticationProviderWebContent

Remove-AdfsAuthenticationProviderWebContent