< Back
Set-AzureServiceRemoteDesktopExtension
Post
NAME Set-AzureServiceRemoteDesktopExtension
SYNOPSIS
Enables remote desktop extension on specified role(s) or all roles on a deployed service or at deployment.
SYNTAX
Set-AzureServiceRemoteDesktopExtension [[-ServiceName] <String>] [[-Slot] <String>] [[-Role] <String[]>] [[-X509Certificate] <X509Certificate2>]
[[-ThumbprintAlgorithm] <String>] [-Credential] <PSCredential> [[-Expiration] <DateTime>] [[-Version] <String>] [[-ExtensionId] <String>] [-Profile
<AzureSMProfile>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Set-AzureServiceRemoteDesktopExtension [[-ServiceName] <String>] [[-Slot] <String>] [[-Role] <String[]>] [-CertificateThumbprint] <String>
[[-ThumbprintAlgorithm] <String>] [-Credential] <PSCredential> [[-Expiration] <DateTime>] [[-Version] <String>] [[-ExtensionId] <String>] [-Profile
<AzureSMProfile>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
DESCRIPTION
The Set-AzureServiceRemoteDesktopExtension cmdlet enables remote desktop extension on specified roles or all roles on a deployed service or at
deployment.
PARAMETERS
-ServiceName <String>
Specifies the Azure service name of the deployment.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Slot <String>
Specifies the environment of the deployment to modify. The acceptable values for this parameter are: Production, Staging.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Role <String[]>
Specifies an optional array of roles for which to specify the remote desktop configuration. If this parameter is not specified, the remote desktop
configuration is applied as the default configuration for all roles.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-X509Certificate <X509Certificate2>
Specifies an x509 certificate that is automatically uploaded to the cloud service and used for encrypting the private configuration of the extension.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ThumbprintAlgorithm <String>
Specifies a thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default
is sha1.
Required? false
Position? 4
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Credential <PSCredential>
Specifies the credentials to enable for remote desktop. Credentials include a user name and password.
Required? true
Position? 5
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Expiration <DateTime>
Specifies a date time object that allows the user to specify when the user account expires.
Required? false
Position? 6
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Version <String>
Specifies the extension version.
Required? false
Position? 7
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ExtensionId <String>
Required? false
Position? 8
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Profile <AzureSMProfile>
Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InformationAction <ActionPreference>
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InformationVariable <String>
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CertificateThumbprint <String>
Specifies a certificate thumbprint to use to encrypt the private configuration. This certificate has to already exist in the certificate store. If
you do not specify a certificate, this cmdlet creates a certificate.
Required? true
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
-------------------------- Example 1: Enable remote desktop extension --------------------------
PS C:\\>Set-AzureServiceRemoteDesktopExtension -ServiceName $svc -Credentials $creds
This command enables the remote desktop extension for the specified service.
-------------------------- Example 2: Enable remote desktop extension for a specified role --------------------------
PS C:\\>Set-AzureServiceRemoteDesktopExtension -ServiceName $svc -Credentials $creds -Role "WebRole1"
This command enables the remote desktop extension for the specified service and role.
RELATED LINKS
Get-AzureServiceRemoteDesktopExtension
SYNOPSIS
Enables remote desktop extension on specified role(s) or all roles on a deployed service or at deployment.
SYNTAX
Set-AzureServiceRemoteDesktopExtension [[-ServiceName] <String>] [[-Slot] <String>] [[-Role] <String[]>] [[-X509Certificate] <X509Certificate2>]
[[-ThumbprintAlgorithm] <String>] [-Credential] <PSCredential> [[-Expiration] <DateTime>] [[-Version] <String>] [[-ExtensionId] <String>] [-Profile
<AzureSMProfile>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Set-AzureServiceRemoteDesktopExtension [[-ServiceName] <String>] [[-Slot] <String>] [[-Role] <String[]>] [-CertificateThumbprint] <String>
[[-ThumbprintAlgorithm] <String>] [-Credential] <PSCredential> [[-Expiration] <DateTime>] [[-Version] <String>] [[-ExtensionId] <String>] [-Profile
<AzureSMProfile>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
DESCRIPTION
The Set-AzureServiceRemoteDesktopExtension cmdlet enables remote desktop extension on specified roles or all roles on a deployed service or at
deployment.
PARAMETERS
-ServiceName <String>
Specifies the Azure service name of the deployment.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Slot <String>
Specifies the environment of the deployment to modify. The acceptable values for this parameter are: Production, Staging.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Role <String[]>
Specifies an optional array of roles for which to specify the remote desktop configuration. If this parameter is not specified, the remote desktop
configuration is applied as the default configuration for all roles.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-X509Certificate <X509Certificate2>
Specifies an x509 certificate that is automatically uploaded to the cloud service and used for encrypting the private configuration of the extension.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ThumbprintAlgorithm <String>
Specifies a thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default
is sha1.
Required? false
Position? 4
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Credential <PSCredential>
Specifies the credentials to enable for remote desktop. Credentials include a user name and password.
Required? true
Position? 5
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Expiration <DateTime>
Specifies a date time object that allows the user to specify when the user account expires.
Required? false
Position? 6
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Version <String>
Specifies the extension version.
Required? false
Position? 7
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ExtensionId <String>
Required? false
Position? 8
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Profile <AzureSMProfile>
Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InformationAction <ActionPreference>
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InformationVariable <String>
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CertificateThumbprint <String>
Specifies a certificate thumbprint to use to encrypt the private configuration. This certificate has to already exist in the certificate store. If
you do not specify a certificate, this cmdlet creates a certificate.
Required? true
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
-------------------------- Example 1: Enable remote desktop extension --------------------------
PS C:\\>Set-AzureServiceRemoteDesktopExtension -ServiceName $svc -Credentials $creds
This command enables the remote desktop extension for the specified service.
-------------------------- Example 2: Enable remote desktop extension for a specified role --------------------------
PS C:\\>Set-AzureServiceRemoteDesktopExtension -ServiceName $svc -Credentials $creds -Role "WebRole1"
This command enables the remote desktop extension for the specified service and role.
RELATED LINKS
Get-AzureServiceRemoteDesktopExtension