New-AzureServiceRemoteDesktopExtensionConfig
Generates a remote desktop extension configuration for a deployment.
Note
The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.
The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.
Syntax
New-AzureServiceRemoteDesktopExtensionConfig
[[-Role] <String[]>]
[[-X509Certificate] <X509Certificate2>]
[[-ThumbprintAlgorithm] <String>]
[-Credential] <PSCredential>
[[-Expiration] <DateTime>]
[[-Version] <String>]
[[-ExtensionId] <String>]
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>] New-AzureServiceRemoteDesktopExtensionConfig
[[-Role] <String[]>]
[-CertificateThumbprint] <String>
[[-ThumbprintAlgorithm] <String>]
[-Credential] <PSCredential>
[[-Expiration] <DateTime>]
[[-Version] <String>]
[[-ExtensionId] <String>]
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>] Description
The New-AzureServiceRemoteDesktopExtensionConfig cmdlet generates a configuration for a remote desktop extension for a deployment.
Examples
Example 1: Generate a remote desktop extension configuration
PS C:\> $rdpConfig = New-AzureServiceRemoteDesktopExtensionConfig -Credential $credThis command generates a remote desktop extension configuration for the specified credentials.
Example 2: Generate a remote desktop extension configuration for a specified role
PS C:\> $rdpConfig = New-AzureServiceRemoteDesktopExtensionConfig -Credential $cred -Role "WebRole01"This command generates a remote desktop extension configuration for the specified credentials and the WebRole01 role.
Parameters
-CertificateThumbprint
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.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Credential
Specifies the credentials to enable for remote desktop. Credentials include a user name and password.
| Type: | PSCredential |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Expiration
Specifies a DateTime object that allows the user to specify when the user account expires.
| Type: | DateTime |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ExtensionId
Specifies the extension ID.
| Type: | String |
| Position: | 6 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InformationAction
Specifies how this cmdlet responds to an information event.
The acceptable values for this parameter are:
- Continue
- Ignore
- Inquire
- SilentlyContinue
- Stop
- Suspend
| Type: | ActionPreference |
| Aliases: | infa |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InformationVariable
Specifies an information variable.
| Type: | String |
| Aliases: | iv |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Profile
Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.
| Type: | AzureSMProfile |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Role
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.
| Type: | String[] |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ThumbprintAlgorithm
Specifies a thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Version
Specifies the extension version.
| Type: | String |
| Position: | 5 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-X509Certificate
Specifies an x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private configuration.
| Type: | X509Certificate2 |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |