HDInsightClient Class

Definition

Client Library that allows interacting with the Azure HDInsight Deployment Service.

public sealed class HDInsightClient : Microsoft.Hadoop.Client.ClientBase, IDisposable, Microsoft.WindowsAzure.Management.HDInsight.IHDInsightClient
type HDInsightClient = class
    inherit ClientBase
    interface IHDInsightClient
    interface IHDInsightAsyncClient
    interface IHDInsightSyncClient
    interface IHDInsightClientBase
    interface IJobSubmissionClientBase
    interface IHadoopClientBase
    interface IDisposable
    interface ILogProvider
Public NotInheritable Class HDInsightClient
Inherits ClientBase
Implements IDisposable, IHDInsightClient
Inheritance
Microsoft.Hadoop.Client.ClientBase
HDInsightClient
Implements
Microsoft.Hadoop.Client.IHadoopClientBase Microsoft.Hadoop.Client.IJobSubmissionClientBase IHDInsightAsyncClient IHDInsightClient IHDInsightClientBase IHDInsightSyncClient Microsoft.WindowsAzure.Management.HDInsight.Logging.ILogProvider IDisposable

Properties

Credentials

Gets the connection credential.

PollingInterval

Gets or sets the polling interval for the CreateCluster\DeleteCluster and user change operations.

Methods

ChangeClusterSize(String, String, Int32)

Submits a request to change the data node size of a cluster.

ChangeClusterSize(String, String, Int32, TimeSpan) Microsoft.Hadoop.Client.ClientBase.ChangeClusterSize(System.String,System.String,System.Int32,System.TimeSpan)
ChangeClusterSizeAsync(String, String, Int32)

Submits a request to change the data node size of a cluster.

ChangeClusterSizeAsync(String, String, Int32, TimeSpan) Microsoft.Hadoop.Client.ClientBase.ChangeClusterSizeAsync(System.String,System.String,System.Int32,System.TimeSpan)
Connect(IHDInsightSubscriptionCredentials)

Connects to an HDInsight subscription.

Connect(IHDInsightSubscriptionCredentials, TimeSpan, IRetryPolicy)

Connects the specified credentials.

CreateCluster(ClusterCreateParameters)

Submits a request to create an HDInsight cluster and waits for it to complete.

CreateCluster(ClusterCreateParameters, TimeSpan)

Submits a request to create an HDInsight cluster and waits for it to complete.

CreateCluster(ClusterCreateParametersV2)
CreateCluster(ClusterCreateParametersV2, TimeSpan)
CreateClusterAsync(ClusterCreateParameters)
CreateClusterAsync(ClusterCreateParametersV2)

Submits a request to create an HDInsight cluster and waits for it to complete.

DeleteCluster(String)

Submits a request to delete an HDInsight cluster and waits for it to complete.

DeleteCluster(String, String)

Submits a request to delete an HDInsight cluster and waits for it to complete.

DeleteCluster(String, String, TimeSpan)

Submits a request to delete an HDInsight cluster and waits for it to complete.

DeleteCluster(String, TimeSpan)

Submits a request to delete an HDInsight cluster and waits for it to complete.

DeleteClusterAsync(String)

Submits a request to delete an HDInsight cluster.

DeleteClusterAsync(String, String)

Submits a request to delete an HDInsight cluster.

DisableHttp(String, String)

Disables Http Connectivity on the HDInsight cluster.

DisableHttpAsync(String, String)

Disables Http Connectivity on the HDInsight cluster.

DisableRdp(String, String)
DisableRdpAsync(String, String)
EnableHttp(String, String, String, String)

Enables Http Connectivity on the HDInsight cluster.

EnableHttpAsync(String, String, String, String)

Enables Http Connectivity on the HDInsight cluster.

EnableRdp(String, String, String, String, DateTime)
EnableRdpAsync(String, String, String, String, DateTime)
EncryptAsBase64String(X509Certificate2, String)

Encrypt payload string into a base 64-encoded string using the certificate. This is suitable for encrypting storage account keys for later use as a job argument.

GetCluster(String)

Queries for a specific HDInsight Cluster registered.

GetCluster(String, String)

Queries for a specific HDInsight Cluster registered.

GetClusterAsync(String)

Queries for a specific HDInsight Cluster registered.

GetClusterAsync(String, String)

Queries for a specific HDInsight Cluster registered.

HandleClusterWaitNotifyEvent(ClusterDetails)

Used to handle the notification events during waiting.

ListAvailableLocations()

Queries the locations where HDInsight has been enabled for the subscription.

ListAvailableLocations(OSType)

Queries the locations where HDInsight deployments for the specified OS type have been enabled for the subscription.

ListAvailableLocationsAsync()

Queries the locations where HDInsight has been enabled for the subscription.

ListAvailableLocationsAsync(OSType)

Queries the locations where HDInsight deployments for the specified OS type have been enabled for the subscription.

ListAvailableVersions()

Queries the versions of HDInsight that have been enabled for the subscription.

ListAvailableVersionsAsync()

Queries the versions of HDInsight that have been enabled for the subscription.

ListClusters()

Queries the HDInsight Clusters registered.

ListClustersAsync()

Queries the HDInsight Clusters registered.

ListResourceProviderProperties()

Queries the locations where HDInsight has been enabled for the subscription.

ListResourceProviderPropertiesAsync()

Queries the properties of a given subscription for the HDInsight resource type.

RaiseClusterProvisioningEvent(Object, ClusterProvisioningStatusEventArgs)

Raises the cluster provisioning event.

Events

ClusterProvisioning

Event that is fired when the client provisions a cluster.

Applies to