New-SearchDocumentFormat

  • リファレンス
モジュール:
ExchangePowerShell
適用対象:
Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。

New-SearchDocumentFormat コマンドレットを使用して、Exchange 検索で使用される形式固有のフィルターを追加します。

以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。

構文

New-SearchDocumentFormat
   [-Identity] <SearchDocumentFormatId>
   -Extension <String>
   -MimeType <String>
   -Name <String>
   [-Confirm]
   [-Enabled <Boolean>]
   [-Server <ServerIdParameter>]
   [-WhatIf]
   [<CommonParameters>]

説明

New-SearchDocumentFormat コマンドレットの実行後に、次のコマンドレットを実行して検索サービスを再起動する必要があります。 短時間、検索が停止します。

このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。

例

例 1

New-SearchDocumentFormat -Name "Proprietary SCT Formats" -MimeType text/scriptlet -Extension .sct -Identity ProprietarySCT1

この例では、拡張子が .sct で MIME の種類がテキスト/スクリプトレットの新しい検索ドキュメント形式を作成します。

パラメーター

-Confirm

Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。

  • 破壊的なコマンドレット (Remove-* コマンドレットなど) には、続行する前にコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文-Confirm:$falseを使用して、確認プロンプトを省略できます。
  • 他のほとんどのコマンドレット (New-* コマンドレットや Set-* コマンドレットなど) には、一時停止が組み込まれています。 これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。
Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Enabled

Enabled パラメーターは、新しい形式を作成時に有効にするかどうかを指定します。

このパラメーターの有効な入力値は、$true または $false です。 既定値は $true です。

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Extension

Extension パラメーターは、フィルターによって処理されるファイルの種類を指定し、ファイルの種類に関連付けられている共通ファイル拡張子によって指定されます。 例としては、.MP3、.JPG、.PNGなどがあります。 先行期間に注意してください。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Identity

Identity パラメーターは、新しい検索ドキュメント形式を一意に識別します。 たとえば、ID「PropSCT」は、カスタム IFilter でサポートされる専用のドキュメント形式を指定できます。 Identity パラメーターは、検索ドキュメント形式内で一意にする必要があります。

Type:SearchDocumentFormatId
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-MimeType

MimeType パラメーターは、形式の MIME 種類を指定します。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Name

Name は形式のフレンドリ名を指定しますが、一意である必要はありません。 たとえば、"My Business Output" と呼ばれる独自のシステムからの出力のインデックスを作成するために使用される複数の異なる形式 (カスタム IFilters でサポートされる) がある場合があります。 Name パラメーターを使用すると、"My Business Output Formats" という形式のカテゴリを作成し、Identity パラメーターを使用してそのグループ内の各形式を一意に識別できます。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Server

Server パラメーターは、このコマンドの実行先となる Exchange サーバーを指定します。 サーバーを一意に識別する任意の値を使用できます。 次に例を示します。

  • 名前
  • FQDN
  • 識別名 (DN)
  • Exchange の従来の DN

このパラメーターを使用しない場合、コマンドはローカル サーバー上で実行されます。

Type:ServerIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-WhatIf

WhatIf スイッチは、コマンドの操作をシミュレートします。 このスイッチを使用すると、実際にその変更内容を適用せずに、発生する変更を確認できます。 このスイッチで値を指定する必要はありません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

入力

Input types

このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。

出力

Output types

このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。