Remove-AdfsAttributeStore
Removes an attribute store from the Federation Service.
Syntax
Name
Remove-AdfsAttributeStore
[-TargetName] <String>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InputObject
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | AttributeStore |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
InputObject
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetName
Specifies the name of the attribute store to remove.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Name
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
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.