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>]
Description
您可以使用此 Cmdlet 來設定或停用 SharePoint Online 中的預先驗證功能。 停用可與參數結合,以支援租用戶層級特定應用程式和功能的細微預先驗證管理。
注意事項
什麼是預先驗證?
SharePoint 在稱為預先驗證 URL 的 URL 中包含自我發行的令牌, (也稱為範本 URL) ,以提供 SharePoint 資源的暫時存取權,這有助於支援更豐富的用戶體驗。 例如,常見的案例是使用在查詢參數中 tempauth
包含令牌的 URL 來下載檔案,如下所示:
https://<tenant>.sharepoint.com/sites/samplesite/_layouts/15/download.aspx?UniqueId=<id>&tempauth=v1.ey...
但這項功能目前已被取代,因此此 Cmdlet 可讓您控制在各種使用案例中使用預先驗證。
重要事項
這些設定會利用優先順序的順序:
- Deny
- 允許
- IsDisabled
此外,由於使用此 Cmdlet 可以停用 SharePoint Online 租使用者中的功能, 強烈建議 您在生產環境中進行變更之前,先測試並評估測試租使用者中的每個變更。
您必須是 SharePoint 系統管理員才能執行 Cmdlet。
範例
範例 1
Set-SPOTenantPreAuthSettings -IsDisabled $true
Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e"
此範例會整體停用預先驗證,並新增可讓兩個應用程式對所有功能使用預先驗證的設定。
範例 2
Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e" -ExcludedApps "" -IncludedFeatures "" -ExcludedFeatures ""
這個範例會執行與範例 1 相同的函式,但在此案例中, 和 -ExcludedFeatures
的-IncludedFeatures
-ExcludedApps
參數會新增至 Cmdlet。
如果未搭配 Cmdlet 使用,則會假設這些參數採用的預設值 ""
,而範例 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"
此範例會整體停用預先驗證,並允許除了一個 以外的所有應用程式針對和 "WebRenderingEmbed"
以外的"Download"
所有功能使用預先驗證。
在此情況下,一律會拒絕應用程式 "029e7c27-4b9c-4f8b-ba32-b96249468d42"
使用預先驗證,因為它會從允許清單設定中排除。 除了和 "WebRenderingEmbed"
之外"Download"
,任何其他應用程式都可對任何功能使用預先驗證。
範例 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"
此範例會整體停用預先驗證,但包含 [允許] 清單和 [拒絕] 列表中設定之間的重疊。 它首先允許應用程式使用、 "WebRenderingEmbed"
和 "Download"
功能的"OfficeOnline"
預先驗證。 但在 Cmdlet 的最終執行中,它會拒絕相同的應用程式對所有功能使用預先驗證。
在此情況下,即使有 設定,還是不允許應用程式 "029e7c27-4b9c-4f8b-ba32-b96249468d42"
對任何允許列出的功能使用預先驗證。 這是因為 [拒絕] 列表優先於 [允許] 列表。
範例 6
Set-SPOTenantPreAuthSettings -IsDisabled $false
Set-SPOTenantPreAuthSettings -Add -Type Deny -IncludedApps "Empty"
此範例會啟用整體預先驗證,並拒絕不是來自應用程式的要求 (例如,透過瀏覽器) 要求來自使用所有功能的預先驗證。
注意事項
或 -ExcludedApps
的"Empty"
-IncludedApps
值與空字串不同""
。 規則如下所示:
-
"Empty"
代表不是來自應用程式的任何要求 (例如來自瀏覽器) 的直接要求,而且不會有與其相關聯的應用程式標識碼 -
""
可能代表幾件事:- 如果您有
-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
此參數會指定 Cmdlet 的作業是將設定新增至允許清單或拒絕清單。
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | False |
接受萬用字元: | False |
-ExcludedApps
此參數值包含要在範圍內設定的應用程式識別 -ExcludedApps
碼。 可能的值包括: ""
、 "Empty"
或以逗號分隔的應用程式識別符清單。
類型: | String |
Position: | Named |
預設值: | "" |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-ExcludedFeatures
此參數值包含要在範圍內設定的 -ExcludedFeatures
功能名稱。 可能的值包括: ""
或以逗號分隔的功能名稱清單, (請參閱下) 的附注一節。
類型: | String |
Position: | Named |
預設值: | "" |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-Id
此參數會識別要從目前組態中移除的清單項目設定。 只有參數才需要 -Remove
此參數。
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | False |
接受萬用字元: | False |
-IncludedApps
此參數值包含要在範圍內設定的 -IncludedApps
應用程式識別碼。 可能的值包括: ""
、 "Empty"
或以逗號分隔的應用程式識別符清單。
類型: | String |
Position: | Named |
預設值: | "" |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-IncludedFeatures
此參數值包含要在範圍內設定的 -IncludedFeatures
功能名稱。 可能的值包括: ""
或以逗號分隔的功能名稱清單, (請參閱下) 的附注一節。
類型: | String |
Position: | Named |
預設值: | "" |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-IsDisabled
此參數可讓系統管理員切換所有應用程式和功能的預先驗證,以啟用或停用。
類型: | Boolean |
Position: | Named |
預設值: | False |
必要: | True |
接受管線輸入: | False |
接受萬用字元: | False |
-Remove
此參數會指定 Cmdlet 的作業是從允許清單或拒絕清單中移除設定。
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | False |
接受萬用字元: | False |
-Type
此參數會指出 Cmdlet 是否正在與允許清單或拒絕清單互動。
類型: | TenantPreAuthSettingsListType |
接受的值: | Allow, Deny |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | False |
接受萬用字元: | False |
輸入
None
輸出
System.Object
備註
和 -ExcludedFeatures
會-IncludedFeatures
使用下表中的功能名稱。 如果透過PowerShell Cmdlet停用功能,則會明確提及該功能是否會中斷。
功能名稱 | 描述 | 其他資訊 |
---|---|---|
DataFormWebpart | DataFormWebParts 用來顯示/與 SharePoint 數據互動的案例。 | DataFormWebPart 属性 (Microsoft.SharePoint.WebPartPages) - Microsoft Learn |
下載 | 取得預先驗證下載 URL 的案例。 第三方應用程式和部分第一方應用程式可能會中斷。 | Microsoft 身分識別平台 上的 OAuth 2.0 和 OpenID Connect 通訊協定 - Microsoft Learn |
OfficeOnline | Office 網頁版 案例。 效能可能會受到影響。 | |
SearchPreview | 產生搜尋查詢結果預覽/縮圖/轉換的相關案例。 體驗可能會中斷。 | |
SharePointConnector | 與 SharePoint 連接器相關的案例 | SharePoint 連接器 - Microsoft Learn |
縮圖 | 取得預先驗證縮圖產生 URL 的案例。 | |
UploadSession | 建立上傳會話的案例。 第三方應用程式和部分第一方應用程式可能會中斷 | |
影片 | 在 SharePoint 上裝載的播放視訊可能會中斷 | |
WebRendering | 在瀏覽器中轉譯檔案預覽的案例。 | |
WebRenderingEmbed | 將 SharePoint 檔案內嵌在另一個應用程式中。 第三方應用程式和部分第一方應用程式可能會中斷 | 內嵌網頁元件 |
Whiteboard | 匿名和來賓使用者的 Teams 與 Whiteboard 應用程式整合將會中斷。 | 在 Teams 會議中使用 Whiteboard - Microsoft 支援服務 |