GetCluster

Use this data source to access information about an existing HDInsight Cluster.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.HDInsight.GetCluster.InvokeAsync(new Azure.HDInsight.GetClusterArgs
        {
            Name = "example",
            ResourceGroupName = "example-resources",
        }));
        this.HttpsEndpoint = example.Apply(example => example.HttpsEndpoint);
    }

    [Output("httpsEndpoint")]
    public Output<string> HttpsEndpoint { get; set; }
}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/hdinsight"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        example, err := hdinsight.GetCluster(ctx, &hdinsight.GetClusterArgs{
            Name:              "example",
            ResourceGroupName: "example-resources",
        }, nil)
        if err != nil {
            return err
        }
        ctx.Export("httpsEndpoint", example.HttpsEndpoint)
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example = azure.hdinsight.get_cluster(name="example",
    resource_group_name="example-resources")
pulumi.export("httpsEndpoint", example.https_endpoint)

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.hdinsight.getCluster({
    name: "example",
    resourceGroupName: "example-resources",
});
export const httpsEndpoint = example.then(example => example.httpsEndpoint);

Using GetCluster

function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>

function  get_cluster(name=None, resource_group_name=None, opts=None)

func GetCluster(ctx *Context, args *GetClusterArgs, opts ...InvokeOption) (*GetClusterResult, error)

public static class GetCluster {
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string: Specifies the name of this HDInsight Cluster.
ResourceGroupName string: Specifies the name of the Resource Group in which this HDInsight Cluster exists.

Name string: Specifies the name of this HDInsight Cluster.
ResourceGroupName string: Specifies the name of the Resource Group in which this HDInsight Cluster exists.

name string: Specifies the name of this HDInsight Cluster.
resourceGroupName string: Specifies the name of the Resource Group in which this HDInsight Cluster exists.

name str: Specifies the name of this HDInsight Cluster.
resource_group_name str: Specifies the name of the Resource Group in which this HDInsight Cluster exists.

GetCluster Result

The following output properties are available:

ClusterVersion string: The version of HDInsights which is used on this HDInsight Cluster.
ComponentVersions Dictionary<string, string>: A map of versions of software used on this HDInsights Cluster.
EdgeSshEndpoint string: The SSH Endpoint of the Edge Node for this HDInsight Cluster, if an Edge Node exists.
Gateways List<GetClusterGateway>: A gateway block as defined below.
HttpsEndpoint string: The HTTPS Endpoint for this HDInsight Cluster.
Id string: The provider-assigned unique ID for this managed resource.
Kind string: The kind of HDInsight Cluster this is, such as a Spark or Storm cluster.
Location string: The Azure Region in which this HDInsight Cluster exists.
Name string
ResourceGroupName string
SshEndpoint string: The SSH Endpoint for this HDInsight Cluster.
Tags Dictionary<string, string>: A map of tags assigned to the HDInsight Cluster.
Tier string: The SKU / Tier of this HDInsight Cluster.
TlsMinVersion string

ClusterVersion string: The version of HDInsights which is used on this HDInsight Cluster.
ComponentVersions map[string]string: A map of versions of software used on this HDInsights Cluster.
EdgeSshEndpoint string: The SSH Endpoint of the Edge Node for this HDInsight Cluster, if an Edge Node exists.
Gateways []GetClusterGateway: A gateway block as defined below.
HttpsEndpoint string: The HTTPS Endpoint for this HDInsight Cluster.
Id string: The provider-assigned unique ID for this managed resource.
Kind string: The kind of HDInsight Cluster this is, such as a Spark or Storm cluster.
Location string: The Azure Region in which this HDInsight Cluster exists.
Name string
ResourceGroupName string
SshEndpoint string: The SSH Endpoint for this HDInsight Cluster.
Tags map[string]string: A map of tags assigned to the HDInsight Cluster.
Tier string: The SKU / Tier of this HDInsight Cluster.
TlsMinVersion string

clusterVersion string: The version of HDInsights which is used on this HDInsight Cluster.
componentVersions {[key: string]: string}: A map of versions of software used on this HDInsights Cluster.
edgeSshEndpoint string: The SSH Endpoint of the Edge Node for this HDInsight Cluster, if an Edge Node exists.
gateways GetClusterGateway[]: A gateway block as defined below.
httpsEndpoint string: The HTTPS Endpoint for this HDInsight Cluster.
id string: The provider-assigned unique ID for this managed resource.
kind string: The kind of HDInsight Cluster this is, such as a Spark or Storm cluster.
location string: The Azure Region in which this HDInsight Cluster exists.
name string
resourceGroupName string
sshEndpoint string: The SSH Endpoint for this HDInsight Cluster.
tags {[key: string]: string}: A map of tags assigned to the HDInsight Cluster.
tier string: The SKU / Tier of this HDInsight Cluster.
tlsMinVersion string

cluster_version str: The version of HDInsights which is used on this HDInsight Cluster.
component_versions Dict[str, str]: A map of versions of software used on this HDInsights Cluster.
edge_ssh_endpoint str: The SSH Endpoint of the Edge Node for this HDInsight Cluster, if an Edge Node exists.
gateways List[GetClusterGateway]: A gateway block as defined below.
https_endpoint str: The HTTPS Endpoint for this HDInsight Cluster.
id str: The provider-assigned unique ID for this managed resource.
kind str: The kind of HDInsight Cluster this is, such as a Spark or Storm cluster.
location str: The Azure Region in which this HDInsight Cluster exists.
name str
resource_group_name str
ssh_endpoint str: The SSH Endpoint for this HDInsight Cluster.
tags Dict[str, str]: A map of tags assigned to the HDInsight Cluster.
tier str: The SKU / Tier of this HDInsight Cluster.
tls_min_version str

Supporting Types

GetClusterGateway

See the output API doc for this type.

Enabled bool: Is the Ambari Portal enabled?
Password string: The password used for the Ambari Portal.
Username string: The username used for the Ambari Portal.

Enabled bool: Is the Ambari Portal enabled?
Password string: The password used for the Ambari Portal.
Username string: The username used for the Ambari Portal.

enabled boolean: Is the Ambari Portal enabled?
password string: The password used for the Ambari Portal.
username string: The username used for the Ambari Portal.

enabled bool: Is the Ambari Portal enabled?
password str: The password used for the Ambari Portal.
username str: The username used for the Ambari Portal.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetCluster

Example Usage

Using GetCluster

GetCluster Result

Supporting Types

GetClusterGateway

Package Details

On This Page