az iot central export destination

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 destination . En savoir plus sur les extensions.

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

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

Commandes

Nom	Description	Type	État
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 destination create

Préversion

Le groupe de commandes « destination d’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 destination d’exportation pour une application IoT Central.

az iot central export destination create --app-id
                                         --dest-id
                                         --display-name
                                         --type {blobstorage@v1, dataexplorer@v1, eventhubs@v1, servicebusqueue@v1, servicebustopic@v1, webhook@v1}
                                         [--api-version {2022-06-30-preview}]
                                         [--au]
                                         [--central-api-uri]
                                         [--cluster-url]
                                         [--database]
                                         [--header]
                                         [--table]
                                         [--token]
                                         [--url]

Exemples

Créer une destination d’exportation de webhook avec une charge utile json

az iot central export destination create --app-id {appid} --dest-id {destinationid} --name {displayname} --url {url} --type webhook@v1 --header '{"x-custom-region":{"value":"westus", "secret": false}}'

Créer une destination d’exportation de stockage d’objets blob avec une charge utile json

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type blobstorage@v1 --name {displayname} --authorization '{
  "type": "connectionString",
  "connectionString":"DefaultEndpointsProtocol=https;AccountName=[accountName];AccountKey=[key];EndpointSuffix=core.windows.net",
  "containerName": "test"
}'

Créer une destination d’exportation Azure Data Explorer avec une charge utile json

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type dataexplorer@v1 --name {displayname} --cluster-url {clusterurl} --database {database} --table {table} --authorization '{
  "type": "servicePrincipal",
  "clientId": "3b420743-2020-44c6-9b70-cc42f945db0x",
  "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
  "clientSecret": "[Secret]"
}'

Créer une destination d’exportation Event Hub avec une charge utile json

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type eventhubs@v1 --name {displayname} --authorization '{
  "type": "connectionString",
  "connectionString": "Endpoint=sb://[hubName].servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=*****;EntityPath=entityPath1"
}'

Créer une destination de file d’attente Service Bus avec une charge utile json

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type servicebusqueue@v1 --name {displayname} --authorization '{
  "type": "connectionString",
  "connectionString": "Endpoint=sb://[namespance].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=[key];EntityPath=[name]"
}'

Créer une destination de rubrique Service Bus avec une charge utile json

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type servicebustopic@v1 --name {displayname} --authorization '{
  "type": "connectionString",
  "connectionString": "Endpoint=sb://[namespace].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=[key];EntityPath=[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.

--dest-id

Identificateur unique pour la destination d’exportation.

--display-name --name

Nom complet de destination.

--type -t

Type de destination.

Valeurs acceptées: blobstorage@v1, dataexplorer@v1, eventhubs@v1, servicebusqueue@v1, servicebustopic@v1, webhook@v1

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

--au --authorization

Configuration d’autorisation dans json.

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

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com

--cluster-url --cu

URL du cluster Azure Data Explorer.

--database

Base de données Azure Data Explorer.

--header

Collection d’en-têtes custimized de destination webhook dans json.

--table

Table Azure Data Explorer.

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

--url

URL du webhook.

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

Préversion

Le groupe de commandes « destination d’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 destination d’exportation pour une application IoT Central.

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

Exemples

Supprimer une destination d’exportation

az iot central export destination delete --app-id {appid} --dest-id {destinationid}

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.

--dest-id

Identificateur unique pour la destination d’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 destination list

Préversion

Le groupe de commandes « destination d’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 destinations d’exportation pour une application IoT Central.

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

Exemples

Répertorier toutes les destinations d’exportation dans une application

az iot central export destination 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 destination show

Préversion

Le groupe de commandes « destination d’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

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

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

Exemples

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

az iot central export destination show --app-id {appid} --dest-id {destinationid}

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.

--dest-id

Identificateur unique pour la destination d’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 destination update

Préversion

Le groupe de commandes « destination d’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 destination d’exportation pour une application IoT Central.

Le type de destination est immuable une fois qu’il est créé. Une nouvelle destination doit être créée avec le nouveau type.

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

Exemples

Mettre à jour une destination d’exportation à partir d’un fichier

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

Mettre à jour une destination d’exportation avec une charge utile json-patch

az iot central export destination update --app-id {appid} --dest-id {destinationid} --content '{"displayName": "Web Hook Updated"}'

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 de destination 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 requête doit contenir du contenu partiel de destination.

--dest-id

Identificateur unique pour la destination d’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 destination

Commandes

az iot central export destination create

Exemples

Paramètres obligatoires

Paramètres facultatifs

az iot central export destination delete

Exemples

Paramètres obligatoires

Paramètres facultatifs

az iot central export destination list

Exemples

Paramètres obligatoires

Paramètres facultatifs

az iot central export destination show

Exemples

Paramètres obligatoires

Paramètres facultatifs

az iot central export destination update

Exemples

Paramètres obligatoires

Paramètres facultatifs

Ressources supplémentaires