Microsoft.HDInsight (preview:2025-01-15)

2025/02/24 • 57 new methods

Applications_ListByCluster (new)
Description :  Lists all of the applications for the HDInsight cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/applications
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of HDInsight applications installed on HDInsight cluster. ,
Required: False ,
}
[
{
etag:
{
Description: The ETag for the application ,
Required: False ,
}
string ,
tags:
{
Description: The tags for the application. ,
Required: False ,
}
object ,
properties:
{
Description: The properties of the application. ,
Required: False ,
}
{
computeProfile:
{
Description: The list of roles in the cluster. ,
Required: False ,
}
{
roles:
{
Description: The list of roles in the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: False ,
}
string ,
minInstanceCount:
{
Description: The minimum instance count of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
targetInstanceCount:
{
Description: The instance count of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
VMGroupName:
{
Description: The name of the virtual machine group. ,
Required: False ,
}
string ,
autoscale:
{
Description: The autoscale configurations. ,
Required: False ,
}
{
capacity:
{
Description: Parameters for load-based autoscale ,
Required: False ,
}
{
minInstanceCount:
{
Description: The minimum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
maxInstanceCount:
{
Description: The maximum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
recurrence:
{
Description: Parameters for schedule-based autoscale ,
Required: False ,
}
{
timeZone:
{
Description: The time zone for the autoscale schedule times ,
Required: False ,
}
string ,
schedule:
{
Description: Array of schedule-based autoscale rules ,
Required: False ,
}
[
{
days:
{
Description: Days of the week for a schedule-based autoscale rule ,
Required: False ,
}
[
string ,
]
,
timeAndCapacity:
{
Description: Time and capacity for a schedule-based autoscale rule ,
Required: False ,
}
{
time:
{
Description: 24-hour time in the form xx:xx ,
Required: False ,
}
string ,
minInstanceCount:
{
Description: The minimum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
maxInstanceCount:
{
Description: The maximum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
hardwareProfile:
{
Description: The hardware profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the VM ,
Required: False ,
}
string ,
}
,
osProfile:
{
Description: The operating system profile. ,
Required: False ,
}
{
linuxOperatingSystemProfile:
{
Description: The Linux OS profile. ,
Required: False ,
}
{
username:
{
Description: The username. ,
Required: False ,
}
string ,
password:
{
Description: The password. ,
Required: False ,
}
string ,
sshProfile:
{
Description: The SSH profile. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys. ,
Required: False ,
}
[
{
certificateData:
{
Description: The certificate for SSH. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
virtualNetworkProfile:
{
Description: The virtual network profile. ,
Required: False ,
}
{
id:
{
Description: The ID of the virtual network. ,
Required: False ,
}
string ,
subnet:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
}
,
dataDisksGroups:
{
Description: The data disks groups for the role. ,
Required: False ,
}
[
{
disksPerNode:
{
Description: The number of disks per node. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountType:
{
Description: ReadOnly. The storage account type. Do not set this value. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: ReadOnly. The DiskSize in GB. Do not set this value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
scriptActions:
{
Description: The list of script actions on the role. ,
Required: False ,
}
[
{
name:
{
Description: The name of the script action. ,
Required: True ,
}
string ,
uri:
{
Description: The URI to the script. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the script provided. ,
Required: True ,
}
string ,
}
,
]
,
encryptDataDisks:
{
Description: Indicates whether encrypt the data disks. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
installScriptActions:
{
Description: The list of install script actions. ,
Required: False ,
}
[
{
name:
{
Description: The name of the script action. ,
Required: True ,
}
string ,
uri:
{
Description: The URI to the script. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the script ,
Required: False ,
}
string ,
roles:
{
Description: The list of roles where script will be executed. ,
Required: True ,
}
[
string ,
]
,
applicationName:
{
Description: The application name of the script action, if any. ,
Required: False ,
}
string ,
}
,
]
,
uninstallScriptActions:
{
Description: The list of uninstall script actions. ,
Required: False ,
}
[
{
name:
{
Description: The name of the script action. ,
Required: True ,
}
string ,
uri:
{
Description: The URI to the script. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the script ,
Required: False ,
}
string ,
roles:
{
Description: The list of roles where script will be executed. ,
Required: True ,
}
[
string ,
]
,
applicationName:
{
Description: The application name of the script action, if any. ,
Required: False ,
}
string ,
}
,
]
,
httpsEndpoints:
{
Description: The list of application HTTPS endpoints. ,
Required: False ,
}
[
{
accessModes:
{
Description: The list of access modes for the application. ,
Required: False ,
}
[
string ,
]
,
location:
{
Description: The location of the endpoint. ,
Required: False ,
}
string ,
destinationPort:
{
Description: The destination port to connect to. ,
Format: int32 ,
Required: False ,
}
integer ,
publicPort:
{
Description: The public port to connect to. ,
Format: int32 ,
Required: False ,
}
integer ,
privateIPAddress:
{
Description: The private ip address of the endpoint. ,
Required: False ,
}
string ,
subDomainSuffix:
{
Description: The subdomain suffix of the application. ,
Required: False ,
}
string ,
disableGatewayAuth:
{
Description: The value indicates whether to disable GatewayAuth. ,
Required: False ,
}
boolean ,
}
,
]
,
sshEndpoints:
{
Description: The list of application SSH endpoints. ,
Required: False ,
}
[
{
location:
{
Description: The location of the endpoint. ,
Required: False ,
}
string ,
destinationPort:
{
Description: The destination port to connect to. ,
Format: int32 ,
Required: False ,
}
integer ,
publicPort:
{
Description: The public port to connect to. ,
Format: int32 ,
Required: False ,
}
integer ,
privateIPAddress:
{
Description: The private ip address of the endpoint. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the application. ,
Required: False ,
}
string ,
applicationType:
{
Description: The application type. ,
Required: False ,
}
string ,
applicationState:
{
Description: The application state. ,
Required: False ,
}
string ,
errors:
{
Description: The list of errors. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
createdDate:
{
Description: The application create date time. ,
Required: False ,
}
string ,
marketplaceIdentifier:
{
Description: The marketplace identifier. ,
Required: False ,
}
string ,
privateLinkConfigurations:
{
Description: The private link configurations. ,
Required: False ,
}
[
{
id:
{
Description: The private link configuration id. ,
Required: False ,
}
string ,
name:
{
Description: The name of private link configuration. ,
Required: True ,
}
string ,
type:
{
Description: The type of the private link configuration. ,
Required: False ,
}
string ,
properties:
{
Description: The private link configuration properties. ,
Required: True ,
}
{
groupId:
{
Description: The HDInsight private linkable sub-resource name to apply the private link configuration to. For example, 'headnode', 'gateway', 'edgenode'. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The private link configuration provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
ipConfigurations:
{
Description: The IP configurations for the private link service. ,
Required: True ,
}
[
{
id:
{
Description: The private link IP configuration id. ,
Required: False ,
}
string ,
name:
{
Description: The name of private link IP configuration. ,
Required: True ,
}
string ,
type:
{
Description: The type of the private link IP configuration. ,
Required: False ,
}
string ,
properties:
{
Description: The private link ip configuration properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The private link configuration provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
primary:
{
Description: Indicates whether this IP configuration is primary for the corresponding NIC. ,
Required: False ,
}
boolean ,
privateIPAddress:
{
Description: The IP address. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The method that private IP address is allocated. ,
Enum:
{
dynamic: No description available. ,
static: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: The subnet resource id. ,
Required: False ,
}
{
id:
{
Description: The azure resource id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
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 URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}
Applications_Get (new)
Description :  Gets properties of the specified application.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/applications/{applicationName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
applicationName:
{
Description: The constant value for the application name. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag for the application ,
Required: False ,
}
string ,
tags:
{
Description: The tags for the application. ,
Required: False ,
}
object ,
properties:
{
Description: The properties of the application. ,
Required: False ,
}
{
computeProfile:
{
Description: The list of roles in the cluster. ,
Required: False ,
}
{
roles:
{
Description: The list of roles in the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: False ,
}
string ,
minInstanceCount:
{
Description: The minimum instance count of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
targetInstanceCount:
{
Description: The instance count of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
VMGroupName:
{
Description: The name of the virtual machine group. ,
Required: False ,
}
string ,
autoscale:
{
Description: The autoscale configurations. ,
Required: False ,
}
{
capacity:
{
Description: Parameters for load-based autoscale ,
Required: False ,
}
{
minInstanceCount:
{
Description: The minimum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
maxInstanceCount:
{
Description: The maximum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
recurrence:
{
Description: Parameters for schedule-based autoscale ,
Required: False ,
}
{
timeZone:
{
Description: The time zone for the autoscale schedule times ,
Required: False ,
}
string ,
schedule:
{
Description: Array of schedule-based autoscale rules ,
Required: False ,
}
[
{
days:
{
Description: Days of the week for a schedule-based autoscale rule ,
Required: False ,
}
[
string ,
]
,
timeAndCapacity:
{
Description: Time and capacity for a schedule-based autoscale rule ,
Required: False ,
}
{
time:
{
Description: 24-hour time in the form xx:xx ,
Required: False ,
}
string ,
minInstanceCount:
{
Description: The minimum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
maxInstanceCount:
{
Description: The maximum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
hardwareProfile:
{
Description: The hardware profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the VM ,
Required: False ,
}
string ,
}
,
osProfile:
{
Description: The operating system profile. ,
Required: False ,
}
{
linuxOperatingSystemProfile:
{
Description: The Linux OS profile. ,
Required: False ,
}
{
username:
{
Description: The username. ,
Required: False ,
}
string ,
password:
{
Description: The password. ,
Required: False ,
}
string ,
sshProfile:
{
Description: The SSH profile. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys. ,
Required: False ,
}
[
{
certificateData:
{
Description: The certificate for SSH. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
virtualNetworkProfile:
{
Description: The virtual network profile. ,
Required: False ,
}
{
id:
{
Description: The ID of the virtual network. ,
Required: False ,
}
string ,
subnet:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
}
,
dataDisksGroups:
{
Description: The data disks groups for the role. ,
Required: False ,
}
[
{
disksPerNode:
{
Description: The number of disks per node. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountType:
{
Description: ReadOnly. The storage account type. Do not set this value. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: ReadOnly. The DiskSize in GB. Do not set this value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
scriptActions:
{
Description: The list of script actions on the role. ,
Required: False ,
}
[
{
name:
{
Description: The name of the script action. ,
Required: True ,
}
string ,
uri:
{
Description: The URI to the script. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the script provided. ,
Required: True ,
}
string ,
}
,
]
,
encryptDataDisks:
{
Description: Indicates whether encrypt the data disks. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
installScriptActions:
{
Description: The list of install script actions. ,
Required: False ,
}
[
{
name:
{
Description: The name of the script action. ,
Required: True ,
}
string ,
uri:
{
Description: The URI to the script. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the script ,
Required: False ,
}
string ,
roles:
{
Description: The list of roles where script will be executed. ,
Required: True ,
}
[
string ,
]
,
applicationName:
{
Description: The application name of the script action, if any. ,
Required: False ,
}
string ,
}
,
]
,
uninstallScriptActions:
{
Description: The list of uninstall script actions. ,
Required: False ,
}
[
{
name:
{
Description: The name of the script action. ,
Required: True ,
}
string ,
uri:
{
Description: The URI to the script. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the script ,
Required: False ,
}
string ,
roles:
{
Description: The list of roles where script will be executed. ,
Required: True ,
}
[
string ,
]
,
applicationName:
{
Description: The application name of the script action, if any. ,
Required: False ,
}
string ,
}
,
]
,
httpsEndpoints:
{
Description: The list of application HTTPS endpoints. ,
Required: False ,
}
[
{
accessModes:
{
Description: The list of access modes for the application. ,
Required: False ,
}
[
string ,
]
,
location:
{
Description: The location of the endpoint. ,
Required: False ,
}
string ,
destinationPort:
{
Description: The destination port to connect to. ,
Format: int32 ,
Required: False ,
}
integer ,
publicPort:
{
Description: The public port to connect to. ,
Format: int32 ,
Required: False ,
}
integer ,
privateIPAddress:
{
Description: The private ip address of the endpoint. ,
Required: False ,
}
string ,
subDomainSuffix:
{
Description: The subdomain suffix of the application. ,
Required: False ,
}
string ,
disableGatewayAuth:
{
Description: The value indicates whether to disable GatewayAuth. ,
Required: False ,
}
boolean ,
}
,
]
,
sshEndpoints:
{
Description: The list of application SSH endpoints. ,
Required: False ,
}
[
{
location:
{
Description: The location of the endpoint. ,
Required: False ,
}
string ,
destinationPort:
{
Description: The destination port to connect to. ,
Format: int32 ,
Required: False ,
}
integer ,
publicPort:
{
Description: The public port to connect to. ,
Format: int32 ,
Required: False ,
}
integer ,
privateIPAddress:
{
Description: The private ip address of the endpoint. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the application. ,
Required: False ,
}
string ,
applicationType:
{
Description: The application type. ,
Required: False ,
}
string ,
applicationState:
{
Description: The application state. ,
Required: False ,
}
string ,
errors:
{
Description: The list of errors. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
createdDate:
{
Description: The application create date time. ,
Required: False ,
}
string ,
marketplaceIdentifier:
{
Description: The marketplace identifier. ,
Required: False ,
}
string ,
privateLinkConfigurations:
{
Description: The private link configurations. ,
Required: False ,
}
[
{
id:
{
Description: The private link configuration id. ,
Required: False ,
}
string ,
name:
{
Description: The name of private link configuration. ,
Required: True ,
}
string ,
type:
{
Description: The type of the private link configuration. ,
Required: False ,
}
string ,
properties:
{
Description: The private link configuration properties. ,
Required: True ,
}
{
groupId:
{
Description: The HDInsight private linkable sub-resource name to apply the private link configuration to. For example, 'headnode', 'gateway', 'edgenode'. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The private link configuration provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
ipConfigurations:
{
Description: The IP configurations for the private link service. ,
Required: True ,
}
[
{
id:
{
Description: The private link IP configuration id. ,
Required: False ,
}
string ,
name:
{
Description: The name of private link IP configuration. ,
Required: True ,
}
string ,
type:
{
Description: The type of the private link IP configuration. ,
Required: False ,
}
string ,
properties:
{
Description: The private link ip configuration properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The private link configuration provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
primary:
{
Description: Indicates whether this IP configuration is primary for the corresponding NIC. ,
Required: False ,
}
boolean ,
privateIPAddress:
{
Description: The IP address. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The method that private IP address is allocated. ,
Enum:
{
dynamic: No description available. ,
static: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: The subnet resource id. ,
Required: False ,
}
{
id:
{
Description: The azure resource id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
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 ,
}
,
}
Applications_Create (new)
Description :  Creates applications for the HDInsight cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/applications/{applicationName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
applicationName:
{
Description: The constant value for the application name. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The application create request. ,
Required: True ,
}
{
etag:
{
Description: The ETag for the application ,
Required: False ,
}
string ,
tags:
{
Description: The tags for the application. ,
Required: False ,
}
object ,
properties:
{
Description: The properties of the application. ,
Required: False ,
}
{
computeProfile:
{
Description: The list of roles in the cluster. ,
Required: False ,
}
{
roles:
{
Description: The list of roles in the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: False ,
}
string ,
minInstanceCount:
{
Description: The minimum instance count of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
targetInstanceCount:
{
Description: The instance count of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
VMGroupName:
{
Description: The name of the virtual machine group. ,
Required: False ,
}
string ,
autoscale:
{
Description: The autoscale configurations. ,
Required: False ,
}
{
capacity:
{
Description: Parameters for load-based autoscale ,
Required: False ,
}
{
minInstanceCount:
{
Description: The minimum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
maxInstanceCount:
{
Description: The maximum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
recurrence:
{
Description: Parameters for schedule-based autoscale ,
Required: False ,
}
{
timeZone:
{
Description: The time zone for the autoscale schedule times ,
Required: False ,
}
string ,
schedule:
{
Description: Array of schedule-based autoscale rules ,
Required: False ,
}
[
{
days:
{
Description: Days of the week for a schedule-based autoscale rule ,
Required: False ,
}
[
string ,
]
,
timeAndCapacity:
{
Description: Time and capacity for a schedule-based autoscale rule ,
Required: False ,
}
{
time:
{
Description: 24-hour time in the form xx:xx ,
Required: False ,
}
string ,
minInstanceCount:
{
Description: The minimum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
maxInstanceCount:
{
Description: The maximum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
hardwareProfile:
{
Description: The hardware profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the VM ,
Required: False ,
}
string ,
}
,
osProfile:
{
Description: The operating system profile. ,
Required: False ,
}
{
linuxOperatingSystemProfile:
{
Description: The Linux OS profile. ,
Required: False ,
}
{
username:
{
Description: The username. ,
Required: False ,
}
string ,
password:
{
Description: The password. ,
Required: False ,
}
string ,
sshProfile:
{
Description: The SSH profile. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys. ,
Required: False ,
}
[
{
certificateData:
{
Description: The certificate for SSH. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
virtualNetworkProfile:
{
Description: The virtual network profile. ,
Required: False ,
}
{
id:
{
Description: The ID of the virtual network. ,
Required: False ,
}
string ,
subnet:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
}
,
dataDisksGroups:
{
Description: The data disks groups for the role. ,
Required: False ,
}
[
{
disksPerNode:
{
Description: The number of disks per node. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountType:
{
Description: ReadOnly. The storage account type. Do not set this value. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: ReadOnly. The DiskSize in GB. Do not set this value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
scriptActions:
{
Description: The list of script actions on the role. ,
Required: False ,
}
[
{
name:
{
Description: The name of the script action. ,
Required: True ,
}
string ,
uri:
{
Description: The URI to the script. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the script provided. ,
Required: True ,
}
string ,
}
,
]
,
encryptDataDisks:
{
Description: Indicates whether encrypt the data disks. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
installScriptActions:
{
Description: The list of install script actions. ,
Required: False ,
}
[
{
name:
{
Description: The name of the script action. ,
Required: True ,
}
string ,
uri:
{
Description: The URI to the script. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the script ,
Required: False ,
}
string ,
roles:
{
Description: The list of roles where script will be executed. ,
Required: True ,
}
[
string ,
]
,
applicationName:
{
Description: The application name of the script action, if any. ,
Required: False ,
}
string ,
}
,
]
,
uninstallScriptActions:
{
Description: The list of uninstall script actions. ,
Required: False ,
}
[
{
name:
{
Description: The name of the script action. ,
Required: True ,
}
string ,
uri:
{
Description: The URI to the script. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the script ,
Required: False ,
}
string ,
roles:
{
Description: The list of roles where script will be executed. ,
Required: True ,
}
[
string ,
]
,
applicationName:
{
Description: The application name of the script action, if any. ,
Required: False ,
}
string ,
}
,
]
,
httpsEndpoints:
{
Description: The list of application HTTPS endpoints. ,
Required: False ,
}
[
{
accessModes:
{
Description: The list of access modes for the application. ,
Required: False ,
}
[
string ,
]
,
location:
{
Description: The location of the endpoint. ,
Required: False ,
}
string ,
destinationPort:
{
Description: The destination port to connect to. ,
Format: int32 ,
Required: False ,
}
integer ,
publicPort:
{
Description: The public port to connect to. ,
Format: int32 ,
Required: False ,
}
integer ,
privateIPAddress:
{
Description: The private ip address of the endpoint. ,
Required: False ,
}
string ,
subDomainSuffix:
{
Description: The subdomain suffix of the application. ,
Required: False ,
}
string ,
disableGatewayAuth:
{
Description: The value indicates whether to disable GatewayAuth. ,
Required: False ,
}
boolean ,
}
,
]
,
sshEndpoints:
{
Description: The list of application SSH endpoints. ,
Required: False ,
}
[
{
location:
{
Description: The location of the endpoint. ,
Required: False ,
}
string ,
destinationPort:
{
Description: The destination port to connect to. ,
Format: int32 ,
Required: False ,
}
integer ,
publicPort:
{
Description: The public port to connect to. ,
Format: int32 ,
Required: False ,
}
integer ,
privateIPAddress:
{
Description: The private ip address of the endpoint. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the application. ,
Required: False ,
}
string ,
applicationType:
{
Description: The application type. ,
Required: False ,
}
string ,
applicationState:
{
Description: The application state. ,
Required: False ,
}
string ,
errors:
{
Description: The list of errors. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
createdDate:
{
Description: The application create date time. ,
Required: False ,
}
string ,
marketplaceIdentifier:
{
Description: The marketplace identifier. ,
Required: False ,
}
string ,
privateLinkConfigurations:
{
Description: The private link configurations. ,
Required: False ,
}
[
{
id:
{
Description: The private link configuration id. ,
Required: False ,
}
string ,
name:
{
Description: The name of private link configuration. ,
Required: True ,
}
string ,
type:
{
Description: The type of the private link configuration. ,
Required: False ,
}
string ,
properties:
{
Description: The private link configuration properties. ,
Required: True ,
}
{
groupId:
{
Description: The HDInsight private linkable sub-resource name to apply the private link configuration to. For example, 'headnode', 'gateway', 'edgenode'. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The private link configuration provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
ipConfigurations:
{
Description: The IP configurations for the private link service. ,
Required: True ,
}
[
{
id:
{
Description: The private link IP configuration id. ,
Required: False ,
}
string ,
name:
{
Description: The name of private link IP configuration. ,
Required: True ,
}
string ,
type:
{
Description: The type of the private link IP configuration. ,
Required: False ,
}
string ,
properties:
{
Description: The private link ip configuration properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The private link configuration provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
primary:
{
Description: Indicates whether this IP configuration is primary for the corresponding NIC. ,
Required: False ,
}
boolean ,
privateIPAddress:
{
Description: The IP address. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The method that private IP address is allocated. ,
Enum:
{
dynamic: No description available. ,
static: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: The subnet resource id. ,
Required: False ,
}
{
id:
{
Description: The azure resource id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
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)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag for the application ,
Required: False ,
}
string ,
tags:
{
Description: The tags for the application. ,
Required: False ,
}
object ,
properties:
{
Description: The properties of the application. ,
Required: False ,
}
{
computeProfile:
{
Description: The list of roles in the cluster. ,
Required: False ,
}
{
roles:
{
Description: The list of roles in the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: False ,
}
string ,
minInstanceCount:
{
Description: The minimum instance count of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
targetInstanceCount:
{
Description: The instance count of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
VMGroupName:
{
Description: The name of the virtual machine group. ,
Required: False ,
}
string ,
autoscale:
{
Description: The autoscale configurations. ,
Required: False ,
}
{
capacity:
{
Description: Parameters for load-based autoscale ,
Required: False ,
}
{
minInstanceCount:
{
Description: The minimum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
maxInstanceCount:
{
Description: The maximum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
recurrence:
{
Description: Parameters for schedule-based autoscale ,
Required: False ,
}
{
timeZone:
{
Description: The time zone for the autoscale schedule times ,
Required: False ,
}
string ,
schedule:
{
Description: Array of schedule-based autoscale rules ,
Required: False ,
}
[
{
days:
{
Description: Days of the week for a schedule-based autoscale rule ,
Required: False ,
}
[
string ,
]
,
timeAndCapacity:
{
Description: Time and capacity for a schedule-based autoscale rule ,
Required: False ,
}
{
time:
{
Description: 24-hour time in the form xx:xx ,
Required: False ,
}
string ,
minInstanceCount:
{
Description: The minimum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
maxInstanceCount:
{
Description: The maximum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
hardwareProfile:
{
Description: The hardware profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the VM ,
Required: False ,
}
string ,
}
,
osProfile:
{
Description: The operating system profile. ,
Required: False ,
}
{
linuxOperatingSystemProfile:
{
Description: The Linux OS profile. ,
Required: False ,
}
{
username:
{
Description: The username. ,
Required: False ,
}
string ,
password:
{
Description: The password. ,
Required: False ,
}
string ,
sshProfile:
{
Description: The SSH profile. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys. ,
Required: False ,
}
[
{
certificateData:
{
Description: The certificate for SSH. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
virtualNetworkProfile:
{
Description: The virtual network profile. ,
Required: False ,
}
{
id:
{
Description: The ID of the virtual network. ,
Required: False ,
}
string ,
subnet:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
}
,
dataDisksGroups:
{
Description: The data disks groups for the role. ,
Required: False ,
}
[
{
disksPerNode:
{
Description: The number of disks per node. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountType:
{
Description: ReadOnly. The storage account type. Do not set this value. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: ReadOnly. The DiskSize in GB. Do not set this value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
scriptActions:
{
Description: The list of script actions on the role. ,
Required: False ,
}
[
{
name:
{
Description: The name of the script action. ,
Required: True ,
}
string ,
uri:
{
Description: The URI to the script. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the script provided. ,
Required: True ,
}
string ,
}
,
]
,
encryptDataDisks:
{
Description: Indicates whether encrypt the data disks. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
installScriptActions:
{
Description: The list of install script actions. ,
Required: False ,
}
[
{
name:
{
Description: The name of the script action. ,
Required: True ,
}
string ,
uri:
{
Description: The URI to the script. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the script ,
Required: False ,
}
string ,
roles:
{
Description: The list of roles where script will be executed. ,
Required: True ,
}
[
string ,
]
,
applicationName:
{
Description: The application name of the script action, if any. ,
Required: False ,
}
string ,
}
,
]
,
uninstallScriptActions:
{
Description: The list of uninstall script actions. ,
Required: False ,
}
[
{
name:
{
Description: The name of the script action. ,
Required: True ,
}
string ,
uri:
{
Description: The URI to the script. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the script ,
Required: False ,
}
string ,
roles:
{
Description: The list of roles where script will be executed. ,
Required: True ,
}
[
string ,
]
,
applicationName:
{
Description: The application name of the script action, if any. ,
Required: False ,
}
string ,
}
,
]
,
httpsEndpoints:
{
Description: The list of application HTTPS endpoints. ,
Required: False ,
}
[
{
accessModes:
{
Description: The list of access modes for the application. ,
Required: False ,
}
[
string ,
]
,
location:
{
Description: The location of the endpoint. ,
Required: False ,
}
string ,
destinationPort:
{
Description: The destination port to connect to. ,
Format: int32 ,
Required: False ,
}
integer ,
publicPort:
{
Description: The public port to connect to. ,
Format: int32 ,
Required: False ,
}
integer ,
privateIPAddress:
{
Description: The private ip address of the endpoint. ,
Required: False ,
}
string ,
subDomainSuffix:
{
Description: The subdomain suffix of the application. ,
Required: False ,
}
string ,
disableGatewayAuth:
{
Description: The value indicates whether to disable GatewayAuth. ,
Required: False ,
}
boolean ,
}
,
]
,
sshEndpoints:
{
Description: The list of application SSH endpoints. ,
Required: False ,
}
[
{
location:
{
Description: The location of the endpoint. ,
Required: False ,
}
string ,
destinationPort:
{
Description: The destination port to connect to. ,
Format: int32 ,
Required: False ,
}
integer ,
publicPort:
{
Description: The public port to connect to. ,
Format: int32 ,
Required: False ,
}
integer ,
privateIPAddress:
{
Description: The private ip address of the endpoint. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the application. ,
Required: False ,
}
string ,
applicationType:
{
Description: The application type. ,
Required: False ,
}
string ,
applicationState:
{
Description: The application state. ,
Required: False ,
}
string ,
errors:
{
Description: The list of errors. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
createdDate:
{
Description: The application create date time. ,
Required: False ,
}
string ,
marketplaceIdentifier:
{
Description: The marketplace identifier. ,
Required: False ,
}
string ,
privateLinkConfigurations:
{
Description: The private link configurations. ,
Required: False ,
}
[
{
id:
{
Description: The private link configuration id. ,
Required: False ,
}
string ,
name:
{
Description: The name of private link configuration. ,
Required: True ,
}
string ,
type:
{
Description: The type of the private link configuration. ,
Required: False ,
}
string ,
properties:
{
Description: The private link configuration properties. ,
Required: True ,
}
{
groupId:
{
Description: The HDInsight private linkable sub-resource name to apply the private link configuration to. For example, 'headnode', 'gateway', 'edgenode'. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The private link configuration provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
ipConfigurations:
{
Description: The IP configurations for the private link service. ,
Required: True ,
}
[
{
id:
{
Description: The private link IP configuration id. ,
Required: False ,
}
string ,
name:
{
Description: The name of private link IP configuration. ,
Required: True ,
}
string ,
type:
{
Description: The type of the private link IP configuration. ,
Required: False ,
}
string ,
properties:
{
Description: The private link ip configuration properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The private link configuration provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
primary:
{
Description: Indicates whether this IP configuration is primary for the corresponding NIC. ,
Required: False ,
}
boolean ,
privateIPAddress:
{
Description: The IP address. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The method that private IP address is allocated. ,
Enum:
{
dynamic: No description available. ,
static: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: The subnet resource id. ,
Required: False ,
}
{
id:
{
Description: The azure resource id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
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 ,
}
,
}
Applications_Delete (new)
Description :  Deletes the specified application on the HDInsight cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/applications/{applicationName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
applicationName:
{
Description: The constant value for the application name. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Applications_GetAzureAsyncOperationStatus (new)
Description :  Gets the async operation status.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/applications/{applicationName}/azureasyncoperations/{operationId}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
applicationName:
{
Description: The constant value for the application name. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
operationId:
{
Description: The long running operation id. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The async operation state. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The operation error information. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Clusters_Create (new)
Description :  Creates a new HDInsight cluster with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The cluster create request. ,
Required: True ,
}
{
location:
{
Description: The location of the cluster. ,
Required: False ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: The cluster create parameters. ,
Required: False ,
}
{
clusterVersion:
{
Description: The version of the cluster. ,
Required: False ,
}
string ,
osType:
{
Description: The type of operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The cluster tier. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
clusterDefinition:
{
Description: The cluster definition. ,
Required: False ,
}
{
blueprint:
{
Description: The link to the blueprint. ,
Required: False ,
}
string ,
kind:
{
Description: The type of cluster. ,
Required: False ,
}
string ,
componentVersion:
{
Description: The versions of different services in the cluster. ,
Required: False ,
}
object ,
configurations:
{
Description: The cluster configurations. ,
Required: False ,
}
object ,
}
,
kafkaRestProperties:
{
Description: The cluster kafka rest proxy configuration. ,
Required: False ,
}
{
clientGroupInfo:
{
Description: The information of AAD security group. ,
Required: False ,
}
{
groupName:
{
Description: The AAD security group name. ,
Required: False ,
}
string ,
groupId:
{
Description: The AAD security group id. ,
Required: False ,
}
string ,
}
,
configurationOverride:
{
Description: The configurations that need to be overriden. ,
Required: False ,
}
object ,
}
,
securityProfile:
{
Description: The security profile. ,
Required: False ,
}
{
directoryType:
{
Description: The directory type. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
domain:
{
Description: The organization's active directory domain. ,
Required: False ,
}
string ,
organizationalUnitDN:
{
Description: The organizational unit within the Active Directory to place the cluster and service accounts. ,
Required: False ,
}
string ,
ldapsUrls:
{
Description: The LDAPS protocol URLs to communicate with the Active Directory. ,
Required: False ,
}
[
string ,
]
,
domainUsername:
{
Description: The domain user account that will have admin privileges on the cluster. ,
Required: False ,
}
string ,
domainUserPassword:
{
Description: The domain admin password. ,
Format: password ,
Required: False ,
}
string ,
clusterUsersGroupDNs:
{
Description: Optional. The Distinguished Names for cluster user groups ,
Required: False ,
}
[
string ,
]
,
aaddsResourceId:
{
Description: The resource ID of the user's Azure Active Directory Domain Service. ,
Required: False ,
}
string ,
msiResourceId:
{
Description: User assigned identity that has permissions to read and create cluster-related artifacts in the user's AADDS. ,
Required: False ,
}
string ,
}
,
computeProfile:
{
Description: The compute profile. ,
Required: False ,
}
{
roles:
{
Description: The list of roles in the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: False ,
}
string ,
minInstanceCount:
{
Description: The minimum instance count of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
targetInstanceCount:
{
Description: The instance count of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
VMGroupName:
{
Description: The name of the virtual machine group. ,
Required: False ,
}
string ,
autoscale:
{
Description: The autoscale configurations. ,
Required: False ,
}
{
capacity:
{
Description: Parameters for load-based autoscale ,
Required: False ,
}
{
minInstanceCount:
{
Description: The minimum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
maxInstanceCount:
{
Description: The maximum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
recurrence:
{
Description: Parameters for schedule-based autoscale ,
Required: False ,
}
{
timeZone:
{
Description: The time zone for the autoscale schedule times ,
Required: False ,
}
string ,
schedule:
{
Description: Array of schedule-based autoscale rules ,
Required: False ,
}
[
{
days:
{
Description: Days of the week for a schedule-based autoscale rule ,
Required: False ,
}
[
string ,
]
,
timeAndCapacity:
{
Description: Time and capacity for a schedule-based autoscale rule ,
Required: False ,
}
{
time:
{
Description: 24-hour time in the form xx:xx ,
Required: False ,
}
string ,
minInstanceCount:
{
Description: The minimum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
maxInstanceCount:
{
Description: The maximum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
hardwareProfile:
{
Description: The hardware profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the VM ,
Required: False ,
}
string ,
}
,
osProfile:
{
Description: The operating system profile. ,
Required: False ,
}
{
linuxOperatingSystemProfile:
{
Description: The Linux OS profile. ,
Required: False ,
}
{
username:
{
Description: The username. ,
Required: False ,
}
string ,
password:
{
Description: The password. ,
Required: False ,
}
string ,
sshProfile:
{
Description: The SSH profile. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys. ,
Required: False ,
}
[
{
certificateData:
{
Description: The certificate for SSH. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
virtualNetworkProfile:
{
Description: The virtual network profile. ,
Required: False ,
}
{
id:
{
Description: The ID of the virtual network. ,
Required: False ,
}
string ,
subnet:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
}
,
dataDisksGroups:
{
Description: The data disks groups for the role. ,
Required: False ,
}
[
{
disksPerNode:
{
Description: The number of disks per node. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountType:
{
Description: ReadOnly. The storage account type. Do not set this value. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: ReadOnly. The DiskSize in GB. Do not set this value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
scriptActions:
{
Description: The list of script actions on the role. ,
Required: False ,
}
[
{
name:
{
Description: The name of the script action. ,
Required: True ,
}
string ,
uri:
{
Description: The URI to the script. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the script provided. ,
Required: True ,
}
string ,
}
,
]
,
encryptDataDisks:
{
Description: Indicates whether encrypt the data disks. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
storageProfile:
{
Description: The storage profile. ,
Required: False ,
}
{
storageaccounts:
{
Description: The list of storage accounts in the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of the storage account. ,
Required: False ,
}
string ,
isDefault:
{
Description: Whether or not the storage account is the default storage account. ,
Required: False ,
}
boolean ,
container:
{
Description: The container in the storage account, only to be specified for WASB storage accounts. ,
Required: False ,
}
string ,
fileSystem:
{
Description: The filesystem, only to be specified for Azure Data Lake Storage Gen 2. ,
Required: False ,
}
string ,
key:
{
Description: The storage account access key. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource ID of storage account, only to be specified for Azure Data Lake Storage Gen 2. ,
Required: False ,
}
string ,
msiResourceId:
{
Description: The managed identity (MSI) that is allowed to access the storage account, only to be specified for Azure Data Lake Storage Gen 2. ,
Required: False ,
}
string ,
saskey:
{
Description: The shared access signature key. ,
Required: False ,
}
string ,
fileshare:
{
Description: The file share name. ,
Required: False ,
}
string ,
enableSecureChannel:
{
Description: Enable secure channel or not, it's an optional field. Default value is false when cluster version < 5.1 and true when cluster version >= 5.1 , ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
diskEncryptionProperties:
{
Description: The disk encryption properties. ,
Required: False ,
}
{
vaultUri:
{
Description: Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net ,
Required: False ,
}
string ,
keyName:
{
Description: Key name that is used for enabling disk encryption. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Specific key version that is used for enabling disk encryption. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: Algorithm identifier for encryption, default RSA-OAEP. ,
Enum:
{
RSA-OAEP: No description available. ,
RSA-OAEP-256: No description available. ,
RSA1_5: No description available. ,
}
,
Required: False ,
}
enum ,
msiResourceId:
{
Description: Resource ID of Managed Identity that is used to access the key vault. ,
Required: False ,
}
string ,
encryptionAtHost:
{
Description: Indicates whether or not resource disk encryption is enabled. ,
Required: False ,
}
boolean ,
}
,
encryptionInTransitProperties:
{
Description: The encryption-in-transit properties. ,
Required: False ,
}
{
isEncryptionInTransitEnabled:
{
Description: Indicates whether or not inter cluster node communication is encrypted in transit. ,
Required: False ,
}
boolean ,
}
,
minSupportedTlsVersion:
{
Description: The minimal supported tls version. ,
Required: False ,
}
string ,
networkProperties:
{
Description: The network properties. ,
Required: False ,
}
{
outboundDependenciesManagedType:
{
Description: A value to describe how the outbound dependencies of a HDInsight cluster are managed. 'Managed' means that the outbound dependencies are managed by the HDInsight service. 'External' means that the outbound dependencies are managed by a customer specific solution. ,
Enum:
{
Managed: No description available. ,
External: No description available. ,
}
,
Required: False ,
}
enum ,
resourceProviderConnection:
{
Description: The direction for the resource provider connection. ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
privateLink:
{
Description: Indicates whether or not private link is enabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
publicIpTag:
{
Description: Gets or sets the IP tag for the public IPs created along with the HDInsight Clusters. ,
Required: False ,
}
{
ipTagType:
{
Description: Gets or sets the ipTag type: Example FirstPartyUsage. ,
Required: True ,
}
string ,
tag:
{
Description: Gets or sets value of the IpTag associated with the public IP. Example HDInsight, SQL, Storage etc ,
Required: True ,
}
string ,
}
,
}
,
computeIsolationProperties:
{
Description: The compute isolation properties. ,
Required: False ,
}
{
enableComputeIsolation:
{
Description: The flag indicates whether enable compute isolation or not. ,
Required: False ,
}
boolean ,
hostSku:
{
Description: The host sku. ,
Required: False ,
}
string ,
}
,
privateLinkConfigurations:
{
Description: The private link configurations. ,
Required: False ,
}
[
{
id:
{
Description: The private link configuration id. ,
Required: False ,
}
string ,
name:
{
Description: The name of private link configuration. ,
Required: True ,
}
string ,
type:
{
Description: The type of the private link configuration. ,
Required: False ,
}
string ,
properties:
{
Description: The private link configuration properties. ,
Required: True ,
}
{
groupId:
{
Description: The HDInsight private linkable sub-resource name to apply the private link configuration to. For example, 'headnode', 'gateway', 'edgenode'. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The private link configuration provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
ipConfigurations:
{
Description: The IP configurations for the private link service. ,
Required: True ,
}
[
{
id:
{
Description: The private link IP configuration id. ,
Required: False ,
}
string ,
name:
{
Description: The name of private link IP configuration. ,
Required: True ,
}
string ,
type:
{
Description: The type of the private link IP configuration. ,
Required: False ,
}
string ,
properties:
{
Description: The private link ip configuration properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The private link configuration provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
primary:
{
Description: Indicates whether this IP configuration is primary for the corresponding NIC. ,
Required: False ,
}
boolean ,
privateIPAddress:
{
Description: The IP address. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The method that private IP address is allocated. ,
Enum:
{
dynamic: No description available. ,
static: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: The subnet resource id. ,
Required: False ,
}
{
id:
{
Description: The azure resource id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}
,
]
,
}
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of cluster identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the cluster. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cluster. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag for the resource ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: The properties of the cluster. ,
Required: False ,
}
{
clusterVersion:
{
Description: The version of the cluster. ,
Required: False ,
}
string ,
clusterHdpVersion:
{
Description: The hdp version of the cluster. ,
Required: False ,
}
string ,
osType:
{
Description: The type of operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The cluster tier. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: The cluster id. ,
Required: False ,
}
string ,
clusterDefinition:
{
Description: The cluster definition. ,
Required: True ,
}
{
blueprint:
{
Description: The link to the blueprint. ,
Required: False ,
}
string ,
kind:
{
Description: The type of cluster. ,
Required: False ,
}
string ,
componentVersion:
{
Description: The versions of different services in the cluster. ,
Required: False ,
}
object ,
configurations:
{
Description: The cluster configurations. ,
Required: False ,
}
object ,
}
,
kafkaRestProperties:
{
Description: The cluster kafka rest proxy configuration. ,
Required: False ,
}
{
clientGroupInfo:
{
Description: The information of AAD security group. ,
Required: False ,
}
{
groupName:
{
Description: The AAD security group name. ,
Required: False ,
}
string ,
groupId:
{
Description: The AAD security group id. ,
Required: False ,
}
string ,
}
,
configurationOverride:
{
Description: The configurations that need to be overriden. ,
Required: False ,
}
object ,
}
,
securityProfile:
{
Description: The security profile. ,
Required: False ,
}
{
directoryType:
{
Description: The directory type. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
domain:
{
Description: The organization's active directory domain. ,
Required: False ,
}
string ,
organizationalUnitDN:
{
Description: The organizational unit within the Active Directory to place the cluster and service accounts. ,
Required: False ,
}
string ,
ldapsUrls:
{
Description: The LDAPS protocol URLs to communicate with the Active Directory. ,
Required: False ,
}
[
string ,
]
,
domainUsername:
{
Description: The domain user account that will have admin privileges on the cluster. ,
Required: False ,
}
string ,
domainUserPassword:
{
Description: The domain admin password. ,
Format: password ,
Required: False ,
}
string ,
clusterUsersGroupDNs:
{
Description: Optional. The Distinguished Names for cluster user groups ,
Required: False ,
}
[
string ,
]
,
aaddsResourceId:
{
Description: The resource ID of the user's Azure Active Directory Domain Service. ,
Required: False ,
}
string ,
msiResourceId:
{
Description: User assigned identity that has permissions to read and create cluster-related artifacts in the user's AADDS. ,
Required: False ,
}
string ,
}
,
computeProfile:
{
Description: The compute profile. ,
Required: False ,
}
{
roles:
{
Description: The list of roles in the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: False ,
}
string ,
minInstanceCount:
{
Description: The minimum instance count of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
targetInstanceCount:
{
Description: The instance count of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
VMGroupName:
{
Description: The name of the virtual machine group. ,
Required: False ,
}
string ,
autoscale:
{
Description: The autoscale configurations. ,
Required: False ,
}
{
capacity:
{
Description: Parameters for load-based autoscale ,
Required: False ,
}
{
minInstanceCount:
{
Description: The minimum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
maxInstanceCount:
{
Description: The maximum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
recurrence:
{
Description: Parameters for schedule-based autoscale ,
Required: False ,
}
{
timeZone:
{
Description: The time zone for the autoscale schedule times ,
Required: False ,
}
string ,
schedule:
{
Description: Array of schedule-based autoscale rules ,
Required: False ,
}
[
{
days:
{
Description: Days of the week for a schedule-based autoscale rule ,
Required: False ,
}
[
string ,
]
,
timeAndCapacity:
{
Description: Time and capacity for a schedule-based autoscale rule ,
Required: False ,
}
{
time:
{
Description: 24-hour time in the form xx:xx ,
Required: False ,
}
string ,
minInstanceCount:
{
Description: The minimum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
maxInstanceCount:
{
Description: The maximum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
hardwareProfile:
{
Description: The hardware profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the VM ,
Required: False ,
}
string ,
}
,
osProfile:
{
Description: The operating system profile. ,
Required: False ,
}
{
linuxOperatingSystemProfile:
{
Description: The Linux OS profile. ,
Required: False ,
}
{
username:
{
Description: The username. ,
Required: False ,
}
string ,
password:
{
Description: The password. ,
Required: False ,
}
string ,
sshProfile:
{
Description: The SSH profile. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys. ,
Required: False ,
}
[
{
certificateData:
{
Description: The certificate for SSH. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
virtualNetworkProfile:
{
Description: The virtual network profile. ,
Required: False ,
}
{
id:
{
Description: The ID of the virtual network. ,
Required: False ,
}
string ,
subnet:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
}
,
dataDisksGroups:
{
Description: The data disks groups for the role. ,
Required: False ,
}
[
{
disksPerNode:
{
Description: The number of disks per node. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountType:
{
Description: ReadOnly. The storage account type. Do not set this value. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: ReadOnly. The DiskSize in GB. Do not set this value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
scriptActions:
{
Description: The list of script actions on the role. ,
Required: False ,
}
[
{
name:
{
Description: The name of the script action. ,
Required: True ,
}
string ,
uri:
{
Description: The URI to the script. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the script provided. ,
Required: True ,
}
string ,
}
,
]
,
encryptDataDisks:
{
Description: Indicates whether encrypt the data disks. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The date on which the cluster was created. ,
Required: False ,
}
string ,
clusterState:
{
Description: The state of the cluster. ,
Required: False ,
}
string ,
quotaInfo:
{
Description: The quota information. ,
Required: False ,
}
{
coresUsed:
{
Description: The cores used by the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
errors:
{
Description: The list of errors. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
connectivityEndpoints:
{
Description: The list of connectivity endpoints. ,
Required: False ,
}
[
{
name:
{
Description: The name of the endpoint. ,
Required: False ,
}
string ,
protocol:
{
Description: The protocol of the endpoint. ,
Required: False ,
}
string ,
location:
{
Description: The location of the endpoint. ,
Required: False ,
}
string ,
port:
{
Description: The port to connect to. ,
Format: int32 ,
Required: False ,
}
integer ,
privateIPAddress:
{
Description: The private ip address of the endpoint. ,
Required: False ,
}
string ,
}
,
]
,
diskEncryptionProperties:
{
Description: The disk encryption properties. ,
Required: False ,
}
{
vaultUri:
{
Description: Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net ,
Required: False ,
}
string ,
keyName:
{
Description: Key name that is used for enabling disk encryption. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Specific key version that is used for enabling disk encryption. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: Algorithm identifier for encryption, default RSA-OAEP. ,
Enum:
{
RSA-OAEP: No description available. ,
RSA-OAEP-256: No description available. ,
RSA1_5: No description available. ,
}
,
Required: False ,
}
enum ,
msiResourceId:
{
Description: Resource ID of Managed Identity that is used to access the key vault. ,
Required: False ,
}
string ,
encryptionAtHost:
{
Description: Indicates whether or not resource disk encryption is enabled. ,
Required: False ,
}
boolean ,
}
,
encryptionInTransitProperties:
{
Description: The encryption-in-transit properties. ,
Required: False ,
}
{
isEncryptionInTransitEnabled:
{
Description: Indicates whether or not inter cluster node communication is encrypted in transit. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: The storage profile. ,
Required: False ,
}
{
storageaccounts:
{
Description: The list of storage accounts in the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of the storage account. ,
Required: False ,
}
string ,
isDefault:
{
Description: Whether or not the storage account is the default storage account. ,
Required: False ,
}
boolean ,
container:
{
Description: The container in the storage account, only to be specified for WASB storage accounts. ,
Required: False ,
}
string ,
fileSystem:
{
Description: The filesystem, only to be specified for Azure Data Lake Storage Gen 2. ,
Required: False ,
}
string ,
key:
{
Description: The storage account access key. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource ID of storage account, only to be specified for Azure Data Lake Storage Gen 2. ,
Required: False ,
}
string ,
msiResourceId:
{
Description: The managed identity (MSI) that is allowed to access the storage account, only to be specified for Azure Data Lake Storage Gen 2. ,
Required: False ,
}
string ,
saskey:
{
Description: The shared access signature key. ,
Required: False ,
}
string ,
fileshare:
{
Description: The file share name. ,
Required: False ,
}
string ,
enableSecureChannel:
{
Description: Enable secure channel or not, it's an optional field. Default value is false when cluster version < 5.1 and true when cluster version >= 5.1 , ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
minSupportedTlsVersion:
{
Description: The minimal supported tls version. ,
Required: False ,
}
string ,
excludedServicesConfig:
{
Description: The excluded services config. ,
Required: False ,
}
{
excludedServicesConfigId:
{
Description: The config id of excluded services. ,
Required: False ,
}
string ,
excludedServicesList:
{
Description: The list of excluded services. ,
Required: False ,
}
string ,
}
,
networkProperties:
{
Description: The network properties. ,
Required: False ,
}
{
outboundDependenciesManagedType:
{
Description: A value to describe how the outbound dependencies of a HDInsight cluster are managed. 'Managed' means that the outbound dependencies are managed by the HDInsight service. 'External' means that the outbound dependencies are managed by a customer specific solution. ,
Enum:
{
Managed: No description available. ,
External: No description available. ,
}
,
Required: False ,
}
enum ,
resourceProviderConnection:
{
Description: The direction for the resource provider connection. ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
privateLink:
{
Description: Indicates whether or not private link is enabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
publicIpTag:
{
Description: Gets or sets the IP tag for the public IPs created along with the HDInsight Clusters. ,
Required: False ,
}
{
ipTagType:
{
Description: Gets or sets the ipTag type: Example FirstPartyUsage. ,
Required: True ,
}
string ,
tag:
{
Description: Gets or sets value of the IpTag associated with the public IP. Example HDInsight, SQL, Storage etc ,
Required: True ,
}
string ,
}
,
}
,
computeIsolationProperties:
{
Description: The compute isolation properties. ,
Required: False ,
}
{
enableComputeIsolation:
{
Description: The flag indicates whether enable compute isolation or not. ,
Required: False ,
}
boolean ,
hostSku:
{
Description: The host sku. ,
Required: False ,
}
string ,
}
,
privateLinkConfigurations:
{
Description: The private link configurations. ,
Required: False ,
}
[
{
id:
{
Description: The private link configuration id. ,
Required: False ,
}
string ,
name:
{
Description: The name of private link configuration. ,
Required: True ,
}
string ,
type:
{
Description: The type of the private link configuration. ,
Required: False ,
}
string ,
properties:
{
Description: The private link configuration properties. ,
Required: True ,
}
{
groupId:
{
Description: The HDInsight private linkable sub-resource name to apply the private link configuration to. For example, 'headnode', 'gateway', 'edgenode'. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The private link configuration provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
ipConfigurations:
{
Description: The IP configurations for the private link service. ,
Required: True ,
}
[
{
id:
{
Description: The private link IP configuration id. ,
Required: False ,
}
string ,
name:
{
Description: The name of private link IP configuration. ,
Required: True ,
}
string ,
type:
{
Description: The type of the private link IP configuration. ,
Required: False ,
}
string ,
properties:
{
Description: The private link ip configuration properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The private link configuration provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
primary:
{
Description: Indicates whether this IP configuration is primary for the corresponding NIC. ,
Required: False ,
}
boolean ,
privateIPAddress:
{
Description: The IP address. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The method that private IP address is allocated. ,
Enum:
{
dynamic: No description available. ,
static: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: The subnet resource id. ,
Required: False ,
}
{
id:
{
Description: The azure resource id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}
,
]
,
privateEndpointConnections:
{
Description: The list of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint of the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The private endpoint id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: True ,
}
{
status:
{
Description: The concrete private link service connection. ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
Pending: No description available. ,
Removed: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The optional description of the status. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Whether there is further actions. ,
Required: False ,
}
string ,
}
,
linkIdentifier:
{
Description: The link identifier. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
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 ,
}
,
}
,
]
,
}
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of cluster identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the cluster. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cluster. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
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 ,
}
,
}
Clusters_Update (new)
Description :  Patch HDInsight cluster with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The cluster patch request. ,
Required: True ,
}
{
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: The identity of the cluster, if configured. Setting this property will override the existing identity configuration of the cluster. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of cluster identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the cluster. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cluster. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag for the resource ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: The properties of the cluster. ,
Required: False ,
}
{
clusterVersion:
{
Description: The version of the cluster. ,
Required: False ,
}
string ,
clusterHdpVersion:
{
Description: The hdp version of the cluster. ,
Required: False ,
}
string ,
osType:
{
Description: The type of operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The cluster tier. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: The cluster id. ,
Required: False ,
}
string ,
clusterDefinition:
{
Description: The cluster definition. ,
Required: True ,
}
{
blueprint:
{
Description: The link to the blueprint. ,
Required: False ,
}
string ,
kind:
{
Description: The type of cluster. ,
Required: False ,
}
string ,
componentVersion:
{
Description: The versions of different services in the cluster. ,
Required: False ,
}
object ,
configurations:
{
Description: The cluster configurations. ,
Required: False ,
}
object ,
}
,
kafkaRestProperties:
{
Description: The cluster kafka rest proxy configuration. ,
Required: False ,
}
{
clientGroupInfo:
{
Description: The information of AAD security group. ,
Required: False ,
}
{
groupName:
{
Description: The AAD security group name. ,
Required: False ,
}
string ,
groupId:
{
Description: The AAD security group id. ,
Required: False ,
}
string ,
}
,
configurationOverride:
{
Description: The configurations that need to be overriden. ,
Required: False ,
}
object ,
}
,
securityProfile:
{
Description: The security profile. ,
Required: False ,
}
{
directoryType:
{
Description: The directory type. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
domain:
{
Description: The organization's active directory domain. ,
Required: False ,
}
string ,
organizationalUnitDN:
{
Description: The organizational unit within the Active Directory to place the cluster and service accounts. ,
Required: False ,
}
string ,
ldapsUrls:
{
Description: The LDAPS protocol URLs to communicate with the Active Directory. ,
Required: False ,
}
[
string ,
]
,
domainUsername:
{
Description: The domain user account that will have admin privileges on the cluster. ,
Required: False ,
}
string ,
domainUserPassword:
{
Description: The domain admin password. ,
Format: password ,
Required: False ,
}
string ,
clusterUsersGroupDNs:
{
Description: Optional. The Distinguished Names for cluster user groups ,
Required: False ,
}
[
string ,
]
,
aaddsResourceId:
{
Description: The resource ID of the user's Azure Active Directory Domain Service. ,
Required: False ,
}
string ,
msiResourceId:
{
Description: User assigned identity that has permissions to read and create cluster-related artifacts in the user's AADDS. ,
Required: False ,
}
string ,
}
,
computeProfile:
{
Description: The compute profile. ,
Required: False ,
}
{
roles:
{
Description: The list of roles in the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: False ,
}
string ,
minInstanceCount:
{
Description: The minimum instance count of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
targetInstanceCount:
{
Description: The instance count of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
VMGroupName:
{
Description: The name of the virtual machine group. ,
Required: False ,
}
string ,
autoscale:
{
Description: The autoscale configurations. ,
Required: False ,
}
{
capacity:
{
Description: Parameters for load-based autoscale ,
Required: False ,
}
{
minInstanceCount:
{
Description: The minimum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
maxInstanceCount:
{
Description: The maximum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
recurrence:
{
Description: Parameters for schedule-based autoscale ,
Required: False ,
}
{
timeZone:
{
Description: The time zone for the autoscale schedule times ,
Required: False ,
}
string ,
schedule:
{
Description: Array of schedule-based autoscale rules ,
Required: False ,
}
[
{
days:
{
Description: Days of the week for a schedule-based autoscale rule ,
Required: False ,
}
[
string ,
]
,
timeAndCapacity:
{
Description: Time and capacity for a schedule-based autoscale rule ,
Required: False ,
}
{
time:
{
Description: 24-hour time in the form xx:xx ,
Required: False ,
}
string ,
minInstanceCount:
{
Description: The minimum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
maxInstanceCount:
{
Description: The maximum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
hardwareProfile:
{
Description: The hardware profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the VM ,
Required: False ,
}
string ,
}
,
osProfile:
{
Description: The operating system profile. ,
Required: False ,
}
{
linuxOperatingSystemProfile:
{
Description: The Linux OS profile. ,
Required: False ,
}
{
username:
{
Description: The username. ,
Required: False ,
}
string ,
password:
{
Description: The password. ,
Required: False ,
}
string ,
sshProfile:
{
Description: The SSH profile. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys. ,
Required: False ,
}
[
{
certificateData:
{
Description: The certificate for SSH. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
virtualNetworkProfile:
{
Description: The virtual network profile. ,
Required: False ,
}
{
id:
{
Description: The ID of the virtual network. ,
Required: False ,
}
string ,
subnet:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
}
,
dataDisksGroups:
{
Description: The data disks groups for the role. ,
Required: False ,
}
[
{
disksPerNode:
{
Description: The number of disks per node. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountType:
{
Description: ReadOnly. The storage account type. Do not set this value. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: ReadOnly. The DiskSize in GB. Do not set this value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
scriptActions:
{
Description: The list of script actions on the role. ,
Required: False ,
}
[
{
name:
{
Description: The name of the script action. ,
Required: True ,
}
string ,
uri:
{
Description: The URI to the script. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the script provided. ,
Required: True ,
}
string ,
}
,
]
,
encryptDataDisks:
{
Description: Indicates whether encrypt the data disks. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The date on which the cluster was created. ,
Required: False ,
}
string ,
clusterState:
{
Description: The state of the cluster. ,
Required: False ,
}
string ,
quotaInfo:
{
Description: The quota information. ,
Required: False ,
}
{
coresUsed:
{
Description: The cores used by the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
errors:
{
Description: The list of errors. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
connectivityEndpoints:
{
Description: The list of connectivity endpoints. ,
Required: False ,
}
[
{
name:
{
Description: The name of the endpoint. ,
Required: False ,
}
string ,
protocol:
{
Description: The protocol of the endpoint. ,
Required: False ,
}
string ,
location:
{
Description: The location of the endpoint. ,
Required: False ,
}
string ,
port:
{
Description: The port to connect to. ,
Format: int32 ,
Required: False ,
}
integer ,
privateIPAddress:
{
Description: The private ip address of the endpoint. ,
Required: False ,
}
string ,
}
,
]
,
diskEncryptionProperties:
{
Description: The disk encryption properties. ,
Required: False ,
}
{
vaultUri:
{
Description: Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net ,
Required: False ,
}
string ,
keyName:
{
Description: Key name that is used for enabling disk encryption. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Specific key version that is used for enabling disk encryption. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: Algorithm identifier for encryption, default RSA-OAEP. ,
Enum:
{
RSA-OAEP: No description available. ,
RSA-OAEP-256: No description available. ,
RSA1_5: No description available. ,
}
,
Required: False ,
}
enum ,
msiResourceId:
{
Description: Resource ID of Managed Identity that is used to access the key vault. ,
Required: False ,
}
string ,
encryptionAtHost:
{
Description: Indicates whether or not resource disk encryption is enabled. ,
Required: False ,
}
boolean ,
}
,
encryptionInTransitProperties:
{
Description: The encryption-in-transit properties. ,
Required: False ,
}
{
isEncryptionInTransitEnabled:
{
Description: Indicates whether or not inter cluster node communication is encrypted in transit. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: The storage profile. ,
Required: False ,
}
{
storageaccounts:
{
Description: The list of storage accounts in the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of the storage account. ,
Required: False ,
}
string ,
isDefault:
{
Description: Whether or not the storage account is the default storage account. ,
Required: False ,
}
boolean ,
container:
{
Description: The container in the storage account, only to be specified for WASB storage accounts. ,
Required: False ,
}
string ,
fileSystem:
{
Description: The filesystem, only to be specified for Azure Data Lake Storage Gen 2. ,
Required: False ,
}
string ,
key:
{
Description: The storage account access key. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource ID of storage account, only to be specified for Azure Data Lake Storage Gen 2. ,
Required: False ,
}
string ,
msiResourceId:
{
Description: The managed identity (MSI) that is allowed to access the storage account, only to be specified for Azure Data Lake Storage Gen 2. ,
Required: False ,
}
string ,
saskey:
{
Description: The shared access signature key. ,
Required: False ,
}
string ,
fileshare:
{
Description: The file share name. ,
Required: False ,
}
string ,
enableSecureChannel:
{
Description: Enable secure channel or not, it's an optional field. Default value is false when cluster version < 5.1 and true when cluster version >= 5.1 , ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
minSupportedTlsVersion:
{
Description: The minimal supported tls version. ,
Required: False ,
}
string ,
excludedServicesConfig:
{
Description: The excluded services config. ,
Required: False ,
}
{
excludedServicesConfigId:
{
Description: The config id of excluded services. ,
Required: False ,
}
string ,
excludedServicesList:
{
Description: The list of excluded services. ,
Required: False ,
}
string ,
}
,
networkProperties:
{
Description: The network properties. ,
Required: False ,
}
{
outboundDependenciesManagedType:
{
Description: A value to describe how the outbound dependencies of a HDInsight cluster are managed. 'Managed' means that the outbound dependencies are managed by the HDInsight service. 'External' means that the outbound dependencies are managed by a customer specific solution. ,
Enum:
{
Managed: No description available. ,
External: No description available. ,
}
,
Required: False ,
}
enum ,
resourceProviderConnection:
{
Description: The direction for the resource provider connection. ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
privateLink:
{
Description: Indicates whether or not private link is enabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
publicIpTag:
{
Description: Gets or sets the IP tag for the public IPs created along with the HDInsight Clusters. ,
Required: False ,
}
{
ipTagType:
{
Description: Gets or sets the ipTag type: Example FirstPartyUsage. ,
Required: True ,
}
string ,
tag:
{
Description: Gets or sets value of the IpTag associated with the public IP. Example HDInsight, SQL, Storage etc ,
Required: True ,
}
string ,
}
,
}
,
computeIsolationProperties:
{
Description: The compute isolation properties. ,
Required: False ,
}
{
enableComputeIsolation:
{
Description: The flag indicates whether enable compute isolation or not. ,
Required: False ,
}
boolean ,
hostSku:
{
Description: The host sku. ,
Required: False ,
}
string ,
}
,
privateLinkConfigurations:
{
Description: The private link configurations. ,
Required: False ,
}
[
{
id:
{
Description: The private link configuration id. ,
Required: False ,
}
string ,
name:
{
Description: The name of private link configuration. ,
Required: True ,
}
string ,
type:
{
Description: The type of the private link configuration. ,
Required: False ,
}
string ,
properties:
{
Description: The private link configuration properties. ,
Required: True ,
}
{
groupId:
{
Description: The HDInsight private linkable sub-resource name to apply the private link configuration to. For example, 'headnode', 'gateway', 'edgenode'. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The private link configuration provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
ipConfigurations:
{
Description: The IP configurations for the private link service. ,
Required: True ,
}
[
{
id:
{
Description: The private link IP configuration id. ,
Required: False ,
}
string ,
name:
{
Description: The name of private link IP configuration. ,
Required: True ,
}
string ,
type:
{
Description: The type of the private link IP configuration. ,
Required: False ,
}
string ,
properties:
{
Description: The private link ip configuration properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The private link configuration provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
primary:
{
Description: Indicates whether this IP configuration is primary for the corresponding NIC. ,
Required: False ,
}
boolean ,
privateIPAddress:
{
Description: The IP address. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The method that private IP address is allocated. ,
Enum:
{
dynamic: No description available. ,
static: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: The subnet resource id. ,
Required: False ,
}
{
id:
{
Description: The azure resource id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}
,
]
,
privateEndpointConnections:
{
Description: The list of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint of the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The private endpoint id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: True ,
}
{
status:
{
Description: The concrete private link service connection. ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
Pending: No description available. ,
Removed: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The optional description of the status. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Whether there is further actions. ,
Required: False ,
}
string ,
}
,
linkIdentifier:
{
Description: The link identifier. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
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 ,
}
,
}
,
]
,
}
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of cluster identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the cluster. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cluster. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
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 ,
}
,
}
Clusters_Delete (new)
Description :  Deletes the specified HDInsight cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ Response (204)

{}
Clusters_Get (new)
Description :  Gets the specified cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag for the resource ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: The properties of the cluster. ,
Required: False ,
}
{
clusterVersion:
{
Description: The version of the cluster. ,
Required: False ,
}
string ,
clusterHdpVersion:
{
Description: The hdp version of the cluster. ,
Required: False ,
}
string ,
osType:
{
Description: The type of operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The cluster tier. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: The cluster id. ,
Required: False ,
}
string ,
clusterDefinition:
{
Description: The cluster definition. ,
Required: True ,
}
{
blueprint:
{
Description: The link to the blueprint. ,
Required: False ,
}
string ,
kind:
{
Description: The type of cluster. ,
Required: False ,
}
string ,
componentVersion:
{
Description: The versions of different services in the cluster. ,
Required: False ,
}
object ,
configurations:
{
Description: The cluster configurations. ,
Required: False ,
}
object ,
}
,
kafkaRestProperties:
{
Description: The cluster kafka rest proxy configuration. ,
Required: False ,
}
{
clientGroupInfo:
{
Description: The information of AAD security group. ,
Required: False ,
}
{
groupName:
{
Description: The AAD security group name. ,
Required: False ,
}
string ,
groupId:
{
Description: The AAD security group id. ,
Required: False ,
}
string ,
}
,
configurationOverride:
{
Description: The configurations that need to be overriden. ,
Required: False ,
}
object ,
}
,
securityProfile:
{
Description: The security profile. ,
Required: False ,
}
{
directoryType:
{
Description: The directory type. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
domain:
{
Description: The organization's active directory domain. ,
Required: False ,
}
string ,
organizationalUnitDN:
{
Description: The organizational unit within the Active Directory to place the cluster and service accounts. ,
Required: False ,
}
string ,
ldapsUrls:
{
Description: The LDAPS protocol URLs to communicate with the Active Directory. ,
Required: False ,
}
[
string ,
]
,
domainUsername:
{
Description: The domain user account that will have admin privileges on the cluster. ,
Required: False ,
}
string ,
domainUserPassword:
{
Description: The domain admin password. ,
Format: password ,
Required: False ,
}
string ,
clusterUsersGroupDNs:
{
Description: Optional. The Distinguished Names for cluster user groups ,
Required: False ,
}
[
string ,
]
,
aaddsResourceId:
{
Description: The resource ID of the user's Azure Active Directory Domain Service. ,
Required: False ,
}
string ,
msiResourceId:
{
Description: User assigned identity that has permissions to read and create cluster-related artifacts in the user's AADDS. ,
Required: False ,
}
string ,
}
,
computeProfile:
{
Description: The compute profile. ,
Required: False ,
}
{
roles:
{
Description: The list of roles in the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: False ,
}
string ,
minInstanceCount:
{
Description: The minimum instance count of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
targetInstanceCount:
{
Description: The instance count of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
VMGroupName:
{
Description: The name of the virtual machine group. ,
Required: False ,
}
string ,
autoscale:
{
Description: The autoscale configurations. ,
Required: False ,
}
{
capacity:
{
Description: Parameters for load-based autoscale ,
Required: False ,
}
{
minInstanceCount:
{
Description: The minimum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
maxInstanceCount:
{
Description: The maximum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
recurrence:
{
Description: Parameters for schedule-based autoscale ,
Required: False ,
}
{
timeZone:
{
Description: The time zone for the autoscale schedule times ,
Required: False ,
}
string ,
schedule:
{
Description: Array of schedule-based autoscale rules ,
Required: False ,
}
[
{
days:
{
Description: Days of the week for a schedule-based autoscale rule ,
Required: False ,
}
[
string ,
]
,
timeAndCapacity:
{
Description: Time and capacity for a schedule-based autoscale rule ,
Required: False ,
}
{
time:
{
Description: 24-hour time in the form xx:xx ,
Required: False ,
}
string ,
minInstanceCount:
{
Description: The minimum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
maxInstanceCount:
{
Description: The maximum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
hardwareProfile:
{
Description: The hardware profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the VM ,
Required: False ,
}
string ,
}
,
osProfile:
{
Description: The operating system profile. ,
Required: False ,
}
{
linuxOperatingSystemProfile:
{
Description: The Linux OS profile. ,
Required: False ,
}
{
username:
{
Description: The username. ,
Required: False ,
}
string ,
password:
{
Description: The password. ,
Required: False ,
}
string ,
sshProfile:
{
Description: The SSH profile. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys. ,
Required: False ,
}
[
{
certificateData:
{
Description: The certificate for SSH. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
virtualNetworkProfile:
{
Description: The virtual network profile. ,
Required: False ,
}
{
id:
{
Description: The ID of the virtual network. ,
Required: False ,
}
string ,
subnet:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
}
,
dataDisksGroups:
{
Description: The data disks groups for the role. ,
Required: False ,
}
[
{
disksPerNode:
{
Description: The number of disks per node. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountType:
{
Description: ReadOnly. The storage account type. Do not set this value. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: ReadOnly. The DiskSize in GB. Do not set this value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
scriptActions:
{
Description: The list of script actions on the role. ,
Required: False ,
}
[
{
name:
{
Description: The name of the script action. ,
Required: True ,
}
string ,
uri:
{
Description: The URI to the script. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the script provided. ,
Required: True ,
}
string ,
}
,
]
,
encryptDataDisks:
{
Description: Indicates whether encrypt the data disks. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The date on which the cluster was created. ,
Required: False ,
}
string ,
clusterState:
{
Description: The state of the cluster. ,
Required: False ,
}
string ,
quotaInfo:
{
Description: The quota information. ,
Required: False ,
}
{
coresUsed:
{
Description: The cores used by the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
errors:
{
Description: The list of errors. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
connectivityEndpoints:
{
Description: The list of connectivity endpoints. ,
Required: False ,
}
[
{
name:
{
Description: The name of the endpoint. ,
Required: False ,
}
string ,
protocol:
{
Description: The protocol of the endpoint. ,
Required: False ,
}
string ,
location:
{
Description: The location of the endpoint. ,
Required: False ,
}
string ,
port:
{
Description: The port to connect to. ,
Format: int32 ,
Required: False ,
}
integer ,
privateIPAddress:
{
Description: The private ip address of the endpoint. ,
Required: False ,
}
string ,
}
,
]
,
diskEncryptionProperties:
{
Description: The disk encryption properties. ,
Required: False ,
}
{
vaultUri:
{
Description: Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net ,
Required: False ,
}
string ,
keyName:
{
Description: Key name that is used for enabling disk encryption. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Specific key version that is used for enabling disk encryption. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: Algorithm identifier for encryption, default RSA-OAEP. ,
Enum:
{
RSA-OAEP: No description available. ,
RSA-OAEP-256: No description available. ,
RSA1_5: No description available. ,
}
,
Required: False ,
}
enum ,
msiResourceId:
{
Description: Resource ID of Managed Identity that is used to access the key vault. ,
Required: False ,
}
string ,
encryptionAtHost:
{
Description: Indicates whether or not resource disk encryption is enabled. ,
Required: False ,
}
boolean ,
}
,
encryptionInTransitProperties:
{
Description: The encryption-in-transit properties. ,
Required: False ,
}
{
isEncryptionInTransitEnabled:
{
Description: Indicates whether or not inter cluster node communication is encrypted in transit. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: The storage profile. ,
Required: False ,
}
{
storageaccounts:
{
Description: The list of storage accounts in the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of the storage account. ,
Required: False ,
}
string ,
isDefault:
{
Description: Whether or not the storage account is the default storage account. ,
Required: False ,
}
boolean ,
container:
{
Description: The container in the storage account, only to be specified for WASB storage accounts. ,
Required: False ,
}
string ,
fileSystem:
{
Description: The filesystem, only to be specified for Azure Data Lake Storage Gen 2. ,
Required: False ,
}
string ,
key:
{
Description: The storage account access key. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource ID of storage account, only to be specified for Azure Data Lake Storage Gen 2. ,
Required: False ,
}
string ,
msiResourceId:
{
Description: The managed identity (MSI) that is allowed to access the storage account, only to be specified for Azure Data Lake Storage Gen 2. ,
Required: False ,
}
string ,
saskey:
{
Description: The shared access signature key. ,
Required: False ,
}
string ,
fileshare:
{
Description: The file share name. ,
Required: False ,
}
string ,
enableSecureChannel:
{
Description: Enable secure channel or not, it's an optional field. Default value is false when cluster version < 5.1 and true when cluster version >= 5.1 , ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
minSupportedTlsVersion:
{
Description: The minimal supported tls version. ,
Required: False ,
}
string ,
excludedServicesConfig:
{
Description: The excluded services config. ,
Required: False ,
}
{
excludedServicesConfigId:
{
Description: The config id of excluded services. ,
Required: False ,
}
string ,
excludedServicesList:
{
Description: The list of excluded services. ,
Required: False ,
}
string ,
}
,
networkProperties:
{
Description: The network properties. ,
Required: False ,
}
{
outboundDependenciesManagedType:
{
Description: A value to describe how the outbound dependencies of a HDInsight cluster are managed. 'Managed' means that the outbound dependencies are managed by the HDInsight service. 'External' means that the outbound dependencies are managed by a customer specific solution. ,
Enum:
{
Managed: No description available. ,
External: No description available. ,
}
,
Required: False ,
}
enum ,
resourceProviderConnection:
{
Description: The direction for the resource provider connection. ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
privateLink:
{
Description: Indicates whether or not private link is enabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
publicIpTag:
{
Description: Gets or sets the IP tag for the public IPs created along with the HDInsight Clusters. ,
Required: False ,
}
{
ipTagType:
{
Description: Gets or sets the ipTag type: Example FirstPartyUsage. ,
Required: True ,
}
string ,
tag:
{
Description: Gets or sets value of the IpTag associated with the public IP. Example HDInsight, SQL, Storage etc ,
Required: True ,
}
string ,
}
,
}
,
computeIsolationProperties:
{
Description: The compute isolation properties. ,
Required: False ,
}
{
enableComputeIsolation:
{
Description: The flag indicates whether enable compute isolation or not. ,
Required: False ,
}
boolean ,
hostSku:
{
Description: The host sku. ,
Required: False ,
}
string ,
}
,
privateLinkConfigurations:
{
Description: The private link configurations. ,
Required: False ,
}
[
{
id:
{
Description: The private link configuration id. ,
Required: False ,
}
string ,
name:
{
Description: The name of private link configuration. ,
Required: True ,
}
string ,
type:
{
Description: The type of the private link configuration. ,
Required: False ,
}
string ,
properties:
{
Description: The private link configuration properties. ,
Required: True ,
}
{
groupId:
{
Description: The HDInsight private linkable sub-resource name to apply the private link configuration to. For example, 'headnode', 'gateway', 'edgenode'. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The private link configuration provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
ipConfigurations:
{
Description: The IP configurations for the private link service. ,
Required: True ,
}
[
{
id:
{
Description: The private link IP configuration id. ,
Required: False ,
}
string ,
name:
{
Description: The name of private link IP configuration. ,
Required: True ,
}
string ,
type:
{
Description: The type of the private link IP configuration. ,
Required: False ,
}
string ,
properties:
{
Description: The private link ip configuration properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The private link configuration provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
primary:
{
Description: Indicates whether this IP configuration is primary for the corresponding NIC. ,
Required: False ,
}
boolean ,
privateIPAddress:
{
Description: The IP address. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The method that private IP address is allocated. ,
Enum:
{
dynamic: No description available. ,
static: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: The subnet resource id. ,
Required: False ,
}
{
id:
{
Description: The azure resource id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}
,
]
,
privateEndpointConnections:
{
Description: The list of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint of the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The private endpoint id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: True ,
}
{
status:
{
Description: The concrete private link service connection. ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
Pending: No description available. ,
Removed: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The optional description of the status. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Whether there is further actions. ,
Required: False ,
}
string ,
}
,
linkIdentifier:
{
Description: The link identifier. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
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 ,
}
,
}
,
]
,
}
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of cluster identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the cluster. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cluster. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
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 ,
}
,
}
Clusters_ListByResourceGroup (new)
Description :  Lists the HDInsight clusters in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Clusters. ,
Required: False ,
}
[
{
etag:
{
Description: The ETag for the resource ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: The properties of the cluster. ,
Required: False ,
}
{
clusterVersion:
{
Description: The version of the cluster. ,
Required: False ,
}
string ,
clusterHdpVersion:
{
Description: The hdp version of the cluster. ,
Required: False ,
}
string ,
osType:
{
Description: The type of operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The cluster tier. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: The cluster id. ,
Required: False ,
}
string ,
clusterDefinition:
{
Description: The cluster definition. ,
Required: True ,
}
{
blueprint:
{
Description: The link to the blueprint. ,
Required: False ,
}
string ,
kind:
{
Description: The type of cluster. ,
Required: False ,
}
string ,
componentVersion:
{
Description: The versions of different services in the cluster. ,
Required: False ,
}
object ,
configurations:
{
Description: The cluster configurations. ,
Required: False ,
}
object ,
}
,
kafkaRestProperties:
{
Description: The cluster kafka rest proxy configuration. ,
Required: False ,
}
{
clientGroupInfo:
{
Description: The information of AAD security group. ,
Required: False ,
}
{
groupName:
{
Description: The AAD security group name. ,
Required: False ,
}
string ,
groupId:
{
Description: The AAD security group id. ,
Required: False ,
}
string ,
}
,
configurationOverride:
{
Description: The configurations that need to be overriden. ,
Required: False ,
}
object ,
}
,
securityProfile:
{
Description: The security profile. ,
Required: False ,
}
{
directoryType:
{
Description: The directory type. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
domain:
{
Description: The organization's active directory domain. ,
Required: False ,
}
string ,
organizationalUnitDN:
{
Description: The organizational unit within the Active Directory to place the cluster and service accounts. ,
Required: False ,
}
string ,
ldapsUrls:
{
Description: The LDAPS protocol URLs to communicate with the Active Directory. ,
Required: False ,
}
[
string ,
]
,
domainUsername:
{
Description: The domain user account that will have admin privileges on the cluster. ,
Required: False ,
}
string ,
domainUserPassword:
{
Description: The domain admin password. ,
Format: password ,
Required: False ,
}
string ,
clusterUsersGroupDNs:
{
Description: Optional. The Distinguished Names for cluster user groups ,
Required: False ,
}
[
string ,
]
,
aaddsResourceId:
{
Description: The resource ID of the user's Azure Active Directory Domain Service. ,
Required: False ,
}
string ,
msiResourceId:
{
Description: User assigned identity that has permissions to read and create cluster-related artifacts in the user's AADDS. ,
Required: False ,
}
string ,
}
,
computeProfile:
{
Description: The compute profile. ,
Required: False ,
}
{
roles:
{
Description: The list of roles in the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: False ,
}
string ,
minInstanceCount:
{
Description: The minimum instance count of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
targetInstanceCount:
{
Description: The instance count of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
VMGroupName:
{
Description: The name of the virtual machine group. ,
Required: False ,
}
string ,
autoscale:
{
Description: The autoscale configurations. ,
Required: False ,
}
{
capacity:
{
Description: Parameters for load-based autoscale ,
Required: False ,
}
{
minInstanceCount:
{
Description: The minimum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
maxInstanceCount:
{
Description: The maximum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
recurrence:
{
Description: Parameters for schedule-based autoscale ,
Required: False ,
}
{
timeZone:
{
Description: The time zone for the autoscale schedule times ,
Required: False ,
}
string ,
schedule:
{
Description: Array of schedule-based autoscale rules ,
Required: False ,
}
[
{
days:
{
Description: Days of the week for a schedule-based autoscale rule ,
Required: False ,
}
[
string ,
]
,
timeAndCapacity:
{
Description: Time and capacity for a schedule-based autoscale rule ,
Required: False ,
}
{
time:
{
Description: 24-hour time in the form xx:xx ,
Required: False ,
}
string ,
minInstanceCount:
{
Description: The minimum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
maxInstanceCount:
{
Description: The maximum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
hardwareProfile:
{
Description: The hardware profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the VM ,
Required: False ,
}
string ,
}
,
osProfile:
{
Description: The operating system profile. ,
Required: False ,
}
{
linuxOperatingSystemProfile:
{
Description: The Linux OS profile. ,
Required: False ,
}
{
username:
{
Description: The username. ,
Required: False ,
}
string ,
password:
{
Description: The password. ,
Required: False ,
}
string ,
sshProfile:
{
Description: The SSH profile. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys. ,
Required: False ,
}
[
{
certificateData:
{
Description: The certificate for SSH. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
virtualNetworkProfile:
{
Description: The virtual network profile. ,
Required: False ,
}
{
id:
{
Description: The ID of the virtual network. ,
Required: False ,
}
string ,
subnet:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
}
,
dataDisksGroups:
{
Description: The data disks groups for the role. ,
Required: False ,
}
[
{
disksPerNode:
{
Description: The number of disks per node. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountType:
{
Description: ReadOnly. The storage account type. Do not set this value. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: ReadOnly. The DiskSize in GB. Do not set this value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
scriptActions:
{
Description: The list of script actions on the role. ,
Required: False ,
}
[
{
name:
{
Description: The name of the script action. ,
Required: True ,
}
string ,
uri:
{
Description: The URI to the script. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the script provided. ,
Required: True ,
}
string ,
}
,
]
,
encryptDataDisks:
{
Description: Indicates whether encrypt the data disks. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The date on which the cluster was created. ,
Required: False ,
}
string ,
clusterState:
{
Description: The state of the cluster. ,
Required: False ,
}
string ,
quotaInfo:
{
Description: The quota information. ,
Required: False ,
}
{
coresUsed:
{
Description: The cores used by the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
errors:
{
Description: The list of errors. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
connectivityEndpoints:
{
Description: The list of connectivity endpoints. ,
Required: False ,
}
[
{
name:
{
Description: The name of the endpoint. ,
Required: False ,
}
string ,
protocol:
{
Description: The protocol of the endpoint. ,
Required: False ,
}
string ,
location:
{
Description: The location of the endpoint. ,
Required: False ,
}
string ,
port:
{
Description: The port to connect to. ,
Format: int32 ,
Required: False ,
}
integer ,
privateIPAddress:
{
Description: The private ip address of the endpoint. ,
Required: False ,
}
string ,
}
,
]
,
diskEncryptionProperties:
{
Description: The disk encryption properties. ,
Required: False ,
}
{
vaultUri:
{
Description: Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net ,
Required: False ,
}
string ,
keyName:
{
Description: Key name that is used for enabling disk encryption. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Specific key version that is used for enabling disk encryption. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: Algorithm identifier for encryption, default RSA-OAEP. ,
Enum:
{
RSA-OAEP: No description available. ,
RSA-OAEP-256: No description available. ,
RSA1_5: No description available. ,
}
,
Required: False ,
}
enum ,
msiResourceId:
{
Description: Resource ID of Managed Identity that is used to access the key vault. ,
Required: False ,
}
string ,
encryptionAtHost:
{
Description: Indicates whether or not resource disk encryption is enabled. ,
Required: False ,
}
boolean ,
}
,
encryptionInTransitProperties:
{
Description: The encryption-in-transit properties. ,
Required: False ,
}
{
isEncryptionInTransitEnabled:
{
Description: Indicates whether or not inter cluster node communication is encrypted in transit. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: The storage profile. ,
Required: False ,
}
{
storageaccounts:
{
Description: The list of storage accounts in the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of the storage account. ,
Required: False ,
}
string ,
isDefault:
{
Description: Whether or not the storage account is the default storage account. ,
Required: False ,
}
boolean ,
container:
{
Description: The container in the storage account, only to be specified for WASB storage accounts. ,
Required: False ,
}
string ,
fileSystem:
{
Description: The filesystem, only to be specified for Azure Data Lake Storage Gen 2. ,
Required: False ,
}
string ,
key:
{
Description: The storage account access key. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource ID of storage account, only to be specified for Azure Data Lake Storage Gen 2. ,
Required: False ,
}
string ,
msiResourceId:
{
Description: The managed identity (MSI) that is allowed to access the storage account, only to be specified for Azure Data Lake Storage Gen 2. ,
Required: False ,
}
string ,
saskey:
{
Description: The shared access signature key. ,
Required: False ,
}
string ,
fileshare:
{
Description: The file share name. ,
Required: False ,
}
string ,
enableSecureChannel:
{
Description: Enable secure channel or not, it's an optional field. Default value is false when cluster version < 5.1 and true when cluster version >= 5.1 , ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
minSupportedTlsVersion:
{
Description: The minimal supported tls version. ,
Required: False ,
}
string ,
excludedServicesConfig:
{
Description: The excluded services config. ,
Required: False ,
}
{
excludedServicesConfigId:
{
Description: The config id of excluded services. ,
Required: False ,
}
string ,
excludedServicesList:
{
Description: The list of excluded services. ,
Required: False ,
}
string ,
}
,
networkProperties:
{
Description: The network properties. ,
Required: False ,
}
{
outboundDependenciesManagedType:
{
Description: A value to describe how the outbound dependencies of a HDInsight cluster are managed. 'Managed' means that the outbound dependencies are managed by the HDInsight service. 'External' means that the outbound dependencies are managed by a customer specific solution. ,
Enum:
{
Managed: No description available. ,
External: No description available. ,
}
,
Required: False ,
}
enum ,
resourceProviderConnection:
{
Description: The direction for the resource provider connection. ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
privateLink:
{
Description: Indicates whether or not private link is enabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
publicIpTag:
{
Description: Gets or sets the IP tag for the public IPs created along with the HDInsight Clusters. ,
Required: False ,
}
{
ipTagType:
{
Description: Gets or sets the ipTag type: Example FirstPartyUsage. ,
Required: True ,
}
string ,
tag:
{
Description: Gets or sets value of the IpTag associated with the public IP. Example HDInsight, SQL, Storage etc ,
Required: True ,
}
string ,
}
,
}
,
computeIsolationProperties:
{
Description: The compute isolation properties. ,
Required: False ,
}
{
enableComputeIsolation:
{
Description: The flag indicates whether enable compute isolation or not. ,
Required: False ,
}
boolean ,
hostSku:
{
Description: The host sku. ,
Required: False ,
}
string ,
}
,
privateLinkConfigurations:
{
Description: The private link configurations. ,
Required: False ,
}
[
{
id:
{
Description: The private link configuration id. ,
Required: False ,
}
string ,
name:
{
Description: The name of private link configuration. ,
Required: True ,
}
string ,
type:
{
Description: The type of the private link configuration. ,
Required: False ,
}
string ,
properties:
{
Description: The private link configuration properties. ,
Required: True ,
}
{
groupId:
{
Description: The HDInsight private linkable sub-resource name to apply the private link configuration to. For example, 'headnode', 'gateway', 'edgenode'. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The private link configuration provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
ipConfigurations:
{
Description: The IP configurations for the private link service. ,
Required: True ,
}
[
{
id:
{
Description: The private link IP configuration id. ,
Required: False ,
}
string ,
name:
{
Description: The name of private link IP configuration. ,
Required: True ,
}
string ,
type:
{
Description: The type of the private link IP configuration. ,
Required: False ,
}
string ,
properties:
{
Description: The private link ip configuration properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The private link configuration provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
primary:
{
Description: Indicates whether this IP configuration is primary for the corresponding NIC. ,
Required: False ,
}
boolean ,
privateIPAddress:
{
Description: The IP address. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The method that private IP address is allocated. ,
Enum:
{
dynamic: No description available. ,
static: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: The subnet resource id. ,
Required: False ,
}
{
id:
{
Description: The azure resource id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}
,
]
,
privateEndpointConnections:
{
Description: The list of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint of the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The private endpoint id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: True ,
}
{
status:
{
Description: The concrete private link service connection. ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
Pending: No description available. ,
Removed: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The optional description of the status. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Whether there is further actions. ,
Required: False ,
}
string ,
}
,
linkIdentifier:
{
Description: The link identifier. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
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 ,
}
,
}
,
]
,
}
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of cluster identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the cluster. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cluster. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
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 ,
}
Clusters_Resize (new)
Description :  Resizes the specified HDInsight cluster to the specified size.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/roles/{roleName}/resize
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
roleName:
{
Description: The constant value for the roleName ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the resize operation. ,
Required: True ,
}
{
targetInstanceCount:
{
Description: The target instance count for the operation. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
Clusters_UpdateAutoScaleConfiguration (new)
Description :  Updates the Autoscale Configuration for HDInsight cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/roles/{roleName}/autoscale
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
roleName:
{
Description: The constant value for the roleName ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the update autoscale configuration operation. ,
Required: True ,
}
{
autoscale:
{
Description: The autoscale configuration. ,
Required: False ,
}
{
capacity:
{
Description: Parameters for load-based autoscale ,
Required: False ,
}
{
minInstanceCount:
{
Description: The minimum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
maxInstanceCount:
{
Description: The maximum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
recurrence:
{
Description: Parameters for schedule-based autoscale ,
Required: False ,
}
{
timeZone:
{
Description: The time zone for the autoscale schedule times ,
Required: False ,
}
string ,
schedule:
{
Description: Array of schedule-based autoscale rules ,
Required: False ,
}
[
{
days:
{
Description: Days of the week for a schedule-based autoscale rule ,
Required: False ,
}
[
string ,
]
,
timeAndCapacity:
{
Description: Time and capacity for a schedule-based autoscale rule ,
Required: False ,
}
{
time:
{
Description: 24-hour time in the form xx:xx ,
Required: False ,
}
string ,
minInstanceCount:
{
Description: The minimum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
maxInstanceCount:
{
Description: The maximum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
Clusters_List (new)
Description :  Lists all the HDInsight clusters under the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/clusters
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Clusters. ,
Required: False ,
}
[
{
etag:
{
Description: The ETag for the resource ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: The properties of the cluster. ,
Required: False ,
}
{
clusterVersion:
{
Description: The version of the cluster. ,
Required: False ,
}
string ,
clusterHdpVersion:
{
Description: The hdp version of the cluster. ,
Required: False ,
}
string ,
osType:
{
Description: The type of operating system. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The cluster tier. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: The cluster id. ,
Required: False ,
}
string ,
clusterDefinition:
{
Description: The cluster definition. ,
Required: True ,
}
{
blueprint:
{
Description: The link to the blueprint. ,
Required: False ,
}
string ,
kind:
{
Description: The type of cluster. ,
Required: False ,
}
string ,
componentVersion:
{
Description: The versions of different services in the cluster. ,
Required: False ,
}
object ,
configurations:
{
Description: The cluster configurations. ,
Required: False ,
}
object ,
}
,
kafkaRestProperties:
{
Description: The cluster kafka rest proxy configuration. ,
Required: False ,
}
{
clientGroupInfo:
{
Description: The information of AAD security group. ,
Required: False ,
}
{
groupName:
{
Description: The AAD security group name. ,
Required: False ,
}
string ,
groupId:
{
Description: The AAD security group id. ,
Required: False ,
}
string ,
}
,
configurationOverride:
{
Description: The configurations that need to be overriden. ,
Required: False ,
}
object ,
}
,
securityProfile:
{
Description: The security profile. ,
Required: False ,
}
{
directoryType:
{
Description: The directory type. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
domain:
{
Description: The organization's active directory domain. ,
Required: False ,
}
string ,
organizationalUnitDN:
{
Description: The organizational unit within the Active Directory to place the cluster and service accounts. ,
Required: False ,
}
string ,
ldapsUrls:
{
Description: The LDAPS protocol URLs to communicate with the Active Directory. ,
Required: False ,
}
[
string ,
]
,
domainUsername:
{
Description: The domain user account that will have admin privileges on the cluster. ,
Required: False ,
}
string ,
domainUserPassword:
{
Description: The domain admin password. ,
Format: password ,
Required: False ,
}
string ,
clusterUsersGroupDNs:
{
Description: Optional. The Distinguished Names for cluster user groups ,
Required: False ,
}
[
string ,
]
,
aaddsResourceId:
{
Description: The resource ID of the user's Azure Active Directory Domain Service. ,
Required: False ,
}
string ,
msiResourceId:
{
Description: User assigned identity that has permissions to read and create cluster-related artifacts in the user's AADDS. ,
Required: False ,
}
string ,
}
,
computeProfile:
{
Description: The compute profile. ,
Required: False ,
}
{
roles:
{
Description: The list of roles in the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: False ,
}
string ,
minInstanceCount:
{
Description: The minimum instance count of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
targetInstanceCount:
{
Description: The instance count of the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
VMGroupName:
{
Description: The name of the virtual machine group. ,
Required: False ,
}
string ,
autoscale:
{
Description: The autoscale configurations. ,
Required: False ,
}
{
capacity:
{
Description: Parameters for load-based autoscale ,
Required: False ,
}
{
minInstanceCount:
{
Description: The minimum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
maxInstanceCount:
{
Description: The maximum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
recurrence:
{
Description: Parameters for schedule-based autoscale ,
Required: False ,
}
{
timeZone:
{
Description: The time zone for the autoscale schedule times ,
Required: False ,
}
string ,
schedule:
{
Description: Array of schedule-based autoscale rules ,
Required: False ,
}
[
{
days:
{
Description: Days of the week for a schedule-based autoscale rule ,
Required: False ,
}
[
string ,
]
,
timeAndCapacity:
{
Description: Time and capacity for a schedule-based autoscale rule ,
Required: False ,
}
{
time:
{
Description: 24-hour time in the form xx:xx ,
Required: False ,
}
string ,
minInstanceCount:
{
Description: The minimum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
maxInstanceCount:
{
Description: The maximum instance count of the cluster ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
hardwareProfile:
{
Description: The hardware profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the VM ,
Required: False ,
}
string ,
}
,
osProfile:
{
Description: The operating system profile. ,
Required: False ,
}
{
linuxOperatingSystemProfile:
{
Description: The Linux OS profile. ,
Required: False ,
}
{
username:
{
Description: The username. ,
Required: False ,
}
string ,
password:
{
Description: The password. ,
Required: False ,
}
string ,
sshProfile:
{
Description: The SSH profile. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys. ,
Required: False ,
}
[
{
certificateData:
{
Description: The certificate for SSH. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
virtualNetworkProfile:
{
Description: The virtual network profile. ,
Required: False ,
}
{
id:
{
Description: The ID of the virtual network. ,
Required: False ,
}
string ,
subnet:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
}
,
dataDisksGroups:
{
Description: The data disks groups for the role. ,
Required: False ,
}
[
{
disksPerNode:
{
Description: The number of disks per node. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountType:
{
Description: ReadOnly. The storage account type. Do not set this value. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: ReadOnly. The DiskSize in GB. Do not set this value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
scriptActions:
{
Description: The list of script actions on the role. ,
Required: False ,
}
[
{
name:
{
Description: The name of the script action. ,
Required: True ,
}
string ,
uri:
{
Description: The URI to the script. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the script provided. ,
Required: True ,
}
string ,
}
,
]
,
encryptDataDisks:
{
Description: Indicates whether encrypt the data disks. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The date on which the cluster was created. ,
Required: False ,
}
string ,
clusterState:
{
Description: The state of the cluster. ,
Required: False ,
}
string ,
quotaInfo:
{
Description: The quota information. ,
Required: False ,
}
{
coresUsed:
{
Description: The cores used by the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
errors:
{
Description: The list of errors. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
connectivityEndpoints:
{
Description: The list of connectivity endpoints. ,
Required: False ,
}
[
{
name:
{
Description: The name of the endpoint. ,
Required: False ,
}
string ,
protocol:
{
Description: The protocol of the endpoint. ,
Required: False ,
}
string ,
location:
{
Description: The location of the endpoint. ,
Required: False ,
}
string ,
port:
{
Description: The port to connect to. ,
Format: int32 ,
Required: False ,
}
integer ,
privateIPAddress:
{
Description: The private ip address of the endpoint. ,
Required: False ,
}
string ,
}
,
]
,
diskEncryptionProperties:
{
Description: The disk encryption properties. ,
Required: False ,
}
{
vaultUri:
{
Description: Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net ,
Required: False ,
}
string ,
keyName:
{
Description: Key name that is used for enabling disk encryption. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Specific key version that is used for enabling disk encryption. ,
Required: False ,
}
string ,
encryptionAlgorithm:
{
Description: Algorithm identifier for encryption, default RSA-OAEP. ,
Enum:
{
RSA-OAEP: No description available. ,
RSA-OAEP-256: No description available. ,
RSA1_5: No description available. ,
}
,
Required: False ,
}
enum ,
msiResourceId:
{
Description: Resource ID of Managed Identity that is used to access the key vault. ,
Required: False ,
}
string ,
encryptionAtHost:
{
Description: Indicates whether or not resource disk encryption is enabled. ,
Required: False ,
}
boolean ,
}
,
encryptionInTransitProperties:
{
Description: The encryption-in-transit properties. ,
Required: False ,
}
{
isEncryptionInTransitEnabled:
{
Description: Indicates whether or not inter cluster node communication is encrypted in transit. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: The storage profile. ,
Required: False ,
}
{
storageaccounts:
{
Description: The list of storage accounts in the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The name of the storage account. ,
Required: False ,
}
string ,
isDefault:
{
Description: Whether or not the storage account is the default storage account. ,
Required: False ,
}
boolean ,
container:
{
Description: The container in the storage account, only to be specified for WASB storage accounts. ,
Required: False ,
}
string ,
fileSystem:
{
Description: The filesystem, only to be specified for Azure Data Lake Storage Gen 2. ,
Required: False ,
}
string ,
key:
{
Description: The storage account access key. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource ID of storage account, only to be specified for Azure Data Lake Storage Gen 2. ,
Required: False ,
}
string ,
msiResourceId:
{
Description: The managed identity (MSI) that is allowed to access the storage account, only to be specified for Azure Data Lake Storage Gen 2. ,
Required: False ,
}
string ,
saskey:
{
Description: The shared access signature key. ,
Required: False ,
}
string ,
fileshare:
{
Description: The file share name. ,
Required: False ,
}
string ,
enableSecureChannel:
{
Description: Enable secure channel or not, it's an optional field. Default value is false when cluster version < 5.1 and true when cluster version >= 5.1 , ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
minSupportedTlsVersion:
{
Description: The minimal supported tls version. ,
Required: False ,
}
string ,
excludedServicesConfig:
{
Description: The excluded services config. ,
Required: False ,
}
{
excludedServicesConfigId:
{
Description: The config id of excluded services. ,
Required: False ,
}
string ,
excludedServicesList:
{
Description: The list of excluded services. ,
Required: False ,
}
string ,
}
,
networkProperties:
{
Description: The network properties. ,
Required: False ,
}
{
outboundDependenciesManagedType:
{
Description: A value to describe how the outbound dependencies of a HDInsight cluster are managed. 'Managed' means that the outbound dependencies are managed by the HDInsight service. 'External' means that the outbound dependencies are managed by a customer specific solution. ,
Enum:
{
Managed: No description available. ,
External: No description available. ,
}
,
Required: False ,
}
enum ,
resourceProviderConnection:
{
Description: The direction for the resource provider connection. ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
privateLink:
{
Description: Indicates whether or not private link is enabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
publicIpTag:
{
Description: Gets or sets the IP tag for the public IPs created along with the HDInsight Clusters. ,
Required: False ,
}
{
ipTagType:
{
Description: Gets or sets the ipTag type: Example FirstPartyUsage. ,
Required: True ,
}
string ,
tag:
{
Description: Gets or sets value of the IpTag associated with the public IP. Example HDInsight, SQL, Storage etc ,
Required: True ,
}
string ,
}
,
}
,
computeIsolationProperties:
{
Description: The compute isolation properties. ,
Required: False ,
}
{
enableComputeIsolation:
{
Description: The flag indicates whether enable compute isolation or not. ,
Required: False ,
}
boolean ,
hostSku:
{
Description: The host sku. ,
Required: False ,
}
string ,
}
,
privateLinkConfigurations:
{
Description: The private link configurations. ,
Required: False ,
}
[
{
id:
{
Description: The private link configuration id. ,
Required: False ,
}
string ,
name:
{
Description: The name of private link configuration. ,
Required: True ,
}
string ,
type:
{
Description: The type of the private link configuration. ,
Required: False ,
}
string ,
properties:
{
Description: The private link configuration properties. ,
Required: True ,
}
{
groupId:
{
Description: The HDInsight private linkable sub-resource name to apply the private link configuration to. For example, 'headnode', 'gateway', 'edgenode'. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The private link configuration provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
ipConfigurations:
{
Description: The IP configurations for the private link service. ,
Required: True ,
}
[
{
id:
{
Description: The private link IP configuration id. ,
Required: False ,
}
string ,
name:
{
Description: The name of private link IP configuration. ,
Required: True ,
}
string ,
type:
{
Description: The type of the private link IP configuration. ,
Required: False ,
}
string ,
properties:
{
Description: The private link ip configuration properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The private link configuration provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
primary:
{
Description: Indicates whether this IP configuration is primary for the corresponding NIC. ,
Required: False ,
}
boolean ,
privateIPAddress:
{
Description: The IP address. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The method that private IP address is allocated. ,
Enum:
{
dynamic: No description available. ,
static: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: The subnet resource id. ,
Required: False ,
}
{
id:
{
Description: The azure resource id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}
,
]
,
privateEndpointConnections:
{
Description: The list of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint of the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The private endpoint id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: True ,
}
{
status:
{
Description: The concrete private link service connection. ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
Pending: No description available. ,
Removed: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The optional description of the status. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Whether there is further actions. ,
Required: False ,
}
string ,
}
,
linkIdentifier:
{
Description: The link identifier. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
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 ,
}
,
}
,
]
,
}
,
identity:
{
Description: The identity of the cluster, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of cluster identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the cluster. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cluster. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
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 ,
}
Clusters_RotateDiskEncryptionKey (new)
Description :  Rotate disk encryption key of the specified HDInsight cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/rotatediskencryptionkey
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the disk encryption operation. ,
Required: True ,
}
{
vaultUri:
{
Description: Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net ,
Required: False ,
}
string ,
keyName:
{
Description: Key name that is used for enabling disk encryption. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Specific key version that is used for enabling disk encryption. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
Clusters_GetGatewaySettings (new)
Description :  Gets the gateway settings for the specified cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/getGatewaySettings
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
restAuthCredential.isEnabled:
{
Description: Indicates whether or not the gateway settings based authorization is enabled. ,
Required: False ,
}
string ,
restAuthCredential.username:
{
Description: The gateway settings user name. ,
Required: False ,
}
string ,
restAuthCredential.password:
{
Description: The gateway settings user password. ,
Required: False ,
}
string ,
restAuthEntraUsers:
{
Description: List of Entra users for gateway access. ,
Required: False ,
}
[
{
objectId:
{
Description: The unique object ID of the Entra user or client ID of the enterprise applications. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the Entra user. ,
Required: False ,
}
string ,
upn:
{
Description: The User Principal Name (UPN) of the Entra user. It may be empty in certain cases, such as for enterprise applications. ,
Required: False ,
}
string ,
}
,
]
,
}
Clusters_UpdateGatewaySettings (new)
Description :  Configures the gateway settings on the specified cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/updateGatewaySettings
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The cluster configurations. ,
Required: True ,
}
{
restAuthCredential.isEnabled:
{
Description: Indicates whether or not the gateway settings based authorization is enabled. ,
Required: False ,
}
boolean ,
restAuthCredential.username:
{
Description: The gateway settings user name. ,
Required: False ,
}
string ,
restAuthCredential.password:
{
Description: The gateway settings user password. ,
Required: False ,
}
string ,
restAuthEntraUsers:
{
Description: List of Entra users for gateway access. ,
Required: False ,
}
[
{
objectId:
{
Description: The unique object ID of the Entra user or client ID of the enterprise applications. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the Entra user. ,
Required: False ,
}
string ,
upn:
{
Description: The User Principal Name (UPN) of the Entra user. It may be empty in certain cases, such as for enterprise applications. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
Clusters_GetAzureAsyncOperationStatus (new)
Description :  The the async operation status.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/azureasyncoperations/{operationId}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
operationId:
{
Description: The long running operation id. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The async operation state. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The operation error information. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Clusters_UpdateIdentityCertificate (new)
Description :  Updates the cluster identity certificate.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/updateClusterIdentityCertificate
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The cluster configurations. ,
Required: True ,
}
{
applicationId:
{
Description: The application id. ,
Required: False ,
}
string ,
certificate:
{
Description: The certificate in base64 encoded format. ,
Required: False ,
}
string ,
certificatePassword:
{
Description: The password of the certificate. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
Configurations_List (new)
Description :  Gets all configuration information for an HDI cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/configurations
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
configurations:
{
Description: The configuration object for the specified configuration for the specified cluster. ,
Required: False ,
}
object ,
}
Configurations_Update (new)
Description :  Configures the HTTP settings on the specified cluster. This API is deprecated, please use UpdateGatewaySettings in cluster endpoint instead.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/configurations/{configurationName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of the cluster configuration. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The cluster configurations. ,
Required: True ,
}
object ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Configurations_Get (new)
Description :  The configuration object for the specified cluster. This API is not recommended and might be removed in the future. Please consider using List configurations API instead.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/configurations/{configurationName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of the cluster configuration. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: The configuration object for the specified configuration for the specified cluster. ,
}
object ,
}
Extensions_EnableMonitoring (new)
Description :  Enables the Operations Management Suite (OMS) on the HDInsight cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/clustermonitoring
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The Operations Management Suite (OMS) workspace parameters. ,
Required: True ,
}
{
workspaceId:
{
Description: The cluster monitor workspace ID. ,
Required: False ,
}
string ,
primaryKey:
{
Description: The cluster monitor workspace key. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
Extensions_GetMonitoringStatus (new)
Description :  Gets the status of Operations Management Suite (OMS) on the HDInsight cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/clustermonitoring
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
clusterMonitoringEnabled:
{
Description: The status of the monitor on the HDInsight cluster. ,
Required: False ,
}
boolean ,
workspaceId:
{
Description: The workspace ID of the monitor on the HDInsight cluster. ,
Required: False ,
}
string ,
}
Extensions_DisableMonitoring (new)
Description :  Disables the Operations Management Suite (OMS) on the HDInsight cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/clustermonitoring
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Extensions_EnableAzureMonitor (new)
Description :  Enables the Azure Monitor on the HDInsight cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/azureMonitor
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The Log Analytics workspace parameters. ,
Required: True ,
}
{
workspaceId:
{
Description: The Log Analytics workspace ID. ,
Required: False ,
}
string ,
primaryKey:
{
Description: The Log Analytics workspace key. ,
Required: False ,
}
string ,
selectedConfigurations:
{
Description: The selected configurations. ,
Required: False ,
}
{
configurationVersion:
{
Description: The configuration version. ,
Required: False ,
}
string ,
globalConfigurations:
{
Description: The global configurations of selected configurations. ,
Required: False ,
}
object ,
tableList:
{
Description: The table list. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
Extensions_GetAzureMonitorStatus (new)
Description :  Gets the status of Azure Monitor on the HDInsight cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/azureMonitor
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
clusterMonitoringEnabled:
{
Description: The status of the monitor on the HDInsight cluster. ,
Required: False ,
}
boolean ,
workspaceId:
{
Description: The workspace ID of the monitor on the HDInsight cluster. ,
Required: False ,
}
string ,
selectedConfigurations:
{
Description: The selected configurations. ,
Required: False ,
}
{
configurationVersion:
{
Description: The configuration version. ,
Required: False ,
}
string ,
globalConfigurations:
{
Description: The global configurations of selected configurations. ,
Required: False ,
}
object ,
tableList:
{
Description: The table list. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Extensions_DisableAzureMonitor (new)
Description :  Disables the Azure Monitor on the HDInsight cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/azureMonitor
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Extensions_EnableAzureMonitorAgent (new)
Description :  Enables the Azure Monitor Agent on the HDInsight cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/azureMonitorAgent
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The Log Analytics workspace parameters. ,
Required: True ,
}
{
workspaceId:
{
Description: The Log Analytics workspace ID. ,
Required: False ,
}
string ,
primaryKey:
{
Description: The Log Analytics workspace key. ,
Required: False ,
}
string ,
selectedConfigurations:
{
Description: The selected configurations. ,
Required: False ,
}
{
configurationVersion:
{
Description: The configuration version. ,
Required: False ,
}
string ,
globalConfigurations:
{
Description: The global configurations of selected configurations. ,
Required: False ,
}
object ,
tableList:
{
Description: The table list. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
Extensions_GetAzureMonitorAgentStatus (new)
Description :  Gets the status of Azure Monitor Agent on the HDInsight cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/azureMonitorAgent
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
clusterMonitoringEnabled:
{
Description: The status of the monitor on the HDInsight cluster. ,
Required: False ,
}
boolean ,
workspaceId:
{
Description: The workspace ID of the monitor on the HDInsight cluster. ,
Required: False ,
}
string ,
selectedConfigurations:
{
Description: The selected configurations. ,
Required: False ,
}
{
configurationVersion:
{
Description: The configuration version. ,
Required: False ,
}
string ,
globalConfigurations:
{
Description: The global configurations of selected configurations. ,
Required: False ,
}
object ,
tableList:
{
Description: The table list. ,
Required: False ,
}
[
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Extensions_DisableAzureMonitorAgent (new)
Description :  Disables the Azure Monitor Agent on the HDInsight cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/azureMonitorAgent
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Extensions_Create (new)
Description :  Creates an HDInsight cluster extension.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the cluster extension. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The cluster extensions create request. ,
Required: True ,
}
{
workspaceId:
{
Description: The workspace ID for the cluster monitoring extension. ,
Required: False ,
}
string ,
primaryKey:
{
Description: The certificate for the cluster monitoring extensions. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
Extensions_Get (new)
Description :  Gets the extension properties for the specified HDInsight cluster extension.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the cluster extension. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
clusterMonitoringEnabled:
{
Description: The status of the monitor on the HDInsight cluster. ,
Required: False ,
}
boolean ,
workspaceId:
{
Description: The workspace ID of the monitor on the HDInsight cluster. ,
Required: False ,
}
string ,
}
Extensions_Delete (new)
Description :  Deletes the specified extension for HDInsight cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the cluster extension. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Extensions_GetAzureAsyncOperationStatus (new)
Description :  Gets the async operation status.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}/azureAsyncOperations/{operationId}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the cluster extension. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
operationId:
{
Description: The long running operation id. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The async operation state. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The operation error information. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Locations_GetCapabilities (new)
Description :  Gets the capabilities for the specified location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/capabilities
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: The Azure location (region) for which to make the request. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
versions:
{
Description: The version capability. ,
Required: False ,
}
object ,
regions:
{
Description: The virtual machine size compatibility features. ,
Required: False ,
}
object ,
features:
{
Description: The capability features. ,
Required: False ,
}
[
string ,
]
,
quota:
{
Description: The quota capability. ,
Required: False ,
}
{
coresUsed:
{
Description: The number of cores used in the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
maxCoresAllowed:
{
Description: The number of cores that the subscription allowed. ,
Format: int64 ,
Required: False ,
}
integer ,
regionalQuotas:
{
Description: The list of region quota capabilities. ,
Required: False ,
}
[
{
regionName:
{
Description: The region name. ,
Required: False ,
}
string ,
coresUsed:
{
Description: The number of cores used in the region. ,
Format: int64 ,
Required: False ,
}
integer ,
coresAvailable:
{
Description: The number of cores available in the region. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
Locations_ListUsages (new)
Description :  Lists the usages for the specified location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/usages
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: The Azure location (region) for which to make the request. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usages. ,
Required: False ,
}
[
{
unit:
{
Description: The type of measurement for usage. ,
Required: False ,
}
string ,
currentValue:
{
Description: The current usage. ,
Format: int64 ,
Required: False ,
}
integer ,
limit:
{
Description: The maximum allowed usage. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The details about the localizable name of the used resource. ,
Required: False ,
}
{
value:
{
Description: The name of the used resource. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The localized name of the used resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
Locations_ListBillingSpecs (new)
Description :  Lists the billingSpecs for the specified subscription and location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/billingSpecs
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: The Azure location (region) for which to make the request. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
vmSizes:
{
Description: The virtual machine sizes to include or exclude. ,
Required: False ,
}
[
string ,
]
,
vmSizesWithEncryptionAtHost:
{
Description: The vm sizes which enable encryption at host. ,
Required: False ,
}
[
string ,
]
,
vmSizeFilters:
{
Description: The virtual machine filtering mode. Effectively this can enabling or disabling the virtual machine sizes in a particular set. ,
Required: False ,
}
[
{
filterMode:
{
Description: The filtering mode. Effectively this can enabling or disabling the VM sizes in a particular set. ,
Enum:
{
Exclude: No description available. ,
Include: No description available. ,
Recommend: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
regions:
{
Description: The list of regions under the effect of the filter. ,
Required: False ,
}
[
string ,
]
,
clusterFlavors:
{
Description: The list of cluster flavors under the effect of the filter. ,
Required: False ,
}
[
string ,
]
,
nodeTypes:
{
Description: The list of node types affected by the filter. ,
Required: False ,
}
[
string ,
]
,
clusterVersions:
{
Description: The list of cluster versions affected in Major.Minor format. ,
Required: False ,
}
[
string ,
]
,
osType:
{
Description: The OSType affected, Windows or Linux. ,
Required: False ,
}
[
string ,
]
,
vmSizes:
{
Description: The list of virtual machine sizes to include or exclude. ,
Required: False ,
}
[
string ,
]
,
espApplied:
{
Description: Whether apply for ESP cluster. 'true' means only for ESP, 'false' means only for non-ESP, null or empty string or others mean for both. ,
Required: False ,
}
string ,
computeIsolationSupported:
{
Description: Whether support compute isolation. 'true' means only for ComputeIsolationEnabled, 'false' means only for regular cluster. ,
Required: False ,
}
string ,
}
,
]
,
vmSizeProperties:
{
Description: The vm size properties. ,
Required: False ,
}
[
{
name:
{
Description: The vm size name. ,
Required: False ,
}
string ,
cores:
{
Description: The number of cores that the vm size has. ,
Format: int32 ,
Required: False ,
}
integer ,
dataDiskStorageTier:
{
Description: The data disk storage tier of the vm size. ,
Required: False ,
}
string ,
label:
{
Description: The label of the vm size. ,
Required: False ,
}
string ,
maxDataDiskCount:
{
Description: The max data disk count of the vm size. ,
Format: int64 ,
Required: False ,
}
integer ,
memoryInMb:
{
Description: The memory whose unit is MB of the vm size. ,
Format: int64 ,
Required: False ,
}
integer ,
supportedByVirtualMachines:
{
Description: This indicates this vm size is supported by virtual machines or not ,
Required: False ,
}
boolean ,
supportedByWebWorkerRoles:
{
Description: The indicates this vm size is supported by web worker roles or not ,
Required: False ,
}
boolean ,
virtualMachineResourceDiskSizeInMb:
{
Description: The virtual machine resource disk size whose unit is MB of the vm size. ,
Format: int64 ,
Required: False ,
}
integer ,
webWorkerResourceDiskSizeInMb:
{
Description: The web worker resource disk size whose unit is MB of the vm size. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
billingResources:
{
Description: The billing and managed disk billing resources for a region. ,
Required: False ,
}
[
{
region:
{
Description: The region or location. ,
Required: False ,
}
string ,
billingMeters:
{
Description: The billing meter information. ,
Required: False ,
}
[
{
meterParameter:
{
Description: The virtual machine sizes. ,
Required: False ,
}
string ,
meter:
{
Description: The HDInsight meter guid. ,
Required: False ,
}
string ,
unit:
{
Description: The unit of meter, VMHours or CoreHours. ,
Required: False ,
}
string ,
}
,
]
,
diskBillingMeters:
{
Description: The managed disk billing information. ,
Required: False ,
}
[
{
diskRpMeter:
{
Description: The managed disk meter guid. ,
Required: False ,
}
string ,
sku:
{
Description: The managed disk billing sku, P30 or S30. ,
Required: False ,
}
string ,
tier:
{
Description: The managed disk billing tier, Standard or Premium. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}
Locations_GetAzureAsyncOperationStatus (new)
Description :  Get the async operation status.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/azureasyncoperations/{operationId}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: The Azure location (region) for which to make the request. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
operationId:
{
Description: The long running operation id. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The async operation state. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The operation error information. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Locations_CheckNameAvailability (new)
Description :  Check the cluster name is available or not.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/checkNameAvailability
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: The Azure location (region) for which to make the request. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: This indicates whether the name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason of the result. ,
Required: False ,
}
string ,
message:
{
Description: The related message. ,
Required: False ,
}
string ,
}
Locations_ValidateClusterCreateRequest (new)
Description :  Validate the cluster create request spec is valid or not.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/validateCreateRequest
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: The Azure location (region) for which to make the request. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
name:
{
Description: The cluster name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id. ,
Required: False ,
}
string ,
fetchAaddsResource:
{
Description: This indicates whether fetch Aadds resource or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
validationErrors:
{
Description: The validation errors. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
errorResource:
{
Description: The error resource. ,
Required: False ,
}
string ,
messageArguments:
{
Description: The message arguments ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
validationWarnings:
{
Description: The validation warnings. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
errorResource:
{
Description: The error resource. ,
Required: False ,
}
string ,
messageArguments:
{
Description: The message arguments ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
estimatedCreationDuration:
{
Description: The estimated creation duration. ,
Format: duration ,
Required: False ,
}
string ,
aaddsResourcesDetails:
{
Description: The Azure active directory domain service resource details. ,
Required: False ,
}
[
{
domainName:
{
Description: The Azure active directory domain service name. ,
Required: False ,
}
string ,
initialSyncComplete:
{
Description: This indicates whether initial sync complete or not. ,
Required: False ,
}
boolean ,
ldapsEnabled:
{
Description: This indicates whether enable ldaps or not. ,
Required: False ,
}
boolean ,
ldapsPublicCertificateInBase64:
{
Description: The base 64 format string of public ldap certificate. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource id of azure active directory domain service. ,
Required: False ,
}
string ,
subnetId:
{
Description: The subnet resource id. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of azure active directory domain service . ,
Required: False ,
}
string ,
}
,
]
,
}
Operations_List (new)
Description :  Lists all of the available HDInsight REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.HDInsight/operations
{
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of HDInsight operations supported by the HDInsight resource provider. ,
Required: False ,
}
[
{
name:
{
Description: The operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The display of operation. ,
Required: False ,
}
{
provider:
{
Description: The service provider: Microsoft.HDInsight ,
Required: False ,
}
string ,
resource:
{
Description: The resource on which the operation is performed: Cluster, Applications, etc. ,
Required: False ,
}
string ,
operation:
{
Description: The operation type: read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Localized friendly description for the operation ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The operation properties. ,
Required: False ,
}
{
serviceSpecification:
{
Description: The specification of the service. ,
Required: False ,
}
{
metricSpecifications:
{
Description: The metric specifications. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metric specification. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the metric specification. ,
Required: False ,
}
string ,
displayDescription:
{
Description: The display description of the metric specification. ,
Required: False ,
}
string ,
unit:
{
Description: The unit of the metric specification. ,
Required: False ,
}
string ,
aggregationType:
{
Description: The aggregation type of the metric specification. ,
Required: False ,
}
string ,
supportedAggregationTypes:
{
Description: The supported aggregation types of the metric specification. ,
Required: False ,
}
[
string ,
]
,
supportedTimeGrainTypes:
{
Description: The supported time grain types of the metric specification. ,
Required: False ,
}
[
string ,
]
,
enableRegionalMdmAccount:
{
Description: The flag indicates whether enable regional mdm account or not. ,
Required: False ,
}
boolean ,
sourceMdmAccount:
{
Description: The source mdm account. ,
Required: False ,
}
string ,
sourceMdmNamespace:
{
Description: The source mdm namespace. ,
Required: False ,
}
string ,
metricFilterPattern:
{
Description: The metric filter pattern. ,
Required: False ,
}
string ,
fillGapWithZero:
{
Description: The flag indicates whether filling gap with zero. ,
Required: False ,
}
boolean ,
category:
{
Description: The category of the metric. ,
Required: False ,
}
string ,
resourceIdDimensionNameOverride:
{
Description: The override name of resource id dimension name. ,
Required: False ,
}
string ,
isInternal:
{
Description: The flag indicates whether the metric is internal or not. ,
Required: False ,
}
boolean ,
delegateMetricNameOverride:
{
Description: The override name of delegate metric. ,
Required: False ,
}
string ,
dimensions:
{
Description: The dimensions of the metric specification. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dimension. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the dimension. ,
Required: False ,
}
string ,
internalName:
{
Description: The display name of the dimension. ,
Required: False ,
}
string ,
toBeExportedForShoebox:
{
Description: The flag indicates whether the metric will be exported for shoebox or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_ListByCluster (new)
Description :  Lists the private endpoint connections for a HDInsight cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/privateEndpointConnections
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint of the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The private endpoint id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: True ,
}
{
status:
{
Description: The concrete private link service connection. ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
Pending: No description available. ,
Removed: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The optional description of the status. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Whether there is further actions. ,
Required: False ,
}
string ,
}
,
linkIdentifier:
{
Description: The link identifier. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
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 ,
}
PrivateEndpointConnections_CreateOrUpdate (new)
Description :  Approve or reject a private endpoint connection manually.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
parameters:
{
Description: The private endpoint connection create or update request. ,
Required: True ,
}
{
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint of the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The private endpoint id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: True ,
}
{
status:
{
Description: The concrete private link service connection. ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
Pending: No description available. ,
Removed: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The optional description of the status. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Whether there is further actions. ,
Required: False ,
}
string ,
}
,
linkIdentifier:
{
Description: The link identifier. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
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)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint of the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The private endpoint id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: True ,
}
{
status:
{
Description: The concrete private link service connection. ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
Pending: No description available. ,
Removed: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The optional description of the status. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Whether there is further actions. ,
Required: False ,
}
string ,
}
,
linkIdentifier:
{
Description: The link identifier. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
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: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint of the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The private endpoint id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: True ,
}
{
status:
{
Description: The concrete private link service connection. ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
Pending: No description available. ,
Removed: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The optional description of the status. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Whether there is further actions. ,
Required: False ,
}
string ,
}
,
linkIdentifier:
{
Description: The link identifier. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
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 ,
}
,
}
PrivateEndpointConnections_Get (new)
Description :  Gets the specific private endpoint connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint of the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The private endpoint id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: True ,
}
{
status:
{
Description: The concrete private link service connection. ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
Pending: No description available. ,
Removed: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The optional description of the status. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Whether there is further actions. ,
Required: False ,
}
string ,
}
,
linkIdentifier:
{
Description: The link identifier. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
InProgress: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
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 ,
}
,
}
PrivateEndpointConnections_Delete (new)
Description :  Deletes the specific private endpoint connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ Response (204)

{}
PrivateLinkResources_ListByCluster (new)
Description :  Lists the private link resources in a HDInsight cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/privateLinkResources
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
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 ,
}
,
}
,
]
,
}
PrivateLinkResources_Get (new)
Description :  Gets the specific private link resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/privateLinkResources/{privateLinkResourceName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
privateLinkResourceName:
{
Description: The name of the private link resource. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
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 ,
}
,
}
ScriptActions_Delete (new)
Description :  Deletes a specified persisted script action of the cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptActions/{scriptName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
scriptName:
{
Description: The name of the script. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Clusters_ExecuteScriptActions (new)
Description :  Executes script actions on the specified HDInsight cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/executeScriptActions
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for executing script actions. ,
Required: True ,
}
{
scriptActions:
{
Description: The list of run time script actions. ,
Required: False ,
}
[
{
name:
{
Description: The name of the script action. ,
Required: True ,
}
string ,
uri:
{
Description: The URI to the script. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the script ,
Required: False ,
}
string ,
roles:
{
Description: The list of roles where script will be executed. ,
Required: True ,
}
[
string ,
]
,
applicationName:
{
Description: The application name of the script action, if any. ,
Required: False ,
}
string ,
}
,
]
,
persistOnSuccess:
{
Description: Gets or sets if the scripts needs to be persisted. ,
Required: True ,
}
boolean ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ Response (404)

{}
ScriptActions_ListByCluster (new)
Description :  Lists all the persisted script actions for the specified cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptActions
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of persisted script action details for the cluster. ,
Required: False ,
}
[
{
scriptExecutionId:
{
Description: The execution id of the script action. ,
Format: int64 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time of script action execution. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of script action execution. ,
Required: False ,
}
string ,
status:
{
Description: The current execution status of the script action. ,
Required: False ,
}
string ,
operation:
{
Description: The reason why the script action was executed. ,
Required: False ,
}
string ,
executionSummary:
{
Description: The summary of script action execution result. ,
Required: False ,
}
[
{
status:
{
Description: The status of script action execution. ,
Required: False ,
}
string ,
instanceCount:
{
Description: The instance count for a given script action execution status. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
debugInformation:
{
Description: The script action execution debug information. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}
ScriptActions_GetExecutionDetail (new)
Description :  Gets the script execution detail for the given script execution ID.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory/{scriptExecutionId}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
scriptExecutionId:
{
Description: The script execution Id ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
scriptExecutionId:
{
Description: The execution id of the script action. ,
Format: int64 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time of script action execution. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of script action execution. ,
Required: False ,
}
string ,
status:
{
Description: The current execution status of the script action. ,
Required: False ,
}
string ,
operation:
{
Description: The reason why the script action was executed. ,
Required: False ,
}
string ,
executionSummary:
{
Description: The summary of script action execution result. ,
Required: False ,
}
[
{
status:
{
Description: The status of script action execution. ,
Required: False ,
}
string ,
instanceCount:
{
Description: The instance count for a given script action execution status. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
debugInformation:
{
Description: The script action execution debug information. ,
Required: False ,
}
string ,
}
ScriptExecutionHistory_ListByCluster (new)
Description :  Lists all scripts' execution history for the specified cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of persisted script action details for the cluster. ,
Required: False ,
}
[
{
scriptExecutionId:
{
Description: The execution id of the script action. ,
Format: int64 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time of script action execution. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of script action execution. ,
Required: False ,
}
string ,
status:
{
Description: The current execution status of the script action. ,
Required: False ,
}
string ,
operation:
{
Description: The reason why the script action was executed. ,
Required: False ,
}
string ,
executionSummary:
{
Description: The summary of script action execution result. ,
Required: False ,
}
[
{
status:
{
Description: The status of script action execution. ,
Required: False ,
}
string ,
instanceCount:
{
Description: The instance count for a given script action execution status. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
debugInformation:
{
Description: The script action execution debug information. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}
ScriptExecutionHistory_Promote (new)
Description :  Promotes the specified ad-hoc script execution to a persisted script.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory/{scriptExecutionId}/promote
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
scriptExecutionId:
{
Description: The script execution Id ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}
ScriptActions_GetExecutionAsyncOperationStatus (new)
Description :  Gets the async operation status of execution operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/executeScriptActions/azureasyncoperations/{operationId}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
operationId:
{
Description: The long running operation id. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The async operation state. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The operation error information. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
VirtualMachines_ListHosts (new)
Description :  Lists the HDInsight clusters hosts
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/listHosts
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The host name ,
Required: False ,
}
string ,
fqdn:
{
Description: The Fully Qualified Domain Name of host ,
Required: False ,
}
string ,
effectiveDiskEncryptionKeyUrl:
{
Description: The effective disk encryption key URL used by the host ,
Required: False ,
}
string ,
}
VirtualMachines_RestartHosts (new)
Description :  Restarts the specified HDInsight cluster hosts.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/restartHosts
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
hosts:
{
Description: The list of hosts to restart ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
VirtualMachines_GetAsyncOperationStatus (new)
Description :  Gets the async operation status.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/restartHosts/azureasyncoperations/{operationId}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The HDInsight client API Version. ,
Required: True ,
}
string ,
operationId:
{
Description: The long running operation id. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The async operation state. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The operation error information. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}