ConvertFrom-String

  • リファレンス
モジュール:
Microsoft.PowerShell.Utility

文字列コンテンツから構造化プロパティを抽出および解析します。

構文

ConvertFrom-String
                [-Delimiter <String>]
                [-PropertyNames <String[]>]
                [-InputObject] <String>
                [<CommonParameters>]
ConvertFrom-String
                [-TemplateFile <String[]>]
                [-TemplateContent <String[]>]
                [-IncludeExtent]
                [-UpdateTemplate]
                [-InputObject] <String>
                [<CommonParameters>]

説明

このコマンドレットは ConvertFrom-String 、文字列コンテンツから構造化プロパティを抽出して解析します。 このコマンドレットは、従来のテキスト ストリームからテキストを解析することによってオブジェクトを生成します。 パイプライン内の各文字列について、コマンドレットは区切り記号または解析式によって入力を分割し、結果の分割要素それぞれにプロパティ名を割り当てます。 これらのプロパティ名を指定できます。そうでない場合は、自動的に生成されます。

コマンドレットの既定のパラメーター セット ByDelimiter は、正規表現の区切り記号で正確に分割されます。 コマンドレットと同様に、引用符の一致や区切り記号のエスケープは Import-Csv 実行されません。

コマンドレットの代替パラメーター セット TemplateParsing は、正規表現によってキャプチャされるグループから要素を生成します。 正規表現の詳細については、「about_Regular_Expressions」を参照してください。

このコマンドレットは、基本的な区切り解析と、自動生成されたサンプル ドリブン解析の 2 つのモードをサポートします。

区切り記号による解析では、既定で、入力を空白の位置で分割し、生成されるグループにプロパティ名を割り当てます。

結果をコマンドレットのいずれかにパイプConvertFrom-String処理して区切り記号をFormat-*カスタマイズすることも、Delimiter パラメーターを使用することもできます。

また、このコマンドレットは、Microsoft Research による FlashExtract の調査作業に基づく、自動生成されたサンプル ドリブン解析もサポートしています。

例

例 1: 既定のプロパティ名を持つオブジェクトを生成する

"Hello World" | ConvertFrom-String

P1    P2
--    --
Hello World

このコマンドは、既定のプロパティ名 P1 と P2 を持つオブジェクトを生成します。

例 1A: 生成されたオブジェクトを把握する

このコマンドは、プロパティ P1、P2 を持つ 1 つのオブジェクトを生成します。どちらのプロパティも既定で String 型です。

"Hello World" | ConvertFrom-String | Get-Member

TypeName: System.Management.Automation.PSCustomObject

Name        MemberType   Definition
----        ----------   ----------
Equals      Method       bool Equals(System.Object obj)
GetHashCode Method       int GetHashCode()
GetType     Method       type GetType()
ToString    Method       string ToString()
P1          NoteProperty string P1=Hello
P2          NoteProperty string P2=World

例 2: 区切り記号を使用して既定のプロパティ名を持つオブジェクトを生成する

このコマンドは、区切り記号として円記号 (\) を使用して、doメイン とユーザー名を持つオブジェクトを生成します。 正規表現を使用する場合は、円記号を別の円記号でエスケープする必要があります。

"Contoso\Administrator" | ConvertFrom-String -Delimiter "\\"

P1      P2
--      --
Contoso Administrator

例 3: 2 つの名前付きプロパティを含むオブジェクトを生成する

次の例では、Windows ホスト のファイル エントリからオブジェクトを作成します。

$content = Get-Content C:\Windows\System32\drivers\etc\hosts
$content = $content -match "^[^#]"
$content | ConvertFrom-String -PropertyNames IP, Server

IP             Server
--             ------
192.168.7.10   W2012R2
192.168.7.20   W2016
192.168.7.101  WIN8
192.168.7.102  WIN10

このコマンドレットは Get-Content 、Windows ホスト ファイル $contentの内容を . 2 番目のコマンドは、(#) で始まらない行と一致する正規表現を使用して、hosts ファイルの先頭にあるコメントを削除します。 最後のコマンドは、再メインテキストをサーバーおよび IP プロパティを持つオブジェクトに変換します。

例 4: TemplateContent パラメーターの値として式を使用し、結果を変数に保存します。

このコマンドは、TemplateContent パラメーターの値として式を使用します。 式は、わかりやすくするために変数に保存されます。 Windows PowerShell は、パイプライン ConvertFrom-String で使用される文字列に次の 3 つのプロパティがあることを理解しています。

  • 名前
  • 電話
  • age
$template = @'
{Name*:Phoebe Cat}, {phone:425-123-6789}, {age:6}
{Name*:Lucky Shot}, {phone:(206) 987-4321}, {age:12}
'@

$testText = @'
Phoebe Cat, 425-123-6789, 6
Lucky Shot, (206) 987-4321, 12
Elephant Wise, 425-888-7766, 87
Wild Shrimp, (111)  222-3333, 1
'@

$PersonalData = $testText | ConvertFrom-String -TemplateContent $template
Write-output ("Pet items found: " + ($PersonalData.Count))
$PersonalData

Pet items found: 4

Name          phone           age
----          -----           ---
Phoebe Cat    425-123-6789    6
Lucky Shot    (206) 987-4321  12
Elephant Wise 425-888-7766    87
Wild Shrimp   (111)  222-3333 1

入力内の各行は、サンプルの一致によって評価されます。 行がパターンで指定された例と一致する場合、値が抽出され、出力変数に渡されます。

サンプル データでは、 $template次の 2 つの異なる電話形式が提供されます。

  • 425-123-6789
  • (206) 987-4321

サンプル データには、次の 2 つの異なる年齢形式も用意されています。

  • 6
  • 12

これは、ハイフンがないため、そのパターンに一致するサンプル データがないため、電話が (206) 987 4321 認識されないことを意味します。

例 5: 生成されたプロパティにデータ型を指定する

これは、上記の例 4 と同じ例です。 違いは、パターン文字列に必要なプロパティごとにデータ型が含まれていることです。

$template = @'
{[string]Name*:Phoebe Cat}, {[string]phone:425-123-6789}, {[int]age:6}
{[string]Name*:Lucky Shot}, {[string]phone:(206) 987-4321}, {[int]age:12}
'@

$testText = @'
Phoebe Cat, 425-123-6789, 6
Lucky Shot, (206) 987-4321, 12
Elephant Wise, 425-888-7766, 87
Wild Shrimp, (111)  222-3333, 1
'@

$PersonalData = $testText | ConvertFrom-String -TemplateContent $template
Write-output ("Pet items found: " + ($PersonalData.Count))
$PersonalData

Pet items found: 4

Name          phone           age
----          -----           ---
Phoebe Cat    425-123-6789      6
Lucky Shot    (206) 987-4321   12
Elephant Wise 425-888-7766     87
Wild Shrimp   (111)  222-3333   1

$PersonalData | Get-Member

TypeName: System.Management.Automation.PSCustomObject

Name        MemberType   Definition
----        ----------   ----------
Equals      Method       bool Equals(System.Object obj)
GetHashCode Method       int GetHashCode()
GetType     Method       type GetType()
ToString    Method       string ToString()
age         NoteProperty int age=6
Name        NoteProperty string Name=Phoebe Cat
phone       NoteProperty string phone=425-123-6789

このGet-Memberコマンドレットは、age プロパティが整数であることを示すために使用されます。

パラメーター

-Delimiter

要素間の境界を識別する正規表現を指定します。 分割によって作成された要素は、結果のオブジェクトのプロパティになります。 区切り記号は、最終的に型の Split メソッドの呼び出しで使用されます[System.Text.RegularExpressions.RegularExpression]。

Type:String
Aliases:DEL
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IncludeExtent

このコマンドレットに、既定で削除されるエクステント テキスト プロパティが含まれていることを示します。

Type:SwitchParameter
Aliases:IE
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

パイプラインから受信した文字列、または文字列オブジェクトを含む変数を指定します。

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PropertyNames

結果のオブジェクトに分割値を割り当てるプロパティ名の配列を指定します。 分割または解析するすべてのテキスト行は、プロパティ値を表す要素を生成します。 要素がキャプチャ グループの結果であり、そのキャプチャ グループに名前が付けられている場合 (たとえば、)(?'name')、(?<name>)そのキャプチャ グループの名前がプロパティに割り当てられます。

PropertyName 配列に要素を指定した場合、それらの名前は、まだ名前が付いていないプロパティに割り当てられます。

フィールドよりも多くのプロパティ名を指定した場合、PowerShell は余分なプロパティ名を無視します。 すべてのフィールドに名前を付けるのに十分なプロパティ名を指定しない場合、PowerShell では、名前のないプロパティ (P1、P2 など) に数値プロパティ名が自動的に割り当てられます。

Type:String[]
Aliases:PN
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TemplateContent

このコマンドレットが文字列を割り当てるプロパティを記述する式または変数として保存された式を指定します。 テンプレート フィールドの仕様の構文は次のとおりです {[optional-typecast]<name>:<example-value>}。

Type:String[]
Aliases:TC
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TemplateFile

文字列の目的の解析用のテンプレートを含むファイルを配列として指定します。 テンプレート ファイルでは、次に示すように、プロパティとその値は角かっこで囲まれています。 Name プロパティとそれに関連付けられている他のプロパティなどのプロパティが複数回表示される場合は、アスタリスク (*) を追加して、この結果が複数のレコードであることを示すことができます。 これにより、1 つのレコードに複数のプロパティが抽出されるのを回避できます。

{Name*:D avid Chew}{City:Redmond}, {State:WA} {Name*:Evan Narvaez} {Name*:Antonio Moreno} {City:Issaquah}, {State:WA}

Type:String[]
Aliases:TF
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UpdateTemplate

このコマンドレットは、学習アルゴリズムの結果をテンプレート ファイル内のコメントに保存することを示します。 これにより、アルゴリズムの学習プロセスが高速になります。 このパラメーターを使用するには、TemplateFile パラメーターを使用してテンプレート ファイルを指定する必要もあります。

Type:SwitchParameter
Aliases:UT
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

String

出力

PSCustomObject

メモ

Windows PowerShell には、次のエイリアスが ConvertFrom-String含まれています。

  • CFS