az iot ops broker authn

Note

This reference is part of the azure-iot-ops extension for the Azure CLI (version 2.62.0 or higher). L’extension installe automatiquement la première fois que vous exécutez une commande az iot ops broker authn . Learn more about extensions.

Gestion de l’authentification du répartiteur Mqtt.

Commandes

Nom	Description	Type	État
az iot ops broker authn apply	Créez ou remplacez une ressource d’authentification du répartiteur mqtt.	Extension	GA
az iot ops broker authn delete	Supprimez une ressource d’authentification du répartiteur mqtt.	Extension	GA
az iot ops broker authn list	Répertoriez les ressources d’authentification du répartiteur mqtt associées à un répartiteur.	Extension	GA
az iot ops broker authn method	Opérations de méthode d’authentification du répartiteur Mqtt.	Extension	GA
az iot ops broker authn method add	Ajoutez des méthodes d’authentification à une ressource d’authentification du répartiteur mqtt.	Extension	GA
az iot ops broker authn show	Afficher les détails d’une ressource d’authentification du répartiteur mqtt.	Extension	GA

az iot ops broker authn apply

Créez ou remplacez une ressource d’authentification du répartiteur mqtt.

Voici un exemple de format de fichier de configuration :

{
    "authenticationMethods": [
        {
            "method": "Custom",
            "customSettings": {
                "endpoint": "https://auth-server-template",
                "caCertConfigMap": "custom-auth-ca",
                "auth": {
                    "x509": {
                        "secretRef": "custom-auth-client-cert"
                    }
                },
                "headers": {
                    "header_key": "header_value"
                }
            }
        },
        {
            "method": "ServiceAccountToken",
            "serviceAccountTokenSettings": {
                "audiences": [
                    "aio-internal",
                    "my-audience"
                ]
            }
        },
        {
            "method": "X509",
            "x509Settings": {
                "trustedClientCaCert": "client-ca",
                "authorizationAttributes": {
                    "root": {
                        "attributes": {
                            "organization": "contoso"
                        },
                        "subject": "CN = Contoso Root CA Cert, OU = Engineering, C = US"
                    },
                    "intermediate": {
                        "attributes": {
                            "city": "seattle",
                            "foo": "bar"
                        },
                        "subject": "CN = Contoso Intermediate CA"
                    },
                    "smartfan": {
                        "attributes": {
                            "building": "17"
                        },
                        "subject": "CN = smart-fan"
                    }
                }
            }
        }
    ]
}

Lorsqu’elle est utilisée avec l’application du contenu ci-dessus, crée ou remplace une ressource d’authentification cible configurée avec trois méthodes d’authentification.

az iot ops broker authn apply --config-file
                              --instance
                              --name
                              --resource-group
                              [--broker]

Exemples

Créez ou remplacez une ressource d’authentification pour le répartiteur par défaut à l’aide d’un fichier de configuration.

az iot ops broker authn apply -n authn --in myinstance -g myresourcegroup --config-file /path/to/authn/config.json

Paramètres obligatoires

--config-file

Chemin d’accès à un fichier de configuration contenant les propriétés de ressource au format json. Le fichier config doit contenir un objet avec des propriétés compatibles avec la représentation ARM de la ressource. L’objet est mis en corrélation directement avec les « propriétés »{} de la ressource ARM.

Propriété	Valeur
Parameter group:	Config Arguments

--instance -i

Nom de l’instance Des opérations IoT.

--name -n

Nom de la ressource d’authentification du répartiteur Mqtt.

--resource-group -g

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

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--broker -b

Nom du répartiteur Mqtt.

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

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

Output format.

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 à l’aide de 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 broker authn delete

Supprimez une ressource d’authentification du répartiteur mqtt.

az iot ops broker authn delete --instance
                               --name
                               --resource-group
                               [--broker]
                               [--yes {false, true}]

Exemples

Supprimez la ressource d’authentification du répartiteur appelée « authn » associée au répartiteur par défaut.

az iot ops broker authn delete -n authn --in myinstance -g myresourcegroup

Identique à l’exemple précédent, mais ignorez l’invite de confirmation.

az iot ops broker authn delete -n authn --in myinstance -g myresourcegroup -y

Paramètres obligatoires

--instance -i

Nom de l’instance Des opérations IoT.

--name -n

Nom de la ressource d’authentification du répartiteur Mqtt.

--resource-group -g

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

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--broker -b

Nom du répartiteur Mqtt.

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

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

Output format.

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 à l’aide de 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 broker authn list

Répertoriez les ressources d’authentification du répartiteur mqtt associées à un répartiteur.

az iot ops broker authn list --instance
                             --resource-group
                             [--broker]

Exemples

Énumérez toutes les ressources d’authentification broker associées au répartiteur par défaut.

az iot ops broker authn list --in myinstance -g myresourcegroup

Paramètres obligatoires

--instance -i

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

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--broker -b

Nom du répartiteur Mqtt.

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

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

Output format.

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 à l’aide de 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 broker authn show

Afficher les détails d’une ressource d’authentification du répartiteur mqtt.

az iot ops broker authn show --instance
                             --name
                             --resource-group
                             [--broker]

Exemples

Afficher les détails de la ressource d’authentification par défaut associée au répartiteur par défaut.

az iot ops broker authn show -n authn --in myinstance -g myresourcegroup

Paramètres obligatoires

--instance -i

Nom de l’instance Des opérations IoT.

--name -n

Nom de la ressource d’authentification du répartiteur Mqtt.

--resource-group -g

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

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--broker -b

Nom du répartiteur Mqtt.

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

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

Output format.

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 à l’aide de 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

Partager via

az iot ops broker authn

Commandes

az iot ops broker authn apply

Exemples

Paramètres obligatoires

Paramètres facultatifs

az iot ops broker authn delete

Exemples

Paramètres obligatoires

Paramètres facultatifs

az iot ops broker authn list

Exemples

Paramètres obligatoires

Paramètres facultatifs

az iot ops broker authn show

Exemples

Paramètres obligatoires

Paramètres facultatifs

Commentaires