az iot ops secretsync secret

Note

Cette référence fait partie de l’extension azure-iot-ops pour la Azure CLI (version 2.70.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande secrète secretsync az iot ops . Apprenez-en davantage sur les extensions.

Gérer des secrets individuels dans les ressources SecretSync.

Commandes

Nom Description Type État
az iot ops secretsync secret list

Répertorier les secrets dans une ressource SecretSync.

Extension GA
az iot ops secretsync secret remove

Supprimez un secret spécifique d’une ressource SecretSync. Si tous les secrets sont supprimés, la ressource SecretSync elle-même est automatiquement supprimée.

Extension GA
az iot ops secretsync secret set

Définissez des mappages de secrets AKV sur une ressource SecretSync.

Extension GA

az iot ops secretsync secret list

Répertorier les secrets dans une ressource SecretSync.

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

Exemples

Répertorier les secrets dans une ressource SecretSync spécifique.

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

Paramètres obligatoires

--instance -i -n

Nom de l’instance Des opérations IoT.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--secret-sync-name

Nom de la ressource SecretSync.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az iot ops secretsync secret remove

Supprimez un secret spécifique d’une ressource SecretSync. Si tous les secrets sont supprimés, la ressource SecretSync elle-même est automatiquement supprimée.

Supprime l’entrée secrète de l’objet SecretSync ObjectSecretMapping. S’il s’agit du dernier secret dans SecretSync, la ressource SecretSync entière est supprimée, car l’API ARM n’autorise pas secretSync avec zéro mappage de secrets.

Avant de supprimer le secret du SPC partagé, une vérification du nombre de références est effectuée sur tous les SecretsSyncs à l’emplacement personnalisé. L’entrée SPC est supprimée uniquement si aucun autre SecretSync ne fait toujours référence au même secret AKV. Cela empêche la rupture d’autres consommateurs du SPC partagé.

Cette commande ne supprime pas le secret de Azure Key Vault.

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

Exemples

Supprimez un secret d’un secret SecretSync.

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

Supprimez un secret sans invite de confirmation.

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

Paramètres obligatoires

--instance -i -n

Nom de l’instance Des opérations IoT.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--secret-name

Nom du secret AKV (valeur sourcePath) à supprimer de SecretSync.

--secret-sync-name

Nom de la ressource SecretSync.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--acquire-policy-token

Acquisition automatique d’un jeton Azure Policy pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--change-reference

ID de référence de modification associé pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--yes -y

Confirmez [y]es sans invite. Utile pour les scénarios CI et Automation.

Propriété Valeur
Valeurs acceptées: false, true
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az iot ops secretsync secret set

Définissez des mappages de secrets AKV sur une ressource SecretSync.

Résout la classe de fournisseur de secrets par défaut (SPC) de l’instance, vérifie que chaque secret AKV existe, ajoute chaque secret à la liste des objets du SPC et crée ou fusionne des entrées dans la ressource SecretSync nommée.

Si SecretSync existe déjà, de nouvelles entrées secrètes sont fusionnées. Les entrées existantes portant le même nom de secret AKV auront leur clé cible mise à jour.

La valeur --secret-sync-name devient le nom du secret K8s. Les consommateurs le référencent via <secret-sync-name>/<target-key> des points de terminaison d’appareil ou uniquement <secret-sync-name> pour les points de terminaison de flux de données.

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

Exemples

Créez une authentification de certificat SecretSync pour le point de terminaison d’appareil x509.

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

Ajoutez un autre secret à un secretSync existant (fusion idempotente).

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

Créez un point de terminaison de flux de données basé sur SECRETSync pour SASL.

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

Paramètres obligatoires

--instance -i -n

Nom de l’instance Des opérations IoT.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--secret-map

Mappage de secrets AKV au format <akv-secret-name>=<target-key>. Répétable. Le secret AKV doit exister.

--secret-sync-name

Nom de la ressource ARM SecretSync et du secret K8s résultant.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--acquire-policy-token

Acquisition automatique d’un jeton Azure Policy pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--change-reference

ID de référence de modification associé pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False