| external help file | Module Name | online version | schema |
|---|---|---|---|
Bicep-help.xml |
Bicep |
2.0.0 |
Format one or several Bicep files.
Format-BicepFile [[-Path] <String>] [[-NewlineOption] <String>] [[-IndentKindOption] <String>]
[[-IndentSize] <Int32>] [-InsertFinalNewline] [-WhatIf] [-Confirm]
[<CommonParameters>]
Format-BicepFile [[-Path] <String>] [[-OutputPath] <String>] [[-NewlineOption] <String>]
[[-IndentKindOption] <String>] [[-IndentSize] <Int32>] [-InsertFinalNewline]
[-WhatIf] [-Confirm] [<CommonParameters>]
Format-BicepFile [[-Path] <String>] [[-OutputDirectory] <String>] [[-NewlineOption] <String>]
[[-IndentKindOption] <String>] [[-IndentSize] <Int32>] [-InsertFinalNewline]
[-WhatIf] [-Confirm] [<CommonParameters>]
Format-BicepFile [[-Path] <String>] [[-NewlineOption] <String>] [[-IndentKindOption] <String>]
[[-IndentSize] <Int32>] [-InsertFinalNewline] [-AsString] [-WhatIf]
[-Confirm] [<CommonParameters>]
Format one or several Bicep files.
PS C:\> Format-BicepFile -Path $BicepTemplateFormats a Bicep file.
PS C:\> Format-BicepFile -Path $Directory -OutputDirectory $OtherDirFormats all Bicep files in a folder and outputs the result as other files in another folder.
Outputs the Bicep file(s) as string instead of files.
Type: SwitchParameter
Parameter Sets: AsString
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts 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: FalseThe kind of indentation, spaces or tabs.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe size of indentation.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseWhether or not to insert a final new line in the formatted file(s).
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe newline type for the file.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe directory to output files to.
Type: String
Parameter Sets: OutputDirectory
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe path to output the file to.
Type: String
Parameter Sets: OutputPath
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe path to the file or directory of files to format.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShows 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: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.