From 7a2fd8d289116a27a2bf612cad1339c0055fa6ad Mon Sep 17 00:00:00 2001 From: Sydney Smith <43417619+SydneyhSmith@users.noreply.github.com> Date: Wed, 18 May 2022 13:27:11 -0700 Subject: [PATCH 01/22] Update Uninstall-PSResource.md --- help/Uninstall-PSResource.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/help/Uninstall-PSResource.md b/help/Uninstall-PSResource.md index 45cb44a4a..ce325c973 100644 --- a/help/Uninstall-PSResource.md +++ b/help/Uninstall-PSResource.md @@ -98,6 +98,21 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -Scope +Specifies the scope of the resource to uninstall. + +```yaml +Type: Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType +Parameter Sets: (All) +Aliases: +Accepted values: CurrentUser, AllUsers + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False + ### -SkipDependencyCheck Skips check to see if other resources are dependent on the resource being uninstalled. From 6d77c359b3fd8f7c1f7831d838487c3a6f256c87 Mon Sep 17 00:00:00 2001 From: Sydney Smith <43417619+SydneyhSmith@users.noreply.github.com> Date: Wed, 18 May 2022 13:27:43 -0700 Subject: [PATCH 02/22] Update Get-PSResource.md --- help/Get-PSResource.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/help/Get-PSResource.md b/help/Get-PSResource.md index a04868f42..3a2575eb3 100644 --- a/help/Get-PSResource.md +++ b/help/Get-PSResource.md @@ -131,6 +131,20 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Scope +Specifies the scope of the resource. + +```yaml +Type: Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType +Parameter Sets: (All) +Aliases: +Accepted values: CurrentUser, AllUsers + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: Falsef ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). From 4f0121d715ee4c446eb3763bf99668bb93e8259f Mon Sep 17 00:00:00 2001 From: Sydney Smith <43417619+SydneyhSmith@users.noreply.github.com> Date: Wed, 18 May 2022 13:28:19 -0700 Subject: [PATCH 03/22] Update Get-PSResource.md --- help/Get-PSResource.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/help/Get-PSResource.md b/help/Get-PSResource.md index 3a2575eb3..cc79f9213 100644 --- a/help/Get-PSResource.md +++ b/help/Get-PSResource.md @@ -13,7 +13,7 @@ Returns resources (modules and scripts) installed on the machine via PowerShellG ## SYNTAX ``` -Get-PSResource [[-Name] ] [-Version ] [-Path ] [] +Get-PSResource [[-Name] ] [-Version ] [-Path ] [-Scope ] [] ``` ## DESCRIPTION From 4fdc3241cf11ddfe2c69fb36f32765e292e7c3b3 Mon Sep 17 00:00:00 2001 From: Sydney Smith <43417619+SydneyhSmith@users.noreply.github.com> Date: Wed, 18 May 2022 13:28:46 -0700 Subject: [PATCH 04/22] Update Uninstall-PSResource.md --- help/Uninstall-PSResource.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/help/Uninstall-PSResource.md b/help/Uninstall-PSResource.md index ce325c973..a833341b3 100644 --- a/help/Uninstall-PSResource.md +++ b/help/Uninstall-PSResource.md @@ -14,7 +14,7 @@ Uninstalls a resource (module or script) that has been installed on the machine ### NameParameterSet ``` -Uninstall-PSResource [-Name] [-Version ] [-SkipDependencyCheck] [-WhatIf] [] +Uninstall-PSResource [-Name] [-Version ] [-Scope ] [-SkipDependencyCheck] [-WhatIf] [] ``` ### InputObjectParameterSet From 137780cc1084d8544502a8c696fb903a124c32e7 Mon Sep 17 00:00:00 2001 From: Sydney Smith <43417619+SydneyhSmith@users.noreply.github.com> Date: Wed, 18 May 2022 13:57:30 -0700 Subject: [PATCH 05/22] Update Update-PSResource.md --- help/Update-PSResource.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/help/Update-PSResource.md b/help/Update-PSResource.md index 167a60673..62d2e6a78 100644 --- a/help/Update-PSResource.md +++ b/help/Update-PSResource.md @@ -15,7 +15,7 @@ Updates a package already installed on the user's machine. ### NameParameterSet (Default) ``` Update-PSResource [-Name] [-Version ] [-Prerelease] [-Repository ] - [-Scope ] [-TrustRepository] [-Credential ] [-Quiet] [-AcceptLicense] [-Force] [-PassThru] [-SkipDependencyCheck] [-WhatIf] [-Confirm] [] + [-Scope ] [-TrustRepository] [-Credential ] [-Quiet] [-AcceptLicense] [-Force] [-PassThru] [-AuthenticodeCheck] [-SkipDependencyCheck] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -221,6 +221,19 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -AuthenticodeCheck +Does a check to to validate signed files and catalog files on Windows. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False ### -SkipdependencyCheck Skips the check for resource dependencies, so that only found resources are updated, and not any resources the found resource depends on. From 90d295ef887ead8ca3a6dc3501c3cb297f18c0b1 Mon Sep 17 00:00:00 2001 From: Sydney Smith <43417619+SydneyhSmith@users.noreply.github.com> Date: Wed, 18 May 2022 13:58:54 -0700 Subject: [PATCH 06/22] Update Save-PSResource.md --- help/Save-PSResource.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/help/Save-PSResource.md b/help/Save-PSResource.md index 8e9f667af..4071ae0ea 100644 --- a/help/Save-PSResource.md +++ b/help/Save-PSResource.md @@ -15,7 +15,7 @@ Saves resources (modules and scripts) from a registered repository onto the mach ### NameParameterSet ``` Save-PSResource [-Name] [-Version ] [-Prerelease] [-Repository ] - [-Credential ] [-AsNupkg] [-IncludeXML] [-Path ] [-TrustRepository] [-SkipDependencyCheck] [-PassThru] [-Quiet] [-WhatIf] [-Confirm] [] + [-Credential ] [-AsNupkg] [-IncludeXML] [-Path ] [-TrustRepository] [-SkipDependencyCheck] [-AuthenticodeCheck] [-PassThru] [-Quiet] [-WhatIf] [-Confirm] [] ``` ### InputObjectParameterSet @@ -199,6 +199,19 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + ### -AuthenticodeCheck +Does a check to to validate signed files and catalog files on Windows. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False ### -PassThru Passes the resource saved to the console. From 41248803bba9e2c3b8e405dee8aa560d3b73f0af Mon Sep 17 00:00:00 2001 From: Sydney Smith <43417619+SydneyhSmith@users.noreply.github.com> Date: Wed, 18 May 2022 13:59:07 -0700 Subject: [PATCH 07/22] Update Install-PSResource.md --- help/Install-PSResource.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/help/Install-PSResource.md b/help/Install-PSResource.md index 8272e9fbc..f7321bf41 100644 --- a/help/Install-PSResource.md +++ b/help/Install-PSResource.md @@ -16,13 +16,13 @@ Installs resources (modules and scripts) from a registered repository onto the m ``` Install-PSResource [-Name] [-Version ] [-Prerelease] [-Repository ] [-Credential ] [-Scope ] [-TrustRepository] - [-Reinstall] [-Quiet] [-AcceptLicense] [-NoClobber] [-SkipDependencyCheck] [-PassThru] [-WhatIf] [-Confirm] [] + [-Reinstall] [-Quiet] [-AcceptLicense] [-NoClobber] [-SkipDependencyCheck] [-AuthenticodeCheck] [-PassThru] [-WhatIf] [-Confirm] [] ``` ### InputObjectParameterSet ``` Install-PSResource [-InputObject ] [-Credential ] [-Scope ] [-TrustRepository] - [-Reinstall] [-Quiet] [-AcceptLicense] [-NoClobber] [-SkipDependencyCheck] [-WhatIf] [-Confirm] [] + [-Reinstall] [-Quiet] [-AcceptLicense] [-NoClobber] [-SkipDependencyCheck] [-AuthenticodeCheck] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -252,6 +252,19 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -AuthenticodeCheck +Does a check to to validate signed files and catalog files on Windows. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False ### -PassThru Passes the resource installed to the console. @@ -322,4 +335,4 @@ None ## NOTES -## RELATED LINKS \ No newline at end of file +## RELATED LINKS From ee056c2fd502c852a277ad7af4159f504b4e2596 Mon Sep 17 00:00:00 2001 From: Sydney Smith <43417619+SydneyhSmith@users.noreply.github.com> Date: Wed, 18 May 2022 14:21:22 -0700 Subject: [PATCH 08/22] Update Set-PSResourceRepository.md --- help/Set-PSResourceRepository.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/help/Set-PSResourceRepository.md b/help/Set-PSResourceRepository.md index 90eba5cb6..042a56113 100644 --- a/help/Set-PSResourceRepository.md +++ b/help/Set-PSResourceRepository.md @@ -14,7 +14,7 @@ Sets information for a registered repository. ### NameParameterSet (Default) ``` -Set-PSResourceRepository [-Name] [-Uri ] [-Trusted] [-Priority ] [-WhatIf] [-Confirm] [] +Set-PSResourceRepository [-Name] [-Uri ][CredentialInfo ] [-Trusted] [-Priority ] [-WhatIf] [-Confirm] [] ``` ### RepositoriesParameterSet @@ -129,6 +129,24 @@ Type: String Parameter Sets: NameParameterSet Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -CredentialInfo +Specifies where a credential is stored to access the PSResourceRepository for Find/Install/Update commands. +Takes a PSCredentialInfo Objects which takes in a vault name and secret name. +This parameter utilizes the Microsoft.PowerShell.SecretManagement module for interfacing with the stored credential. + +`New-Object Microsoft.PowerShell.PowerShellGet.UtilClasses.PSCredentialInfo ("VaultName", "SecretName")` + +```yaml +Type: PSCredentialInfo +Parameter Sets: NameParameterSet +Aliases: + Required: False Position: Named Default value: None From 2d620ddfc92281710c6295cad91b3aca64018775 Mon Sep 17 00:00:00 2001 From: Sydney Smith <43417619+SydneyhSmith@users.noreply.github.com> Date: Wed, 18 May 2022 14:21:36 -0700 Subject: [PATCH 09/22] Update Register-PSResourceRepository.md --- help/Register-PSResourceRepository.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/help/Register-PSResourceRepository.md b/help/Register-PSResourceRepository.md index 9b5cc7855..183f58259 100644 --- a/help/Register-PSResourceRepository.md +++ b/help/Register-PSResourceRepository.md @@ -14,7 +14,7 @@ Registers a repository for PowerShell resources. ### NameParameterSet (Default) ``` -Register-PSResourceRepository [-Name] [-Uri] [-Trusted] [-Priority ] [-PassThru] +Register-PSResourceRepository [-Name ] [-Uri ] [CredentialInfo ] [-Trusted] [-Priority ] [-PassThru] [-WhatIf] [-Confirm] [] ``` @@ -164,6 +164,24 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -CredentialInfo +Specifies where a credential is stored to access the PSResourceRepository for Find/Install/Update commands. +Takes a PSCredentialInfo Objects which takes in a vault name and secret name. +This parameter utilizes the Microsoft.PowerShell.SecretManagement module for interfacing with the stored credential. + +`New-Object Microsoft.PowerShell.PowerShellGet.UtilClasses.PSCredentialInfo ("VaultName", "SecretName")` + +```yaml +Type: PSCredentialInfo +Parameter Sets: NameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` ### -Confirm Prompts you for confirmation before running the cmdlet. From 0dca492844f186de2c3838a0a61ba1b2916c07e7 Mon Sep 17 00:00:00 2001 From: Sydney Smith <43417619+SydneyhSmith@users.noreply.github.com> Date: Fri, 20 May 2022 09:13:03 -0700 Subject: [PATCH 10/22] Update Install-PSResource.md --- help/Install-PSResource.md | 61 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) diff --git a/help/Install-PSResource.md b/help/Install-PSResource.md index f7321bf41..8c4f9b1d2 100644 --- a/help/Install-PSResource.md +++ b/help/Install-PSResource.md @@ -24,6 +24,12 @@ Install-PSResource [-Name] [-Version ] [-Prerelease] Install-PSResource [-InputObject ] [-Credential ] [-Scope ] [-TrustRepository] [-Reinstall] [-Quiet] [-AcceptLicense] [-NoClobber] [-SkipDependencyCheck] [-AuthenticodeCheck] [-WhatIf] [-Confirm] [] ``` + +### RequiredResourceFileParameterSet +``` +Install-PSResource [-RequiredResourceFile ] [-Credential ] [-Scope ] [-TrustRepository] + [-Reinstall] [-Quiet] [-AcceptLicense] [-NoClobber] [-SkipDependencyCheck] [-AuthenticodeCheck] [-PassThru] [-WhatIf] [-Confirm] [] +``` ## DESCRIPTION The Install-PSResource cmdlet combines the Install-Module and Install-Script cmdlets from V2. @@ -59,6 +65,13 @@ PS C:\> Install-PSResource Az -Reinstall ``` Installs the Az module and will write over any previously installed version if it is already installed. + +### Example 4 +```powershell +PS C:\> Install-PSResource -RequiredResourceFile myRequiredModules.psd1 +``` + +Installs the PSResources specified in the psd1 file. ## PARAMETERS @@ -131,6 +144,54 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -RequiredResourceFile +Path to a psd1 or json which specifies resources to install. Does not accept wildcard characters or a null value. + +The psd1 will take a hashtable format with the module attributes like the following example +```Powershell + @{ + TestModule = @{ + version = "[0.0.1,1.3.0]" + repository = "PSGallery" + } + + TestModulePrerelease = @{ + version = "[0.0.0,0.0.5]" + repository = "PSGallery" + prerelease = "true" + } + + TestModule99 = @{} +} +``` +json files will take the following example format +```json +{ + "TestModule": { + "version": "[0.0.1,1.3.0)", + "repository": "PSGallery" + }, + "TestModulePrerelease": { + "version": "[0.0.0,0.0.5]", + "repository": "PSGallery", + "prerelease": "true" + }, + "TestModule99": {} +} +``` + +```yaml +Type: System.String[] +Parameter Sets: RequiredResourceFileParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -Credential Optional credentials to be used when accessing a repository. From aa2b561beb0216dc21e8ec5c49f53c6ca2ae45d5 Mon Sep 17 00:00:00 2001 From: Sydney Smith <43417619+SydneyhSmith@users.noreply.github.com> Date: Mon, 23 May 2022 08:26:24 -0700 Subject: [PATCH 11/22] Update Install-PSResource.md --- help/Install-PSResource.md | 74 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) diff --git a/help/Install-PSResource.md b/help/Install-PSResource.md index 8c4f9b1d2..5d600ff04 100644 --- a/help/Install-PSResource.md +++ b/help/Install-PSResource.md @@ -25,6 +25,12 @@ Install-PSResource [-InputObject ] [-Credential ] [-Reinstall] [-Quiet] [-AcceptLicense] [-NoClobber] [-SkipDependencyCheck] [-AuthenticodeCheck] [-WhatIf] [-Confirm] [] ``` +### RequiredResourceParameterSet +``` +Install-PSResource [-RequiredResource ] [-Credential ] [-Scope ] [-TrustRepository] + [-Reinstall] [-Quiet] [-AcceptLicense] [-NoClobber] [-SkipDependencyCheck] [-AuthenticodeCheck] [-PassThru] [-WhatIf] [-Confirm] [] +``` + ### RequiredResourceFileParameterSet ``` Install-PSResource [-RequiredResourceFile ] [-Credential ] [-Scope ] [-TrustRepository] @@ -72,6 +78,26 @@ PS C:\> Install-PSResource -RequiredResourceFile myRequiredModules.psd1 ``` Installs the PSResources specified in the psd1 file. + + ### Example 5 +```powershell +PS C:\> Install-PSResource -RequiredResource @{ + TestModule = @{ + version = "[0.0.1,1.3.0]" + repository = "PSGallery" + } + + TestModulePrerelease = @{ + version = "[0.0.0,0.0.5]" + repository = "PSGallery" + prerelease = "true" + } + + TestModule99 = @{} +} +``` + +Installs the PSResources specified in the hashtable. ## PARAMETERS @@ -144,6 +170,54 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -RequiredResource +A hashtable or json string which specifies resources to install. Does not accept wildcard characters or a null value. + +The hashtable will take a format with the module attributes like the following example +```Powershell + @{ + TestModule = @{ + version = "[0.0.1,1.3.0]" + repository = "PSGallery" + } + + TestModulePrerelease = @{ + version = "[0.0.0,0.0.5]" + repository = "PSGallery" + prerelease = "true" + } + + TestModule99 = @{} +} +``` +A json string will take the following example format +```json +{ + "TestModule": { + "version": "[0.0.1,1.3.0)", + "repository": "PSGallery" + }, + "TestModulePrerelease": { + "version": "[0.0.0,0.0.5]", + "repository": "PSGallery", + "prerelease": "true" + }, + "TestModule99": {} +} +``` + +```yaml +Type: RequiredResource +Parameter Sets: RequiredResource +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -RequiredResourceFile Path to a psd1 or json which specifies resources to install. Does not accept wildcard characters or a null value. From d0d8db1f2988719a2e4fb18cf1c2438bae0397fc Mon Sep 17 00:00:00 2001 From: Sydney Smith <43417619+SydneyhSmith@users.noreply.github.com> Date: Mon, 23 May 2022 08:26:53 -0700 Subject: [PATCH 12/22] Update Install-PSResource.md --- help/Install-PSResource.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/help/Install-PSResource.md b/help/Install-PSResource.md index 5d600ff04..0b4274322 100644 --- a/help/Install-PSResource.md +++ b/help/Install-PSResource.md @@ -14,7 +14,7 @@ Installs resources (modules and scripts) from a registered repository onto the m ### NameParameterSet ``` -Install-PSResource [-Name] [-Version ] [-Prerelease] +Install-PSResource [-Name ] [-Version ] [-Prerelease] [-Repository ] [-Credential ] [-Scope ] [-TrustRepository] [-Reinstall] [-Quiet] [-AcceptLicense] [-NoClobber] [-SkipDependencyCheck] [-AuthenticodeCheck] [-PassThru] [-WhatIf] [-Confirm] [] ``` From ec871296662569b8d399d57f8228457500006a4a Mon Sep 17 00:00:00 2001 From: Sydney Smith <43417619+SydneyhSmith@users.noreply.github.com> Date: Mon, 23 May 2022 08:30:00 -0700 Subject: [PATCH 13/22] Update Find-PSResource.md --- help/Find-PSResource.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/help/Find-PSResource.md b/help/Find-PSResource.md index e2a9d3371..6e9b7d5b4 100644 --- a/help/Find-PSResource.md +++ b/help/Find-PSResource.md @@ -118,6 +118,13 @@ PS C:\> Find-PSResource -DscResourceName "SystemLocale" -Repository PSGallery This examples searches for all module resources with `-DscResourceName` "SystemLocale" from the `-Repository` PSGallery. It returns all the module resources which include a DSC resource named "SystemLocale" and also lists the following information for each module resource: version, name (displayed under ModuleName) and repository. To access the rest of the properties of the parent module resource, you can access the `$_.ParentResource` of the PSIncludedResourceInfo object returned from the DSCResourceName parameter set. +### Example 7 +```powershell +PS C:\> Find-PSResource -Name * +``` + +This will search all PSResources from registered PSResourceRepositories. + ## PARAMETERS ### -Credential From c17b29f3ebcc6f417a5e102dfba713b23fdbd42a Mon Sep 17 00:00:00 2001 From: Sydney Smith <43417619+SydneyhSmith@users.noreply.github.com> Date: Mon, 23 May 2022 08:42:34 -0700 Subject: [PATCH 14/22] Update Find-PSResource.md --- help/Find-PSResource.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/help/Find-PSResource.md b/help/Find-PSResource.md index 6e9b7d5b4..02342a805 100644 --- a/help/Find-PSResource.md +++ b/help/Find-PSResource.md @@ -275,7 +275,7 @@ Required: False Position: Named Default value: None Accept pipeline input: False -Accept wildcard characters: False +Accept wildcard characters: True ``` ### -Confirm From a09ac5fc036471a0c93853c65413f8cc415fae31 Mon Sep 17 00:00:00 2001 From: Sydney Smith <43417619+SydneyhSmith@users.noreply.github.com> Date: Mon, 23 May 2022 10:38:13 -0700 Subject: [PATCH 15/22] Update PowerShellGet.dll-Help.xml --- help/en-US/PowerShellGet.dll-Help.xml | 4112 ++++++++++++------------- 1 file changed, 1957 insertions(+), 2155 deletions(-) diff --git a/help/en-US/PowerShellGet.dll-Help.xml b/help/en-US/PowerShellGet.dll-Help.xml index 5e215e596..6258499a0 100644 --- a/help/en-US/PowerShellGet.dll-Help.xml +++ b/help/en-US/PowerShellGet.dll-Help.xml @@ -1,4 +1,4 @@ - + @@ -6,20 +6,20 @@ Find PSResource - {{ Fill in the Synopsis }} + Searches for packages from a repository (local or remote), based on `-Name` and other package properties. - {{ Fill in the Description }} + The `Find-PSResource` cmdlet searches for a package from a repository (local or remote) based on `-Name` or other package properties. Find-PSResource - + Name - - {{ Fill Name Description }} - + + Name of a resource or resources to find. Accepts wild card character '*'. + System.String[] System.String[] @@ -27,11 +27,11 @@ None - + Credential - - {{ Fill Credential Description }} - + + Optional credentials to be used when accessing a repository. + System.Management.Automation.PSCredential System.Management.Automation.PSCredential @@ -39,22 +39,22 @@ None - + IncludeDependencies - - {{ Fill IncludeDependencies Description }} - + + When specified, search will return all matched resources along with any resources the matched resources depends on. Dependencies are deduplicated. + System.Management.Automation.SwitchParameter False - + ModuleName - - {{ Fill ModuleName Description }} - + + Specifies a module resource package name type to search for. Wildcards are supported. Not yet implemented. + System.String System.String @@ -64,20 +64,20 @@ Prerelease - - {{ Fill Prerelease Description }} - + + When specified, includes prerelease versions in search results returned. + System.Management.Automation.SwitchParameter False - + Repository - - {{ Fill Repository Description }} - + + Specifies one or more repository names to search, which can include wildcard. If not specified, search will include all currently registered repositories, in order of highest priority, until a repository is found that contains the package. + System.String[] System.String[] @@ -85,11 +85,11 @@ None - - Tags - - {{ Fill Tags Description }} - + + Tag + + Filters search results for resources that include one or more of the specified tags. + System.String[] System.String[] @@ -97,30 +97,30 @@ None - + Type - - {{ Fill Type Description }} - + + Specifies one or more resource types to find. Resource types supported are: Module, Script, Command, DscResource. + Module Script DscResource - RoleCapability Command - System.String[] + Microsoft.PowerShell.PowerShellGet.UtilClasses.ResourceType[] - System.String[] + Microsoft.PowerShell.PowerShellGet.UtilClasses.ResourceType[] None - + Version - - {{ Fill Version Description }} - + + Specifies the version of the resource to be returned. The value can be an exact version or a version range using the NuGet versioning syntax. + For more information about NuGet version ranges, see Package versioning (/nuget/concepts/package-versioning#version-ranges)PowerShellGet supports all but the minimum inclusive version listed in the NuGet version range documentation. So inputting "1.0.0.0" as the version doesn't yield versions 1.0.0.0 and higher (minimum inclusive range). Instead, the values is considered as the required version and yields version 1.0.0.0 only (required version). To use the minimum inclusive range, provide `[1.0.0.0, ]` as the version range. + System.String System.String @@ -130,9 +130,9 @@ Confirm - + Prompts you for confirmation before running the cmdlet. - + System.Management.Automation.SwitchParameter @@ -141,9 +141,9 @@ WhatIf - + Shows what would happen if the cmdlet runs. The cmdlet is not run. - + System.Management.Automation.SwitchParameter @@ -153,11 +153,11 @@ - + Credential - - {{ Fill Credential Description }} - + + Optional credentials to be used when accessing a repository. + System.Management.Automation.PSCredential System.Management.Automation.PSCredential @@ -165,11 +165,11 @@ None - + IncludeDependencies - - {{ Fill IncludeDependencies Description }} - + + When specified, search will return all matched resources along with any resources the matched resources depends on. Dependencies are deduplicated. + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -177,11 +177,11 @@ False - + ModuleName - - {{ Fill ModuleName Description }} - + + Specifies a module resource package name type to search for. Wildcards are supported. Not yet implemented. + System.String System.String @@ -189,11 +189,11 @@ None - + Name - - {{ Fill Name Description }} - + + Name of a resource or resources to find. Accepts wild card character '*'. + System.String[] System.String[] @@ -203,9 +203,9 @@ Prerelease - - {{ Fill Prerelease Description }} - + + When specified, includes prerelease versions in search results returned. + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -213,11 +213,11 @@ False - + Repository - - {{ Fill Repository Description }} - + + Specifies one or more repository names to search, which can include wildcard. If not specified, search will include all currently registered repositories, in order of highest priority, until a repository is found that contains the package. + System.String[] System.String[] @@ -225,11 +225,11 @@ None - - Tags - - {{ Fill Tags Description }} - + + Tag + + Filters search results for resources that include one or more of the specified tags. + System.String[] System.String[] @@ -237,23 +237,24 @@ None - + Type - - {{ Fill Type Description }} - - System.String[] + + Specifies one or more resource types to find. Resource types supported are: Module, Script, Command, DscResource. + + Microsoft.PowerShell.PowerShellGet.UtilClasses.ResourceType[] - System.String[] + Microsoft.PowerShell.PowerShellGet.UtilClasses.ResourceType[] None - + Version - - {{ Fill Version Description }} - + + Specifies the version of the resource to be returned. The value can be an exact version or a version range using the NuGet versioning syntax. + For more information about NuGet version ranges, see Package versioning (/nuget/concepts/package-versioning#version-ranges)PowerShellGet supports all but the minimum inclusive version listed in the NuGet version range documentation. So inputting "1.0.0.0" as the version doesn't yield versions 1.0.0.0 and higher (minimum inclusive range). Instead, the values is considered as the required version and yields version 1.0.0.0 only (required version). To use the minimum inclusive range, provide `[1.0.0.0, ]` as the version range. + System.String System.String @@ -263,9 +264,9 @@ Confirm - + Prompts you for confirmation before running the cmdlet. - + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -275,9 +276,9 @@ WhatIf - + Shows what would happen if the cmdlet runs. The cmdlet is not run. - + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -295,35 +296,11 @@ - - - System.String - - - - - - - - System.Management.Automation.PSCredential - - - - - - - - System.Management.Automation.SwitchParameter - - - - - - System.Object + Microsoft.PowerShell.PowerShellGet.UtilClasses.PSResourceInfo @@ -338,9 +315,79 @@ -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} + PS C:\> Find-PSResource -Name "Microsoft.PowerShell.SecretManagement" -Repository PSGallery + Name Version Prerelease Description + ---- ------- ---------- ----------- + Microsoft.PowerShell.SecretManagement 1.0.0.0 This module ... - {{ Add example description here }} + This examples searches for the package with `-Name` "Microsoft.PowerShell.SecretManagement". It returns the highest non-prerelease version for the package found by searching through the `-Repository` "PSGallery", which at the time of writing this example is version "1.0.0.0". + + + + -------------------------- Example 2 -------------------------- + PS C:\> Find-PSResource -Name "Microsoft.PowerShell.SecretManagement" -Repository PSGallery -Prerelease + Name Version Prerelease Description + ---- ------- ---------- ----------- + Microsoft.PowerShell.SecretManagement 1.1.0.0 preview2 This module ... + + This examples searches for the package with `-Name` "Microsoft.PowerShell.SecretManagement". It returns the highest version (including considering prerelease versions) for the package found by searching through the specified `-Repository` "PSGallery", which at the time of writing this example is version "1.1.0-preview2". + + + + -------------------------- Example 3 -------------------------- + PS C:\> Find-PSResource -Name "Microsoft.PowerShell.SecretManagement" -Version "(0.9.0.0, 1.0.0.0]" -Repository PSGallery -Prerelease + Name Version Prerelease Description + ---- ------- ---------- ----------- + Microsoft.PowerShell.SecretManagement 0.9.1.0 This module ... + Microsoft.PowerShell.SecretManagement 1.0.0.0 This module ... + + This examples searches for the package with `-Name` "Microsoft.PowerShell.SecretManagement". It returns all versions which satisfy the specified `-Version` range by looking through the specified `-Repository` "PSGallery". At the time of writing this example those satisfying versions are: "0.9.1.0" and "1.0.0.0". + + + + -------------------------- Example 4 -------------------------- + PS C:\> Find-PSResource -CommandName "Get-TargetResource" -Repository PSGallery + Name Version Prerelease ModuleName Repository + ---- ------- ---------- ---------- ---------- + Get-TargetResource 3.1.0.0 xPowerShellExecutionPolicy PSGallery + Get-TargetResource 1.0.0.4 WindowsDefender PSGallery + Get-TargetResource 1.2.0.0 SystemLocaleDsc PSGallery + Get-TargetResource 1.0.0.0 xInternetExplorerHomePage PSGallery + Get-TargetResource 4.0.1055.0 OctopusDSC PSGallery + Get-TargetResource 1.2.0.0 cRegFile PSGallery + Get-TargetResource 1.1.0.0 cWindowsErrorReporting PSGallery + Get-TargetResource 1.0.0.0 cVNIC PSGallery + Get-TargetResource 1.1.17.0 supVsts PSGallery + + This examples searches for all module resources with `-CommandName` "Get-TargetResource" from the `-Repository` PSGallery. It returns all the module resources which include a command named "Get-TargetResource" and also lists the following information for each module resource: version, name (displayed under ModuleName) and repository. To access the rest of the properties of the parent module resource, you can access the `$_.ParentResource` of the PSIncludedResourceInfo object returned from the CommandName parameter set. + + + + -------------------------- Example 5 -------------------------- + PS C:\> Find-PSResource -CommandName "Get-TargetResource" -ModuleName "SystemLocaleDsc" -Repository PSGallery + Name Version Prerelease ModuleName Repository + ---- ------- ---------- ---------- ---------- + Get-TargetResource 1.2.0.0 SystemLocaleDsc PSGallery + + This examples searches for a module resource with a command named "Get-TargetResource" (via the `-CommandName` parameter), specifically from the module resource "SystemLocaleDsc" (via the `-ModuleName` parameter) from the `-Repository` PSGallery. The "SystemLocaleDsc" resource does indeed include a command named Get-TargetResource so this resource will be returned. The returned object lists the name of the command (displayed under Name) and the following information for the parent module resource: version, name (displayed under ModuleName) and repository. To access the rest of the properties of the parent module resource, you can access the `$_.ParentResource` of the PSIncludedResourceInfo object returned from the CommandName parameter set. + + + + -------------------------- Example 6 -------------------------- + PS C:\> Find-PSResource -DscResourceName "SystemLocale" -Repository PSGallery + Name Version Prerelease ModuleName Repository + ---- ------- ---------- ---------- ---------- + Get-TargetResource 8.5.0.0 ComputerManagementDsc PSGallery + Get-TargetResource 1.2.0.0 SystemLocaleDsc PSGallery + + This examples searches for all module resources with `-DscResourceName` "SystemLocale" from the `-Repository` PSGallery. It returns all the module resources which include a DSC resource named "SystemLocale" and also lists the following information for each module resource: version, name (displayed under ModuleName) and repository. To access the rest of the properties of the parent module resource, you can access the `$_.ParentResource` of the PSIncludedResourceInfo object returned from the DSCResourceName parameter set. + + + + -------------------------- Example 7 -------------------------- + PS C:\> Find-PSResource -Name * + + This will search all PSResources from registered PSResourceRepositories. @@ -357,20 +404,20 @@ Get PSResource - {{ Fill in the Synopsis }} + Returns resources (modules and scripts) installed on the machine via PowerShellGet. - {{ Fill in the Description }} + The Get-PSResource 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. Get-PSResource - + Name - - {{ Fill Name Description }} - + + Name of a resource or resources to find. Accepts wild card characters or a null value. + System.String[] System.String[] @@ -380,9 +427,9 @@ Path - - {{ Fill Path Description }} - + + Specifies the path to search in. + System.String System.String @@ -392,9 +439,10 @@ Version - - {{ Fill Version Description }} - + + Specifies the version of the resource to be returned. The value can be an exact version or a version range using the NuGet versioning syntax. + For more information about NuGet version ranges, see Package versioning (/nuget/concepts/package-versioning#version-ranges)PowerShellGet supports all but the minimum inclusive version listed in the NuGet version range documentation. So inputting "1.0.0.0" as the version doesn't yield versions 1.0.0.0 and higher (minimum inclusive range). Instead, the values is considered as the required version and yields version 1.0.0.0 only (required version). To use the minimum inclusive range, provide `[1.0.0.0, ]` as the version range. + System.String System.String @@ -402,36 +450,30 @@ None - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - System.Management.Automation.SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - + + Scope + + Specifies the scope of the resource. + + + CurrentUser + AllUsers + + Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType - System.Management.Automation.SwitchParameter + Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType - False + None - + Name - - {{ Fill Name Description }} - + + Name of a resource or resources to find. Accepts wild card characters or a null value. + System.String[] System.String[] @@ -441,9 +483,9 @@ Path - - {{ Fill Path Description }} - + + Specifies the path to search in. + System.String System.String @@ -453,9 +495,10 @@ Version - - {{ Fill Version Description }} - + + Specifies the version of the resource to be returned. The value can be an exact version or a version range using the NuGet versioning syntax. + For more information about NuGet version ranges, see Package versioning (/nuget/concepts/package-versioning#version-ranges)PowerShellGet supports all but the minimum inclusive version listed in the NuGet version range documentation. So inputting "1.0.0.0" as the version doesn't yield versions 1.0.0.0 and higher (minimum inclusive range). Instead, the values is considered as the required version and yields version 1.0.0.0 only (required version). To use the minimum inclusive range, provide `[1.0.0.0, ]` as the version range. + System.String System.String @@ -463,51 +506,21 @@ None - - Confirm - - Prompts you for confirmation before running the cmdlet. - - System.Management.Automation.SwitchParameter - - System.Management.Automation.SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - System.Management.Automation.SwitchParameter + + Scope + + Specifies the scope of the resource. + + Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType - System.Management.Automation.SwitchParameter + Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType - False + None - - - - System.String[] - - - - - - - - - - System.Object - - - - - - + + @@ -516,18 +529,62 @@ -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} + PS C:\> Get-PSResource Az + + This will return versions (stable and prerelease) of the Az module installed via PowerShellGet. + + + + -------------------------- Example 2 -------------------------- + PS C:\> Get-PSResource Az -version "1.0.0" + + This will return version 1.0.0 of the Az module. + + + + -------------------------- Example 3 -------------------------- + PS C:\> Get-PSResource Az -version "(1.0.0, 3.0.0)" + + This will return all versions of the Az module within the specified range. + + + + -------------------------- Example 4 -------------------------- + PS C:\> Get-PSResource Az -version "4.0.1-preview" + + Assume that the package Az version 4.0.1-preview is already installed. This will return version 4.0.1-preview of the Az module. + + + + -------------------------- Example 5 -------------------------- + PS C:\> Get-PSResource Az -version "4.0.1" + + Assume that the package Az version 4.0.1-preview is already installed. This will not return Az version 4.0.1-preview as the full version (including prerelease label, i.e "4.0.1-preview") was not specified. + + + + -------------------------- Example 6 -------------------------- + PS C:\> Get-PSResource Az -Version "[4.0.1, 4.0.2-preview] + + Assume that the following versions are already installed for package Az: 4.0.1-preview and 4.0.2-preview. This will only return version 4.0.2-preview as it is the only one which falls within the specified version range. Per NuGetVersion rules, a prerelease version is less than a stable version, so 4.0.1-preview is less than the 4.0.1 specified version so 4.0.1-preview does not fall within the specified version range and won't be returned. + + + + -------------------------- Example 6 -------------------------- + PS C:\> Get-PSResource Az -Path . + + This will return all versions of the Az module that have been installed in the current directory. + + + + -------------------------- Example 7 -------------------------- + PS C:\> Get-PSResource - {{ Add example description here }} + This will return all versions and scripts installed on the machine. - - - <add> - - - + @@ -535,88 +592,42 @@ Get PSResourceRepository - {{ Fill in the Synopsis }} + Finds and returns registered repository information. - {{ Fill in the Description }} + The Get-PSResourceRepository cmdlet searches for the PowerShell resource repositories that are registered on the machine. By default it will return all registered repositories, or if the `-Name` parameter argument is specified then it will return the repository which matches that name. It returns PSRepositoryInfo objects which contain information for each repository item found. Get-PSResourceRepository - + Name - - {{ Fill Name Description }} - - System.String[] + + This parameter takes a String argument, including wildcard characters, or an array of such String arguments. It is used to search for repository names from the repository store which match the provided name pattern. Tab completion is provided on this argument and will display registered repository names. + + String[] - System.String[] + String[] None - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - System.Management.Automation.SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - System.Management.Automation.SwitchParameter - - - False - - + Name - - {{ Fill Name Description }} - - System.String[] + + This parameter takes a String argument, including wildcard characters, or an array of such String arguments. It is used to search for repository names from the repository store which match the provided name pattern. Tab completion is provided on this argument and will display registered repository names. + + String[] - System.String[] + String[] None - - Confirm - - Prompts you for confirmation before running the cmdlet. - - System.Management.Automation.SwitchParameter - - System.Management.Automation.SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - System.Management.Automation.SwitchParameter - - System.Management.Automation.SwitchParameter - - - False - @@ -631,7 +642,7 @@ - System.Object + Microsoft.PowerShell.PowerShellGet.UtilClasses.PSRepositoryInfo @@ -640,24 +651,56 @@ - + If no value for Name is provided, Get-PSResourceRepository will return information for all registered repositories. -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} + PS C:\> Get-PSResourceRepository -Name "PSGallery" + Name Uri Trusted Priority + ---- --- ------- -------- + PSGallery https://www.powershellgallery.com/api/v2 False 50 + + This example runs the command with the 'Name' parameter being set to "PSGallery". This repository is registered on this machine so the command returns information on this repository. + + + + -------------------------- Example 2 -------------------------- + PS C:\> Get-PSResourceRepository -Name "*Gallery" + Name Uri Trusted Priority + ---- --- ------- -------- + PoshTestGallery https://www.poshtestgallery.com/api/v2 True 40 + PSGallery https://www.powershellgallery.com/api/v2 False 50 + + This example runs the command with the 'Name' parameter being set to "*Gallery" which includes a wildcard. The following repositories are registered on this machine and match the name pattern, so the command returns information on these repositories. + + + + -------------------------- Example 3 -------------------------- + PS C:\> Get-PSResourceRepository -Name "PSGallery","PoshTestGallery" + Name Uri Trusted Priority + ---- --- ------- -------- + PoshTestGallery https://www.poshtestgallery.com/api/v2 True 40 + PSGallery https://www.powershellgallery.com/api/v2 False 50 + + This example runs the command with the 'Name' parameter being set to an array of Strings. Both of the specified repositories are registered on this machine and match the name pattern, so the command returns information on these repositories. + + + + -------------------------- Example 4 -------------------------- + PS C:\> Get-PSResourceRepository -Name "*" + Name Uri Trusted Priority + ---- --- ------- -------- + PoshTestGallery https://www.poshtestgallery.com/api/v2 True 40 + PSGallery https://www.powershellgallery.com/api/v2 False 50 + psgettestlocal file:///c:/code/testdir True 50 - {{ Add example description here }} + This example runs the command with the 'Name' parameter being set to a single wildcard character. So all the repositories registered on this machine are returned. - - - <add> - - - + @@ -665,20 +708,20 @@ Install PSResource - {{ Fill in the Synopsis }} + Installs resources (modules and scripts) from a registered repository onto the machine. - {{ Fill in the Description }} + The Install-PSResource cmdlet combines the Install-Module and Install-Script cmdlets from V2. It installs a resource from a registered repository to an installation path on a machine based on the -Name parameter argument. It does not return any object. Other parameters allow the resource to be specified by repository and version, and allow the user to suppress prompts or specify the scope of installation. Install-PSResource - + Name - - {{ Fill Name Description }} - + + Name of a resource or resources to install. Does not accept wildcard characters or a null value. + System.String[] System.String[] @@ -687,21 +730,46 @@ None - AcceptLicense - - {{ Fill AcceptLicense Description }} - + Version + + Specifies the version of the resource to be installed. The value can be an exact version or a version range using the NuGet versioning syntax. + For more information about NuGet version ranges, see Package versioning (/nuget/concepts/package-versioning#version-ranges)PowerShellGet supports all but the minimum inclusive version listed in the NuGet version range documentation. So inputting "1.0.0.0" as the version doesn't yield versions 1.0.0.0 and higher (minimum inclusive range). Instead, the values is considered as the required version and yields version 1.0.0.0 only (required version). To use the minimum inclusive range, provide `[1.0.0.0, ]` as the version range. + + System.String - System.Management.Automation.SwitchParameter + System.String + + + None + + + Prerelease + + When specified, includes prerelease versions in search results returned. + + + System.Management.Automation.SwitchParameter False - + + Repository + + Specifies one or more repository names to search. If not specified, search will include all currently registered repositories, in order of highest priority, until first repository package is found in. + + System.String[] + + System.String[] + + + None + + Credential - - {{ Fill Credential Description }} - + + Optional credentials to be used when accessing a repository. + System.Management.Automation.PSCredential System.Management.Automation.PSCredential @@ -710,10 +778,26 @@ None - NoClobber - - {{ Fill NoClobber Description }} - + Scope + + Specifies the scope under which a user has access. + + + CurrentUser + AllUsers + + Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType + + Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType + + + None + + + TrustRepository + + Suppress prompts to trust repository. The prompt to trust repository only occurs if the repository is not already set to a trusted level. + System.Management.Automation.SwitchParameter @@ -721,10 +805,10 @@ False - Prerelease - - {{ Fill Prerelease Description }} - + Reinstall + + Writes over any previously installed resource version that already exists on the machine. + System.Management.Automation.SwitchParameter @@ -733,9 +817,9 @@ Quiet - - {{ Fill Quiet Description }} - + + Supresses installation progress bar. + System.Management.Automation.SwitchParameter @@ -743,10 +827,10 @@ False - Reinstall - - {{ Fill Reinstall Description }} - + AcceptLicense + + Specifies that the resource should accept any request to accept license. This will suppress prompting if the module mandates that a user accept their license. + System.Management.Automation.SwitchParameter @@ -754,38 +838,32 @@ False - Repository - - {{ Fill Repository Description }} - - System.String[] + NoClobber + + Prevents installing a package that contains cmdlets that already exist on the machine. + - System.String[] + System.Management.Automation.SwitchParameter - None + False - Scope - - {{ Fill Scope Description }} - - - CurrentUser - AllUsers - - System.String + SkipDependencyCheck + + Skips the check for resource dependencies, so that only found resources are installed, and not any resources the found resource depends on. + - System.String + System.Management.Automation.SwitchParameter - None + False - TrustRepository - - {{ Fill TrustRepository Description }} - + AuthenticodeCheck + + Does a check to to validate signed files and catalog files on Windows. + System.Management.Automation.SwitchParameter @@ -793,34 +871,33 @@ False - Type - - {{ Fill Type Description }} - - System.String[] + PassThru + + Passes the resource installed to the console. + - System.String[] + System.Management.Automation.SwitchParameter - None + False - - Version - - {{ Fill Version Description }} - - System.String + + InputObject + + Used for pipeline input. + + Microsoft.PowerShell.PowerShellGet.UtilClasses.PSResourceInfo - System.String + Microsoft.PowerShell.PowerShellGet.UtilClasses.PSResourceInfo None Confirm - + Prompts you for confirmation before running the cmdlet. - + System.Management.Automation.SwitchParameter @@ -829,9 +906,9 @@ WhatIf - + Shows what would happen if the cmdlet runs. The cmdlet is not run. - + System.Management.Automation.SwitchParameter @@ -841,22 +918,54 @@ Install-PSResource - - AcceptLicense - - {{ Fill AcceptLicense Description }} - - - System.Management.Automation.SwitchParameter + + RequiredResource + + A hashtable or json string which specifies resources to install. Does not accept wildcard characters or a null value. + The hashtable will take a format with the module attributes like the following example + + @{ + TestModule = @{ + version = "[0.0.1,1.3.0]" + repository = "PSGallery" + } + + TestModulePrerelease = @{ + version = "[0.0.0,0.0.5]" + repository = "PSGallery" + prerelease = "true" + } + + TestModule99 = @{} + } + + A json string will take the following example format + + { + "TestModule": { + "version": "[0.0.1,1.3.0)", + "repository": "PSGallery" + }, + "TestModulePrerelease": { + "version": "[0.0.0,0.0.5]", + "repository": "PSGallery", + "prerelease": "true" + }, + "TestModule99": {} + } + + RequiredResource + + RequiredResource - False + None - + Credential - - {{ Fill Credential Description }} - + + Optional credentials to be used when accessing a repository. + System.Management.Automation.PSCredential System.Management.Automation.PSCredential @@ -865,10 +974,26 @@ None - NoClobber - - {{ Fill NoClobber Description }} - + Scope + + Specifies the scope under which a user has access. + + + CurrentUser + AllUsers + + Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType + + Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType + + + None + + + TrustRepository + + Suppress prompts to trust repository. The prompt to trust repository only occurs if the repository is not already set to a trusted level. + System.Management.Automation.SwitchParameter @@ -876,10 +1001,10 @@ False - Prerelease - - {{ Fill Prerelease Description }} - + Reinstall + + Writes over any previously installed resource version that already exists on the machine. + System.Management.Automation.SwitchParameter @@ -888,9 +1013,9 @@ Quiet - - {{ Fill Quiet Description }} - + + Supresses installation progress bar. + System.Management.Automation.SwitchParameter @@ -898,10 +1023,10 @@ False - Reinstall - - {{ Fill Reinstall Description }} - + AcceptLicense + + Specifies that the resource should accept any request to accept license. This will suppress prompting if the module mandates that a user accept their license. + System.Management.Automation.SwitchParameter @@ -909,10 +1034,122 @@ False - Repository - - {{ Fill Repository Description }} - + NoClobber + + Prevents installing a package that contains cmdlets that already exist on the machine. + + + System.Management.Automation.SwitchParameter + + + False + + + SkipDependencyCheck + + Skips the check for resource dependencies, so that only found resources are installed, and not any resources the found resource depends on. + + + System.Management.Automation.SwitchParameter + + + False + + + AuthenticodeCheck + + Does a check to to validate signed files and catalog files on Windows. + + + System.Management.Automation.SwitchParameter + + + False + + + PassThru + + Passes the resource installed to the console. + + + System.Management.Automation.SwitchParameter + + + False + + + InputObject + + Used for pipeline input. + + Microsoft.PowerShell.PowerShellGet.UtilClasses.PSResourceInfo + + Microsoft.PowerShell.PowerShellGet.UtilClasses.PSResourceInfo + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + System.Management.Automation.SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + System.Management.Automation.SwitchParameter + + + False + + + + Install-PSResource + + RequiredResourceFile + + Path to a psd1 or json which specifies resources to install. Does not accept wildcard characters or a null value. + The psd1 will take a hashtable format with the module attributes like the following example + + @{ + TestModule = @{ + version = "[0.0.1,1.3.0]" + repository = "PSGallery" + } + + TestModulePrerelease = @{ + version = "[0.0.0,0.0.5]" + repository = "PSGallery" + prerelease = "true" + } + + TestModule99 = @{} + } + + json files will take the following example format + + { + "TestModule": { + "version": "[0.0.1,1.3.0)", + "repository": "PSGallery" + }, + "TestModulePrerelease": { + "version": "[0.0.0,0.0.5]", + "repository": "PSGallery", + "prerelease": "true" + }, + "TestModule99": {} + } + System.String[] System.String[] @@ -921,38 +1158,38 @@ None - RequiredResourceFile - - {{ Fill RequiredResourceFile Description }} - - System.String + Credential + + Optional credentials to be used when accessing a repository. + + System.Management.Automation.PSCredential - System.String + System.Management.Automation.PSCredential None Scope - - {{ Fill Scope Description }} - + + Specifies the scope under which a user has access. + CurrentUser AllUsers - System.String + Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType - System.String + Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType None TrustRepository - - {{ Fill TrustRepository Description }} - + + Suppress prompts to trust repository. The prompt to trust repository only occurs if the repository is not already set to a trusted level. + System.Management.Automation.SwitchParameter @@ -960,96 +1197,99 @@ False - Type - - {{ Fill Type Description }} - - System.String[] + Reinstall + + Writes over any previously installed resource version that already exists on the machine. + - System.String[] + System.Management.Automation.SwitchParameter - None + False - - Confirm - - Prompts you for confirmation before running the cmdlet. - + + Quiet + + Supresses installation progress bar. + System.Management.Automation.SwitchParameter False - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - + + AcceptLicense + + Specifies that the resource should accept any request to accept license. This will suppress prompting if the module mandates that a user accept their license. + System.Management.Automation.SwitchParameter False - - - Install-PSResource - - InputObject - - {{ Fill InputObject Description }} - - System.Object[] + + NoClobber + + Prevents installing a package that contains cmdlets that already exist on the machine. + - System.Object[] + System.Management.Automation.SwitchParameter - None + False - - Confirm - - Prompts you for confirmation before running the cmdlet. - + + SkipDependencyCheck + + Skips the check for resource dependencies, so that only found resources are installed, and not any resources the found resource depends on. + System.Management.Automation.SwitchParameter False - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - + + AuthenticodeCheck + + Does a check to to validate signed files and catalog files on Windows. + System.Management.Automation.SwitchParameter False - - - Install-PSResource - RequiredResource - - {{ Fill RequiredResource Description }} - - System.Object + PassThru + + Passes the resource installed to the console. + + + System.Management.Automation.SwitchParameter + + + False + + + InputObject + + Used for pipeline input. + + Microsoft.PowerShell.PowerShellGet.UtilClasses.PSResourceInfo - System.Object + Microsoft.PowerShell.PowerShellGet.UtilClasses.PSResourceInfo None Confirm - + Prompts you for confirmation before running the cmdlet. - + System.Management.Automation.SwitchParameter @@ -1058,9 +1298,9 @@ WhatIf - + Shows what would happen if the cmdlet runs. The cmdlet is not run. - + System.Management.Automation.SwitchParameter @@ -1070,47 +1310,11 @@ - - AcceptLicense - - {{ Fill AcceptLicense Description }} - - System.Management.Automation.SwitchParameter - - System.Management.Automation.SwitchParameter - - - False - - - Credential - - {{ Fill Credential Description }} - - System.Management.Automation.PSCredential - - System.Management.Automation.PSCredential - - - None - - - InputObject - - {{ Fill InputObject Description }} - - System.Object[] - - System.Object[] - - - None - - + Name - - {{ Fill Name Description }} - + + Name of a resource or resources to install. Does not accept wildcard characters or a null value. + System.String[] System.String[] @@ -1119,22 +1323,23 @@ None - NoClobber - - {{ Fill NoClobber Description }} - - System.Management.Automation.SwitchParameter + Version + + Specifies the version of the resource to be installed. The value can be an exact version or a version range using the NuGet versioning syntax. + For more information about NuGet version ranges, see Package versioning (/nuget/concepts/package-versioning#version-ranges)PowerShellGet supports all but the minimum inclusive version listed in the NuGet version range documentation. So inputting "1.0.0.0" as the version doesn't yield versions 1.0.0.0 and higher (minimum inclusive range). Instead, the values is considered as the required version and yields version 1.0.0.0 only (required version). To use the minimum inclusive range, provide `[1.0.0.0, ]` as the version range. + + System.String - System.Management.Automation.SwitchParameter + System.String - False + None Prerelease - - {{ Fill Prerelease Description }} - + + When specified, includes prerelease versions in search results returned. + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -1143,34 +1348,96 @@ False - Quiet - - {{ Fill Quiet Description }} - - System.Management.Automation.SwitchParameter + Repository + + Specifies one or more repository names to search. If not specified, search will include all currently registered repositories, in order of highest priority, until first repository package is found in. + + System.String[] - System.Management.Automation.SwitchParameter + System.String[] - False + None - - Reinstall - - {{ Fill Reinstall Description }} - - System.Management.Automation.SwitchParameter - - System.Management.Automation.SwitchParameter + + RequiredResource + + A hashtable or json string which specifies resources to install. Does not accept wildcard characters or a null value. + The hashtable will take a format with the module attributes like the following example + + @{ + TestModule = @{ + version = "[0.0.1,1.3.0]" + repository = "PSGallery" + } + + TestModulePrerelease = @{ + version = "[0.0.0,0.0.5]" + repository = "PSGallery" + prerelease = "true" + } + + TestModule99 = @{} + } + + A json string will take the following example format + + { + "TestModule": { + "version": "[0.0.1,1.3.0)", + "repository": "PSGallery" + }, + "TestModulePrerelease": { + "version": "[0.0.0,0.0.5]", + "repository": "PSGallery", + "prerelease": "true" + }, + "TestModule99": {} + } + + RequiredResource + + RequiredResource - False + None - - Repository - - {{ Fill Repository Description }} - + + RequiredResourceFile + + Path to a psd1 or json which specifies resources to install. Does not accept wildcard characters or a null value. + The psd1 will take a hashtable format with the module attributes like the following example + + @{ + TestModule = @{ + version = "[0.0.1,1.3.0]" + repository = "PSGallery" + } + + TestModulePrerelease = @{ + version = "[0.0.0,0.0.5]" + repository = "PSGallery" + prerelease = "true" + } + + TestModule99 = @{} + } + + json files will take the following example format + + { + "TestModule": { + "version": "[0.0.1,1.3.0)", + "repository": "PSGallery" + }, + "TestModulePrerelease": { + "version": "[0.0.0,0.0.5]", + "repository": "PSGallery", + "prerelease": "true" + }, + "TestModule99": {} + } + System.String[] System.String[] @@ -1179,46 +1446,46 @@ None - RequiredResource - - {{ Fill RequiredResource Description }} - - System.Object + Credential + + Optional credentials to be used when accessing a repository. + + System.Management.Automation.PSCredential - System.Object + System.Management.Automation.PSCredential None - RequiredResourceFile - - {{ Fill RequiredResourceFile Description }} - - System.String + Scope + + Specifies the scope under which a user has access. + + Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType - System.String + Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType None - Scope - - {{ Fill Scope Description }} - - System.String + TrustRepository + + Suppress prompts to trust repository. The prompt to trust repository only occurs if the repository is not already set to a trusted level. + + System.Management.Automation.SwitchParameter - System.String + System.Management.Automation.SwitchParameter - None + False - TrustRepository - - {{ Fill TrustRepository Description }} - + Reinstall + + Writes over any previously installed resource version that already exists on the machine. + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -1227,34 +1494,34 @@ False - Type - - {{ Fill Type Description }} - - System.String[] + Quiet + + Supresses installation progress bar. + + System.Management.Automation.SwitchParameter - System.String[] + System.Management.Automation.SwitchParameter - None + False - Version - - {{ Fill Version Description }} - - System.String + AcceptLicense + + Specifies that the resource should accept any request to accept license. This will suppress prompting if the module mandates that a user accept their license. + + System.Management.Automation.SwitchParameter - System.String + System.Management.Automation.SwitchParameter - None + False - - Confirm - - Prompts you for confirmation before running the cmdlet. - + + NoClobber + + Prevents installing a package that contains cmdlets that already exist on the machine. + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -1262,11 +1529,11 @@ False - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - + + SkipDependencyCheck + + Skips the check for resource dependencies, so that only found resources are installed, and not any resources the found resource depends on. + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -1274,43 +1541,69 @@ False - - - + + AuthenticodeCheck + + Does a check to to validate signed files and catalog files on Windows. + + System.Management.Automation.SwitchParameter - System.String[] + System.Management.Automation.SwitchParameter + + False + + + PassThru - + Passes the resource installed to the console. - - + System.Management.Automation.SwitchParameter - System.Object[] + System.Management.Automation.SwitchParameter + + False + + + InputObject - + Used for pipeline input. - - + Microsoft.PowerShell.PowerShellGet.UtilClasses.PSResourceInfo - System.Management.Automation.PSCredential + Microsoft.PowerShell.PowerShellGet.UtilClasses.PSResourceInfo + + None + + + Confirm - + Prompts you for confirmation before running the cmdlet. - - - - + System.Management.Automation.SwitchParameter - System.Object + System.Management.Automation.SwitchParameter + + False + + + WhatIf - + Shows what would happen if the cmdlet runs. The cmdlet is not run. - - + System.Management.Automation.SwitchParameter + + System.Management.Automation.SwitchParameter + + + False + + + + @@ -1319,555 +1612,67 @@ -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} + PS C:\> Install-PSResource Az - {{ Add example description here }} + Installs the Az module. - - - - <add> - - - - - - - Publish-PSResource - Publish - PSResource - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Publish-PSResource - - Path - - {{ Fill Path Description }} - - System.String - - System.String - - - None - - - APIKey - - {{ Fill APIKey Description }} - - System.String - - System.String - - - None - - - Credential - - {{ Fill Credential Description }} - - System.Management.Automation.PSCredential - - System.Management.Automation.PSCredential - - - None - - - DestinationPath - - {{ Fill DestinationPath Description }} - - System.String - - System.String - - - None - - - Exclude - - {{ Fill Exclude Description }} - - System.String[] - - System.String[] - - - None - - - IconUrl - - {{ Fill IconUrl Description }} - - System.String - - System.String - - - None - - - LicenseUrl - - {{ Fill LicenseUrl Description }} - - System.String - - System.String - - - None - - - Nuspec - - {{ Fill Nuspec Description }} - - System.String - - System.String - - - None - - - ProjectUrl - - {{ Fill ProjectUrl Description }} - - System.String - - System.String - - - None - - - ReleaseNotes - - {{ Fill ReleaseNotes Description }} - - System.String - - System.String - - - None - - - Repository - - {{ Fill Repository Description }} - - System.String - - System.String - - - None - - - SkipDependenciesCheck - - {{ Fill SkipDependenciesCheck Description }} - - - System.Management.Automation.SwitchParameter - - - False - - - Tags - - {{ Fill Tags Description }} - - System.String[] - - System.String[] - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - System.Management.Automation.SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - System.Management.Automation.SwitchParameter - - - False - - - - Publish-PSResource - - APIKey - - {{ Fill APIKey Description }} - - System.String - - System.String - - - None - - - Credential - - {{ Fill Credential Description }} - - System.Management.Automation.PSCredential - - System.Management.Automation.PSCredential - - - None - - - DestinationPath - - {{ Fill DestinationPath Description }} - - System.String - - System.String - - - None - - - Exclude - - {{ Fill Exclude Description }} - - System.String[] - - System.String[] - - - None - - - IconUrl - - {{ Fill IconUrl Description }} - - System.String - - System.String - - - None - - - LicenseUrl - - {{ Fill LicenseUrl Description }} - - System.String - - System.String - - - None - - - LiteralPath - - {{ Fill LiteralPath Description }} - - System.String - - System.String - - - None - - - Nuspec - - {{ Fill Nuspec Description }} - - System.String - - System.String - - - None - - - ProjectUrl - - {{ Fill ProjectUrl Description }} - - System.String - - System.String - - - None - - - ReleaseNotes - - {{ Fill ReleaseNotes Description }} - - System.String - - System.String - - - None - - - Repository - - {{ Fill Repository Description }} - - System.String - - System.String - - - None - - - SkipDependenciesCheck - - {{ Fill SkipDependenciesCheck Description }} - - - System.Management.Automation.SwitchParameter - - - False - - - Tags - - {{ Fill Tags Description }} - - System.String[] - - System.String[] - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - System.Management.Automation.SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - System.Management.Automation.SwitchParameter - - - False - - - - Publish-PSResource - - APIKey - - {{ Fill APIKey Description }} - - System.String - - System.String - - - None - - - Credential - - {{ Fill Credential Description }} - - System.Management.Automation.PSCredential - - System.Management.Automation.PSCredential - - - None - - - DestinationPath - - {{ Fill DestinationPath Description }} - - System.String - - System.String - - - None - - - Exclude - - {{ Fill Exclude Description }} - - System.String[] - - System.String[] - - - None - - - IconUrl - - {{ Fill IconUrl Description }} - - System.String - - System.String - - - None - - - LicenseUrl - - {{ Fill LicenseUrl Description }} - - System.String - - System.String - - - None - - - ProjectUrl - - {{ Fill ProjectUrl Description }} - - System.String - - System.String - - - None - - - ReleaseNotes - - {{ Fill ReleaseNotes Description }} - - System.String - - System.String - - - None - - - Repository - - {{ Fill Repository Description }} - - System.String - - System.String - - - None - - - SkipDependenciesCheck - - {{ Fill SkipDependenciesCheck Description }} - - - System.Management.Automation.SwitchParameter - - - False - - - Tags - - {{ Fill Tags Description }} - - System.String[] - - System.String[] - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - System.Management.Automation.SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - System.Management.Automation.SwitchParameter - - - False - - + + -------------------------- Example 2 -------------------------- + PS C:\> Install-PSResource Az -Version "[2.0.0, 3.0.0]" + + Installs the latest stable Az module that is within the range 2.0.0 and 3.0.0. + + + + -------------------------- Example 3 -------------------------- + PS C:\> Install-PSResource Az -Repository PSGallery + + Installs the latest stable Az module from the PowerShellGallery. + + + + -------------------------- Example 3 -------------------------- + PS C:\> Install-PSResource Az -Reinstall + + Installs the Az module and will write over any previously installed version if it is already installed. + + + + -------------------------- Example 4 -------------------------- + PS C:\> Install-PSResource -RequiredResourceFile myRequiredModules.psd1 + + Installs the PSResources specified in the psd1 file. + + + + + + Online Version: + + + + + + + Publish-PSResource + Publish + PSResource + + Publishes a specified module from the local computer to PSResource repository. + + + + The Publish-PSResource cmdlet combines the Publish-Module and Publish-Script cmdlets from V2. It publishes a specified resource from the local computer to an online Nuget-based gallery by using an API key, stored as part of a user's profile in the gallery or to a local repository. You can specify the resource to publish either by the resource's name, or by the path to the folder containing the module or script resource. + + Publish-PSResource - - APIKey - - {{ Fill APIKey Description }} - + + Path + + When specified, includes prerelease versions in search. + System.String System.String @@ -1876,22 +1681,10 @@ None - Credential - - {{ Fill Credential Description }} - - System.Management.Automation.PSCredential - - System.Management.Automation.PSCredential - - - None - - - DestinationPath - - {{ Fill DestinationPath Description }} - + APIKey + + Specifies the API key that you want to use to publish a resource to the online gallery. + System.String System.String @@ -1900,22 +1693,22 @@ None - Exclude - - {{ Fill Exclude Description }} - - System.String[] + Repository + + Specifies the repository to publish to. + + System.String - System.String[] + System.String None - - Nuspec - - {{ Fill Nuspec Description }} - + + DestinationPath + + Specifies the path to where the resource (as a nupkg) should be saved to. This parameter can be used in conjunction with the -Repository parameter to publish to a repository and also save the exact same package to the local file system. + System.String System.String @@ -1924,22 +1717,22 @@ None - Repository - - {{ Fill Repository Description }} - - System.String + Credential + + Specifies a user account that has rights to a specific repository (used for finding dependencies). + + System.Management.Automation.PSCredential - System.String + System.Management.Automation.PSCredential None SkipDependenciesCheck - - {{ Fill SkipDependenciesCheck Description }} - + + Bypasses the default check that all dependencies are present on the repository which the resource is being published to. + System.Management.Automation.SwitchParameter @@ -1948,9 +1741,9 @@ Confirm - + Prompts you for confirmation before running the cmdlet. - + System.Management.Automation.SwitchParameter @@ -1959,9 +1752,9 @@ WhatIf - + Shows what would happen if the cmdlet runs. The cmdlet is not run. - + System.Management.Automation.SwitchParameter @@ -1973,81 +1766,9 @@ APIKey - - {{ Fill APIKey Description }} - - System.String - - System.String - - - None - - - Credential - - {{ Fill Credential Description }} - - System.Management.Automation.PSCredential - - System.Management.Automation.PSCredential - - - None - - - DestinationPath - - {{ Fill DestinationPath Description }} - - System.String - - System.String - - - None - - - Exclude - - {{ Fill Exclude Description }} - - System.String[] - - System.String[] - - - None - - - IconUrl - - {{ Fill IconUrl Description }} - - System.String - - System.String - - - None - - - LicenseUrl - - {{ Fill LicenseUrl Description }} - - System.String - - System.String - - - None - - - LiteralPath - - {{ Fill LiteralPath Description }} - + + Specifies the API key that you want to use to publish a resource to the online gallery. + System.String System.String @@ -2056,10 +1777,10 @@ None - Nuspec - - {{ Fill Nuspec Description }} - + Repository + + Specifies the repository to publish to. + System.String System.String @@ -2067,23 +1788,11 @@ None - + Path - - {{ Fill Path Description }} - - System.String - - System.String - - - None - - - ProjectUrl - - {{ Fill ProjectUrl Description }} - + + When specified, includes prerelease versions in search. + System.String System.String @@ -2091,11 +1800,11 @@ None - - ReleaseNotes - - {{ Fill ReleaseNotes Description }} - + + DestinationPath + + Specifies the path to where the resource (as a nupkg) should be saved to. This parameter can be used in conjunction with the -Repository parameter to publish to a repository and also save the exact same package to the local file system. + System.String System.String @@ -2104,22 +1813,22 @@ None - Repository - - {{ Fill Repository Description }} - - System.String + Credential + + Specifies a user account that has rights to a specific repository (used for finding dependencies). + + System.Management.Automation.PSCredential - System.String + System.Management.Automation.PSCredential None SkipDependenciesCheck - - {{ Fill SkipDependenciesCheck Description }} - + + Bypasses the default check that all dependencies are present on the repository which the resource is being published to. + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -2127,23 +1836,11 @@ False - - Tags - - {{ Fill Tags Description }} - - System.String[] - - System.String[] - - - None - Confirm - + Prompts you for confirmation before running the cmdlet. - + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -2153,9 +1850,9 @@ WhatIf - + Shows what would happen if the cmdlet runs. The cmdlet is not run. - + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -2164,26 +1861,8 @@ False - - - - System.String - - - - - - - - - - System.Object - - - - - - + + @@ -2192,15 +1871,22 @@ -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} + PS C:\> Publish-PSResource -Path c:\Test-Module + + This will publish the module 'Test-Module' to the highest priority repository + + + + -------------------------- Example 2 -------------------------- + PS C:\> Publish-PSResource -Path c:\Test-Module -Repository PSGallery -APIKey '1234567' - {{ Add example description here }} + This will publish the module 'Test-Module' to the PowerShellGallery. Note that the API key is a secret that is generated for a user from the website itself. - <add> + Online Version: @@ -2211,260 +1897,233 @@ Register PSResourceRepository - {{ Fill in the Synopsis }} + Registers a repository for PowerShell resources. - {{ Fill in the Description }} + The Register-PSResourceRepository cmdlet registers a repository for PowerShell resources. Register-PSResourceRepository Name - - {{ Fill Name Description }} - - System.String + + Name of the repository to be registered. Cannot be "PSGallery". + + String - System.String + String None - URL - - {{ Fill URL Description }} - - System.Uri - - System.Uri - - - None - - - Credential - - {{ Fill Credential Description }} - - System.Management.Automation.PSCredential + Uri + + Specifies the location of the repository to be registered. Uri can be of the following Uri schemas: HTTPS, HTTP, FTP, file share based. + + String - System.Management.Automation.PSCredential + String None Priority - - {{ Fill Priority Description }} - - System.Int32 - - System.Int32 - - - None - - - Proxy - - {{ Fill Proxy Description }} - - System.Uri + + Specifies the priority ranking of the repository. Repositories with higher ranking priority are searched before a lower ranking priority one, when searching for a repository item across multiple registered repositories. Valid priority values range from 0 to 50, such that a lower numeric value (i.e 10) corresponds to a higher priority ranking than a higher numeric value (i.e 40). Has default value of 50. + + Int32 - System.Uri + Int32 - None + 50 - - ProxyCredential - - {{ Fill ProxyCredential Description }} - - System.Management.Automation.PSCredential + + Trusted + + Specifies whether the repository should be trusted. + - System.Management.Automation.PSCredential + SwitchParameter - None + False - Trusted - - {{ Fill Trusted Description }} - + CredentialInfo + + Specifies where a credential is stored to access the PSResourceRepository for Find/Install/Update commands. Takes a PSCredentialInfo Objects which takes in a vault name and secret name. This parameter utilizes the Microsoft.PowerShell.SecretManagement module for interfacing with the stored credential. + `New-Object Microsoft.PowerShell.PowerShellGet.UtilClasses.PSCredentialInfo ("VaultName", "SecretName")` + + PSCredentialInfo - System.Management.Automation.SwitchParameter + PSCredentialInfo - False + None Confirm - + Prompts you for confirmation before running the cmdlet. - + - System.Management.Automation.SwitchParameter + SwitchParameter False WhatIf - + Shows what would happen if the cmdlet runs. The cmdlet is not run. - + - System.Management.Automation.SwitchParameter + SwitchParameter False - - - Register-PSResourceRepository - Priority - - {{ Fill Priority Description }} - - System.Int32 - - System.Int32 - - - None - - - Proxy - - {{ Fill Proxy Description }} - - System.Uri + PassThru + + When specified, displays the succcessfully registered repository and its information. + - System.Uri + SwitchParameter - None + False - - ProxyCredential - - {{ Fill ProxyCredential Description }} - - System.Management.Automation.PSCredential + + + Register-PSResourceRepository + + Priority + + Specifies the priority ranking of the repository. Repositories with higher ranking priority are searched before a lower ranking priority one, when searching for a repository item across multiple registered repositories. Valid priority values range from 0 to 50, such that a lower numeric value (i.e 10) corresponds to a higher priority ranking than a higher numeric value (i.e 40). Has default value of 50. + + Int32 - System.Management.Automation.PSCredential + Int32 - None + 50 PSGallery - - {{ Fill PSGallery Description }} - + + When specified, registers PSGallery repository. + - System.Management.Automation.SwitchParameter + SwitchParameter False Trusted - - {{ Fill Trusted Description }} - + + Specifies whether the repository should be trusted. + - System.Management.Automation.SwitchParameter + SwitchParameter False Confirm - + Prompts you for confirmation before running the cmdlet. - + - System.Management.Automation.SwitchParameter + SwitchParameter False WhatIf - + Shows what would happen if the cmdlet runs. The cmdlet is not run. - + - System.Management.Automation.SwitchParameter + SwitchParameter False - - - Register-PSResourceRepository - - Proxy - - {{ Fill Proxy Description }} - - System.Uri + + PassThru + + When specified, displays the succcessfully registered repository and its information. + - System.Uri + SwitchParameter - None + False - - ProxyCredential - - {{ Fill ProxyCredential Description }} - - System.Management.Automation.PSCredential + + + Register-PSResourceRepository + + Repository + + Specifies an array of hashtables which contains repository information and is used to register multiple repositories at once. + + Hashtable[] - System.Management.Automation.PSCredential + Hashtable[] None - - Repositories - - {{ Fill Repositories Description }} - - System.Collections.Generic.List`1[System.Collections.Hashtable] + + Trusted + + Specifies whether the repository should be trusted. + - System.Collections.Generic.List`1[System.Collections.Hashtable] + SwitchParameter - None + False Confirm - + Prompts you for confirmation before running the cmdlet. - + - System.Management.Automation.SwitchParameter + SwitchParameter False WhatIf - + Shows what would happen if the cmdlet runs. The cmdlet is not run. - + + + SwitchParameter + + + False + + + PassThru + + When specified, displays the succcessfully registered repository and its information. + - System.Management.Automation.SwitchParameter + SwitchParameter False @@ -2472,151 +2131,132 @@ - - Credential - - {{ Fill Credential Description }} - - System.Management.Automation.PSCredential - - System.Management.Automation.PSCredential - - - None - Name - - {{ Fill Name Description }} - - System.String + + Name of the repository to be registered. Cannot be "PSGallery". + + String - System.String + String None Priority - - {{ Fill Priority Description }} - - System.Int32 - - System.Int32 - - - None - - - Proxy - - {{ Fill Proxy Description }} - - System.Uri - - System.Uri - - - None - - - ProxyCredential - - {{ Fill ProxyCredential Description }} - - System.Management.Automation.PSCredential + + Specifies the priority ranking of the repository. Repositories with higher ranking priority are searched before a lower ranking priority one, when searching for a repository item across multiple registered repositories. Valid priority values range from 0 to 50, such that a lower numeric value (i.e 10) corresponds to a higher priority ranking than a higher numeric value (i.e 40). Has default value of 50. + + Int32 - System.Management.Automation.PSCredential + Int32 - None + 50 PSGallery - - {{ Fill PSGallery Description }} - - System.Management.Automation.SwitchParameter + + When specified, registers PSGallery repository. + + SwitchParameter - System.Management.Automation.SwitchParameter + SwitchParameter False - - Repositories - - {{ Fill Repositories Description }} - - System.Collections.Generic.List`1[System.Collections.Hashtable] + + Repository + + Specifies an array of hashtables which contains repository information and is used to register multiple repositories at once. + + Hashtable[] - System.Collections.Generic.List`1[System.Collections.Hashtable] + Hashtable[] None Trusted - - {{ Fill Trusted Description }} - - System.Management.Automation.SwitchParameter + + Specifies whether the repository should be trusted. + + SwitchParameter - System.Management.Automation.SwitchParameter + SwitchParameter False - URL - - {{ Fill URL Description }} - - System.Uri + Uri + + Specifies the location of the repository to be registered. Uri can be of the following Uri schemas: HTTPS, HTTP, FTP, file share based. + + String + + String + + + None + + + CredentialInfo + + Specifies where a credential is stored to access the PSResourceRepository for Find/Install/Update commands. Takes a PSCredentialInfo Objects which takes in a vault name and secret name. This parameter utilizes the Microsoft.PowerShell.SecretManagement module for interfacing with the stored credential. + `New-Object Microsoft.PowerShell.PowerShellGet.UtilClasses.PSCredentialInfo ("VaultName", "SecretName")` + + PSCredentialInfo - System.Uri + PSCredentialInfo None Confirm - + Prompts you for confirmation before running the cmdlet. - - System.Management.Automation.SwitchParameter + + SwitchParameter - System.Management.Automation.SwitchParameter + SwitchParameter False WhatIf - + Shows what would happen if the cmdlet runs. The cmdlet is not run. - - System.Management.Automation.SwitchParameter + + SwitchParameter - System.Management.Automation.SwitchParameter + SwitchParameter False - - - - - System.Management.Automation.PSCredential - + + PassThru - + When specified, displays the succcessfully registered repository and its information. - + SwitchParameter + + SwitchParameter + + + False + + + - System.Uri + System.String @@ -2626,7 +2266,7 @@ - System.Object + Microsoft.PowerShell.PowerShellGet.UtilClasses.PSRepositoryInfo (if 'PassThru' parameter is used) @@ -2635,24 +2275,49 @@ - + Repositories are unique by 'Name'. Attempting to register a repository with same 'Name' as an already registered repository will not successfully register. + Registering the PSGallery repository must be done via the PSGalleryParameterSet (i.e by using the 'PSGallery' parameter instead of 'Name' and 'Uri' parameters). + Uri string input must be of one of the following Uri schemes: HTTP, HTTPS, FTP, File -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} + PS C:\> Register-PSResourceRepository -Name "PoshTestGallery" -Uri "https://www.powershellgallery.com/api/v2" +PS C:\> Get-PSResourceRepository -Name "PoshTestGallery" + Name Uri Trusted Priority + ---- --- ------- -------- + PoshTestGallery https://www.poshtestgallery.com/api/v2 False 50 + + This example registers the repository with the `-Name` of "PoshTestGallery" along with the associated `Uri` value for it. + + + + -------------------------- Example 2 -------------------------- + PS C:\> Register-PSResourceRepository -PSGallery +PS C:\> Get-PSResourceRepository -Name "PSGallery" + Name Uri Trusted Priority + ---- --- ------- -------- + PSGallery https://www.powershellgallery.com/api/v2 False 50 + + This example registers the "PSGallery" repository, with the 'PSGallery' parameter. Unlike the previous example, we cannot use the `-Name` or `-Uri` parameters to register the "PSGallery" repository as it is considered Powershell's default repository store and has its own value for Uri. + + + + -------------------------- Example 3 -------------------------- + PS C:\> $arrayOfHashtables = @{Name = "psgettestlocal"; Uri = "c:/code/testdir"}, @{PSGallery = $True} +PS C:\> Register-PSResourceRepository -Repository $arrayOfHashtables +PS C:\> Get-PSResourceRepository + Name Uri Trusted Priority + ---- --- ------- -------- + PSGallery https://www.powershellgallery.com/api/v2 False 50 + psgettestlocal file:///c:/code/testdir False 50 - {{ Add example description here }} + This example registers multiple repositories at once. To do so, we use the `-Repository` parameter and provide an array of hashtables. Each hashtable can only have keys associated with parameters for the NameParameterSet or the PSGalleryParameterSet. Upon running the command we can see that the "psgettestlocal" and "PSGallery" repositories have been succesfully registered. - - - <add> - - - + @@ -2660,20 +2325,20 @@ Save PSResource - {{ Fill in the Synopsis }} + Saves resources (modules and scripts) from a registered repository onto the machine. - {{ Fill in the Description }} + The Save-PSResource cmdlet combines the Save-Module and Save-Script cmdlets from V2. It saves a resource from a registered repository to a specific path on a machine based on the -Name parameter argument. It does not return any object. Other parameters allow the resource to be specified by repository and version, and allow the user to save the resource as a .nupkg or with the PowerShellGet XML metadata. Save-PSResource - + Name - - {{ Fill Name Description }} - + + Name of a resource or resources to save. Does not accept wildcard characters or a null value. + System.String[] System.String[] @@ -2682,21 +2347,46 @@ None - AsNupkg - - {{ Fill AsNupkg Description }} - + Version + + Specifies the version of the resource to be saved. The value can be an exact version or a version range using the NuGet versioning syntax. + For more information about NuGet version ranges, see Package versioning (/nuget/concepts/package-versioning#version-ranges)PowerShellGet supports all but the minimum inclusive version listed in the NuGet version range documentation. So inputting "1.0.0.0" as the version doesn't yield versions 1.0.0.0 and higher (minimum inclusive range). Instead, the values is considered as the required version and yields version 1.0.0.0 only (required version). To use the minimum inclusive range, provide `[1.0.0.0, ]` as the version range. + + System.String + + System.String + + + None + + + Prerelease + + Specifies to include prerelease versions. + System.Management.Automation.SwitchParameter False - + + Repository + + Specifies one or more repository names to search. If not specified, search will include all currently registered repositories, in order of highest priority, until first repository package is found in. + + System.String[] + + System.String[] + + + None + + Credential - - {{ Fill Credential Description }} - + + Optional credentials to be used when accessing a repository. + System.Management.Automation.PSCredential System.Management.Automation.PSCredential @@ -2704,11 +2394,22 @@ None + + AsNupkg + + Saves the resource as a zipped .nupkg file. + + + System.Management.Automation.SwitchParameter + + + False + IncludeXML - - {{ Fill IncludeXML Description }} - + + Includes the PowerShellGet metadata XML (used to verify that PowerShellGet has installed a module). + System.Management.Automation.SwitchParameter @@ -2717,9 +2418,9 @@ Path - - {{ Fill Path Description }} - + + Specifies the path to save the resource to. + System.String System.String @@ -2728,10 +2429,10 @@ None - Prerelease - - {{ Fill Prerelease Description }} - + TrustRepository + + Suppress prompts to trust repository. The prompt to trust repository only occurs if the repository is not already set to a trusted level. + System.Management.Automation.SwitchParameter @@ -2739,34 +2440,66 @@ False - Repository - - {{ Fill Repository Description }} - - System.String[] + AuthenticodeCheck + + Does a check to to validate signed files and catalog files on Windows. + - System.String[] + System.Management.Automation.SwitchParameter - None + False - Version - - {{ Fill Version Description }} - - System.String + PassThru + + Passes the resource saved to the console. + - System.String + System.Management.Automation.SwitchParameter + + + False + + + SkipDependencyCheck + + Skips the check for resource dependencies, so that only found resources are saved, and not any resources the found resource depends on. + + + System.Management.Automation.SwitchParameter + + + False + + + Quiet + + Supresses progress information. + + + System.Management.Automation.SwitchParameter + + + False + + + InputObject + + Used for pipeline input. + + Microsoft.PowerShell.PowerShellGet.UtilClasses.PSResourceInfo + + Microsoft.PowerShell.PowerShellGet.UtilClasses.PSResourceInfo None Confirm - + Prompts you for confirmation before running the cmdlet. - + System.Management.Automation.SwitchParameter @@ -2775,9 +2508,9 @@ WhatIf - + Shows what would happen if the cmdlet runs. The cmdlet is not run. - + System.Management.Automation.SwitchParameter @@ -2787,11 +2520,36 @@ + + Name + + Name of a resource or resources to save. Does not accept wildcard characters or a null value. + + System.String[] + + System.String[] + + + None + - AsNupkg - - {{ Fill AsNupkg Description }} - + Version + + Specifies the version of the resource to be saved. The value can be an exact version or a version range using the NuGet versioning syntax. + For more information about NuGet version ranges, see Package versioning (/nuget/concepts/package-versioning#version-ranges)PowerShellGet supports all but the minimum inclusive version listed in the NuGet version range documentation. So inputting "1.0.0.0" as the version doesn't yield versions 1.0.0.0 and higher (minimum inclusive range). Instead, the values is considered as the required version and yields version 1.0.0.0 only (required version). To use the minimum inclusive range, provide `[1.0.0.0, ]` as the version range. + + System.String + + System.String + + + None + + + Prerelease + + Specifies to include prerelease versions. + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -2799,11 +2557,23 @@ False - + + Repository + + Specifies one or more repository names to search. If not specified, search will include all currently registered repositories, in order of highest priority, until first repository package is found in. + + System.String[] + + System.String[] + + + None + + Credential - - {{ Fill Credential Description }} - + + Optional credentials to be used when accessing a repository. + System.Management.Automation.PSCredential System.Management.Automation.PSCredential @@ -2812,10 +2582,10 @@ None - IncludeXML - - {{ Fill IncludeXML Description }} - + AsNupkg + + Saves the resource as a zipped .nupkg file. + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -2823,23 +2593,23 @@ False - - Name - - {{ Fill Name Description }} - - System.String[] + + IncludeXML + + Includes the PowerShellGet metadata XML (used to verify that PowerShellGet has installed a module). + + System.Management.Automation.SwitchParameter - System.String[] + System.Management.Automation.SwitchParameter - None + False Path - - {{ Fill Path Description }} - + + Specifies the path to save the resource to. + System.String System.String @@ -2848,10 +2618,10 @@ None - Prerelease - - {{ Fill Prerelease Description }} - + TrustRepository + + Suppress prompts to trust repository. The prompt to trust repository only occurs if the repository is not already set to a trusted level. + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -2860,34 +2630,70 @@ False - Repository - - {{ Fill Repository Description }} - - System.String[] + AuthenticodeCheck + + Does a check to to validate signed files and catalog files on Windows. + + System.Management.Automation.SwitchParameter - System.String[] + System.Management.Automation.SwitchParameter - None + False + + + PassThru + + Passes the resource saved to the console. + + System.Management.Automation.SwitchParameter + + System.Management.Automation.SwitchParameter + + + False + + + SkipDependencyCheck + + Skips the check for resource dependencies, so that only found resources are saved, and not any resources the found resource depends on. + + System.Management.Automation.SwitchParameter + + System.Management.Automation.SwitchParameter + + + False + + + Quiet + + Supresses progress information. + + System.Management.Automation.SwitchParameter + + System.Management.Automation.SwitchParameter + + + False - - Version - - {{ Fill Version Description }} - - System.String + + InputObject + + Used for pipeline input. + + Microsoft.PowerShell.PowerShellGet.UtilClasses.PSResourceInfo - System.String + Microsoft.PowerShell.PowerShellGet.UtilClasses.PSResourceInfo None Confirm - + Prompts you for confirmation before running the cmdlet. - + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -2897,9 +2703,9 @@ WhatIf - + Shows what would happen if the cmdlet runs. The cmdlet is not run. - + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -2908,42 +2714,8 @@ False - - - - System.String[] - - - - - - - - System.Management.Automation.PSCredential - - - - - - - - System.String - - - - - - - - - - System.Object - - - - - - + + @@ -2952,15 +2724,36 @@ -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} + PS C:\> Save-PSResource -Name Az - {{ Add example description here }} + Saves the Az module + + + + -------------------------- Example 2 -------------------------- + PS C:\> Save-PSResource -Name Az -Repository PSGallery + + Saves the Az module found in the PowerShellGallery + + + + -------------------------- Example 3 -------------------------- + PS C:\> Save-PSResource Az -AsNupkg + + Saves the Az module as a .nupkg file + + + + -------------------------- Example 4 -------------------------- + PS C:\> Save-PSResource Az -IncludeXML + + Saves the Az module and includes the PowerShellGet XML metadata - <add> + Online Version: @@ -2971,20 +2764,20 @@ Set PSResourceRepository - {{ Fill in the Synopsis }} + Sets information for a registered repository. - {{ Fill in the Description }} + The Set-PSResourceRepository cmdlet sets information for a registered repository. Set-PSResourceRepository - + Name - - {{ Fill Name Description }} - + + Specifies the name of the repository to be set. + System.String System.String @@ -2992,23 +2785,11 @@ None - - Credential - - {{ Fill Credential Description }} - - System.Management.Automation.PSCredential - - System.Management.Automation.PSCredential - - - None - - + Priority - - {{ Fill Priority Description }} - + + Specifies the priority ranking of the repository, such that repositories with higher ranking priority are searched before a lower ranking priority one, when searching for a repository item across multiple registered repositories. Valid priority values range from 0 to 50, such that a lower numeric value (i.e 10) corresponds to a higher priority ranking than a higher numeric value (i.e 40). + System.Int32 System.Int32 @@ -3016,131 +2797,58 @@ None - - Proxy - - {{ Fill Proxy Description }} - - System.Uri - - System.Uri - - - None - - - ProxyCredential - - {{ Fill ProxyCredential Description }} - - System.Management.Automation.PSCredential - - System.Management.Automation.PSCredential - - - None - Trusted - - {{ Fill Trusted Description }} - + + Specifies whether the repository should be trusted. + System.Management.Automation.SwitchParameter False - - URL - - {{ Fill URL Description }} - - System.Uri + + Uri + + Specifies the location of the repository to be set. + + String - System.Uri + String None - - Confirm - - Prompts you for confirmation before running the cmdlet. - + + CredentialInfo + + Specifies where a credential is stored to access the PSResourceRepository for Find/Install/Update commands. Takes a PSCredentialInfo Objects which takes in a vault name and secret name. This parameter utilizes the Microsoft.PowerShell.SecretManagement module for interfacing with the stored credential. + `New-Object Microsoft.PowerShell.PowerShellGet.UtilClasses.PSCredentialInfo ("VaultName", "SecretName")` + + PSCredentialInfo - System.Management.Automation.SwitchParameter + PSCredentialInfo - False + None - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - + + PassThru + + When specified, displays the succcessfully registered repository and its information + System.Management.Automation.SwitchParameter False - - - Set-PSResourceRepository - - Priority - - {{ Fill Priority Description }} - - System.Int32 - - System.Int32 - - - None - - - Proxy - - {{ Fill Proxy Description }} - - System.Uri - - System.Uri - - - None - - - ProxyCredential - - {{ Fill ProxyCredential Description }} - - System.Management.Automation.PSCredential - - System.Management.Automation.PSCredential - - - None - - - Repositories - - {{ Fill Repositories Description }} - - System.Collections.Generic.List`1[System.Collections.Hashtable] - - System.Collections.Generic.List`1[System.Collections.Hashtable] - - - None - Confirm - + Prompts you for confirmation before running the cmdlet. - + System.Management.Automation.SwitchParameter @@ -3149,9 +2857,9 @@ WhatIf - + Shows what would happen if the cmdlet runs. The cmdlet is not run. - + System.Management.Automation.SwitchParameter @@ -3161,23 +2869,11 @@ - - Credential - - {{ Fill Credential Description }} - - System.Management.Automation.PSCredential - - System.Management.Automation.PSCredential - - - None - - + Name - - {{ Fill Name Description }} - + + Specifies the name of the repository to be set. + System.String System.String @@ -3185,11 +2881,11 @@ None - + Priority - - {{ Fill Priority Description }} - + + Specifies the priority ranking of the repository, such that repositories with higher ranking priority are searched before a lower ranking priority one, when searching for a repository item across multiple registered repositories. Valid priority values range from 0 to 50, such that a lower numeric value (i.e 10) corresponds to a higher priority ranking than a higher numeric value (i.e 40). + System.Int32 System.Int32 @@ -3197,47 +2893,48 @@ None - - Proxy - - {{ Fill Proxy Description }} - - System.Uri + + Trusted + + Specifies whether the repository should be trusted. + + System.Management.Automation.SwitchParameter - System.Uri + System.Management.Automation.SwitchParameter - None + False - - ProxyCredential - - {{ Fill ProxyCredential Description }} - - System.Management.Automation.PSCredential + + Uri + + Specifies the location of the repository to be set. + + String - System.Management.Automation.PSCredential + String None - - Repositories - - {{ Fill Repositories Description }} - - System.Collections.Generic.List`1[System.Collections.Hashtable] + + CredentialInfo + + Specifies where a credential is stored to access the PSResourceRepository for Find/Install/Update commands. Takes a PSCredentialInfo Objects which takes in a vault name and secret name. This parameter utilizes the Microsoft.PowerShell.SecretManagement module for interfacing with the stored credential. + `New-Object Microsoft.PowerShell.PowerShellGet.UtilClasses.PSCredentialInfo ("VaultName", "SecretName")` + + PSCredentialInfo - System.Collections.Generic.List`1[System.Collections.Hashtable] + PSCredentialInfo None - - Trusted - - {{ Fill Trusted Description }} - + + PassThru + + When specified, displays the succcessfully registered repository and its information + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -3245,23 +2942,11 @@ False - - URL - - {{ Fill URL Description }} - - System.Uri - - System.Uri - - - None - Confirm - + Prompts you for confirmation before running the cmdlet. - + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -3271,9 +2956,9 @@ WhatIf - + Shows what would happen if the cmdlet runs. The cmdlet is not run. - + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -3293,31 +2978,7 @@ - System.Uri - - - - - - - - System.Management.Automation.PSCredential - - - - - - - - System.Collections.Generic.List`1[[System.Collections.Hashtable, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] - - - - - - - - System.Int32 + System.Collections.Hashtable[] @@ -3327,7 +2988,7 @@ - System.Object + Microsoft.PowerShell.PowerShellGet.UtilClasses.PSRepositoryInfo (if 'PassThru' parameter used) @@ -3342,18 +3003,53 @@ -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} + PS C:\> Get-PSResourceRepository -Name "PoshTestGallery" + Name Uri Trusted Priority + ---- --- ------- -------- + PoshTestGallery https://www.poshtestgallery.com/api/v2 False 50 +PS C:\> Set-PSResourceRepository -Name "PoshTestGallery" -Uri "c:/code/testdir" -PassThru + Name Uri Trusted Priority + ---- --- ------- -------- + PoshTestGallery file:///c:/code/testdir False 50 + + This example first checks if the PoshTestGallery repository has been registered. We wish to set the `-Uri` value of this repository by running the Set-PSResourceRepository cmdlet with the `-Uri` parameter and a valid Uri scheme Uri. We run the Get-PSResourceRepository cmdlet again to ensure that the `-Uri` of the repository was changed. We also use the `-PassThru` parameter to see the changed repository. + + + + -------------------------- Example 2 -------------------------- + PS C:\> Get-PSResourceRepository -Name "PSGallery" + Name Uri Trusted Priority + ---- --- ------- -------- + PSGallery https://www.powershellgallery.com/api/v2 False 50 +PS C:\> Set-PSResourceRepository -Name "PSGallery" -Priority 25 -Trusted -PassThru + Name Uri Trusted Priority + ---- --- ------- -------- + PSGallery https://www.powershellgallery.com/api/v2 True 25 + + This example first checks if the PSGallery repository has been registered. We wish to set the `-Priority` and `-Trusted` values of this repository by running the Set-PSResourceRepository cmdlet with the `-Priority` parameter set to a value between 0 and 50 and by using the `-Trusted` parameter switch. We run the Get-PSResourceRepository cmdlet again to ensure that the `-Priority` and `-Trusted` values of the repository were changed. An important note here is that just for the default PSGallery repository, the `-Uri` value can't be changed/set. We also use the `-PassThru` parameter to see the changed repository. + + + + -------------------------- Example 3 -------------------------- + PS C:\> Get-PSResourceRepository -Name "*" + Name Uri Trusted Priority + ---- --- ------- -------- + PSGallery https://www.powershellgallery.com/api/v2 False 50 + PoshTestGallery https://www.poshtestgallery.com/api/v2 False 50 + +PS C:\> $arrayOfHashtables = @{Name = "PSGallery"; Trusted = $True}, @{Name = "PoshTestGallery"; Uri = "c:/code/testdir"} + +PS C:\> Set-PSResourceRepository -Repository $arrayOfHashtables -PassThru + Name Uri Trusted Priority + ---- --- ------- -------- + PSGallery https://www.powershellgallery.com/api/v2 True 50 + PoshTestGallery file:///c:/code/testdir False 50 - {{ Add example description here }} + This example first checks for all registered repositories. We wish to set the properties for multiple repositories at once (i.e the PSGallery and PoshTestGallery repositories), so we run Set-PSResourceRepository with the `-Repository` parameter. This parameter takes an array of hashtables, where each hashtable contains information for a repository we wish to set information for. We also use the `-PassThru` parameter to see the changed repositories. - - - <add> - - - + @@ -3361,20 +3057,20 @@ Uninstall PSResource - {{ Fill in the Synopsis }} + Uninstalls a resource (module or script) that has been installed on the machine via PowerShellGet. - {{ Fill in the Description }} + The Uninstall-PSResource cmdlet combines the Uninstall-Module, Uninstall-Script cmdlets from V2. It uninstalls a package found in a module or script installation path based on the -Name parameter argument. It does not return an object. Other parameters allow the returned results to be further filtered. Uninstall-PSResource - + Name - - {{ Fill Name Description }} - + + Name of a resource or resources that has been installed. Accepts wild card characters. + System.String[] System.String[] @@ -3382,56 +3078,62 @@ None - - Force - - {{ Fill Force Description }} - + + Version + + Specifies the version of the resource to be uninstalled. + + System.String - System.Management.Automation.SwitchParameter + System.String - False + None - PrereleaseOnly - - {{ Fill PrereleaseOnly Description }} - + Scope + + Specifies the scope of the resource to uninstall. + + + CurrentUser + AllUsers + + Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType - System.Management.Automation.SwitchParameter + Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType - False + None - Version - - {{ Fill Version Description }} - - System.String + SkipDependencyCheck + + Skips check to see if other resources are dependent on the resource being uninstalled. + - System.String + System.Management.Automation.SwitchParameter - None + False - - Confirm - - Prompts you for confirmation before running the cmdlet. - + + InputObject + + Used for pipeline input. + + Microsoft.PowerShell.PowerShellGet.UtilClasses.PSResourceInfo - System.Management.Automation.SwitchParameter + Microsoft.PowerShell.PowerShellGet.UtilClasses.PSResourceInfo - False + None WhatIf - + Shows what would happen if the cmdlet runs. The cmdlet is not run. - + System.Management.Automation.SwitchParameter @@ -3441,35 +3143,47 @@ - - Force - - {{ Fill Force Description }} - - System.Management.Automation.SwitchParameter + + Name + + Name of a resource or resources that has been installed. Accepts wild card characters. + + System.String[] - System.Management.Automation.SwitchParameter + System.String[] - False + None + + + Version + + Specifies the version of the resource to be uninstalled. + + System.String + + System.String + + + None - - Name - - {{ Fill Name Description }} - - System.String[] + + Scope + + Specifies the scope of the resource to uninstall. + + Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType - System.String[] + Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType None - PrereleaseOnly - - {{ Fill PrereleaseOnly Description }} - + SkipDependencyCheck + + Skips check to see if other resources are dependent on the resource being uninstalled. + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -3477,35 +3191,23 @@ False - - Version - - {{ Fill Version Description }} - - System.String + + InputObject + + Used for pipeline input. + + Microsoft.PowerShell.PowerShellGet.UtilClasses.PSResourceInfo - System.String + Microsoft.PowerShell.PowerShellGet.UtilClasses.PSResourceInfo None - - Confirm - - Prompts you for confirmation before running the cmdlet. - - System.Management.Automation.SwitchParameter - - System.Management.Automation.SwitchParameter - - - False - WhatIf - + Shows what would happen if the cmdlet runs. The cmdlet is not run. - + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -3514,26 +3216,8 @@ False - - - - System.String[] - - - - - - - - - - System.Object - - - - - - + + @@ -3542,18 +3226,41 @@ -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} + PS C:\> Uninstall-PSResource Az + + Uninstalls the latest version of the Az module. + + + + -------------------------- Example 2 -------------------------- + PS C:\> Uninstall-PSResource -name Az -version "1.0.0" + + Uninstalls version 1.0.0 of the Az module. + + + + -------------------------- Example 3 -------------------------- + PS C:\> Uninstall-PSResource -name Az -version "(1.0.0, 3.0.0)" + + Uninstalls all versions within the specified version range. + + + + -------------------------- Example 4 -------------------------- + PS C:\> Uninstall-PSResource -name Az -version "[4.0.1, 4.1.0]" + + Assume that the following versions are already installed for package Az: 4.0.1-preview, 4.1.0, 4.0.2-preview installed, this will uninstall all versions (stable and prerelease) which fall within the specified version range. Per NuGetVersion rules, a prerelease version is less than a stable version, so 4.0.1-preview is actually less than the 4.0.1 specified version so 4.0.1-preview does not fall within the specified version range and won't be removed. Versions 4.1.0 and 4.0.2-preview do fall in the range and will both be removed. + + + + -------------------------- Example 4 -------------------------- + PS C:\> Uninstall-PSResource -name Az -version "[4.0.1, 4.1.0]" -Prerelease - {{ Add example description here }} + Assume that the following versions are already installed for package Az: 4.0.1-preview, 4.1.0, 4.0.2-preview installed. This is the same example as above, except the added `-Prerelease` parameter means only prerelease versions which fall within this range will be removed. Again, per NuGetVersion rules, a prerelease version is less than a stable version, so 4.0.1-preview is actually less than the 4.0.1 specified version. Therefore 4.0.1-preview does not fall within the specified version range and won't be removed. Version 4.1.0 does fall in range however it is not a prerelease version so it will remain installed. Version 4.0.2-preview does fall in the range and is prerelease so it will be removed. - - - <add> - - - + @@ -3561,45 +3268,56 @@ Unregister PSResourceRepository - {{ Fill in the Synopsis }} + Un-registers a repository from the repository store. - {{ Fill in the Description }} + The Unregister-PSResourceRepository cmdlet unregisters a repository. Unregister-PSResourceRepository Name - - {{ Fill Name Description }} - - System.String[] + + This parameter takes a String argument, or an array of String arguments. It is the name of the repository to un-register. + + String[] - System.String[] + String[] None + + PassThru + + Passes the resource installed to the console. + + + SwitchParameter + + + False + Confirm - + Prompts you for confirmation before running the cmdlet. - + - System.Management.Automation.SwitchParameter + SwitchParameter False WhatIf - + Shows what would happen if the cmdlet runs. The cmdlet is not run. - + - System.Management.Automation.SwitchParameter + SwitchParameter False @@ -3609,36 +3327,48 @@ Name - - {{ Fill Name Description }} - - System.String[] + + This parameter takes a String argument, or an array of String arguments. It is the name of the repository to un-register. + + String[] - System.String[] + String[] None + + PassThru + + Passes the resource installed to the console. + + SwitchParameter + + SwitchParameter + + + False + Confirm - + Prompts you for confirmation before running the cmdlet. - - System.Management.Automation.SwitchParameter + + SwitchParameter - System.Management.Automation.SwitchParameter + SwitchParameter False WhatIf - + Shows what would happen if the cmdlet runs. The cmdlet is not run. - - System.Management.Automation.SwitchParameter + + SwitchParameter - System.Management.Automation.SwitchParameter + SwitchParameter False @@ -3654,16 +3384,7 @@ - - - - System.Object - - - - - - + @@ -3672,18 +3393,34 @@ -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} + PS C:\> Get-PSResourceRepository -Name "PoshTestGallery" +PS C:\> Unregister-PSResourceRepository -Name "PoshTestGallery" +PS C:\> Get-PSResourceRepository -Name "PoshTestGallery" +PS C:\> + + In this example, we assume the repository "PoshTestGallery" has been previously registered. So when we first run the command to find "PoshTestGallery" it verifies that this repository can be found. Next, we run the command to unregister "PoshTestGallery". Finally, we again run the command to find "PoshTestGallery" but since it was successfully un-registered it cannot be found or retrieved. + + + + -------------------------- Example 2 -------------------------- + PS C:\> Get-PSResourceRepository + Name Uri Trusted Priority + ---- --- ------- -------- + PoshTestGallery https://www.poshtestgallery.com/api/v2 True 40 + PSGallery https://www.powershellgallery.com/api/v2 False 50 + psgettestlocal file:///c:/code/testdir True 50 + +PS C:\> Unregister-PSResourceRepository -Name "PoshTestGallery","psgettestlocal" +PS C:\> Get-PSResourceRepository + Name Uri Trusted Priority + ---- --- ------- -------- + PSGallery https://www.powershellgallery.com/api/v2 False 50 - {{ Add example description here }} + In this example, the command to find all registered repositories is run and the repositories found are displayed. Next, the command to un-register is run with a list of names ("PoshTestGallery", "psgettestlocal") provided for the `-Name` parameter. Finally, the command to find all registered repositories is run again, but this time we can see that "PoshTestGallery" and "psgettestlocal" are not found and displayed as they have been successfully unregistered. - - - <add> - - - + @@ -3691,43 +3428,43 @@ Update PSResource - {{ Fill in the Synopsis }} + Updates a package already installed on the user's machine. - {{ Fill in the Description }} + The Update-PSResource cmdlet replaces the Update-Module and Update-Script cmdlets from V2. It updates an already installed package based on the `-Name` parameter argument. It does not return an object. Other parameters allow the package to be updated to be further filtered. Update-PSResource - + Name - - {{ Fill Name Description }} - + + Specifies name of a resource or resources to update. + System.String[] System.String[] - None + "*" AcceptLicense - - {{ Fill AcceptLicense Description }} - + + For resources that require a license, AcceptLicense automatically accepts the license agreement during the update. + System.Management.Automation.SwitchParameter False - + Credential - - {{ Fill Credential Description }} - + + Specifies optional credentials to be used when accessing a private repository. + System.Management.Automation.PSCredential System.Management.Automation.PSCredential @@ -3735,22 +3472,11 @@ None - - NoClobber - - {{ Fill NoClobber Description }} - - - System.Management.Automation.SwitchParameter - - - False - Prerelease - - {{ Fill Prerelease Description }} - + + When specified, allows updating to a prerelease version. + System.Management.Automation.SwitchParameter @@ -3759,9 +3485,9 @@ Quiet - - {{ Fill Quiet Description }} - + + Supresses progress information. + System.Management.Automation.SwitchParameter @@ -3770,9 +3496,9 @@ Repository - - {{ Fill Repository Description }} - + + Specifies one or more repository names to update packages from. If not specified, search for packages to update will include all currently registered repositories in order of highest priority. + System.String[] System.String[] @@ -3782,25 +3508,25 @@ Scope - - {{ Fill Scope Description }} - + + Specifies the scope of the resource to update. + CurrentUser AllUsers - System.String + Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType - System.String + Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType None TrustRepository - - {{ Fill TrustRepository Description }} - + + Specifies optional credentials to be used when accessing a private repository. + System.Management.Automation.SwitchParameter @@ -3809,9 +3535,10 @@ Version - - {{ Fill Version Description }} - + + Specifies the version of the resource to be updated to. The value can be an exact version or a version range using the NuGet versioning syntax. + For more information about NuGet version ranges, see Package versioning (/nuget/concepts/package-versioning#version-ranges)PowerShellGet supports all but the minimum inclusive version listed in the NuGet version range documentation. So inputting "1.0.0.0" as the version doesn't yield versions 1.0.0.0 and higher (minimum inclusive range). Instead, the values is considered as the required version and yields version 1.0.0.0 only (required version). To use the minimum inclusive range, provide `[1.0.0.0, ]` as the version range. + System.String System.String @@ -3819,11 +3546,55 @@ None + + Force + + When specified, bypasses checks for TrustRepository and AcceptLicense and updates the package. + + + System.Management.Automation.SwitchParameter + + + False + + + PassThru + + Passes the resource updated to the console. + + + System.Management.Automation.SwitchParameter + + + False + + + AuthenticodeCheck + + Does a check to to validate signed files and catalog files on Windows. + + + System.Management.Automation.SwitchParameter + + + False + + + SkipdependencyCheck + + Skips the check for resource dependencies, so that only found resources are updated, and not any resources the found resource depends on. + + + System.Management.Automation.SwitchParameter + + + False + Confirm - + Prompts you for confirmation before running the cmdlet. - + System.Management.Automation.SwitchParameter @@ -3832,9 +3603,9 @@ WhatIf - + Shows what would happen if the cmdlet runs. The cmdlet is not run. - + System.Management.Automation.SwitchParameter @@ -3846,9 +3617,9 @@ AcceptLicense - - {{ Fill AcceptLicense Description }} - + + For resources that require a license, AcceptLicense automatically accepts the license agreement during the update. + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -3856,11 +3627,11 @@ False - + Credential - - {{ Fill Credential Description }} - + + Specifies optional credentials to be used when accessing a private repository. + System.Management.Automation.PSCredential System.Management.Automation.PSCredential @@ -3868,35 +3639,23 @@ None - + Name - - {{ Fill Name Description }} - + + Specifies name of a resource or resources to update. + System.String[] System.String[] - None - - - NoClobber - - {{ Fill NoClobber Description }} - - System.Management.Automation.SwitchParameter - - System.Management.Automation.SwitchParameter - - - False + "*" Prerelease - - {{ Fill Prerelease Description }} - + + When specified, allows updating to a prerelease version. + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -3906,9 +3665,9 @@ Quiet - - {{ Fill Quiet Description }} - + + Supresses progress information. + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -3918,9 +3677,9 @@ Repository - - {{ Fill Repository Description }} - + + Specifies one or more repository names to update packages from. If not specified, search for packages to update will include all currently registered repositories in order of highest priority. + System.String[] System.String[] @@ -3930,21 +3689,21 @@ Scope - - {{ Fill Scope Description }} - - System.String + + Specifies the scope of the resource to update. + + Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType - System.String + Microsoft.PowerShell.PowerShellGet.UtilClasses.ScopeType None TrustRepository - - {{ Fill TrustRepository Description }} - + + Specifies optional credentials to be used when accessing a private repository. + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -3954,9 +3713,10 @@ Version - - {{ Fill Version Description }} - + + Specifies the version of the resource to be updated to. The value can be an exact version or a version range using the NuGet versioning syntax. + For more information about NuGet version ranges, see Package versioning (/nuget/concepts/package-versioning#version-ranges)PowerShellGet supports all but the minimum inclusive version listed in the NuGet version range documentation. So inputting "1.0.0.0" as the version doesn't yield versions 1.0.0.0 and higher (minimum inclusive range). Instead, the values is considered as the required version and yields version 1.0.0.0 only (required version). To use the minimum inclusive range, provide `[1.0.0.0, ]` as the version range. + System.String System.String @@ -3964,11 +3724,59 @@ None + + Force + + When specified, bypasses checks for TrustRepository and AcceptLicense and updates the package. + + System.Management.Automation.SwitchParameter + + System.Management.Automation.SwitchParameter + + + False + + + PassThru + + Passes the resource updated to the console. + + System.Management.Automation.SwitchParameter + + System.Management.Automation.SwitchParameter + + + False + + + AuthenticodeCheck + + Does a check to to validate signed files and catalog files on Windows. + + System.Management.Automation.SwitchParameter + + System.Management.Automation.SwitchParameter + + + False + + + SkipdependencyCheck + + Skips the check for resource dependencies, so that only found resources are updated, and not any resources the found resource depends on. + + System.Management.Automation.SwitchParameter + + System.Management.Automation.SwitchParameter + + + False + Confirm - + Prompts you for confirmation before running the cmdlet. - + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -3978,9 +3786,9 @@ WhatIf - + Shows what would happen if the cmdlet runs. The cmdlet is not run. - + System.Management.Automation.SwitchParameter System.Management.Automation.SwitchParameter @@ -3998,25 +3806,8 @@ - - - System.Management.Automation.PSCredential - - - - - - - - - System.Object - - - - - - + @@ -4025,9 +3816,20 @@ -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} + PS C:\> Update-PSResource -Name "TestModule" + Name Version Prerelease Description + ---- ------- ---------- ----------- + TestModule 1.2.0 test + +PS C:\> Update-PSResource -Name "TestModule" + +PS C:\> Update-PSResource -Name "TestModule" + Name Version Prerelease Description + ---- ------- ---------- ----------- + TestModule 1.3.0 test + TestModule 1.2.0 test - {{ Add example description here }} + In this example, the user already has the TestModule package installed and they update the package. Update-PSResource will install the latest version of the package without deleting the older version installed. From d020296d165d124c2d91c79fdb497f1b8cf6f43f Mon Sep 17 00:00:00 2001 From: Sydney Smith <43417619+SydneyhSmith@users.noreply.github.com> Date: Mon, 23 May 2022 10:42:09 -0700 Subject: [PATCH 16/22] Update Get-PSResource.md --- help/Get-PSResource.md | 1 + 1 file changed, 1 insertion(+) diff --git a/help/Get-PSResource.md b/help/Get-PSResource.md index cc79f9213..8d5384e0a 100644 --- a/help/Get-PSResource.md +++ b/help/Get-PSResource.md @@ -145,6 +145,7 @@ Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: Falsef +``` ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). From 8e163689fb94adadc0d3d05e686388b66682f34f Mon Sep 17 00:00:00 2001 From: Sydney Smith <43417619+SydneyhSmith@users.noreply.github.com> Date: Mon, 23 May 2022 10:42:22 -0700 Subject: [PATCH 17/22] Update Get-PSResource.md --- help/Get-PSResource.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/help/Get-PSResource.md b/help/Get-PSResource.md index 8d5384e0a..23df4b701 100644 --- a/help/Get-PSResource.md +++ b/help/Get-PSResource.md @@ -144,7 +144,7 @@ Required: False Position: Named Default value: None Accept pipeline input: False -Accept wildcard characters: Falsef +Accept wildcard characters: False ``` ### CommonParameters From a150a8d58318a150323f8d87dfd3e0ffddd022f4 Mon Sep 17 00:00:00 2001 From: Sydney Smith <43417619+SydneyhSmith@users.noreply.github.com> Date: Mon, 23 May 2022 10:43:26 -0700 Subject: [PATCH 18/22] Update Install-PSResource.md --- help/Install-PSResource.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/help/Install-PSResource.md b/help/Install-PSResource.md index 0b4274322..7ff060471 100644 --- a/help/Install-PSResource.md +++ b/help/Install-PSResource.md @@ -400,7 +400,8 @@ Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False - +``` + ### -PassThru Passes the resource installed to the console. From ef930d8a0f0ecf4230a92d24f77ad9d13640ae49 Mon Sep 17 00:00:00 2001 From: Sydney Smith <43417619+SydneyhSmith@users.noreply.github.com> Date: Mon, 23 May 2022 10:46:10 -0700 Subject: [PATCH 19/22] Update Update-PSResource.md --- help/Update-PSResource.md | 1 + 1 file changed, 1 insertion(+) diff --git a/help/Update-PSResource.md b/help/Update-PSResource.md index 62d2e6a78..1471e002a 100644 --- a/help/Update-PSResource.md +++ b/help/Update-PSResource.md @@ -234,6 +234,7 @@ Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False +``` ### -SkipdependencyCheck Skips the check for resource dependencies, so that only found resources are updated, and not any resources the found resource depends on. From 47dcfe0d4d327c50ff835a914b6404894dbd4529 Mon Sep 17 00:00:00 2001 From: Sydney Smith <43417619+SydneyhSmith@users.noreply.github.com> Date: Tue, 24 May 2022 13:29:38 -0700 Subject: [PATCH 20/22] Update Install-PSResource.md --- help/Install-PSResource.md | 16 +--------------- 1 file changed, 1 insertion(+), 15 deletions(-) diff --git a/help/Install-PSResource.md b/help/Install-PSResource.md index 7ff060471..042e305b8 100644 --- a/help/Install-PSResource.md +++ b/help/Install-PSResource.md @@ -16,7 +16,7 @@ Installs resources (modules and scripts) from a registered repository onto the m ``` Install-PSResource [-Name ] [-Version ] [-Prerelease] [-Repository ] [-Credential ] [-Scope ] [-TrustRepository] - [-Reinstall] [-Quiet] [-AcceptLicense] [-NoClobber] [-SkipDependencyCheck] [-AuthenticodeCheck] [-PassThru] [-WhatIf] [-Confirm] [] + [-Reinstall] [-Quiet] [-AcceptLicense] [-NoClobber] [-SkipDependencyCheck] [-PassThru] [-WhatIf] [-Confirm] [] ``` ### InputObjectParameterSet @@ -381,20 +381,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -AuthenticodeCheck -Does a check to to validate signed files and catalog files on Windows. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None From bb5beeb01e9c4a5464c9f27cea73b5478a9df0e4 Mon Sep 17 00:00:00 2001 From: Sydney Smith <43417619+SydneyhSmith@users.noreply.github.com> Date: Tue, 24 May 2022 13:30:17 -0700 Subject: [PATCH 21/22] Update Save-PSResource.md --- help/Save-PSResource.md | 17 ++--------------- 1 file changed, 2 insertions(+), 15 deletions(-) diff --git a/help/Save-PSResource.md b/help/Save-PSResource.md index 4071ae0ea..2809af983 100644 --- a/help/Save-PSResource.md +++ b/help/Save-PSResource.md @@ -15,7 +15,7 @@ Saves resources (modules and scripts) from a registered repository onto the mach ### NameParameterSet ``` Save-PSResource [-Name] [-Version ] [-Prerelease] [-Repository ] - [-Credential ] [-AsNupkg] [-IncludeXML] [-Path ] [-TrustRepository] [-SkipDependencyCheck] [-AuthenticodeCheck] [-PassThru] [-Quiet] [-WhatIf] [-Confirm] [] + [-Credential ] [-AsNupkg] [-IncludeXML] [-Path ] [-TrustRepository] [-SkipDependencyCheck] [-PassThru] [-Quiet] [-WhatIf] [-Confirm] [] ``` ### InputObjectParameterSet @@ -199,20 +199,7 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` - ### -AuthenticodeCheck -Does a check to to validate signed files and catalog files on Windows. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False - + ### -PassThru Passes the resource saved to the console. From 1cee1c5079591255c5dcf57a9f380b43194019dc Mon Sep 17 00:00:00 2001 From: Sydney Smith <43417619+SydneyhSmith@users.noreply.github.com> Date: Tue, 24 May 2022 13:31:03 -0700 Subject: [PATCH 22/22] Update Update-PSResource.md --- help/Update-PSResource.md | 16 +--------------- 1 file changed, 1 insertion(+), 15 deletions(-) diff --git a/help/Update-PSResource.md b/help/Update-PSResource.md index 1471e002a..167a60673 100644 --- a/help/Update-PSResource.md +++ b/help/Update-PSResource.md @@ -15,7 +15,7 @@ Updates a package already installed on the user's machine. ### NameParameterSet (Default) ``` Update-PSResource [-Name] [-Version ] [-Prerelease] [-Repository ] - [-Scope ] [-TrustRepository] [-Credential ] [-Quiet] [-AcceptLicense] [-Force] [-PassThru] [-AuthenticodeCheck] [-SkipDependencyCheck] [-WhatIf] [-Confirm] [] + [-Scope ] [-TrustRepository] [-Credential ] [-Quiet] [-AcceptLicense] [-Force] [-PassThru] [-SkipDependencyCheck] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -215,20 +215,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -AuthenticodeCheck -Does a check to to validate signed files and catalog files on Windows. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None