Add-Adfs Attribute Store

Module:
adfs
Adds an attribute store to the Federation Service.

Syntax 

Add-AdfsAttributeStore
   -Name <String>
   -StoreType <String>
   -Configuration <Hashtable>
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-AdfsAttributeStore
   -Name <String>
   -TypeQualifiedName <String>
   -Configuration <Hashtable>
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Add-AdfsAttributeStore cmdlet adds an attribute store to the Federation Service.

Examples

Example 1: Add a SQL type attribute store 

PS C:\> Add-AdfsAttributeStore -Name "LocalSqlStore" -StoreType "SQL" -Configuration @{"name" = "SQL Attribute Store"; "Connection" = "Server=CONTOSOSRV01;Database=UserAttributes;Integrated Security=True;Async=True"}

This command adds a SQL-based attribute store named LocalSqlStore.

Example 2: Add a custom attribute store 

PS C:\> Add-AdfsAttributeStore -Name "MyCustomStore" -TypeQualifiedName "Contoso.CustomTypes.MyAttributeStore, Contoso.CustomTypes" -Configuration @{"Name" = "Custom Attribute Store"; "Connection" = "Default"}

This command adds a custom attribute store named MyCustomStore.

Required Parameters

-Configuration

Specifies the initialization parameters of the attribute store, such as a connection string.

Type: Hashtable
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name

Specifies the friendly name of this attribute store.

Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-StoreType

Specifies the type of attribute store to add. The acceptable values for this parameter are:

  • ActiveDirectory
  • LDAP
  • SQL
Type: String
Parameter Sets: ActiveDirectory, LDAP, SQL
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TypeQualifiedName

Specifies the class reference for a custom attribute store that is implemented in a .NET assembly.

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

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Aliases: cf
Position: Named
Default value: False
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
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Aliases: wi
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Outputs

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.