Set-SPSecurityTokenServiceConfig

SharePoint セキュリティ トークン サービス (STS) ID プロバイダーの設定を更新します。

構文

Set-SPSecurityTokenServiceConfig
   -QueueSigningCertificateThumbprint <String>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-FormsTokenLifetime <Int32>]
   [-MaxLogonTokenCacheItems <Int32>]
   [-MaxServiceTokenCacheItems <Int32>]
   [-QueueSigningCertificateStoreName <String>]
   [-ServiceTokenCacheExpirationWindow <Int32>]
   [-ServiceTokenLifetime <Int32>]
   [-WhatIf]
   [-WindowsTokenLifetime <Int32>]
   [<CommonParameters>]
Set-SPSecurityTokenServiceConfig
   -RevokeSigningCertificateThumbprint <String>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-FormsTokenLifetime <Int32>]
   [-MaxLogonTokenCacheItems <Int32>]
   [-MaxServiceTokenCacheItems <Int32>]
   [-RevokeSigningCertificateStoreName <String>]
   [-ServiceTokenCacheExpirationWindow <Int32>]
   [-ServiceTokenLifetime <Int32>]
   [-WhatIf]
   [-WindowsTokenLifetime <Int32>]
   [<CommonParameters>]
Set-SPSecurityTokenServiceConfig
   -SigningCertificateThumbprint <String>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-FormsTokenLifetime <Int32>]
   [-MaxLogonTokenCacheItems <Int32>]
   [-MaxServiceTokenCacheItems <Int32>]
   [-ServiceTokenCacheExpirationWindow <Int32>]
   [-ServiceTokenLifetime <Int32>]
   [-SigningCertificateStoreName <String>]
   [-WhatIf]
   [-WindowsTokenLifetime <Int32>]
   [-QueueSigningCertificateThumbprint <String>]
   [-QueueSigningCertificateStoreName <String>]
   [<CommonParameters>]
Set-SPSecurityTokenServiceConfig
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-FormsTokenLifetime <Int32>]
   [-ImportSigningCertificate <X509Certificate2>]
   [-MaxLogonTokenCacheItems <Int32>]
   [-MaxServiceTokenCacheItems <Int32>]
   [-ServiceTokenCacheExpirationWindow <Int32>]
   [-ServiceTokenLifetime <Int32>]
   [-WhatIf]
   [-WindowsTokenLifetime <Int32>]
   [<CommonParameters>]
Set-SPSecurityTokenServiceConfig
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-FormsTokenLifetime <Int32>]
   [-MaxLogonTokenCacheItems <Int32>]
   [-MaxServiceTokenCacheItems <Int32>]
   [-QueueSigningCertificate <X509Certificate2>]
   [-ServiceTokenCacheExpirationWindow <Int32>]
   [-ServiceTokenLifetime <Int32>]
   [-WhatIf]
   [-WindowsTokenLifetime <Int32>]
   [<CommonParameters>]
Set-SPSecurityTokenServiceConfig
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-FormsTokenLifetime <Int32>]
   [-MaxLogonTokenCacheItems <Int32>]
   [-MaxServiceTokenCacheItems <Int32>]
   [-RevokeSigningCertificate <X509Certificate2>]
   [-ServiceTokenCacheExpirationWindow <Int32>]
   [-ServiceTokenLifetime <Int32>]
   [-WhatIf]
   [-WindowsTokenLifetime <Int32>]
   [<CommonParameters>]

説明

このコマンドレットには、複数のパラメーター セットが含まれています。 使用できるのは、1 つのパラメーター セットのパラメーターだけであり、異なるパラメーター セットのパラメーターを組み合わせることはできません。 パラメーター セットの使用法に関する詳しい情報については、「コマンドレットのパラメーター セット」を参照してください。

コマンドレットは Set-SPSecurityTokenServiceConfig 、SharePoint セキュリティ トークン サービス (STS) ID プロバイダーの設定を更新します。 証明書ファイルを使用する場合、証明書は秘密キーを持つ X509 証明書である必要があります。それ以外の場合は例外が発生します。

このコマンドレットはエクスポート可能な証明書のみで動作します。 このコマンドレットで使用可能な証明書を作成するには、x509Certificate2 オブジェクト コンストラクターの keyStorageFlagsパラメーターで X509KeyStorageFlags.Exportable ビットを指定します。

Windows PowerShell for SharePoint 製品のアクセス許可と最新情報については、「SharePoint Server コマンドレット」のオンライン ドキュメントをご覧ください。

--------------------例 1---------------------

Set-SPSecurityTokenServiceConfig -SigningCertificateThumbprint "2796BAE63F1801E277261BA0D77770028F20EEE4"

この例では、SharePoint セキュリティ トークン サービス (STS) ID プロバイダーの署名証明書を、証明書ストアに展開されている証明書で更新します。

-------------------- 例 2 ---------------------

$stsCert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2 "c:\sts.pfx","a",20
Set-SPSecurityTokenServiceConfig -ImportSigningCertificate $stsCert

この例では、SharePoint STS ID プロバイダー用の署名証明書をインポートします。

パラメーター

-AssignmentCollection

適切な破棄を行うためにオブジェクトを管理します。 SPWeb や SPSite などのオブジェクトの使用によって大量のメモリが使用される場合があるので、Windows PowerShell スクリプトでこれらのオブジェクトを使用するには適切なメモリ管理が必要です。 メモリの解放が必要になった場合は、SPAssignment オブジェクトを使用して、変数へのオブジェクトの割り当てとオブジェクトの破棄を行うことができます。 割り当てコレクションまたは Global パラメーターが使用されていない場合、SPWeb、SPSite、または SPSiteAdministration オブジェクトが使用されていると、オブジェクトは自動的に破棄されます。

Global パラメーターが使用されている場合は、オブジェクトはすべてグローバル ストアに格納されます。 Stop-SPAssignment コマンドを使用してオブジェクトの使用または破棄を直接行わないと、メモリ不足のシナリオになる場合があります。

Type:SPAssignmentCollection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Confirm

コマンドを実行する前に確認メッセージを表示します。 詳細については、次のコマンドを入力します。get-help about_commonparameters

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-FormsTokenLifetime

ASP.NET メンバーシップ プロバイダーおよびロール プロバイダーに発行されたトークンの有効期限を分単位で指定します。 既定値は 1380 です。

この型は、有効な整数であることが必要です。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-ImportSigningCertificate

信頼できる認証プロバイダー ファームの X.509 証明書オブジェクトを指定します。

この型は、有効な X.509 証明書の名前 (Certificate1 など) であることが必要です。

Type:X509Certificate2
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-MaxLogonTokenCacheItems

メモリ内のログオン トークン キャッシュ エントリの最大数を指定します。 既定値は 250 エントリです。

この型は、有効な整数であることが必要です。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-MaxServiceTokenCacheItems

メモリ内のサービス トークン キャッシュ エントリの最大数を指定します。 既定値は 250 エントリです。

この型は、有効な整数であることが必要です。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-QueueSigningCertificate

提供されている証明書を、キューに入っている署名証明書として設定します。

Type:X509Certificate2
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-QueueSigningCertificateStoreName

キューに入っている拇印が押された署名証明書として設定する証明書を探すときに検索対象となるストア。 QueueSigningCertificateThumbprint が指定された場合に必要です。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-QueueSigningCertificateThumbprint

拇印が押してある証明書を、キューに入っている署名証明書として設定します。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-RevokeSigningCertificate

提供されている証明書と一致する署名証明書を取り消します。

Type:X509Certificate2
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-RevokeSigningCertificateStoreName

拇印によって取り消される証明書を探すときに検索対象となるストア。 QueueSigningCertificateThumbprint が指定された場合に必要です。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-RevokeSigningCertificateThumbprint

指定された拇印を使用して署名証明書を取り消します。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-ServiceTokenCacheExpirationWindow

キャッシュ内のトークンを自動的に更新する間隔を分単位で指定します。 既定値は 2 分です。

この型は、有効な整数であることが必要です。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-ServiceTokenLifetime

セキュリティ トークン サービス キャッシュの有効期限を分単位で指定します。 既定値は 15 分です。

この型は、有効な整数であることが必要です。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-SigningCertificateStoreName

署名証明書が存在する証明書ストアを指定します。 ID プロバイダーの ID ストアは SQL データベース テーブル、Active Directory ドメイン サービス (AD DS)、または Active Directory Lightweight Directory Service (AD LDS) です。

この型は、署名証明書ストアの有効な ID (IdentityStore1 など) であることが必要です。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-SigningCertificateThumbprint

署名証明書の拇印を指定します。

この型は、署名証明書の有効な ID (2796BAE63F1801E277261BA0D77770028F20EEE4 など) であることが必要です。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-WhatIf

コマンドを実行する代わりに、コマンドの実行結果を説明するメッセージを表示します。 詳細については、次のコマンドを入力します。get-help about_commonparameters

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-WindowsTokenLifetime

Windows ユーザーに発行されたトークンの有効期限を分単位で指定します。 既定値は 1380 分です。

この型は、有効な整数であることが必要です。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019