Update-AdfsRelyingPartyTrust
Update-AdfsRelyingPartyTrust
Updates the relying party trust from federation metadata.
構文
Parameter Set: Identifier
Update-AdfsRelyingPartyTrust -TargetIdentifier <String> [-MetadataFile <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: IdentifierName
Update-AdfsRelyingPartyTrust -TargetName <String> [-MetadataFile <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: IdentifierObject
Update-AdfsRelyingPartyTrust -TargetRelyingParty <RelyingPartyTrust> [-MetadataFile <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
詳細説明
The Update-AdfsRelyingPartyTrust cmdlet updates the relying party trust from the federation metadata that is available at the federation metadata URL. The cmdlet updates claims, endpoints, and certificates.
パラメーター
-MetadataFile<String>
Specifies a file path in UNC format. The file that you specify contains the federation metadata for the relying party application.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-PassThru
作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-TargetIdentifier<String>
Specifies the identifier of the relying party trust to update.
エイリアス |
なし |
必須? |
true |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
true (ByValue) |
ワイルドカード文字を許可する |
false |
-TargetName<String>
Specifies the name of the relying party trust to update.
エイリアス |
なし |
必須? |
true |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
true (ByValue) |
ワイルドカード文字を許可する |
false |
-TargetRelyingParty<RelyingPartyTrust>
Specifies a RelyingPartyTrust object. The cmdlet updates the relying party trust that you specify. To obtain a RelyingPartyTrust object, use the Get-AdfsRelyingPartyTrust cmdlet.
エイリアス |
なし |
必須? |
true |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
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.RelyingPartyTrust
A class structure that represents a relying party trust.
出力
出力型は、コマンドレットによって生成されるオブジェクトの型です。
- None
注
- A relying party in Active Directory フェデレーション サービス (AD FS) is an organization in which Web servers that host one or more Web-based applications reside. Tokens and Information Cards that originate from a claims provider can then be presented and ultimately consumed by the Web-based resources that are located in the relying party organization. When you configure AD FS in the role of the relying party, it acts as a partner that trusts a claims provider to authenticate users. Therefore, the relying party consumes the claims that are packaged in security tokens that come from users in the claims provider. In other words, a relying party is the organization whose Web servers are protected by the resource-side federation server. The federation server at the relying party uses the security tokens that the claims provider produces to issue tokens to the Web servers that are located in the relying party.
例
Example 1: Update a relying party trust
This command updates the relying party trust named FabrikamApp.
PS C:\> Update-ADFSRelyingPartyTrust -TargetName "FarikamApp"