Remove-AdfsClaimDescription

Remove-AdfsClaimDescription is accessible with the help of adfs module. To install adfs on your system please refer to this adfs.

Synopsis

Removes a claim description from the Federation Service.

Description

The Remove-AdfsClaimDescription cmdlet removes a claim description from the Federation Service.

Parameters

-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-TargetClaimDescription <ClaimDescription>
    Specifies a ClaimDescription object. The cmdlet removes the ClaimDescription object that you specify. To obtain a claim description, use the Get-AdfsClaimDescription cmdlet.

    Required?                    true
    Position?                    1
    Default value                none
    Accept pipeline input?       true (ByValue)
    Accept wildcard characters?  false

-TargetClaimType <String>
    Specifies the claim type of the claim description to remove.

    Required?                    true
    Position?                    1
    Default value                none
    Accept pipeline input?       true (ByValue)
    Accept wildcard characters?  false

-TargetName <String>
    Specifies the name of the claim description to remove.

    Required?                    true
    Position?                    1
    Default value                none
    Accept pipeline input?       true (ByValue)
    Accept wildcard characters?  false

-TargetShortName <String>
    Specifies the short name ID that AD FS uses to lookup an existing claim description.

    Required?                    true
    Position?                    1
    Default value                none
    Accept pipeline input?       true(ByValue)
    Accept wildcard characters?  false

-Confirm <SwitchParameter>
    Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.

    Required?                    false
    Position?                    named
    Default value                false
    Accept pipeline input?       false
    Accept wildcard characters?  false

-WhatIf <SwitchParameter>
    Shows what would happen if the cmdlet runs. The cmdlet is not run.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

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>]

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) 2.0.

——————-Example 1——————-
Remove a claim description
PS C:> Remove- AdfsClaimDescription -TargetName “Role”
This command removes the claim description named Role.

You can check the Version, CommandType and Source of this cmdlet by giving below command.

Get-Command Remove- AdfsClaimDescription

You can also read about

To know more PowerShell cmdlets(Commands) on Active Directory Federation Services(ADFS) click here

Click on this Link for an Single place where you get all the PowerShell cmdlet sorted based on the modules.

You can also refer other blogs on PowerShell at link

You can also refer other blogs on Microsoft at link

And also if you required any technology you want to learn, let us know below we will publish them in our site http://tossolution.com/

Like our page in Facebook and follow us for New technical information.

References are taken from Microsoft