Set-SPWebApplication
指定した 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>]
説明
このコマンドレットには、複数のパラメーター セットが含まれています。 使用できるのは、1 つのパラメーター セットのパラメーターだけであり、異なるパラメーター セットのパラメーターを組み合わせることはできません。 パラメーター セットの使用法に関する詳しい情報については、「コマンドレットのパラメーター セット」を参照してください。
コマンドレットは Set-SPWebApplication
、Identity パラメーターで指定された Web アプリケーションを構成します。
ゾーン固有の設定を構成するには、構成するゾーンを Zone パラメーターで指定します。
既存のゾーンを指定する必要があります。
コマンドレットを使用して IIS Web サイトのバインドを更新するときは、すべての IIS バインド設定を再指定する Set-SPWebApplication
必要があります。 これには、URL、セキュリティで保護されたソケット レイヤーの設定、ポート番号、ホスト ヘッダー、および証明書が含まれます。 バインド設定が再指定されていない場合は、既定値に戻されます。
Windows PowerShell for SharePoint 製品のアクセス許可と最新情報については、「SharePoint Server コマンドレット」のオンライン ドキュメントをご覧ください。
例
例 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使用例は、SMTP サーバー mail.example.com、SMTP サーバー ポート 587、from アドレス、応答先アドレスuser@example.comreplyto@example.com、および$credentials オブジェクトに格納されている資格情報を使用するように Web アプリケーションを設定します。
例 2
Set-SPWebApplication -Identity http://servername -SMTPServer mail.example.com -OutgoingEmailAddress user@example.com -ReplyToAddress replyto@example.com -SMTPCredentials $null
次のhttp://servername使用例は、SMTP サーバー mail.example.com、既定の SMTP サーバー ポート、from アドレス、応答先アドレスuser@example.comreplyto@example.com、および SMTP サーバーに匿名で接続するように Web アプリケーションを設定します。
パラメーター
-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
この IIS Web サイトで古い SSL および TLS プロトコルのバージョンと暗号スイートを使用することを許可するように指定します。 従来の暗号化は最新の暗号化よりも弱く、推奨されません。
この機能には、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 オブジェクトを使用して、変数へのオブジェクトの割り当てとオブジェクトの破棄を行うことができます。 割り当てコレクションまたは Global パラメーターが使用されていない場合、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
この IIS Web サイトの Secure Sockets Layer (SSL) バインド、または電子メールを送信する SMTP サーバーへの認証に使用する証明書を指定します。
この IIS Web サイトの Secure Sockets Layer (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 Web サイトのホスト ヘッダー バインドを指定します。 ホスト ヘッダー バインドを使用すると、複数の IIS Web サイトで同じポート番号を共有できます。 共有ポート番号に送信された Web 要求は、クライアントによって送信された HTTP ホスト ヘッダーの値に基づいて、正しい IIS Web サイトにルーティングされます。
ホスト ヘッダー バインドが指定されていない場合、このポート番号に送信されるすべての Web 要求は、別の IIS Web サイトに、クライアントから送信された HTTP ホスト ヘッダーと一致するホスト ヘッダー バインドがない限り、この IIS Web サイトにルーティングされます。
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 という形式の有効な名前であるか、http://<サーバー名>/WebApplicaiton-1212 という形式の URL であることが必要です。
Type: | SPWebApplicationPipeBind |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | SharePoint Server Subscription Edition |
-NotProvisionGlobally
このコマンドレットによって指定された変更を使用して、ローカル サーバー上の 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 アプリケーションの Secure Sockets Layer (SSL) 暗号化を有効にします。 SSL を使用する場合は、サーバー証明書を SharePoint にインポートし、この Web アプリケーションの IIS Web サイトに割り当てる必要があります。 この操作が完了するまで、この IIS Web サイトから Web アプリケーションにアクセスできなくなります。
既定値は 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 サーバーに対して認証する資格情報を指定します。 SMTP サーバーに匿名で接続するには、値を $null に設定します。 このパラメーターが指定されていない場合、既存の認証設定は保持されます。
PowerShell コマンドレットを Set-SPApplicationCredentialKey
使用して、資格情報を指定する前に、ファーム内の各サーバーで同じアプリケーション資格情報キーを設定する必要があります。
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 Web サイトの Secure Sockets Layer (SSL) バインドでサーバー名表示 (SNI) を使用することを指定します。 サーバー名表示を使用すると、一意のホスト ヘッダーと一意のサーバー証明書を持つ複数の IIS Web サイトが同じ SSL ポートを共有できます。 サーバー名表示を使用しない場合、同じ SSL ポートを共有するすべての IIS Web サイトで同じ 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 |