Ajoute et supprime des éléments dans une valeur de propriété contenant une collection d'objets.
Syntaxe
Update-List [-Add <Object[]>] [-Remove <Object[]>] [[-Property] <string>] [-InputObject <psobject>] [<CommonParameters>] Update-List -Replace <Object[]> [[-Property] <string>] [-InputObject <psobject>] [<CommonParameters>]
Description
L'applet de commande Update-List ajoute et supprime des éléments dans une valeur de propriété d'un objet, puis elle retourne l'objet mis à jour. Cette applet de commande est conçue pour les propriétés contenant des collections d'objets.
Les paramètres Add et Remove ajoutent et suppriment des éléments individuels dans la collection. Le paramètre Replace remplace l'ensemble de la collection.
Si vous ne spécifiez pas de propriété dans la commande, Update-List retourne un objet qui décrit la mise à jour au lieu de mettre à jour l'objet. Vous pouvez envoyer l'objet mise à jour aux applets de commande qui modifient les objets, tels que les applets de commande Set-*.
Cette applet de commande fonctionne uniquement lorsque la propriété mise à jour prend en charge l'interface IList utilisée par Update-List. En outre, toutes les applets de commande Set-* qui acceptent une mise à jour doivent prendre en charge l'interface IList. Les applets de commande principales installées avec Windows PowerShell ne prennent pas en charge cette interface. Pour déterminer si une applet de commande prend en charge Update-List, consultez la rubrique d'aide de cette applet de commande.
Paramètres
-Add <Object[]>
Spécifie les valeurs de propriété à ajouter à la collection. Entrez les valeurs dans l'ordre où elles doivent apparaître dans la collection.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-InputObject <psobject>
Spécifie les objets à mettre à jour. Vous pouvez également diriger l'objet à mettre à jour vers Update-List.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
true (ByValue) |
|
Accepter les caractères génériques ? |
false |
-Property <string>
Identifie la propriété contenant la collection mise à jour. Si vous omettez ce paramètre, Update-List retourne un objet qui représente la modification au lieu de modifier l'objet.
|
Obligatoire ? |
false |
|
Position ? |
1 |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Remove <Object[]>
Spécifie les valeurs de propriété à supprimer de la collection.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Replace <Object[]>
Spécifie une nouvelle collection. Ce paramètre remplace tous les éléments de la collection d'origine par les éléments spécifiés par ce paramètre.
|
Obligatoire ? |
true |
|
Position ? |
named |
|
Valeur par défaut |
aucun |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
<CommonParameters>
Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez about_Commonparameters.
Entrées et sorties
Le type d'entrée est le type des objets que vous pouvez diriger vers l'applet de commande. Le type de retour est le type des objets que l'applet de commande retourne.
|
Entrées |
System.Management.Automation.PSObject Vous pouvez diriger les objets à mettre à jour vers Update-List. |
|
Sorties |
Objets ou System.Management.Automation.PSListModifier Update-List retourne l'objet mis à jour, ou retourne un objet représentant l'action de mise à jour. |
Exemple 1
C:\PS>get-mailbox | update-list -Property aliases -Add "A","B" -Remove "X","Y" | set-mailbox Description ----------- Cette commande ajoute A et B et supprime X et Y dans la propriété Aliases d'une boîte aux lettres. Elle utilise l'applet de commande Get-MailBox de Microsoft Exchange Server pour obtenir la boîte aux lettres. Un opérateur de pipeline envoie l'objet boîte aux lettres à l'applet de commande Update-List. La commande Update-List utilise le paramètre Property pour indiquer que la propriété Aliases de la boîte aux lettres est mise à jour, et elle utilise les paramètres Add et Remove pour spécifier les éléments qui sont ajoutés et supprimés dans la collection. La propriété Aliases remplit les conditions de Update-List, car elle stocke une collection d'objets Microsoft .NET Framework possédant les méthodes Add et Remove. L'applet de commande Update-List retourne la boîte aux lettres mise à jour, qui est dirigée vers l'applet de commande Set-MailBox qui change la boîte aux lettres. Pour plus d'informations sur Get-Mailbox, consultez https://go.microsoft.com/fwlink/?LinkId=111536 (page éventuellement en anglais).
Exemple 2
C:\PS>$m = get-mailbox C:\PS> update-list -InputObject $m -Property aliases -Add "A","B" -Remove "X", "Y" | set-mailbox Description ----------- Cette commande ajoute A et B à la valeur de la propriété Aliases d'une boîte aux lettres et supprime X et Y. Elle a le même effet que la commande précédente, bien qu'elle présente un format légèrement différent. La commande utilise l'applet de commande Get-MailBox pour obtenir la boîte aux lettres, qu'elle enregistre dans la variable $m. Cette commande utilise le paramètre InputObject de Update-List pour spécifier la boîte aux lettres. La valeur d'InputObject est la boîte aux lettres située dans la variable $m. Elle utilise le paramètre Property pour spécifier la propriété Aliases, ainsi que les paramètres Add et Remove pour spécifier les éléments qui sont ajoutés et supprimés de la valeur d'Alias. La commande utilise un opérateur de pipeline (|) pour envoyer l'objet boîte aux lettres mis à jour à l'applet de commande Set-Mailbox, qui change la boîte aux lettres.
Exemple 3
C:\PS>get-mailbox | set-mailbox -alias (update-list -Add "A", "B" -Remove "X","Y") Description ----------- Cette commande ajoute A et B à la valeur de la propriété Aliases d'une boîte aux lettres et supprime X et Y. Elle a le même effet que les deux commandes précédentes, mais elle utilise une procédure différente. Au lieu de mettre à jour la propriété Aliases de la boîte aux lettres avant de l'envoyer à Set-Mailbox, cette commande utilise Update-List pour créer un objet représentant le changement. Elle envoie ensuite ce changement au paramètre Alias de Set-Mailbox. La commande utilise l'applet de commande Get-MailBox pour obtenir la boîte aux lettres. Un opérateur de pipeline envoie l'objet boîte aux lettres à l'applet de commande Set-Mailbox, qui change les boîtes aux lettres. La commande utilise le paramètre Alias de Set-Mailbox pour modifier la propriété Aliases de l'objet boîte aux lettres. La valeur du paramètre Alias est une commande Update-List qui crée un objet représentant la mise à jour. La commande Update-List est mise entre parenthèses pour garantir qu'elle s'exécute avant l'évaluation de la valeur du paramètre Alias. Lorsque la commande Set-Mailbox s'achève, la boîte aux lettres est modifiée.
Exemple 4
C:\PS>update-list -InputObject $a -Property aliases -replace "A", "B" | set-mailbox Description ----------- Cette commande utilise l'opérateur Replace de Update-List pour remplacer la collection de la propriété Aliases de l'objet de la variable $a par une nouvelle collection. Elle utilise le paramètre InputObject qui, dans ce cas, est équivalent à l'utilisation d'un opérateur de pipeline pour passer $a à Update-List.
Voir aussi