hyperv_host_controllers

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

Overview

Name	hyperv_host_controllers
Type	Resource
Id	azure.migrate.hyperv_host_controllers

Fields

The following fields are returned by SELECT queries:

get

ARM operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

list_by_hyperv_site

ARM operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, siteName, hostName		Get a HypervHost
list_by_hyperv_site	select	subscriptionId, resourceGroupName, siteName	filter	List HypervHost resources by HypervSite
create	insert	subscriptionId, resourceGroupName, siteName, hostName		Create a HypervHost
delete	delete	subscriptionId, resourceGroupName, siteName, hostName		Delete a HypervHost

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
hostName	string	Host name
resourceGroupName	string	The name of the resource group. The name is case insensitive.
siteName	string	Site name
subscriptionId	string	The ID of the target subscription.
filter	string	filter query

SELECT examples

get

Get a HypervHost

SELECT
properties
FROM azure.migrate.hyperv_host_controllers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND siteName = '{{ siteName }}' -- required
AND hostName = '{{ hostName }}' -- required
;

list_by_hyperv_site

List HypervHost resources by HypervSite

SELECT
properties
FROM azure.migrate.hyperv_host_controllers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND siteName = '{{ siteName }}' -- required
AND filter = '{{ filter }}'
;

INSERT examples

create

Create a HypervHost

INSERT INTO azure.migrate.hyperv_host_controllers (
data__properties,
subscriptionId,
resourceGroupName,
siteName,
hostName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ siteName }}',
'{{ hostName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: hyperv_host_controllers
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the hyperv_host_controllers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the hyperv_host_controllers resource.
    - name: siteName
      value: string
      description: Required parameter for the hyperv_host_controllers resource.
    - name: hostName
      value: string
      description: Required parameter for the hyperv_host_controllers resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.

DELETE examples

delete

Delete a HypervHost

DELETE FROM azure.migrate.hyperv_host_controllers
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND siteName = '{{ siteName }}' --required
AND hostName = '{{ hostName }}' --required
;