Set-SPOTenantPreAuthSettings
事前認証の構成を設定します。
構文
Set-SPOTenantPreAuthSettings
-IsDisabled <Boolean>
[<CommonParameters>] Set-SPOTenantPreAuthSettings
[-Add]
-Type <TenantPreAuthSettingsListType>
[-IncludedApps <String>]
[-ExcludedApps <String>]
[-IncludedFeatures <String>]
[-ExcludedFeatures <String>]
[<CommonParameters>] Set-SPOTenantPreAuthSettings
[-Remove]
-Id <String>
[<CommonParameters>] 説明
このコマンドレットを使用して、SharePoint Online 内で事前認証機能を構成または無効にすることができます。 無効化をスイッチと組み合わせて、テナント レベルで特定のアプリと機能の詳細な事前認証管理をサポートできます。
注:
事前認証とは
SharePoint には、事前認証 URL (一時認証 URL とも呼ばれます) と呼ばれる URL に自己発行トークンが含まれており、SharePoint リソースへの一時的なアクセスを提供するため、より豊富なユーザー エクスペリエンスをサポートできます。 たとえば、一般的なシナリオは、次のような tempauth クエリ パラメーターにトークンを含む URL を使用してファイルをダウンロードすることです。
https://<tenant>.sharepoint.com/sites/samplesite/_layouts/15/download.aspx?UniqueId=<id>&tempauth=v1.ey...
ただし、この機能は現在非推奨になっているため、このコマンドレットを使用すると、さまざまなユース ケースでの事前認証の使用を制御できます。
重要
この設定では、優先順位が利用されます。
- 拒否
- 許可
- IsDisabled
さらに、このコマンドレットを使用すると SharePoint Online テナントの機能を無効にできるため、運用環境で変更を加える前に、テスト テナントの各変更をテストして評価 することを強くお勧めします 。
コマンドレットを実行するには、SharePoint 管理者である必要があります。
例
例 1
Set-SPOTenantPreAuthSettings -IsDisabled $true
Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e"この例では、事前認証全体を無効にし、2 つのアプリですべての機能に事前認証を使用できるようにする設定を追加します。
例 2
Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e" -ExcludedApps "" -IncludedFeatures "" -ExcludedFeatures ""この例では、例 1 と同じ関数を実行しますが、この場合、 -ExcludedApps、 -IncludedFeatures、および -ExcludedFeatures のスイッチがコマンドレットに追加されます。
これらのスイッチは、コマンドレットで使用されていない場合は "" の既定値を使用すると想定され、例 2 はスイッチの完全なセットのみを示すために使用されます。
例 3
Set-SPOTenantPreAuthSettings -Remove -Id "368dde6f-c857-4383-a8a7-02a04a294e6d"この例では、項目の現在のリストから既存の項目を削除します。 削除スイッチは、許可または拒否エントリを一覧から削除できます。
例 4
Set-SPOTenantPreAuthSettings -IsDisabled $true
Set-SPOTenantPreAuthSettings -Add -Type Allow -ExcludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42" -ExcludedFeatures "Download,WebRenderingEmbed"この例では、事前認証全体を無効にし、1 つ以外のすべてのアプリで、 "Download" と "WebRenderingEmbed"を除くすべての機能に事前認証を使用できるようにします。
この場合、アプリ "029e7c27-4b9c-4f8b-ba32-b96249468d42" は許可リスト設定から除外されるため、事前認証の使用は常に拒否されます。 その他のアプリは、 "Download" や "WebRenderingEmbed"以外の機能に対して事前認証を使用できます。
例 5
Set-SPOTenantPreAuthSettings -IsDisabled $true
Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42" -IncludedFeatures "OfficeOnline,WebRenderingEmbed,Download"
Set-SPOTenantPreAuthSettings -Add -Type Deny -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e"この例では、事前認証全体を無効にしますが、[許可] リストと [拒否] リストの設定の重複が含まれています。 最初に、アプリが "OfficeOnline"、 "WebRenderingEmbed"、および "Download" 機能に事前認証を使用できるようにします。 ただし、コマンドレットの最終的な実行では、同じアプリがすべての機能に事前認証を使用することは拒否されます。
この場合、アプリ "029e7c27-4b9c-4f8b-ba32-b96249468d42" は、設定があるにもかかわらず、許可されている機能に対して事前認証を使用することは許可されません。 これは、[拒否] リストが [許可] リストよりも優先されるためです。
例 6
Set-SPOTenantPreAuthSettings -IsDisabled $false
Set-SPOTenantPreAuthSettings -Add -Type Deny -IncludedApps "Empty"この例では、全体的な事前認証を有効にし、アプリから送信されていない要求 (ブラウザー経由の要求など) がすべての機能に対して事前認証を使用することを拒否します。
注:
-IncludedAppsまたは-ExcludedAppsの"Empty"値は、空の文字列""とは異なります。 規則は次のとおりです。
-
"Empty"は、アプリから送信されていない要求 (ブラウザーからの直接要求など) を表し、アプリ ID が関連付けられていないことを表します。 -
""は、いくつかのことを意味する可能性があります。-
-IncludedApps "" -ExcludedApps ""がある場合は、設定がすべてに適用されることを意味します -
-IncludedApps "" -ExcludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42"がある場合は、"029e7c27-4b9c-4f8b-ba32-b96249468d42"とは別にすべてのアプリに設定が適用されることを意味します。 -
-IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42" and -ExcludedApps ""がある場合は、設定がアプリにのみ適用されることを意味します"029e7c27-4b9c-4f8b-ba32-b96249468d42" - を使用して設定することはできません。
-IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42" -ExcludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42"
-
パラメーター
-Add
このパラメーターは、コマンドレットの操作が許可リストまたは拒否リストに設定を追加することを指定します。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ExcludedApps
このパラメーター値には、 -ExcludedApps スコープ内で構成するアプリ ID が含まれています。 使用可能な値は、 ""、 "Empty"、またはアプリ ID のコンマ区切りのリストです。
| 型: | String |
| 配置: | Named |
| 規定値: | "" |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ExcludedFeatures
このパラメーター値には、 -ExcludedFeatures スコープ内で構成する機能名が含まれています。 使用可能な値は、 "" または機能名のコンマ区切りの一覧です (下記の「NOTES」セクションを参照)。
| 型: | String |
| 配置: | Named |
| 規定値: | "" |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Id
このパラメーターは、現在の構成から削除するリスト アイテム設定を識別します。
-Remove パラメーターでのみ必要です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-IncludedApps
このパラメーター値には、 -IncludedApps スコープ内で構成するアプリ ID が含まれています。 使用可能な値は、 ""、 "Empty"、またはアプリ ID のコンマ区切りのリストです。
| 型: | String |
| 配置: | Named |
| 規定値: | "" |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-IncludedFeatures
このパラメーター値には、 -IncludedFeatures スコープ内で構成する機能名が含まれています。 使用可能な値は、 "" または機能名のコンマ区切りの一覧です (下記の「NOTES」セクションを参照)。
| 型: | String |
| 配置: | Named |
| 規定値: | "" |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-IsDisabled
このパラメーターを使用すると、管理者はすべてのアプリと機能の事前認証を有効または無効に切り替えることができます。
| 型: | Boolean |
| 配置: | Named |
| 規定値: | False |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Remove
このパラメーターは、コマンドレットの操作が許可リストまたは拒否リストから設定を削除することを指定します。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Type
このパラメーターは、コマンドレットが許可リストと対話しているか、拒否リストと対話しているかを示します。
| 型: | TenantPreAuthSettingsListType |
| 指定可能な値: | Allow, Deny |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
入力
None
出力
System.Object
メモ
-IncludedFeaturesと-ExcludedFeaturesでは、次の表の機能名を使用します。 PowerShell コマンドレットを使用して機能が無効になっている場合に機能が壊れるかどうかを明示的に示します。
| 機能名 | 説明 | その他の情報 |
|---|---|---|
| DataFormWebpart | SharePoint データを表示または操作するための DataFormWebParts に関連するシナリオ。 | DataFormWebPart プロパティ (Microsoft.SharePoint.WebPartPages) - Microsoft Learn |
| ダウンロード | 事前認証されたダウンロード URL を取得するためのシナリオ。 サードパーティアプリケーションと一部のファーストパーティアプリケーションが壊れている可能性があります。 | Microsoft ID プラットフォームの OAuth 2.0 プロトコルと OpenID Connect プロトコル - Microsoft Learn |
| OfficeOnline | Office on the webシナリオ。 パフォーマンスが影響を受ける可能性があります。 | |
| SearchPreview | 検索クエリ結果のプレビュー/サムネイル/変換の生成に関連するシナリオ。 エクスペリエンスが壊れている可能性があります。 | |
| SharePointConnector | SharePoint コネクタに関連するシナリオ | SharePoint コネクタ - Microsoft Learn |
| サムネイル | 事前認証されたサムネイル生成 URL を取得するためのシナリオ。 | |
| UploadSession | アップロード セッションを作成するためのシナリオ。 サードパーティアプリケーションと一部のファーストパーティアプリケーションが壊れている可能性がある | |
| ビデオ | SharePoint でホストされているビデオの再生が壊れている可能性がある | |
| WebRendering | ブラウザーでファイルのプレビューをレンダリングするためのシナリオ。 | |
| WebRenderingEmbed | SharePoint ファイルを別のアプリケーションに埋め込む。 サードパーティアプリケーションと一部のファーストパーティアプリケーションが壊れている可能性がある | Web パーツを埋め込む |
| Whiteboard | Whiteboard アプリとの Teams の統合は、匿名ユーザーとゲスト ユーザーに対して破損します。 | Teams 会議でWhiteboardを使用する - Microsoft サポート |