Sdílet prostřednictvím

New-ItemProperty

  • Reference
Modul:
Microsoft.PowerShell.Management

Vytvoří novou vlastnost pro položku a nastaví její hodnotu.

Syntaxe

New-ItemProperty
   [-Path] <String[]>
   [-Name] <String>
   [-PropertyType <String>]
   [-Value <Object>]
   [-Force]
   [-Filter <String>]
   [-Include <String[]>]
   [-Exclude <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [<CommonParameters>]
New-ItemProperty
   -LiteralPath <String[]>
   [-Name] <String>
   [-PropertyType <String>]
   [-Value <Object>]
   [-Force]
   [-Filter <String>]
   [-Include <String[]>]
   [-Exclude <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [<CommonParameters>]

Description

Rutina New-ItemProperty vytvoří novou vlastnost pro zadanou položku a nastaví její hodnotu. Tato rutina se obvykle používá k vytvoření nových hodnot registru, protože hodnoty registru jsou vlastnosti položky klíče registru.

Tato rutina nepřidá vlastnosti do objektu.

  • Pokud chcete přidat vlastnost do instance objektu, použijte rutinu Add-Member.
  • Chcete-li přidat vlastnost ke všem objektům určitého typu, upravte soubor Types.ps1xml.

Příklady

Příklad 1: Přidání položky registru

Tento příkaz přidá novou položku registru NoOfEmployees do klíče MyCompany hKLM:\Software hive.

První příkaz použije parametr Path k určení cesty klíče registru MyCompany. Pomocí parametru Name určuje název položky a parametr Value k určení jeho hodnoty.

Druhý příkaz použije rutinu Get-ItemProperty k zobrazení nové položky registru.

New-ItemProperty -Path "HKLM:\Software\MyCompany" -Name "NoOfEmployees" -Value 822
Get-ItemProperty "HKLM:\Software\MyCompany"

PSPath        : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software\mycompany
PSParentPath  : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software
PSChildName   : mycompany
PSDrive       : HKLM
PSProvider    : Microsoft.PowerShell.Core\Registry
NoOfLocations : 2
NoOfEmployees : 822

Příklad 2: Přidání položky registru do klíče

Tento příkaz přidá novou položku registru do klíče registru. K zadání klíče používá operátor kanálu (|) k odeslání objektu, který představuje klíč k New-ItemProperty.

První část příkazu používá rutinu Get-Item k získání klíče registru MyCompany. Operátor kanálu odešle výsledky příkazu do New-ItemProperty, který přidá novou položku registru ("NoOfLocations") a jeho hodnotu (3) do klíče "MyCompany".

Get-Item -Path "HKLM:\Software\MyCompany" | New-ItemProperty -Name NoOfLocations -Value 3

Tento příkaz funguje, protože funkce vazby parametrů prostředí Windows PowerShell přidruží cestu k objektu RegistryKey, který Get-Item vrátí s parametrem LiteralPath parametru New-ItemProperty. Další informace najdete v tématu about_Pipelines.

Příklad 3: Vytvoření hodnoty MultiString v registru pomocí Here-String

Tento příklad vytvoří hodnotu MultiString pomocí here-String.

$newValue = New-ItemProperty -Path "HKLM:\SOFTWARE\ContosoCompany\" -Name 'HereString' -PropertyType MultiString -Value @"
This is text which contains newlines
It can also contain "quoted" strings
"@
$newValue.multistring

This is text which contains newlines
It can also contain "quoted" strings

Příklad 4: Vytvoření hodnoty MultiString v registru pomocí pole

Příklad ukazuje, jak pomocí pole hodnot vytvořit MultiString hodnotu.

$newValue = New-ItemProperty -Path "HKLM:\SOFTWARE\ContosoCompany\" -Name 'MultiString' -PropertyType MultiString -Value ('a','b','c')
$newValue.multistring[0]

a

Parametry

-Confirm

Před spuštěním rutiny vás vyzve k potvrzení.

Typ:SwitchParameter
Aliasy:cf
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Credential

Určuje uživatelský účet, který má oprávnění k provedení této akce. Výchozí hodnota je aktuální uživatel.

Zadejte uživatelské jméno, například "User01" nebo "Domain01\User01", nebo zadejte PSCredential objekt, například objekt vygenerovaný rutinou Get-Credential. Pokud zadáte uživatelské jméno, zobrazí se výzva k zadání hesla.

Varování

Tento parametr nejsou podporovány žádnými poskytovateli nainstalovanými ve Windows PowerShellu.

Typ:PSCredential
Position:Named
Default value:Current user
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Exclude

Určuje, jako pole řetězců, vlastnost nebo vlastnost, které tato rutina vylučuje z operace. Hodnota tohoto parametru kvalifikuje parametr Path. Zadejte prvek cesty nebo vzor, například "*.txt". Jsou povoleny zástupné znaky.

Typ:String[]
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:True

-Filter

Určuje filtr ve formátu nebo jazyce poskytovatele. Hodnota tohoto parametru kvalifikuje parametr Path.

Syntaxe filtru, včetně použití zástupných znaků, závisí na poskytovateli. Filtry jsou efektivnější než jiné parametry, protože je poskytovatel použije, když rutina získá objekty místo toho, aby objekty po jejich načtení vyfiltroval PowerShell.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:True

-Force

Vynutí, aby rutina vytvořila vlastnost objektu, ke kterému uživatel jinak nemá přístup. Implementace se liší od zprostředkovatele po zprostředkovatele. Další informace naleznete v tématu about_Providers.

Typ:SwitchParameter
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Include

Určuje, jako pole řetězců, položku nebo položky, které tato rutina zahrnuje v operaci. Hodnota tohoto parametru kvalifikuje parametr Path. Zadejte prvek cesty nebo vzor, například "*.txt". Jsou povoleny zástupné znaky.

Typ:String[]
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:True

-LiteralPath

Určuje cestu k aktuálnímu umístění vlastnosti. Na rozdíl od parametru Path se hodnota LiteralPath používá přesně tak, jak je zadána. Žádné znaky nejsou interpretovány jako zástupné znaky. Pokud cesta obsahuje řídicí znaky, uzavřete ji do jednoduchých uvozovek. Jednoduché uvozovky říkají PowerShellu, aby nepřekládaly žádné znaky jako řídicí sekvence.

Typ:String[]
Aliasy:PSPath
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Name

Určuje název nové vlastnosti. Pokud je vlastnost položka registru, tento parametr určuje název položky.

Typ:String
Aliasy:PSProperty
Position:1
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Path

Určuje cestu k položce. Tento parametr identifikuje položku, do které tato rutina přidá novou vlastnost.

Typ:String[]
Position:0
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-PropertyType

Určuje typ vlastnosti, kterou tato rutina přidá. Přijatelné hodnoty pro tento parametr jsou:

  • řetězcové: Určuje řetězec ukončený hodnotou null. Ekvivalent REG_SZ.
  • ExpandString: Určuje řetězec ukončený hodnotou null, který obsahuje nevyexpandované odkazy na proměnné prostředí, které se rozbalí při načtení hodnoty. Ekvivalent REG_EXPAND_SZ.
  • Binární: Určuje binární data v libovolné podobě. Ekvivalent REG_BINARY.
  • DWord: Určuje 32bitové binární číslo. Ekvivalent REG_DWORD.
  • MultiString: Určuje pole řetězců ukončených hodnotou null ukončených dvěma znaky null. Ekvivalent REG_MULTI_SZ.
  • Qword: Určuje 64bitové binární číslo. Ekvivalent REG_QWORD.
  • Neznámý: Označuje nepodporovaný datový typ registru, například REG_RESOURCE_LIST.
Typ:String
Aliasy:Type
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-UseTransaction

Zahrnuje příkaz v aktivní transakci. Tento parametr je platný pouze v případě, že probíhá transakce. Další informace najdete v tématu about_Transactions.

Typ:SwitchParameter
Aliasy:usetx
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Value

Určuje hodnotu vlastnosti. Pokud je vlastnost položka registru, tento parametr určuje hodnotu položky.

Typ:Object
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-WhatIf

Ukazuje, co se stane, když se rutina spustí. Rutina se nespustí.

Typ:SwitchParameter
Aliasy:wi
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

Vstupy

None

Vstup do této rutiny nelze převést.

Výstupy

PSCustomObject

New-ItemProperty vrátí vlastní objekt, který obsahuje novou vlastnost.

Poznámky

New-ItemProperty je navržená tak, aby fungovala s daty vystavenými libovolným poskytovatelem. Pokud chcete zobrazit seznam poskytovatelů dostupných v relaci, zadejte Get-PSProvider. Další informace naleznete v tématu about_Providers.