Introducing RemoteApp PowerShell Cmdlets and SDK
Published Sep 08 2018 06:14 AM 449 Views
Occasional Contributor
First published on CloudBlogs on Mar 16, 2015

My name is Sandeep Patnaik, and I work in the Remote Desktop team. Many of you reached out to us and asked for a way to manage Azure RemoteApp collections programmatically. I am excited to announce the public availability of the Azure RemoteApp PowerShell cmdlets, as part of the latest version of Microsoft Azure CLI tools (direct download from here ). Additionally, the RemoteApp .NET SDK is available as a NuGet package here .

Full documentation for the RemoteApp tools will be available soon, but in the meantime we have ensured that each of the cmdlets is accompanied by help. To get you started, here are some examples on how to use the cmdlets.

First, follow the instructions outlined here to start managing your subscription using Microsoft Azure PowerShell.

To create a cloud collection:

New-AzureRemoteAppCollection -Collectionname RAppO365Col1 -ImageName "Office 365 ProPlus (Subscription required)" -Plan Basic -Location "West US" -Description "Office 365 Collection."

The above command automatically publishes Microsoft Office 365 applications (Excel, OneNote, Outlook, PowerPoint, Visio and Word).

Collection creation can take 30 minutes or longer to complete. Therefore, this command returns a tracking ID that you can use as follows:

Get-AzureRemoteAppOperationResult -TrackingId xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

After the collection has been created, you can add users to a collection:

Add-AzureRemoteAppUser -Collectionname RAppO365Col1 -Type MicrosoftAccount -UserUpn

Here are all the cmdlets we have introduced:

RemoteApp collection cmdlets:

  • New-AzureRemoteAppCollection
  • Get-AzureRemoteAppCollection
  • Set-AzureRemoteAppCollection
  • Update-AzureRemoteAppCollection
  • Remove-AzureRemoteAppCollection
  • Add-AzureRemoteAppUser
  • Get-AzureRemoteAppUser
  • Remove-AzureRemoteAppUser
  • Get-AzureRemoteAppSession
  • Disconnect-AzureRemoteAppSession
  • Invoke-AzureRemoteAppSessionLogoff
  • Send-AzureRemoteAppSessionMessage
  • Get-AzureRemoteAppProgram
  • Get-AzureRemoteAppStartMenuProgram
  • Publish-AzureRemoteAppProgram
  • Unpublish-AzureRemoteAppProgram
  • Get-AzureRemoteAppCollectionUsageDetails
  • Get-AzureRemoteAppCollectionUsageSummary
  • Get-AzureRemoteAppPlan

RemoteApp virtual network cmdlets:

  • New-AzureRemoteAppVNet
  • Get-AzureRemoteAppVNet
  • Set-AzureRemoteAppVNet
  • Remove-AzureRemoteAppVNet
  • Get-AzureRemoteAppVpnDevice
  • Get-AzureRemoteAppVpnDeviceConfigScript
  • Reset-AzureRemoteAppVpnSharedKey

RemoteApp template image cmdlets:

  • New-AzureRemoteAppTemplateImage
  • Get-AzureRemoteAppTemplateImage
  • Rename-AzureRemoteAppTemplateImage
  • Remove-AzureRemoteAppTemplateImage

Other RemoteApp cmdlets:

  • Get-AzureRemoteAppLocation
  • Get-AzureRemoteAppWorkspace
  • Set-AzureRemoteAppWorkspace
  • Get-AzureRemoteAppOperationResult

Our goal is to provide you the best management experience. Let us know what you think of these new PowerShell cmdlets in the comments section below or on the Azure discussion forums . You can also submit feedback request on the Azure feedback site .

You can also file bugs directly here .

Happy scripting and happy coding!

Thank you!

Note: Questions and comments are welcome. However, please DO NOT post a request for troubleshooting by using the comment tool at the end of this post. Instead, post a new thread in the Azure RemoteApp forum .

Version history
Last update:
‎Sep 08 2018 06:14 AM