az iot ops ns device endpoint inbound

Note

This reference is part of the azure-iot-ops extension for the Azure CLI (version 2.70.0 or higher). The extension will automatically install the first time you run an az iot ops ns device endpoint inbound command. Learn more about extensions.

Manage inbound endpoints for devices in Device Registry namespaces.

Inbound endpoints define communication channels from the device to the IoT Ops platform.

Commands

Name	Description	Type	Status
az iot ops ns device endpoint inbound add	Add a type-specific inbound endpoint to a device in a Device Registry namespace.	Extension	GA
az iot ops ns device endpoint inbound add custom	Add a custom inbound endpoint to a device in a Device Registry namespace.	Extension	GA
az iot ops ns device endpoint inbound add media	Add a media inbound endpoint to a device in a Device Registry namespace.	Extension	GA
az iot ops ns device endpoint inbound add mqtt	Add an MQTT inbound endpoint to a device in a Device Registry namespace.	Extension	GA
az iot ops ns device endpoint inbound add onvif	Add an ONVIF inbound endpoint to a device in a Device Registry namespace.	Extension	GA
az iot ops ns device endpoint inbound add opcua	Add an OPC UA inbound endpoint to a device in a Device Registry namespace.	Extension	GA
az iot ops ns device endpoint inbound add rest	Add a rest inbound endpoint to a device in a Device Registry namespace.	Extension	GA
az iot ops ns device endpoint inbound add sse	Add an SSE inbound endpoint to a device in a Device Registry namespace.	Extension	GA
az iot ops ns device endpoint inbound apply	Apply an inbound endpoint to a device using a generalized connector-type approach.	Extension	Preview
az iot ops ns device endpoint inbound list	List inbound endpoints of a device in a Device Registry namespace.	Extension	GA
az iot ops ns device endpoint inbound remove	Remove inbound endpoints from a device in a Device Registry namespace.	Extension	GA

az iot ops ns device endpoint inbound apply

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Apply an inbound endpoint to a device using a generalized connector-type approach.

The generalized apply command is schema-driven. For non-OPC UA connector types it looks up an existing connector template for the specified --connector-type, auto-resolves the endpoint version, and optionally validates --endpoint-config against the connector schema.

Schema validation of --endpoint-config is only performed when the connector's additionalConfigurationSchema uses JSON Schema Draft-07 (http://json-schema.org/draft-07/schema#). If the schema uses a different dialect, validation is skipped with a warning and the endpoint is still created.

OPC UA (Microsoft.OpcUa) is a special case: it does not use Akri connector templates. Its schema and version are derived from bundled metadata. The instance must have OPC UA enabled (feature.opcua.mode != Disabled).

Use --show-template to discover valid configuration fields before creating an endpoint.

az iot ops ns device endpoint inbound apply --connector-type --ct
                                            --instance
                                            --resource-group
                                            [--acquire-policy-token]
                                            [--address --endpoint-address]
                                            [--cert-ref --certificate-ref]
                                            [--change-reference]
                                            [--device]
                                            [--ec --endpoint-config]
                                            [--icr --intermediate-cert-ref]
                                            [--key-ref]
                                            [--name]
                                            [--no-replace {false, true}]
                                            [--pass-ref --password-ref]
                                            [--scc --skip-connector-check {false, true}]
                                            [--show-template {config, schema}]
                                            [--trust-list]
                                            [--user-ref --username-ref]
                                            [--version]

Examples

Discover default endpoint configuration template for an OPC UA connector

az iot ops ns device endpoint inbound apply --connector-type Microsoft.OpcUa --instance myInstance -g myInstanceResourceGroup --show-template config

Discover full schema template (with types and constraints) for an OPC UA connector

az iot ops ns device endpoint inbound apply --connector-type Microsoft.OpcUa --instance myInstance -g myInstanceResourceGroup --show-template schema

Apply a generalized OPC UA inbound endpoint using a JSON config file

az iot ops ns device endpoint inbound apply --device mydevice --name myOPCUAEndpoint --endpoint-address "opc.tcp://192.168.1.100:4840" --connector-type Microsoft.OpcUa --instance myInstance -g myInstanceResourceGroup --endpoint-config ./opcua-endpoint-config.json

Apply a generalized OPC UA inbound endpoint using a YAML config file

az iot ops ns device endpoint inbound apply --device mydevice --name myOPCUAEndpoint --endpoint-address "opc.tcp://192.168.1.100:4840" --connector-type Microsoft.OpcUa --instance myInstance -g myInstanceResourceGroup --endpoint-config ./opcua-endpoint-config.yaml

Apply a generalized OPC UA inbound endpoint using inline JSON with nested objects

az iot ops ns device endpoint inbound apply --device mydevice --name myOPCUAEndpoint --endpoint-address "opc.tcp://192.168.1.100:4840" --connector-type Microsoft.OpcUa --instance myInstance -g myInstanceResourceGroup --endpoint-config '{"applicationName":"line1-opcua-client","keepAliveMilliseconds":10000,"session":{"timeoutMilliseconds":60000,"reconnectPeriod":5000},"security":{"securityPolicy":"Basic256Sha256","securityMode":"SignAndEncrypt","autoAcceptUntrustedServerCertificates":true}}'

Apply a generalized ONVIF inbound endpoint using a config file with authentication

az iot ops ns device endpoint inbound apply --device mydevice --name myONVIFEndpoint --endpoint-address "http://192.168.1.100:8000/onvif/device_service" --connector-type Microsoft.Onvif --instance myInstance -g myInstanceResourceGroup --endpoint-config ./onvif-config.json --user-ref auth-secret/username --pass-ref auth-secret/password

Apply an inbound endpoint skipping connector template check (no schema validation, no version auto-resolution)

az iot ops ns device endpoint inbound apply --device mydevice --name myEndpoint --endpoint-address "opc.tcp://192.168.1.100:4840" --connector-type Microsoft.OpcUa --instance myInstance -g myInstanceResourceGroup --skip-connector-check

Apply an inbound endpoint but error if it already exists (prevent overwrite)

az iot ops ns device endpoint inbound apply --device mydevice --name myOPCUAEndpoint --endpoint-address "opc.tcp://192.168.1.100:4840" --connector-type Microsoft.OpcUa --instance myInstance -g myInstanceResourceGroup --no-replace

Required Parameters

--connector-type --ct

Connector type for the inbound endpoint (e.g. 'Microsoft.OpcUa', 'Microsoft.Onvif'). For all types except Microsoft.OpcUa, the matching connector template must exist in the instance unless --skip-connector-check is used.

--instance -i

The name of the Azure IoT Operations instance.

--resource-group -g

The resource group of the Azure IoT Operations instance.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--address --endpoint-address

Endpoint address to connect to. Required unless --show-template is used.

--cert-ref --certificate-ref

Reference for the certificate used in authentication. Supported by 1P types: OpcUa, REST, SSE, MQTT. Not supported by Media or Onvif. For custom connector types, depends on the connector implementation.

Property	Value
Parameter group:	Authentication Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--device -d

Device name. Required unless --show-template is used.

--ec --endpoint-config

Inline JSON string or path to a JSON/YAML file (.json, .yaml, .yml) containing connector-specific endpoint configuration. The template can be discovered with --show-template. When the connector schema uses JSON Schema Draft-07, the config is validated against it; other dialects are accepted but validation is skipped. Cannot be combined with --skip-connector-check.

--icr --intermediate-cert-ref

Intermediate certificates reference for certificate authentication. Supported by 1P types: OpcUa, REST, SSE, MQTT. Not supported by Media or Onvif. For custom connector types, depends on the connector implementation.

Property	Value
Parameter group:	Authentication Arguments

--key-ref

Private key reference for certificate authentication. Supported by 1P types: OpcUa, REST, SSE, MQTT. Not supported by Media or Onvif. For custom connector types, depends on the connector implementation.

Property	Value
Parameter group:	Authentication Arguments

--name -n

Endpoint name. Required unless --show-template is used.

--no-replace

Prevent replacing an existing endpoint with the same name. By default, apply upserts the endpoint.

Property	Value
Default value:	False
Accepted values:	false, true

--pass-ref --password-ref

Reference for the password used in authentication. Supported by all 1P connector types.

Property	Value
Parameter group:	Authentication Arguments

--scc --skip-connector-check

Skip validation that a connector template exists for the connector type. The endpoint version will not be auto-resolved and no schema validation is performed. Cannot be combined with --endpoint-config.

Property	Value
Default value:	False
Accepted values:	false, true

--show-template

Show a starter configuration template for the connector type and exit without creating an endpoint. config: fields shown with their default values (null if no default); output is directly usable as --endpoint-config input. oneOf fields with multiple variants collapse to the first non-null variant and emit a warning — run with schema mode to see all options. allOf fields merge all non-null sub-schemas into one flat object. schema: every field includes type, default, and constraints (min, max, enum, pattern); oneOf/allOf fields show all variants so you can inspect the full schema. Draft-07 $ref pointers (#/definitions/...) are resolved inline in both modes.

Property	Value
Accepted values:	config, schema

--trust-list

List of trusted certificates for the endpoint. Supported by 1P types: OpcUa, REST, SSE, MQTT. Not supported by Media or Onvif. For custom connector types, depends on the connector implementation.

--user-ref --username-ref

Reference for the username used in authentication. Supported by all 1P connector types.

Property	Value
Parameter group:	Authentication Arguments

--version

Endpoint version. If not provided, the version is automatically retrieved from the connector template matching this endpoint type (if one exists). The endpoint version is required for connector pods to be created - without it, devices will not have associated connector pods even if a connector template is deployed.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az iot ops ns device endpoint inbound list

List inbound endpoints of a device in a Device Registry namespace.

az iot ops ns device endpoint inbound list --device
                                           --instance
                                           --resource-group
                                           [--endpoint-type --et]

Examples

List all inbound endpoints of a device

az iot ops ns device endpoint inbound list --device mydevice --instance myInstance -g myInstanceResourceGroup

List all Media endpoints of a device using a keyword

az iot ops ns device endpoint inbound list --device mydevice --instance myInstance -g myInstanceResourceGroup --endpoint-type media

List all Media endpoints of a device using the full endpoint type

az iot ops ns device endpoint inbound list --device mydevice --instance myInstance -g myInstanceResourceGroup --endpoint-type Microsoft.Media

Required Parameters

--device -d

Device name.

--instance -i

The name of the Azure IoT Operations instance.

--resource-group -g

The resource group of the Azure IoT Operations instance.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--endpoint-type --et

Filter inbound endpoints by type. Both full endpoint name Microsoft.OpcUa and short name opcua are supported.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az iot ops ns device endpoint inbound remove

Remove inbound endpoints from a device in a Device Registry namespace.

az iot ops ns device endpoint inbound remove --device
                                             --endpoint
                                             --instance
                                             --resource-group
                                             [--acquire-policy-token]
                                             [--change-reference]
                                             [--yes {false, true}]

Examples

Remove a single inbound endpoint from a device

az iot ops ns device endpoint inbound remove --device mydevice --instance myInstance -g myInstanceResourceGroup --endpoint myEndpoint

Remove multiple inbound endpoints from a device

az iot ops ns device endpoint inbound remove --device mydevice --instance myInstance -g myInstanceResourceGroup --endpoint myEndpoint1 myEndpoint2

Required Parameters

--device -d

Device name.

--endpoint

Space-separated list of endpoint names to remove from the device.

--instance -i

The name of the Azure IoT Operations instance.

--resource-group -g

The resource group of the Azure IoT Operations instance.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--yes -y

Confirm [y]es without a prompt. Useful for CI and automation scenarios.

Property	Value
Default value:	False
Accepted values:	false, true

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

Feedback

Was this page helpful?