Bicep

3.0.2-preview2

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.String</dev:name>
        </dev:type>
        <maml:description>
          <maml:para>Returns the API version information as a string.</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-BicepChildResourceType</command:name>
      <maml:description>
        <maml:para>Gets available Azure child resource type names from Bicep's type definitions, optionally filtered by resource provider, parent resource type, and child type name. Use `-OutputFullyQualifiedName` to return provider-qualified names.</maml:para>
      </maml:description>
      <command:verb>Get</command:verb>
      <command:noun>BicepChildResourceType</command:noun>
    </command:details>
    <maml:description>
      <maml:para>Queries the Bicep type definitions for child resource types. Provider and parent filters match exactly, while the child filter matches by prefix unless `-ExactMatch` is specified.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-BicepChildResourceType</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none">
          <maml:name>Child</maml:name>
          <maml:description>
            <maml:para>The name of the child resource type to retrieve.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>ExactMatch</maml:name>
          <maml:description>
            <maml:para>Requires the complete child resource type path supplied by `Child` or `FullyQualifiedName` to match exactly, ignoring case. Without this switch, the child path is treated as a case-insensitive prefix.</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>OutputFullyQualifiedName</maml:name>
          <maml:description>
            <maml:para>Returns each matching child resource type with its resource provider and parent type, for example `Microsoft.Network/virtualNetworks/subnets`. By default, only the child portion of the type name is returned.</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="1" aliases="none">
          <maml:name>Resource</maml:name>
          <maml:description>
            <maml:para>The name of the resource type to retrieve.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">
          <maml:name>ResourceProvider</maml:name>
          <maml:description>
            <maml:para>The name of the resource provider to retrieve resource types for.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
      <command:syntaxItem>
        <maml:name>Get-BicepChildResourceType</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>ExactMatch</maml:name>
          <maml:description>
            <maml:para>Requires the complete child resource type path supplied by `Child` or `FullyQualifiedName` to match exactly, ignoring case. Without this switch, the child path is treated as a case-insensitive prefix.</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>FullyQualifiedName</maml:name>
          <maml:description>
            <maml:para>The fully qualified name of the child resource type to retrieve.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>OutputFullyQualifiedName</maml:name>
          <maml:description>
            <maml:para>Returns each matching child resource type with its resource provider and parent type, for example `Microsoft.Network/virtualNetworks/subnets`. By default, only the child portion of the type name is returned.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none">
        <maml:name>Child</maml:name>
        <maml:description>
          <maml:para>The name of the child resource type to retrieve.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>ExactMatch</maml:name>
        <maml:description>
          <maml:para>Requires the complete child resource type path supplied by `Child` or `FullyQualifiedName` to match exactly, ignoring case. Without this switch, the child path is treated as a case-insensitive prefix.</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>FullyQualifiedName</maml:name>
        <maml:description>
          <maml:para>The fully qualified name of the child resource type to retrieve.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>OutputFullyQualifiedName</maml:name>
        <maml:description>
          <maml:para>Returns each matching child resource type with its resource provider and parent type, for example `Microsoft.Network/virtualNetworks/subnets`. By default, only the child portion of the type name is returned.</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="1" aliases="none">
        <maml:name>Resource</maml:name>
        <maml:description>
          <maml:para>The name of the resource type to retrieve.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">
        <maml:name>ResourceProvider</maml:name>
        <maml:description>
          <maml:para>The name of the resource provider to retrieve resource types for.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes />
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <dev:name>System.String</dev:name>
        </dev:type>
        <maml:description>
          <maml:para>The cmdlet writes one string for each unique matching child resource type, either as the child portion or as the fully qualified type name.</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para>Filters are case-insensitive. Provider and parent filters match exactly; child filters use prefix matching unless `-ExactMatch` is specified. Results reflect the Azure resource types available from the Bicep type loader bundled with the module.</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>--------- Example 1 ---------</maml:title>
        <maml:introduction>
          <maml:para>This example lists the available child resource type names from the loaded Bicep type definitions.</maml:para>
          <maml:para>&#x80;</maml:para>
          <maml:para>```powershell
Get-BicepChildResourceType
```</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>Get-BicepResourceProvider</maml:linkText>
        <command:uri />
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Get-BicepResourceType</maml:linkText>
        <command:uri />
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Get-BicepApiVersion</maml:linkText>
        <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>&#x80;</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>&#x80;</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>&#x80;</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>
  <command:command>
    <command:details>
      <command:name>Get-BicepResourceProvider</command:name>
      <maml:description>
        <maml:para>Gets Azure resource provider namespaces available to Bicep, optionally filtered by a case-insensitive name prefix.</maml:para>
      </maml:description>
      <command:verb>Get</command:verb>
      <command:noun>BicepResourceProvider</command:noun>
    </command:details>
    <maml:description>
      <maml:para>The cmdlet reads Bicep's available resource types and returns each distinct Azure resource provider namespace. Use `ResourceProvider` parameter to limit results by a case-insensitive prefix.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-BicepResourceProvider</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>ExactMatch</maml:name>
          <maml:description>
            <maml:para>Requires the resource provider namespace to match exactly instead of treating the supplied value as a prefix. Matching remains case-insensitive.</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="0" aliases="none">
          <maml:name>ResourceProvider</maml:name>
          <maml:description>
            <maml:para>The resource provider namespace to retrieve.</maml:para>
          </maml:description>
          <command:parameterValue required="false" 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>ExactMatch</maml:name>
        <maml:description>
          <maml:para>Requires the resource provider namespace to match exactly instead of treating the supplied value as a prefix. Matching remains case-insensitive.</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>FullyQualifiedName</maml:name>
        <maml:description>
          <maml:para>The resource provider namespace to retrieve.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">
        <maml:name>ResourceProvider</maml:name>
        <maml:description>
          <maml:para>The resource provider namespace to retrieve.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes />
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <dev:name>System.String</dev:name>
        </dev:type>
        <maml:description>
          <maml:para>Returns each matching distinct Azure resource provider namespace as a string.</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para>Results come from the resource type definitions bundled with the loaded Bicep version; the cmdlet does not query an Azure subscription.</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>--------- Example 1 ---------</maml:title>
        <maml:introduction>
          <maml:para>This example returns all distinct Azure resource provider namespaces available in the loaded Bicep type definitions.</maml:para>
          <maml:para>&#x80;</maml:para>
          <maml:para>```powershell
Get-BicepResourceProvider
```</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>Get-BicepResourceType</maml:linkText>
        <command:uri />
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Get-BicepChildResourceType</maml:linkText>
        <command:uri />
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Get-BicepApiVersion</maml:linkText>
        <command:uri />
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
  <command:command>
    <command:details>
      <command:name>Get-BicepResourceType</command:name>
      <maml:description>
        <maml:para>Gets available top-level Azure resource types, optionally filtering by an exact provider name and a resource-type name prefix and returning short or fully qualified names.</maml:para>
      </maml:description>
      <command:verb>Get</command:verb>
      <command:noun>BicepResourceType</command:noun>
    </command:details>
    <maml:description>
      <maml:para>Queries Bicep's Azure resource type definitions for top-level resource types. You can filter results by an exact provider name and a type-name prefix or use a fully qualified name, and request fully qualified output.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-BicepResourceType</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>ExactMatch</maml:name>
          <maml:description>
            <maml:para>Matches the resource type name exactly instead of treating `-Resource` as a prefix. Matching remains case-insensitive.</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>OutputFullyQualifiedName</maml:name>
          <maml:description>
            <maml:para>Returns each resource type as a fully qualified provider/type name. Without this switch, the cmdlet returns only the resource type name.</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="1" aliases="none">
          <maml:name>Resource</maml:name>
          <maml:description>
            <maml:para>The name of the resource type to retrieve.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">
          <maml:name>ResourceProvider</maml:name>
          <maml:description>
            <maml:para>The name of the resource provider to retrieve resource types for.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
      <command:syntaxItem>
        <maml:name>Get-BicepResourceType</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>ExactMatch</maml:name>
          <maml:description>
            <maml:para>Matches the resource type name exactly instead of treating `-Resource` as a prefix. Matching remains case-insensitive.</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>FullyQualifiedName</maml:name>
          <maml:description>
            <maml:para>The fully qualified resource type to retrieve.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>OutputFullyQualifiedName</maml:name>
          <maml:description>
            <maml:para>Returns each resource type as a fully qualified provider/type name. Without this switch, the cmdlet returns only the resource type name.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</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>ExactMatch</maml:name>
        <maml:description>
          <maml:para>Matches the resource type name exactly instead of treating `-Resource` as a prefix. Matching remains case-insensitive.</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>FullyQualifiedName</maml:name>
        <maml:description>
          <maml:para>The fully qualified resource type to retrieve.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>OutputFullyQualifiedName</maml:name>
        <maml:description>
          <maml:para>Returns each resource type as a fully qualified provider/type name. Without this switch, the cmdlet returns only the resource type name.</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="1" aliases="none">
        <maml:name>Resource</maml:name>
        <maml:description>
          <maml:para>The name of the resource type to retrieve.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">
        <maml:name>ResourceProvider</maml:name>
        <maml:description>
          <maml:para>The name of the resource provider to retrieve resource types for.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes />
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <dev:name>System.String</dev:name>
        </dev:type>
        <maml:description>
          <maml:para>Returns distinct strings containing matching resource type names. With `-OutputFullyQualifiedName`, each string uses the provider/type format; otherwise, it contains only the resource type name.</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para>Filtering is case-insensitive. A supplied provider name is matched exactly; resource type names use prefix matching unless `-ExactMatch` is specified. This cmdlet returns only top-level types; use `Get-BicepChildResourceType` for child resource types.</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>--------- Example 1 ---------</maml:title>
        <maml:introduction>
          <maml:para>Retrieves matching top-level resource type names. By default, the output contains short type names; use `-OutputFullyQualifiedName` to include the provider name.</maml:para>
          <maml:para>&#x80;</maml:para>
          <maml:para>```powershell
Get-BicepResourceType
```</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>Get-BicepResourceProvider</maml:linkText>
        <command:uri />
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Get-BicepChildResourceType</maml:linkText>
        <command:uri />
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Get-BicepApiVersion</maml:linkText>
        <command:uri />
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
</helpItems>