Set-AzureServiceRemoteDesktopExtension

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Set-AzureServiceRemoteDesktopExtension

Enables a Remote Desktop extension on one or more specified roles or all roles on a deployed service or at deployment.

Parameter Set: SetExtension
Set-AzureServiceRemoteDesktopExtension [[-ServiceName] <String> ] [[-Slot] <String> ] [[-Role] <String[]> ] [[-X509Certificate] <X509Certificate2> ] [[-ThumbprintAlgorithm] <String> ] [-Credential] <PSCredential> [[-Expiration] <DateTime> ] [ <CommonParameters>]

Parameter Set: SetExtensionUsingThumbprint
Set-AzureServiceRemoteDesktopExtension [[-ServiceName] <String> ] [[-Slot] <String> ] [[-Role] <String[]> ] [-CertificateThumbprint] <String> [[-ThumbprintAlgorithm] <String> ] [-Credential] <PSCredential> [[-Expiration] <DateTime> ] [ <CommonParameters>]

This topic describes the cmdlet in the .6.19 version of the Windows Azure PowerShell module. To find out the version of the module you're using, from the Windows Azure PowerShell console, type (get-module azure).version.

This cmdlet enables remote desktop extension on one or more specified roles or all roles on a deployed service or at deployment.

-CertificateThumbprint<String>

Specifies the thumbprint of a certificate (from the Certificate store) to use for encrypting the private configuration. If not specified, a certificate is created automatically.

-Credential<PSCredential>

Specifies the name and password of the user account to enable for Remote Desktop access.

-Expiration<DateTime>

Allows you to specify when the user account will expire.

-Role<String[]>

Specifies the roles to which you want to apply the Remote Desktop configuration. If not specified, the Remote Desktop configuration is applied as the default configuration for all roles.

-ServiceName<String>

Specifies the Windows Azure service name of the deployment.

-Slot<String>

Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".

-ThumbprintAlgorithm<String>

Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. The default is SHA1.

-X509Certificate<X509Certificate2>

An x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private configuration.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see  about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Example 1

This example sets a default Remote Desktop configuration for all roles.

C:\PS>Set-AzureServiceRemoteDesktopExtension -ServiceName $svc -Credentials $creds

Example 2

This example sets a default Remote Desktop configuration for a role named “WebRole1”.

C:\PS>Set-AzureServiceRemoteDesktopExtension -ServiceName $svc -Credentials $creds -Role "WebRole1"

Related topics

New-AzureServiceRemoteDesktopExtensionConfig