Share via

Microsoft.AzureStackHCI clusters/arcSettings/extensions 2023-02-01

Bicep resource definition

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

resource symbolicname 'Microsoft.AzureStackHCI/clusters/arcSettings/extensions@2023-02-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    extensionParameters: {
      autoUpgradeMinorVersion: bool
      enableAutomaticUpgrade: bool
      forceUpdateTag: 'string'
      protectedSettings: any(...)
      publisher: 'string'
      settings: any(...)
      type: 'string'
      typeHandlerVersion: 'string'
    }
  }
}

Property Values

Microsoft.AzureStackHCI/clusters/arcSettings/extensions

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: clusters/arcSettings
properties Describes Machine Extension Properties. ExtensionProperties

ExtensionParameters

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
protectedSettings Protected settings (may contain secrets). 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. Latest version would be used if not specified. string

ExtensionProperties

Name Description Value
extensionParameters Parameters specific to this extension type. ExtensionParameters

ARM template resource definition

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

{
  "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions",
  "apiVersion": "2023-02-01",
  "name": "string",
  "properties": {
    "extensionParameters": {
      "autoUpgradeMinorVersion": "bool",
      "enableAutomaticUpgrade": "bool",
      "forceUpdateTag": "string",
      "protectedSettings": {},
      "publisher": "string",
      "settings": {},
      "type": "string",
      "typeHandlerVersion": "string"
    }
  }
}

Property Values

Microsoft.AzureStackHCI/clusters/arcSettings/extensions

Name Description Value
apiVersion The api version '2023-02-01'
name The resource name string (required)
properties Describes Machine Extension Properties. ExtensionProperties
type The resource type 'Microsoft.AzureStackHCI/clusters/arcSettings/extensions'

ExtensionParameters

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
protectedSettings Protected settings (may contain secrets). 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. Latest version would be used if not specified. string

ExtensionProperties

Name Description Value
extensionParameters Parameters specific to this extension type. ExtensionParameters

Usage Examples

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AzureStackHCI/clusters/arcSettings/extensions@2023-02-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      extensionParameters = {
        autoUpgradeMinorVersion = bool
        enableAutomaticUpgrade = bool
        forceUpdateTag = "string"
        protectedSettings = ?
        publisher = "string"
        settings = ?
        type = "string"
        typeHandlerVersion = "string"
      }
    }
  }
}

Property Values

Microsoft.AzureStackHCI/clusters/arcSettings/extensions

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: clusters/arcSettings
properties Describes Machine Extension Properties. ExtensionProperties
type The resource type "Microsoft.AzureStackHCI/clusters/arcSettings/extensions@2023-02-01"

ExtensionParameters

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
protectedSettings Protected settings (may contain secrets). 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. Latest version would be used if not specified. string

ExtensionProperties

Name Description Value
extensionParameters Parameters specific to this extension type. ExtensionParameters