hyperv_sites_controllers

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

Overview

Name	hyperv_sites_controllers
Type	Resource
Id	azure.migrate.hyperv_sites_controllers

Fields

The following fields are returned by SELECT queries:

get

ARM operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, siteName		Get a HypervSite
create	insert	subscriptionId, resourceGroupName, siteName		Create a HypervSite
update	update	subscriptionId, resourceGroupName, siteName		Update a HypervSite
delete	delete	subscriptionId, resourceGroupName, siteName		Delete a HypervSite
compute_error_summary	exec	subscriptionId, resourceGroupName, siteName		Method to get site error summary.
computeusage	exec	subscriptionId, resourceGroupName, siteName		Get a hyperv site usage.
export_applications	exec	subscriptionId, resourceGroupName, siteName		Method to generate report containing machine and the deep discovery of the application installed in the machine.
export_machine_errors	exec	subscriptionId, resourceGroupName, siteName		Method to generate report containing machine and the errors encountered during guest discovery of the machine.
summary	exec	subscriptionId, resourceGroupName, siteName		Method to get site usage.

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
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.

SELECT examples

get

Get a HypervSite

SELECT
location,
properties,
tags
FROM azure.migrate.hyperv_sites_controllers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND siteName = '{{ siteName }}' -- required
;

INSERT examples

create

Create a HypervSite

INSERT INTO azure.migrate.hyperv_sites_controllers (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
siteName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ siteName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: hyperv_sites_controllers
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the hyperv_sites_controllers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the hyperv_sites_controllers resource.
    - name: siteName
      value: string
      description: Required parameter for the hyperv_sites_controllers resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update a HypervSite

UPDATE azure.migrate.hyperv_sites_controllers
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND siteName = '{{ siteName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Delete a HypervSite

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

Lifecycle Methods

compute_error_summary

Method to get site error summary.

EXEC azure.migrate.hyperv_sites_controllers.compute_error_summary 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@siteName='{{ siteName }}' --required
;

computeusage

Get a hyperv site usage.

EXEC azure.migrate.hyperv_sites_controllers.computeusage 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@siteName='{{ siteName }}' --required
;

export_applications

Method to generate report containing
machine and the deep discovery of the application installed in the machine.

EXEC azure.migrate.hyperv_sites_controllers.export_applications 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@siteName='{{ siteName }}' --required
;

export_machine_errors

Method to generate report containing
machine and the errors encountered during guest discovery of the machine.

EXEC azure.migrate.hyperv_sites_controllers.export_machine_errors 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@siteName='{{ siteName }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

summary

Method to get site usage.

EXEC azure.migrate.hyperv_sites_controllers.summary 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@siteName='{{ siteName }}' --required
;