Disable-AdfsClient

Disable-AdfsClient

Disables an OAuth 2.0 client that is currently registered with AD FS.

構文

Parameter Set: Name
Disable-AdfsClient [[-TargetName] <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ClientId
Disable-AdfsClient [-TargetClientId] <String> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject
Disable-AdfsClient [-TargetClient] <AdfsClient> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

詳細説明

The Disable-AdfsClient cmdlet disables an OAuth 2.0 client that is currently registered with Active Directory フェデレーション サービス (AD FS). Once you disable the client, AD FS no longer authorizes requests to access resources from that OAuth 2.0 client.

パラメーター

-PassThru

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

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

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

false

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

false

-TargetClient<AdfsClient>

Specifies the registered OAuth 2.0 client to disable.

エイリアス

なし

必須?

true

位置は?

1

既定値

なし

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

True (ByValue)

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

false

-TargetClientId<String>

Specifies the client identifier of the registered OAuth 2.0 client to disable.

エイリアス

なし

必須?

true

位置は?

1

既定値

なし

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

True (ByPropertyName)

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

false

-TargetName<String>

Specifies the name of the registered OAuth 2.0 client to disable.

エイリアス

なし

必須?

false

位置は?

1

既定値

なし

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

True (ByPropertyName)

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

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)。

入力

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

出力

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

Example 1: Disable an OAuth 2.0 client

This command disables the OAuth 2.0 client that is currently registered with AD FS.

PS C:\> Disable-AdfsClient -TargetName "Payroll Application"

関連トピック

Add-AdfsClient

Enable-AdfsClient

Get-AdfsClient

Remove-AdfsClient

Set-AdfsClient