Method to get a Hyper-V cluster.
Uses Azure REST API version 2023-10-01-preview.
Other available API versions: 2023-06-06, 2024-05-01-preview, 2024-07-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 offazure [ApiVersion]. See the version guide for details.
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>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]func LookupHypervClusterControllerCluster(ctx *Context, args *LookupHypervClusterControllerClusterArgs, opts ...InvokeOption) (*LookupHypervClusterControllerClusterResult, error)
func LookupHypervClusterControllerClusterOutput(ctx *Context, args *LookupHypervClusterControllerClusterOutputArgs, opts ...InvokeOption) LookupHypervClusterControllerClusterResultOutput> 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)
}public static CompletableFuture<GetHypervClusterControllerClusterResult> getHypervClusterControllerCluster(GetHypervClusterControllerClusterArgs args, InvokeOptions options)
public static Output<GetHypervClusterControllerClusterResult> getHypervClusterControllerCluster(GetHypervClusterControllerClusterArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:offazure:getHypervClusterControllerCluster
arguments:
# arguments dictionaryThe following arguments are supported:
- Cluster
Name string - Cluster ARM name
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Site
Name string - Site name
- Cluster
Name string - Cluster ARM name
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Site
Name string - Site name
- cluster
Name String - Cluster ARM name
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- site
Name String - Site name
- cluster
Name string - Cluster ARM name
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- site
Name string - Site name
- cluster_
name str - Cluster ARM name
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- site_
name str - Site name
- cluster
Name String - Cluster ARM name
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- site
Name String - Site name
getHypervClusterControllerCluster Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- Created
Timestamp string - Gets the timestamp marking Hyper-V cluster creation.
- Errors
List<Pulumi.
Azure Native. Off Azure. Outputs. Health Error Details Response> - Gets the errors.
- Functional
Level 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.
- System
Data Pulumi.Azure Native. Off Azure. Outputs. System Data Response - 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"
- Updated
Timestamp 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.
- Host
Fqdn List<string>List - Gets or sets list of hosts (FQDN) currently being tracked by the cluster.
- Provisioning
State string - The status of the last operation.
- Run
As stringAccount Id - Gets or sets Run as account ID of the Hyper-V cluster.
- Azure
Api stringVersion - The Azure API version of the resource.
- Created
Timestamp string - Gets the timestamp marking Hyper-V cluster creation.
- Errors
[]Health
Error Details Response - Gets the errors.
- Functional
Level 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.
- System
Data SystemData Response - 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"
- Updated
Timestamp 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.
- Host
Fqdn []stringList - Gets or sets list of hosts (FQDN) currently being tracked by the cluster.
- Provisioning
State string - The status of the last operation.
- Run
As stringAccount Id - Gets or sets Run as account ID of the Hyper-V cluster.
- azure
Api StringVersion - The Azure API version of the resource.
- created
Timestamp String - Gets the timestamp marking Hyper-V cluster creation.
- errors
List<Health
Error Details Response> - Gets the errors.
- functional
Level 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.
- system
Data SystemData Response - 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"
- updated
Timestamp 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.
- host
Fqdn List<String>List - Gets or sets list of hosts (FQDN) currently being tracked by the cluster.
- provisioning
State String - The status of the last operation.
- run
As StringAccount Id - Gets or sets Run as account ID of the Hyper-V cluster.
- azure
Api stringVersion - The Azure API version of the resource.
- created
Timestamp string - Gets the timestamp marking Hyper-V cluster creation.
- errors
Health
Error Details Response[] - Gets the errors.
- functional
Level 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.
- system
Data SystemData Response - 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"
- updated
Timestamp 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.
- host
Fqdn string[]List - Gets or sets list of hosts (FQDN) currently being tracked by the cluster.
- provisioning
State string - The status of the last operation.
- run
As stringAccount Id - Gets or sets Run as account ID of the Hyper-V cluster.
- azure_
api_ strversion - The Azure API version of the resource.
- created_
timestamp str - Gets the timestamp marking Hyper-V cluster creation.
- errors
Sequence[Health
Error Details Response] - 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 SystemData Response - 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_ Sequence[str]list - Gets or sets list of hosts (FQDN) currently being tracked by the cluster.
- provisioning_
state str - The status of the last operation.
- run_
as_ straccount_ id - Gets or sets Run as account ID of the Hyper-V cluster.
- azure
Api StringVersion - The Azure API version of the resource.
- created
Timestamp String - Gets the timestamp marking Hyper-V cluster creation.
- errors List<Property Map>
- Gets the errors.
- functional
Level 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.
- system
Data 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"
- updated
Timestamp 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.
- host
Fqdn List<String>List - Gets or sets list of hosts (FQDN) currently being tracked by the cluster.
- provisioning
State String - The status of the last operation.
- run
As StringAccount Id - Gets or sets Run as account ID of the Hyper-V cluster.
Supporting Types
HealthErrorDetailsResponse
- Appliance
Name string - Gets the appliance name.
- Code string
- Gets the error name.
- Discovery
Scope string - Gets discovery scope for which error is encountered.
- Id double
- Gets the error ID.
- Message string
- Gets the error message.
- Message
Parameters Dictionary<string, string> - Gets the message parameters.
- Possible
Causes string - Gets the possible causes of error.
- Recommended
Action string - Gets the recommended action to resolve error.
- Run
As stringAccount Id - Gets run as account id used while performing discovery of entity.
- Severity string
- Gets the error severity.
- Source string
- Gets the error source.
- Summary
Message string - Gets the error summary message.
- Updated
Time stringStamp - Gets the time stamp when the error was updated.
- Appliance
Name string - Gets the appliance name.
- Code string
- Gets the error name.
- Discovery
Scope string - Gets discovery scope for which error is encountered.
- Id float64
- Gets the error ID.
- Message string
- Gets the error message.
- Message
Parameters map[string]string - Gets the message parameters.
- Possible
Causes string - Gets the possible causes of error.
- Recommended
Action string - Gets the recommended action to resolve error.
- Run
As stringAccount Id - Gets run as account id used while performing discovery of entity.
- Severity string
- Gets the error severity.
- Source string
- Gets the error source.
- Summary
Message string - Gets the error summary message.
- Updated
Time stringStamp - Gets the time stamp when the error was updated.
- appliance
Name String - Gets the appliance name.
- code String
- Gets the error name.
- discovery
Scope String - Gets discovery scope for which error is encountered.
- id Double
- Gets the error ID.
- message String
- Gets the error message.
- message
Parameters Map<String,String> - Gets the message parameters.
- possible
Causes String - Gets the possible causes of error.
- recommended
Action String - Gets the recommended action to resolve error.
- run
As StringAccount Id - Gets run as account id used while performing discovery of entity.
- severity String
- Gets the error severity.
- source String
- Gets the error source.
- summary
Message String - Gets the error summary message.
- updated
Time StringStamp - Gets the time stamp when the error was updated.
- appliance
Name string - Gets the appliance name.
- code string
- Gets the error name.
- discovery
Scope string - Gets discovery scope for which error is encountered.
- id number
- Gets the error ID.
- message string
- Gets the error message.
- message
Parameters {[key: string]: string} - Gets the message parameters.
- possible
Causes string - Gets the possible causes of error.
- recommended
Action string - Gets the recommended action to resolve error.
- run
As stringAccount Id - Gets run as account id used while performing discovery of entity.
- severity string
- Gets the error severity.
- source string
- Gets the error source.
- summary
Message string - Gets the error summary message.
- updated
Time stringStamp - Gets the time stamp when the error was updated.
- appliance_
name str - Gets the appliance name.
- code str
- Gets the error name.
- discovery_
scope str - Gets discovery scope for which error is encountered.
- id float
- Gets the error ID.
- message str
- Gets the error message.
- message_
parameters Mapping[str, str] - Gets the message parameters.
- possible_
causes str - Gets the possible causes of error.
- recommended_
action str - Gets the recommended action to resolve error.
- run_
as_ straccount_ id - Gets run as account id used while performing discovery of entity.
- severity str
- Gets the error severity.
- source str
- Gets the error source.
- summary_
message str - Gets the error summary message.
- updated_
time_ strstamp - Gets the time stamp when the error was updated.
- appliance
Name String - Gets the appliance name.
- code String
- Gets the error name.
- discovery
Scope String - Gets discovery scope for which error is encountered.
- id Number
- Gets the error ID.
- message String
- Gets the error message.
- message
Parameters Map<String> - Gets the message parameters.
- possible
Causes String - Gets the possible causes of error.
- recommended
Action String - Gets the recommended action to resolve error.
- run
As StringAccount Id - Gets run as account id used while performing discovery of entity.
- severity String
- Gets the error severity.
- source String
- Gets the error source.
- summary
Message String - Gets the error summary message.
- updated
Time StringStamp - Gets the time stamp when the error was updated.
SystemDataResponse
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
