hyperv_cluster_controllers
Creates, updates, deletes, gets or lists a hyperv_cluster_controllers resource.
Overview
| Name | hyperv_cluster_controllers |
| Type | Resource |
| Id | azure.migrate.hyperv_cluster_controllers |
Fields
The following fields are returned by SELECT queries:
- 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 |
|---|---|---|---|---|
list_by_hyperv_site | select | subscriptionId, resourceGroupName, siteName | filter | List HypervCluster resources by HypervSite |
delete | delete | subscriptionId, resourceGroupName, siteName, clusterName | Delete a HypervCluster |
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. |
filter | string | filter query |
SELECT examples
- list_by_hyperv_site
List HypervCluster resources by HypervSite
SELECT
properties
FROM azure.migrate.hyperv_cluster_controllers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND siteName = '{{ siteName }}' -- required
AND filter = '{{ filter }}'
;
DELETE examples
- delete
Delete a HypervCluster
DELETE FROM azure.migrate.hyperv_cluster_controllers
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND siteName = '{{ siteName }}' --required
AND clusterName = '{{ clusterName }}' --required
;