az iot central export destination

Nota:

Esta referencia forma parte de la extensión azure-iot para la CLI de Azure (versión 2.46.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az iot central export destination . Obtenga más información sobre las extensiones.

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

Administrar y configurar destinos de exportación de IoT Central.

Comandos

Nombre	Description	Tipo	Estado
az iot central export destination create	Cree un destino de exportación para una aplicación de IoT Central.	Extensión	Vista previa
az iot central export destination delete	Elimine un destino de exportación para una aplicación de IoT Central.	Extensión	Vista previa
az iot central export destination list	Obtenga la lista completa de destinos de exportación para una aplicación de IoT Central.	Extensión	Vista previa
az iot central export destination show	Obtenga los detalles de un destino de exportación.	Extensión	Vista previa
az iot central export destination update	Actualice un destino de exportación para una aplicación de IoT Central.	Extensión	Vista previa

az iot central export destination create

Vista previa

El grupo de comandos "destino de exportación central de iot" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Cree un destino de exportación para una aplicación de 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]

Ejemplos

Creación de un destino de exportación de webhook con carga 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}}'

Creación de un destino de exportación de Blob Storage con carga 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"
}'

Creación de un destino de exportación de Azure Data Explorer con carga 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]"
}'

Creación de un destino de exportación del centro de eventos con carga 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"
}'

Creación de un destino de cola de Service Bus con carga 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]"
}'

Creación de un destino de tema de Service Bus con carga 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]"
}'

Parámetros requeridos

--app-id -n

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.

--dest-id

Identificador único para el destino de exportación.

--display-name --name

Nombre para mostrar de destino.

--type -t

Tipo de destino.

Valores aceptados: blobstorage@v1, dataexplorer@v1, eventhubs@v1, servicebusqueue@v1, servicebustopic@v1, webhook@v1

Parámetros opcionales

--api-version --av

Obsoleto

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.

Valores aceptados: 2022-06-30-preview

Valor predeterminado: 2022-06-30-preview

--au --authorization

Configuración de autorización en json.

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

Sufijo DNS de IoT Central asociado a la aplicación.

Valor predeterminado: azureiotcentral.com

--cluster-url --cu

Dirección URL del clúster de Azure Data Explorer.

--database

Base de datos de Azure Data Explorer.

--header

Colección de encabezados custimized de destino de webhook en json.

--table

Tabla del Explorador de datos de Azure.

--token

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.

--url

Dirección URL del webhook.

Parámetros globales

--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

Valor predeterminado: json

--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az iot central export destination delete

Vista previa

El grupo de comandos "destino de exportación central de iot" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Elimine un destino de exportación para una aplicación de IoT Central.

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

Ejemplos

Eliminar un destino de exportación

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

Parámetros requeridos

--app-id -n

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.

--dest-id

Identificador único para el destino de exportación.

Parámetros opcionales

--api-version --av

Obsoleto

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.

Valores aceptados: 2022-06-30-preview

Valor predeterminado: 2022-06-30-preview

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

Sufijo DNS de IoT Central asociado a la aplicación.

Valor predeterminado: azureiotcentral.com

--token

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

--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

Valor predeterminado: json

--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az iot central export destination list

Vista previa

El grupo de comandos "destino de exportación central de iot" 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 destinos de exportación para una aplicación de IoT Central.

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

Ejemplos

Enumerar todos los destinos de exportación de una aplicación

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

Parámetros requeridos

--app-id -n

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

--api-version --av

Obsoleto

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.

Valores aceptados: 2022-06-30-preview

Valor predeterminado: 2022-06-30-preview

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

Sufijo DNS de IoT Central asociado a la aplicación.

Valor predeterminado: azureiotcentral.com

--token

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

--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

Valor predeterminado: json

--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az iot central export destination show

Vista previa

El grupo de comandos "destino de exportación central de iot" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Obtenga los detalles de un destino de exportación.

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

Ejemplos

Obtención de detalles de destino de exportación

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

Parámetros requeridos

--app-id -n

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.

--dest-id

Identificador único para el destino de exportación.

Parámetros opcionales

--api-version --av

Obsoleto

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.

Valores aceptados: 2022-06-30-preview

Valor predeterminado: 2022-06-30-preview

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

Sufijo DNS de IoT Central asociado a la aplicación.

Valor predeterminado: azureiotcentral.com

--token

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

--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

Valor predeterminado: json

--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az iot central export destination update

Vista previa

El grupo de comandos "destino de exportación central de iot" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Actualice un destino de exportación para una aplicación de IoT Central.

El tipo de destino es inmutable una vez creado. Se debe crear un nuevo destino con el nuevo tipo.

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

Ejemplos

Actualización de un destino de exportación desde el archivo

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

Actualización de un destino de exportación con carga de json-patch

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

Parámetros requeridos

--app-id -n

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.

--content -k

Definición de destino 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:{}]. El cuerpo de la solicitud debe contener contenido parcial de Destination.

--dest-id

Identificador único para el destino de exportación.

Parámetros opcionales

--api-version --av

Obsoleto

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.

Valores aceptados: 2022-06-30-preview

Valor predeterminado: 2022-06-30-preview

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

Sufijo DNS de IoT Central asociado a la aplicación.

Valor predeterminado: azureiotcentral.com

--token

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

--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

Valor predeterminado: json

--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.