Set-AdfsClaimDescription
Modifies the properties of a claim description.
Syntax
Set-AdfsClaimDescription
[-IsAccepted <Boolean>]
[-IsOffered <Boolean>]
[-IsRequired <Boolean>]
[-Notes <String>]
[-Name <String>]
[-ClaimType <String>]
[-ShortName <String>]
[-TargetName] <String>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AdfsClaimDescription
[-IsAccepted <Boolean>]
[-IsOffered <Boolean>]
[-IsRequired <Boolean>]
[-Notes <String>]
[-Name <String>]
[-ClaimType <String>]
[-ShortName <String>]
[-TargetShortName] <String>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AdfsClaimDescription
[-IsAccepted <Boolean>]
[-IsOffered <Boolean>]
[-IsRequired <Boolean>]
[-Notes <String>]
[-Name <String>]
[-ClaimType <String>]
[-ShortName <String>]
[-TargetClaimType] <String>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AdfsClaimDescription
[-IsAccepted <Boolean>]
[-IsOffered <Boolean>]
[-IsRequired <Boolean>]
[-Notes <String>]
[-Name <String>]
[-ClaimType <String>]
[-ShortName <String>]
[-TargetClaimDescription] <ClaimDescription>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-AdfsClaimDescription cmdlet modifies properties on a Active Directory Federation Services (AD FS) claim description.
Examples
Example 1: Change the name of a claim description
PS C:\> Set-AdfsClaimDescription -TargetName "Role" -Name "RoleDesc"
This command changes the name of the claim description named Role to RoleDesc.
Parameters
-ClaimType
Specifies the claim type URI of the claim.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-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 |
-IsAccepted
Indicates whether the claim is published in federation metadata as a claim that is accepted by the federation service.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IsOffered
Indicates whether the claim is published in federation metadata as a claim that is offered by the federation service.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IsRequired
Indicates whether the claim is published in federation metadata as a claim that is required by the federation service.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Specifies the friendly name of the claim to modify.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Notes
Specifies text that describes the purpose of the claim description. The cmdlet adds the notes to the claim description.
Type: | String |
Position: | Named |
Default value: | None |
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 |
-ShortName
{{Fill ShortName Description}}
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TargetClaimDescription
Specifies a ClaimDescription object. The cmdlet modifies 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 modify.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TargetName
Specifies the friendly name of the claim description to modify.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TargetShortName
{{Fill TargetShortName 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 class structure for representing a claim description object for the Federation Service.
Outputs
None
Notes
- 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
Related Links
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for