Microsoft.OffAzure hypervSites/clusters 2024-07-01-preview

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@2024-07-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    fqdn: 'string'
    hostFqdnList: [
      'string'
    ]
    provisioningState: 'string'
    runAsAccountId: 'string'
  }
}

Property Values

Microsoft.OffAzure/hypervSites/clusters

Name Description Value
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9-]{3,24}$ (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 The resource-specific properties for this resource. HypervClusterProperties

HypervClusterProperties

Name Description Value
fqdn Gets or sets the FQDN/IPAddress of the Hyper-V cluster. string
hostFqdnList Gets or sets list of hosts (FQDN) currently being tracked by the cluster. string[]
provisioningState The status of the last operation. 'Canceled'
'Completed'
'Created'
'Failed'
'Running'
'Succeeded'
'Updated'
runAsAccountId Gets or sets 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": "2024-07-01-preview",
  "name": "string",
  "properties": {
    "fqdn": "string",
    "hostFqdnList": [ "string" ],
    "provisioningState": "string",
    "runAsAccountId": "string"
  }
}

Property Values

Microsoft.OffAzure/hypervSites/clusters

Name Description Value
apiVersion The api version '2024-07-01-preview'
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9-]{3,24}$ (required)
properties The resource-specific properties for this resource. HypervClusterProperties
type The resource type 'Microsoft.OffAzure/hypervSites/clusters'

HypervClusterProperties

Name Description Value
fqdn Gets or sets the FQDN/IPAddress of the Hyper-V cluster. string
hostFqdnList Gets or sets list of hosts (FQDN) currently being tracked by the cluster. string[]
provisioningState The status of the last operation. 'Canceled'
'Completed'
'Created'
'Failed'
'Running'
'Succeeded'
'Updated'
runAsAccountId Gets or sets 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@2024-07-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      fqdn = "string"
      hostFqdnList = [
        "string"
      ]
      provisioningState = "string"
      runAsAccountId = "string"
    }
  }
}

Property Values

Microsoft.OffAzure/hypervSites/clusters

Name Description Value
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9-]{3,24}$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: hypervSites
properties The resource-specific properties for this resource. HypervClusterProperties
type The resource type "Microsoft.OffAzure/hypervSites/clusters@2024-07-01-preview"

HypervClusterProperties

Name Description Value
fqdn Gets or sets the FQDN/IPAddress of the Hyper-V cluster. string
hostFqdnList Gets or sets list of hosts (FQDN) currently being tracked by the cluster. string[]
provisioningState The status of the last operation. 'Canceled'
'Completed'
'Created'
'Failed'
'Running'
'Succeeded'
'Updated'
runAsAccountId Gets or sets Run as account ID of the Hyper-V cluster. string
  • Last updated on