hyperv_cluster_controller_clusters

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

Overview

Name	hyperv_cluster_controller_clusters
Type	Resource
Id	azure.migrate.hyperv_cluster_controller_clusters

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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, siteName, clusterName		Method to get a Hyper-V cluster.
create	insert	subscriptionId, resourceGroupName, siteName, clusterName		Method to create or update a Hyper-V 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
clusterName	string	Cluster ARM 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.

SELECT examples

get

Method to get a Hyper-V cluster.

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

INSERT examples

create

Method to create or update a Hyper-V cluster.

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

Manifest

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