HDInsightClient Class
Note
This version of the HDInsight .NET SDK is deprecated and will be removed by January 1, 2017. You are encouraged to use the newer ARM-based version of HDInsight .NET SDK going forward. For instructions on how to use the new HDInsight .NET SDK to create a cluster, see Create HDInsight Linux clusters using .NET SDK. For instructions on how to submit jobs using the new .NET SDK and other approaches, see Submit jobs to an HDInsight cluster. The HDInsight SDK reference for the newer version is available at HDInsight .NET SDK Reference.
Defines the HDInsight client interface for the management of cluster deployments on the Azure HDInsight Service.
Namespace: Microsoft.WindowsAzure.Management.HDInsight
Assembly: Microsoft.WindowsAzure.Management.HDInsight (in Microsoft.WindowsAzure.Management.HDInsight.dll)
Inheritance Hierarchy
System.Object
Microsoft.WindowsAzure.Management.HDInsight.Framework.Core.DisposableObject
Microsoft.Hadoop.Client.ClientBase
Microsoft.WindowsAzure.Management.HDInsight.HDInsightClient
Syntax
[SuppressMessageAttribute("Microsoft.Design", "CA1063:ImplementIDisposableCorrectly",
Justification = "DisposableObject implements IDisposable correctly, the implementation of IDisposable in the interfaces is necessary for the design.")]
[SuppressMessageAttribute("Microsoft.Maintainability", "CA1506:AvoidExcessiveClassCoupling",
Justification = "This complexity is needed to handle all the operations.")]
public sealed class HDInsightClient : ClientBase, IHDInsightClient,
IHDInsightAsyncClient, IHDInsightSyncClient, IHDInsightClientBase,
IJobSubmissionClientBase, IHadoopClientBase, IDisposable, ILogProvider
[SuppressMessageAttribute("Microsoft.Design", "CA1063:ImplementIDisposableCorrectly",
Justification = "DisposableObject implements IDisposable correctly, the implementation of IDisposable in the interfaces is necessary for the design.")]
[SuppressMessageAttribute("Microsoft.Maintainability", "CA1506:AvoidExcessiveClassCoupling",
Justification = "This complexity is needed to handle all the operations.")]
public ref class HDInsightClient sealed : ClientBase, IHDInsightClient,
IHDInsightAsyncClient, IHDInsightSyncClient, IHDInsightClientBase,
IJobSubmissionClientBase, IHadoopClientBase, IDisposable, ILogProvider
[<Sealed>]
[<SuppressMessageAttribute("Microsoft.Design", "CA1063:ImplementIDisposableCorrectly",
Justification = "DisposableObject implements IDisposable correctly, the implementation of IDisposable in the interfaces is necessary for the design.")>]
[<SuppressMessageAttribute("Microsoft.Maintainability", "CA1506:AvoidExcessiveClassCoupling",
Justification = "This complexity is needed to handle all the operations.")>]
type HDInsightClient =
class
inherit ClientBase
interface IHDInsightClient
interface IHDInsightAsyncClient
interface IHDInsightSyncClient
interface IHDInsightClientBase
interface IJobSubmissionClientBase
interface IHadoopClientBase
interface IDisposable
interface ILogProvider
end
<SuppressMessageAttribute("Microsoft.Design", "CA1063:ImplementIDisposableCorrectly",
Justification := "DisposableObject implements IDisposable correctly, the implementation of IDisposable in the interfaces is necessary for the design.")>
<SuppressMessageAttribute("Microsoft.Maintainability", "CA1506:AvoidExcessiveClassCoupling",
Justification := "This complexity is needed to handle all the operations.")>
Public NotInheritable Class HDInsightClient
Inherits ClientBase
Implements IHDInsightClient, IHDInsightAsyncClient, IHDInsightSyncClient,
IHDInsightClientBase, IJobSubmissionClientBase, IHadoopClientBase,
IDisposable, ILogProvider
Properties
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_pubproperty") |
CancellationSource | Gets or sets the cancellation token source that is used to signal to a cancellation token that it should be canceled.(Inherited from ClientBase.) |
|
CancellationToken | Gets the cancellation token that propagates notification that operations should be canceled.(Inherited from ClientBase.) |
|
Credentials | Gets the connection credentials. |
|
HttpOperationTimeout | Gets or sets the HTTP operation timeout.(Inherited from ClientBase.) |
|
IgnoreSslErrors | (Inherited from ClientBase.) |
|
Logger | Gets the logger used to log messages.(Inherited from ClientBase.) |
|
PollingInterval | Gets or sets the polling interval for the CreateCluster/DeleteCluster operations. |
|
RetryPolicy | Gets or sets the retry policy.(Inherited from ClientBase.) |
Methods
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_pubmethod") |
AddLogWriter(ILogWriter) | Adds a log writer to the client.(Inherited from ClientBase.) |
|
Cancel() | Cancels a pending operation.(Inherited from ClientBase.) |
|
ChangeClusterSize(String, String, Int32) | |
|
ChangeClusterSize(String, String, Int32, TimeSpan) | |
|
ChangeClusterSizeAsync(String, String, Int32) | |
|
ChangeClusterSizeAsync(String, String, Int32, TimeSpan) | |
.jpeg "System_CAPS_static") |
Connect(IHDInsightSubscriptionCredentials) | Connects to an HDInsight subscription with a new client. |
|
Connect(IHDInsightSubscriptionCredentials, TimeSpan, IRetryPolicy) | Connects the specified credentials. |
|
CreateCluster(ClusterCreateParameters) | Submits a request synchronously to create an HDInsight cluster and waits for it to complete. |
|
CreateCluster(ClusterCreateParameters, TimeSpan) | Submits a request synchronously to create an HDInsight cluster and waits a specified interval of time for it to complete. |
|
CreateCluster(ClusterCreateParametersV2) | |
|
CreateCluster(ClusterCreateParametersV2, TimeSpan) | |
|
CreateClusterAsync(ClusterCreateParameters) | Submits a request to create an HDInsight cluster asynchronously. |
|
CreateClusterAsync(ClusterCreateParametersV2) | |
|
DeleteCluster(String) | Submits a request synchronously to delete an HDInsight cluster and waits for it to complete. |
|
DeleteCluster(String, String) | |
|
DeleteCluster(String, String, TimeSpan) | |
|
DeleteCluster(String, TimeSpan) | Submits a request synchronously to delete an HDInsight cluster and waits for it to complete. |
|
DeleteClusterAsync(String) | Submits a request asynchronously to delete an HDInsight cluster. |
|
DeleteClusterAsync(String, String) | |
|
DisableHttp(String, String) | Disables HTTP connectivity on the HDInsight cluster synchronously. |
|
DisableHttpAsync(String, String) | Disables HTTP connectivity on the HDInsight cluster asychronously. |
|
DisableRdp(String, String) | |
|
DisableRdpAsync(String, String) | |
|
Dispose() | (Inherited from DisposableObject.) |
|
EnableHttp(String, String, String, String) | Enables HTTP connectivity on the HDInsight cluster synchronously. |
|
EnableHttpAsync(String, String, String, String) | Enables HTTP connectivity on the HDInsight cluster asynchro nously. |
|
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. |
|
Equals(Object) | (Inherited from Object.) |
|
GetCluster(String) | Queries for a specific HDInsight Cluster registered in the subscription synchronously. |
|
GetCluster(String, String) | |
|
GetClusterAsync(String) | Queries for a specified HDInsight Cluster asynchronously. |
|
GetClusterAsync(String, String) | |
|
GetHashCode() | (Inherited from Object.) |
|
GetType() | (Inherited from Object.) |
|
HandleClusterWaitNotifyEvent(ClusterDetails) | Handles the notification events during waiting. |
|
IsDisposed() | (Inherited from DisposableObject.) |
|
ListAvailableLocations() | Queries sychronouslyfor the Azure region locations where the HDInsight service is available to the current subscription. |
|
ListAvailableLocations(OSType) | |
|
ListAvailableLocationsAsync() | Queries asychronouslyfor the Azure region locations where the HDInsight service is available to the current subscription. |
|
ListAvailableLocationsAsync(OSType) | |
|
ListAvailableVersions() | Queries sychronously the versions of HDInsight that are available to the subscription. |
|
ListAvailableVersionsAsync() | Queries asychronously the versions of HDInsight that are available to the subscription. |
|
ListClusters() | Queries for the HDInsight clusters registered in the current subscription synchronously. |
|
ListClustersAsync() | Queries for the HDInsight clusters registered in the subscription asynchronously. |
|
ListResourceProviderProperties() | Queries for the HDInsight resources providers of the HDInsight Service and their properties. |
|
ListResourceProviderPropertiesAsync() | Asynchronously queries for the HDInsight resources providers of the HDInsight Service and their properties. |
|
RaiseClusterProvisioningEvent(Object, ClusterProvisioningStatusEventArgs) | Raises the cluster provisioning event. |
|
RemoveLogWriter(ILogWriter) | (Inherited from ClientBase.) |
|
SetCancellationSource(CancellationTokenSource) | Allows a user to set a custom cancellation source.(Inherited from ClientBase.) |
|
ToString() | (Inherited from Object.) |
Events
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_pubevent") |
ClusterProvisioning | Event that occurs when the client provisions a cluster. |
Remarks
Provides implementation for the IHDInsightClient interface.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also
Microsoft.WindowsAzure.Management.HDInsight Namespace
Return to top