1. Packages
  2. Azure Native
  3. API Docs
  4. avs
  5. getCluster
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.9.0 published on Wednesday, Sep 27, 2023 by Pulumi

azure-native.avs.getCluster

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.9.0 published on Wednesday, Sep 27, 2023 by Pulumi

    A cluster resource Azure REST API version: 2022-05-01.

    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(cluster_name: Optional[str] = None,
                    private_cloud_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetClusterResult
    def get_cluster_output(cluster_name: Optional[pulumi.Input[str]] = None,
                    private_cloud_name: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
    func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
    func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

    > Note: This function is named LookupCluster 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-native:avs:getCluster
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ClusterName string

    Name of the cluster in the private cloud

    PrivateCloudName string

    Name of the private cloud

    ResourceGroupName string

    The name of the resource group. The name is case insensitive.

    ClusterName string

    Name of the cluster in the private cloud

    PrivateCloudName string

    Name of the private cloud

    ResourceGroupName string

    The name of the resource group. The name is case insensitive.

    clusterName String

    Name of the cluster in the private cloud

    privateCloudName String

    Name of the private cloud

    resourceGroupName String

    The name of the resource group. The name is case insensitive.

    clusterName string

    Name of the cluster in the private cloud

    privateCloudName string

    Name of the private cloud

    resourceGroupName string

    The name of the resource group. The name is case insensitive.

    cluster_name str

    Name of the cluster in the private cloud

    private_cloud_name str

    Name of the private cloud

    resource_group_name str

    The name of the resource group. The name is case insensitive.

    clusterName String

    Name of the cluster in the private cloud

    privateCloudName String

    Name of the private cloud

    resourceGroupName String

    The name of the resource group. The name is case insensitive.

    getCluster Result

    The following output properties are available:

    ClusterId int

    The identity

    Id string

    Resource ID.

    Name string

    Resource name.

    ProvisioningState string

    The state of the cluster provisioning

    Sku Pulumi.AzureNative.AVS.Outputs.SkuResponse

    The cluster SKU

    Type string

    Resource type.

    ClusterSize int

    The cluster size

    Hosts List<string>

    The hosts

    ClusterId int

    The identity

    Id string

    Resource ID.

    Name string

    Resource name.

    ProvisioningState string

    The state of the cluster provisioning

    Sku SkuResponse

    The cluster SKU

    Type string

    Resource type.

    ClusterSize int

    The cluster size

    Hosts []string

    The hosts

    clusterId Integer

    The identity

    id String

    Resource ID.

    name String

    Resource name.

    provisioningState String

    The state of the cluster provisioning

    sku SkuResponse

    The cluster SKU

    type String

    Resource type.

    clusterSize Integer

    The cluster size

    hosts List<String>

    The hosts

    clusterId number

    The identity

    id string

    Resource ID.

    name string

    Resource name.

    provisioningState string

    The state of the cluster provisioning

    sku SkuResponse

    The cluster SKU

    type string

    Resource type.

    clusterSize number

    The cluster size

    hosts string[]

    The hosts

    cluster_id int

    The identity

    id str

    Resource ID.

    name str

    Resource name.

    provisioning_state str

    The state of the cluster provisioning

    sku SkuResponse

    The cluster SKU

    type str

    Resource type.

    cluster_size int

    The cluster size

    hosts Sequence[str]

    The hosts

    clusterId Number

    The identity

    id String

    Resource ID.

    name String

    Resource name.

    provisioningState String

    The state of the cluster provisioning

    sku Property Map

    The cluster SKU

    type String

    Resource type.

    clusterSize Number

    The cluster size

    hosts List<String>

    The hosts

    Supporting Types

    SkuResponse

    Name string

    The name of the SKU.

    Name string

    The name of the SKU.

    name String

    The name of the SKU.

    name string

    The name of the SKU.

    name str

    The name of the SKU.

    name String

    The name of the SKU.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.9.0 published on Wednesday, Sep 27, 2023 by Pulumi