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>] 说明
可以使用此 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 允许你在各种用例中控制预身份验证的使用。
重要
这些设置利用优先级顺序：
- 拒绝
- 允许
- 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 相同的功能，但在这种情况下， -IncludedFeatures和 -ExcludedFeatures 的-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"此示例在整体上禁用预身份验证，并允许除 和 之外"Download""WebRenderingEmbed"的所有应用使用预身份验证。
在这种情况下，应用 "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"此示例全面禁用预身份验证，但包含“允许”列表和“拒绝”列表中的设置之间的重叠。 它首先允许应用对 "OfficeOnline"、 "WebRenderingEmbed"和 "Download" 功能使用预身份验证。 但在 cmdlet 的最终执行中，它拒绝同一应用对所有功能使用预身份验证。
在这种情况下，尽管具有 设置，但不允许应用 "029e7c27-4b9c-4f8b-ba32-b96249468d42" 对任何允许列出的功能使用预身份验证。 这是因为“拒绝”列表优先于“允许”列表。
示例 6
Set-SPOTenantPreAuthSettings -IsDisabled $false
Set-SPOTenantPreAuthSettings -Add -Type Deny -IncludedApps "Empty"此示例全面启用预身份验证，并拒绝来自应用 (的请求，例如，通过浏览器传入的请求) 对所有功能使用预身份验证。
注意
"Empty"或 -ExcludedApps 的值-IncludedApps不同于空字符串 ""。 规则如下：
-
"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
此参数指定 cmdlet 的作是向允许列表或拒绝列表添加设置。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | False |
| 接受通配符: | False |
-ExcludedApps
此参数值包含要在范围内 -ExcludedApps 配置的应用 ID。 可能的值包括： ""、 "Empty"或以逗号分隔的应用 ID 列表。
| 类型: | String |
| Position: | Named |
| 默认值: | "" |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-ExcludedFeatures
此参数值包含要在范围内 -ExcludedFeatures 配置的功能名称。 可能的值包括： "" 或以逗号分隔的特征名称列表， (请参阅) 下面的 NOTES 部分。
| 类型: | String |
| Position: | Named |
| 默认值: | "" |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-Id
此参数标识要从当前配置中删除的列表项设置。 只有 参数 -Remove 才需要它。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | False |
| 接受通配符: | False |
-IncludedApps
此参数值包含要在范围内 -IncludedApps 配置的应用 ID。 可能的值包括： ""、 "Empty"或以逗号分隔的应用 ID 列表。
| 类型: | String |
| Position: | Named |
| 默认值: | "" |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-IncludedFeatures
此参数值包含要在范围内 -IncludedFeatures 配置的功能名称。 可能的值包括： "" 或以逗号分隔的特征名称列表， (请参阅) 下面的 NOTES 部分。
| 类型: | 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
备注
-IncludedFeatures和 -ExcludedFeatures 使用下表中的特征名称。 它明确提到如果通过 PowerShell cmdlet 禁用该功能，该功能是否会中断。
| 功能名称 | 说明 | 其他信息 |
|---|---|---|
| DataFormWebpart | DataFormWebParts 涉及的方案，用于显示 SharePoint 数据/与 SharePoint 数据交互。 | DataFormWebPart 属性 (Microsoft.SharePoint.WebPartPages) - Microsoft Learn |
| 下载 | 获取预身份验证下载 URL 的方案。 第三方应用程序和某些第一方应用程序可能会中断。 | Microsoft 标识平台上的 OAuth 2.0 和 OpenID Connect 协议 - Microsoft Learn |
| OfficeOnline | Office web 版方案。 性能可能会受到影响。 | |
| SearchPreview | 生成搜索查询结果的预览/缩略图/转换所涉及的方案。 体验可能会中断。 | |
| SharePointConnector | SharePoint 连接器所涉及的方案 | SharePoint 连接器 - Microsoft Learn |
| 缩略图 | 获取预先身份验证的缩略图生成 URL 的方案。 | |
| UploadSession | 创建上传会话的方案。 第三方应用程序和某些第一方应用程序可能会中断 | |
| 视频 | 播放 SharePoint 上托管的视频可能已中断 | |
| WebRendering | 在浏览器中呈现文件预览的方案。 | |
| WebRenderingEmbed | 在另一个应用程序中嵌入 SharePoint 文件。 第三方应用程序和某些第一方应用程序可能会中断 | 嵌入 Web 部件 |
| Whiteboard | 对于匿名用户和来宾用户，Teams 与 Whiteboard 应用的集成将会中断。 | 在 Teams 会议中使用Whiteboard - Microsoft 支持部门 |