Set-SPEnterpriseSearchResultSource
検索先のプロパティを設定します。
構文
Set-SPEnterpriseSearchResultSource
[-AssignmentCollection <SPAssignmentCollection>]
[-AuthenticationType <FederationAuthType>]
[-AutoDiscover <Boolean>]
[-Confirm]
[-Description <String>]
-Identity <ResultSourcePipeBind>
[-MakeDefault <Boolean>]
[-Name <String>]
[-Owner <SearchObjectOwner>]
[-Password <String>]
[-ProviderId <Guid>]
[-QueryTemplate <String>]
[-RemoteUrl <String>]
[-SearchApplication <SearchServiceApplicationPipeBind>]
[-SsoId <String>]
[-UserName <String>]
[-WhatIf]
[<CommonParameters>] 説明
このコマンドレットでは、ユーザーが作成した検索先のプロパティを更新します。 このコマンドレットは、サーバーの全体管理の [結果ソースの管理] ページでサポートされているのと同じ更新操作をサポートします。 MakeDefault パラメーターを使用して既定の検索先を変更する以外の更新操作で、検索先を組み込みのソース (組み込みのソースは、BuiltIn プロパティが True に設定されています) にすることはできません。 Windows PowerShell for SharePoint 製品のアクセス許可と最新情報については、「SharePoint Server コマンドレット」のオンライン ドキュメントをご覧ください。
例
--------------------例 1---------------------
$ssa = Get-SPEnterpriseSearchServiceApplication
$owner = Get-SPEnterpriseSearchOwner -Level SSA
$customResultSource = New-SPEnterpriseSearchResultSource -SearchApplication $ssa -Owner $owner -ProviderId fa947043-6046-4f97-9714-40d4c113963d -Name "Custom SharePoint Result Source"
Set-SPEnterpriseSearchResultSource -Identity $customResultSource -Name "Basic SharePoint Result Source"次の使用例は、結果ソースの名前を更新し、結果ソースインスタンスとして結果ソースの ID を指定します。 この更新操作では、SearchApplication と Owner は必要ありません。
-------------------- 例 2 ---------------------
$ssa = Get-SPEnterpriseSearchServiceApplication
$owner = Get-SPEnterpriseSearchOwner -Level SSA
$customResultSource = New-SPEnterpriseSearchResultSource -SearchApplication $ssa -Owner $owner -ProviderId fa947043-6046-4f97-9714-40d4c113963d -Name "Custom SharePoint Result Source"
Set-SPEnterpriseSearchResultSource -SearchApplication $ssa -Owner $owner -Identity "Custom SharePoint Result Source" -Description "A custom SharePoint Result Source for demonstration purposes"次の使用例は、結果ソースの説明を更新し、結果ソースの ID は名前で指定します。
パラメーター
-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 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-AuthenticationType
結果ソースの認証の種類を指定します。 パラメーターを指定しない場合、値は変更されません。
検索プロバイダーの種類ごとに特定の認証の種類のセットがサポートされており、パラメーターが指定されていない場合、認証の種類は検索プロバイダーの種類に基づいて既定で使用されます。
このコマンドレットでは、既定の SharePoint 認証 (FederationAuthType.LocalNTAuth)、基本認証 (FederationAuthType.SingleAccountBasicAuth - UserName とパスワードの指定)、既定のリモート SharePoint 認証 (FederationAuthType.PerUserBasicAuth)、シングル サインオン (FederationAuthType.SSO - SsoId の指定が必要)、匿名 (FederationAuthType.Anonymous)、ダイジェスト認証 (FederationAuthType.SingleAccountDigest - UserName と Password の指定、NTLM アプリケーション プール ID (FederationAuthType.ApplicationPoolIdentity)、NTLM ユーザー名とパスワード (FederationAuthType.SingleAccountNTLM - UserName と Password の指定) を指定します。
ローカル SharePoint Search/ローカル SharePoint People Search プロバイダーを使用する場合は、FederationAuthType.LocalNTAuth (既定値) と FederationAuthType.SingleAccountBasicAuth がサポートされます。
リモート SharePoint Search/リモート SharePoint People Search プロバイダーを使用する場合は、FederationAuthType.PerUserBasicAuth (既定値) と FederationAuthType.SSO がサポートされます。
OpenSearch 1.0/1.1 検索プロバイダーを使用する場合は、FederationAuthType.Anonymous (既定値)、FederationAuthType.SingleAccountBasicAuth、FederationAuthType.SingleAccountDigest、FederationAuthType.SingleAccountNTLM、および FederationAuthType.ApplicationPoolIdentity の認証の種類がサポートされます。
すべての認証の種類は、enum FederationAuthType に一覧表示されます。
| Type: | FederationAuthType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-AutoDiscover
結果ソースに Exchange サーバー エンドポイントの自動検出を使用するかどうかを指定します。
値を True ($true) に設定すると、自動検出が使用されます。
パラメーターを指定しない場合、値は変更されません。
Exchange 検索プロバイダーを使用する場合のみ、適用可能です。
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-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 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Description
検索先の説明を指定します。
パラメーターを指定しない場合、値は変更されません。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Identity
更新する検索先を指定します。
この型は、12345678-90ab-cdef-1234-567890bcdefgh という形式の有効な GUID であるか、検索先の有効な名前 (Custom SharePoint Result Source など) であるか、有効な Source オブジェクトのインスタンスであることが必要です。
| Type: | ResultSourcePipeBind |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-MakeDefault
Owner パラメーターで指定されたスコープに対して、結果ソースを既定の結果ソースとして設定するかどうかを指定します。
パラメーターが指定されていない場合、既定の結果ソースは変更されません。
値を True ($true) に設定すると、検索先が既定として設定されます。
値を false ($false) に設定すると、結果ソースを既定として設定してはならないことが示されます。この場合、更新する結果ソースが現在既定の場合、元の既定の結果ソース ("Local SharePoint Results") が再び既定値として設定されます。
ヒント: Makedefault を使用する場合は、ID として名前または GUID 文字列 ID ではなくインスタンスを使用して、結果のソースを既定値として設定する必要があるレベル (値が true の場合) または既定値を元にリセットする必要があるレベル (値が false の場合) を指定するために所有者のみを使用することを明確に指定します。
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Name
検索先の名前を指定します。
パラメーターを指定しない場合、値は変更されません。
名前は管理レベルごとに一意である必要があります。
たとえば、サイトの 2 つの検索先は名前を共有することはできませんが、サイトの 1 つの検索先と、サイト コレクションが提供する 1 つの検索先は名前を共有できます。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Owner
対応する検索先が使用可能な範囲を定義する検索オブジェクトの所有者を指定します。
| Type: | SearchObjectOwner |
| Aliases: | o |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Password
検索先への接続に使用するユーザー資格情報のパスワードを指定します。
パラメーターを指定しない場合、値は変更されません。
認証の種類 (AuthenticationType) がユーザー資格情報 (FederationAuthType.SingleAccountBasicAuth、FederationAuthType.SingleAccountDigest、または FederationAuthType.SingleAccountNTLM) を使用する種類に設定された場合に使用されます。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-ProviderId
結果ソースで使用する検索プロバイダーを指定します。
パラメーターを指定しない場合、値は変更されません。
Guid または GUID 文字列として指定します。 FA947043-6046-4F97-9714-40D4C113963D (ローカル SharePoint Search)、E4BCC058-F133-4425-8FFC-1D70596FFD33 (Local Share SharePoint People Search)、1E0C8601-2E5D-4CCB-9561-53743B5DBDE7 (リモート SharePoint Search)、E377CAAA-FCAF-4a1b-B7A1-E69A506A07AA (リモート SharePoint People 検索)、3A17E140-1574-4093-BAD6-E19CDF1C0122 (Exchange Search)、3A17E140-1574-4093-BAD6-E19CDF1C0121 (OpenSearch 1.0/1.1)。
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-QueryTemplate
検索先のクエリの変換テンプレートを指定します。
パラメーターを指定しない場合、値は変更されません。
この新しいクエリ テキストを使用するために、受信クエリはテンプレートに従って変更されます。 クエリ変数 {searchTerms} を使用して、新しいテキストに受信クエリを含めます。 これを結果の適用範囲に使用します。
たとえば、OneNote アイテムのみを返すには、新しいテキストを "{searchTerms} fileextension=one" に設定します。 その後、受信クエリ sharepoint は sharepoint fileextension=one になります。 既定値は {searchTerms} です。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-RemoteUrl
検索先の接続 URL テンプレートを指定します。
パラメーターを指定しない場合、値は変更されません。
これを使用する検索プロバイダー (リモートの SharePoint 検索、リモートの SharePoint でのひとの検索、OpenSearch 1.0/1.1、Exchange (AutoDiscover が無効の場合)) を使用する場合に、設定される必要があります。
その他の検索プロバイダーを使用する場合、パラメーターは無視されます。
リモートの SharePoint 検索/リモートの SharePoint でのひとの検索の場合、リモート SharePoint ファームのルート サイト コレクションのアドレスを指定します。
OpenSearch 1.0/1.1 の場合、OpenSearch ソースの URL を指定します。
自動的にクエリで置換される、クエリ変数 {searchTerms} を使用して URL にクエリを含めます。 Exchange の場合、結果を取得する Exchange EWS URL を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-SearchApplication
検索アプリケーションを指定します。
この型は、12345678-90ab-cdef-1234-567890bcdefgh という形式の有効な GUID であるか、検索アプリケーションの有効な名前 (SearchApp1 など) であるか、有効な SearchServiceApplication オブジェクトのインスタンスであることが必要です。
| Type: | SearchServiceApplicationPipeBind |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-SsoId
検索先への接続に使用するリバース プロキシ証明書 Secure Store ID を指定します。
パラメーターを指定しない場合、値は変更されません。
認証の種類 (AUthenticationType) が FederationAuthType.SSO (シングル サインオン) に設定されている場合は、指定する必要があります。
リバース プロキシを通じてイントラネットに接続している場合、リバース プロキシの認証に使用する証明書を格納するシングル サインオン エントリの SSO ID を入力します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-UserName
検索先への接続に使用するユーザー資格情報のユーザー名を指定します。
パラメーターを指定しない場合、値は変更されません。
認証の種類 (AuthenticationType) がユーザー資格情報 (FederationAuthType.SingleAccountBasicAuth、FederationAuthType.SingleAccountDigest、または FederationAuthType.SingleAccountNTLM) を使用する種類に設定された場合に使用されます。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-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 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |