Clusters - Get
Gets the specified cluster.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}?api-version=2021-06-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
cluster
|
path | True |
string |
The name of the cluster. |
resource
|
path | True |
string |
The name of the resource group. |
subscription
|
path | True |
string |
The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
api-version
|
query | True |
string |
The HDInsight client API Version. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK response definition. |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
Get Hadoop on Linux cluster |
Get Spark on Linux cluster |
Get Hadoop on Linux cluster
Sample Request
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1",
"name": "cluster1",
"type": "Microsoft.HDInsight/clusters",
"location": "West US",
"etag": "f0212a39-b827-45e0-9ffa-4f5232e58851",
"tags": {
"key1": "val1"
},
"properties": {
"clusterVersion": "3.5.1000.0",
"osType": "Linux",
"clusterDefinition": {
"blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json",
"kind": "hadoop"
},
"computeProfile": {
"roles": [
{
"name": "headnode",
"targetInstanceCount": 2,
"hardwareProfile": {
"vmSize": "Standard_D3_V2"
},
"osProfile": {
"linuxOperatingSystemProfile": {
"username": "sshuser"
}
}
},
{
"name": "workernode",
"targetInstanceCount": 4,
"hardwareProfile": {
"vmSize": "Standard_D3_V2"
},
"osProfile": {
"linuxOperatingSystemProfile": {
"username": "sshuser"
}
}
},
{
"name": "zookeepernode",
"targetInstanceCount": 3,
"hardwareProfile": {
"vmSize": "Medium"
},
"osProfile": {
"linuxOperatingSystemProfile": {
"username": "sshuser"
}
}
}
]
},
"provisioningState": "Succeeded",
"clusterState": "Running",
"createdDate": "2017-01-11T18:58:26.187",
"quotaInfo": {
"coresUsed": 24
},
"connectivityEndpoints": [
{
"name": "SSH",
"protocol": "TCP",
"location": "cluster1-ssh.azurehdinsight.net",
"port": 22
},
{
"name": "HTTPS",
"protocol": "TCP",
"location": "cluster1.azurehdinsight.net",
"port": 443
}
],
"tier": "Standard"
}
}
Get Spark on Linux cluster
Sample Request
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1",
"name": "cluster1",
"type": "Microsoft.HDInsight/clusters",
"location": "West US",
"etag": "4cd8b5a9-ca9c-4239-9e5b-3916032e994c",
"tags": {
"key1": "val1"
},
"properties": {
"clusterVersion": "3.5.1000.0",
"osType": "Linux",
"clusterDefinition": {
"blueprint": "https://blueprints.azurehdinsight.net/spark-3.5.1000.0.9625065.json",
"kind": "SPARK",
"componentVersion": {
"Spark": "2.0"
}
},
"computeProfile": {
"roles": [
{
"name": "headnode",
"targetInstanceCount": 2,
"hardwareProfile": {
"vmSize": "Standard_D12_V2"
},
"osProfile": {
"linuxOperatingSystemProfile": {
"username": "sshuser"
}
}
},
{
"name": "workernode",
"targetInstanceCount": 4,
"hardwareProfile": {
"vmSize": "Standard_D4_V2"
},
"osProfile": {
"linuxOperatingSystemProfile": {
"username": "sshuser"
}
}
},
{
"name": "zookeepernode",
"targetInstanceCount": 3,
"hardwareProfile": {
"vmSize": "Medium"
},
"osProfile": {
"linuxOperatingSystemProfile": {
"username": "sshuser"
}
}
}
]
},
"provisioningState": "Succeeded",
"clusterState": "Running",
"createdDate": "2017-03-03T08:35:07.323",
"quotaInfo": {
"coresUsed": 40
},
"connectivityEndpoints": [
{
"name": "SSH",
"protocol": "TCP",
"location": "cluster1-ssh.azurehdinsight.net",
"port": 22
},
{
"name": "HTTPS",
"protocol": "TCP",
"location": "cluster1.azurehdinsight.net",
"port": 443
}
],
"tier": "Standard"
}
}
Definitions
Name | Description |
---|---|
Autoscale |
The autoscale request parameters |
Autoscale |
The load-based autoscale request parameters |
Autoscale |
Schedule-based autoscale request parameters |
Autoscale |
Parameters for a schedule-based autoscale rule, consisting of an array of days + a time and capacity |
Autoscale |
Time and capacity request parameters |
Client |
The information of AAD security group. |
Cluster |
The HDInsight cluster. |
Cluster |
The cluster definition. |
Cluster |
The properties of cluster. |
Cluster |
Identity for the cluster. |
Compute |
The compute isolation properties. |
Compute |
Describes the compute profile. |
Connectivity |
The connectivity properties |
created |
The type of identity that created the resource. |
Data |
The data disks groups for the role. |
Days |
Days of the week for a schedule-based autoscale rule |
Directory |
The directory type. |
Disk |
The disk encryption properties |
Encryption |
The encryption-in-transit properties. |
Error |
Describes the format of Error response. |
Errors |
The error message associated with the cluster creation. |
Excluded |
The configuration that services will be excluded when creating cluster. |
Hardware |
The hardware profile. |
HDInsight |
The provisioning state, which only appears in the response. |
IPConfiguration |
The ip configurations for the private link service. |
Json |
Algorithm identifier for encryption, default RSA-OAEP. |
Kafka |
The kafka rest proxy configuration which contains AAD security group information. |
Linux |
The ssh username, password, and ssh public key. |
Network |
The network properties. |
Os |
The Linux operation systems profile. |
OSType |
The type of operating system. |
Private |
The private endpoint. |
Private |
The private endpoint connection. |
Private |
The provisioning state, which only appears in the response. |
Private |
The method that private IP address is allocated. |
Private |
Indicates whether or not private link is enabled. |
Private |
The private link configuration. |
Private |
The private link configuration provisioning state, which only appears in the response. |
Private |
The private link service connection state. |
Private |
The concrete private link service connection. |
Quota |
The quota properties for the cluster. |
Resource |
The azure resource id. |
Resource |
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. |
Resource |
The direction for the resource provider connection. |
Role |
Describes a role on the cluster. |
Script |
Describes a script action on role on the cluster. |
Security |
The security profile which contains Ssh public key for the HDInsight cluster. |
Ssh |
The list of SSH public keys. |
Ssh |
The SSH public key for the cluster nodes. |
Storage |
The storage Account. |
Storage |
The storage profile. |
system |
Metadata pertaining to creation and last modification of the resource. |
Tier |
The cluster tier. |
User |
The User Assigned Identity |
Virtual |
The virtual network properties. |
Autoscale
The autoscale request parameters
Name | Type | Description |
---|---|---|
capacity |
Parameters for load-based autoscale |
|
recurrence |
Parameters for schedule-based autoscale |
AutoscaleCapacity
The load-based autoscale request parameters
Name | Type | Description |
---|---|---|
maxInstanceCount |
integer |
The maximum instance count of the cluster |
minInstanceCount |
integer |
The minimum instance count of the cluster |
AutoscaleRecurrence
Schedule-based autoscale request parameters
Name | Type | Description |
---|---|---|
schedule |
Array of schedule-based autoscale rules |
|
timeZone |
string |
The time zone for the autoscale schedule times |
AutoscaleSchedule
Parameters for a schedule-based autoscale rule, consisting of an array of days + a time and capacity
Name | Type | Description |
---|---|---|
days |
Days of the week for a schedule-based autoscale rule |
|
timeAndCapacity |
Time and capacity for a schedule-based autoscale rule |
AutoscaleTimeAndCapacity
Time and capacity request parameters
Name | Type | Description |
---|---|---|
maxInstanceCount |
integer |
The maximum instance count of the cluster |
minInstanceCount |
integer |
The minimum instance count of the cluster |
time |
string |
24-hour time in the form xx:xx |
ClientGroupInfo
The information of AAD security group.
Name | Type | Description |
---|---|---|
groupId |
string |
The AAD security group id. |
groupName |
string |
The AAD security group name. |
Cluster
The HDInsight cluster.
Name | Type | Description |
---|---|---|
etag |
string |
The ETag for the resource |
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
identity |
The identity of the cluster, if configured. |
|
location |
string |
The geo-location where the resource lives |
name |
string |
The name of the resource |
properties |
The properties of the cluster. |
|
systemData |
Metadata pertaining to creation and last modification of the resource. |
|
tags |
object |
Resource tags. |
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
zones |
string[] |
The availability zones. |
ClusterDefinition
The cluster definition.
Name | Type | Description |
---|---|---|
blueprint |
string |
The link to the blueprint. |
componentVersion |
object |
The versions of different services in the cluster. |
configurations |
object |
The cluster configurations. |
kind |
string |
The type of cluster. |
ClusterGetProperties
The properties of cluster.
Name | Type | Description |
---|---|---|
clusterDefinition |
The cluster definition. |
|
clusterHdpVersion |
string |
The hdp version of the cluster. |
clusterId |
string |
The cluster id. |
clusterState |
string |
The state of the cluster. |
clusterVersion |
string |
The version of the cluster. |
computeIsolationProperties |
The compute isolation properties. |
|
computeProfile |
The compute profile. |
|
connectivityEndpoints |
The list of connectivity endpoints. |
|
createdDate |
string |
The date on which the cluster was created. |
diskEncryptionProperties |
The disk encryption properties. |
|
encryptionInTransitProperties |
The encryption-in-transit properties. |
|
errors |
Errors[] |
The list of errors. |
excludedServicesConfig |
The excluded services config. |
|
kafkaRestProperties |
The cluster kafka rest proxy configuration. |
|
minSupportedTlsVersion |
string |
The minimal supported tls version. |
networkProperties |
The network properties. |
|
osType |
The type of operating system. |
|
privateEndpointConnections |
The list of private endpoint connections. |
|
privateLinkConfigurations |
The private link configurations. |
|
provisioningState |
The provisioning state, which only appears in the response. |
|
quotaInfo |
The quota information. |
|
securityProfile |
The security profile. |
|
storageProfile |
The storage profile. |
|
tier |
The cluster tier. |
ClusterIdentity
Identity for the cluster.
Name | Type | Description |
---|---|---|
principalId |
string |
The principal id of cluster identity. This property will only be provided for a system assigned identity. |
tenantId |
string |
The tenant id associated with the cluster. This property will only be provided for a system assigned identity. |
type |
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. |
|
userAssignedIdentities |
<string,
User |
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}'. |
ComputeIsolationProperties
The compute isolation properties.
Name | Type | Default Value | Description |
---|---|---|---|
enableComputeIsolation |
boolean |
False |
The flag indicates whether enable compute isolation or not. |
hostSku |
string |
The host sku. |
ComputeProfile
Describes the compute profile.
Name | Type | Description |
---|---|---|
roles |
Role[] |
The list of roles in the cluster. |
ConnectivityEndpoint
The connectivity properties
Name | Type | Description |
---|---|---|
location |
string |
The location of the endpoint. |
name |
string |
The name of the endpoint. |
port |
integer |
The port to connect to. |
privateIPAddress |
string |
The private ip address of the endpoint. |
protocol |
string |
The protocol of the endpoint. |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DataDisksGroups
The data disks groups for the role.
Name | Type | Description |
---|---|---|
diskSizeGB |
integer |
ReadOnly. The DiskSize in GB. Do not set this value. |
disksPerNode |
integer |
The number of disks per node. |
storageAccountType |
string |
ReadOnly. The storage account type. Do not set this value. |
DaysOfWeek
Days of the week for a schedule-based autoscale rule
Name | Type | Description |
---|---|---|
Friday |
string |
|
Monday |
string |
|
Saturday |
string |
|
Sunday |
string |
|
Thursday |
string |
|
Tuesday |
string |
|
Wednesday |
string |
DirectoryType
The directory type.
Name | Type | Description |
---|---|---|
ActiveDirectory |
string |
DiskEncryptionProperties
The disk encryption properties
Name | Type | Default Value | Description |
---|---|---|---|
encryptionAlgorithm |
Algorithm identifier for encryption, default RSA-OAEP. |
||
encryptionAtHost |
boolean |
False |
Indicates whether or not resource disk encryption is enabled. |
keyName |
string |
Key name that is used for enabling disk encryption. |
|
keyVersion |
string |
Specific key version that is used for enabling disk encryption. |
|
msiResourceId |
string |
Resource ID of Managed Identity that is used to access the key vault. |
|
vaultUri |
string |
Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net |
EncryptionInTransitProperties
The encryption-in-transit properties.
Name | Type | Default Value | Description |
---|---|---|---|
isEncryptionInTransitEnabled |
boolean |
False |
Indicates whether or not inter cluster node communication is encrypted in transit. |
ErrorResponse
Describes the format of Error response.
Name | Type | Description |
---|---|---|
code |
string |
Error code |
message |
string |
Error message indicating why the operation failed. |
Errors
The error message associated with the cluster creation.
Name | Type | Description |
---|---|---|
code |
string |
The error code. |
message |
string |
The error message. |
ExcludedServicesConfig
The configuration that services will be excluded when creating cluster.
Name | Type | Description |
---|---|---|
excludedServicesConfigId |
string |
The config id of excluded services. |
excludedServicesList |
string |
The list of excluded services. |
HardwareProfile
The hardware profile.
Name | Type | Description |
---|---|---|
vmSize |
string |
The size of the VM |
HDInsightClusterProvisioningState
The provisioning state, which only appears in the response.
Name | Type | Description |
---|---|---|
Canceled |
string |
|
Deleting |
string |
|
Failed |
string |
|
InProgress |
string |
|
Succeeded |
string |
IPConfiguration
The ip configurations for the private link service.
Name | Type | Description |
---|---|---|
id |
string |
The private link IP configuration id. |
name |
string |
The name of private link IP configuration. |
properties.primary |
boolean |
Indicates whether this IP configuration is primary for the corresponding NIC. |
properties.privateIPAddress |
string |
The IP address. |
properties.privateIPAllocationMethod |
The method that private IP address is allocated. |
|
properties.provisioningState |
The private link configuration provisioning state, which only appears in the response. |
|
properties.subnet |
The subnet resource id. |
|
type |
string |
The type of the private link IP configuration. |
JsonWebKeyEncryptionAlgorithm
Algorithm identifier for encryption, default RSA-OAEP.
Name | Type | Description |
---|---|---|
RSA-OAEP |
string |
|
RSA-OAEP-256 |
string |
|
RSA1_5 |
string |
KafkaRestProperties
The kafka rest proxy configuration which contains AAD security group information.
Name | Type | Description |
---|---|---|
clientGroupInfo |
The information of AAD security group. |
|
configurationOverride |
object |
The configurations that need to be overriden. |
LinuxOperatingSystemProfile
The ssh username, password, and ssh public key.
Name | Type | Description |
---|---|---|
password |
string |
The password. |
sshProfile |
The SSH profile. |
|
username |
string |
The username. |
NetworkProperties
The network properties.
Name | Type | Description |
---|---|---|
privateLink |
Indicates whether or not private link is enabled. |
|
resourceProviderConnection |
The direction for the resource provider connection. |
OsProfile
The Linux operation systems profile.
Name | Type | Description |
---|---|---|
linuxOperatingSystemProfile |
The Linux OS profile. |
OSType
The type of operating system.
Name | Type | Description |
---|---|---|
Linux |
string |
|
Windows |
string |
PrivateEndpoint
The private endpoint.
Name | Type | Description |
---|---|---|
id |
string |
The private endpoint id. |
PrivateEndpointConnection
The private endpoint connection.
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
The name of the resource |
properties.linkIdentifier |
string |
The link identifier. |
properties.privateEndpoint |
The private endpoint of the private endpoint connection |
|
properties.privateLinkServiceConnectionState |
The private link service connection state. |
|
properties.provisioningState |
The provisioning state, which only appears in the response. |
|
systemData |
Metadata pertaining to creation and last modification of the resource. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
PrivateEndpointConnectionProvisioningState
The provisioning state, which only appears in the response.
Name | Type | Description |
---|---|---|
Canceled |
string |
|
Deleting |
string |
|
Failed |
string |
|
InProgress |
string |
|
Succeeded |
string |
|
Updating |
string |
PrivateIPAllocationMethod
The method that private IP address is allocated.
Name | Type | Description |
---|---|---|
dynamic |
string |
|
static |
string |
PrivateLink
Indicates whether or not private link is enabled.
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
PrivateLinkConfiguration
The private link configuration.
Name | Type | Description |
---|---|---|
id |
string |
The private link configuration id. |
name |
string |
The name of private link configuration. |
properties.groupId |
string |
The HDInsight private linkable sub-resource name to apply the private link configuration to. For example, 'headnode', 'gateway', 'edgenode'. |
properties.ipConfigurations |
The IP configurations for the private link service. |
|
properties.provisioningState |
The private link configuration provisioning state, which only appears in the response. |
|
type |
string |
The type of the private link configuration. |
PrivateLinkConfigurationProvisioningState
The private link configuration provisioning state, which only appears in the response.
Name | Type | Description |
---|---|---|
Canceled |
string |
|
Deleting |
string |
|
Failed |
string |
|
InProgress |
string |
|
Succeeded |
string |
PrivateLinkServiceConnectionState
The private link service connection state.
Name | Type | Description |
---|---|---|
actionsRequired |
string |
Whether there is further actions. |
description |
string |
The optional description of the status. |
status |
The concrete private link service connection. |
PrivateLinkServiceConnectionStatus
The concrete private link service connection.
Name | Type | Description |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
|
Removed |
string |
QuotaInfo
The quota properties for the cluster.
Name | Type | Description |
---|---|---|
coresUsed |
integer |
The cores used by the cluster. |
ResourceId
The azure resource id.
Name | Type | Description |
---|---|---|
id |
string |
The azure resource id. |
ResourceIdentityType
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.
Name | Type | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
ResourceProviderConnection
The direction for the resource provider connection.
Name | Type | Description |
---|---|---|
Inbound |
string |
|
Outbound |
string |
Role
Describes a role on the cluster.
Name | Type | Default Value | Description |
---|---|---|---|
VMGroupName |
string |
The name of the virtual machine group. |
|
autoscale |
The autoscale configurations. |
||
dataDisksGroups |
The data disks groups for the role. |
||
encryptDataDisks |
boolean |
False |
Indicates whether encrypt the data disks. |
hardwareProfile |
The hardware profile. |
||
minInstanceCount |
integer |
The minimum instance count of the cluster. |
|
name |
string |
The name of the role. |
|
osProfile |
The operating system profile. |
||
scriptActions |
The list of script actions on the role. |
||
targetInstanceCount |
integer |
The instance count of the cluster. |
|
virtualNetworkProfile |
The virtual network profile. |
ScriptAction
Describes a script action on role on the cluster.
Name | Type | Description |
---|---|---|
name |
string |
The name of the script action. |
parameters |
string |
The parameters for the script provided. |
uri |
string |
The URI to the script. |
SecurityProfile
The security profile which contains Ssh public key for the HDInsight cluster.
Name | Type | Description |
---|---|---|
aaddsResourceId |
string |
The resource ID of the user's Azure Active Directory Domain Service. |
clusterUsersGroupDNs |
string[] |
Optional. The Distinguished Names for cluster user groups |
directoryType |
The directory type. |
|
domain |
string |
The organization's active directory domain. |
domainUserPassword |
string |
The domain admin password. |
domainUsername |
string |
The domain user account that will have admin privileges on the cluster. |
ldapsUrls |
string[] |
The LDAPS protocol URLs to communicate with the Active Directory. |
msiResourceId |
string |
User assigned identity that has permissions to read and create cluster-related artifacts in the user's AADDS. |
organizationalUnitDN |
string |
The organizational unit within the Active Directory to place the cluster and service accounts. |
SshProfile
The list of SSH public keys.
Name | Type | Description |
---|---|---|
publicKeys |
The list of SSH public keys. |
SshPublicKey
The SSH public key for the cluster nodes.
Name | Type | Description |
---|---|---|
certificateData |
string |
The certificate for SSH. |
StorageAccount
The storage Account.
Name | Type | Description |
---|---|---|
container |
string |
The container in the storage account, only to be specified for WASB storage accounts. |
fileSystem |
string |
The filesystem, only to be specified for Azure Data Lake Storage Gen 2. |
fileshare |
string |
The file share name. |
isDefault |
boolean |
Whether or not the storage account is the default storage account. |
key |
string |
The storage account access key. |
msiResourceId |
string |
The managed identity (MSI) that is allowed to access the storage account, only to be specified for Azure Data Lake Storage Gen 2. |
name |
string |
The name of the storage account. |
resourceId |
string |
The resource ID of storage account, only to be specified for Azure Data Lake Storage Gen 2. |
saskey |
string |
The shared access signature key. |
StorageProfile
The storage profile.
Name | Type | Description |
---|---|---|
storageaccounts |
The list of storage accounts in the cluster. |
systemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of resource last modification (UTC) |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |
Tier
The cluster tier.
Name | Type | Description |
---|---|---|
Premium |
string |
|
Standard |
string |
UserAssignedIdentity
The User Assigned Identity
Name | Type | Description |
---|---|---|
clientId |
string |
The client id of user assigned identity. |
principalId |
string |
The principal id of user assigned identity. |
tenantId |
string |
The tenant id of user assigned identity. |
VirtualNetworkProfile
The virtual network properties.
Name | Type | Description |
---|---|---|
id |
string |
The ID of the virtual network. |
subnet |
string |
The name of the subnet. |