PSDocs.Azure

0.4.0-B2107030

en-GB/PSDocs.Azure-help.xml

                                <?xml version="1.0" encoding="utf-8"?>

<helpItems schema="maml" xmlns="http://msh">

  <command:command 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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Get-AzDocTemplateFile</command:name>

      <command:verb>Get</command:verb>

      <command:noun>AzDocTemplateFile</command:noun>

      <maml:description>

        <maml:para>Get Azure template files within a directory structure.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Gets any Azure Resource Manager (ARM) template files found within the search path. By default, the current working path is used.</maml:para>

      <maml:para>When a JSON file is found the schema is compared to determine if it is a valid ARM template file. JSON files without a valid schema are ignored.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Get-AzDocTemplateFile</maml:name>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="p">

          <maml:name>Path</maml:name>

          <maml:description>

            <maml:para>The path to search for template files within. By default, the current working path is used.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

          <dev:type>

            <maml:name>String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>$PWD</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName)" position="1" aliases="f, TemplateFile, FullName">

          <maml:name>InputPath</maml:name>

          <maml:description>

            <maml:para>A filter for finding template files within the search path.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>

          <dev:type>

            <maml:name>String[]</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>*.json</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName)" position="1" aliases="f, TemplateFile, FullName">

        <maml:name>InputPath</maml:name>

        <maml:description>

          <maml:para>A filter for finding template files within the search path.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>

        <dev:type>

          <maml:name>String[]</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>*.json</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="p">

        <maml:name>Path</maml:name>

        <maml:description>

          <maml:para>The path to search for template files within. By default, the current working path is used.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

        <dev:type>

          <maml:name>String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>$PWD</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>System.String[]</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>PSDocs.Azure.Data.Metadata.ITemplateLink</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- Example 1 --------------------------</maml:title>

        <dev:code>PS C:\&gt; Get-AzDocTemplateFile</dev:code>

        <dev:remarks>

          <maml:para>Get a list of template files within the current working directory.</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>Online Version:</maml:linkText>

        <maml:uri>https://github.com/Azure/PSDocs.Azure/blob/main/docs/commands/en-US/Get-AzDocTemplateFile.md</maml:uri>

      </maml:navigationLink>

    </command:relatedLinks>

  </command:command>

</helpItems>