Set-AzureServiceRemoteDesktopExtension

Article
02/06/2015

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

Set-AzureServiceRemoteDesktopExtension

This cmdlet enables remote desktop extension on specified role(s) or all roles on a deployed service or at deployment.

Syntax

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

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

Detailed Description

This cmdlet enables remote desktop extension on specified role(s) or all roles on a deployed service or at deployment.

Parameters

-CertificateThumbprint<String>

A certificate thumbprint to use for encrypting the private configuration. If not specified a certificate will be created for you. This certificate has to already exist in the certificate store.

Aliases	none
Required?	true
Position?	4
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Credential<PSCredential>

The credentials (user name/password) to enable for remote desktop.

Aliases	none
Required?	true
Position?	6
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Expiration<DateTime>

A date time object that allows the user to specify when the user account will expire.

Aliases	none
Required?	false
Position?	7
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Role<String[]>

An optional array of roles to specify the remote desktop configuration for. If not specified the remote desktop configuration is applied as the default configuration for all roles.

Aliases	none
Required?	false
Position?	3
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ServiceName<String>

Specifies the Microsoft Azure service name of the deployment.

Aliases	none
Required?	false
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Slot<String>

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

Aliases	none
Required?	false
Position?	2
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ThumbprintAlgorithm<String>

Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.

Aliases	none
Required?	false
Position?	5
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Version<String>

Specifies the version of the extension to enable on the deployment.

Aliases	none
Required?	false
Position?	8
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-X509Certificate<X509Certificate2>

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

Aliases	none
Required?	false
Position?	4
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

<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.

Examples

-------------------------- EXAMPLE 1 --------------------------

Description

-----------

Setting default remote desktop configuration for all roles.

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

-------------------------- EXAMPLE 2 --------------------------

Description

-----------

Setting remote desktop configuration for WebRole1.

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

Set-AzureServiceRemoteDesktopExtension