Edit

Share via

Remove-AdfsAttributeStore

  • Reference
Module:
ADFS

Removes an attribute store from the Federation Service.

Syntax

Remove-AdfsAttributeStore
      [-TargetName] <String>
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AdfsAttributeStore
      [-TargetAttributeStore] <AttributeStore>
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AdfsAttributeStore cmdlet removes an attribute store from the Federation Service.

Examples

Example 1: Remove an attribute store

PS C:\> Remove-ADFSAttributeStore -TargetName "ContosoAttributeStore01"

This command removes the attribute store named ContosoAttributeStore01 from the Federation Service.

Parameters

-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

-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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TargetAttributeStore

Specifies an AttributeStore object. The cmdlet removes the AttributeStore object that you specify. To obtain an attribute store, use the Get-AdfsAttributeStore cmdlet.

Type:AttributeStore
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-TargetName

Specifies the name of the attribute store to remove.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
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

Microsoft.IdentityServer.PowerShell.Resources.AttributeStore

An AttributeStore object is received by the TargetName parameter.

Outputs

None or Microsoft.IdentityServer.Management.Resources.AttributeStore

Returns the removed AttributeStore object when the PassThru parameter is specified. By default, this cmdlet does not generate any output.

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.