about_Types.ps1xml

Korte beschrijving

Legt uit hoe u bestanden gebruikt Types.ps1xml om de typen objecten uit te breiden die worden gebruikt in PowerShell.

Lange beschrijving

Uitgebreide typegegevens definiëren aanvullende eigenschappen en methoden ('leden') van objecttypen in PowerShell. Er zijn twee technieken voor het toevoegen van uitgebreide typegegevens aan een PowerShell-sessie.

  • Types.ps1xml bestand: een XML-bestand dat uitgebreide typegegevens definieert.
  • Update-TypeData: Een cmdlet die bestanden opnieuw laadt Types.ps1xml en uitgebreide gegevens definieert voor typen in de huidige sessie.

In dit onderwerp worden bestanden Types.ps1xml beschreven. Zie Update-TypeDataUpdate-TypeData voor meer informatie over het gebruik van de cmdlet om dynamische uitgebreide typegegevens toe te voegen aan de huidige sessie.

Uitgebreide typegegevens

Uitgebreide typegegevens definiëren aanvullende eigenschappen en methoden ('leden') van objecttypen in PowerShell. U kunt elk type uitbreiden dat wordt ondersteund door PowerShell en de toegevoegde eigenschappen en methoden op dezelfde manier gebruiken als de eigenschappen die zijn gedefinieerd voor de objecttypen.

PowerShell voegt bijvoorbeeld een eigenschap DateTime toe aan alle System.DateTime objecten, zoals de objecten die Get-Date de cmdlet retourneert.

(Get-Date).DateTime
Sunday, January 29, 2012 9:43:57 AM

U vindt de eigenschap DateTime niet in de beschrijving van de structuur System.DateTime , omdat PowerShell de eigenschap toevoegt en deze alleen zichtbaar is in PowerShell.

PowerShell definieert intern een standaardset uitgebreide typen. Deze typegegevens worden bij het opstarten in elke PowerShell-sessie geladen. De eigenschap DateTime maakt deel uit van deze standaardset. Vóór PowerShell 6 werden de typedefinities opgeslagen in Types.ps1xml de PowerShell-installatiemap ($PSHOME).

Uitgebreide gegevens van het type toevoegen aan PowerShell

Er zijn drie bronnen van uitgebreide gegevens in PowerShell-sessies.

  • Uitgebreide typegegevens worden gedefinieerd door PowerShell en automatisch in elke PowerShell-sessie geladen. Vanaf PowerShell 6 wordt deze informatie gecompileerd in PowerShell en wordt deze niet meer verzonden in een Types.ps1xml bestand.

  • De Types.ps1xml bestanden die modules exporteren, worden geladen wanneer de module wordt geïmporteerd in de huidige sessie.

  • Uitgebreide type gegevens die is gedefinieerd met behulp van de Update-TypeData cmdlet wordt alleen toegevoegd aan de huidige sessie. Het wordt niet opgeslagen in een bestand.

In de sessie worden de uitgebreide typegegevens uit de drie bronnen op dezelfde manier toegepast op objecten en zijn ze beschikbaar voor alle objecten van de opgegeven typen.

De TypeData-cmdlets

De volgende cmdlets zijn opgenomen in de module Microsoft.PowerShell.Utility in PowerShell 3.0 en hoger.

  • Get-TypeData: Haalt uitgebreide typegegevens op in de huidige sessie.
  • Update-TypeData: bestanden opnieuw Types.ps1xml laden. Uitgebreide typegegevens toegevoegd aan de huidige sessie.
  • Remove-TypeData: hiermee verwijdert u uitgebreide type gegevens uit de huidige sessie.

Zie het Help-onderwerp voor elke cmdlet voor meer informatie over deze cmdlets.

Ingebouwde Types.ps1xml-bestanden

De Types.ps1xml bestanden in de $PSHOME map worden automatisch toegevoegd aan elke sessie.

Het Types.ps1xml bestand in de PowerShell-installatiemap ($PSHOME) is een op XML gebaseerd tekstbestand waarmee u eigenschappen en methoden kunt toevoegen aan de objecten die worden gebruikt in PowerShell. PowerShell heeft ingebouwde bestanden Types.ps1xml die verschillende elementen toevoegen aan de .NET-typen, Types.ps1xml maar u kunt aanvullende bestanden maken om de typen verder uit te breiden.

Matrixobjecten () hebben bijvoorbeeld standaardSystem.Array de eigenschap Length waarin het aantal objecten in de matrix wordt vermeld. Omdat de naam Length de eigenschap niet duidelijk beschrijft, voegt PowerShell echter een alias-eigenschap toe met de naam Count die dezelfde waarde werekent. Met de volgende XML wordt de eigenschap Count toegevoegd aan het System.Array type .

<Type>
  <Name>System.Array</Name>
  <Members>
    <AliasProperty>
      <Name>Count</Name>
      <ReferencedMemberName>
        Length
      </ReferencedMemberName>
    </AliasProperty>
  </Members>
</Type>

Als u de nieuwe AliasProperty wilt op halen, gebruikt u een Get-Member opdracht in een matrix, zoals wordt weergegeven in het volgende voorbeeld.

Get-Member -InputObject (1,2,3,4)

De opdracht retourneert de volgende resultaten.

Name       MemberType    Definition
----       ----------    ----------
Count      AliasProperty Count = Length
Address    Method        System.Object& Address(Int32)
Clone      Method        System.Object Clone()
CopyTo     Method        System.Void CopyTo(Array array, Int32 index):
Equals     Method        System.Boolean Equals(Object obj)
Get        Method        System.Object Get(Int32)
# ...

Als gevolg hiervan kunt u de eigenschap Count of de eigenschap Length van matrices in PowerShell gebruiken. Bijvoorbeeld:

(1, 2, 3, 4).count
4
(1, 2, 3, 4).length
4

Nieuwe Types.ps1xml-bestanden maken

De .ps1xml bestanden die zijn geïnstalleerd met PowerShell, zijn digitaal ondertekend om manipulatie te voorkomen, omdat de opmaak scriptblokken kan bevatten. Als u daarom een eigenschap of methode wilt toevoegen aan een .NET-type, Types.ps1xml maakt u uw eigen bestanden en voegt u deze vervolgens toe aan uw PowerShell-sessie.

Als u een nieuw bestand wilt maken, begint u met het kopiëren van een bestaand Types.ps1xml bestand. Het nieuwe bestand kan elke naam hebben, maar moet een bestandsnaamextensie .ps1xml hebben. U kunt het nieuwe bestand in elke map plaatsen die toegankelijk is voor PowerShell, maar het is handig om de bestanden in de PowerShell-installatiemap ($PSHOME) of in een submap van de installatiemap te plaatsen.

Wanneer u het nieuwe bestand hebt opgeslagen, gebruikt u Update-TypeData de cmdlet om het nieuwe bestand toe te voegen aan uw PowerShell-sessie. Als u wilt dat uw typen voorrang hebben op de ingebouwde typen die zijn gedefinieerd, gebruikt u de parameter PrependData van de Update-TypeData cmdlet . Update-TypeData is alleen van invloed op de huidige sessie. Als u alle toekomstige sessies wilt wijzigen, exporteert u de -console of voegt u de opdracht Update-TypeData toe aan uw PowerShell-profiel.

Types.ps1xml en Add-Member

De Types.ps1xml bestanden voegen eigenschappen en methoden toe aan alle exemplaren van de objecten van het opgegeven .NET-type in de betreffende PowerShell-sessie. Als u echter alleen eigenschappen of methoden wilt toevoegen aan één exemplaar van een object, gebruikt u de Add-Member cmdlet .

Zie Add-Member (Lid toevoegen) voor meer informatie.

Voorbeeld: Een Age-lid toevoegen aan FileInfo-objecten

In dit voorbeeld ziet u hoe u een eigenschap Age toevoegt aan System.IO.FileInfo-objecten . De leeftijd van een bestand is het verschil tussen de aanmaaktijd en de huidige tijd in dagen.

Omdat de eigenschap Age wordt berekend met behulp van een scriptblok, <ScriptProperty> moet u een tag zoeken die moet worden gebruikt als model voor de nieuwe eigenschap Age.

Sla de volgende XML-code op in het bestand $PSHOME\MyTypes.ps1xml.

<?xml version="1.0" encoding="utf-8" ?>
<Types>
  <Type>
    <Name>System.IO.FileInfo</Name>
    <Members>
      <ScriptProperty>
        <Name>Age</Name>
        <GetScriptBlock>
          ((Get-Date) - ($this.CreationTime)).Days
        </GetScriptBlock>
      </ScriptProperty>
    </Members>
  </Type>
</Types>

Voer uit Update-TypeData om het nieuwe bestand Types.ps1xml toe te voegen aan de huidige sessie. De opdracht maakt gebruik van de parameter PrependData om het nieuwe bestand in een hogere volgorde te plaatsen dan de oorspronkelijke definities.

Zie Update-TypeDataUpdate-TypeData voor meer informatie over .

Update-Typedata -PrependPath $PSHOME\MyTypes.ps1xml

Als u de wijziging wilt testen, Get-ChildItem moet u een opdracht uitvoeren om het PowerShell.exe-bestand op te halen in $PSHOME Format-List de map en het bestand vervolgens doorspijpen naar de cmdlet om alle eigenschappen van het bestand weer te geven. Als gevolg van de wijziging wordt de eigenschap Age in de lijst weergegeven.

Get-ChildItem $PSHOME\pwsh.exe | Select-Object Age
142

De XML in Types.ps1xml-bestanden

De volledige schemadefinitie vindt u in Types.xsd in de Opslagplaats voor PowerShell-broncode op GitHub.

De <Types> tag sluit alle typen in die in het bestand zijn gedefinieerd. Er mag slechts één <Types> tag zijn.

Elk .NET-type dat in het bestand wordt vermeld, moet worden vertegenwoordigd door een <Type> tag.

De typetags moeten de volgende tags bevatten:

<Name>: Sluit de naam van het betrokken .NET-type in.

<Members>: Sluit de tags in voor de nieuwe eigenschappen en methoden die zijn gedefinieerd voor het .NET-type.

Elk van de volgende lidtags kan zich in de <Members> tag .

AliasProperty

Hiermee definieert u een nieuwe naam voor een bestaande eigenschap.

De <AliasProperty> tag moet een tag hebben <Name> die de naam van <ReferencedMemberName> de nieuwe eigenschap specificeert en een tag die de bestaande eigenschap specificeert.

De eigenschap Count alias is bijvoorbeeld een alias voor de eigenschap Length van matrixobjecten.

<Type>
  <Name>System.Array</Name>
  <Members>
    <AliasProperty>
      <Name>Count</Name>
      <ReferencedMemberName>Length</ReferencedMemberName>
    </AliasProperty>
  </Members>
</Type>

CodeMethod

Verwijst naar een statische methode van een .NET-klasse.

De <CodeMethod> tag moet een <Name> tag hebben waarmee de naam <CodeReference> van de nieuwe methode wordt opgegeven en een tag die de code specificeert waarin de methode is gedefinieerd.

De methode ToString is bijvoorbeeld de naam van de codedefinitie Microsoft.PowerShell.ToStringCodeMethods .

  <Type>
    <Name>System.Xml.XmlNode</Name>
    <Members>
      <CodeMethod>
        <Name>ToString</Name>
        <CodeReference>
          <TypeName>Microsoft.PowerShell.ToStringCodeMethods</TypeName>
          <MethodName>XmlNode</MethodName>
        </CodeReference>
      </CodeMethod>
    </Members>
  </Type>

CodeProperty

Verwijst naar een statische methode van een .NET-klasse.

De <CodeProperty> tag moet een <Name> tag hebben die de <GetCodeReference> naam van de nieuwe eigenschap specificeert en een tag die de code specificeert waarin de eigenschap is gedefinieerd.

De eigenschap Mode van objecten is bijvoorbeeld System.IO.DirectoryInfo een code-eigenschap die is gedefinieerd in de PowerShell FileSystem-provider.

<Type>
  <Name>System.IO.DirectoryInfo</Name>
  <Members>
    <CodeProperty>
      <Name>Mode</Name>
      <GetCodeReference>
        <TypeName>
          Microsoft.PowerShell.Commands.FileSystemProvider
        </TypeName>
        <MethodName>Mode</MethodName>
      </GetCodeReference>
    </CodeProperty>
  </Members>
</Type>

MemberSet

Definieert een verzameling leden (eigenschappen en methoden).

De <MemberSet> tags worden weergegeven binnen de primaire <Members> tags. De tags moeten een tag <Members> rond <Name> de naam van de ledenset en een secundaire tag rond de leden (eigenschappen en methoden) in de set zetten. Alle tags die een eigenschap maken (<NoteProperty>``<ScriptProperty>zoals of ) of een methode (<Method>``<ScriptMethod>zoals of ) kunnen lid zijn van de set.

In Types.ps1xml bestanden wordt de <MemberSet> tag gebruikt om de standaardweergaven van de .NET-objecten in PowerShell te definiëren. In dit geval is de naam van de ledenset ( <Name> de waarde binnen de tags) altijd PsStandardMembers en zijn de namen van de eigenschappen ( <Name> de waarde van de tag) een van de volgende:

  • DefaultDisplayProperty: Een enkele eigenschap van een object.

  • DefaultDisplayPropertySet: Een of meer eigenschappen van een object.

  • DefaultKeyPropertySet: Een of meer sleuteleigenschappen van een object. Een sleutel-eigenschap identificeert exemplaren van eigenschapswaarden, zoals het id-aantal items in een sessiegeschiedenis.

De volgende XML definieert bijvoorbeeld de standaardweergave van services (System.ServiceProcess.ServiceController objecten) die worden geretourneerd door de Get-Service cmdlet . Het definieert een ledenset met de naam PsStandardMembers die bestaat uit een standaardeigenschappenset met de eigenschappen Status, Naam en DisplayName .

<Type>
  <Name>System.ServiceProcess.ServiceController</Name>
  <Members>
    <MemberSet>
      <Name>PSStandardMembers</Name>
      <Members>
        <PropertySet>
          <Name>DefaultDisplayPropertySet</Name>
          <ReferencedProperties>
            <Name>Status</Name>
            <Name>Name</Name>
            <Name>DisplayName</Name>
          </ReferencedProperties>
        </PropertySet>
      </Members>
    </MemberSet>
  </Members>
</Type>

<Method>: Verwijst naar een native methode van het onderliggende object.

<Methods>: Een verzameling van de methoden van het -object.

NoteProperty

Definieert een eigenschap met een statische waarde.

De <NoteProperty> tag moet een tag hebben <Name> die de naam van <Value> de nieuwe eigenschap specificeert en een tag die de waarde van de eigenschap specificeert.

Met de volgende XML wordt bijvoorbeeld een eigenschap Status gemaakt voor System.IO.DirectoryInfo-objecten . De waarde van de eigenschap Status is altijd Geslaagd.

<Type>
  <Name>System.IO.DirectoryInfo</Name>
  <Members>
    <NoteProperty>
      <Name>Status</Name>
      <Value>Success</Value>
    </NoteProperty>
  </Members>
</Type>

PropertySet

Eigenschappen die argumenten nemen en een waarde retourneren.

<Properties>: Een verzameling van de eigenschappen van het -object.

<Property>: Een eigenschap van het basisobject.

<PropertySet>: Hiermee definieert u een verzameling eigenschappen van het -object.

De <PropertySet> tag moet een tag hebben <Name> die de naam van de eigenschappenset specificeert <ReferencedProperty> en een tag die de eigenschappen specificeert. De namen van de eigenschappen worden ingesloten in de <Name> tag .

In Types.ps1xmlworden <PropertySet> tags gebruikt voor het definiëren van sets eigenschappen voor de standaardweergave van een object. U kunt de standaardweergaven identificeren met de waarde PsStandardMembers in de <Name> tag van een <MemberSet> tag.

Met de volgende XML maakt u bijvoorbeeld een PropertySet met de naam DefaultDisplayPropertySet met drie ReferencedProperties.

<Type>
  <Name>System.ServiceProcess.ServiceController</Name>
  <Members>
    <MemberSet>
      <Name>PSStandardMembers</Name>
      <Members>
        <PropertySet>
          <Name>DefaultDisplayPropertySet</Name>
          <ReferencedProperties>
            <Name>Status</Name>
            <Name>Name</Name>
            <Name>DisplayName</Name>
          </ReferencedProperties>
        </PropertySet>
      </Members>
    </MemberSet>
  </Members>
</Type>

ScriptMethod

Definieert een methode waarvan de waarde de uitvoer van een script is.

De <ScriptMethod> tag moet een <Name> tag hebben waarmee <Script> de naam van de nieuwe methode wordt opgegeven en een tag die het scriptblok omsluit dat het resultaat van de methode retourneert.

De methoden en van ConvertToDateTime ConvertFromDateTime beheerobjecten (System.System.Management.ManagementObject) zijn bijvoorbeeld scriptmethoden die gebruikmaken van de ToDateTime statische methoden en ToDmtfDateTime van de System.Management.ManagementDateTimeConverter klasse .

<Type>
 <Name>System.Management.ManagementObject</Name>
 <Members>
 <ScriptMethod>
   <Name>ConvertToDateTime</Name>
   <Script>
   [System.Management.ManagementDateTimeConverter]::ToDateTime($args[0])
   </Script>
 </ScriptMethod>
 <ScriptMethod>
   <Name>ConvertFromDateTime</Name>
   <Script>
   [System.Management.ManagementDateTimeConverter]::ToDmtfDateTime($args[0])
   </Script>
 </ScriptMethod>
 </Members>
</Type>

ScriptProperty

Definieert een eigenschap waarvan de waarde de uitvoer van een script is.

De <ScriptProperty> tag moet een <Name> tag hebben die <GetScriptBlock> de naam van de nieuwe eigenschap specificeert en een tag die het scriptblok omsluit dat de eigenschapswaarde retourneert.

De eigenschap VersionInfo van het object System.IO.FileInfo is bijvoorbeeld een script-eigenschap die het resultaat is van het gebruik van de eigenschap FullName van de statische methode GetVersionInfo van System.Diagnostics.FileVersionInfo-objecten .

<Type>
  <Name>System.IO.FileInfo</Name>
  <Members>
    <ScriptProperty>
      <Name>VersionInfo</Name>
      <GetScriptBlock>
      [System.Diagnostics.FileVersionInfo]::GetVersionInfo($this.FullName)
      </GetScriptBlock>
    </ScriptProperty>
  </Members>
</Type>

Zie de Windows PowerShell Software Development Kit (SDK) voor meer informatie.

Update-TypeData

Voer de Types.ps1xml cmdlet uit om uw bestanden in een PowerShell-sessie Update-TypeData te laden. Als u wilt dat de typen in uw bestand voorrang hebben op typen in het ingebouwde Types.ps1xml bestand, voegt u de parameter PrependData van toe Update-TypeData. Update-TypeData is alleen van invloed op de huidige sessie. Als u de wijziging wilt maken in alle toekomstige sessies, exporteert u de sessie of voegt u de opdracht Update-TypeData toe aan uw PowerShell-profiel.

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

"hello".get_Length()

De syntaxis van de methode kan alleen worden gebruikt met .NET-eigenschappen. Eigenschappen die worden toegevoegd door het uitvoeren van de Update-TypeData cmdlet kunnen de syntaxis van de methode niet gebruiken.

Een Types.ps1xml-bestand ondertekenen

Als u gebruikers van uw bestand wilt Types.ps1xml beveiligen, kunt u het bestand ondertekenen met behulp van een digitale handtekening. Zie voor meer informatie about_Signing.

Zie ook