Skip to content

Update help files for {Get-Installed, Install, Publish, Save, and Uninstall}-PSResource #435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 3, 2021
Merged

Update help files for {Get-Installed, Install, Publish, Save, and Uninstall}-PSResource #435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 17 additions & 7 deletions help/Get-InstalledPSResource.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Get-InstalledPSResource [[-Name] <String[]>] [-Version <String>] [-Path <String>
```

## DESCRIPTION
The Get-InstalledPSResource cmdlet combines the Get-InstalledModule, Get-InstalledScript cmdlets from V2. It performs a search within module or script installation paths based on the -Name parameter argument. It returns PSResourceInfo objects which describe each resource item found. Other parameters allow the returned results to be filtered by version and path.
The Get-InstalledPSResource cmdlet combines the Get-InstalledModule, Get-InstalledScript cmdlets from V2. It performs a search within module or script installation paths based on the -Name parameter argument. It returns PSResourceInfo objects which describes each resource item found. Other parameters allow the returned results to be filtered by version and path.

## EXAMPLES

Expand Down Expand Up @@ -49,14 +49,21 @@ PS C:\> Get-InstalledPSResource Az -Path .

This will return all versions of the Az module that have been installed in the current directory.

### Example 5
```powershell
PS C:\> Get-InstalledPSResource
```

This will return all versions and scripts installed on the machine.

## PARAMETERS

### -Name
Name of a resource or resources to find. Accepts wild card characters.
Name of a resource or resources to find. Accepts wild card characters or a null value.

```yaml
Type: System.String[]
Parameter Sets: (All)
Parameter Sets: NameParameterSet
Aliases:

Required: False
Expand All @@ -71,7 +78,7 @@ Specifies the path to search in.

```yaml
Type: System.String
Parameter Sets: (All)
Parameter Sets: NameParameterSet
Aliases:

Required: False
Expand All @@ -82,11 +89,13 @@ Accept wildcard characters: False
```

### -Version
Specifies the version of the resource to be returned. Can be an exact version or a version range.
Specifies the version of the resource to be returned.
Can be an exact version or a version range, using the NuGet versioning syntax.
Expected version/version range format is documented here: https://docs.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges

```yaml
Type: System.String
Parameter Sets: (All)
Parameter Sets: NameParameterSet
Aliases:

Required: False
Expand All @@ -103,7 +112,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### Microsoft.PowerShell.PowerShellGet.UtilClasses.PSResourceInfo
```
PSRepositoryItemInfo : {
PSResourceInfo : {
AdditionalMetadata
Author
CompanyName
Expand All @@ -119,6 +128,7 @@ PSRepositoryItemInfo : {
Name
PackageManagementProvider
PowerShellGetFormatVersion
PrereleaseLabel
ProjectUri
PublishedDate
ReleaseNotes
Expand Down
Loading