Share via

HDInsightClusterResource Class

  • Reference

Definition

Namespace:
Azure.ResourceManager.HDInsight
Assembly:
Azure.ResourceManager.HDInsight.dll
Package:
Azure.ResourceManager.HDInsight v1.1.0
Package:
Azure.ResourceManager.HDInsight v1.2.0-beta.2
Source:
HDInsightClusterResource.cs
Source:
HDInsightClusterResource.cs

A Class representing a HDInsightCluster along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a HDInsightClusterResource from an instance of ArmClient using the GetHDInsightClusterResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetHDInsightCluster method.

public class HDInsightClusterResource : Azure.ResourceManager.ArmResource
type HDInsightClusterResource = class
    inherit ArmResource
Public Class HDInsightClusterResource
Inherits ArmResource
Inheritance
Object
ArmResource
HDInsightClusterResource

Constructors

HDInsightClusterResource()

Initializes a new instance of the HDInsightClusterResource class for mocking.

Fields

ResourceType

Gets the resource type for the operations.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmResource)
Data

Gets the data representing this Feature.
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmResource)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmResource)
HasData

Gets whether or not the current instance has data.
Id

Gets the resource identifier.

(Inherited from ArmResource)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmResource)

Methods

AddTag(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}
  • Operation Id: Clusters_Get
AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}
  • Operation Id: Clusters_Get
CanUseTagResource(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CreateExtension(WaitUntil, String, HDInsightClusterCreateExtensionContent, CancellationToken)

Creates an HDInsight cluster extension.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}
  • Operation Id: Extensions_Create
CreateExtensionAsync(WaitUntil, String, HDInsightClusterCreateExtensionContent, CancellationToken)

Creates an HDInsight cluster extension.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}
  • Operation Id: Extensions_Create
CreateResourceIdentifier(String, String, String)

Generate the resource identifier of a HDInsightClusterResource instance.
Delete(WaitUntil, CancellationToken)

Deletes the specified HDInsight cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}
  • Operation Id: Clusters_Delete
DeleteAsync(WaitUntil, CancellationToken)

Deletes the specified HDInsight cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}
  • Operation Id: Clusters_Delete
DeleteExtension(WaitUntil, String, CancellationToken)

Deletes the specified extension for HDInsight cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}
  • Operation Id: Extensions_Delete
DeleteExtensionAsync(WaitUntil, String, CancellationToken)

Deletes the specified extension for HDInsight cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}
  • Operation Id: Extensions_Delete
DeleteScriptAction(String, CancellationToken)

Deletes a specified persisted script action of the cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptActions/{scriptName}
  • Operation Id: ScriptActions_Delete
DeleteScriptActionAsync(String, CancellationToken)

Deletes a specified persisted script action of the cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptActions/{scriptName}
  • Operation Id: ScriptActions_Delete
DisableAzureMonitorExtension(WaitUntil, CancellationToken)

Disables the Azure Monitor on the HDInsight cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/azureMonitor
  • Operation Id: Extensions_DisableAzureMonitor
DisableAzureMonitorExtensionAsync(WaitUntil, CancellationToken)

Disables the Azure Monitor on the HDInsight cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/azureMonitor
  • Operation Id: Extensions_DisableAzureMonitor
DisableClusterMonitoringExtension(WaitUntil, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/clustermonitoring
  • Operation Id: Extensions_DisableMonitoring
DisableClusterMonitoringExtensionAsync(WaitUntil, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/clustermonitoring
  • Operation Id: Extensions_DisableMonitoring
EnableAzureMonitorExtension(WaitUntil, HDInsightAzureMonitorExtensionEnableContent, CancellationToken)

Enables the Azure Monitor on the HDInsight cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/azureMonitor
  • Operation Id: Extensions_EnableAzureMonitor
EnableAzureMonitorExtensionAsync(WaitUntil, HDInsightAzureMonitorExtensionEnableContent, CancellationToken)

Enables the Azure Monitor on the HDInsight cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/azureMonitor
  • Operation Id: Extensions_EnableAzureMonitor
EnableClusterMonitoringExtension(WaitUntil, HDInsightClusterEnableClusterMonitoringContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/clustermonitoring
  • Operation Id: Extensions_EnableMonitoring
EnableClusterMonitoringExtensionAsync(WaitUntil, HDInsightClusterEnableClusterMonitoringContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/clustermonitoring
  • Operation Id: Extensions_EnableMonitoring
ExecuteScriptActions(WaitUntil, ExecuteScriptActionContent, CancellationToken)

Executes script actions on the specified HDInsight cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/executeScriptActions
  • Operation Id: Clusters_ExecuteScriptActions
ExecuteScriptActionsAsync(WaitUntil, ExecuteScriptActionContent, CancellationToken)

Executes script actions on the specified HDInsight cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/executeScriptActions
  • Operation Id: Clusters_ExecuteScriptActions
Get(CancellationToken)

Gets the specified cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}
  • Operation Id: Clusters_Get
GetAsync(CancellationToken)

Gets the specified cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}
  • Operation Id: Clusters_Get
GetAsyncOperationStatus(String, CancellationToken)

The the async operation status.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/azureasyncoperations/{operationId}
  • Operation Id: Clusters_GetAzureAsyncOperationStatus
GetAsyncOperationStatusAsync(String, CancellationToken)

The the async operation status.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/azureasyncoperations/{operationId}
  • Operation Id: Clusters_GetAzureAsyncOperationStatus
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAzureMonitorExtensionStatus(CancellationToken)

Gets the status of Azure Monitor on the HDInsight cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/azureMonitor
  • Operation Id: Extensions_GetAzureMonitorStatus
GetAzureMonitorExtensionStatusAsync(CancellationToken)

Gets the status of Azure Monitor on the HDInsight cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/azureMonitor
  • Operation Id: Extensions_GetAzureMonitorStatus
GetClusterMonitoringExtensionStatus(CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/clustermonitoring
  • Operation Id: Extensions_GetMonitoringStatus
GetClusterMonitoringExtensionStatusAsync(CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/clustermonitoring
  • Operation Id: Extensions_GetMonitoringStatus
GetConfiguration(CancellationToken)

Gets all configuration information for an HDI cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/configurations
  • Operation Id: Configurations_List
GetConfiguration(String, CancellationToken)

The configuration object for the specified cluster. This API is not recommended and might be removed in the future. Please consider using List configurations API instead.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/configurations/{configurationName}
  • Operation Id: Configurations_Get
GetConfigurationAsync(CancellationToken)

Gets all configuration information for an HDI cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/configurations
  • Operation Id: Configurations_List
GetConfigurationAsync(String, CancellationToken)

The configuration object for the specified cluster. This API is not recommended and might be removed in the future. Please consider using List configurations API instead.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/configurations/{configurationName}
  • Operation Id: Configurations_Get
GetExtension(String, CancellationToken)

Gets the extension properties for the specified HDInsight cluster extension.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}
  • Operation Id: Extensions_Get
GetExtensionAsync(String, CancellationToken)

Gets the extension properties for the specified HDInsight cluster extension.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}
  • Operation Id: Extensions_Get
GetExtensionAsyncOperationStatus(String, String, CancellationToken)

Gets the async operation status.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}/azureAsyncOperations/{operationId}
  • Operation Id: Extensions_GetAzureAsyncOperationStatus
GetExtensionAsyncOperationStatusAsync(String, String, CancellationToken)

Gets the async operation status.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}/azureAsyncOperations/{operationId}
  • Operation Id: Extensions_GetAzureAsyncOperationStatus
GetGatewaySettings(CancellationToken)

Gets the gateway settings for the specified cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/getGatewaySettings
  • Operation Id: Clusters_GetGatewaySettings
GetGatewaySettingsAsync(CancellationToken)

Gets the gateway settings for the specified cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/getGatewaySettings
  • Operation Id: Clusters_GetGatewaySettings
GetHDInsightApplication(String, CancellationToken)

Gets properties of the specified application.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/applications/{applicationName}
  • Operation Id: Applications_Get
GetHDInsightApplicationAsync(String, CancellationToken)

Gets properties of the specified application.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/applications/{applicationName}
  • Operation Id: Applications_Get
GetHDInsightApplications()

Gets a collection of HDInsightApplicationResources in the HDInsightCluster.
GetHDInsightPrivateEndpointConnection(String, CancellationToken)

Gets the specific private endpoint connection.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}
  • Operation Id: PrivateEndpointConnections_Get
GetHDInsightPrivateEndpointConnectionAsync(String, CancellationToken)

Gets the specific private endpoint connection.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}
  • Operation Id: PrivateEndpointConnections_Get
GetHDInsightPrivateEndpointConnections()

Gets a collection of HDInsightPrivateEndpointConnectionResources in the HDInsightCluster.
GetHDInsightPrivateLinkResource(String, CancellationToken)

Gets the specific private link resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/privateLinkResources/{privateLinkResourceName}
  • Operation Id: PrivateLinkResources_Get
GetHDInsightPrivateLinkResourceAsync(String, CancellationToken)

Gets the specific private link resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/privateLinkResources/{privateLinkResourceName}
  • Operation Id: PrivateLinkResources_Get
GetHDInsightPrivateLinkResources()

Gets a collection of HDInsightPrivateLinkResources in the HDInsightCluster.
GetManagementLock(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLocks()

Gets a collection of ManagementLockResources in the ArmResource.

(Inherited from ArmResource)
GetPolicyAssignment(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignments()

Gets a collection of PolicyAssignmentResources in the ArmResource.

(Inherited from ArmResource)
GetScriptActionExecutionAsyncOperationStatus(String, CancellationToken)

Gets the async operation status of execution operation.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/executeScriptActions/azureasyncoperations/{operationId}
  • Operation Id: ScriptActions_GetExecutionAsyncOperationStatus
GetScriptActionExecutionAsyncOperationStatusAsync(String, CancellationToken)

Gets the async operation status of execution operation.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/executeScriptActions/azureasyncoperations/{operationId}
  • Operation Id: ScriptActions_GetExecutionAsyncOperationStatus
GetScriptActionExecutionDetail(String, CancellationToken)

Gets the script execution detail for the given script execution ID.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory/{scriptExecutionId}
  • Operation Id: ScriptActions_GetExecutionDetail
GetScriptActionExecutionDetailAsync(String, CancellationToken)

Gets the script execution detail for the given script execution ID.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory/{scriptExecutionId}
  • Operation Id: ScriptActions_GetExecutionDetail
GetScriptActions(CancellationToken)

Lists all the persisted script actions for the specified cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptActions
  • Operation Id: ScriptActions_ListByCluster
GetScriptActionsAsync(CancellationToken)

Lists all the persisted script actions for the specified cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptActions
  • Operation Id: ScriptActions_ListByCluster
GetScriptExecutionHistories(CancellationToken)

Lists all scripts' execution history for the specified cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory
  • Operation Id: ScriptExecutionHistory_ListByCluster
GetScriptExecutionHistoriesAsync(CancellationToken)

Lists all scripts' execution history for the specified cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory
  • Operation Id: ScriptExecutionHistory_ListByCluster
GetTagResource()

Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource.

(Inherited from ArmResource)
GetVirtualMachineAsyncOperationStatus(String, CancellationToken)

Gets the async operation status.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/restartHosts/azureasyncoperations/{operationId}
  • Operation Id: VirtualMachines_GetAsyncOperationStatus
GetVirtualMachineAsyncOperationStatusAsync(String, CancellationToken)

Gets the async operation status.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/restartHosts/azureasyncoperations/{operationId}
  • Operation Id: VirtualMachines_GetAsyncOperationStatus
GetVirtualMachineHosts(CancellationToken)

Lists the HDInsight clusters hosts

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/listHosts
  • Operation Id: VirtualMachines_ListHosts
GetVirtualMachineHostsAsync(CancellationToken)

Lists the HDInsight clusters hosts

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/listHosts
  • Operation Id: VirtualMachines_ListHosts
PromoteScriptExecutionHistory(String, CancellationToken)

Promotes the specified ad-hoc script execution to a persisted script.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory/{scriptExecutionId}/promote
  • Operation Id: ScriptExecutionHistory_Promote
PromoteScriptExecutionHistoryAsync(String, CancellationToken)

Promotes the specified ad-hoc script execution to a persisted script.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory/{scriptExecutionId}/promote
  • Operation Id: ScriptExecutionHistory_Promote
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}
  • Operation Id: Clusters_Get
RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}
  • Operation Id: Clusters_Get
Resize(WaitUntil, HDInsightRoleName, HDInsightClusterResizeContent, CancellationToken)

Resizes the specified HDInsight cluster to the specified size.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/roles/{roleName}/resize
  • Operation Id: Clusters_Resize
ResizeAsync(WaitUntil, HDInsightRoleName, HDInsightClusterResizeContent, CancellationToken)

Resizes the specified HDInsight cluster to the specified size.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/roles/{roleName}/resize
  • Operation Id: Clusters_Resize
RestartVirtualMachineHosts(WaitUntil, IEnumerable<String>, CancellationToken)

Restarts the specified HDInsight cluster hosts.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/restartHosts
  • Operation Id: VirtualMachines_RestartHosts
RestartVirtualMachineHostsAsync(WaitUntil, IEnumerable<String>, CancellationToken)

Restarts the specified HDInsight cluster hosts.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/restartHosts
  • Operation Id: VirtualMachines_RestartHosts
RotateDiskEncryptionKey(WaitUntil, HDInsightClusterDiskEncryptionContent, CancellationToken)

Rotate disk encryption key of the specified HDInsight cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/rotatediskencryptionkey
  • Operation Id: Clusters_RotateDiskEncryptionKey
RotateDiskEncryptionKeyAsync(WaitUntil, HDInsightClusterDiskEncryptionContent, CancellationToken)

Rotate disk encryption key of the specified HDInsight cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/rotatediskencryptionkey
  • Operation Id: Clusters_RotateDiskEncryptionKey
SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}
  • Operation Id: Clusters_Get
SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}
  • Operation Id: Clusters_Get
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmResource)
Update(HDInsightClusterPatch, CancellationToken)

Patch HDInsight cluster with the specified parameters.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}
  • Operation Id: Clusters_Update
UpdateAsync(HDInsightClusterPatch, CancellationToken)

Patch HDInsight cluster with the specified parameters.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}
  • Operation Id: Clusters_Update
UpdateAutoScaleConfiguration(WaitUntil, HDInsightRoleName, HDInsightAutoScaleConfigurationUpdateContent, CancellationToken)

Updates the Autoscale Configuration for HDInsight cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/roles/{roleName}/autoscale
  • Operation Id: Clusters_UpdateAutoScaleConfiguration
UpdateAutoScaleConfigurationAsync(WaitUntil, HDInsightRoleName, HDInsightAutoScaleConfigurationUpdateContent, CancellationToken)

Updates the Autoscale Configuration for HDInsight cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/roles/{roleName}/autoscale
  • Operation Id: Clusters_UpdateAutoScaleConfiguration
UpdateConfiguration(WaitUntil, String, IDictionary<String,String>, CancellationToken)

Configures the HTTP settings on the specified cluster. This API is deprecated, please use UpdateGatewaySettings in cluster endpoint instead.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/configurations/{configurationName}
  • Operation Id: Configurations_Update
UpdateConfigurationAsync(WaitUntil, String, IDictionary<String,String>, CancellationToken)

Configures the HTTP settings on the specified cluster. This API is deprecated, please use UpdateGatewaySettings in cluster endpoint instead.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/configurations/{configurationName}
  • Operation Id: Configurations_Update
UpdateGatewaySettings(WaitUntil, HDInsightClusterUpdateGatewaySettingsContent, CancellationToken)

Configures the gateway settings on the specified cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/updateGatewaySettings
  • Operation Id: Clusters_UpdateGatewaySettings
UpdateGatewaySettingsAsync(WaitUntil, HDInsightClusterUpdateGatewaySettingsContent, CancellationToken)

Configures the gateway settings on the specified cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/updateGatewaySettings
  • Operation Id: Clusters_UpdateGatewaySettings
UpdateIdentityCertificate(WaitUntil, HDInsightClusterUpdateIdentityCertificateContent, CancellationToken)

Updates the cluster identity certificate.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/updateClusterIdentityCertificate
  • Operation Id: Clusters_UpdateIdentityCertificate
UpdateIdentityCertificateAsync(WaitUntil, HDInsightClusterUpdateIdentityCertificateContent, CancellationToken)

Updates the cluster identity certificate.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/updateClusterIdentityCertificate
  • Operation Id: Clusters_UpdateIdentityCertificate

Extension Methods

GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead.
GetDenyAssignment(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead.
GetRoleAssignment(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead.
GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead.
GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead.
GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead.
GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead.
GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead.
GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead.
GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead.
GetRoleManagementPolicy(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead.
GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetSystemAssignedIdentity(ArmResource)

Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead.
GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResources(ArmResource)

Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead.

Applies to