AzureAutomationTools.PackageManagement

0.1

en-US/AzureAutomationTools.PackageManagement-help.xml

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

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

<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>Add-AatPackageVariable</command:name>

<command:verb>Add</command:verb>

<command:noun>AatPackageVariable</command:noun>

<maml:description><maml:para>Adds a variable defintion to an assets file.

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>Adds a variable defintion to an assets file, by default this use the default assests file for the project, but can be overriden by specifying the name of another assets file.

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>Add-AatPackageVariable</maml:name>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AssetsFileName</maml:name>

<maml:Description><maml:para>The name of an assets file. This must already exist in the package assets folder.

</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="named" aliases="cf"><maml:name>Confirm</maml:name>

<maml:Description><maml:para>Prompts you for confirmation before running the cmdlet.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IsEncrypted</maml:name>

<maml:Description><maml:para>Adds an encrypted variable.

</maml:para>

<maml:para>Note: settings a value is not supported with encrpyted value - these must be securely set after publishing.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Name</maml:name>

<maml:Description><maml:para>The name of the variable. Must be unique in the assets file.

</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="named" aliases="wi"><maml:name>WhatIf</maml:name>

<maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:syntaxItem>

<command:syntaxItem><maml:name>Add-AatPackageVariable</maml:name>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AssetsFileName</maml:name>

<maml:Description><maml:para>The name of an assets file. This must already exist in the package assets folder.

</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="named" aliases="cf"><maml:name>Confirm</maml:name>

<maml:Description><maml:para>Prompts you for confirmation before running the cmdlet.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Name</maml:name>

<maml:Description><maml:para>The name of the variable. Must be unique in the assets file.

</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="named" aliases="none"><maml:name>Value</maml:name>

<maml:Description><maml:para>The value of the variable. Can be a simple type or complex object. Complex objects are converted to json.

</maml:para>

</maml:Description>

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

<dev:type><maml:name>Object</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name>

<maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:syntaxItem>

</command:syntax>

<command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AssetsFileName</maml:name>

<maml:Description><maml:para>The name of an assets file. This must already exist in the package assets folder.

</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="named" aliases="cf"><maml:name>Confirm</maml:name>

<maml:Description><maml:para>Prompts you for confirmation before running the cmdlet.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IsEncrypted</maml:name>

<maml:Description><maml:para>Adds an encrypted variable.

</maml:para>

<maml:para>Note: settings a value is not supported with encrpyted value - these must be securely set after publishing.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Name</maml:name>

<maml:Description><maml:para>The name of the variable. Must be unique in the assets file.

</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="named" aliases="none"><maml:name>Value</maml:name>

<maml:Description><maml:para>The value of the variable. Can be a simple type or complex object. Complex objects are converted to json.

</maml:para>

</maml:Description>

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

<dev:type><maml:name>Object</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name>

<maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:parameters>

<command:inputTypes><command:inputType><dev:type><maml:name>None</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: Add a plaintext variable</maml:title>

<dev:code>PS&gt; Add-AatPackageVariable -Name 'plain-value' -Value 'some value'</dev:code>

<dev:remarks><maml:para>Adds the variable plain-value to the default assets file.

</maml:para>

</dev:remarks>

</command:example>

<command:example><maml:title>Example 2: Add a enrypted variable</maml:title>

<dev:code>PS&gt; Add-AatPackageVariable -Name 'encrypted-value' -IsEncrypted</dev:code>

<dev:remarks><maml:para>Adds the variable encrypted-value to the default assets file.

</maml:para>

</dev:remarks>

</command:example>

<command:example><maml:title>Example 3: Add a plaintext variable to a specific assets file</maml:title>

<dev:code>PS&gt; Add-AatPackageVariable -Name 'simple-value' -Value 'some-value' -AssetsFileName some-assets</dev:code>

<dev:remarks><maml:para>Adds the varaible simple-value to the some-assets assets file.

</maml:para>

</dev:remarks>

</command:example>

<command:example><maml:title>Example 4: Add a complex variable</maml:title>

<dev:code>PS&gt; $ObjectVariable = [pscutomobject]@{StringProperty = 'lorem'; IntProperty = 1; ObjectProperty = [pscutomobject]@{StringProperty='Ipsum';FloatProperty = 17.3}

    PS&gt; Add-AatPackageVariable -Name 'complex-value' -Value $ObjectVariable</dev:code>

<dev:remarks><maml:para>Adds the varaible complex-value to the default assets file.

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks><maml:navigationLink><maml:linkText>New-AatAssetsFile</maml:linkText>

<maml:uri></maml:uri>

</maml:navigationLink>

</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>Get-AatPackageFolderPath</command:name>

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

<command:noun>AatPackageFolderPath</command:noun>

<maml:description><maml:para>Gets the specified package folder path.

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>Gets the specifed package folder path - this is a concatenation of Get-WorkingFolder and Get-WorkingPackage as well as the specified folder (Assets, Modules or Runbooks).

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>Get-AatPackageFolderPath</maml:name>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Assets</maml:name>

<maml:Description><maml:para>Return the Assets folder path.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:syntaxItem>

<command:syntaxItem><maml:name>Get-AatPackageFolderPath</maml:name>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Modules</maml:name>

<maml:Description><maml:para>Return the Modules folder path.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:syntaxItem>

<command:syntaxItem><maml:name>Get-AatPackageFolderPath</maml:name>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Runbooks</maml:name>

<maml:Description><maml:para>Return the Runbooks folder path.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:syntaxItem>

</command:syntax>

<command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Assets</maml:name>

<maml:Description><maml:para>Return the Assets folder path.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Modules</maml:name>

<maml:Description><maml:para>Return the Modules folder path.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Runbooks</maml:name>

<maml:Description><maml:para>Return the Runbooks folder path.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:parameters>

<command:inputTypes><command:inputType><dev:type><maml:name>None</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: Get Assets folder path</maml:title>

<dev:code>PS C:\&gt; Get-AatPackageFolderPath -Assets

C:\aat-package-examples\example-1\assets</dev:code>

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

<command:example><maml:title>Example 2: Get Modules folder path</maml:title>

<dev:code>PS C:\&gt; Get-AatPackageFolderPath -Modules

C:\aat-package-examples\example-1\Modules</dev:code>

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

<command:example><maml:title>Example 3: Get Runbooks folder path</maml:title>

<dev:code>PS C:\&gt; Get-AatPackageFolderPath -Runbooks

C:\aat-package-examples\example-1\Runbooks

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

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks><maml:navigationLink><maml:linkText>Get-AatWorkingFolder</maml:linkText>

<maml:uri></maml:uri>

</maml:navigationLink>

<maml:navigationLink><maml:linkText>Get-AatWorkingPackage</maml:linkText>

<maml:uri></maml:uri>

</maml:navigationLink>

<maml:navigationLink><maml:linkText>Set-AatWorkingFolder</maml:linkText>

<maml:uri></maml:uri>

</maml:navigationLink>

<maml:navigationLink><maml:linkText>Set-AatWorkingPackage</maml:linkText>

<maml:uri></maml:uri>

</maml:navigationLink>

</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>Get-AatPackageOption</command:name>

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

<command:noun>AatPackageOption</command:noun>

<maml:description><maml:para>Gets the current package options.

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>Gets the current package options e.g. AssetsFolderName, AssetsFileName, JsonAssetDepth.

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>Get-AatPackageOption</maml:name>

</command:syntaxItem>

</command:syntax>

<command:parameters></command:parameters>

<command:inputTypes><command:inputType><dev:type><maml:name>None (does not accept pipeline input)</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.Management.Automation.PSCustomObject</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: Get options</maml:title>

<dev:code>PS C:&gt; Get-AatPackageOption

Name                           Value

----                           -----

JsonAssetDepth                 4

RunbooksFolderName             runbooks

ModulesFolderName              modules

Encoding                       UTF8

AssetsFolderName               assets

AssetsFileName                 assets.json</dev:code>

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks><maml:navigationLink><maml:linkText>Set-AatPackageOption</maml:linkText>

<maml:uri></maml:uri>

</maml:navigationLink>

</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>Get-AatPackagePath</command:name>

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

<command:noun>AatPackagePath</command:noun>

<maml:description><maml:para>Gets the package path for the working package.

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>Gets the package path for the working package.

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>Get-AatPackagePath</maml:name>

</command:syntaxItem>

</command:syntax>

<command:parameters></command:parameters>

<command:inputTypes><command:inputType><dev:type><maml:name>None</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: Get the package path</maml:title>

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

C:\aat-package-examples\example-1</dev:code>

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks></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>Get-AatWorkingFolder</command:name>

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

<command:noun>AatWorkingFolder</command:noun>

<maml:description><maml:para>Gets the working folder for packages.

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>Gets the working folder for packages. This defaults to the the current working folder

unless explicitly set using Set-AatWorkingFolder .

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>Get-AatWorkingFolder</maml:name>

</command:syntaxItem>

</command:syntax>

<command:parameters></command:parameters>

<command:inputTypes><command:inputType><dev:type><maml:name>None (does not accept pipeline input)</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.String</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: Get the working folder</maml:title>

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

C:\aat-package-examples\</dev:code>

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks><maml:navigationLink><maml:linkText>Set-AatWorkingFolder</maml:linkText>

<maml:uri></maml:uri>

</maml:navigationLink>

</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>Get-AatWorkingPackage</command:name>

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

<command:noun>AatWorkingPackage</command:noun>

<maml:description><maml:para>Gets the working package.

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>Gets the working package, or if none has been set returns the first folder in the working package folder (i.e. as returned by Get-AatWorkingFolder)

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>Get-AatWorkingPackage</maml:name>

</command:syntaxItem>

</command:syntax>

<command:parameters></command:parameters>

<command:inputTypes><command:inputType><dev:type><maml:name>None (does not accept pipeline input)</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.String</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: Get the working package</maml:title>

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

example-1</dev:code>

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks><maml:navigationLink><maml:linkText>Get-AatWorkingFolder</maml:linkText>

<maml:uri></maml:uri>

</maml:navigationLink>

</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>New-AatAssetsFile</command:name>

<command:verb>New</command:verb>

<command:noun>AatAssetsFile</command:noun>

<maml:description><maml:para>Creates a new assets file in the assets folder for the working package.

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>Creates a new assets file in the assets folder for the working package. This can optionally be created with entries for the different supported types of assets.

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>New-AatAssetsFile</maml:name>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>All</maml:name>

<maml:Description><maml:para>Create an placeholder for all asset types in the newly created file.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name>

<maml:Description><maml:para>Prompts you for confirmation before running the cmdlet.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Name</maml:name>

<maml:Description><maml:para>The name of the assets file to create.

</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="named" aliases="wi"><maml:name>WhatIf</maml:name>

<maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:syntaxItem>

<command:syntaxItem><maml:name>New-AatAssetsFile</maml:name>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name>

<maml:Description><maml:para>Prompts you for confirmation before running the cmdlet.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IncludeCertificates</maml:name>

<maml:Description><maml:para>Create an placeholder for certificates in the newly created file.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IncludeConnections</maml:name>

<maml:Description><maml:para>Create an placeholder for connections in the newly created file.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IncludeCredentials</maml:name>

<maml:Description><maml:para>Create an placeholder for credentials in the newly created file.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IncludeVariables</maml:name>

<maml:Description><maml:para>Create an placeholder for variables in the newly created file.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Name</maml:name>

<maml:Description><maml:para>The name of the assets file to create.

</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="named" aliases="wi"><maml:name>WhatIf</maml:name>

<maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:syntaxItem>

</command:syntax>

<command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>All</maml:name>

<maml:Description><maml:para>Create an placeholder for all asset types in the newly created file.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name>

<maml:Description><maml:para>Prompts you for confirmation before running the cmdlet.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IncludeCertificates</maml:name>

<maml:Description><maml:para>Create an placeholder for certificates in the newly created file.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IncludeConnections</maml:name>

<maml:Description><maml:para>Create an placeholder for connections in the newly created file.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IncludeCredentials</maml:name>

<maml:Description><maml:para>Create an placeholder for credentials in the newly created file.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IncludeVariables</maml:name>

<maml:Description><maml:para>Create an placeholder for variables in the newly created file.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Name</maml:name>

<maml:Description><maml:para>The name of the assets file to create.

</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="named" aliases="wi"><maml:name>WhatIf</maml:name>

<maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:parameters>

<command:inputTypes><command:inputType><dev:type><maml:name>None</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: Create an assets file for all asset types</maml:title>

<dev:code>PS C:\&gt; New-AatAssetsFile -Name all-assets.json -All</dev:code>

<dev:remarks><maml:para>This will create the file all-assets.json in the package assets folder.

</maml:para>

</dev:remarks>

</command:example>

<command:example><maml:title>Example 2: Create an assets file just for variables</maml:title>

<dev:code>PS C:\&gt; New-AatAssetsFile -Name variables-assets.json -IncludeVariables</dev:code>

<dev:remarks><maml:para>This will create the file variables-assets.json in the package assets folder.

</maml:para>

</dev:remarks>

</command:example>

<command:example><maml:title>Example 3: Create an assets file for variables and creentials</maml:title>

<dev:code>PS C:\&gt; New-AatAssetsFile -Name variables-and-credential-assets.json -IncludeVariables -IncludeCredentials</dev:code>

<dev:remarks><maml:para>This will create the file variables-and-credential-assets.json in the package assets folder.

</maml:para>

</dev:remarks>

</command:example>

<command:example><maml:title>Example 4: Create an empty assets file</maml:title>

<dev:code>PS C:\&gt; New-AatAssetsFile -Name empty.json</dev:code>

<dev:remarks><maml:para>This will create the file empty.json in the package assets folder.

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks><maml:navigationLink><maml:linkText>New-AatAutomationPackage</maml:linkText>

<maml:uri></maml:uri>

</maml:navigationLink>

<maml:navigationLink><maml:linkText>Add-AatPackageVariable</maml:linkText>

<maml:uri></maml:uri>

</maml:navigationLink>

</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>New-AatAutomationPackage</command:name>

<command:verb>New</command:verb>

<command:noun>AatAutomationPackage</command:noun>

<maml:description><maml:para>Gets the working package.

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>Gets the working package, or if none has been set returns the first folder in the working package folder (i.e. as returned by Get-AatWorkingFolder)

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>New-AatAutomationPackage</maml:name>

</command:syntaxItem>

</command:syntax>

<command:parameters></command:parameters>

<command:inputTypes><command:inputType><dev:type><maml:name>None (does not accept pipeline input)</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.String</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: Get the working package</maml:title>

<dev:code>PS C:\&gt; New-AatAutomationPackage

example-1</dev:code>

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks><maml:navigationLink><maml:linkText>Get-AatWorkingFolder</maml:linkText>

<maml:uri></maml:uri>

</maml:navigationLink>

</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>New-AatPackageVariable</command:name>

<command:verb>New</command:verb>

<command:noun>AatPackageVariable</command:noun>

<maml:description><maml:para>Creates a new variable.

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>Creates a new variable.

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>New-AatPackageVariable</maml:name>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AsJson</maml:name>

<maml:Description><maml:para>Specifies that the variable is returned as json instead of PSCustomObject.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name>

<maml:Description><maml:para>Prompts you for confirmation before running the cmdlet.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IsEncrypted</maml:name>

<maml:Description><maml:para>Specifies that the variable is encrypted.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Name</maml:name>

<maml:Description><maml:para>Specifies the name of the variable.

</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="named" aliases="wi"><maml:name>WhatIf</maml:name>

<maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:syntaxItem>

<command:syntaxItem><maml:name>New-AatPackageVariable</maml:name>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AsJson</maml:name>

<maml:Description><maml:para>Specifies that the variable is returned as json instead of PSCustomObject.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name>

<maml:Description><maml:para>Prompts you for confirmation before running the cmdlet.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Name</maml:name>

<maml:Description><maml:para>Specifies the name of the variable.

</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="named" aliases="none"><maml:name>Value</maml:name>

<maml:Description><maml:para>Specifies the value of the variable.

</maml:para>

</maml:Description>

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

<dev:type><maml:name>Object</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name>

<maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:syntaxItem>

</command:syntax>

<command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AsJson</maml:name>

<maml:Description><maml:para>Specifies that the variable is returned as json instead of PSCustomObject.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name>

<maml:Description><maml:para>Prompts you for confirmation before running the cmdlet.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IsEncrypted</maml:name>

<maml:Description><maml:para>Specifies that the variable is encrypted.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Name</maml:name>

<maml:Description><maml:para>Specifies the name of the variable.

</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="named" aliases="none"><maml:name>Value</maml:name>

<maml:Description><maml:para>Specifies the value of the variable.

</maml:para>

</maml:Description>

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

<dev:type><maml:name>Object</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name>

<maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:parameters>

<command:inputTypes><command:inputType><dev:type><maml:name>None</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.Management.Automation.PSCustomObject</maml:name>

</dev:type>

<maml:description><maml:para>

</maml:para>

</maml:description>

</command:returnValue>

<command:returnValue><dev:type><maml:name>System.String</maml:name>

</dev:type>

<maml:description><maml:para>

</maml:para>

</maml:description>

</command:returnValue>

</command:returnValues>

<maml:alertSet><maml:alert></maml:alert>

</maml:alertSet>

<command:examples><command:example><maml:title>Example 1: Create a variable</maml:title>

<dev:code>PS C:\&gt; New-AatPackageVariable -Name var -Value 1

Name IsEncrypted Value

---- ----------- -----

var        False     1</dev:code>

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

<command:example><maml:title>Example 2: Create an encrypted variable</maml:title>

<dev:code>PS C:\&gt; New-AatPackageVariable -Name var -IsEncrypted

Name IsEncrypted Value

---- ----------- -----

var         True</dev:code>

<dev:remarks><maml:para>Note: Values are not supported for encypted variables. These must be set securely after publishing.

</maml:para>

</dev:remarks>

</command:example>

<command:example><maml:title>Example 3: Create a variable as json</maml:title>

<dev:code>PS C:\&gt; New-AatPackageVariable -Name var -Value 1 -AsJson

{

    "Name":  "var",

    "IsEncrypted":  false,

    "Value":  1

}</dev:code>

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks></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>Publish-AatAutomationPackage</command:name>

<command:verb>Publish</command:verb>

<command:noun>AatAutomationPackage</command:noun>

<maml:description><maml:para>Publish automation resources: runbooks, modules and assets (variables &amp; credentials)

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>Publish automation resources: runbooks, modules and assets (variables &amp; credentials) to an automation account.

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>Publish-AatAutomationPackage</maml:name>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AssetsFilter</maml:name>

<maml:Description><maml:para>Only assets in files matching the filter will be published.

</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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AutomationAccountName</maml:name>

<maml:Description><maml:para>Name of automation account to publish 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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name>

<maml:Description><maml:para>Prompts you for confirmation before running the cmdlet.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DeployCredentials</maml:name>

<maml:Description><maml:para>Publish credentials.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DeployModules</maml:name>

<maml:Description><maml:para>Publish modules.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DeployRunbooks</maml:name>

<maml:Description><maml:para>Publish runbooks.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DeployVariables</maml:name>

<maml:Description><maml:para>Publish assets.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>JsonAssetDepth</maml:name>

<maml:Description><maml:para>The depth to use when converting objects to json.

</maml:para>

</maml:Description>

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

<dev:type><maml:name>Int32</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>4</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>NewCredentialsOnly</maml:name>

<maml:Description><maml:para>Publish only new credentials.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Paths</maml:name>

<maml:Description><maml:para>The paths to deploy - if ommitted all folders at the root level (except deploy) will be searched for the specified automation resources.

</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="named" aliases="none"><maml:name>ResourceGroupName</maml:name>

<maml:Description><maml:para>Name of resource group to publish 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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>RunbookFilter</maml:name>

<maml:Description><maml:para>Only runbooks matching the filter will be published.

</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>*.ps1</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name>

<maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:syntaxItem>

</command:syntax>

<command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AssetsFilter</maml:name>

<maml:Description><maml:para>Only assets in files matching the filter will be published.

</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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AutomationAccountName</maml:name>

<maml:Description><maml:para>Name of automation account to publish 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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name>

<maml:Description><maml:para>Prompts you for confirmation before running the cmdlet.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DeployCredentials</maml:name>

<maml:Description><maml:para>Publish credentials.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DeployModules</maml:name>

<maml:Description><maml:para>Publish modules.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DeployRunbooks</maml:name>

<maml:Description><maml:para>Publish runbooks.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DeployVariables</maml:name>

<maml:Description><maml:para>Publish assets.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>JsonAssetDepth</maml:name>

<maml:Description><maml:para>The depth to use when converting objects to json.

</maml:para>

</maml:Description>

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

<dev:type><maml:name>Int32</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>4</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>NewCredentialsOnly</maml:name>

<maml:Description><maml:para>Publish only new credentials.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Paths</maml:name>

<maml:Description><maml:para>The paths to deploy - if ommitted all folders at the root level (except deploy) will be searched for the specified automation resources.

</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="named" aliases="none"><maml:name>ResourceGroupName</maml:name>

<maml:Description><maml:para>Name of resource group to publish 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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>RunbookFilter</maml:name>

<maml:Description><maml:para>Only runbooks matching the filter will be published.

</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>*.ps1</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name>

<maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:parameters>

<command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name>

</dev:type>

<maml:description><maml:para>

</maml:para>

</maml:description>

</command:inputType>

</command:inputTypes>

<command:returnValues><command:returnValue><dev:type><maml:name>None</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: Publish all packages</maml:title>

<dev:code>PS C:\&gt; Publish-AatAutomationPackage -ResourceGroupName rg -AutomationAccountName aa</dev:code>

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks></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>Set-AatPackageOption</command:name>

<command:verb>Set</command:verb>

<command:noun>AatPackageOption</command:noun>

<maml:description><maml:para>Sets the current package options.

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>Gets the current package options e.g. AssetsFolderName, AssetsFileName, JsonAssetDepth.

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>Set-AatPackageOption</maml:name>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AssetsFileName</maml:name>

<maml:Description><maml:para>The name of the default file to use for assets.

</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="named" aliases="none"><maml:name>AssetsFolderName</maml:name>

<maml:Description><maml:para>The name of the folder to use for assets.

</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="named" aliases="cf"><maml:name>Confirm</maml:name>

<maml:Description><maml:para>Prompts you for confirmation before running the cmdlet.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Encoding</maml:name>

<maml:Description><maml:para>The encoding to use when writing files. Suported values are UTF8 &amp; Unicode. The package will use UTF8 unless unicode is set explicitly

</maml:para>

</maml:Description>

<command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Unicode</command:parameterValue>

<command:parameterValue required="false" variableLength="false">UTF8</command:parameterValue>

</command:parameterValueGroup>

<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="named" aliases="none"><maml:name>JsonAssetDepth</maml:name>

<maml:Description><maml:para>The maximum depth to resolve objects when converting them to json. The package will use 4 unless it is exlicitly set.

</maml:para>

</maml:Description>

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

<dev:type><maml:name>Int32</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>0</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ModulesFolderName</maml:name>

<maml:Description><maml:para>The name of the folder to use for modules.

</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="named" aliases="none"><maml:name>RunbooksFolderName</maml:name>

<maml:Description><maml:para>The name of the folder to use for runbooks.

</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="named" aliases="wi"><maml:name>WhatIf</maml:name>

<maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:syntaxItem>

</command:syntax>

<command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AssetsFileName</maml:name>

<maml:Description><maml:para>The name of the default file to use for assets.

</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="named" aliases="none"><maml:name>AssetsFolderName</maml:name>

<maml:Description><maml:para>The name of the folder to use for assets.

</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="named" aliases="cf"><maml:name>Confirm</maml:name>

<maml:Description><maml:para>Prompts you for confirmation before running the cmdlet.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Encoding</maml:name>

<maml:Description><maml:para>The encoding to use when writing files. Suported values are UTF8 &amp; Unicode. The package will use UTF8 unless unicode is set explicitly

</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="named" aliases="none"><maml:name>JsonAssetDepth</maml:name>

<maml:Description><maml:para>The maximum depth to resolve objects when converting them to json. The package will use 4 unless it is exlicitly set.

</maml:para>

</maml:Description>

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

<dev:type><maml:name>Int32</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>0</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ModulesFolderName</maml:name>

<maml:Description><maml:para>The name of the folder to use for modules.

</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="named" aliases="none"><maml:name>RunbooksFolderName</maml:name>

<maml:Description><maml:para>The name of the folder to use for runbooks.

</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="named" aliases="wi"><maml:name>WhatIf</maml:name>

<maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:parameters>

<command:inputTypes><command:inputType><dev:type><maml:name>None (does not accept pipeline input)</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.Management.Automation.PSCustomObject</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: Set the assets folder</maml:title>

<dev:code>PS C:\&gt; Set-AatPackageOption -AssetsFolderName example-assets</dev:code>

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

<command:example><maml:title>Example 2: Set the default file for assets</maml:title>

<dev:code>PS C:\&gt; Set-AatPackageOption -AssetsFileName example-assets.json</dev:code>

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

<command:example><maml:title>Example 3: Set the folder for modules</maml:title>

<dev:code>PS C:\&gt; Set-AatPackageOption -ModulesFolderName example-modules</dev:code>

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

<command:example><maml:title>Example 4: Set the folder for runbooks</maml:title>

<dev:code>PS C:\&gt; Set-AatPackageOption -RunbooksFolderName example-runbooks</dev:code>

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

<command:example><maml:title>Example 5: Set the encoding for package files</maml:title>

<dev:code>PS C:\&gt; Set-AatPackageOption -Encoding Unicode</dev:code>

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

<command:example><maml:title>Example 6: Setting all options</maml:title>

<dev:code>PS C:\&gt; Set-AatPackageOption -AssetsFolderName example-assets -AssetsFileName example-assets.json -ModulesFolderName example-modules -RunbooksFolderName example-runbooks -Encoding Unicode</dev:code>

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks><maml:navigationLink><maml:linkText>Get-AatPackageOption</maml:linkText>

<maml:uri></maml:uri>

</maml:navigationLink>

</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>Set-AatWorkingFolder</command:name>

<command:verb>Set</command:verb>

<command:noun>AatWorkingFolder</command:noun>

<maml:description><maml:para>Sets the working packages folder

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>Sets the working packages folder, this folder will continue to be used regardless of pwd

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>Set-AatWorkingFolder</maml:name>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name>

<maml:Description><maml:para>Prompts you for confirmation before running the cmdlet.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Path</maml:name>

<maml:Description><maml:para>Specifies the path to set as the working folder.

</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="named" aliases="wi"><maml:name>WhatIf</maml:name>

<maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:syntaxItem>

</command:syntax>

<command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name>

<maml:Description><maml:para>Prompts you for confirmation before running the cmdlet.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Path</maml:name>

<maml:Description><maml:para>Specifies the path to set as the working folder.

</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="named" aliases="wi"><maml:name>WhatIf</maml:name>

<maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:parameters>

<command:inputTypes><command:inputType><dev:type><maml:name>None (does not accept pipeline input)</maml:name>

</dev:type>

<maml:description><maml:para>

</maml:para>

</maml:description>

</command:inputType>

</command:inputTypes>

<command:returnValues><command:returnValue><dev:type><maml:name>None</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: Set the working folder</maml:title>

<dev:code>PS C:\&gt; Set-AatWorkingFolder -Path c:\aat-package-examples</dev:code>

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks><maml:navigationLink><maml:linkText>Get-AatWorkingFolder</maml:linkText>

<maml:uri></maml:uri>

</maml:navigationLink>

</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>Set-AatWorkingPackage</command:name>

<command:verb>Set</command:verb>

<command:noun>AatWorkingPackage</command:noun>

<maml:description><maml:para>Sets the working package.

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>Sets the working package - this must be a folder in the working package folder

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>Set-AatWorkingPackage</maml:name>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name>

<maml:Description><maml:para>Prompts you for confirmation before running the cmdlet.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>PackageName</maml:name>

<maml:Description><maml:para>Specifies the name of the working package.

</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="named" aliases="wi"><maml:name>WhatIf</maml:name>

<maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:syntaxItem>

</command:syntax>

<command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name>

<maml:Description><maml:para>Prompts you for confirmation before running the cmdlet.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>PackageName</maml:name>

<maml:Description><maml:para>Specifies the name of the working package.

</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="named" aliases="wi"><maml:name>WhatIf</maml:name>

<maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:parameters>

<command:inputTypes><command:inputType><dev:type><maml:name>None (does not accept pipeline input)</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.String</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: Set the working package</maml:title>

<dev:code>PS C:\&gt; Set-AatWorkingPackage -PackageName example</dev:code>

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks><maml:navigationLink><maml:linkText>Get-AatWorkingPackage</maml:linkText>

<maml:uri></maml:uri>

</maml:navigationLink>

</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>Test-AatAutomationPackage</command:name>

<command:verb>Test</command:verb>

<command:noun>AatAutomationPackage</command:noun>

<maml:description><maml:para>Tests an automation package.

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>Tests an automation package. If no package name is specified then the current working package will be tested.

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>Test-AatAutomationPackage</maml:name>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IgnoreWarnings</maml:name>

<maml:Description><maml:para>Specifies that warnings should note be reported.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>PackageName</maml:name>

<maml:Description><maml:para>Specifies the name of the package to test.

</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IgnoreWarnings</maml:name>

<maml:Description><maml:para>Specifies that warnings should note be reported.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>PackageName</maml:name>

<maml:Description><maml:para>Specifies the name of the package to test.

</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>None</maml:name>

</dev:type>

<maml:description><maml:para>

</maml:para>

</maml:description>

</command:inputType>

</command:inputTypes>

<command:returnValues><command:returnValue><dev:type><maml:name>PackageTestResult</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: Test the current working package</maml:title>

<dev:code>PS C:\&gt; Test-AatAutomationPackage

Message                                                                Severity

-------                                                                --------

Assets file 'assets.json' does not contain any of the supported prop   Error

No module defintions found in  'C:\aat-package-examples\bad\modules'   Warning

No runbooks found in  'C:\aat-package-examples\bad\runbooks'           Warning</dev:code>

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

<command:example><maml:title>Example 2: Test the current working package and ignore warnings</maml:title>

<dev:code>PS C:\&gt; Test-AatAutomationPackage -IgnoreWarnings

Message                                                                Severity

-------                                                                --------

Assets file 'assets.json' does not contain any of the supported prop   Error</dev:code>

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

<command:example><maml:title>Example 3: Test a specified package</maml:title>

<dev:code>PS C:\&gt; Test-AatAutomationPackage -PackageName example-3

Message                                                                Severity

-------                                                                --------

Assets file 'assets.json' does not contain any of the supported prop   Error

No runbooks found in  'C:\aat-package-examples\bad\runbooks'           Warning</dev:code>

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks></command:relatedLinks>

</command:command>

</helpItems>