Edit

Share via

Enable-AzureServiceProjectRemoteDesktop

  • Reference
Module:
Azure

Enables remote desktop access to a cloud service.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Enable-AzureServiceProjectRemoteDesktop
      -Username <String>
      -Password <SecureString>
      [-PassThru]
      [-Profile <AzureSMProfile>]
      [<CommonParameters>]

Description

This topic describes the cmdlet in the 0.8.10 version of the Microsoft Azure PowerShell module. To get the version of the module you're using, in the Azure PowerShell console, type (Get-Module -Name Azure).Version.

The Enable-AzureServiceProjectRemoteDesktop cmdlet enables Remote Desktop access to a cloud service. You must publish the service using the Publish-AzureServiceProject cmdlet after enabling Remote Desktop access for the change to take effect.

Parameters

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Password

Specifies the password.

Type:SecureString
Aliases:pwd
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Type:AzureSMProfile
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Username

Specifies the user name to use when connecting to the role instance in Azure via the Remote Desktop Protocol (RDP).

Type:String
Aliases:user
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False