az iot central export

Préversion
Référence

Remarque

Cette référence fait partie de l’extension azure-iot pour Azure CLI (version 2.46.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande az iot central export . En savoir plus sur les extensions.

Ce groupe de commandes est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Gérez et configurez les exportations de données IoT Central.

Commandes

Nom	Description	Type	État
az iot central export create	Créez une exportation pour une application IoT Central.	Extension	Aperçu
az iot central export delete	Supprimez une exportation pour une application IoT Central.	Extension	Aperçu
az iot central export destination	Gérez et configurez les destinations d’exportation IoT Central.	Extension	Aperçu
az iot central export destination create	Créez une destination d’exportation pour une application IoT Central.	Extension	Aperçu
az iot central export destination delete	Supprimez une destination d’exportation pour une application IoT Central.	Extension	Aperçu
az iot central export destination list	Obtenez la liste complète des destinations d’exportation pour une application IoT Central.	Extension	Aperçu
az iot central export destination show	Obtenir les détails d’une destination d’exportation.	Extension	Aperçu
az iot central export destination update	Mettez à jour une destination d’exportation pour une application IoT Central.	Extension	Aperçu
az iot central export list	Obtenez la liste complète des exportations pour une application IoT Central.	Extension	Aperçu
az iot central export show	Obtenez des détails d’exportation.	Extension	Aperçu
az iot central export update	Mettez à jour une exportation pour une application IoT Central.	Extension	Aperçu

az iot central export create

Préversion

Le groupe de commandes « exportation centrale iot » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Créez une exportation pour une application IoT Central.

az iot central export create --app-id
                             --destinations
                             --display-name
                             --export-id
                             --source {deviceConnectivity, deviceLifecycle, deviceTemplateLifecycle, properties, telemetry}
                             [--api-version {2022-06-30-preview}]
                             [--central-api-uri]
                             [--en]
                             [--enabled {false, true}]
                             [--filter]
                             [--token]

Exemples

Créer une exportation avec filtre, enrichissements, destinations

az iot central export create --app-id {appid} --export-id {exportid} --enabled {enabled} --display-name {displayname} --source {source} --filter "SELECT * FROM devices WHERE $displayName != "abc" AND $id = "a"" --enrichments '{
  "simulated": {
    "path": "$simulated"
  }
}' --destinations '[
  {
    "id": "{destinationid}",
    "transform": "{ ApplicationId: .applicationId, Component: .component, DeviceName: .device.name }"
  }
]'

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--destinations --dests

Liste des destinations avec transformation.

--display-name --name

Nom complet de l’exportation de données.

--export-id --id

Identificateur unique de l’exportation.

--source -s

Source d’exportation de données.

Valeurs acceptées: deviceConnectivity, deviceLifecycle, deviceTemplateLifecycle, properties, telemetry

Paramètres facultatifs

--api-version --av

Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Version de l’API pour l’opération demandée.

Valeurs acceptées: 2022-06-30-preview

Valeur par défaut: 2022-06-30-preview

--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com

--en --enrichments

Enrichissement de l’exportation des données.

--enabled -e

État activé pour l’exportation de données, True ou False.

Valeurs acceptées: false, true

Valeur par défaut: True

--filter -f

Filtre basé sur le langage de requête IoT Central, plus de détails à partir de : aka.ms/iotcquery.

--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

Paramètres globaux

--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc

Valeur par défaut: json

--query

Chaîne de requêtes 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 détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az iot central export delete

Préversion

Le groupe de commandes « exportation centrale iot » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Supprimez une exportation pour une application IoT Central.

az iot central export delete --app-id
                             --export-id
                             [--api-version {2022-06-30-preview}]
                             [--central-api-uri]
                             [--token]

Exemples

Supprimer une exportation

az iot central export delete --app-id {appid} --export-id {exportid}

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--export-id --id

Identificateur unique de l’exportation.

Paramètres facultatifs

--api-version --av

Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Version de l’API pour l’opération demandée.

Valeurs acceptées: 2022-06-30-preview

Valeur par défaut: 2022-06-30-preview

--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com

--token

Paramètres globaux

--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc

Valeur par défaut: json

--query

Chaîne de requêtes 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 détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az iot central export list

Préversion

Le groupe de commandes « exportation centrale iot » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Obtenez la liste complète des exportations pour une application IoT Central.

az iot central export list --app-id
                           [--api-version {2022-06-30-preview}]
                           [--central-api-uri]
                           [--token]

Exemples

Répertorier toutes les exportations dans une application

az iot central export list --app-id {appid}

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

Paramètres facultatifs

--api-version --av

Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Version de l’API pour l’opération demandée.

Valeurs acceptées: 2022-06-30-preview

Valeur par défaut: 2022-06-30-preview

--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com

--token

Paramètres globaux

--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc

Valeur par défaut: json

--query

Chaîne de requêtes 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 détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az iot central export show

Préversion

Le groupe de commandes « exportation centrale iot » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Obtenez des détails d’exportation.

az iot central export show --app-id
                           --export-id
                           [--api-version {2022-06-30-preview}]
                           [--central-api-uri]
                           [--token]

Exemples

Obtenir des détails d’exportation

az iot central export show --app-id {appid} --export-id {exportid}

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--export-id --id

Identificateur unique de l’exportation.

Paramètres facultatifs

--api-version --av

Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Version de l’API pour l’opération demandée.

Valeurs acceptées: 2022-06-30-preview

Valeur par défaut: 2022-06-30-preview

--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com

--token

Paramètres globaux

--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc

Valeur par défaut: json

--query

Chaîne de requêtes 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 détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az iot central export update

Préversion

Le groupe de commandes « exportation centrale iot » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Mettez à jour une exportation pour une application IoT Central.

La source est immuable une fois qu’une exportation est créée.

az iot central export update --app-id
                             --content
                             --export-id
                             [--api-version {2022-06-30-preview}]
                             [--central-api-uri]
                             [--token]

Exemples

Mettre à jour une exportation à partir d’un fichier

az iot central export update --app-id {appid} --export-id {exportid} --content './filepath/payload.json'

Mettre à jour le nom d’affichage d’une exportation et activer l’exportation à partir de la charge utile json

az iot central export update --app-id {appid} --export-id {exportid} --content "{'displayName': 'Updated Export Name', 'enabled': true}"

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--content -k

Définition d’exportation partielle. Fournissez le chemin d’accès au fichier JSON ou au fichier JSON brut en chaîne. [Exemple de chemin de fichier :./path/to/file.json] [Exemple de JSON stringified :{}]. Le corps de la demande doit contenir du contenu partiel d’exportation.

--export-id --id

Identificateur unique de l’exportation.

Paramètres facultatifs

--api-version --av

Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Version de l’API pour l’opération demandée.

Valeurs acceptées: 2022-06-30-preview

Valeur par défaut: 2022-06-30-preview

--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com

--token

Paramètres globaux

--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc

Valeur par défaut: json

--query

Chaîne de requêtes 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 détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

Partager via

az iot central export

Commandes

az iot central export create

Exemples

Paramètres obligatoires

Paramètres facultatifs

az iot central export delete

Exemples

Paramètres obligatoires

Paramètres facultatifs

az iot central export list

Exemples

Paramètres obligatoires

Paramètres facultatifs

az iot central export show

Exemples

Paramètres obligatoires

Paramètres facultatifs

az iot central export update

Exemples

Paramètres obligatoires

Paramètres facultatifs

Ressources supplémentaires