Partager via


az iot central export

Note

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

Ce groupe de commandes est en préversion et en cours de développement. Niveaux de référence et 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 Preview
az iot central export delete

Supprimez une exportation pour une application IoT Central.

Extension Preview
az iot central export destination

Gérez et configurez les destinations d’exportation IoT Central.

Extension Preview
az iot central export destination create

Créez une destination d’exportation pour une application IoT Central.

Extension Preview
az iot central export destination delete

Supprimez une destination d’exportation pour une application IoT Central.

Extension Preview
az iot central export destination list

Obtenez la liste complète des destinations d’exportation pour une application IoT Central.

Extension Preview
az iot central export destination show

Obtenir les détails d’une destination d’exportation.

Extension Preview
az iot central export destination update

Mettez à jour une destination d’exportation pour une application IoT Central.

Extension Preview
az iot central export list

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

Extension Preview
az iot central export show

Obtenez des détails d’exportation.

Extension Preview
az iot central export update

Mettez à jour une exportation pour une application IoT Central.

Extension Preview

az iot central export create

Préversion

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

Créez une exportation pour une application IoT Central.

az iot central export create --app-id
                             --destinations --dests
                             --display-name --name
                             --export-id --id
                             --source {deviceConnectivity, deviceLifecycle, deviceTemplateLifecycle, properties, telemetry}
                             [--api-version --av {2022-06-30-preview}]
                             [--central-api-uri --central-dns-suffix]
                             [--en --enrichments]
                             [--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.

Propriété Valeur
Valeurs acceptées: deviceConnectivity, deviceLifecycle, deviceTemplateLifecycle, properties, telemetry

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.

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

Propriété Valeur
Valeur par défaut: 2022-06-30-preview
Valeurs acceptées: 2022-06-30-preview
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Propriété Valeur
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.

Propriété Valeur
Valeur par défaut: True
Valeurs acceptées: false, 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. En savoir plus sur https://aka.ms/iotcentraldocsapi.

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 à 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 central export delete

Préversion

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

Supprimez une exportation pour une application IoT Central.

az iot central export delete --app-id
                             --export-id --id
                             [--api-version --av {2022-06-30-preview}]
                             [--central-api-uri --central-dns-suffix]
                             [--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

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.

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

Propriété Valeur
Valeur par défaut: 2022-06-30-preview
Valeurs acceptées: 2022-06-30-preview
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Propriété Valeur
Valeur par défaut: azureiotcentral.com
--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. En savoir plus sur https://aka.ms/iotcentraldocsapi.

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 à 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 central export list

Préversion

Le groupe de commandes « exportation centrale iot » est en préversion et en cours de développement. Niveaux de référence et 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 --av {2022-06-30-preview}]
                           [--central-api-uri --central-dns-suffix]
                           [--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

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.

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

Propriété Valeur
Valeur par défaut: 2022-06-30-preview
Valeurs acceptées: 2022-06-30-preview
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Propriété Valeur
Valeur par défaut: azureiotcentral.com
--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. En savoir plus sur https://aka.ms/iotcentraldocsapi.

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 à 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 central export show

Préversion

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

Obtenez des détails d’exportation.

az iot central export show --app-id
                           --export-id --id
                           [--api-version --av {2022-06-30-preview}]
                           [--central-api-uri --central-dns-suffix]
                           [--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

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.

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

Propriété Valeur
Valeur par défaut: 2022-06-30-preview
Valeurs acceptées: 2022-06-30-preview
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Propriété Valeur
Valeur par défaut: azureiotcentral.com
--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. En savoir plus sur https://aka.ms/iotcentraldocsapi.

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 à 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 central export update

Préversion

Le groupe de commandes « exportation centrale iot » est en préversion et en cours de développement. Niveaux de référence et 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 --id
                             [--api-version --av {2022-06-30-preview}]
                             [--central-api-uri --central-dns-suffix]
                             [--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 :{Exporter des données JSON}]. Le corps de la demande doit contenir du contenu partiel d’exportation.

--export-id --id

Identificateur unique de l’exportation.

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.

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

Propriété Valeur
Valeur par défaut: 2022-06-30-preview
Valeurs acceptées: 2022-06-30-preview
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Propriété Valeur
Valeur par défaut: azureiotcentral.com
--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. En savoir plus sur https://aka.ms/iotcentraldocsapi.

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