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:
- Cluster
Name string The name of the cluster.
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- Cluster
Name string The name of the cluster.
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- cluster
Name String The name of the cluster.
- resource
Group StringName The name of the resource group. The name is case insensitive.
- cluster
Name string The name of the cluster.
- resource
Group stringName The name of the resource group. The name is case insensitive.
- cluster_
name str The name of the cluster.
- resource_
group_ strname The name of the resource group. The name is case insensitive.
- cluster
Name String The name of the cluster.
- resource
Group StringName The name of the resource group. The name is case insensitive.
getCluster Result
The following output properties are available:
- Aad
Client stringId App id of cluster AAD identity.
- Aad
Tenant stringId Tenant id of cluster AAD identity.
- Billing
Model string Type of billing applied to the resource.
- Cloud
Id string Unique, immutable resource id.
- Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Last
Billing stringTimestamp Most recent billing meter timestamp.
- Last
Sync stringTimestamp Most recent cluster sync timestamp.
- Location string
The geo-location where the resource lives
- Name string
The name of the resource
- Provisioning
State string Provisioning state.
- Registration
Timestamp string First cluster sync timestamp.
- Status string
Status of the cluster agent.
- Trial
Days doubleRemaining Number of days remaining in the trial period.
- Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- Reported
Properties Pulumi.Azure Native. Azure Stack HCI. Outputs. Cluster Reported Properties Response Properties reported by cluster agent.
- Dictionary<string, string>
Resource tags.
- Aad
Client stringId App id of cluster AAD identity.
- Aad
Tenant stringId Tenant id of cluster AAD identity.
- Billing
Model string Type of billing applied to the resource.
- Cloud
Id string Unique, immutable resource id.
- Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Last
Billing stringTimestamp Most recent billing meter timestamp.
- Last
Sync stringTimestamp Most recent cluster sync timestamp.
- Location string
The geo-location where the resource lives
- Name string
The name of the resource
- Provisioning
State string Provisioning state.
- Registration
Timestamp string First cluster sync timestamp.
- Status string
Status of the cluster agent.
- Trial
Days float64Remaining Number of days remaining in the trial period.
- Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- Reported
Properties ClusterReported Properties Response Properties reported by cluster agent.
- map[string]string
Resource tags.
- aad
Client StringId App id of cluster AAD identity.
- aad
Tenant StringId Tenant id of cluster AAD identity.
- billing
Model String Type of billing applied to the resource.
- cloud
Id String Unique, immutable resource id.
- id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- last
Billing StringTimestamp Most recent billing meter timestamp.
- last
Sync StringTimestamp Most recent cluster sync timestamp.
- location String
The geo-location where the resource lives
- name String
The name of the resource
- provisioning
State String Provisioning state.
- registration
Timestamp String First cluster sync timestamp.
- status String
Status of the cluster agent.
- trial
Days DoubleRemaining Number of days remaining in the trial period.
- type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
- reported
Properties ClusterReported Properties Response Properties reported by cluster agent.
- Map<String,String>
Resource tags.
- aad
Client stringId App id of cluster AAD identity.
- aad
Tenant stringId Tenant id of cluster AAD identity.
- billing
Model string Type of billing applied to the resource.
- cloud
Id string Unique, immutable resource id.
- id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- last
Billing stringTimestamp Most recent billing meter timestamp.
- last
Sync stringTimestamp Most recent cluster sync timestamp.
- location string
The geo-location where the resource lives
- name string
The name of the resource
- provisioning
State string Provisioning state.
- registration
Timestamp string First cluster sync timestamp.
- status string
Status of the cluster agent.
- trial
Days numberRemaining Number of days remaining in the trial period.
- type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- created
At string The timestamp of resource creation (UTC).
- created
By string The identity that created the resource.
- created
By stringType The type of identity that created the resource.
- last
Modified stringAt The timestamp of resource last modification (UTC)
- last
Modified stringBy The identity that last modified the resource.
- last
Modified stringBy Type The type of identity that last modified the resource.
- reported
Properties ClusterReported Properties Response Properties reported by cluster agent.
- {[key: string]: string}
Resource tags.
- aad_
client_ strid App id of cluster AAD identity.
- aad_
tenant_ strid 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_ strtimestamp Most recent billing meter timestamp.
- last_
sync_ strtimestamp 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_ floatremaining 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_ strtype The type of identity that created the resource.
- last_
modified_ strat The timestamp of resource last modification (UTC)
- last_
modified_ strby The identity that last modified the resource.
- last_
modified_ strby_ type The type of identity that last modified the resource.
- reported_
properties ClusterReported Properties Response Properties reported by cluster agent.
- Mapping[str, str]
Resource tags.
- aad
Client StringId App id of cluster AAD identity.
- aad
Tenant StringId Tenant id of cluster AAD identity.
- billing
Model String Type of billing applied to the resource.
- cloud
Id String Unique, immutable resource id.
- id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- last
Billing StringTimestamp Most recent billing meter timestamp.
- last
Sync StringTimestamp Most recent cluster sync timestamp.
- location String
The geo-location where the resource lives
- name String
The name of the resource
- provisioning
State String Provisioning state.
- registration
Timestamp String First cluster sync timestamp.
- status String
Status of the cluster agent.
- trial
Days NumberRemaining Number of days remaining in the trial period.
- type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
- reported
Properties Property Map Properties reported by cluster agent.
- Map<String>
Resource tags.
Supporting Types
ClusterNodeResponse
- Core
Count 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.
- Memory
In doubleGi B 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.
- Os
Name string Operating system running on the cluster node.
- Os
Version string Version of the operating system running on the cluster node.
- Serial
Number string Immutable id of the cluster node.
- Core
Count 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.
- Memory
In float64Gi B 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.
- Os
Name string Operating system running on the cluster node.
- Os
Version string Version of the operating system running on the cluster node.
- Serial
Number string Immutable id of the cluster node.
- core
Count 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.
- memory
In DoubleGi B 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.
- os
Name String Operating system running on the cluster node.
- os
Version String Version of the operating system running on the cluster node.
- serial
Number String Immutable id of the cluster node.
- core
Count 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.
- memory
In numberGi B 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.
- os
Name string Operating system running on the cluster node.
- os
Version string Version of the operating system running on the cluster node.
- serial
Number 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_ floatgi_ b 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.
- core
Count 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.
- memory
In NumberGi B 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.
- os
Name String Operating system running on the cluster node.
- os
Version String Version of the operating system running on the cluster node.
- serial
Number String Immutable id of the cluster node.
ClusterReportedPropertiesResponse
- Cluster
Id string Unique id generated by the on-prem cluster.
- Cluster
Name string Name of the on-prem cluster connected to this resource.
- Cluster
Version string Version of the cluster software.
- Last
Updated string Last time the cluster reported the data.
- Nodes
List<Pulumi.
Azure Native. Azure Stack HCI. Inputs. Cluster Node Response> List of nodes reported by the cluster.
- Cluster
Id string Unique id generated by the on-prem cluster.
- Cluster
Name string Name of the on-prem cluster connected to this resource.
- Cluster
Version string Version of the cluster software.
- Last
Updated string Last time the cluster reported the data.
- Nodes
[]Cluster
Node Response List of nodes reported by the cluster.
- cluster
Id String Unique id generated by the on-prem cluster.
- cluster
Name String Name of the on-prem cluster connected to this resource.
- cluster
Version String Version of the cluster software.
- last
Updated String Last time the cluster reported the data.
- nodes
List<Cluster
Node Response> List of nodes reported by the cluster.
- cluster
Id string Unique id generated by the on-prem cluster.
- cluster
Name string Name of the on-prem cluster connected to this resource.
- cluster
Version string Version of the cluster software.
- last
Updated string Last time the cluster reported the data.
- nodes
Cluster
Node Response[] 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[Cluster
Node Response] List of nodes reported by the cluster.
- cluster
Id String Unique id generated by the on-prem cluster.
- cluster
Name String Name of the on-prem cluster connected to this resource.
- cluster
Version String Version of the cluster software.
- last
Updated 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