PowerAzPlus

1.1.1

PowerAzPlus-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>Export-LogicAppDefinition</command:name>

      <command:verb>Export</command:verb>

      <command:noun>LogicAppDefinition</command:noun>

      <maml:description>

        <maml:para>Exports the definition of an Azure Logic App to a JSON file.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>The `Export-LogicAppDefinition` function retrieves the definition of a specified Azure Logic App and saves it as a JSON file to the specified file path. If the `FileName` parameter is not provided, a default name is generated based on the Logic App name and the current date/time.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Export-LogicAppDefinition</maml:name>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none">

          <maml:name>Name</maml:name>

          <maml:description>

            <maml:para>Specifies the name of the Logic App to export. This parameter accepts input from the pipeline and by property name.</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>None</dev:defaultValue>

        </command:parameter>

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

          <maml:name>FilePath</maml:name>

          <maml:description>

            <maml:para>Specifies the directory path where the exported JSON file will be saved. If not provided, the current working directory is used by default.</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>None</dev:defaultValue>

        </command:parameter>

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

          <maml:name>FileName</maml:name>

          <maml:description>

            <maml:para>Specifies the name of the JSON file to be created. If not provided, a name will be generated in the format `&lt;LogicAppName&gt;_&lt;Timestamp&gt;.json`.</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>None</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none">

        <maml:name>Name</maml:name>

        <maml:description>

          <maml:para>Specifies the name of the Logic App to export. This parameter accepts input from the pipeline and by property name.</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>None</dev:defaultValue>

      </command:parameter>

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

        <maml:name>FilePath</maml:name>

        <maml:description>

          <maml:para>Specifies the directory path where the exported JSON file will be saved. If not provided, the current working directory is used by default.</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>None</dev:defaultValue>

      </command:parameter>

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

        <maml:name>FileName</maml:name>

        <maml:description>

          <maml:para>Specifies the name of the JSON file to be created. If not provided, a name will be generated in the format `&lt;LogicAppName&gt;_&lt;Timestamp&gt;.json`.</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>None</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>System.Object</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>Export-LogicAppDefinition -Name "MyLogicApp" -FilePath "C:\Exports" -FileName "MyLogicApp.json"</dev:code>

        <dev:remarks>

          <maml:para>This example exports the definition of the Logic App named "MyLogicApp" to the file `C:\Exports\MyLogicApp.json`.</maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>---- Example 2: Exporting all Logic Apps in a Subscription ----</maml:title>

        <dev:code>Get-AzLogicApp | Export-LogicAppDefinition -FilePath "C:\Exports"</dev:code>

        <dev:remarks>

          <maml:para>This example exports the definitions of all Logic Apps in the current Azure subscription to the `C:\Exports` directory. File names are automatically generated.</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

  <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>Import-LogicAppDefinition</command:name>

      <command:verb>Import</command:verb>

      <command:noun>LogicAppDefinition</command:noun>

      <maml:description>

        <maml:para>Imnports the definition of an Azure Logic App from a JSON file.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>The `Export-LogicAppDefinition` function imports the definition from a JSON and overwrites an existing Logic Apps' workflow definition. The Logic App Name and Resource Group must be specific.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Import-LogicAppDefinition</maml:name>

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

          <maml:name>Name</maml:name>

          <maml:description>

            <maml:para>Specifies the name of the Logic App to import the workflow definition to.</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>None</dev:defaultValue>

        </command:parameter>

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

          <maml:name>ResourceGroupName</maml:name>

          <maml:description>

            <maml:para>Specifies the resource group name where the Logic App resides.</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>None</dev:defaultValue>

        </command:parameter>

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

          <maml:name>FileName</maml:name>

          <maml:description>

            <maml:para>Specifies the file name of the JSON file to import.</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>None</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

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

        <maml:name>Name</maml:name>

        <maml:description>

          <maml:para>Specifies the name of the Logic App to import the workflow definition to.</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>None</dev:defaultValue>

      </command:parameter>

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

        <maml:name>ResourceGroupName</maml:name>

        <maml:description>

          <maml:para>Specifies the resource group name where the Logic App resides.</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>None</dev:defaultValue>

      </command:parameter>

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

        <maml:name>FileName</maml:name>

        <maml:description>

          <maml:para>Specifies the file name of the JSON file to import.</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>None</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>System.Object</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>Import-LogicAppDefinition -Name mylogicapp -Resource logicapps-rg -File C:\backup\mylogicapp-export.json</dev:code>

        <dev:remarks>

          <maml:para>This example imports the definition found in C:\backup\mylogicapp-export.json to the Logic App named "mylogicapp".</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

</helpItems>