< Back

Grant-AzureRmHDInsightRdpServicesAccess

Tue Jan 29, 2019 9:48 pm

NAME Grant-AzureRmHDInsightRdpServicesAccess



SYNOPSIS

Grants RDP access to the Windows cluster.





SYNTAX

Grant-AzureRmHDInsightRdpServicesAccess [-ClusterName] <String> [-RdpCredential] <PSCredential> [-RdpAccessExpiry] <DateTime> [-DefaultProfile

<IAzureContextContainer>] [-ResourceGroupName <String>] [<CommonParameters>]





DESCRIPTION

The Grant-AzureRmHDInsightRdpServicesAccess cmdlet enables Remote Desktop Protocol (RDP) to access to a Windows-based Azure HDInsight cluster.





PARAMETERS

-ClusterName <String>

Specifies the name of the cluster.



Required? true

Position? 0

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-RdpAccessExpiry <DateTime>

Specifies the expiration, as a DateTime object, for RDP access to a cluster.



Required? true

Position? 2

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-RdpCredential <PSCredential>

Specifies the RDP credentials for the cluster. This is only for Windows clusters.



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the name of the resource group.



Required? false

Position? named

Default value None

Accept pipeline input? False

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 (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

System.Void







NOTES









Example 1: Grant RDP access to an Azure HDInsight cluster



PS C:\\># Cluster info

PS C:\\> $clusterName = "your-hadoop-001"

PS C:\\> $clusterCreds = Get-Credential



PS C:\\> Grant-AzureRmHDInsightRdpServicesAccess `

-ClusterName $clusterName `

-RdpCredential $newRdpCreds `

-RdpAccessExpiry $newRdpExpiry



This command grants RDP access to the cluster named your-hadoop-001.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... icesaccess

Revoke-AzureRmHDInsightRdpServicesAccess