about_Properties
Description courte
Décrit comment utiliser des propriétés d’objet dans PowerShell.
Description longue
PowerShell utilise des collections structurées d’informations appelées objets pour représenter les éléments dans les magasins de données ou l’état de l’ordinateur. En règle générale, vous travaillez avec des objets qui font partie de Microsoft .NET Framework, mais vous pouvez également créer des objets personnalisés dans PowerShell.
L’association entre un élément et son objet est très proche. Lorsque vous modifiez un objet, vous modifiez généralement l’élément qu’il représente. Par exemple, lorsque vous obtenez un fichier dans PowerShell, vous n’obtenez pas le fichier réel. Au lieu de cela, vous obtenez un objet FileInfo qui représente le fichier. Lorsque vous modifiez l’objet FileInfo, le fichier change également.
La plupart des objets ont des propriétés. Les propriétés sont les données associées à un objet. Différents types d’objet ont des propriétés différentes. Par exemple, un objet FileInfo, qui représente un fichier, a une propriété IsReadOnly qui contient $True si le fichier est l’attribut en lecture seule et $False si ce n’est pas le cas. Un objet DirectoryInfo, qui représente un répertoire de système de fichiers, a une propriété Parent qui contient le chemin d’accès au répertoire parent.
Propriétés des objets
Pour obtenir les propriétés d’un objet, utilisez l’applet de Get-Member commande . Par exemple, pour obtenir les propriétés d’un objet FileInfo , utilisez l’applet de Get-ChildItem commande pour obtenir l’objet FileInfo qui représente un fichier. Ensuite, utilisez un opérateur de pipeline (|) pour envoyer l’objet FileInfo à Get-Member. La commande suivante obtient le fichier PowerShell.exe et l’envoie à Get-Member.
La variable automatique $Pshome contient le chemin du répertoire d’installation de PowerShell.
Get-ChildItem $pshome\PowerShell.exe | Get-Member
La sortie de la commande répertorie les membres de l’objet FileInfo . Les membres incluent à la fois des propriétés et des méthodes. Lorsque vous travaillez dans PowerShell, vous avez accès à tous les membres des objets.
Pour obtenir uniquement les propriétés d’un objet et non les méthodes, utilisez le paramètre MemberType de l’applet Get-Member de commande avec la valeur « property », comme illustré dans l’exemple suivant.
Get-ChildItem $pshome\PowerShell.exe | Get-Member -MemberType property
TypeName: System.IO.FileInfo
Name MemberType Definition
---- ---------- ----------
Attributes Property System.IO.FileAttributes Attributes {get;set;}
CreationTime Property System.DateTime CreationTime {get;set;}
CreationTimeUtc Property System.DateTime CreationTimeUtc {get;set;}
Directory Property System.IO.DirectoryInfo Directory {get;}
DirectoryName Property System.String DirectoryName {get;}
Exists Property System.Boolean Exists {get;}
Extension Property System.String Extension {get;}
FullName Property System.String FullName {get;}
IsReadOnly Property System.Boolean IsReadOnly {get;set;}
LastAccessTime Property System.DateTime LastAccessTime {get;set;}
LastAccessTimeUtc Property System.DateTime LastAccessTimeUtc {get;set;}
LastWriteTime Property System.DateTime LastWriteTime {get;set;}
LastWriteTimeUtc Property System.DateTime LastWriteTimeUtc {get;set;}
Length Property System.Int64 Length {get;}
Name Property System.String Name {get;}
Une fois que vous avez trouvé les propriétés, vous pouvez les utiliser dans vos commandes PowerShell.
Valeurs de propriétés
Bien que chaque objet d’un type spécifique possède les mêmes propriétés, les valeurs de ces propriétés décrivent l’objet particulier. Par exemple, chaque objet FileInfo a une propriété CreationTime, mais la valeur de cette propriété diffère pour chaque fichier.
La façon la plus courante d’obtenir les valeurs des propriétés d’un objet consiste à utiliser la méthode dot. Tapez une référence à l’objet, telle qu’une variable qui contient l’objet, ou une commande qui obtient l’objet. Ensuite, tapez un point (.) suivi du nom de la propriété.
Par exemple, la commande suivante affiche la valeur de la propriété CreationTime du fichier PowerShell.exe. La Get-ChildItem commande retourne un objet FileInfo qui représente le fichier PowerShell.exe. La commande est placée entre parenthèses pour s’assurer qu’elle est exécutée avant l’accès à toutes les propriétés. La Get-ChildItem commande est suivie d’un point et du nom de la propriété CreationTime, comme suit :
(Get-ChildItem $pshome\PowerShell.exe).creationtime
Tuesday, March 18, 2008 12:07:52 AM
Vous pouvez également enregistrer un objet dans une variable, puis obtenir ses propriétés à l’aide de la méthode dot, comme illustré dans l’exemple suivant :
$a = Get-ChildItem $pshome\PowerShell.exe
$a.CreationTime
Tuesday, March 18, 2008 12:07:52 AM
Vous pouvez également utiliser les applets de Select-Object commande et Format-List pour afficher les valeurs de propriété d’un objet. Select-Object et Format-List ont chacun un paramètre Property . Vous pouvez utiliser le paramètre Property pour spécifier une ou plusieurs propriétés et leurs valeurs. Vous pouvez également utiliser le caractère générique (*) pour représenter toutes les propriétés.
Par exemple, la commande suivante affiche les valeurs de toutes les propriétés du fichier PowerShell.exe.
Get-ChildItem $pshome\PowerShell.exe | Format-List -Property *
PSPath : Microsoft.PowerShell.Core\FileSystem::C:\Windows\System3
2\WindowsPowerShell\v1.0\PowerShell.exe
PSParentPath : Microsoft.PowerShell.Core\FileSystem::C:\Windows\System3
2\WindowsPowerShell\v1.0
PSChildName : PowerShell.exe
PSDrive : C
PSProvider : Microsoft.PowerShell.Core\FileSystem
PSIsContainer : False
Mode : -a----
VersionInfo : File: C:\Windows\System32\WindowsPowerShell\
v1.0\PowerShell.exe
InternalName: POWERSHELL
OriginalFilename: PowerShell.EXE.MUI
FileVersion: 10.0.16299.15 (WinBuild.160101.0800)
FileDescription: Windows PowerShell
Product: Microsoft Windows Operating System
ProductVersion: 10.0.16299.15
Debug: False
Patched: False
PreRelease: False
PrivateBuild: False
SpecialBuild: False
Language: English (United States)
BaseName : PowerShell
Target : {C:\Windows\WinSxS\amd64_microsoft-windows-powershell-ex
e_31bf3856ad364e35_10.0.16299.15_none_8c022aa6735716ae\p
owershell.exe}
LinkType : HardLink
Name : PowerShell.exe
Length : 449024
DirectoryName : C:\Windows\System32\WindowsPowerShell\v1.0
Directory : C:\Windows\System32\WindowsPowerShell\v1.0
IsReadOnly : False
Exists : True
FullName : C:\Windows\System32\WindowsPowerShell\v1.0\PowerShell.ex
Extension : .exe
CreationTime : 9/29/2017 6:43:19 AM
CreationTimeUtc : 9/29/2017 1:43:19 PM
LastAccessTime : 9/29/2017 6:43:19 AM
LastAccessTimeUtc : 9/29/2017 1:43:19 PM
LastWriteTime : 9/29/2017 6:43:19 AM
LastWriteTimeUtc : 9/29/2017 1:43:19 PM
Attributes : Archive
Propriétés statiques
Vous pouvez utiliser les propriétés statiques des classes .NET dans PowerShell. Les propriétés statiques sont des propriétés de classe, contrairement aux propriétés standard, qui sont des propriétés d’un objet.
Pour obtenir les propriétés statiques d’une classe, utilisez le paramètre Static de l’applet de commande Get-Member.
Par exemple, la commande suivante obtient les propriétés statiques de la System.DateTime classe .
Get-Date | Get-Member -MemberType Property -Static
TypeName: System.DateTime
Name MemberType Definition
---- ---------- ----------
MaxValue Property static datetime MaxValue {get;}
MinValue Property static datetime MinValue {get;}
Now Property datetime Now {get;}
Today Property datetime Today {get;}
UtcNow Property datetime UtcNow {get;}
Pour obtenir la valeur d’une propriété statique, utilisez la syntaxe suivante.
[<ClassName>]::<Property>
Par exemple, la commande suivante obtient la valeur de la propriété statique UtcNow de la System.DateTime classe .
[System.DateTime]::UtcNow
Énumération des accès aux membres
À compter de PowerShell 3.0, lorsque vous utilisez l’opérateur d’accès aux membres (.) pour accéder à une propriété qui n’existe pas dans une collection de listes, PowerShell énumère automatiquement les éléments de la collection et retourne la valeur de la propriété sur chaque élément. Pour plus d’informations, consultez about_Member-Access_Enumeration.
Exemples
Cette commande retourne la valeur de la propriété DisplayName de chaque service retourné Get-Service .
(Get-Service).DisplayName
Application Experience
Application Layer Gateway Service
Windows All-User Install Agent
Application Identity
Application Information
...
Toutes les collections ont une propriété Count qui retourne le nombre d’objets dans la collection.
(Get-Service).Count
176
À partir de PowerShell 3.0, si vous demandez la propriété Count ou Length de zéro objet ou d’un objet, PowerShell retourne la valeur correcte.
(Get-Service Audiosrv).Count
1
Si une propriété existe sur les objets individuels et sur la collection, seule la propriété de la collection est retournée.
$collection = @(
[pscustomobject]@{length = "foo"}
[pscustomobject]@{length = "bar"}
)
# PowerShell returns the collection's Length.
$collection.length
2