Microsoft.HDInsight (preview:2023-11-01)

2025/11/06 • 25 deleted methods

ClusterPools_Get (removed)
Description :  Gets a cluster pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
clusterPoolName:
{
Description: The name of the cluster pool. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties. Define cluster pool specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentId:
{
Description: A unique id generated by the RP to identify the resource. ,
Required: False ,
}
string ,
managedResourceGroupName:
{
Description: A resource group created by RP, to hold the resources created by RP on-behalf of customers. It will also be used to generate aksManagedResourceGroupName by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region}. Please make sure it meets resource group name restriction. ,
Required: False ,
}
string ,
aksManagedResourceGroupName:
{
Description: A resource group created by AKS, to hold the infrastructure resources created by AKS on-behalf of customers. It is generated by cluster pool name and managed resource group name by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region} ,
Required: False ,
}
string ,
clusterPoolProfile:
{
Description: CLuster pool profile. ,
Required: False ,
}
string ,
computeProfile:
{
Description: CLuster pool compute profile. ,
Required: True ,
}
string ,
aksClusterProfile:
{
Description: Properties of underlying AKS cluster. ,
Required: False ,
}
string ,
networkProfile:
{
Description: Cluster pool network profile. ,
Required: False ,
}
string ,
logAnalyticsProfile:
{
Description: Cluster pool log analytics profile to enable OMS agent for AKS cluster. ,
Required: False ,
}
string ,
status:
{
Description: Business status of the resource. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: SystemData of cluster pool. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClusterPools_CreateOrUpdate (removed)
Description :  Creates or updates a cluster pool.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
clusterPoolName:
{
Description: The name of the cluster pool. ,
Required: True ,
}
string ,
ClusterPool:
{
Description: The Cluster Pool to create. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the properties. Define cluster pool specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentId:
{
Description: A unique id generated by the RP to identify the resource. ,
Required: False ,
}
string ,
managedResourceGroupName:
{
Description: A resource group created by RP, to hold the resources created by RP on-behalf of customers. It will also be used to generate aksManagedResourceGroupName by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region}. Please make sure it meets resource group name restriction. ,
Required: False ,
}
string ,
aksManagedResourceGroupName:
{
Description: A resource group created by AKS, to hold the infrastructure resources created by AKS on-behalf of customers. It is generated by cluster pool name and managed resource group name by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region} ,
Required: False ,
}
string ,
clusterPoolProfile:
{
Description: CLuster pool profile. ,
Required: False ,
}
string ,
computeProfile:
{
Description: CLuster pool compute profile. ,
Required: True ,
}
string ,
aksClusterProfile:
{
Description: Properties of underlying AKS cluster. ,
Required: False ,
}
string ,
networkProfile:
{
Description: Cluster pool network profile. ,
Required: False ,
}
string ,
logAnalyticsProfile:
{
Description: Cluster pool log analytics profile to enable OMS agent for AKS cluster. ,
Required: False ,
}
string ,
status:
{
Description: Business status of the resource. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: SystemData of cluster pool. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the properties. Define cluster pool specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentId:
{
Description: A unique id generated by the RP to identify the resource. ,
Required: False ,
}
string ,
managedResourceGroupName:
{
Description: A resource group created by RP, to hold the resources created by RP on-behalf of customers. It will also be used to generate aksManagedResourceGroupName by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region}. Please make sure it meets resource group name restriction. ,
Required: False ,
}
string ,
aksManagedResourceGroupName:
{
Description: A resource group created by AKS, to hold the infrastructure resources created by AKS on-behalf of customers. It is generated by cluster pool name and managed resource group name by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region} ,
Required: False ,
}
string ,
clusterPoolProfile:
{
Description: CLuster pool profile. ,
Required: False ,
}
string ,
computeProfile:
{
Description: CLuster pool compute profile. ,
Required: True ,
}
string ,
aksClusterProfile:
{
Description: Properties of underlying AKS cluster. ,
Required: False ,
}
string ,
networkProfile:
{
Description: Cluster pool network profile. ,
Required: False ,
}
string ,
logAnalyticsProfile:
{
Description: Cluster pool log analytics profile to enable OMS agent for AKS cluster. ,
Required: False ,
}
string ,
status:
{
Description: Business status of the resource. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: SystemData of cluster pool. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties. Define cluster pool specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentId:
{
Description: A unique id generated by the RP to identify the resource. ,
Required: False ,
}
string ,
managedResourceGroupName:
{
Description: A resource group created by RP, to hold the resources created by RP on-behalf of customers. It will also be used to generate aksManagedResourceGroupName by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region}. Please make sure it meets resource group name restriction. ,
Required: False ,
}
string ,
aksManagedResourceGroupName:
{
Description: A resource group created by AKS, to hold the infrastructure resources created by AKS on-behalf of customers. It is generated by cluster pool name and managed resource group name by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region} ,
Required: False ,
}
string ,
clusterPoolProfile:
{
Description: CLuster pool profile. ,
Required: False ,
}
string ,
computeProfile:
{
Description: CLuster pool compute profile. ,
Required: True ,
}
string ,
aksClusterProfile:
{
Description: Properties of underlying AKS cluster. ,
Required: False ,
}
string ,
networkProfile:
{
Description: Cluster pool network profile. ,
Required: False ,
}
string ,
logAnalyticsProfile:
{
Description: Cluster pool log analytics profile to enable OMS agent for AKS cluster. ,
Required: False ,
}
string ,
status:
{
Description: Business status of the resource. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: SystemData of cluster pool. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClusterPools_UpdateTags (removed)
Description :  Updates an existing Cluster Pool Tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
clusterPoolName:
{
Description: The name of the cluster pool. ,
Required: True ,
}
string ,
clusterPoolTags:
{
Description: Parameters supplied to update tags. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties. Define cluster pool specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentId:
{
Description: A unique id generated by the RP to identify the resource. ,
Required: False ,
}
string ,
managedResourceGroupName:
{
Description: A resource group created by RP, to hold the resources created by RP on-behalf of customers. It will also be used to generate aksManagedResourceGroupName by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region}. Please make sure it meets resource group name restriction. ,
Required: False ,
}
string ,
aksManagedResourceGroupName:
{
Description: A resource group created by AKS, to hold the infrastructure resources created by AKS on-behalf of customers. It is generated by cluster pool name and managed resource group name by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region} ,
Required: False ,
}
string ,
clusterPoolProfile:
{
Description: CLuster pool profile. ,
Required: False ,
}
string ,
computeProfile:
{
Description: CLuster pool compute profile. ,
Required: True ,
}
string ,
aksClusterProfile:
{
Description: Properties of underlying AKS cluster. ,
Required: False ,
}
string ,
networkProfile:
{
Description: Cluster pool network profile. ,
Required: False ,
}
string ,
logAnalyticsProfile:
{
Description: Cluster pool log analytics profile to enable OMS agent for AKS cluster. ,
Required: False ,
}
string ,
status:
{
Description: Business status of the resource. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: SystemData of cluster pool. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Cluster pool. ,
}
{
properties:
{
Description: Gets or sets the properties. Define cluster pool specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentId:
{
Description: A unique id generated by the RP to identify the resource. ,
Required: False ,
}
string ,
managedResourceGroupName:
{
Description: A resource group created by RP, to hold the resources created by RP on-behalf of customers. It will also be used to generate aksManagedResourceGroupName by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region}. Please make sure it meets resource group name restriction. ,
Required: False ,
}
string ,
aksManagedResourceGroupName:
{
Description: A resource group created by AKS, to hold the infrastructure resources created by AKS on-behalf of customers. It is generated by cluster pool name and managed resource group name by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region} ,
Required: False ,
}
string ,
clusterPoolProfile:
{
Description: CLuster pool profile. ,
Required: False ,
}
string ,
computeProfile:
{
Description: CLuster pool compute profile. ,
Required: True ,
}
string ,
aksClusterProfile:
{
Description: Properties of underlying AKS cluster. ,
Required: False ,
}
string ,
networkProfile:
{
Description: Cluster pool network profile. ,
Required: False ,
}
string ,
logAnalyticsProfile:
{
Description: Cluster pool log analytics profile to enable OMS agent for AKS cluster. ,
Required: False ,
}
string ,
status:
{
Description: Business status of the resource. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: SystemData of cluster pool. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClusterPools_Delete (removed)
Description :  Deletes a Cluster Pool.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
clusterPoolName:
{
Description: The name of the cluster pool. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClusterPools_ListBySubscription (removed)
Description :  Gets the list of Cluster Pools within a Subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/clusterpools
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of cluster pools. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the properties. Define cluster pool specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentId:
{
Description: A unique id generated by the RP to identify the resource. ,
Required: False ,
}
string ,
managedResourceGroupName:
{
Description: A resource group created by RP, to hold the resources created by RP on-behalf of customers. It will also be used to generate aksManagedResourceGroupName by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region}. Please make sure it meets resource group name restriction. ,
Required: False ,
}
string ,
aksManagedResourceGroupName:
{
Description: A resource group created by AKS, to hold the infrastructure resources created by AKS on-behalf of customers. It is generated by cluster pool name and managed resource group name by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region} ,
Required: False ,
}
string ,
clusterPoolProfile:
{
Description: CLuster pool profile. ,
Required: False ,
}
string ,
computeProfile:
{
Description: CLuster pool compute profile. ,
Required: True ,
}
string ,
aksClusterProfile:
{
Description: Properties of underlying AKS cluster. ,
Required: False ,
}
string ,
networkProfile:
{
Description: Cluster pool network profile. ,
Required: False ,
}
string ,
logAnalyticsProfile:
{
Description: Cluster pool log analytics profile to enable OMS agent for AKS cluster. ,
Required: False ,
}
string ,
status:
{
Description: Business status of the resource. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: SystemData of cluster pool. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClusterPools_ListByResourceGroup (removed)
Description :  Lists the HDInsight cluster pools under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of cluster pools. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the properties. Define cluster pool specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentId:
{
Description: A unique id generated by the RP to identify the resource. ,
Required: False ,
}
string ,
managedResourceGroupName:
{
Description: A resource group created by RP, to hold the resources created by RP on-behalf of customers. It will also be used to generate aksManagedResourceGroupName by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region}. Please make sure it meets resource group name restriction. ,
Required: False ,
}
string ,
aksManagedResourceGroupName:
{
Description: A resource group created by AKS, to hold the infrastructure resources created by AKS on-behalf of customers. It is generated by cluster pool name and managed resource group name by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region} ,
Required: False ,
}
string ,
clusterPoolProfile:
{
Description: CLuster pool profile. ,
Required: False ,
}
string ,
computeProfile:
{
Description: CLuster pool compute profile. ,
Required: True ,
}
string ,
aksClusterProfile:
{
Description: Properties of underlying AKS cluster. ,
Required: False ,
}
string ,
networkProfile:
{
Description: Cluster pool network profile. ,
Required: False ,
}
string ,
logAnalyticsProfile:
{
Description: Cluster pool log analytics profile to enable OMS agent for AKS cluster. ,
Required: False ,
}
string ,
status:
{
Description: Business status of the resource. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: SystemData of cluster pool. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClusterPools_Upgrade (removed)
Description :  Upgrade a cluster pool.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/upgrade
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
clusterPoolName:
{
Description: The name of the cluster pool. ,
Required: True ,
}
string ,
ClusterPoolUpgradeRequest:
{
Description: Upgrade a cluster pool. ,
Required: True ,
}
{
properties:
{
Description: Properties of upgrading cluster pool. ,
Required: True ,
}
{
upgradeType:
{
Description: Type of upgrade. ,
Enum:
{
AKSPatchUpgrade: No description available. ,
NodeOsUpgrade: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties. Define cluster pool specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentId:
{
Description: A unique id generated by the RP to identify the resource. ,
Required: False ,
}
string ,
managedResourceGroupName:
{
Description: A resource group created by RP, to hold the resources created by RP on-behalf of customers. It will also be used to generate aksManagedResourceGroupName by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region}. Please make sure it meets resource group name restriction. ,
Required: False ,
}
string ,
aksManagedResourceGroupName:
{
Description: A resource group created by AKS, to hold the infrastructure resources created by AKS on-behalf of customers. It is generated by cluster pool name and managed resource group name by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region} ,
Required: False ,
}
string ,
clusterPoolProfile:
{
Description: CLuster pool profile. ,
Required: False ,
}
string ,
computeProfile:
{
Description: CLuster pool compute profile. ,
Required: True ,
}
string ,
aksClusterProfile:
{
Description: Properties of underlying AKS cluster. ,
Required: False ,
}
string ,
networkProfile:
{
Description: Cluster pool network profile. ,
Required: False ,
}
string ,
logAnalyticsProfile:
{
Description: Cluster pool log analytics profile to enable OMS agent for AKS cluster. ,
Required: False ,
}
string ,
status:
{
Description: Business status of the resource. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: SystemData of cluster pool. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to get the status of the resize operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClusterPoolAvailableUpgrades_List (removed)
Description :  List a cluster pool available upgrade.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/availableUpgrades
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
clusterPoolName:
{
Description: The name of the cluster pool. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of cluster pool available upgrade. ,
Required: True ,
}
[
{
properties:
{
Description: Gets or sets the properties. Define cluster pool upgrade specific properties. ,
Required: False ,
}
{
upgradeType:
{
Description: Type of upgrade. ,
Enum:
{
AKSPatchUpgrade: No description available. ,
NodeOsUpgrade: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ListByClusterPoolName (removed)
Description :  Lists the HDInsight cluster pools under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
clusterPoolName:
{
Description: The name of the cluster pool. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of clusters. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the properties. Define cluster specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
clusterType:
{
Description: The type of cluster. ,
Required: True ,
}
string ,
deploymentId:
{
Description: A unique id generated by the RP to identify the resource. ,
Required: False ,
}
string ,
computeProfile:
{
Description: The compute profile. ,
Required: True ,
}
{
nodes:
{
Description: The nodes definitions. ,
Required: True ,
}
[
{
type:
{
Description: The node type. ,
Required: True ,
}
string ,
vmSize:
{
Description: The virtual machine SKU. ,
Required: True ,
}
string ,
count:
{
Description: The number of virtual machines. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
clusterProfile:
{
Description: Cluster profile. ,
Required: True ,
}
{
clusterVersion:
{
Description: Version with 3/4 part. ,
Required: True ,
}
string ,
ossVersion:
{
Description: Version with three part. ,
Required: True ,
}
string ,
components:
{
Description: Component list of this cluster type and version. ,
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
version:
{
Required: False ,
}
string ,
}
,
]
,
identityProfile:
{
Description: This property is required by Trino, Spark and Flink cluster but is optional for Kafka cluster. ,
Required: False ,
}
{
msiResourceId:
{
Description: ResourceId of the MSI. ,
Format: arm-id ,
Required: True ,
}
string ,
msiClientId:
{
Description: ClientId of the MSI. ,
Required: True ,
}
string ,
msiObjectId:
{
Description: ObjectId of the MSI. ,
Required: True ,
}
string ,
}
,
authorizationProfile:
{
Description: Authorization profile with details of AAD user Ids and group Ids authorized for data plane access. ,
Required: True ,
}
{
userIds:
{
Description: AAD user Ids authorized for data plane access. ,
Required: False ,
}
[
string ,
]
,
groupIds:
{
Description: AAD group Ids authorized for data plane access. ,
Required: False ,
}
[
string ,
]
,
}
,
secretsProfile:
{
Description: The cluster secret profile. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: Name of the user Key Vault where all the cluster specific user secrets are stored. ,
Format: arm-id ,
Required: True ,
}
string ,
secrets:
{
Description: Properties of Key Vault secret. ,
Required: False ,
}
[
{
referenceName:
{
Description: Reference name of the secret to be used in service configs. ,
Required: True ,
}
string ,
type:
{
Description: Type of key vault object: secret, key or certificate. ,
Enum:
{
Key: No description available. ,
Secret: No description available. ,
Certificate: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: Version of the secret in key vault. ,
Required: False ,
}
string ,
keyVaultObjectName:
{
Description: Object identifier name of the secret in key vault. ,
Required: True ,
}
string ,
}
,
]
,
}
,
serviceConfigsProfiles:
{
Description: The service configs profiles. ,
Required: False ,
}
[
{
serviceName:
{
Description: Name of the service the configurations should apply to. ,
Required: True ,
}
string ,
configs:
{
Description: List of service configs. ,
Required: True ,
}
[
{
component:
{
Description: Name of the component the config files should apply to. ,
Required: True ,
}
string ,
files:
{
Description: List of Config Files. ,
Required: True ,
}
[
{
fileName:
{
Description: Configuration file name. ,
Required: True ,
}
string ,
content:
{
Description: Free form content of the entire configuration file. ,
Required: False ,
}
string ,
encoding:
{
Description: This property indicates if the content is encoded and is case-insensitive. Please set the value to base64 if the content is base64 encoded. Set it to none or skip it if the content is plain text. ,
Enum:
{
Base64: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
path:
{
Description: Path of the config file if content is specified. ,
Required: False ,
}
string ,
values:
{
Description: List of key value pairs where key represents a valid service configuration name and value represents the value of the config. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
]
,
connectivityProfile:
{
Description: Cluster connectivity profile. ,
Required: False ,
}
{
web:
{
Description: Web connectivity endpoint details. ,
Required: True ,
}
string ,
ssh:
{
Description: List of SSH connectivity endpoints. ,
Required: False ,
}
[
{
endpoint:
{
Description: SSH connectivity endpoint. ,
Required: True ,
}
string ,
privateSshEndpoint:
{
Description: Private SSH connectivity endpoint. This property will only be returned when enableInternalIngress is true. ,
Required: False ,
}
string ,
}
,
]
,
}
,
clusterAccessProfile:
{
Description: Cluster access profile. ,
Required: False ,
}
{
enableInternalIngress:
{
Description: Whether to create cluster using private IP instead of public IP. This property must be set at create time. ,
Required: True ,
}
boolean ,
privateLinkServiceId:
{
Description: Private link service resource ID. Only when enableInternalIngress is true, this property will be returned. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
logAnalyticsProfile:
{
Description: Cluster log analytics profile to enable or disable OMS agent for cluster. ,
Required: False ,
}
{
enabled:
{
Description: True if log analytics is enabled for the cluster, otherwise false. ,
Required: True ,
}
boolean ,
applicationLogs:
{
Description: Collection of logs to be enabled or disabled for log analytics. ,
Required: False ,
}
{
stdOutEnabled:
{
Description: True if stdout is enabled, otherwise false. ,
Required: False ,
}
boolean ,
stdErrorEnabled:
{
Description: True if stderror is enabled, otherwise false. ,
Required: False ,
}
boolean ,
}
,
metricsEnabled:
{
Description: True if metrics are enabled, otherwise false. ,
Required: False ,
}
boolean ,
}
,
prometheusProfile:
{
Description: Cluster Prometheus profile. ,
Required: False ,
}
{
enabled:
{
Description: Enable Prometheus for cluster or not. ,
Required: True ,
}
boolean ,
}
,
sshProfile:
{
Description: Ssh profile for the cluster. ,
Required: False ,
}
{
count:
{
Description: Number of ssh pods per cluster. ,
Format: int32 ,
Required: True ,
}
integer ,
podPrefix:
{
Description: Prefix of the pod names. Pod number will be appended to the prefix. The ingress URLs for the pods will be available at //- ,
Required: False ,
}
string ,
}
,
autoscaleProfile:
{
Description: This is the Autoscale profile for the cluster. This will allow customer to create cluster enabled with Autoscale. ,
Required: False ,
}
{
enabled:
{
Description: This indicates whether auto scale is enabled on HDInsight on AKS cluster. ,
Required: True ,
}
boolean ,
gracefulDecommissionTimeout:
{
Description: This property is for graceful decommission timeout; It has a default setting of 3600 seconds before forced shutdown takes place. This is the maximal time to wait for running containers and applications to complete before transition a DECOMMISSIONING node into DECOMMISSIONED. The default value is 3600 seconds. Negative value (like -1) is handled as infinite timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
autoscaleType:
{
Description: User to specify which type of Autoscale to be implemented - Scheduled Based or Load Based. ,
Enum:
{
ScheduleBased: No description available. ,
LoadBased: No description available. ,
}
,
Required: False ,
}
enum ,
scheduleBasedConfig:
{
Description: Profiles of schedule based Autoscale. ,
Required: False ,
}
{
timeZone:
{
Description: User has to specify the timezone on which the schedule has to be set for schedule based autoscale configuration. ,
Required: True ,
}
string ,
defaultCount:
{
Description: Setting default node count of current schedule configuration. Default node count specifies the number of nodes which are default when an specified scaling operation is executed (scale up/scale down) ,
Format: int32 ,
Required: True ,
}
integer ,
schedules:
{
Description: This specifies the schedules where scheduled based Autoscale to be enabled, the user has a choice to set multiple rules within the schedule across days and times (start/end). ,
Required: True ,
}
[
{
startTime:
{
Description: User has to set the start time of current schedule configuration, format like 10:30 (HH:MM). ,
Required: True ,
}
string ,
endTime:
{
Description: User has to set the end time of current schedule configuration, format like 10:30 (HH:MM). ,
Required: True ,
}
string ,
count:
{
Description: User has to set the node count anticipated at end of the scaling operation of the set current schedule configuration, format is integer. ,
Format: int32 ,
Required: True ,
}
integer ,
days:
{
Description: User has to set the days where schedule has to be set for autoscale operation. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
loadBasedConfig:
{
Description: Profiles of load based Autoscale. ,
Required: False ,
}
{
minNodes:
{
Description: User needs to set the minimum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. ,
Format: int32 ,
Required: True ,
}
integer ,
maxNodes:
{
Description: User needs to set the maximum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. ,
Format: int32 ,
Required: True ,
}
integer ,
pollInterval:
{
Description: User can specify the poll interval, this is the time period (in seconds) after which scaling metrics are polled for triggering a scaling operation. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: This is a cool down period, this is a time period in seconds, which determines the amount of time that must elapse between a scaling activity started by a rule and the start of the next scaling activity, regardless of the rule that triggers it. The default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
scalingRules:
{
Description: The scaling rules. ,
Required: True ,
}
[
{
actionType:
{
Description: The action type. ,
Enum:
{
scaleup: No description available. ,
scaledown: No description available. ,
}
,
Required: True ,
}
enum ,
evaluationCount:
{
Description: This is an evaluation count for a scaling condition, the number of times a trigger condition should be successful, before scaling activity is triggered. ,
Format: int32 ,
Required: True ,
}
integer ,
scalingMetric:
{
Description: Metrics name for individual workloads. For example: cpu ,
Required: True ,
}
string ,
comparisonRule:
{
Description: The comparison rule. ,
Required: True ,
}
{
operator:
{
Description: The comparison operator. ,
Enum:
{
greaterThan: No description available. ,
greaterThanOrEqual: No description available. ,
lessThan: No description available. ,
lessThanOrEqual: No description available. ,
}
,
Required: True ,
}
enum ,
threshold:
{
Description: Threshold setting. ,
Required: True ,
}
number ,
}
,
}
,
]
,
}
,
}
,
rangerPluginProfile:
{
Description: Cluster Ranger plugin profile. ,
Required: False ,
}
{
enabled:
{
Description: Enable Ranger for cluster or not. ,
Required: True ,
}
boolean ,
}
,
kafkaProfile:
{
Description: The Kafka cluster profile. ,
Required: False ,
}
{
enableKRaft:
{
Description: Expose Kafka cluster in KRaft mode. ,
Required: False ,
}
boolean ,
enablePublicEndpoints:
{
Description: Expose worker nodes as public endpoints. ,
Required: False ,
}
boolean ,
remoteStorageUri:
{
Description: Fully qualified path of Azure Storage container used for Tiered Storage. ,
Required: False ,
}
string ,
diskStorage:
{
Description: Kafka disk storage profile. ,
Required: True ,
}
{
dataDiskSize:
{
Description: Managed Disk size in GB. The maximum supported disk size for Standard and Premium HDD/SSD is 32TB, except for Premium SSD v2, which supports up to 64TB. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskType:
{
Description: Managed Disk Type. ,
Enum:
{
Standard_HDD_LRS: No description available. ,
Standard_SSD_LRS: No description available. ,
Standard_SSD_ZRS: No description available. ,
Premium_SSD_LRS: No description available. ,
Premium_SSD_ZRS: No description available. ,
Premium_SSD_v2_LRS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
clusterIdentity:
{
Description: Identity of the internal service components inside the Kafka cluster. ,
Required: False ,
}
{
msiResourceId:
{
Description: ResourceId of the MSI. ,
Format: arm-id ,
Required: True ,
}
string ,
msiClientId:
{
Description: ClientId of the MSI. ,
Required: True ,
}
string ,
msiObjectId:
{
Description: ObjectId of the MSI. ,
Required: True ,
}
string ,
}
,
connectivityEndpoints:
{
Description: Kafka bootstrap server and brokers related connectivity endpoints. ,
Required: False ,
}
{
bootstrapServerEndpoint:
{
Description: bootstrap server connectivity endpoint. ,
Required: False ,
}
string ,
brokerEndpoints:
{
Description: Kafka broker endpoint list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
trinoProfile:
{
Description: Trino Cluster profile. ,
Required: False ,
}
{
catalogOptions:
{
Description: Trino cluster catalog options. ,
Required: False ,
}
{
hive:
{
Description: hive catalog options. ,
Required: False ,
}
[
{
catalogName:
{
Description: Name of trino catalog which should use specified hive metastore. ,
Required: True ,
}
string ,
metastoreDbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metastoreDbConnectionPasswordSecret:
{
Description: Secret reference name from secretsProfile.secrets containing password for database connection. ,
Required: False ,
}
string ,
metastoreDbConnectionURL:
{
Description: Connection string for hive metastore database. ,
Required: True ,
}
string ,
metastoreDbConnectionUserName:
{
Description: User name for database connection. ,
Required: False ,
}
string ,
metastoreWarehouseDir:
{
Description: Metastore root directory URI, format: abfs[s]://@.dfs.core.windows.net/. More details: https://docs.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction-abfs-uri ,
Required: True ,
}
string ,
}
,
]
,
}
,
coordinator:
{
Description: Trino Coordinator. ,
Required: False ,
}
{
debug:
{
Description: Trino debug configuration. ,
Required: False ,
}
{
enable:
{
Description: The flag that if enable debug or not. ,
Required: False ,
}
boolean ,
port:
{
Description: The debug port. ,
Format: int32 ,
Required: False ,
}
integer ,
suspend:
{
Description: The flag that if suspend debug or not. ,
Required: False ,
}
boolean ,
}
,
highAvailabilityEnabled:
{
Description: The flag that if enable coordinator HA, uses multiple coordinator replicas with auto failover, one per each head node. Default: true. ,
Required: False ,
}
boolean ,
}
,
userPluginsSpec:
{
Description: Trino user plugins spec ,
Required: False ,
}
{
plugins:
{
Description: Trino user plugins. ,
Required: False ,
}
[
{
enabled:
{
Description: Denotes whether the plugin is active or not. ,
Required: False ,
}
boolean ,
name:
{
Description: This field maps to the sub-directory in trino plugins location, that will contain all the plugins under path. ,
Required: False ,
}
string ,
path:
{
Description: Fully qualified path to the folder containing the plugins. ,
Required: False ,
}
string ,
}
,
]
,
}
,
userTelemetrySpec:
{
Description: User telemetry ,
Required: False ,
}
{
storage:
{
Description: Trino user telemetry definition. ,
Required: False ,
}
{
hivecatalogName:
{
Description: Hive Catalog name used to mount external tables on the logs written by trino, if not specified there tables are not created. ,
Required: False ,
}
string ,
hivecatalogSchema:
{
Description: Schema of the above catalog to use, to mount query logs as external tables, if not specified tables will be mounted under schema trinologs. ,
Required: False ,
}
string ,
partitionRetentionInDays:
{
Description: Retention period for query log table partitions, this doesn't have any affect on actual data. ,
Format: int32 ,
Required: False ,
}
integer ,
path:
{
Description: Azure storage location of the blobs. ,
Required: False ,
}
string ,
}
,
}
,
worker:
{
Description: Trino worker. ,
Required: False ,
}
{
debug:
{
Description: Trino debug configuration. ,
Required: False ,
}
{
enable:
{
Description: The flag that if enable debug or not. ,
Required: False ,
}
boolean ,
port:
{
Description: The debug port. ,
Format: int32 ,
Required: False ,
}
integer ,
suspend:
{
Description: The flag that if suspend debug or not. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
llapProfile:
{
Description: LLAP cluster profile. ,
Required: False ,
}
object ,
flinkProfile:
{
Description: The Flink cluster profile. ,
Required: False ,
}
{
storage:
{
Description: The storage profile ,
Required: True ,
}
{
storageUri:
{
Description: Storage account uri which is used for savepoint and checkpoint state. ,
Required: True ,
}
string ,
storagekey:
{
Description: Storage key is only required for wasb(s) storage. ,
Required: False ,
}
string ,
}
,
numReplicas:
{
Description: The number of task managers. ,
Format: int32 ,
Required: False ,
}
integer ,
jobManager:
{
Description: Job Manager container/ process CPU and memory requirements ,
Required: True ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
historyServer:
{
Description: History Server container/ process CPU and memory requirements ,
Required: False ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
taskManager:
{
Description: Task Manager container/ process CPU and memory requirements ,
Required: True ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
catalogOptions:
{
Description: Flink cluster catalog options. ,
Required: False ,
}
{
hive:
{
Description: Hive Catalog Option for Flink cluster. ,
Required: False ,
}
{
metastoreDbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metastoreDbConnectionPasswordSecret:
{
Description: Secret reference name from secretsProfile.secrets containing password for database connection. ,
Required: False ,
}
string ,
metastoreDbConnectionURL:
{
Description: Connection string for hive metastore database. ,
Required: True ,
}
string ,
metastoreDbConnectionUserName:
{
Description: User name for database connection. ,
Required: False ,
}
string ,
}
,
}
,
deploymentMode:
{
Description: A string property that indicates the deployment mode of Flink cluster. It can have one of the following enum values => Application, Session. Default value is Session ,
Enum:
{
Application: No description available. ,
Session: No description available. ,
}
,
Required: False ,
}
enum ,
jobSpec:
{
Description: 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. ,
Required: False ,
}
{
jobJarDirectory:
{
Description: A string property that specifies the directory where the job JAR is located. ,
Required: True ,
}
string ,
jarName:
{
Description: A string property that represents the name of the job JAR. ,
Required: True ,
}
string ,
entryClass:
{
Description: A string property that specifies the entry class for the Flink job. If not specified, the entry point is auto-detected from the flink job jar package. ,
Required: False ,
}
string ,
args:
{
Description: A string property representing additional JVM arguments for the Flink job. It should be space separated value. ,
Required: False ,
}
string ,
savePointName:
{
Description: A string property that represents the name of the savepoint for the Flink job ,
Required: False ,
}
string ,
upgradeMode:
{
Description: A string property that indicates the upgrade mode to be performed on the Flink job. It can have one of the following enum values => STATELESS_UPDATE, UPDATE, LAST_STATE_UPDATE. ,
Enum:
{
STATELESS_UPDATE: No description available. ,
UPDATE: No description available. ,
LAST_STATE_UPDATE: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
sparkProfile:
{
Description: The spark cluster profile. ,
Required: False ,
}
{
defaultStorageUrl:
{
Description: The default storage URL. ,
Required: False ,
}
string ,
metastoreSpec:
{
Description: The metastore specification for Spark cluster. ,
Required: False ,
}
{
dbServerHost:
{
Description: The database server host. ,
Required: True ,
}
string ,
dbName:
{
Description: The database name. ,
Required: True ,
}
string ,
dbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
dbUserName:
{
Description: The database user name. ,
Required: False ,
}
string ,
dbPasswordSecretName:
{
Description: The secret name which contains the database user password. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: The key vault resource id. ,
Required: False ,
}
string ,
thriftUrl:
{
Description: The thrift url. ,
Required: False ,
}
string ,
}
,
userPluginsSpec:
{
Description: Spark user plugins spec ,
Required: False ,
}
{
plugins:
{
Description: Spark user plugins. ,
Required: False ,
}
[
{
path:
{
Description: Fully qualified path to the folder containing the plugins. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
rangerProfile:
{
Description: The ranger cluster profile. ,
Required: False ,
}
{
rangerAdmin:
{
Description: Specification for the Ranger Admin service. ,
Required: True ,
}
{
admins:
{
Description: List of usernames that should be marked as ranger admins. These usernames should match the user principal name (UPN) of the respective AAD users. ,
Required: True ,
}
[
string ,
]
,
database:
{
Required: True ,
}
{
host:
{
Description: The database URL ,
Required: True ,
}
string ,
name:
{
Description: The database name ,
Required: True ,
}
string ,
passwordSecretRef:
{
Description: Reference for the database password ,
Required: False ,
}
string ,
username:
{
Description: The name of the database user ,
Required: False ,
}
string ,
}
,
}
,
rangerAudit:
{
Description: Properties required to describe audit log storage. ,
Required: False ,
}
{
storageAccount:
{
Description: Azure storage location of the blobs. MSI should have read/write access to this Storage account. ,
Required: False ,
}
string ,
}
,
rangerUsersync:
{
Description: Specification for the Ranger Usersync service ,
Required: True ,
}
{
enabled:
{
Description: Denotes whether usersync service should be enabled ,
Required: False ,
}
boolean ,
groups:
{
Description: List of groups that should be synced. These group names should match the object id of the respective AAD groups. ,
Required: False ,
}
[
string ,
]
,
mode:
{
Description: User & groups can be synced automatically or via a static list that's refreshed. ,
Enum:
{
static: No description available. ,
automatic: No description available. ,
}
,
Required: False ,
}
enum ,
userMappingLocation:
{
Description: Azure storage location of a mapping file that lists user & group associations. ,
Required: False ,
}
string ,
users:
{
Description: List of user names that should be synced. These usernames should match the User principal name of the respective AAD users. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
stubProfile:
{
Description: Stub cluster profile. ,
Required: False ,
}
object ,
scriptActionProfiles:
{
Description: The script action profile list. ,
Required: False ,
}
[
{
type:
{
Description: Type of the script action. Supported type is bash scripts. ,
Required: True ,
}
string ,
name:
{
Description: Script name. ,
Required: True ,
}
string ,
url:
{
Description: Url of the script file. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters for the script action. It should be space-separated list of arguments required for script execution. ,
Required: False ,
}
string ,
services:
{
Description: List of services to apply the script action. ,
Required: True ,
}
[
string ,
]
,
timeoutInMinutes:
{
Description: Timeout duration for the script action in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
shouldPersist:
{
Description: Specify if the script should persist on the cluster. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
status:
{
Description: Business status of the resource. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: SystemData of cluster. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Upgrade (removed)
Description :  Upgrade a cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/upgrade
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
clusterPoolName:
{
Description: The name of the cluster pool. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the HDInsight cluster. ,
Required: True ,
}
string ,
ClusterUpgradeRequest:
{
Description: Upgrade a cluster. ,
Required: True ,
}
{
properties:
{
Description: Properties of upgrading cluster. ,
Required: True ,
}
{
upgradeType:
{
Description: Type of upgrade. ,
Enum:
{
AKSPatchUpgrade: No description available. ,
HotfixUpgrade: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties. Define cluster specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
clusterType:
{
Description: The type of cluster. ,
Required: True ,
}
string ,
deploymentId:
{
Description: A unique id generated by the RP to identify the resource. ,
Required: False ,
}
string ,
computeProfile:
{
Description: The compute profile. ,
Required: True ,
}
{
nodes:
{
Description: The nodes definitions. ,
Required: True ,
}
[
{
type:
{
Description: The node type. ,
Required: True ,
}
string ,
vmSize:
{
Description: The virtual machine SKU. ,
Required: True ,
}
string ,
count:
{
Description: The number of virtual machines. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
clusterProfile:
{
Description: Cluster profile. ,
Required: True ,
}
{
clusterVersion:
{
Description: Version with 3/4 part. ,
Required: True ,
}
string ,
ossVersion:
{
Description: Version with three part. ,
Required: True ,
}
string ,
components:
{
Description: Component list of this cluster type and version. ,
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
version:
{
Required: False ,
}
string ,
}
,
]
,
identityProfile:
{
Description: This property is required by Trino, Spark and Flink cluster but is optional for Kafka cluster. ,
Required: False ,
}
{
msiResourceId:
{
Description: ResourceId of the MSI. ,
Format: arm-id ,
Required: True ,
}
string ,
msiClientId:
{
Description: ClientId of the MSI. ,
Required: True ,
}
string ,
msiObjectId:
{
Description: ObjectId of the MSI. ,
Required: True ,
}
string ,
}
,
authorizationProfile:
{
Description: Authorization profile with details of AAD user Ids and group Ids authorized for data plane access. ,
Required: True ,
}
{
userIds:
{
Description: AAD user Ids authorized for data plane access. ,
Required: False ,
}
[
string ,
]
,
groupIds:
{
Description: AAD group Ids authorized for data plane access. ,
Required: False ,
}
[
string ,
]
,
}
,
secretsProfile:
{
Description: The cluster secret profile. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: Name of the user Key Vault where all the cluster specific user secrets are stored. ,
Format: arm-id ,
Required: True ,
}
string ,
secrets:
{
Description: Properties of Key Vault secret. ,
Required: False ,
}
[
{
referenceName:
{
Description: Reference name of the secret to be used in service configs. ,
Required: True ,
}
string ,
type:
{
Description: Type of key vault object: secret, key or certificate. ,
Enum:
{
Key: No description available. ,
Secret: No description available. ,
Certificate: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: Version of the secret in key vault. ,
Required: False ,
}
string ,
keyVaultObjectName:
{
Description: Object identifier name of the secret in key vault. ,
Required: True ,
}
string ,
}
,
]
,
}
,
serviceConfigsProfiles:
{
Description: The service configs profiles. ,
Required: False ,
}
[
{
serviceName:
{
Description: Name of the service the configurations should apply to. ,
Required: True ,
}
string ,
configs:
{
Description: List of service configs. ,
Required: True ,
}
[
{
component:
{
Description: Name of the component the config files should apply to. ,
Required: True ,
}
string ,
files:
{
Description: List of Config Files. ,
Required: True ,
}
[
{
fileName:
{
Description: Configuration file name. ,
Required: True ,
}
string ,
content:
{
Description: Free form content of the entire configuration file. ,
Required: False ,
}
string ,
encoding:
{
Description: This property indicates if the content is encoded and is case-insensitive. Please set the value to base64 if the content is base64 encoded. Set it to none or skip it if the content is plain text. ,
Enum:
{
Base64: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
path:
{
Description: Path of the config file if content is specified. ,
Required: False ,
}
string ,
values:
{
Description: List of key value pairs where key represents a valid service configuration name and value represents the value of the config. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
]
,
connectivityProfile:
{
Description: Cluster connectivity profile. ,
Required: False ,
}
{
web:
{
Description: Web connectivity endpoint details. ,
Required: True ,
}
string ,
ssh:
{
Description: List of SSH connectivity endpoints. ,
Required: False ,
}
[
{
endpoint:
{
Description: SSH connectivity endpoint. ,
Required: True ,
}
string ,
privateSshEndpoint:
{
Description: Private SSH connectivity endpoint. This property will only be returned when enableInternalIngress is true. ,
Required: False ,
}
string ,
}
,
]
,
}
,
clusterAccessProfile:
{
Description: Cluster access profile. ,
Required: False ,
}
{
enableInternalIngress:
{
Description: Whether to create cluster using private IP instead of public IP. This property must be set at create time. ,
Required: True ,
}
boolean ,
privateLinkServiceId:
{
Description: Private link service resource ID. Only when enableInternalIngress is true, this property will be returned. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
logAnalyticsProfile:
{
Description: Cluster log analytics profile to enable or disable OMS agent for cluster. ,
Required: False ,
}
{
enabled:
{
Description: True if log analytics is enabled for the cluster, otherwise false. ,
Required: True ,
}
boolean ,
applicationLogs:
{
Description: Collection of logs to be enabled or disabled for log analytics. ,
Required: False ,
}
{
stdOutEnabled:
{
Description: True if stdout is enabled, otherwise false. ,
Required: False ,
}
boolean ,
stdErrorEnabled:
{
Description: True if stderror is enabled, otherwise false. ,
Required: False ,
}
boolean ,
}
,
metricsEnabled:
{
Description: True if metrics are enabled, otherwise false. ,
Required: False ,
}
boolean ,
}
,
prometheusProfile:
{
Description: Cluster Prometheus profile. ,
Required: False ,
}
{
enabled:
{
Description: Enable Prometheus for cluster or not. ,
Required: True ,
}
boolean ,
}
,
sshProfile:
{
Description: Ssh profile for the cluster. ,
Required: False ,
}
{
count:
{
Description: Number of ssh pods per cluster. ,
Format: int32 ,
Required: True ,
}
integer ,
podPrefix:
{
Description: Prefix of the pod names. Pod number will be appended to the prefix. The ingress URLs for the pods will be available at //- ,
Required: False ,
}
string ,
}
,
autoscaleProfile:
{
Description: This is the Autoscale profile for the cluster. This will allow customer to create cluster enabled with Autoscale. ,
Required: False ,
}
{
enabled:
{
Description: This indicates whether auto scale is enabled on HDInsight on AKS cluster. ,
Required: True ,
}
boolean ,
gracefulDecommissionTimeout:
{
Description: This property is for graceful decommission timeout; It has a default setting of 3600 seconds before forced shutdown takes place. This is the maximal time to wait for running containers and applications to complete before transition a DECOMMISSIONING node into DECOMMISSIONED. The default value is 3600 seconds. Negative value (like -1) is handled as infinite timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
autoscaleType:
{
Description: User to specify which type of Autoscale to be implemented - Scheduled Based or Load Based. ,
Enum:
{
ScheduleBased: No description available. ,
LoadBased: No description available. ,
}
,
Required: False ,
}
enum ,
scheduleBasedConfig:
{
Description: Profiles of schedule based Autoscale. ,
Required: False ,
}
{
timeZone:
{
Description: User has to specify the timezone on which the schedule has to be set for schedule based autoscale configuration. ,
Required: True ,
}
string ,
defaultCount:
{
Description: Setting default node count of current schedule configuration. Default node count specifies the number of nodes which are default when an specified scaling operation is executed (scale up/scale down) ,
Format: int32 ,
Required: True ,
}
integer ,
schedules:
{
Description: This specifies the schedules where scheduled based Autoscale to be enabled, the user has a choice to set multiple rules within the schedule across days and times (start/end). ,
Required: True ,
}
[
{
startTime:
{
Description: User has to set the start time of current schedule configuration, format like 10:30 (HH:MM). ,
Required: True ,
}
string ,
endTime:
{
Description: User has to set the end time of current schedule configuration, format like 10:30 (HH:MM). ,
Required: True ,
}
string ,
count:
{
Description: User has to set the node count anticipated at end of the scaling operation of the set current schedule configuration, format is integer. ,
Format: int32 ,
Required: True ,
}
integer ,
days:
{
Description: User has to set the days where schedule has to be set for autoscale operation. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
loadBasedConfig:
{
Description: Profiles of load based Autoscale. ,
Required: False ,
}
{
minNodes:
{
Description: User needs to set the minimum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. ,
Format: int32 ,
Required: True ,
}
integer ,
maxNodes:
{
Description: User needs to set the maximum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. ,
Format: int32 ,
Required: True ,
}
integer ,
pollInterval:
{
Description: User can specify the poll interval, this is the time period (in seconds) after which scaling metrics are polled for triggering a scaling operation. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: This is a cool down period, this is a time period in seconds, which determines the amount of time that must elapse between a scaling activity started by a rule and the start of the next scaling activity, regardless of the rule that triggers it. The default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
scalingRules:
{
Description: The scaling rules. ,
Required: True ,
}
[
{
actionType:
{
Description: The action type. ,
Enum:
{
scaleup: No description available. ,
scaledown: No description available. ,
}
,
Required: True ,
}
enum ,
evaluationCount:
{
Description: This is an evaluation count for a scaling condition, the number of times a trigger condition should be successful, before scaling activity is triggered. ,
Format: int32 ,
Required: True ,
}
integer ,
scalingMetric:
{
Description: Metrics name for individual workloads. For example: cpu ,
Required: True ,
}
string ,
comparisonRule:
{
Description: The comparison rule. ,
Required: True ,
}
{
operator:
{
Description: The comparison operator. ,
Enum:
{
greaterThan: No description available. ,
greaterThanOrEqual: No description available. ,
lessThan: No description available. ,
lessThanOrEqual: No description available. ,
}
,
Required: True ,
}
enum ,
threshold:
{
Description: Threshold setting. ,
Required: True ,
}
number ,
}
,
}
,
]
,
}
,
}
,
rangerPluginProfile:
{
Description: Cluster Ranger plugin profile. ,
Required: False ,
}
{
enabled:
{
Description: Enable Ranger for cluster or not. ,
Required: True ,
}
boolean ,
}
,
kafkaProfile:
{
Description: The Kafka cluster profile. ,
Required: False ,
}
{
enableKRaft:
{
Description: Expose Kafka cluster in KRaft mode. ,
Required: False ,
}
boolean ,
enablePublicEndpoints:
{
Description: Expose worker nodes as public endpoints. ,
Required: False ,
}
boolean ,
remoteStorageUri:
{
Description: Fully qualified path of Azure Storage container used for Tiered Storage. ,
Required: False ,
}
string ,
diskStorage:
{
Description: Kafka disk storage profile. ,
Required: True ,
}
{
dataDiskSize:
{
Description: Managed Disk size in GB. The maximum supported disk size for Standard and Premium HDD/SSD is 32TB, except for Premium SSD v2, which supports up to 64TB. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskType:
{
Description: Managed Disk Type. ,
Enum:
{
Standard_HDD_LRS: No description available. ,
Standard_SSD_LRS: No description available. ,
Standard_SSD_ZRS: No description available. ,
Premium_SSD_LRS: No description available. ,
Premium_SSD_ZRS: No description available. ,
Premium_SSD_v2_LRS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
clusterIdentity:
{
Description: Identity of the internal service components inside the Kafka cluster. ,
Required: False ,
}
{
msiResourceId:
{
Description: ResourceId of the MSI. ,
Format: arm-id ,
Required: True ,
}
string ,
msiClientId:
{
Description: ClientId of the MSI. ,
Required: True ,
}
string ,
msiObjectId:
{
Description: ObjectId of the MSI. ,
Required: True ,
}
string ,
}
,
connectivityEndpoints:
{
Description: Kafka bootstrap server and brokers related connectivity endpoints. ,
Required: False ,
}
{
bootstrapServerEndpoint:
{
Description: bootstrap server connectivity endpoint. ,
Required: False ,
}
string ,
brokerEndpoints:
{
Description: Kafka broker endpoint list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
trinoProfile:
{
Description: Trino Cluster profile. ,
Required: False ,
}
{
catalogOptions:
{
Description: Trino cluster catalog options. ,
Required: False ,
}
{
hive:
{
Description: hive catalog options. ,
Required: False ,
}
[
{
catalogName:
{
Description: Name of trino catalog which should use specified hive metastore. ,
Required: True ,
}
string ,
metastoreDbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metastoreDbConnectionPasswordSecret:
{
Description: Secret reference name from secretsProfile.secrets containing password for database connection. ,
Required: False ,
}
string ,
metastoreDbConnectionURL:
{
Description: Connection string for hive metastore database. ,
Required: True ,
}
string ,
metastoreDbConnectionUserName:
{
Description: User name for database connection. ,
Required: False ,
}
string ,
metastoreWarehouseDir:
{
Description: Metastore root directory URI, format: abfs[s]://@.dfs.core.windows.net/. More details: https://docs.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction-abfs-uri ,
Required: True ,
}
string ,
}
,
]
,
}
,
coordinator:
{
Description: Trino Coordinator. ,
Required: False ,
}
{
debug:
{
Description: Trino debug configuration. ,
Required: False ,
}
{
enable:
{
Description: The flag that if enable debug or not. ,
Required: False ,
}
boolean ,
port:
{
Description: The debug port. ,
Format: int32 ,
Required: False ,
}
integer ,
suspend:
{
Description: The flag that if suspend debug or not. ,
Required: False ,
}
boolean ,
}
,
highAvailabilityEnabled:
{
Description: The flag that if enable coordinator HA, uses multiple coordinator replicas with auto failover, one per each head node. Default: true. ,
Required: False ,
}
boolean ,
}
,
userPluginsSpec:
{
Description: Trino user plugins spec ,
Required: False ,
}
{
plugins:
{
Description: Trino user plugins. ,
Required: False ,
}
[
{
enabled:
{
Description: Denotes whether the plugin is active or not. ,
Required: False ,
}
boolean ,
name:
{
Description: This field maps to the sub-directory in trino plugins location, that will contain all the plugins under path. ,
Required: False ,
}
string ,
path:
{
Description: Fully qualified path to the folder containing the plugins. ,
Required: False ,
}
string ,
}
,
]
,
}
,
userTelemetrySpec:
{
Description: User telemetry ,
Required: False ,
}
{
storage:
{
Description: Trino user telemetry definition. ,
Required: False ,
}
{
hivecatalogName:
{
Description: Hive Catalog name used to mount external tables on the logs written by trino, if not specified there tables are not created. ,
Required: False ,
}
string ,
hivecatalogSchema:
{
Description: Schema of the above catalog to use, to mount query logs as external tables, if not specified tables will be mounted under schema trinologs. ,
Required: False ,
}
string ,
partitionRetentionInDays:
{
Description: Retention period for query log table partitions, this doesn't have any affect on actual data. ,
Format: int32 ,
Required: False ,
}
integer ,
path:
{
Description: Azure storage location of the blobs. ,
Required: False ,
}
string ,
}
,
}
,
worker:
{
Description: Trino worker. ,
Required: False ,
}
{
debug:
{
Description: Trino debug configuration. ,
Required: False ,
}
{
enable:
{
Description: The flag that if enable debug or not. ,
Required: False ,
}
boolean ,
port:
{
Description: The debug port. ,
Format: int32 ,
Required: False ,
}
integer ,
suspend:
{
Description: The flag that if suspend debug or not. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
llapProfile:
{
Description: LLAP cluster profile. ,
Required: False ,
}
object ,
flinkProfile:
{
Description: The Flink cluster profile. ,
Required: False ,
}
{
storage:
{
Description: The storage profile ,
Required: True ,
}
{
storageUri:
{
Description: Storage account uri which is used for savepoint and checkpoint state. ,
Required: True ,
}
string ,
storagekey:
{
Description: Storage key is only required for wasb(s) storage. ,
Required: False ,
}
string ,
}
,
numReplicas:
{
Description: The number of task managers. ,
Format: int32 ,
Required: False ,
}
integer ,
jobManager:
{
Description: Job Manager container/ process CPU and memory requirements ,
Required: True ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
historyServer:
{
Description: History Server container/ process CPU and memory requirements ,
Required: False ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
taskManager:
{
Description: Task Manager container/ process CPU and memory requirements ,
Required: True ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
catalogOptions:
{
Description: Flink cluster catalog options. ,
Required: False ,
}
{
hive:
{
Description: Hive Catalog Option for Flink cluster. ,
Required: False ,
}
{
metastoreDbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metastoreDbConnectionPasswordSecret:
{
Description: Secret reference name from secretsProfile.secrets containing password for database connection. ,
Required: False ,
}
string ,
metastoreDbConnectionURL:
{
Description: Connection string for hive metastore database. ,
Required: True ,
}
string ,
metastoreDbConnectionUserName:
{
Description: User name for database connection. ,
Required: False ,
}
string ,
}
,
}
,
deploymentMode:
{
Description: A string property that indicates the deployment mode of Flink cluster. It can have one of the following enum values => Application, Session. Default value is Session ,
Enum:
{
Application: No description available. ,
Session: No description available. ,
}
,
Required: False ,
}
enum ,
jobSpec:
{
Description: 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. ,
Required: False ,
}
{
jobJarDirectory:
{
Description: A string property that specifies the directory where the job JAR is located. ,
Required: True ,
}
string ,
jarName:
{
Description: A string property that represents the name of the job JAR. ,
Required: True ,
}
string ,
entryClass:
{
Description: A string property that specifies the entry class for the Flink job. If not specified, the entry point is auto-detected from the flink job jar package. ,
Required: False ,
}
string ,
args:
{
Description: A string property representing additional JVM arguments for the Flink job. It should be space separated value. ,
Required: False ,
}
string ,
savePointName:
{
Description: A string property that represents the name of the savepoint for the Flink job ,
Required: False ,
}
string ,
upgradeMode:
{
Description: A string property that indicates the upgrade mode to be performed on the Flink job. It can have one of the following enum values => STATELESS_UPDATE, UPDATE, LAST_STATE_UPDATE. ,
Enum:
{
STATELESS_UPDATE: No description available. ,
UPDATE: No description available. ,
LAST_STATE_UPDATE: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
sparkProfile:
{
Description: The spark cluster profile. ,
Required: False ,
}
{
defaultStorageUrl:
{
Description: The default storage URL. ,
Required: False ,
}
string ,
metastoreSpec:
{
Description: The metastore specification for Spark cluster. ,
Required: False ,
}
{
dbServerHost:
{
Description: The database server host. ,
Required: True ,
}
string ,
dbName:
{
Description: The database name. ,
Required: True ,
}
string ,
dbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
dbUserName:
{
Description: The database user name. ,
Required: False ,
}
string ,
dbPasswordSecretName:
{
Description: The secret name which contains the database user password. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: The key vault resource id. ,
Required: False ,
}
string ,
thriftUrl:
{
Description: The thrift url. ,
Required: False ,
}
string ,
}
,
userPluginsSpec:
{
Description: Spark user plugins spec ,
Required: False ,
}
{
plugins:
{
Description: Spark user plugins. ,
Required: False ,
}
[
{
path:
{
Description: Fully qualified path to the folder containing the plugins. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
rangerProfile:
{
Description: The ranger cluster profile. ,
Required: False ,
}
{
rangerAdmin:
{
Description: Specification for the Ranger Admin service. ,
Required: True ,
}
{
admins:
{
Description: List of usernames that should be marked as ranger admins. These usernames should match the user principal name (UPN) of the respective AAD users. ,
Required: True ,
}
[
string ,
]
,
database:
{
Required: True ,
}
{
host:
{
Description: The database URL ,
Required: True ,
}
string ,
name:
{
Description: The database name ,
Required: True ,
}
string ,
passwordSecretRef:
{
Description: Reference for the database password ,
Required: False ,
}
string ,
username:
{
Description: The name of the database user ,
Required: False ,
}
string ,
}
,
}
,
rangerAudit:
{
Description: Properties required to describe audit log storage. ,
Required: False ,
}
{
storageAccount:
{
Description: Azure storage location of the blobs. MSI should have read/write access to this Storage account. ,
Required: False ,
}
string ,
}
,
rangerUsersync:
{
Description: Specification for the Ranger Usersync service ,
Required: True ,
}
{
enabled:
{
Description: Denotes whether usersync service should be enabled ,
Required: False ,
}
boolean ,
groups:
{
Description: List of groups that should be synced. These group names should match the object id of the respective AAD groups. ,
Required: False ,
}
[
string ,
]
,
mode:
{
Description: User & groups can be synced automatically or via a static list that's refreshed. ,
Enum:
{
static: No description available. ,
automatic: No description available. ,
}
,
Required: False ,
}
enum ,
userMappingLocation:
{
Description: Azure storage location of a mapping file that lists user & group associations. ,
Required: False ,
}
string ,
users:
{
Description: List of user names that should be synced. These usernames should match the User principal name of the respective AAD users. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
stubProfile:
{
Description: Stub cluster profile. ,
Required: False ,
}
object ,
scriptActionProfiles:
{
Description: The script action profile list. ,
Required: False ,
}
[
{
type:
{
Description: Type of the script action. Supported type is bash scripts. ,
Required: True ,
}
string ,
name:
{
Description: Script name. ,
Required: True ,
}
string ,
url:
{
Description: Url of the script file. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters for the script action. It should be space-separated list of arguments required for script execution. ,
Required: False ,
}
string ,
services:
{
Description: List of services to apply the script action. ,
Required: True ,
}
[
string ,
]
,
timeoutInMinutes:
{
Description: Timeout duration for the script action in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
shouldPersist:
{
Description: Specify if the script should persist on the cluster. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
status:
{
Description: Business status of the resource. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: SystemData of cluster. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to get the status of the resize operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClusterAvailableUpgrades_List (removed)
Description :  List a cluster available upgrade.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/availableUpgrades
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
clusterPoolName:
{
Description: The name of the cluster pool. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the HDInsight cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of Cluster available upgrade. ,
Required: True ,
}
[
{
properties:
{
Description: Gets or sets the properties. Define cluster upgrade specific properties. ,
Required: False ,
}
{
upgradeType:
{
Description: Type of upgrade. ,
Enum:
{
AKSPatchUpgrade: No description available. ,
HotfixUpgrade: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL of next result page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Resize (removed)
Description :  Resize an existing Cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/resize
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
clusterPoolName:
{
Description: The name of the cluster pool. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the HDInsight cluster. ,
Required: True ,
}
string ,
ClusterResizeRequest:
{
Description: Resize a cluster. ,
Required: True ,
}
{
properties:
{
Description: Sets the properties. Define cluster resize specific properties. ,
Required: False ,
}
{
targetWorkerNodeCount:
{
Description: Target node count of worker node. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties. Define cluster specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
clusterType:
{
Description: The type of cluster. ,
Required: True ,
}
string ,
deploymentId:
{
Description: A unique id generated by the RP to identify the resource. ,
Required: False ,
}
string ,
computeProfile:
{
Description: The compute profile. ,
Required: True ,
}
{
nodes:
{
Description: The nodes definitions. ,
Required: True ,
}
[
{
type:
{
Description: The node type. ,
Required: True ,
}
string ,
vmSize:
{
Description: The virtual machine SKU. ,
Required: True ,
}
string ,
count:
{
Description: The number of virtual machines. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
clusterProfile:
{
Description: Cluster profile. ,
Required: True ,
}
{
clusterVersion:
{
Description: Version with 3/4 part. ,
Required: True ,
}
string ,
ossVersion:
{
Description: Version with three part. ,
Required: True ,
}
string ,
components:
{
Description: Component list of this cluster type and version. ,
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
version:
{
Required: False ,
}
string ,
}
,
]
,
identityProfile:
{
Description: This property is required by Trino, Spark and Flink cluster but is optional for Kafka cluster. ,
Required: False ,
}
{
msiResourceId:
{
Description: ResourceId of the MSI. ,
Format: arm-id ,
Required: True ,
}
string ,
msiClientId:
{
Description: ClientId of the MSI. ,
Required: True ,
}
string ,
msiObjectId:
{
Description: ObjectId of the MSI. ,
Required: True ,
}
string ,
}
,
authorizationProfile:
{
Description: Authorization profile with details of AAD user Ids and group Ids authorized for data plane access. ,
Required: True ,
}
{
userIds:
{
Description: AAD user Ids authorized for data plane access. ,
Required: False ,
}
[
string ,
]
,
groupIds:
{
Description: AAD group Ids authorized for data plane access. ,
Required: False ,
}
[
string ,
]
,
}
,
secretsProfile:
{
Description: The cluster secret profile. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: Name of the user Key Vault where all the cluster specific user secrets are stored. ,
Format: arm-id ,
Required: True ,
}
string ,
secrets:
{
Description: Properties of Key Vault secret. ,
Required: False ,
}
[
{
referenceName:
{
Description: Reference name of the secret to be used in service configs. ,
Required: True ,
}
string ,
type:
{
Description: Type of key vault object: secret, key or certificate. ,
Enum:
{
Key: No description available. ,
Secret: No description available. ,
Certificate: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: Version of the secret in key vault. ,
Required: False ,
}
string ,
keyVaultObjectName:
{
Description: Object identifier name of the secret in key vault. ,
Required: True ,
}
string ,
}
,
]
,
}
,
serviceConfigsProfiles:
{
Description: The service configs profiles. ,
Required: False ,
}
[
{
serviceName:
{
Description: Name of the service the configurations should apply to. ,
Required: True ,
}
string ,
configs:
{
Description: List of service configs. ,
Required: True ,
}
[
{
component:
{
Description: Name of the component the config files should apply to. ,
Required: True ,
}
string ,
files:
{
Description: List of Config Files. ,
Required: True ,
}
[
{
fileName:
{
Description: Configuration file name. ,
Required: True ,
}
string ,
content:
{
Description: Free form content of the entire configuration file. ,
Required: False ,
}
string ,
encoding:
{
Description: This property indicates if the content is encoded and is case-insensitive. Please set the value to base64 if the content is base64 encoded. Set it to none or skip it if the content is plain text. ,
Enum:
{
Base64: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
path:
{
Description: Path of the config file if content is specified. ,
Required: False ,
}
string ,
values:
{
Description: List of key value pairs where key represents a valid service configuration name and value represents the value of the config. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
]
,
connectivityProfile:
{
Description: Cluster connectivity profile. ,
Required: False ,
}
{
web:
{
Description: Web connectivity endpoint details. ,
Required: True ,
}
string ,
ssh:
{
Description: List of SSH connectivity endpoints. ,
Required: False ,
}
[
{
endpoint:
{
Description: SSH connectivity endpoint. ,
Required: True ,
}
string ,
privateSshEndpoint:
{
Description: Private SSH connectivity endpoint. This property will only be returned when enableInternalIngress is true. ,
Required: False ,
}
string ,
}
,
]
,
}
,
clusterAccessProfile:
{
Description: Cluster access profile. ,
Required: False ,
}
{
enableInternalIngress:
{
Description: Whether to create cluster using private IP instead of public IP. This property must be set at create time. ,
Required: True ,
}
boolean ,
privateLinkServiceId:
{
Description: Private link service resource ID. Only when enableInternalIngress is true, this property will be returned. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
logAnalyticsProfile:
{
Description: Cluster log analytics profile to enable or disable OMS agent for cluster. ,
Required: False ,
}
{
enabled:
{
Description: True if log analytics is enabled for the cluster, otherwise false. ,
Required: True ,
}
boolean ,
applicationLogs:
{
Description: Collection of logs to be enabled or disabled for log analytics. ,
Required: False ,
}
{
stdOutEnabled:
{
Description: True if stdout is enabled, otherwise false. ,
Required: False ,
}
boolean ,
stdErrorEnabled:
{
Description: True if stderror is enabled, otherwise false. ,
Required: False ,
}
boolean ,
}
,
metricsEnabled:
{
Description: True if metrics are enabled, otherwise false. ,
Required: False ,
}
boolean ,
}
,
prometheusProfile:
{
Description: Cluster Prometheus profile. ,
Required: False ,
}
{
enabled:
{
Description: Enable Prometheus for cluster or not. ,
Required: True ,
}
boolean ,
}
,
sshProfile:
{
Description: Ssh profile for the cluster. ,
Required: False ,
}
{
count:
{
Description: Number of ssh pods per cluster. ,
Format: int32 ,
Required: True ,
}
integer ,
podPrefix:
{
Description: Prefix of the pod names. Pod number will be appended to the prefix. The ingress URLs for the pods will be available at //- ,
Required: False ,
}
string ,
}
,
autoscaleProfile:
{
Description: This is the Autoscale profile for the cluster. This will allow customer to create cluster enabled with Autoscale. ,
Required: False ,
}
{
enabled:
{
Description: This indicates whether auto scale is enabled on HDInsight on AKS cluster. ,
Required: True ,
}
boolean ,
gracefulDecommissionTimeout:
{
Description: This property is for graceful decommission timeout; It has a default setting of 3600 seconds before forced shutdown takes place. This is the maximal time to wait for running containers and applications to complete before transition a DECOMMISSIONING node into DECOMMISSIONED. The default value is 3600 seconds. Negative value (like -1) is handled as infinite timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
autoscaleType:
{
Description: User to specify which type of Autoscale to be implemented - Scheduled Based or Load Based. ,
Enum:
{
ScheduleBased: No description available. ,
LoadBased: No description available. ,
}
,
Required: False ,
}
enum ,
scheduleBasedConfig:
{
Description: Profiles of schedule based Autoscale. ,
Required: False ,
}
{
timeZone:
{
Description: User has to specify the timezone on which the schedule has to be set for schedule based autoscale configuration. ,
Required: True ,
}
string ,
defaultCount:
{
Description: Setting default node count of current schedule configuration. Default node count specifies the number of nodes which are default when an specified scaling operation is executed (scale up/scale down) ,
Format: int32 ,
Required: True ,
}
integer ,
schedules:
{
Description: This specifies the schedules where scheduled based Autoscale to be enabled, the user has a choice to set multiple rules within the schedule across days and times (start/end). ,
Required: True ,
}
[
{
startTime:
{
Description: User has to set the start time of current schedule configuration, format like 10:30 (HH:MM). ,
Required: True ,
}
string ,
endTime:
{
Description: User has to set the end time of current schedule configuration, format like 10:30 (HH:MM). ,
Required: True ,
}
string ,
count:
{
Description: User has to set the node count anticipated at end of the scaling operation of the set current schedule configuration, format is integer. ,
Format: int32 ,
Required: True ,
}
integer ,
days:
{
Description: User has to set the days where schedule has to be set for autoscale operation. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
loadBasedConfig:
{
Description: Profiles of load based Autoscale. ,
Required: False ,
}
{
minNodes:
{
Description: User needs to set the minimum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. ,
Format: int32 ,
Required: True ,
}
integer ,
maxNodes:
{
Description: User needs to set the maximum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. ,
Format: int32 ,
Required: True ,
}
integer ,
pollInterval:
{
Description: User can specify the poll interval, this is the time period (in seconds) after which scaling metrics are polled for triggering a scaling operation. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: This is a cool down period, this is a time period in seconds, which determines the amount of time that must elapse between a scaling activity started by a rule and the start of the next scaling activity, regardless of the rule that triggers it. The default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
scalingRules:
{
Description: The scaling rules. ,
Required: True ,
}
[
{
actionType:
{
Description: The action type. ,
Enum:
{
scaleup: No description available. ,
scaledown: No description available. ,
}
,
Required: True ,
}
enum ,
evaluationCount:
{
Description: This is an evaluation count for a scaling condition, the number of times a trigger condition should be successful, before scaling activity is triggered. ,
Format: int32 ,
Required: True ,
}
integer ,
scalingMetric:
{
Description: Metrics name for individual workloads. For example: cpu ,
Required: True ,
}
string ,
comparisonRule:
{
Description: The comparison rule. ,
Required: True ,
}
{
operator:
{
Description: The comparison operator. ,
Enum:
{
greaterThan: No description available. ,
greaterThanOrEqual: No description available. ,
lessThan: No description available. ,
lessThanOrEqual: No description available. ,
}
,
Required: True ,
}
enum ,
threshold:
{
Description: Threshold setting. ,
Required: True ,
}
number ,
}
,
}
,
]
,
}
,
}
,
rangerPluginProfile:
{
Description: Cluster Ranger plugin profile. ,
Required: False ,
}
{
enabled:
{
Description: Enable Ranger for cluster or not. ,
Required: True ,
}
boolean ,
}
,
kafkaProfile:
{
Description: The Kafka cluster profile. ,
Required: False ,
}
{
enableKRaft:
{
Description: Expose Kafka cluster in KRaft mode. ,
Required: False ,
}
boolean ,
enablePublicEndpoints:
{
Description: Expose worker nodes as public endpoints. ,
Required: False ,
}
boolean ,
remoteStorageUri:
{
Description: Fully qualified path of Azure Storage container used for Tiered Storage. ,
Required: False ,
}
string ,
diskStorage:
{
Description: Kafka disk storage profile. ,
Required: True ,
}
{
dataDiskSize:
{
Description: Managed Disk size in GB. The maximum supported disk size for Standard and Premium HDD/SSD is 32TB, except for Premium SSD v2, which supports up to 64TB. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskType:
{
Description: Managed Disk Type. ,
Enum:
{
Standard_HDD_LRS: No description available. ,
Standard_SSD_LRS: No description available. ,
Standard_SSD_ZRS: No description available. ,
Premium_SSD_LRS: No description available. ,
Premium_SSD_ZRS: No description available. ,
Premium_SSD_v2_LRS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
clusterIdentity:
{
Description: Identity of the internal service components inside the Kafka cluster. ,
Required: False ,
}
{
msiResourceId:
{
Description: ResourceId of the MSI. ,
Format: arm-id ,
Required: True ,
}
string ,
msiClientId:
{
Description: ClientId of the MSI. ,
Required: True ,
}
string ,
msiObjectId:
{
Description: ObjectId of the MSI. ,
Required: True ,
}
string ,
}
,
connectivityEndpoints:
{
Description: Kafka bootstrap server and brokers related connectivity endpoints. ,
Required: False ,
}
{
bootstrapServerEndpoint:
{
Description: bootstrap server connectivity endpoint. ,
Required: False ,
}
string ,
brokerEndpoints:
{
Description: Kafka broker endpoint list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
trinoProfile:
{
Description: Trino Cluster profile. ,
Required: False ,
}
{
catalogOptions:
{
Description: Trino cluster catalog options. ,
Required: False ,
}
{
hive:
{
Description: hive catalog options. ,
Required: False ,
}
[
{
catalogName:
{
Description: Name of trino catalog which should use specified hive metastore. ,
Required: True ,
}
string ,
metastoreDbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metastoreDbConnectionPasswordSecret:
{
Description: Secret reference name from secretsProfile.secrets containing password for database connection. ,
Required: False ,
}
string ,
metastoreDbConnectionURL:
{
Description: Connection string for hive metastore database. ,
Required: True ,
}
string ,
metastoreDbConnectionUserName:
{
Description: User name for database connection. ,
Required: False ,
}
string ,
metastoreWarehouseDir:
{
Description: Metastore root directory URI, format: abfs[s]://@.dfs.core.windows.net/. More details: https://docs.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction-abfs-uri ,
Required: True ,
}
string ,
}
,
]
,
}
,
coordinator:
{
Description: Trino Coordinator. ,
Required: False ,
}
{
debug:
{
Description: Trino debug configuration. ,
Required: False ,
}
{
enable:
{
Description: The flag that if enable debug or not. ,
Required: False ,
}
boolean ,
port:
{
Description: The debug port. ,
Format: int32 ,
Required: False ,
}
integer ,
suspend:
{
Description: The flag that if suspend debug or not. ,
Required: False ,
}
boolean ,
}
,
highAvailabilityEnabled:
{
Description: The flag that if enable coordinator HA, uses multiple coordinator replicas with auto failover, one per each head node. Default: true. ,
Required: False ,
}
boolean ,
}
,
userPluginsSpec:
{
Description: Trino user plugins spec ,
Required: False ,
}
{
plugins:
{
Description: Trino user plugins. ,
Required: False ,
}
[
{
enabled:
{
Description: Denotes whether the plugin is active or not. ,
Required: False ,
}
boolean ,
name:
{
Description: This field maps to the sub-directory in trino plugins location, that will contain all the plugins under path. ,
Required: False ,
}
string ,
path:
{
Description: Fully qualified path to the folder containing the plugins. ,
Required: False ,
}
string ,
}
,
]
,
}
,
userTelemetrySpec:
{
Description: User telemetry ,
Required: False ,
}
{
storage:
{
Description: Trino user telemetry definition. ,
Required: False ,
}
{
hivecatalogName:
{
Description: Hive Catalog name used to mount external tables on the logs written by trino, if not specified there tables are not created. ,
Required: False ,
}
string ,
hivecatalogSchema:
{
Description: Schema of the above catalog to use, to mount query logs as external tables, if not specified tables will be mounted under schema trinologs. ,
Required: False ,
}
string ,
partitionRetentionInDays:
{
Description: Retention period for query log table partitions, this doesn't have any affect on actual data. ,
Format: int32 ,
Required: False ,
}
integer ,
path:
{
Description: Azure storage location of the blobs. ,
Required: False ,
}
string ,
}
,
}
,
worker:
{
Description: Trino worker. ,
Required: False ,
}
{
debug:
{
Description: Trino debug configuration. ,
Required: False ,
}
{
enable:
{
Description: The flag that if enable debug or not. ,
Required: False ,
}
boolean ,
port:
{
Description: The debug port. ,
Format: int32 ,
Required: False ,
}
integer ,
suspend:
{
Description: The flag that if suspend debug or not. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
llapProfile:
{
Description: LLAP cluster profile. ,
Required: False ,
}
object ,
flinkProfile:
{
Description: The Flink cluster profile. ,
Required: False ,
}
{
storage:
{
Description: The storage profile ,
Required: True ,
}
{
storageUri:
{
Description: Storage account uri which is used for savepoint and checkpoint state. ,
Required: True ,
}
string ,
storagekey:
{
Description: Storage key is only required for wasb(s) storage. ,
Required: False ,
}
string ,
}
,
numReplicas:
{
Description: The number of task managers. ,
Format: int32 ,
Required: False ,
}
integer ,
jobManager:
{
Description: Job Manager container/ process CPU and memory requirements ,
Required: True ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
historyServer:
{
Description: History Server container/ process CPU and memory requirements ,
Required: False ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
taskManager:
{
Description: Task Manager container/ process CPU and memory requirements ,
Required: True ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
catalogOptions:
{
Description: Flink cluster catalog options. ,
Required: False ,
}
{
hive:
{
Description: Hive Catalog Option for Flink cluster. ,
Required: False ,
}
{
metastoreDbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metastoreDbConnectionPasswordSecret:
{
Description: Secret reference name from secretsProfile.secrets containing password for database connection. ,
Required: False ,
}
string ,
metastoreDbConnectionURL:
{
Description: Connection string for hive metastore database. ,
Required: True ,
}
string ,
metastoreDbConnectionUserName:
{
Description: User name for database connection. ,
Required: False ,
}
string ,
}
,
}
,
deploymentMode:
{
Description: A string property that indicates the deployment mode of Flink cluster. It can have one of the following enum values => Application, Session. Default value is Session ,
Enum:
{
Application: No description available. ,
Session: No description available. ,
}
,
Required: False ,
}
enum ,
jobSpec:
{
Description: 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. ,
Required: False ,
}
{
jobJarDirectory:
{
Description: A string property that specifies the directory where the job JAR is located. ,
Required: True ,
}
string ,
jarName:
{
Description: A string property that represents the name of the job JAR. ,
Required: True ,
}
string ,
entryClass:
{
Description: A string property that specifies the entry class for the Flink job. If not specified, the entry point is auto-detected from the flink job jar package. ,
Required: False ,
}
string ,
args:
{
Description: A string property representing additional JVM arguments for the Flink job. It should be space separated value. ,
Required: False ,
}
string ,
savePointName:
{
Description: A string property that represents the name of the savepoint for the Flink job ,
Required: False ,
}
string ,
upgradeMode:
{
Description: A string property that indicates the upgrade mode to be performed on the Flink job. It can have one of the following enum values => STATELESS_UPDATE, UPDATE, LAST_STATE_UPDATE. ,
Enum:
{
STATELESS_UPDATE: No description available. ,
UPDATE: No description available. ,
LAST_STATE_UPDATE: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
sparkProfile:
{
Description: The spark cluster profile. ,
Required: False ,
}
{
defaultStorageUrl:
{
Description: The default storage URL. ,
Required: False ,
}
string ,
metastoreSpec:
{
Description: The metastore specification for Spark cluster. ,
Required: False ,
}
{
dbServerHost:
{
Description: The database server host. ,
Required: True ,
}
string ,
dbName:
{
Description: The database name. ,
Required: True ,
}
string ,
dbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
dbUserName:
{
Description: The database user name. ,
Required: False ,
}
string ,
dbPasswordSecretName:
{
Description: The secret name which contains the database user password. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: The key vault resource id. ,
Required: False ,
}
string ,
thriftUrl:
{
Description: The thrift url. ,
Required: False ,
}
string ,
}
,
userPluginsSpec:
{
Description: Spark user plugins spec ,
Required: False ,
}
{
plugins:
{
Description: Spark user plugins. ,
Required: False ,
}
[
{
path:
{
Description: Fully qualified path to the folder containing the plugins. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
rangerProfile:
{
Description: The ranger cluster profile. ,
Required: False ,
}
{
rangerAdmin:
{
Description: Specification for the Ranger Admin service. ,
Required: True ,
}
{
admins:
{
Description: List of usernames that should be marked as ranger admins. These usernames should match the user principal name (UPN) of the respective AAD users. ,
Required: True ,
}
[
string ,
]
,
database:
{
Required: True ,
}
{
host:
{
Description: The database URL ,
Required: True ,
}
string ,
name:
{
Description: The database name ,
Required: True ,
}
string ,
passwordSecretRef:
{
Description: Reference for the database password ,
Required: False ,
}
string ,
username:
{
Description: The name of the database user ,
Required: False ,
}
string ,
}
,
}
,
rangerAudit:
{
Description: Properties required to describe audit log storage. ,
Required: False ,
}
{
storageAccount:
{
Description: Azure storage location of the blobs. MSI should have read/write access to this Storage account. ,
Required: False ,
}
string ,
}
,
rangerUsersync:
{
Description: Specification for the Ranger Usersync service ,
Required: True ,
}
{
enabled:
{
Description: Denotes whether usersync service should be enabled ,
Required: False ,
}
boolean ,
groups:
{
Description: List of groups that should be synced. These group names should match the object id of the respective AAD groups. ,
Required: False ,
}
[
string ,
]
,
mode:
{
Description: User & groups can be synced automatically or via a static list that's refreshed. ,
Enum:
{
static: No description available. ,
automatic: No description available. ,
}
,
Required: False ,
}
enum ,
userMappingLocation:
{
Description: Azure storage location of a mapping file that lists user & group associations. ,
Required: False ,
}
string ,
users:
{
Description: List of user names that should be synced. These usernames should match the User principal name of the respective AAD users. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
stubProfile:
{
Description: Stub cluster profile. ,
Required: False ,
}
object ,
scriptActionProfiles:
{
Description: The script action profile list. ,
Required: False ,
}
[
{
type:
{
Description: Type of the script action. Supported type is bash scripts. ,
Required: True ,
}
string ,
name:
{
Description: Script name. ,
Required: True ,
}
string ,
url:
{
Description: Url of the script file. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters for the script action. It should be space-separated list of arguments required for script execution. ,
Required: False ,
}
string ,
services:
{
Description: List of services to apply the script action. ,
Required: True ,
}
[
string ,
]
,
timeoutInMinutes:
{
Description: Timeout duration for the script action in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
shouldPersist:
{
Description: Specify if the script should persist on the cluster. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
status:
{
Description: Business status of the resource. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: SystemData of cluster. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to get the status of the resize operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Get (removed)
Description :  Gets a HDInsight cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
clusterPoolName:
{
Description: The name of the cluster pool. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the HDInsight cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties. Define cluster specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
clusterType:
{
Description: The type of cluster. ,
Required: True ,
}
string ,
deploymentId:
{
Description: A unique id generated by the RP to identify the resource. ,
Required: False ,
}
string ,
computeProfile:
{
Description: The compute profile. ,
Required: True ,
}
{
nodes:
{
Description: The nodes definitions. ,
Required: True ,
}
[
{
type:
{
Description: The node type. ,
Required: True ,
}
string ,
vmSize:
{
Description: The virtual machine SKU. ,
Required: True ,
}
string ,
count:
{
Description: The number of virtual machines. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
clusterProfile:
{
Description: Cluster profile. ,
Required: True ,
}
{
clusterVersion:
{
Description: Version with 3/4 part. ,
Required: True ,
}
string ,
ossVersion:
{
Description: Version with three part. ,
Required: True ,
}
string ,
components:
{
Description: Component list of this cluster type and version. ,
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
version:
{
Required: False ,
}
string ,
}
,
]
,
identityProfile:
{
Description: This property is required by Trino, Spark and Flink cluster but is optional for Kafka cluster. ,
Required: False ,
}
{
msiResourceId:
{
Description: ResourceId of the MSI. ,
Format: arm-id ,
Required: True ,
}
string ,
msiClientId:
{
Description: ClientId of the MSI. ,
Required: True ,
}
string ,
msiObjectId:
{
Description: ObjectId of the MSI. ,
Required: True ,
}
string ,
}
,
authorizationProfile:
{
Description: Authorization profile with details of AAD user Ids and group Ids authorized for data plane access. ,
Required: True ,
}
{
userIds:
{
Description: AAD user Ids authorized for data plane access. ,
Required: False ,
}
[
string ,
]
,
groupIds:
{
Description: AAD group Ids authorized for data plane access. ,
Required: False ,
}
[
string ,
]
,
}
,
secretsProfile:
{
Description: The cluster secret profile. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: Name of the user Key Vault where all the cluster specific user secrets are stored. ,
Format: arm-id ,
Required: True ,
}
string ,
secrets:
{
Description: Properties of Key Vault secret. ,
Required: False ,
}
[
{
referenceName:
{
Description: Reference name of the secret to be used in service configs. ,
Required: True ,
}
string ,
type:
{
Description: Type of key vault object: secret, key or certificate. ,
Enum:
{
Key: No description available. ,
Secret: No description available. ,
Certificate: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: Version of the secret in key vault. ,
Required: False ,
}
string ,
keyVaultObjectName:
{
Description: Object identifier name of the secret in key vault. ,
Required: True ,
}
string ,
}
,
]
,
}
,
serviceConfigsProfiles:
{
Description: The service configs profiles. ,
Required: False ,
}
[
{
serviceName:
{
Description: Name of the service the configurations should apply to. ,
Required: True ,
}
string ,
configs:
{
Description: List of service configs. ,
Required: True ,
}
[
{
component:
{
Description: Name of the component the config files should apply to. ,
Required: True ,
}
string ,
files:
{
Description: List of Config Files. ,
Required: True ,
}
[
{
fileName:
{
Description: Configuration file name. ,
Required: True ,
}
string ,
content:
{
Description: Free form content of the entire configuration file. ,
Required: False ,
}
string ,
encoding:
{
Description: This property indicates if the content is encoded and is case-insensitive. Please set the value to base64 if the content is base64 encoded. Set it to none or skip it if the content is plain text. ,
Enum:
{
Base64: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
path:
{
Description: Path of the config file if content is specified. ,
Required: False ,
}
string ,
values:
{
Description: List of key value pairs where key represents a valid service configuration name and value represents the value of the config. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
]
,
connectivityProfile:
{
Description: Cluster connectivity profile. ,
Required: False ,
}
{
web:
{
Description: Web connectivity endpoint details. ,
Required: True ,
}
string ,
ssh:
{
Description: List of SSH connectivity endpoints. ,
Required: False ,
}
[
{
endpoint:
{
Description: SSH connectivity endpoint. ,
Required: True ,
}
string ,
privateSshEndpoint:
{
Description: Private SSH connectivity endpoint. This property will only be returned when enableInternalIngress is true. ,
Required: False ,
}
string ,
}
,
]
,
}
,
clusterAccessProfile:
{
Description: Cluster access profile. ,
Required: False ,
}
{
enableInternalIngress:
{
Description: Whether to create cluster using private IP instead of public IP. This property must be set at create time. ,
Required: True ,
}
boolean ,
privateLinkServiceId:
{
Description: Private link service resource ID. Only when enableInternalIngress is true, this property will be returned. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
logAnalyticsProfile:
{
Description: Cluster log analytics profile to enable or disable OMS agent for cluster. ,
Required: False ,
}
{
enabled:
{
Description: True if log analytics is enabled for the cluster, otherwise false. ,
Required: True ,
}
boolean ,
applicationLogs:
{
Description: Collection of logs to be enabled or disabled for log analytics. ,
Required: False ,
}
{
stdOutEnabled:
{
Description: True if stdout is enabled, otherwise false. ,
Required: False ,
}
boolean ,
stdErrorEnabled:
{
Description: True if stderror is enabled, otherwise false. ,
Required: False ,
}
boolean ,
}
,
metricsEnabled:
{
Description: True if metrics are enabled, otherwise false. ,
Required: False ,
}
boolean ,
}
,
prometheusProfile:
{
Description: Cluster Prometheus profile. ,
Required: False ,
}
{
enabled:
{
Description: Enable Prometheus for cluster or not. ,
Required: True ,
}
boolean ,
}
,
sshProfile:
{
Description: Ssh profile for the cluster. ,
Required: False ,
}
{
count:
{
Description: Number of ssh pods per cluster. ,
Format: int32 ,
Required: True ,
}
integer ,
podPrefix:
{
Description: Prefix of the pod names. Pod number will be appended to the prefix. The ingress URLs for the pods will be available at //- ,
Required: False ,
}
string ,
}
,
autoscaleProfile:
{
Description: This is the Autoscale profile for the cluster. This will allow customer to create cluster enabled with Autoscale. ,
Required: False ,
}
{
enabled:
{
Description: This indicates whether auto scale is enabled on HDInsight on AKS cluster. ,
Required: True ,
}
boolean ,
gracefulDecommissionTimeout:
{
Description: This property is for graceful decommission timeout; It has a default setting of 3600 seconds before forced shutdown takes place. This is the maximal time to wait for running containers and applications to complete before transition a DECOMMISSIONING node into DECOMMISSIONED. The default value is 3600 seconds. Negative value (like -1) is handled as infinite timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
autoscaleType:
{
Description: User to specify which type of Autoscale to be implemented - Scheduled Based or Load Based. ,
Enum:
{
ScheduleBased: No description available. ,
LoadBased: No description available. ,
}
,
Required: False ,
}
enum ,
scheduleBasedConfig:
{
Description: Profiles of schedule based Autoscale. ,
Required: False ,
}
{
timeZone:
{
Description: User has to specify the timezone on which the schedule has to be set for schedule based autoscale configuration. ,
Required: True ,
}
string ,
defaultCount:
{
Description: Setting default node count of current schedule configuration. Default node count specifies the number of nodes which are default when an specified scaling operation is executed (scale up/scale down) ,
Format: int32 ,
Required: True ,
}
integer ,
schedules:
{
Description: This specifies the schedules where scheduled based Autoscale to be enabled, the user has a choice to set multiple rules within the schedule across days and times (start/end). ,
Required: True ,
}
[
{
startTime:
{
Description: User has to set the start time of current schedule configuration, format like 10:30 (HH:MM). ,
Required: True ,
}
string ,
endTime:
{
Description: User has to set the end time of current schedule configuration, format like 10:30 (HH:MM). ,
Required: True ,
}
string ,
count:
{
Description: User has to set the node count anticipated at end of the scaling operation of the set current schedule configuration, format is integer. ,
Format: int32 ,
Required: True ,
}
integer ,
days:
{
Description: User has to set the days where schedule has to be set for autoscale operation. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
loadBasedConfig:
{
Description: Profiles of load based Autoscale. ,
Required: False ,
}
{
minNodes:
{
Description: User needs to set the minimum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. ,
Format: int32 ,
Required: True ,
}
integer ,
maxNodes:
{
Description: User needs to set the maximum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. ,
Format: int32 ,
Required: True ,
}
integer ,
pollInterval:
{
Description: User can specify the poll interval, this is the time period (in seconds) after which scaling metrics are polled for triggering a scaling operation. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: This is a cool down period, this is a time period in seconds, which determines the amount of time that must elapse between a scaling activity started by a rule and the start of the next scaling activity, regardless of the rule that triggers it. The default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
scalingRules:
{
Description: The scaling rules. ,
Required: True ,
}
[
{
actionType:
{
Description: The action type. ,
Enum:
{
scaleup: No description available. ,
scaledown: No description available. ,
}
,
Required: True ,
}
enum ,
evaluationCount:
{
Description: This is an evaluation count for a scaling condition, the number of times a trigger condition should be successful, before scaling activity is triggered. ,
Format: int32 ,
Required: True ,
}
integer ,
scalingMetric:
{
Description: Metrics name for individual workloads. For example: cpu ,
Required: True ,
}
string ,
comparisonRule:
{
Description: The comparison rule. ,
Required: True ,
}
{
operator:
{
Description: The comparison operator. ,
Enum:
{
greaterThan: No description available. ,
greaterThanOrEqual: No description available. ,
lessThan: No description available. ,
lessThanOrEqual: No description available. ,
}
,
Required: True ,
}
enum ,
threshold:
{
Description: Threshold setting. ,
Required: True ,
}
number ,
}
,
}
,
]
,
}
,
}
,
rangerPluginProfile:
{
Description: Cluster Ranger plugin profile. ,
Required: False ,
}
{
enabled:
{
Description: Enable Ranger for cluster or not. ,
Required: True ,
}
boolean ,
}
,
kafkaProfile:
{
Description: The Kafka cluster profile. ,
Required: False ,
}
{
enableKRaft:
{
Description: Expose Kafka cluster in KRaft mode. ,
Required: False ,
}
boolean ,
enablePublicEndpoints:
{
Description: Expose worker nodes as public endpoints. ,
Required: False ,
}
boolean ,
remoteStorageUri:
{
Description: Fully qualified path of Azure Storage container used for Tiered Storage. ,
Required: False ,
}
string ,
diskStorage:
{
Description: Kafka disk storage profile. ,
Required: True ,
}
{
dataDiskSize:
{
Description: Managed Disk size in GB. The maximum supported disk size for Standard and Premium HDD/SSD is 32TB, except for Premium SSD v2, which supports up to 64TB. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskType:
{
Description: Managed Disk Type. ,
Enum:
{
Standard_HDD_LRS: No description available. ,
Standard_SSD_LRS: No description available. ,
Standard_SSD_ZRS: No description available. ,
Premium_SSD_LRS: No description available. ,
Premium_SSD_ZRS: No description available. ,
Premium_SSD_v2_LRS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
clusterIdentity:
{
Description: Identity of the internal service components inside the Kafka cluster. ,
Required: False ,
}
{
msiResourceId:
{
Description: ResourceId of the MSI. ,
Format: arm-id ,
Required: True ,
}
string ,
msiClientId:
{
Description: ClientId of the MSI. ,
Required: True ,
}
string ,
msiObjectId:
{
Description: ObjectId of the MSI. ,
Required: True ,
}
string ,
}
,
connectivityEndpoints:
{
Description: Kafka bootstrap server and brokers related connectivity endpoints. ,
Required: False ,
}
{
bootstrapServerEndpoint:
{
Description: bootstrap server connectivity endpoint. ,
Required: False ,
}
string ,
brokerEndpoints:
{
Description: Kafka broker endpoint list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
trinoProfile:
{
Description: Trino Cluster profile. ,
Required: False ,
}
{
catalogOptions:
{
Description: Trino cluster catalog options. ,
Required: False ,
}
{
hive:
{
Description: hive catalog options. ,
Required: False ,
}
[
{
catalogName:
{
Description: Name of trino catalog which should use specified hive metastore. ,
Required: True ,
}
string ,
metastoreDbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metastoreDbConnectionPasswordSecret:
{
Description: Secret reference name from secretsProfile.secrets containing password for database connection. ,
Required: False ,
}
string ,
metastoreDbConnectionURL:
{
Description: Connection string for hive metastore database. ,
Required: True ,
}
string ,
metastoreDbConnectionUserName:
{
Description: User name for database connection. ,
Required: False ,
}
string ,
metastoreWarehouseDir:
{
Description: Metastore root directory URI, format: abfs[s]://@.dfs.core.windows.net/. More details: https://docs.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction-abfs-uri ,
Required: True ,
}
string ,
}
,
]
,
}
,
coordinator:
{
Description: Trino Coordinator. ,
Required: False ,
}
{
debug:
{
Description: Trino debug configuration. ,
Required: False ,
}
{
enable:
{
Description: The flag that if enable debug or not. ,
Required: False ,
}
boolean ,
port:
{
Description: The debug port. ,
Format: int32 ,
Required: False ,
}
integer ,
suspend:
{
Description: The flag that if suspend debug or not. ,
Required: False ,
}
boolean ,
}
,
highAvailabilityEnabled:
{
Description: The flag that if enable coordinator HA, uses multiple coordinator replicas with auto failover, one per each head node. Default: true. ,
Required: False ,
}
boolean ,
}
,
userPluginsSpec:
{
Description: Trino user plugins spec ,
Required: False ,
}
{
plugins:
{
Description: Trino user plugins. ,
Required: False ,
}
[
{
enabled:
{
Description: Denotes whether the plugin is active or not. ,
Required: False ,
}
boolean ,
name:
{
Description: This field maps to the sub-directory in trino plugins location, that will contain all the plugins under path. ,
Required: False ,
}
string ,
path:
{
Description: Fully qualified path to the folder containing the plugins. ,
Required: False ,
}
string ,
}
,
]
,
}
,
userTelemetrySpec:
{
Description: User telemetry ,
Required: False ,
}
{
storage:
{
Description: Trino user telemetry definition. ,
Required: False ,
}
{
hivecatalogName:
{
Description: Hive Catalog name used to mount external tables on the logs written by trino, if not specified there tables are not created. ,
Required: False ,
}
string ,
hivecatalogSchema:
{
Description: Schema of the above catalog to use, to mount query logs as external tables, if not specified tables will be mounted under schema trinologs. ,
Required: False ,
}
string ,
partitionRetentionInDays:
{
Description: Retention period for query log table partitions, this doesn't have any affect on actual data. ,
Format: int32 ,
Required: False ,
}
integer ,
path:
{
Description: Azure storage location of the blobs. ,
Required: False ,
}
string ,
}
,
}
,
worker:
{
Description: Trino worker. ,
Required: False ,
}
{
debug:
{
Description: Trino debug configuration. ,
Required: False ,
}
{
enable:
{
Description: The flag that if enable debug or not. ,
Required: False ,
}
boolean ,
port:
{
Description: The debug port. ,
Format: int32 ,
Required: False ,
}
integer ,
suspend:
{
Description: The flag that if suspend debug or not. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
llapProfile:
{
Description: LLAP cluster profile. ,
Required: False ,
}
object ,
flinkProfile:
{
Description: The Flink cluster profile. ,
Required: False ,
}
{
storage:
{
Description: The storage profile ,
Required: True ,
}
{
storageUri:
{
Description: Storage account uri which is used for savepoint and checkpoint state. ,
Required: True ,
}
string ,
storagekey:
{
Description: Storage key is only required for wasb(s) storage. ,
Required: False ,
}
string ,
}
,
numReplicas:
{
Description: The number of task managers. ,
Format: int32 ,
Required: False ,
}
integer ,
jobManager:
{
Description: Job Manager container/ process CPU and memory requirements ,
Required: True ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
historyServer:
{
Description: History Server container/ process CPU and memory requirements ,
Required: False ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
taskManager:
{
Description: Task Manager container/ process CPU and memory requirements ,
Required: True ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
catalogOptions:
{
Description: Flink cluster catalog options. ,
Required: False ,
}
{
hive:
{
Description: Hive Catalog Option for Flink cluster. ,
Required: False ,
}
{
metastoreDbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metastoreDbConnectionPasswordSecret:
{
Description: Secret reference name from secretsProfile.secrets containing password for database connection. ,
Required: False ,
}
string ,
metastoreDbConnectionURL:
{
Description: Connection string for hive metastore database. ,
Required: True ,
}
string ,
metastoreDbConnectionUserName:
{
Description: User name for database connection. ,
Required: False ,
}
string ,
}
,
}
,
deploymentMode:
{
Description: A string property that indicates the deployment mode of Flink cluster. It can have one of the following enum values => Application, Session. Default value is Session ,
Enum:
{
Application: No description available. ,
Session: No description available. ,
}
,
Required: False ,
}
enum ,
jobSpec:
{
Description: 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. ,
Required: False ,
}
{
jobJarDirectory:
{
Description: A string property that specifies the directory where the job JAR is located. ,
Required: True ,
}
string ,
jarName:
{
Description: A string property that represents the name of the job JAR. ,
Required: True ,
}
string ,
entryClass:
{
Description: A string property that specifies the entry class for the Flink job. If not specified, the entry point is auto-detected from the flink job jar package. ,
Required: False ,
}
string ,
args:
{
Description: A string property representing additional JVM arguments for the Flink job. It should be space separated value. ,
Required: False ,
}
string ,
savePointName:
{
Description: A string property that represents the name of the savepoint for the Flink job ,
Required: False ,
}
string ,
upgradeMode:
{
Description: A string property that indicates the upgrade mode to be performed on the Flink job. It can have one of the following enum values => STATELESS_UPDATE, UPDATE, LAST_STATE_UPDATE. ,
Enum:
{
STATELESS_UPDATE: No description available. ,
UPDATE: No description available. ,
LAST_STATE_UPDATE: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
sparkProfile:
{
Description: The spark cluster profile. ,
Required: False ,
}
{
defaultStorageUrl:
{
Description: The default storage URL. ,
Required: False ,
}
string ,
metastoreSpec:
{
Description: The metastore specification for Spark cluster. ,
Required: False ,
}
{
dbServerHost:
{
Description: The database server host. ,
Required: True ,
}
string ,
dbName:
{
Description: The database name. ,
Required: True ,
}
string ,
dbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
dbUserName:
{
Description: The database user name. ,
Required: False ,
}
string ,
dbPasswordSecretName:
{
Description: The secret name which contains the database user password. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: The key vault resource id. ,
Required: False ,
}
string ,
thriftUrl:
{
Description: The thrift url. ,
Required: False ,
}
string ,
}
,
userPluginsSpec:
{
Description: Spark user plugins spec ,
Required: False ,
}
{
plugins:
{
Description: Spark user plugins. ,
Required: False ,
}
[
{
path:
{
Description: Fully qualified path to the folder containing the plugins. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
rangerProfile:
{
Description: The ranger cluster profile. ,
Required: False ,
}
{
rangerAdmin:
{
Description: Specification for the Ranger Admin service. ,
Required: True ,
}
{
admins:
{
Description: List of usernames that should be marked as ranger admins. These usernames should match the user principal name (UPN) of the respective AAD users. ,
Required: True ,
}
[
string ,
]
,
database:
{
Required: True ,
}
{
host:
{
Description: The database URL ,
Required: True ,
}
string ,
name:
{
Description: The database name ,
Required: True ,
}
string ,
passwordSecretRef:
{
Description: Reference for the database password ,
Required: False ,
}
string ,
username:
{
Description: The name of the database user ,
Required: False ,
}
string ,
}
,
}
,
rangerAudit:
{
Description: Properties required to describe audit log storage. ,
Required: False ,
}
{
storageAccount:
{
Description: Azure storage location of the blobs. MSI should have read/write access to this Storage account. ,
Required: False ,
}
string ,
}
,
rangerUsersync:
{
Description: Specification for the Ranger Usersync service ,
Required: True ,
}
{
enabled:
{
Description: Denotes whether usersync service should be enabled ,
Required: False ,
}
boolean ,
groups:
{
Description: List of groups that should be synced. These group names should match the object id of the respective AAD groups. ,
Required: False ,
}
[
string ,
]
,
mode:
{
Description: User & groups can be synced automatically or via a static list that's refreshed. ,
Enum:
{
static: No description available. ,
automatic: No description available. ,
}
,
Required: False ,
}
enum ,
userMappingLocation:
{
Description: Azure storage location of a mapping file that lists user & group associations. ,
Required: False ,
}
string ,
users:
{
Description: List of user names that should be synced. These usernames should match the User principal name of the respective AAD users. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
stubProfile:
{
Description: Stub cluster profile. ,
Required: False ,
}
object ,
scriptActionProfiles:
{
Description: The script action profile list. ,
Required: False ,
}
[
{
type:
{
Description: Type of the script action. Supported type is bash scripts. ,
Required: True ,
}
string ,
name:
{
Description: Script name. ,
Required: True ,
}
string ,
url:
{
Description: Url of the script file. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters for the script action. It should be space-separated list of arguments required for script execution. ,
Required: False ,
}
string ,
services:
{
Description: List of services to apply the script action. ,
Required: True ,
}
[
string ,
]
,
timeoutInMinutes:
{
Description: Timeout duration for the script action in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
shouldPersist:
{
Description: Specify if the script should persist on the cluster. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
status:
{
Description: Business status of the resource. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: SystemData of cluster. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Create (removed)
Description :  Creates a cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
clusterPoolName:
{
Description: The name of the cluster pool. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the HDInsight cluster. ,
Required: True ,
}
string ,
HDInsightCluster:
{
Description: The cluster to create. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the properties. Define cluster specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
clusterType:
{
Description: The type of cluster. ,
Required: True ,
}
string ,
deploymentId:
{
Description: A unique id generated by the RP to identify the resource. ,
Required: False ,
}
string ,
computeProfile:
{
Description: The compute profile. ,
Required: True ,
}
{
nodes:
{
Description: The nodes definitions. ,
Required: True ,
}
[
{
type:
{
Description: The node type. ,
Required: True ,
}
string ,
vmSize:
{
Description: The virtual machine SKU. ,
Required: True ,
}
string ,
count:
{
Description: The number of virtual machines. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
clusterProfile:
{
Description: Cluster profile. ,
Required: True ,
}
{
clusterVersion:
{
Description: Version with 3/4 part. ,
Required: True ,
}
string ,
ossVersion:
{
Description: Version with three part. ,
Required: True ,
}
string ,
components:
{
Description: Component list of this cluster type and version. ,
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
version:
{
Required: False ,
}
string ,
}
,
]
,
identityProfile:
{
Description: This property is required by Trino, Spark and Flink cluster but is optional for Kafka cluster. ,
Required: False ,
}
{
msiResourceId:
{
Description: ResourceId of the MSI. ,
Format: arm-id ,
Required: True ,
}
string ,
msiClientId:
{
Description: ClientId of the MSI. ,
Required: True ,
}
string ,
msiObjectId:
{
Description: ObjectId of the MSI. ,
Required: True ,
}
string ,
}
,
authorizationProfile:
{
Description: Authorization profile with details of AAD user Ids and group Ids authorized for data plane access. ,
Required: True ,
}
{
userIds:
{
Description: AAD user Ids authorized for data plane access. ,
Required: False ,
}
[
string ,
]
,
groupIds:
{
Description: AAD group Ids authorized for data plane access. ,
Required: False ,
}
[
string ,
]
,
}
,
secretsProfile:
{
Description: The cluster secret profile. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: Name of the user Key Vault where all the cluster specific user secrets are stored. ,
Format: arm-id ,
Required: True ,
}
string ,
secrets:
{
Description: Properties of Key Vault secret. ,
Required: False ,
}
[
{
referenceName:
{
Description: Reference name of the secret to be used in service configs. ,
Required: True ,
}
string ,
type:
{
Description: Type of key vault object: secret, key or certificate. ,
Enum:
{
Key: No description available. ,
Secret: No description available. ,
Certificate: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: Version of the secret in key vault. ,
Required: False ,
}
string ,
keyVaultObjectName:
{
Description: Object identifier name of the secret in key vault. ,
Required: True ,
}
string ,
}
,
]
,
}
,
serviceConfigsProfiles:
{
Description: The service configs profiles. ,
Required: False ,
}
[
{
serviceName:
{
Description: Name of the service the configurations should apply to. ,
Required: True ,
}
string ,
configs:
{
Description: List of service configs. ,
Required: True ,
}
[
{
component:
{
Description: Name of the component the config files should apply to. ,
Required: True ,
}
string ,
files:
{
Description: List of Config Files. ,
Required: True ,
}
[
{
fileName:
{
Description: Configuration file name. ,
Required: True ,
}
string ,
content:
{
Description: Free form content of the entire configuration file. ,
Required: False ,
}
string ,
encoding:
{
Description: This property indicates if the content is encoded and is case-insensitive. Please set the value to base64 if the content is base64 encoded. Set it to none or skip it if the content is plain text. ,
Enum:
{
Base64: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
path:
{
Description: Path of the config file if content is specified. ,
Required: False ,
}
string ,
values:
{
Description: List of key value pairs where key represents a valid service configuration name and value represents the value of the config. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
]
,
connectivityProfile:
{
Description: Cluster connectivity profile. ,
Required: False ,
}
{
web:
{
Description: Web connectivity endpoint details. ,
Required: True ,
}
string ,
ssh:
{
Description: List of SSH connectivity endpoints. ,
Required: False ,
}
[
{
endpoint:
{
Description: SSH connectivity endpoint. ,
Required: True ,
}
string ,
privateSshEndpoint:
{
Description: Private SSH connectivity endpoint. This property will only be returned when enableInternalIngress is true. ,
Required: False ,
}
string ,
}
,
]
,
}
,
clusterAccessProfile:
{
Description: Cluster access profile. ,
Required: False ,
}
{
enableInternalIngress:
{
Description: Whether to create cluster using private IP instead of public IP. This property must be set at create time. ,
Required: True ,
}
boolean ,
privateLinkServiceId:
{
Description: Private link service resource ID. Only when enableInternalIngress is true, this property will be returned. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
logAnalyticsProfile:
{
Description: Cluster log analytics profile to enable or disable OMS agent for cluster. ,
Required: False ,
}
{
enabled:
{
Description: True if log analytics is enabled for the cluster, otherwise false. ,
Required: True ,
}
boolean ,
applicationLogs:
{
Description: Collection of logs to be enabled or disabled for log analytics. ,
Required: False ,
}
{
stdOutEnabled:
{
Description: True if stdout is enabled, otherwise false. ,
Required: False ,
}
boolean ,
stdErrorEnabled:
{
Description: True if stderror is enabled, otherwise false. ,
Required: False ,
}
boolean ,
}
,
metricsEnabled:
{
Description: True if metrics are enabled, otherwise false. ,
Required: False ,
}
boolean ,
}
,
prometheusProfile:
{
Description: Cluster Prometheus profile. ,
Required: False ,
}
{
enabled:
{
Description: Enable Prometheus for cluster or not. ,
Required: True ,
}
boolean ,
}
,
sshProfile:
{
Description: Ssh profile for the cluster. ,
Required: False ,
}
{
count:
{
Description: Number of ssh pods per cluster. ,
Format: int32 ,
Required: True ,
}
integer ,
podPrefix:
{
Description: Prefix of the pod names. Pod number will be appended to the prefix. The ingress URLs for the pods will be available at //- ,
Required: False ,
}
string ,
}
,
autoscaleProfile:
{
Description: This is the Autoscale profile for the cluster. This will allow customer to create cluster enabled with Autoscale. ,
Required: False ,
}
{
enabled:
{
Description: This indicates whether auto scale is enabled on HDInsight on AKS cluster. ,
Required: True ,
}
boolean ,
gracefulDecommissionTimeout:
{
Description: This property is for graceful decommission timeout; It has a default setting of 3600 seconds before forced shutdown takes place. This is the maximal time to wait for running containers and applications to complete before transition a DECOMMISSIONING node into DECOMMISSIONED. The default value is 3600 seconds. Negative value (like -1) is handled as infinite timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
autoscaleType:
{
Description: User to specify which type of Autoscale to be implemented - Scheduled Based or Load Based. ,
Enum:
{
ScheduleBased: No description available. ,
LoadBased: No description available. ,
}
,
Required: False ,
}
enum ,
scheduleBasedConfig:
{
Description: Profiles of schedule based Autoscale. ,
Required: False ,
}
{
timeZone:
{
Description: User has to specify the timezone on which the schedule has to be set for schedule based autoscale configuration. ,
Required: True ,
}
string ,
defaultCount:
{
Description: Setting default node count of current schedule configuration. Default node count specifies the number of nodes which are default when an specified scaling operation is executed (scale up/scale down) ,
Format: int32 ,
Required: True ,
}
integer ,
schedules:
{
Description: This specifies the schedules where scheduled based Autoscale to be enabled, the user has a choice to set multiple rules within the schedule across days and times (start/end). ,
Required: True ,
}
[
{
startTime:
{
Description: User has to set the start time of current schedule configuration, format like 10:30 (HH:MM). ,
Required: True ,
}
string ,
endTime:
{
Description: User has to set the end time of current schedule configuration, format like 10:30 (HH:MM). ,
Required: True ,
}
string ,
count:
{
Description: User has to set the node count anticipated at end of the scaling operation of the set current schedule configuration, format is integer. ,
Format: int32 ,
Required: True ,
}
integer ,
days:
{
Description: User has to set the days where schedule has to be set for autoscale operation. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
loadBasedConfig:
{
Description: Profiles of load based Autoscale. ,
Required: False ,
}
{
minNodes:
{
Description: User needs to set the minimum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. ,
Format: int32 ,
Required: True ,
}
integer ,
maxNodes:
{
Description: User needs to set the maximum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. ,
Format: int32 ,
Required: True ,
}
integer ,
pollInterval:
{
Description: User can specify the poll interval, this is the time period (in seconds) after which scaling metrics are polled for triggering a scaling operation. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: This is a cool down period, this is a time period in seconds, which determines the amount of time that must elapse between a scaling activity started by a rule and the start of the next scaling activity, regardless of the rule that triggers it. The default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
scalingRules:
{
Description: The scaling rules. ,
Required: True ,
}
[
{
actionType:
{
Description: The action type. ,
Enum:
{
scaleup: No description available. ,
scaledown: No description available. ,
}
,
Required: True ,
}
enum ,
evaluationCount:
{
Description: This is an evaluation count for a scaling condition, the number of times a trigger condition should be successful, before scaling activity is triggered. ,
Format: int32 ,
Required: True ,
}
integer ,
scalingMetric:
{
Description: Metrics name for individual workloads. For example: cpu ,
Required: True ,
}
string ,
comparisonRule:
{
Description: The comparison rule. ,
Required: True ,
}
{
operator:
{
Description: The comparison operator. ,
Enum:
{
greaterThan: No description available. ,
greaterThanOrEqual: No description available. ,
lessThan: No description available. ,
lessThanOrEqual: No description available. ,
}
,
Required: True ,
}
enum ,
threshold:
{
Description: Threshold setting. ,
Required: True ,
}
number ,
}
,
}
,
]
,
}
,
}
,
rangerPluginProfile:
{
Description: Cluster Ranger plugin profile. ,
Required: False ,
}
{
enabled:
{
Description: Enable Ranger for cluster or not. ,
Required: True ,
}
boolean ,
}
,
kafkaProfile:
{
Description: The Kafka cluster profile. ,
Required: False ,
}
{
enableKRaft:
{
Description: Expose Kafka cluster in KRaft mode. ,
Required: False ,
}
boolean ,
enablePublicEndpoints:
{
Description: Expose worker nodes as public endpoints. ,
Required: False ,
}
boolean ,
remoteStorageUri:
{
Description: Fully qualified path of Azure Storage container used for Tiered Storage. ,
Required: False ,
}
string ,
diskStorage:
{
Description: Kafka disk storage profile. ,
Required: True ,
}
{
dataDiskSize:
{
Description: Managed Disk size in GB. The maximum supported disk size for Standard and Premium HDD/SSD is 32TB, except for Premium SSD v2, which supports up to 64TB. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskType:
{
Description: Managed Disk Type. ,
Enum:
{
Standard_HDD_LRS: No description available. ,
Standard_SSD_LRS: No description available. ,
Standard_SSD_ZRS: No description available. ,
Premium_SSD_LRS: No description available. ,
Premium_SSD_ZRS: No description available. ,
Premium_SSD_v2_LRS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
clusterIdentity:
{
Description: Identity of the internal service components inside the Kafka cluster. ,
Required: False ,
}
{
msiResourceId:
{
Description: ResourceId of the MSI. ,
Format: arm-id ,
Required: True ,
}
string ,
msiClientId:
{
Description: ClientId of the MSI. ,
Required: True ,
}
string ,
msiObjectId:
{
Description: ObjectId of the MSI. ,
Required: True ,
}
string ,
}
,
connectivityEndpoints:
{
Description: Kafka bootstrap server and brokers related connectivity endpoints. ,
Required: False ,
}
{
bootstrapServerEndpoint:
{
Description: bootstrap server connectivity endpoint. ,
Required: False ,
}
string ,
brokerEndpoints:
{
Description: Kafka broker endpoint list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
trinoProfile:
{
Description: Trino Cluster profile. ,
Required: False ,
}
{
catalogOptions:
{
Description: Trino cluster catalog options. ,
Required: False ,
}
{
hive:
{
Description: hive catalog options. ,
Required: False ,
}
[
{
catalogName:
{
Description: Name of trino catalog which should use specified hive metastore. ,
Required: True ,
}
string ,
metastoreDbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metastoreDbConnectionPasswordSecret:
{
Description: Secret reference name from secretsProfile.secrets containing password for database connection. ,
Required: False ,
}
string ,
metastoreDbConnectionURL:
{
Description: Connection string for hive metastore database. ,
Required: True ,
}
string ,
metastoreDbConnectionUserName:
{
Description: User name for database connection. ,
Required: False ,
}
string ,
metastoreWarehouseDir:
{
Description: Metastore root directory URI, format: abfs[s]://@.dfs.core.windows.net/. More details: https://docs.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction-abfs-uri ,
Required: True ,
}
string ,
}
,
]
,
}
,
coordinator:
{
Description: Trino Coordinator. ,
Required: False ,
}
{
debug:
{
Description: Trino debug configuration. ,
Required: False ,
}
{
enable:
{
Description: The flag that if enable debug or not. ,
Required: False ,
}
boolean ,
port:
{
Description: The debug port. ,
Format: int32 ,
Required: False ,
}
integer ,
suspend:
{
Description: The flag that if suspend debug or not. ,
Required: False ,
}
boolean ,
}
,
highAvailabilityEnabled:
{
Description: The flag that if enable coordinator HA, uses multiple coordinator replicas with auto failover, one per each head node. Default: true. ,
Required: False ,
}
boolean ,
}
,
userPluginsSpec:
{
Description: Trino user plugins spec ,
Required: False ,
}
{
plugins:
{
Description: Trino user plugins. ,
Required: False ,
}
[
{
enabled:
{
Description: Denotes whether the plugin is active or not. ,
Required: False ,
}
boolean ,
name:
{
Description: This field maps to the sub-directory in trino plugins location, that will contain all the plugins under path. ,
Required: False ,
}
string ,
path:
{
Description: Fully qualified path to the folder containing the plugins. ,
Required: False ,
}
string ,
}
,
]
,
}
,
userTelemetrySpec:
{
Description: User telemetry ,
Required: False ,
}
{
storage:
{
Description: Trino user telemetry definition. ,
Required: False ,
}
{
hivecatalogName:
{
Description: Hive Catalog name used to mount external tables on the logs written by trino, if not specified there tables are not created. ,
Required: False ,
}
string ,
hivecatalogSchema:
{
Description: Schema of the above catalog to use, to mount query logs as external tables, if not specified tables will be mounted under schema trinologs. ,
Required: False ,
}
string ,
partitionRetentionInDays:
{
Description: Retention period for query log table partitions, this doesn't have any affect on actual data. ,
Format: int32 ,
Required: False ,
}
integer ,
path:
{
Description: Azure storage location of the blobs. ,
Required: False ,
}
string ,
}
,
}
,
worker:
{
Description: Trino worker. ,
Required: False ,
}
{
debug:
{
Description: Trino debug configuration. ,
Required: False ,
}
{
enable:
{
Description: The flag that if enable debug or not. ,
Required: False ,
}
boolean ,
port:
{
Description: The debug port. ,
Format: int32 ,
Required: False ,
}
integer ,
suspend:
{
Description: The flag that if suspend debug or not. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
llapProfile:
{
Description: LLAP cluster profile. ,
Required: False ,
}
object ,
flinkProfile:
{
Description: The Flink cluster profile. ,
Required: False ,
}
{
storage:
{
Description: The storage profile ,
Required: True ,
}
{
storageUri:
{
Description: Storage account uri which is used for savepoint and checkpoint state. ,
Required: True ,
}
string ,
storagekey:
{
Description: Storage key is only required for wasb(s) storage. ,
Required: False ,
}
string ,
}
,
numReplicas:
{
Description: The number of task managers. ,
Format: int32 ,
Required: False ,
}
integer ,
jobManager:
{
Description: Job Manager container/ process CPU and memory requirements ,
Required: True ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
historyServer:
{
Description: History Server container/ process CPU and memory requirements ,
Required: False ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
taskManager:
{
Description: Task Manager container/ process CPU and memory requirements ,
Required: True ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
catalogOptions:
{
Description: Flink cluster catalog options. ,
Required: False ,
}
{
hive:
{
Description: Hive Catalog Option for Flink cluster. ,
Required: False ,
}
{
metastoreDbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metastoreDbConnectionPasswordSecret:
{
Description: Secret reference name from secretsProfile.secrets containing password for database connection. ,
Required: False ,
}
string ,
metastoreDbConnectionURL:
{
Description: Connection string for hive metastore database. ,
Required: True ,
}
string ,
metastoreDbConnectionUserName:
{
Description: User name for database connection. ,
Required: False ,
}
string ,
}
,
}
,
deploymentMode:
{
Description: A string property that indicates the deployment mode of Flink cluster. It can have one of the following enum values => Application, Session. Default value is Session ,
Enum:
{
Application: No description available. ,
Session: No description available. ,
}
,
Required: False ,
}
enum ,
jobSpec:
{
Description: 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. ,
Required: False ,
}
{
jobJarDirectory:
{
Description: A string property that specifies the directory where the job JAR is located. ,
Required: True ,
}
string ,
jarName:
{
Description: A string property that represents the name of the job JAR. ,
Required: True ,
}
string ,
entryClass:
{
Description: A string property that specifies the entry class for the Flink job. If not specified, the entry point is auto-detected from the flink job jar package. ,
Required: False ,
}
string ,
args:
{
Description: A string property representing additional JVM arguments for the Flink job. It should be space separated value. ,
Required: False ,
}
string ,
savePointName:
{
Description: A string property that represents the name of the savepoint for the Flink job ,
Required: False ,
}
string ,
upgradeMode:
{
Description: A string property that indicates the upgrade mode to be performed on the Flink job. It can have one of the following enum values => STATELESS_UPDATE, UPDATE, LAST_STATE_UPDATE. ,
Enum:
{
STATELESS_UPDATE: No description available. ,
UPDATE: No description available. ,
LAST_STATE_UPDATE: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
sparkProfile:
{
Description: The spark cluster profile. ,
Required: False ,
}
{
defaultStorageUrl:
{
Description: The default storage URL. ,
Required: False ,
}
string ,
metastoreSpec:
{
Description: The metastore specification for Spark cluster. ,
Required: False ,
}
{
dbServerHost:
{
Description: The database server host. ,
Required: True ,
}
string ,
dbName:
{
Description: The database name. ,
Required: True ,
}
string ,
dbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
dbUserName:
{
Description: The database user name. ,
Required: False ,
}
string ,
dbPasswordSecretName:
{
Description: The secret name which contains the database user password. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: The key vault resource id. ,
Required: False ,
}
string ,
thriftUrl:
{
Description: The thrift url. ,
Required: False ,
}
string ,
}
,
userPluginsSpec:
{
Description: Spark user plugins spec ,
Required: False ,
}
{
plugins:
{
Description: Spark user plugins. ,
Required: False ,
}
[
{
path:
{
Description: Fully qualified path to the folder containing the plugins. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
rangerProfile:
{
Description: The ranger cluster profile. ,
Required: False ,
}
{
rangerAdmin:
{
Description: Specification for the Ranger Admin service. ,
Required: True ,
}
{
admins:
{
Description: List of usernames that should be marked as ranger admins. These usernames should match the user principal name (UPN) of the respective AAD users. ,
Required: True ,
}
[
string ,
]
,
database:
{
Required: True ,
}
{
host:
{
Description: The database URL ,
Required: True ,
}
string ,
name:
{
Description: The database name ,
Required: True ,
}
string ,
passwordSecretRef:
{
Description: Reference for the database password ,
Required: False ,
}
string ,
username:
{
Description: The name of the database user ,
Required: False ,
}
string ,
}
,
}
,
rangerAudit:
{
Description: Properties required to describe audit log storage. ,
Required: False ,
}
{
storageAccount:
{
Description: Azure storage location of the blobs. MSI should have read/write access to this Storage account. ,
Required: False ,
}
string ,
}
,
rangerUsersync:
{
Description: Specification for the Ranger Usersync service ,
Required: True ,
}
{
enabled:
{
Description: Denotes whether usersync service should be enabled ,
Required: False ,
}
boolean ,
groups:
{
Description: List of groups that should be synced. These group names should match the object id of the respective AAD groups. ,
Required: False ,
}
[
string ,
]
,
mode:
{
Description: User & groups can be synced automatically or via a static list that's refreshed. ,
Enum:
{
static: No description available. ,
automatic: No description available. ,
}
,
Required: False ,
}
enum ,
userMappingLocation:
{
Description: Azure storage location of a mapping file that lists user & group associations. ,
Required: False ,
}
string ,
users:
{
Description: List of user names that should be synced. These usernames should match the User principal name of the respective AAD users. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
stubProfile:
{
Description: Stub cluster profile. ,
Required: False ,
}
object ,
scriptActionProfiles:
{
Description: The script action profile list. ,
Required: False ,
}
[
{
type:
{
Description: Type of the script action. Supported type is bash scripts. ,
Required: True ,
}
string ,
name:
{
Description: Script name. ,
Required: True ,
}
string ,
url:
{
Description: Url of the script file. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters for the script action. It should be space-separated list of arguments required for script execution. ,
Required: False ,
}
string ,
services:
{
Description: List of services to apply the script action. ,
Required: True ,
}
[
string ,
]
,
timeoutInMinutes:
{
Description: Timeout duration for the script action in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
shouldPersist:
{
Description: Specify if the script should persist on the cluster. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
status:
{
Description: Business status of the resource. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: SystemData of cluster. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the properties. Define cluster specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
clusterType:
{
Description: The type of cluster. ,
Required: True ,
}
string ,
deploymentId:
{
Description: A unique id generated by the RP to identify the resource. ,
Required: False ,
}
string ,
computeProfile:
{
Description: The compute profile. ,
Required: True ,
}
{
nodes:
{
Description: The nodes definitions. ,
Required: True ,
}
[
{
type:
{
Description: The node type. ,
Required: True ,
}
string ,
vmSize:
{
Description: The virtual machine SKU. ,
Required: True ,
}
string ,
count:
{
Description: The number of virtual machines. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
clusterProfile:
{
Description: Cluster profile. ,
Required: True ,
}
{
clusterVersion:
{
Description: Version with 3/4 part. ,
Required: True ,
}
string ,
ossVersion:
{
Description: Version with three part. ,
Required: True ,
}
string ,
components:
{
Description: Component list of this cluster type and version. ,
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
version:
{
Required: False ,
}
string ,
}
,
]
,
identityProfile:
{
Description: This property is required by Trino, Spark and Flink cluster but is optional for Kafka cluster. ,
Required: False ,
}
{
msiResourceId:
{
Description: ResourceId of the MSI. ,
Format: arm-id ,
Required: True ,
}
string ,
msiClientId:
{
Description: ClientId of the MSI. ,
Required: True ,
}
string ,
msiObjectId:
{
Description: ObjectId of the MSI. ,
Required: True ,
}
string ,
}
,
authorizationProfile:
{
Description: Authorization profile with details of AAD user Ids and group Ids authorized for data plane access. ,
Required: True ,
}
{
userIds:
{
Description: AAD user Ids authorized for data plane access. ,
Required: False ,
}
[
string ,
]
,
groupIds:
{
Description: AAD group Ids authorized for data plane access. ,
Required: False ,
}
[
string ,
]
,
}
,
secretsProfile:
{
Description: The cluster secret profile. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: Name of the user Key Vault where all the cluster specific user secrets are stored. ,
Format: arm-id ,
Required: True ,
}
string ,
secrets:
{
Description: Properties of Key Vault secret. ,
Required: False ,
}
[
{
referenceName:
{
Description: Reference name of the secret to be used in service configs. ,
Required: True ,
}
string ,
type:
{
Description: Type of key vault object: secret, key or certificate. ,
Enum:
{
Key: No description available. ,
Secret: No description available. ,
Certificate: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: Version of the secret in key vault. ,
Required: False ,
}
string ,
keyVaultObjectName:
{
Description: Object identifier name of the secret in key vault. ,
Required: True ,
}
string ,
}
,
]
,
}
,
serviceConfigsProfiles:
{
Description: The service configs profiles. ,
Required: False ,
}
[
{
serviceName:
{
Description: Name of the service the configurations should apply to. ,
Required: True ,
}
string ,
configs:
{
Description: List of service configs. ,
Required: True ,
}
[
{
component:
{
Description: Name of the component the config files should apply to. ,
Required: True ,
}
string ,
files:
{
Description: List of Config Files. ,
Required: True ,
}
[
{
fileName:
{
Description: Configuration file name. ,
Required: True ,
}
string ,
content:
{
Description: Free form content of the entire configuration file. ,
Required: False ,
}
string ,
encoding:
{
Description: This property indicates if the content is encoded and is case-insensitive. Please set the value to base64 if the content is base64 encoded. Set it to none or skip it if the content is plain text. ,
Enum:
{
Base64: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
path:
{
Description: Path of the config file if content is specified. ,
Required: False ,
}
string ,
values:
{
Description: List of key value pairs where key represents a valid service configuration name and value represents the value of the config. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
]
,
connectivityProfile:
{
Description: Cluster connectivity profile. ,
Required: False ,
}
{
web:
{
Description: Web connectivity endpoint details. ,
Required: True ,
}
string ,
ssh:
{
Description: List of SSH connectivity endpoints. ,
Required: False ,
}
[
{
endpoint:
{
Description: SSH connectivity endpoint. ,
Required: True ,
}
string ,
privateSshEndpoint:
{
Description: Private SSH connectivity endpoint. This property will only be returned when enableInternalIngress is true. ,
Required: False ,
}
string ,
}
,
]
,
}
,
clusterAccessProfile:
{
Description: Cluster access profile. ,
Required: False ,
}
{
enableInternalIngress:
{
Description: Whether to create cluster using private IP instead of public IP. This property must be set at create time. ,
Required: True ,
}
boolean ,
privateLinkServiceId:
{
Description: Private link service resource ID. Only when enableInternalIngress is true, this property will be returned. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
logAnalyticsProfile:
{
Description: Cluster log analytics profile to enable or disable OMS agent for cluster. ,
Required: False ,
}
{
enabled:
{
Description: True if log analytics is enabled for the cluster, otherwise false. ,
Required: True ,
}
boolean ,
applicationLogs:
{
Description: Collection of logs to be enabled or disabled for log analytics. ,
Required: False ,
}
{
stdOutEnabled:
{
Description: True if stdout is enabled, otherwise false. ,
Required: False ,
}
boolean ,
stdErrorEnabled:
{
Description: True if stderror is enabled, otherwise false. ,
Required: False ,
}
boolean ,
}
,
metricsEnabled:
{
Description: True if metrics are enabled, otherwise false. ,
Required: False ,
}
boolean ,
}
,
prometheusProfile:
{
Description: Cluster Prometheus profile. ,
Required: False ,
}
{
enabled:
{
Description: Enable Prometheus for cluster or not. ,
Required: True ,
}
boolean ,
}
,
sshProfile:
{
Description: Ssh profile for the cluster. ,
Required: False ,
}
{
count:
{
Description: Number of ssh pods per cluster. ,
Format: int32 ,
Required: True ,
}
integer ,
podPrefix:
{
Description: Prefix of the pod names. Pod number will be appended to the prefix. The ingress URLs for the pods will be available at //- ,
Required: False ,
}
string ,
}
,
autoscaleProfile:
{
Description: This is the Autoscale profile for the cluster. This will allow customer to create cluster enabled with Autoscale. ,
Required: False ,
}
{
enabled:
{
Description: This indicates whether auto scale is enabled on HDInsight on AKS cluster. ,
Required: True ,
}
boolean ,
gracefulDecommissionTimeout:
{
Description: This property is for graceful decommission timeout; It has a default setting of 3600 seconds before forced shutdown takes place. This is the maximal time to wait for running containers and applications to complete before transition a DECOMMISSIONING node into DECOMMISSIONED. The default value is 3600 seconds. Negative value (like -1) is handled as infinite timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
autoscaleType:
{
Description: User to specify which type of Autoscale to be implemented - Scheduled Based or Load Based. ,
Enum:
{
ScheduleBased: No description available. ,
LoadBased: No description available. ,
}
,
Required: False ,
}
enum ,
scheduleBasedConfig:
{
Description: Profiles of schedule based Autoscale. ,
Required: False ,
}
{
timeZone:
{
Description: User has to specify the timezone on which the schedule has to be set for schedule based autoscale configuration. ,
Required: True ,
}
string ,
defaultCount:
{
Description: Setting default node count of current schedule configuration. Default node count specifies the number of nodes which are default when an specified scaling operation is executed (scale up/scale down) ,
Format: int32 ,
Required: True ,
}
integer ,
schedules:
{
Description: This specifies the schedules where scheduled based Autoscale to be enabled, the user has a choice to set multiple rules within the schedule across days and times (start/end). ,
Required: True ,
}
[
{
startTime:
{
Description: User has to set the start time of current schedule configuration, format like 10:30 (HH:MM). ,
Required: True ,
}
string ,
endTime:
{
Description: User has to set the end time of current schedule configuration, format like 10:30 (HH:MM). ,
Required: True ,
}
string ,
count:
{
Description: User has to set the node count anticipated at end of the scaling operation of the set current schedule configuration, format is integer. ,
Format: int32 ,
Required: True ,
}
integer ,
days:
{
Description: User has to set the days where schedule has to be set for autoscale operation. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
loadBasedConfig:
{
Description: Profiles of load based Autoscale. ,
Required: False ,
}
{
minNodes:
{
Description: User needs to set the minimum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. ,
Format: int32 ,
Required: True ,
}
integer ,
maxNodes:
{
Description: User needs to set the maximum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. ,
Format: int32 ,
Required: True ,
}
integer ,
pollInterval:
{
Description: User can specify the poll interval, this is the time period (in seconds) after which scaling metrics are polled for triggering a scaling operation. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: This is a cool down period, this is a time period in seconds, which determines the amount of time that must elapse between a scaling activity started by a rule and the start of the next scaling activity, regardless of the rule that triggers it. The default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
scalingRules:
{
Description: The scaling rules. ,
Required: True ,
}
[
{
actionType:
{
Description: The action type. ,
Enum:
{
scaleup: No description available. ,
scaledown: No description available. ,
}
,
Required: True ,
}
enum ,
evaluationCount:
{
Description: This is an evaluation count for a scaling condition, the number of times a trigger condition should be successful, before scaling activity is triggered. ,
Format: int32 ,
Required: True ,
}
integer ,
scalingMetric:
{
Description: Metrics name for individual workloads. For example: cpu ,
Required: True ,
}
string ,
comparisonRule:
{
Description: The comparison rule. ,
Required: True ,
}
{
operator:
{
Description: The comparison operator. ,
Enum:
{
greaterThan: No description available. ,
greaterThanOrEqual: No description available. ,
lessThan: No description available. ,
lessThanOrEqual: No description available. ,
}
,
Required: True ,
}
enum ,
threshold:
{
Description: Threshold setting. ,
Required: True ,
}
number ,
}
,
}
,
]
,
}
,
}
,
rangerPluginProfile:
{
Description: Cluster Ranger plugin profile. ,
Required: False ,
}
{
enabled:
{
Description: Enable Ranger for cluster or not. ,
Required: True ,
}
boolean ,
}
,
kafkaProfile:
{
Description: The Kafka cluster profile. ,
Required: False ,
}
{
enableKRaft:
{
Description: Expose Kafka cluster in KRaft mode. ,
Required: False ,
}
boolean ,
enablePublicEndpoints:
{
Description: Expose worker nodes as public endpoints. ,
Required: False ,
}
boolean ,
remoteStorageUri:
{
Description: Fully qualified path of Azure Storage container used for Tiered Storage. ,
Required: False ,
}
string ,
diskStorage:
{
Description: Kafka disk storage profile. ,
Required: True ,
}
{
dataDiskSize:
{
Description: Managed Disk size in GB. The maximum supported disk size for Standard and Premium HDD/SSD is 32TB, except for Premium SSD v2, which supports up to 64TB. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskType:
{
Description: Managed Disk Type. ,
Enum:
{
Standard_HDD_LRS: No description available. ,
Standard_SSD_LRS: No description available. ,
Standard_SSD_ZRS: No description available. ,
Premium_SSD_LRS: No description available. ,
Premium_SSD_ZRS: No description available. ,
Premium_SSD_v2_LRS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
clusterIdentity:
{
Description: Identity of the internal service components inside the Kafka cluster. ,
Required: False ,
}
{
msiResourceId:
{
Description: ResourceId of the MSI. ,
Format: arm-id ,
Required: True ,
}
string ,
msiClientId:
{
Description: ClientId of the MSI. ,
Required: True ,
}
string ,
msiObjectId:
{
Description: ObjectId of the MSI. ,
Required: True ,
}
string ,
}
,
connectivityEndpoints:
{
Description: Kafka bootstrap server and brokers related connectivity endpoints. ,
Required: False ,
}
{
bootstrapServerEndpoint:
{
Description: bootstrap server connectivity endpoint. ,
Required: False ,
}
string ,
brokerEndpoints:
{
Description: Kafka broker endpoint list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
trinoProfile:
{
Description: Trino Cluster profile. ,
Required: False ,
}
{
catalogOptions:
{
Description: Trino cluster catalog options. ,
Required: False ,
}
{
hive:
{
Description: hive catalog options. ,
Required: False ,
}
[
{
catalogName:
{
Description: Name of trino catalog which should use specified hive metastore. ,
Required: True ,
}
string ,
metastoreDbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metastoreDbConnectionPasswordSecret:
{
Description: Secret reference name from secretsProfile.secrets containing password for database connection. ,
Required: False ,
}
string ,
metastoreDbConnectionURL:
{
Description: Connection string for hive metastore database. ,
Required: True ,
}
string ,
metastoreDbConnectionUserName:
{
Description: User name for database connection. ,
Required: False ,
}
string ,
metastoreWarehouseDir:
{
Description: Metastore root directory URI, format: abfs[s]://@.dfs.core.windows.net/. More details: https://docs.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction-abfs-uri ,
Required: True ,
}
string ,
}
,
]
,
}
,
coordinator:
{
Description: Trino Coordinator. ,
Required: False ,
}
{
debug:
{
Description: Trino debug configuration. ,
Required: False ,
}
{
enable:
{
Description: The flag that if enable debug or not. ,
Required: False ,
}
boolean ,
port:
{
Description: The debug port. ,
Format: int32 ,
Required: False ,
}
integer ,
suspend:
{
Description: The flag that if suspend debug or not. ,
Required: False ,
}
boolean ,
}
,
highAvailabilityEnabled:
{
Description: The flag that if enable coordinator HA, uses multiple coordinator replicas with auto failover, one per each head node. Default: true. ,
Required: False ,
}
boolean ,
}
,
userPluginsSpec:
{
Description: Trino user plugins spec ,
Required: False ,
}
{
plugins:
{
Description: Trino user plugins. ,
Required: False ,
}
[
{
enabled:
{
Description: Denotes whether the plugin is active or not. ,
Required: False ,
}
boolean ,
name:
{
Description: This field maps to the sub-directory in trino plugins location, that will contain all the plugins under path. ,
Required: False ,
}
string ,
path:
{
Description: Fully qualified path to the folder containing the plugins. ,
Required: False ,
}
string ,
}
,
]
,
}
,
userTelemetrySpec:
{
Description: User telemetry ,
Required: False ,
}
{
storage:
{
Description: Trino user telemetry definition. ,
Required: False ,
}
{
hivecatalogName:
{
Description: Hive Catalog name used to mount external tables on the logs written by trino, if not specified there tables are not created. ,
Required: False ,
}
string ,
hivecatalogSchema:
{
Description: Schema of the above catalog to use, to mount query logs as external tables, if not specified tables will be mounted under schema trinologs. ,
Required: False ,
}
string ,
partitionRetentionInDays:
{
Description: Retention period for query log table partitions, this doesn't have any affect on actual data. ,
Format: int32 ,
Required: False ,
}
integer ,
path:
{
Description: Azure storage location of the blobs. ,
Required: False ,
}
string ,
}
,
}
,
worker:
{
Description: Trino worker. ,
Required: False ,
}
{
debug:
{
Description: Trino debug configuration. ,
Required: False ,
}
{
enable:
{
Description: The flag that if enable debug or not. ,
Required: False ,
}
boolean ,
port:
{
Description: The debug port. ,
Format: int32 ,
Required: False ,
}
integer ,
suspend:
{
Description: The flag that if suspend debug or not. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
llapProfile:
{
Description: LLAP cluster profile. ,
Required: False ,
}
object ,
flinkProfile:
{
Description: The Flink cluster profile. ,
Required: False ,
}
{
storage:
{
Description: The storage profile ,
Required: True ,
}
{
storageUri:
{
Description: Storage account uri which is used for savepoint and checkpoint state. ,
Required: True ,
}
string ,
storagekey:
{
Description: Storage key is only required for wasb(s) storage. ,
Required: False ,
}
string ,
}
,
numReplicas:
{
Description: The number of task managers. ,
Format: int32 ,
Required: False ,
}
integer ,
jobManager:
{
Description: Job Manager container/ process CPU and memory requirements ,
Required: True ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
historyServer:
{
Description: History Server container/ process CPU and memory requirements ,
Required: False ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
taskManager:
{
Description: Task Manager container/ process CPU and memory requirements ,
Required: True ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
catalogOptions:
{
Description: Flink cluster catalog options. ,
Required: False ,
}
{
hive:
{
Description: Hive Catalog Option for Flink cluster. ,
Required: False ,
}
{
metastoreDbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metastoreDbConnectionPasswordSecret:
{
Description: Secret reference name from secretsProfile.secrets containing password for database connection. ,
Required: False ,
}
string ,
metastoreDbConnectionURL:
{
Description: Connection string for hive metastore database. ,
Required: True ,
}
string ,
metastoreDbConnectionUserName:
{
Description: User name for database connection. ,
Required: False ,
}
string ,
}
,
}
,
deploymentMode:
{
Description: A string property that indicates the deployment mode of Flink cluster. It can have one of the following enum values => Application, Session. Default value is Session ,
Enum:
{
Application: No description available. ,
Session: No description available. ,
}
,
Required: False ,
}
enum ,
jobSpec:
{
Description: 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. ,
Required: False ,
}
{
jobJarDirectory:
{
Description: A string property that specifies the directory where the job JAR is located. ,
Required: True ,
}
string ,
jarName:
{
Description: A string property that represents the name of the job JAR. ,
Required: True ,
}
string ,
entryClass:
{
Description: A string property that specifies the entry class for the Flink job. If not specified, the entry point is auto-detected from the flink job jar package. ,
Required: False ,
}
string ,
args:
{
Description: A string property representing additional JVM arguments for the Flink job. It should be space separated value. ,
Required: False ,
}
string ,
savePointName:
{
Description: A string property that represents the name of the savepoint for the Flink job ,
Required: False ,
}
string ,
upgradeMode:
{
Description: A string property that indicates the upgrade mode to be performed on the Flink job. It can have one of the following enum values => STATELESS_UPDATE, UPDATE, LAST_STATE_UPDATE. ,
Enum:
{
STATELESS_UPDATE: No description available. ,
UPDATE: No description available. ,
LAST_STATE_UPDATE: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
sparkProfile:
{
Description: The spark cluster profile. ,
Required: False ,
}
{
defaultStorageUrl:
{
Description: The default storage URL. ,
Required: False ,
}
string ,
metastoreSpec:
{
Description: The metastore specification for Spark cluster. ,
Required: False ,
}
{
dbServerHost:
{
Description: The database server host. ,
Required: True ,
}
string ,
dbName:
{
Description: The database name. ,
Required: True ,
}
string ,
dbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
dbUserName:
{
Description: The database user name. ,
Required: False ,
}
string ,
dbPasswordSecretName:
{
Description: The secret name which contains the database user password. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: The key vault resource id. ,
Required: False ,
}
string ,
thriftUrl:
{
Description: The thrift url. ,
Required: False ,
}
string ,
}
,
userPluginsSpec:
{
Description: Spark user plugins spec ,
Required: False ,
}
{
plugins:
{
Description: Spark user plugins. ,
Required: False ,
}
[
{
path:
{
Description: Fully qualified path to the folder containing the plugins. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
rangerProfile:
{
Description: The ranger cluster profile. ,
Required: False ,
}
{
rangerAdmin:
{
Description: Specification for the Ranger Admin service. ,
Required: True ,
}
{
admins:
{
Description: List of usernames that should be marked as ranger admins. These usernames should match the user principal name (UPN) of the respective AAD users. ,
Required: True ,
}
[
string ,
]
,
database:
{
Required: True ,
}
{
host:
{
Description: The database URL ,
Required: True ,
}
string ,
name:
{
Description: The database name ,
Required: True ,
}
string ,
passwordSecretRef:
{
Description: Reference for the database password ,
Required: False ,
}
string ,
username:
{
Description: The name of the database user ,
Required: False ,
}
string ,
}
,
}
,
rangerAudit:
{
Description: Properties required to describe audit log storage. ,
Required: False ,
}
{
storageAccount:
{
Description: Azure storage location of the blobs. MSI should have read/write access to this Storage account. ,
Required: False ,
}
string ,
}
,
rangerUsersync:
{
Description: Specification for the Ranger Usersync service ,
Required: True ,
}
{
enabled:
{
Description: Denotes whether usersync service should be enabled ,
Required: False ,
}
boolean ,
groups:
{
Description: List of groups that should be synced. These group names should match the object id of the respective AAD groups. ,
Required: False ,
}
[
string ,
]
,
mode:
{
Description: User & groups can be synced automatically or via a static list that's refreshed. ,
Enum:
{
static: No description available. ,
automatic: No description available. ,
}
,
Required: False ,
}
enum ,
userMappingLocation:
{
Description: Azure storage location of a mapping file that lists user & group associations. ,
Required: False ,
}
string ,
users:
{
Description: List of user names that should be synced. These usernames should match the User principal name of the respective AAD users. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
stubProfile:
{
Description: Stub cluster profile. ,
Required: False ,
}
object ,
scriptActionProfiles:
{
Description: The script action profile list. ,
Required: False ,
}
[
{
type:
{
Description: Type of the script action. Supported type is bash scripts. ,
Required: True ,
}
string ,
name:
{
Description: Script name. ,
Required: True ,
}
string ,
url:
{
Description: Url of the script file. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters for the script action. It should be space-separated list of arguments required for script execution. ,
Required: False ,
}
string ,
services:
{
Description: List of services to apply the script action. ,
Required: True ,
}
[
string ,
]
,
timeoutInMinutes:
{
Description: Timeout duration for the script action in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
shouldPersist:
{
Description: Specify if the script should persist on the cluster. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
status:
{
Description: Business status of the resource. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: SystemData of cluster. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties. Define cluster specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
clusterType:
{
Description: The type of cluster. ,
Required: True ,
}
string ,
deploymentId:
{
Description: A unique id generated by the RP to identify the resource. ,
Required: False ,
}
string ,
computeProfile:
{
Description: The compute profile. ,
Required: True ,
}
{
nodes:
{
Description: The nodes definitions. ,
Required: True ,
}
[
{
type:
{
Description: The node type. ,
Required: True ,
}
string ,
vmSize:
{
Description: The virtual machine SKU. ,
Required: True ,
}
string ,
count:
{
Description: The number of virtual machines. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
clusterProfile:
{
Description: Cluster profile. ,
Required: True ,
}
{
clusterVersion:
{
Description: Version with 3/4 part. ,
Required: True ,
}
string ,
ossVersion:
{
Description: Version with three part. ,
Required: True ,
}
string ,
components:
{
Description: Component list of this cluster type and version. ,
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
version:
{
Required: False ,
}
string ,
}
,
]
,
identityProfile:
{
Description: This property is required by Trino, Spark and Flink cluster but is optional for Kafka cluster. ,
Required: False ,
}
{
msiResourceId:
{
Description: ResourceId of the MSI. ,
Format: arm-id ,
Required: True ,
}
string ,
msiClientId:
{
Description: ClientId of the MSI. ,
Required: True ,
}
string ,
msiObjectId:
{
Description: ObjectId of the MSI. ,
Required: True ,
}
string ,
}
,
authorizationProfile:
{
Description: Authorization profile with details of AAD user Ids and group Ids authorized for data plane access. ,
Required: True ,
}
{
userIds:
{
Description: AAD user Ids authorized for data plane access. ,
Required: False ,
}
[
string ,
]
,
groupIds:
{
Description: AAD group Ids authorized for data plane access. ,
Required: False ,
}
[
string ,
]
,
}
,
secretsProfile:
{
Description: The cluster secret profile. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: Name of the user Key Vault where all the cluster specific user secrets are stored. ,
Format: arm-id ,
Required: True ,
}
string ,
secrets:
{
Description: Properties of Key Vault secret. ,
Required: False ,
}
[
{
referenceName:
{
Description: Reference name of the secret to be used in service configs. ,
Required: True ,
}
string ,
type:
{
Description: Type of key vault object: secret, key or certificate. ,
Enum:
{
Key: No description available. ,
Secret: No description available. ,
Certificate: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: Version of the secret in key vault. ,
Required: False ,
}
string ,
keyVaultObjectName:
{
Description: Object identifier name of the secret in key vault. ,
Required: True ,
}
string ,
}
,
]
,
}
,
serviceConfigsProfiles:
{
Description: The service configs profiles. ,
Required: False ,
}
[
{
serviceName:
{
Description: Name of the service the configurations should apply to. ,
Required: True ,
}
string ,
configs:
{
Description: List of service configs. ,
Required: True ,
}
[
{
component:
{
Description: Name of the component the config files should apply to. ,
Required: True ,
}
string ,
files:
{
Description: List of Config Files. ,
Required: True ,
}
[
{
fileName:
{
Description: Configuration file name. ,
Required: True ,
}
string ,
content:
{
Description: Free form content of the entire configuration file. ,
Required: False ,
}
string ,
encoding:
{
Description: This property indicates if the content is encoded and is case-insensitive. Please set the value to base64 if the content is base64 encoded. Set it to none or skip it if the content is plain text. ,
Enum:
{
Base64: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
path:
{
Description: Path of the config file if content is specified. ,
Required: False ,
}
string ,
values:
{
Description: List of key value pairs where key represents a valid service configuration name and value represents the value of the config. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
]
,
connectivityProfile:
{
Description: Cluster connectivity profile. ,
Required: False ,
}
{
web:
{
Description: Web connectivity endpoint details. ,
Required: True ,
}
string ,
ssh:
{
Description: List of SSH connectivity endpoints. ,
Required: False ,
}
[
{
endpoint:
{
Description: SSH connectivity endpoint. ,
Required: True ,
}
string ,
privateSshEndpoint:
{
Description: Private SSH connectivity endpoint. This property will only be returned when enableInternalIngress is true. ,
Required: False ,
}
string ,
}
,
]
,
}
,
clusterAccessProfile:
{
Description: Cluster access profile. ,
Required: False ,
}
{
enableInternalIngress:
{
Description: Whether to create cluster using private IP instead of public IP. This property must be set at create time. ,
Required: True ,
}
boolean ,
privateLinkServiceId:
{
Description: Private link service resource ID. Only when enableInternalIngress is true, this property will be returned. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
logAnalyticsProfile:
{
Description: Cluster log analytics profile to enable or disable OMS agent for cluster. ,
Required: False ,
}
{
enabled:
{
Description: True if log analytics is enabled for the cluster, otherwise false. ,
Required: True ,
}
boolean ,
applicationLogs:
{
Description: Collection of logs to be enabled or disabled for log analytics. ,
Required: False ,
}
{
stdOutEnabled:
{
Description: True if stdout is enabled, otherwise false. ,
Required: False ,
}
boolean ,
stdErrorEnabled:
{
Description: True if stderror is enabled, otherwise false. ,
Required: False ,
}
boolean ,
}
,
metricsEnabled:
{
Description: True if metrics are enabled, otherwise false. ,
Required: False ,
}
boolean ,
}
,
prometheusProfile:
{
Description: Cluster Prometheus profile. ,
Required: False ,
}
{
enabled:
{
Description: Enable Prometheus for cluster or not. ,
Required: True ,
}
boolean ,
}
,
sshProfile:
{
Description: Ssh profile for the cluster. ,
Required: False ,
}
{
count:
{
Description: Number of ssh pods per cluster. ,
Format: int32 ,
Required: True ,
}
integer ,
podPrefix:
{
Description: Prefix of the pod names. Pod number will be appended to the prefix. The ingress URLs for the pods will be available at //- ,
Required: False ,
}
string ,
}
,
autoscaleProfile:
{
Description: This is the Autoscale profile for the cluster. This will allow customer to create cluster enabled with Autoscale. ,
Required: False ,
}
{
enabled:
{
Description: This indicates whether auto scale is enabled on HDInsight on AKS cluster. ,
Required: True ,
}
boolean ,
gracefulDecommissionTimeout:
{
Description: This property is for graceful decommission timeout; It has a default setting of 3600 seconds before forced shutdown takes place. This is the maximal time to wait for running containers and applications to complete before transition a DECOMMISSIONING node into DECOMMISSIONED. The default value is 3600 seconds. Negative value (like -1) is handled as infinite timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
autoscaleType:
{
Description: User to specify which type of Autoscale to be implemented - Scheduled Based or Load Based. ,
Enum:
{
ScheduleBased: No description available. ,
LoadBased: No description available. ,
}
,
Required: False ,
}
enum ,
scheduleBasedConfig:
{
Description: Profiles of schedule based Autoscale. ,
Required: False ,
}
{
timeZone:
{
Description: User has to specify the timezone on which the schedule has to be set for schedule based autoscale configuration. ,
Required: True ,
}
string ,
defaultCount:
{
Description: Setting default node count of current schedule configuration. Default node count specifies the number of nodes which are default when an specified scaling operation is executed (scale up/scale down) ,
Format: int32 ,
Required: True ,
}
integer ,
schedules:
{
Description: This specifies the schedules where scheduled based Autoscale to be enabled, the user has a choice to set multiple rules within the schedule across days and times (start/end). ,
Required: True ,
}
[
{
startTime:
{
Description: User has to set the start time of current schedule configuration, format like 10:30 (HH:MM). ,
Required: True ,
}
string ,
endTime:
{
Description: User has to set the end time of current schedule configuration, format like 10:30 (HH:MM). ,
Required: True ,
}
string ,
count:
{
Description: User has to set the node count anticipated at end of the scaling operation of the set current schedule configuration, format is integer. ,
Format: int32 ,
Required: True ,
}
integer ,
days:
{
Description: User has to set the days where schedule has to be set for autoscale operation. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
loadBasedConfig:
{
Description: Profiles of load based Autoscale. ,
Required: False ,
}
{
minNodes:
{
Description: User needs to set the minimum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. ,
Format: int32 ,
Required: True ,
}
integer ,
maxNodes:
{
Description: User needs to set the maximum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. ,
Format: int32 ,
Required: True ,
}
integer ,
pollInterval:
{
Description: User can specify the poll interval, this is the time period (in seconds) after which scaling metrics are polled for triggering a scaling operation. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: This is a cool down period, this is a time period in seconds, which determines the amount of time that must elapse between a scaling activity started by a rule and the start of the next scaling activity, regardless of the rule that triggers it. The default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
scalingRules:
{
Description: The scaling rules. ,
Required: True ,
}
[
{
actionType:
{
Description: The action type. ,
Enum:
{
scaleup: No description available. ,
scaledown: No description available. ,
}
,
Required: True ,
}
enum ,
evaluationCount:
{
Description: This is an evaluation count for a scaling condition, the number of times a trigger condition should be successful, before scaling activity is triggered. ,
Format: int32 ,
Required: True ,
}
integer ,
scalingMetric:
{
Description: Metrics name for individual workloads. For example: cpu ,
Required: True ,
}
string ,
comparisonRule:
{
Description: The comparison rule. ,
Required: True ,
}
{
operator:
{
Description: The comparison operator. ,
Enum:
{
greaterThan: No description available. ,
greaterThanOrEqual: No description available. ,
lessThan: No description available. ,
lessThanOrEqual: No description available. ,
}
,
Required: True ,
}
enum ,
threshold:
{
Description: Threshold setting. ,
Required: True ,
}
number ,
}
,
}
,
]
,
}
,
}
,
rangerPluginProfile:
{
Description: Cluster Ranger plugin profile. ,
Required: False ,
}
{
enabled:
{
Description: Enable Ranger for cluster or not. ,
Required: True ,
}
boolean ,
}
,
kafkaProfile:
{
Description: The Kafka cluster profile. ,
Required: False ,
}
{
enableKRaft:
{
Description: Expose Kafka cluster in KRaft mode. ,
Required: False ,
}
boolean ,
enablePublicEndpoints:
{
Description: Expose worker nodes as public endpoints. ,
Required: False ,
}
boolean ,
remoteStorageUri:
{
Description: Fully qualified path of Azure Storage container used for Tiered Storage. ,
Required: False ,
}
string ,
diskStorage:
{
Description: Kafka disk storage profile. ,
Required: True ,
}
{
dataDiskSize:
{
Description: Managed Disk size in GB. The maximum supported disk size for Standard and Premium HDD/SSD is 32TB, except for Premium SSD v2, which supports up to 64TB. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskType:
{
Description: Managed Disk Type. ,
Enum:
{
Standard_HDD_LRS: No description available. ,
Standard_SSD_LRS: No description available. ,
Standard_SSD_ZRS: No description available. ,
Premium_SSD_LRS: No description available. ,
Premium_SSD_ZRS: No description available. ,
Premium_SSD_v2_LRS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
clusterIdentity:
{
Description: Identity of the internal service components inside the Kafka cluster. ,
Required: False ,
}
{
msiResourceId:
{
Description: ResourceId of the MSI. ,
Format: arm-id ,
Required: True ,
}
string ,
msiClientId:
{
Description: ClientId of the MSI. ,
Required: True ,
}
string ,
msiObjectId:
{
Description: ObjectId of the MSI. ,
Required: True ,
}
string ,
}
,
connectivityEndpoints:
{
Description: Kafka bootstrap server and brokers related connectivity endpoints. ,
Required: False ,
}
{
bootstrapServerEndpoint:
{
Description: bootstrap server connectivity endpoint. ,
Required: False ,
}
string ,
brokerEndpoints:
{
Description: Kafka broker endpoint list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
trinoProfile:
{
Description: Trino Cluster profile. ,
Required: False ,
}
{
catalogOptions:
{
Description: Trino cluster catalog options. ,
Required: False ,
}
{
hive:
{
Description: hive catalog options. ,
Required: False ,
}
[
{
catalogName:
{
Description: Name of trino catalog which should use specified hive metastore. ,
Required: True ,
}
string ,
metastoreDbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metastoreDbConnectionPasswordSecret:
{
Description: Secret reference name from secretsProfile.secrets containing password for database connection. ,
Required: False ,
}
string ,
metastoreDbConnectionURL:
{
Description: Connection string for hive metastore database. ,
Required: True ,
}
string ,
metastoreDbConnectionUserName:
{
Description: User name for database connection. ,
Required: False ,
}
string ,
metastoreWarehouseDir:
{
Description: Metastore root directory URI, format: abfs[s]://@.dfs.core.windows.net/. More details: https://docs.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction-abfs-uri ,
Required: True ,
}
string ,
}
,
]
,
}
,
coordinator:
{
Description: Trino Coordinator. ,
Required: False ,
}
{
debug:
{
Description: Trino debug configuration. ,
Required: False ,
}
{
enable:
{
Description: The flag that if enable debug or not. ,
Required: False ,
}
boolean ,
port:
{
Description: The debug port. ,
Format: int32 ,
Required: False ,
}
integer ,
suspend:
{
Description: The flag that if suspend debug or not. ,
Required: False ,
}
boolean ,
}
,
highAvailabilityEnabled:
{
Description: The flag that if enable coordinator HA, uses multiple coordinator replicas with auto failover, one per each head node. Default: true. ,
Required: False ,
}
boolean ,
}
,
userPluginsSpec:
{
Description: Trino user plugins spec ,
Required: False ,
}
{
plugins:
{
Description: Trino user plugins. ,
Required: False ,
}
[
{
enabled:
{
Description: Denotes whether the plugin is active or not. ,
Required: False ,
}
boolean ,
name:
{
Description: This field maps to the sub-directory in trino plugins location, that will contain all the plugins under path. ,
Required: False ,
}
string ,
path:
{
Description: Fully qualified path to the folder containing the plugins. ,
Required: False ,
}
string ,
}
,
]
,
}
,
userTelemetrySpec:
{
Description: User telemetry ,
Required: False ,
}
{
storage:
{
Description: Trino user telemetry definition. ,
Required: False ,
}
{
hivecatalogName:
{
Description: Hive Catalog name used to mount external tables on the logs written by trino, if not specified there tables are not created. ,
Required: False ,
}
string ,
hivecatalogSchema:
{
Description: Schema of the above catalog to use, to mount query logs as external tables, if not specified tables will be mounted under schema trinologs. ,
Required: False ,
}
string ,
partitionRetentionInDays:
{
Description: Retention period for query log table partitions, this doesn't have any affect on actual data. ,
Format: int32 ,
Required: False ,
}
integer ,
path:
{
Description: Azure storage location of the blobs. ,
Required: False ,
}
string ,
}
,
}
,
worker:
{
Description: Trino worker. ,
Required: False ,
}
{
debug:
{
Description: Trino debug configuration. ,
Required: False ,
}
{
enable:
{
Description: The flag that if enable debug or not. ,
Required: False ,
}
boolean ,
port:
{
Description: The debug port. ,
Format: int32 ,
Required: False ,
}
integer ,
suspend:
{
Description: The flag that if suspend debug or not. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
llapProfile:
{
Description: LLAP cluster profile. ,
Required: False ,
}
object ,
flinkProfile:
{
Description: The Flink cluster profile. ,
Required: False ,
}
{
storage:
{
Description: The storage profile ,
Required: True ,
}
{
storageUri:
{
Description: Storage account uri which is used for savepoint and checkpoint state. ,
Required: True ,
}
string ,
storagekey:
{
Description: Storage key is only required for wasb(s) storage. ,
Required: False ,
}
string ,
}
,
numReplicas:
{
Description: The number of task managers. ,
Format: int32 ,
Required: False ,
}
integer ,
jobManager:
{
Description: Job Manager container/ process CPU and memory requirements ,
Required: True ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
historyServer:
{
Description: History Server container/ process CPU and memory requirements ,
Required: False ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
taskManager:
{
Description: Task Manager container/ process CPU and memory requirements ,
Required: True ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
catalogOptions:
{
Description: Flink cluster catalog options. ,
Required: False ,
}
{
hive:
{
Description: Hive Catalog Option for Flink cluster. ,
Required: False ,
}
{
metastoreDbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metastoreDbConnectionPasswordSecret:
{
Description: Secret reference name from secretsProfile.secrets containing password for database connection. ,
Required: False ,
}
string ,
metastoreDbConnectionURL:
{
Description: Connection string for hive metastore database. ,
Required: True ,
}
string ,
metastoreDbConnectionUserName:
{
Description: User name for database connection. ,
Required: False ,
}
string ,
}
,
}
,
deploymentMode:
{
Description: A string property that indicates the deployment mode of Flink cluster. It can have one of the following enum values => Application, Session. Default value is Session ,
Enum:
{
Application: No description available. ,
Session: No description available. ,
}
,
Required: False ,
}
enum ,
jobSpec:
{
Description: 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. ,
Required: False ,
}
{
jobJarDirectory:
{
Description: A string property that specifies the directory where the job JAR is located. ,
Required: True ,
}
string ,
jarName:
{
Description: A string property that represents the name of the job JAR. ,
Required: True ,
}
string ,
entryClass:
{
Description: A string property that specifies the entry class for the Flink job. If not specified, the entry point is auto-detected from the flink job jar package. ,
Required: False ,
}
string ,
args:
{
Description: A string property representing additional JVM arguments for the Flink job. It should be space separated value. ,
Required: False ,
}
string ,
savePointName:
{
Description: A string property that represents the name of the savepoint for the Flink job ,
Required: False ,
}
string ,
upgradeMode:
{
Description: A string property that indicates the upgrade mode to be performed on the Flink job. It can have one of the following enum values => STATELESS_UPDATE, UPDATE, LAST_STATE_UPDATE. ,
Enum:
{
STATELESS_UPDATE: No description available. ,
UPDATE: No description available. ,
LAST_STATE_UPDATE: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
sparkProfile:
{
Description: The spark cluster profile. ,
Required: False ,
}
{
defaultStorageUrl:
{
Description: The default storage URL. ,
Required: False ,
}
string ,
metastoreSpec:
{
Description: The metastore specification for Spark cluster. ,
Required: False ,
}
{
dbServerHost:
{
Description: The database server host. ,
Required: True ,
}
string ,
dbName:
{
Description: The database name. ,
Required: True ,
}
string ,
dbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
dbUserName:
{
Description: The database user name. ,
Required: False ,
}
string ,
dbPasswordSecretName:
{
Description: The secret name which contains the database user password. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: The key vault resource id. ,
Required: False ,
}
string ,
thriftUrl:
{
Description: The thrift url. ,
Required: False ,
}
string ,
}
,
userPluginsSpec:
{
Description: Spark user plugins spec ,
Required: False ,
}
{
plugins:
{
Description: Spark user plugins. ,
Required: False ,
}
[
{
path:
{
Description: Fully qualified path to the folder containing the plugins. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
rangerProfile:
{
Description: The ranger cluster profile. ,
Required: False ,
}
{
rangerAdmin:
{
Description: Specification for the Ranger Admin service. ,
Required: True ,
}
{
admins:
{
Description: List of usernames that should be marked as ranger admins. These usernames should match the user principal name (UPN) of the respective AAD users. ,
Required: True ,
}
[
string ,
]
,
database:
{
Required: True ,
}
{
host:
{
Description: The database URL ,
Required: True ,
}
string ,
name:
{
Description: The database name ,
Required: True ,
}
string ,
passwordSecretRef:
{
Description: Reference for the database password ,
Required: False ,
}
string ,
username:
{
Description: The name of the database user ,
Required: False ,
}
string ,
}
,
}
,
rangerAudit:
{
Description: Properties required to describe audit log storage. ,
Required: False ,
}
{
storageAccount:
{
Description: Azure storage location of the blobs. MSI should have read/write access to this Storage account. ,
Required: False ,
}
string ,
}
,
rangerUsersync:
{
Description: Specification for the Ranger Usersync service ,
Required: True ,
}
{
enabled:
{
Description: Denotes whether usersync service should be enabled ,
Required: False ,
}
boolean ,
groups:
{
Description: List of groups that should be synced. These group names should match the object id of the respective AAD groups. ,
Required: False ,
}
[
string ,
]
,
mode:
{
Description: User & groups can be synced automatically or via a static list that's refreshed. ,
Enum:
{
static: No description available. ,
automatic: No description available. ,
}
,
Required: False ,
}
enum ,
userMappingLocation:
{
Description: Azure storage location of a mapping file that lists user & group associations. ,
Required: False ,
}
string ,
users:
{
Description: List of user names that should be synced. These usernames should match the User principal name of the respective AAD users. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
stubProfile:
{
Description: Stub cluster profile. ,
Required: False ,
}
object ,
scriptActionProfiles:
{
Description: The script action profile list. ,
Required: False ,
}
[
{
type:
{
Description: Type of the script action. Supported type is bash scripts. ,
Required: True ,
}
string ,
name:
{
Description: Script name. ,
Required: True ,
}
string ,
url:
{
Description: Url of the script file. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters for the script action. It should be space-separated list of arguments required for script execution. ,
Required: False ,
}
string ,
services:
{
Description: List of services to apply the script action. ,
Required: True ,
}
[
string ,
]
,
timeoutInMinutes:
{
Description: Timeout duration for the script action in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
shouldPersist:
{
Description: Specify if the script should persist on the cluster. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
status:
{
Description: Business status of the resource. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: SystemData of cluster. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Update (removed)
Description :  Updates an existing Cluster.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
clusterPoolName:
{
Description: The name of the cluster pool. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the HDInsight cluster. ,
Required: True ,
}
string ,
ClusterPatchRequest:
{
Description: Patch a cluster. ,
Required: True ,
}
{
properties:
{
Description: Define cluster patch specific properties. ,
Required: False ,
}
{
clusterProfile:
{
Description: Cluster resource patch properties. ,
Required: False ,
}
{
serviceConfigsProfiles:
{
Description: The service configs profiles. ,
Required: False ,
}
[
{
serviceName:
{
Description: Name of the service the configurations should apply to. ,
Required: True ,
}
string ,
configs:
{
Description: List of service configs. ,
Required: True ,
}
[
{
component:
{
Description: Name of the component the config files should apply to. ,
Required: True ,
}
string ,
files:
{
Description: List of Config Files. ,
Required: True ,
}
[
{
fileName:
{
Description: Configuration file name. ,
Required: True ,
}
string ,
content:
{
Description: Free form content of the entire configuration file. ,
Required: False ,
}
string ,
encoding:
{
Description: This property indicates if the content is encoded and is case-insensitive. Please set the value to base64 if the content is base64 encoded. Set it to none or skip it if the content is plain text. ,
Enum:
{
Base64: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
path:
{
Description: Path of the config file if content is specified. ,
Required: False ,
}
string ,
values:
{
Description: List of key value pairs where key represents a valid service configuration name and value represents the value of the config. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
]
,
sshProfile:
{
Description: Ssh profile for the cluster. ,
Required: False ,
}
{
count:
{
Description: Number of ssh pods per cluster. ,
Format: int32 ,
Required: True ,
}
integer ,
podPrefix:
{
Description: Prefix of the pod names. Pod number will be appended to the prefix. The ingress URLs for the pods will be available at //- ,
Required: False ,
}
string ,
}
,
autoscaleProfile:
{
Description: This is the Autoscale profile for the cluster. This will allow customer to create cluster enabled with Autoscale. ,
Required: False ,
}
{
enabled:
{
Description: This indicates whether auto scale is enabled on HDInsight on AKS cluster. ,
Required: True ,
}
boolean ,
gracefulDecommissionTimeout:
{
Description: This property is for graceful decommission timeout; It has a default setting of 3600 seconds before forced shutdown takes place. This is the maximal time to wait for running containers and applications to complete before transition a DECOMMISSIONING node into DECOMMISSIONED. The default value is 3600 seconds. Negative value (like -1) is handled as infinite timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
autoscaleType:
{
Description: User to specify which type of Autoscale to be implemented - Scheduled Based or Load Based. ,
Enum:
{
ScheduleBased: No description available. ,
LoadBased: No description available. ,
}
,
Required: False ,
}
enum ,
scheduleBasedConfig:
{
Description: Profiles of schedule based Autoscale. ,
Required: False ,
}
{
timeZone:
{
Description: User has to specify the timezone on which the schedule has to be set for schedule based autoscale configuration. ,
Required: True ,
}
string ,
defaultCount:
{
Description: Setting default node count of current schedule configuration. Default node count specifies the number of nodes which are default when an specified scaling operation is executed (scale up/scale down) ,
Format: int32 ,
Required: True ,
}
integer ,
schedules:
{
Description: This specifies the schedules where scheduled based Autoscale to be enabled, the user has a choice to set multiple rules within the schedule across days and times (start/end). ,
Required: True ,
}
[
{
startTime:
{
Description: User has to set the start time of current schedule configuration, format like 10:30 (HH:MM). ,
Required: True ,
}
string ,
endTime:
{
Description: User has to set the end time of current schedule configuration, format like 10:30 (HH:MM). ,
Required: True ,
}
string ,
count:
{
Description: User has to set the node count anticipated at end of the scaling operation of the set current schedule configuration, format is integer. ,
Format: int32 ,
Required: True ,
}
integer ,
days:
{
Description: User has to set the days where schedule has to be set for autoscale operation. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
loadBasedConfig:
{
Description: Profiles of load based Autoscale. ,
Required: False ,
}
{
minNodes:
{
Description: User needs to set the minimum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. ,
Format: int32 ,
Required: True ,
}
integer ,
maxNodes:
{
Description: User needs to set the maximum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. ,
Format: int32 ,
Required: True ,
}
integer ,
pollInterval:
{
Description: User can specify the poll interval, this is the time period (in seconds) after which scaling metrics are polled for triggering a scaling operation. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: This is a cool down period, this is a time period in seconds, which determines the amount of time that must elapse between a scaling activity started by a rule and the start of the next scaling activity, regardless of the rule that triggers it. The default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
scalingRules:
{
Description: The scaling rules. ,
Required: True ,
}
[
{
actionType:
{
Description: The action type. ,
Enum:
{
scaleup: No description available. ,
scaledown: No description available. ,
}
,
Required: True ,
}
enum ,
evaluationCount:
{
Description: This is an evaluation count for a scaling condition, the number of times a trigger condition should be successful, before scaling activity is triggered. ,
Format: int32 ,
Required: True ,
}
integer ,
scalingMetric:
{
Description: Metrics name for individual workloads. For example: cpu ,
Required: True ,
}
string ,
comparisonRule:
{
Description: The comparison rule. ,
Required: True ,
}
{
operator:
{
Description: The comparison operator. ,
Enum:
{
greaterThan: No description available. ,
greaterThanOrEqual: No description available. ,
lessThan: No description available. ,
lessThanOrEqual: No description available. ,
}
,
Required: True ,
}
enum ,
threshold:
{
Description: Threshold setting. ,
Required: True ,
}
number ,
}
,
}
,
]
,
}
,
}
,
authorizationProfile:
{
Description: Authorization profile with details of AAD user Ids and group Ids authorized for data plane access. ,
Required: False ,
}
{
userIds:
{
Description: AAD user Ids authorized for data plane access. ,
Required: False ,
}
[
string ,
]
,
groupIds:
{
Description: AAD group Ids authorized for data plane access. ,
Required: False ,
}
[
string ,
]
,
}
,
logAnalyticsProfile:
{
Description: Cluster log analytics profile to enable or disable OMS agent for cluster. ,
Required: False ,
}
{
enabled:
{
Description: True if log analytics is enabled for the cluster, otherwise false. ,
Required: True ,
}
boolean ,
applicationLogs:
{
Description: Collection of logs to be enabled or disabled for log analytics. ,
Required: False ,
}
{
stdOutEnabled:
{
Description: True if stdout is enabled, otherwise false. ,
Required: False ,
}
boolean ,
stdErrorEnabled:
{
Description: True if stderror is enabled, otherwise false. ,
Required: False ,
}
boolean ,
}
,
metricsEnabled:
{
Description: True if metrics are enabled, otherwise false. ,
Required: False ,
}
boolean ,
}
,
prometheusProfile:
{
Description: Cluster Prometheus profile. ,
Required: False ,
}
{
enabled:
{
Description: Enable Prometheus for cluster or not. ,
Required: True ,
}
boolean ,
}
,
rangerPluginProfile:
{
Description: Cluster Ranger plugin profile. ,
Required: False ,
}
{
enabled:
{
Description: Enable Ranger for cluster or not. ,
Required: True ,
}
boolean ,
}
,
rangerProfile:
{
Description: The ranger cluster profile. ,
Required: False ,
}
{
rangerAdmin:
{
Description: Specification for the Ranger Admin service. ,
Required: True ,
}
{
admins:
{
Description: List of usernames that should be marked as ranger admins. These usernames should match the user principal name (UPN) of the respective AAD users. ,
Required: True ,
}
[
string ,
]
,
database:
{
Required: True ,
}
{
host:
{
Description: The database URL ,
Required: True ,
}
string ,
name:
{
Description: The database name ,
Required: True ,
}
string ,
passwordSecretRef:
{
Description: Reference for the database password ,
Required: False ,
}
string ,
username:
{
Description: The name of the database user ,
Required: False ,
}
string ,
}
,
}
,
rangerAudit:
{
Description: Properties required to describe audit log storage. ,
Required: False ,
}
{
storageAccount:
{
Description: Azure storage location of the blobs. MSI should have read/write access to this Storage account. ,
Required: False ,
}
string ,
}
,
rangerUsersync:
{
Description: Specification for the Ranger Usersync service ,
Required: True ,
}
{
enabled:
{
Description: Denotes whether usersync service should be enabled ,
Required: False ,
}
boolean ,
groups:
{
Description: List of groups that should be synced. These group names should match the object id of the respective AAD groups. ,
Required: False ,
}
[
string ,
]
,
mode:
{
Description: User & groups can be synced automatically or via a static list that's refreshed. ,
Enum:
{
static: No description available. ,
automatic: No description available. ,
}
,
Required: False ,
}
enum ,
userMappingLocation:
{
Description: Azure storage location of a mapping file that lists user & group associations. ,
Required: False ,
}
string ,
users:
{
Description: List of user names that should be synced. These usernames should match the User principal name of the respective AAD users. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
scriptActionProfiles:
{
Description: The script action profile list. ,
Required: False ,
}
[
{
type:
{
Description: Type of the script action. Supported type is bash scripts. ,
Required: True ,
}
string ,
name:
{
Description: Script name. ,
Required: True ,
}
string ,
url:
{
Description: Url of the script file. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters for the script action. It should be space-separated list of arguments required for script execution. ,
Required: False ,
}
string ,
services:
{
Description: List of services to apply the script action. ,
Required: True ,
}
[
string ,
]
,
timeoutInMinutes:
{
Description: Timeout duration for the script action in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
shouldPersist:
{
Description: Specify if the script should persist on the cluster. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties. Define cluster specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
clusterType:
{
Description: The type of cluster. ,
Required: True ,
}
string ,
deploymentId:
{
Description: A unique id generated by the RP to identify the resource. ,
Required: False ,
}
string ,
computeProfile:
{
Description: The compute profile. ,
Required: True ,
}
{
nodes:
{
Description: The nodes definitions. ,
Required: True ,
}
[
{
type:
{
Description: The node type. ,
Required: True ,
}
string ,
vmSize:
{
Description: The virtual machine SKU. ,
Required: True ,
}
string ,
count:
{
Description: The number of virtual machines. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
clusterProfile:
{
Description: Cluster profile. ,
Required: True ,
}
{
clusterVersion:
{
Description: Version with 3/4 part. ,
Required: True ,
}
string ,
ossVersion:
{
Description: Version with three part. ,
Required: True ,
}
string ,
components:
{
Description: Component list of this cluster type and version. ,
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
version:
{
Required: False ,
}
string ,
}
,
]
,
identityProfile:
{
Description: This property is required by Trino, Spark and Flink cluster but is optional for Kafka cluster. ,
Required: False ,
}
{
msiResourceId:
{
Description: ResourceId of the MSI. ,
Format: arm-id ,
Required: True ,
}
string ,
msiClientId:
{
Description: ClientId of the MSI. ,
Required: True ,
}
string ,
msiObjectId:
{
Description: ObjectId of the MSI. ,
Required: True ,
}
string ,
}
,
authorizationProfile:
{
Description: Authorization profile with details of AAD user Ids and group Ids authorized for data plane access. ,
Required: True ,
}
{
userIds:
{
Description: AAD user Ids authorized for data plane access. ,
Required: False ,
}
[
string ,
]
,
groupIds:
{
Description: AAD group Ids authorized for data plane access. ,
Required: False ,
}
[
string ,
]
,
}
,
secretsProfile:
{
Description: The cluster secret profile. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: Name of the user Key Vault where all the cluster specific user secrets are stored. ,
Format: arm-id ,
Required: True ,
}
string ,
secrets:
{
Description: Properties of Key Vault secret. ,
Required: False ,
}
[
{
referenceName:
{
Description: Reference name of the secret to be used in service configs. ,
Required: True ,
}
string ,
type:
{
Description: Type of key vault object: secret, key or certificate. ,
Enum:
{
Key: No description available. ,
Secret: No description available. ,
Certificate: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: Version of the secret in key vault. ,
Required: False ,
}
string ,
keyVaultObjectName:
{
Description: Object identifier name of the secret in key vault. ,
Required: True ,
}
string ,
}
,
]
,
}
,
serviceConfigsProfiles:
{
Description: The service configs profiles. ,
Required: False ,
}
[
{
serviceName:
{
Description: Name of the service the configurations should apply to. ,
Required: True ,
}
string ,
configs:
{
Description: List of service configs. ,
Required: True ,
}
[
{
component:
{
Description: Name of the component the config files should apply to. ,
Required: True ,
}
string ,
files:
{
Description: List of Config Files. ,
Required: True ,
}
[
{
fileName:
{
Description: Configuration file name. ,
Required: True ,
}
string ,
content:
{
Description: Free form content of the entire configuration file. ,
Required: False ,
}
string ,
encoding:
{
Description: This property indicates if the content is encoded and is case-insensitive. Please set the value to base64 if the content is base64 encoded. Set it to none or skip it if the content is plain text. ,
Enum:
{
Base64: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
path:
{
Description: Path of the config file if content is specified. ,
Required: False ,
}
string ,
values:
{
Description: List of key value pairs where key represents a valid service configuration name and value represents the value of the config. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
]
,
connectivityProfile:
{
Description: Cluster connectivity profile. ,
Required: False ,
}
{
web:
{
Description: Web connectivity endpoint details. ,
Required: True ,
}
string ,
ssh:
{
Description: List of SSH connectivity endpoints. ,
Required: False ,
}
[
{
endpoint:
{
Description: SSH connectivity endpoint. ,
Required: True ,
}
string ,
privateSshEndpoint:
{
Description: Private SSH connectivity endpoint. This property will only be returned when enableInternalIngress is true. ,
Required: False ,
}
string ,
}
,
]
,
}
,
clusterAccessProfile:
{
Description: Cluster access profile. ,
Required: False ,
}
{
enableInternalIngress:
{
Description: Whether to create cluster using private IP instead of public IP. This property must be set at create time. ,
Required: True ,
}
boolean ,
privateLinkServiceId:
{
Description: Private link service resource ID. Only when enableInternalIngress is true, this property will be returned. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
logAnalyticsProfile:
{
Description: Cluster log analytics profile to enable or disable OMS agent for cluster. ,
Required: False ,
}
{
enabled:
{
Description: True if log analytics is enabled for the cluster, otherwise false. ,
Required: True ,
}
boolean ,
applicationLogs:
{
Description: Collection of logs to be enabled or disabled for log analytics. ,
Required: False ,
}
{
stdOutEnabled:
{
Description: True if stdout is enabled, otherwise false. ,
Required: False ,
}
boolean ,
stdErrorEnabled:
{
Description: True if stderror is enabled, otherwise false. ,
Required: False ,
}
boolean ,
}
,
metricsEnabled:
{
Description: True if metrics are enabled, otherwise false. ,
Required: False ,
}
boolean ,
}
,
prometheusProfile:
{
Description: Cluster Prometheus profile. ,
Required: False ,
}
{
enabled:
{
Description: Enable Prometheus for cluster or not. ,
Required: True ,
}
boolean ,
}
,
sshProfile:
{
Description: Ssh profile for the cluster. ,
Required: False ,
}
{
count:
{
Description: Number of ssh pods per cluster. ,
Format: int32 ,
Required: True ,
}
integer ,
podPrefix:
{
Description: Prefix of the pod names. Pod number will be appended to the prefix. The ingress URLs for the pods will be available at //- ,
Required: False ,
}
string ,
}
,
autoscaleProfile:
{
Description: This is the Autoscale profile for the cluster. This will allow customer to create cluster enabled with Autoscale. ,
Required: False ,
}
{
enabled:
{
Description: This indicates whether auto scale is enabled on HDInsight on AKS cluster. ,
Required: True ,
}
boolean ,
gracefulDecommissionTimeout:
{
Description: This property is for graceful decommission timeout; It has a default setting of 3600 seconds before forced shutdown takes place. This is the maximal time to wait for running containers and applications to complete before transition a DECOMMISSIONING node into DECOMMISSIONED. The default value is 3600 seconds. Negative value (like -1) is handled as infinite timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
autoscaleType:
{
Description: User to specify which type of Autoscale to be implemented - Scheduled Based or Load Based. ,
Enum:
{
ScheduleBased: No description available. ,
LoadBased: No description available. ,
}
,
Required: False ,
}
enum ,
scheduleBasedConfig:
{
Description: Profiles of schedule based Autoscale. ,
Required: False ,
}
{
timeZone:
{
Description: User has to specify the timezone on which the schedule has to be set for schedule based autoscale configuration. ,
Required: True ,
}
string ,
defaultCount:
{
Description: Setting default node count of current schedule configuration. Default node count specifies the number of nodes which are default when an specified scaling operation is executed (scale up/scale down) ,
Format: int32 ,
Required: True ,
}
integer ,
schedules:
{
Description: This specifies the schedules where scheduled based Autoscale to be enabled, the user has a choice to set multiple rules within the schedule across days and times (start/end). ,
Required: True ,
}
[
{
startTime:
{
Description: User has to set the start time of current schedule configuration, format like 10:30 (HH:MM). ,
Required: True ,
}
string ,
endTime:
{
Description: User has to set the end time of current schedule configuration, format like 10:30 (HH:MM). ,
Required: True ,
}
string ,
count:
{
Description: User has to set the node count anticipated at end of the scaling operation of the set current schedule configuration, format is integer. ,
Format: int32 ,
Required: True ,
}
integer ,
days:
{
Description: User has to set the days where schedule has to be set for autoscale operation. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
loadBasedConfig:
{
Description: Profiles of load based Autoscale. ,
Required: False ,
}
{
minNodes:
{
Description: User needs to set the minimum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. ,
Format: int32 ,
Required: True ,
}
integer ,
maxNodes:
{
Description: User needs to set the maximum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. ,
Format: int32 ,
Required: True ,
}
integer ,
pollInterval:
{
Description: User can specify the poll interval, this is the time period (in seconds) after which scaling metrics are polled for triggering a scaling operation. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: This is a cool down period, this is a time period in seconds, which determines the amount of time that must elapse between a scaling activity started by a rule and the start of the next scaling activity, regardless of the rule that triggers it. The default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
scalingRules:
{
Description: The scaling rules. ,
Required: True ,
}
[
{
actionType:
{
Description: The action type. ,
Enum:
{
scaleup: No description available. ,
scaledown: No description available. ,
}
,
Required: True ,
}
enum ,
evaluationCount:
{
Description: This is an evaluation count for a scaling condition, the number of times a trigger condition should be successful, before scaling activity is triggered. ,
Format: int32 ,
Required: True ,
}
integer ,
scalingMetric:
{
Description: Metrics name for individual workloads. For example: cpu ,
Required: True ,
}
string ,
comparisonRule:
{
Description: The comparison rule. ,
Required: True ,
}
{
operator:
{
Description: The comparison operator. ,
Enum:
{
greaterThan: No description available. ,
greaterThanOrEqual: No description available. ,
lessThan: No description available. ,
lessThanOrEqual: No description available. ,
}
,
Required: True ,
}
enum ,
threshold:
{
Description: Threshold setting. ,
Required: True ,
}
number ,
}
,
}
,
]
,
}
,
}
,
rangerPluginProfile:
{
Description: Cluster Ranger plugin profile. ,
Required: False ,
}
{
enabled:
{
Description: Enable Ranger for cluster or not. ,
Required: True ,
}
boolean ,
}
,
kafkaProfile:
{
Description: The Kafka cluster profile. ,
Required: False ,
}
{
enableKRaft:
{
Description: Expose Kafka cluster in KRaft mode. ,
Required: False ,
}
boolean ,
enablePublicEndpoints:
{
Description: Expose worker nodes as public endpoints. ,
Required: False ,
}
boolean ,
remoteStorageUri:
{
Description: Fully qualified path of Azure Storage container used for Tiered Storage. ,
Required: False ,
}
string ,
diskStorage:
{
Description: Kafka disk storage profile. ,
Required: True ,
}
{
dataDiskSize:
{
Description: Managed Disk size in GB. The maximum supported disk size for Standard and Premium HDD/SSD is 32TB, except for Premium SSD v2, which supports up to 64TB. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskType:
{
Description: Managed Disk Type. ,
Enum:
{
Standard_HDD_LRS: No description available. ,
Standard_SSD_LRS: No description available. ,
Standard_SSD_ZRS: No description available. ,
Premium_SSD_LRS: No description available. ,
Premium_SSD_ZRS: No description available. ,
Premium_SSD_v2_LRS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
clusterIdentity:
{
Description: Identity of the internal service components inside the Kafka cluster. ,
Required: False ,
}
{
msiResourceId:
{
Description: ResourceId of the MSI. ,
Format: arm-id ,
Required: True ,
}
string ,
msiClientId:
{
Description: ClientId of the MSI. ,
Required: True ,
}
string ,
msiObjectId:
{
Description: ObjectId of the MSI. ,
Required: True ,
}
string ,
}
,
connectivityEndpoints:
{
Description: Kafka bootstrap server and brokers related connectivity endpoints. ,
Required: False ,
}
{
bootstrapServerEndpoint:
{
Description: bootstrap server connectivity endpoint. ,
Required: False ,
}
string ,
brokerEndpoints:
{
Description: Kafka broker endpoint list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
trinoProfile:
{
Description: Trino Cluster profile. ,
Required: False ,
}
{
catalogOptions:
{
Description: Trino cluster catalog options. ,
Required: False ,
}
{
hive:
{
Description: hive catalog options. ,
Required: False ,
}
[
{
catalogName:
{
Description: Name of trino catalog which should use specified hive metastore. ,
Required: True ,
}
string ,
metastoreDbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metastoreDbConnectionPasswordSecret:
{
Description: Secret reference name from secretsProfile.secrets containing password for database connection. ,
Required: False ,
}
string ,
metastoreDbConnectionURL:
{
Description: Connection string for hive metastore database. ,
Required: True ,
}
string ,
metastoreDbConnectionUserName:
{
Description: User name for database connection. ,
Required: False ,
}
string ,
metastoreWarehouseDir:
{
Description: Metastore root directory URI, format: abfs[s]://@.dfs.core.windows.net/. More details: https://docs.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction-abfs-uri ,
Required: True ,
}
string ,
}
,
]
,
}
,
coordinator:
{
Description: Trino Coordinator. ,
Required: False ,
}
{
debug:
{
Description: Trino debug configuration. ,
Required: False ,
}
{
enable:
{
Description: The flag that if enable debug or not. ,
Required: False ,
}
boolean ,
port:
{
Description: The debug port. ,
Format: int32 ,
Required: False ,
}
integer ,
suspend:
{
Description: The flag that if suspend debug or not. ,
Required: False ,
}
boolean ,
}
,
highAvailabilityEnabled:
{
Description: The flag that if enable coordinator HA, uses multiple coordinator replicas with auto failover, one per each head node. Default: true. ,
Required: False ,
}
boolean ,
}
,
userPluginsSpec:
{
Description: Trino user plugins spec ,
Required: False ,
}
{
plugins:
{
Description: Trino user plugins. ,
Required: False ,
}
[
{
enabled:
{
Description: Denotes whether the plugin is active or not. ,
Required: False ,
}
boolean ,
name:
{
Description: This field maps to the sub-directory in trino plugins location, that will contain all the plugins under path. ,
Required: False ,
}
string ,
path:
{
Description: Fully qualified path to the folder containing the plugins. ,
Required: False ,
}
string ,
}
,
]
,
}
,
userTelemetrySpec:
{
Description: User telemetry ,
Required: False ,
}
{
storage:
{
Description: Trino user telemetry definition. ,
Required: False ,
}
{
hivecatalogName:
{
Description: Hive Catalog name used to mount external tables on the logs written by trino, if not specified there tables are not created. ,
Required: False ,
}
string ,
hivecatalogSchema:
{
Description: Schema of the above catalog to use, to mount query logs as external tables, if not specified tables will be mounted under schema trinologs. ,
Required: False ,
}
string ,
partitionRetentionInDays:
{
Description: Retention period for query log table partitions, this doesn't have any affect on actual data. ,
Format: int32 ,
Required: False ,
}
integer ,
path:
{
Description: Azure storage location of the blobs. ,
Required: False ,
}
string ,
}
,
}
,
worker:
{
Description: Trino worker. ,
Required: False ,
}
{
debug:
{
Description: Trino debug configuration. ,
Required: False ,
}
{
enable:
{
Description: The flag that if enable debug or not. ,
Required: False ,
}
boolean ,
port:
{
Description: The debug port. ,
Format: int32 ,
Required: False ,
}
integer ,
suspend:
{
Description: The flag that if suspend debug or not. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
llapProfile:
{
Description: LLAP cluster profile. ,
Required: False ,
}
object ,
flinkProfile:
{
Description: The Flink cluster profile. ,
Required: False ,
}
{
storage:
{
Description: The storage profile ,
Required: True ,
}
{
storageUri:
{
Description: Storage account uri which is used for savepoint and checkpoint state. ,
Required: True ,
}
string ,
storagekey:
{
Description: Storage key is only required for wasb(s) storage. ,
Required: False ,
}
string ,
}
,
numReplicas:
{
Description: The number of task managers. ,
Format: int32 ,
Required: False ,
}
integer ,
jobManager:
{
Description: Job Manager container/ process CPU and memory requirements ,
Required: True ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
historyServer:
{
Description: History Server container/ process CPU and memory requirements ,
Required: False ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
taskManager:
{
Description: Task Manager container/ process CPU and memory requirements ,
Required: True ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
catalogOptions:
{
Description: Flink cluster catalog options. ,
Required: False ,
}
{
hive:
{
Description: Hive Catalog Option for Flink cluster. ,
Required: False ,
}
{
metastoreDbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metastoreDbConnectionPasswordSecret:
{
Description: Secret reference name from secretsProfile.secrets containing password for database connection. ,
Required: False ,
}
string ,
metastoreDbConnectionURL:
{
Description: Connection string for hive metastore database. ,
Required: True ,
}
string ,
metastoreDbConnectionUserName:
{
Description: User name for database connection. ,
Required: False ,
}
string ,
}
,
}
,
deploymentMode:
{
Description: A string property that indicates the deployment mode of Flink cluster. It can have one of the following enum values => Application, Session. Default value is Session ,
Enum:
{
Application: No description available. ,
Session: No description available. ,
}
,
Required: False ,
}
enum ,
jobSpec:
{
Description: 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. ,
Required: False ,
}
{
jobJarDirectory:
{
Description: A string property that specifies the directory where the job JAR is located. ,
Required: True ,
}
string ,
jarName:
{
Description: A string property that represents the name of the job JAR. ,
Required: True ,
}
string ,
entryClass:
{
Description: A string property that specifies the entry class for the Flink job. If not specified, the entry point is auto-detected from the flink job jar package. ,
Required: False ,
}
string ,
args:
{
Description: A string property representing additional JVM arguments for the Flink job. It should be space separated value. ,
Required: False ,
}
string ,
savePointName:
{
Description: A string property that represents the name of the savepoint for the Flink job ,
Required: False ,
}
string ,
upgradeMode:
{
Description: A string property that indicates the upgrade mode to be performed on the Flink job. It can have one of the following enum values => STATELESS_UPDATE, UPDATE, LAST_STATE_UPDATE. ,
Enum:
{
STATELESS_UPDATE: No description available. ,
UPDATE: No description available. ,
LAST_STATE_UPDATE: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
sparkProfile:
{
Description: The spark cluster profile. ,
Required: False ,
}
{
defaultStorageUrl:
{
Description: The default storage URL. ,
Required: False ,
}
string ,
metastoreSpec:
{
Description: The metastore specification for Spark cluster. ,
Required: False ,
}
{
dbServerHost:
{
Description: The database server host. ,
Required: True ,
}
string ,
dbName:
{
Description: The database name. ,
Required: True ,
}
string ,
dbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
dbUserName:
{
Description: The database user name. ,
Required: False ,
}
string ,
dbPasswordSecretName:
{
Description: The secret name which contains the database user password. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: The key vault resource id. ,
Required: False ,
}
string ,
thriftUrl:
{
Description: The thrift url. ,
Required: False ,
}
string ,
}
,
userPluginsSpec:
{
Description: Spark user plugins spec ,
Required: False ,
}
{
plugins:
{
Description: Spark user plugins. ,
Required: False ,
}
[
{
path:
{
Description: Fully qualified path to the folder containing the plugins. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
rangerProfile:
{
Description: The ranger cluster profile. ,
Required: False ,
}
{
rangerAdmin:
{
Description: Specification for the Ranger Admin service. ,
Required: True ,
}
{
admins:
{
Description: List of usernames that should be marked as ranger admins. These usernames should match the user principal name (UPN) of the respective AAD users. ,
Required: True ,
}
[
string ,
]
,
database:
{
Required: True ,
}
{
host:
{
Description: The database URL ,
Required: True ,
}
string ,
name:
{
Description: The database name ,
Required: True ,
}
string ,
passwordSecretRef:
{
Description: Reference for the database password ,
Required: False ,
}
string ,
username:
{
Description: The name of the database user ,
Required: False ,
}
string ,
}
,
}
,
rangerAudit:
{
Description: Properties required to describe audit log storage. ,
Required: False ,
}
{
storageAccount:
{
Description: Azure storage location of the blobs. MSI should have read/write access to this Storage account. ,
Required: False ,
}
string ,
}
,
rangerUsersync:
{
Description: Specification for the Ranger Usersync service ,
Required: True ,
}
{
enabled:
{
Description: Denotes whether usersync service should be enabled ,
Required: False ,
}
boolean ,
groups:
{
Description: List of groups that should be synced. These group names should match the object id of the respective AAD groups. ,
Required: False ,
}
[
string ,
]
,
mode:
{
Description: User & groups can be synced automatically or via a static list that's refreshed. ,
Enum:
{
static: No description available. ,
automatic: No description available. ,
}
,
Required: False ,
}
enum ,
userMappingLocation:
{
Description: Azure storage location of a mapping file that lists user & group associations. ,
Required: False ,
}
string ,
users:
{
Description: List of user names that should be synced. These usernames should match the User principal name of the respective AAD users. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
stubProfile:
{
Description: Stub cluster profile. ,
Required: False ,
}
object ,
scriptActionProfiles:
{
Description: The script action profile list. ,
Required: False ,
}
[
{
type:
{
Description: Type of the script action. Supported type is bash scripts. ,
Required: True ,
}
string ,
name:
{
Description: Script name. ,
Required: True ,
}
string ,
url:
{
Description: Url of the script file. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters for the script action. It should be space-separated list of arguments required for script execution. ,
Required: False ,
}
string ,
services:
{
Description: List of services to apply the script action. ,
Required: True ,
}
[
string ,
]
,
timeoutInMinutes:
{
Description: Timeout duration for the script action in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
shouldPersist:
{
Description: Specify if the script should persist on the cluster. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
status:
{
Description: Business status of the resource. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: SystemData of cluster. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: The cluster. ,
}
{
properties:
{
Description: Gets or sets the properties. Define cluster specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
clusterType:
{
Description: The type of cluster. ,
Required: True ,
}
string ,
deploymentId:
{
Description: A unique id generated by the RP to identify the resource. ,
Required: False ,
}
string ,
computeProfile:
{
Description: The compute profile. ,
Required: True ,
}
{
nodes:
{
Description: The nodes definitions. ,
Required: True ,
}
[
{
type:
{
Description: The node type. ,
Required: True ,
}
string ,
vmSize:
{
Description: The virtual machine SKU. ,
Required: True ,
}
string ,
count:
{
Description: The number of virtual machines. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
clusterProfile:
{
Description: Cluster profile. ,
Required: True ,
}
{
clusterVersion:
{
Description: Version with 3/4 part. ,
Required: True ,
}
string ,
ossVersion:
{
Description: Version with three part. ,
Required: True ,
}
string ,
components:
{
Description: Component list of this cluster type and version. ,
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
version:
{
Required: False ,
}
string ,
}
,
]
,
identityProfile:
{
Description: This property is required by Trino, Spark and Flink cluster but is optional for Kafka cluster. ,
Required: False ,
}
{
msiResourceId:
{
Description: ResourceId of the MSI. ,
Format: arm-id ,
Required: True ,
}
string ,
msiClientId:
{
Description: ClientId of the MSI. ,
Required: True ,
}
string ,
msiObjectId:
{
Description: ObjectId of the MSI. ,
Required: True ,
}
string ,
}
,
authorizationProfile:
{
Description: Authorization profile with details of AAD user Ids and group Ids authorized for data plane access. ,
Required: True ,
}
{
userIds:
{
Description: AAD user Ids authorized for data plane access. ,
Required: False ,
}
[
string ,
]
,
groupIds:
{
Description: AAD group Ids authorized for data plane access. ,
Required: False ,
}
[
string ,
]
,
}
,
secretsProfile:
{
Description: The cluster secret profile. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: Name of the user Key Vault where all the cluster specific user secrets are stored. ,
Format: arm-id ,
Required: True ,
}
string ,
secrets:
{
Description: Properties of Key Vault secret. ,
Required: False ,
}
[
{
referenceName:
{
Description: Reference name of the secret to be used in service configs. ,
Required: True ,
}
string ,
type:
{
Description: Type of key vault object: secret, key or certificate. ,
Enum:
{
Key: No description available. ,
Secret: No description available. ,
Certificate: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: Version of the secret in key vault. ,
Required: False ,
}
string ,
keyVaultObjectName:
{
Description: Object identifier name of the secret in key vault. ,
Required: True ,
}
string ,
}
,
]
,
}
,
serviceConfigsProfiles:
{
Description: The service configs profiles. ,
Required: False ,
}
[
{
serviceName:
{
Description: Name of the service the configurations should apply to. ,
Required: True ,
}
string ,
configs:
{
Description: List of service configs. ,
Required: True ,
}
[
{
component:
{
Description: Name of the component the config files should apply to. ,
Required: True ,
}
string ,
files:
{
Description: List of Config Files. ,
Required: True ,
}
[
{
fileName:
{
Description: Configuration file name. ,
Required: True ,
}
string ,
content:
{
Description: Free form content of the entire configuration file. ,
Required: False ,
}
string ,
encoding:
{
Description: This property indicates if the content is encoded and is case-insensitive. Please set the value to base64 if the content is base64 encoded. Set it to none or skip it if the content is plain text. ,
Enum:
{
Base64: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
path:
{
Description: Path of the config file if content is specified. ,
Required: False ,
}
string ,
values:
{
Description: List of key value pairs where key represents a valid service configuration name and value represents the value of the config. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
]
,
connectivityProfile:
{
Description: Cluster connectivity profile. ,
Required: False ,
}
{
web:
{
Description: Web connectivity endpoint details. ,
Required: True ,
}
string ,
ssh:
{
Description: List of SSH connectivity endpoints. ,
Required: False ,
}
[
{
endpoint:
{
Description: SSH connectivity endpoint. ,
Required: True ,
}
string ,
privateSshEndpoint:
{
Description: Private SSH connectivity endpoint. This property will only be returned when enableInternalIngress is true. ,
Required: False ,
}
string ,
}
,
]
,
}
,
clusterAccessProfile:
{
Description: Cluster access profile. ,
Required: False ,
}
{
enableInternalIngress:
{
Description: Whether to create cluster using private IP instead of public IP. This property must be set at create time. ,
Required: True ,
}
boolean ,
privateLinkServiceId:
{
Description: Private link service resource ID. Only when enableInternalIngress is true, this property will be returned. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
logAnalyticsProfile:
{
Description: Cluster log analytics profile to enable or disable OMS agent for cluster. ,
Required: False ,
}
{
enabled:
{
Description: True if log analytics is enabled for the cluster, otherwise false. ,
Required: True ,
}
boolean ,
applicationLogs:
{
Description: Collection of logs to be enabled or disabled for log analytics. ,
Required: False ,
}
{
stdOutEnabled:
{
Description: True if stdout is enabled, otherwise false. ,
Required: False ,
}
boolean ,
stdErrorEnabled:
{
Description: True if stderror is enabled, otherwise false. ,
Required: False ,
}
boolean ,
}
,
metricsEnabled:
{
Description: True if metrics are enabled, otherwise false. ,
Required: False ,
}
boolean ,
}
,
prometheusProfile:
{
Description: Cluster Prometheus profile. ,
Required: False ,
}
{
enabled:
{
Description: Enable Prometheus for cluster or not. ,
Required: True ,
}
boolean ,
}
,
sshProfile:
{
Description: Ssh profile for the cluster. ,
Required: False ,
}
{
count:
{
Description: Number of ssh pods per cluster. ,
Format: int32 ,
Required: True ,
}
integer ,
podPrefix:
{
Description: Prefix of the pod names. Pod number will be appended to the prefix. The ingress URLs for the pods will be available at //- ,
Required: False ,
}
string ,
}
,
autoscaleProfile:
{
Description: This is the Autoscale profile for the cluster. This will allow customer to create cluster enabled with Autoscale. ,
Required: False ,
}
{
enabled:
{
Description: This indicates whether auto scale is enabled on HDInsight on AKS cluster. ,
Required: True ,
}
boolean ,
gracefulDecommissionTimeout:
{
Description: This property is for graceful decommission timeout; It has a default setting of 3600 seconds before forced shutdown takes place. This is the maximal time to wait for running containers and applications to complete before transition a DECOMMISSIONING node into DECOMMISSIONED. The default value is 3600 seconds. Negative value (like -1) is handled as infinite timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
autoscaleType:
{
Description: User to specify which type of Autoscale to be implemented - Scheduled Based or Load Based. ,
Enum:
{
ScheduleBased: No description available. ,
LoadBased: No description available. ,
}
,
Required: False ,
}
enum ,
scheduleBasedConfig:
{
Description: Profiles of schedule based Autoscale. ,
Required: False ,
}
{
timeZone:
{
Description: User has to specify the timezone on which the schedule has to be set for schedule based autoscale configuration. ,
Required: True ,
}
string ,
defaultCount:
{
Description: Setting default node count of current schedule configuration. Default node count specifies the number of nodes which are default when an specified scaling operation is executed (scale up/scale down) ,
Format: int32 ,
Required: True ,
}
integer ,
schedules:
{
Description: This specifies the schedules where scheduled based Autoscale to be enabled, the user has a choice to set multiple rules within the schedule across days and times (start/end). ,
Required: True ,
}
[
{
startTime:
{
Description: User has to set the start time of current schedule configuration, format like 10:30 (HH:MM). ,
Required: True ,
}
string ,
endTime:
{
Description: User has to set the end time of current schedule configuration, format like 10:30 (HH:MM). ,
Required: True ,
}
string ,
count:
{
Description: User has to set the node count anticipated at end of the scaling operation of the set current schedule configuration, format is integer. ,
Format: int32 ,
Required: True ,
}
integer ,
days:
{
Description: User has to set the days where schedule has to be set for autoscale operation. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
loadBasedConfig:
{
Description: Profiles of load based Autoscale. ,
Required: False ,
}
{
minNodes:
{
Description: User needs to set the minimum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. ,
Format: int32 ,
Required: True ,
}
integer ,
maxNodes:
{
Description: User needs to set the maximum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. ,
Format: int32 ,
Required: True ,
}
integer ,
pollInterval:
{
Description: User can specify the poll interval, this is the time period (in seconds) after which scaling metrics are polled for triggering a scaling operation. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: This is a cool down period, this is a time period in seconds, which determines the amount of time that must elapse between a scaling activity started by a rule and the start of the next scaling activity, regardless of the rule that triggers it. The default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
scalingRules:
{
Description: The scaling rules. ,
Required: True ,
}
[
{
actionType:
{
Description: The action type. ,
Enum:
{
scaleup: No description available. ,
scaledown: No description available. ,
}
,
Required: True ,
}
enum ,
evaluationCount:
{
Description: This is an evaluation count for a scaling condition, the number of times a trigger condition should be successful, before scaling activity is triggered. ,
Format: int32 ,
Required: True ,
}
integer ,
scalingMetric:
{
Description: Metrics name for individual workloads. For example: cpu ,
Required: True ,
}
string ,
comparisonRule:
{
Description: The comparison rule. ,
Required: True ,
}
{
operator:
{
Description: The comparison operator. ,
Enum:
{
greaterThan: No description available. ,
greaterThanOrEqual: No description available. ,
lessThan: No description available. ,
lessThanOrEqual: No description available. ,
}
,
Required: True ,
}
enum ,
threshold:
{
Description: Threshold setting. ,
Required: True ,
}
number ,
}
,
}
,
]
,
}
,
}
,
rangerPluginProfile:
{
Description: Cluster Ranger plugin profile. ,
Required: False ,
}
{
enabled:
{
Description: Enable Ranger for cluster or not. ,
Required: True ,
}
boolean ,
}
,
kafkaProfile:
{
Description: The Kafka cluster profile. ,
Required: False ,
}
{
enableKRaft:
{
Description: Expose Kafka cluster in KRaft mode. ,
Required: False ,
}
boolean ,
enablePublicEndpoints:
{
Description: Expose worker nodes as public endpoints. ,
Required: False ,
}
boolean ,
remoteStorageUri:
{
Description: Fully qualified path of Azure Storage container used for Tiered Storage. ,
Required: False ,
}
string ,
diskStorage:
{
Description: Kafka disk storage profile. ,
Required: True ,
}
{
dataDiskSize:
{
Description: Managed Disk size in GB. The maximum supported disk size for Standard and Premium HDD/SSD is 32TB, except for Premium SSD v2, which supports up to 64TB. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskType:
{
Description: Managed Disk Type. ,
Enum:
{
Standard_HDD_LRS: No description available. ,
Standard_SSD_LRS: No description available. ,
Standard_SSD_ZRS: No description available. ,
Premium_SSD_LRS: No description available. ,
Premium_SSD_ZRS: No description available. ,
Premium_SSD_v2_LRS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
clusterIdentity:
{
Description: Identity of the internal service components inside the Kafka cluster. ,
Required: False ,
}
{
msiResourceId:
{
Description: ResourceId of the MSI. ,
Format: arm-id ,
Required: True ,
}
string ,
msiClientId:
{
Description: ClientId of the MSI. ,
Required: True ,
}
string ,
msiObjectId:
{
Description: ObjectId of the MSI. ,
Required: True ,
}
string ,
}
,
connectivityEndpoints:
{
Description: Kafka bootstrap server and brokers related connectivity endpoints. ,
Required: False ,
}
{
bootstrapServerEndpoint:
{
Description: bootstrap server connectivity endpoint. ,
Required: False ,
}
string ,
brokerEndpoints:
{
Description: Kafka broker endpoint list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
trinoProfile:
{
Description: Trino Cluster profile. ,
Required: False ,
}
{
catalogOptions:
{
Description: Trino cluster catalog options. ,
Required: False ,
}
{
hive:
{
Description: hive catalog options. ,
Required: False ,
}
[
{
catalogName:
{
Description: Name of trino catalog which should use specified hive metastore. ,
Required: True ,
}
string ,
metastoreDbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metastoreDbConnectionPasswordSecret:
{
Description: Secret reference name from secretsProfile.secrets containing password for database connection. ,
Required: False ,
}
string ,
metastoreDbConnectionURL:
{
Description: Connection string for hive metastore database. ,
Required: True ,
}
string ,
metastoreDbConnectionUserName:
{
Description: User name for database connection. ,
Required: False ,
}
string ,
metastoreWarehouseDir:
{
Description: Metastore root directory URI, format: abfs[s]://@.dfs.core.windows.net/. More details: https://docs.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction-abfs-uri ,
Required: True ,
}
string ,
}
,
]
,
}
,
coordinator:
{
Description: Trino Coordinator. ,
Required: False ,
}
{
debug:
{
Description: Trino debug configuration. ,
Required: False ,
}
{
enable:
{
Description: The flag that if enable debug or not. ,
Required: False ,
}
boolean ,
port:
{
Description: The debug port. ,
Format: int32 ,
Required: False ,
}
integer ,
suspend:
{
Description: The flag that if suspend debug or not. ,
Required: False ,
}
boolean ,
}
,
highAvailabilityEnabled:
{
Description: The flag that if enable coordinator HA, uses multiple coordinator replicas with auto failover, one per each head node. Default: true. ,
Required: False ,
}
boolean ,
}
,
userPluginsSpec:
{
Description: Trino user plugins spec ,
Required: False ,
}
{
plugins:
{
Description: Trino user plugins. ,
Required: False ,
}
[
{
enabled:
{
Description: Denotes whether the plugin is active or not. ,
Required: False ,
}
boolean ,
name:
{
Description: This field maps to the sub-directory in trino plugins location, that will contain all the plugins under path. ,
Required: False ,
}
string ,
path:
{
Description: Fully qualified path to the folder containing the plugins. ,
Required: False ,
}
string ,
}
,
]
,
}
,
userTelemetrySpec:
{
Description: User telemetry ,
Required: False ,
}
{
storage:
{
Description: Trino user telemetry definition. ,
Required: False ,
}
{
hivecatalogName:
{
Description: Hive Catalog name used to mount external tables on the logs written by trino, if not specified there tables are not created. ,
Required: False ,
}
string ,
hivecatalogSchema:
{
Description: Schema of the above catalog to use, to mount query logs as external tables, if not specified tables will be mounted under schema trinologs. ,
Required: False ,
}
string ,
partitionRetentionInDays:
{
Description: Retention period for query log table partitions, this doesn't have any affect on actual data. ,
Format: int32 ,
Required: False ,
}
integer ,
path:
{
Description: Azure storage location of the blobs. ,
Required: False ,
}
string ,
}
,
}
,
worker:
{
Description: Trino worker. ,
Required: False ,
}
{
debug:
{
Description: Trino debug configuration. ,
Required: False ,
}
{
enable:
{
Description: The flag that if enable debug or not. ,
Required: False ,
}
boolean ,
port:
{
Description: The debug port. ,
Format: int32 ,
Required: False ,
}
integer ,
suspend:
{
Description: The flag that if suspend debug or not. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
llapProfile:
{
Description: LLAP cluster profile. ,
Required: False ,
}
object ,
flinkProfile:
{
Description: The Flink cluster profile. ,
Required: False ,
}
{
storage:
{
Description: The storage profile ,
Required: True ,
}
{
storageUri:
{
Description: Storage account uri which is used for savepoint and checkpoint state. ,
Required: True ,
}
string ,
storagekey:
{
Description: Storage key is only required for wasb(s) storage. ,
Required: False ,
}
string ,
}
,
numReplicas:
{
Description: The number of task managers. ,
Format: int32 ,
Required: False ,
}
integer ,
jobManager:
{
Description: Job Manager container/ process CPU and memory requirements ,
Required: True ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
historyServer:
{
Description: History Server container/ process CPU and memory requirements ,
Required: False ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
taskManager:
{
Description: Task Manager container/ process CPU and memory requirements ,
Required: True ,
}
{
cpu:
{
Description: The required CPU. ,
Format: float ,
Required: True ,
}
number ,
memory:
{
Description: The required memory in MB, Container memory will be 110 percentile ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
catalogOptions:
{
Description: Flink cluster catalog options. ,
Required: False ,
}
{
hive:
{
Description: Hive Catalog Option for Flink cluster. ,
Required: False ,
}
{
metastoreDbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metastoreDbConnectionPasswordSecret:
{
Description: Secret reference name from secretsProfile.secrets containing password for database connection. ,
Required: False ,
}
string ,
metastoreDbConnectionURL:
{
Description: Connection string for hive metastore database. ,
Required: True ,
}
string ,
metastoreDbConnectionUserName:
{
Description: User name for database connection. ,
Required: False ,
}
string ,
}
,
}
,
deploymentMode:
{
Description: A string property that indicates the deployment mode of Flink cluster. It can have one of the following enum values => Application, Session. Default value is Session ,
Enum:
{
Application: No description available. ,
Session: No description available. ,
}
,
Required: False ,
}
enum ,
jobSpec:
{
Description: 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. ,
Required: False ,
}
{
jobJarDirectory:
{
Description: A string property that specifies the directory where the job JAR is located. ,
Required: True ,
}
string ,
jarName:
{
Description: A string property that represents the name of the job JAR. ,
Required: True ,
}
string ,
entryClass:
{
Description: A string property that specifies the entry class for the Flink job. If not specified, the entry point is auto-detected from the flink job jar package. ,
Required: False ,
}
string ,
args:
{
Description: A string property representing additional JVM arguments for the Flink job. It should be space separated value. ,
Required: False ,
}
string ,
savePointName:
{
Description: A string property that represents the name of the savepoint for the Flink job ,
Required: False ,
}
string ,
upgradeMode:
{
Description: A string property that indicates the upgrade mode to be performed on the Flink job. It can have one of the following enum values => STATELESS_UPDATE, UPDATE, LAST_STATE_UPDATE. ,
Enum:
{
STATELESS_UPDATE: No description available. ,
UPDATE: No description available. ,
LAST_STATE_UPDATE: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
sparkProfile:
{
Description: The spark cluster profile. ,
Required: False ,
}
{
defaultStorageUrl:
{
Description: The default storage URL. ,
Required: False ,
}
string ,
metastoreSpec:
{
Description: The metastore specification for Spark cluster. ,
Required: False ,
}
{
dbServerHost:
{
Description: The database server host. ,
Required: True ,
}
string ,
dbName:
{
Description: The database name. ,
Required: True ,
}
string ,
dbConnectionAuthenticationMode:
{
Description: The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
dbUserName:
{
Description: The database user name. ,
Required: False ,
}
string ,
dbPasswordSecretName:
{
Description: The secret name which contains the database user password. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: The key vault resource id. ,
Required: False ,
}
string ,
thriftUrl:
{
Description: The thrift url. ,
Required: False ,
}
string ,
}
,
userPluginsSpec:
{
Description: Spark user plugins spec ,
Required: False ,
}
{
plugins:
{
Description: Spark user plugins. ,
Required: False ,
}
[
{
path:
{
Description: Fully qualified path to the folder containing the plugins. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
rangerProfile:
{
Description: The ranger cluster profile. ,
Required: False ,
}
{
rangerAdmin:
{
Description: Specification for the Ranger Admin service. ,
Required: True ,
}
{
admins:
{
Description: List of usernames that should be marked as ranger admins. These usernames should match the user principal name (UPN) of the respective AAD users. ,
Required: True ,
}
[
string ,
]
,
database:
{
Required: True ,
}
{
host:
{
Description: The database URL ,
Required: True ,
}
string ,
name:
{
Description: The database name ,
Required: True ,
}
string ,
passwordSecretRef:
{
Description: Reference for the database password ,
Required: False ,
}
string ,
username:
{
Description: The name of the database user ,
Required: False ,
}
string ,
}
,
}
,
rangerAudit:
{
Description: Properties required to describe audit log storage. ,
Required: False ,
}
{
storageAccount:
{
Description: Azure storage location of the blobs. MSI should have read/write access to this Storage account. ,
Required: False ,
}
string ,
}
,
rangerUsersync:
{
Description: Specification for the Ranger Usersync service ,
Required: True ,
}
{
enabled:
{
Description: Denotes whether usersync service should be enabled ,
Required: False ,
}
boolean ,
groups:
{
Description: List of groups that should be synced. These group names should match the object id of the respective AAD groups. ,
Required: False ,
}
[
string ,
]
,
mode:
{
Description: User & groups can be synced automatically or via a static list that's refreshed. ,
Enum:
{
static: No description available. ,
automatic: No description available. ,
}
,
Required: False ,
}
enum ,
userMappingLocation:
{
Description: Azure storage location of a mapping file that lists user & group associations. ,
Required: False ,
}
string ,
users:
{
Description: List of user names that should be synced. These usernames should match the User principal name of the respective AAD users. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
stubProfile:
{
Description: Stub cluster profile. ,
Required: False ,
}
object ,
scriptActionProfiles:
{
Description: The script action profile list. ,
Required: False ,
}
[
{
type:
{
Description: Type of the script action. Supported type is bash scripts. ,
Required: True ,
}
string ,
name:
{
Description: Script name. ,
Required: True ,
}
string ,
url:
{
Description: Url of the script file. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters for the script action. It should be space-separated list of arguments required for script execution. ,
Required: False ,
}
string ,
services:
{
Description: List of services to apply the script action. ,
Required: True ,
}
[
string ,
]
,
timeoutInMinutes:
{
Description: Timeout duration for the script action in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
shouldPersist:
{
Description: Specify if the script should persist on the cluster. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
status:
{
Description: Business status of the resource. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: SystemData of cluster. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Delete (removed)
Description :  Deletes a cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
clusterPoolName:
{
Description: The name of the cluster pool. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the HDInsight cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClusterJobs_RunJob (removed)
Description :  Operations on jobs of HDInsight on AKS cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/runJob
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
clusterPoolName:
{
Description: The name of the cluster pool. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the HDInsight cluster. ,
Required: True ,
}
string ,
ClusterJob:
{
Description: The Cluster job. ,
Required: True ,
}
{
properties:
{
Description: Properties of cluster job. ,
Required: True ,
}
{
jobType:
{
Description: Type of cluster job. ,
Enum:
{
FlinkJob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of cluster job. ,
Required: True ,
}
{
jobType:
{
Description: Type of cluster job. ,
Enum:
{
FlinkJob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to get the status of the resize operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClusterJobs_List (removed)
Description :  Get jobs of HDInsight on AKS cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/jobs
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
clusterPoolName:
{
Description: The name of the cluster pool. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the HDInsight cluster. ,
Required: True ,
}
string ,
$filter:
{
Description: The system query option to filter job returned in the response. Allowed value is 'jobName eq {jobName}' or 'jarName eq {jarName}'. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of cluster job. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of cluster job. ,
Required: True ,
}
{
jobType:
{
Description: Type of cluster job. ,
Enum:
{
FlinkJob: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ListServiceConfigs (removed)
Description :  Lists the config dump of all services running in cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/serviceConfigs
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
clusterPoolName:
{
Description: The name of the cluster pool. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the HDInsight cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Cluster instance service config array. ,
Required: False ,
}
[
{
properties:
{
Description: Cluster instance service config properties. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Locations_CheckNameAvailability (removed)
Description :  Check the availability of the resource name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/checkNameAvailability
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
NameAvailabilityParameters:
{
Description: The name and type of the resource. ,
Required: True ,
}
{
name:
{
Description: Name for checking availability. ,
Required: False ,
}
string ,
type:
{
Description: The resource type in Microsoft.HDInsight. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicator of availability of the Microsoft.HDInsight resource name. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason of unavailability. ,
Required: False ,
}
string ,
message:
{
Description: The error message of unavailability. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ListInstanceViews (removed)
Description :  Lists the lists of instance views
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/instanceViews
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
clusterPoolName:
{
Description: The name of the cluster pool. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the HDInsight cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Cluster instance view array. ,
Required: False ,
}
[
{
name:
{
Description: Name of the instance view. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the instance view. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_GetInstanceView (removed)
Description :  Gets the status of a cluster instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/instanceViews/default
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
clusterPoolName:
{
Description: The name of the cluster pool. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the HDInsight cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of the instance view. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the instance view. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Returns list of operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.HDInsight/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvailableClusterPoolVersions_ListByLocation (removed)
Description :  Returns a list of available cluster pool versions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/availableClusterPoolVersions
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of cluster pool versions. ,
Required: False ,
}
[
{
properties:
{
Description: Cluster pool version properties. ,
Required: False ,
}
{
clusterPoolVersion:
{
Description: Cluster pool version is a 2-part version. ,
Required: False ,
}
string ,
aksVersion:
{
Description: AKS version. ,
Required: False ,
}
string ,
isPreview:
{
Description: Indicate if this version is in preview or not. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvailableClusterVersions_ListByLocation (removed)
Description :  Returns a list of available cluster versions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/availableClusterVersions
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of cluster versions. ,
Required: False ,
}
[
{
properties:
{
Description: Cluster version properties. ,
Required: False ,
}
{
clusterType:
{
Description: The type of cluster. ,
Required: False ,
}
string ,
clusterVersion:
{
Description: Version with three part. ,
Required: False ,
}
string ,
ossVersion:
{
Description: Version with three part. ,
Required: False ,
}
string ,
clusterPoolVersion:
{
Description: The two part cluster pool version. If the cluster version is before cluster pool version on-board, the return value will be empty string ,
Required: False ,
}
string ,
isPreview:
{
Description: Indicate if this version is in preview or not. ,
Required: False ,
}
boolean ,
components:
{
Description: Component list of this cluster type and version. ,
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
version:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}