hosts

Creates, updates, deletes, gets or lists a hosts resource.

Overview

Name	hosts
Type	Resource
Id	azure_isv.avs.hosts

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
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.
displayName	string	Display name of the host in VMware vCenter.
faultDomain	string	:vartype fault_domain: str
fqdn	string	Fully qualified domain name of the host.
kind	string	The kind of host. Required. Known values are: "General" and "Specialized".
maintenance	string	If provided, the host is in maintenance. The value is the reason for maintenance. Known values are: "Replacement" and "Upgrade". (Replacement, Upgrade)
moRefId	string	vCenter managed object reference ID of the host.
provisioningState	string	The state of the host provisioning. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
sku	object	The SKU (Stock Keeping Unit) assigned to this resource.
systemData	object	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".
zones	array	The availability zones.

list

Name	Datatype	Description
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.
displayName	string	Display name of the host in VMware vCenter.
faultDomain	string	:vartype fault_domain: str
fqdn	string	Fully qualified domain name of the host.
kind	string	The kind of host. Required. Known values are: "General" and "Specialized".
maintenance	string	If provided, the host is in maintenance. The value is the reason for maintenance. Known values are: "Replacement" and "Upgrade". (Replacement, Upgrade)
moRefId	string	vCenter managed object reference ID of the host.
provisioningState	string	The state of the host provisioning. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
sku	object	The SKU (Stock Keeping Unit) assigned to this resource.
systemData	object	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".
zones	array	The availability zones.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, private_cloud_name, cluster_name, host_id, subscription_id		Get a Host.
list	select	resource_group_name, private_cloud_name, cluster_name, subscription_id		List Host resources by Cluster.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cluster_name	string	Name of the cluster. Required.
host_id	string	The host identifier. Required.
private_cloud_name	string	Name of the private cloud. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a Host.

SELECT
id,
name,
displayName,
faultDomain,
fqdn,
kind,
maintenance,
moRefId,
provisioningState,
sku,
systemData,
type,
zones
FROM azure_isv.avs.hosts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND host_id = '{{ host_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List Host resources by Cluster.

SELECT
id,
name,
displayName,
faultDomain,
fqdn,
kind,
maintenance,
moRefId,
provisioningState,
sku,
systemData,
type,
zones
FROM azure_isv.avs.hosts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;