Compartilhar via

Update-List

  • Referência
Módulo:
Microsoft.PowerShell.Utility

Adiciona itens e remove itens de um valor de propriedade que contém uma coleção de objetos.

Sintaxe

Update-List
      [-Add <Object[]>]
      [-Remove <Object[]>]
      [-InputObject <PSObject>]
      [[-Property] <String>]
      [<CommonParameters>]
Update-List
      -Replace <Object[]>
      [-InputObject <PSObject>]
      [[-Property] <String>]
      [<CommonParameters>]

Description

O cmdlet Update-List adiciona itens e remove itens de um valor de propriedade de um objeto e retorna o objeto atualizado. Esse cmdlet foi projetado para propriedades que contêm coleções de objetos.

Os parâmetros Adicionar e Remover adicionam itens individuais e os removem da coleção. O parâmetro Substituir substitui toda a coleção.

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. Você pode enviar o objeto de atualização para cmdlets que alteram objetos, como cmdlets Set-*.

Esse cmdlet funciona somente quando a propriedade que está sendo atualizada dá suporte à interface IList que a lista de atualizações usa. Além disso, todos os cmdlets set-* que aceitam uma atualização devem dar suporte à interface IList. Os principais cmdlets instalados com o Windows PowerShell não dão suporte a essa interface. Para determinar se um cmdlet dá suporte a de Lista de Atualizações, consulte o tópico da Ajuda do cmdlet.

Exemplos

Exemplo 1: Adicionar e remover itens de um valor de propriedade

PS C:\> Get-MailBox | Update-List -Property aliases -Add "A","B" -Remove "X","Y" | Set-MailBox

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 de correio. 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 Adicionar e Remover 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 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.

Exemplo 2: Adicionar e remover itens de um valor de propriedade em uma variável

PS C:\> $M = Get-MailBox
PS C:\> Update-List -InputObject $M -Property aliases -Add "A","B" -Remove "X", "Y" | Set-MailBox

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 ligeiramente diferente.

O comando usa o cmdlet Get-MailBox para obter a caixa de correio e salva a caixa de correio na variável $M. Esse comando usa o parâmetro InputObject de lista de atualizações 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 Adicionar e Remover 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: Adicionar e remover itens de um valor de propriedade

PS C:\> Get-MailBox | Set-MailBox -Alias (Update-List -Add "A", "B" -Remove "X","Y")

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 represente a alteração. Em seguida, ele envia a alteração para o parâmetro do 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 está entre parênteses para garantir que ele seja executado antes que o valor do parâmetro Alias seja avaliado. Quando o comando Set-Mailbox for concluído, a caixa de correio será alterada.

Exemplo 4: substituir uma coleção de propriedades

PS C:\> Update-List -InputObject $A -Property aliases -Replace "A", "B" | Set-MailBox

Esse comando usa o operador Replace de Update-List para substituir a coleção na propriedade Aliases do objeto em $A por uma nova coleção.

Esse comando usa o parâmetro InputObject que, nesse caso, é equivalente ao uso de um operador de pipeline para passar $A para update-list.

Parâmetros

-Add

Especifica os valores de propriedade a serem adicionados à coleção. Insira os valores na ordem em que eles devem aparecer na coleção.

Tipo:Object[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-InputObject

Especifica os objetos a serem atualizados. Você também pode canalizar o objeto a ser atualizado para lista de atualizações.

Tipo:PSObject
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Property

Especifica 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.

Tipo:String
Cargo:0
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Remove

Especifica os valores de propriedade a serem removidos da coleção.

Tipo:Object[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Replace

Especifica uma nova coleção. Esse parâmetro substitui todos os itens da coleção original pelos itens especificados por esse parâmetro.

Tipo:Object[]
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

PSObject

Você pode canalizar os objetos a serem atualizados para de Lista de Atualizações.

Saídas

Objects or System.Management.Automation.PSListModifier

Update-List retorna o objeto atualizado ou retorna um objeto que representa a ação de atualização.