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

De Update-TypeData cmdlet werkt de uitgebreide typegegevens in de sessie bij door de Types.ps1xml bestanden opnieuw in het geheugen te laden en nieuwe uitgebreide typegegevens toe te voegen.

PowerShell laadt standaard uitgebreide gegevens van het type omdat deze nodig zijn. Zonder parameters laadt Update-TypeData alle Types.ps1xml bestanden die in de sessie zijn geladen, inclusief alle typebestanden die u hebt toegevoegd. U kunt de parameters van Update-TypeData gebruiken om nieuwe typebestanden toe te voegen en uitgebreide typegegevens toe te voegen en te vervangen.

De cmdlet Update-TypeData kan worden gebruikt om alle typegegevens vooraf te laden. Deze functie is met name handig wanneer u typen ontwikkelt en deze nieuwe typen wilt laden voor testdoeleinden.

Vanaf Windows PowerShell 3.0 kunt u Update-TypeData gebruiken om uitgebreide typegegevens in de sessie toe te voegen en te vervangen zonder een Types.ps1xml bestand te gebruiken. Typ gegevens die dynamisch worden toegevoegd, dus zonder een bestand, worden alleen toegevoegd aan de huidige sessie. Als u de typegegevens aan alle sessies wilt toevoegen, voegt u een Update-TypeData opdracht toe aan uw PowerShell-profiel. Zie about_Profilesvoor meer informatie.

Vanaf Windows PowerShell 3.0 kunt u ook de cmdlet Get-TypeData gebruiken om de uitgebreide typen in de huidige sessie op te halen en de Remove-TypeData cmdlet om uitgebreide typen uit de huidige sessie te verwijderen.

Uitzonderingen die voorkomen in eigenschappen of van het toevoegen van eigenschappen aan een Update-TypeData opdracht, melden geen fouten. Dit is om uitzonderingen te onderdrukken die in veel algemene typen voorkomen tijdens het opmaken en uitvoeren. Als u .NET-eigenschappen krijgt, kunt u in plaats daarvan de onderdrukking van uitzonderingen omzeilen met behulp van de syntaxis van de methode, zoals wordt weergegeven in het volgende voorbeeld:

"hello".get_Length()

Houd er rekening mee dat de syntaxis van de methode alleen kan worden gebruikt met .NET-eigenschappen. Eigenschappen die worden toegevoegd door de cmdlet Update-TypeData uit te voeren, kunnen geen syntaxis van de methode gebruiken.

Zie Types.ps1xmlvoor meer informatie over de -bestanden in PowerShell.

Update-TypeData

Met deze opdracht wordt de configuratie van het uitgebreide type bijgewerkt van de Types.ps1xml bestanden die al in de sessie zijn gebruikt.

In dit voorbeeld ziet u hoe u de typen in een typebestand meerdere keren in dezelfde sessie bijwerkt.

Met de eerste opdracht wordt de configuratie van het uitgebreide type bijgewerkt van de Types.ps1xml-bestanden, waarna de TypesA.types.ps1xml- en TypesB.types.ps1xml-bestanden eerst worden verwerkt.

De tweede opdracht laat zien hoe u de TypesA.types.ps1xml opnieuw bijwerkt, bijvoorbeeld als u een type in het bestand hebt toegevoegd of gewijzigd. U kunt de vorige opdracht voor het TypesA.types.ps1xml-bestand herhalen of een Update-TypeData opdracht zonder parameters uitvoeren, omdat TypesA.types.ps1xml al in de lijst met typebestanden voor de huidige sessie staat.

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

In dit voorbeeld wordt Update-TypeData gebruikt om de scripteigenschap Quarter toe te voegen aan System.DateTime--objecten in de huidige sessie, zoals objecten die worden geretourneerd door de 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

De opdracht Update-TypeData gebruikt de parameter TypeName om op te geven het type System.DateTime, de parameter MemberName om een naam op te geven voor de nieuwe eigenschap, de eigenschap MemberType om het Type ScriptProperty op te geven en de parameter Waarde om het script op te geven dat het jaarlijkse kwartaal bepaalt.

De waarde van de eigenschap Value is een script waarmee het huidige jaarkwartaal wordt berekend. Het scriptblok maakt gebruik van de $this automatische variabele om het huidige exemplaar van het object en de Operator In weer te geven om te bepalen of de maandwaarde wordt weergegeven in elke matrix met gehele getallen. Zie -invoor meer informatie over de operator .

Met de tweede opdracht wordt de nieuwe eigenschap Quarter van de huidige datum ophaalt.

In dit voorbeeld ziet u hoe u de eigenschappen van een type instelt dat standaard wordt weergegeven in lijsten, dat wil gezegd, wanneer er geen eigenschappen zijn opgegeven. Omdat de typegegevens niet zijn opgegeven in een Types.ps1xml-bestand, is dit alleen van kracht in de huidige sessie.

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

De eerste opdracht toont de lijstweergave voor de opdracht Get-Date, waarmee een System.DateTime--object wordt uitgevoerd dat de huidige datum vertegenwoordigt. De opdracht maakt gebruik van een pijplijnoperator (|) om het DateTime--object naar de Format-List-cmdlet te verzenden. Omdat de opdracht Format-List niet de eigenschappen opgeeft die in de lijst moeten worden weergegeven, geeft PowerShell elke openbare, niet-verborgen eigenschap voor het object weer.

De tweede opdracht maakt gebruik van de Update-TypeData cmdlet om de standaardlijsteigenschappen in te stellen voor het System.DateTime type. De opdracht gebruikt de parameter TypeName om het type en de parameter DefaultDisplayPropertySet op te geven om de standaardeigenschappen voor een lijst op te geven. De geselecteerde eigenschappen bevatten de nieuwe Quarter scripteigenschap die in een vorig voorbeeld is toegevoegd.

Met de laatste opdracht wordt de huidige datum opgehaald en weergegeven in een lijstindeling. Hiermee worden alleen de eigenschappen weergegeven die zijn gedefinieerd in de opdracht Update-TypeData, in plaats van de volledige lijst met eigenschappen.

In dit voorbeeld ziet u hoe u een nieuwe scripteigenschap maakt en deze gebruikt als de standaardeigenschap die wordt weergegeven wanneer het type wordt doorgegeven aan de Format-Wide cmdlet.

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

De eerste opdracht gebruikt de Get-Command cmdlet om elke opdracht met een naam met het woord Filete retourneren. Het pijpt de uitvoer naar de Format-Wide cmdlet, waarin de namen van de opdrachten in kolommen worden weergegeven.

Vervolgens wordt in het voorbeeld Update-TypeData gebruikt om zowel de DefaultDisplayProperty- als een nieuwe scripteigenschap voor het CommandInfo- type te definiëren. De uitvoer voor Get-Command retourneert CommandInfo objecten en objecten die zijn afgeleid van dat type. De nieuwe scripteigenschap, FullyQualifiedName, retourneert het volledige pad naar uitvoerbare toepassingen en de volledig gekwalificeerde naam voor cmdlets, waarmee de naam van de cmdlet wordt voorafgegaan door de module die deze definieert. De cmdlet Update-TypeData kan de nieuwe scripteigenschap definiëren en gebruiken als de DefaultDisplayProperty- in dezelfde opdracht.

Ten slotte toont de uitvoer de resultaten van de Get-Command in brede indeling weergegeven na de type-update. Hier ziet u de volledig gekwalificeerde naam voor cmdlets en het volledige pad naar uitvoerbare toepassingen.

$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

In dit voorbeeld ziet u dat wanneer u een object doorsluist naar Update-TypeData, Update-TypeData uitgebreide typegegevens toevoegt voor het objecttype.

Deze techniek is sneller dan het gebruik van de Get-Member cmdlet of de Get-Type methode om het objecttype op te halen. Als u echter een verzameling objecten doorsluist naar Update-TypeData, worden de typegegevens van het eerste objecttype bijgewerkt en wordt vervolgens een fout geretourneerd voor alle andere objecten in de verzameling omdat het lid al is gedefinieerd voor het type.

De eerste opdracht maakt gebruik van de Get-Module cmdlet om de Microsoft.PowerShell.Utility module op te halen. De opdracht geeft het moduleobject door aan de Update-TypeData cmdlet, waarmee de typegegevens voor het System.Management.Automation.PSModuleInfo type worden bijgewerkt, zoals het ModuleInfoGrouping type dat Get-Module retourneert wanneer u de ListAvailable parameter in de opdracht gebruikt.

Met de Update-TypeData-opdrachten wordt de scripteigenschap SupportsUpdatableHelp toegevoegd aan alle geïmporteerde modules. De waarde van de parameter Value is een script dat $true retourneert als de eigenschap HelpInfoUri van de module wordt ingevuld en anders $false.

Met de tweede opdracht worden de moduleobjecten van Get-Module naar de Format-Table-cmdlet uitgevoerd, waarin de eigenschappen Name en SupportsUpdatableHelp van de beschikbare modules worden weergegeven.

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

U kunt een tekenreeks met de waarden van de AppendPath-, TypeNameof TypeData--parameters doorsluisen naar deze cmdlet.

Deze cmdlet retourneert geen uitvoer.