Get-BicepMetadata.md

external help file	Module Name	online version	schema
Bicep-help.xml	Bicep		2.0.0

Get-BicepMetadata

SYNOPSIS

Get metadata from a Bicep template

SYNTAX

Get-BicepMetadata [-Path] <String> [[-OutputType] <String>] [-IncludeReservedMetadata]
 [<CommonParameters>]

DESCRIPTION

Get metadata from a Bicep template

EXAMPLES

Example 1 - Get metadata from Bicep file

Get-BicepMetadata -Path .\myTemplate.bicep

Get metadata from Bicep file

Example 2 - Get metadata from Bicep file and output as Json

Get-BicepMetadata -Path .\myTemplate.bicep -OutputType Json

Get metadata from Bicep file and output as json

Example 3 - Get metadata from Bicep file and output as hashtable

Get-BicepMetadata -Path .\myTemplate.bicep -OutputType Hashtable

Get metadata from Bicep file and output as hashtable

Example 4 - Get metadata from Bicep file and include reserved metadata

Get-BicepMetadata -Path .\myTemplate.bicep -IncludeReservedMetadata

Get metadata from Bicep file and include Bicep reserved metadata

PARAMETERS

-IncludeReservedMetadata

Include Bicep reserved metadata

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-OutputType

Specify output type

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: PSObject, Json, Hashtable

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

-Path

Path to Bicep file

Type: String
Parameter Sets: (All)
Aliases: PSPath

Required: True
Position: 0
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

None

OUTPUTS

System.Object

NOTES

RELATED LINKS