TestJsonSchema

1.0.1

TestJsonSchema.psm1-Help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml">
    <!--Edited with: SAPIEN PowerShell HelpWriter 2019 v2.3.44-->
    <!--Generated by: SAPIEN PowerShell HelpWriter 2019 v2.3.44-->
    <!--
        Module: TestJsonSchema
        Version: 1.0.1
    -->
    <!--All Commands-->
    <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">
        <!--TAG: HASCOMMONPARAMETERS-->
        <!--Command-->
        <command:details>
            <command:name>Test-JsonSchema</command:name>
            <maml:description>
                <maml:para>Perform Pester Test to validate JSON files against the specified schema</maml:para>
            </maml:description>
            <maml:copyright>
                <maml:para></maml:para>
            </maml:copyright>
            <command:verb>Test</command:verb>
            <command:noun>JsonSchema</command:noun>
            <dev:version />
        </command:details>
        <maml:description>
            <maml:para></maml:para>
        </maml:description>
        <command:syntax>
            <!--Parameter Sets-->
            <command:syntaxItem parametersetname="NoOutputFile">
                <!--NAME: NoOutputFile-->
                <maml:name>Test-JsonSchema</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named">
                    <maml:name>JsonPath</maml:name>
                    <maml:description>
                        <maml:para>Specify the file paths for the json files.</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></dev:defaultValue>
                </command:parameter>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named">
                    <maml:name>SchemaPath</maml:name>
                    <maml:description>
                        <maml:para>Specify the Json Schema file 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></dev:defaultValue>
                </command:parameter>
            </command:syntaxItem>
            <command:syntaxItem parametersetname="ProduceOutputFile">
                <!--NAME: ProduceOutputFile-->
                <maml:name>Test-JsonSchema</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named">
                    <maml:name>JsonPath</maml:name>
                    <maml:description>
                        <maml:para>Specify the file paths for the json files.</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></dev:defaultValue>
                </command:parameter>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named">
                    <maml:name>SchemaPath</maml:name>
                    <maml:description>
                        <maml:para>Specify the Json Schema file 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></dev:defaultValue>
                </command:parameter>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>OutputFile</maml:name>
                    <maml:description>
                        <maml:para></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></dev:defaultValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>OutputFormat</maml:name>
                    <maml:description>
                        <maml:para></maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
                    <command:parameterValueGroup>
                        <command:parameterValue required="false" variableLength="false">NUnitXml</command:parameterValue>
                        <command:parameterValue required="false" variableLength="false">LegacyNUnitXML</command:parameterValue>
                    </command:parameterValueGroup>
                    <dev:type>
                        <maml:name>String</maml:name>
                        <maml:uri />
                    </dev:type>
                    <dev:defaultValue>NUnitXml</dev:defaultValue>
                </command:parameter>
            </command:syntaxItem>
        </command:syntax>
        <command:parameters>
            <!--All Parameters-->
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named">
                <maml:name>JsonPath</maml:name>
                <maml:description>
                    <maml:para>Specify the file paths for the json files.</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></dev:defaultValue>
            </command:parameter>
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named">
                <maml:name>SchemaPath</maml:name>
                <maml:description>
                    <maml:para>Specify the Json Schema file 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></dev:defaultValue>
            </command:parameter>
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>OutputFile</maml:name>
                <maml:description>
                    <maml:para></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></dev:defaultValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named">
                <maml:name>OutputFormat</maml:name>
                <maml:description>
                    <maml:para></maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
                <command:parameterValueGroup>
                    <command:parameterValue required="false" variableLength="false">NUnitXml</command:parameterValue>
                    <command:parameterValue required="false" variableLength="false">LegacyNUnitXML</command:parameterValue>
                </command:parameterValueGroup>
                <dev:type>
                    <maml:name>String</maml:name>
                    <maml:uri />
                </dev:type>
                <dev:defaultValue>NUnitXml</dev:defaultValue>
            </command:parameter>
        </command:parameters>
        <command:inputTypes>
            <!--Inputs-->
            <command:inputType>
                <dev:type>
                    <maml:name>System.String
</maml:name>
                    <maml:uri></maml:uri>
                </dev:type>
                <maml:description>
                    <maml:para></maml:para>
                </maml:description>
            </command:inputType>
        </command:inputTypes>
        <command:returnValues>
            <!--Outputs-->
            <command:returnValue>
                <dev:type>
                    <maml:name>System.Object</maml:name>
                    <maml:uri></maml:uri>
                </dev:type>
                <maml:description>
                    <maml:para></maml:para>
                </maml:description>
            </command:returnValue>
        </command:returnValues>
        <command:examples>
            <!--Examples-->
            <command:example>
                <maml:title>EXAMPLE 1</maml:title>
                <maml:introduction>
                    <maml:para />
                </maml:introduction>
                <dev:code>C:\PS&gt; Test-JSONSchema -JsonPath "C:\Temp" -Schema "C:\schema.json"</dev:code>
                <dev:remarks>
                    <maml:para>Test all Json in a folder and its subfolders against a scehema file and display Pester result on the PowerShell host</maml:para>
                </dev:remarks>
            </command:example>
            <command:example>
                <maml:title>EXAMPLE 2</maml:title>
                <maml:introduction>
                    <maml:para />
                </maml:introduction>
                <dev:code>C:\PS&gt; Test-AzPolicyDefinition -JsonPath "C:\Temp" -Schema "C:\schema.json" -OutputFile "C:\Temp\MyTestResult.xml"</dev:code>
                <dev:remarks>
                    <maml:para>Test all Json in a folder and its subfolders against a scehema file and store the test result in a file</maml:para>
                </dev:remarks>
            </command:example>
            <command:example>
                <maml:title>EXAMPLE 3</maml:title>
                <maml:introduction>
                    <maml:para />
                </maml:introduction>
                <dev:code>C:\PS&gt; Test-AzPolicyDefinition -JsonPath "C:\Temp" -Schema "C:\schema.json" -OutputFile "C:\Temp\MyTestResult.xml" -OutputFormat 'LegacyNUnitXML'</dev:code>
                <dev:remarks>
                    <maml:para>Test all Json in a folder and its subfolders against a scehema file and store the test result in a file with the 'LegacyNUnitXML' format</maml:para>
                </dev:remarks>
            </command:example>
        </command:examples>
        <maml:relatedLinks>
            <!--Links-->
            <maml:navigationLink>
            </maml:navigationLink>
        </maml:relatedLinks>
    </command:command>
    <!--Generated by: SAPIEN PowerShell HelpWriter 2019 v2.3.44-->
</helpItems>