Share via

Microsoft.ConnectedVMwarevSphere clusters 2023-10-01

  • Article

Bicep resource definition

The 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.ConnectedVMwarevSphere/clusters resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ConnectedVMwarevSphere/clusters@2023-10-01' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    inventoryItemId: 'string'
    moRefId: 'string'
    vCenterId: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

ClusterProperties

Name Description Value
inventoryItemId Gets or sets the inventory Item ID for the cluster. string
moRefId Gets or sets the vCenter MoRef (Managed Object Reference) ID for the cluster. string
vCenterId Gets or sets the ARM Id of the vCenter resource in which this cluster resides. string

ClusterTags

Name Description Value

ExtendedLocation

Name Description Value
name The extended location name. string
type The extended location type. string

Microsoft.ConnectedVMwarevSphere/clusters

Name Description Value
extendedLocation Gets or sets the extended location. ExtendedLocation
kind Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. string
location Gets or sets the location. string (required)
name The resource name string (required)
properties Resource properties. ClusterProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

ARM template resource definition

The 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.ConnectedVMwarevSphere/clusters resource, add the following JSON to your template.

{
  "type": "Microsoft.ConnectedVMwarevSphere/clusters",
  "apiVersion": "2023-10-01",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "inventoryItemId": "string",
    "moRefId": "string",
    "vCenterId": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

ClusterProperties

Name Description Value
inventoryItemId Gets or sets the inventory Item ID for the cluster. string
moRefId Gets or sets the vCenter MoRef (Managed Object Reference) ID for the cluster. string
vCenterId Gets or sets the ARM Id of the vCenter resource in which this cluster resides. string

ClusterTags

Name Description Value

ExtendedLocation

Name Description Value
name The extended location name. string
type The extended location type. string

Microsoft.ConnectedVMwarevSphere/clusters

Name Description Value
apiVersion The api version '2023-10-01'
extendedLocation Gets or sets the extended location. ExtendedLocation
kind Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. string
location Gets or sets the location. string (required)
name The resource name string (required)
properties Resource properties. ClusterProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.ConnectedVMwarevSphere/clusters'

Usage Examples

Terraform (AzAPI provider) resource definition

The 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.ConnectedVMwarevSphere/clusters resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ConnectedVMwarevSphere/clusters@2023-10-01"
  name = "string"
  kind = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      inventoryItemId = "string"
      moRefId = "string"
      vCenterId = "string"
    }
  })
}

Property Values

ClusterProperties

Name Description Value
inventoryItemId Gets or sets the inventory Item ID for the cluster. string
moRefId Gets or sets the vCenter MoRef (Managed Object Reference) ID for the cluster. string
vCenterId Gets or sets the ARM Id of the vCenter resource in which this cluster resides. string

ClusterTags

Name Description Value

ExtendedLocation

Name Description Value
name The extended location name. string
type The extended location type. string

Microsoft.ConnectedVMwarevSphere/clusters

Name Description Value
extendedLocation Gets or sets the extended location. ExtendedLocation
kind Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. string
location Gets or sets the location. string (required)
name The resource name string (required)
properties Resource properties. ClusterProperties (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.ConnectedVMwarevSphere/clusters@2023-10-01"