Edit

Share via

Get-AzureHDInsightCluster

  • Reference
Module:
Azure

Gets an HDInsight cluster.

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

Get-AzureHDInsightCluster
   [-Certificate <X509Certificate2>]
   [-HostedService <String>]
   [-Endpoint <Uri>]
   [-IgnoreSslErrors <Boolean>]
   [-Name <String>]
   [-Subscription <String>]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

This version of Azure PowerShell HDInsight is deprecated. These cmdlets will be removed by January 1, 2017. Please use the newer version of Azure PowerShell HDInsight.

For information about how to use the new HDInsight to create a cluster, see Create Linux-based clusters in HDInsight using Azure PowerShell (https://azure.microsoft.com/en-us/documentation/articles/hdinsight-hadoop-create-linux-clusters-azure-powershell/). For information about how to submit jobs by using Azure PowerShell and other approaches, see Submit Hadoop jobs in HDInsight (https://azure.microsoft.com/en-us/documentation/articles/hdinsight-submit-hadoop-jobs-programmatically/). For reference information about Azure PowerShell HDInsight, see Azure HDInsight Cmdlets.

The Get-AzureHDInsightCluster cmdlet gets the Azure HDInsight service clusters for the current subscription. You can use the Name parameter to get a specific cluster.

Examples

Example 1: Get the clusters in a subscription

PS C:\> Get-AzureHDInsightCluster

This command gets information about the HDInsight clusters in the current subscription.

Parameters

-Certificate

Specifies the management certificate for an Azure subscription.

Type:X509Certificate2
Aliases:Cert
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Endpoint

Specifies the endpoint to use to connect to Azure. If you do not specify this parameter, this cmdlet uses the default endpoint.

Type:Uri
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HostedService

Specifies the namespace of an HDInsight service. If you do not specify this parameter, this cmdlet uses the default namespace.

Type:String
Aliases:CloudServiceName
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IgnoreSslErrors

Indicates whether Secure Sockets Layer (SSL) errors are ignored.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name of an HDInsight cluster to get.

Type:String
Aliases:ClusterName, DnsName
Position:Named
Default value:None
Required:False
Accept pipeline input:True
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

-Subscription

Specifies the subscription that contains the HDInsight cluster to get.

Type:String
Aliases:Sub
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False