Update-List
Adiciona itens e remove itens de um valor de propriedade que contém uma coleção de objetos.
Sintaxe
AddRemoveSet (Predefinição)
Update-List
[[-Property] <String>]
[-Add <Object[]>]
[-Remove <Object[]>]
[-InputObject <PSObject>]
[<CommonParameters>]
ReplaceSet
Update-List
[[-Property] <String>]
-Replace <Object[]>
[-InputObject <PSObject>]
[<CommonParameters>]
Description
O cmdlet Update-List adiciona itens e remove itens de um valor de propriedade de um objeto e, em seguida, retorna o objeto atualizado. Este cmdlet foi projetado para propriedades que contêm coleções de objetos.
Os parâmetros Adicionar e Remover adicionar itens individuais e removê-los da coleção. O parâmetro Replace 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 atualizá-lo. Você pode enviar o objeto update para cmdlets que alteram objetos, como cmdlets Set-*.
Esse cmdlet funciona somente quando a propriedade que está sendo atualizada oferece suporte à interface IList que Update-List usa. Além disso, todos os cmdlets Set-* que aceitam uma atualização devem suportar a interface IList. Os cmdlets principais instalados com o Windows PowerShell não oferecem suporte a essa interface. Para determinar se um cmdlet oferece suporte a de Lista de Atualização , 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
Este 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 Add e Remove para especificar os itens que estão sendo adicionados e removidos da coleção. A propriedade Aliases cumpre as condições de Update-List, porque armazena uma coleção de objetos do Microsoft .NET Framework que têm métodos Add e Remover.
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
Este comando adiciona A e B ao valor da propriedade Aliases de uma caixa de correio e remove X e Y. Este 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. Este 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: Adicionar e remover itens de um valor de propriedade
PS C:\> Get-MailBox | Set-MailBox -Alias (Update-List -Add "A", "B" -Remove "X","Y")
Este comando adiciona A e B ao valor da propriedade Aliases de uma caixa de correio e remove X e Y. Este 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
Exemplo 4: Substituir uma coleção de propriedades
PS C:\> Update-List -InputObject $A -Property aliases -Replace "A", "B" | Set-MailBox
Este 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.
Este comando usa o parâmetro InputObject que, neste caso, é equivalente a usar 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 devem aparecer na coleção.
Propriedades dos parâmetros
| Tipo: | Object[] |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
AddRemoveSet
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-InputObject
Especifica os objetos a serem atualizados. Você também pode canalizar o objeto a ser atualizado para Update-List .
Propriedades dos parâmetros
| Tipo: | PSObject |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | 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.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | 0 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Remove
Especifica os valores de propriedade a serem removidos da coleção.
Propriedades dos parâmetros
| Tipo: | Object[] |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
AddRemoveSet
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Replace
Especifica uma nova coleção. Este parâmetro substitui todos os itens da coleção original pelos itens especificados por esse parâmetro.
Propriedades dos parâmetros
| Tipo: | Object[] |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
ReplaceSet
| Position: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.
Entradas
PSObject
Você pode canalizar os objetos a serem atualizados para Lista de Atualização.
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.