description | external help file | Module Name | ms.date | online version | schema | title |
---|---|---|---|---|---|---|
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. |
Microsoft.IdentityServer.Management.dll-Help.xml |
ADFS |
12/20/2016 |
2.0.0 |
Remove-AdfsClaimDescription |
Removes a claim description from the Federation Service.
Remove-AdfsClaimDescription [-TargetName] <String> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-AdfsClaimDescription [-TargetShortName] <String> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-AdfsClaimDescription [-TargetClaimType] <String> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-AdfsClaimDescription [-TargetClaimDescription] <ClaimDescription> [-PassThru] [-WhatIf] [-Confirm]
[<CommonParameters>]
The Remove-AdfsClaimDescription cmdlet removes a claim description from the Federation Service.
PS C:\> Remove-AdfsClaimDescription -TargetName "Role"
This command removes the claim description named Role.
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a ClaimDescription object. The cmdlet removes the ClaimDescription object that you specify. To obtain a claim description, use the Get-AdfsClaimDescription cmdlet.
Type: ClaimDescription
Parameter Sets: InputObject
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Specifies the claim type of the claim description to remove.
Type: String
Parameter Sets: Identifier
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Specifies the name of the claim description to remove.
Type: String
Parameter Sets: Name
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Specifies the short name ID that AD FS uses to lookup an existing claim description.
Type: String
Parameter Sets: ShortName
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
A ClaimDescription object is received by the TargetClaimDescription parameter.
String objects are received by the TargetClaimType, TargetName, and TargetShortName parameters.
Returns the removed ClaimDescription object when the PassThru parameter is specified. By default, this cmdlet does not generate any output.
- Use claim descriptions to configure the list of claims that are available to be offered or accepted by the Active Directory Federation Services (AD FS).