az iot ops ns device endpoint inbound

Note

Questo riferimento fa parte dell'estensione azure-iot-ops per l'interfaccia della riga di comando di Azure (versione 2.70.0 o successiva). L'estensione installerà automaticamente la prima volta che si esegue un comando az iot ops ns device endpoint inbound . Altre informazioni sulle estensioni.

Gestire gli endpoint in ingresso per i dispositivi negli spazi dei nomi del Registro di sistema dei dispositivi.

Gli endpoint in ingresso definiscono i canali di comunicazione dal dispositivo alla piattaforma IoT Ops.

Comandi

Nome Descrizione Tipo Status
az iot ops ns device endpoint inbound add

Aggiungere un endpoint in ingresso specifico del tipo a un dispositivo in uno spazio dei nomi del Registro di sistema dispositivi.

Extension GA
az iot ops ns device endpoint inbound add custom

Aggiungere un endpoint in ingresso personalizzato a un dispositivo in uno spazio dei nomi del Registro di sistema dispositivi.

Extension GA
az iot ops ns device endpoint inbound add media

Aggiungere un endpoint in ingresso multimediale a un dispositivo in uno spazio dei nomi del Registro dispositivi.

Extension GA
az iot ops ns device endpoint inbound add mqtt

Aggiungere un endpoint in ingresso MQTT a un dispositivo in uno spazio dei nomi del Registro di sistema dispositivi.

Extension GA
az iot ops ns device endpoint inbound add onvif

Aggiungere un endpoint in ingresso ONVIF a un dispositivo in uno spazio dei nomi del Registro di sistema dispositivi.

Extension GA
az iot ops ns device endpoint inbound add opcua

Aggiungere un endpoint in ingresso OPC UA a un dispositivo in uno spazio dei nomi del Registro di sistema dispositivi.

Extension GA
az iot ops ns device endpoint inbound add rest

Aggiungere un endpoint in ingresso inattivo a un dispositivo in uno spazio dei nomi del Registro di sistema dispositivi.

Extension GA
az iot ops ns device endpoint inbound add sse

Aggiungere un endpoint in ingresso SSE a un dispositivo in uno spazio dei nomi del Registro di sistema dispositivi.

Extension GA
az iot ops ns device endpoint inbound apply

Applicare un endpoint in ingresso a un dispositivo usando un approccio di tipo connettore generalizzato.

Extension Anteprima
az iot ops ns device endpoint inbound list

Elencare gli endpoint in ingresso di un dispositivo in uno spazio dei nomi del Registro di sistema dispositivi.

Extension GA
az iot ops ns device endpoint inbound remove

Rimuovere gli endpoint in ingresso da un dispositivo in uno spazio dei nomi del Registro di sistema dispositivi.

Extension GA

az iot ops ns device endpoint inbound apply

Anteprima

Questo comando è in anteprima e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

Applicare un endpoint in ingresso a un dispositivo usando un approccio di tipo connettore generalizzato.

Il comando apply generalizzato è basato sullo schema. Per i tipi di connettore non OPC UA cerca un modello di connettore esistente per il tipo --connector-specificato, risolve automaticamente la versione dell'endpoint e, facoltativamente, convalida --endpoint-config sullo schema del connettore.

La convalida dello schema di --endpoint-config viene eseguita solo quando l'elemento additionalConfigurationSchema del connettore usa JSON Schema Draft-07 (http://json-schema.org/draft-07/schema#). Se lo schema usa un dialetto diverso, la convalida viene ignorata con un avviso e l'endpoint viene comunque creato.

OPC UA (Microsoft. OpcUa) è un caso speciale: non usa modelli di connettore Akri. Lo schema e la versione sono derivati dai metadati in bundle. L'istanza deve avere OPC UA abilitato (feature.opcua.mode != Disabilitato).

Usare --show-template per individuare campi di configurazione validi prima di creare un 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]

Esempio

Individuare il modello di configurazione dell'endpoint predefinito per un connettore OPC UA

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

Individuare un modello di schema completo (con tipi e vincoli) per un connettore OPC UA

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

Applicare un endpoint in ingresso OPC UA generalizzato usando un file di configurazione JSON

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

Applicare un endpoint in ingresso OPC UA generalizzato usando un file di configurazione YAML

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

Applicare un endpoint in ingresso OPC UA generalizzato usando JSON inline con oggetti annidati

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}}'

Applicare un endpoint in ingresso ONVIF generalizzato usando un file di configurazione con l'autenticazione

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

Applicare un controllo del modello di connettore per l'endpoint in ingresso (nessuna convalida dello schema, nessuna risoluzione automatica della versione)

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

Applicare un endpoint in ingresso ma un errore se esiste già (impedire la sovrascrittura)

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

Parametri necessari

--connector-type --ct

Tipo di connettore per l'endpoint in ingresso ,ad esempio 'Microsoft. OpcUa', 'Microsoft. Onvif'). Per tutti i tipi tranne Microsoft. OpcUa, il modello di connettore corrispondente deve esistere nell'istanza a meno che non venga usato --skip-connector-check.

--instance -i

Nome dell'istanza di Operazioni di Azure IoT.

--resource-group -g

Gruppo di risorse dell'istanza di Operazioni di Azure IoT.

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--address --endpoint-address

Indirizzo endpoint a cui connettersi. Obbligatorio a meno che non venga usato --show-template.

--cert-ref --certificate-ref

Riferimento per il certificato usato nell'autenticazione. Supportato dai tipi 1P: OpcUa, REST, SSE, MQTT. Non supportato da Supporti o Onvif. Per i tipi di connettore personalizzati, dipende dall'implementazione del connettore.

Proprietà Valore
Gruppo di parametri: Authentication Arguments
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--device -d

Nome dispositivo. Obbligatorio a meno che non venga usato --show-template.

--ec --endpoint-config

Stringa JSON inline o percorso di un file JSON/YAML (.json, yaml, .yml) contenente la configurazione dell'endpoint specifica del connettore. Il modello può essere individuato con --show-template. Quando lo schema del connettore usa JSON Schema Draft-07, la configurazione viene convalidata in base a essa; altri dialetti vengono accettati, ma la convalida viene ignorata. Non può essere combinato con --skip-connector-check.

--icr --intermediate-cert-ref

Informazioni di riferimento intermedie su certificati per l'autenticazione del certificato. Supportato dai tipi 1P: OpcUa, REST, SSE, MQTT. Non supportato da Supporti o Onvif. Per i tipi di connettore personalizzati, dipende dall'implementazione del connettore.

Proprietà Valore
Gruppo di parametri: Authentication Arguments
--key-ref

Informazioni di riferimento sulla chiave privata per l'autenticazione del certificato. Supportato dai tipi 1P: OpcUa, REST, SSE, MQTT. Non supportato da Supporti o Onvif. Per i tipi di connettore personalizzati, dipende dall'implementazione del connettore.

Proprietà Valore
Gruppo di parametri: Authentication Arguments
--name -n

Nome endpoint. Obbligatorio a meno che non venga usato --show-template.

--no-replace

Impedire di sostituire un endpoint esistente con lo stesso nome. Per impostazione predefinita, applicare upserts all'endpoint.

Proprietà Valore
Valore predefinito: False
Valori accettati: false, true
--pass-ref --password-ref

Informazioni di riferimento sulla password usata nell'autenticazione. Supportato da tutti i tipi di connettore 1P.

Proprietà Valore
Gruppo di parametri: Authentication Arguments
--scc --skip-connector-check

Ignorare la convalida dell'esistenza di un modello di connettore per il tipo di connettore. La versione dell'endpoint non verrà risolta automaticamente e non verrà eseguita alcuna convalida dello schema. Non può essere combinato con --endpoint-config.

Proprietà Valore
Valore predefinito: False
Valori accettati: false, true
--show-template

Visualizzare un modello di configurazione iniziale per il tipo di connettore e uscire senza creare un endpoint. config: campi visualizzati con i relativi valori predefiniti (null se nessun valore predefinito); l'output è utilizzabile direttamente come input --endpoint-config. i campi oneOf con più varianti comprimono la prima variante non Null e generano un avviso, eseguito con la modalità schema per visualizzare tutte le opzioni. tutti i campi allOf uniscono tutti gli schemi secondari non Null in un unico oggetto flat. schema: ogni campo include tipo, impostazione predefinita e vincoli (min, max, enum, pattern); I campi oneOf/allOf mostrano tutte le varianti in modo da poter esaminare lo schema completo. Draft-07 $ref puntatori (#/definitions/...) vengono risolti inline in entrambe le modalità.

Proprietà Valore
Valori accettati: config, schema
--trust-list

Elenco di certificati attendibili per l'endpoint. Supportato dai tipi 1P: OpcUa, REST, SSE, MQTT. Non supportato da Supporti o Onvif. Per i tipi di connettore personalizzati, dipende dall'implementazione del connettore.

--user-ref --username-ref

Riferimento per il nome utente usato nell'autenticazione. Supportato da tutti i tipi di connettore 1P.

Proprietà Valore
Gruppo di parametri: Authentication Arguments
--version

Versione dell'endpoint. Se non specificato, la versione viene recuperata automaticamente dal modello di connettore corrispondente a questo tipo di endpoint (se presente). La versione dell'endpoint è necessaria per la creazione dei pod del connettore, senza di essa, i dispositivi non avranno pod connettore associati anche se viene distribuito un modello di connettore.

Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az iot ops ns device endpoint inbound list

Elencare gli endpoint in ingresso di un dispositivo in uno spazio dei nomi del Registro di sistema dispositivi.

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

Esempio

Elencare tutti gli endpoint in ingresso di un dispositivo

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

Elencare tutti gli endpoint multimediali di un dispositivo usando una parola chiave

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

Elencare tutti gli endpoint multimediali di un dispositivo usando il tipo di endpoint completo

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

Parametri necessari

--device -d

Nome dispositivo.

--instance -i

Nome dell'istanza di Operazioni di Azure IoT.

--resource-group -g

Gruppo di risorse dell'istanza di Operazioni di Azure IoT.

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--endpoint-type --et

Filtrare gli endpoint in ingresso per tipo. Sono supportati sia il nome completo dell'endpoint Microsoft.OpcUa che il nome breve opcua.

Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az iot ops ns device endpoint inbound remove

Rimuovere gli endpoint in ingresso da un dispositivo in uno spazio dei nomi del Registro di sistema dispositivi.

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

Esempio

Rimuovere un singolo endpoint in ingresso da un dispositivo

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

Rimuovere più endpoint in ingresso da un dispositivo

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

Parametri necessari

--device -d

Nome dispositivo.

--endpoint

Elenco delimitato da spazi di nomi di endpoint da rimuovere dal dispositivo.

--instance -i

Nome dell'istanza di Operazioni di Azure IoT.

--resource-group -g

Gruppo di risorse dell'istanza di Operazioni di Azure IoT.

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--yes -y

Confermare [y]es senza una richiesta. Utile per scenari di integrazione continua e automazione.

Proprietà Valore
Valore predefinito: False
Valori accettati: false, true
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False