Share via

Add-ADFSAttributeStore

  • Article

Add-ADFSAttributeStore

Adds an attribute store to the Federation Service.

Syntax

Add-ADFSAttributeStore -Configuration <hashtable> -Name <string> -TypeQualifiedName <string> [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]

  • Configuration

  • Name

  • TypeQualifiedName

  • PassThru

  • Confirm

  • WhatIf

    Add-ADFSAttributeStore -Configuration -Name -StoreType [-PassThru] [-Confirm] [-WhatIf] []

  • Configuration

  • Name

  • StoreType

  • PassThru

  • Confirm

  • WhatIf

Detailed Description

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

Parameters

Configuration

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

Default Value: **

Data Type: hashtable

Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Name

Specifies the friendly name of this attribute store.

Default Value: **

Data Type: string

Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

PassThru

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

Default Value: **

Data Type: SwitchParameter

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

StoreType

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

Default Value: **

Data Type: string

Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

TypeQualifiedName

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

Default Value: **

Data Type: string

Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Confirm

Prompts you for confirmation before executing the command.

Default Value: **

Data Type: SwitchParameter

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

true

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

WhatIf

Describes what would happen if you executed the command without actually executing the command.

Default Value: **

Data Type: SwitchParameter

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

true

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Input Type

None

Return Type

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

Command Prompt: 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 --------------------------

Command Prompt: 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.

See Also

Reference

Get-ADFSAttributeStore
Remove-ADFSAttributeStore
Set-ADFSAttributeStore

Other Resources

Online version: