Update-List
Adiciona itens e os remove de um valor de propriedade que contém uma coleção de objetos.
Sintaxe
Update-List [-Add <Object[]>] [-Remove <Object[]>] [[-Property] <string>] [-InputObject <psobject>] [<CommonParameters>]
Update-List -Replace <Object[]> [[-Property] <string>] [-InputObject <psobject>] [<CommonParameters>]
Descrição
O cmdlet Update-List adiciona e remove itens de um valor de propriedade de um objeto e retorna o objeto atualizado. Esse cmdlet é criado para propriedades que contêm coleções de objetos.
Os parâmetros Add e Remove adicionam itens individuais e os removem da coleção. O parâmetro Replace substitui a coleção inteira.
Se você não especificar uma propriedade no comando, Update-List retornará um objeto que descreve a atualização, em vez de atualizar o objeto. É possível enviar o objeto de atualização a cmdlets que alteram objetos, como cmdlets Set-*.
Esse cmdlet só funciona quando a propriedade que está sendo atualizada suporta a interface IList que usa o Update-List. Além disso, qualquer cmdlet Set-* que aceite uma atualização deve oferecer suporte à interface de IList. Os cmdlets de núcleo que são instalados com o Windows PowerShell não dão suporte a essa interface. Para determinar se um cmdlet dá suporte ao Update-List, consulte o tópico da Ajuda do cmdlet.
Parâmetros
-Add <Object[]>
Especifica os valores de propriedade a serem adicionados à coleção. Insira os valores na ordem em que devem aparecer na coleção.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-InputObject <psobject>
Especifica os objetos a serem atualizados. Também é possível canalizar o objeto a ser atualizado para Update-List.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
true (ByValue) |
Aceitar caracteres curinga? |
false |
-Property <string>
Identifica a propriedade que contém a coleção que está sendo atualizada. Se você omitir esse parâmetro, Update-List retornará um objeto que representa a alteração em vez de alterar o objeto.
Necessário? |
false |
Posição? |
1 |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Remove <Object[]>
Especifica os valores de propriedade a serem removidos da coleção.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Replace <Object[]>
Especifica uma nova coleção. Esse parâmetro substitui todos os itens na coleção original pelos itens especificados por esse parâmetro.
Necessário? |
true |
Posição? |
named |
Valor padrão |
Nenhum |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
<CommonParameters>
Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.
Entradas e saídas
O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.
Entradas |
System.Management.Automation.PSObject Você pode canalizar os objetos a serem atualizados para Update-List. |
Saídas |
Objects ou System.Management.Automation.PSListModifier Update-List retorna o objeto atualizado ou retorna um objeto que representa a ação de atualização. |
Exemplo 1
C:\PS>get-mailbox | update-list -Property aliases -Add "A","B" -Remove "X","Y" | set-mailbox
Descrição
-----------
Esse comando adiciona A e B e remove X e Y da propriedade Aliases de uma caixa de correio.
O comando usa o cmdlet Get-MailBox do Microsoft Exchange Server para obter a caixa postal. Um operador de pipeline envia o objeto de caixa de correio para o cmdlet Update-List.
O comando Update-List usa o parâmetro Property para indicar que a propriedade Aliases da caixa de correio está sendo atualizada, e usa os parâmetros Add e Remove para especificar os itens que estão sendo adicionados e removidos da coleção. A propriedade Aliases atende às condições de Update-List, pois ele armazena uma coleção de objetos do Microsoft .NET Framework que têm métodos Add e Remove.
O cmdlet Update-List retorna a caixa de correio atualizada, que é canalizada para o cmdlet Set-MailBox que altera a caixa de correio.
Para obter mais informações sobre Get-Mailbox, consulte https://go.microsoft.com/fwlink/?LinkId=111536.
Exemplo 2
C:\PS>$m = get-mailbox
C:\PS> update-list -InputObject $m -Property aliases -Add "A","B" -Remove "X", "Y" | set-mailbox
Descrição
-----------
Esse comando adiciona A e B ao valor da propriedade Aliases de uma caixa de correio e remove X e Y. Esse comando tem o mesmo efeito que o comando anterior, embora tenha um formato levemente diferente.
O comando usa o cmdlet Get-MailBox para obter a caixa de correio e salvá-la na variável $m. O comando usa o parâmetro InputObject de Update-List para especificar a caixa de correio. O valor de InputObject é a caixa de correio na variável $m. Ele usa o parâmetro Property para especificar a propriedade Aliases e os parâmetros Add e Remove para especificar os itens que estão sendo adicionados e removidos do valor de Aliases.
O comando usa um operador de pipeline (|) para enviar o objeto de caixa de correio atualizado para o cmdlet Set-Mailbox, que altera a caixa de correio.
Exemplo 3
C:\PS>get-mailbox | set-mailbox -alias (update-list -Add "A", "B" -Remove "X","Y")
Descrição
-----------
Esse comando adiciona A e B ao valor da propriedade Aliases de uma caixa de correio e remove X e Y. Esse comando tem o mesmo efeito que os dois comandos anteriores, mas usa um procedimento diferente para executar a tarefa.
Em vez de atualizar a propriedade Aliases da caixa de correio antes de enviá-la para Set-Mailbox, esse comando usa Update-List para criar um objeto que representa a alteração. Em seguida, ele envia a alteração para o parâmetro Alias de Set-Mailbox.
O comando usa o cmdlet Get-MailBox para obter a caixa de correio. Um operador de pipeline envia o objeto de caixa de correio para o cmdlet Set-Mailbox, que altera as caixas de correio.
O comando usa o parâmetro Alias de Set-Mailbox para alterar a propriedade Aliases do objeto de caixa de correio. O valor do parâmetro Alias é um comando Update-List que cria um objeto que representa a atualização. O comando Update-List é colocado entre parênteses para garantir que seja executado antes que o valor do parâmetro Alias seja avaliado. Quando o comando Set-Mailbox é concluído, a caixa de correio é alterada.
Exemplo 4
C:\PS>update-list -InputObject $a -Property aliases -replace "A", "B" | set-mailbox
Descrição
-----------
Esse comando usa o operador Replace de Update-List para substituir a coleção na propriedade Aliases do objeto em $a com uma nova coleção.
Esse comando usa o parâmetro InputObject que, neste caso, é equivalente a usar um operador de pipeline para transmitir $a para o Update-List.