-
Notifications
You must be signed in to change notification settings - Fork 41
Update docs for 1.1.0-rc1 release #164
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
cee0044
Update docs for 1.1.0-rc1 release
sdwheeler 7b72c9a
Add new parameters to Save-PSResource
sdwheeler e64c0e3
fix metadata
sdwheeler c7c9ef8
Update powershell-gallery/docs-conceptual/powershellget/psresourceget…
sdwheeler d156f03
Update powershell-gallery/docs-conceptual/powershellget/psresourceget…
sdwheeler File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
109 changes: 109 additions & 0 deletions
109
....x/Microsoft.PowerShell.PSResourceGet/About/about_PSResourceGet_Group_Policy.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| --- | ||
| description: Describes the Group Policy settings for PowerShell | ||
| Locale: en-US | ||
| ms.custom: 1.1.0-rc1 | ||
| ms.date: 10/22/2024 | ||
| online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_psresourceget_group_policy?view=powershellget-3.x&WT.mc_id=ps-gethelp | ||
| schema: 2.0.0 | ||
| title: about_PSResourceGet_Group_Policy | ||
| --- | ||
| # about_PSResourceGet_Group_Policy | ||
|
|
||
| ## Short description | ||
|
|
||
| Describes the Group Policy settings for the PSResourceGet module. | ||
|
|
||
| ## Long description | ||
|
|
||
| **Microsoft.PowerShell.PSResourceGet** includes a Group Policy to specify a | ||
| list of repositories that can be accessed by the module. All other repositories | ||
| are blocked. | ||
|
|
||
| Support for Group Policy was added in **Microsoft.PowerShell.PSResourceGet** | ||
| v1.1.0-rc1. | ||
|
|
||
| The PowerShell Group Policy settings are in the following Group Policy path: | ||
|
|
||
| ``` | ||
| User Configuration\ | ||
| Administrative Templates\ | ||
| PSResourceGet Repository Policies | ||
| ``` | ||
|
|
||
| There is no computer configuration path for these settings. | ||
|
|
||
| **Microsoft.PowerShell.PSResourceGet** includes Group Policy templates and an | ||
| installation script in module install location. | ||
|
|
||
| Group Policy tools use administrative template files (`.admx`, `.adml`) to | ||
| populate policy settings in the user interface. This allows administrators to | ||
| manage registry-based policy settings. To install the administrative template, | ||
| run the `InstallPSResourceGetPolicyDefinitions.ps1` script from an elevated | ||
| PowerShell session. The following example shows the location of the script and | ||
| template files. | ||
|
|
||
| ```powershell | ||
| $modulePath = Split-Path (Get-Module -Name Microsoft.PowerShell.PSResourceGet).Path | ||
| Get-ChildItem -Path $modulePath\*.adm*, $modulePath\*.ps1 | ||
| ``` | ||
|
|
||
| ```Output | ||
| Directory: C:\Program Files\PowerShell\Modules\Microsoft.PowerShell.PSResourceGet\1.1.0 | ||
|
|
||
| Mode LastWriteTime Length Name | ||
| ---- ------------- ------ ---- | ||
| -a--- 10/22/2024 3:48 PM 1364 PSResourceRepository.adml | ||
| -a--- 10/22/2024 3:48 PM 1839 PSResourceRepository.admx | ||
| -a--- 10/22/2024 3:48 PM 2869 InstallPSResourceGetPolicyDefinitions.ps1 | ||
| ``` | ||
|
|
||
| After installing the templates, you can edit these settings in the Group Policy | ||
| Editor (`gpedit.msc`). | ||
|
|
||
| ## Configure a list of allowed repositories | ||
|
|
||
| There is only one setting for the **PSResourceGet Repository Policies** Group | ||
| Policy. | ||
|
|
||
| 1. Open the Group Policy Editor (`gpedit.msc`) | ||
| 1. Locate the policy under **User configuration** -> **Administrative | ||
| Templates** -> **Windows Components** -> **PSResourceGet Repository | ||
| Policies** | ||
| 1. Open the **PSResourceGet Repository Policy** setting | ||
| 1. Select **Enabled** | ||
| 1. Select **Show** | ||
| 1. Add repository in the format: | ||
| `Name=PSGallery;Uri=https://www.powershellgallery.com/api/v2` | ||
|
|
||
| > [!NOTE] | ||
| > Don't use quote characters around the values. Separate the key-value pairs | ||
| > with a semicolon (`;`) only. | ||
|
|
||
| You may add as may repositories as you like, each on their own line. | ||
|
|
||
| > [!CAUTION] | ||
| > If you enable the policy without defining any repositories then no | ||
| > repositories are allowed, effectively disabling | ||
| > **Microsoft.PowerShell.PSResourceGet** module. | ||
|
|
||
| ## Determine the affect of Group Policy | ||
|
|
||
| Once you have applied the Group Policy setting, the PSResourceGet commands that | ||
| communicate with repositories check the policy before attempting to access the | ||
| repository. If the a specified repository isn't in the allow list, you receive | ||
| and error message similar to: | ||
|
|
||
| > Repository 'RepoName' is not allowed by Group Policy. | ||
|
|
||
| Adding repositories to the allow list doesn't register them for the user. You | ||
| must use add the repositories using the `Register-PSResourceRepository` cmdlet. | ||
| The `Register-PSResourceRepository` cmdlet doesn't access the repository at | ||
| registration time. You won't receive an error if the repository isn't in the | ||
| allow list until you try to access the repository. | ||
|
|
||
| You can use the following command to determine the repositories that are | ||
| allowed by Group Policy: | ||
|
|
||
| ```powershell | ||
| Get-PSResourceRepository | Where-Object { $_.IsAllowedByPolicy } | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...gallery/powershellget-3.x/Microsoft.PowerShell.PSResourceGet/Find-PSResource.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...powershellget-3.x/Microsoft.PowerShell.PSResourceGet/Get-InstalledPSResource.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...owershellget-3.x/Microsoft.PowerShell.PSResourceGet/Get-PSResourceRepository.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...ry/powershellget-3.x/Microsoft.PowerShell.PSResourceGet/Get-PSScriptFileInfo.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
.../powershellget-3.x/Microsoft.PowerShell.PSResourceGet/Import-PSGetRepository.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...lery/powershellget-3.x/Microsoft.PowerShell.PSResourceGet/Install-PSResource.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...ry/powershellget-3.x/Microsoft.PowerShell.PSResourceGet/New-PSScriptFileInfo.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...lery/powershellget-3.x/Microsoft.PowerShell.PSResourceGet/Publish-PSResource.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...hellget-3.x/Microsoft.PowerShell.PSResourceGet/Register-PSResourceRepository.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.