Extensions interface

Package:

@azure/arm-hdinsight

Interface representing a Extensions.

Methods

beginCreate(string, string, string, Extension, ExtensionsCreateOptionalParams)	Creates an HDInsight cluster extension.
beginCreateAndWait(string, string, string, Extension, ExtensionsCreateOptionalParams)	Creates an HDInsight cluster extension.
beginDelete(string, string, string, ExtensionsDeleteOptionalParams)	Deletes the specified extension for HDInsight cluster.
beginDeleteAndWait(string, string, string, ExtensionsDeleteOptionalParams)	Deletes the specified extension for HDInsight cluster.
beginDisableAzureMonitor(string, string, ExtensionsDisableAzureMonitorOptionalParams)	Disables the Azure Monitor on the HDInsight cluster.
beginDisableAzureMonitorAndWait(string, string, ExtensionsDisableAzureMonitorOptionalParams)	Disables the Azure Monitor on the HDInsight cluster.
beginDisableMonitoring(string, string, ExtensionsDisableMonitoringOptionalParams)	Disables the Operations Management Suite (OMS) on the HDInsight cluster.
beginDisableMonitoringAndWait(string, string, ExtensionsDisableMonitoringOptionalParams)	Disables the Operations Management Suite (OMS) on the HDInsight cluster.
beginEnableAzureMonitor(string, string, AzureMonitorRequest, ExtensionsEnableAzureMonitorOptionalParams)	Enables the Azure Monitor on the HDInsight cluster.
beginEnableAzureMonitorAndWait(string, string, AzureMonitorRequest, ExtensionsEnableAzureMonitorOptionalParams)	Enables the Azure Monitor on the HDInsight cluster.
beginEnableMonitoring(string, string, ClusterMonitoringRequest, ExtensionsEnableMonitoringOptionalParams)	Enables the Operations Management Suite (OMS) on the HDInsight cluster.
beginEnableMonitoringAndWait(string, string, ClusterMonitoringRequest, ExtensionsEnableMonitoringOptionalParams)	Enables the Operations Management Suite (OMS) on the HDInsight cluster.
get(string, string, string, ExtensionsGetOptionalParams)	Gets the extension properties for the specified HDInsight cluster extension.
getAzureAsyncOperationStatus(string, string, string, string, ExtensionsGetAzureAsyncOperationStatusOptionalParams)	Gets the async operation status.
getAzureMonitorStatus(string, string, ExtensionsGetAzureMonitorStatusOptionalParams)	Gets the status of Azure Monitor on the HDInsight cluster.
getMonitoringStatus(string, string, ExtensionsGetMonitoringStatusOptionalParams)	Gets the status of Operations Management Suite (OMS) on the HDInsight cluster.

Method Details

beginCreate(string, string, string, Extension, ExtensionsCreateOptionalParams)

Creates an HDInsight cluster extension.

function beginCreate(resourceGroupName: string, clusterName: string, extensionName: string, parameters: Extension, options?: ExtensionsCreateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

extensionName

string

The name of the cluster extension.

parameters

Extension

The cluster extensions create request.

options

ExtensionsCreateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginCreateAndWait(string, string, string, Extension, ExtensionsCreateOptionalParams)

Creates an HDInsight cluster extension.

function beginCreateAndWait(resourceGroupName: string, clusterName: string, extensionName: string, parameters: Extension, options?: ExtensionsCreateOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

extensionName

string

The name of the cluster extension.

parameters

Extension

The cluster extensions create request.

options

ExtensionsCreateOptionalParams

The options parameters.

Returns

Promise<void>

beginDelete(string, string, string, ExtensionsDeleteOptionalParams)

Deletes the specified extension for HDInsight cluster.

function beginDelete(resourceGroupName: string, clusterName: string, extensionName: string, options?: ExtensionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

extensionName

string

The name of the cluster extension.

options

ExtensionsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, ExtensionsDeleteOptionalParams)

Deletes the specified extension for HDInsight cluster.

function beginDeleteAndWait(resourceGroupName: string, clusterName: string, extensionName: string, options?: ExtensionsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

extensionName

string

The name of the cluster extension.

options

ExtensionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginDisableAzureMonitor(string, string, ExtensionsDisableAzureMonitorOptionalParams)

Disables the Azure Monitor on the HDInsight cluster.

function beginDisableAzureMonitor(resourceGroupName: string, clusterName: string, options?: ExtensionsDisableAzureMonitorOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

options

ExtensionsDisableAzureMonitorOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDisableAzureMonitorAndWait(string, string, ExtensionsDisableAzureMonitorOptionalParams)

Disables the Azure Monitor on the HDInsight cluster.

function beginDisableAzureMonitorAndWait(resourceGroupName: string, clusterName: string, options?: ExtensionsDisableAzureMonitorOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

options

ExtensionsDisableAzureMonitorOptionalParams

The options parameters.

Returns

Promise<void>

beginDisableMonitoring(string, string, ExtensionsDisableMonitoringOptionalParams)

Disables the Operations Management Suite (OMS) on the HDInsight cluster.

function beginDisableMonitoring(resourceGroupName: string, clusterName: string, options?: ExtensionsDisableMonitoringOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

options

ExtensionsDisableMonitoringOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDisableMonitoringAndWait(string, string, ExtensionsDisableMonitoringOptionalParams)

Disables the Operations Management Suite (OMS) on the HDInsight cluster.

function beginDisableMonitoringAndWait(resourceGroupName: string, clusterName: string, options?: ExtensionsDisableMonitoringOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

options

ExtensionsDisableMonitoringOptionalParams

The options parameters.

Returns

Promise<void>

beginEnableAzureMonitor(string, string, AzureMonitorRequest, ExtensionsEnableAzureMonitorOptionalParams)

Enables the Azure Monitor on the HDInsight cluster.

function beginEnableAzureMonitor(resourceGroupName: string, clusterName: string, parameters: AzureMonitorRequest, options?: ExtensionsEnableAzureMonitorOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

parameters

AzureMonitorRequest

The Log Analytics workspace parameters.

options

ExtensionsEnableAzureMonitorOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginEnableAzureMonitorAndWait(string, string, AzureMonitorRequest, ExtensionsEnableAzureMonitorOptionalParams)

Enables the Azure Monitor on the HDInsight cluster.

function beginEnableAzureMonitorAndWait(resourceGroupName: string, clusterName: string, parameters: AzureMonitorRequest, options?: ExtensionsEnableAzureMonitorOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

parameters

AzureMonitorRequest

The Log Analytics workspace parameters.

options

ExtensionsEnableAzureMonitorOptionalParams

The options parameters.

Returns

Promise<void>

beginEnableMonitoring(string, string, ClusterMonitoringRequest, ExtensionsEnableMonitoringOptionalParams)

Enables the Operations Management Suite (OMS) on the HDInsight cluster.

function beginEnableMonitoring(resourceGroupName: string, clusterName: string, parameters: ClusterMonitoringRequest, options?: ExtensionsEnableMonitoringOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

parameters

ClusterMonitoringRequest

The Operations Management Suite (OMS) workspace parameters.

options

ExtensionsEnableMonitoringOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginEnableMonitoringAndWait(string, string, ClusterMonitoringRequest, ExtensionsEnableMonitoringOptionalParams)

Enables the Operations Management Suite (OMS) on the HDInsight cluster.

function beginEnableMonitoringAndWait(resourceGroupName: string, clusterName: string, parameters: ClusterMonitoringRequest, options?: ExtensionsEnableMonitoringOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

parameters

ClusterMonitoringRequest

The Operations Management Suite (OMS) workspace parameters.

options

ExtensionsEnableMonitoringOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, ExtensionsGetOptionalParams)

Gets the extension properties for the specified HDInsight cluster extension.

function get(resourceGroupName: string, clusterName: string, extensionName: string, options?: ExtensionsGetOptionalParams): Promise<ClusterMonitoringResponse>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

extensionName

string

The name of the cluster extension.

options

ExtensionsGetOptionalParams

The options parameters.

Returns

Promise<ClusterMonitoringResponse>

getAzureAsyncOperationStatus(string, string, string, string, ExtensionsGetAzureAsyncOperationStatusOptionalParams)

Gets the async operation status.

function getAzureAsyncOperationStatus(resourceGroupName: string, clusterName: string, extensionName: string, operationId: string, options?: ExtensionsGetAzureAsyncOperationStatusOptionalParams): Promise<AsyncOperationResult>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

extensionName

string

The name of the cluster extension.

operationId

string

The long running operation id.

options

ExtensionsGetAzureAsyncOperationStatusOptionalParams

The options parameters.

Returns

Promise<AsyncOperationResult>

getAzureMonitorStatus(string, string, ExtensionsGetAzureMonitorStatusOptionalParams)

Gets the status of Azure Monitor on the HDInsight cluster.

function getAzureMonitorStatus(resourceGroupName: string, clusterName: string, options?: ExtensionsGetAzureMonitorStatusOptionalParams): Promise<AzureMonitorResponse>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

options

ExtensionsGetAzureMonitorStatusOptionalParams

The options parameters.

Returns

Promise<AzureMonitorResponse>

getMonitoringStatus(string, string, ExtensionsGetMonitoringStatusOptionalParams)

Gets the status of Operations Management Suite (OMS) on the HDInsight cluster.

function getMonitoringStatus(resourceGroupName: string, clusterName: string, options?: ExtensionsGetMonitoringStatusOptionalParams): Promise<ClusterMonitoringResponse>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

options

ExtensionsGetMonitoringStatusOptionalParams

The options parameters.

Returns

Promise<ClusterMonitoringResponse>