about_Properties
Краткое описание
Описывает, как использовать свойства объекта в PowerShell.
Подробное описание
PowerShell использует структурированные коллекции данных, называемых объектами, для представления элементов в хранилищах данных или состояния компьютера. Как правило, вы работаете с объектами, которые являются частью microsoft платформа .NET Framework, но вы также можете создавать пользовательские объекты в PowerShell.
Элемент и его объект тесно связаны между собой. При изменении объекта обычно изменяется и элемент, который он представляет. Например, при получении файла в PowerShell фактический файл не возвращается. Вместо этого вы получите объект FileInfo , представляющий файл. При изменении объекта FileInfo файл также изменяется.
Большинство объектов имеют свойства. Свойства — это данные, связанные с объектом . Различные типы объектов имеют разные свойства. Например, объект FileInfo , представляющий файл, имеет свойство IsReadOnly , содержащее $True значение , если файл имеет атрибут только для чтения, а $False если это не так. Объект DirectoryInfo , представляющий каталог файловой системы, имеет свойство Parent , содержащее путь к родительскому каталогу.
Свойства объекта
Чтобы получить свойства объекта, используйте Get-Member командлет . Например, чтобы получить свойства объекта FileInfo , используйте Get-ChildItem командлет , чтобы получить объект FileInfo, представляющий файл. Затем используйте оператор конвейера (|), чтобы отправить объект FileInfo в Get-Member. Следующая команда получает pwsh.exe файл и отправляет его в Get-Member. Автоматическая $PSHOME переменная содержит путь к каталогу установки PowerShell.
Get-ChildItem $PSHOME\pwsh.exe | Get-Member
Выходные данные команды перечисляют элементы объекта FileInfo . К элементам относятся свойства и методы. При работе в PowerShell у вас есть доступ ко всем членам объектов .
Чтобы получить только свойства объекта, а не методы, используйте параметр MemberType командлета Get-MemberPropertyсо значением , как показано в следующем примере.
Get-ChildItem $PSHOME\pwsh.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;}
Найдя свойства, их можно использовать в командах PowerShell.
Значения свойств
Несмотря на то, что все объекты определенного типа имеют одинаковые свойства, значения этих свойств описывают конкретный объект. Например, каждый объект FileInfo имеет свойство CreationTime , но его значение для каждого файла отличается.
Наиболее распространенным способом получения значений свойств объекта является использование оператора доступа к члену (.). Введите ссылку на объект, например переменную, содержащую этот объект, либо команду, которая его возвращает. Затем введите оператор (.), за которым следует имя свойства.
Например, следующая команда отображает значение свойства pwsh.exeCreationTime файла. Команда Get-ChildItem возвращает объект FileInfo , представляющий pwsh.exe file. Команда заключена в круглые скобки, чтобы убедиться, что она выполнена перед доступом к каким-либо свойствам.
(Get-ChildItem $PSHOME\pwsh.exe).CreationTime
Tuesday, June 14, 2022 5:17:14 PM
Можно также сохранить объект в переменной, а затем получить его свойства с помощью метода доступа к члену (.), как показано в следующем примере:
$a = Get-ChildItem $PSHOME\pwsh.exe
$a.CreationTime
Tuesday, June 14, 2022 5:17:14 PM
Можно также использовать Select-Object командлеты и Format-List для отображения значений свойств объекта . Select-Object и Format-List каждый из них имеет параметр Property . Параметр Property можно использовать для указания одного или нескольких свойств и их значений. Или можно использовать подстановочный знак (*) для представления всех свойств.
Например, следующая команда отображает значения всех свойств файла pwsh.exe.
Get-ChildItem $PSHOME\pwsh.exe | Format-List -Property *
PSPath : Microsoft.PowerShell.Core\FileSystem::C:\Program Files\PowerShell\7\pwsh.exe
PSParentPath : Microsoft.PowerShell.Core\FileSystem::C:\Program Files\PowerShell\7
PSChildName : pwsh.exe
PSDrive : C
PSProvider : Microsoft.PowerShell.Core\FileSystem
PSIsContainer : False
Mode : -a---
ModeWithoutHardLink : -a---
VersionInfo : File: C:\Program Files\PowerShell\7\pwsh.exe
InternalName: pwsh.dll
OriginalFilename: pwsh.dll
FileVersion: 7.3.9.500
FileDescription: pwsh
Product: PowerShell
ProductVersion: 7.3.9 SHA: 116d193ed28dcc6914653c799846bbf379cea0fb
Debug: False
Patched: False
PreRelease: False
PrivateBuild: False
SpecialBuild: False
Language: Language Neutral
BaseName : pwsh
ResolvedTarget : C:\Program Files\PowerShell\7\pwsh.exe
Target :
LinkType :
Length : 293312
DirectoryName : C:\Program Files\PowerShell\7
Directory : C:\Program Files\PowerShell\7
IsReadOnly : False
FullName : C:\Program Files\PowerShell\7\pwsh.exe
Extension : .exe
Name : pwsh.exe
Exists : True
CreationTime : 10/25/2023 7:00:18 PM
CreationTimeUtc : 10/26/2023 12:00:18 AM
LastAccessTime : 11/14/2023 5:14:36 PM
LastAccessTimeUtc : 11/14/2023 11:14:36 PM
LastWriteTime : 10/25/2023 7:00:18 PM
LastWriteTimeUtc : 10/26/2023 12:00:18 AM
LinkTarget :
UnixFileMode : -1
Attributes : Archive
Статические свойства
Статические свойства классов .NET можно использовать в PowerShell. Статические свойства являются свойствами класса, в отличие от стандартных свойств, которые являются свойствами объекта.
Чтобы получить статические свойства класса, используйте параметр Static командлета Get-Member . Например, следующая команда получает статические свойства System.DateTime класса .
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;}
Чтобы получить значение статического свойства, используйте следующий синтаксис.
[<ClassName>]::<Property>
Например, следующая команда возвращает значение статического свойства System.DateTimeUtcNow класса .
[System.DateTime]::UtcNow
Перечисление с доступом к членам
Начиная с PowerShell 3.0, при использовании оператора доступа к членам (.) для доступа к свойству, которое не существует в коллекции списков, PowerShell автоматически перечисляет элементы в коллекции и возвращает значение свойства для каждого элемента. Дополнительные сведения см. в разделе about_Member-Access_Enumeration.
Примеры
Эта команда возвращает значение свойства DisplayName каждой возвращающей Get-Service службы.
(Get-Service).DisplayName
Application Experience
Application Layer Gateway Service
Windows All-User Install Agent
Application Identity
Application Information
...
Все коллекции имеют свойство Count , которое возвращает количество объектов в коллекции.
(Get-Service).Count
176
Начиная с PowerShell 3.0, можно получить свойство Count или Length одноэлементных объектов, которые не являются коллекциями.
(Get-Service Audiosrv).Count
1
Однако некоторые объекты имеют свойство Length . Например, длина строки — это количество символов в строке. Свойство Count — это количество экземпляров объекта .
PS> $str = 'string'
PS> $str.Length
6
PS> $str.Count
1
Если свойство существует в отдельных объектах и в коллекции, возвращается только свойство коллекции.
$collection = @(
[pscustomobject]@{length = "foo"}
[pscustomobject]@{length = "bar"}
)
# PowerShell returns the collection's Length.
$collection.length
2