@azure/arm-hdinsight package

Classes

HDInsightManagementClient

Interfaces

AaddsResourceDetails	The Azure active directory domain service resource details.
Application	The HDInsight cluster application
ApplicationGetEndpoint	Gets the application SSH endpoint
ApplicationGetHttpsEndpoint	Gets the application HTTP endpoints.
ApplicationListResult	Result of the request to list cluster Applications. It contains a list of operations and a URL link to get the next set of results.
ApplicationProperties	The HDInsight cluster application GET response.
Applications	Interface representing a Applications.
ApplicationsCreateOptionalParams	Optional parameters.
ApplicationsDeleteOptionalParams	Optional parameters.
ApplicationsGetAzureAsyncOperationStatusOptionalParams	Optional parameters.
ApplicationsGetOptionalParams	Optional parameters.
ApplicationsListByClusterNextOptionalParams	Optional parameters.
ApplicationsListByClusterOptionalParams	Optional parameters.
AsyncOperationResult	The azure async operation response.
Autoscale	The autoscale request parameters
AutoscaleCapacity	The load-based autoscale request parameters
AutoscaleConfigurationUpdateParameter	The autoscale configuration update parameter.
AutoscaleRecurrence	Schedule-based autoscale request parameters
AutoscaleSchedule	Parameters for a schedule-based autoscale rule, consisting of an array of days + a time and capacity
AutoscaleTimeAndCapacity	Time and capacity request parameters
AzureMonitorRequest	The azure monitor parameters.
AzureMonitorResponse	The azure monitor status response.
AzureMonitorSelectedConfigurations	The selected configurations for azure monitor.
AzureMonitorTableConfiguration	The table configuration for the Log Analytics integration.
BillingMeters	The billing meters.
BillingResources	The billing resources.
BillingResponseListResult	The response for the operation to get regional billingSpecs for a subscription.
CapabilitiesResult	The Get Capabilities operation response.
ClientGroupInfo	The information of AAD security group.
Cluster	The HDInsight cluster.
ClusterConfigurations	The configuration object for the specified cluster.
ClusterCreateParametersExtended	The CreateCluster request parameters.
ClusterCreateProperties	The cluster create parameters.
ClusterCreateRequestValidationParameters	The cluster create request specification.
ClusterCreateValidationResult	The response of cluster create request validation.
ClusterDefinition	The cluster definition.
ClusterDiskEncryptionParameters	The Disk Encryption Cluster request parameters.
ClusterGetProperties	The properties of cluster.
ClusterIdentity	Identity for the cluster.
ClusterListPersistedScriptActionsResult	The ListPersistedScriptActions operation response.
ClusterListResult	The List Cluster operation response.
ClusterMonitoringRequest	The cluster monitor parameters.
ClusterMonitoringResponse	The cluster monitoring status response.
ClusterPatchParameters	The PatchCluster request parameters
ClusterResizeParameters	The Resize Cluster request parameters.
Clusters	Interface representing a Clusters.
ClustersCreateOptionalParams	Optional parameters.
ClustersDeleteOptionalParams	Optional parameters.
ClustersExecuteScriptActionsOptionalParams	Optional parameters.
ClustersGetAzureAsyncOperationStatusOptionalParams	Optional parameters.
ClustersGetGatewaySettingsOptionalParams	Optional parameters.
ClustersGetOptionalParams	Optional parameters.
ClustersListByResourceGroupNextOptionalParams	Optional parameters.
ClustersListByResourceGroupOptionalParams	Optional parameters.
ClustersListNextOptionalParams	Optional parameters.
ClustersListOptionalParams	Optional parameters.
ClustersResizeOptionalParams	Optional parameters.
ClustersRotateDiskEncryptionKeyOptionalParams	Optional parameters.
ClustersUpdateAutoScaleConfigurationOptionalParams	Optional parameters.
ClustersUpdateGatewaySettingsOptionalParams	Optional parameters.
ClustersUpdateIdentityCertificateOptionalParams	Optional parameters.
ClustersUpdateOptionalParams	Optional parameters.
ComputeIsolationProperties	The compute isolation properties.
ComputeProfile	Describes the compute profile.
Configurations	Interface representing a Configurations.
ConfigurationsGetOptionalParams	Optional parameters.
ConfigurationsListOptionalParams	Optional parameters.
ConfigurationsUpdateOptionalParams	Optional parameters.
ConnectivityEndpoint	The connectivity properties
DataDisksGroups	The data disks groups for the role.
Dimension	The definition of Dimension.
DiskBillingMeters	The disk billing meters.
DiskEncryptionProperties	The disk encryption properties
EncryptionInTransitProperties	The encryption-in-transit properties.
ErrorResponse	Describes the format of Error response.
Errors	The error message associated with the cluster creation.
ExcludedServicesConfig	The configuration that services will be excluded when creating cluster.
ExecuteScriptActionParameters	The parameters for the script actions to execute on a running cluster.
Extension	Cluster monitoring extensions.
Extensions	Interface representing a Extensions.
ExtensionsCreateOptionalParams	Optional parameters.
ExtensionsDeleteOptionalParams	Optional parameters.
ExtensionsDisableAzureMonitorOptionalParams	Optional parameters.
ExtensionsDisableMonitoringOptionalParams	Optional parameters.
ExtensionsEnableAzureMonitorOptionalParams	Optional parameters.
ExtensionsEnableMonitoringOptionalParams	Optional parameters.
ExtensionsGetAzureAsyncOperationStatusOptionalParams	Optional parameters.
ExtensionsGetAzureMonitorStatusOptionalParams	Optional parameters.
ExtensionsGetMonitoringStatusOptionalParams	Optional parameters.
ExtensionsGetOptionalParams	Optional parameters.
GatewaySettings	Gateway settings.
HDInsightManagementClientOptionalParams	Optional parameters.
HardwareProfile	The hardware profile.
HostInfo	The cluster host information.
IPConfiguration	The ip configurations for the private link service.
KafkaRestProperties	The kafka rest proxy configuration which contains AAD security group information.
LinuxOperatingSystemProfile	The ssh username, password, and ssh public key.
LocalizedName	The details about the localizable name of a type of usage.
Locations	Interface representing a Locations.
LocationsCheckNameAvailabilityOptionalParams	Optional parameters.
LocationsGetAzureAsyncOperationStatusOptionalParams	Optional parameters.
LocationsGetCapabilitiesOptionalParams	Optional parameters.
LocationsListBillingSpecsOptionalParams	Optional parameters.
LocationsListUsagesOptionalParams	Optional parameters.
LocationsValidateClusterCreateRequestOptionalParams	Optional parameters.
MetricSpecifications	The details of metric specifications.
NameAvailabilityCheckRequestParameters	The request spec of checking name availability.
NameAvailabilityCheckResult	The response spec of checking name availability.
NetworkProperties	The network properties.
Operation	The HDInsight REST API operation.
OperationDisplay	The object that represents the operation.
OperationListResult	Result of the request to list HDInsight operations. It contains a list of operations and a URL link to get the next set of results.
OperationProperties	The details of operation.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
OsProfile	The Linux operation systems profile.
PrivateEndpoint	The private endpoint.
PrivateEndpointConnection	The private endpoint connection.
PrivateEndpointConnectionListResult	The list private endpoint connections response.
PrivateEndpointConnections	Interface representing a PrivateEndpointConnections.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByClusterNextOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByClusterOptionalParams	Optional parameters.
PrivateLinkConfiguration	The private link configuration.
PrivateLinkResource	A private link resource
PrivateLinkResourceListResult	A list of private link resources
PrivateLinkResources	Interface representing a PrivateLinkResources.
PrivateLinkResourcesGetOptionalParams	Optional parameters.
PrivateLinkResourcesListByClusterOptionalParams	Optional parameters.
PrivateLinkServiceConnectionState	The private link service connection state.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
QuotaCapability	The regional quota capability.
QuotaInfo	The quota properties for the cluster.
RegionalQuotaCapability	The regional quota capacity.
RegionsCapability	The regions capability.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceAutoGenerated	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceId	The azure resource id.
Role	Describes a role on the cluster.
RuntimeScriptAction	Describes a script action on a running cluster.
RuntimeScriptActionDetail	The execution details of a script action.
ScriptAction	Describes a script action on role on the cluster.
ScriptActionExecutionHistoryList	The list script execution history response.
ScriptActionExecutionSummary	The execution summary of a script action.
ScriptActionPersistedGetResponseSpec	The persisted script action for cluster.
ScriptActions	Interface representing a ScriptActions.
ScriptActionsDeleteOptionalParams	Optional parameters.
ScriptActionsGetExecutionAsyncOperationStatusOptionalParams	Optional parameters.
ScriptActionsGetExecutionDetailOptionalParams	Optional parameters.
ScriptActionsList	The persisted script action for the cluster.
ScriptActionsListByClusterNextOptionalParams	Optional parameters.
ScriptActionsListByClusterOptionalParams	Optional parameters.
ScriptExecutionHistory	Interface representing a ScriptExecutionHistory.
ScriptExecutionHistoryListByClusterNextOptionalParams	Optional parameters.
ScriptExecutionHistoryListByClusterOptionalParams	Optional parameters.
ScriptExecutionHistoryPromoteOptionalParams	Optional parameters.
SecurityProfile	The security profile which contains Ssh public key for the HDInsight cluster.
ServiceSpecification	The specification of the service.
SshProfile	The list of SSH public keys.
SshPublicKey	The SSH public key for the cluster nodes.
StorageAccount	The storage Account.
StorageProfile	The storage profile.
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UpdateClusterIdentityCertificateParameters	The update cluster identity certificate request parameters.
UpdateGatewaySettingsParameters	The update gateway settings request parameters.
Usage	The details about the usage of a particular limited resource.
UsagesListResult	The response for the operation to get regional usages for a subscription.
UserAssignedIdentity	The User Assigned Identity
ValidationErrorInfo	The validation error information.
VersionSpec	The version properties.
VersionsCapability	The version capability.
VirtualMachines	Interface representing a VirtualMachines.
VirtualMachinesGetAsyncOperationStatusOptionalParams	Optional parameters.
VirtualMachinesListHostsOptionalParams	Optional parameters.
VirtualMachinesRestartHostsOptionalParams	Optional parameters.
VirtualNetworkProfile	The virtual network properties.
VmSizeCompatibilityFilterV2	This class represent a single filter object that defines a multidimensional set. The dimensions of this set are Regions, ClusterFlavors, NodeTypes and ClusterVersions. The constraint should be defined based on the following: FilterMode (Exclude vs Include), VMSizes (the vm sizes in affect of exclusion/inclusion) and the ordering of the Filters. Later filters override previous settings if conflicted.
VmSizeProperty	The vm size property

Type Aliases

ApplicationsCreateResponse	Contains response data for the create operation.
ApplicationsGetAzureAsyncOperationStatusResponse	Contains response data for the getAzureAsyncOperationStatus operation.
ApplicationsGetResponse	Contains response data for the get operation.
ApplicationsListByClusterNextResponse	Contains response data for the listByClusterNext operation.
ApplicationsListByClusterResponse	Contains response data for the listByCluster operation.
AsyncOperationState	Defines values for AsyncOperationState. KnownAsyncOperationState can be used interchangeably with AsyncOperationState, this enum contains the known values that the service supports. Known values supported by the service InProgress Succeeded Failed
ClustersCreateResponse	Contains response data for the create operation.
ClustersGetAzureAsyncOperationStatusResponse	Contains response data for the getAzureAsyncOperationStatus operation.
ClustersGetGatewaySettingsResponse	Contains response data for the getGatewaySettings operation.
ClustersGetResponse	Contains response data for the get operation.
ClustersListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
ClustersListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
ClustersListNextResponse	Contains response data for the listNext operation.
ClustersListResponse	Contains response data for the list operation.
ClustersUpdateResponse	Contains response data for the update operation.
ConfigurationsGetResponse	Contains response data for the get operation.
ConfigurationsListResponse	Contains response data for the list operation.
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
DaysOfWeek	Defines values for DaysOfWeek. KnownDaysOfWeek can be used interchangeably with DaysOfWeek, this enum contains the known values that the service supports. Known values supported by the service Monday Tuesday Wednesday Thursday Friday Saturday Sunday
DirectoryType	Defines values for DirectoryType. KnownDirectoryType can be used interchangeably with DirectoryType, this enum contains the known values that the service supports. Known values supported by the service ActiveDirectory
ExtensionsGetAzureAsyncOperationStatusResponse	Contains response data for the getAzureAsyncOperationStatus operation.
ExtensionsGetAzureMonitorStatusResponse	Contains response data for the getAzureMonitorStatus operation.
ExtensionsGetMonitoringStatusResponse	Contains response data for the getMonitoringStatus operation.
ExtensionsGetResponse	Contains response data for the get operation.
FilterMode	Defines values for FilterMode. KnownFilterMode can be used interchangeably with FilterMode, this enum contains the known values that the service supports. Known values supported by the service Exclude Include Recommend Default
HDInsightClusterProvisioningState	Defines values for HDInsightClusterProvisioningState. KnownHDInsightClusterProvisioningState can be used interchangeably with HDInsightClusterProvisioningState, this enum contains the known values that the service supports. Known values supported by the service InProgress Failed Succeeded Canceled Deleting
JsonWebKeyEncryptionAlgorithm	Defines values for JsonWebKeyEncryptionAlgorithm. KnownJsonWebKeyEncryptionAlgorithm can be used interchangeably with JsonWebKeyEncryptionAlgorithm, this enum contains the known values that the service supports. Known values supported by the service RSA-OAEP RSA-OAEP-256 RSA1_5
LocationsCheckNameAvailabilityResponse	Contains response data for the checkNameAvailability operation.
LocationsGetAzureAsyncOperationStatusResponse	Contains response data for the getAzureAsyncOperationStatus operation.
LocationsGetCapabilitiesResponse	Contains response data for the getCapabilities operation.
LocationsListBillingSpecsResponse	Contains response data for the listBillingSpecs operation.
LocationsListUsagesResponse	Contains response data for the listUsages operation.
LocationsValidateClusterCreateRequestResponse	Contains response data for the validateClusterCreateRequest operation.
OSType	Defines values for OSType. KnownOSType can be used interchangeably with OSType, this enum contains the known values that the service supports. Known values supported by the service Windows Linux
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
PrivateEndpointConnectionProvisioningState	Defines values for PrivateEndpointConnectionProvisioningState. KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports. Known values supported by the service InProgress Updating Failed Succeeded Canceled Deleting
PrivateEndpointConnectionsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
PrivateEndpointConnectionsGetResponse	Contains response data for the get operation.
PrivateEndpointConnectionsListByClusterNextResponse	Contains response data for the listByClusterNext operation.
PrivateEndpointConnectionsListByClusterResponse	Contains response data for the listByCluster operation.
PrivateIPAllocationMethod	Defines values for PrivateIPAllocationMethod. KnownPrivateIPAllocationMethod can be used interchangeably with PrivateIPAllocationMethod, this enum contains the known values that the service supports. Known values supported by the service dynamic static
PrivateLink	Defines values for PrivateLink. KnownPrivateLink can be used interchangeably with PrivateLink, this enum contains the known values that the service supports. Known values supported by the service Disabled Enabled
PrivateLinkConfigurationProvisioningState	Defines values for PrivateLinkConfigurationProvisioningState. KnownPrivateLinkConfigurationProvisioningState can be used interchangeably with PrivateLinkConfigurationProvisioningState, this enum contains the known values that the service supports. Known values supported by the service InProgress Failed Succeeded Canceled Deleting
PrivateLinkResourcesGetResponse	Contains response data for the get operation.
PrivateLinkResourcesListByClusterResponse	Contains response data for the listByCluster operation.
PrivateLinkServiceConnectionStatus	Defines values for PrivateLinkServiceConnectionStatus. KnownPrivateLinkServiceConnectionStatus can be used interchangeably with PrivateLinkServiceConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Approved Rejected Pending Removed
ResourceIdentityType	Defines values for ResourceIdentityType. KnownResourceIdentityType can be used interchangeably with ResourceIdentityType, this enum contains the known values that the service supports. Known values supported by the service SystemAssigned UserAssigned SystemAssigned, UserAssigned None
ResourceProviderConnection	Defines values for ResourceProviderConnection. KnownResourceProviderConnection can be used interchangeably with ResourceProviderConnection, this enum contains the known values that the service supports. Known values supported by the service Inbound Outbound
RoleName	Defines values for RoleName. KnownRoleName can be used interchangeably with RoleName, this enum contains the known values that the service supports. Known values supported by the service workernode
ScriptActionsGetExecutionAsyncOperationStatusResponse	Contains response data for the getExecutionAsyncOperationStatus operation.
ScriptActionsGetExecutionDetailResponse	Contains response data for the getExecutionDetail operation.
ScriptActionsListByClusterNextResponse	Contains response data for the listByClusterNext operation.
ScriptActionsListByClusterResponse	Contains response data for the listByCluster operation.
ScriptExecutionHistoryListByClusterNextResponse	Contains response data for the listByClusterNext operation.
ScriptExecutionHistoryListByClusterResponse	Contains response data for the listByCluster operation.
Tier	Defines values for Tier. KnownTier can be used interchangeably with Tier, this enum contains the known values that the service supports. Known values supported by the service Standard Premium
VirtualMachinesGetAsyncOperationStatusResponse	Contains response data for the getAsyncOperationStatus operation.
VirtualMachinesListHostsResponse	Contains response data for the listHosts operation.

Enums

KnownAsyncOperationState	Known values of AsyncOperationState that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownDaysOfWeek	Known values of DaysOfWeek that the service accepts.
KnownDirectoryType	Known values of DirectoryType that the service accepts.
KnownFilterMode	Known values of FilterMode that the service accepts.
KnownHDInsightClusterProvisioningState	Known values of HDInsightClusterProvisioningState that the service accepts.
KnownJsonWebKeyEncryptionAlgorithm	Known values of JsonWebKeyEncryptionAlgorithm that the service accepts.
KnownOSType	Known values of OSType that the service accepts.
KnownPrivateEndpointConnectionProvisioningState	Known values of PrivateEndpointConnectionProvisioningState that the service accepts.
KnownPrivateIPAllocationMethod	Known values of PrivateIPAllocationMethod that the service accepts.
KnownPrivateLink	Known values of PrivateLink that the service accepts.
KnownPrivateLinkConfigurationProvisioningState	Known values of PrivateLinkConfigurationProvisioningState that the service accepts.
KnownPrivateLinkServiceConnectionStatus	Known values of PrivateLinkServiceConnectionStatus that the service accepts.
KnownResourceIdentityType	Known values of ResourceIdentityType that the service accepts.
KnownResourceProviderConnection	Known values of ResourceProviderConnection that the service accepts.
KnownRoleName	Known values of RoleName that the service accepts.
KnownTier	Known values of Tier that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.