Get-AzureHDInsightProperties

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Get-AzureHDInsightProperties

Retrieves properties specific to a Windows Azure HDInsight service.

Syntax

Parameter Set: Default
Get-AzureHDInsightProperties [[-Subscription] <String> ] [[-Certificate] <X509Certificate2> ] [[-Endpoint] <Uri> ] [[-HostedService] <String> ] [-Locations] [-Versions] [ <CommonParameters>]

Detailed Description

Retrieves properties specific to a Windows Azure HDInsight service, such as a list of available Azure regions, HDInsight cluster versions, and available compute capacity.

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 the default.

Aliases

CloudServiceName

Required?

false

Position?

5

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Locations

Retrieves the list of Azure regions where the HDInsight service is available.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Subscription<String>

The subscription that contains the HDInsight properties to retrieve.

Aliases

Sub

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Versions

Retrieves list of HDInsight cluster versions available in the service for this subscription.

Aliases

none

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, -OutBuffer, and -OutVariable. For more information, see  about_CommonParameters (http://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

Get HDInsight properties

Retrieve the HDInsight properties of an Azure subscription.

PS C:\> $SubName = Get-AzureSubscription -Current | %{ $_.SubscriptionName } 
Get-AzureHDInsightProperties -Subscription $SubName