Edit

Add-ADFSAttributeStore

  • Reference
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 --------------------------

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

Description

Adds a SQL-based attribute store named LocalSqlStore.

-------------------------- EXAMPLE 2 --------------------------

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

Description

Adds a custom attribute store named MyCustomStore.

Parameters

-Configuration

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

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-Name

Specifies the friendly name of this attribute store.

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

-PassThru

Passes an object to the pipeline. By default, this cmdlet does not generate any output.

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

-StoreType

Specifies the type of attribute store to add. Valid values are ActiveDirectory, LDAP, and SQL.

Type:String
Accepted values:ActiveDirectory, LDAP, SQL
Position:Named
Default value:None
Required:True
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
Required:True
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

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.