Microsoft.DeviceUpdate accounts/instances 2022-12-01-preview

Bicep resource definition

The accounts/instances resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DeviceUpdate/accounts/instances resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DeviceUpdate/accounts/instances@2022-12-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    diagnosticStorageProperties: {
      authenticationType: 'KeyBased'
      connectionString: 'string'
      resourceId: 'string'
    }
    enableDiagnostics: bool
    iotHubs: [
      {
        resourceId: 'string'
      }
    ]
  }
}

Property values

accounts/instances

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.
string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
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: accounts
properties Device Update instance properties. InstanceProperties (required)

InstanceProperties

Name Description Value
diagnosticStorageProperties Customer-initiated diagnostic log collection storage properties DiagnosticStorageProperties
enableDiagnostics Enables or Disables the diagnostic logs collection bool
iotHubs List of IoT Hubs associated with the account. IotHubSettings[]

DiagnosticStorageProperties

Name Description Value
authenticationType Authentication Type 'KeyBased' (required)
connectionString ConnectionString of the diagnostic storage account string
resourceId ResourceId of the diagnostic storage account string (required)

IotHubSettings

Name Description Value
resourceId IoTHub resource ID string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create Device Update for IoT Hub account, instance, IoT Hub

Deploy to Azure
This template creates an account, and an instance and a hub to link the instance with. It configures the hub with the necessary access polices, routes, and consumer group.

ARM template resource definition

The accounts/instances resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DeviceUpdate/accounts/instances resource, add the following JSON to your template.

{
  "type": "Microsoft.DeviceUpdate/accounts/instances",
  "apiVersion": "2022-12-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "diagnosticStorageProperties": {
      "authenticationType": "KeyBased",
      "connectionString": "string",
      "resourceId": "string"
    },
    "enableDiagnostics": "bool",
    "iotHubs": [
      {
        "resourceId": "string"
      }
    ]
  }
}

Property values

accounts/instances

Name Description Value
type The resource type 'Microsoft.DeviceUpdate/accounts/instances'
apiVersion The resource api version '2022-12-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties Device Update instance properties. InstanceProperties (required)

InstanceProperties

Name Description Value
diagnosticStorageProperties Customer-initiated diagnostic log collection storage properties DiagnosticStorageProperties
enableDiagnostics Enables or Disables the diagnostic logs collection bool
iotHubs List of IoT Hubs associated with the account. IotHubSettings[]

DiagnosticStorageProperties

Name Description Value
authenticationType Authentication Type 'KeyBased' (required)
connectionString ConnectionString of the diagnostic storage account string
resourceId ResourceId of the diagnostic storage account string (required)

IotHubSettings

Name Description Value
resourceId IoTHub resource ID string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create Device Update for IoT Hub account, instance, IoT Hub

Deploy to Azure
This template creates an account, and an instance and a hub to link the instance with. It configures the hub with the necessary access polices, routes, and consumer group.

Terraform (AzAPI provider) resource definition

The accounts/instances resource type can be deployed to:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DeviceUpdate/accounts/instances resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DeviceUpdate/accounts/instances@2022-12-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      diagnosticStorageProperties = {
        authenticationType = "KeyBased"
        connectionString = "string"
        resourceId = "string"
      }
      enableDiagnostics = bool
      iotHubs = [
        {
          resourceId = "string"
        }
      ]
    }
  })
}

Property values

accounts/instances

Name Description Value
type The resource type "Microsoft.DeviceUpdate/accounts/instances@2022-12-01-preview"
name The resource name string (required)
location The geo-location where the resource lives string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: accounts
tags Resource tags. Dictionary of tag names and values.
properties Device Update instance properties. InstanceProperties (required)

InstanceProperties

Name Description Value
diagnosticStorageProperties Customer-initiated diagnostic log collection storage properties DiagnosticStorageProperties
enableDiagnostics Enables or Disables the diagnostic logs collection bool
iotHubs List of IoT Hubs associated with the account. IotHubSettings[]

DiagnosticStorageProperties

Name Description Value
authenticationType Authentication Type "KeyBased" (required)
connectionString ConnectionString of the diagnostic storage account string
resourceId ResourceId of the diagnostic storage account string (required)

IotHubSettings

Name Description Value
resourceId IoTHub resource ID string (required)