Azure Native v3.1.0, Apr 8 25

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.azurestackhci.getCluster

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Other available API versions: 2022-12-15-preview, 2023-02-01, 2023-03-01, 2023-06-01, 2023-08-01, 2023-08-01-preview, 2023-11-01-preview, 2024-01-01, 2024-02-15-preview, 2024-09-01-preview, 2024-12-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native azurestackhci [ApiVersion]. See the version guide for details.

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.

TypeScript
Python
Go
C#
Java
YAML

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)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)

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:

AzureApiVersion string: The Azure API version of the resource.
BillingModel string: Type of billing applied to the resource.
CloudId string: Unique, immutable resource id.
ConnectivityStatus string: Overall connectivity status for the cluster resource.
Id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
IsolatedVmAttestationConfiguration Pulumi.AzureNative.AzureStackHCI.Outputs.IsolatedVmAttestationConfigurationResponse: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.
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
PrincipalId string: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
ProvisioningState string: Provisioning state.
RegistrationTimestamp string: First cluster sync timestamp.
ReportedProperties Pulumi.AzureNative.AzureStackHCI.Outputs.ClusterReportedPropertiesResponse: Properties reported by cluster agent.
ResourceProviderObjectId string: Object id of RP Service Principal
ServiceEndpoint string: Region specific DataPath Endpoint of the cluster.
Status string: Status of the cluster agent.
SystemData Pulumi.AzureNative.AzureStackHCI.Outputs.SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
TenantId string: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
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"
AadApplicationObjectId string: Object id of cluster AAD identity.
AadClientId string: App id of cluster AAD identity.
AadServicePrincipalObjectId string: Id of cluster identity service principal.
AadTenantId string: Tenant id of cluster AAD identity.
CloudManagementEndpoint string: Endpoint configured for management from the Azure portal.
DesiredProperties Pulumi.AzureNative.AzureStackHCI.Outputs.ClusterDesiredPropertiesResponse: Desired properties of the cluster.
LogCollectionProperties Pulumi.AzureNative.AzureStackHCI.Outputs.LogCollectionPropertiesResponse: Log Collection properties of the cluster.
RemoteSupportProperties Pulumi.AzureNative.AzureStackHCI.Outputs.RemoteSupportPropertiesResponse: RemoteSupport properties of the cluster.
SoftwareAssuranceProperties Pulumi.AzureNative.AzureStackHCI.Outputs.SoftwareAssurancePropertiesResponse: Software Assurance properties of the cluster.
Tags Dictionary<string, string>: Resource tags.
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.AzureStackHCI.Outputs.UserAssignedIdentityResponse>: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

AzureApiVersion string: The Azure API version of the resource.
BillingModel string: Type of billing applied to the resource.
CloudId string: Unique, immutable resource id.
ConnectivityStatus string: Overall connectivity status for the cluster resource.
Id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
IsolatedVmAttestationConfiguration IsolatedVmAttestationConfigurationResponse: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.
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
PrincipalId string: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
ProvisioningState string: Provisioning state.
RegistrationTimestamp string: First cluster sync timestamp.
ReportedProperties ClusterReportedPropertiesResponse: Properties reported by cluster agent.
ResourceProviderObjectId string: Object id of RP Service Principal
ServiceEndpoint string: Region specific DataPath Endpoint of the cluster.
Status string: Status of the cluster agent.
SystemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
TenantId string: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
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"
AadApplicationObjectId string: Object id of cluster AAD identity.
AadClientId string: App id of cluster AAD identity.
AadServicePrincipalObjectId string: Id of cluster identity service principal.
AadTenantId string: Tenant id of cluster AAD identity.
CloudManagementEndpoint string: Endpoint configured for management from the Azure portal.
DesiredProperties ClusterDesiredPropertiesResponse: Desired properties of the cluster.
LogCollectionProperties LogCollectionPropertiesResponse: Log Collection properties of the cluster.
RemoteSupportProperties RemoteSupportPropertiesResponse: RemoteSupport properties of the cluster.
SoftwareAssuranceProperties SoftwareAssurancePropertiesResponse: Software Assurance properties of the cluster.
Tags map[string]string: Resource tags.
UserAssignedIdentities map[string]UserAssignedIdentityResponse: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

azureApiVersion String: The Azure API version of the resource.
billingModel String: Type of billing applied to the resource.
cloudId String: Unique, immutable resource id.
connectivityStatus String: Overall connectivity status for the cluster resource.
id String: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
isolatedVmAttestationConfiguration IsolatedVmAttestationConfigurationResponse: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.
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
principalId String: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
provisioningState String: Provisioning state.
registrationTimestamp String: First cluster sync timestamp.
reportedProperties ClusterReportedPropertiesResponse: Properties reported by cluster agent.
resourceProviderObjectId String: Object id of RP Service Principal
serviceEndpoint String: Region specific DataPath Endpoint of the cluster.
status String: Status of the cluster agent.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId String: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
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"
aadApplicationObjectId String: Object id of cluster AAD identity.
aadClientId String: App id of cluster AAD identity.
aadServicePrincipalObjectId String: Id of cluster identity service principal.
aadTenantId String: Tenant id of cluster AAD identity.
cloudManagementEndpoint String: Endpoint configured for management from the Azure portal.
desiredProperties ClusterDesiredPropertiesResponse: Desired properties of the cluster.
logCollectionProperties LogCollectionPropertiesResponse: Log Collection properties of the cluster.
remoteSupportProperties RemoteSupportPropertiesResponse: RemoteSupport properties of the cluster.
softwareAssuranceProperties SoftwareAssurancePropertiesResponse: Software Assurance properties of the cluster.
tags Map<String,String>: Resource tags.
userAssignedIdentities Map<String,UserAssignedIdentityResponse>: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

azureApiVersion string: The Azure API version of the resource.
billingModel string: Type of billing applied to the resource.
cloudId string: Unique, immutable resource id.
connectivityStatus string: Overall connectivity status for the cluster resource.
id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
isolatedVmAttestationConfiguration IsolatedVmAttestationConfigurationResponse: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.
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
principalId string: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
provisioningState string: Provisioning state.
registrationTimestamp string: First cluster sync timestamp.
reportedProperties ClusterReportedPropertiesResponse: Properties reported by cluster agent.
resourceProviderObjectId string: Object id of RP Service Principal
serviceEndpoint string: Region specific DataPath Endpoint of the cluster.
status string: Status of the cluster agent.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId string: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
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"
aadApplicationObjectId string: Object id of cluster AAD identity.
aadClientId string: App id of cluster AAD identity.
aadServicePrincipalObjectId string: Id of cluster identity service principal.
aadTenantId string: Tenant id of cluster AAD identity.
cloudManagementEndpoint string: Endpoint configured for management from the Azure portal.
desiredProperties ClusterDesiredPropertiesResponse: Desired properties of the cluster.
logCollectionProperties LogCollectionPropertiesResponse: Log Collection properties of the cluster.
remoteSupportProperties RemoteSupportPropertiesResponse: RemoteSupport properties of the cluster.
softwareAssuranceProperties SoftwareAssurancePropertiesResponse: Software Assurance properties of the cluster.
tags {[key: string]: string}: Resource tags.
userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

azure_api_version str: The Azure API version of the resource.
billing_model str: Type of billing applied to the resource.
cloud_id str: Unique, immutable resource id.
connectivity_status str: Overall connectivity status for the cluster resource.
id str: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
isolated_vm_attestation_configuration IsolatedVmAttestationConfigurationResponse: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.
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
principal_id str: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
provisioning_state str: Provisioning state.
registration_timestamp str: First cluster sync timestamp.
reported_properties ClusterReportedPropertiesResponse: Properties reported by cluster agent.
resource_provider_object_id str: Object id of RP Service Principal
service_endpoint str: Region specific DataPath Endpoint of the cluster.
status str: Status of the cluster agent.
system_data SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenant_id str: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
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"
aad_application_object_id str: Object id of cluster AAD identity.
aad_client_id str: App id of cluster AAD identity.
aad_service_principal_object_id str: Id of cluster identity service principal.
aad_tenant_id str: Tenant id of cluster AAD identity.
cloud_management_endpoint str: Endpoint configured for management from the Azure portal.
desired_properties ClusterDesiredPropertiesResponse: Desired properties of the cluster.
log_collection_properties LogCollectionPropertiesResponse: Log Collection properties of the cluster.
remote_support_properties RemoteSupportPropertiesResponse: RemoteSupport properties of the cluster.
software_assurance_properties SoftwareAssurancePropertiesResponse: Software Assurance properties of the cluster.
tags Mapping[str, str]: Resource tags.
user_assigned_identities Mapping[str, UserAssignedIdentityResponse]: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

azureApiVersion String: The Azure API version of the resource.
billingModel String: Type of billing applied to the resource.
cloudId String: Unique, immutable resource id.
connectivityStatus String: Overall connectivity status for the cluster resource.
id String: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
isolatedVmAttestationConfiguration Property Map: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.
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
principalId String: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
provisioningState String: Provisioning state.
registrationTimestamp String: First cluster sync timestamp.
reportedProperties Property Map: Properties reported by cluster agent.
resourceProviderObjectId String: Object id of RP Service Principal
serviceEndpoint String: Region specific DataPath Endpoint of the cluster.
status String: Status of the cluster agent.
systemData Property Map: Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId String: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
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"
aadApplicationObjectId String: Object id of cluster AAD identity.
aadClientId String: App id of cluster AAD identity.
aadServicePrincipalObjectId String: Id of cluster identity service principal.
aadTenantId String: Tenant id of cluster AAD identity.
cloudManagementEndpoint String: Endpoint configured for management from the Azure portal.
desiredProperties Property Map: Desired properties of the cluster.
logCollectionProperties Property Map: Log Collection properties of the cluster.
remoteSupportProperties Property Map: RemoteSupport properties of the cluster.
softwareAssuranceProperties Property Map: Software Assurance properties of the cluster.
tags Map<String>: Resource tags.
userAssignedIdentities Map<Property Map>: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

Supporting Types

ClusterDesiredPropertiesResponse

DiagnosticLevel string: Desired level of diagnostic data emitted by the cluster.
WindowsServerSubscription string: Desired state of Windows Server Subscription.

DiagnosticLevel string: Desired level of diagnostic data emitted by the cluster.
WindowsServerSubscription string: Desired state of Windows Server Subscription.

diagnosticLevel String: Desired level of diagnostic data emitted by the cluster.
windowsServerSubscription String: Desired state of Windows Server Subscription.

diagnosticLevel string: Desired level of diagnostic data emitted by the cluster.
windowsServerSubscription string: Desired state of Windows Server Subscription.

diagnostic_level str: Desired level of diagnostic data emitted by the cluster.
windows_server_subscription str: Desired state of Windows Server Subscription.

diagnosticLevel String: Desired level of diagnostic data emitted by the cluster.
windowsServerSubscription String: Desired state of Windows Server Subscription.

ClusterNodeResponse

CoreCount double: Number of physical cores on the cluster node.
EhcResourceId string: Edge Hardware Center Resource Id
Id double: Id of the node in the cluster.
LastLicensingTimestamp string: Most recent licensing timestamp.
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.
NodeType string: Type of the cluster node hardware.
OemActivation string: OEM activation status of the node.
OsDisplayVersion string: Display version of the operating system running on 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.
WindowsServerSubscription string: State of Windows Server Subscription.

CoreCount float64: Number of physical cores on the cluster node.
EhcResourceId string: Edge Hardware Center Resource Id
Id float64: Id of the node in the cluster.
LastLicensingTimestamp string: Most recent licensing timestamp.
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.
NodeType string: Type of the cluster node hardware.
OemActivation string: OEM activation status of the node.
OsDisplayVersion string: Display version of the operating system running on 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.
WindowsServerSubscription string: State of Windows Server Subscription.

coreCount Double: Number of physical cores on the cluster node.
ehcResourceId String: Edge Hardware Center Resource Id
id Double: Id of the node in the cluster.
lastLicensingTimestamp String: Most recent licensing timestamp.
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.
nodeType String: Type of the cluster node hardware.
oemActivation String: OEM activation status of the node.
osDisplayVersion String: Display version of the operating system running on 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.
windowsServerSubscription String: State of Windows Server Subscription.

coreCount number: Number of physical cores on the cluster node.
ehcResourceId string: Edge Hardware Center Resource Id
id number: Id of the node in the cluster.
lastLicensingTimestamp string: Most recent licensing timestamp.
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.
nodeType string: Type of the cluster node hardware.
oemActivation string: OEM activation status of the node.
osDisplayVersion string: Display version of the operating system running on 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.
windowsServerSubscription string: State of Windows Server Subscription.

core_count float: Number of physical cores on the cluster node.
ehc_resource_id str: Edge Hardware Center Resource Id
id float: Id of the node in the cluster.
last_licensing_timestamp str: Most recent licensing timestamp.
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.
node_type str: Type of the cluster node hardware.
oem_activation str: OEM activation status of the node.
os_display_version str: Display version of the operating system running on 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.
windows_server_subscription str: State of Windows Server Subscription.

coreCount Number: Number of physical cores on the cluster node.
ehcResourceId String: Edge Hardware Center Resource Id
id Number: Id of the node in the cluster.
lastLicensingTimestamp String: Most recent licensing timestamp.
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.
nodeType String: Type of the cluster node hardware.
oemActivation String: OEM activation status of the node.
osDisplayVersion String: Display version of the operating system running on 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.
windowsServerSubscription String: State of Windows Server Subscription.

ClusterReportedPropertiesResponse

ClusterId string: Unique id generated by the on-prem cluster.
ClusterName string: Name of the on-prem cluster connected to this resource.
ClusterType string: The node type of all the nodes of the cluster.
ClusterVersion string: Version of the cluster software.
ImdsAttestation string: IMDS attestation status of the cluster.
LastUpdated string: Last time the cluster reported the data.
Manufacturer string: The manufacturer of all the nodes of the cluster.
Nodes List<Pulumi.AzureNative.AzureStackHCI.Inputs.ClusterNodeResponse>: List of nodes reported by the cluster.
OemActivation string: OEM activation status of the cluster.
SupportedCapabilities List<string>: Capabilities supported by the cluster.
DiagnosticLevel string: Level of diagnostic data emitted 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.
ClusterType string: The node type of all the nodes of the cluster.
ClusterVersion string: Version of the cluster software.
ImdsAttestation string: IMDS attestation status of the cluster.
LastUpdated string: Last time the cluster reported the data.
Manufacturer string: The manufacturer of all the nodes of the cluster.
Nodes []ClusterNodeResponse: List of nodes reported by the cluster.
OemActivation string: OEM activation status of the cluster.
SupportedCapabilities []string: Capabilities supported by the cluster.
DiagnosticLevel string: Level of diagnostic data emitted 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.
clusterType String: The node type of all the nodes of the cluster.
clusterVersion String: Version of the cluster software.
imdsAttestation String: IMDS attestation status of the cluster.
lastUpdated String: Last time the cluster reported the data.
manufacturer String: The manufacturer of all the nodes of the cluster.
nodes List<ClusterNodeResponse>: List of nodes reported by the cluster.
oemActivation String: OEM activation status of the cluster.
supportedCapabilities List<String>: Capabilities supported by the cluster.
diagnosticLevel String: Level of diagnostic data emitted 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.
clusterType string: The node type of all the nodes of the cluster.
clusterVersion string: Version of the cluster software.
imdsAttestation string: IMDS attestation status of the cluster.
lastUpdated string: Last time the cluster reported the data.
manufacturer string: The manufacturer of all the nodes of the cluster.
nodes ClusterNodeResponse[]: List of nodes reported by the cluster.
oemActivation string: OEM activation status of the cluster.
supportedCapabilities string[]: Capabilities supported by the cluster.
diagnosticLevel string: Level of diagnostic data emitted 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_type str: The node type of all the nodes of the cluster.
cluster_version str: Version of the cluster software.
imds_attestation str: IMDS attestation status of the cluster.
last_updated str: Last time the cluster reported the data.
manufacturer str: The manufacturer of all the nodes of the cluster.
nodes Sequence[ClusterNodeResponse]: List of nodes reported by the cluster.
oem_activation str: OEM activation status of the cluster.
supported_capabilities Sequence[str]: Capabilities supported by the cluster.
diagnostic_level str: Level of diagnostic data emitted 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.
clusterType String: The node type of all the nodes of the cluster.
clusterVersion String: Version of the cluster software.
imdsAttestation String: IMDS attestation status of the cluster.
lastUpdated String: Last time the cluster reported the data.
manufacturer String: The manufacturer of all the nodes of the cluster.
nodes List<Property Map>: List of nodes reported by the cluster.
oemActivation String: OEM activation status of the cluster.
supportedCapabilities List<String>: Capabilities supported by the cluster.
diagnosticLevel String: Level of diagnostic data emitted by the cluster.

IsolatedVmAttestationConfigurationResponse

AttestationResourceId string: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster.
AttestationServiceEndpoint string: Region specific endpoint for Microsoft Azure Attestation service for the cluster
RelyingPartyServiceEndpoint string: Region specific endpoint for relying party service.

AttestationResourceId string: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster.
AttestationServiceEndpoint string: Region specific endpoint for Microsoft Azure Attestation service for the cluster
RelyingPartyServiceEndpoint string: Region specific endpoint for relying party service.

attestationResourceId String: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster.
attestationServiceEndpoint String: Region specific endpoint for Microsoft Azure Attestation service for the cluster
relyingPartyServiceEndpoint String: Region specific endpoint for relying party service.

attestationResourceId string: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster.
attestationServiceEndpoint string: Region specific endpoint for Microsoft Azure Attestation service for the cluster
relyingPartyServiceEndpoint string: Region specific endpoint for relying party service.

attestation_resource_id str: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster.
attestation_service_endpoint str: Region specific endpoint for Microsoft Azure Attestation service for the cluster
relying_party_service_endpoint str: Region specific endpoint for relying party service.

attestationResourceId String: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster.
attestationServiceEndpoint String: Region specific endpoint for Microsoft Azure Attestation service for the cluster
relyingPartyServiceEndpoint String: Region specific endpoint for relying party service.

LogCollectionErrorResponse

ErrorCode string: Error Code of the log collection
ErrorMessage string: Error Message of the log collection

ErrorCode string: Error Code of the log collection
ErrorMessage string: Error Message of the log collection

errorCode String: Error Code of the log collection
errorMessage String: Error Message of the log collection

errorCode string: Error Code of the log collection
errorMessage string: Error Message of the log collection

error_code str: Error Code of the log collection
error_message str: Error Message of the log collection

errorCode String: Error Code of the log collection
errorMessage String: Error Message of the log collection

LogCollectionPropertiesResponse

FromDate string: From DateTimeStamp from when logs need to be connected
LastLogGenerated string: Recent DateTimeStamp where logs are successfully generated
LogCollectionSessionDetails List<Pulumi.AzureNative.AzureStackHCI.Inputs.LogCollectionSessionResponse>
ToDate string: To DateTimeStamp till when logs need to be connected

FromDate string: From DateTimeStamp from when logs need to be connected
LastLogGenerated string: Recent DateTimeStamp where logs are successfully generated
LogCollectionSessionDetails []LogCollectionSessionResponse
ToDate string: To DateTimeStamp till when logs need to be connected

fromDate String: From DateTimeStamp from when logs need to be connected
lastLogGenerated String: Recent DateTimeStamp where logs are successfully generated
logCollectionSessionDetails List<LogCollectionSessionResponse>
toDate String: To DateTimeStamp till when logs need to be connected

fromDate string: From DateTimeStamp from when logs need to be connected
lastLogGenerated string: Recent DateTimeStamp where logs are successfully generated
logCollectionSessionDetails LogCollectionSessionResponse[]
toDate string: To DateTimeStamp till when logs need to be connected

from_date str: From DateTimeStamp from when logs need to be connected
last_log_generated str: Recent DateTimeStamp where logs are successfully generated
log_collection_session_details Sequence[LogCollectionSessionResponse]
to_date str: To DateTimeStamp till when logs need to be connected

fromDate String: From DateTimeStamp from when logs need to be connected
lastLogGenerated String: Recent DateTimeStamp where logs are successfully generated
logCollectionSessionDetails List<Property Map>
toDate String: To DateTimeStamp till when logs need to be connected

LogCollectionSessionResponse

CorrelationId string: CorrelationId of the log collection
EndTimeCollected string: End Time of the logs when it was collected
LogCollectionError Pulumi.AzureNative.AzureStackHCI.Inputs.LogCollectionErrorResponse: Log Collection Error details of the cluster.
LogCollectionJobType string: LogCollection job type
LogCollectionStatus string: LogCollection status
LogEndTime string: End Time of the logs when it was collected
LogSize double: Size of the logs collected
LogStartTime string: Start Time of the logs when it was collected
TimeCollected string: Duration of logs collected

CorrelationId string: CorrelationId of the log collection
EndTimeCollected string: End Time of the logs when it was collected
LogCollectionError LogCollectionErrorResponse: Log Collection Error details of the cluster.
LogCollectionJobType string: LogCollection job type
LogCollectionStatus string: LogCollection status
LogEndTime string: End Time of the logs when it was collected
LogSize float64: Size of the logs collected
LogStartTime string: Start Time of the logs when it was collected
TimeCollected string: Duration of logs collected

correlationId String: CorrelationId of the log collection
endTimeCollected String: End Time of the logs when it was collected
logCollectionError LogCollectionErrorResponse: Log Collection Error details of the cluster.
logCollectionJobType String: LogCollection job type
logCollectionStatus String: LogCollection status
logEndTime String: End Time of the logs when it was collected
logSize Double: Size of the logs collected
logStartTime String: Start Time of the logs when it was collected
timeCollected String: Duration of logs collected

correlationId string: CorrelationId of the log collection
endTimeCollected string: End Time of the logs when it was collected
logCollectionError LogCollectionErrorResponse: Log Collection Error details of the cluster.
logCollectionJobType string: LogCollection job type
logCollectionStatus string: LogCollection status
logEndTime string: End Time of the logs when it was collected
logSize number: Size of the logs collected
logStartTime string: Start Time of the logs when it was collected
timeCollected string: Duration of logs collected

correlation_id str: CorrelationId of the log collection
end_time_collected str: End Time of the logs when it was collected
log_collection_error LogCollectionErrorResponse: Log Collection Error details of the cluster.
log_collection_job_type str: LogCollection job type
log_collection_status str: LogCollection status
log_end_time str: End Time of the logs when it was collected
log_size float: Size of the logs collected
log_start_time str: Start Time of the logs when it was collected
time_collected str: Duration of logs collected

correlationId String: CorrelationId of the log collection
endTimeCollected String: End Time of the logs when it was collected
logCollectionError Property Map: Log Collection Error details of the cluster.
logCollectionJobType String: LogCollection job type
logCollectionStatus String: LogCollection status
logEndTime String: End Time of the logs when it was collected
logSize Number: Size of the logs collected
logStartTime String: Start Time of the logs when it was collected
timeCollected String: Duration of logs collected

PerNodeRemoteSupportSessionResponse

AccessLevel string: Remote Support Access Level
Duration double: Duration of Remote Support Enablement
NodeName string: Name of the node
SessionEndTime string: Remote Support Session EndTime on the Node
SessionStartTime string: Remote Support Session StartTime on the Node

AccessLevel string: Remote Support Access Level
Duration float64: Duration of Remote Support Enablement
NodeName string: Name of the node
SessionEndTime string: Remote Support Session EndTime on the Node
SessionStartTime string: Remote Support Session StartTime on the Node

accessLevel String: Remote Support Access Level
duration Double: Duration of Remote Support Enablement
nodeName String: Name of the node
sessionEndTime String: Remote Support Session EndTime on the Node
sessionStartTime String: Remote Support Session StartTime on the Node

accessLevel string: Remote Support Access Level
duration number: Duration of Remote Support Enablement
nodeName string: Name of the node
sessionEndTime string: Remote Support Session EndTime on the Node
sessionStartTime string: Remote Support Session StartTime on the Node

access_level str: Remote Support Access Level
duration float: Duration of Remote Support Enablement
node_name str: Name of the node
session_end_time str: Remote Support Session EndTime on the Node
session_start_time str: Remote Support Session StartTime on the Node

accessLevel String: Remote Support Access Level
duration Number: Duration of Remote Support Enablement
nodeName String: Name of the node
sessionEndTime String: Remote Support Session EndTime on the Node
sessionStartTime String: Remote Support Session StartTime on the Node

RemoteSupportNodeSettingsResponse

ArcResourceId string: Arc ResourceId of the Node
ConnectionErrorMessage string: Remote Support Access Connection Error Message on the Node
ConnectionStatus string: Remote Support Access Connection Status on the Node
CreatedAt string: Remote Support Enablement Request Created TimeStamp on the Node
State string: Remote Support Access Connection State on the Node
TranscriptLocation string: Remote Support Transcript location on the node
UpdatedAt string: Remote Support Enablement Request Updated TimeStamp on the Node

ArcResourceId string: Arc ResourceId of the Node
ConnectionErrorMessage string: Remote Support Access Connection Error Message on the Node
ConnectionStatus string: Remote Support Access Connection Status on the Node
CreatedAt string: Remote Support Enablement Request Created TimeStamp on the Node
State string: Remote Support Access Connection State on the Node
TranscriptLocation string: Remote Support Transcript location on the node
UpdatedAt string: Remote Support Enablement Request Updated TimeStamp on the Node

arcResourceId String: Arc ResourceId of the Node
connectionErrorMessage String: Remote Support Access Connection Error Message on the Node
connectionStatus String: Remote Support Access Connection Status on the Node
createdAt String: Remote Support Enablement Request Created TimeStamp on the Node
state String: Remote Support Access Connection State on the Node
transcriptLocation String: Remote Support Transcript location on the node
updatedAt String: Remote Support Enablement Request Updated TimeStamp on the Node

arcResourceId string: Arc ResourceId of the Node
connectionErrorMessage string: Remote Support Access Connection Error Message on the Node
connectionStatus string: Remote Support Access Connection Status on the Node
createdAt string: Remote Support Enablement Request Created TimeStamp on the Node
state string: Remote Support Access Connection State on the Node
transcriptLocation string: Remote Support Transcript location on the node
updatedAt string: Remote Support Enablement Request Updated TimeStamp on the Node

arc_resource_id str: Arc ResourceId of the Node
connection_error_message str: Remote Support Access Connection Error Message on the Node
connection_status str: Remote Support Access Connection Status on the Node
created_at str: Remote Support Enablement Request Created TimeStamp on the Node
state str: Remote Support Access Connection State on the Node
transcript_location str: Remote Support Transcript location on the node
updated_at str: Remote Support Enablement Request Updated TimeStamp on the Node

arcResourceId String: Arc ResourceId of the Node
connectionErrorMessage String: Remote Support Access Connection Error Message on the Node
connectionStatus String: Remote Support Access Connection Status on the Node
createdAt String: Remote Support Enablement Request Created TimeStamp on the Node
state String: Remote Support Access Connection State on the Node
transcriptLocation String: Remote Support Transcript location on the node
updatedAt String: Remote Support Enablement Request Updated TimeStamp on the Node

RemoteSupportPropertiesResponse

AccessLevel string: Remote Support Access Level
ExpirationTimeStamp string: Expiration DateTimeStamp when Remote Support Access will be expired
RemoteSupportNodeSettings List<Pulumi.AzureNative.AzureStackHCI.Inputs.RemoteSupportNodeSettingsResponse>
RemoteSupportSessionDetails List<Pulumi.AzureNative.AzureStackHCI.Inputs.PerNodeRemoteSupportSessionResponse>
RemoteSupportType string: Remote Support Type for cluster

AccessLevel string: Remote Support Access Level
ExpirationTimeStamp string: Expiration DateTimeStamp when Remote Support Access will be expired
RemoteSupportNodeSettings []RemoteSupportNodeSettingsResponse
RemoteSupportSessionDetails []PerNodeRemoteSupportSessionResponse
RemoteSupportType string: Remote Support Type for cluster

accessLevel String: Remote Support Access Level
expirationTimeStamp String: Expiration DateTimeStamp when Remote Support Access will be expired
remoteSupportNodeSettings List<RemoteSupportNodeSettingsResponse>
remoteSupportSessionDetails List<PerNodeRemoteSupportSessionResponse>
remoteSupportType String: Remote Support Type for cluster

accessLevel string: Remote Support Access Level
expirationTimeStamp string: Expiration DateTimeStamp when Remote Support Access will be expired
remoteSupportNodeSettings RemoteSupportNodeSettingsResponse[]
remoteSupportSessionDetails PerNodeRemoteSupportSessionResponse[]
remoteSupportType string: Remote Support Type for cluster

access_level str: Remote Support Access Level
expiration_time_stamp str: Expiration DateTimeStamp when Remote Support Access will be expired
remote_support_node_settings Sequence[RemoteSupportNodeSettingsResponse]
remote_support_session_details Sequence[PerNodeRemoteSupportSessionResponse]
remote_support_type str: Remote Support Type for cluster

accessLevel String: Remote Support Access Level
expirationTimeStamp String: Expiration DateTimeStamp when Remote Support Access will be expired
remoteSupportNodeSettings List<Property Map>
remoteSupportSessionDetails List<Property Map>
remoteSupportType String: Remote Support Type for cluster

SoftwareAssurancePropertiesResponse

LastUpdated string: TimeStamp denoting the latest SA benefit applicability is validated.
SoftwareAssuranceStatus string: Status of the Software Assurance for the cluster.
SoftwareAssuranceIntent string: Customer Intent for Software Assurance Benefit.

LastUpdated string: TimeStamp denoting the latest SA benefit applicability is validated.
SoftwareAssuranceStatus string: Status of the Software Assurance for the cluster.
SoftwareAssuranceIntent string: Customer Intent for Software Assurance Benefit.

lastUpdated String: TimeStamp denoting the latest SA benefit applicability is validated.
softwareAssuranceStatus String: Status of the Software Assurance for the cluster.
softwareAssuranceIntent String: Customer Intent for Software Assurance Benefit.

lastUpdated string: TimeStamp denoting the latest SA benefit applicability is validated.
softwareAssuranceStatus string: Status of the Software Assurance for the cluster.
softwareAssuranceIntent string: Customer Intent for Software Assurance Benefit.

last_updated str: TimeStamp denoting the latest SA benefit applicability is validated.
software_assurance_status str: Status of the Software Assurance for the cluster.
software_assurance_intent str: Customer Intent for Software Assurance Benefit.

lastUpdated String: TimeStamp denoting the latest SA benefit applicability is validated.
softwareAssuranceStatus String: Status of the Software Assurance for the cluster.
softwareAssuranceIntent String: Customer Intent for Software Assurance Benefit.

SystemDataResponse

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.

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.

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.

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.

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.

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.

UserAssignedIdentityResponse

ClientId string: The client ID of the assigned identity.
PrincipalId string: The principal ID of the assigned identity.

ClientId string: The client ID of the assigned identity.
PrincipalId string: The principal ID of the assigned identity.

clientId String: The client ID of the assigned identity.
principalId String: The principal ID of the assigned identity.

clientId string: The client ID of the assigned identity.
principalId string: The principal ID of the assigned identity.

client_id str: The client ID of the assigned identity.
principal_id str: The principal ID of the assigned identity.

clientId String: The client ID of the assigned identity.
principalId String: The principal ID of the assigned identity.

Package Details

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

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.azurestackhci.getCluster

On this page

On this page

Using getCluster

getCluster Result

Supporting Types

ClusterDesiredPropertiesResponse

ClusterNodeResponse

ClusterReportedPropertiesResponse

IsolatedVmAttestationConfigurationResponse

LogCollectionErrorResponse

LogCollectionPropertiesResponse

LogCollectionSessionResponse

PerNodeRemoteSupportSessionResponse

RemoteSupportNodeSettingsResponse

RemoteSupportPropertiesResponse

SoftwareAssurancePropertiesResponse

SystemDataResponse

UserAssignedIdentityResponse

Package Details

On this page

On this page