Remove-AdfsClaimDescription
Removes a claim description from the Federation Service.
Syntax
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>]
Description
The Remove-AdfsClaimDescription cmdlet removes a claim description from the Federation Service.
Examples
Example 1: Remove a claim description
PS C:\> Remove-AdfsClaimDescription -TargetName "Role"
This command removes the claim description named Role.
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 |
-TargetClaimDescription
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 |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TargetClaimType
Specifies the claim type of the claim description to remove.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TargetName
Specifies the name of the claim description to remove.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TargetShortName
Specifies the short name ID that AD FS uses to lookup an existing claim description.
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.ClaimDescription
A ClaimDescription object is received by the TargetClaimDescription parameter.
String objects are received by the TargetClaimType, TargetName, and TargetShortName parameters.
Outputs
Microsoft.IdentityServer.PowerShell.Resources.ClaimDescription
Returns the removed ClaimDescription object when the PassThru parameter is specified. By default, this cmdlet does not generate any output.
None
Notes
- 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).
Related Links
Saran dan Komentar
https://aka.ms/ContentUserFeedback.
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat:Kirim dan lihat umpan balik untuk