Share via

Microsoft.ResourceConnector appliances 2022-10-27

Bicep resource definition

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

resource symbolicname 'Microsoft.ResourceConnector/appliances@2022-10-27' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    distro: 'string'
    infrastructureConfig: {
      provider: 'string'
    }
    publicKey: 'string'
    version: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.ResourceConnector/appliances

Name Description Value
identity Identity for the resource. Identity
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 1
Max length = 63
Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ (required)
properties The set of properties specific to an Appliance ApplianceProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

ApplianceProperties

Name Description Value
distro Represents a supported Fabric/Infra. (AKSEdge etc...). 'AKSEdge'
infrastructureConfig Contains infrastructure information about the Appliance AppliancePropertiesInfrastructureConfig
publicKey Certificates pair used to download MSI certificate from HIS. Can only be set once. string
version Version of the Appliance string

AppliancePropertiesInfrastructureConfig

Name Description Value
provider Information about the connected appliance. 'HCI'
'SCVMM'
'VMWare'

Identity

Name Description Value
type The identity type. 'None'
'SystemAssigned'

TrackedResourceTags

Name Description Value

ARM template resource definition

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

{
  "type": "Microsoft.ResourceConnector/appliances",
  "apiVersion": "2022-10-27",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "distro": "string",
    "infrastructureConfig": {
      "provider": "string"
    },
    "publicKey": "string",
    "version": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.ResourceConnector/appliances

Name Description Value
apiVersion The api version '2022-10-27'
identity Identity for the resource. Identity
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 1
Max length = 63
Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ (required)
properties The set of properties specific to an Appliance ApplianceProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.ResourceConnector/appliances'

ApplianceProperties

Name Description Value
distro Represents a supported Fabric/Infra. (AKSEdge etc...). 'AKSEdge'
infrastructureConfig Contains infrastructure information about the Appliance AppliancePropertiesInfrastructureConfig
publicKey Certificates pair used to download MSI certificate from HIS. Can only be set once. string
version Version of the Appliance string

AppliancePropertiesInfrastructureConfig

Name Description Value
provider Information about the connected appliance. 'HCI'
'SCVMM'
'VMWare'

Identity

Name Description Value
type The identity type. 'None'
'SystemAssigned'

TrackedResourceTags

Name Description Value

Usage Examples

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ResourceConnector/appliances@2022-10-27"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      distro = "string"
      infrastructureConfig = {
        provider = "string"
      }
      publicKey = "string"
      version = "string"
    }
  }
}

Property Values

Microsoft.ResourceConnector/appliances

Name Description Value
identity Identity for the resource. Identity
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 1
Max length = 63
Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ (required)
properties The set of properties specific to an Appliance ApplianceProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.ResourceConnector/appliances@2022-10-27"

ApplianceProperties

Name Description Value
distro Represents a supported Fabric/Infra. (AKSEdge etc...). 'AKSEdge'
infrastructureConfig Contains infrastructure information about the Appliance AppliancePropertiesInfrastructureConfig
publicKey Certificates pair used to download MSI certificate from HIS. Can only be set once. string
version Version of the Appliance string

AppliancePropertiesInfrastructureConfig

Name Description Value
provider Information about the connected appliance. 'HCI'
'SCVMM'
'VMWare'

Identity

Name Description Value
type The identity type. 'None'
'SystemAssigned'

TrackedResourceTags

Name Description Value