Set-SPWebApplication

参考

模块:: sharepoint-server

适用于:: SharePoint Server Subscription Edition

配置指定的 Web 应用程序。

语法

Set-SPWebApplication
   [-Identity] <SPWebApplicationPipeBind>
   [-DefaultTimeZone <Int32>]
   [-DefaultQuotaTemplate <String>]
   [-ServiceApplicationProxyGroup <SPServiceApplicationProxyGroupPipeBind>]
   [-NotProvisionGlobally]
   [-AssignmentCollection <SPAssignmentCollection>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-SPWebApplication
   [-Identity] <SPWebApplicationPipeBind>
   -Zone <SPUrlZone>
   [-AuthenticationProvider <SPAuthenticationProviderPipeBind[]>]
   [-AdditionalClaimProvider <SPClaimProviderPipeBind[]>]
   [-SignInRedirectURL <String>]
   [-SignInRedirectProvider <SPTrustedIdentityTokenIssuerPipeBind>]
   [-AuthenticationMethod <String>]
   [-Force]
   [-NotProvisionGlobally]
   [-AssignmentCollection <SPAssignmentCollection>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-SPWebApplication
   [-Identity] <SPWebApplicationPipeBind>
   -Zone <SPUrlZone>
   [-SecureSocketsLayer]
   [-HostHeader <String>]
   [-Certificate <SPServerCertificatePipeBind>]
   [-UseServerNameIndication]
   [-AllowLegacyEncryption]
   -Port <Int32>
   [-Url <String>]
   [-NotProvisionGlobally]
   [-AssignmentCollection <SPAssignmentCollection>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-SPWebApplication
   [-Identity] <SPWebApplicationPipeBind>
   -SMTPServer <String>
   [-SMTPServerPort <Int32>]
   [-OutgoingEmailAddress <String>]
   [-ReplyToEmailAddress <String>]
   [-SMTPCredentials <PSCredential>]
   [-DisableSMTPEncryption]
   [-Certificate <SPServerCertificatePipeBind>]
   [-NotProvisionGlobally]
   [-AssignmentCollection <SPAssignmentCollection>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

说明

此 cmdlet 包含多个参数集。您可以只使用来自一个参数集的参数，也可以不合并来自不同参数集的参数。若要详细了解如何使用参数集，请参阅 Cmdlet 参数集。

cmdlet Set-SPWebApplication 配置 Identity 参数指定的 Web 应用程序。对于区域特定（针对 Zone 参数集）的任何设置，必须提供要配置的区域。所提供的区域必须已经存在。

通过 Set-SPWebApplication cmdlet 更新 IIS 网站的绑定时，应重新指定所有 IIS 绑定设置。这包括 URL、安全套接字层设置、端口号、主机标头和证书。如果未重新指定绑定设置，它将还原为其默认值。

有关适用于 SharePoint 产品的 Windows PowerShell 的权限和最新信息，请参阅 SharePoint Server cmdlet。

示例

示例 1

$credentials = Get-Credential
Set-SPWebApplication -Identity http://servername -SMTPServer mail.example.com -SMTPServerPort 587 -OutgoingEmailAddress user@example.com -ReplyToAddress replyto@example.com -SMTPCredentials $credentials

此示例将 http://servername Web 应用程序设置为使用 SMTP 服务器 mail.example.com、SMTP 服务器端口 587、发件人地址 user@example.com、答复地址 replyto@example.com以及存储在 $credentials 对象中的凭据。

示例 2

Set-SPWebApplication -Identity http://servername -SMTPServer mail.example.com -OutgoingEmailAddress user@example.com -ReplyToAddress replyto@example.com -SMTPCredentials $null

本示例将 Web 应用程序设置为 http://servername 使用 SMTP 服务器 mail.example.com、默认 SMTP 服务器端口、发件人地址 user@example.com、答复地址 replyto@example.com以及匿名连接到 SMTP 服务器。

参数

-AdditionalClaimProvider

将特定声明提供程序添加到定义的 Web 应用程序。

Type:	SPClaimProviderPipeBind[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-AllowLegacyEncryption

指定允许旧版 SSL 和 TLS 协议版本以及密码套件用于此 IIS 网站。旧式加密比新式加密弱，不建议这样做。

此功能需要 Windows Server 2022 或更高版本。当 SharePoint 与早期版本的 Windows Server 一起部署时，此功能不可用。

仅当与 SecureSocketsLayer 参数一起使用时，此参数才有效。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-AssignmentCollection

管理对象以便正确进行处理。使用 SPWeb 或 SPSite 等对象可能会耗用大量内存，而且在 Windows PowerShell 脚本中使用这些对象需要正确管理内存。通过使用 SPAssignment 对象，可以将对象分配给变量，然后在不需要这些对象时对它们进行处理，以释放内存。在使用 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 Subscription Edition

-AuthenticationMethod

使用将 Web 应用程序设置为经典Windows 身份验证。有效值为 NTLM 或 Kerberos。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-AuthenticationProvider

定义应用于 Web 应用程序的身份验证提供程序 () 。

Type:	SPAuthenticationProviderPipeBind[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Certificate

指定将用于安全套接字层 (SSL) 绑定此 IIS 网站的证书，或用于向 SMTP 服务器进行身份验证以发送电子邮件。

配置此 IIS 网站的安全套接字层 (SSL) 绑定时，此参数仅在与 SecureSocketsLayer 参数一起使用时才有效。配置 SMTP 身份验证时，仅当未指定 DisableSMTPEncryption 参数时，此参数才有效。

Type:	SPServerCertificatePipeBind
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-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 Subscription Edition

-DefaultQuotaTemplate

指定此 Web 应用程序的新默认网站配额模板。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-DefaultTimeZone

指定此 Web 应用程序中新网站集的默认时区。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-DisableSMTPEncryption

指定是否打开或关闭 SMTP 加密。

默认值为 false。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Force

禁止显示 Web 应用程序的设置中涉及的确认消息。

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-HostHeader

指定此 IIS 网站的主机标头绑定。主机标头绑定允许多个 IIS 网站共享同一端口号。发送到共享端口号的 Web 请求根据客户端发送的 HTTP 主机标头的值路由到正确的 IIS 网站。

如果未指定主机标头绑定，则发送到此端口号的所有 Web 请求都将路由到此 IIS 网站，除非其他 IIS 网站具有与客户端发送的 HTTP 主机标头匹配的主机标头绑定。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Identity

指定 Web 应用程序的名称或 URL。

键入的值必须为有效名称（格式为 WebApplication-1212）或 URL（格式为 https://example.contoso.com）。

Type:	SPWebApplicationPipeBind
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-NotProvisionGlobally

仅使用此 cmdlet 指定的更改在本地服务器上预配 Web 应用程序。服务器场中其他服务器上的 Web 应用程序不会使用这些更改进行预配。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-OutgoingEmailAddress

指定从此 Web 应用程序发送的电子邮件的新传出电子邮件地址。类型必须是有效的地址;例如。 someone@example.com

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Port

指定可以访问此 Web 应用程序的端口。可以是任意有效端口号。

如果指定了已分配的端口号，则直到您更改新网站的端口号或旧网站的端口号时，IIS 才会启动新网站。

Type:	Int32
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-ReplyToEmailAddress

配置答复电子邮件地址。

类型必须是有效的地址;例如。 someone@example.com

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-SecureSocketsLayer

为此 Web 应用程序启用安全套接字层 (SSL) 加密。如果选择使用 SSL，则必须将服务器证书导入 SharePoint 并将其分配给此 Web 应用程序的 IIS 网站。在完成此操作之前，Web 应用程序将无法从此 IIS 网站访问。

默认值为 False。

如果省略此参数或设置为 False，则此 Web 应用程序将对指定端口使用 HTTP。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-ServiceApplicationProxyGroup

指定 Web 应用程序要使用的自定义服务应用程序代理组。 Web 应用程序将使用此代理组中的代理连接到服务应用程序。如果未指定此参数，则使用场的默认代理组。

Type:	SPServiceApplicationProxyGroupPipeBind
Aliases:	ProxyGroup
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-SignInRedirectProvider

设置登录重定向 URL，使其指向在指定验证提供程序中定义的 URL。

Type:	SPTrustedIdentityTokenIssuerPipeBind
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-SignInRedirectURL

指定 Web 应用程序的登录重定向 URL。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-SMTPCredentials

指定要向 SMTP 服务器进行身份验证的凭据。将值设置为 $null 以匿名连接到 SMTP 服务器。如果未指定此参数，则将保留现有的身份验证设置。

在指定凭据之前， Set-SPApplicationCredentialKey 必须使用 PowerShell cmdlet 在场中的每个服务器上设置相同的应用程序凭据密钥。

Type:	PSCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-SMTPServer

指定此 Web 应用程序将使用的新出站 SMTP 服务器。设置为 $null 以清除服务器设置。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-SMTPServerPort

指定 SMTP 端口值。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Url

指定 Web 应用程序区域的负载均衡 URL。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-UseServerNameIndication

指定此 IIS 网站的安全套接字层 (SSL) 绑定应使用服务器名称指示 (SNI) 。服务器名称指示允许具有唯一主机标头和唯一服务器证书的多个 IIS 网站共享同一 SSL 端口。如果未使用服务器名称指示，共享同一 SSL 端口的所有 IIS 网站必须共享相同的 SSL 证书。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-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 Subscription Edition

-Zone

配置区域特定的设置时，必须指定要配置的区域。此区域必须已经存在。

键入的值必须是下列值中的任何一个： Default 、 Intranet 、 Internet 、 Extranet 或 Custom 。

Type:	SPUrlZone
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition