Freigeben über

az iot ops secretsync

Note

Diese Referenz ist Teil der Azure-iot-ops-Erweiterung für die Azure CLI (Version 2.67.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie ein az iot ops secretsync Befehl ausführen. Erfahren Sie mehr über Erweiterungen.

Verwaltung der geheimen Instanzsynchronisierung.

Befehle

Name Beschreibung Typ Status
az iot ops secretsync disable

Deaktivieren Sie die geheime Synchronisierung für eine Instanz.

 Extension GA
az iot ops secretsync enable

Aktivieren sie die geheime Synchronisierung für eine Instanz.

 Extension GA
az iot ops secretsync list

Listet die geheimen Synchronisierungskonfigurationen auf, die einer Instanz zugeordnet sind.

 Extension GA

az iot ops secretsync disable

Deaktivieren Sie die geheime Synchronisierung für eine Instanz.

Alle geheimen Anbieterklassen, die der Instanz zugeordnet sind, und alle geheimen Synchronisierungen, die den klassen des geheimen Anbieters zugeordnet sind, werden gelöscht.

az iot ops secretsync disable --instance
                              --resource-group
                              [--yes {false, true}]

Beispiele

Deaktivieren Sie die geheime Synchronisierung für eine Instanz.

az iot ops secretsync disable --instance myinstance -g myresourcegroup

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.

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.

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

Aktivieren sie die geheime Synchronisierung für eine Instanz.

Der Vorgang behandelt den Identitätsverbund, die Erstellung einer Standardklasse des geheimen Anbieters und Rollenzuweisungen (Key Vault Reader, Key Vault Secrets User) der verwalteten Identität für den Zielschlüsseltresor.

Der Ablauf beginnt mit der Sicherstellung von Schlüsseltresor-Rollenzuweisungen, die angewendet werden, wenn sie nicht vorhanden sind. Wenn die Rollenzuweisungen nicht vorgenommen werden können, wird ein Fehler ausgelöst. Bei Bedarf kann eine benutzerdefinierte Rolle über "--custom-role-id" anstelle der integrierten Rollen verwendet werden. Oder das Flag "-skip-ra" kann verwendet werden, um Rollenzuweisungen zu überspringen.

az iot ops secretsync enable --instance
                             --kv-resource-id
                             --mi-user-assigned
                             --resource-group
                             [--custom-role-id]
                             [--self-hosted-issuer {false, true}]
                             [--skip-ra {false, true}]
                             [--spc]
                             [--tags]

Beispiele

Aktivieren Sie die Zielinstanz für die geheime Schlüsseltresor-Synchronisierung.

az iot ops secretsync enable --instance myinstance -g myresourcegroup --mi-user-assigned $UA_MI_RESOURCE_ID --kv-resource-id $KEYVAULT_RESOURCE_ID

Aktivieren Sie die geheime Synchronisierung, und wenden Sie Tags an, wenn Sie die Standardklasse des geheimen Anbieters erstellen.

az iot ops secretsync enable --instance myinstance -g myresourcegroup --mi-user-assigned $UA_MI_RESOURCE_ID --kv-resource-id $KEYVAULT_RESOURCE_ID --tags a=b c=d

Aktivieren Sie die geheime Synchronisierung mit benutzerdefinierter Rollen-ID für den Key Vault.

az iot ops secretsync enable --instance myinstance -g myresourcegroup --mi-user-assigned $UA_MI_RESOURCE_ID --kv-resource-id $KEYVAULT_RESOURCE_ID --custom-role-id $CUSTOM_ROLE_ID

Verwendung der Kennzeichnung zum Überspringen von Schlüsseltresor-Rollenzuweisungen.

az iot ops secretsync enable --instance myinstance -g myresourcegroup --mi-user-assigned $UA_MI_RESOURCE_ID --kv-resource-id $KEYVAULT_RESOURCE_ID --skip-ra

Erforderliche Parameter

--instance -i -n

IoT Operations-Instanzname.

--kv-resource-id

Key Vault ARM-Ressourcen-ID.

--mi-user-assigned

Die Ressourcen-ID für die gewünschte vom Benutzer zugewiesene verwaltete Identität, die mit der Instanz verwendet werden soll.

--resource-group -g

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

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.

--custom-role-id

Vollqualifizierte Rollendefinitions-ID im folgenden Format: /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/roleDefinitions/{roleId}.

Eigenschaft Wert
Parametergruppe: Role Assignment Arguments
--self-hosted-issuer

Verwenden Sie den selbst gehosteten oidc-Aussteller für den Partnerverbund.

Eigenschaft Wert
Zulässige Werte: false, true
--skip-ra

Bei Verwendung des Rollenzuweisungsschritts des Vorgangs wird übersprungen.

Eigenschaft Wert
Parametergruppe: Role Assignment Arguments
Zulässige Werte: false, true
--spc

Der Klassenname des standardmäßigen geheimen Anbieters für die Aktivierung der geheimen Synchronisierung. Das Standardmuster lautet "spc-ops-{hash}".

--tags

Durch Leerzeichen getrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.

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 list

Listet die geheimen Synchronisierungskonfigurationen auf, die einer Instanz zugeordnet sind.

az iot ops secretsync list --instance
                           --resource-group

Beispiele

Listet die geheimen Synchronisierungskonfigurationen auf, die einer Instanz zugeordnet sind.

az iot ops secretsync list --instance myinstance -g myresourcegroup

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.

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