Update-TypeData

Синтаксис

Update-TypeData
      [[-AppendPath] <String[]>]
      [-PrependPath <String[]>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-TypeData
      [-MemberType <PSMemberTypes>]
      [-MemberName <String>]
      [-Value <Object>]
      [-SecondValue <Object>]
      [-TypeConverter <Type>]
      [-TypeAdapter <Type>]
      [-SerializationMethod <String>]
      [-TargetTypeForDeserialization <Type>]
      [-SerializationDepth <Int32>]
      [-DefaultDisplayProperty <String>]
      [-InheritPropertySerializationSet <Nullable`1>]
      [-StringSerializationSource <String>]
      [-DefaultDisplayPropertySet <String[]>]
      [-DefaultKeyPropertySet <String[]>]
      [-PropertySerializationSet <String[]>]
      -TypeName <String>
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-TypeData
      [-Force]
      [-TypeData] <TypeData[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Описание

Командлет Update-TypeData обновляет данные расширенного типа в сеансе, перезагрузив Types.ps1xml файлы в память и добавив новые данные расширенного типа.

По умолчанию PowerShell загружает данные расширенного типа по мере необходимости. Без параметров Update-TypeData перезагрузит все Types.ps1xml файлы, загруженные в сеансе, включая все добавленные файлы типов. Параметры можно использовать для добавления новых файлов типов и добавления и замены данных расширенного Update-TypeData типа.

Командлет Update-TypeData можно использовать для предварительной загрузки всех данных типа. Эта функция особенно полезна при разработке собственных типов, так как позволяет загружать их для тестирования.

Начиная с Windows PowerShell 3.0, можно использовать для Update-TypeData добавления и замены данных расширенного типа в сеансе без использования Types.ps1xml файла. Данные типа, добавленные динамически, то есть без помощи файла, добавляются только в текущий сеанс. Чтобы добавить данные типа ко всем сеансам, добавьте Update-TypeData команду в профиль PowerShell. Дополнительные сведения см. в разделе about_Profiles.

Кроме того, начиная с Windows PowerShell 3.0, можно использовать Get-TypeData командлет для получения расширенных типов в текущем сеансе и Remove-TypeData командлета для удаления расширенных типов из текущего сеанса.

Исключения, возникающие в свойствах или добавлении свойств в Update-TypeData команду, не сообщают об ошибках. Это необходимо для подавления исключений, которые могут возникнуть во многих распространенных типах в процессе форматирования и вывода. При получении свойств .NET можно обойти подавление исключений с помощью синтаксиса метода, как показано в следующем примере:

"hello".get_Length()

Обратите внимание, что синтаксис метода можно использовать только с свойствами .NET. Свойства, добавленные при выполнении командлета Update-TypeData , не могут использовать синтаксис метода.

Дополнительные сведения о файлах Types.ps1xml в PowerShell см. в разделе about_Types.ps1xml.

Примеры

Пример 1. Обновление расширенных типов

Update-TypeData

Эта команда обновляет конфигурацию расширенного типа из Types.ps1xml файлов, которые уже использовались в сеансе.

Пример 2. Типы обновлений несколько раз

В этом примере показано, как обновлять типы в файле типов несколько раз в одном сеансе.

Первая команда обновляет конфигурацию расширенного Types.ps1xml типа из файлов, обрабатывая TypesA.types.ps1xml файлы и TypesB.types.ps1xml файлы.

Вторая команда показывает, как обновить TypesA.types.ps1xml повторно, например, если вы добавили или изменили тип в файле. Вы можете повторить предыдущую Update-TypeData команду для TypesA.types.ps1xml файла или выполнить команду без параметров, так как TypesA.types.ps1xml уже находится в списке файлов типов для текущего сеанса.

Update-TypeData -PrependPath TypesA.types.ps1xml, TypesB.types.ps1xml
Update-TypeData -PrependPath TypesA.types.ps1xml

Пример 3. Добавление свойства скрипта в объекты DateTime

В этом примере используется Update-TypeData для добавления свойства скрипта "Квартал" в объекты System.DateTime в текущем сеансе, например возвращаемых командлетомGet-Date.

$typeDataParams = @{
    TypeName   = 'System.DateTime'
    MemberType = 'ScriptProperty'
    MemberName = 'Quarter'
    Value      = {
        switch ($this.Month) {
            { $_ -in @(1, 2, 3) } { return 'Q1' }
            { $_ -in @(4, 5, 6) } { return 'Q2' }
            { $_ -in @(7, 8, 9) } { return 'Q3' }
            default               { return 'Q4' }
        }
    }
}
Update-TypeData @typeDataParams

(Get-Date).Quarter

Q1

Команда Update-TypeData использует параметр TypeName для указания типа System.DateTime, параметра MemberName, чтобы указать имя нового свойства, свойство MemberType, чтобы указать тип ScriptProperty и параметр Value, чтобы указать скрипт, определяющий годовой квартал.

Значение свойства Value — это сценарий, вычисляющий текущий годовой квартал. Блок скрипта использует $this автоматическую переменную для представления текущего экземпляра объекта и оператора In, чтобы определить, отображается ли значение месяца в каждом целочисленном массиве. Дополнительные сведения об операторе -in см. в about_Comparison_Operators.

Вторая команда возвращает новое свойство Quarter текущей даты.

Пример 4. Обновление типа, отображающегося в списках по умолчанию

В этом примере показано, как задать свойства типа, отображаемого в списках по умолчанию, то есть если свойства не указаны. Так как данные типа не указаны в Types.ps1xml файле, он действует только в текущем сеансе.

Get-Date | Format-list

Update-TypeData -TypeName "System.DateTime" -DefaultDisplayPropertySet @(
    'DateTime'
    'DayOfYear'
    'Quarter'
)

Get-Date | Format-List

DisplayHint : DateTime
Date        : 8/7/2024 12:00:00 AM
Day         : 7
DayOfWeek   : Wednesday
DayOfYear   : 220
Hour        : 10
Kind        : Local
Millisecond : 568
Microsecond : 308
Nanosecond  : 600
Minute      : 34
Month       : 8
Second      : 43
Ticks       : 638586236835683086
TimeOfDay   : 10:34:43.5683086
Year        : 2024
DateTime    : Wednesday, August 7, 2024 10:34:43 AM
Quarter     : Q3


DateTime  : Wednesday, August 7, 2024 10:34:43 AM
DayOfYear : 220
Quarter   : Q3

Первая команда показывает представление списка для Get-Date команды, которая выводит объект System.DateTime , представляющий текущую дату. Команда использует оператор конвейера (|) для отправки объекта DateTime командлету Format-List . Format-List Так как команда не указывает свойства, отображаемые в списке, PowerShell отображает каждое общедоступное, не скрытое свойство для объекта.

Вторая команда использует Update-TypeData командлет для задания свойств списка по умолчанию для типа System.DateTime . С помощью параметра TypeName она определяет тип, а с помощью параметраDefaultDisplayPropertySet — свойства списка по умолчанию. Выбранные свойства включают новое свойство скрипта Квартал , добавленное в предыдущем примере.

Последняя команда получает дату currnet и снова отображает ее в формате списка. Он отображает только свойства, определенные в команде Update-TypeData , а не полный список свойств.

Пример 5. Задание свойства тип отображается в широком формате

В этом примере показано, как создать новое свойство скрипта и использовать его в качестве свойства по умолчанию, отображаемого при передаче типа командлету Format-Wide .

Get-Command *File* | Format-Wide

Set-AppPackageProvisionedDataFile                            Set-ProvisionedAppPackageDataFile
Set-ProvisionedAppXDataFile                                  Write-FileSystemCache
Write-FileSystemCache                                        Add-PoshGitToProfile
Block-FileShareAccess                                        Clear-FileStorageTier
Close-SmbOpenFile                                            Debug-FileShare
Disable-NetIPHttpsProfile                                    Enable-NetIPHttpsProfile
Get-FileIntegrity                                            Get-FileShare
Get-FileShareAccessControlEntry                              Get-FileStorageTier
Get-NetConnectionProfile                                     Get-NetFirewallHyperVProfile
Get-NetFirewallProfile                                       Get-SmbOpenFile
Get-StorageFileServer                                        Get-SupportedFileSystems
Grant-FileShareAccess                                        New-FileShare
New-NetFirewallHyperVProfile                                 New-ScriptFileInfo
New-ScriptFileInfo                                           New-StorageFileServer
Publish-BCFileContent                                        Remove-FileShare
Remove-NetFirewallHyperVProfile                              Remove-PoshGitFromProfile
Remove-StorageFileServer                                     Repair-FileIntegrity
Revoke-FileShareAccess                                       Set-FileIntegrity
Set-FileShare                                                Set-FileStorageTier
Set-NetConnectionProfile                                     Set-NetFirewallHyperVProfile
Set-NetFirewallProfile                                       Set-StorageBusProfile
Set-StorageFileServer                                        Test-ScriptFileInfo
Test-ScriptFileInfo                                          Unblock-FileShareAccess
Update-ScriptFileInfo                                        Update-ScriptFileInfo
Add-BitsFile                                                 Get-AppLockerFileInformation
Get-FileHash                                                 Get-PSScriptFileInfo
Import-PowerShellDataFile                                    New-FileCatalog
New-PSRoleCapabilityFile                                     New-PSScriptFileInfo
New-PSSessionConfigurationFile                               New-TemporaryFile
Out-File                                                     Set-AppXProvisionedDataFile
Test-FileCatalog                                             Test-PSScriptFileInfo
Test-PSSessionConfigurationFile                              Unblock-File
Update-PSScriptFileInfo                                      FileDialogBroker.exe
FileHistory.exe                                              forfiles.exe
openfiles.exe

$typeDataParams = @{
    TypeName               = 'System.Management.Automation.CommandInfo'
    DefaultDisplayProperty = 'FullyQualifiedName'
    MemberType             = 'ScriptProperty'
    MemberName             = 'FullyQualifiedName'
    Value                  = {
        [OutputType([string])]
        param()

        # For executables, return the path to the application.
        if ($this -is [System.Management.Automation.ApplicationInfo]) {
            return $this.Path
        }

        # For commands defined outside a module, return only the name.
        if ([string]::IsNullOrEmpty($this.ModuleName)) {
            return $this.Name
        }

        # Return the fully-qualified command name "<ModuleName>\<CommandName>"
        return '{0}\{1}' -f $this.ModuleName, $this.Name
    }
}
Update-TypeData @typeDataParams

Get-Command *File* | Format-Wide

Dism\Set-AppPackageProvisionedDataFile                       Dism\Set-ProvisionedAppPackageDataFile
Dism\Set-ProvisionedAppXDataFile                             Storage\Write-FileSystemCache
VMDirectStorage\Write-FileSystemCache                        posh-git\Add-PoshGitToProfile
Storage\Block-FileShareAccess                                Storage\Clear-FileStorageTier
SmbShare\Close-SmbOpenFile                                   Storage\Debug-FileShare
NetworkTransition\Disable-NetIPHttpsProfile                  NetworkTransition\Enable-NetIPHttpsProfile
Storage\Get-FileIntegrity                                    Storage\Get-FileShare
Storage\Get-FileShareAccessControlEntry                      Storage\Get-FileStorageTier
NetConnection\Get-NetConnectionProfile                       NetSecurity\Get-NetFirewallHyperVProfile
NetSecurity\Get-NetFirewallProfile                           SmbShare\Get-SmbOpenFile
Storage\Get-StorageFileServer                                Storage\Get-SupportedFileSystems
Storage\Grant-FileShareAccess                                Storage\New-FileShare
NetSecurity\New-NetFirewallHyperVProfile                     PowerShellGet\New-ScriptFileInfo
PowerShellGet\New-ScriptFileInfo                             Storage\New-StorageFileServer
BranchCache\Publish-BCFileContent                            Storage\Remove-FileShare
NetSecurity\Remove-NetFirewallHyperVProfile                  posh-git\Remove-PoshGitFromProfile
Storage\Remove-StorageFileServer                             Storage\Repair-FileIntegrity
Storage\Revoke-FileShareAccess                               Storage\Set-FileIntegrity
Storage\Set-FileShare                                        Storage\Set-FileStorageTier
NetConnection\Set-NetConnectionProfile                       NetSecurity\Set-NetFirewallHyperVProfile
NetSecurity\Set-NetFirewallProfile                           StorageBusCache\Set-StorageBusProfile
Storage\Set-StorageFileServer                                PowerShellGet\Test-ScriptFileInfo
PowerShellGet\Test-ScriptFileInfo                            Storage\Unblock-FileShareAccess
PowerShellGet\Update-ScriptFileInfo                          PowerShellGet\Update-ScriptFileInfo
BitsTransfer\Add-BitsFile                                    AppLocker\Get-AppLockerFileInformation
Microsoft.PowerShell.Utility\Get-FileHash                    Microsoft.PowerShell.PSResourceGet\Get-PSScriptFileInfo        
Microsoft.PowerShell.Utility\Import-PowerShellDataFile       Microsoft.PowerShell.Security\New-FileCatalog
Microsoft.PowerShell.Core\New-PSRoleCapabilityFile           Microsoft.PowerShell.PSResourceGet\New-PSScriptFileInfo        
Microsoft.PowerShell.Core\New-PSSessionConfigurationFile     Microsoft.PowerShell.Utility\New-TemporaryFile
Microsoft.PowerShell.Utility\Out-File                        Dism\Set-AppXProvisionedDataFile
Microsoft.PowerShell.Security\Test-FileCatalog               Microsoft.PowerShell.PSResourceGet\Test-PSScriptFileInfo       
Microsoft.PowerShell.Core\Test-PSSessionConfigurationFile    Microsoft.PowerShell.Utility\Unblock-File
Microsoft.PowerShell.PSResourceGet\Update-PSScriptFileInfo   C:\WINDOWS\system32\FileDialogBroker.exe
C:\WINDOWS\system32\FileHistory.exe                          C:\WINDOWS\system32\forfiles.exe
C:\WINDOWS\system32\openfiles.exe

Первая команда использует Get-Command командлет для возврата каждой команды с именем, содержащим слово File. Он передает выходные данные Format-Wide командлету, в котором отображаются имена команд в столбцах.

Далее пример используется Update-TypeData для определения свойства DefaultDisplayProperty и нового свойства скрипта для типа CommandInfo . Выходные данные для Get-Command возвращаемых объектов и объектов CommandInfo , производных от этого типа. Новое свойство скрипта FullQualifiedName возвращает полный путь к исполняемым приложениям и полное имя командлетов, которое префиксирует имя командлета с помощью модуля, определяющего его. Командлет Update-TypeData может определить новое свойство скрипта и использовать его в качестве defaultDisplayProperty в той же команде.

Наконец, выходные данные показывают результаты Get-Command отображения в широком формате после обновления типа. В нем отображается полное имя командлетов и полный путь к исполняемым приложениям.

Пример 6. Обновление данных типа для объекта с каналом

$typeDataParams = @{
    MemberType = 'ScriptProperty'
    MemberName = 'SupportsUpdatableHelp'
    Value      = {
        [OutputType([bool])]
        param()

        return (-not [string]::IsNullOrEmpty($this.HelpInfoUri))
    }
}
Get-Module Microsoft.PowerShell.Utility | Update-TypeData @typeDataParams

Get-Module -ListAvailable -Name Microsoft.PowerShell.* |
    Format-Table Name, SupportsUpdatableHelp

Name                                      SupportsUpdatableHelp
----                                      ---------------------
Microsoft.PowerShell.Archive                               True
Microsoft.PowerShell.Diagnostics                           True
Microsoft.PowerShell.Host                                  True
Microsoft.PowerShell.Management                            True
Microsoft.PowerShell.PSResourceGet                         True
Microsoft.PowerShell.Security                              True
Microsoft.PowerShell.Utility                               True
Microsoft.PowerShell.Operation.Validation                  True
Microsoft.PowerShell.LocalAccounts                         True

В этом примере показано, что при канале объекта Update-TypeDataUpdate-TypeData добавляется расширенные данные типа для типа объекта.

Этот метод быстрее, чем с помощью командлета Get-Member Get-Type или метода для получения типа объекта. Однако при канале коллекции объектов Update-TypeDataон обновляет данные типа первого типа объекта, а затем возвращает ошибку для всех остальных объектов в коллекции, так как элемент уже определен в типе.

Первая команда использует Get-Module командлет для получения модуля Microsoft.PowerShell.Utility . Командный объект передает объект Update-TypeData модуля командлету, который обновляет данные типа для типа System.Management.Automation.PSModuleInfo и типы, производные от него, например тип ModuleInfoGrouping , который Get-Module возвращается при использовании параметра ListAvailable в команде.

Команды Update-TypeData добавляют свойство скрипта SupportsUpdatableHelp ко всем импортированным модулям. Значение параметра Value — это скрипт, который возвращает $true , если свойство HelpInfoUri модуля заполняется и в $false противном случае.

Вторая команда передает объекты модуля из Get-Module Format-Table командлета, в котором отображаются свойства Name и SupportsUpdatableHelp доступных модулей.

Параметры

-AppendPath

-Confirm

-DefaultDisplayProperty

-DefaultDisplayPropertySet

-DefaultKeyPropertySet

-Force

-InheritPropertySerializationSet

-MemberName

-MemberType

-PrependPath

-PropertySerializationSet

-SecondValue

-SerializationDepth

-SerializationMethod

-StringSerializationSource

-TargetTypeForDeserialization

-TypeAdapter

-TypeConverter

-TypeData

-TypeName

-Value

-WhatIf

Входные данные

String

Можно передать строку, содержащую значения параметров AppendPath, TypeName или TypeData , в этот командлет.

Выходные данные

None

Этот командлет не возвращает выходные данные.

Связанные ссылки

• about_Types.ps1xml
• Get-TypeData
• Remove-TypeData