az iot ops connector template

Hinweis

Diese Referenz ist Teil der Erweiterung azure-iot-ops für die Azure CLI (Version 2.70.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen Az iot ops Connector-Vorlagenbefehl zum ersten Mal ausführen. Erfahren Sie mehr über Erweiterungen.

Verwaltung von Verbindervorlagen.

Connectorvorlagen bieten einen standardisierten, metadatengesteuerten Ansatz für die Connectorbereitstellung. Vorlagen werden aus Konnektormetadatenverweisen (MCR für Connectors von Drittanbietern, ACR für Drittanbieterconnectors) erstellt, die connectorspezifische Konfiguration automatisch auffüllen und gleichzeitig die Benutzeranpassung von Bereitstellungsparametern ermöglichen.

Befehle

Name	Beschreibung	Typ	Status
az iot ops connector template create	Erstellen Sie eine neue Connectorvorlage.	Erweiterung	GA
az iot ops connector template delete	Löschen sie eine Verbindervorlage.	Erweiterung	GA
az iot ops connector template list	Alle Connectorvorlagen auflisten.	Erweiterung	GA
az iot ops connector template show	Anzeigen einer Verbindervorlage.	Erweiterung	GA
az iot ops connector template update	Aktualisieren sie eine vorhandene Connectorvorlage.	Erweiterung	GA

az iot ops connector template create

Erstellen Sie eine neue Connectorvorlage.

Erstellt eine Connectorvorlage aus Metadaten, die in einer Containerregistrierung gespeichert sind. Die Metadaten füllen automatisch connectorspezifische Einstellungen auf, während Bereitstellungsparameter wie Replikate, Protokollebenen und geheime Schlüssel angepasst werden können.

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]

Beispiele

Erstellen Sie eine Vorlage für DEN REST-Connector mit Standardeinstellungen.

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

Erstellen Sie eine Vorlage mit benutzerdefinierter 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

Erstellen Sie eine Vorlage für den Drittanbieterconnector aus privatem 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

Erforderliche Parameter

--connector-metadata-ref --ref

URL zum Konnektormetadatenartefakt aus der Containerregistrierung.

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

--name -n

Vorlagenname.

--resource-group -g

Instanzressourcengruppe.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--acquire-policy-token

Automatisches Abrufen eines Azure Policy Tokens für diesen Ressourcenvorgang.

Eigenschaft	Wert
Parametergruppe:	Global Policy Arguments

--allocation-policy --ap

Richtlinie zum Zuordnen von Geräteendpunkten über Connectorinstanzen hinweg (Groß-/Kleinschreibung wird nicht beachtet). Optionen: Bucketisiert. Wenn nicht angegeben, wird keine Zuordnungsrichtlinie festgelegt.

--bs --bucket-size

Anzahl der Endpunkte pro Connectorinstanz-Bucket. Erforderlich, wenn die Zuordnungsrichtlinie "Bucketisiert" ist.

--cc --connector-config

Konfigurationen mit durch leer getrennten Verbindungstastenwerten. Format: key=value. Kann mehrere Werte in einem Anruf bereitstellen oder mehrmals verwenden. Beispiele: --cc brokerAddress=mqtt://broker:1883 qos=1 keepAlive=60 OR --cc brokerAddress=mqtt://broker:1883 --cc qos=1 --cc keepAlive=60. Verwenden Sie '' zum Löschen vorhandener Konfigurationen.

--change-reference

Die zugehörige Änderungsreferenz-ID für diesen Ressourcenvorgang.

Eigenschaft	Wert
Parametergruppe:	Global Policy Arguments

--image-pull-policy --ipp

Kubernetes-Image-Pull-Richtlinie. Optionen: Always, IfNotPresent, Never.

--image-pull-secrets --ips

Leerzeichentrennte Kubernetes geheime Namen zum Abrufen von Containerimages aus privaten Registrierungen. Stellen Sie für Connectors von Drittanbietern, die eine private Containerregistrierung verwenden, die geheime(n) Schlüssel mit Registrierungsanmeldeinformationen bereit, damit der Connector-Pod das Image abrufen kann. Verwenden Sie "" zum Löschen vorhandener Bildziehschlüssel.

--ll --log-level

Protokollebene für Connector-Pods. Optionen: Ablaufverfolgung, Debuggen, Informationen, Warnung, Fehler. Standard: Informationen.

--replicas -r

Anzahl der bereitzustellenden Connector-Pod-Replikate. Der Standardwert wird von recommendedReplicas in Metadaten oder 1 übernommen, falls nicht angegeben.

--secrets

Geheime Schlüssel der leerzeichentrennten Verbinderanwendung, die im Schlüssel=Wertformat bereitgestellt werden sollen. Jeder geheime Schlüssel erfordert drei Felder: secretRef (Name des zu mountende geheimen Schlüssels), secretKey (der Schlüssel im geheimen Schlüssel, der bereitgestellt werden soll) und secretAlias (Anwendungsalias). Beispiel: secretRef=mySecret secretKey=password secretAlias=dbPassword. Kann mehrmals verwendet werden, um mehrere geheime Schlüssel zu definieren. The secretRef must reference a secret synced via the secret provider class. Verwenden Sie '' zum Löschen vorhandener geheimer Schlüssel.

--storage-volumes --sv

Durch Leerzeichen getrennte Referenz für beständigen Volumeanspruch im Key=Wertformat. Erforderliche Schlüssel: claimName (Name vorhandener PVC), MountPath (Mount Path in Container). Beispiel: claimName=myPVC mountPath=/data. Verwenden Sie '' zum Löschen vorhandener Speichervolumes.

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

Geheimer Verweis für Zu vertrauende Zertifikate. Dadurch wird der Name des Kubernetes-Schlüssels angegeben, der vertrauenswürdige Zertifizierungsstellenzertifikate enthält. Verwenden Sie '' zum Löschen vorhandener Vertrauenseinstellungen.

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az iot ops connector template delete

Löschen sie eine Verbindervorlage.

Löscht eine Verbindervorlage. Überprüft, ob die Vorlage derzeit von bereitgestellten Connectors verwendet wird, und fordert zur Bestätigung auf, es sei denn, --yes wird angegeben.

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

Beispiele

Vorlage mit Bestätigungsaufforderung löschen.

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

Vorlage ohne Bestätigung löschen.

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

Erforderliche Parameter

--instance -i

IoT Operations-Instanzname.

--name -n

Vorlagenname.

--resource-group -g

Instanzressourcengruppe.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--acquire-policy-token

Automatisches Abrufen eines Azure Policy Tokens für diesen Ressourcenvorgang.

Eigenschaft	Wert
Parametergruppe:	Global Policy Arguments

--change-reference

Die zugehörige Änderungsreferenz-ID für diesen Ressourcenvorgang.

Eigenschaft	Wert
Parametergruppe:	Global Policy Arguments

--yes -y

Bestätigen Sie [y]es ohne Aufforderung. Nützlich für CI- und Automatisierungsszenarien.

Eigenschaft	Wert
Standardwert:	False
Zulässige Werte:	false, true

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az iot ops connector template list

Alle Connectorvorlagen auflisten.

Listet alle Connectorvorlagen für eine bestimmte Azure IoT Einsatz Instanz mit Zusammenfassungsinformationen auf, einschließlich Vorlagenname, Connectortyp, Version, Replikaten und Erstellungs-/Änderungsdaten.

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

Beispiele

Listet alle Vorlagen für eine Instanz auf.

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

Erforderliche Parameter

--instance -i

IoT Operations-Instanzname.

--resource-group -g

Instanzressourcengruppe.

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az iot ops connector template show

Anzeigen einer Verbindervorlage.

Zeigt die vollständige Vorlagenkonfiguration einschließlich Metadaten, Connectorinformationen, Imagekonfiguration, Bereitstellungseinstellungen, storage Konfiguration und Sicherheitseinstellungen an.

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

Beispiele

Zeigen Sie Vorlagendetails im JSON-Format an.

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

Vorlage im Tabellenformat anzeigen.

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

Erforderliche Parameter

--instance -i

IoT Operations-Instanzname.

--name -n

Vorlagenname.

--resource-group -g

Instanzressourcengruppe.

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az iot ops connector template update

Aktualisieren sie eine vorhandene Connectorvorlage.

Aktualisiert eine Connectorvorlage. Bereitstellungsparameter wie Replikate, Protokollebenen, geheime Schlüssel, Bild-Pull-Einstellungen und Vertrauenseinstellungen können geändert werden. Connectormetadaten können nur auf Patch- oder Nebenversionsupgrades aktualisiert werden. Hauptversionsupdates erfordern das Erstellen einer neuen Vorlage.

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]

Beispiele

Replikatanzahl und Protokollebene aktualisieren.

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

Aktualisieren Sie auf eine neuere Patchversion des Connectors.

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

Erforderliche Parameter

--instance -i

IoT Operations-Instanzname.

--name -n

Vorlagenname.

--resource-group -g

Instanzressourcengruppe.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--acquire-policy-token

Automatisches Abrufen eines Azure Policy Tokens für diesen Ressourcenvorgang.

Eigenschaft	Wert
Parametergruppe:	Global Policy Arguments

--allocation-policy --ap

--bs --bucket-size

Anzahl der Endpunkte pro Connectorinstanz-Bucket. Erforderlich, wenn die Zuordnungsrichtlinie "Bucketisiert" ist.

--cc --connector-config

--change-reference

Die zugehörige Änderungsreferenz-ID für diesen Ressourcenvorgang.

Eigenschaft	Wert
Parametergruppe:	Global Policy Arguments

--connector-metadata-ref --ref

URL zum Konnektormetadatenartefakt aus der Containerregistrierung.

            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-Image-Pull-Richtlinie. Optionen: Always, IfNotPresent, Never.

--image-pull-secrets --ips

--ll --log-level

Protokollebene für Connector-Pods. Optionen: Ablaufverfolgung, Debuggen, Informationen, Warnung, Fehler. Standard: Informationen.

--replicas -r

Anzahl der bereitzustellenden Connector-Pod-Replikate. Der Standardwert wird von recommendedReplicas in Metadaten oder 1 übernommen, falls nicht angegeben.

--secrets

--storage-volumes --sv

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

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

Feedback

War diese Seite hilfreich?