Set-SPEnterpriseSearchResultSource

検索先のプロパティを設定します。

構文

Default (既定)

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

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

適切な破棄を行うためにオブジェクトを管理します。 SPWeb や SPSite などのオブジェクトの使用によって大量のメモリが使用される場合があるので、Windows PowerShell スクリプトでこれらのオブジェクトを使用するには適切なメモリ管理が必要です。 メモリの解放が必要になった場合は、SPAssignment オブジェクトを使用して、変数へのオブジェクトの割り当てとオブジェクトの破棄を行うことができます。 割り当てコレクションまたは Global パラメーターが使用されていない場合、SPWeb、SPSite、または SPSiteAdministration オブジェクトが使用されていると、オブジェクトは自動的に破棄されます。

Global パラメーターが使用されている場合は、オブジェクトはすべてグローバル ストアに格納されます。 Stop-SPAssignment コマンドを使用してオブジェクトの使用または破棄を直接行わないと、メモリ不足のシナリオになる場合があります。

パラメーターのプロパティ

型:SPAssignmentCollection
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:True
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-AuthenticationType

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

検索先の認証の種類を指定します。 パラメーターを指定しない場合、値は変更されません。

検索プロバイダーの種類ごとに特定の認証の種類のセットがサポートされており、パラメーターが指定されていない場合、認証の種類は検索プロバイダーの種類に基づく既定値になります。

このコマンドレットは、既定の SharePoint 認証 (FederationAuthType.LocalNTAuth)、基本認証 (FederationAuthType.SingleAccountBasicAuth - ユーザー名とパスワードを指定)、既定のリモート SharePoint 認証 (FederationAuthType.PerUserBasicAuth)、シングル サインオンの認証メカニズムと対応する種類のセットをサポートします(FederationAuthType.SSO - SsoId を指定する必要がある)、匿名 (FederationAuthType.Anonymous)、ダイジェスト認証 (FederationAuthType.SingleAccountDigest - ユーザー名とパスワードを指定)、NTLM アプリケーション プール ID (FederationAuthType.ApplicationPoolIdentity)、NTLM ユーザー名とパスワード (FederationAuthType.SingleAccountNTLM - ユーザー名とパスワードを指定)。

ローカル SharePoint Search/Local SharePoint People Search プロバイダーを使用する場合は、FederationAuthType.LocalNTAuth (既定) と FederationAuthType.SingleAccountBasicAuth がサポートされます。

リモート SharePoint 検索/リモート SharePoint People 検索プロバイダーを使用する場合、FederationAuthType.PerUserBasicAuth (既定) と FederationAuthType.SSO がサポートされます。

OpenSearch 1.0/1.1 検索プロバイダーを使用する場合、次の認証タイプがサポートされます: FederationAuthType.Anonymous (デフォルト)、FederationAuthType.SingleAccountBasicAuth、FederationAuthType.SingleAccountDigest、FederationAuthType.SingleAccountNTLM、および FederationAuthType.ApplicationPoolIdentity。

すべての認証の種類は、列挙型の FederationAuthType に一覧表示されます。

パラメーターのプロパティ

型:FederationAuthType
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-AutoDiscover

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

結果ソースの Exchange サーバー エンドポイントの自動検出を使用するかどうかを指定します。

値を True ($true) に設定すると、自動検出が使用されます。

パラメーターを指定しない場合、値は変更されません。

Exchange 検索プロバイダーを使用する場合のみ、適用可能です。

パラメーターのプロパティ

型:Boolean
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Confirm

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

コマンドを実行する前に確認メッセージを表示します。 詳細については、次のコマンドを入力します。get-help about_commonparameters

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:Cf

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Description

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

検索先の説明を指定します。

パラメーターを指定しない場合、値は変更されません。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Identity

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

更新する検索先を指定します。

この型は、12345678-90ab-cdef-1234-567890bcdefgh という形式の有効な GUID であるか、検索先の有効な名前 (Custom SharePoint Result Source など) であるか、有効な Source オブジェクトのインスタンスであることが必要です。

パラメーターのプロパティ

型:ResultSourcePipeBind
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-MakeDefault

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

Owner パラメーターで指定されたスコープについて、結果ソースを既定の結果ソースとして設定するかどうかを指定します。

パラメーターを指定しない場合、既定の結果ソースは変更されません。

値を True ($true) に設定すると、検索先が既定として設定されます。

値を false ($false) に設定すると、結果ソースを既定として設定しないでください。この場合、更新する結果ソースが現在既定の場合、元の既定の結果ソース ("ローカル SharePoint 結果") が再び既定として設定されます。

ヒント: Makedefault を使用する場合は、名前や GUID の文字列 ID ではなくインスタンスを ID として使用して、Owner が、結果ソースをデフォルトとして設定するレベル (値が true の場合) またはデフォルトを元のものにリセットするレベル (値が false の場合) を指定するためにのみ使用されることを明確に指定します。

パラメーターのプロパティ

型:Boolean
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Name

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

検索先の名前を指定します。

パラメーターを指定しない場合、値は変更されません。

名前は管理レベルごとに一意である必要があります。

たとえば、サイトの 2 つの検索先は名前を共有することはできませんが、サイトの 1 つの検索先と、サイト コレクションが提供する 1 つの検索先は名前を共有できます。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Owner

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

対応する検索先が使用可能な範囲を定義する検索オブジェクトの所有者を指定します。

パラメーターのプロパティ

型:SearchObjectOwner
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:o

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Password

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

検索先への接続に使用するユーザー資格情報のパスワードを指定します。

パラメーターを指定しない場合、値は変更されません。

認証の種類 (AuthenticationType) がユーザー資格情報 (FederationAuthType.SingleAccountBasicAuth、FederationAuthType.SingleAccountDigest、または FederationAuthType.SingleAccountNTLM) を使用する種類に設定された場合に使用されます。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ProviderId

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

検索先で使用する検索プロバイダーを指定します。

パラメーターを指定しない場合、値は変更されません。

GUID または GUID 文字列として指定され、次のいずれかである必要があります。FA947043-6046-4F97-9714-40D4C113963D (ローカル SharePoint 検索)、E4BCC058-F133-4425-8FFC-1D70596FFD33 (ローカル SharePoint People検索)、1E0C8601-2E5D-4CCB-9561-53743B5DBDE7 (リモート SharePoint 検索)、E377CAAA-FCAF-4A1B-B7A1-E69A506A07AA (リモート SharePoint People検索)、3A17E140-1574-4093-BAD6-E19CDF1C0122 (Exchange 検索)、3A17E140-1574-4093-BAD6-E19CDF1C0121 (OpenSearch 1.0/1.1)。

パラメーターのプロパティ

型:Guid
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-QueryTemplate

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

検索先のクエリの変換テンプレートを指定します。

パラメーターを指定しない場合、値は変更されません。

この新しいクエリ テキストを使用するために、受信クエリはテンプレートに従って変更されます。 クエリ変数 {searchTerms} を使用して、新しいテキストに受信クエリを含めます。 これを結果の適用範囲に使用します。

たとえば、OneNote アイテムのみを返すには、新しいテキストを "{searchTerms} fileextension=one" に設定します。 その後、受信クエリ sharepoint は sharepoint fileextension=one になります。 既定値は {searchTerms} です。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-RemoteUrl

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

検索先の接続 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 を指定します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-SearchApplication

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

検索アプリケーションを指定します。

この型は、12345678-90ab-cdef-1234-567890bcdefgh という形式の有効な GUID であるか、検索アプリケーションの有効な名前 (SearchApp1 など) であるか、有効な SearchServiceApplication オブジェクトのインスタンスであることが必要です。

パラメーターのプロパティ

型:SearchServiceApplicationPipeBind
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:True
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-SsoId

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

検索先への接続に使用するリバース プロキシ証明書 Secure Store ID を指定します。

パラメーターを指定しない場合、値は変更されません。

認証の種類 (AUthenticationType) が FederationAuthType.SSO (シングル サインオン) に設定されている場合は指定する必要があります。

リバース プロキシを通じてイントラネットに接続している場合、リバース プロキシの認証に使用する証明書を格納するシングル サインオン エントリの SSO ID を入力します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-UserName

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

検索先への接続に使用するユーザー資格情報のユーザー名を指定します。

パラメーターを指定しない場合、値は変更されません。

認証の種類 (AuthenticationType) がユーザー資格情報 (FederationAuthType.SingleAccountBasicAuth、FederationAuthType.SingleAccountDigest、または FederationAuthType.SingleAccountNTLM) を使用する種類に設定された場合に使用されます。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-WhatIf

適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019

コマンドを実行する代わりに、コマンドの実行結果を説明するメッセージを表示します。 詳細については、次のコマンドを入力します。get-help about_commonparameters

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:wi

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

CommonParameters

このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、「about_CommonParameters」を参照してください。