Get-AzureHDInsightCluster
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Get-AzureHDInsightCluster
Retrieves and lists all of the Windows Azure HDInsight clusters associated with the current subscription or retrieves a specific named cluster.
Syntax
Parameter Set: Cluster By Name (with Specific Subscription Credential)
Get-AzureHDInsightCluster [[-Name] <String> ] [[-Subscription] <String> ] [[-Certificate] <X509Certificate2> ] [[-Endpoint] <Uri> ] [[-HostedService] <String> ] [ <CommonParameters>]
Detailed Description
Lists all Windows Azure HDInsight Service clusters for the current subscription. If the Name parameter is specified, only information for the cluster with that name is returned.
This topic describes the cmdlet in the 0.8.1 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.
Parameters
-Certificate<X509Certificate2>
Management certificate of the Azure subscription.
Aliases |
Cert |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Endpoint<Uri>
Specifies the endpoint to use when connecting to Windows Azure if the endpoint is different from the default.
Aliases |
none |
Required? |
false |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-HostedService<String>
The namespace of the Azure HDInsight Service if it is different from default.
Aliases |
CloudServiceName |
Required? |
false |
Position? |
5 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
The name of an HDInsight cluster to retrieve.
Aliases |
ClusterName,DnsName |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Subscription<String>
The subscription that contains the HDInsight clusters to retrieve.
Aliases |
Sub |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
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.
Examples
Clusters in a subscription
Get information about the clusters associated with a specified subscription.
PS C:\> Get-AzureHDInsightCluster