Microsoft.VaaS.Commands.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?><helpItems 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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Add-AzureStackVaaSAccount</command:name> <maml:description> <maml:para>Adds an authenticated account to use for Azure Stack VaaS cmdlet requests.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureStackVaaSAccount</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-AzureStackVaaSAccount cmdlet adds an authenticated Azure account to use for Azure Stack VaaS cmdlet requests. You can either specify user credentials to authenticate or Service Principal.</maml:para> <maml:para>If specifying User credentials then a native application must be provisioned in your Azure AD directory with Delegated Permissions checked to access VaaS Api. Use that native application Id and Uri as Application Id and Uri when invoking the cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureStackVaaSAccount</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a PSCredential object. For more information about the PSCredential object, type Get-Help Get-Credential.</maml:para> <maml:para>The PSCredential object provides the user ID and password for organizational ID credentials, or the application ID and secret for service principal credentials. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Native Application Id that was provisioned in Azure AD directory. Specify this only when using User credentials.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationUri</maml:name> <maml:description> <maml:para>Native Application Uri that was provisioned in Azure AD directory. Specify this only when using User credentials.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>Specifies the ID of the tenant.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AzureStackVaaSAccount</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a PSCredential object. For more information about the PSCredential object, type Get-Help Get-Credential.</maml:para> <maml:para>The PSCredential object provides the user ID and password for organizational ID credentials, or the application ID and secret for service principal credentials. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>Specifies the ID of the tenant.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServicePrincipal</maml:name> <maml:description> <maml:para>Indicates that this account authenticates by providing service principal credentials. By default it uses User credentials.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a PSCredential object. For more information about the PSCredential object, type Get-Help Get-Credential.</maml:para> <maml:para>The PSCredential object provides the user ID and password for organizational ID credentials, or the application ID and secret for service principal credentials. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Native Application Id that was provisioned in Azure AD directory. Specify this only when using User credentials.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationUri</maml:name> <maml:description> <maml:para>Native Application Uri that was provisioned in Azure AD directory. Specify this only when using User credentials.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>Specifies the ID of the tenant.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServicePrincipal</maml:name> <maml:description> <maml:para>Indicates that this account authenticates by providing service principal credentials. By default it uses User 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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.VaaS.PowerShell.Profile.Models.PSVaaSProfile</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Add an account that requires interactive logon --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-AzureStackVaaSAccount -TenantId 'xxxx-xxxx-xxxx-xxxx'</dev:code> <dev:remarks> <maml:para>The command adds an Azure Stack VaaS account. </maml:para> <maml:para>To run Azure Stack VaaS cmdlets by using this account, you must provide Microsoft account or organizational ID credentials at the prompt. If multi-factor authentication is enabled for your credentials, you must log on by using the interactive option or use service principal authentication.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Add an account that authenticates by using organizational ID credentials --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> $Credential = Get-Credential PS C:\> Add-AzureStackAccount -Credential $Credential -TenantId 'xxxx-xxxx-xxxx-xxxx' </dev:code> <dev:remarks> <maml:para>The first command gets the user credentials, and then stores them in the $Credential variable. </maml:para> <maml:para>The second command adds a Azure Stack VaaS account that has the credentials in $Credential. </maml:para> <maml:para>This account authenticates with Azure AD using organizational ID credentials. You cannot use multi-factor authentication or Microsoft account credentials to run Azure Stack VaaS cmdlets by using this account. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Add an account using User Credentials --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> $secstr = ConvertTo-SecureString “<userPassword>” -AsPlainText -Force PS C:\> $mycreds = New-Object System.Management.Automation.PSCredential (“<usreName>”, $secstr) PS C:\> Add-AzureStackVaaSAccount -Credential $mycreds -ApplicationId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -ApplicationUri http://NativeClientUri -TenantId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</dev:code> <dev:remarks> <maml:para>This account authenticates with Azure AD using organizational ID credentials. You cannot use multi-factor authentication or Microsoft account credentials to run Azure Stack VaaS cmdlets by using this account.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Find-AzureStackVaaSTestLaunch</command:name> <maml:description> <maml:para>Searches for test launches.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Find</command:verb> <command:noun>AzureStackVaaSTestLaunch</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Find-AzureStackVaaSTestLaunch cmdlet finds test launches from an existing test pass and solution. To get information about all the test launches do not specify the Name parameter</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AzureStackVaaSTestLaunch</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Specifies the name of the solution to retrieve the test launch from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>TestPassName</maml:name> <maml:description> <maml:para>Specifies the name of the test pass under the solution to retrieve the test launch from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Optional. Specifies a name for the test launch. If not specified then all test launches inside the test pass are retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies tag information, as a hash table, to filter your results. Use the following formats: </maml:para> <maml:para>@{Name = 'tagName'} @{Name = 'tagName'; Value = 'tagValue'}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>Use this parameter to include all information about the test launch in the result.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Specifies the name of the solution to retrieve the test launch from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>TestPassName</maml:name> <maml:description> <maml:para>Specifies the name of the test pass under the solution to retrieve the test launch from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Optional. Specifies a name for the test launch. If not specified then all test launches inside the test pass are retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies tag information, as a hash table, to filter your results. Use the following formats: </maml:para> <maml:para>@{Name = 'tagName'} @{Name = 'tagName'; Value = 'tagValue'}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>Use this parameter to include all information about the test launch in the result.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<Microsoft.VaaS.PowerShell.Test.Models.PSVaaSTestManifest></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Find all test launches --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Find-AzureStackVaaSTestLaunch -SolutionName Contoso -TestPassName 2016.11.16.TP2 -Detailed</dev:code> <dev:remarks> <maml:para>The command finds all test launches under the 2016.11.16.TP2 test pass which is under solution Contoso. Detailed properties are listed in the output.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Find-AzureStackVaaSTestPass</command:name> <maml:description> <maml:para>Searches for test passes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Find</command:verb> <command:noun>AzureStackVaaSTestPass</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Find-AzureStackVaaSTestPass cmdlet finds test passes from an existing solution. To get information about all the test passes in a soluton do not specify the Name parameter</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AzureStackVaaSTestPass</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Specifies the name of the solution to retrieve the test pass from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Optional. Specifies a name for the test pass. If not specified then all test passes inside the solution are retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies tag information, as a hash table, to filter your results. Use the following formats: </maml:para> <maml:para>@{Name = 'tagName'} @{Name = 'tagName'; Value = 'tagValue'}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>Use this parameter to include all information about the test pass in the result.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Specifies the name of the solution to retrieve the test pass from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Optional. Specifies a name for the test pass. If not specified then all test passes inside the solution are retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies tag information, as a hash table, to filter your results. Use the following formats: </maml:para> <maml:para>@{Name = 'tagName'} @{Name = 'tagName'; Value = 'tagValue'}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>Use this parameter to include all information about the test pass in the result.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<Microsoft.VaaS.PowerShell.TestPass.Models.PSVaaSTestPass></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Find all test passes. --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Find-AzureStackVaaSTestPass -SolutionName Contoso</dev:code> <dev:remarks> <maml:para>The command finds all test passes inside Contoso solution.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureStackVaaSTestLaunch</command:name> <maml:description> <maml:para>Gets a test launch.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureStackVaaSTestLaunch</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureStackVaaSTestLaunch cmdlet gets a test launch from an existing test pass under a solution. To get information about all the test launches use the Find-AzureStackVaaSTestLaunch without specifying Name parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureStackVaaSTestLaunch</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Specifies the name of the solution to retrieve the test launch from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>TestPassName</maml:name> <maml:description> <maml:para>Specifies the name of the test pass, under the solution, to retrieve the test launch from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the test launch. An exception is thrown if the test launch is not found.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Specifies the name of the solution to retrieve the test launch from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>TestPassName</maml:name> <maml:description> <maml:para>Specifies the name of the test pass, under the solution, to retrieve the test launch from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the test launch. An exception is thrown if the test launch is not found.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.VaaS.PowerShell.TestPass.Models.PSVaaSTestPass</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Get a test launch by name --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureStackVaaSTestLaunch -SolutionName Contoso -TestPassName 2016.11.16.TP2 -Name SampleLaunch</dev:code> <dev:remarks> <maml:para>The command gets the test launch SampleLaunch under test pass 2016.11.16.TP2 in your solution Contoso.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureStackVaaSTestPass</command:name> <maml:description> <maml:para>Gets a test pass.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureStackVaaSTestPass</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureStackVaaSTestPass cmdlet gets a test pass from an existing solution. To get information about all the test passes in a soluton use the Find-AzureStackVaaSTestPass without specifying Name parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureStackVaaSTestPass</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Specifies the name of the solution to retrieve the test pass from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the test pass. An exception is thrown if the test pass is not found.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Specifies the name of the solution to retrieve the test pass from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the test pass. An exception is thrown if the test pass is not found.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.VaaS.PowerShell.TestPass.Models.PSVaaSTestPass</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Get a test pass by name --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureStackVaaSTestPass -SolutionName Contoso -Name 2016.11.16.TP2</dev:code> <dev:remarks> <maml:para>The command gets the test pass in your solution named Contoso.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureStackVaaSSolution</command:name> <maml:description> <maml:para>Creates a Solution.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureStackVaaSSolution</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureStackVaaSSolution cmdlet creates a solution. You can create a solution by using just a name. </maml:para> <maml:para>To add a test pass to an existing solution use the New-AzureStackVaaSTestPass cmdlet. A Solution is a logical group or collection of all Test Passes. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureStackVaaSSolution</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the solution. The solution name must be unique in Tenant. If a solution that has that name already exists, the command prompts you for confirmation before replacing the existing solution.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a hash table of tags. To add or change a tag, you must replace the collection of tags for the solution. </maml:para> <maml:para>A tag is a name-value pair that you can create and apply. After you assign tags, you can use the Tags parameter of Find-AzureStackVaaSSolution to search for solution by tag name or by name and value. </maml:para> <maml:para>Each tag must have a Name key. To specify a tag, use a hash table, such as @{Name="Department";Value="IT"}. To specify multiple tags, use commas to separate the hash tables, such as @{Name="Inventory";Value="Send"}, @{Name="Department";Value="IT"}. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the solution. The solution name must be unique in Tenant. If a solution that has that name already exists, the command prompts you for confirmation before replacing the existing solution.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a hash table of tags. To add or change a tag, you must replace the collection of tags for the solution. </maml:para> <maml:para>A tag is a name-value pair that you can create and apply. After you assign tags, you can use the Tags parameter of Find-AzureStackVaaSSolution to search for solution by tag name or by name and value. </maml:para> <maml:para>Each tag must have a Name key. To specify a tag, use a hash table, such as @{Name="Department";Value="IT"}. To specify multiple tags, use commas to separate the hash tables, such as @{Name="Inventory";Value="Send"}, @{Name="Department";Value="IT"}. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation. </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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.VaaS.PowerShell.Solution.Models.PSVaaSSolution</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Create a solution --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>New-AzureStackVaaSSolution -Name Contoso</dev:code> <dev:remarks> <maml:para>The command creates a solution named Contoso</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Create a Solution with Tags --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>New-AzureStackVaaSSolution -Name Contoso -Tags @{Name="Department";Value="IT"}</dev:code> <dev:remarks> <maml:para>Creates a solution Contoso with Tags</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureStackVaaSTestPass</command:name> <maml:description> <maml:para>Creates a Test Pass inside a solution.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureStackVaaSTestPass</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureStackVaaSTestPass cmdlet adds a test pass to an existing solution. </maml:para> <maml:para>To launch a test pass to an existing test pass use the New-AzureStackVaaSTestLaunch cmdlet. A Test Pass is a collection of all tests launches. Usually, there is a one to one correspondence between a test pass and each Azure Stack deploytment of build.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureStackVaaSTestPass</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Specifies the name of the solution to add this test pass under.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the test pass. The test pass name must be unique in Solution. If a test pass that has that name already exists, the command prompts you for confirmation before replacing the existing test pass.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a hash table of tags. To add or change a tag, you must replace the collection of tags for the test pass. </maml:para> <maml:para>A tag is a name-value pair that you can create and apply. After you assign tags, you can use the Tags parameter of Find-AzureStackVaaSTestPass to search for test pass by tag name or by name and value. </maml:para> <maml:para>Each tag must have a Name key. To specify a tag, use a hash table, such as @{Name="Department";Value="IT"}. To specify multiple tags, use commas to separate the hash tables, such as @{Name="Inventory";Value="Send"}, @{Name="Department";Value="IT"}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Specifies the name of the solution to add this test pass under.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the test pass. The test pass name must be unique in Solution. If a test pass that has that name already exists, the command prompts you for confirmation before replacing the existing test pass.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a hash table of tags. To add or change a tag, you must replace the collection of tags for the test pass. </maml:para> <maml:para>A tag is a name-value pair that you can create and apply. After you assign tags, you can use the Tags parameter of Find-AzureStackVaaSTestPass to search for test pass by tag name or by name and value. </maml:para> <maml:para>Each tag must have a Name key. To specify a tag, use a hash table, such as @{Name="Department";Value="IT"}. To specify multiple tags, use commas to separate the hash tables, such as @{Name="Inventory";Value="Send"}, @{Name="Department";Value="IT"}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation. </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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.VaaS.PowerShell.TestPass.Models.PSVaaSTestPass</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Create a Test Pass under an existing solution --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>New-AzureStackVaaSSolution -Name 2016.11.16.TP2 -SolutionName Contoso</dev:code> <dev:remarks> <maml:para>The command adds a test pass named 2016.11.16.TP2 to Contoso</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Create a Test Pass under an existing solution with Tags --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>New-AzureStackVaaSTestPass -Name 2016.11.16.TP2 -SolutionName Contoso -Tags @{Name="Department";Value="IT"}</dev:code> <dev:remarks> <maml:para>The command adds a test pass named 2016.11.16.TP2 to Contoso with Tags</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureStackVaaSTestLaunch</command:name> <maml:description> <maml:para>Launches a new test under a test pass.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureStackVaaSTestLaunch</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureStackVaaSTestLaunch cmdlet adds a test launch to an existing test pass. </maml:para> <maml:para>The Test launch uses a test manifest template which describes how to execute the test with what binaries. The parameters template file specifies the values for any parameters defined in the test manifest template. The model for both the templates is JavaScript Object Notation (JSON)</maml:para> <maml:para>The test manifest template and the test parameters template file can either be a well form URI path or a local path.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureStackVaaSTestLaunch</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Specifies the name of the solution to add this test launch under.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TestPassName</maml:name> <maml:description> <maml:para>Specifies the name of the test pass within the solution to add this test launch under.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AgentName</maml:name> <maml:description> <maml:para>Specifies the location where the test execution should occur. If not specified then test execution happens from Azure Cloud provisioned agent. This will require in-bound connectivity to Azure Stack environment. The Agent name if specified can be maximum 15 alpha-numeric characters with only dash (-) allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateFile</maml:name> <maml:description> <maml:para>Specifies the full path of a test manifest template file that this cmdlet uses for the test launch. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a hash table of tags. To add or change a tag, you must replace the collection of tags for the test pass. </maml:para> <maml:para>A tag is a name-value pair that you can create and apply. After you assign tags, you can use the Tags parameter of Find-AzureStackVaaSTestLaunch to search for test launch by tag name or by name and value. </maml:para> <maml:para>Each tag must have a Name key. To specify a tag, use a hash table, such as @{Name="Department";Value="IT"}. To specify multiple tags, use commas to separate the hash tables, such as @{Name="Inventory";Value="Send"}, @{Name="Department";Value="IT"}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureStackVaaSTestLaunch</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Specifies the name of the solution to add this test launch under.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TestPassName</maml:name> <maml:description> <maml:para>Specifies the name of the test pass within the solution to add this test launch under.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AgentName</maml:name> <maml:description> <maml:para>Specifies the location where the test execution should occur. If not specified then test execution happens from Azure Cloud provisioned agent. This will require in-bound connectivity to Azure Stack environment. The Agent name if specified can be maximum 15 alpha-numeric characters with only dash (-) allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateFile</maml:name> <maml:description> <maml:para>Specifies the full path of a test manifest template file that this cmdlet uses for the test launch. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateParameterFile</maml:name> <maml:description> <maml:para>Specifies the full path of a file that contains parameter values, for the parameters defined in test manifest template, for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a hash table of tags. To add or change a tag, you must replace the collection of tags for the test pass. </maml:para> <maml:para>A tag is a name-value pair that you can create and apply. After you assign tags, you can use the Tags parameter of Find-AzureStackVaaSTestLaunch to search for test launch by tag name or by name and value. </maml:para> <maml:para>Each tag must have a Name key. To specify a tag, use a hash table, such as @{Name="Department";Value="IT"}. To specify multiple tags, use commas to separate the hash tables, such as @{Name="Inventory";Value="Send"}, @{Name="Department";Value="IT"}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureStackVaaSTestLaunch</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Specifies the name of the solution to add this test launch under.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TestPassName</maml:name> <maml:description> <maml:para>Specifies the name of the test pass within the solution to add this test launch under.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AgentName</maml:name> <maml:description> <maml:para>Specifies the location where the test execution should occur. If not specified then test execution happens from Azure Cloud provisioned agent. This will require in-bound connectivity to Azure Stack environment. The Agent name if specified can be maximum 15 alpha-numeric characters with only dash (-) allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateFile</maml:name> <maml:description> <maml:para>Specifies the full path of a test manifest template file that this cmdlet uses for the test launch. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateParameterUri</maml:name> <maml:description> <maml:para>Specifies the URI of a file that contains test parameter values for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateParameterVersion</maml:name> <maml:description> <maml:para>Specifies the content version of a parameter template file that this cmdlet uses for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a hash table of tags. To add or change a tag, you must replace the collection of tags for the test pass. </maml:para> <maml:para>A tag is a name-value pair that you can create and apply. After you assign tags, you can use the Tags parameter of Find-AzureStackVaaSTestLaunch to search for test launch by tag name or by name and value. </maml:para> <maml:para>Each tag must have a Name key. To specify a tag, use a hash table, such as @{Name="Department";Value="IT"}. To specify multiple tags, use commas to separate the hash tables, such as @{Name="Inventory";Value="Send"}, @{Name="Department";Value="IT"}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureStackVaaSTestLaunch</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Specifies the name of the solution to add this test launch under.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TestPassName</maml:name> <maml:description> <maml:para>Specifies the name of the test pass within the solution to add this test launch under.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AgentName</maml:name> <maml:description> <maml:para>Specifies the location where the test execution should occur. If not specified then test execution happens from Azure Cloud provisioned agent. This will require in-bound connectivity to Azure Stack environment. The Agent name if specified can be maximum 15 alpha-numeric characters with only dash (-) allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateFile</maml:name> <maml:description> <maml:para>Specifies the full path of a test manifest template file that this cmdlet uses for the test launch. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateParameterObject</maml:name> <maml:description> <maml:para>Specifies a hash table that contains test manifest template parameter values for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a hash table of tags. To add or change a tag, you must replace the collection of tags for the test pass. </maml:para> <maml:para>A tag is a name-value pair that you can create and apply. After you assign tags, you can use the Tags parameter of Find-AzureStackVaaSTestLaunch to search for test launch by tag name or by name and value. </maml:para> <maml:para>Each tag must have a Name key. To specify a tag, use a hash table, such as @{Name="Department";Value="IT"}. To specify multiple tags, use commas to separate the hash tables, such as @{Name="Inventory";Value="Send"}, @{Name="Department";Value="IT"}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureStackVaaSTestLaunch</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Specifies the name of the solution to add this test launch under.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TestPassName</maml:name> <maml:description> <maml:para>Specifies the name of the test pass within the solution to add this test launch under.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AgentName</maml:name> <maml:description> <maml:para>Specifies the location where the test execution should occur. If not specified then test execution happens from Azure Cloud provisioned agent. This will require in-bound connectivity to Azure Stack environment. The Agent name if specified can be maximum 15 alpha-numeric characters with only dash (-) allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateUri</maml:name> <maml:description> <maml:para>Specifies the URI of a file that contains test manifest template for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateVersion</maml:name> <maml:description> <maml:para>Specifies the content version of a test manifest template file that this cmdlet uses for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateParameterUri</maml:name> <maml:description> <maml:para>Specifies the URI of a file that contains test parameter values for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateParameterVersion</maml:name> <maml:description> <maml:para>Specifies the content version of a parameter template file that this cmdlet uses for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a hash table of tags. To add or change a tag, you must replace the collection of tags for the test pass. </maml:para> <maml:para>A tag is a name-value pair that you can create and apply. After you assign tags, you can use the Tags parameter of Find-AzureStackVaaSTestLaunch to search for test launch by tag name or by name and value. </maml:para> <maml:para>Each tag must have a Name key. To specify a tag, use a hash table, such as @{Name="Department";Value="IT"}. To specify multiple tags, use commas to separate the hash tables, such as @{Name="Inventory";Value="Send"}, @{Name="Department";Value="IT"}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureStackVaaSTestLaunch</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Specifies the name of the solution to add this test launch under.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TestPassName</maml:name> <maml:description> <maml:para>Specifies the name of the test pass within the solution to add this test launch under.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AgentName</maml:name> <maml:description> <maml:para>Specifies the location where the test execution should occur. If not specified then test execution happens from Azure Cloud provisioned agent. This will require in-bound connectivity to Azure Stack environment. The Agent name if specified can be maximum 15 alpha-numeric characters with only dash (-) allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateUri</maml:name> <maml:description> <maml:para>Specifies the URI of a file that contains test manifest template for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateVersion</maml:name> <maml:description> <maml:para>Specifies the content version of a test manifest template file that this cmdlet uses for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a hash table of tags. To add or change a tag, you must replace the collection of tags for the test pass. </maml:para> <maml:para>A tag is a name-value pair that you can create and apply. After you assign tags, you can use the Tags parameter of Find-AzureStackVaaSTestLaunch to search for test launch by tag name or by name and value. </maml:para> <maml:para>Each tag must have a Name key. To specify a tag, use a hash table, such as @{Name="Department";Value="IT"}. To specify multiple tags, use commas to separate the hash tables, such as @{Name="Inventory";Value="Send"}, @{Name="Department";Value="IT"}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureStackVaaSTestLaunch</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Specifies the name of the solution to add this test launch under.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TestPassName</maml:name> <maml:description> <maml:para>Specifies the name of the test pass within the solution to add this test launch under.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AgentName</maml:name> <maml:description> <maml:para>Specifies the location where the test execution should occur. If not specified then test execution happens from Azure Cloud provisioned agent. This will require in-bound connectivity to Azure Stack environment. The Agent name if specified can be maximum 15 alpha-numeric characters with only dash (-) allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateUri</maml:name> <maml:description> <maml:para>Specifies the URI of a file that contains test manifest template for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateVersion</maml:name> <maml:description> <maml:para>Specifies the content version of a test manifest template file that this cmdlet uses for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateParameterFile</maml:name> <maml:description> <maml:para>Specifies the full path of a file that contains parameter values, for the parameters defined in test manifest template, for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a hash table of tags. To add or change a tag, you must replace the collection of tags for the test pass. </maml:para> <maml:para>A tag is a name-value pair that you can create and apply. After you assign tags, you can use the Tags parameter of Find-AzureStackVaaSTestLaunch to search for test launch by tag name or by name and value. </maml:para> <maml:para>Each tag must have a Name key. To specify a tag, use a hash table, such as @{Name="Department";Value="IT"}. To specify multiple tags, use commas to separate the hash tables, such as @{Name="Inventory";Value="Send"}, @{Name="Department";Value="IT"}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureStackVaaSTestLaunch</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Specifies the name of the solution to add this test launch under.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TestPassName</maml:name> <maml:description> <maml:para>Specifies the name of the test pass within the solution to add this test launch under.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AgentName</maml:name> <maml:description> <maml:para>Specifies the location where the test execution should occur. If not specified then test execution happens from Azure Cloud provisioned agent. This will require in-bound connectivity to Azure Stack environment. The Agent name if specified can be maximum 15 alpha-numeric characters with only dash (-) allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateUri</maml:name> <maml:description> <maml:para>Specifies the URI of a file that contains test manifest template for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateVersion</maml:name> <maml:description> <maml:para>Specifies the content version of a test manifest template file that this cmdlet uses for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateParameterObject</maml:name> <maml:description> <maml:para>Specifies a hash table that contains test manifest template parameter values for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a hash table of tags. To add or change a tag, you must replace the collection of tags for the test pass. </maml:para> <maml:para>A tag is a name-value pair that you can create and apply. After you assign tags, you can use the Tags parameter of Find-AzureStackVaaSTestLaunch to search for test launch by tag name or by name and value. </maml:para> <maml:para>Each tag must have a Name key. To specify a tag, use a hash table, such as @{Name="Department";Value="IT"}. To specify multiple tags, use commas to separate the hash tables, such as @{Name="Inventory";Value="Send"}, @{Name="Department";Value="IT"}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Specifies the name of the solution to add this test launch under.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TestPassName</maml:name> <maml:description> <maml:para>Specifies the name of the test pass within the solution to add this test launch under.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AgentName</maml:name> <maml:description> <maml:para>Specifies the location where the test execution should occur. If not specified then test execution happens from Azure Cloud provisioned agent. This will require in-bound connectivity to Azure Stack environment. The Agent name if specified can be maximum 15 alpha-numeric characters with only dash (-) allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateFile</maml:name> <maml:description> <maml:para>Specifies the full path of a test manifest template file that this cmdlet uses for the test launch. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateParameterUri</maml:name> <maml:description> <maml:para>Specifies the URI of a file that contains test parameter values for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateParameterVersion</maml:name> <maml:description> <maml:para>Specifies the content version of a parameter template file that this cmdlet uses for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateParameterFile</maml:name> <maml:description> <maml:para>Specifies the full path of a file that contains parameter values, for the parameters defined in test manifest template, for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateParameterObject</maml:name> <maml:description> <maml:para>Specifies a hash table that contains test manifest template parameter values for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a hash table of tags. To add or change a tag, you must replace the collection of tags for the test pass. </maml:para> <maml:para>A tag is a name-value pair that you can create and apply. After you assign tags, you can use the Tags parameter of Find-AzureStackVaaSTestLaunch to search for test launch by tag name or by name and value. </maml:para> <maml:para>Each tag must have a Name key. To specify a tag, use a hash table, such as @{Name="Department";Value="IT"}. To specify multiple tags, use commas to separate the hash tables, such as @{Name="Inventory";Value="Send"}, @{Name="Department";Value="IT"}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation. </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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateUri</maml:name> <maml:description> <maml:para>Specifies the URI of a file that contains test manifest template for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateVersion</maml:name> <maml:description> <maml:para>Specifies the content version of a test manifest template file that this cmdlet uses for the test launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.VaaS.PowerShell.Test.Models.PSVaaSTestManifest</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Launch a test using custom template and parameter file --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>New-AzureStackVaaSTestLaunch -SolutionName Contoso -TestPass 2016.11.16.TP2 -TemplateFile "D:\AzureStack\TestManifestTemplates\ReliabilityCRP.json" -TemplateParameterFile "D:\AzureStack\ParameterTemplates\ReliabilityCRPParams.json" </dev:code> <dev:remarks> <maml:para>The command launches a test based on a custom template and a parameters file. The TemplateParameterFile parameter specifies a file of parameters and parameter values.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Launch a test using template URI and parameter object --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> $params = @{serviceAdmin="ContosoAdmin";tenantAdmin="ContosoTenant"} PS C:\> New-AzureStackVaaSTestLaunch -SolutionName Contoso -TestPass 2016.11.16.TP2 -TemplateURI http://contoso.com/testmanifesttemplate/reliabilityCRP.json -TemplateVersion 1.0.0.0 -TemplateParameterObject $params</dev:code> <dev:remarks> <maml:para>The first command saves a hash table of the test manifest template parameter values in the $Params variable. The second command launches the test by specifying a test manifest template URI and the parameter object. The TemplateVersion value must match the Content Version value in the test manifest template.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Find-AzureStackVaaSSolution</command:name> <maml:description> <maml:para>Searches for solutions.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Find</command:verb> <command:noun>AzureStackVaaSSolution</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Find-AzureStackVaaSSolution cmdlet finds solution. To get information about all the solutions do not specify the Name parameter</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AzureStackVaaSSolution</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Optional. Specifies a name for the solution. If not specified then all solutions are retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies tag information, as a hash table, to filter your results. Use the following formats: </maml:para> <maml:para>@{Name = 'tagName'} @{Name = 'tagName'; Value = 'tagValue'}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>Use this parameter to include all information about the solution in the result.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Optional. Specifies a name for the solution. If not specified then all solutions are retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies tag information, as a hash table, to filter your results. Use the following formats: </maml:para> <maml:para>@{Name = 'tagName'} @{Name = 'tagName'; Value = 'tagValue'}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>Use this parameter to include all information about the solution in the result.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<Microsoft.VaaS.PowerShell.Solution.Models.PSVaaSSolution></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Find all solutions --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Find-AzureStackVaaSSolution </dev:code> <dev:remarks> <maml:para>The command finds all solutions inside a tenant.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureStackVaaSSolution</command:name> <maml:description> <maml:para>Gets a solution.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureStackVaaSSolution</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureStackVaaSSolution cmdlet gets a solution. To get information about all the solution use the Find-AzureStackVaaSSolution without specifying Name parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureStackVaaSSolution</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the solution. An exception is thrown if the solution is not found.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the solution. An exception is thrown if the solution is not found.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.VaaS.PowerShell.Solution.Models.PSVaaSSolution</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Get solution by name --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureStackVaaSSolution -Name Contoso</dev:code> <dev:remarks> <maml:para>The command gets the solution named Contoso.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Find-AzureStackVaaSOnPremAgent</command:name> <maml:description> <maml:para>Searches for on-prem agents.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Find</command:verb> <command:noun>AzureStackVaaSOnPremAgent</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Find-AzureStackVaaSOnPremAgent cmdlet finds an on-prem agent. To get information about all the on-prem agents do not specify the Name parameter</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AzureStackVaaSOnPremAgent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Optional. Specifies a name for the on-prem agent. If not specified then all on-prem agents are retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies tag information, as a hash table, to filter your results. Use the following formats: </maml:para> <maml:para>@{Name = 'tagName'} @{Name = 'tagName'; Value = 'tagValue'}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>Use this parameter to include all information about the on-prem in the result.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Optional. Specifies a name for the on-prem agent. If not specified then all on-prem agents are retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies tag information, as a hash table, to filter your results. Use the following formats: </maml:para> <maml:para>@{Name = 'tagName'} @{Name = 'tagName'; Value = 'tagValue'}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>Use this parameter to include all information about the on-prem in the result.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<Microsoft.VaaS.PowerShell.OnPremAgent.Models.PSVaaSOnPremAgent></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Find all on-prem agents --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Find-AzureStackVaaSOnPremAgent</dev:code> <dev:remarks> <maml:para>The command finds all on-prem agents inside a tenant.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureStackVaaSOnPremAgent</command:name> <maml:description> <maml:para>Gets a on-prem agent.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureStackVaaSOnPremAgent</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureStackVaaSOnPremAgent cmdlet gets an on-prem agent information. To get information about all the on-prem use the Find-AzureStackVaaSOnPremAgent without specifying Name parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureStackVaaSOnPremAgent</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the on-prem agent. An exception is thrown if the on-prem agent is not found.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the on-prem agent. An exception is thrown if the on-prem agent is not found.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.VaaS.PowerShell.OnPremAgent.Models.PSVaaSOnPremAgent</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Get on-prem agent by name --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureStackVaaSOnPremAgent -Name OnPrem-Agent01</dev:code> <dev:remarks> <maml:para>The command gets the on-prem agent named OnPrem-Agent01.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureStackVaaSOnPremAgent</command:name> <maml:description> <maml:para>Removes the agent.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureStackVaaSOnPremAgent</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureStackVaaSOnPremAgent deletes the agent and all resources acquired by it. Ensure no test launches are using the agent when it is deleted. Deleting an on-prem agent that is currently executing tests can cause unexpected test results. Cancel the test using Stop-AzureStackVaaSTestLaunch prior to deleting the agent.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureStackVaaSOnPremAgent</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the on-prem agent. An exception is thrown if the on-prem agent is not found.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the on-prem agent. An exception is thrown if the on-prem agent is not found.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation. </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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Remove an on-prem agent --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-AzureStackVaaSOnPremAgent -Name OnPrem-Agent01 -Force</dev:code> <dev:remarks> <maml:para>The command removes the on-prem agent OnPrem-Agent01 without confirmation.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Stop-AzureStackVaaSTestLaunch</command:name> <maml:description> <maml:para>Cancels a test launch.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>AzureStackVaaSTestLaunch</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Stop-AzureStackVaaSTestLaunch cancels the test inside a test pass if it is currently active.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-AzureStackVaaSTestLaunch</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Specifies the name of the solution.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>TestPassName</maml:name> <maml:description> <maml:para>Specifies the name of the test pass.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the test to cancel.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Specifies the name of the solution.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>TestPassName</maml:name> <maml:description> <maml:para>Specifies the name of the test pass.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the test to cancel.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation. </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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Cancel a test execution --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Stop-AzureStackVaaSTestLaunch -SolutionName Contoso -TestPassName 2016.11.16.TP2 -Name TestLaunch01</dev:code> <dev:remarks> <maml:para>The command cancels the test TestLaunch01 in a test pass 2016.11.16.TP2 under solution Contoso.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> </helpItems> |