Add-ADFSAttributeStore
Add-ADFSAttributeStore
Adds an attribute store to the Federation Service.
Syntax
Parameter Set: Custom
Add-ADFSAttributeStore -Configuration <Hashtable> -Name <String> -TypeQualifiedName <String> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: Predefined
Add-ADFSAttributeStore -Configuration <Hashtable> -Name <String> -StoreType <String> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Add-ADFSAttributeStore cmdlet adds an attribute store to the Federation Service.
Parameters
-Configuration<Hashtable>
Specifies the initialization parameters of the attribute store, such as a connection string.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the friendly name of this attribute store.
Aliases |
none |
Required? |
true |
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 |
-StoreType<String>
Specifies the type of attribute store to add. Valid values are ActiveDirectory, LDAP, and SQL.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-TypeQualifiedName<String>
Specifies the class reference for a custom attribute store that is implemented in a .NET Assembly.
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.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
- None
Notes
- An Active Directory Federation Services (AD FS) 2.0 attribute store is a pluggable module that the policy process for AD FS 2.0 can query to retrieve claim values. You can use either an Active Directory database or a Microsoft SQL Server database as your attribute store, or you can implement your own custom attribute store.
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
Adds a SQL-based attribute store named LocalSqlStore.
C:\PS>Add-ADFSAttributeStore -name 'LocalSqlStore' -StoreType 'SQL' -Configuration @{"name" = "SQL Attribute Store"; "Connection" = "Server=CONTOSOSRV01;Database=UserAttributes;Integrated Security=True;Async=True"}
-------------------------- EXAMPLE 2 --------------------------
Description
-----------
Adds a custom attribute store named MyCustomStore.
C:\PS>Add-ADFSAttributeStore -Name 'MyCustomStore' -TypeQualifiedName 'Contoso.CustomTypes.MyAttributeStore, Contoso.CustomTypes' -Configuration @{"Name" = "Custom Attribute Store"; "Connection" = "Default"}