Share via


az iot ops

Kommentar

Den här referensen är en del av azure-iot-ops-tillägget för Azure CLI (version 2.46.0 eller senare). Tillägget installeras automatiskt första gången du kör kommandot az iot ops . Läs mer om tillägg.

Den här kommandogruppen är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Hantera Azure IoT-åtgärder.

Azure IoT Operations är en uppsättning mycket anpassade, men löst kopplade Kubernetes-tjänster från första part som gör att du kan aggregera data från lokala tillgångar till en MQTT Broker i industriell kvalitet, lägga till edge-beräkning och konfigurera dubbelriktade dataflöden med en mängd olika tjänster i molnet.

Som standard kontrollerar CLI-kommandon för IoT Operations regelbundet om en ny tilläggsversion är tillgänglig. Det här beteendet kan inaktiveras med az config set iotops.check_latest=false.

Kommandon

Name Description Typ Status
az iot ops asset

Hantera tillgångar.

Anknytning Förhandsversion
az iot ops asset create

Skapa en tillgång.

Anknytning Förhandsversion
az iot ops asset data-point

Hantera datapunkter i en tillgång.

Anknytning Förhandsversion
az iot ops asset data-point add

Lägg till en datapunkt i en tillgång.

Anknytning Förhandsversion
az iot ops asset data-point export

Exportera datapunkter i en tillgång.

Anknytning Förhandsversion
az iot ops asset data-point import

Importera datapunkter i en tillgång.

Anknytning Förhandsversion
az iot ops asset data-point list

Visa en lista över datapunkter i en tillgång.

Anknytning Förhandsversion
az iot ops asset data-point remove

Ta bort en datapunkt i en tillgång.

Anknytning Förhandsversion
az iot ops asset delete

Ta bort en tillgång.

Anknytning Förhandsversion
az iot ops asset endpoint

Hantera tillgångsslutpunktsprofiler.

Anknytning Förhandsversion
az iot ops asset endpoint certificate

Hantera ägda certifikat i en tillgångsslutpunkt.

Anknytning Förhandsversion
az iot ops asset endpoint certificate add

Lägg till ett ägt certifikat till en tillgångsslutpunkt.

Anknytning Förhandsversion
az iot ops asset endpoint certificate list

Visa en lista över ägda certifikat i en tillgångsslutpunkt.

Anknytning Förhandsversion
az iot ops asset endpoint certificate remove

Ta bort ett ägt certifikat i en tillgångsslutpunkt.

Anknytning Förhandsversion
az iot ops asset endpoint create

Skapa en tillgångsslutpunkt.

Anknytning Förhandsversion
az iot ops asset endpoint delete

Ta bort en tillgångsslutpunkt.

Anknytning Förhandsversion
az iot ops asset endpoint query

Fråga Resource Graph efter tillgångsslutpunkter.

Anknytning Förhandsversion
az iot ops asset endpoint show

Visa en tillgångsslutpunkt.

Anknytning Förhandsversion
az iot ops asset endpoint update

Uppdatera en tillgångsslutpunkt.

Anknytning Förhandsversion
az iot ops asset event

Hantera händelser i en tillgång.

Anknytning Förhandsversion
az iot ops asset event add

Lägg till en händelse i en tillgång.

Anknytning Förhandsversion
az iot ops asset event export

Exportera händelser i en tillgång.

Anknytning Förhandsversion
az iot ops asset event import

Importera händelser i en tillgång.

Anknytning Förhandsversion
az iot ops asset event list

Visa en lista över händelser i en tillgång.

Anknytning Förhandsversion
az iot ops asset event remove

Ta bort en händelse i en tillgång.

Anknytning Förhandsversion
az iot ops asset query

Fråga Resursdiagrammet efter tillgångar.

Anknytning Förhandsversion
az iot ops asset show

Visa en tillgång.

Anknytning Förhandsversion
az iot ops asset update

Uppdatera en tillgång.

Anknytning Förhandsversion
az iot ops check

Utvärdera körningshälsan på klustersidan för distribuerade IoT Operations-tjänster.

Anknytning Förhandsversion
az iot ops init

Bootstrap, konfigurera och distribuera IoT-åtgärder till målbågsaktiverat kluster.

Anknytning Förhandsversion
az iot ops mq

MQ-specifika verktyg.

Anknytning Förhandsversion
az iot ops mq get-password-hash

Genererar en PBKDF2-hash av lösenfrasen som tillämpar PBKDF2-HMAC-SHA512. Ett 128-bitars salt används från os.urandom.

Anknytning Förhandsversion
az iot ops mq stats

Visa dmqtt-körningsstatistik.

Anknytning Förhandsversion
az iot ops support

IoT Operations stöder kommandoutrymme.

Anknytning Förhandsversion
az iot ops support create-bundle

Skapar ett zip-arkiv för standardsupportpaket för användning i felsökning och diagnostik.

Anknytning Förhandsversion
az iot ops verify-host

Kör en uppsättning klustervärdverifieringar för IoT Operations-distributionskompatibilitet.

Anknytning Förhandsversion

az iot ops check

Förhandsgranskning

Kommandogruppen "iot ops" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Utvärdera körningshälsan på klustersidan för distribuerade IoT Operations-tjänster.

Kommandot visar som standard en människovänlig sammanfattningsvy över den valda tjänsten. Mer information kan begäras via --detail-level.

{Tjänst-API:er som stöds}

  • akri.sh/[v0]
  • dataprocessor.iotoperations.azure.com/[v1]
  • deviceregistry.microsoft.com/[v1beta1]
  • layerednetworkmgmt.iotoperations.azure.com/[v1beta1]
  • mq.iotoperations.azure.com/[v1beta1]
  • opcuabroker.iotoperations.azure.com/[v1beta1].
az iot ops check [--as-object {false, true}]
                 [--context]
                 [--detail-level {0, 1, 2}]
                 [--ops-service {akri, dataprocessor, deviceregistry, lnm, mq, opcua}]
                 [--post {false, true}]
                 [--pre {false, true}]
                 [--resource-name]
                 [--resources {asset, assetendpointprofile, assettype, broker, brokerlistener, configuration, datalakeconnector, dataset, diagnosticservice, instance, kafkaconnector, lnm, mqttbridgeconnector, pipeline}]

Exempel

Grundläggande användning. Kontrollerar hälsotillståndet mq med sammanfattningsutdata.

az iot ops check

Utvärderar "mq" som föregående exempel, men utdata är optimerade för CI.

az iot ops check --as-object

Kontrollerar hälsotillståndet och konfigurationen för "dataprocessorn" med detaljerade utdata.

az iot ops check --svc dataprocessor --detail-level 1

Samma som tidigare exempel, förutom att begränsa resultaten till pipelineresursen.

az iot ops check --svc dataprocessor --detail-level 1 --resources pipeline

Använd resursnamnet för att begränsa resultatet till "pipeline"-resursen exakt matchande namn "pipeline".

az iot ops check --svc dataprocessor  --resources pipeline --resource-name pipeline

Använd resursnamnet för att begränsa resultaten till resursnamn som börjar med "pipeline-name".

az iot ops check --svc dataprocessor --detail-level 1 --resource-name pipeline-name*

Använd globmönstret ?för att begränsa resultatet till resursnamn som innehåller "pipeline" och sluta med ett enda tecken.

az iot ops check --svc dataprocessor --detail-level 1 --resource-name pipeline?

Valfria parametrar

--as-object

Utdata kontrollerar innehåll och valideringar i en CI-vänlig datastruktur.

accepterade värden: false, true
--context

Kubeconfig-kontextnamn som ska användas för k8s-klusterkommunikation. Om ingen kontext anges används current_context.

--detail-level

Styr detaljnivån som visas i kontrollutdata. Välj 0 för en sammanfattningsvy (minimala utdata), 1 för en detaljerad vy (mer omfattande information) eller 2 för en utförlig vy (all tillgänglig information).

accepterade värden: 0, 1, 2
standardvärde: 0
--ops-service --svc

Distributionen av IoT Operations-tjänsten som ska utvärderas.

accepterade värden: akri, dataprocessor, deviceregistry, lnm, mq, opcua
standardvärde: mq
--post

Kör kontroller efter distributionen.

accepterade värden: false, true
--pre

Kör nödvändiga kontroller för att avgöra om minimikraven för en tjänstdistribution uppfylls.

accepterade värden: false, true
--resource-name --rn

Kör endast kontroller för det specifika resursnamnet. Namnet är skiftlägesokänsligt. Globmönster "" och "?" stöds. Obs! Endast alfanumeriska tecken, bindestreck, "?" och "" tillåts.

--resources

Kör endast kontroller på specifika resurstyper. Använd blankstegsavgränsade värden.

accepterade värden: asset, assetendpointprofile, assettype, broker, brokerlistener, configuration, datalakeconnector, dataset, diagnosticservice, instance, kafkaconnector, lnm, mqttbridgeconnector, pipeline
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot ops init

Förhandsgranskning

Kommandogruppen "iot ops" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Bootstrap, konfigurera och distribuera IoT-åtgärder till målbågsaktiverat kluster.

Ytterligare resurser, inklusive hur du arcaktiverar ett kluster, finns i https://learn.microsoft.com/en-us/azure/iot-operations/deploy-iot-ops/howto-prepare-cluster.

az iot ops init --cluster
                --resource-group
                [--ca-dir]
                [--ca-file]
                [--ca-key-file]
                [--ca-valid-days]
                [--cluster-namespace]
                [--context]
                [--csi-driver-ver]
                [--custom-location]
                [--disable-rotation {false, true}]
                [--disable-rsync-rules {false, true}]
                [--dp-instance]
                [--ensure-latest {false, true}]
                [--kubernetes-distro {k3s, k8s, microk8s}]
                [--kv-id]
                [--kv-spc-secret-name]
                [--location]
                [--mq-authn]
                [--mq-backend-part]
                [--mq-backend-rf]
                [--mq-backend-workers]
                [--mq-broker]
                [--mq-frontend-replicas]
                [--mq-frontend-server]
                [--mq-frontend-workers]
                [--mq-insecure {false, true}]
                [--mq-instance]
                [--mq-listener]
                [--mq-mem-profile {high, low, medium, tiny}]
                [--mq-mode {auto, distributed}]
                [--mq-service-type {clusterIp, loadBalancer, nodePort}]
                [--no-block {false, true}]
                [--no-deploy {false, true}]
                [--no-progress {false, true}]
                [--no-tls {false, true}]
                [--opcua-discovery-url]
                [--rotation-int]
                [--runtime-socket]
                [--show-template {false, true}]
                [--simulate-plc {false, true}]
                [--sp-app-id]
                [--sp-object-id]
                [--sp-secret]
                [--sp-secret-valid-days]
                [--target]

Exempel

Minsta indata för fullständig installation. Detta omfattar Key Vault-konfiguration, CSI-drivrutinsdistribution, TLS-konfiguration och distribution av IoT-åtgärder.

az iot ops init --cluster mycluster -g myresourcegroup --kv-id /subscriptions/2cb3a427-1abc-48d0-9d03-dd240819742a/resourceGroups/myresourcegroup/providers/Microsoft.KeyVault/vaults/mykeyvault

Samma konfiguration som tidigare exempel, förutom med användning av ett befintligt app-ID och en flagga för att inkludera en simulerad PLC-server som en del av distributionen. Om du inkluderar app-ID:t förhindras "init" från att skapa en appregistrering.

az iot ops init --cluster mycluster -g myresourcegroup --kv-id $KEYVAULT_ID --sp-app-id a14e216b-6802-4e9c-a6ac-844f9ffd230d --simulate-plc

Om du bara vill hoppa över distributionen och bara fokusera på Key Vault CSI-drivrutinen och TLS-konfigurationsarbetsflöden skickar du enkelt in "--no-deploy". Detta kan vara användbart när du vill distribuera från ett annat verktyg, till exempel portalen.

az iot ops init --cluster mycluster -g myresourcegroup --kv-id $KEYVAULT_ID --sp-app-id a14e216b-6802-4e9c-a6ac-844f9ffd230d --no-deploy

Om du bara vill distribuera IoT-åtgärder i ett kluster som redan har förberetts utelämnar du "--kv-id" och inkluderar "--no-tls".

az iot ops init --cluster mycluster -g myresourcegroup --no-tls

Använd "--no-block" för att utföra annat arbete medan distributionen pågår jämfört med att vänta på att distributionen ska slutföras innan du påbörjar det andra arbetet.

az iot ops init --cluster mycluster -g myresourcegroup --kv-id $KEYVAULT_ID --sp-app-id a14e216b-6802-4e9c-a6ac-844f9ffd230d --no-block

För att undvika att anropa MS Graph, till exempel för CI-scenarier där de inloggade till az cli-tjänstens huvudnamn är begränsade eller ett befintligt tjänsthuvudnamn ska återanvändas, anger du alla "--sp-app-id", "--sp-object-id" och "--sp-secret". Dessa värden bör återspegla det önskade tjänstens huvudnamn som ska användas för CSI-drivrutinskonfigurationen för Key Vault.

az iot ops init --cluster mycluster -g myresourcegroup --kv-id $KEYVAULT_ID --sp-app-id a14e216b-6802-4e9c-a6ac-844f9ffd230d --sp-object-id 224a7a3f-c63d-4923-8950-c4a85f0d2f29 --sp-secret $SP_SECRET

Obligatoriska parametrar

--cluster

Målklusternamn för IoT Operations-distribution.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Valfria parametrar

--ca-dir

Den lokala katalogen som den genererade test-CA:en och den privata nyckeln placeras i. Om ingen katalog anges skrivs inga filer till disken. Gäller när ingen --ca-file och --ca-key-file tillhandahålls.

--ca-file

Sökvägen till önskad CA-fil i PEM-format.

--ca-key-file

Sökvägen till ca:ens privata nyckelfil i PEM-format. ! Krävs! när --ca-file tillhandahålls.

--ca-valid-days

Alternativ för att styra varaktigheten i dagar för den init-genererade x509 CA:en. Gäller om --ca-file och --ca-key-file inte tillhandahålls.

standardvärde: 365
--cluster-namespace

Infra för klusternamnområdet IoT Operations distribueras till. Måste vara gemener.

standardvärde: azure-iot-operations
--context

Kubeconfig-kontextnamn som ska användas för k8s-klusterkommunikation. Om ingen kontext anges används current_context.

--csi-driver-ver

CSI-drivrutinsversion.

standardvärde: 1.5.2
--custom-location

Det anpassade platsnamnet som motsvarar IoT Operations-distributionen. Standardvärdet är i formatet {cluster_name}-ops-init-cl.

--disable-rotation

Flagga för att inaktivera hemlig rotation.

accepterade värden: false, true
--disable-rsync-rules

Regler för resurssynkronisering tas inte med i distributionen.

accepterade värden: false, true
--dp-instance

Instansnamn för dataprocessor. Standardvärdet är i formatet {cluster_name}-ops-init-processor.

--ensure-latest

Kontrollera att den senaste IoT Ops CLI är installerad, vilket ger upphov till ett fel om en uppgradering är tillgänglig.

accepterade värden: false, true
--kubernetes-distro

Kubernetes-distributionen som ska användas för Akri-konfiguration. Den valda distributionen innebär standardsökvägen för containerkörningssocketen när inget --runtime-socket-värde anges.

accepterade värden: k3s, k8s, microk8s
standardvärde: k8s
--kv-id

Key Vault ARM-resurs-ID. Om du anger det här resurs-ID:t kan klienten konfigurera alla nödvändiga resurser och konfiguration på klustersidan för att aktivera Key Vault CSI-drivrutinen för IoT-åtgärder.

--kv-spc-secret-name

Det Nyckelvalvshemlighetsnamn som ska användas som standard-SPC-hemlighet. Om hemligheten inte finns skapas den med ett kryptografiskt säkert platshållarvärde.

standardvärde: azure-iot-operations
--location

ARM-platsen som ska användas för etablerade RPSaaS-säkerheter. Om det inte anges används den anslutna klusterplatsen.

--mq-authn

Namnet på mq authN. Standardvärdet är "authn".

--mq-backend-part

MQ-serverdelspartitioner.

standardvärde: 2
--mq-backend-rf

Redundansfaktor för MQ-serverdel.

standardvärde: 2
--mq-backend-workers

MQ-serverdelsarbetare.

standardvärde: 2
--mq-broker

Namnet på mq-koordinatorn. Standardvärdet är "broker".

--mq-frontend-replicas

MQ-klientdelsrepliker.

standardvärde: 2
--mq-frontend-server

Servernamnet för mq-klientdelen. Standardvärdet är "mq-dmqtt-frontend".

--mq-frontend-workers

MQ-klientdelsarbetare.

standardvärde: 2
--mq-insecure

När mq-distributionen är aktiverad kommer den att innehålla en lyssnare som är bunden till port 1883 utan authN eller authZ. Inställningen broker encryptInternalTraffic anges till false. Endast för icke-produktionsarbetsbelastningar.

accepterade värden: false, true
--mq-instance

Namnet på mq-instansen. Standardvärdet är i formatet "init-{hash}-mq-instance".

--mq-listener

Mq-lyssnarens namn. Standardvärdet är "lyssnare".

--mq-mem-profile

MQ-minnesprofil.

accepterade värden: high, low, medium, tiny
standardvärde: medium
--mq-mode

MQ-funktionsläge.

accepterade värden: auto, distributed
standardvärde: distributed
--mq-service-type

MQ-tjänsttyp.

accepterade värden: clusterIp, loadBalancer, nodePort
standardvärde: clusterIp
--no-block

Returnera omedelbart efter att IoT Operations-distributionen har startats.

accepterade värden: false, true
--no-deploy

Arbetsflödet för IoT Operations-distributionen hoppas över.

accepterade värden: false, true
--no-progress

Inaktivera förloppsindikatorn init.

accepterade värden: false, true
--no-tls

TLS-konfigurationsarbetsflödet hoppas över.

accepterade värden: false, true
--opcua-discovery-url

Konfigurerar en OPC-UA-serverslutpunkt för Akri-identifieringshanterare. Om det inte anges och --simulate-plc har angetts blir det här värdet "opc.tcp://opcplc-0000000. {cluster_namespace}:50000'.

--rotation-int

Rotationsmätningsintervall.

standardvärde: 1h
--runtime-socket

Standardnodsökvägen för containerkörningssocketen. Om den inte anges (standard) bestäms socketsökvägen av --kubernetes-distro.

--show-template

Flagga när den anges, matar ut mallen som är avsedd för distribution.

accepterade värden: false, true
--simulate-plc

Flagga när den ställs in, konfigurerar OPC-UA broker installer för att starta en PLC-server.

accepterade värden: false, true
--sp-app-id

App-ID för tjänstens huvudnamn. Om detta anges kommer att användas för CSI-drivrutinskonfiguration. Annars skapas en appregistrering. Krävs om det inloggade huvudkontot inte har behörighet att köra frågor mot grafen.

--sp-object-id

Objekt-ID för tjänstens huvudnamn (sp). Om detta anges kommer att användas för CSI-drivrutinskonfiguration. Annars kommer objekt-ID:t att frågas från app-ID:t – skapa sp om det inte finns något. Krävs om det inloggade huvudkontot inte har behörighet att köra frågor mot grafen. Använd az ad sp show --id <app Id> --query id -o tsv för att skapa rätt objekt-ID. Du kan också navigera till Företagsprogram i Entra-ID-klientorganisationen med hjälp av portalen.

--sp-secret

Hemligheten som motsvarar det angivna app-ID:t för tjänstens huvudnamn. Om detta anges kommer att användas för CSI-drivrutinskonfiguration. Annars skapas en ny hemlighet. Krävs om det inloggade huvudkontot inte har behörighet att köra frågor mot grafen.

--sp-secret-valid-days

Alternativ för att styra varaktigheten i dagar för den init-genererade tjänstens huvudnamnshemlighet. Gäller om --sp-secret inte har angetts.

standardvärde: 365
--target

Målnamn för ops orchestrator. Standardvärdet är i formatet {cluster_name}-ops-init-target.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot ops verify-host

Förhandsgranskning

Kommandogruppen "iot ops" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Kör en uppsättning klustervärdverifieringar för IoT Operations-distributionskompatibilitet.

Avsett att köras direkt på en målklustervärd. Kommandot kan uppmana till att tillämpa en uppsättning privilegierade åtgärder, till exempel att installera ett beroende. I det här fallet måste CLI köras med förhöjd behörighet. Till exempel sudo AZURE_EXTENSION_DIR=~/.azure/cliextensions az iot ops verify-host.

az iot ops verify-host [--no-progress {false, true}]

Valfria parametrar

--no-progress

Inaktivera visuell representation av arbete.

accepterade värden: false, true
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.