az iot hub message-endpoint update

  • Vista previa
  • Referencia

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 hub message-endpoint update . Obtenga más información sobre las extensiones.

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

Actualice las propiedades de un punto de conexión existente para una instancia de IoT Hub.

Comandos

Nombre Description Tipo Estado
az iot hub message-endpoint update cosmosdb-container

Actualice las propiedades de un punto de conexión de contenedor de Cosmos DB existente para ioT Hub.

 Extensión Vista previa
az iot hub message-endpoint update eventhub

Actualice las propiedades de un punto de conexión de Centro de eventos existente para una instancia de IoT Hub.

 Extensión Vista previa
az iot hub message-endpoint update servicebus-queue

Actualice las propiedades de un punto de conexión de cola de Service Bus existente para ioT Hub.

 Extensión Vista previa
az iot hub message-endpoint update servicebus-topic

Actualice las propiedades de un punto de conexión de tema de Service Bus existente para ioT Hub.

 Extensión Vista previa
az iot hub message-endpoint update storage-container

Actualice las propiedades de un punto de conexión de contenedor de almacenamiento existente para ioT Hub.

 Extensión Vista previa

az iot hub message-endpoint update cosmosdb-container

Vista previa

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

Actualice las propiedades de un punto de conexión de contenedor de Cosmos DB existente para ioT Hub.

Si actualiza el tipo de autenticación de un punto de conexión de contenedor de Cosmos DB basado en claves a basado en identidades, debe proporcionar la identidad (a través de --identity) y el URI del punto de conexión (a través de --endpoint-uri). La clave principal antigua y la clave secundaria se anularán.

Si actualiza el tipo de autenticación de un punto de conexión de contenedor de Cosmos DB basado en claves basado en claves, debe proporcionar el cadena de conexión (a través de --connection-string), la clave principal (a través de --primary-key) o la clave secundaria (a través de --secondary-key).

No se puede cambiar el nombre del contenedor para el punto de conexión. Los nombres de cuenta solo se pueden cambiar si existen contenedores con el mismo nombre en ambas cuentas.

az iot hub message-endpoint update cosmosdb-container --en
                                                      --hub-name
                                                      [--connection-string]
                                                      [--database-name]
                                                      [--endpoint-resource-group]
                                                      [--endpoint-subscription-id]
                                                      [--endpoint-uri]
                                                      [--identity]
                                                      [--partition-key-name]
                                                      [--partition-key-template]
                                                      [--pk]
                                                      [--resource-group]
                                                      [--secondary-key]

Ejemplos

Actualice un punto de conexión de contenedor de Cosmos DB basado en claves o basado en identidades para que ioT Hub use un nuevo cadena de conexión especificado.

az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --connection-string {connection_string}

Actualice un punto de conexión de contenedor de Cosmos DB para que ioT Hub use una clave principal y una clave secundaria especificadas.

az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --pk {primary_key} --sk {secondary_key}

Actualice un punto de conexión de contenedor de Cosmos DB para que ioT Hub use la identidad asignada por el sistema y un nombre de clave de partición. La plantilla de clave de partición será la predeterminada.

az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --pkn {partition_key_name} --identity [system]

Actualice un punto de conexión de contenedor de Cosmos DB basado en claves para que ioT Hub use la identidad asignada por el usuario (puede omitir --endpoint-uri si el punto de conexión ya está basado en identidad).

az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri}

Parámetros requeridos

--en --endpoint --endpoint-name

Nombre del punto de conexión de enrutamiento.

--hub-name -n

Nombre de IoT Hub.

Parámetros opcionales

--connection-string -c

Cadena de conexión del punto de conexión de enrutamiento.

--database-name --db

Nombre de la base de datos de Cosmos DB en la cuenta de cosmos DB.

--endpoint-resource-group --erg -r

Grupo de recursos del punto de conexión. Si no se proporciona, se usará el grupo de recursos de IoT Hub.

--endpoint-subscription-id -s

Identificador de suscripción del recurso punto de conexión. Si no se proporciona, se usará la suscripción de IoT Hub.

--endpoint-uri

Identificador URI del recurso de punto de conexión.

--identity

Use una identidad administrada asignada por el sistema o asignada por el usuario para la autenticación de punto de conexión. Use "[system]" para hacer referencia a la identidad asignada por el sistema o a un identificador de recurso para hacer referencia a una identidad asignada por el usuario.

--partition-key-name --pkn

Nombre de la clave de partición asociada a este contenedor SQL de Cosmos DB si existe. Para borrar esta propiedad, establezca esta propiedad en "".

--partition-key-template --pkt

Plantilla para generar un valor de clave de partición sintética para su uso con este contenedor sql de Cosmos DB. La plantilla debe incluir al menos uno de los siguientes marcadores de posición: {iothub}, {deviceid}, {DD}, {MM}y {AAAA}. Se puede especificar un marcador de posición como máximo una vez, pero los componentes order y non-placeholder son arbitrarios. Si se proporciona el nombre de clave de partición, la plantilla de clave de partición tiene como valor predeterminado {deviceid}-{AAAA}-{MM}. Para borrar esta propiedad, establezca esta propiedad en "".

--pk --primary-key

Clave principal de la cuenta de Cosmos DB.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--secondary-key --sk

Clave secundaria de la cuenta de Cosmos DB.

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 hub message-endpoint update eventhub

Vista previa

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

Actualice las propiedades de un punto de conexión de Centro de eventos existente para una instancia de IoT Hub.

Si actualiza el tipo de autenticación de un punto de conexión del centro de eventos basado en claves a basado en identidad, debe proporcionar la identidad (a través de --identity), el URI del punto de conexión (a través de --endpoint-uri) y la ruta de acceso de entidad (a través de --entity-path). El cadena de conexión anterior se anulará.

Si actualiza el tipo de autenticación de un punto de conexión del centro de eventos basado en identidades a un punto de conexión del centro de eventos basado en claves, debe proporcionar el cadena de conexión (a través de --connection-string). El URI del punto de conexión antiguo y la ruta de acceso de entidad se anularán.

az iot hub message-endpoint update eventhub --en
                                            --hub-name
                                            [--connection-string]
                                            [--endpoint-resource-group]
                                            [--endpoint-subscription-id]
                                            [--endpoint-uri]
                                            [--entity-path]
                                            [--identity]
                                            [--resource-group]

Ejemplos

Actualice un punto de conexión de Centro de eventos basado en claves o basado en identidades para que ioT Hub use un nuevo cadena de conexión especificado.

az iot hub message-endpoint update eventhub -n {iothub_name} --en {endpoint_name} -c {connection_string}

Actualice un punto de conexión del centro de eventos para que ioT Hub use la identidad asignada por el sistema y una ruta de acceso de entidad diferente.

az iot hub message-endpoint update eventhub -n {iothub_name} --en {endpoint_name} --entity-path {entity_path} --identity [system]

Actualice un punto de conexión del centro de eventos basado en claves para que ioT Hub use la identidad asignada por el usuario (puede omitir --endpoint-uri si el punto de conexión ya está basado en identidad).

az iot hub message-endpoint update eventhub -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri} --entity-path {entity_path}

Parámetros requeridos

--en --endpoint --endpoint-name

Nombre del punto de conexión de enrutamiento.

--hub-name -n

Nombre de IoT Hub.

Parámetros opcionales

--connection-string -c

Cadena de conexión del punto de conexión de enrutamiento.

--endpoint-resource-group --erg -r

Grupo de recursos del punto de conexión. Si no se proporciona, se usará el grupo de recursos de IoT Hub.

--endpoint-subscription-id -s

Identificador de suscripción del recurso punto de conexión. Si no se proporciona, se usará la suscripción de IoT Hub.

--endpoint-uri

Identificador URI del recurso de punto de conexión.

--entity-path

Ruta de acceso de entidad del recurso de punto de conexión.

--identity

Use una identidad administrada asignada por el sistema o asignada por el usuario para la autenticación de punto de conexión. Use "[system]" para hacer referencia a la identidad asignada por el sistema o a un identificador de recurso para hacer referencia a una identidad asignada por el usuario.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

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 hub message-endpoint update servicebus-queue

Vista previa

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

Actualice las propiedades de un punto de conexión de cola de Service Bus existente para ioT Hub.

Si actualiza el tipo de autenticación de un punto de conexión de cola de Service Bus basado en claves a una identidad, debe proporcionar la identidad (a través de --identity), el URI del punto de conexión (a través de --endpoint-uri) y la ruta de acceso de entidad (a través de --entity-path). El cadena de conexión anterior se anulará.

Si actualiza el tipo de autenticación de un punto de conexión de cola de Service Bus basado en claves a una clave, debe proporcionar el cadena de conexión (a través de --connection-string). El URI del punto de conexión antiguo y la ruta de acceso de entidad se anularán.

az iot hub message-endpoint update servicebus-queue --en
                                                    --hub-name
                                                    [--connection-string]
                                                    [--endpoint-resource-group]
                                                    [--endpoint-subscription-id]
                                                    [--endpoint-uri]
                                                    [--entity-path]
                                                    [--identity]
                                                    [--resource-group]

Ejemplos

Actualice un punto de conexión de cola de Service Bus basado en claves o basado en identidades para que ioT Hub use un nuevo cadena de conexión especificado.

az iot hub message-endpoint update servicebus-queue -n {iothub_name} --en {endpoint_name} -c {connection_string}

Actualice un punto de conexión de cola de Service Bus para que ioT Hub use la identidad asignada por el sistema y una ruta de acceso de entidad diferente.

az iot hub message-endpoint update servicebus-queue -n {iothub_name} --en {endpoint_name} --entity-path {entity_path} --identity [system]

Actualice un punto de conexión de cola de Service Bus basado en claves para que ioT Hub use la identidad asignada por el usuario (puede omitir --endpoint-uri si el punto de conexión ya está basado en identidad).

az iot hub message-endpoint update servicebus-queue -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri} --entity-path {entity_path}

Parámetros requeridos

--en --endpoint --endpoint-name

Nombre del punto de conexión de enrutamiento.

--hub-name -n

Nombre de IoT Hub.

Parámetros opcionales

--connection-string -c

Cadena de conexión del punto de conexión de enrutamiento.

--endpoint-resource-group --erg -r

Grupo de recursos del punto de conexión. Si no se proporciona, se usará el grupo de recursos de IoT Hub.

--endpoint-subscription-id -s

Identificador de suscripción del recurso punto de conexión. Si no se proporciona, se usará la suscripción de IoT Hub.

--endpoint-uri

Identificador URI del recurso de punto de conexión.

--entity-path

Ruta de acceso de entidad del recurso de punto de conexión.

--identity

Use una identidad administrada asignada por el sistema o asignada por el usuario para la autenticación de punto de conexión. Use "[system]" para hacer referencia a la identidad asignada por el sistema o a un identificador de recurso para hacer referencia a una identidad asignada por el usuario.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

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 hub message-endpoint update servicebus-topic

Vista previa

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

Actualice las propiedades de un punto de conexión de tema de Service Bus existente para ioT Hub.

Si actualiza el tipo de autenticación de un punto de conexión de tema de Service Bus basado en claves a basado en identidades, debe proporcionar la identidad (a través de --identity), el URI del punto de conexión (a través de --endpoint-uri) y la ruta de acceso de entidad (a través de --entity-path). El cadena de conexión anterior se anulará.

Si actualiza el tipo de autenticación de un punto de conexión de tema de Service Bus basado en identidad a clave, debe proporcionar el cadena de conexión (a través de --connection-string). El URI del punto de conexión antiguo y la ruta de acceso de entidad se anularán.

az iot hub message-endpoint update servicebus-topic --en
                                                    --hub-name
                                                    [--connection-string]
                                                    [--endpoint-resource-group]
                                                    [--endpoint-subscription-id]
                                                    [--endpoint-uri]
                                                    [--entity-path]
                                                    [--identity]
                                                    [--resource-group]

Ejemplos

Actualice un punto de conexión de tema de Service Bus basado en claves o basado en identidades para que ioT Hub use un nuevo cadena de conexión especificado.

az iot hub message-endpoint update servicebus-topic -n {iothub_name} --en {endpoint_name} -c {connection_string}

Actualice un punto de conexión de tema de Service Bus para que ioT Hub use la identidad asignada por el sistema y una ruta de acceso de entidad diferente.

az iot hub message-endpoint update servicebus-topic -n {iothub_name} --en {endpoint_name} --entity-path {entity_path} --identity [system]

Actualice un punto de conexión de tema de Service Bus basado en claves para que ioT Hub use la identidad asignada por el usuario (puede omitir --endpoint-uri si el punto de conexión ya está basado en identidad).

az iot hub message-endpoint update servicebus-topic -n {iothub_name} --en {endpoint_name}  --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri} --entity-path {entity_path}

Parámetros requeridos

--en --endpoint --endpoint-name

Nombre del punto de conexión de enrutamiento.

--hub-name -n

Nombre de IoT Hub.

Parámetros opcionales

--connection-string -c

Cadena de conexión del punto de conexión de enrutamiento.

--endpoint-resource-group --erg -r

Grupo de recursos del punto de conexión. Si no se proporciona, se usará el grupo de recursos de IoT Hub.

--endpoint-subscription-id -s

Identificador de suscripción del recurso punto de conexión. Si no se proporciona, se usará la suscripción de IoT Hub.

--endpoint-uri

Identificador URI del recurso de punto de conexión.

--entity-path

Ruta de acceso de entidad del recurso de punto de conexión.

--identity

Use una identidad administrada asignada por el sistema o asignada por el usuario para la autenticación de punto de conexión. Use "[system]" para hacer referencia a la identidad asignada por el sistema o a un identificador de recurso para hacer referencia a una identidad asignada por el usuario.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

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 hub message-endpoint update storage-container

Vista previa

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

Actualice las propiedades de un punto de conexión de contenedor de almacenamiento existente para ioT Hub.

Si actualiza el tipo de autenticación de un punto de conexión de contenedor de almacenamiento basado en claves a basado en identidades, debe proporcionar la identidad (a través de --identity) y el URI del punto de conexión (a través de --endpoint-uri). El cadena de conexión anterior se anulará.

Si actualiza el tipo de autenticación de un punto de conexión de contenedor de almacenamiento basado en identidad a basado en claves, debe proporcionar el cadena de conexión (a través de --connection-string).

No se puede cambiar el nombre y la codificación del contenedor para el punto de conexión. Los nombres de cuenta solo se pueden cambiar si existen contenedores con el mismo nombre en ambas cuentas.

az iot hub message-endpoint update storage-container --en
                                                     --hub-name
                                                     [--batch-frequency]
                                                     [--chunk-size]
                                                     [--connection-string]
                                                     [--endpoint-resource-group]
                                                     [--endpoint-subscription-id]
                                                     [--endpoint-uri]
                                                     [--ff]
                                                     [--identity]
                                                     [--resource-group]

Ejemplos

Actualice un punto de conexión de contenedor de almacenamiento basado en claves o basado en identidades para que ioT Hub use un nuevo cadena de conexión especificado.

az iot hub message-endpoint update storage-container -n {iothub_name} --en {endpoint_name} -c {connection_string}

Actualice un punto de conexión de contenedor de almacenamiento para que ioT Hub use la identidad asignada por el sistema con la frecuencia del lote, el tamaño del fragmento y el formato de nombre de archivo especificados.

az iot hub message-endpoint update storage-container -n {iothub_name} --en {endpoint_name}  -b {batch_frequency} -w {chunk_size} --ff {file_format} --identity [system]

Actualice un punto de conexión de contenedor de almacenamiento basado en claves para que ioT Hub use la identidad asignada por el usuario (puede omitir --endpoint-uri si el punto de conexión ya está basado en identidad).

az iot hub message-endpoint update storage-container -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri}

Parámetros requeridos

--en --endpoint --endpoint-name

Nombre del punto de conexión de enrutamiento.

--hub-name -n

Nombre de IoT Hub.

Parámetros opcionales

--batch-frequency -b

Frecuencia del lote de solicitud en segundos. Cantidad máxima de tiempo que puede transcurrir antes de que los datos se escriban en un blob, entre 60 y 720 segundos.

--chunk-size -w

Tamaño del fragmento de solicitud en megabytes(MB). Tamaño máximo de blobs, entre 10 y 500 MB.

--connection-string -c

Cadena de conexión del punto de conexión de enrutamiento.

--endpoint-resource-group --erg -r

Grupo de recursos del punto de conexión. Si no se proporciona, se usará el grupo de recursos de IoT Hub.

--endpoint-subscription-id -s

Identificador de suscripción del recurso punto de conexión. Si no se proporciona, se usará la suscripción de IoT Hub.

--endpoint-uri

Identificador URI del recurso de punto de conexión.

--ff --file-name-format

Formato de nombre de archivo para el blob. El formato de nombre de archivo debe contener {iothub}, {partition}, {AAAA}, {MM}, {DD}, {HH} y {mm} campos. Todos los parámetros son obligatorios, pero se pueden reordenar con o sin delimitadores.

--identity

Use una identidad administrada asignada por el sistema o asignada por el usuario para la autenticación de punto de conexión. Use "[system]" para hacer referencia a la identidad asignada por el sistema o a un identificador de recurso para hacer referencia a una identidad asignada por el usuario.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

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.