az iot central export
Note
Esta referencia forma parte de la extensión azure-iot para la CLI de Azure (versión 2.67.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az iot central export. Obtenga más información sobre las extensiones.
Este grupo de comandos está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus
Administrar y configurar exportaciones de datos de IoT Central.
Comandos
| Nombre | Description | Tipo | Estado |
|---|---|---|---|
| az iot central export create |
Cree una exportación para una aplicación de IoT Central. |
Extension | Preview |
| az iot central export delete |
Elimine una exportación de una aplicación de IoT Central. |
Extension | Preview |
| az iot central export destination |
Administrar y configurar destinos de exportación de IoT Central. |
Extension | Preview |
| az iot central export destination create |
Cree un destino de exportación para una aplicación de IoT Central. |
Extension | Preview |
| az iot central export destination delete |
Elimine un destino de exportación para una aplicación de IoT Central. |
Extension | Preview |
| az iot central export destination list |
Obtenga la lista completa de destinos de exportación para una aplicación de IoT Central. |
Extension | Preview |
| az iot central export destination show |
Obtenga los detalles de un destino de exportación. |
Extension | Preview |
| az iot central export destination update |
Actualice un destino de exportación para una aplicación de IoT Central. |
Extension | Preview |
| az iot central export list |
Obtenga la lista completa de exportaciones de una aplicación de IoT Central. |
Extension | Preview |
| az iot central export show |
Obtenga los detalles de la exportación. |
Extension | Preview |
| az iot central export update |
Actualice una exportación para una aplicación de IoT Central. |
Extension | Preview |
az iot central export create
El grupo de comandos "iot central export" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus
Cree una exportación para una aplicación de 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]
Ejemplos
Creación de una exportación con filtros, enriquecimientos, destinos
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 }"
}
]'
Parámetros requeridos
El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.
Lista de destinos con transformación.
Nombre para mostrar de exportación de datos.
Identificador único de la exportación.
Origen de exportación de datos.
| Propiedad | Valor |
|---|---|
| Valores aceptados: | deviceConnectivity, deviceLifecycle, deviceTemplateLifecycle, properties, telemetry |
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
El argumento "api_version" está en desuso y se quitará en una versión futura.
Versión de la API para la operación solicitada.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | 2022-06-30-preview |
| Valores aceptados: | 2022-06-30-preview |
Sufijo DNS de IoT Central asociado a la aplicación.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | azureiotcentral.com |
Enriquecimiento de exportación de datos.
Estado habilitado para la exportación de datos, True o False.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | True |
| Valores aceptados: | false, true |
Filtro basado en lenguaje de consulta de IoT Central, más detalles de: aka.ms/iotcquery.
Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az iot central export delete
El grupo de comandos "iot central export" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus
Elimine una exportación de una aplicación de 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]
Ejemplos
Eliminar una exportación
az iot central export delete --app-id {appid} --export-id {exportid}
Parámetros requeridos
El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.
Identificador único de la exportación.
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
El argumento "api_version" está en desuso y se quitará en una versión futura.
Versión de la API para la operación solicitada.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | 2022-06-30-preview |
| Valores aceptados: | 2022-06-30-preview |
Sufijo DNS de IoT Central asociado a la aplicación.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | azureiotcentral.com |
Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az iot central export list
El grupo de comandos "iot central export" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus
Obtenga la lista completa de exportaciones de una aplicación de IoT Central.
az iot central export list --app-id
[--api-version --av {2022-06-30-preview}]
[--central-api-uri --central-dns-suffix]
[--token]
Ejemplos
Enumerar todas las exportaciones de una aplicación
az iot central export list --app-id {appid}
Parámetros requeridos
El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
El argumento "api_version" está en desuso y se quitará en una versión futura.
Versión de la API para la operación solicitada.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | 2022-06-30-preview |
| Valores aceptados: | 2022-06-30-preview |
Sufijo DNS de IoT Central asociado a la aplicación.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | azureiotcentral.com |
Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az iot central export show
El grupo de comandos "iot central export" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus
Obtenga los detalles de la exportación.
az iot central export show --app-id
--export-id --id
[--api-version --av {2022-06-30-preview}]
[--central-api-uri --central-dns-suffix]
[--token]
Ejemplos
Obtención de detalles de exportación
az iot central export show --app-id {appid} --export-id {exportid}
Parámetros requeridos
El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.
Identificador único de la exportación.
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
El argumento "api_version" está en desuso y se quitará en una versión futura.
Versión de la API para la operación solicitada.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | 2022-06-30-preview |
| Valores aceptados: | 2022-06-30-preview |
Sufijo DNS de IoT Central asociado a la aplicación.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | azureiotcentral.com |
Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az iot central export update
El grupo de comandos "iot central export" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus
Actualice una exportación para una aplicación de IoT Central.
El origen es inmutable una vez creada una exportación.
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]
Ejemplos
Actualización de una exportación desde un archivo
az iot central export update --app-id {appid} --export-id {exportid} --content './filepath/payload.json'
Actualizar el nombre para mostrar de una exportación y habilitar la exportación desde la carga json
az iot central export update --app-id {appid} --export-id {exportid} --content "{'displayName': 'Updated Export Name', 'enabled': true}"
Parámetros requeridos
El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.
Definición de exportación parcial. Proporcione la ruta de acceso al archivo JSON o json con cadena sin formato. [Ejemplo de ruta de acceso de archivo:./path/to/file.json] [Ejemplo de JSON con cadena:{Export Data JSON}]. El cuerpo de la solicitud debe contener contenido parcial de Export.
Identificador único de la exportación.
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
El argumento "api_version" está en desuso y se quitará en una versión futura.
Versión de la API para la operación solicitada.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | 2022-06-30-preview |
| Valores aceptados: | 2022-06-30-preview |
Sufijo DNS de IoT Central asociado a la aplicación.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | azureiotcentral.com |
Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |