Skip to content

Latest commit

 

History

History
111 lines (85 loc) · 2.23 KB

New-PsDscVsCodeSettingsFile.md

File metadata and controls

111 lines (85 loc) · 2.23 KB
external help file GeneratedBy Module Name online version schema
PSDSC-help.xml
Sampler update_help_source task
PSDSC
2.0.0

New-PsDscVsCodeSettingsFile

SYNOPSIS

Simple function to add schema definitions to VSCode settings file.

SYNTAX

New-PsDscVsCodeSettingsFile [[-Path] <Object>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

The function New-PsDscVsCodeSettingsFile adds schema definitions to the 'settings.json' file to help author DSC Configuration Documents.

EXAMPLES

EXAMPLE 1

New-PsDscVsCodeSettingsFile

EXAMPLE 2

New-PsDscVsCodeSettingsFile -Path customsettingsfile.json

PARAMETERS

-Path

The path to the VSCode settings file. Defaults to $Home\AppData\Roaming\Code\User\settings.json

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: "$Home\AppData\Roaming\Code\User\settings.json"
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
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.

INPUTS

OUTPUTS

System.String

NOTES

For more details, go to module repository at: https://github.com/Gijsreyn/PSDSC.

RELATED LINKS