Remove-AdfsClaimDescription

Article
11/16/2015

Remove-AdfsClaimDescription

Removes a claim description from the Federation Service.

Syntaxe

Parameter Set: Identifier
Remove-AdfsClaimDescription [-TargetClaimType] <String> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject
Remove-AdfsClaimDescription [-TargetClaimDescription] <ClaimDescription> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Name
Remove-AdfsClaimDescription [-TargetName] <String> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Description détaillée

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

Paramètres

-PassThru

Retourne un objet qui représente l’élément avec lequel vous travaillez. Par défaut, cette applet de commande ne génère aucun résultat.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	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.

Alias	none
Obligatoire ?	true
Position ?	1
Valeur par défaut	none
Accepter l’entrée de pipeline ?	true (ByValue)
Accepter les caractères génériques ?	false

-TargetClaimType<String>

Specifies the claim type of the claim description to remove.

Alias	none
Obligatoire ?	true
Position ?	1
Valeur par défaut	none
Accepter l’entrée de pipeline ?	true (ByValue)
Accepter les caractères génériques ?	false

-TargetName<String>

Specifies the name of the claim description to remove.

Alias	none
Obligatoire ?	true
Position ?	1
Valeur par défaut	none
Accepter l’entrée de pipeline ?	true (ByValue)
Accepter les caractères génériques ?	false

-Confirm

Votre confirmation sera requise avant l’exécution de l’applet de commande.

Obligatoire ?	false
Position ?	named
Valeur par défaut	false
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-WhatIf

Présente les conséquences éventuelles de l’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Obligatoire ?	false
Position ?	named
Valeur par défaut	false
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

<CommonParameters>

Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d’informations, consultez about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Entrées

Le type d’entrée correspond au type des objets que vous pouvez transmettre à l’applet de commande.

Microsoft.IdentityServer.PowerShell.Resources.ClaimDescription

A class structure that represents a claim description object for the Federation Service.

Sorties

Le type de sortie est le type des objets émis par l’applet de commande.

None

Remarques

Use claim descriptions to configure the list of claims that are available to be offered or accepted by the services de fédération Active Directory (AD FS) 2.0.

Exemples

Example 1: Remove a claim description

This command removes the claim description named Role.

PS C:\> Remove-AdfsClaimDescription -TargetName "Role"

Rubriques connexes

Add-AdfsClaimDescription

Get-AdfsClaimDescription

Set-AdfsClaimDescription

Remove-AdfsClaimDescription