az iot ops secretsync secret

Note

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 secretsync geheimen Befehl zum ersten Mal ausführen. Erfahren Sie mehr über Erweiterungen.

Verwalten sie einzelne geheime Schlüssel in SecretSync-Ressourcen.

Befehle

Name Beschreibung Typ Status
az iot ops secretsync secret list

Geheime Schlüssel in einer SecretSync-Ressource auflisten.

Extension GA
az iot ops secretsync secret remove

Entfernen Sie einen bestimmten geheimen Schlüssel aus einer SecretSync-Ressource. Wenn alle geheimen Schlüssel entfernt werden, wird die SecretSync-Ressource selbst automatisch gelöscht.

Extension GA
az iot ops secretsync secret set

Legen Sie geheime AKV-Zuordnungen für eine SecretSync-Ressource fest.

Extension GA

az iot ops secretsync secret list

Geheime Schlüssel in einer SecretSync-Ressource auflisten.

az iot ops secretsync secret list --instance
                                  --resource-group
                                  --secret-sync-name

Beispiele

Geheime Schlüssel in einer bestimmten SecretSync-Ressource auflisten.

az iot ops secretsync secret list --instance myInstance -g myRG --secret-sync-name my-certs

Erforderliche Parameter

--instance -i -n

IoT Operations-Instanzname.

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--secret-sync-name

Name der SecretSync-Ressource.

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 secretsync secret remove

Entfernen Sie einen bestimmten geheimen Schlüssel aus einer SecretSync-Ressource. Wenn alle geheimen Schlüssel entfernt werden, wird die SecretSync-Ressource selbst automatisch gelöscht.

Entfernt den geheimen Eintrag aus dem ObjectSecretMapping von SecretSync. Wenn dies der letzte geheime Schlüssel in "SecretSync" ist, wird die gesamte SecretSync-Ressource gelöscht, da die ARM-API keine SecretSync mit null geheimen Zuordnungen zulässt.

Bevor Sie den geheimen Schlüssel aus dem freigegebenen SPC entfernen, wird eine Überprüfung der Verweisanzahl für alle SecretSyncs am benutzerdefinierten Speicherort durchgeführt. Der SPC-Eintrag wird nur entfernt, wenn kein anderer SecretSync auf denselben AKV-Schlüssel verweist. Dies verhindert, dass andere Verbraucher des gemeinsamen SPC brechen.

Mit diesem Befehl wird der geheime Schlüssel nicht aus Azure Key Vault gelöscht.

az iot ops secretsync secret remove --instance
                                    --resource-group
                                    --secret-name
                                    --secret-sync-name
                                    [--acquire-policy-token]
                                    [--change-reference]
                                    [--yes {false, true}]

Beispiele

Entfernen Eines geheimen Schlüssels aus einem SecretSync-Element.

az iot ops secretsync secret remove --instance myInstance -g myRG --secret-sync-name my-certs --secret-name my-tls-cert

Entfernen Sie einen geheimen Schlüssel ohne Bestätigungsaufforderung.

az iot ops secretsync secret remove --instance myInstance -g myRG --secret-sync-name my-certs --secret-name my-tls-cert -y

Erforderliche Parameter

--instance -i -n

IoT Operations-Instanzname.

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--secret-name

AKV-Geheimer Name (SourcePath-Wert), der aus "SecretSync" entfernt werden soll.

--secret-sync-name

Name der SecretSync-Ressource.

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
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 secretsync secret set

Legen Sie geheime AKV-Zuordnungen für eine SecretSync-Ressource fest.

Löst die Standardmäßige geheime Anbieterklasse (SPC) der Instanz auf, überprüft, ob jeder AKV-Schlüssel vorhanden ist, fügt jeden geheimen Schlüssel zur Objektliste des SPC hinzu und erstellt oder führt Einträge in der benannten SecretSync-Ressource zusammen.

Wenn "SecretSync" bereits vorhanden ist, werden neue geheime Einträge mit ihr zusammengeführt. Vorhandene Einträge mit demselben geheimen AKV-Namen werden mit dem Zielschlüssel aktualisiert.

Der Wert "--secret-sync-name" wird zum geheimen K8s-Namen. Verbraucher verweisen auf sie über <secret-sync-name>/<target-key> Geräteendpunkte oder nur <secret-sync-name> für Datenflussendpunkte.

az iot ops secretsync secret set --instance
                                 --resource-group
                                 --secret-map
                                 --secret-sync-name
                                 [--acquire-policy-token]
                                 [--change-reference]

Beispiele

Erstellen Sie eine SecretSync für geräteendpunkt x509-Zertifikatauthentifizierung.

az iot ops secretsync secret set --instance myInstance -g myRG --secret-sync-name my-certs --secret-map my-tls-cert=certificate --secret-map my-tls-key=privateKey

Hinzufügen eines weiteren geheimen Schlüssels zu einem vorhandenen SecretSync (idempotent merge).

az iot ops secretsync secret set --instance myInstance -g myRG --secret-sync-name my-certs --secret-map my-intermediate-cert=intermediateCerts

Erstellen Sie eine SecretSync für SASL-basierte Datenflussendpunkt.

az iot ops secretsync secret set --instance myInstance -g myRG --secret-sync-name eventhub-sasl --secret-map my-eh-user=username --secret-map my-eh-pass=password

Erforderliche Parameter

--instance -i -n

IoT Operations-Instanzname.

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--secret-map

GEHEIME AKV-Zuordnung im Format <akv-secret-name>=<target-key>. Wiederholbar. Das AKV-Geheimnis muss vorhanden sein.

--secret-sync-name

Name für die SecretSync ARM-Ressource und den resultierenden K8s-Schlüssel.

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