az iot ops connector template

Anmärkning

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

Hantering av anslutningsmallar.

Anslutningsmallar tillhandahåller en standardiserad, metadatadriven metod för anslutningsdistribution. Mallar skapas från metadatareferenser för anslutningsprogram (MCR för anslutningsappar från första part, ACR för anslutningsprogram från tredje part), som automatiskt fyller i anslutningsspecifika konfigurationer samtidigt som användaranpassning av distributionsparametrar tillåts.

Kommandon

Name Description Typ Status
az iot ops connector template create

Skapa en ny anslutningsmall.

 Förlängning GA
az iot ops connector template delete

Ta bort en anslutningsmall.

 Förlängning GA
az iot ops connector template list

Visa en lista över alla anslutningsmallar.

 Förlängning GA
az iot ops connector template show

Visa en anslutningsmall.

 Förlängning GA
az iot ops connector template update

Uppdatera en befintlig anslutningsmall.

 Förlängning GA

az iot ops connector template create

Skapa en ny anslutningsmall.

Skapar en anslutningsmall från metadata som lagras i ett containerregister. Metadata fyller automatiskt i anslutningsspecifika inställningar, medan distributionsparametrar som repliker, loggnivåer och hemligheter kan anpassas.

az iot ops connector template create --connector-metadata-ref --ref
                                     --instance
                                     --name
                                     --resource-group
                                     [--acquire-policy-token]
                                     [--allocation-policy --ap]
                                     [--bs --bucket-size]
                                     [--cc --connector-config]
                                     [--change-reference]
                                     [--image-pull-policy --ipp]
                                     [--image-pull-secrets --ips]
                                     [--ll --log-level]
                                     [--replicas]
                                     [--secrets]
                                     [--storage-volumes --sv]
                                     [--trust-settings-secret-ref --tssr]

Exempel

Skapa en mall för REST-anslutningsappen med standardinställningar.

az iot ops connector template create --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --connector-metadata-ref mcr.microsoft.com/azureiotoperations/akri-connectors/rest-metadata:1.0.6

Skapa en mall med anpassad konfiguration.

az iot ops connector template create --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --connector-metadata-ref mcr.microsoft.com/azureiotoperations/akri-connectors/rest-metadata:1.0.6 --replicas 3 --log-level debug --image-pull-secrets acr-credentials

Skapa en mall för tredjepartsanslutning från privat ACR.

az iot ops connector template create --name custom-plc-template --resource-group myResourceGroup --instance myAIOInstance --connector-metadata-ref contoso.azurecr.io/connectors/plc-metadata:1.0.0 --image-pull-secrets acr-pull-secret

Obligatoriska parametrar

--connector-metadata-ref --ref

URL till metadataartefakt för anslutningsappen från containerregistret.

            1st-party connectors (MCR):
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/rest-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/media-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/mqtt-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/sse-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/onvif-metadata:VERSION`

            3rd-party connectors:
            - `REGISTRY.azurecr.io/PATH-metadata:VERSION`

            To list available versions for 1st-party connectors:
            `curl https://mcr.microsoft.com/v2/azureiotoperations/akri-connectors/TYPE-metadata/tags/list`.
--instance -i

IoT Operations-instansens namn.

--name -n

Mallnamn.

--resource-group -g

Instansresursgrupp.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--allocation-policy --ap

Princip för allokering av enhetsslutpunkter mellan anslutningsinstanser (skiftlägeskänslig). Alternativ: Bucketized. Om inget anges anges ingen allokeringsprincip.

--bs --bucket-size

Antal slutpunkter per bucket för anslutningsinstansen. Krävs när allokeringsprincipen är "Bucketized".

--cc --connector-config

Utrymmesavgränsade anslutningsspecifika nyckel/värde-konfigurationer. Format: key=value. Kan ange flera värden i ett anrop eller använda flera gånger. Exempel: --cc brokerAddress=mqtt://broker:1883 qos=1 keepAlive=60 OR --cc brokerAddress=mqtt://broker:1883 --cc qos=1 --cc keepAlive=60. Använd för att rensa befintliga konfigurationer.

--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--image-pull-policy --ipp

Kubernetes-avbildnings pull-princip. Alternativ: Always, IfNotPresent, Never.

--image-pull-secrets --ips

Utrymmesavgränsade Kubernetes-hemliga namn för att hämta containeravbildningar från privata register. För anslutningsprogram från tredje part som använder ett privat containerregister anger du de hemligheter som innehåller registerautentiseringsuppgifter för att göra det möjligt för anslutningspodden att hämta avbildningen. Använd för att rensa befintliga avbildningshämtningshemligheter.

--ll --log-level

Loggnivå för anslutningspoddar. Alternativ: spårning, felsökning, information, varning, fel. Standard: info.

--replicas -r

Antal poddrepliker för anslutningsprogram som ska distribueras. Standardvärdet hämtas från rekommenderadeReplicas i metadata, eller 1 om det inte anges.

--secrets

Utrymmesavgränsade anslutningsprogramhemligheter som ska monteras i key=value-format. Varje hemlighet kräver tre fält: secretRef (namnet på hemligheten som ska monteras), secretKey (nyckeln i hemligheten som ska monteras) och secretAlias (programalias). Exempel: secretRef=mySecret secretKey=password secretAlias=dbPassword. Kan användas flera gånger för att definiera flera hemligheter. SecretRef måste referera till en hemlighet som synkroniserats via klassen hemlig provider. Använd för att rensa befintliga hemligheter.

--storage-volumes --sv

Utrymmesavgränsad referens för beständiga volymanspråk i key=value-format. Nödvändiga nycklar: claimName (namn på befintlig PVC), mountPath (monteringssökväg i container). Exempel: claimName=myPVC mountPath=/data. Använd "" för att rensa befintliga lagringsvolymer.

--trust-settings-secret-ref --tssr

Hemlig referens för certifikat att lita på. Detta anger namnet på Kubernetes-hemligheten som innehåller betrodda CA-certifikat. Använd "" för att rensa befintliga förtroendeinställningar.

Globala parametrar
--debug

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

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

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

Egenskap Värde
Standardvärde: False

az iot ops connector template delete

Ta bort en anslutningsmall.

Tar bort en anslutningsmall. Verifierar om mallen för närvarande används av distribuerade anslutningsappar och uppmanar till bekräftelse såvida inte --yes tillhandahålls.

az iot ops connector template delete --instance
                                     --name
                                     --resource-group
                                     [--acquire-policy-token]
                                     [--change-reference]
                                     [--yes {false, true}]

Exempel

Ta bort mall med bekräftelsemeddelande.

az iot ops connector template delete --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance

Ta bort mall utan bekräftelse.

az iot ops connector template delete --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --yes

Obligatoriska parametrar

--instance -i

IoT Operations-instansens namn.

--name -n

Mallnamn.

--resource-group -g

Instansresursgrupp.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--yes -y

Bekräfta [y]es utan att fråga. Användbart för CI- och automationsscenarier.

Egenskap Värde
Standardvärde: False
Godkända värden: false, true
Globala parametrar
--debug

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

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

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

Egenskap Värde
Standardvärde: False

az iot ops connector template list

Visa en lista över alla anslutningsmallar.

Visar en lista över alla anslutningsmallar för en specifik Azure IoT Operations-instans med sammanfattningsinformation, inklusive mallnamn, anslutningstyp, version, repliker och datum för skapande/ändring.

az iot ops connector template list --instance
                                   --resource-group

Exempel

Visa en lista över alla mallar för en instans.

az iot ops connector template list --resource-group myResourceGroup --instance myAIOInstance

Obligatoriska parametrar

--instance -i

IoT Operations-instansens namn.

--resource-group -g

Instansresursgrupp.

Globala parametrar
--debug

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

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

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

Egenskap Värde
Standardvärde: False

az iot ops connector template show

Visa en anslutningsmall.

Visar den fullständiga mallkonfigurationen, inklusive metadata, anslutningsinformation, bildkonfiguration, distributionsinställningar, storage konfiguration och säkerhetsinställningar.

az iot ops connector template show --instance
                                   --name
                                   --resource-group

Exempel

Visa mallinformation i JSON-format.

az iot ops connector template show --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance

Visa mallen i tabellformat.

az iot ops connector template show --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --output table

Obligatoriska parametrar

--instance -i

IoT Operations-instansens namn.

--name -n

Mallnamn.

--resource-group -g

Instansresursgrupp.

Globala parametrar
--debug

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

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

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

Egenskap Värde
Standardvärde: False

az iot ops connector template update

Uppdatera en befintlig anslutningsmall.

Uppdaterar en anslutningsmall. Distributionsparametrar som repliker, loggnivåer, hemligheter, inställningar för bildhämtning och förtroendeinställningar kan ändras. Metadata för anslutningsappen kan endast uppdateras till uppdatering eller delversionsuppgraderingar. Viktiga versionsuppdateringar kräver att du skapar en ny mall.

az iot ops connector template update --instance
                                     --name
                                     --resource-group
                                     [--acquire-policy-token]
                                     [--allocation-policy --ap]
                                     [--bs --bucket-size]
                                     [--cc --connector-config]
                                     [--change-reference]
                                     [--connector-metadata-ref --ref]
                                     [--image-pull-policy --ipp]
                                     [--image-pull-secrets --ips]
                                     [--ll --log-level]
                                     [--replicas]
                                     [--secrets]
                                     [--storage-volumes --sv]
                                     [--trust-settings-secret-ref --tssr]

Exempel

Uppdatera antal repliker och loggnivå.

az iot ops connector template update --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --replicas 5 --log-level debug

Uppdatera till en nyare korrigeringsversion av anslutningsappen.

az iot ops connector template update --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --connector-metadata-ref mcr.microsoft.com/azureiotoperations/akri-connectors/rest-metadata:1.0.7

Obligatoriska parametrar

--instance -i

IoT Operations-instansens namn.

--name -n

Mallnamn.

--resource-group -g

Instansresursgrupp.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--allocation-policy --ap

Princip för allokering av enhetsslutpunkter mellan anslutningsinstanser (skiftlägeskänslig). Alternativ: Bucketized. Om inget anges anges ingen allokeringsprincip.

--bs --bucket-size

Antal slutpunkter per bucket för anslutningsinstansen. Krävs när allokeringsprincipen är "Bucketized".

--cc --connector-config

Utrymmesavgränsade anslutningsspecifika nyckel/värde-konfigurationer. Format: key=value. Kan ange flera värden i ett anrop eller använda flera gånger. Exempel: --cc brokerAddress=mqtt://broker:1883 qos=1 keepAlive=60 OR --cc brokerAddress=mqtt://broker:1883 --cc qos=1 --cc keepAlive=60. Använd för att rensa befintliga konfigurationer.

--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--connector-metadata-ref --ref

URL till metadataartefakt för anslutningsappen från containerregistret.

            1st-party connectors (MCR):
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/rest-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/media-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/mqtt-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/sse-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/onvif-metadata:VERSION`

            3rd-party connectors:
            - `REGISTRY.azurecr.io/PATH-metadata:VERSION`

            To list available versions for 1st-party connectors:
            `curl https://mcr.microsoft.com/v2/azureiotoperations/akri-connectors/TYPE-metadata/tags/list`.
--image-pull-policy --ipp

Kubernetes-avbildnings pull-princip. Alternativ: Always, IfNotPresent, Never.

--image-pull-secrets --ips

Utrymmesavgränsade Kubernetes-hemliga namn för att hämta containeravbildningar från privata register. För anslutningsprogram från tredje part som använder ett privat containerregister anger du de hemligheter som innehåller registerautentiseringsuppgifter för att göra det möjligt för anslutningspodden att hämta avbildningen. Använd för att rensa befintliga avbildningshämtningshemligheter.

--ll --log-level

Loggnivå för anslutningspoddar. Alternativ: spårning, felsökning, information, varning, fel. Standard: info.

--replicas -r

Antal poddrepliker för anslutningsprogram som ska distribueras. Standardvärdet hämtas från rekommenderadeReplicas i metadata, eller 1 om det inte anges.

--secrets

Utrymmesavgränsade anslutningsprogramhemligheter som ska monteras i key=value-format. Varje hemlighet kräver tre fält: secretRef (namnet på hemligheten som ska monteras), secretKey (nyckeln i hemligheten som ska monteras) och secretAlias (programalias). Exempel: secretRef=mySecret secretKey=password secretAlias=dbPassword. Kan användas flera gånger för att definiera flera hemligheter. SecretRef måste referera till en hemlighet som synkroniserats via klassen hemlig provider. Använd för att rensa befintliga hemligheter.

--storage-volumes --sv

Utrymmesavgränsad referens för beständiga volymanspråk i key=value-format. Nödvändiga nycklar: claimName (namn på befintlig PVC), mountPath (monteringssökväg i container). Exempel: claimName=myPVC mountPath=/data. Använd "" för att rensa befintliga lagringsvolymer.

--trust-settings-secret-ref --tssr

Hemlig referens för certifikat att lita på. Detta anger namnet på Kubernetes-hemligheten som innehåller betrodda CA-certifikat. Använd "" för att rensa befintliga förtroendeinställningar.

Globala parametrar
--debug

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

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

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

Egenskap Värde
Standardvärde: False