We recommend using Azure Native.
azure.hdinsight.getCluster
Explore with Pulumi AI
Use this data source to access information about an existing HDInsight Cluster.
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.
- Resource
Group stringName Specifies the name of the Resource Group in which this HDInsight Cluster exists.
- Name string
Specifies the name of this HDInsight Cluster.
- Resource
Group stringName Specifies the name of the Resource Group in which this HDInsight Cluster exists.
- name String
Specifies the name of this HDInsight Cluster.
- resource
Group StringName Specifies the name of the Resource Group in which this HDInsight Cluster exists.
- name string
Specifies the name of this HDInsight Cluster.
- resource
Group stringName Specifies the name of the Resource Group in which this HDInsight Cluster exists.
- name str
Specifies the name of this HDInsight Cluster.
- resource_
group_ strname Specifies the name of the Resource Group in which this HDInsight Cluster exists.
- name String
Specifies the name of this HDInsight Cluster.
- resource
Group StringName Specifies the name of the Resource Group in which this HDInsight Cluster exists.
getCluster Result
The following output properties are available:
- Cluster
Version string The version of HDInsights which is used on this HDInsight Cluster.
- Component
Versions Dictionary<string, string> A map of versions of software used on this HDInsights Cluster.
- Edge
Ssh stringEndpoint The SSH Endpoint of the Edge Node for this HDInsight Cluster, if an Edge Node exists.
- Gateways
List<Get
Cluster Gateway> A
gateway
block as defined below.- Https
Endpoint string The HTTPS Endpoint for this HDInsight Cluster.
- Id string
The provider-assigned unique ID for this managed resource.
- Kafka
Rest stringProxy Endpoint 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
- Resource
Group stringName - Ssh
Endpoint string The SSH Endpoint for this HDInsight Cluster.
- Dictionary<string, string>
A map of tags assigned to the HDInsight Cluster.
- Tier string
The SKU / Tier of this HDInsight Cluster.
- Tls
Min stringVersion The minimal supported TLS version.
- Cluster
Version string The version of HDInsights which is used on this HDInsight Cluster.
- Component
Versions map[string]string A map of versions of software used on this HDInsights Cluster.
- Edge
Ssh stringEndpoint The SSH Endpoint of the Edge Node for this HDInsight Cluster, if an Edge Node exists.
- Gateways
[]Get
Cluster Gateway A
gateway
block as defined below.- Https
Endpoint string The HTTPS Endpoint for this HDInsight Cluster.
- Id string
The provider-assigned unique ID for this managed resource.
- Kafka
Rest stringProxy Endpoint 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
- Resource
Group stringName - Ssh
Endpoint string The SSH Endpoint for this HDInsight Cluster.
- map[string]string
A map of tags assigned to the HDInsight Cluster.
- Tier string
The SKU / Tier of this HDInsight Cluster.
- Tls
Min stringVersion The minimal supported TLS version.
- cluster
Version String The version of HDInsights which is used on this HDInsight Cluster.
- component
Versions Map<String,String> A map of versions of software used on this HDInsights Cluster.
- edge
Ssh StringEndpoint The SSH Endpoint of the Edge Node for this HDInsight Cluster, if an Edge Node exists.
- gateways
List<Get
Cluster Gateway> A
gateway
block as defined below.- https
Endpoint String The HTTPS Endpoint for this HDInsight Cluster.
- id String
The provider-assigned unique ID for this managed resource.
- kafka
Rest StringProxy Endpoint 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
- resource
Group StringName - ssh
Endpoint String The SSH Endpoint for this HDInsight Cluster.
- Map<String,String>
A map of tags assigned to the HDInsight Cluster.
- tier String
The SKU / Tier of this HDInsight Cluster.
- tls
Min StringVersion The minimal supported TLS version.
- cluster
Version string The version of HDInsights which is used on this HDInsight Cluster.
- component
Versions {[key: string]: string} A map of versions of software used on this HDInsights Cluster.
- edge
Ssh stringEndpoint The SSH Endpoint of the Edge Node for this HDInsight Cluster, if an Edge Node exists.
- gateways
Get
Cluster Gateway[] A
gateway
block as defined below.- https
Endpoint string The HTTPS Endpoint for this HDInsight Cluster.
- id string
The provider-assigned unique ID for this managed resource.
- kafka
Rest stringProxy Endpoint 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
- resource
Group stringName - ssh
Endpoint string The SSH Endpoint for this HDInsight Cluster.
- {[key: string]: string}
A map of tags assigned to the HDInsight Cluster.
- tier string
The SKU / Tier of this HDInsight Cluster.
- tls
Min stringVersion 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_ strendpoint The SSH Endpoint of the Edge Node for this HDInsight Cluster, if an Edge Node exists.
- gateways
Sequence[Get
Cluster Gateway] 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_ strproxy_ endpoint 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_ strname - ssh_
endpoint str The SSH Endpoint for this HDInsight Cluster.
- Mapping[str, str]
A map of tags assigned to the HDInsight Cluster.
- tier str
The SKU / Tier of this HDInsight Cluster.
- tls_
min_ strversion The minimal supported TLS version.
- cluster
Version String The version of HDInsights which is used on this HDInsight Cluster.
- component
Versions Map<String> A map of versions of software used on this HDInsights Cluster.
- edge
Ssh StringEndpoint 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.- https
Endpoint String The HTTPS Endpoint for this HDInsight Cluster.
- id String
The provider-assigned unique ID for this managed resource.
- kafka
Rest StringProxy Endpoint 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
- resource
Group StringName - ssh
Endpoint String The SSH Endpoint for this HDInsight Cluster.
- Map<String>
A map of tags assigned to the HDInsight Cluster.
- tier String
The SKU / Tier of this HDInsight Cluster.
- tls
Min StringVersion The minimal supported TLS version.
Supporting Types
GetClusterGateway
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurerm
Terraform Provider.