Update-TypeData

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

Update-TypeData
    -TypeName <String>
    [-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[]>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

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

Update-TypeData cmdlet 通过将 Types.ps1xml 文件重新加载到内存中并添加新的扩展类型数据来更新会话中的扩展类型数据。

默认情况下，PowerShell 会根据需要加载扩展类型数据。 如果没有参数，Update-TypeData 会重新加载会话中加载的所有 Types.ps1xml 文件，包括添加的任何类型文件。 可以使用 Update-TypeData 的参数添加新类型文件并添加和替换扩展类型数据。

Update-TypeData cmdlet 可用于预加载所有类型的数据。 当你开发类型并希望加载这些新类型以进行测试时，此功能特别有用。

从 Windows PowerShell 3.0 开始，可以使用 Update-TypeData 在会话中添加和替换扩展类型数据，而无需使用 Types.ps1xml 文件。 动态添加的类型数据（即不带文件）仅添加到当前会话中。 若要将类型数据添加到所有会话，请将 Update-TypeData 命令添加到 PowerShell 配置文件。 有关详细信息，请参阅 about_Profiles。

此外，从 Windows PowerShell 3.0 开始，可以使用 Get-TypeData cmdlet 获取当前会话中的扩展类型，Remove-TypeData cmdlet 从当前会话中删除扩展类型。

属性中发生的异常或从将属性添加到 Update-TypeData 命令时，不会报告错误。 这是为了禁止在格式化和输出过程中在很多常见类型中发生的异常。 如果你要获得 .NET 属性，可以通过改用方法语法来处理取消显示异常问题，如下面的示例所示：

"hello".get_Length()

请注意，方法语法只能与 .NET 属性一起使用。 通过运行 Update-TypeData cmdlet 添加的属性不能使用方法语法。

有关 PowerShell 中的 Types.ps1xml 文件的详细信息，请参阅 about_Types.ps1xml。

Update-TypeData

此命令从会话中使用的 Types.ps1xml 文件更新扩展类型配置。

此示例演示如何在同一会话中多次更新类型文件中的类型。

第一个命令从 Types.ps1xml 文件更新扩展类型配置，首先处理 TypesA.types.ps1xml 和 TypesB.types.ps1xml 文件。

第二个命令演示如何再次更新 TypesA.types.ps1xml，例如，如果添加或更改了文件中的类型，则可以执行此作。 可以为 TypesA.types.ps1xml 文件重复上一个命令，也可以运行不带参数的 Update-TypeData 命令，因为 TypesA.types.ps1xml 已在当前会话的类型文件列表中。

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

此示例使用 Update-TypeData 将 Quarter 脚本属性 添加到当前会话中的 system.DateTime 对象，例如 Get-Date cmdlet 返回的对象。

$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 属性。

此示例演示如何设置默认在列表中显示的类型的属性，即未指定任何属性时。 由于类型数据未在 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
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 cmdlet。 由于 Format-List 命令未指定要在列表中显示的属性，因此 PowerShell 显示对象的每个公共非隐藏属性。

第二个命令使用 Update-TypeData cmdlet 设置 System.DateTime 类型的默认列表属性。 该命令使用 TypeName 参数指定类型，DefaultDisplayPropertySet 参数指定列表的默认属性。 所选属性包括前面示例中添加的新 Quarter 脚本属性。

最后一个命令获取当前日期，并再次以列表格式显示它。 它仅显示 Update-TypeData 命令中定义的属性，而不是属性的完整列表。

此示例演示如何创建新的脚本属性，并将其用作将类型传递给 Format-Wide cmdlet 时显示的默认属性。

Get-Command *File* | Format-Wide

Set-AppPackageProvisionedDataFile                          Set-ProvisionedAppPackageDataFile
Set-ProvisionedAppXDataFile                                Write-FileSystemCache
Write-FileSystemCache                                      Block-FileShareAccess
Clear-FileStorageTier                                      Close-SmbOpenFile
Debug-FileShare                                            Disable-NetIPHttpsProfile
Enable-NetIPHttpsProfile                                   Get-FileHash
Get-FileIntegrity                                          Get-FileShare
Get-FileShareAccessControlEntry                            Get-FileStorageTier
Get-NetConnectionProfile                                   Get-NetFirewallHyperVProfile
Get-NetFirewallProfile                                     Get-SmbOpenFile
Get-StorageFileServer                                      Get-SupportedFileSystems
Grant-FileShareAccess                                      Import-PowerShellDataFile
New-FileShare                                              New-NetFirewallHyperVProfile
New-ScriptFileInfo                                         New-StorageFileServer
New-TemporaryFile                                          Publish-BCFileContent
Remove-FileShare                                           Remove-NetFirewallHyperVProfile
Remove-StorageFileServer                                   Repair-FileIntegrity
Revoke-FileShareAccess                                     Set-FileIntegrity
Set-FileShare                                              Set-FileStorageTier
Set-NetConnectionProfile                                   Set-NetFirewallHyperVProfile
Set-NetFirewallProfile                                     Set-StorageBusProfile
Set-StorageFileServer                                      Test-ScriptFileInfo
Unblock-FileShareAccess                                    Update-ScriptFileInfo
Add-BitsFile                                               Get-AIPFileStatus
Get-AppLockerFileInformation                               New-FileCatalog
New-PSRoleCapabilityFile                                   New-PSSessionConfigurationFile
Out-File                                                   Set-AIPFileClassification
Set-AIPFileLabel                                           Set-AppXProvisionedDataFile
Set-UevTemplateProfile                                     Test-FileCatalog
Test-PSSessionConfigurationFile                            Unblock-File
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                      Storage\Block-FileShareAccess
Storage\Clear-FileStorageTier                              SmbShare\Close-SmbOpenFile
Storage\Debug-FileShare                                    NetworkTransition\Disable-NetIPHttpsProfile
NetworkTransition\Enable-NetIPHttpsProfile                 Microsoft.PowerShell.Utility\Get-FileHash
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                              Microsoft.PowerShell.Utility\Import-PowerShellDataFile
Storage\New-FileShare                                      NetSecurity\New-NetFirewallHyperVProfile
PowerShellGet\New-ScriptFileInfo                           Storage\New-StorageFileServer
Microsoft.PowerShell.Utility\New-TemporaryFile             BranchCache\Publish-BCFileContent
Storage\Remove-FileShare                                   NetSecurity\Remove-NetFirewallHyperVProfile
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
Storage\Unblock-FileShareAccess                            PowerShellGet\Update-ScriptFileInfo
BitsTransfer\Add-BitsFile                                  AzureInformationProtection\Get-AIPFileStatus
AppLocker\Get-AppLockerFileInformation                     Microsoft.PowerShell.Security\New-FileCatalog
Microsoft.PowerShell.Core\New-PSRoleCapabilityFile         Microsoft.PowerShell.Core\New-PSSessionConfigurationFile
Microsoft.PowerShell.Utility\Out-File                      AzureInformationProtection\Set-AIPFileClassification
AzureInformationProtection\Set-AIPFileLabel                Dism\Set-AppXProvisionedDataFile
UEV\Set-UevTemplateProfile                                 Microsoft.PowerShell.Security\Test-FileCatalog
Microsoft.PowerShell.Core\Test-PSSessionConfigurationFile  Microsoft.PowerShell.Utility\Unblock-File
C:\WINDOWS\system32\FileDialogBroker.exe                   C:\WINDOWS\system32\FileHistory.exe
C:\WINDOWS\system32\forfiles.exe                           C:\WINDOWS\system32\openfiles.exe

第一个命令使用 Get-Command cmdlet 返回包含单词 File的名称的每个命令。 它通过管道将输出传递给 Format-Wide cmdlet，该 cmdlet 显示列中命令的名称。

接下来，该示例使用 Update-TypeData 定义 DefaultDisplayProperty 和 CommandInfo 类型的新脚本属性。 Get-Command 的输出返回 CommandInfo 派生自该类型的对象和对象。 新的脚本属性，FullyQualifiedName，返回可执行应用程序的完整路径和 cmdlet 的完全限定名称，该名称为 cmdlet 名称加上定义它的模块前缀。 Update-TypeData cmdlet 能够定义新的脚本属性，并将其用作同一命令中的 DefaultDisplayProperty。

最后，输出显示类型更新后以宽格式显示的 Get-Command 的结果。 它显示 cmdlet 的完全限定名称以及可执行应用程序的完整路径。

$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.Operation.Validation                  True
Microsoft.PowerShell.Archive                               True
Microsoft.PowerShell.Diagnostics                           True
Microsoft.PowerShell.Host                                  True
Microsoft.PowerShell.LocalAccounts                         True
Microsoft.PowerShell.Management                            True
Microsoft.PowerShell.ODataUtils                            True
Microsoft.PowerShell.Security                              True
Microsoft.PowerShell.Utility                               True

此示例演示在通过管道将对象传递给 Update-TypeData时，Update-TypeData 为对象类型添加扩展类型数据。

此方法比使用 Get-Member cmdlet 或 Get-Type 方法获取对象类型要快。 但是，如果通过管道将对象集合传递给 Update-TypeData，它将更新第一个对象类型的类型数据，然后返回集合中所有其他对象的错误，因为该成员已在类型上定义。

第一个命令使用 Get-Module cmdlet 获取 Microsoft.PowerShell.Utility 模块。 该命令通过管道将模块对象传递给 Update-TypeData cmdlet，该 cmdlet 会更新 System.Management.Automation.PSModuleInfo 类型和派生自它的类型，例如 ModuleInfoGrouping 类型，Get-Module 在命令中使用 ListAvailable 参数时返回。

Update-TypeData 命令将 SupportsUpdatableHelp 脚本属性添加到所有导入的模块。 Value 参数的值是一个脚本，如果填充模块的 $true 属性并 ，则返回 $false。

第二个命令通过管道将模块对象从 Get-Module 传递给 Format-Table cmdlet，该 cmdlet 显示 Name 和 SupportsUpdatableHelp 可用模块的属性。

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。

可以通过管道将包含 AppendPath、TypeName的值或 TypeData 参数的字符串传递给此 cmdlet。

此 cmdlet 不返回任何输出。