Skip to content

Updated the RemoteApp help file for the changes in the cmdlet #299

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 25, 2015
Merged

Updated the RemoteApp help file for the changes in the cmdlet #299

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3a2fd43
Added updated help file for RemoteApp cmdlet
yadavb Mar 25, 2015
8807416
Merge branch 'release-0.8.16' of https://github.com/Azure/azure-power…
yadavb Mar 25, 2015
fd67879
Fixed the ambigous message
yadavb Mar 25, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
179 changes: 150 additions & 29 deletions ...ceManagement/RemoteApp/Commands.RemoteApp/Microsoft.Azure.Commands.RemoteApp.dll-help.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -589,10 +589,29 @@ Get-AzureRemoteAppCollection Finance* </dev:code>
</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>AsJob</maml:name>
<maml:description>
<maml:para>Allows running the cmdlet in the background as a PS job</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<!-- Cmdlet parameter section -->
<command:parameters>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>AsJob</maml:name>
<maml:description>
<maml:para>Allows running the cmdlet in the background as a PS job</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="1">
<maml:name>CollectionName</maml:name>
<maml:description>
Expand Down Expand Up @@ -724,14 +743,14 @@ Get-AzureRemoteAppCollection Finance* </dev:code>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2">
<maml:name>UsageMonth</maml:name>
<maml:description>
<maml:para>Two digit number for the usage month</maml:para>
<maml:para>Two digit number for the usage month. If not provided then the current month will be used.</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="3">
<maml:name>UsageYear</maml:name>
<maml:description>
<maml:para>Full year of the usage.</maml:para>
<maml:para>Full year of the usage. If not provided then the current year will be used.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
</command:parameter>
Expand All @@ -755,7 +774,7 @@ Get-AzureRemoteAppCollection Finance* </dev:code>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2">
<maml:name>UsageMonth</maml:name>
<maml:description>
<maml:para>Two digit number for the usage month</maml:para>
<maml:para>Two digit number for the usage month. If not provided then the current month will be used.</maml:para>

</maml:description>
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
Expand All @@ -768,7 +787,7 @@ Get-AzureRemoteAppCollection Finance* </dev:code>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3">
<maml:name>UsageYear</maml:name>
<maml:description>
<maml:para>Full year of the usage.</maml:para>
<maml:para>Full year of the usage. If not provided then the current year will be used.</maml:para>

</maml:description>
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
Expand Down Expand Up @@ -2729,7 +2748,7 @@ Invoke-AzureRemoteAppSessionLogoff -CollectionName ContosoApps -UserUpn user@con
</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="4">
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4">
<maml:name>VNetName</maml:name>
<maml:description>
<maml:para>Name of Microsoft Azure RemoteApp virtual network.</maml:para>
Expand All @@ -2743,13 +2762,20 @@ Invoke-AzureRemoteAppSessionLogoff -CollectionName ContosoApps -UserUpn user@con
</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="6">
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="6">
<maml:name>Credential</maml:name>
<maml:description>
<maml:para>Credential of a service account that has permission to join the RemoteApp servers to your domain.</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="7">
<maml:name>SubnetName</maml:name>
<maml:description>
<maml:para>Name of the Subnet in the Virtual Network which should be used to create the Microsoft Azure RemoteApp collection.</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>CustomRdpProperty</maml:name>
<maml:description>
Expand All @@ -2771,6 +2797,65 @@ Invoke-AzureRemoteAppSessionLogoff -CollectionName ContosoApps -UserUpn user@con
</maml:description>
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>New-AzureRemoteAppCollection</maml:name>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1">
<maml:name>CollectionName</maml:name>
<maml:description>
<maml:para>Name of the Microsoft Azure RemoteApp collection. </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="2">
<maml:name>ImageName</maml:name>
<maml:description>
<maml:para>Name of Microsoft Azure RemoteApp template image.</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="3">
<maml:name>Plan</maml:name>
<maml:description>
<maml:para>The plan for the Microsoft Azure RemoteApp collection, which may define the usage limits. Use Get-AzureRemoteAppPlan to see the plans available.</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="4">
<maml:name>VNetName</maml:name>
<maml:description>
<maml:para>Name of Microsoft Azure RemoteApp virtual network.</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="5">
<maml:name>Domain</maml:name>
<maml:description>
<maml:para>The name of the Active Directory Domain Services domain to join the RD Session Host servers to.</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="6">
<maml:name>Credential</maml:name>
<maml:description>
<maml:para>Credential of a service account that has permission to join the RemoteApp servers to your domain.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
<maml:name>CustomRdpProperty</maml:name>
<maml:description>
<maml:para>Custom RDP properties which can be used to configure drive redirection and other settings. See https://technet.microsoft.com/library/ff393699(v=ws.10).aspx for details. </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>Description</maml:name>
<maml:description>
<maml:para>A short description for the object.</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>OrganizationalUnit</maml:name>
<maml:description>
Expand Down Expand Up @@ -2823,13 +2908,6 @@ Invoke-AzureRemoteAppSessionLogoff -CollectionName ContosoApps -UserUpn user@con
</maml:description>
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named">
<maml:name>DnsServers</maml:name>
<maml:description>
<maml:para>A string containing a comma-separated list of IPv4 addresses of the DNS servers.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<!-- Cmdlet parameter section -->
Expand All @@ -2847,7 +2925,7 @@ Invoke-AzureRemoteAppSessionLogoff -CollectionName ContosoApps -UserUpn user@con
</dev:type>
<dev:defaultValue></dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6">
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="6">
<maml:name>Credential</maml:name>
<maml:description>
<maml:para>Credential of a service account that has permission to join the RemoteApp servers to your domain.</maml:para>
Expand Down Expand Up @@ -2964,7 +3042,20 @@ Invoke-AzureRemoteAppSessionLogoff -CollectionName ContosoApps -UserUpn user@con
</dev:type>
<dev:defaultValue></dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4">
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="7">
<maml:name>SubnetName</maml:name>
<maml:description>
<maml:para>Name of the Subnet in the Virtual Network which should be used to create the Microsoft Azure RemoteApp collection.</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="4">
<maml:name>VNetName</maml:name>
<maml:description>
<maml:para>Name of Microsoft Azure RemoteApp virtual network.</maml:para>
Expand Down Expand Up @@ -4905,31 +4996,61 @@ Send-AzureRemoteAppSessionMessage -CollectionName ContosoApps -UserUpn user@cont
</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="2">
<maml:name>Plan</maml:name>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
<maml:name>Description</maml:name>
<maml:description>
<maml:para>The plan for the Microsoft Azure RemoteApp collection, which may define the usage limits. Use Get-AzureRemoteAppPlan to see the plans available.</maml:para>
<maml:para>A short description for the collection.</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="6">
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Set-AzureRemoteAppCollection</maml:name>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1">
<maml:name>CollectionName</maml:name>
<maml:description>
<maml:para>Name of the Microsoft Azure RemoteApp collection.</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>Credential</maml:name>
<maml:description>
<maml:para>Credential of a service account that has permission to join the RemoteApp servers to your domain.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>CustomRdpProperty</maml:name>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Set-AzureRemoteAppCollection</maml:name>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1">
<maml:name>CollectionName</maml:name>
<maml:description>
<maml:para>Custom RDP properties which can be used to configure drive redirection and other settings. See https://technet.microsoft.com/library/ff393699(v=ws.10).aspx for details. </maml:para>
<maml:para>Name of the Microsoft Azure RemoteApp collection.</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>Description</maml:name>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
<maml:name>Plan</maml:name>
<maml:description>
<maml:para>A short description for the collection.</maml:para>
<maml:para>The plan for the Microsoft Azure RemoteApp collection, which may define the usage limits. Use Get-AzureRemoteAppPlan to see the plans available.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Set-AzureRemoteAppCollection</maml:name>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1">
<maml:name>CollectionName</maml:name>
<maml:description>
<maml:para>Name of the Microsoft Azure RemoteApp collection.</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>CustomRdpProperty</maml:name>
<maml:description>
<maml:para>Custom RDP properties which can be used to configure drive redirection and other settings. See https://technet.microsoft.com/library/ff393699(v=ws.10).aspx for details. </maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
</command:parameter>
Expand All @@ -4950,7 +5071,7 @@ Send-AzureRemoteAppSessionMessage -CollectionName ContosoApps -UserUpn user@cont
</dev:type>
<dev:defaultValue></dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6">
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
<maml:name>Credential</maml:name>
<maml:description>
<maml:para>Credential of a service account that has permission to join the RemoteApp servers to your domain.</maml:para>
Expand All @@ -4963,7 +5084,7 @@ Send-AzureRemoteAppSessionMessage -CollectionName ContosoApps -UserUpn user@cont
</dev:type>
<dev:defaultValue></dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>CustomRdpProperty</maml:name>
<maml:description>
<maml:para>Custom RDP properties which can be used to configure drive redirection and other settings. See https://technet.microsoft.com/library/ff393699(v=ws.10).aspx for details. </maml:para>
Expand All @@ -4976,7 +5097,7 @@ Send-AzureRemoteAppSessionMessage -CollectionName ContosoApps -UserUpn user@cont
</dev:type>
<dev:defaultValue></dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
<maml:name>Description</maml:name>
<maml:description>
<maml:para>A short description for the collection.</maml:para>
Expand All @@ -4989,7 +5110,7 @@ Send-AzureRemoteAppSessionMessage -CollectionName ContosoApps -UserUpn user@cont
</dev:type>
<dev:defaultValue></dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2">
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
<maml:name>Plan</maml:name>
<maml:description>
<maml:para>The plan for the Microsoft Azure RemoteApp collection, which may define the usage limits. Use Get-AzureRemoteAppPlan to see the plans available.</maml:para>
Expand Down