Share via

Microsoft.ConnectedVMwarevSphere hosts

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.ConnectedVMwarevSphere/hosts@2022-07-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  properties: {
    inventoryItemId: 'string'
    moRefId: 'string'
    vCenterId: 'string'
  }
}

Property values

hosts

Name Description Value
name The resource name string (required)
location Gets or sets the location. string (required)
tags Gets or sets the Resource tags. Dictionary of tag names and values. See Tags in templates
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
extendedLocation Gets or sets the extended location. ExtendedLocation
properties Resource properties. HostProperties (required)

ExtendedLocation

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

HostProperties

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

ARM template resource definition

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

{
  "type": "Microsoft.ConnectedVMwarevSphere/hosts",
  "apiVersion": "2022-07-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "properties": {
    "inventoryItemId": "string",
    "moRefId": "string",
    "vCenterId": "string"
  }
}

Property values

hosts

Name Description Value
type The resource type 'Microsoft.ConnectedVMwarevSphere/hosts'
apiVersion The resource api version '2022-07-15-preview'
name The resource name string (required)
location Gets or sets the location. string (required)
tags Gets or sets the Resource tags. Dictionary of tag names and values. See Tags in templates
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
extendedLocation Gets or sets the extended location. ExtendedLocation
properties Resource properties. HostProperties (required)

ExtendedLocation

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

HostProperties

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

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ConnectedVMwarevSphere/hosts@2022-07-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      inventoryItemId = "string"
      moRefId = "string"
      vCenterId = "string"
    }
    kind = "string"
    extendedLocation = {
      name = "string"
      type = "string"
    }
  })
}

Property values

hosts

Name Description Value
type The resource type "Microsoft.ConnectedVMwarevSphere/hosts@2022-07-15-preview"
name The resource name string (required)
location Gets or sets the location. string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Gets or sets the Resource tags. Dictionary of tag names and values.
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
extendedLocation Gets or sets the extended location. ExtendedLocation
properties Resource properties. HostProperties (required)

ExtendedLocation

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

HostProperties

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