Set-AdfsClaimDescription

Windows Server 2012 R2 and Windows 8.1

Set-AdfsClaimDescription

Modifies the properties of a claim description.

構文

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




詳細説明

The Set-AdfsClaimDescription cmdlet modifies properties on a Active Directory フェデレーション サービス (AD FS) claim description.

パラメーター

-ClaimType<String>

Specifies the claim type URI of the claim.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-IsAccepted<Boolean>

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


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-IsOffered<Boolean>

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


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-IsRequired<Boolean>

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


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Name<String>

Specifies the friendly name of the claim to modify.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Notes<String>

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


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-PassThru

作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

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.


エイリアス

なし

必須?

true

位置は?

1

既定値

なし

パイプライン入力を許可する

true (ByValue)

ワイルドカード文字を許可する

false

-TargetClaimType<String>

Specifies the claim type of the claim description to modify.


エイリアス

なし

必須?

true

位置は?

1

既定値

なし

パイプライン入力を許可する

true (ByValue)

ワイルドカード文字を許可する

false

-TargetName<String>

Specifies the friendly name of the claim description to modify.


エイリアス

なし

必須?

true

位置は?

1

既定値

なし

パイプライン入力を許可する

true (ByValue)

ワイルドカード文字を許可する

false

-Confirm

コマンドレットを実行する前に、ユーザーに確認を求めます。


必須?

false

位置は?

named

既定値

false

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-WhatIf

コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。


必須?

false

位置は?

named

既定値

false

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

  • Microsoft.IdentityServer.PowerShell.Resources.ClaimDescription



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



出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

  • None

  • 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


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"

関連トピック

コミュニティの追加

追加
表示: