From 6905370fb62a492c4605a7a1e9227e2762302e9a Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Tue, 29 Apr 2025 12:12:23 -0700 Subject: [PATCH 1/2] Fix formatting to avoid over localization (#12037) --- ...d-verbs-for-windows-powershell-commands.md | 428 +++++++++++------- 1 file changed, 268 insertions(+), 160 deletions(-) diff --git a/reference/docs-conceptual/developer/cmdlet/approved-verbs-for-windows-powershell-commands.md b/reference/docs-conceptual/developer/cmdlet/approved-verbs-for-windows-powershell-commands.md index 2eef0a598234..773c2d80e55c 100644 --- a/reference/docs-conceptual/developer/cmdlet/approved-verbs-for-windows-powershell-commands.md +++ b/reference/docs-conceptual/developer/cmdlet/approved-verbs-for-windows-powershell-commands.md @@ -1,6 +1,6 @@ --- description: Approved Verbs for PowerShell Commands -ms.date: 01/31/2022 +ms.date: 04/29/2025 ms.topic: reference title: Approved Verbs for PowerShell Commands --- @@ -12,9 +12,9 @@ the name identifies the entity on which the action is performed. For example, th cmdlet retrieves all the commands that are registered in PowerShell. > [!NOTE] -> PowerShell uses the term _verb_ to describe a word that implies an action even if that word is not -> a standard verb in the English language. For example, the term _New_ is a valid PowerShell verb -> name because it implies an action even though it is not a verb in the English language. +> PowerShell uses the term _verb_ to describe a word that implies an action even if that word isn't +> a standard verb in the English language. For example, the term `New` is a valid PowerShell verb +> name because it implies an action even though it isn't a verb in the English language. Each approved verb has a corresponding _alias prefix_ defined. We use this alias prefix in aliases for commands using that verb. For example, the alias prefix for `Import` is `ip` and, accordingly, @@ -30,17 +30,17 @@ the cmdlets that are designed by others. - Use one of the predefined verb names provided by PowerShell - Use the verb to describe the general scope of the action, and use parameters to further refine the action of the cmdlet. -- Do not use a synonym of an approved verb. For example, always use `Remove`, never use `Delete` or +- Don't use a synonym of an approved verb. For example, always use `Remove`, never use `Delete` or `Eliminate`. -- Use only the form of each verb that is listed in this topic. For example, use `Get`, but do not +- Use only the form of each verb that's listed in this topic. For example, use `Get`, but don't use `Getting` or `Gets`. -- Do not use the following reserved verbs or aliases. The PowerShell language and a rare few cmdlets +- Don't use the following reserved verbs or aliases. The PowerShell language and a rare few cmdlets use these verbs under exceptional circumstances. - - ForEach (foreach) - - Ping (pi) - - Sort (sr) - - Tee (te) - - Where (wh) + - `ForEach` (`foreach`) + - `Ping` (`pi`) + - `Sort` (`sr`) + - `Tee` (`te`) + - `Where` (`wh`) You may get a complete list of verbs using the `Get-Verb` cmdlet. @@ -48,214 +48,322 @@ You may get a complete list of verbs using the `Get-Verb` cmdlet. The following similar verbs represent different actions. -### New vs. Add +### `New` vs. `Add` Use the `New` verb to create a new resource. Use the `Add` to add something to an existing container or resource. For example, `Add-Content` adds output to an existing file. -### New vs. Set +### `New` vs. `Set` Use the `New` verb to create a new resource. Use the `Set` verb to modify an existing resource, -optionally creating it if it does not exist, such as the `Set-Variable` cmdlet. +optionally creating it if it doesn't exist, such as the `Set-Variable` cmdlet. -### Find vs. Search +### `Find` vs. `Search` Use the `Find` verb to look for an object. Use the `Search` verb to create a reference to a resource in a container. -### Get vs. Read +### `Get` vs. `Read` Use the `Get` verb to obtain information about a resource (such as a file) or to obtain an object with which you can access the resource in future. Use the `Read` verb to open a resource and extract information contained within. -### Invoke vs. Start +### `Invoke` vs. `Start` Use the `Invoke` verb to perform synchronous operations, such as running a command and waiting for it to end. Use the `Start` verb to begin asynchronous operations, such as starting an autonomous process. -### Ping vs. Test +### `Ping` vs. `Test` Use the `Test` verb. ## Common Verbs -PowerShell uses the -[System.Management.Automation.VerbsCommon](/dotnet/api/System.Management.Automation.VerbsCommon) -enumeration class to define generic actions that can apply to almost any cmdlet. The following table -lists most of the defined verbs. - -| Verb (alias) | Action | Synonyms to avoid | -| ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [Add](/dotnet/api/System.Management.Automation.VerbsCommon.Add) (a) | Adds a resource to a container, or attaches an item to another item. For example, the `Add-Content` cmdlet adds content to a file. This verb is paired with `Remove`. | Append, Attach, Concatenate, Insert | -| [Clear](/dotnet/api/System.Management.Automation.VerbsCommon.Clear) (cl) | Removes all the resources from a container but does not delete the container. For example, the `Clear-Content` cmdlet removes the contents of a file but does not delete the file. | Flush, Erase, Release, Unmark, Unset, Nullify | -| [Close](/dotnet/api/System.Management.Automation.VerbsCommon.Close) (cs) | Changes the state of a resource to make it inaccessible, unavailable, or unusable. This verb is paired with `Open.` | | -| [Copy](/dotnet/api/System.Management.Automation.VerbsCommon.Copy) (cp) | Copies a resource to another name or to another container. For example, the `Copy-Item` cmdlet copies an item (such as a file) from one location in the data store to another location. | Duplicate, Clone, Replicate, Sync | -| [Enter](/dotnet/api/System.Management.Automation.VerbsCommon.Enter) (et) | Specifies an action that allows the user to move into a resource. For example, the `Enter-PSSession` cmdlet places the user in an interactive session. This verb is paired with `Exit`. | Push, Into | -| [Exit](/dotnet/api/System.Management.Automation.VerbsCommon.Exit) (ex) | Sets the current environment or context to the most recently used context. For example, the `Exit-PSSession` cmdlet places the user in the session that was used to start the interactive session. This verb is paired with `Enter`. | Pop, Out | -| [Find](/dotnet/api/System.Management.Automation.VerbsCommon.Find) (fd) | Looks for an object in a container that is unknown, implied, optional, or specified. | Search | -| [Format](/dotnet/api/System.Management.Automation.VerbsCommon.Format) (f) | Arranges objects in a specified form or layout | | -| [Get](/dotnet/api/System.Management.Automation.VerbsCommon.Get) (g) | Specifies an action that retrieves a resource. This verb is paired with `Set`. | Read, Open, Cat, Type, Dir, Obtain, Dump, Acquire, Examine, Find, Search | -| [Hide](/dotnet/api/System.Management.Automation.VerbsCommon.Hide) (h) | Makes a resource undetectable. For example, a cmdlet whose name includes the Hide verb might conceal a service from a user. This verb is paired with `Show`. | Block | -| [Join](/dotnet/api/System.Management.Automation.VerbsCommon.Join) (j) | Combines resources into one resource. For example, the `Join-Path` cmdlet combines a path with one of its child paths to create a single path. This verb is paired with `Split`. | Combine, Unite, Connect, Associate | -| [Lock](/dotnet/api/System.Management.Automation.VerbsCommon.Lock) (lk) | Secures a resource. This verb is paired with `Unlock`. | Restrict, Secure | -| [Move](/dotnet/api/System.Management.Automation.VerbsCommon.Move) (m) | Moves a resource from one location to another. For example, the `Move-Item` cmdlet moves an item from one location in the data store to another location. | Transfer, Name, Migrate | -| [New](/dotnet/api/System.Management.Automation.VerbsCommon.New) (n) | Creates a resource. (The `Set` verb can also be used when creating a resource that includes data, such as the `Set-Variable` cmdlet.) | Create, Generate, Build, Make, Allocate | -| [Open](/dotnet/api/System.Management.Automation.VerbsCommon.Open) (op) | Changes the state of a resource to make it accessible, available, or usable. This verb is paired with `Close`. | | -| [Optimize](/dotnet/api/System.Management.Automation.VerbsCommon.Optimize) (om) | Increases the effectiveness of a resource. | | -| [Pop](/dotnet/api/System.Management.Automation.VerbsCommon.Pop) (pop) | Removes an item from the top of a stack. For example, the `Pop-Location` cmdlet changes the current location to the location that was most recently pushed onto the stack. | | -| [Push](/dotnet/api/System.Management.Automation.VerbsCommon.Push) (pu) | Adds an item to the top of a stack. For example, the `Push-Location` cmdlet pushes the current location onto the stack. | | -| [Redo](/dotnet/api/System.Management.Automation.VerbsCommon.Redo) (re) | Resets a resource to the state that was undone. | | -| [Remove](/dotnet/api/System.Management.Automation.VerbsCommon.Remove) (r) | Deletes a resource from a container. For example, the `Remove-Variable` cmdlet deletes a variable and its value. This verb is paired with `Add`. | Clear, Cut, Dispose, Discard, Erase | -| [Rename](/dotnet/api/System.Management.Automation.VerbsCommon.Rename) (rn) | Changes the name of a resource. For example, the `Rename-Item` cmdlet, which is used to access stored data, changes the name of an item in the data store. | Change | -| [Reset](/dotnet/api/System.Management.Automation.VerbsCommon.Reset) (rs) | Sets a resource back to its original state. | | -| [Resize](/dotnet/api/System.Management.Automation.VerbsCommon.Resize)(rz) | Changes the size of a resource. | | -| [Search](/dotnet/api/System.Management.Automation.VerbsCommon.Search) (sr) | Creates a reference to a resource in a container. | Find, Locate | -| [Select](/dotnet/api/System.Management.Automation.VerbsCommon.Select) (sc) | Locates a resource in a container. For example, the `Select-String` cmdlet finds text in strings and files. | Find, Locate | -| [Set](/dotnet/api/System.Management.Automation.VerbsCommon.Set) (s) | Replaces data on an existing resource or creates a resource that contains some data. For example, the `Set-Date` cmdlet changes the system time on the local computer. (The `New` verb can also be used to create a resource.) This verb is paired with `Get`. | Write, Reset, Assign, Configure, Update | -| [Show](/dotnet/api/System.Management.Automation.VerbsCommon.Show) (sh) | Makes a resource visible to the user. This verb is paired with `Hide`. | Display, Produce | -| [Skip](/dotnet/api/System.Management.Automation.VerbsCommon.Skip) (sk) | Bypasses one or more resources or points in a sequence. | Bypass, Jump | -| [Split](/dotnet/api/System.Management.Automation.VerbsCommon.Split) (sl) | Separates parts of a resource. For example, the `Split-Path` cmdlet returns different parts of a path. This verb is paired with `Join`. | Separate | -| [Step](/dotnet/api/System.Management.Automation.VerbsCommon.Step) (st) | Moves to the next point or resource in a sequence. | | -| [Switch](/dotnet/api/System.Management.Automation.VerbsCommon.Switch) (sw) | Specifies an action that alternates between two resources, such as to change between two locations, responsibilities, or states. | | -| [Undo](/dotnet/api/System.Management.Automation.VerbsCommon.Undo) (un) | Sets a resource to its previous state. | | -| [Unlock](/dotnet/api/System.Management.Automation.VerbsCommon.Unlock) (uk) | Releases a resource that was locked. This verb is paired with `Lock`. | Release, Unrestrict, Unsecure | -| [Watch](/dotnet/api/System.Management.Automation.VerbsCommon.Watch) (wc) | Continually inspects or monitors a resource for changes. | | +PowerShell uses the [System.Management.Automation.VerbsCommon][05] enumeration class to define +generic actions that can apply to almost any cmdlet. The following table lists most of the defined +verbs. + +| Verb (alias) | Action | Synonyms to avoid | +| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | +| [`Add`][06] (`a`) | Adds a resource to a container, or attaches an item to another item. For example, the `Add-Content` cmdlet adds content to a file. This verb is paired with `Remove`. | Append, Attach, Concatenate, Insert | +| [`Clear`][07] (`cl`) | Removes all the resources from a container but doesn't delete the container. For example, the `Clear-Content` cmdlet removes the contents of a file but doesn't delete the file. | Flush, Erase, Release, Unmark, Unset, Nullify | +| [`Close`][08] (`cs`) | Changes the state of a resource to make it inaccessible, unavailable, or unusable. This verb is paired with `Open.` | | +| [`Copy`][09] (`cp`) | Copies a resource to another name or to another container. For example, the `Copy-Item` cmdlet copies an item (such as a file) from one location in the data store to another location. | Duplicate, Clone, Replicate, Sync | +| [`Enter`][10] (`et`) | Specifies an action that allows the user to move into a resource. For example, the `Enter-PSSession` cmdlet places the user in an interactive session. This verb is paired with `Exit`. | Push, Into | +| [`Exit`][11] (`ex`) | Sets the current environment or context to the most recently used context. For example, the `Exit-PSSession` cmdlet places the user in the session that was used to start the interactive session. This verb is paired with `Enter`. | Pop, Out | +| [`Find`][12] (`fd`) | Looks for an object in a container that's unknown, implied, optional, or specified. | Search | +| [`Format`][13] (`f`) | Arranges objects in a specified form or layout | | +| [`Get`][14] (`g`) | Specifies an action that retrieves a resource. This verb is paired with `Set`. | Read, Open, Cat, Type, Dir, Obtain, Dump, Acquire, Examine, Find, Search | +| [`Hide`][15] (`h`) | Makes a resource undetectable. For example, a cmdlet whose name includes the Hide verb might conceal a service from a user. This verb is paired with `Show`. | Block | +| [`Join`][16] (`j`) | Combines resources into one resource. For example, the `Join-Path` cmdlet combines a path with one of its child paths to create a single path. This verb is paired with `Split`. | Combine, Unite, Connect, Associate | +| [`Lock`][17] (`lk`) | Secures a resource. This verb is paired with `Unlock`. | Restrict, Secure | +| [`Move`][18] (`m`) | Moves a resource from one location to another. For example, the `Move-Item` cmdlet moves an item from one location in the data store to another location. | Transfer, Name, Migrate | +| [`New`][19] (`n`) | Creates a resource. (The `Set` verb can also be used when creating a resource that includes data, such as the `Set-Variable` cmdlet.) | Create, Generate, Build, Make, Allocate | +| [`Open`][20] (`op`) | Changes the state of a resource to make it accessible, available, or usable. This verb is paired with `Close`. | | +| [`Optimize`][21] (`om`) | Increases the effectiveness of a resource. | | +| [`Pop`][22] (`pop`) | Removes an item from the top of a stack. For example, the `Pop-Location` cmdlet changes the current location to the location that was most recently pushed onto the stack. | | +| [`Push`][23] (`pu`) | Adds an item to the top of a stack. For example, the `Push-Location` cmdlet pushes the current location onto the stack. | | +| [`Redo`][24] (`re`) | Resets a resource to the state that was undone. | | +| [`Remove`][25] (`r`) | Deletes a resource from a container. For example, the `Remove-Variable` cmdlet deletes a variable and its value. This verb is paired with `Add`. | Clear, Cut, Dispose, Discard, Erase | +| [`Rename`][26] (`rn`) | Changes the name of a resource. For example, the `Rename-Item` cmdlet, which is used to access stored data, changes the name of an item in the data store. | Change | +| [`Reset`][27] (`rs`) | Sets a resource back to its original state. | | +| [`Resize`][28](`rz`) | Changes the size of a resource. | | +| [`Search`][29] (`sr`) | Creates a reference to a resource in a container. | Find, Locate | +| [`Select`][30] (`sc`) | Locates a resource in a container. For example, the `Select-String` cmdlet finds text in strings and files. | Find, Locate | +| [`Set`][31] (`s`) | Replaces data on an existing resource or creates a resource that contains some data. For example, the `Set-Date` cmdlet changes the system time on the local computer. (The `New` verb can also be used to create a resource.) This verb is paired with `Get`. | Write, Reset, Assign, Configure, Update | +| [`Show`][32] (`sh`) | Makes a resource visible to the user. This verb is paired with `Hide`. | Display, Produce | +| [`Skip`][33] (`sk`) | Bypasses one or more resources or points in a sequence. | Bypass, Jump | +| [`Split`][34] (`sl`) | Separates parts of a resource. For example, the `Split-Path` cmdlet returns different parts of a path. This verb is paired with `Join`. | Separate | +| [`Step`][35] (`st`) | Moves to the next point or resource in a sequence. | | +| [`Switch`][36] (`sw`) | Specifies an action that alternates between two resources, such as to change between two locations, responsibilities, or states. | | +| [`Undo`][37] (`un`) | Sets a resource to its previous state. | | +| [`Unlock`][38] (`uk`) | Releases a resource that was locked. This verb is paired with `Lock`. | Release, Unrestrict, Unsecure | +| [`Watch`][39] (`wc`) | Continually inspects or monitors a resource for changes. | | ## Communications Verbs -PowerShell uses the -[System.Management.Automation.VerbsCommunications](/dotnet/api/System.Management.Automation.VerbsCommunications) -class to define actions that apply to communications. The following table lists most of the defined -verbs. +PowerShell uses the [System.Management.Automation.VerbsCommunications][40] class to define actions +that apply to communications. The following table lists most of the defined verbs. -| Verb (alias) | Action | Synonyms to avoid | -| ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------- | ------------------------- | -| [Connect](/dotnet/api/System.Management.Automation.VerbsCommunications.Connect) (cc) | Creates a link between a source and a destination. This verb is paired with `Disconnect`. | Join, Telnet, Login | -| [Disconnect](/dotnet/api/System.Management.Automation.VerbsCommunications.Disconnect) (dc) | Breaks the link between a source and a destination. This verb is paired with `Connect`. | Break, Logoff | -| [Read](/dotnet/api/System.Management.Automation.VerbsCommunications.Read) (rd) | Acquires information from a source. This verb is paired with `Write`. | Acquire, Prompt, Get | -| [Receive](/dotnet/api/System.Management.Automation.VerbsCommunications.Receive) (rc) | Accepts information sent from a source. This verb is paired with `Send`. | Read, Accept, Peek | -| [Send](/dotnet/api/System.Management.Automation.VerbsCommunications.Send) (sd) | Delivers information to a destination. This verb is paired with `Receive`. | Put, Broadcast, Mail, Fax | -| [Write](/dotnet/api/System.Management.Automation.VerbsCommunications.Write) (wr) | Adds information to a target. This verb is paired with `Read`. | Put, Print | +| Verb (alias) | Action | Synonyms to avoid | +| ------------------------- | ----------------------------------------------------------------------------------------- | ------------------------- | +| [`Connect`][41] (`cc`) | Creates a link between a source and a destination. This verb is paired with `Disconnect`. | Join, Telnet, Login | +| [`Disconnect`][42] (`dc`) | Breaks the link between a source and a destination. This verb is paired with `Connect`. | Break, Logoff | +| [`Read`][43] (`rd`) | Acquires information from a source. This verb is paired with `Write`. | Acquire, Prompt, Get | +| [`Receive`][44] (`rc`) | Accepts information sent from a source. This verb is paired with `Send`. | Read, Accept, Peek | +| [`Send`][45] (`sd`) | Delivers information to a destination. This verb is paired with `Receive`. | Put, Broadcast, Mail, Fax | +| [`Write`][46] (`wr`) | Adds information to a target. This verb is paired with `Read`. | Put, Print | ## Data Verbs PowerShell uses the -[System.Management.Automation.VerbsData](/dotnet/api/System.Management.Automation.VerbsData) class +[System.Management.Automation.VerbsData][47] class to define actions that apply to data handling. The following table lists most of the defined verbs. -| Verb Name (alias) | Action | Synonyms to avoid | -| ---------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | -| [Backup](/dotnet/api/System.Management.Automation.VerbsData.Backup) (ba) | Stores data by replicating it. | Save, Burn, Replicate, Sync | -| [Checkpoint](/dotnet/api/System.Management.Automation.VerbsData.Checkpoint) (ch) | Creates a snapshot of the current state of the data or of its configuration. | Diff | -| [Compare](/dotnet/api/System.Management.Automation.VerbsData.Compare) (cr) | Evaluates the data from one resource against the data from another resource. | Diff | -| [Compress](/dotnet/api/System.Management.Automation.VerbsData.Compress) (cm) | Compacts the data of a resource. Pairs with `Expand`. | Compact | -| [Convert](/dotnet/api/System.Management.Automation.VerbsData.Convert) (cv) | Changes the data from one representation to another when the cmdlet supports bidirectional conversion or when the cmdlet supports conversion between multiple data types. | Change, Resize, Resample | -| [ConvertFrom](/dotnet/api/System.Management.Automation.VerbsData.ConvertFrom) (cf) | Converts one primary type of input (the cmdlet noun indicates the input) to one or more supported output types. | Export, Output, Out | -| [ConvertTo](/dotnet/api/System.Management.Automation.VerbsData.ConvertTo) (ct) | Converts from one or more types of input to a primary output type (the cmdlet noun indicates the output type). | Import, Input, In | -| [Dismount](/dotnet/api/System.Management.Automation.VerbsData.Dismount) (dm) | Detaches a named entity from a location. This verb is paired with `Mount`. | Unmount, Unlink | -| [Edit](/dotnet/api/System.Management.Automation.VerbsData.Edit) (ed) | Modifies existing data by adding or removing content. | Change, Update, Modify | -| [Expand](/dotnet/api/System.Management.Automation.VerbsData.Expand) (en) | Restores the data of a resource that has been compressed to its original state. This verb is paired with `Compress`. | Explode, Uncompress | -| [Export](/dotnet/api/System.Management.Automation.VerbsData.Export) (ep) | Encapsulates the primary input into a persistent data store, such as a file, or into an interchange format. This verb is paired with `Import`. | Extract, Backup | -| [Group](/dotnet/api/System.Management.Automation.VerbsData.Group) (gp) | Arranges or associates one or more resources | | -| [Import](/dotnet/api/System.Management.Automation.VerbsData.Import) (ip) | Creates a resource from data that is stored in a persistent data store (such as a file) or in an interchange format. For example, the `Import-Csv` cmdlet imports data from a comma-separated value (CSV) file to objects that can be used by other cmdlets. This verb is paired with `Export`. | BulkLoad, Load | -| [Initialize](/dotnet/api/System.Management.Automation.VerbsData.Initialize) (in) | Prepares a resource for use, and sets it to a default state. | Erase, Init, Renew, Rebuild, Reinitialize, Setup | -| [Limit](/dotnet/api/System.Management.Automation.VerbsData.Limit) (l) | Applies constraints to a resource. | Quota | -| [Merge](/dotnet/api/System.Management.Automation.VerbsData.Merge) (mg) | Creates a single resource from multiple resources. | Combine, Join | -| [Mount](/dotnet/api/System.Management.Automation.VerbsData.Mount) (mt) | Attaches a named entity to a location. This verb is paired with `Dismount`. | Connect | -| [Out](/dotnet/api/System.Management.Automation.VerbsData.Out) (o) | Sends data out of the environment. For example, the `Out-Printer` cmdlet sends data to a printer. | | -| [Publish](/dotnet/api/System.Management.Automation.VerbsData.Publish) (pb) | Makes a resource available to others. This verb is paired with `Unpublish`. | Deploy, Release, Install | -| [Restore](/dotnet/api/System.Management.Automation.VerbsData.Restore) (rr) | Sets a resource to a predefined state, such as a state set by `Checkpoint`. For example, the `Restore-Computer` cmdlet starts a system restore on the local computer. | Repair, Return, Undo, Fix | -| [Save](/dotnet/api/System.Management.Automation.VerbsData.Save) (sv) | Preserves data to avoid loss. | | -| [Sync](/dotnet/api/System.Management.Automation.VerbsData.Sync) (sy) | Assures that two or more resources are in the same state. | Replicate, Coerce, Match | -| [Unpublish](/dotnet/api/System.Management.Automation.VerbsData.Unpublish) (ub) | Makes a resource unavailable to others. This verb is paired with `Publish`. | Uninstall, Revert, Hide | -| [Update](/dotnet/api/System.Management.Automation.VerbsData.Update) (ud) | Brings a resource up-to-date to maintain its state, accuracy, conformance, or compliance. For example, the `Update-FormatData` cmdlet updates and adds formatting files to the current PowerShell console. | Refresh, Renew, Recalculate, Re-index | +| Verb Name (alias) | Action | Synonyms to avoid | +| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------ | +| [`Backup`][48] (`ba`) | Stores data by replicating it. | Save, Burn, Replicate, Sync | +| [`Checkpoint`][49] (`ch`) | Creates a snapshot of the current state of the data or of its configuration. | Diff | +| [`Compare`][50] (`cr`) | Evaluates the data from one resource against the data from another resource. | Diff | +| [`Compress`][51] (`cm`) | Compacts the data of a resource. Pairs with `Expand`. | Compact | +| [`Convert`][52] (`cv`) | Changes the data from one representation to another when the cmdlet supports bidirectional conversion or when the cmdlet supports conversion between multiple data types. | Change, Resize, Resample | +| [`ConvertFrom`][53] (`cf`) | Converts one primary type of input (the cmdlet noun indicates the input) to one or more supported output types. | Export, Output, Out | +| [`ConvertTo`][54] (`ct`) | Converts from one or more types of input to a primary output type (the cmdlet noun indicates the output type). | Import, Input, In | +| [`Dismount`][55] (`dm`) | Detaches a named entity from a location. This verb is paired with `Mount`. | Unmount, Unlink | +| [`Edit`][56] (`ed`) | Modifies existing data by adding or removing content. | Change, Update, Modify | +| [`Expand`][57] (`en`) | Restores the data of a resource that has been compressed to its original state. This verb is paired with `Compress`. | Explode, Uncompress | +| [`Export`][58] (`ep`) | Encapsulates the primary input into a persistent data store, such as a file, or into an interchange format. This verb is paired with `Import`. | Extract, Backup | +| [`Group`][59] (`gp`) | Arranges or associates one or more resources | | +| [`Import`][60] (`ip`) | Creates a resource from data that's stored in a persistent data store (such as a file) or in an interchange format. For example, the `Import-Csv` cmdlet imports data from a comma-separated value (`CSV`) file to objects that can be used by other cmdlets. This verb is paired with `Export`. | BulkLoad, Load | +| [`Initialize`][61] (`in`) | Prepares a resource for use, and sets it to a default state. | Erase, Init, Renew, Rebuild, Reinitialize, Setup | +| [`Limit`][62] (`l`) | Applies constraints to a resource. | Quota | +| [`Merge`][63] (`mg`) | Creates a single resource from multiple resources. | Combine, Join | +| [`Mount`][64] (`mt`) | Attaches a named entity to a location. This verb is paired with `Dismount`. | Connect | +| [`Out`][65] (`o`) | Sends data out of the environment. For example, the `Out-Printer` cmdlet sends data to a printer. | | +| [`Publish`][66] (`pb`) | Makes a resource available to others. This verb is paired with `Unpublish`. | Deploy, Release, Install | +| [`Restore`][67] (`rr`) | Sets a resource to a predefined state, such as a state set by `Checkpoint`. For example, the `Restore-Computer` cmdlet starts a system restore on the local computer. | Repair, Return, Undo, Fix | +| [`Save`][68] (`sv`) | Preserves data to avoid loss. | | +| [`Sync`][69] (`sy`) | Assures that two or more resources are in the same state. | Replicate, Coerce, Match | +| [`Unpublish`][70] (`ub`) | Makes a resource unavailable to others. This verb is paired with `Publish`. | Uninstall, Revert, Hide | +| [`Update`][71] (`ud`) | Brings a resource up-to-date to maintain its state, accuracy, conformance, or compliance. For example, the `Update-FormatData` cmdlet updates and adds formatting files to the current PowerShell console. | Refresh, Renew, Recalculate, Re-index | ## Diagnostic Verbs PowerShell uses the -[System.Management.Automation.VerbsDiagnostic](/dotnet/api/System.Management.Automation.VerbsDiagnostic) +[System.Management.Automation.VerbsDiagnostic][72] class to define actions that apply to diagnostics. The following table lists most of the defined verbs. -| Verb (alias) | Action | Synonyms to avoid | -| -------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------- | -| [Debug](/dotnet/api/System.Management.Automation.VerbsDiagnostic.Debug) (db) | Examines a resource to diagnose operational problems. | Diagnose | -| [Measure](/dotnet/api/System.Management.Automation.VerbsDiagnostic.Measure) (ms) | Identifies resources that are consumed by a specified operation, or retrieves statistics about a resource. | Calculate, Determine, Analyze | -| [Ping](/dotnet/api/System.Management.Automation.VerbsDiagnostic.Ping) (pi) | Deprecated - Use the Test verb instead. | | -| [Repair](/dotnet/api/System.Management.Automation.VerbsDiagnostic.Repair) (rp) | Restores a resource to a usable condition | Fix, Restore | -| [Resolve](/dotnet/api/System.Management.Automation.VerbsDiagnostic.Resolve) (rv) | Maps a shorthand representation of a resource to a more complete representation. | Expand, Determine | -| [Test](/dotnet/api/System.Management.Automation.VerbsDiagnostic.Test) (t) | Verifies the operation or consistency of a resource. | Diagnose, Analyze, Salvage, Verify | -| [Trace](/dotnet/api/System.Management.Automation.VerbsDiagnostic.Trace) (tr) | Tracks the activities of a resource. | Track, Follow, Inspect, Dig | +| Verb (alias) | Action | Synonyms to avoid | +| ---------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------- | +| [`Debug`][73] (`db`) | Examines a resource to diagnose operational problems. | Diagnose | +| [`Measure`][74] (`ms`) | Identifies resources that are consumed by a specified operation, or retrieves statistics about a resource. | Calculate, Determine, Analyze | +| [`Ping`][75] (`pi`) | Deprecated - Use the Test verb instead. | | +| [`Repair`][76] (`rp`) | Restores a resource to a usable condition | Fix, Restore | +| [`Resolve`][77] (`rv`) | Maps a shorthand representation of a resource to a more complete representation. | Expand, Determine | +| [`Test`][78] (`t`) | Verifies the operation or consistency of a resource. | Diagnose, Analyze, Salvage, Verify | +| [`Trace`][79] (`tr`) | Tracks the activities of a resource. | Track, Follow, Inspect, Dig | ## Lifecycle Verbs PowerShell uses the -[System.Management.Automation.VerbsLifecycle](/dotnet/api/System.Management.Automation.VerbsLifecycle) +[System.Management.Automation.VerbsLifecycle][80] class to define actions that apply to the lifecycle of a resource. The following table lists most of the defined verbs. -| Verb (alias) | Action | Synonyms to avoid | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------- | -| [Approve](/dotnet/api/System.Management.Automation.VerbsLifecycle.Approve) (ap) | Confirms or agrees to the status of a resource or process. | | -| [Assert](/dotnet/api/System.Management.Automation.VerbsLifecycle.Assert) (as) | Affirms the state of a resource. | Certify | -| [Build](/dotnet/api/System.Management.Automation.VerbsLifecycle.Build) (bd) | Creates an artifact (usually a binary or document) out of some set of input files (usually source code or declarative documents.) This verb was added in PowerShell 6. | | -| [Complete](/dotnet/api/system.management.automation.host.buffercelltype) (cp) | Concludes an operation. | | -| [Confirm](/dotnet/api/System.Management.Automation.VerbsLifecycle.Confirm) (cn) | Acknowledges, verifies, or validates the state of a resource or process. | Acknowledge, Agree, Certify, Validate, Verify | -| [Deny](/dotnet/api/System.Management.Automation.VerbsLifecycle.Deny) (dn) | Refuses, objects, blocks, or opposes the state of a resource or process. | Block, Object, Refuse, Reject | -| [Deploy](/dotnet/api/System.Management.Automation.VerbsLifecycle.Deploy) (dp) | Sends an application, website, or solution to a remote target[s] in such a way that a consumer of that solution can access it after deployment is complete. This verb was added in PowerShell 6. | | -| [Disable](/dotnet/api/System.Management.Automation.VerbsLifecycle.Disable) (d) | Configures a resource to an unavailable or inactive state. For example, the `Disable-PSBreakpoint` cmdlet makes a breakpoint inactive. This verb is paired with `Enable`. | Halt, Hide | -| [Enable](/dotnet/api/System.Management.Automation.VerbsLifecycle.Enable) (e) | Configures a resource to an available or active state. For example, the `Enable-PSBreakpoint` cmdlet makes a breakpoint active. This verb is paired with `Disable`. | Start, Begin | -| [Install](/dotnet/api/System.Management.Automation.VerbsLifecycle.Install) (is) | Places a resource in a location, and optionally initializes it. This verb is paired with `Uninstall`. | Setup | -| [Invoke](/dotnet/api/System.Management.Automation.VerbsLifecycle.Invoke) (i) | Performs an action, such as running a command or a method. | Run, Start | -| [Register](/dotnet/api/System.Management.Automation.VerbsLifecycle.Register) (rg) | Creates an entry for a resource in a repository such as a database. This verb is paired with `Unregister`. | | -| [Request](/dotnet/api/System.Management.Automation.VerbsLifecycle.Request) (rq) | Asks for a resource or asks for permissions. | | -| [Restart](/dotnet/api/System.Management.Automation.VerbsLifecycle.Restart) (rt) | Stops an operation and then starts it again. For example, the `Restart-Service` cmdlet stops and then starts a service. | Recycle | -| [Resume](/dotnet/api/System.Management.Automation.VerbsLifecycle.Resume) (ru) | Starts an operation that has been suspended. For example, the `Resume-Service` cmdlet starts a service that has been suspended. This verb is paired with `Suspend`. | | -| [Start](/dotnet/api/System.Management.Automation.VerbsLifecycle.Start) (sa) | Initiates an operation. For example, the `Start-Service` cmdlet starts a service. This verb is paired with `Stop`. | Launch, Initiate, Boot | -| [Stop](/dotnet/api/System.Management.Automation.VerbsLifecycle.Stop) (sp) | Discontinues an activity. This verb is paired with `Start`. | End, Kill, Terminate, Cancel | -| [Submit](/dotnet/api/System.Management.Automation.VerbsLifecycle.Submit) (sb) | Presents a resource for approval. | Post | -| [Suspend](/dotnet/api/System.Management.Automation.VerbsLifecycle.Suspend) (ss) | Pauses an activity. For example, the `Suspend-Service` cmdlet pauses a service. This verb is paired with `Resume`. | Pause | -| [Uninstall](/dotnet/api/System.Management.Automation.VerbsLifecycle.Uninstall) (us) | Removes a resource from an indicated location. This verb is paired with `Install`. | | -| [Unregister](/dotnet/api/System.Management.Automation.VerbsLifecycle.Unregister) (ur) | Removes the entry for a resource from a repository. This verb is paired with `Register`. | Remove | -| [Wait](/dotnet/api/System.Management.Automation.VerbsLifecycle.Wait) (w) | Pauses an operation until a specified event occurs. For example, the `Wait-Job` cmdlet pauses operations until one or more of the background jobs are complete. | Sleep, Pause | +| Verb (alias) | Action | Synonyms to avoid | +| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------- | +| [`Approve`][81] (`ap`) | Confirms or agrees to the status of a resource or process. | | +| [`Assert`][82] (`as`) | Affirms the state of a resource. | Certify | +| [`Build`][83] (`bd`) | Creates an artifact (usually a binary or document) out of some set of input files (usually source code or declarative documents.) This verb was added in PowerShell 6. | | +| [`Complete`][04] (`cp`) | Concludes an operation. | | +| [`Confirm`][84] (`cn`) | Acknowledges, verifies, or validates the state of a resource or process. | Acknowledge, Agree, Certify, Validate, Verify | +| [`Deny`][85] (`dn`) | Refuses, objects, blocks, or opposes the state of a resource or process. | Block, Object, Refuse, Reject | +| [`Deploy`][86] (`dp`) | Sends an application, website, or solution to a remote target[s] in such a way that a consumer of that solution can access it after deployment is complete. This verb was added in PowerShell 6. | | +| [`Disable`][87] (`d`) | Configures a resource to an unavailable or inactive state. For example, the `Disable-PSBreakpoint` cmdlet makes a breakpoint inactive. This verb is paired with `Enable`. | Halt, Hide | +| [`Enable`][88] (`e`) | Configures a resource to an available or active state. For example, the `Enable-PSBreakpoint` cmdlet makes a breakpoint active. This verb is paired with `Disable`. | Start, Begin | +| [`Install`][89] (`is`) | Places a resource in a location, and optionally initializes it. This verb is paired with `Uninstall`. | Setup | +| [`Invoke`][90] (`i`) | Performs an action, such as running a command or a method. | Run, Start | +| [`Register`][91] (`rg`) | Creates an entry for a resource in a repository such as a database. This verb is paired with `Unregister`. | | +| [`Request`][92] (`rq`) | Asks for a resource or asks for permissions. | | +| [`Restart`][93] (`rt`) | Stops an operation and then starts it again. For example, the `Restart-Service` cmdlet stops and then starts a service. | Recycle | +| [`Resume`][94] (`ru`) | Starts an operation that has been suspended. For example, the `Resume-Service` cmdlet starts a service that has been suspended. This verb is paired with `Suspend`. | | +| [`Start`][95] (`sa`) | Initiates an operation. For example, the `Start-Service` cmdlet starts a service. This verb is paired with `Stop`. | Launch, Initiate, Boot | +| [`Stop`][96] (`sp`) | Discontinues an activity. This verb is paired with `Start`. | End, Kill, Terminate, Cancel | +| [`Submit`][97] (`sb`) | Presents a resource for approval. | Post | +| [`Suspend`][98] (`ss`) | Pauses an activity. For example, the `Suspend-Service` cmdlet pauses a service. This verb is paired with `Resume`. | Pause | +| [`Uninstall`][99] (`us`) | Removes a resource from an indicated location. This verb is paired with `Install`. | | +| [`Unregister`][100] (`ur`) | Removes the entry for a resource from a repository. This verb is paired with `Register`. | Remove | +| [`Wait`][101] (`w`) | Pauses an operation until a specified event occurs. For example, the `Wait-Job` cmdlet pauses operations until one or more of the background jobs are complete. | Sleep, Pause | ## Security Verbs PowerShell uses the -[System.Management.Automation.VerbsSecurity](/dotnet/api/System.Management.Automation.VerbsSecurity) +[System.Management.Automation.VerbsSecurity][104] class to define actions that apply to security. The following table lists most of the defined verbs. -| Verb (alias) | Action | Synonyms to avoid | -| ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------ | -| [Block](/dotnet/api/System.Management.Automation.VerbsSecurity.Block) (bl) | Restricts access to a resource. This verb is paired with `Unblock`. | Prevent, Limit, Deny | -| [Grant](/dotnet/api/System.Management.Automation.VerbsSecurity.Grant) (gr) | Allows access to a resource. This verb is paired with `Revoke`. | Allow, Enable | -| [Protect](/dotnet/api/System.Management.Automation.VerbsSecurity.Protect) (pt) | Safeguards a resource from attack or loss. This verb is paired with `Unprotect`. | Encrypt, Safeguard, Seal | -| [Revoke](/dotnet/api/System.Management.Automation.VerbsSecurity.Revoke) (rk) | Specifies an action that does not allow access to a resource. This verb is paired with `Grant`. | Remove, Disable | -| [Unblock](/dotnet/api/System.Management.Automation.VerbsSecurity.Unblock) (ul) | Removes restrictions to a resource. This verb is paired with `Block`. | Clear, Allow | -| [Unprotect](/dotnet/api/System.Management.Automation.VerbsSecurity.Unprotect) (up) | Removes safeguards from a resource that were added to prevent it from attack or loss. This verb is paired with `Protect`. | Decrypt, Unseal | +| Verb (alias) | Action | Synonyms to avoid | +| ------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------ | +| [`Block`][105] (`bl`) | Restricts access to a resource. This verb is paired with `Unblock`. | Prevent, Limit, Deny | +| [`Grant`][106] (`gr`) | Allows access to a resource. This verb is paired with `Revoke`. | Allow, Enable | +| [`Protect`][107] (`pt`) | Safeguards a resource from attack or loss. This verb is paired with `Unprotect`. | Encrypt, Safeguard, Seal | +| [`Revoke`][108] (`rk`) | Specifies an action that doesn't allow access to a resource. This verb is paired with `Grant`. | Remove, Disable | +| [`Unblock`][109] (`ul`) | Removes restrictions to a resource. This verb is paired with `Block`. | Clear, Allow | +| [`Unprotect`][110] (`up`) | Removes safeguards from a resource that were added to prevent it from attack or loss. This verb is paired with `Protect`. | Decrypt, Unseal | ## Other Verbs -PowerShell uses the -[System.Management.Automation.VerbsOther](/dotnet/api/System.Management.Automation.VerbsOther) class -to define canonical verb names that do not fit into a specific verb name category such as the -common, communications, data, lifecycle, or security verb names verbs. +PowerShell uses the [System.Management.Automation.VerbsOther][102] class to define canonical verb +names that don't fit into a specific verb name category such as the common, communications, data, +lifecycle, or security verb names verbs. -| Verb (alias) | Action | Synonyms to avoid | -| ------------------------------------------------------------------ | -------------------------------------------- | ----------------- | -| [Use](/dotnet/api/System.Management.Automation.VerbsOther.Use) (u) | Uses or includes a resource to do something. | | +| Verb (alias) | Action | Synonyms to avoid | +| ------------------ | -------------------------------------------- | ----------------- | +| [`Use`][103] (`u`) | Uses or includes a resource to do something. | | ## See Also -- [System.Management.Automation.VerbsCommon](/dotnet/api/System.Management.Automation.VerbsCommon) -- [System.Management.Automation.VerbsCommunications](/dotnet/api/System.Management.Automation.VerbsCommunications) -- [System.Management.Automation.VerbsData](/dotnet/api/System.Management.Automation.VerbsData) -- [System.Management.Automation.VerbsDiagnostic](/dotnet/api/System.Management.Automation.VerbsDiagnostic) -- [System.Management.Automation.VerbsLifecycle](/dotnet/api/System.Management.Automation.VerbsLifecycle) -- [System.Management.Automation.VerbsSecurity](/dotnet/api/System.Management.Automation.VerbsSecurity) -- [System.Management.Automation.VerbsOther](/dotnet/api/System.Management.Automation.VerbsOther) -- [Cmdlet Declaration](./cmdlet-class-declaration.md) -- [Windows PowerShell Programmer's Guide](../prog-guide/windows-powershell-programmer-s-guide.md) -- [Windows PowerShell Shell SDK](../windows-powershell-reference.md) +- [System.Management.Automation.VerbsCommon][05] +- [System.Management.Automation.VerbsCommunications][40] +- [System.Management.Automation.VerbsData][47] +- [System.Management.Automation.VerbsDiagnostic][72] +- [System.Management.Automation.VerbsLifecycle][80] +- [System.Management.Automation.VerbsSecurity][104] +- [System.Management.Automation.VerbsOther][102] +- [Cmdlet Declaration][03] +- [Windows PowerShell Programmer's Guide][01] +- [Windows PowerShell Shell SDK][02] + + +[01]: ../prog-guide/windows-powershell-programmer-s-guide.md +[02]: ../windows-powershell-reference.md +[03]: ./cmdlet-class-declaration.md +[04]: xref:System.Management.Automation.Host.BufferCellType +[05]: xref:System.Management.Automation.VerbsCommon +[06]: xref:System.Management.Automation.VerbsCommon.Add%2A +[07]: xref:System.Management.Automation.VerbsCommon.Clear%2A +[08]: xref:System.Management.Automation.VerbsCommon.Close%2A +[09]: xref:System.Management.Automation.VerbsCommon.Copy%2A +[10]: xref:System.Management.Automation.VerbsCommon.Enter%2A +[11]: xref:System.Management.Automation.VerbsCommon.Exit%2A +[12]: xref:System.Management.Automation.VerbsCommon.Find%2A +[13]: xref:System.Management.Automation.VerbsCommon.Format%2A +[14]: xref:System.Management.Automation.VerbsCommon.Get%2A +[15]: xref:System.Management.Automation.VerbsCommon.Hide%2A +[16]: xref:System.Management.Automation.VerbsCommon.Join%2A +[17]: xref:System.Management.Automation.VerbsCommon.Lock%2A +[18]: xref:System.Management.Automation.VerbsCommon.Move%2A +[19]: xref:System.Management.Automation.VerbsCommon.New%2A +[20]: xref:System.Management.Automation.VerbsCommon.Open%2A +[21]: xref:System.Management.Automation.VerbsCommon.Optimize%2A +[22]: xref:System.Management.Automation.VerbsCommon.Pop%2A +[23]: xref:System.Management.Automation.VerbsCommon.Push%2A +[24]: xref:System.Management.Automation.VerbsCommon.Redo%2A +[25]: xref:System.Management.Automation.VerbsCommon.Remove%2A +[26]: xref:System.Management.Automation.VerbsCommon.Rename%2A +[27]: xref:System.Management.Automation.VerbsCommon.Reset%2A +[28]: xref:System.Management.Automation.VerbsCommon.Resize%2A +[29]: xref:System.Management.Automation.VerbsCommon.Search%2A +[30]: xref:System.Management.Automation.VerbsCommon.Select%2A +[31]: xref:System.Management.Automation.VerbsCommon.Set%2A +[32]: xref:System.Management.Automation.VerbsCommon.Show%2A +[33]: xref:System.Management.Automation.VerbsCommon.Skip%2A +[34]: xref:System.Management.Automation.VerbsCommon.Split%2A +[35]: xref:System.Management.Automation.VerbsCommon.Step%2A +[36]: xref:System.Management.Automation.VerbsCommon.Switch%2A +[37]: xref:System.Management.Automation.VerbsCommon.Undo%2A +[38]: xref:System.Management.Automation.VerbsCommon.Unlock%2A +[39]: xref:System.Management.Automation.VerbsCommon.Watch%2A +[40]: xref:System.Management.Automation.VerbsCommunications +[41]: xref:System.Management.Automation.VerbsCommunications.Connect%2A +[42]: xref:System.Management.Automation.VerbsCommunications.Disconnect%2A +[43]: xref:System.Management.Automation.VerbsCommunications.Read%2A +[44]: xref:System.Management.Automation.VerbsCommunications.Receive%2A +[45]: xref:System.Management.Automation.VerbsCommunications.Send%2A +[46]: xref:System.Management.Automation.VerbsCommunications.Write%2A +[47]: xref:System.Management.Automation.VerbsData +[48]: xref:System.Management.Automation.VerbsData.Backup%2A +[49]: xref:System.Management.Automation.VerbsData.Checkpoint%2A +[50]: xref:System.Management.Automation.VerbsData.Compare%2A +[51]: xref:System.Management.Automation.VerbsData.Compress%2A +[52]: xref:System.Management.Automation.VerbsData.Convert%2A +[53]: xref:System.Management.Automation.VerbsData.ConvertFrom%2A +[54]: xref:System.Management.Automation.VerbsData.ConvertTo%2A +[55]: xref:System.Management.Automation.VerbsData.Dismount%2A +[56]: xref:System.Management.Automation.VerbsData.Edit%2A +[57]: xref:System.Management.Automation.VerbsData.Expand%2A +[58]: xref:System.Management.Automation.VerbsData.Export%2A +[59]: xref:System.Management.Automation.VerbsData.Group%2A +[60]: xref:System.Management.Automation.VerbsData.Import%2A +[61]: xref:System.Management.Automation.VerbsData.Initialize%2A +[62]: xref:System.Management.Automation.VerbsData.Limit%2A +[63]: xref:System.Management.Automation.VerbsData.Merge%2A +[64]: xref:System.Management.Automation.VerbsData.Mount%2A +[65]: xref:System.Management.Automation.VerbsData.Out%2A +[66]: xref:System.Management.Automation.VerbsData.Publish%2A +[67]: xref:System.Management.Automation.VerbsData.Restore%2A +[68]: xref:System.Management.Automation.VerbsData.Save%2A +[69]: xref:System.Management.Automation.VerbsData.Sync%2A +[70]: xref:System.Management.Automation.VerbsData.Unpublish%2A +[71]: xref:System.Management.Automation.VerbsData.Update%2A +[72]: xref:System.Management.Automation.VerbsDiagnostic +[73]: xref:System.Management.Automation.VerbsDiagnostic.Debug%2A +[74]: xref:System.Management.Automation.VerbsDiagnostic.Measure%2A +[75]: xref:System.Management.Automation.VerbsDiagnostic.Ping%2A +[76]: xref:System.Management.Automation.VerbsDiagnostic.Repair%2A +[77]: xref:System.Management.Automation.VerbsDiagnostic.Resolve%2A +[78]: xref:System.Management.Automation.VerbsDiagnostic.Test%2A +[79]: xref:System.Management.Automation.VerbsDiagnostic.Trace%2A +[80]: xref:System.Management.Automation.VerbsLifecycle +[81]: xref:System.Management.Automation.VerbsLifecycle.Approve%2A +[82]: xref:System.Management.Automation.VerbsLifecycle.Assert%2A +[83]: xref:System.Management.Automation.VerbsLifecycle.Build%2A +[84]: xref:System.Management.Automation.VerbsLifecycle.Confirm%2A +[85]: xref:System.Management.Automation.VerbsLifecycle.Deny%2A +[86]: xref:System.Management.Automation.VerbsLifecycle.Deploy%2A +[87]: xref:System.Management.Automation.VerbsLifecycle.Disable%2A +[88]: xref:System.Management.Automation.VerbsLifecycle.Enable%2A +[89]: xref:System.Management.Automation.VerbsLifecycle.Install%2A +[90]: xref:System.Management.Automation.VerbsLifecycle.Invoke%2A +[91]: xref:System.Management.Automation.VerbsLifecycle.Register%2A +[92]: xref:System.Management.Automation.VerbsLifecycle.Request%2A +[93]: xref:System.Management.Automation.VerbsLifecycle.Restart%2A +[94]: xref:System.Management.Automation.VerbsLifecycle.Resume%2A +[95]: xref:System.Management.Automation.VerbsLifecycle.Start%2A +[96]: xref:System.Management.Automation.VerbsLifecycle.Stop%2A +[97]: xref:System.Management.Automation.VerbsLifecycle.Submit%2A +[98]: xref:System.Management.Automation.VerbsLifecycle.Suspend%2A +[99]: xref:System.Management.Automation.VerbsLifecycle.Uninstall%2A +[100]: xref:System.Management.Automation.VerbsLifecycle.Unregister%2A +[101]: xref:System.Management.Automation.VerbsLifecycle.Wait%2A +[102]: xref:System.Management.Automation.VerbsOther +[103]: xref:System.Management.Automation.VerbsOther.Use%2A +[104]: xref:System.Management.Automation.VerbsSecurity +[105]: xref:System.Management.Automation.VerbsSecurity.Block%2A +[106]: xref:System.Management.Automation.VerbsSecurity.Grant%2A +[107]: xref:System.Management.Automation.VerbsSecurity.Protect%2A +[108]: xref:System.Management.Automation.VerbsSecurity.Revoke%2A +[109]: xref:System.Management.Automation.VerbsSecurity.Unblock%2A +[110]: xref:System.Management.Automation.VerbsSecurity.Unprotect%2A From 128effcd5d849c0acfb06f90c8721eaf7841ee19 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Tue, 29 Apr 2025 13:32:39 -0700 Subject: [PATCH 2/2] Minor updates for issues reported by UUF (#12038) * Minor updates for issues reported by UUF * Simplify terminology for docs build system --- .../About/about_Break.md | 4 +-- .../Microsoft.PowerShell.Core/Clear-Host.md | 28 +++---------------- .../About/about_Break.md | 4 +-- .../Microsoft.PowerShell.Core/Clear-Host.md | 28 +++---------------- .../Microsoft.PowerShell.Utility/Test-Json.md | 18 +++++------- .../About/about_Break.md | 4 +-- .../Microsoft.PowerShell.Core/Clear-Host.md | 28 +++---------------- .../Microsoft.PowerShell.Utility/Test-Json.md | 14 ++++------ .../About/about_Break.md | 6 ++-- .../Microsoft.PowerShell.Core/Clear-Host.md | 28 +++---------------- .../Microsoft.PowerShell.Utility/Test-Json.md | 14 ++++------ .../contributing/general-markdown.md | 10 +++---- .../install/Installing-PowerShell-on-macOS.md | 4 +-- reference/includes/ubuntu-support.md | 4 +-- 14 files changed, 51 insertions(+), 143 deletions(-) diff --git a/reference/5.1/Microsoft.PowerShell.Core/About/about_Break.md b/reference/5.1/Microsoft.PowerShell.Core/About/about_Break.md index 1091a7340ed2..814e7bf7e2e1 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/About/about_Break.md +++ b/reference/5.1/Microsoft.PowerShell.Core/About/about_Break.md @@ -1,7 +1,7 @@ --- description: Describes a statement you can use to immediately exit `foreach`, `for`, `while`, `do`, `switch`, or `trap` statements. Locale: en-US -ms.date: 12/26/2024 +ms.date: 04/29/2025 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_break?view=powershell-5.1&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_Break @@ -79,7 +79,7 @@ example has a `while` statement with a `for` statement: ```powershell :myLabel while () { - for ($item in $items) { + foreach ($item in $items) { if () { break myLabel } diff --git a/reference/5.1/Microsoft.PowerShell.Core/Clear-Host.md b/reference/5.1/Microsoft.PowerShell.Core/Clear-Host.md index 90a9fda6ee89..6b27a9157756 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/Clear-Host.md +++ b/reference/5.1/Microsoft.PowerShell.Core/Clear-Host.md @@ -2,7 +2,7 @@ external help file: System.Management.Automation.dll-Help.xml Locale: en-US Module Name: Microsoft.PowerShell.Core -ms.date: 08/29/2023 +ms.date: 04/29/2025 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/functions/clear-host?view=powershell-5.1&WT.mc_id=ps-gethelp schema: 2.0.0 title: Clear-Host @@ -38,7 +38,7 @@ might work differently in different host programs. ### Example 1 ```powershell -PS> Get-Process +PS> Get-Process | Select-Object -First 5 Handles NPM(K) PM(K) WS(K) VM(M) CPU(s) Id ProcessName ------- ------ ----- ----- ----- ------ -- ----------- @@ -47,29 +47,9 @@ Handles NPM(K) PM(K) WS(K) VM(M) CPU(s) Id ProcessName 646 12 2332 4896 49 1.12 388 csrss 189 11 2860 7084 114 0.66 2896 csrss 78 11 1876 4008 42 0.22 4000 csrss - 76 7 1848 5064 54 0.08 1028 dwm - 610 41 23952 44048 208 4.40 2080 explorer - 0 0 0 24 0 0 Idle - 182 32 7692 15980 91 0.23 3056 LogonUI - 186 25 7832 16068 91 0.27 3996 LogonUI - 1272 32 11512 20432 58 25.07 548 lsass - 267 10 3536 6736 34 0.80 556 lsm - 137 17 3520 7472 61 0.05 1220 msdtc - 447 31 70316 84476 201 1,429.67 836 MsMpEng - 265 18 7136 15628 134 2.20 3544 msseces - 248 16 6476 4076 76 0.22 1592 NisSrv - 368 25 61312 65508 614 1.78 848 powershell - 101 8 2304 6624 70 0.64 3648 rdpclip - 258 15 6804 12156 50 2.65 536 services -... - -PS> cls - - -PS> -``` -This command uses the `cls` alias of `Clear-Host` to clear the current display. +PS> Clear-Host +``` ## INPUTS diff --git a/reference/7.4/Microsoft.PowerShell.Core/About/about_Break.md b/reference/7.4/Microsoft.PowerShell.Core/About/about_Break.md index af39e4288e7c..d838fccf6ec2 100644 --- a/reference/7.4/Microsoft.PowerShell.Core/About/about_Break.md +++ b/reference/7.4/Microsoft.PowerShell.Core/About/about_Break.md @@ -1,7 +1,7 @@ --- description: Describes a statement you can use to immediately exit `foreach`, `for`, `while`, `do`, `switch`, or `trap` statements. Locale: en-US -ms.date: 12/26/2024 +ms.date: 04/29/2025 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_break?view=powershell-7.4&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_Break @@ -79,7 +79,7 @@ example has a `while` statement with a `for` statement: ```powershell :myLabel while () { - for ($item in $items) { + foreach ($item in $items) { if () { break myLabel } diff --git a/reference/7.4/Microsoft.PowerShell.Core/Clear-Host.md b/reference/7.4/Microsoft.PowerShell.Core/Clear-Host.md index 093241c27a05..8f2fd1fbd842 100644 --- a/reference/7.4/Microsoft.PowerShell.Core/Clear-Host.md +++ b/reference/7.4/Microsoft.PowerShell.Core/Clear-Host.md @@ -2,7 +2,7 @@ external help file: System.Management.Automation.dll-Help.xml Locale: en-US Module Name: Microsoft.PowerShell.Core -ms.date: 08/29/2023 +ms.date: 04/29/2025 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/clear-host?view=powershell-7.4&WT.mc_id=ps-gethelp schema: 2.0.0 title: Clear-Host @@ -38,7 +38,7 @@ might work differently in different host programs. ### Example 1 ```powershell -PS> Get-Process +PS> Get-Process | Select-Object -First 5 Handles NPM(K) PM(K) WS(K) VM(M) CPU(s) Id ProcessName ------- ------ ----- ----- ----- ------ -- ----------- @@ -47,29 +47,9 @@ Handles NPM(K) PM(K) WS(K) VM(M) CPU(s) Id ProcessName 646 12 2332 4896 49 1.12 388 csrss 189 11 2860 7084 114 0.66 2896 csrss 78 11 1876 4008 42 0.22 4000 csrss - 76 7 1848 5064 54 0.08 1028 dwm - 610 41 23952 44048 208 4.40 2080 explorer - 0 0 0 24 0 0 Idle - 182 32 7692 15980 91 0.23 3056 LogonUI - 186 25 7832 16068 91 0.27 3996 LogonUI - 1272 32 11512 20432 58 25.07 548 lsass - 267 10 3536 6736 34 0.80 556 lsm - 137 17 3520 7472 61 0.05 1220 msdtc - 447 31 70316 84476 201 1,429.67 836 MsMpEng - 265 18 7136 15628 134 2.20 3544 msseces - 248 16 6476 4076 76 0.22 1592 NisSrv - 368 25 61312 65508 614 1.78 848 powershell - 101 8 2304 6624 70 0.64 3648 rdpclip - 258 15 6804 12156 50 2.65 536 services -... - -PS> cls - - -PS> -``` -This command uses the `cls` alias of `Clear-Host` to clear the current display. +PS> Clear-Host +``` ## INPUTS diff --git a/reference/7.4/Microsoft.PowerShell.Utility/Test-Json.md b/reference/7.4/Microsoft.PowerShell.Utility/Test-Json.md index 3390b21b0400..e1ed5c0a0cc6 100644 --- a/reference/7.4/Microsoft.PowerShell.Utility/Test-Json.md +++ b/reference/7.4/Microsoft.PowerShell.Utility/Test-Json.md @@ -2,7 +2,7 @@ external help file: Microsoft.PowerShell.Commands.Utility.dll-Help.xml Locale: en-US Module Name: Microsoft.PowerShell.Utility -ms.date: 07/24/2024 +ms.date: 04/29/2025 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/test-json?view=powershell-7.4&WT.mc_id=ps-gethelp schema: 2.0.0 title: Test-Json @@ -136,20 +136,16 @@ $schema = @' } } '@ -'{"name": "Ashley", "age": "25"}' | Test-Json -Schema $schema +'{"name": "Ashley", "age": "25"}' | Test-Json -Schema $schema -ErrorAction SilentlyContinue ``` ```Output -Test-Json: -Line | - 35 | '{"name": "Ashley", "age": "25"}' | Test-Json -Schema $schema - | ~~~~~~~~~~~~~~~~~~~~~~~~~ - | The JSON is not valid with the schema: Value is "string" but should be "integer" at '/age' False ``` -In this example, we get an error because the schema expects an integer for **age** but the JSON -input we tested uses a string value instead. +In this example, we use the **ErrorAction** parameter to suppres the error message. Without this +parameter the command also outputs an error because the schema expects an integer for **age** but +the JSON input we tested uses a string value instead. For more information, see [JSON Schema](https://json-schema.org/). @@ -275,8 +271,8 @@ Accept wildcard characters: True ### -Schema Specifies a schema to validate the JSON input against. If passed, `Test-Json` validates that the -JSON input conforms to the spec specified by the **Schema** parameter and return `$true` only if the -input conforms to the provided schema. +JSON input conforms to the specification defined by the **Schema** parameter and returns `$true` +only if the input conforms to the provided schema. For more information, see [JSON Schema](https://json-schema.org/). diff --git a/reference/7.5/Microsoft.PowerShell.Core/About/about_Break.md b/reference/7.5/Microsoft.PowerShell.Core/About/about_Break.md index 892d4e94914b..4469cb6cb53d 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/About/about_Break.md +++ b/reference/7.5/Microsoft.PowerShell.Core/About/about_Break.md @@ -1,7 +1,7 @@ --- description: Describes a statement you can use to immediately exit `foreach`, `for`, `while`, `do`, `switch`, or `trap` statements. Locale: en-US -ms.date: 12/26/2024 +ms.date: 04/29/2025 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_break?view=powershell-7.5&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_Break @@ -79,7 +79,7 @@ example has a `while` statement with a `for` statement: ```powershell :myLabel while () { - for ($item in $items) { + foreach ($item in $items) { if () { break myLabel } diff --git a/reference/7.5/Microsoft.PowerShell.Core/Clear-Host.md b/reference/7.5/Microsoft.PowerShell.Core/Clear-Host.md index 7ec13f403335..f0c2f7d498ee 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/Clear-Host.md +++ b/reference/7.5/Microsoft.PowerShell.Core/Clear-Host.md @@ -2,7 +2,7 @@ external help file: System.Management.Automation.dll-Help.xml Locale: en-US Module Name: Microsoft.PowerShell.Core -ms.date: 08/29/2023 +ms.date: 04/29/2025 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/clear-host?view=powershell-7.5&WT.mc_id=ps-gethelp schema: 2.0.0 title: Clear-Host @@ -38,7 +38,7 @@ might work differently in different host programs. ### Example 1 ```powershell -PS> Get-Process +PS> Get-Process | Select-Object -First 5 Handles NPM(K) PM(K) WS(K) VM(M) CPU(s) Id ProcessName ------- ------ ----- ----- ----- ------ -- ----------- @@ -47,29 +47,9 @@ Handles NPM(K) PM(K) WS(K) VM(M) CPU(s) Id ProcessName 646 12 2332 4896 49 1.12 388 csrss 189 11 2860 7084 114 0.66 2896 csrss 78 11 1876 4008 42 0.22 4000 csrss - 76 7 1848 5064 54 0.08 1028 dwm - 610 41 23952 44048 208 4.40 2080 explorer - 0 0 0 24 0 0 Idle - 182 32 7692 15980 91 0.23 3056 LogonUI - 186 25 7832 16068 91 0.27 3996 LogonUI - 1272 32 11512 20432 58 25.07 548 lsass - 267 10 3536 6736 34 0.80 556 lsm - 137 17 3520 7472 61 0.05 1220 msdtc - 447 31 70316 84476 201 1,429.67 836 MsMpEng - 265 18 7136 15628 134 2.20 3544 msseces - 248 16 6476 4076 76 0.22 1592 NisSrv - 368 25 61312 65508 614 1.78 848 powershell - 101 8 2304 6624 70 0.64 3648 rdpclip - 258 15 6804 12156 50 2.65 536 services -... - -PS> cls - - -PS> -``` -This command uses the `cls` alias of `Clear-Host` to clear the current display. +PS> Clear-Host +``` ## INPUTS diff --git a/reference/7.5/Microsoft.PowerShell.Utility/Test-Json.md b/reference/7.5/Microsoft.PowerShell.Utility/Test-Json.md index 3001d2a38055..86a42df7b32d 100644 --- a/reference/7.5/Microsoft.PowerShell.Utility/Test-Json.md +++ b/reference/7.5/Microsoft.PowerShell.Utility/Test-Json.md @@ -2,7 +2,7 @@ external help file: Microsoft.PowerShell.Commands.Utility.dll-Help.xml Locale: en-US Module Name: Microsoft.PowerShell.Utility -ms.date: 07/24/2024 +ms.date: 04/29/2025 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/test-json?view=powershell-7.5&WT.mc_id=ps-gethelp schema: 2.0.0 title: Test-Json @@ -142,20 +142,16 @@ $schema = @' } } '@ -'{"name": "Ashley", "age": "25"}' | Test-Json -Schema $schema +'{"name": "Ashley", "age": "25"}' | Test-Json -Schema $schema -ErrorAction SilentlyContinue ``` ```Output -Test-Json: -Line | - 35 | '{"name": "Ashley", "age": "25"}' | Test-Json -Schema $schema - | ~~~~~~~~~~~~~~~~~~~~~~~~~ - | The JSON is not valid with the schema: Value is "string" but should be "integer" at '/age' False ``` -In this example, we get an error because the schema expects an integer for **age** but the JSON -input we tested uses a string value instead. +In this example, we use the **ErrorAction** parameter to suppres the error message. Without this +parameter the command also outputs an error because the schema expects an integer for **age** but +the JSON input we tested uses a string value instead. For more information, see [JSON Schema](https://json-schema.org/). diff --git a/reference/7.6/Microsoft.PowerShell.Core/About/about_Break.md b/reference/7.6/Microsoft.PowerShell.Core/About/about_Break.md index c23c711a2e5a..2e97e507856e 100644 --- a/reference/7.6/Microsoft.PowerShell.Core/About/about_Break.md +++ b/reference/7.6/Microsoft.PowerShell.Core/About/about_Break.md @@ -1,7 +1,7 @@ --- description: Describes a statement you can use to immediately exit `foreach`, `for`, `while`, `do`, `switch`, or `trap` statements. Locale: en-US -ms.date: 12/26/2024 +ms.date: 04/29/2025 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_break?view=powershell-7.6&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_Break @@ -79,7 +79,7 @@ example has a `while` statement with a `for` statement: ```powershell :myLabel while () { - for ($item in $items) { + foreach ($item in $items) { if () { break myLabel } @@ -132,7 +132,7 @@ specific condition: ```powershell $var = "word2" -switch -regex ($var) { +switch -Regex ($var) { "word2" { Write-Host "Exact" $_ break diff --git a/reference/7.6/Microsoft.PowerShell.Core/Clear-Host.md b/reference/7.6/Microsoft.PowerShell.Core/Clear-Host.md index fa655af0113a..c35b630422be 100644 --- a/reference/7.6/Microsoft.PowerShell.Core/Clear-Host.md +++ b/reference/7.6/Microsoft.PowerShell.Core/Clear-Host.md @@ -2,7 +2,7 @@ external help file: System.Management.Automation.dll-Help.xml Locale: en-US Module Name: Microsoft.PowerShell.Core -ms.date: 08/29/2023 +ms.date: 04/29/2025 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/clear-host?view=powershell-7.6&WT.mc_id=ps-gethelp schema: 2.0.0 title: Clear-Host @@ -38,7 +38,7 @@ might work differently in different host programs. ### Example 1 ```powershell -PS> Get-Process +PS> Get-Process | Select-Object -First 5 Handles NPM(K) PM(K) WS(K) VM(M) CPU(s) Id ProcessName ------- ------ ----- ----- ----- ------ -- ----------- @@ -47,29 +47,9 @@ Handles NPM(K) PM(K) WS(K) VM(M) CPU(s) Id ProcessName 646 12 2332 4896 49 1.12 388 csrss 189 11 2860 7084 114 0.66 2896 csrss 78 11 1876 4008 42 0.22 4000 csrss - 76 7 1848 5064 54 0.08 1028 dwm - 610 41 23952 44048 208 4.40 2080 explorer - 0 0 0 24 0 0 Idle - 182 32 7692 15980 91 0.23 3056 LogonUI - 186 25 7832 16068 91 0.27 3996 LogonUI - 1272 32 11512 20432 58 25.07 548 lsass - 267 10 3536 6736 34 0.80 556 lsm - 137 17 3520 7472 61 0.05 1220 msdtc - 447 31 70316 84476 201 1,429.67 836 MsMpEng - 265 18 7136 15628 134 2.20 3544 msseces - 248 16 6476 4076 76 0.22 1592 NisSrv - 368 25 61312 65508 614 1.78 848 powershell - 101 8 2304 6624 70 0.64 3648 rdpclip - 258 15 6804 12156 50 2.65 536 services -... - -PS> cls - - -PS> -``` -This command uses the `cls` alias of `Clear-Host` to clear the current display. +PS> Clear-Host +``` ## INPUTS diff --git a/reference/7.6/Microsoft.PowerShell.Utility/Test-Json.md b/reference/7.6/Microsoft.PowerShell.Utility/Test-Json.md index 47499b1a12af..2e5e9dc6a4b4 100644 --- a/reference/7.6/Microsoft.PowerShell.Utility/Test-Json.md +++ b/reference/7.6/Microsoft.PowerShell.Utility/Test-Json.md @@ -2,7 +2,7 @@ external help file: Microsoft.PowerShell.Commands.Utility.dll-Help.xml Locale: en-US Module Name: Microsoft.PowerShell.Utility -ms.date: 07/24/2024 +ms.date: 04/29/2025 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/test-json?view=powershell-7.6&WT.mc_id=ps-gethelp schema: 2.0.0 title: Test-Json @@ -142,20 +142,16 @@ $schema = @' } } '@ -'{"name": "Ashley", "age": "25"}' | Test-Json -Schema $schema +'{"name": "Ashley", "age": "25"}' | Test-Json -Schema $schema -ErrorAction SilentlyContinue ``` ```Output -Test-Json: -Line | - 35 | '{"name": "Ashley", "age": "25"}' | Test-Json -Schema $schema - | ~~~~~~~~~~~~~~~~~~~~~~~~~ - | The JSON is not valid with the schema: Value is "string" but should be "integer" at '/age' False ``` -In this example, we get an error because the schema expects an integer for **age** but the JSON -input we tested uses a string value instead. +In this example, we use the **ErrorAction** parameter to suppres the error message. Without this +parameter the command also outputs an error because the schema expects an integer for **age** but +the JSON input we tested uses a string value instead. For more information, see [JSON Schema](https://json-schema.org/). diff --git a/reference/docs-conceptual/community/contributing/general-markdown.md b/reference/docs-conceptual/community/contributing/general-markdown.md index e0785cace3e1..5466de8f9225 100644 --- a/reference/docs-conceptual/community/contributing/general-markdown.md +++ b/reference/docs-conceptual/community/contributing/general-markdown.md @@ -1,6 +1,6 @@ --- description: This article provides specific guidance for using Markdown in our documentation. -ms.date: 03/30/2025 +ms.date: 04/29/2025 title: Markdown best practices --- # Markdown best practices @@ -8,10 +8,10 @@ title: Markdown best practices This article provides specific guidance for using Markdown in our documentation. It isn't a tutorial for Markdown. If you need a tutorial for Markdown, see this [Markdown cheatsheet][12]. -The Microsoft Open Publishing System (OPS) that builds our documentation uses [markdig][06] to -process the Markdown documents. Markdig parses the documents based on the rules of the latest -[CommonMark][10] specification. OPS follows the CommonMark specification and adds some extensions -for platform-specific features, such as tables and alerts. +The build pipeline that builds our documentation uses [markdig][06] to process the Markdown +documents. Markdig parses the documents based on the rules of the latest [CommonMark][10] +specification. OPS follows the CommonMark specification and adds some extensions for +platform-specific features, such as tables and alerts. The CommonMark specification is stricter about the construction of some Markdown elements. Pay close attention to the details provided in this document. diff --git a/reference/docs-conceptual/install/Installing-PowerShell-on-macOS.md b/reference/docs-conceptual/install/Installing-PowerShell-on-macOS.md index 695cff6ce7b6..a63ac3aae790 100644 --- a/reference/docs-conceptual/install/Installing-PowerShell-on-macOS.md +++ b/reference/docs-conceptual/install/Installing-PowerShell-on-macOS.md @@ -1,6 +1,6 @@ --- description: Information about installing PowerShell on macOS -ms.date: 04/28/2025 +ms.date: 04/29/2025 title: Installing PowerShell on macOS --- @@ -37,7 +37,7 @@ Once `brew` is installed you can install PowerShell. The following command installs the latest stable release of PowerShell: ```sh -brew install powershell/tap/powershell +brew install --cask powershell ``` Finally, verify that your install is working properly: diff --git a/reference/includes/ubuntu-support.md b/reference/includes/ubuntu-support.md index 224bb949bb34..99c483df52e3 100644 --- a/reference/includes/ubuntu-support.md +++ b/reference/includes/ubuntu-support.md @@ -1,7 +1,7 @@ --- author: sdwheeler ms.author: sewhee -ms.date: 11/02/2024 +ms.date: 04/29/2025 ms.topic: include --- @@ -15,7 +15,7 @@ from the [Microsoft Artifact Registry][mcr] for the following versions of Ubuntu - Ubuntu 24.04 (Noble Numbat) - OS support ends on 2029-04-01 - Ubuntu 22.04 (Jammy Jellyfish) - OS support ends on 2027-04-01 -- Ubuntu 20.04 (Focal Fossa) - OS support ends on 2025-04-02 +- Ubuntu 20.04 (Focal Fossa) - OS support ends on 2025-05-31 Ubuntu 24.10 (Oracular Oriole) is an interim release. Microsoft doesn't support [interim releases][interim] of Ubuntu. For more information, see