az iot ops ns device endpoint inbound add

Preview

Note

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

Command group 'iot ops ns' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Add inbound endpoints to devices in Device Registry namespaces.

Commands

Name	Description	Type	Status
az iot ops ns device endpoint inbound add custom	Add a custom inbound endpoint to a device in a Device Registry namespace.	Extension	Preview
az iot ops ns device endpoint inbound add media	Add a media inbound endpoint to a device in a Device Registry namespace.	Extension	Preview
az iot ops ns device endpoint inbound add onvif	Add an ONVIF inbound endpoint to a device in a Device Registry namespace.	Extension	Preview
az iot ops ns device endpoint inbound add opcua	Add an OPC UA inbound endpoint to a device in a Device Registry namespace.	Extension	Preview
az iot ops ns device endpoint inbound add rest	Add a rest inbound endpoint to a device in a Device Registry namespace.	Extension	Preview

az iot ops ns device endpoint inbound add custom

Preview

Command group 'iot ops ns' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Add a custom inbound endpoint to a device in a Device Registry namespace.

Custom endpoints allow you to define your own endpoint type and configuration.

az iot ops ns device endpoint inbound add custom --address --endpoint-address
                                                 --device
                                                 --endpoint-type --type
                                                 --instance
                                                 --name
                                                 --resource-group
                                                 [--additional-config --config]
                                                 [--cert-ref --certificate-ref]
                                                 [--icr --intermediate-cert-ref]
                                                 [--key-ref]
                                                 [--pass-ref --password-ref]
                                                 [--replace {false, true}]
                                                 [--trust-list]
                                                 [--user-ref --username-ref]
                                                 [--version]

Examples

Add a basic custom endpoint to a device

az iot ops ns device endpoint inbound add custom --device mydevice --instance myInstance -g myInstanceResourceGroup --name myCustomEndpoint --endpoint-type "Custom.Type" --endpoint-address "192.168.1.100:8080"

Add a custom endpoint with authentication

az iot ops ns device endpoint inbound add custom --device mydevice --instance myInstance -g myInstanceResourceGroup --name myCustomEndpoint --endpoint-type "Custom.Type" --endpoint-address "192.168.1.100:8080" --user-ref auth-secret/username --pass-ref auth-secret/password

Add a custom endpoint with certificate authentication and a version

az iot ops ns device endpoint inbound add custom --device mydevice --instance myInstance -g myInstanceResourceGroup --name myCustomEndpoint --endpoint-type "Custom.Type" --endpoint-address "192.168.1.100:8080" --cert-ref cert-secret/certificate --version "1.0"

Add a custom endpoint with enhanced certificate authentication including private key

az iot ops ns device endpoint inbound add custom --device mydevice --instance myInstance -g myInstanceResourceGroup --name myCustomEndpoint --endpoint-type "Custom.Type" --endpoint-address "192.168.1.100:8080" --cert-ref cert-secret/certificate --key-ref cert-secret/privateKey

Add a custom endpoint with certificate authentication including intermediate certificates

az iot ops ns device endpoint inbound add custom --device mydevice --instance myInstance -g myInstanceResourceGroup --name myCustomEndpoint --endpoint-type "Custom.Type" --endpoint-address "192.168.1.100:8080" --cert-ref cert-secret/certificate --icr cert-secret/intermediateCerts

Add a custom endpoint with full certificate chain authentication

az iot ops ns device endpoint inbound add custom --device mydevice --instance myInstance -g myInstanceResourceGroup --name myCustomEndpoint --endpoint-type "Custom.Type" --endpoint-address "192.168.1.100:8080" --cert-ref cert-secret/certificate --key-ref cert-secret/privateKey --icr cert-secret/intermediateCerts

Add a custom endpoint with additional configuration

az iot ops ns device endpoint inbound add custom --device mydevice --instance myInstance -g myInstanceResourceGroup --name myCustomEndpoint --endpoint-type "Custom.Type" --endpoint-address "192.168.1.100:8080" --additional-config "{\"customSetting\": \"value\"}"

Required Parameters

--address --endpoint-address

Endpoint address to connect to.

--device -d

Device name.

--endpoint-type --type

Type of the custom endpoint.

--instance -i

The name of the Azure IoT Operations instance.

--name -n

Endpoint name.

--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.

--additional-config --config

Additional configuration for the custom endpoint in JSON format.

--cert-ref --certificate-ref

Reference for the certificate used in authentication.

Property	Value
Parameter group:	Authentication Arguments

--icr --intermediate-cert-ref

Intermediate certificates reference for certificate authentication.

Property	Value
Parameter group:	Authentication Arguments

--key-ref

Private key reference for certificate authentication.

Property	Value
Parameter group:	Authentication Arguments

--pass-ref --password-ref

Reference for the password used in authentication.

Property	Value
Parameter group:	Authentication Arguments

--replace

Replace the endpoint if another endpoint with the same name is present already.

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

--trust-list

List of trusted certificates for the endpoint.

--user-ref --username-ref

Reference for the username used in authentication.

Property	Value
Parameter group:	Authentication Arguments

--version

Endpoint version.

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 add media

Preview

Command group 'iot ops ns' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Add a media inbound endpoint to a device in a Device Registry namespace.

For more information on media connectors, please see https://aka.ms/aio-media-quickstart.

az iot ops ns device endpoint inbound add media --address --endpoint-address
                                                --device
                                                --instance
                                                --name
                                                --resource-group
                                                [--pass-ref --password-ref]
                                                [--replace {false, true}]
                                                [--user-ref --username-ref]
                                                [--version]

Examples

Add a basic media endpoint to a device

az iot ops ns device endpoint inbound add media --device mydevice --instance myInstance -g myInstanceResourceGroup --name myCameraEndpoint --endpoint-address "rtsp://192.168.1.100:554/stream"

Add a media endpoint with authentication

az iot ops ns device endpoint inbound add media --device mydevice --instance myInstance -g myInstanceResourceGroup --name myCameraEndpoint --endpoint-address "rtsp://192.168.1.100:554/stream" --user-ref auth-secret/username --pass-ref auth-secret/password

Required Parameters

--address --endpoint-address

Endpoint address to connect to.

--device -d

Device name.

--instance -i

The name of the Azure IoT Operations instance.

--name -n

Endpoint name.

--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.

--pass-ref --password-ref

Reference for the password used in authentication.

Property	Value
Parameter group:	Authentication Arguments

--replace

Replace the endpoint if another endpoint with the same name is present already.

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

--user-ref --username-ref

Reference for the username used in authentication.

Property	Value
Parameter group:	Authentication Arguments

--version

Endpoint version.

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 add onvif

Preview

Command group 'iot ops ns' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Add an ONVIF inbound endpoint to a device in a Device Registry namespace.

For more information on ONVIF connectors, please see https://aka.ms/aio-onvif-quickstart.

az iot ops ns device endpoint inbound add onvif --address --endpoint-address
                                                --device
                                                --instance
                                                --name
                                                --resource-group
                                                [--accept-invalid-certificates --aic {false, true}]
                                                [--accept-invalid-hostnames --aih {false, true}]
                                                [--pass-ref --password-ref]
                                                [--replace {false, true}]
                                                [--user-ref --username-ref]
                                                [--version]

Examples

Add a basic ONVIF endpoint to a device

az iot ops ns device endpoint inbound add onvif --device mydevice --instance myInstance -g myInstanceResourceGroup --name myONVIFEndpoint --endpoint-address "http://192.168.1.100:8000/onvif/device_service"

Add an ONVIF endpoint with authentication

az iot ops ns device endpoint inbound add onvif --device mydevice --instance myInstance -g myInstanceResourceGroup --name myONVIFEndpoint --endpoint-address "http://192.168.1.100:8000/onvif/device_service" --user-ref auth-secret/username --pass-ref auth-secret/password

Add an ONVIF endpoint that accepts invalid hostnames and certificates

az iot ops ns device endpoint inbound add onvif --device mydevice --instance myInstance -g myInstanceResourceGroup --name myONVIFEndpoint --endpoint-address "https://192.168.1.100:8000/onvif/device_service" --accept-invalid-hostnames --accept-invalid-certificates

Required Parameters

--address --endpoint-address

Endpoint address to connect to.

--device -d

Device name.

--instance -i

The name of the Azure IoT Operations instance.

--name -n

Endpoint name.

--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.

--accept-invalid-certificates --aic

Accept invalid certificates.

Property	Value
Parameter group:	ONVIF Configuration Arguments
Default value:	False
Accepted values:	false, true

--accept-invalid-hostnames --aih

Accept invalid hostnames in certificates.

Property	Value
Parameter group:	ONVIF Configuration Arguments
Default value:	False
Accepted values:	false, true

--pass-ref --password-ref

Reference for the password used in authentication.

Property	Value
Parameter group:	Authentication Arguments

--replace

Replace the endpoint if another endpoint with the same name is present already.

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

--user-ref --username-ref

Reference for the username used in authentication.

Property	Value
Parameter group:	Authentication Arguments

--version

Endpoint version.

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 add opcua

Preview

Command group 'iot ops ns' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Add an OPC UA inbound endpoint to a device in a Device Registry namespace.

For more information on OPC UA connectors, please see https://aka.ms/aio-opcua-quickstart.

az iot ops ns device endpoint inbound add opcua --address --endpoint-address
                                                --device
                                                --instance
                                                --name
                                                --resource-group
                                                [--ac --accept-certs {false, true}]
                                                [--ad --run-asset-discovery {false, true}]
                                                [--app --application-name]
                                                [--keep-alive]
                                                [--key-frame-count --kfc]
                                                [--pass-ref --password-ref]
                                                [--pi --publishing-interval]
                                                [--qs --queue-size]
                                                [--replace {false, true}]
                                                [--sampling-interval --si]
                                                [--sbo --session-backoff]
                                                [--security-mode --sm {none, sign, signAndEncrypt}]
                                                [--security-policy --sp {Aes128_Sha256_RsaOaep, Aes256_Sha256_RsaPss, Basic128Rsa15, Basic256, Basic256Sha256, None}]
                                                [--session-keep-alive --ska]
                                                [--session-reconnect --srp]
                                                [--session-timeout]
                                                [--session-tracing --str {false, true}]
                                                [--slt --subscription-lifetime]
                                                [--smi --subscription-max-items]
                                                [--user-ref --username-ref]
                                                [--version]

Examples

Add a basic OPC UA endpoint to a device

az iot ops ns device endpoint inbound add opcua --device mydevice --instance myInstance -g myInstanceResourceGroup --name myOPCUAEndpoint --endpoint-address "opc.tcp://192.168.1.100:4840"

Add an OPC UA endpoint with authentication

az iot ops ns device endpoint inbound add opcua --device mydevice --instance myInstance -g myInstanceResourceGroup --name myOPCUAEndpoint --endpoint-address "opc.tcp://192.168.1.100:4840" --user-ref auth-secret/username --pass-ref auth-secret/password

Add an OPC UA endpoint with a custom application name

az iot ops ns device endpoint inbound add opcua --device mydevice --instance myInstance -g myInstanceResourceGroup --name myOPCUAEndpoint --endpoint-address "opc.tcp://192.168.1.100:4840" --application-name "My OPC UA App"

Add an OPC UA endpoint with customized session parameters

az iot ops ns device endpoint inbound add opcua --device mydevice --instance myInstance -g myInstanceResourceGroup --name myOPCUAEndpoint --endpoint-address "opc.tcp://192.168.1.100:4840" --keep-alive 15000 --session-timeout 90000 --publishing-interval 2000 --sampling-interval 1500

Add an OPC UA endpoint with security settings and asset discovery enabled

az iot ops ns device endpoint inbound add opcua --device mydevice --instance myInstance -g myInstanceResourceGroup --name myOPCUAEndpoint --endpoint-address "opc.tcp://192.168.1.100:4840" --security-policy "Basic256Sha256" --security-mode "SignAndEncrypt" --run-asset-discovery

Required Parameters

--address --endpoint-address

Endpoint address to connect to.

--device -d

Device name.

--instance -i

The name of the Azure IoT Operations instance.

--name -n

Endpoint name.

--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.

--ac --accept-certs

Auto accept untrusted server certificates.

Property	Value
Parameter group:	Security Arguments
Default value:	False
Accepted values:	false, true

--ad --run-asset-discovery

Enable asset discovery after connecting to the endpoint.

Property	Value
Parameter group:	Configuration Arguments
Default value:	False
Accepted values:	false, true

--app --application-name

Application name for the OPC UA client.

Property	Value
Parameter group:	Configuration Arguments
Default value:	OPC UA Broker

--keep-alive

Keep alive time in milliseconds.

Property	Value
Parameter group:	Configuration Arguments
Default value:	10000

--key-frame-count --kfc

Key frame count.

Property	Value
Parameter group:	Configuration Arguments
Default value:	0

--pass-ref --password-ref

Reference for the password used in authentication.

Property	Value
Parameter group:	Authentication Arguments

--pi --publishing-interval

Publishing interval in milliseconds.

Property	Value
Parameter group:	Configuration Arguments
Default value:	1000

--qs --queue-size

Queue size.

Property	Value
Parameter group:	Configuration Arguments
Default value:	1

--replace

Replace the endpoint if another endpoint with the same name is present already.

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

--sampling-interval --si

Sampling interval in milliseconds.

Property	Value
Parameter group:	Configuration Arguments
Default value:	1000

--sbo --session-backoff

Session reconnect exponential backoff in milliseconds.

Property	Value
Parameter group:	Session Arguments
Default value:	10000

--security-mode --sm

Security mode to use for the connection.

Property	Value
Parameter group:	Security Arguments
Accepted values:	none, sign, signAndEncrypt

--security-policy --sp

Security policy to use for the connection.

Property	Value
Parameter group:	Security Arguments
Accepted values:	Aes128_Sha256_RsaOaep, Aes256_Sha256_RsaPss, Basic128Rsa15, Basic256, Basic256Sha256, None

--session-keep-alive --ska

Session keep alive interval in milliseconds.

Property	Value
Parameter group:	Session Arguments
Default value:	10000

--session-reconnect --srp

Session reconnect period in milliseconds.

Property	Value
Parameter group:	Session Arguments
Default value:	2000

--session-timeout

Session timeout in milliseconds.

Property	Value
Parameter group:	Session Arguments
Default value:	60000

--session-tracing --str

Enable tracing headers for the session.

Property	Value
Parameter group:	Session Arguments
Default value:	False
Accepted values:	false, true

--slt --subscription-lifetime

Subscription lifetime in milliseconds.

Property	Value
Parameter group:	Subscription Arguments
Default value:	60000

--smi --subscription-max-items

Maximum number of items in subscription.

Property	Value
Parameter group:	Subscription Arguments
Default value:	1000

--user-ref --username-ref

Reference for the username used in authentication.

Property	Value
Parameter group:	Authentication Arguments

--version

Endpoint version.

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 add rest

Preview

Command group 'iot ops ns' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Add a rest inbound endpoint to a device in a Device Registry namespace.

az iot ops ns device endpoint inbound add rest --address --endpoint-address
                                               --device
                                               --instance
                                               --name
                                               --resource-group
                                               [--cert-ref --certificate-ref]
                                               [--icr --intermediate-cert-ref]
                                               [--key-ref]
                                               [--pass-ref --password-ref]
                                               [--replace {false, true}]
                                               [--user-ref --username-ref]
                                               [--version]

Examples

Add a basic rest endpoint to a device

az iot ops ns device endpoint inbound add rest --device mydevice --instance myInstance -g myInstanceResourceGroup --name myEndpoint --endpoint-address "https://api.example.com/data"

Add a rest endpoint with authentication

az iot ops ns device endpoint inbound add rest --device mydevice --instance myInstance -g myInstanceResourceGroup --name myEndpoint --endpoint-address "https://api.example.com/data" --user-ref auth-secret/username --pass-ref auth-secret/password

Add a rest endpoint with certificate authentication

az iot ops ns device endpoint inbound add rest --device mydevice --instance myInstance -g myInstanceResourceGroup --name myEndpoint --endpoint-address "https://api.example.com/data" --cert-ref cert-secret/certificate

Add a rest endpoint with enhanced certificate authentication including private key

az iot ops ns device endpoint inbound add rest --device mydevice --instance myInstance -g myInstanceResourceGroup --name myEndpoint --endpoint-address "https://api.example.com/data" --cert-ref cert-secret/certificate --key-ref cert-secret/privateKey

Add a rest endpoint with certificate authentication including intermediate certificates

az iot ops ns device endpoint inbound add rest --device mydevice --instance myInstance -g myInstanceResourceGroup --name myEndpoint --endpoint-address "https://api.example.com/data" --cert-ref cert-secret/certificate --icr cert-secret/intermediateCerts

Add a rest endpoint with full certificate chain authentication

az iot ops ns device endpoint inbound add rest --device mydevice --instance myInstance -g myInstanceResourceGroup --name myEndpoint --endpoint-address "https://api.example.com/data" --cert-ref cert-secret/certificate --key-ref cert-secret/privateKey --icr cert-secret/intermediateCerts

Required Parameters

--address --endpoint-address

Endpoint address to connect to.

--device -d

Device name.

--instance -i

The name of the Azure IoT Operations instance.

--name -n

Endpoint name.

--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.

--cert-ref --certificate-ref

Reference for the certificate used in authentication.

Property	Value
Parameter group:	Authentication Arguments

--icr --intermediate-cert-ref

Intermediate certificates reference for certificate authentication.

Property	Value
Parameter group:	Authentication Arguments

--key-ref

Private key reference for certificate authentication.

Property	Value
Parameter group:	Authentication Arguments

--pass-ref --password-ref

Reference for the password used in authentication.

Property	Value
Parameter group:	Authentication Arguments

--replace

Replace the endpoint if another endpoint with the same name is present already.

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

--user-ref --username-ref

Reference for the username used in authentication.

Property	Value
Parameter group:	Authentication Arguments

--version

Endpoint version.

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?

Share via

az iot ops ns device endpoint inbound add

Commands

az iot ops ns device endpoint inbound add custom

Examples

Required Parameters

Optional Parameters

az iot ops ns device endpoint inbound add media

Examples

Required Parameters

Optional Parameters

az iot ops ns device endpoint inbound add onvif

Examples

Required Parameters

Optional Parameters

az iot ops ns device endpoint inbound add opcua

Examples

Required Parameters

Optional Parameters

az iot ops ns device endpoint inbound add rest

Examples

Required Parameters

Optional Parameters

Feedback