hosts

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

Overview

Name	hosts
Type	Resource
Id	azure_isv.connectedvmware.hosts

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Gets or sets the Id.
name	string	Gets or sets the name.
cpuMhz	integer	Gets the max CPU usage across all cores in MHz.
customResourceName	string	Gets the name of the corresponding resource in Kubernetes.
datastoreIds	array	Gets the datastore ARM ids.
extendedLocation	object	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.
location	string	Gets or sets the location. Required.
memorySizeGB	integer	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.
moRefId	string	Gets or sets the vCenter MoRef (Managed Object Reference) ID for the host.
networkIds	array	Gets the network ARM ids.
overallCpuUsageMHz	integer	Gets the used CPU usage across all cores in MHz.
overallMemoryUsageGB	integer	Gets the used physical memory on the host in GB.
provisioningState	string	Gets the provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
statuses	array	The resource status information.
systemData	object	The system data.
tags	object	Gets or sets the Resource tags.
type	string	Gets or sets the type of the resource.
uuid	string	Gets or sets a unique identifier for this resource.
vCenterId	string	Gets or sets the ARM Id of the vCenter resource in which this host resides.

list_by_resource_group

Name	Datatype	Description
id	string	Gets or sets the Id.
name	string	Gets or sets the name.
cpuMhz	integer	Gets the max CPU usage across all cores in MHz.
customResourceName	string	Gets the name of the corresponding resource in Kubernetes.
datastoreIds	array	Gets the datastore ARM ids.
extendedLocation	object	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.
location	string	Gets or sets the location. Required.
memorySizeGB	integer	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.
moRefId	string	Gets or sets the vCenter MoRef (Managed Object Reference) ID for the host.
networkIds	array	Gets the network ARM ids.
overallCpuUsageMHz	integer	Gets the used CPU usage across all cores in MHz.
overallMemoryUsageGB	integer	Gets the used physical memory on the host in GB.
provisioningState	string	Gets the provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
statuses	array	The resource status information.
systemData	object	The system data.
tags	object	Gets or sets the Resource tags.
type	string	Gets or sets the type of the resource.
uuid	string	Gets or sets a unique identifier for this resource.
vCenterId	string	Gets or sets the ARM Id of the vCenter resource in which this host resides.

list

Name	Datatype	Description
id	string	Gets or sets the Id.
name	string	Gets or sets the name.
cpuMhz	integer	Gets the max CPU usage across all cores in MHz.
customResourceName	string	Gets the name of the corresponding resource in Kubernetes.
datastoreIds	array	Gets the datastore ARM ids.
extendedLocation	object	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.
location	string	Gets or sets the location. Required.
memorySizeGB	integer	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.
moRefId	string	Gets or sets the vCenter MoRef (Managed Object Reference) ID for the host.
networkIds	array	Gets the network ARM ids.
overallCpuUsageMHz	integer	Gets the used CPU usage across all cores in MHz.
overallMemoryUsageGB	integer	Gets the used physical memory on the host in GB.
provisioningState	string	Gets the provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
statuses	array	The resource status information.
systemData	object	The system data.
tags	object	Gets or sets the Resource tags.
type	string	Gets or sets the type of the resource.
uuid	string	Gets or sets a unique identifier for this resource.
vCenterId	string	Gets or sets the ARM Id of the vCenter resource in which this host resides.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, host_name, subscription_id		Gets a host. Implements host GET method.
list_by_resource_group	select	resource_group_name, subscription_id		Implements GET hosts in a resource group. List of hosts in a resource group.
list	select	subscription_id		Implements GET hosts in a subscription. List of hosts in a subscription.
create	insert	resource_group_name, host_name, subscription_id, location		Implements host PUT method. Create Or Update host.
update	update	resource_group_name, host_name, subscription_id		Updates a host. API to update certain properties of the host resource.
delete	delete	resource_group_name, host_name, subscription_id	force	Deletes an host. Implements host DELETE method.

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
host_name	string	Name of the host. Required.
resource_group_name	string	The Resource Group Name. Required.
subscription_id	string
force	boolean	Whether force delete was specified. Default value is None.

SELECT examples

get

Gets a host. Implements host GET method.

SELECT
id,
name,
cpuMhz,
customResourceName,
datastoreIds,
extendedLocation,
inventoryItemId,
kind,
location,
memorySizeGB,
moName,
moRefId,
networkIds,
overallCpuUsageMHz,
overallMemoryUsageGB,
provisioningState,
statuses,
systemData,
tags,
type,
uuid,
vCenterId
FROM azure_isv.connectedvmware.hosts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND host_name = '{{ host_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Implements GET hosts in a resource group. List of hosts in a resource group.

SELECT
id,
name,
cpuMhz,
customResourceName,
datastoreIds,
extendedLocation,
inventoryItemId,
kind,
location,
memorySizeGB,
moName,
moRefId,
networkIds,
overallCpuUsageMHz,
overallMemoryUsageGB,
provisioningState,
statuses,
systemData,
tags,
type,
uuid,
vCenterId
FROM azure_isv.connectedvmware.hosts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Implements GET hosts in a subscription. List of hosts in a subscription.

SELECT
id,
name,
cpuMhz,
customResourceName,
datastoreIds,
extendedLocation,
inventoryItemId,
kind,
location,
memorySizeGB,
moName,
moRefId,
networkIds,
overallCpuUsageMHz,
overallMemoryUsageGB,
provisioningState,
statuses,
systemData,
tags,
type,
uuid,
vCenterId
FROM azure_isv.connectedvmware.hosts
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Implements host PUT method. Create Or Update host.

INSERT INTO azure_isv.connectedvmware.hosts (
location,
extendedLocation,
tags,
kind,
properties,
resource_group_name,
host_name,
subscription_id
)
SELECT 
'{{ location }}' /* required */,
'{{ extendedLocation }}',
'{{ tags }}',
'{{ kind }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ host_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
kind,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: hosts
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the hosts resource.
  - name: host_name
    value: "{{ host_name }}"
    description: Required parameter for the hosts resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the hosts resource.
  - name: location
    value: "{{ location }}"
    description: |
      Gets or sets the location. Required.
  - name: extendedLocation
    description: |
      Gets or sets the extended location.
    value:
      type: "{{ type }}"
      name: "{{ name }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Gets or sets the Resource tags.
  - name: kind
    value: "{{ kind }}"
    description: |
      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.
  - name: properties
    value:
      vCenterId: "{{ vCenterId }}"
      moRefId: "{{ moRefId }}"
      inventoryItemId: "{{ inventoryItemId }}"

UPDATE examples

update

Updates a host. API to update certain properties of the host resource.

UPDATE azure_isv.connectedvmware.hosts
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND host_name = '{{ host_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
kind,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes an host. Implements host DELETE method.

DELETE FROM azure_isv.connectedvmware.hosts
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND host_name = '{{ host_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND force = '{{ force }}'
;