Remove-AdfsClaimDescription

Remove-AdfsClaimDescription

Removes a claim description from the Federation Service.

構文

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

詳細説明

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

パラメーター

-PassThru

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

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

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

false

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

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.

エイリアス

なし

必須?

true

位置は?

1

既定値

なし

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

true (ByValue)

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

false

-TargetClaimType<String>

Specifies the claim type of the claim description to remove.

エイリアス

なし

必須?

true

位置は?

1

既定値

なし

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

true (ByValue)

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

false

-TargetName<String>

Specifies the name of the claim description to remove.

エイリアス

なし

必須?

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 (https://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

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

  • Microsoft.IdentityServer.PowerShell.Resources.ClaimDescription

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

出力

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

  • None

  • Use claim descriptions to configure the list of claims that are available to be offered or accepted by the Active Directory フェデレーション サービス (AD FS) 2.0.

Example 1: Remove a claim description

This command removes the claim description named Role.

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

関連トピック

Add-AdfsClaimDescription

Get-AdfsClaimDescription

Set-AdfsClaimDescription