ConvertFrom-String

構文

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: 区切り記号を使用して既定のプロパティ名を持つオブジェクトを生成する

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

"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 ファイルの先頭にあるコメントを削除します。 最後のコマンドは、残りのテキストを Server および 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

-IncludeExtent

-InputObject

-PropertyNames

-TemplateContent

-TemplateFile

-UpdateTemplate

入力

String

出力

PSCustomObject

メモ

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

• CFS

関連リンク

• ConvertFrom-String: サンプル ベースのテキスト解析
• ConvertFrom-StringData
• ConvertFrom-Csv
• ConvertTo-Xml