en-US/Bicep/PSBicep.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?> <helpItems xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" schema="maml" xmlns="http://msh"> <command:command> <command:details> <command:name>Get-BicepApiVersion</command:name> <maml:description> <maml:para>Retrieve the API version for a Bicep resource type.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>BicepApiVersion</command:noun> </command:details> <maml:description> <maml:para>Retrieve the API version for a specified Bicep resource type. This command helps identify which API versions are available for a given resource, allowing you to target specific or latest API versions in your Bicep templates.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-BicepApiVersion</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AvoidPreview</maml:name> <maml:description> <maml:para>When specified, excludes preview API versions from the results, returning only stable/general availability (GA) versions.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>The Bicep resource type to get the API version for (e.g., Microsoft.Compute/virtualMachines).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>The number of results to skip. Useful for pagination when there are many API versions available.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AvoidPreview</maml:name> <maml:description> <maml:para>When specified, excludes preview API versions from the results, returning only stable/general availability (GA) versions.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>The Bicep resource type to get the API version for (e.g., Microsoft.Compute/virtualMachines).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>The number of results to skip. Useful for pagination when there are many API versions available.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Int32</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <dev:name>System.String</dev:name> </dev:type> <maml:description> <maml:para>The Bicep resource type string to retrieve API versions for. Accepts pipeline input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <dev:name>System.Object</dev:name> </dev:type> <maml:description> <maml:para>Returns the API version information as an object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This command retrieves available API versions for a Bicep resource type. Use -AvoidPreview to filter out preview versions.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>Get the API version for the Microsoft.Compute/virtualMachines resource type.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Bicep Documentation</maml:linkText> <command:uri>https://learn.microsoft.com/azure/azure-resource-manager/bicep/</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Azure Resource Manager Template Reference</maml:linkText> <command:uri>https://learn.microsoft.com/azure/azure-resource-manager/templates/template-reference</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-BicepConfig</command:name> <maml:description> <maml:para>Get bicep configuration (bicepconfig.json) in use for a bicep file.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>BicepConfig</command:noun> </command:details> <maml:description> <maml:para>Command to get the bicep configuration in use for a specific Bicep file. Will return path to the bicepconfig.json file as well as the current settings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-BicepConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsString</maml:name> <maml:description> <maml:para>Output result as string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Default</maml:name> <maml:description> <maml:para>Returns the default bicep configuration</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-BicepConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsString</maml:name> <maml:description> <maml:para>Output result as string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Local</maml:name> <maml:description> <maml:para>Returns the settings in the local bicepconfig.json file</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to a bicep file</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-BicepConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsString</maml:name> <maml:description> <maml:para>Output result as string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Merged</maml:name> <maml:description> <maml:para>Returns the merged settings from the local bicepconfig.json file and the default settings</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to a bicep file</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-BicepConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsString</maml:name> <maml:description> <maml:para>Output result as string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to a bicep file</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsString</maml:name> <maml:description> <maml:para>Output result as string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Default</maml:name> <maml:description> <maml:para>Returns the default bicep configuration</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Local</maml:name> <maml:description> <maml:para>Returns the settings in the local bicepconfig.json file</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Merged</maml:name> <maml:description> <maml:para>Returns the merged settings from the local bicepconfig.json file and the default settings</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to a bicep file</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <dev:name>System.Object</dev:name> </dev:type> <maml:description> <maml:para>Returns an object containing information about how bicep is configured at specified scope</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 - Get bicep configuration for a bicep file ---------</maml:title> <maml:introduction> <maml:para>Get-BicepConfig -Path .\storage.bicep</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 - Get the merged bicep configuration for a bicep file ---------</maml:title> <maml:introduction> <maml:para>Get-BicepConfig -Path .\storage.bicep -Merged</maml:para> <maml:para>€</maml:para> <maml:para>Returns the path to the bicepconfig.json file in use, and the merged settings (default + local file).</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3 - Get the local bicep configuration for a bicep file ---------</maml:title> <maml:introduction> <maml:para>Get-BicepConfig -Path .\storage.bicep -Merged</maml:para> <maml:para>€</maml:para> <maml:para>Returns the path to the bicepconfig.json file in use, and the settings in the local bicepconfig.json.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 4 - Get the default bicep configuration ---------</maml:title> <maml:introduction> <maml:para>Get-BicepConfig -Default</maml:para> <maml:para>€</maml:para> <maml:para>Returns the default settings.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Build-Bicep</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Format-BicepFile</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-BicepFile</maml:linkText> <command:uri /> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |