Remove-ADFSAttributeStore
Remove-ADFSAttributeStore
Removes an attribute store from the Federation Service.
Syntax
Parameter Set: InputObject
Remove-ADFSAttributeStore [-TargetAttributeStore] <AttributeStore> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: Name
Remove-ADFSAttributeStore [-TargetName] <String> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-ADFSAttributeStore cmdlet removes an attribute store from the Federation Service.
Parameters
-PassThru
Passes an object to the pipeline. By default, this cmdlet does not generate any output.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-TargetAttributeStore<AttributeStore>
Specifies the attribute store to remove. This value is typically taken from the pipeline.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-TargetName<String>
Specifies the name of the attribute store to remove.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Microsoft.IdentityServer.PowerShell.Resources.AttributeStore
A class structure that represents an AD FS 2.0 attribute store object
Outputs
The output type is the type of the objects that the cmdlet emits.
- 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 create your own custom attribute store.
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
Removes an attribute store from the Federation Service.
C:\PS>Remove-ADFSAttributeStore -TargetName "My Attribute Store"