Microsoft.OffAzure HyperVSites/clusters 2020-07-07

Bicep resource definition

The HyperVSites/clusters resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.OffAzure/HyperVSites/clusters resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.OffAzure/HyperVSites/clusters@2020-07-07' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    fqdn: 'string'
    hostFqdnList: [
      'string'
    ]
    runAsAccountId: 'string'
  }
}

Property Values

Microsoft.OffAzure/HyperVSites/clusters

Name Description Value
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: HyperVSites
properties Nested properties of the cluster. HyperVClusterProperties

HyperVClusterProperties

Name Description Value
fqdn FQDN/IPAddress of the Hyper-V cluster. string
hostFqdnList List of hosts (FQDN) currently being tracked by the cluster. string[]
runAsAccountId Run as account ID of the Hyper-V cluster. string

ARM template resource definition

The HyperVSites/clusters resource type can be deployed with operations that target:

Usage Examples

Resource format

To create a Microsoft.OffAzure/HyperVSites/clusters resource, add the following JSON to your template.

{
  "type": "Microsoft.OffAzure/HyperVSites/clusters",
  "apiVersion": "2020-07-07",
  "name": "string",
  "properties": {
    "fqdn": "string",
    "hostFqdnList": [ "string" ],
    "runAsAccountId": "string"
  }
}

Property Values

Microsoft.OffAzure/HyperVSites/clusters

Name Description Value
apiVersion The api version '2020-07-07'
name The resource name string (required)
properties Nested properties of the cluster. HyperVClusterProperties
type The resource type 'Microsoft.OffAzure/HyperVSites/clusters'

HyperVClusterProperties

Name Description Value
fqdn FQDN/IPAddress of the Hyper-V cluster. string
hostFqdnList List of hosts (FQDN) currently being tracked by the cluster. string[]
runAsAccountId Run as account ID of the Hyper-V cluster. string

Terraform (AzAPI provider) resource definition

The HyperVSites/clusters resource type can be deployed with operations that target:

  • Resource groups For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.OffAzure/HyperVSites/clusters resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.OffAzure/HyperVSites/clusters@2020-07-07"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      fqdn = "string"
      hostFqdnList = [
        "string"
      ]
      runAsAccountId = "string"
    }
  }
}

Property Values

Microsoft.OffAzure/HyperVSites/clusters

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: HyperVSites
properties Nested properties of the cluster. HyperVClusterProperties
type The resource type "Microsoft.OffAzure/HyperVSites/clusters@2020-07-07"

HyperVClusterProperties

Name Description Value
fqdn FQDN/IPAddress of the Hyper-V cluster. string
hostFqdnList List of hosts (FQDN) currently being tracked by the cluster. string[]
runAsAccountId Run as account ID of the Hyper-V cluster. string
  • Last updated on