Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. offazure
  5. getHypervClusterControllerCluster
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.offazure.getHypervClusterControllerCluster

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Method to get a Hyper-V cluster. Azure REST API version: 2023-06-06.

Other available API versions: 2023-10-01-preview, 2024-05-01-preview.

Using getHypervClusterControllerCluster

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 getHypervClusterControllerCluster(args: GetHypervClusterControllerClusterArgs, opts?: InvokeOptions): Promise<GetHypervClusterControllerClusterResult>
function getHypervClusterControllerClusterOutput(args: GetHypervClusterControllerClusterOutputArgs, opts?: InvokeOptions): Output<GetHypervClusterControllerClusterResult>
Copy
def get_hyperv_cluster_controller_cluster(cluster_name: Optional[str] = None,
                                          resource_group_name: Optional[str] = None,
                                          site_name: Optional[str] = None,
                                          opts: Optional[InvokeOptions] = None) -> GetHypervClusterControllerClusterResult
def get_hyperv_cluster_controller_cluster_output(cluster_name: Optional[pulumi.Input[str]] = None,
                                          resource_group_name: Optional[pulumi.Input[str]] = None,
                                          site_name: Optional[pulumi.Input[str]] = None,
                                          opts: Optional[InvokeOptions] = None) -> Output[GetHypervClusterControllerClusterResult]
Copy
func LookupHypervClusterControllerCluster(ctx *Context, args *LookupHypervClusterControllerClusterArgs, opts ...InvokeOption) (*LookupHypervClusterControllerClusterResult, error)
func LookupHypervClusterControllerClusterOutput(ctx *Context, args *LookupHypervClusterControllerClusterOutputArgs, opts ...InvokeOption) LookupHypervClusterControllerClusterResultOutput
Copy

> Note: This function is named LookupHypervClusterControllerCluster in the Go SDK.

public static class GetHypervClusterControllerCluster 
{
    public static Task<GetHypervClusterControllerClusterResult> InvokeAsync(GetHypervClusterControllerClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetHypervClusterControllerClusterResult> Invoke(GetHypervClusterControllerClusterInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetHypervClusterControllerClusterResult> getHypervClusterControllerCluster(GetHypervClusterControllerClusterArgs args, InvokeOptions options)
public static Output<GetHypervClusterControllerClusterResult> getHypervClusterControllerCluster(GetHypervClusterControllerClusterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:offazure:getHypervClusterControllerCluster
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterName
This property is required.
Changes to this property will trigger replacement.
string
Cluster ARM name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SiteName
This property is required.
Changes to this property will trigger replacement.
string
Site name
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
Cluster ARM name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SiteName
This property is required.
Changes to this property will trigger replacement.
string
Site name
clusterName
This property is required.
Changes to this property will trigger replacement.
String
Cluster ARM name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
siteName
This property is required.
Changes to this property will trigger replacement.
String
Site name
clusterName
This property is required.
Changes to this property will trigger replacement.
string
Cluster ARM name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
siteName
This property is required.
Changes to this property will trigger replacement.
string
Site name
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
Cluster ARM name
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
site_name
This property is required.
Changes to this property will trigger replacement.
str
Site name
clusterName
This property is required.
Changes to this property will trigger replacement.
String
Cluster ARM name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
siteName
This property is required.
Changes to this property will trigger replacement.
String
Site name

getHypervClusterControllerCluster Result

The following output properties are available:

CreatedTimestamp string
Gets the timestamp marking Hyper-V cluster creation.
Errors List<Pulumi.AzureNative.OffAzure.Outputs.HealthErrorDetailsResponse>
Gets the errors.
FunctionalLevel int
Gets the functional level of the Hyper-V cluster.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Status string
Gets the status of the Hyper-V cluster.
SystemData Pulumi.AzureNative.OffAzure.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
UpdatedTimestamp string
Gets the timestamp marking last updated on the Hyper-V cluster.
Fqdn string
Gets or sets the FQDN/IPAddress of the Hyper-V cluster.
HostFqdnList List<string>
Gets or sets list of hosts (FQDN) currently being tracked by the cluster.
ProvisioningState string
The status of the last operation.
RunAsAccountId string
Gets or sets Run as account ID of the Hyper-V cluster.
CreatedTimestamp string
Gets the timestamp marking Hyper-V cluster creation.
Errors []HealthErrorDetailsResponse
Gets the errors.
FunctionalLevel int
Gets the functional level of the Hyper-V cluster.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Status string
Gets the status of the Hyper-V cluster.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
UpdatedTimestamp string
Gets the timestamp marking last updated on the Hyper-V cluster.
Fqdn string
Gets or sets the FQDN/IPAddress of the Hyper-V cluster.
HostFqdnList []string
Gets or sets list of hosts (FQDN) currently being tracked by the cluster.
ProvisioningState string
The status of the last operation.
RunAsAccountId string
Gets or sets Run as account ID of the Hyper-V cluster.
createdTimestamp String
Gets the timestamp marking Hyper-V cluster creation.
errors List<HealthErrorDetailsResponse>
Gets the errors.
functionalLevel Integer
Gets the functional level of the Hyper-V cluster.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
status String
Gets the status of the Hyper-V cluster.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
updatedTimestamp String
Gets the timestamp marking last updated on the Hyper-V cluster.
fqdn String
Gets or sets the FQDN/IPAddress of the Hyper-V cluster.
hostFqdnList List<String>
Gets or sets list of hosts (FQDN) currently being tracked by the cluster.
provisioningState String
The status of the last operation.
runAsAccountId String
Gets or sets Run as account ID of the Hyper-V cluster.
createdTimestamp string
Gets the timestamp marking Hyper-V cluster creation.
errors HealthErrorDetailsResponse[]
Gets the errors.
functionalLevel number
Gets the functional level of the Hyper-V cluster.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
status string
Gets the status of the Hyper-V cluster.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
updatedTimestamp string
Gets the timestamp marking last updated on the Hyper-V cluster.
fqdn string
Gets or sets the FQDN/IPAddress of the Hyper-V cluster.
hostFqdnList string[]
Gets or sets list of hosts (FQDN) currently being tracked by the cluster.
provisioningState string
The status of the last operation.
runAsAccountId string
Gets or sets Run as account ID of the Hyper-V cluster.
created_timestamp str
Gets the timestamp marking Hyper-V cluster creation.
errors Sequence[HealthErrorDetailsResponse]
Gets the errors.
functional_level int
Gets the functional level of the Hyper-V cluster.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
status str
Gets the status of the Hyper-V cluster.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
updated_timestamp str
Gets the timestamp marking last updated on the Hyper-V cluster.
fqdn str
Gets or sets the FQDN/IPAddress of the Hyper-V cluster.
host_fqdn_list Sequence[str]
Gets or sets list of hosts (FQDN) currently being tracked by the cluster.
provisioning_state str
The status of the last operation.
run_as_account_id str
Gets or sets Run as account ID of the Hyper-V cluster.
createdTimestamp String
Gets the timestamp marking Hyper-V cluster creation.
errors List<Property Map>
Gets the errors.
functionalLevel Number
Gets the functional level of the Hyper-V cluster.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
status String
Gets the status of the Hyper-V cluster.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
updatedTimestamp String
Gets the timestamp marking last updated on the Hyper-V cluster.
fqdn String
Gets or sets the FQDN/IPAddress of the Hyper-V cluster.
hostFqdnList List<String>
Gets or sets list of hosts (FQDN) currently being tracked by the cluster.
provisioningState String
The status of the last operation.
runAsAccountId String
Gets or sets Run as account ID of the Hyper-V cluster.

Supporting Types

HealthErrorDetailsResponse

ApplianceName This property is required. string
Gets the appliance name.
Code This property is required. string
Gets the error name.
DiscoveryScope This property is required. string
Gets discovery scope for which error is encountered.
Id This property is required. double
Gets the error ID.
Message This property is required. string
Gets the error message.
MessageParameters This property is required. Dictionary<string, string>
Gets the message parameters.
PossibleCauses This property is required. string
Gets the possible causes of error.
RecommendedAction This property is required. string
Gets the recommended action to resolve error.
RunAsAccountId This property is required. string
Gets run as account id used while performing discovery of entity.
Severity This property is required. string
Gets the error severity.
Source This property is required. string
Gets the error source.
SummaryMessage This property is required. string
Gets the error summary message.
UpdatedTimeStamp This property is required. string
Gets the time stamp when the error was updated.
ApplianceName This property is required. string
Gets the appliance name.
Code This property is required. string
Gets the error name.
DiscoveryScope This property is required. string
Gets discovery scope for which error is encountered.
Id This property is required. float64
Gets the error ID.
Message This property is required. string
Gets the error message.
MessageParameters This property is required. map[string]string
Gets the message parameters.
PossibleCauses This property is required. string
Gets the possible causes of error.
RecommendedAction This property is required. string
Gets the recommended action to resolve error.
RunAsAccountId This property is required. string
Gets run as account id used while performing discovery of entity.
Severity This property is required. string
Gets the error severity.
Source This property is required. string
Gets the error source.
SummaryMessage This property is required. string
Gets the error summary message.
UpdatedTimeStamp This property is required. string
Gets the time stamp when the error was updated.
applianceName This property is required. String
Gets the appliance name.
code This property is required. String
Gets the error name.
discoveryScope This property is required. String
Gets discovery scope for which error is encountered.
id This property is required. Double
Gets the error ID.
message This property is required. String
Gets the error message.
messageParameters This property is required. Map<String,String>
Gets the message parameters.
possibleCauses This property is required. String
Gets the possible causes of error.
recommendedAction This property is required. String
Gets the recommended action to resolve error.
runAsAccountId This property is required. String
Gets run as account id used while performing discovery of entity.
severity This property is required. String
Gets the error severity.
source This property is required. String
Gets the error source.
summaryMessage This property is required. String
Gets the error summary message.
updatedTimeStamp This property is required. String
Gets the time stamp when the error was updated.
applianceName This property is required. string
Gets the appliance name.
code This property is required. string
Gets the error name.
discoveryScope This property is required. string
Gets discovery scope for which error is encountered.
id This property is required. number
Gets the error ID.
message This property is required. string
Gets the error message.
messageParameters This property is required. {[key: string]: string}
Gets the message parameters.
possibleCauses This property is required. string
Gets the possible causes of error.
recommendedAction This property is required. string
Gets the recommended action to resolve error.
runAsAccountId This property is required. string
Gets run as account id used while performing discovery of entity.
severity This property is required. string
Gets the error severity.
source This property is required. string
Gets the error source.
summaryMessage This property is required. string
Gets the error summary message.
updatedTimeStamp This property is required. string
Gets the time stamp when the error was updated.
appliance_name This property is required. str
Gets the appliance name.
code This property is required. str
Gets the error name.
discovery_scope This property is required. str
Gets discovery scope for which error is encountered.
id This property is required. float
Gets the error ID.
message This property is required. str
Gets the error message.
message_parameters This property is required. Mapping[str, str]
Gets the message parameters.
possible_causes This property is required. str
Gets the possible causes of error.
recommended_action This property is required. str
Gets the recommended action to resolve error.
run_as_account_id This property is required. str
Gets run as account id used while performing discovery of entity.
severity This property is required. str
Gets the error severity.
source This property is required. str
Gets the error source.
summary_message This property is required. str
Gets the error summary message.
updated_time_stamp This property is required. str
Gets the time stamp when the error was updated.
applianceName This property is required. String
Gets the appliance name.
code This property is required. String
Gets the error name.
discoveryScope This property is required. String
Gets discovery scope for which error is encountered.
id This property is required. Number
Gets the error ID.
message This property is required. String
Gets the error message.
messageParameters This property is required. Map<String>
Gets the message parameters.
possibleCauses This property is required. String
Gets the possible causes of error.
recommendedAction This property is required. String
Gets the recommended action to resolve error.
runAsAccountId This property is required. String
Gets run as account id used while performing discovery of entity.
severity This property is required. String
Gets the error severity.
source This property is required. String
Gets the error source.
summaryMessage This property is required. String
Gets the error summary message.
updatedTimeStamp This property is required. String
Gets the time stamp when the error was updated.

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.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native