New-AzureServiceRemoteDesktopExtensionConfig
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
New-AzureServiceRemoteDesktopExtensionConfig
Creates configuration of a Remote Desktop extension for any deployment.
Parameter Set: NewExtension
New-AzureServiceRemoteDesktopExtensionConfig [[-Role] <String[]> ] [[-X509Certificate] <X509Certificate2> ] [[-ThumbprintAlgorithm] <String> ] [-Credential] <PSCredential> [[-Expiration] <DateTime> ] [ <CommonParameters>]
Parameter Set: NewExtensionUsingThumbprint
New-AzureServiceRemoteDesktopExtensionConfig [[-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 cmdlets generates configuration of remote desktop extension for any 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.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies the name and password of the user account to enable for Remote Desktop access.
Aliases |
none |
Required? |
true |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Expiration<DateTime>
Allows you to specify when the user account will expire.
Aliases |
none |
Required? |
false |
Position? |
5 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-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.
Aliases |
none |
Required? |
false |
Position? |
1 |
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. The default is SHA1.
Aliases |
none |
Required? |
false |
Position? |
3 |
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? |
2 |
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.
Example 1
This example creates an object that has the service extension object default for all roles that will be installed with the deployment and the role configuration.
C:\PS>$rdpConfig = New-AzureServiceRemoteDesktopExtensionConfig -Credential $cred
Example 2
This example creates an object that has the service extension object for a specific role that will be installed with the deployment and the role configuration.
C:\PS>$rdpConfig = New-AzureServiceRemoteDesktopExtensionConfig -Credential $cred -Role "WebRole1"