Update-TypeData

Sintassi

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

Descrizione

Il Update-TypeData cmdlet aggiorna i dati dei tipi estesi nella sessione ricaricando i Types.ps1xml file in memoria e aggiungendo nuovi dati di tipo esteso.

Per impostazione predefinita, PowerShell carica i dati di tipo esteso in base alle esigenze. Senza parametri, Update-TypeData ricarica tutti i file caricati nella sessione, inclusi i Types.ps1xml file di tipo aggiunti. È possibile usare i parametri di per aggiungere nuovi file di Update-TypeData tipo e aggiungere e sostituire i dati dei tipi estesi.

Il Update-TypeData cmdlet può essere usato per precaricare tutti i dati di tipo. Questa funzionalità è particolarmente utile quando si sviluppano tipi e si vogliono caricare i nuovi tipi a scopo di test.

A partire da Windows PowerShell 3.0, è possibile usare per aggiungere e sostituire i dati dei tipi estesi nella sessione senza usare Update-TypeData un Types.ps1xml file. I dati di tipo vengono aggiunti in modo dinamico, ovvero, senza un file, vengono aggiunti solo alla sessione corrente. Per aggiungere i dati del tipo a tutte le sessioni, aggiungere un Update-TypeData comando al profilo di PowerShell. Per altre informazioni, vedere about_Profiles.

Inoltre, a partire da Windows PowerShell 3.0, è possibile usare il Get-TypeData cmdlet per ottenere i tipi estesi nella sessione corrente e il Remove-TypeData cmdlet per eliminare i tipi estesi dalla sessione corrente.

Le eccezioni che si verificano nelle proprietà o dall'aggiunta di proprietà a un Update-TypeData comando non segnalano errori. Ciò serve a sopprimere le eccezioni che si verificherebbero in molti dei tipi più comuni durante la formattazione e l'output. Se si ottengono proprietà .NET, è possibile aggirare l'eliminazione delle eccezioni usando invece la sintassi del metodo, come illustrato nell'esempio seguente:

"hello".get_Length()

Si noti che la sintassi del metodo può essere usata solo con le proprietà .NET. Le proprietà aggiunte eseguendo il cmdlet non possono usare la sintassi del Update-TypeData metodo.

Per altre informazioni sui Types.ps1xml file in PowerShell, vedere about_Types.ps1xml.

Esempio

Esempio 1: Aggiornare i tipi estesi

Update-TypeData

Questo comando aggiorna la configurazione del Types.ps1xml tipo esteso dai file già usati nella sessione.

Esempio 2: Aggiornare i tipi più volte

In questo esempio viene illustrato come aggiornare i tipi in un file di tipo più volte nella stessa sessione.

Il primo comando aggiorna prima la configurazione del Types.ps1xml tipo esteso dai file, elaborando i TypesA.types.ps1xml file e TypesB.types.ps1xml .

Il secondo comando mostra come aggiornare di TypesA.types.ps1xml nuovo, ad esempio se è stato aggiunto o modificato un tipo nel file. È possibile ripetere il comando precedente per il TypesA.types.ps1xml file oppure eseguire un Update-TypeData comando senza parametri, perché TypesA.types.ps1xml è già presente nell'elenco di file di tipo per la sessione corrente.

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

Esempio 3: Aggiungere una proprietà script agli oggetti DateTime

In questo esempio viene Update-TypeData utilizzata per aggiungere la proprietà script Quarter agli oggetti System.DateTime nella sessione corrente, ad esempio quelli restituiti dal 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

Il Update-TypeData comando usa il parametro TypeName per specificare il tipo System.DateTime , il parametro MemberName per specificare un nome per la nuova proprietà, la proprietà MemberType per specificare il tipo ScriptProperty e il parametro Value per specificare lo script che determina il trimestre annuale.

Il valore della proprietà Value è uno script che calcola il trimestre annuale corrente. Il blocco di script usa la $this variabile automatica per rappresentare l'istanza corrente dell'oggetto e l'operatore In per determinare se il valore del mese viene visualizzato in ogni matrice integer. Per altre informazioni sull'operatore -in , vedere about_Comparison_Operators.

Il secondo comando recupera la nuova proprietà trimestre della data corrente.

Esempio 4: Aggiornare un tipo visualizzato negli elenchi per impostazione predefinita

In questo esempio viene illustrato come impostare le proprietà di un tipo visualizzato negli elenchi per impostazione predefinita, ovvero quando non vengono specificate proprietà. Poiché i dati di tipo non vengono specificati in un Types.ps1xml file, è effettivo solo nella sessione corrente.

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

Il primo comando mostra la visualizzazione elenco per il Get-Date comando, che restituisce un oggetto System.DateTime che rappresenta la data corrente. Il comando usa un operatore pipeline (|) per inviare l'oggetto DateTime al Format-List cmdlet . Poiché il Format-List comando non specifica le proprietà da visualizzare nell'elenco, PowerShell visualizza ogni proprietà pubblica e non nascosta per l'oggetto.

Il secondo comando usa il Update-TypeData cmdlet per impostare le proprietà di elenco predefinite per il tipo System.DateTime . Il comando usa il parametro TypeName per specificare il tipo e il parametro DefaultDisplayPropertySet per specificare le proprietà predefinite per un elenco. Le proprietà selezionate includono la nuova proprietà script Quarter aggiunta in un esempio precedente.

L'ultimo comando ottiene la data corrente e la visualizza nuovamente in un formato elenco. Visualizza solo le proprietà definite nel Update-TypeData comando, anziché l'elenco completo delle proprietà.

Esempio 5: Impostare la proprietà visualizzata in un tipo in formato wide

In questo esempio viene illustrato come creare una nuova proprietà script e usarla come proprietà predefinita visualizzata quando il tipo viene passato al 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

Il primo comando usa il Get-Command cmdlet per restituire ogni comando con un nome contenente la parola File. Invia tramite pipe l'output al Format-Wide cmdlet, che mostra i nomi dei comandi nelle colonne.

L'esempio usa Update-TypeData quindi per definire sia DefaultDisplayProperty che una nuova proprietà script per il tipo CommandInfo. L'output per Get-Command restituisce oggetti CommandInfo e oggetti derivati da tale tipo. La nuova proprietà script, FullyQualifiedName, restituisce il percorso completo delle applicazioni eseguibili e il nome completo per i cmdlet, che prefissi il nome del cmdlet con il modulo che lo definisce. Il Update-TypeData cmdlet è in grado di definire la nuova proprietà script e usarla come DefaultDisplayProperty nello stesso comando.

Infine, l'output mostra i risultati dell'oggetto Get-Command visualizzato in formato wide dopo l'aggiornamento del tipo. Mostra il nome completo per i cmdlet e il percorso completo delle applicazioni eseguibili.

Esempio 6: Aggiornare i dati del tipo per un oggetto inviato tramite pipe

$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 questo esempio viene illustrato che quando si invia tramite pipe un oggetto a Update-TypeData, Update-TypeData vengono aggiunti dati di tipo esteso per il tipo di oggetto.

Questa tecnica è più rapida rispetto all'uso del Get-Member cmdlet o del Get-Type metodo per ottenere il tipo di oggetto. Tuttavia, se si invia tramite pipe una raccolta di oggetti a Update-TypeData, aggiorna i dati di tipo del primo tipo di oggetto e quindi restituisce un errore per tutti gli altri oggetti dell'insieme perché il membro è già definito nel tipo.

Il primo comando usa il Get-Module cmdlet per ottenere il modulo Microsoft.PowerShell.Utility . Il comando invia tramite pipe l'oggetto modulo al Update-TypeData cmdlet , che aggiorna i dati di tipo per il tipo System.Management.Automation.PSModuleInfo e i tipi derivati da esso, ad esempio il tipo ModuleInfoGrouping che Get-Module restituisce quando si utilizza il parametro ListAvailable nel comando.

I Update-TypeData comandi aggiungono la proprietà script SupportsUpdatableHelp a tutti i moduli importati. Il valore del parametro Value è uno script che restituisce $true se la proprietà HelpInfoUri del modulo viene popolata e $false in caso contrario.

Il secondo comando invia tramite pipe gli oggetti modulo dal Get-Module Format-Table cmdlet , che visualizza le proprietà Name e SupportsUpdatableHelp dei moduli disponibili.

Parametri

-AppendPath

-Confirm

-DefaultDisplayProperty

-DefaultDisplayPropertySet

-DefaultKeyPropertySet

-Force

-InheritPropertySerializationSet

-MemberName

-MemberType

-PrependPath

-PropertySerializationSet

-SecondValue

-SerializationDepth

-SerializationMethod

-StringSerializationSource

-TargetTypeForDeserialization

-TypeAdapter

-TypeConverter

-TypeData

-TypeName

-Value

-WhatIf

Input

String

È possibile inviare tramite pipe una stringa contenente i valori dei parametri AppendPath, TypeName o TypeData a questo cmdlet.

Output

None

Questo cmdlet non restituisce output.

Collegamenti correlati

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