Import-AdfsAuthenticationProviderConfigurationData
Import-AdfsAuthenticationProviderConfigurationData
Imports the custom configuration for an authentication provider.
Syntax
Parameter Set: Default
Import-AdfsAuthenticationProviderConfigurationData -FilePath <String> -Name <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Import-AdfsAuthenticationProviderConfigurationData cmdlet imports custom configuration for an authentication provider from a file. Before you use this cmdlet, verify that the external authentication provider supports a custom configuration.
Use this cmdlet when the information specific to the authentication provider changes after you initially register the authentication provider. In some situations, the security key to access the authentication service can change and you must update the information in the Active Directory Federation Services (AD FS) configuration store for the authentication provider to function correctly.
Parameters
-FilePath<String>
Specifies a file path. The cmdlet imports the configuration data from a file that you specify.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of the authentication provider to import.
Aliases |
none |
Required? |
true |
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.
Outputs
The output type is the type of the objects that the cmdlet emits.
- System.Object
Examples
Example 1: Import authentication provider configuration data
This command imports the authentication provider configuration data. This command also overwrites existing configuration data for the specified authentication provider with the data from the file.
PS C:\> Import-AdfsAuthenticationProviderConfigurationData -Name "ContosoExternalAuthProvider" -FilePath "C:\share\test.txt"