Azure Device Registry

azure Coordination serviceazure-device-registry

Cloud registry that projects Azure IoT Operations devices and assets into Azure Resource Manager and syncs them to the edge cluster.

Provider: azure
Kind: Coordination service
Category: Operations
Official docs: https://learn.microsoft.com/en-us/azure/iot-operations/discover-manage-assets/overview-manage-assets

Properties · 2 set by this component

property	type	values	required	kind default	this component
cloudSourceOfTruth · component property	boolean	—	no	true	inherited
consensus	enum	none \| raft \| paxos \| zab	no	none	inherited
edgeSync · component property	boolean	—	no	true	inherited
managed	boolean	—	no	false	▸ true
namespaces · component property	boolean	—	no	true	inherited
nodes	integer	—	no	—	inherited
replicated	boolean	—	no	false	inherited
role	enum	metadata \| lock \| discovery \| placement \| sharding \| leader-election \| config	yes	—	▸ metadata

Rules that apply · 2

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

Shared dependency without redundancyerror

shared-dependency-without-redundancy

The design requires redundant discovery, but this DNS or coordination service, which everything depends on, runs on a single provider or a single replica. Its failure is the whole system's failure.

— all of these hold:
— the design requirement `availability.discoveryRedundant` is true
— any of these hold:
— the node's `redundantProviders` is false
— the node's `replicated` is false

Stateful engine pinned to a single zoneerror

stateful-engine-pinned-to-single-zone

A matching engine, coordination service or event store living in exactly one availability zone, with no failover and no replication, is lost with that zone. Everything that depends on it stops with it.

— all of these hold:
— the node sits inside exactly 1 availability-zone group
— any of these hold:
— the node's `failover` is "none"
— the node's `replicated` is false
— the node's `replication` is "none"

Use it in a design

nodes:
  - { id: "device-registry", component: "azure-device-registry" }

Other Coordination service products · 17

Source

1# yaml-language-server: $schema=../../schema/component.schema.json
2# Azure Device Registry: the cloud registry that projects the devices and assets of an Azure IoT
3# Operations deployment into Azure Resource Manager ("Asset and Device Management - Azure IoT
4# Operations"). That page states Device Registry "offers a unified registry so that apps and services
5# that interact with your assets connect to a single source", that it "syncs assets in the cloud with
6# custom resources in Kubernetes on the edge", that it organises assets and devices into namespaces
7# with one namespace per IoT Operations instance, and that "the cloud is always the source of truth for
8# device and asset configuration".
9schemaVersion: "1"
10type: "component"
11id: "azure-device-registry"
12kind: "coordination-service"
13provider: "azure"
14docs: "https://learn.microsoft.com/en-us/azure/iot-operations/discover-manage-assets/overview-manage-assets"
15defaults:
16  managed: true
17  role: "metadata"
18properties:
19  namespaces:
20    type: "boolean"
21    default: true
22  edgeSync:
23    type: "boolean"
24    default: true
25  cloudSourceOfTruth:
26    type: "boolean"
27    default: true

The same page as markdown, for an agent: /catalogue/components/azure-device-registry.md