Dela via

Godkända verb för PowerShell-kommandon

PowerShell använder ett verb-substantivpar för namnen på cmdletar och för deras härledda .NET-klasser. Verbdelen av namnet identifierar den åtgärd som cmdleten utför. Substantivdelen av namnet identifierar den entitet som åtgärden utförs på. Till exempel hämtar cmdleten Get-Command alla kommandon som är registrerade i PowerShell.

Anmärkning

PowerShell använder termen verb för att beskriva ett ord som innebär en åtgärd även om ordet inte är ett standardverb på engelska. Termen New är till exempel ett giltigt PowerShell-verbnamn eftersom det innebär en åtgärd även om det inte är ett verb på engelska.

Varje godkänt verb har ett motsvarande aliasprefix definierat. Vi använder det här aliasprefixet i alias för kommandon med hjälp av det verbet. Aliasprefixet för Import är till exempel ip och därför är aliaset för Import-Moduleipmo. Det här är en rekommendation, men inte en regel. I synnerhet behöver den inte respekteras för kommandoalias som efterliknar välkända kommandon från andra miljöer.

Rekommendationer för verbnamngivning

Följande rekommendationer hjälper dig att välja ett lämpligt verb för din cmdlet för att säkerställa konsekvens mellan de cmdletar som du skapar, de cmdletar som tillhandahålls av PowerShell och de cmdletar som har utformats av andra.

  • Använd ett av de fördefinierade verbnamnen som tillhandahålls av PowerShell
  • Använd verbet för att beskriva åtgärdens allmänna omfång och använd parametrar för att ytterligare förfina cmdletens åtgärd.
  • Använd inte en synonym till ett godkänt verb. Använd till exempel alltid Remove, använd aldrig Delete eller Eliminate.
  • Använd endast formen för varje verb som visas i det här avsnittet. Använd till Getexempel , men använd Getting inte eller Gets.
  • Använd inte följande reserverade verb eller alias. PowerShell-språket och några få cmdletar använder dessa verb under exceptionella omständigheter.
    • ForEach (foreach)
    • Ping (pi)
    • Sort (sr)
    • Tee (te)
    • Where (wh)

Du kan få en fullständig lista över verb med hjälp av cmdleten Get-Verb.

Liknande verb för olika åtgärder

Följande liknande verb representerar olika åtgärder.

New jämfört med Add

Använd verbet New för att skapa en ny resurs. Använd Add för att lägga till något i en befintlig container eller resurs. Till exempel lägger Add-Content till utdata till en befintlig fil.

New jämfört med Set

Använd verbet New för att skapa en ny resurs. Använd verbet Set för att ändra en befintlig resurs, om du vill skapa den om den inte finns, till exempel cmdleten Set-Variable .

Använd verbet Find för att leta efter ett objekt. Använd verbet Search för att skapa en referens till en resurs i en container.

Get jämfört med Read

Använd verbet Get för att hämta information om en resurs (till exempel en fil) eller för att hämta ett objekt som du kan komma åt resursen med i framtiden. Använd verbet Read för att öppna en resurs och extrahera information som finns i.

Invoke jämfört med Start

Använd verbet Invoke för att utföra synkrona åtgärder, till exempel att köra ett kommando och vänta på att det ska avslutas. Använd verbet Start för att påbörja asynkrona åtgärder, till exempel starta en autonom process.

Ping jämfört med Test

Använd verbet Test.

Vanliga verb

PowerShell använder System.Management.Automation.VerbsCommon uppräkningsklass för att definiera allmänna åtgärder som kan tillämpas på nästan alla cmdletar. I följande tabell visas de flesta av de definierade verben.

Verb (alias) Åtgärd Synonymer att undvika
Add (a) Lägger till en resurs i en container eller kopplar ett objekt till ett annat objekt. Till exempel lägger cmdleten Add-Content till innehåll i en fil. Det här verbet är kopplat till Remove. Append, Attach, , ConcatenateInsert
Clear (cl) Tar bort alla resurser från en container men tar inte bort containern. Cmdleten Clear-Content tar till exempel bort innehållet i en fil men tar inte bort filen. Flush, Erase, Release, Unmark, , , UnsetNullify
Close (cs) Ändrar tillståndet för en resurs så att den blir otillgänglig, otillgänglig eller oanvändbar. Det här verbet är kopplat till Open.
Copy (cp) Kopierar en resurs till ett annat namn eller till en annan container. Till exempel kopierar cmdleten Copy-Item ett objekt (till exempel en fil) från en plats i datalagret till en annan plats. Duplicate, Clone, , ReplicateSync
Enter (et) Anger en åtgärd som gör att användaren kan flytta till en resurs. Till exempel placerar cmdleten Enter-PSSession användaren i en interaktiv session. Det här verbet är kopplat till Exit. Push, Into
Exit (ex) Anger den aktuella miljön eller kontexten till den senast använda kontexten. Till exempel placerar cmdleten Exit-PSSession användaren i sessionen som användes för att starta den interaktiva sessionen. Det här verbet är kopplat till Enter. Pop, Out
Find (fd) Söker efter ett objekt i en container som är okänd, underförstådd, valfri eller angiven. Search
Format (f) Ordnar objekt i ett angivet formulär eller en layout
Get (g) Anger en åtgärd som hämtar en resurs. Det här verbet är kopplat till Set. Read, Open, Cat, Type, Dir, Obtain, , Dump, Acquire, Examine, , , FindSearch
Hide (h) Gör en resurs oidentifierbar. En cmdlet vars namn innehåller hide-verbet kan till exempel dölja en tjänst för en användare. Det här verbet är kopplat till Show. Block
Join (j) Kombinerar resurser till en resurs. Till exempel kombinerar cmdleten Join-Path en sökväg med en av dess underordnade sökvägar för att skapa en enda sökväg. Det här verbet är kopplat till Split. Combine, Unite, , ConnectAssociate
Lock (lk) Skyddar en resurs. Det här verbet är kopplat till Unlock. Restrict, Secure
Move (m) Flyttar en resurs från en plats till en annan. Till exempel flyttar cmdleten Move-Item ett objekt från en plats i datalagret till en annan plats. Transfer, , NameMigrate
New (n) Skapar en resurs. (Det Set verbet kan också användas när du skapar en resurs som innehåller data, till exempel Set-Variable cmdlet.) Create, Generate, Build, , , MakeAllocate
Open (op) Ändrar tillståndet för en resurs så att den blir tillgänglig, tillgänglig eller användbar. Det här verbet är kopplat till Close.
Optimize (om) Ökar effektiviteten för en resurs.
Pop (pop) Tar bort ett objekt överst i en stack. Till exempel ändrar cmdleten Pop-Location den aktuella platsen till den plats som senast överfördes till stacken.
Push (pu) Lägger till ett objekt överst i en stack. Till exempel skickar cmdleten Push-Location den aktuella platsen till stacken.
Redo (re) Återställer en resurs till det tillstånd som ångrades.
Remove (r) Tar bort en resurs från en container. Till exempel tar cmdleten Remove-Variable bort en variabel och dess värde. Det här verbet är kopplat till Add. Clear, Cut, Dispose, , , DiscardErase
Rename (rn) Ändrar namnet på en resurs. Till exempel ändrar cmdleten Rename-Item, som används för att komma åt lagrade data, namnet på ett objekt i datalagret. Change
Reset (rs) Anger en resurs tillbaka till sitt ursprungliga tillstånd.
Resize (rz) Ändrar storleken på en resurs.
Search (sr) Skapar en referens till en resurs i en container. Find, Locate
Select (sc) Letar upp en resurs i en container. Till exempel hittar Select-String-cmdleten text i strängar och filer. Find, Locate
Set (s) Ersätter data på en befintlig resurs eller skapar en resurs som innehåller vissa data. Till exempel ändrar cmdleten Set-Date systemtiden på den lokala datorn. (Det New verbet kan också användas för att skapa en resurs.) Det här verbet är kopplat till Get. Write, Reset, Assign, , , ConfigureUpdate
Show (sh) Gör en resurs synlig för användaren. Det här verbet är kopplat till Hide. Display, Produce
Skip (sk) Kringgår en eller flera resurser eller punkter i en sekvens. Bypass, Jump
Split (sl) Separerar delar av en resurs. Till exempel returnerar cmdleten Split-Path olika delar av en sökväg. Det här verbet är kopplat till Join. Separate
Step (st) Flyttas till nästa punkt eller resurs i en sekvens.
Switch (sw) Anger en åtgärd som växlar mellan två resurser, till exempel att ändra mellan två platser, ansvarsområden eller tillstånd.
Undo (un) Anger en resurs till dess tidigare tillstånd.
Unlock (uk) Frigör en resurs som var låst. Det här verbet är kopplat till Lock. Release, , UnrestrictUnsecure
Watch (wc) Inspekterar eller övervakar kontinuerligt en resurs för ändringar.

Kommunikationsverb

PowerShell använder klassen System.Management.Automation.VerbsCommunications för att definiera åtgärder som gäller för kommunikation. I följande tabell visas de flesta av de definierade verben.

Verb (alias) Åtgärd Synonymer att undvika
Connect (cc) Skapar en länk mellan en källa och ett mål. Det här verbet är kopplat till Disconnect. Join, , TelnetLogin
Disconnect (dc) Bryter länken mellan en källa och ett mål. Det här verbet är kopplat till Connect. Break, Logoff
Read (rd) Hämtar information från en källa. Det här verbet är kopplat till Write. Acquire, , PromptGet
Receive (rc) Accepterar information som skickas från en källa. Det här verbet är kopplat till Send. Read, , AcceptPeek
Send (sd) Levererar information till ett mål. Det här verbet är kopplat till Receive. Put, Broadcast, , MailFax
Write (wr) Lägger till information i ett mål. Det här verbet är kopplat till Read. Put, Print

Dataverb

PowerShell använder klassen System.Management.Automation.VerbsData för att definiera åtgärder som gäller för datahantering. I följande tabell visas de flesta av de definierade verben.

Verbnamn (alias) Åtgärd Synonymer att undvika
Backup (ba) Lagrar data genom att replikera dem. Save, Burn, , ReplicateSync
Checkpoint (ch) Skapar en ögonblicksbild av det aktuella tillståndet för data eller dess konfiguration. Diff
Compare (cr) Utvärderar data från en resurs mot data från en annan resurs. Diff
Compress (cm) Komprimerar data för en resurs. Par med Expand. Compact
Convert (cv) Ändrar data från en representation till en annan när cmdleten stöder dubbelriktad konvertering eller när cmdleten stöder konvertering mellan flera datatyper. Change, , ResizeResample
ConvertFrom (cf) Konverterar en primär typ av indata (cmdletens substantiv anger indata) till en eller flera utdatatyper som stöds. Export, , OutputOut
ConvertTo (ct) Konverterar från en eller flera typer av indata till en primär utdatatyp (cmdletens substantiv anger utdatatypen). Import, , InputIn
Dismount (dm) Kopplar från en namngiven entitet från en plats. Det här verbet är kopplat till Mount. Unmount, Unlink
Edit (ed) Ändrar befintliga data genom att lägga till eller ta bort innehåll. Change, , UpdateModify
Expand (en) Återställer data för en resurs som har komprimerats till sitt ursprungliga tillstånd. Det här verbet är kopplat till Compress. Explode, Uncompress
Export (ep) Kapslar in de primära indata i ett beständigt datalager, till exempel en fil eller i ett utbytesformat. Det här verbet är kopplat till Import. Extract, Backup
Group (gp) Ordnar eller associerar en eller flera resurser
Import (ip) Skapar en resurs från data som lagras i ett beständigt datalager (till exempel en fil) eller i ett utbytesformat. Cmdleten Import-Csv importerar till exempel data från en kommaavgränsad värdefil (CSV) till objekt som kan användas av andra cmdletar. Det här verbet är kopplat till Export. BulkLoad, Load
Initialize (in) Förbereder en resurs för användning och anger den till ett standardtillstånd. Erase, Init, Renew, Rebuild, , , ReinitializeSetup
Limit (l) Tillämpar begränsningar för en resurs. Quota
Merge (mg) Skapar en enskild resurs från flera resurser. Combine, Join
Mount (mt) Kopplar en namngiven entitet till en plats. Det här verbet är kopplat till Dismount. Connect
Out (o) Skickar data från miljön. Till exempel skickar cmdleten Out-Printer data till en skrivare.
Publish (pb) Gör en resurs tillgänglig för andra. Det här verbet är kopplat till Unpublish. Deploy, , ReleaseInstall
Restore (rr) Anger en resurs till ett fördefinierat tillstånd, till exempel ett tillstånd som anges av Checkpoint. Till exempel startar cmdleten Restore-Computer en systemåterställning på den lokala datorn. Repair, Return, , UndoFix
Save (sv) Bevarar data för att undvika förlust.
Sync (sy) Försäkrar att två eller flera resurser är i samma tillstånd. Replicate, , CoerceMatch
Unpublish (ub) Gör en resurs otillgänglig för andra. Det här verbet är kopplat till Publish. Uninstall, , RevertHide
Update (ud) Ger en resurs up-to-date för att upprätthålla dess tillstånd, noggrannhet, efterlevnad eller efterlevnad. Till exempel uppdateras Update-FormatData cmdlet och lägger till formateringsfiler i den aktuella PowerShell-konsolen. Refresh, Renew, , RecalculateRe-index

Diagnostikverb

PowerShell använder klassen System.Management.Automation.VerbsDiagnostic för att definiera åtgärder som gäller för diagnostik. I följande tabell visas de flesta av de definierade verben.

Verb (alias) Åtgärd Synonymer att undvika
Debug (db) Undersöker en resurs för att diagnostisera driftsproblem. Diagnose
Measure (ms) Identifierar resurser som förbrukas av en angiven åtgärd eller hämtar statistik om en resurs. Calculate, , DetermineAnalyze
Ping (pi) Inaktuell – Använd testverb i stället.
Repair (rp) Återställer en resurs till ett användbart villkor Fix, Restore
Resolve (rv) Mappar en kortfattad representation av en resurs till en mer fullständig representation. Expand, Determine
Test (t) Verifierar åtgärden eller konsekvensen för en resurs. Diagnose, Analyze, , SalvageVerify
Trace (tr) Spårar aktiviteterna för en resurs. Track, Follow, , InspectDig

Livscykelverb

PowerShell använder klassen System.Management.Automation.VerbsLifecycle för att definiera åtgärder som gäller för livscykeln för en resurs. I följande tabell visas de flesta av de definierade verben.

Verb (alias) Åtgärd Synonymer att undvika
Approve (ap) Bekräftar eller godkänner statusen för en resurs eller process.
Assert (as) Bekräftar tillståndet för en resurs. Certify
Build (bd) Skapar en artefakt (vanligtvis en binär fil eller ett dokument) av någon uppsättning indatafiler (vanligtvis källkod eller deklarativa dokument.) Det här verbet lades till i PowerShell 6.
Complete (cp) Avslutar en åtgärd.
Confirm (cn) Bekräftar, verifierar eller verifierar tillståndet för en resurs eller process. Acknowledge, Agree, Certify, , , ValidateVerify
Deny (dn) Vägrar, objekt, blockerar eller motsätter sig tillståndet för en resurs eller process. Block, Object, , RefuseReject
Deploy (dp) Skickar ett program, en webbplats eller en lösning till ett fjärrmål på ett sådant sätt att en konsument av lösningen kan komma åt den när distributionen är klar. Det här verbet lades till i PowerShell 6.
Disable (d) Konfigurerar en resurs till ett otillgängligt eller inaktivt tillstånd. Till exempel gör cmdleten Disable-PSBreakpoint en brytpunkt inaktiv. Det här verbet är kopplat till Enable. Halt, Hide
Enable (e) Konfigurerar en resurs till ett tillgängligt eller aktivt tillstånd. Till exempel gör cmdleten Enable-PSBreakpoint en brytpunkt aktiv. Det här verbet är kopplat till Disable. Start, Begin
Install (is) Placerar en resurs på en plats och initierar den eventuellt. Det här verbet är kopplat till Uninstall. Setup
Invoke (i) Utför en åtgärd, till exempel att köra ett kommando eller en metod. Run, Start
Register (rg) Skapar en post för en resurs på en lagringsplats, till exempel en databas. Det här verbet är kopplat till Unregister.
Request (rq) Frågar efter en resurs eller ber om behörigheter.
Restart (rt) Stoppar en åtgärd och startar den sedan igen. Till exempel stoppas Restart-Service-cmdleten och startar sedan en tjänst. Recycle
Resume (ru) Startar en åtgärd som har pausats. Till exempel startar cmdleten Resume-Service en tjänst som har pausats. Det här verbet är kopplat till Suspend.
Start (sa) Initierar en åtgärd. Till exempel startar cmdleten Start-Service en tjänst. Det här verbet är kopplat till Stop. Launch, , InitiateBoot
Stop (sp) Avbryter en aktivitet. Det här verbet är kopplat till Start. End, Kill, , TerminateCancel
Submit (sb) Presenterar en resurs för godkännande. Post
Suspend (ss) Pausar en aktivitet. Till exempel pausar cmdleten Suspend-Service en tjänst. Det här verbet är kopplat till Resume. Pause
Uninstall (us) Tar bort en resurs från en angiven plats. Det här verbet är kopplat till Install.
Unregister (ur) Tar bort posten för en resurs från en lagringsplats. Det här verbet är kopplat till Register. Remove
Wait (w) Pausar en åtgärd tills en angiven händelse inträffar. Till exempel pausar cmdleten Wait-Job åtgärder tills ett eller flera av bakgrundsjobben har slutförts. Sleep, Pause

Säkerhetsverb

PowerShell använder klassen System.Management.Automation.VerbsSecurity för att definiera åtgärder som gäller för säkerhet. I följande tabell visas de flesta av de definierade verben.

Verb (alias) Åtgärd Synonymer att undvika
Block (bl) Begränsar åtkomsten till en resurs. Det här verbet är kopplat till Unblock. Prevent, , LimitDeny
Grant (gr) Tillåter åtkomst till en resurs. Det här verbet är kopplat till Revoke. Allow, Enable
Protect (pt) Skyddar en resurs från angrepp eller förlust. Det här verbet är kopplat till Unprotect. Encrypt, , SafeguardSeal
Revoke (rk) Anger en åtgärd som inte tillåter åtkomst till en resurs. Det här verbet är kopplat till Grant. Remove, Disable
Unblock (ul) Tar bort begränsningar för en resurs. Det här verbet är kopplat till Block. Clear, Allow
Unprotect (up) Tar bort skydd från en resurs som har lagts till för att förhindra angrepp eller förlust. Det här verbet är kopplat till Protect. Decrypt, Unseal

Andra verb

PowerShell använder klassen System.Management.Automation.VerbsOther för att definiera kanoniska verbnamn som inte passar in i en specifik verbnamnkategori, till exempel verben common, communications, data, lifecycle eller security verb.

Verb (alias) Åtgärd Synonymer att undvika
Use (u) Använder eller innehåller en resurs för att göra något.

Se även

  • Last updated on