HDInsightClusterResource Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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
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
- Implements
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.
|
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.
|
CreateExtensionAsync(WaitUntil, String, HDInsightClusterCreateExtensionContent, CancellationToken) |
Creates an HDInsight cluster extension.
|
CreateResourceIdentifier(String, String, String) |
Generate the resource identifier of a HDInsightClusterResource instance. |
Delete(WaitUntil, CancellationToken) |
Deletes the specified HDInsight cluster.
|
DeleteAsync(WaitUntil, CancellationToken) |
Deletes the specified HDInsight cluster.
|
DeleteExtension(WaitUntil, String, CancellationToken) |
Deletes the specified extension for HDInsight cluster.
|
DeleteExtensionAsync(WaitUntil, String, CancellationToken) |
Deletes the specified extension for HDInsight cluster.
|
DeleteScriptAction(String, CancellationToken) |
Deletes a specified persisted script action of the cluster.
|
DeleteScriptActionAsync(String, CancellationToken) |
Deletes a specified persisted script action of the cluster.
|
DisableAzureMonitorAgentExtension(WaitUntil, CancellationToken) |
Disables the Azure Monitor Agent on the HDInsight cluster.
|
DisableAzureMonitorAgentExtensionAsync(WaitUntil, CancellationToken) |
Disables the Azure Monitor Agent on the HDInsight cluster.
|
DisableAzureMonitorExtension(WaitUntil, CancellationToken) |
Disables the Azure Monitor on the HDInsight cluster.
|
DisableAzureMonitorExtensionAsync(WaitUntil, CancellationToken) |
Disables the Azure Monitor on the HDInsight cluster.
|
DisableClusterMonitoringExtension(WaitUntil, CancellationToken) |
Disables the Operations Management Suite (OMS) on the HDInsight cluster.
|
DisableClusterMonitoringExtensionAsync(WaitUntil, CancellationToken) |
Disables the Operations Management Suite (OMS) on the HDInsight cluster.
|
EnableAzureMonitorAgentExtension(WaitUntil, HDInsightAzureMonitorExtensionEnableContent, CancellationToken) |
Enables the Azure Monitor Agent on the HDInsight cluster.
|
EnableAzureMonitorAgentExtensionAsync(WaitUntil, HDInsightAzureMonitorExtensionEnableContent, CancellationToken) |
Enables the Azure Monitor Agent on the HDInsight cluster.
|
EnableAzureMonitorExtension(WaitUntil, HDInsightAzureMonitorExtensionEnableContent, CancellationToken) |
Enables the Azure Monitor on the HDInsight cluster.
|
EnableAzureMonitorExtensionAsync(WaitUntil, HDInsightAzureMonitorExtensionEnableContent, CancellationToken) |
Enables the Azure Monitor on the HDInsight cluster.
|
EnableClusterMonitoringExtension(WaitUntil, HDInsightClusterEnableClusterMonitoringContent, CancellationToken) |
Enables the Operations Management Suite (OMS) on the HDInsight cluster.
|
EnableClusterMonitoringExtensionAsync(WaitUntil, HDInsightClusterEnableClusterMonitoringContent, CancellationToken) |
Enables the Operations Management Suite (OMS) on the HDInsight cluster.
|
ExecuteScriptActions(WaitUntil, ExecuteScriptActionContent, CancellationToken) |
Executes script actions on the specified HDInsight cluster.
|
ExecuteScriptActionsAsync(WaitUntil, ExecuteScriptActionContent, CancellationToken) |
Executes script actions on the specified HDInsight cluster.
|
Get(CancellationToken) |
Gets the specified cluster.
|
GetAsync(CancellationToken) |
Gets the specified cluster.
|
GetAsyncOperationStatus(String, CancellationToken) |
The the async operation status.
|
GetAsyncOperationStatusAsync(String, CancellationToken) |
The the async operation status.
|
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.
|
GetAzureMonitorAgentStatusExtensionAsync(CancellationToken) |
Gets the status of Azure Monitor Agent on the HDInsight cluster.
|
GetAzureMonitorExtensionStatus(CancellationToken) |
Gets the status of Azure Monitor on the HDInsight cluster.
|
GetAzureMonitorExtensionStatusAsync(CancellationToken) |
Gets the status of Azure Monitor on the HDInsight cluster.
|
GetClusterMonitoringExtensionStatus(CancellationToken) |
Gets the status of Operations Management Suite (OMS) on the HDInsight cluster.
|
GetClusterMonitoringExtensionStatusAsync(CancellationToken) |
Gets the status of Operations Management Suite (OMS) on the HDInsight cluster.
|
GetConfiguration(CancellationToken) |
Gets all configuration information for an HDI cluster.
|
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.
|
GetConfigurationAsync(CancellationToken) |
Gets all configuration information for an HDI cluster.
|
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.
|
GetExtension(String, CancellationToken) |
Gets the extension properties for the specified HDInsight cluster extension.
|
GetExtensionAsync(String, CancellationToken) |
Gets the extension properties for the specified HDInsight cluster extension.
|
GetExtensionAsyncOperationStatus(String, String, CancellationToken) |
Gets the async operation status.
|
GetExtensionAsyncOperationStatusAsync(String, String, CancellationToken) |
Gets the async operation status.
|
GetGatewaySettings(CancellationToken) |
Gets the gateway settings for the specified cluster.
|
GetGatewaySettingsAsync(CancellationToken) |
Gets the gateway settings for the specified cluster.
|
GetHDInsightApplication(String, CancellationToken) |
Gets properties of the specified application.
|
GetHDInsightApplicationAsync(String, CancellationToken) |
Gets properties of the specified application.
|
GetHDInsightApplications() |
Gets a collection of HDInsightApplicationResources in the HDInsightCluster. |
GetHDInsightPrivateEndpointConnection(String, CancellationToken) |
Gets the specific private endpoint connection.
|
GetHDInsightPrivateEndpointConnectionAsync(String, CancellationToken) |
Gets the specific private endpoint connection.
|
GetHDInsightPrivateEndpointConnections() |
Gets a collection of HDInsightPrivateEndpointConnectionResources in the HDInsightCluster. |
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 HDInsightCluster. |
GetManagementLock(String, CancellationToken) |
Get a management lock by scope.
|
GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
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.
|
GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
GetPolicyAssignments() |
Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource) |
GetScriptActionExecutionAsyncOperationStatus(String, CancellationToken) |
Gets the async operation status of execution operation.
|
GetScriptActionExecutionAsyncOperationStatusAsync(String, CancellationToken) |
Gets the async operation status of execution operation.
|
GetScriptActionExecutionDetail(String, CancellationToken) |
Gets the script execution detail for the given script execution ID.
|
GetScriptActionExecutionDetailAsync(String, CancellationToken) |
Gets the script execution detail for the given script execution ID.
|
GetScriptActions(CancellationToken) |
Lists all the persisted script actions for the specified cluster.
|
GetScriptActionsAsync(CancellationToken) |
Lists all the persisted script actions for the specified cluster.
|
GetScriptExecutionHistories(CancellationToken) |
Lists all scripts' execution history for the specified cluster.
|
GetScriptExecutionHistoriesAsync(CancellationToken) |
Lists all scripts' execution history for the specified cluster.
|
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.
|
GetVirtualMachineAsyncOperationStatusAsync(String, CancellationToken) |
Gets the async operation status.
|
GetVirtualMachineHosts(CancellationToken) |
Lists the HDInsight clusters hosts
|
GetVirtualMachineHostsAsync(CancellationToken) |
Lists the HDInsight clusters hosts
|
PromoteScriptExecutionHistory(String, CancellationToken) |
Promotes the specified ad-hoc script execution to a persisted script.
|
PromoteScriptExecutionHistoryAsync(String, CancellationToken) |
Promotes the specified ad-hoc script execution to a persisted script.
|
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.
|
ResizeAsync(WaitUntil, HDInsightRoleName, HDInsightClusterResizeContent, CancellationToken) |
Resizes the specified HDInsight cluster to the specified size.
|
RestartVirtualMachineHosts(WaitUntil, IEnumerable<String>, CancellationToken) |
Restarts the specified HDInsight cluster hosts.
|
RestartVirtualMachineHostsAsync(WaitUntil, IEnumerable<String>, CancellationToken) |
Restarts the specified HDInsight cluster hosts.
|
RotateDiskEncryptionKey(WaitUntil, HDInsightClusterDiskEncryptionContent, CancellationToken) |
Rotate disk encryption key of the specified HDInsight cluster.
|
RotateDiskEncryptionKeyAsync(WaitUntil, HDInsightClusterDiskEncryptionContent, CancellationToken) |
Rotate disk encryption key of the specified HDInsight cluster.
|
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.
|
UpdateAsync(HDInsightClusterPatch, CancellationToken) |
Patch HDInsight cluster with the specified parameters.
|
UpdateAutoScaleConfiguration(WaitUntil, HDInsightRoleName, HDInsightAutoScaleConfigurationUpdateContent, CancellationToken) |
Updates the Autoscale Configuration for HDInsight cluster.
|
UpdateAutoScaleConfigurationAsync(WaitUntil, HDInsightRoleName, HDInsightAutoScaleConfigurationUpdateContent, CancellationToken) |
Updates the Autoscale Configuration for HDInsight cluster.
|
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.
|
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.
|
UpdateGatewaySettings(WaitUntil, HDInsightClusterUpdateGatewaySettingsContent, CancellationToken) |
Configures the gateway settings on the specified cluster.
|
UpdateGatewaySettingsAsync(WaitUntil, HDInsightClusterUpdateGatewaySettingsContent, CancellationToken) |
Configures the gateway settings on the specified cluster.
|
UpdateIdentityCertificate(WaitUntil, HDInsightClusterUpdateIdentityCertificateContent, CancellationToken) |
Updates the cluster identity certificate.
|
UpdateIdentityCertificateAsync(WaitUntil, HDInsightClusterUpdateIdentityCertificateContent, CancellationToken) |
Updates the cluster identity certificate.
|
Explicit Interface Implementations
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
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
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.
|
GetDenyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
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.
|
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken) |
Get a role assignment by scope and name.
|
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
|
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule for a resource scope
|
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
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.
|
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule request.
|
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
|
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule for a resource scope
|
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
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.
|
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule request.
|
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
|
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
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
|
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.
|
GetLinkerResourceAsync(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
GetLinkerResources(ArmResource) |
Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead. |