Share via

Microsoft.ConnectedVMwarevSphere virtualMachines/extensions

  • Article
  • 12/09/2024

Bicep resource definition

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

resource symbolicname 'Microsoft.ConnectedVMwarevSphere/virtualMachines/extensions@2023-03-01-preview' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    autoUpgradeMinorVersion: bool
    enableAutomaticUpgrade: bool
    forceUpdateTag: 'string'
    instanceView: {
      status: {}
    }
    protectedSettings: any(...)
    publisher: 'string'
    settings: any(...)
    type: 'string'
    typeHandlerVersion: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

MachineExtensionInstanceViewStatus

Name Description Value

MachineExtensionProperties

Name Description Value
autoUpgradeMinorVersion Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. bool
enableAutomaticUpgrade Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. bool
forceUpdateTag How the extension handler should be forced to update even if the extension configuration has not changed. string
instanceView The machine extension instance view. MachineExtensionPropertiesInstanceView
protectedSettings The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. any
publisher The name of the extension handler publisher. string
settings Json formatted public settings for the extension. any
type Specifies the type of the extension; an example is "CustomScriptExtension". string
typeHandlerVersion Specifies the version of the script handler. string

MachineExtensionPropertiesInstanceView

Name Description Value
status Instance view status. MachineExtensionInstanceViewStatus

MachineExtensionTags

Name Description Value

Microsoft.ConnectedVMwarevSphere/virtualMachines/extensions

Name Description Value
location Gets or sets the location. string
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: virtualMachines
properties Describes Machine Extension Properties. MachineExtensionProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

ARM template resource definition

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

{
  "type": "Microsoft.ConnectedVMwarevSphere/virtualMachines/extensions",
  "apiVersion": "2023-03-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "autoUpgradeMinorVersion": "bool",
    "enableAutomaticUpgrade": "bool",
    "forceUpdateTag": "string",
    "instanceView": {
      "status": {
      }
    },
    "protectedSettings": {},
    "publisher": "string",
    "settings": {},
    "type": "string",
    "typeHandlerVersion": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

MachineExtensionInstanceViewStatus

Name Description Value

MachineExtensionProperties

Name Description Value
autoUpgradeMinorVersion Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. bool
enableAutomaticUpgrade Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. bool
forceUpdateTag How the extension handler should be forced to update even if the extension configuration has not changed. string
instanceView The machine extension instance view. MachineExtensionPropertiesInstanceView
protectedSettings The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. any
publisher The name of the extension handler publisher. string
settings Json formatted public settings for the extension. any
type Specifies the type of the extension; an example is "CustomScriptExtension". string
typeHandlerVersion Specifies the version of the script handler. string

MachineExtensionPropertiesInstanceView

Name Description Value
status Instance view status. MachineExtensionInstanceViewStatus

MachineExtensionTags

Name Description Value

Microsoft.ConnectedVMwarevSphere/virtualMachines/extensions

Name Description Value
apiVersion The api version '2023-03-01-preview'
location Gets or sets the location. string
name The resource name string (required)
properties Describes Machine Extension Properties. MachineExtensionProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.ConnectedVMwarevSphere/virtualMachines/extensions'

Usage Examples

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ConnectedVMwarevSphere/virtualMachines/extensions@2023-03-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      autoUpgradeMinorVersion = bool
      enableAutomaticUpgrade = bool
      forceUpdateTag = "string"
      instanceView = {
        status = {
        }
      }
      protectedSettings = ?
      publisher = "string"
      settings = ?
      type = "string"
      typeHandlerVersion = "string"
    }
  }
}

Property Values

MachineExtensionInstanceViewStatus

Name Description Value

MachineExtensionProperties

Name Description Value
autoUpgradeMinorVersion Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. bool
enableAutomaticUpgrade Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. bool
forceUpdateTag How the extension handler should be forced to update even if the extension configuration has not changed. string
instanceView The machine extension instance view. MachineExtensionPropertiesInstanceView
protectedSettings The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. any
publisher The name of the extension handler publisher. string
settings Json formatted public settings for the extension. any
type Specifies the type of the extension; an example is "CustomScriptExtension". string
typeHandlerVersion Specifies the version of the script handler. string

MachineExtensionPropertiesInstanceView

Name Description Value
status Instance view status. MachineExtensionInstanceViewStatus

MachineExtensionTags

Name Description Value

Microsoft.ConnectedVMwarevSphere/virtualMachines/extensions

Name Description Value
location Gets or sets the location. string
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: virtualMachines
properties Describes Machine Extension Properties. MachineExtensionProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.ConnectedVMwarevSphere/virtualMachines/extensions@2023-03-01-preview"