Skip to content

Latest commit

 

History

History
296 lines (233 loc) · 6.62 KB

Build-Bicep.md

File metadata and controls

296 lines (233 loc) · 6.62 KB
Raw
external help file Module Name online version schema
Bicep-help.xml
Bicep
2.0.0

Build-Bicep

SYNOPSIS

Builds one or more .bicep files.

SYNTAX

Default (Default)

Build-Bicep [[-Path] <String>] [[-OutputDirectory] <String>] [-ExcludeFile <String[]>]
 [-GenerateAllParametersFile] [-GenerateRequiredParametersFile] [-NoRestore] [-Compress]
 [-WhatIf] [-Confirm] [<CommonParameters>]

OutputPath

Build-Bicep [[-Path] <String>] [[-OutputPath] <String>] [-ExcludeFile <String[]>] [-GenerateAllParametersFile]
 [-GenerateRequiredParametersFile] [-NoRestore] [-Compress] [-WhatIf]
 [-Confirm] [<CommonParameters>]

AsHashtable

Build-Bicep [[-Path] <String>] [-ExcludeFile <String[]>] [-AsHashtable] [-NoRestore]
 [-WhatIf] [-Confirm] [<CommonParameters>]

AsString

Build-Bicep [[-Path] <String>] [-ExcludeFile <String[]>] [-AsString] [-NoRestore]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Build-Bicep is equivalent to the Bicep CLI command 'bicep build' but with some additional features.

  • Compile all files in a directory
  • Generate ARM Template Parameter files
  • Output ARM Template directly as string or hashtable without writing to file

Any error or warning from bicep will be written to the information stream. To save output in a variable, use stream redirection. See example below.

EXAMPLES

Example 1: Compile single bicep file in working directory

Build-Bicep -Path vnet.bicep

Example 2: Compile single bicep file and specify the output directory

Build-Bicep -Path 'c:\bicep\modules\vnet.bicep' -OutputDirectory 'c:\armtemplates\vnet.json'

Example 3: Compile all .bicep files in a directory

Build-Bicep -Path 'c:\bicep\modules\'

Example 4: Compile all .bicep files in the working directory except vnet.bicep

Build-Bicep -Path 'c:\bicep\modules\' -ExcludeFile vnet.bicep

Example 5: Compile a .bicep file and output as string

Build-Bicep -Path '.\vnet.bicep' -AsString

Example 6: Compile a .bicep files in the working directory and generate a parameter file with all parameters

Build-Bicep -Path '.\vnet.bicep' -GenerateAllParametersFile

Example 7: Compile a .bicep file as hashtable and pass it to New-AzResourceGroupDeployment

$Template=Build-Bicep -Path '.\vnet.bicep' -AsHashtable
New-AzResourceGroupDeployment -ResourceGroupName vnet-rg -TemplateObject $Template

Example 8: Compiles single bicep file and saves the output as the specified file path.

Build-Bicep -Path 'c:\bicep\modules\vnet.bicep' -OutputPath 'c:\armtemplates\newvnet.json'

Example 9: Compile a .bicep file without restoring dependant modules

Build-Bicep -Path '.\main.bicep' -NoRestore

Example 10: Compile a .bicep file and compress the outputted ARM Json

Build-Bicep -Path '.\main.bicep' -Compress

PARAMETERS

-AsHashtable

The -AsHashtable prints all output as a hashtable instead of corresponding files.

Type: SwitchParameter
Parameter Sets: AsHashtable
Aliases:

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

-AsString

The -AsString prints all output as a string instead of corresponding files.

Type: SwitchParameter
Parameter Sets: AsString
Aliases:

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

-Compress

Compress the built ARM Template to reduce file size

Type: SwitchParameter
Parameter Sets: Default, OutputPath
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.

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

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

-ExcludeFile

Specifies a .bicep file to exclude from compilation

Type: String[]
Parameter Sets: (All)
Aliases:

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

-GenerateAllParametersFile

Generate an ARM template parameter file with all parameters from the bicep file.

Type: SwitchParameter
Parameter Sets: Default, OutputPath
Aliases:

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

-GenerateRequiredParametersFile

Generate an ARM template parameter file with the required parameters from the bicep file.

Type: SwitchParameter
Parameter Sets: Default, OutputPath
Aliases:

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

-NoRestore

Skips trying to restore dependent modules

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-OutputDirectory

Specifies the target directory where the compiled files should be created

Type: String
Parameter Sets: Default
Aliases:

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

-OutputPath

Specify the filename of the generated ARM template.

Type: String
Parameter Sets: OutputPath
Aliases:

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

-Path

Specfies the path to the directory or file that should be compiled

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: $pwd.path
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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Go to module repository https://github.com/PSBicep/PSBicep for detailed info, reporting issues and to submit contributions.

RELATED LINKS