Microsoft.DeviceRegistry namespaces/registryDevices/attributes

Bicep resource definition

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

resource symbolicname 'Microsoft.DeviceRegistry/namespaces/registryDevices/attributes@2026-11-02-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    schema: 'string'
    reportedBy: 'string'
    // For remaining properties, see DeviceAttributeProperties objects
  }
}

DeviceAttributeProperties objects

Set the reportedBy property to specify the type of object.

For Microsoft.DeviceUpdate, use:

{
  agentInfo: {
    agentProfile: int
    agentSdkVersion: 'string'
    compatibilityProperties: {
      {customized property}: 'string'
    }
  }
  agentInfoEtag: 'string'
  deviceClassId: 'string'
  installedUpdateId: {
    name: 'string'
    provider: 'string'
    version: 'string'
  }
  latestUpdateJobInfo: {
    installResult: {
      extendedResultCodes: 'string'
      failureOrigin: 'string'
      resultCode: int
      resultDetails: 'string'
      stepResults: [
        {
          extendedResultCodes: 'string'
          failureOrigin: 'string'
          resultCode: int
          resultDetails: 'string'
          updateId: {
            name: 'string'
            provider: 'string'
            version: 'string'
          }
        }
      ]
    }
    updateId: {
      name: 'string'
      provider: 'string'
      version: 'string'
    }
    workflowId: 'string'
  }
  reportedBy: 'Microsoft.DeviceUpdate'
}

For User, use:

{
  reportedBy: 'User'
}

Property Values

Microsoft.DeviceRegistry/namespaces/registryDevices/attributes

Name Description Value
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[0-9a-zA-Z][a-zA-Z0-9-]*$ (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: namespaces/registryDevices
properties The resource-specific properties for this resource. DeviceAttributeProperties

AgentInfo

Name Description Value
agentProfile The agent profile identifier. int
agentSdkVersion The version of the agent SDK in use on the device. string
compatibilityProperties Properties used to determine compatibility with available updates. AgentInfoCompatibilityProperties

AgentInfoCompatibilityProperties

Name Description Value

DeviceAttributeProperties

Name Description Value
reportedBy Set to 'Microsoft.DeviceUpdate' for type UpdateDeviceAttributeProperties. Set to 'User' for type UserDeviceAttributeProperties. 'Microsoft.DeviceUpdate'
'User' (required)
schema URL of the JSON Schema document describing the concrete shape of this property bag. Optional
advertisement so clients can validate the bag without out-of-band documentation.
string

DeviceUpdateId

Name Description Value
name The name of the update. string (required)
provider The provider of the update. string (required)
version The version of the update. string (required)

InstallResult

Name Description Value
extendedResultCodes Comma-separated list of agent ExtendedResultCode (ERC) values for diagnostic correlation. Each value is the unsigned hexadecimal representation of an int32. string

Constraints:
Max length = 1024 (required)
failureOrigin Best-effort hint identifying which subsystem produced the failure. Value is NOT_APPLICABLE for successful install. 'ADU_CLOUD_SERVICE'
'ADU_MANAGED_RESOURCE'
'AGENT_CORE'
'AGENT_DEPENDENCY'
'AGENT_EXTENSION'
'DEVICE'
'NOT_APPLICABLE'
'OTHER' (required)
resultCode Result code representing an install result. 0 or negative values designate failures, positive values indicate success. int (required)
resultDetails Human-readable result details. string

Constraints:
Max length = 1024
stepResults Per-step results of the steps defined by the manifest's instructions.steps. UpdateStepResult[]

UpdateDeviceAttributeProperties

Name Description Value
agentInfo Information reported by the device update agent. AgentInfo
agentInfoEtag The entity tag for the reported agentInfo. string
deviceClassId The device class identifier, calculated by ADU from agentInfo.compatibilityProperties and agentInfo.agentProfile. string
installedUpdateId The identifier of the update currently installed on the device. DeviceUpdateId
latestUpdateJobInfo Information about the most recent update job targeting this device. UpdateJobInfo
reportedBy The cloud service type that reports this device attribute. 'Microsoft.DeviceUpdate' (required)

UpdateJobInfo

Name Description Value
installResult The result of installing the update on the device, if available. InstallResult
updateId The identifier of the update being applied by the job. DeviceUpdateId (required)
workflowId The identifier of the update job workflow. string (required)

UpdateStepResult

Name Description Value
extendedResultCodes Step-level extended result codes. Same format as InstallResult.extendedResultCodes. string

Constraints:
Max length = 1024 (required)
failureOrigin Best-effort hint identifying which subsystem produced the failure for this step. Value is NOT_APPLICABLE for successful install. 'ADU_CLOUD_SERVICE'
'ADU_MANAGED_RESOURCE'
'AGENT_CORE'
'AGENT_DEPENDENCY'
'AGENT_EXTENSION'
'DEVICE'
'NOT_APPLICABLE'
'OTHER' (required)
resultCode Step-level install result code. Same semantics as InstallResult.resultCode. int (required)
resultDetails Human-readable result details for this step. string

Constraints:
Max length = 1024
updateId The identifier of the leaf update worked on by this step. ADU resolves this from the manifest's instructions.steps (inline step → parent updateId; reference step → child updateId). DeviceUpdateId (required)

UserDeviceAttributeProperties

Name Description Value
reportedBy The cloud service type that reports this device attribute. 'User' (required)

ARM template resource definition

The namespaces/registryDevices/attributes resource type can be deployed with operations that target:

Usage Examples

Resource format

To create a Microsoft.DeviceRegistry/namespaces/registryDevices/attributes resource, add the following JSON to your template.

{
  "type": "Microsoft.DeviceRegistry/namespaces/registryDevices/attributes",
  "apiVersion": "2026-11-02-preview",
  "name": "string",
  "properties": {
    "schema": "string",
    "reportedBy": "string"
    // For remaining properties, see DeviceAttributeProperties objects
  }
}

DeviceAttributeProperties objects

Set the reportedBy property to specify the type of object.

For Microsoft.DeviceUpdate, use:

{
  "agentInfo": {
    "agentProfile": "int",
    "agentSdkVersion": "string",
    "compatibilityProperties": {
      "{customized property}": "string"
    }
  },
  "agentInfoEtag": "string",
  "deviceClassId": "string",
  "installedUpdateId": {
    "name": "string",
    "provider": "string",
    "version": "string"
  },
  "latestUpdateJobInfo": {
    "installResult": {
      "extendedResultCodes": "string",
      "failureOrigin": "string",
      "resultCode": "int",
      "resultDetails": "string",
      "stepResults": [
        {
          "extendedResultCodes": "string",
          "failureOrigin": "string",
          "resultCode": "int",
          "resultDetails": "string",
          "updateId": {
            "name": "string",
            "provider": "string",
            "version": "string"
          }
        }
      ]
    },
    "updateId": {
      "name": "string",
      "provider": "string",
      "version": "string"
    },
    "workflowId": "string"
  },
  "reportedBy": "Microsoft.DeviceUpdate"
}

For User, use:

{
  "reportedBy": "User"
}

Property Values

Microsoft.DeviceRegistry/namespaces/registryDevices/attributes

Name Description Value
apiVersion The api version '2026-11-02-preview'
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[0-9a-zA-Z][a-zA-Z0-9-]*$ (required)
properties The resource-specific properties for this resource. DeviceAttributeProperties
type The resource type 'Microsoft.DeviceRegistry/namespaces/registryDevices/attributes'

AgentInfo

Name Description Value
agentProfile The agent profile identifier. int
agentSdkVersion The version of the agent SDK in use on the device. string
compatibilityProperties Properties used to determine compatibility with available updates. AgentInfoCompatibilityProperties

AgentInfoCompatibilityProperties

Name Description Value

DeviceAttributeProperties

Name Description Value
reportedBy Set to 'Microsoft.DeviceUpdate' for type UpdateDeviceAttributeProperties. Set to 'User' for type UserDeviceAttributeProperties. 'Microsoft.DeviceUpdate'
'User' (required)
schema URL of the JSON Schema document describing the concrete shape of this property bag. Optional
advertisement so clients can validate the bag without out-of-band documentation.
string

DeviceUpdateId

Name Description Value
name The name of the update. string (required)
provider The provider of the update. string (required)
version The version of the update. string (required)

InstallResult

Name Description Value
extendedResultCodes Comma-separated list of agent ExtendedResultCode (ERC) values for diagnostic correlation. Each value is the unsigned hexadecimal representation of an int32. string

Constraints:
Max length = 1024 (required)
failureOrigin Best-effort hint identifying which subsystem produced the failure. Value is NOT_APPLICABLE for successful install. 'ADU_CLOUD_SERVICE'
'ADU_MANAGED_RESOURCE'
'AGENT_CORE'
'AGENT_DEPENDENCY'
'AGENT_EXTENSION'
'DEVICE'
'NOT_APPLICABLE'
'OTHER' (required)
resultCode Result code representing an install result. 0 or negative values designate failures, positive values indicate success. int (required)
resultDetails Human-readable result details. string

Constraints:
Max length = 1024
stepResults Per-step results of the steps defined by the manifest's instructions.steps. UpdateStepResult[]

UpdateDeviceAttributeProperties

Name Description Value
agentInfo Information reported by the device update agent. AgentInfo
agentInfoEtag The entity tag for the reported agentInfo. string
deviceClassId The device class identifier, calculated by ADU from agentInfo.compatibilityProperties and agentInfo.agentProfile. string
installedUpdateId The identifier of the update currently installed on the device. DeviceUpdateId
latestUpdateJobInfo Information about the most recent update job targeting this device. UpdateJobInfo
reportedBy The cloud service type that reports this device attribute. 'Microsoft.DeviceUpdate' (required)

UpdateJobInfo

Name Description Value
installResult The result of installing the update on the device, if available. InstallResult
updateId The identifier of the update being applied by the job. DeviceUpdateId (required)
workflowId The identifier of the update job workflow. string (required)

UpdateStepResult

Name Description Value
extendedResultCodes Step-level extended result codes. Same format as InstallResult.extendedResultCodes. string

Constraints:
Max length = 1024 (required)
failureOrigin Best-effort hint identifying which subsystem produced the failure for this step. Value is NOT_APPLICABLE for successful install. 'ADU_CLOUD_SERVICE'
'ADU_MANAGED_RESOURCE'
'AGENT_CORE'
'AGENT_DEPENDENCY'
'AGENT_EXTENSION'
'DEVICE'
'NOT_APPLICABLE'
'OTHER' (required)
resultCode Step-level install result code. Same semantics as InstallResult.resultCode. int (required)
resultDetails Human-readable result details for this step. string

Constraints:
Max length = 1024
updateId The identifier of the leaf update worked on by this step. ADU resolves this from the manifest's instructions.steps (inline step → parent updateId; reference step → child updateId). DeviceUpdateId (required)

UserDeviceAttributeProperties

Name Description Value
reportedBy The cloud service type that reports this device attribute. 'User' (required)

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DeviceRegistry/namespaces/registryDevices/attributes@2026-11-02-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      schema = "string"
      reportedBy = "string"
      // For remaining properties, see DeviceAttributeProperties objects
    }
  }
}

DeviceAttributeProperties objects

Set the reportedBy property to specify the type of object.

For Microsoft.DeviceUpdate, use:

{
  agentInfo = {
    agentProfile = int
    agentSdkVersion = "string"
    compatibilityProperties = {
      {customized property} = "string"
    }
  }
  agentInfoEtag = "string"
  deviceClassId = "string"
  installedUpdateId = {
    name = "string"
    provider = "string"
    version = "string"
  }
  latestUpdateJobInfo = {
    installResult = {
      extendedResultCodes = "string"
      failureOrigin = "string"
      resultCode = int
      resultDetails = "string"
      stepResults = [
        {
          extendedResultCodes = "string"
          failureOrigin = "string"
          resultCode = int
          resultDetails = "string"
          updateId = {
            name = "string"
            provider = "string"
            version = "string"
          }
        }
      ]
    }
    updateId = {
      name = "string"
      provider = "string"
      version = "string"
    }
    workflowId = "string"
  }
  reportedBy = "Microsoft.DeviceUpdate"
}

For User, use:

{
  reportedBy = "User"
}

Property Values

Microsoft.DeviceRegistry/namespaces/registryDevices/attributes

Name Description Value
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[0-9a-zA-Z][a-zA-Z0-9-]*$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: namespaces/registryDevices
properties The resource-specific properties for this resource. DeviceAttributeProperties
type The resource type "Microsoft.DeviceRegistry/namespaces/registryDevices/attributes@2026-11-02-preview"

AgentInfo

Name Description Value
agentProfile The agent profile identifier. int
agentSdkVersion The version of the agent SDK in use on the device. string
compatibilityProperties Properties used to determine compatibility with available updates. AgentInfoCompatibilityProperties

AgentInfoCompatibilityProperties

Name Description Value

DeviceAttributeProperties

Name Description Value
reportedBy Set to 'Microsoft.DeviceUpdate' for type UpdateDeviceAttributeProperties. Set to 'User' for type UserDeviceAttributeProperties. 'Microsoft.DeviceUpdate'
'User' (required)
schema URL of the JSON Schema document describing the concrete shape of this property bag. Optional
advertisement so clients can validate the bag without out-of-band documentation.
string

DeviceUpdateId

Name Description Value
name The name of the update. string (required)
provider The provider of the update. string (required)
version The version of the update. string (required)

InstallResult

Name Description Value
extendedResultCodes Comma-separated list of agent ExtendedResultCode (ERC) values for diagnostic correlation. Each value is the unsigned hexadecimal representation of an int32. string

Constraints:
Max length = 1024 (required)
failureOrigin Best-effort hint identifying which subsystem produced the failure. Value is NOT_APPLICABLE for successful install. 'ADU_CLOUD_SERVICE'
'ADU_MANAGED_RESOURCE'
'AGENT_CORE'
'AGENT_DEPENDENCY'
'AGENT_EXTENSION'
'DEVICE'
'NOT_APPLICABLE'
'OTHER' (required)
resultCode Result code representing an install result. 0 or negative values designate failures, positive values indicate success. int (required)
resultDetails Human-readable result details. string

Constraints:
Max length = 1024
stepResults Per-step results of the steps defined by the manifest's instructions.steps. UpdateStepResult[]

UpdateDeviceAttributeProperties

Name Description Value
agentInfo Information reported by the device update agent. AgentInfo
agentInfoEtag The entity tag for the reported agentInfo. string
deviceClassId The device class identifier, calculated by ADU from agentInfo.compatibilityProperties and agentInfo.agentProfile. string
installedUpdateId The identifier of the update currently installed on the device. DeviceUpdateId
latestUpdateJobInfo Information about the most recent update job targeting this device. UpdateJobInfo
reportedBy The cloud service type that reports this device attribute. 'Microsoft.DeviceUpdate' (required)

UpdateJobInfo

Name Description Value
installResult The result of installing the update on the device, if available. InstallResult
updateId The identifier of the update being applied by the job. DeviceUpdateId (required)
workflowId The identifier of the update job workflow. string (required)

UpdateStepResult

Name Description Value
extendedResultCodes Step-level extended result codes. Same format as InstallResult.extendedResultCodes. string

Constraints:
Max length = 1024 (required)
failureOrigin Best-effort hint identifying which subsystem produced the failure for this step. Value is NOT_APPLICABLE for successful install. 'ADU_CLOUD_SERVICE'
'ADU_MANAGED_RESOURCE'
'AGENT_CORE'
'AGENT_DEPENDENCY'
'AGENT_EXTENSION'
'DEVICE'
'NOT_APPLICABLE'
'OTHER' (required)
resultCode Step-level install result code. Same semantics as InstallResult.resultCode. int (required)
resultDetails Human-readable result details for this step. string

Constraints:
Max length = 1024
updateId The identifier of the leaf update worked on by this step. ADU resolves this from the manifest's instructions.steps (inline step → parent updateId; reference step → child updateId). DeviceUpdateId (required)

UserDeviceAttributeProperties

Name Description Value
reportedBy The cloud service type that reports this device attribute. 'User' (required)