Set-SPWebApplication

設定指定的 Web 應用程式。

Syntax

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>]

Description

This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet parameter sets.

Cmdlet Set-SPWebApplication 會設定 Identity 參數所指定的 Web 應用程式。 凡是區域特定的設定 (設定 Zone 參數者),都必須提供要設定的區域。 提供的區域必須已經存在。

透過 Cmdlet 更新 IIS 網站 Set-SPWebApplication 的系結時,應該重新指定所有 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

本範例會將 Web 應用程式設定 http://servername 為使用 SMTP 伺服器 mail.example.com、SMTP 伺服器埠 587、from 位址 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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-AllowLegacyEncryption

指定允許使用較舊的 SSL 和 TLS 通訊協定版本和加密套件與此 IIS 網站搭配使用。 舊版加密比新式加密弱,不建議使用。

此功能需要 Windows Server 2022 或更新版本。 使用舊版 Windows Server 部署 SharePoint 時,無法使用此功能。

此參數只有在搭配 SecureSocketsLayer 參數使用時才有效。

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

-AssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Type:SPAssignmentCollection
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-AuthenticationProvider

定義適用于 Web 應用程式的驗證提供者 () 。

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

-Certificate

指定將用於此 IIS 網站的安全通訊端層 (SSL) 系結,或用於驗證 SMTP 伺服器以傳送電子郵件的憑證。

設定此 IIS 網站的安全通訊端層 (SSL) 系結時,只有在搭配 SecureSocketsLayer 參數使用時,此參數才有效。 設定 SMTP 驗證時,只有在未指定 DisableSMTPEncryption 參數時,此參數才有效。

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

-Confirm

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

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

-DefaultQuotaTemplate

指定此 Web 應用程式的新預設網站配額範本。

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

-DefaultTimeZone

指定此 Web 應用程式中新網站集合的預設時區。

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

-DisableSMTPEncryption

指定要開啟或關閉 SMTP 加密。

預設值為 false。

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

-Force

隱藏 Web 應用程式設定中所涉及的確認訊息。

Type:SwitchParameter
Position:Named
Default value: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
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
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
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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-Port

指定可存取此 Web 應用程式的埠。 連接埠可以是任何有效的連接埠號碼。

如果您指定已指派的埠號碼,IIS 在變更新網站的埠號碼或舊月臺的埠號碼之前,不會啟動新網站。

Type:Int32
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-SecureSocketsLayer

啟用此 Web 應用程式的安全通訊端層 (SSL) 加密。 如果您選擇使用 SSL,您必須將伺服器憑證匯入 SharePoint,並將其指派給此 Web 應用程式的 IIS 網站。 完成之前,將無法從此 IIS 網站存取 Web 應用程式。

預設值為 False。

如果省略此參數或設定為 False,此 Web 應用程式會針對指定的埠使用 HTTP。

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

-ServiceApplicationProxyGroup

指定 Web 應用程式要使用的自訂服務應用程式 Proxy 群組。 Web 應用程式會使用此 Proxy 群組中的 Proxy 來連線到服務應用程式。 如果未指定此參數,則會使用伺服器陣列的預設 Proxy 群組。

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

-SignInRedirectProvider

設定登入重新導向 URL 以指向在特定驗證提供者中所定義的 URL。

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

-SignInRedirectURL

指定 Web 應用程式的登入重新導向 URL。

Type:String
Position:Named
Default value:None
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
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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-SMTPServerPort

指定 SMTP 連接埠值。

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

-Url

指定 Web 應用程式區域的負載平衡 URL。

Type:String
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-WhatIf

Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition