-
Notifications
You must be signed in to change notification settings - Fork 205
(#1074) Add docs for Get-ChocolateyConfigValue #1174
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
Draft
vexx32
wants to merge
1
commit into
chocolatey:master
Choose a base branch
from
vexx32:Get-ChocolateyConfigValue.docs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+94
−86
Draft
Changes from all commits
Commits
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
93 changes: 93 additions & 0 deletions
93
src/content/docs/en-us/create/cmdlets/Get-ChocolateyConfigValue.mdx
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,93 @@ | ||
--- | ||
description: Information on Get-ChocolateyConfigValue function | ||
external help file: Chocolatey.PowerShell.dll-Help.xml | ||
Module Name: Chocolatey.PowerShell | ||
online version: | ||
order: 30 | ||
schema: 2.0.0 | ||
title: Get-ChocolateyConfigValue | ||
xref: get-chocolateyconfigvalue | ||
--- | ||
import Xref from '@components/Xref.astro'; | ||
|
||
# Get-ChocolateyConfigValue | ||
|
||
## SYNOPSIS | ||
Retrieves a named configuration value from the Chocolatey Configuration file. | ||
|
||
## SYNTAX | ||
|
||
``` | ||
Get-ChocolateyConfigValue -Name <String> [-IgnoredArguments <Object[]>] [<CommonParameters>] | ||
``` | ||
|
||
## DESCRIPTION | ||
This cmdlet will retrieve the configuration value specified by the `-Name` parameter from the Chocolatey configuration file. | ||
Sensitive configuration values (for example: `proxyPassword`) will remain in encrypted form when retrieved. | ||
|
||
Configuration entries are retrieved by case-insensitive comparison of the name (`key` attribute) in the configuration file. | ||
|
||
## EXAMPLES | ||
|
||
### Example 1 | ||
```powershell | ||
PS C:\> Get-ChocolateyConfigValue -Name cacheLocation | ||
``` | ||
|
||
Outputs the cacheLocation from the Chocolatey configuration file. | ||
|
||
### Example 2 | ||
```powershell | ||
PS C:\> Get-ChocolateyConfigValue -ConfigKey cacheLocation | ||
``` | ||
|
||
Outputs the cacheLocation from the Chocolatey configuration file. | ||
|
||
## PARAMETERS | ||
|
||
### -IgnoredArguments | ||
Allows splatting with arguments that do not apply. Do not use directly. | ||
|
||
```yaml | ||
Type: Object[] | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -Name | ||
The name of the configuration value to retrieve. | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: ConfigKey | ||
|
||
Required: True | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### 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](http://go.microsoft.com/fwlink/?LinkID=113216). | ||
|
||
## OUTPUTS | ||
|
||
### System.String | ||
|
||
## NOTES | ||
|
||
Available in 2.1.0+ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This needs to be updated, right? |
||
|
||
## RELATED LINKS | ||
|
||
<Xref title="Cmdlet Reference" value="powershell-cmdlet-reference" /> | ||
|
||
<Xref title="Function Reference" value="powershell-reference" /> |
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
85 changes: 0 additions & 85 deletions
85
src/content/docs/en-us/create/functions/get-chocolateyconfigvalue.mdx
This file was deleted.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there an alias for
-ConfigKey
, as this is what the previous version of-Name
was.NOTE: I haven't got to the other PR yet 😄
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Never mind, I can see this in play in the example below.