Azure Native v1.102.0, May 2 23

azure-native.azurestackhci.getCluster

Explore with Pulumi AI

Get HCI cluster. API Version: 2020-10-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,
                resource_group_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_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:azurestackhci:getCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

ClusterName string: The name of the cluster.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

ClusterName string: The name of the cluster.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

clusterName String: The name of the cluster.
resourceGroupName String: The name of the resource group. The name is case insensitive.

clusterName string: The name of the cluster.
resourceGroupName string: The name of the resource group. The name is case insensitive.

cluster_name str: The name of the cluster.
resource_group_name str: The name of the resource group. The name is case insensitive.

clusterName String: The name of the cluster.
resourceGroupName String: The name of the resource group. The name is case insensitive.

getCluster Result

The following output properties are available:

AadClientId string: App id of cluster AAD identity.
AadTenantId string: Tenant id of cluster AAD identity.
BillingModel string: Type of billing applied to the resource.
CloudId string: Unique, immutable resource id.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
LastBillingTimestamp string: Most recent billing meter timestamp.
LastSyncTimestamp string: Most recent cluster sync timestamp.
Location string: The geo-location where the resource lives
Name string: The name of the resource
ProvisioningState string: Provisioning state.
RegistrationTimestamp string: First cluster sync timestamp.
Status string: Status of the cluster agent.
TrialDaysRemaining double: Number of days remaining in the trial period.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: 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 string: The type of identity that last modified the resource.
ReportedProperties Pulumi.AzureNative.AzureStackHCI.Outputs.ClusterReportedPropertiesResponse: Properties reported by cluster agent.
Tags Dictionary<string, string>: Resource tags.

AadClientId string: App id of cluster AAD identity.
AadTenantId string: Tenant id of cluster AAD identity.
BillingModel string: Type of billing applied to the resource.
CloudId string: Unique, immutable resource id.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
LastBillingTimestamp string: Most recent billing meter timestamp.
LastSyncTimestamp string: Most recent cluster sync timestamp.
Location string: The geo-location where the resource lives
Name string: The name of the resource
ProvisioningState string: Provisioning state.
RegistrationTimestamp string: First cluster sync timestamp.
Status string: Status of the cluster agent.
TrialDaysRemaining float64: Number of days remaining in the trial period.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: 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 string: The type of identity that last modified the resource.
ReportedProperties ClusterReportedPropertiesResponse: Properties reported by cluster agent.
Tags map[string]string: Resource tags.

aadClientId String: App id of cluster AAD identity.
aadTenantId String: Tenant id of cluster AAD identity.
billingModel String: Type of billing applied to the resource.
cloudId String: Unique, immutable resource id.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
lastBillingTimestamp String: Most recent billing meter timestamp.
lastSyncTimestamp String: Most recent cluster sync timestamp.
location String: The geo-location where the resource lives
name String: The name of the resource
provisioningState String: Provisioning state.
registrationTimestamp String: First cluster sync timestamp.
status String: Status of the cluster agent.
trialDaysRemaining Double: Number of days remaining in the trial period.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: 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 String: The type of identity that last modified the resource.
reportedProperties ClusterReportedPropertiesResponse: Properties reported by cluster agent.
tags Map<String,String>: Resource tags.

aadClientId string: App id of cluster AAD identity.
aadTenantId string: Tenant id of cluster AAD identity.
billingModel string: Type of billing applied to the resource.
cloudId string: Unique, immutable resource id.
id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
lastBillingTimestamp string: Most recent billing meter timestamp.
lastSyncTimestamp string: Most recent cluster sync timestamp.
location string: The geo-location where the resource lives
name string: The name of the resource
provisioningState string: Provisioning state.
registrationTimestamp string: First cluster sync timestamp.
status string: Status of the cluster agent.
trialDaysRemaining number: Number of days remaining in the trial period.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string: 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 string: The type of identity that last modified the resource.
reportedProperties ClusterReportedPropertiesResponse: Properties reported by cluster agent.
tags {[key: string]: string}: Resource tags.

aad_client_id str: App id of cluster AAD identity.
aad_tenant_id str: Tenant id of cluster AAD identity.
billing_model str: Type of billing applied to the resource.
cloud_id str: Unique, immutable resource id.
id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
last_billing_timestamp str: Most recent billing meter timestamp.
last_sync_timestamp str: Most recent cluster sync timestamp.
location str: The geo-location where the resource lives
name str: The name of the resource
provisioning_state str: Provisioning state.
registration_timestamp str: First cluster sync timestamp.
status str: Status of the cluster agent.
trial_days_remaining float: Number of days remaining in the trial period.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str: The type of identity that created the resource.
last_modified_at str: The timestamp of resource last modification (UTC)
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: The type of identity that last modified the resource.
reported_properties ClusterReportedPropertiesResponse: Properties reported by cluster agent.
tags Mapping[str, str]: Resource tags.

aadClientId String: App id of cluster AAD identity.
aadTenantId String: Tenant id of cluster AAD identity.
billingModel String: Type of billing applied to the resource.
cloudId String: Unique, immutable resource id.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
lastBillingTimestamp String: Most recent billing meter timestamp.
lastSyncTimestamp String: Most recent cluster sync timestamp.
location String: The geo-location where the resource lives
name String: The name of the resource
provisioningState String: Provisioning state.
registrationTimestamp String: First cluster sync timestamp.
status String: Status of the cluster agent.
trialDaysRemaining Number: Number of days remaining in the trial period.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: 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 String: The type of identity that last modified the resource.
reportedProperties Property Map: Properties reported by cluster agent.
tags Map<String>: Resource tags.

Supporting Types

ClusterNodeResponse

CoreCount double: Number of physical cores on the cluster node.
Id double: Id of the node in the cluster.
Manufacturer string: Manufacturer of the cluster node hardware.
MemoryInGiB double: Total available memory on the cluster node (in GiB).
Model string: Model name of the cluster node hardware.
Name string: Name of the cluster node.
OsName string: Operating system running on the cluster node.
OsVersion string: Version of the operating system running on the cluster node.
SerialNumber string: Immutable id of the cluster node.

CoreCount float64: Number of physical cores on the cluster node.
Id float64: Id of the node in the cluster.
Manufacturer string: Manufacturer of the cluster node hardware.
MemoryInGiB float64: Total available memory on the cluster node (in GiB).
Model string: Model name of the cluster node hardware.
Name string: Name of the cluster node.
OsName string: Operating system running on the cluster node.
OsVersion string: Version of the operating system running on the cluster node.
SerialNumber string: Immutable id of the cluster node.

coreCount Double: Number of physical cores on the cluster node.
id Double: Id of the node in the cluster.
manufacturer String: Manufacturer of the cluster node hardware.
memoryInGiB Double: Total available memory on the cluster node (in GiB).
model String: Model name of the cluster node hardware.
name String: Name of the cluster node.
osName String: Operating system running on the cluster node.
osVersion String: Version of the operating system running on the cluster node.
serialNumber String: Immutable id of the cluster node.

coreCount number: Number of physical cores on the cluster node.
id number: Id of the node in the cluster.
manufacturer string: Manufacturer of the cluster node hardware.
memoryInGiB number: Total available memory on the cluster node (in GiB).
model string: Model name of the cluster node hardware.
name string: Name of the cluster node.
osName string: Operating system running on the cluster node.
osVersion string: Version of the operating system running on the cluster node.
serialNumber string: Immutable id of the cluster node.

core_count float: Number of physical cores on the cluster node.
id float: Id of the node in the cluster.
manufacturer str: Manufacturer of the cluster node hardware.
memory_in_gi_b float: Total available memory on the cluster node (in GiB).
model str: Model name of the cluster node hardware.
name str: Name of the cluster node.
os_name str: Operating system running on the cluster node.
os_version str: Version of the operating system running on the cluster node.
serial_number str: Immutable id of the cluster node.

coreCount Number: Number of physical cores on the cluster node.
id Number: Id of the node in the cluster.
manufacturer String: Manufacturer of the cluster node hardware.
memoryInGiB Number: Total available memory on the cluster node (in GiB).
model String: Model name of the cluster node hardware.
name String: Name of the cluster node.
osName String: Operating system running on the cluster node.
osVersion String: Version of the operating system running on the cluster node.
serialNumber String: Immutable id of the cluster node.

ClusterReportedPropertiesResponse

ClusterId string: Unique id generated by the on-prem cluster.
ClusterName string: Name of the on-prem cluster connected to this resource.
ClusterVersion string: Version of the cluster software.
LastUpdated string: Last time the cluster reported the data.
Nodes List<Pulumi.AzureNative.AzureStackHCI.Inputs.ClusterNodeResponse>: List of nodes reported by the cluster.

ClusterId string: Unique id generated by the on-prem cluster.
ClusterName string: Name of the on-prem cluster connected to this resource.
ClusterVersion string: Version of the cluster software.
LastUpdated string: Last time the cluster reported the data.
Nodes []ClusterNodeResponse: List of nodes reported by the cluster.

clusterId String: Unique id generated by the on-prem cluster.
clusterName String: Name of the on-prem cluster connected to this resource.
clusterVersion String: Version of the cluster software.
lastUpdated String: Last time the cluster reported the data.
nodes List<ClusterNodeResponse>: List of nodes reported by the cluster.

clusterId string: Unique id generated by the on-prem cluster.
clusterName string: Name of the on-prem cluster connected to this resource.
clusterVersion string: Version of the cluster software.
lastUpdated string: Last time the cluster reported the data.
nodes ClusterNodeResponse[]: List of nodes reported by the cluster.

cluster_id str: Unique id generated by the on-prem cluster.
cluster_name str: Name of the on-prem cluster connected to this resource.
cluster_version str: Version of the cluster software.
last_updated str: Last time the cluster reported the data.
nodes Sequence[ClusterNodeResponse]: List of nodes reported by the cluster.

clusterId String: Unique id generated by the on-prem cluster.
clusterName String: Name of the on-prem cluster connected to this resource.
clusterVersion String: Version of the cluster software.
lastUpdated String: Last time the cluster reported the data.
nodes List<Property Map>: List of nodes reported by the cluster.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0