Set-AdfsClaimDescription
Set-AdfsClaimDescription
Modifies the properties of a claim description.
Syntaxe
Parameter Set: Identifier
Set-AdfsClaimDescription [-TargetClaimType] <String> [-ClaimType <String> ] [-IsAccepted <Boolean> ] [-IsOffered <Boolean> ] [-IsRequired <Boolean> ] [-Name <String> ] [-Notes <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: InputObject
Set-AdfsClaimDescription [-TargetClaimDescription] <ClaimDescription> [-ClaimType <String> ] [-IsAccepted <Boolean> ] [-IsOffered <Boolean> ] [-IsRequired <Boolean> ] [-Name <String> ] [-Notes <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: Name
Set-AdfsClaimDescription [-TargetName] <String> [-ClaimType <String> ] [-IsAccepted <Boolean> ] [-IsOffered <Boolean> ] [-IsRequired <Boolean> ] [-Name <String> ] [-Notes <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Description détaillée
The Set-AdfsClaimDescription cmdlet modifies properties on a services de fédération Active Directory (AD FS) claim description.
Paramètres
-ClaimType<String>
Specifies the claim type URI of the claim.
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 |
-IsAccepted<Boolean>
Indicates whether the claim is published in federation metadata as a claim that is accepted by the federation service.
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 |
-IsOffered<Boolean>
Indicates whether the claim is published in federation metadata as a claim that is offered by the federation service.
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 |
-IsRequired<Boolean>
Indicates whether the claim is published in federation metadata as a claim that is required by the federation service.
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 |
-Name<String>
Specifies the friendly name of the claim to modify.
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 |
-Notes<String>
Specifies text that describes the purpose of the claim description. The cmdlet adds the notes to the claim description.
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 |
-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 modifies 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 modify.
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 friendly name of the claim description to modify.
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 for representing 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
All Set-* cmdlets have a positional parameter (at position 0) with a name that starts with Target*. This parameter defines the search criteria, and the parameter set. For example, Set-ADFSRelyingParty has the parameters TargetName, TargetIdentifierUri, and TargetRelyingParty. You can use only one of these Target* parameters to identify which RelyingParty to modify. Because these parameters are positional, you do not have to specify their name. Therefore, the following commands are identical in effect. The commands change the RelyingParty object named RP1 to RP2
Set-ADFSRelyingParty -TargetName RP1Name -Name RP2Name
Set-ADFSRelyingParty RP1Name -Name RP2Name
Exemples
Example 1: Change the name of a claim description
This command changes the name of the claim description named Role to RoleDesc.
PS C:\> Set-AdfsClaimDescription -TargetName "Role" -Name "RoleDesc"