You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/cloud-services/cloud-services-role-config-xpath.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: The various XPath settings you can use in the cloud service role co
4
4
ms.topic: article
5
5
ms.service: cloud-services
6
6
ms.subservice: deployment-files
7
-
ms.date: 02/21/2023
7
+
ms.date: 07/23/2024
8
8
author: hirenshah1
9
9
ms.author: hirshah
10
10
ms.reviewer: mimckitt
@@ -116,7 +116,7 @@ Retrieves the endpoint port for the instance.
116
116
| Code |var port = RoleEnvironment.CurrentRoleInstance.InstanceEndpoints["Endpoint1"].IPEndpoint.Port; |
117
117
118
118
## Example
119
-
Here is an example of a worker role that creates a startup task with an environment variable named `TestIsEmulated` set to the [@emulated xpath value](#app-running-in-emulator).
119
+
Here's an example of a worker role that creates a startup task with an environment variable named `TestIsEmulated` set to the [@emulated xpath value](#app-running-in-emulator).
Remote Desktop enables you to access the desktop of a role running in Azure. You can use a Remote Desktop connection to troubleshoot and diagnose problems with your application while it is running.
22
+
Remote Desktop enables you to access the desktop of a role running in Azure. You can use a Remote Desktop connection to troubleshoot and diagnose problems with your application while it runs.
23
23
24
-
You can enable a Remote Desktop connection in your role during development by including the Remote Desktop modules in your service definition or you can choose to enable Remote Desktop through the Remote Desktop Extension. The preferred approach is to use the Remote Desktop extension as you can enable Remote Desktop even after the application is deployed without having to redeploy your application.
24
+
You can enable a Remote Desktop connection in your role during development by including the Remote Desktop modules in your service definition. Alternatively, you can choose to enable Remote Desktop through the Remote Desktop extension. The preferred approach is to use the Remote Desktop extension, as you can enable Remote Desktop even after the application is deployed without having to redeploy your application.
25
25
26
26
## Configure Remote Desktop from the Azure portal
27
27
28
-
The Azure portal uses the Remote Desktop Extension approach so you can enable Remote Desktop even after the application is deployed. The **Remote Desktop**settings for your cloud service allows you to enable Remote Desktop, change the local Administrator account used to connect to the virtual machines, the certificate used in authentication and set the expiration date.
28
+
The Azure portal uses the Remote Desktop Extension approach so you can enable Remote Desktop even after the application is deployed. The **Remote Desktop**setting for your cloud service allows you to enable Remote Desktop, change the local Administrator account used to connect to the virtual machines, the certificate used in authentication and set the expiration date.
29
29
30
-
1.Click**Cloud Services**, select the name of the cloud service, and then select **Remote Desktop**.
30
+
1.Select**Cloud Services**, select the name of the cloud service, and then select **Remote Desktop**.
@@ -42,23 +42,23 @@ The Azure portal uses the Remote Desktop Extension approach so you can enable Re
42
42
43
43
4. In **Roles**, select the role you want to update or select **All** for all roles.
44
44
45
-
5. When you finish your configuration updates, select **Save**. It will take a few moments before your role instances are ready to receive connections.
45
+
5. When you finish your configuration updates, select **Save**. It takes a few moments before your role instances are ready to receive connections.
46
46
47
47
## Remote into role instances
48
48
49
49
Once Remote Desktop is enabled on the roles, you can initiate a connection directly from the Azure portal:
50
50
51
-
1.Click**Instances** to open the **Instances** settings.
52
-
2.Select a role instance that has Remote Desktop configured.
53
-
3.Click**Connect** to download an RDP file for the role instance.
51
+
1.Select**Instances** to open the **Instances** settings.
52
+
2.Choose a role instance that has Remote Desktop configured.
53
+
3.Select**Connect** to download a Remote Desktop Protocol (RDP) file for the role instance.
4.Click**Open** and then **Connect** to start the Remote Desktop connection.
57
+
4.Choose**Open** and then **Connect** to start the Remote Desktop connection.
58
58
59
59
>[!NOTE]
60
60
> If your cloud service is sitting behind an NSG, you may need to create rules that allow traffic on ports **3389** and **20000**. Remote Desktop uses port **3389**. Cloud Service instances are load balanced, so you can't directly control which instance to connect to. The *RemoteForwarder* and *RemoteAccess* agents manage RDP traffic and allow the client to send an RDP cookie and specify an individual instance to connect to. The *RemoteForwarder* and *RemoteAccess* agents require that port **20000** is open, which may be blocked if you have an NSG.
61
61
62
-
## Additional resources
62
+
## Next steps
63
63
64
-
[How to Configure Cloud Services](cloud-services-how-to-configure-portal.md)
64
+
*[How to Configure Cloud Services](cloud-services-how-to-configure-portal.md)
Remote Desktop enables you to access the desktop of a role running in Azure. You can use a Remote Desktop connection to troubleshoot and diagnose problems with your application while it is running.
22
+
Remote Desktop enables you to access the desktop of a role running in Azure. You can use a Remote Desktop connection to troubleshoot and diagnose problems with your application while it runs.
23
23
24
24
This article describes how to enable remote desktop on your Cloud Service Roles using PowerShell. See [How to install and configure Azure PowerShell](/powershell/azure/) for the prerequisites needed for this article. PowerShell utilizes the Remote Desktop Extension so you can enable Remote Desktop after the application is deployed.
25
25
26
26
## Configure Remote Desktop from PowerShell
27
27
The [Set-AzureServiceRemoteDesktopExtension](/powershell/module/servicemanagement/azure/set-azureserviceremotedesktopextension) cmdlet allows you to enable Remote Desktop on specified roles or all roles of your cloud service deployment. The cmdlet lets you specify the Username and Password for the remote desktop user through the *Credential* parameter that accepts a PSCredential object.
28
28
29
-
If you are using PowerShell interactively, you can easily set the PSCredential object by calling the [Get-Credentials](/powershell/module/microsoft.powershell.security/get-credential) cmdlet.
29
+
If you use PowerShell interactively, you can easily set the PSCredential object by calling the [Get-Credentials](/powershell/module/microsoft.powershell.security/get-credential) cmdlet.
You can also optionally specify the deployment slot and roles that you want to enable remote desktop on. If these parameters are not specified, the cmdlet enables remote desktop on all roles in the **Production** deployment slot.
62
+
You can also optionally specify the deployment slot and roles that you want to enable remote desktop on. If these parameters aren't specified, the cmdlet enables remote desktop on all roles in the **Production** deployment slot.
63
63
64
64
The Remote Desktop extension is associated with a deployment. If you create a new deployment for the service, you have to enable remote desktop on that deployment. If you always want to have remote desktop enabled, then you should consider integrating the PowerShell scripts into your deployment workflow.
65
65
66
66
## Remote Desktop into a role instance
67
67
68
-
The [Get-AzureRemoteDesktopFile](/powershell/module/servicemanagement/azure/get-azureremotedesktopfile) cmdlet is used to remote desktop into a specific role instance of your cloud service. You can use the *LocalPath* parameter to download the RDP file locally. Or you can use the *Launch* parameter to directly launch the Remote Desktop Connection dialog to access the cloud service role instance.
68
+
The [Get-AzureRemoteDesktopFile](/powershell/module/servicemanagement/azure/get-azureremotedesktopfile) cmdlet is used to remote desktop into a specific role instance of your cloud service. You can use the *LocalPath* parameter to download the Remote Desktop Protocol (RDP) file locally. Or you can use the *Launch* parameter to directly launch the Remote Desktop Connection dialog to access the cloud service role instance.
## Check if Remote Desktop extension is enabled on a service
75
75
76
-
The [Get-AzureServiceRemoteDesktopExtension](/powershell/module/servicemanagement/azure/get-azureremotedesktopfile) cmdlet displays that remote desktop is enabled or disabled on a service deployment. The cmdlet returns the username for the remote desktop user and the roles that the remote desktop extension is enabled for. By default, this happens on the deployment slot and you can choose to use the staging slot instead.
76
+
The [Get-AzureServiceRemoteDesktopExtension](/powershell/module/servicemanagement/azure/get-azureremotedesktopfile) cmdlet displays that remote desktop is enabled or disabled on a service deployment. The cmdlet returns the username for the remote desktop user and the roles that the remote desktop extension is enabled for. By default, the deployment slot is used, but you can choose to use the staging slot instead.
If you have already enabled the remote desktop extension on a deployment, and need to update the remote desktop settings, first remove the extension. And enable it again with the new settings. For example, if you want to set a new password for the remote user account, or the account expired. Doing this is required on existing deployments that have the remote desktop extension enabled. For new deployments, you can simply apply the extension directly.
84
+
If you already enabled the remote desktop extension on a deployment and need to update the remote desktop settings, first remove the extension. Then, enable it again with the new settings. For example, if you want to set a new password for the remote user account or the account expired. Doing this step is required on existing deployments that have the remote desktop extension enabled. For new deployments, you can apply the extension directly.
85
85
86
86
To remove the remote desktop extension from the deployment, you can use the [Remove-AzureServiceRemoteDesktopExtension](/powershell/module/servicemanagement/azure/remove-azureserviceremotedesktopextension) cmdlet. You can also optionally specify the deployment slot and role from which you want to remove the remote desktop extension.
> The **UninstallConfiguration** parameter uninstalls any extension configuration that is applied to the service. Every extension configuration is associated with the service configuration. Calling the *remove* cmdlet without **UninstallConfiguration** disassociates the **deployment** from the extension configuration, thus effectively removing the extension. However, the extension configuration remains associated with the service.
96
96
97
-
## Additional resources
97
+
## Next steps
98
98
99
-
[How to Configure Cloud Services](cloud-services-how-to-configure-portal.md)
99
+
*[How to Configure Cloud Services](cloud-services-how-to-configure-portal.md)
0 commit comments