1. Packages
  2. Azure Native
  3. API Docs
  4. connectedvmwarevsphere
  5. getHost
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.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.connectedvmwarevsphere.getHost

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.2.0 published on Monday, Apr 14, 2025 by Pulumi

Implements host GET method.

Uses Azure REST API version 2023-12-01.

Other available API versions: 2022-07-15-preview, 2023-03-01-preview, 2023-10-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native connectedvmwarevsphere [ApiVersion]. See the version guide for details.

Using getHost

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 getHost(args: GetHostArgs, opts?: InvokeOptions): Promise<GetHostResult>
function getHostOutput(args: GetHostOutputArgs, opts?: InvokeOptions): Output<GetHostResult>
Copy
def get_host(host_name: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetHostResult
def get_host_output(host_name: Optional[pulumi.Input[str]] = None,
             resource_group_name: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetHostResult]
Copy
func LookupHost(ctx *Context, args *LookupHostArgs, opts ...InvokeOption) (*LookupHostResult, error)
func LookupHostOutput(ctx *Context, args *LookupHostOutputArgs, opts ...InvokeOption) LookupHostResultOutput
Copy

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

public static class GetHost 
{
    public static Task<GetHostResult> InvokeAsync(GetHostArgs args, InvokeOptions? opts = null)
    public static Output<GetHostResult> Invoke(GetHostInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetHostResult> getHost(GetHostArgs args, InvokeOptions options)
public static Output<GetHostResult> getHost(GetHostArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:connectedvmwarevsphere:getHost
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

HostName
This property is required.
Changes to this property will trigger replacement.
string
Name of the host.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The Resource Group Name.
HostName
This property is required.
Changes to this property will trigger replacement.
string
Name of the host.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The Resource Group Name.
hostName
This property is required.
Changes to this property will trigger replacement.
String
Name of the host.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The Resource Group Name.
hostName
This property is required.
Changes to this property will trigger replacement.
string
Name of the host.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The Resource Group Name.
host_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the host.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The Resource Group Name.
hostName
This property is required.
Changes to this property will trigger replacement.
String
Name of the host.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The Resource Group Name.

getHost Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
CpuMhz double
Gets the max CPU usage across all cores in MHz.
CustomResourceName string
Gets the name of the corresponding resource in Kubernetes.
DatastoreIds List<string>
Gets the datastore ARM ids.
Id string
Gets or sets the Id.
Location string
Gets or sets the location.
MemorySizeGB double
Gets the total amount of physical memory on the host in GB.
MoName string
Gets or sets the vCenter Managed Object name for the host.
Name string
Gets or sets the name.
NetworkIds List<string>
Gets the network ARM ids.
OverallCpuUsageMHz double
Gets the used CPU usage across all cores in MHz.
OverallMemoryUsageGB double
Gets the used physical memory on the host in GB.
ProvisioningState string
Gets the provisioning state.
Statuses List<Pulumi.AzureNative.ConnectedVMwarevSphere.Outputs.ResourceStatusResponse>
The resource status information.
SystemData Pulumi.AzureNative.ConnectedVMwarevSphere.Outputs.SystemDataResponse
The system data.
Type string
Gets or sets the type of the resource.
Uuid string
Gets or sets a unique identifier for this resource.
ExtendedLocation Pulumi.AzureNative.ConnectedVMwarevSphere.Outputs.ExtendedLocationResponse
Gets or sets the extended location.
InventoryItemId string
Gets or sets the inventory Item ID for the host.
Kind string
Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
MoRefId string
Gets or sets the vCenter MoRef (Managed Object Reference) ID for the host.
Tags Dictionary<string, string>
Gets or sets the Resource tags.
VCenterId string
Gets or sets the ARM Id of the vCenter resource in which this host resides.
AzureApiVersion string
The Azure API version of the resource.
CpuMhz float64
Gets the max CPU usage across all cores in MHz.
CustomResourceName string
Gets the name of the corresponding resource in Kubernetes.
DatastoreIds []string
Gets the datastore ARM ids.
Id string
Gets or sets the Id.
Location string
Gets or sets the location.
MemorySizeGB float64
Gets the total amount of physical memory on the host in GB.
MoName string
Gets or sets the vCenter Managed Object name for the host.
Name string
Gets or sets the name.
NetworkIds []string
Gets the network ARM ids.
OverallCpuUsageMHz float64
Gets the used CPU usage across all cores in MHz.
OverallMemoryUsageGB float64
Gets the used physical memory on the host in GB.
ProvisioningState string
Gets the provisioning state.
Statuses []ResourceStatusResponse
The resource status information.
SystemData SystemDataResponse
The system data.
Type string
Gets or sets the type of the resource.
Uuid string
Gets or sets a unique identifier for this resource.
ExtendedLocation ExtendedLocationResponse
Gets or sets the extended location.
InventoryItemId string
Gets or sets the inventory Item ID for the host.
Kind string
Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
MoRefId string
Gets or sets the vCenter MoRef (Managed Object Reference) ID for the host.
Tags map[string]string
Gets or sets the Resource tags.
VCenterId string
Gets or sets the ARM Id of the vCenter resource in which this host resides.
azureApiVersion String
The Azure API version of the resource.
cpuMhz Double
Gets the max CPU usage across all cores in MHz.
customResourceName String
Gets the name of the corresponding resource in Kubernetes.
datastoreIds List<String>
Gets the datastore ARM ids.
id String
Gets or sets the Id.
location String
Gets or sets the location.
memorySizeGB Double
Gets the total amount of physical memory on the host in GB.
moName String
Gets or sets the vCenter Managed Object name for the host.
name String
Gets or sets the name.
networkIds List<String>
Gets the network ARM ids.
overallCpuUsageMHz Double
Gets the used CPU usage across all cores in MHz.
overallMemoryUsageGB Double
Gets the used physical memory on the host in GB.
provisioningState String
Gets the provisioning state.
statuses List<ResourceStatusResponse>
The resource status information.
systemData SystemDataResponse
The system data.
type String
Gets or sets the type of the resource.
uuid String
Gets or sets a unique identifier for this resource.
extendedLocation ExtendedLocationResponse
Gets or sets the extended location.
inventoryItemId String
Gets or sets the inventory Item ID for the host.
kind String
Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
moRefId String
Gets or sets the vCenter MoRef (Managed Object Reference) ID for the host.
tags Map<String,String>
Gets or sets the Resource tags.
vCenterId String
Gets or sets the ARM Id of the vCenter resource in which this host resides.
azureApiVersion string
The Azure API version of the resource.
cpuMhz number
Gets the max CPU usage across all cores in MHz.
customResourceName string
Gets the name of the corresponding resource in Kubernetes.
datastoreIds string[]
Gets the datastore ARM ids.
id string
Gets or sets the Id.
location string
Gets or sets the location.
memorySizeGB number
Gets the total amount of physical memory on the host in GB.
moName string
Gets or sets the vCenter Managed Object name for the host.
name string
Gets or sets the name.
networkIds string[]
Gets the network ARM ids.
overallCpuUsageMHz number
Gets the used CPU usage across all cores in MHz.
overallMemoryUsageGB number
Gets the used physical memory on the host in GB.
provisioningState string
Gets the provisioning state.
statuses ResourceStatusResponse[]
The resource status information.
systemData SystemDataResponse
The system data.
type string
Gets or sets the type of the resource.
uuid string
Gets or sets a unique identifier for this resource.
extendedLocation ExtendedLocationResponse
Gets or sets the extended location.
inventoryItemId string
Gets or sets the inventory Item ID for the host.
kind string
Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
moRefId string
Gets or sets the vCenter MoRef (Managed Object Reference) ID for the host.
tags {[key: string]: string}
Gets or sets the Resource tags.
vCenterId string
Gets or sets the ARM Id of the vCenter resource in which this host resides.
azure_api_version str
The Azure API version of the resource.
cpu_mhz float
Gets the max CPU usage across all cores in MHz.
custom_resource_name str
Gets the name of the corresponding resource in Kubernetes.
datastore_ids Sequence[str]
Gets the datastore ARM ids.
id str
Gets or sets the Id.
location str
Gets or sets the location.
memory_size_gb float
Gets the total amount of physical memory on the host in GB.
mo_name str
Gets or sets the vCenter Managed Object name for the host.
name str
Gets or sets the name.
network_ids Sequence[str]
Gets the network ARM ids.
overall_cpu_usage_m_hz float
Gets the used CPU usage across all cores in MHz.
overall_memory_usage_gb float
Gets the used physical memory on the host in GB.
provisioning_state str
Gets the provisioning state.
statuses Sequence[ResourceStatusResponse]
The resource status information.
system_data SystemDataResponse
The system data.
type str
Gets or sets the type of the resource.
uuid str
Gets or sets a unique identifier for this resource.
extended_location ExtendedLocationResponse
Gets or sets the extended location.
inventory_item_id str
Gets or sets the inventory Item ID for the host.
kind str
Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
mo_ref_id str
Gets or sets the vCenter MoRef (Managed Object Reference) ID for the host.
tags Mapping[str, str]
Gets or sets the Resource tags.
v_center_id str
Gets or sets the ARM Id of the vCenter resource in which this host resides.
azureApiVersion String
The Azure API version of the resource.
cpuMhz Number
Gets the max CPU usage across all cores in MHz.
customResourceName String
Gets the name of the corresponding resource in Kubernetes.
datastoreIds List<String>
Gets the datastore ARM ids.
id String
Gets or sets the Id.
location String
Gets or sets the location.
memorySizeGB Number
Gets the total amount of physical memory on the host in GB.
moName String
Gets or sets the vCenter Managed Object name for the host.
name String
Gets or sets the name.
networkIds List<String>
Gets the network ARM ids.
overallCpuUsageMHz Number
Gets the used CPU usage across all cores in MHz.
overallMemoryUsageGB Number
Gets the used physical memory on the host in GB.
provisioningState String
Gets the provisioning state.
statuses List<Property Map>
The resource status information.
systemData Property Map
The system data.
type String
Gets or sets the type of the resource.
uuid String
Gets or sets a unique identifier for this resource.
extendedLocation Property Map
Gets or sets the extended location.
inventoryItemId String
Gets or sets the inventory Item ID for the host.
kind String
Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
moRefId String
Gets or sets the vCenter MoRef (Managed Object Reference) ID for the host.
tags Map<String>
Gets or sets the Resource tags.
vCenterId String
Gets or sets the ARM Id of the vCenter resource in which this host resides.

Supporting Types

ExtendedLocationResponse

Name string
The extended location name.
Type string
The extended location type.
Name string
The extended location name.
Type string
The extended location type.
name String
The extended location name.
type String
The extended location type.
name string
The extended location name.
type string
The extended location type.
name str
The extended location name.
type str
The extended location type.
name String
The extended location name.
type String
The extended location type.

ResourceStatusResponse

LastUpdatedAt This property is required. string
The last update time for this condition.
Message This property is required. string
A human readable message indicating details about the status.
Reason This property is required. string
The reason for the condition's status.
Severity This property is required. string
Severity with which to treat failures of this type of condition.
Status This property is required. string
Status of the condition.
Type This property is required. string
The type of the condition.
LastUpdatedAt This property is required. string
The last update time for this condition.
Message This property is required. string
A human readable message indicating details about the status.
Reason This property is required. string
The reason for the condition's status.
Severity This property is required. string
Severity with which to treat failures of this type of condition.
Status This property is required. string
Status of the condition.
Type This property is required. string
The type of the condition.
lastUpdatedAt This property is required. String
The last update time for this condition.
message This property is required. String
A human readable message indicating details about the status.
reason This property is required. String
The reason for the condition's status.
severity This property is required. String
Severity with which to treat failures of this type of condition.
status This property is required. String
Status of the condition.
type This property is required. String
The type of the condition.
lastUpdatedAt This property is required. string
The last update time for this condition.
message This property is required. string
A human readable message indicating details about the status.
reason This property is required. string
The reason for the condition's status.
severity This property is required. string
Severity with which to treat failures of this type of condition.
status This property is required. string
Status of the condition.
type This property is required. string
The type of the condition.
last_updated_at This property is required. str
The last update time for this condition.
message This property is required. str
A human readable message indicating details about the status.
reason This property is required. str
The reason for the condition's status.
severity This property is required. str
Severity with which to treat failures of this type of condition.
status This property is required. str
Status of the condition.
type This property is required. str
The type of the condition.
lastUpdatedAt This property is required. String
The last update time for this condition.
message This property is required. String
A human readable message indicating details about the status.
reason This property is required. String
The reason for the condition's status.
severity This property is required. String
Severity with which to treat failures of this type of condition.
status This property is required. String
Status of the condition.
type This property is required. String
The type of the condition.

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 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.2.0 published on Monday, Apr 14, 2025 by Pulumi