Update-List
オブジェクトのコレクションを含むプロパティ値に項目を追加および削除します。
構文
Update-List
[-Add <Object[]>]
[-Remove <Object[]>]
[-InputObject <PSObject>]
[[-Property] <String>]
[<CommonParameters>]Update-List
-Replace <Object[]>
[-InputObject <PSObject>]
[[-Property] <String>]
[<CommonParameters>]説明
Update-List コマンドレットは、オブジェクトのプロパティ値に項目を追加したり、オブジェクトのプロパティ値から項目を削除したりして、更新されたオブジェクトを返します。 このコマンドレットは、オブジェクトのコレクションを含むプロパティ用に設計されています。
の追加と削除 パラメーターは、個々の項目をコレクションに追加してコレクションから削除します。 Replace パラメーターは、コレクション全体を置き換えます。
コマンドでプロパティを指定しない場合、 Update-List はオブジェクトを更新する代わりに、更新を記述するオブジェクトを返します。 更新オブジェクトは、Set-* コマンドレットなど、オブジェクトを変更するコマンドレットに送信できます。
このコマンドレットは、更新されるプロパティが Update-List が使用する IList インターフェイスをサポートしている場合にのみ機能します。 また、更新プログラムを受け入れる Set-* コマンドレットは、IList インターフェイスをサポートする必要があります。 Windows PowerShell と共にインストールされるコア コマンドレットは、このインターフェイスをサポートしていません。 コマンドレットが Update-List をサポートしているかどうかを確認するには、コマンドレットのヘルプ トピックを参照してください。
例
例 1: プロパティ値に項目を追加および削除する
PS C:\> Get-MailBox | Update-List -Property aliases -Add "A","B" -Remove "X","Y" | Set-MailBoxこのコマンドは、メールボックスの Aliases プロパティから A と B を追加し、X と Y を削除します。
このコマンドは、Microsoft Exchange Server の Get-Mailbox コマンドレットを使用してメールボックスを取得します。 パイプライン オペレーターは、メールボックス オブジェクトを Update-List コマンドレットに送信します。
Update-List コマンドは、Property パラメーターを使用してメールボックスの Aliases プロパティが更新されていることを示し、Add パラメーターと Remove パラメーターを使用して、コレクションに追加されるアイテムとコレクションから削除されるアイテムを指定します。 Aliases プロパティは、Add メソッドと Remove メソッドを持つ Microsoft .NET Framework オブジェクトのコレクションを格納するため、 Update-List の条件を満たします。
Update-List コマンドレットは更新されたメールボックスを返し、メールボックスは Set-MailBox コマンドレットにパイプ処理されます。これにより、メールボックスが変更されます。
例 2: 変数のプロパティ値に項目を追加および削除する
PS C:\> $M = Get-MailBox
PS C:\> Update-List -InputObject $M -Property aliases -Add "A","B" -Remove "X", "Y" | Set-MailBoxこのコマンドは、メールボックスの Aliases プロパティの値に A と B を加算し、X と Y を削除します。このコマンドは、形式が若干異なりますが、前のコマンドと同じ効果があります。
このコマンドでは、 Get-MailBox コマンドレットを使用してメールボックスを取得し、メールボックスを $M 変数に保存します。 このコマンドは、Update-List の InputObject パラメーターを使用してメールボックスを指定します。 InputObject の値は、$M 変数のメールボックスです。 Property パラメーターを使用して Aliases プロパティを指定し、Add パラメーターと Remove パラメーターを使用して Aliases の値に追加される項目と値から除去される項目を指定します。
このコマンドでは、パイプライン演算子 (|) を使用して、更新されたメールボックス オブジェクトを Set-Mailbox コマンドレットに送信し、メールボックスを変更します。
例 3: プロパティ値に項目を追加および削除する
PS C:\> Get-MailBox | Set-MailBox -Alias (Update-List -Add "A", "B" -Remove "X","Y")このコマンドは、メールボックスの Aliases プロパティの値に A と B を加算し、X と Y を削除します。このコマンドは、前の 2 つのコマンドと同じ効果を持ちますが、タスクを実行するために異なる手順を使用します。
このコマンドは、メールボックスを Set-Mailbox に送信する前にメールボックスの Aliases プロパティを更新する代わりに、 Update-List を使用して変更を表すオブジェクトを作成します。 次に、Set-Mailbox の Alias パラメーターに変更を送信します。
このコマンドでは、 Get-MailBox コマンドレットを使用してメールボックスを取得します。 パイプライン オペレーターは、メールボックスを変更する Set-Mailbox コマンドレットにメールボックス オブジェクトを送信します。
このコマンドは、Set-Mailbox の Alias パラメーターを使用して、メールボックス オブジェクトの Aliases プロパティを変更します。 Alias パラメーターの値は、更新を表すオブジェクトを作成する Update-List コマンドです。 Update-List コマンドは、Alias パラメーターの値が評価される前に実行されるように、かっこで囲まれています。 Set-Mailbox コマンドが完了すると、メールボックスが変更されます。
例 4: プロパティ コレクションを置き換える
PS C:\> Update-List -InputObject $A -Property aliases -Replace "A", "B" | Set-MailBoxこのコマンドでは、 Update-List の Replace 演算子を使用して、$A 内のオブジェクトの Aliases プロパティのコレクションを新しいコレクションに置き換えます。
このコマンドは InputObject パラメーターを使用しますが、この場合は、パイプライン演算子を使用して Update-List に$Aを渡すのと同じです。
パラメーター
-Add
コレクションに追加するプロパティ値を指定します。 コレクションに表示する順序で値を入力します。
| 型: | Object[] |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-InputObject
更新するオブジェクトを指定します。 また、更新するオブジェクトを Update-List にパイプすることもできます。
| 型: | PSObject |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Property
更新されるコレクションを含むプロパティを指定します。 このパラメーターを省略すると、 Update-List はオブジェクトを変更するのではなく、変更を表すオブジェクトを返します。
| 型: | String |
| 配置: | 0 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Remove
コレクションから削除するプロパティ値を指定します。
| 型: | Object[] |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Replace
新しいコレクションを指定します。 このパラメーターは、元のコレクション内のすべての項目を、このパラメーターで指定された項目に置き換えます。
| 型: | Object[] |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
入力
更新するオブジェクトを Update-List にパイプできます。
出力
Objects or System.Management.Automation.PSListModifier
Update-List は、更新されたオブジェクトを返すか、更新アクションを表すオブジェクトを返します。