編集

次の方法で共有

Set-AdfsClaimDescription

Module:
ADFS Module

Modifies the properties of a claim description.

Syntax

Name 

Set-AdfsClaimDescription
    [-TargetName] <String>
    [-IsAccepted <Boolean>]
    [-IsOffered <Boolean>]
    [-IsRequired <Boolean>]
    [-Notes <String>]
    [-Name <String>]
    [-ClaimType <String>]
    [-ShortName <String>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ShortName 

Set-AdfsClaimDescription
    [-TargetShortName] <String>
    [-IsAccepted <Boolean>]
    [-IsOffered <Boolean>]
    [-IsRequired <Boolean>]
    [-Notes <String>]
    [-Name <String>]
    [-ClaimType <String>]
    [-ShortName <String>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Identifier 

Set-AdfsClaimDescription
    [-TargetClaimType] <String>
    [-IsAccepted <Boolean>]
    [-IsOffered <Boolean>]
    [-IsRequired <Boolean>]
    [-Notes <String>]
    [-Name <String>]
    [-ClaimType <String>]
    [-ShortName <String>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InputObject 

Set-AdfsClaimDescription
    [-TargetClaimDescription] <ClaimDescription>
    [-IsAccepted <Boolean>]
    [-IsOffered <Boolean>]
    [-IsRequired <Boolean>]
    [-Notes <String>]
    [-Name <String>]
    [-ClaimType <String>]
    [-ShortName <String>]
    [-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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IsAccepted

Indicates whether the claim is published in federation metadata as a claim that is accepted by the Federation Service.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IsOffered

Indicates whether the claim is published in federation metadata as a claim that is offered by the Federation Service.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IsRequired

Indicates whether the claim is published in federation metadata as a claim that is required by the Federation Service.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the friendly name of the claim to modify.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Notes

Specifies text that describes the purpose of the claim description. The cmdlet adds the notes to the claim description.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ShortName

Specifies the unique short name identifier for the claim description that is used for issuing and consuming JWT tokens.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:ClaimDescription
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

InputObject
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-TargetClaimType

Specifies the claim type of the claim description to modify.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Identifier
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-TargetName

Specifies the friendly name of the claim description to modify.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Name
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-TargetShortName

Specifies the short name identifier that AD FS uses to lookup an existing claim description.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ShortName
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.IdentityServer.PowerShell.Resources.ClaimDescription

A ClaimDescription object is received by the TargetClaimDescription parameter.

String

String objects are received by the TargetClaimType, TargetName, and TargetShortName parameters.

Outputs

Microsoft.IdentityServer.PowerShell.Resources.ClaimDescription

Returns the updated ClaimDescription object when the PassThru parameter is specified. By default, this cmdlet does not generate any output.

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