@azure/arm-hdinsightcontainers package

Classes

HDInsightContainersManagementClient

Interfaces

AksClusterProfile	Properties of the cluster pool underlying AKS cluster.
AksClusterProfileAksClusterAgentPoolIdentityProfile	Identity properties of the AKS cluster agentpool MSI
AuthorizationProfile	Authorization profile with details of AAD user Ids and group Ids authorized for data plane access.
AutoscaleProfile	This is the Autoscale profile for the cluster. This will allow customer to create cluster enabled with Autoscale.
AvailableClusterPoolVersions	Interface representing a AvailableClusterPoolVersions.
AvailableClusterPoolVersionsListByLocationNextOptionalParams	Optional parameters.
AvailableClusterPoolVersionsListByLocationOptionalParams	Optional parameters.
AvailableClusterVersions	Interface representing a AvailableClusterVersions.
AvailableClusterVersionsListByLocationNextOptionalParams	Optional parameters.
AvailableClusterVersionsListByLocationOptionalParams	Optional parameters.
CatalogOptions	Trino cluster catalog options.
Cluster	The cluster.
ClusterAKSPatchVersionUpgradeProperties	Properties of upgrading cluster's AKS patch version.
ClusterAccessProfile	Cluster access profile.
ClusterAvailableUpgrade	Cluster available upgrade.
ClusterAvailableUpgradeAksPatchUpgradeProperties	Cluster available AKS patch version upgrade.
ClusterAvailableUpgradeHotfixUpgradeProperties	Cluster available hotfix version upgrade.
ClusterAvailableUpgradeList	Collection of cluster available upgrade.
ClusterAvailableUpgradeProperties	Cluster available upgrade properties.
ClusterAvailableUpgrades	Interface representing a ClusterAvailableUpgrades.
ClusterAvailableUpgradesListNextOptionalParams	Optional parameters.
ClusterAvailableUpgradesListOptionalParams	Optional parameters.
ClusterComponentsItem
ClusterConfigFile	Cluster configuration files.
ClusterHotfixUpgradeProperties	Properties of upgrading cluster's hotfix.
ClusterInstanceViewProperties	Cluster Instance View Properties.
ClusterInstanceViewPropertiesStatus	Status of the instance view.
ClusterInstanceViewResult	Cluster Instance View.
ClusterInstanceViewResultProperties	Properties of the instance view.
ClusterInstanceViewStatus	Status of the instance view.
ClusterInstanceViewsResult	The instance view of a HDInsight Cluster.
ClusterJob	Cluster job.
ClusterJobList	Collection of cluster job.
ClusterJobProperties	Properties of cluster job.
ClusterJobs	Interface representing a ClusterJobs.
ClusterJobsListNextOptionalParams	Optional parameters.
ClusterJobsListOptionalParams	Optional parameters.
ClusterJobsRunJobHeaders	Defines headers for ClusterJobs_runJob operation.
ClusterJobsRunJobOptionalParams	Optional parameters.
ClusterListResult	The list cluster operation response.
ClusterLogAnalyticsApplicationLogs	Collection of logs to be enabled or disabled for log analytics.
ClusterLogAnalyticsProfile	Cluster log analytics profile to enable or disable OMS agent for cluster.
ClusterPatch	The patch for a cluster.
ClusterPatchProperties	Cluster resource patch data.
ClusterPool	Cluster pool.
ClusterPoolAKSPatchVersionUpgradeProperties	Properties of upgrading cluster pool's AKS patch version.
ClusterPoolAvailableUpgrade	Cluster pool available upgrade.
ClusterPoolAvailableUpgradeAksPatchUpgradeProperties	Cluster pool available AKS patch version upgrade.
ClusterPoolAvailableUpgradeList	collection of cluster pool available upgrade.
ClusterPoolAvailableUpgradeNodeOsUpgradeProperties	Cluster pool available node OS update.
ClusterPoolAvailableUpgradeProperties	Cluster pool available upgrade properties.
ClusterPoolAvailableUpgrades	Interface representing a ClusterPoolAvailableUpgrades.
ClusterPoolAvailableUpgradesListNextOptionalParams	Optional parameters.
ClusterPoolAvailableUpgradesListOptionalParams	Optional parameters.
ClusterPoolComputeProfile	Cluster pool compute profile.
ClusterPoolListResult	The list cluster pools operation response.
ClusterPoolLogAnalyticsProfile	Cluster pool log analytics profile used to enable or disable OMS agent for AKS cluster.
ClusterPoolNetworkProfile	Cluster pool networking configuration.
ClusterPoolNodeOsImageUpdateProperties	Properties of upgrading cluster pool's AKS patch version.
ClusterPoolProfile	Cluster pool profile.
ClusterPoolResourceProperties	Cluster pool resource properties.
ClusterPoolResourcePropertiesAksClusterProfile	Properties of underlying AKS cluster.
ClusterPoolResourcePropertiesClusterPoolProfile	CLuster pool profile.
ClusterPoolResourcePropertiesComputeProfile	CLuster pool compute profile.
ClusterPoolResourcePropertiesLogAnalyticsProfile	Cluster pool log analytics profile to enable OMS agent for AKS cluster.
ClusterPoolResourcePropertiesNetworkProfile	Cluster pool network profile.
ClusterPoolUpgrade	Cluster Pool Upgrade.
ClusterPoolUpgradeProperties	Properties of upgrading cluster pool.
ClusterPoolVersion	Available cluster pool version.
ClusterPoolVersionProperties	Cluster pool version properties.
ClusterPoolVersionsListResult	Represents a list of cluster pool versions.
ClusterPools	Interface representing a ClusterPools.
ClusterPoolsCreateOrUpdateOptionalParams	Optional parameters.
ClusterPoolsDeleteHeaders	Defines headers for ClusterPools_delete operation.
ClusterPoolsDeleteOptionalParams	Optional parameters.
ClusterPoolsGetOptionalParams	Optional parameters.
ClusterPoolsListByResourceGroupNextOptionalParams	Optional parameters.
ClusterPoolsListByResourceGroupOptionalParams	Optional parameters.
ClusterPoolsListBySubscriptionNextOptionalParams	Optional parameters.
ClusterPoolsListBySubscriptionOptionalParams	Optional parameters.
ClusterPoolsUpdateTagsHeaders	Defines headers for ClusterPools_updateTags operation.
ClusterPoolsUpdateTagsOptionalParams	Optional parameters.
ClusterPoolsUpgradeHeaders	Defines headers for ClusterPools_upgrade operation.
ClusterPoolsUpgradeOptionalParams	Optional parameters.
ClusterProfile	Cluster profile.
ClusterPrometheusProfile	Cluster Prometheus profile.
ClusterRangerPluginProfile	Cluster Ranger plugin profile.
ClusterResizeData	The parameters for resizing a cluster.
ClusterResizeProperties	The properties for resizing a cluster.
ClusterResourceProperties	Cluster resource properties.
ClusterServiceConfig	Cluster configs per component.
ClusterServiceConfigsProfile	Cluster service configs.
ClusterUpgrade	Cluster Upgrade.
ClusterUpgradeProperties	Properties of upgrading cluster.
ClusterVersion	Available cluster version.
ClusterVersionProperties	Cluster version properties.
ClusterVersionsListResult	Represents a list of cluster versions.
Clusters	Interface representing a Clusters.
ClustersCreateOptionalParams	Optional parameters.
ClustersDeleteHeaders	Defines headers for Clusters_delete operation.
ClustersDeleteOptionalParams	Optional parameters.
ClustersGetInstanceViewOptionalParams	Optional parameters.
ClustersGetOptionalParams	Optional parameters.
ClustersListByClusterPoolNameNextOptionalParams	Optional parameters.
ClustersListByClusterPoolNameOptionalParams	Optional parameters.
ClustersListInstanceViewsNextOptionalParams	Optional parameters.
ClustersListInstanceViewsOptionalParams	Optional parameters.
ClustersListServiceConfigsNextOptionalParams	Optional parameters.
ClustersListServiceConfigsOptionalParams	Optional parameters.
ClustersResizeHeaders	Defines headers for Clusters_resize operation.
ClustersResizeOptionalParams	Optional parameters.
ClustersUpdateHeaders	Defines headers for Clusters_update operation.
ClustersUpdateOptionalParams	Optional parameters.
ClustersUpgradeHeaders	Defines headers for Clusters_upgrade operation.
ClustersUpgradeOptionalParams	Optional parameters.
ComparisonRule	The comparison rule.
ComputeProfile	The compute profile.
ComputeResourceDefinition	The cpu and memory requirement definition.
ConnectivityProfile	Cluster connectivity profile.
ConnectivityProfileWeb	Web connectivity endpoint details.
DiskStorageProfile	Kafka disk storage profile.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
FlinkCatalogOptions	Flink cluster catalog options.
FlinkHiveCatalogOption	Hive Catalog Option for Flink cluster.
FlinkJobProfile	Job specifications for flink clusters in application deployment mode. The specification is immutable even if job properties are changed by calling the RunJob API, please use the ListJob API to get the latest job information.
FlinkJobProperties	Properties of flink job.
FlinkProfile	The Flink cluster profile.
FlinkStorageProfile	The storage profile
HDInsightContainersManagementClientOptionalParams	Optional parameters.
HiveCatalogOption	Hive Catalog Option
IdentityProfile	Identity Profile with details of an MSI.
KafkaConnectivityEndpoints	Kafka bootstrap server and broker related connectivity endpoints.
KafkaProfile	The Kafka cluster profile.
LoadBasedConfig	Profile of load based Autoscale.
Locations	Interface representing a Locations.
LocationsCheckNameAvailabilityOptionalParams	Optional parameters.
NameAvailabilityParameters	Details of check name availability request body.
NameAvailabilityResult	Result of check name availability.
NodeProfile	The node profile.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for this particular operation.
OperationListResult	A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RangerAdminSpec	Specification for the Ranger Admin service.
RangerAdminSpecDatabase
RangerAuditSpec	Properties required to describe audit log storage.
RangerProfile	The ranger cluster profile.
RangerUsersyncSpec	Specification for the Ranger Usersync service
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ScalingRule	The scaling rule.
Schedule	Schedule definition.
ScheduleBasedConfig	Profile of schedule based Autoscale.
ScriptActionProfile	The script action profile.
SecretReference	Secret reference and corresponding properties of a key vault secret.
SecretsProfile	The cluster secret profile.
ServiceConfigListResult	Cluster instance service configs api response.
ServiceConfigListResultProperties	Service config response.
ServiceConfigListResultValueEntity	Default config details.
ServiceConfigResult	Cluster instance service config.
ServiceConfigResultProperties	Cluster instance service config properties.
ServiceStatus	Describes the status of a service of a HDInsight on AKS cluster.
SparkMetastoreSpec	The metastore specification for Spark cluster.
SparkProfile	The spark cluster profile.
SparkUserPlugin	Spark user plugin.
SparkUserPlugins	Spark user plugins spec
SshConnectivityEndpoint	SSH connectivity endpoint details.
SshProfile	Ssh profile for the cluster.
SystemData	Metadata pertaining to creation and last modification of the resource.
TagsObject	Tags object for patch operations.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
TrinoCoordinator	Trino Coordinator.
TrinoDebugConfig	Trino debug configuration.
TrinoProfile	Trino Cluster profile.
TrinoTelemetryConfig	Trino user telemetry definition.
TrinoUserPlugin	Trino user plugin.
TrinoUserPlugins	Trino user plugins spec
TrinoUserTelemetry	User telemetry
TrinoWorker	Trino worker.
UpdatableClusterProfile	Cluster resource patch properties.
WebConnectivityEndpoint	Web connectivity endpoint details.

Type Aliases

Action	Defines values for Action. KnownAction can be used interchangeably with Action, this enum contains the known values that the service supports. Known values supported by the service NEW UPDATE STATELESS_UPDATE STOP START CANCEL SAVEPOINT LIST_SAVEPOINT DELETE LAST_STATE_UPDATE RE_LAUNCH
ActionType	Defines values for ActionType. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal
AutoscaleType	Defines values for AutoscaleType. KnownAutoscaleType can be used interchangeably with AutoscaleType, this enum contains the known values that the service supports. Known values supported by the service ScheduleBased LoadBased
AvailableClusterPoolVersionsListByLocationNextResponse	Contains response data for the listByLocationNext operation.
AvailableClusterPoolVersionsListByLocationResponse	Contains response data for the listByLocation operation.
AvailableClusterVersionsListByLocationNextResponse	Contains response data for the listByLocationNext operation.
AvailableClusterVersionsListByLocationResponse	Contains response data for the listByLocation operation.
ClusterAvailableUpgradePropertiesUnion
ClusterAvailableUpgradeType	Defines values for ClusterAvailableUpgradeType. KnownClusterAvailableUpgradeType can be used interchangeably with ClusterAvailableUpgradeType, this enum contains the known values that the service supports. Known values supported by the service AKSPatchUpgrade HotfixUpgrade
ClusterAvailableUpgradesListNextResponse	Contains response data for the listNext operation.
ClusterAvailableUpgradesListResponse	Contains response data for the list operation.
ClusterJobPropertiesUnion
ClusterJobsListNextResponse	Contains response data for the listNext operation.
ClusterJobsListResponse	Contains response data for the list operation.
ClusterJobsRunJobResponse	Contains response data for the runJob operation.
ClusterPoolAvailableUpgradePropertiesUnion
ClusterPoolAvailableUpgradeType	Defines values for ClusterPoolAvailableUpgradeType. KnownClusterPoolAvailableUpgradeType can be used interchangeably with ClusterPoolAvailableUpgradeType, this enum contains the known values that the service supports. Known values supported by the service AKSPatchUpgrade NodeOsUpgrade
ClusterPoolAvailableUpgradesListNextResponse	Contains response data for the listNext operation.
ClusterPoolAvailableUpgradesListResponse	Contains response data for the list operation.
ClusterPoolUpgradePropertiesUnion
ClusterPoolUpgradeType	Defines values for ClusterPoolUpgradeType. KnownClusterPoolUpgradeType can be used interchangeably with ClusterPoolUpgradeType, this enum contains the known values that the service supports. Known values supported by the service AKSPatchUpgrade NodeOsUpgrade
ClusterPoolsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ClusterPoolsGetResponse	Contains response data for the get operation.
ClusterPoolsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
ClusterPoolsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
ClusterPoolsListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
ClusterPoolsListBySubscriptionResponse	Contains response data for the listBySubscription operation.
ClusterPoolsUpdateTagsResponse	Contains response data for the updateTags operation.
ClusterPoolsUpgradeResponse	Contains response data for the upgrade operation.
ClusterUpgradePropertiesUnion
ClusterUpgradeType	Defines values for ClusterUpgradeType. KnownClusterUpgradeType can be used interchangeably with ClusterUpgradeType, this enum contains the known values that the service supports. Known values supported by the service AKSPatchUpgrade HotfixUpgrade
ClustersCreateResponse	Contains response data for the create operation.
ClustersGetInstanceViewResponse	Contains response data for the getInstanceView operation.
ClustersGetResponse	Contains response data for the get operation.
ClustersListByClusterPoolNameNextResponse	Contains response data for the listByClusterPoolNameNext operation.
ClustersListByClusterPoolNameResponse	Contains response data for the listByClusterPoolName operation.
ClustersListInstanceViewsNextResponse	Contains response data for the listInstanceViewsNext operation.
ClustersListInstanceViewsResponse	Contains response data for the listInstanceViews operation.
ClustersListServiceConfigsNextResponse	Contains response data for the listServiceConfigsNext operation.
ClustersListServiceConfigsResponse	Contains response data for the listServiceConfigs operation.
ClustersResizeResponse	Contains response data for the resize operation.
ClustersUpdateResponse	Contains response data for the update operation.
ClustersUpgradeResponse	Contains response data for the upgrade operation.
ComparisonOperator	Defines values for ComparisonOperator. KnownComparisonOperator can be used interchangeably with ComparisonOperator, this enum contains the known values that the service supports. Known values supported by the service greaterThan greaterThanOrEqual lessThan lessThanOrEqual
ContentEncoding	Defines values for ContentEncoding. KnownContentEncoding can be used interchangeably with ContentEncoding, this enum contains the known values that the service supports. Known values supported by the service Base64 None
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
CurrentClusterAksVersionStatus	Defines values for CurrentClusterAksVersionStatus. KnownCurrentClusterAksVersionStatus can be used interchangeably with CurrentClusterAksVersionStatus, this enum contains the known values that the service supports. Known values supported by the service Deprecated Supported
CurrentClusterPoolAksVersionStatus	Defines values for CurrentClusterPoolAksVersionStatus. KnownCurrentClusterPoolAksVersionStatus can be used interchangeably with CurrentClusterPoolAksVersionStatus, this enum contains the known values that the service supports. Known values supported by the service Deprecated Supported
DataDiskType	Defines values for DataDiskType. KnownDataDiskType can be used interchangeably with DataDiskType, this enum contains the known values that the service supports. Known values supported by the service Standard_HDD_LRS Standard_SSD_LRS Standard_SSD_ZRS Premium_SSD_LRS Premium_SSD_ZRS Premium_SSD_v2_LRS
DbConnectionAuthenticationMode	Defines values for DbConnectionAuthenticationMode. KnownDbConnectionAuthenticationMode can be used interchangeably with DbConnectionAuthenticationMode, this enum contains the known values that the service supports. Known values supported by the service SqlAuth: The password-based authentication to connect to your Hive metastore database. IdentityAuth: The managed-identity-based authentication to connect to your Hive metastore database.
DeploymentMode	Defines values for DeploymentMode. KnownDeploymentMode can be used interchangeably with DeploymentMode, this enum contains the known values that the service supports. Known values supported by the service Application Session
JobType	Defines values for JobType. KnownJobType can be used interchangeably with JobType, this enum contains the known values that the service supports. Known values supported by the service FlinkJob
KeyVaultObjectType	Defines values for KeyVaultObjectType. KnownKeyVaultObjectType can be used interchangeably with KeyVaultObjectType, this enum contains the known values that the service supports. Known values supported by the service Key Secret Certificate
LocationsCheckNameAvailabilityResponse	Contains response data for the checkNameAvailability operation.
MetastoreDbConnectionAuthenticationMode	Defines values for MetastoreDbConnectionAuthenticationMode. KnownMetastoreDbConnectionAuthenticationMode can be used interchangeably with MetastoreDbConnectionAuthenticationMode, this enum contains the known values that the service supports. Known values supported by the service SqlAuth: The password-based authentication to connect to your Hive metastore database. IdentityAuth: The managed-identity-based authentication to connect to your Hive metastore database.
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
Origin	Defines values for Origin. KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user system user,system
OutboundType	Defines values for OutboundType. KnownOutboundType can be used interchangeably with OutboundType, this enum contains the known values that the service supports. Known values supported by the service loadBalancer: The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. userDefinedRouting: Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration.
ProvisioningStatus	Defines values for ProvisioningStatus. KnownProvisioningStatus can be used interchangeably with ProvisioningStatus, this enum contains the known values that the service supports. Known values supported by the service Accepted Succeeded Canceled Failed
RangerUsersyncMode	Defines values for RangerUsersyncMode. KnownRangerUsersyncMode can be used interchangeably with RangerUsersyncMode, this enum contains the known values that the service supports. Known values supported by the service static automatic
ScaleActionType	Defines values for ScaleActionType. KnownScaleActionType can be used interchangeably with ScaleActionType, this enum contains the known values that the service supports. Known values supported by the service scaleup scaledown
ScheduleDay	Defines values for ScheduleDay. KnownScheduleDay can be used interchangeably with ScheduleDay, this enum contains the known values that the service supports. Known values supported by the service Sunday Monday Tuesday Wednesday Thursday Friday Saturday
Severity	Defines values for Severity. KnownSeverity can be used interchangeably with Severity, this enum contains the known values that the service supports. Known values supported by the service low medium high critical
UpgradeMode	Defines values for UpgradeMode. KnownUpgradeMode can be used interchangeably with UpgradeMode, this enum contains the known values that the service supports. Known values supported by the service STATELESS_UPDATE UPDATE LAST_STATE_UPDATE

Enums

KnownAction	Known values of Action that the service accepts.
KnownActionType	Known values of ActionType that the service accepts.
KnownAutoscaleType	Known values of AutoscaleType that the service accepts.
KnownClusterAvailableUpgradeType	Known values of ClusterAvailableUpgradeType that the service accepts.
KnownClusterPoolAvailableUpgradeType	Known values of ClusterPoolAvailableUpgradeType that the service accepts.
KnownClusterPoolUpgradeType	Known values of ClusterPoolUpgradeType that the service accepts.
KnownClusterUpgradeType	Known values of ClusterUpgradeType that the service accepts.
KnownComparisonOperator	Known values of ComparisonOperator that the service accepts.
KnownContentEncoding	Known values of ContentEncoding that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownCurrentClusterAksVersionStatus	Known values of CurrentClusterAksVersionStatus that the service accepts.
KnownCurrentClusterPoolAksVersionStatus	Known values of CurrentClusterPoolAksVersionStatus that the service accepts.
KnownDataDiskType	Known values of DataDiskType that the service accepts.
KnownDbConnectionAuthenticationMode	Known values of DbConnectionAuthenticationMode that the service accepts.
KnownDeploymentMode	Known values of DeploymentMode that the service accepts.
KnownJobType	Known values of JobType that the service accepts.
KnownKeyVaultObjectType	Known values of KeyVaultObjectType that the service accepts.
KnownMetastoreDbConnectionAuthenticationMode	Known values of MetastoreDbConnectionAuthenticationMode that the service accepts.
KnownOrigin	Known values of Origin that the service accepts.
KnownOutboundType	Known values of OutboundType that the service accepts.
KnownProvisioningStatus	Known values of ProvisioningStatus that the service accepts.
KnownRangerUsersyncMode	Known values of RangerUsersyncMode that the service accepts.
KnownScaleActionType	Known values of ScaleActionType that the service accepts.
KnownScheduleDay	Known values of ScheduleDay that the service accepts.
KnownSeverity	Known values of Severity that the service accepts.
KnownUpgradeMode	Known values of UpgradeMode 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.