Azure Classic v5.43.0, May 6 23

We recommend using Azure Native.

Azure Classic v5.43.0 published on Saturday, May 6, 2023 by Pulumi

pulumi/pulumi-azure

azure.hdinsight.getCluster

Explore with Pulumi AI

We recommend using Azure Native.

Azure Classic v5.43.0 published on Saturday, May 6, 2023 by Pulumi

pulumi/pulumi-azure

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.HDInsight.GetCluster.Invoke(new()
    {
        Name = "example",
        ResourceGroupName = "example-resources",
    });

    return new Dictionary<string, object?>
    {
        ["httpsEndpoint"] = example.Apply(getClusterResult => getClusterResult.HttpsEndpoint),
    };
});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/hdinsight"
	"github.com/pulumi/pulumi/sdk/v3/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
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.hdinsight.HdinsightFunctions;
import com.pulumi.azure.hdinsight.inputs.GetClusterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = HdinsightFunctions.getCluster(GetClusterArgs.builder()
            .name("example")
            .resourceGroupName("example-resources")
            .build());

        ctx.export("httpsEndpoint", example.applyValue(getClusterResult -> getClusterResult.httpsEndpoint()));
    }
}

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);

variables:
  example:
    fn::invoke:
      Function: azure:hdinsight:getCluster
      Arguments:
        name: example
        resourceGroupName: example-resources
outputs:
  httpsEndpoint: ${example.httpsEndpoint}

Using getCluster

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

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

def get_cluster(name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]

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

> Note: This function is named GetCluster in the Go SDK.

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

public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure:hdinsight/getCluster:getCluster
  arguments:
    # arguments dictionary

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 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.

name String: Specifies the name of this HDInsight Cluster.
resourceGroupName String: 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.
KafkaRestProxyEndpoint string: The Kafka Rest Proxy Endpoint for this HDInsight Cluster.
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: The minimal supported TLS version.

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.
KafkaRestProxyEndpoint string: The Kafka Rest Proxy Endpoint for this HDInsight Cluster.
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: The minimal supported TLS version.

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 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.
kafkaRestProxyEndpoint String: The Kafka Rest Proxy Endpoint for this HDInsight Cluster.
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: The minimal supported TLS version.

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.
kafkaRestProxyEndpoint string: The Kafka Rest Proxy Endpoint for this HDInsight Cluster.
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: The minimal supported TLS version.

cluster_version str: The version of HDInsights which is used on this HDInsight Cluster.
component_versions Mapping[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 Sequence[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.
kafka_rest_proxy_endpoint str: The Kafka Rest Proxy Endpoint for this HDInsight Cluster.
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 Mapping[str, str]: A map of tags assigned to the HDInsight Cluster.
tier str: The SKU / Tier of this HDInsight Cluster.
tls_min_version str: The minimal supported TLS version.

clusterVersion String: The version of HDInsights which is used on this HDInsight Cluster.
componentVersions Map<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<Property Map>: 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.
kafkaRestProxyEndpoint String: The Kafka Rest Proxy Endpoint for this HDInsight Cluster.
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>: A map of tags assigned to the HDInsight Cluster.
tier String: The SKU / Tier of this HDInsight Cluster.
tlsMinVersion String: The minimal supported TLS version.

Supporting Types

GetClusterGateway

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 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.

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.

Package Details

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

We recommend using Azure Native.

Azure Classic v5.43.0 published on Saturday, May 6, 2023 by Pulumi

pulumi/pulumi-azure

azure.hdinsight.getCluster

On this page

On this page

Example Usage

Using getCluster

getCluster Result

Supporting Types

GetClusterGateway

Package Details

On this page

On this page