Update-TypeData

Syntax

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>]

Description

Cmdleten Update-TypeData uppdaterar de utökade typdata i sessionen genom att Types.ps1xml läsa in filerna i minnet igen och lägga till nya utökade typdata.

Som standard läser PowerShell in utökade typdata efter behov. Utan parametrar Update-TypeData läser du in alla filer som har lästs in i sessionen igen, inklusive alla typer av Types.ps1xml filer som du har lagt till. Du kan använda parametrarna Update-TypeData för för att lägga till nya typfiler och lägga till och ersätta utökade typdata.

Cmdleten Update-TypeData kan användas för att förinläsa alla typdata. Den här funktionen är särskilt användbar när du utvecklar typer och vill läsa in de nya typerna i testsyfte.

Från och med Windows PowerShell 3.0 kan du använda Update-TypeData för att lägga till och ersätta utökade typdata i sessionen utan att använda en Types.ps1xml fil. Skriv data som läggs till dynamiskt, dvs. utan en fil, läggs bara till i den aktuella sessionen. Om du vill lägga till typdata i alla sessioner lägger du till ett Update-TypeData kommando i din PowerShell-profil. Mer information finns i about_Profiles.

Från och med Windows PowerShell 3.0 kan du också använda cmdleten Get-TypeData för att hämta de utökade typerna i den aktuella sessionen och cmdleten Remove-TypeData för att ta bort utökade typer från den aktuella sessionen.

Undantag som inträffar i egenskaper, eller från att lägga till egenskaper i ett Update-TypeData kommando, rapporterar inte fel. Detta är för att förhindra undantag som skulle inträffa i många vanliga typer under formatering och utdata. Om du får .NET-egenskaper kan du kringgå undertryckningen av undantag med hjälp av metodsyntax i stället, som du ser i följande exempel:

"hello".get_Length()

Observera att metodsyntax endast kan användas med .NET-egenskaper. Egenskaper som läggs till genom att köra cmdleten Update-TypeData kan inte använda metodsyntax.

Mer information om Types.ps1xml filerna i PowerShell finns i about_Types.ps1xml.

Exempel

Exempel 1: Uppdatera utökade typer

Update-TypeData

Det här kommandot uppdaterar konfigurationen av den utökade typen från de Types.ps1xml filer som redan har använts i sessionen.

Exempel 2: Uppdateringstyper flera gånger

Det här exemplet visar hur du uppdaterar typerna i en typfil flera gånger i samma session.

Det första kommandot uppdaterar konfigurationen Types.ps1xml av den utökade typen från filerna och bearbetar TypesA.types.ps1xml TypesB.types.ps1xml filerna först.

Det andra kommandot visar hur du uppdaterar TypesA.types.ps1xml igen, till exempel om du har lagt till eller ändrat en typ i filen. Du kan antingen upprepa föregående kommando för TypesA.types.ps1xml filen eller köra ett Update-TypeData kommando utan parametrar, eftersom TypesA.types.ps1xml det redan finns i typfillistan för den aktuella sessionen.

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

Exempel 3: Lägg till en skriptegenskap i DateTime-objekt

I det här exemplet används Update-TypeData för att lägga till egenskapen Kvartalsskript till System.DateTime-objekt i den aktuella sessionen, till exempel de som returneras av cmdleten 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

Kommandot Update-TypeData använder parametern TypeName för att ange typen System.DateTime , parametern MemberName för att ange ett namn för den nya egenskapen, egenskapen MemberType för att ange typen ScriptProperty och parametern Value för att ange skriptet som avgör det årliga kvartalet.

Värdet för egenskapen Value är ett skript som beräknar det aktuella årliga kvartalet. Skriptblocket använder den $this automatiska variabeln för att representera den aktuella instansen av objektet och In-operatorn för att avgöra om månadsvärdet visas i varje heltalsmatris. Mer information om operatorn finns i -in about_Comparison_Operators.

Det andra kommandot hämtar den nya egenskapen Quarter för det aktuella datumet.

Exempel 4: Uppdatera en typ som visas i listor som standard

Det här exemplet visar hur du anger egenskaperna för en typ som visas i listor som standard, det vill säga när inga egenskaper har angetts. Eftersom typdata inte anges i en Types.ps1xml fil är de endast effektiva i den aktuella sessionen.

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

Det första kommandot visar listvyn för Get-Date kommandot, som matar ut ett System.DateTime-objekt som representerar det aktuella datumet. Kommandot använder en pipelineoperator (|) för att skicka DateTime-objektet till cmdleten Format-List . Format-List Eftersom kommandot inte anger de egenskaper som ska visas i listan visar PowerShell alla offentliga, icke-dolda egenskaper för objektet.

Det andra kommandot använder cmdleten Update-TypeData för att ange standardlisteegenskaperna för typen System.DateTime . Kommandot använder parametern TypeName för att ange typen och parametern DefaultDisplayPropertySet för att ange standardegenskaperna för en lista. De valda egenskaperna inkluderar den nya egenskapen Kvartalsskript som lades till i ett tidigare exempel.

Det senaste kommandot hämtar det aktuella datumet och visar det i listformat igen. Den visar bara de egenskaper som definierats i Update-TypeData kommandot i stället för den fullständiga listan med egenskaper.

Exempel 5: Ange egenskapen som en typ visas i brett format

Det här exemplet visar hur du skapar en ny skriptegenskap och använder den som standardegenskap som visas när typen skickas till cmdleten 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

Det första kommandot använder cmdleten Get-Command för att returnera varje kommando med ett namn som innehåller ordet File. Den skickar utdata till cmdleten Format-Wide , som visar namnen på kommandona i kolumner.

Sedan används Update-TypeData exemplet för att definiera både DefaultDisplayProperty och en ny skriptegenskap för Typen CommandInfo . Utdata för Get-Command returnerar CommandInfo-objekt och objekt som härletts från den typen. Den nya skriptegenskapen FullyQualifiedName returnerar den fullständiga sökvägen till körbara program och det fullständigt kvalificerade namnet för cmdletar, som prefixar cmdlet-namnet med modulen som definierar den. Cmdleten Update-TypeData kan definiera den nya skriptegenskapen och använda den som DefaultDisplayProperty i samma kommando.

Slutligen visar utdata resultatet av det Get-Command som visas i brett format efter typuppdateringen. Den visar det fullständigt kvalificerade namnet för cmdletar och den fullständiga sökvägen till körbara program.

Exempel 6: Uppdatera typdata för ett rörobjekt

$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

Det här exemplet visar att när du rör ett objekt till lägger Update-TypeData du till Update-TypeDatautökade typdata för objekttypen.

Den här tekniken går snabbare än att använda cmdleten Get-Member Get-Type eller metoden för att hämta objekttypen. Men om du skickar en samling objekt till Update-TypeDatauppdaterar den typdata för den första objekttypen och returnerar sedan ett fel för alla andra objekt i samlingen eftersom medlemmen redan har definierats för typen.

Det första kommandot använder cmdleten Get-Module för att hämta modulen Microsoft.PowerShell.Utility . Kommandot skickar modulobjektet till cmdletenUpdate-TypeData, som uppdaterar typdata för typen System.Management.Automation.PSModuleInfo och de typer som härleds från den, till exempel modulinfogruppstypen som Get-Module returneras när du använder parametern ListAvailable i kommandot.

Kommandona Update-TypeData lägger till skriptegenskapen SupportsUpdatableHelp till alla importerade moduler. Värdet för parametern Value är ett skript som returnerar $true om egenskapen HelpInfoUri för modulen är ifylld och $false på annat sätt.

Det andra kommandot dirigerar modulobjekten från Get-Module till cmdletenFormat-Table, som visar egenskaperna Namn och SupportsUpdatableHelp för de tillgängliga modulerna.

Parametrar

-AppendPath

-Confirm

-DefaultDisplayProperty

-DefaultDisplayPropertySet

-DefaultKeyPropertySet

-Force

-InheritPropertySerializationSet

-MemberName

-MemberType

-PrependPath

-PropertySerializationSet

-SecondValue

-SerializationDepth

-SerializationMethod

-StringSerializationSource

-TargetTypeForDeserialization

-TypeAdapter

-TypeConverter

-TypeData

-TypeName

-Value

-WhatIf

Indata

String

Du kan skicka en sträng som innehåller värdena för parametrarna AppendPath, TypeName eller TypeData till den här cmdleten.

Utdata

None

Den här cmdleten returnerar inga utdata.

Relaterade länkar

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