HDInsightClusterResource Class

Definition

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 GetResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetHDInsightClusters method.

public class HDInsightClusterResource : Azure.ResourceManager.ArmResource
public class HDInsightClusterResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.HDInsight.HDInsightClusterData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.HDInsight.HDInsightClusterData>
type HDInsightClusterResource = class
    inherit ArmResource
type HDInsightClusterResource = class
    inherit ArmResource
    interface IJsonModel<HDInsightClusterData>
    interface IPersistableModel<HDInsightClusterData>
Public Class HDInsightClusterResource
Inherits ArmResource
Public Class HDInsightClusterResource
Inherits ArmResource
Implements IJsonModel(Of HDInsightClusterData), IPersistableModel(Of HDInsightClusterData)
Inheritance
HDInsightClusterResource
Implements

Constructors

Name Description
HDInsightClusterResource()

Initializes a new instance of HDInsightClusterResource for mocking.

Fields

Name Description
ResourceType

Gets the resource type for the operations.

Properties

Name Description
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

Name Description
AddTag(String, String, CancellationToken)

Add a tag to the current resource.

AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
CreateResourceIdentifier(String, String, String)

Generate the resource identifier for this resource.

Delete(WaitUntil, CancellationToken)

Deletes the specified HDInsight cluster.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}.
  • Operation Id. : Clusters_Delete.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
DeleteAsync(WaitUntil, CancellationToken)

Deletes the specified HDInsight cluster.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}.
  • Operation Id. : Clusters_Delete.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
DeleteExtension(WaitUntil, String, CancellationToken)

Deletes the specified extension for HDInsight cluster. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}

DeleteExtensionAsync(WaitUntil, String, CancellationToken)

Deletes the specified extension for HDInsight cluster. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}

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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
DisableAzureMonitorAgentExtension(WaitUntil, CancellationToken)

Disables the Azure Monitor Agent on the HDInsight cluster.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/azureMonitorAgent.
  • Operation Id. : Extensions_DisableAzureMonitorAgent.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
DisableAzureMonitorAgentExtensionAsync(WaitUntil, CancellationToken)

Disables the Azure Monitor Agent on the HDInsight cluster.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/azureMonitorAgent.
  • Operation Id. : Extensions_DisableAzureMonitorAgent.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
EnableAzureMonitorAgentExtension(WaitUntil, HDInsightAzureMonitorExtensionEnableContent, CancellationToken)

Enables the Azure Monitor Agent on the HDInsight cluster.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/azureMonitorAgent.
  • Operation Id. : Extensions_EnableAzureMonitorAgent.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
EnableAzureMonitorAgentExtensionAsync(WaitUntil, HDInsightAzureMonitorExtensionEnableContent, CancellationToken)

Enables the Azure Monitor Agent on the HDInsight cluster.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/azureMonitorAgent.
  • Operation Id. : Extensions_EnableAzureMonitorAgent.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
Get(CancellationToken)

Gets the specified cluster.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}.
  • Operation Id. : Clusters_Get.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
GetAsync(CancellationToken)

Gets the specified cluster.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}.
  • Operation Id. : Clusters_Get.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
GetAsyncOperationStatus(String, CancellationToken)

The the async operation status. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/azureasyncoperations/{operationId}

GetAsyncOperationStatusAsync(String, CancellationToken)

The the async operation status. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/azureasyncoperations/{operationId}

GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAzureMonitorAgentStatusExtension(CancellationToken)

Gets the status of Azure Monitor Agent on the HDInsight cluster.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/azureMonitorAgent.
  • Operation Id. : Extensions_GetAzureMonitorAgentStatus.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
GetAzureMonitorAgentStatusExtensionAsync(CancellationToken)

Gets the status of Azure Monitor Agent on the HDInsight cluster.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/azureMonitorAgent.
  • Operation Id. : Extensions_GetAzureMonitorAgentStatus.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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}

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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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}

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}

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}

GetExtensionAsyncOperationStatus(String, String, CancellationToken)

Gets the async operation status of the extension. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}/azureAsyncOperations/{operationId}

GetExtensionAsyncOperationStatusAsync(String, String, CancellationToken)

Gets the async operation status of the extension. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}/azureAsyncOperations/{operationId}

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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
GetHDInsightApplication(String, CancellationToken)

Gets properties of the specified application.

GetHDInsightApplicationAsync(String, CancellationToken)

Gets properties of the specified application.

GetHDInsightApplications()

Gets a collection of HDInsightApplications in the HDInsightClusterResource.

GetHDInsightPrivateEndpointConnection(String, CancellationToken)

Gets the specific private endpoint connection.

GetHDInsightPrivateEndpointConnectionAsync(String, CancellationToken)

Gets the specific private endpoint connection.

GetHDInsightPrivateEndpointConnections()

Gets a collection of HDInsightPrivateEndpointConnections in the HDInsightClusterResource.

GetHDInsightPrivateLinkResource(String, CancellationToken)

Gets the specific private link resource.

GetHDInsightPrivateLinkResourceAsync(String, CancellationToken)

Gets the specific private link resource.

GetHDInsightPrivateLinkResources()

Gets a collection of HDInsightPrivateLinkResources in the HDInsightClusterResource.

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}

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}

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}

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}

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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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 of virtual machine restart. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/restartHosts/azureasyncoperations/{operationId}

GetVirtualMachineAsyncOperationStatusAsync(String, CancellationToken)

Gets the async operation status of virtual machine restart. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/restartHosts/azureasyncoperations/{operationId}

GetVirtualMachineHosts(CancellationToken)

Lists the HDInsight clusters hosts

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/listHosts.
  • Operation Id. : VirtualMachines_ListHosts.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
GetVirtualMachineHostsAsync(CancellationToken)

Lists the HDInsight clusters hosts

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/listHosts.
  • Operation Id. : VirtualMachines_ListHosts.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
RestartVirtualMachineHosts(WaitUntil, IEnumerable<String>, CancellationToken)

Restarts the specified HDInsight cluster hosts. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/restartHosts

RestartVirtualMachineHostsAsync(WaitUntil, IEnumerable<String>, CancellationToken)

Restarts the specified HDInsight cluster hosts. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
UpdateConfiguration(WaitUntil, String, IDictionary<String,String>, CancellationToken)

Configures the HTTP settings on the specified cluster. This API is not recommended and might be removed in the future. Please consider using Update cluster configurations API instead. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/configurations/{configurationName}

UpdateConfigurationAsync(WaitUntil, String, IDictionary<String,String>, CancellationToken)

Configures the HTTP settings on the specified cluster. This API is not recommended and might be removed in the future. Please consider using Update cluster configurations API instead. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/configurations/{configurationName}

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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.
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.
  • Default Api Version. : 2025-01-15-preview.
  • Resource. : HDInsightClusterResource.

Explicit Interface Implementations

Name Description
IJsonModel<HDInsightClusterData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<HDInsightClusterData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<HDInsightClusterData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<HDInsightClusterData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<HDInsightClusterData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Extension Methods

Name Description
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
<item>MockingTo mock this method, please mock GetAuthorizationRoleDefinition(ResourceIdentifier, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetAuthorizationRoleDefinitionAsync(ResourceIdentifier, CancellationToken) instead.</item>
GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. <item>MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead.</item>

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
<item>MockingTo mock this method, please mock GetDenyAssignment(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetDenyAssignmentAsync(String, CancellationToken) instead.</item>
GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentResources in the ArmResource. <item>MockingTo mock this method, please mock GetDenyAssignments() instead.</item>

GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResource(String, CancellationToken) instead.</item>
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResourceAsync(String, CancellationToken) instead.</item>
GetLinkerResources(ArmResource)

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

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
<item>MockingTo mock this method, please mock GetRoleAssignment(String, String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentAsync(String, String, CancellationToken) instead.</item>
GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleAssignments() instead.</item>

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
<item>MockingTo mock this method, please mock GetRoleAssignmentSchedule(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleAsync(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleInstance(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleInstanceAsync(String, CancellationToken) instead.</item>
GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead.</item>

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
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleRequest(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleRequestAsync(String, CancellationToken) instead.</item>
GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead.</item>

GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead.</item>

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
<item>MockingTo mock this method, please mock GetRoleEligibilitySchedule(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleAsync(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleInstance(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleInstanceAsync(String, CancellationToken) instead.</item>
GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead.</item>

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
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleRequest(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleRequestAsync(String, CancellationToken) instead.</item>
GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead.</item>

GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead.</item>

GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleManagementPolicies() instead.</item>

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
<item>MockingTo mock this method, please mock GetRoleManagementPolicy(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleManagementPolicyAssignment(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleManagementPolicyAssignmentAsync(String, CancellationToken) instead.</item>
GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead.</item>

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
<item>MockingTo mock this method, please mock GetRoleManagementPolicyAsync(String, CancellationToken) instead.</item>
GetSystemAssignedIdentity(ArmResource)

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

Applies to