Iot Hub Resource - Create Or Update

Cree o actualice los metadatos de un centro de IoT. El patrón habitual para modificar una propiedad es recuperar los metadatos de IoT Hub y los metadatos de seguridad y, después, combinarlos con los valores modificados en un nuevo cuerpo para actualizar el centro de IoT. Si faltan determinadas propiedades en json, la actualización de IoT Hub puede provocar que estos valores se realicen de forma predeterminada, lo que puede provocar un comportamiento inesperado.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2018-04-01

Parámetros de identificador URI

Name In Required Type Description
resourceGroupName
path True
  • string

Nombre del grupo de recursos que contiene el centro de IoT.

resourceName
path True
  • string

Nombre del centro de IoT.

subscriptionId
path True
  • string

Identificador de la suscripción.

api-version
query True
  • string

La versión de la API.

Encabezado de la solicitud

Name Required Type Description
If-Match
  • string

ETag del IoT Hub. No especifique para crear un nuevo IoT Hub. Necesario para actualizar un IoT Hub existente.

Cuerpo de la solicitud

Name Required Type Description
location True
  • string

Ubicación del recurso.

sku True

Información de SKU de IotHub

etag
  • string

El campo Etag no es obligatorio. Si se proporciona en el cuerpo de la respuesta, también debe proporcionarse como encabezado según la convención de ETag normal.

properties

Propiedades de IotHub

tags
  • object

Etiquetas del recurso.

Respuestas

Name Type Description
200 OK

Se devuelve como respuesta a la solicitud de sondeo de estado para la operación de creación o actualización. El cuerpo contiene la representación de recursos que indica un estado de aprovisionamiento transitorio.

201 Created

Se trata de una operación de ejecución prolongada. La operación devuelve un valor 201 si se completa la validación. La respuesta incluye un encabezado Azure-AsyncOperation que contiene una dirección URL de estado. Se espera que los clientes sondee la dirección URL de estado de la operación. Si se ejecuta correctamente, la operación devuelve el código de estado HTTP de 201 (Correcto).

Other Status Codes

DefaultErrorResponse

Seguridad

azure_auth

Azure Active Directory Flow OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

IotHubResource_CreateOrUpdate

Sample Request

PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub?api-version=2018-04-01

{
  "name": "iot-dps-cit-hub-1",
  "type": "Microsoft.Devices/IotHubs",
  "location": "centraluseuap",
  "tags": {},
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "operationsMonitoringProperties": {
      "events": {
        "None": "None",
        "Connections": "None",
        "DeviceTelemetry": "None",
        "C2DCommands": "None",
        "DeviceIdentityOperations": "None",
        "FileUploadOperations": "None",
        "Routes": "None"
      }
    },
    "state": "Active",
    "provisioningState": "Succeeded",
    "ipFilterRules": [],
    "hostName": "iot-dps-cit-hub-1.azure-devices.net",
    "eventHubEndpoints": {
      "events": {
        "retentionTimeInDays": 1,
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "path": "iot-dps-cit-hub-1",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
      },
      "operationsMonitoringEvents": {
        "retentionTimeInDays": 1,
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "path": "iot-dps-cit-hub-1-operationmonitoring",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": []
      },
      "routes": [],
      "fallbackRoute": {
        "name": "$fallback",
        "source": "DeviceMessages",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true
      }
    },
    "storageEndpoints": {
      "$default": {
        "sasTtlAsIso8601": "PT1H",
        "connectionString": "",
        "containerName": ""
      }
    },
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "enableFileUploadNotifications": false,
    "cloudToDevice": {
      "maxDeliveryCount": 10,
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "features": "None"
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}

Sample Response

{
  "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
  "name": "testHub",
  "type": "Microsoft.Devices/IotHubs",
  "location": "centraluseuap",
  "tags": {},
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "operationsMonitoringProperties": {
      "events": {
        "None": "None",
        "Connections": "None",
        "DeviceTelemetry": "None",
        "C2DCommands": "None",
        "DeviceIdentityOperations": "None",
        "FileUploadOperations": "None",
        "Routes": "None"
      }
    },
    "state": "Active",
    "provisioningState": "Succeeded",
    "ipFilterRules": [],
    "hostName": "iot-dps-cit-hub-1.azure-devices.net",
    "eventHubEndpoints": {
      "events": {
        "retentionTimeInDays": 1,
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "path": "iot-dps-cit-hub-1",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
      },
      "operationsMonitoringEvents": {
        "retentionTimeInDays": 1,
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "path": "iot-dps-cit-hub-1-operationmonitoring",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": []
      },
      "routes": [],
      "fallbackRoute": {
        "name": "$fallback",
        "source": "DeviceMessages",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true
      }
    },
    "storageEndpoints": {
      "$default": {
        "sasTtlAsIso8601": "PT1H",
        "connectionString": "",
        "containerName": ""
      }
    },
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "enableFileUploadNotifications": false,
    "cloudToDevice": {
      "maxDeliveryCount": 10,
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "features": "None"
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}
{
  "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
  "name": "testHub",
  "type": "Microsoft.Devices/IotHubs",
  "location": "centraluseuap",
  "tags": {},
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "operationsMonitoringProperties": {
      "events": {
        "None": "None",
        "Connections": "None",
        "DeviceTelemetry": "None",
        "C2DCommands": "None",
        "DeviceIdentityOperations": "None",
        "FileUploadOperations": "None",
        "Routes": "None"
      }
    },
    "state": "Active",
    "provisioningState": "Succeeded",
    "ipFilterRules": [],
    "hostName": "iot-dps-cit-hub-1.azure-devices.net",
    "eventHubEndpoints": {
      "events": {
        "retentionTimeInDays": 1,
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "path": "iot-dps-cit-hub-1",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
      },
      "operationsMonitoringEvents": {
        "retentionTimeInDays": 1,
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "path": "iot-dps-cit-hub-1-operationmonitoring",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": []
      },
      "routes": [],
      "fallbackRoute": {
        "name": "$fallback",
        "source": "DeviceMessages",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true
      }
    },
    "storageEndpoints": {
      "$default": {
        "sasTtlAsIso8601": "PT1H",
        "connectionString": "",
        "containerName": ""
      }
    },
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "enableFileUploadNotifications": false,
    "cloudToDevice": {
      "maxDeliveryCount": 10,
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "features": "None"
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}

Definiciones

AccessRights

Permisos asignados a la directiva de acceso compartido.

Capabilities

Las funcionalidades y características habilitadas para el centro de IoT.

CloudToDeviceProperties

Las propiedades de mensajería de nube a dispositivo de IoT Hub.

ErrorDetails

Detalles del error.

EventHubProperties

Las propiedades del punto de conexión compatible con Event Hubs aprovisionado que usa el centro de IoT.

FallbackRouteProperties

Las propiedades de la ruta de reserva. IoT Hub usa estas propiedades cuando enruta mensajes al punto de conexión de reserva.

FeedbackProperties

Las propiedades de la cola de comentarios para los mensajes de la nube al dispositivo.

IotHubDescription

Descripción del centro de IoT.

IotHubProperties

Propiedades de un centro de IoT.

IotHubSku

El nombre de la SKU.

IotHubSkuInfo

Información sobre la SKU del centro de IoT.

IotHubSkuTier

Nivel de facturación del centro de IoT.

IpFilterActionType

La acción deseada para las solicitudes capturadas por esta regla.

IpFilterRule

Reglas de filtro IP del centro de IoT.

MessagingEndpointProperties

Las propiedades de los puntos de conexión de mensajería usados por este centro de IoT.

OperationsMonitoringProperties

Las propiedades de supervisión de operaciones para ioT Hub. Las claves posibles para el diccionario son Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations, Routes, D2CTwinOperations, C2DTwinOperations, TwinQueries, JobsOperations, DirectMethods.

RouteProperties

Las propiedades de una regla de enrutamiento que usa ioT Hub para enrutar mensajes a puntos de conexión.

RoutingEndpoints

Las propiedades relacionadas con los puntos de conexión personalizados a los que ioT Hub enruta los mensajes en función de las reglas de enrutamiento. Se permiten un máximo de 10 puntos de conexión personalizados en todos los tipos de puntos de conexión para centros de pago y solo se permite 1 punto de conexión personalizado en todos los tipos de puntos de conexión para centros gratuitos.

RoutingEventHubProperties

Propiedades relacionadas con un punto de conexión del centro de eventos.

RoutingProperties

Las propiedades relacionadas con el enrutamiento del centro de IoT. Consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

RoutingServiceBusQueueEndpointProperties

Las propiedades relacionadas con los tipos de punto de conexión de cola de Service Bus.

RoutingServiceBusTopicEndpointProperties

Las propiedades relacionadas con los tipos de punto de conexión del tema de Service Bus.

RoutingSource

Origen al que se va a aplicar la regla de enrutamiento, como DeviceMessages.

RoutingStorageContainerProperties

Propiedades relacionadas con un punto de conexión de contenedor de almacenamiento.

SharedAccessSignatureAuthorizationRule

Las propiedades de una directiva de acceso compartido de IoT Hub.

StorageEndpointProperties

Las propiedades del punto de conexión de Azure Storage para la carga de archivos.

AccessRights

Permisos asignados a la directiva de acceso compartido.

Name Type Description
DeviceConnect
  • string
RegistryRead
  • string
RegistryRead, DeviceConnect
  • string
RegistryRead, RegistryWrite
  • string
RegistryRead, RegistryWrite, DeviceConnect
  • string
RegistryRead, RegistryWrite, ServiceConnect
  • string
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect
  • string
RegistryRead, ServiceConnect
  • string
RegistryRead, ServiceConnect, DeviceConnect
  • string
RegistryWrite
  • string
RegistryWrite, DeviceConnect
  • string
RegistryWrite, ServiceConnect
  • string
RegistryWrite, ServiceConnect, DeviceConnect
  • string
ServiceConnect
  • string
ServiceConnect, DeviceConnect
  • string

Capabilities

Las funcionalidades y características habilitadas para el centro de IoT.

Name Type Description
DeviceManagement
  • string
None
  • string

CloudToDeviceProperties

Las propiedades de mensajería de nube a dispositivo de IoT Hub.

Name Type Description
defaultTtlAsIso8601
  • string

El período de vida predeterminado para los mensajes de nube a dispositivo en la cola de dispositivos. Consulta: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

feedback

Las propiedades de la cola de comentarios para los mensajes de nube a dispositivo.

maxDeliveryCount
  • integer

Recuento máximo de entregas para los mensajes de nube a dispositivo en la cola de dispositivos. Consulta: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

ErrorDetails

Detalles del error.

Name Type Description
code
  • string

Código de error.

details
  • string

Los detalles del error.

httpStatusCode
  • string

El código de estado HTTP.

message
  • string

El mensaje de error.

EventHubProperties

Las propiedades del punto de conexión compatible con Event Hubs aprovisionado que usa el centro de IoT.

Name Type Description
endpoint
  • string

Punto de conexión compatible con Event Hubs.

partitionCount
  • integer

Número de particiones para recibir mensajes de dispositivo a nube en el punto de conexión compatible con Event Hubs. Consulta: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.

partitionIds
  • string[]

Identificadores de partición en el punto de conexión compatible con Event Hubs.

path
  • string

Nombre compatible con el centro de eventos.

retentionTimeInDays
  • integer

El tiempo de retención de los mensajes de dispositivo a nube en días. Consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

FallbackRouteProperties

Las propiedades de la ruta de reserva. IoT Hub usa estas propiedades cuando enruta mensajes al punto de conexión de reserva.

Name Type Description
condition
  • string

Condición que se evalúa para aplicar la ruta de reserva. Si la condición no se proporciona, se evaluará como true de forma predeterminada. Para la gramática, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpointNames
  • string[]

Lista de puntos de conexión a los que se enrutan los mensajes que cumplen la condición. Actualmente solo se permite 1 punto de conexión.

isEnabled
  • boolean

Se usa para especificar si la ruta de reserva está habilitada.

name
  • string

Nombre de la ruta. El nombre solo puede incluir caracteres alfanuméricos, puntos, caracteres de subrayado, guiones, tiene una longitud máxima de 64 caracteres y debe ser único.

source

Origen al que se va a aplicar la regla de enrutamiento. Por ejemplo, DeviceMessages

FeedbackProperties

Las propiedades de la cola de comentarios para los mensajes de la nube al dispositivo.

Name Type Description
lockDurationAsIso8601
  • string

Duración del bloqueo de la cola de comentarios. Consulta: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

maxDeliveryCount
  • integer

Número de veces que el centro de IoT intenta entregar un mensaje en la cola de comentarios. Consulta: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

ttlAsIso8601
  • string

Período de tiempo durante el que un mensaje está disponible para consumir antes de que el centro de IoT haya expirado. Consulta: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

IotHubDescription

Descripción del centro de IoT.

Name Type Description
etag
  • string

El campo Etag no es obligatorio. Si se proporciona en el cuerpo de la respuesta, también se debe proporcionar como un encabezado según la convención ETag normal.

id
  • string

Identificador de recurso.

location
  • string

Ubicación del recurso.

name
  • string

Nombre del recurso.

properties

Propiedades de IotHub

sku

Información de SKU de IotHub

tags
  • object

Etiquetas del recurso.

type
  • string

El tipo de recurso.

IotHubProperties

Propiedades de un centro de IoT.

Name Type Description
authorizationPolicies

Las directivas de acceso compartido que puede usar para proteger una conexión al centro de IoT.

cloudToDevice

Las propiedades de mensajería de nube a dispositivo de IoT Hub.

comments
  • string

Comentarios de IoT Hub.

enableFileUploadNotifications
  • boolean

Si es True, las notificaciones de carga de archivos están habilitadas.

eventHubEndpoints

Propiedades del punto de conexión compatible con Event Hubs. Las posibles claves de este diccionario son eventos y operacionesMonitoringEvents. Ambas claves deben estar presentes en el diccionario mientras se realizan llamadas de creación o actualización para ioT Hub.

features

Las funcionalidades y características habilitadas para el centro de IoT.

hostName
  • string

El nombre del host.

ipFilterRules

Reglas de filtro IP.

messagingEndpoints

Las propiedades del punto de conexión de mensajería para la cola de notificaciones de carga de archivos.

operationsMonitoringProperties

Las propiedades de supervisión de operaciones para ioT Hub. Las claves posibles para el diccionario son Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations, Routes, D2CTwinOperations, C2DTwinOperations, TwinQueries, JobsOperations, DirectMethods.

provisioningState
  • string

Estado de aprovisionamiento.

routing

Las propiedades relacionadas con el enrutamiento del centro de IoT. Consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

state
  • string

Estado del concentrador.

storageEndpoints

La lista de puntos de conexión de Azure Storage donde puede cargar archivos. Actualmente solo puede configurar una cuenta de Azure Storage y que DEBE tener su clave como $default. Si se especifica más de una cuenta de almacenamiento, se producirá un error. Si no se especifica un valor para esta propiedad cuando la propiedad enableFileUploadNotifications está establecida en True, se produce un error.

IotHubSku

El nombre de la SKU.

Name Type Description
B1
  • string
B2
  • string
B3
  • string
F1
  • string
S1
  • string
S2
  • string
S3
  • string

IotHubSkuInfo

Información sobre la SKU del centro de IoT.

Name Type Description
capacity
  • integer

Número de unidades de IoT Hub aprovisionadas. Consulta: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.

name

El nombre de la SKU.

tier

Nivel de facturación del centro de IoT.

IotHubSkuTier

Nivel de facturación del centro de IoT.

Name Type Description
Basic
  • string
Free
  • string
Standard
  • string

IpFilterActionType

La acción deseada para las solicitudes capturadas por esta regla.

Name Type Description
Accept
  • string
Reject
  • string

IpFilterRule

Reglas de filtro IP del centro de IoT.

Name Type Description
action

La acción deseada para las solicitudes capturadas por esta regla.

filterName
  • string

Nombre de la regla de filtro IP.

ipMask
  • string

Cadena que contiene el intervalo de direcciones IP en notación CIDR para la regla.

MessagingEndpointProperties

Las propiedades de los puntos de conexión de mensajería usados por este centro de IoT.

Name Type Description
lockDurationAsIso8601
  • string

Duración del bloqueo. Consulta: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

maxDeliveryCount
  • integer

Número de veces que el centro de IoT intenta entregar un mensaje. Consulta: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

ttlAsIso8601
  • string

Período de tiempo durante el que un mensaje está disponible para consumir antes de que el centro de IoT expire. Consulta: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

OperationsMonitoringProperties

Las propiedades de supervisión de operaciones para ioT Hub. Las claves posibles para el diccionario son Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations, Routes, D2CTwinOperations, C2DTwinOperations, TwinQueries, JobsOperations, DirectMethods.

Name Type Description
events
  • object

RouteProperties

Las propiedades de una regla de enrutamiento que usa ioT Hub para enrutar mensajes a puntos de conexión.

Name Type Description
condition
  • string

Condición que se evalúa para aplicar la regla de enrutamiento. Si no se proporciona ninguna condición, se evalúa como true de forma predeterminada. Para la gramática, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpointNames
  • string[]

Lista de puntos de conexión a los que se enrutan los mensajes que cumplen la condición. Actualmente solo se permite un punto de conexión.

isEnabled
  • boolean

Se usa para especificar si una ruta está habilitada.

name
  • string

Nombre de la ruta. El nombre solo puede incluir caracteres alfanuméricos, puntos, caracteres de subrayado, guiones, tiene una longitud máxima de 64 caracteres y debe ser único.

source

Origen al que se va a aplicar la regla de enrutamiento, como DeviceMessages.

RoutingEndpoints

Las propiedades relacionadas con los puntos de conexión personalizados a los que ioT Hub enruta los mensajes en función de las reglas de enrutamiento. Se permiten un máximo de 10 puntos de conexión personalizados en todos los tipos de puntos de conexión para centros de pago y solo se permite 1 punto de conexión personalizado en todos los tipos de puntos de conexión para centros gratuitos.

Name Type Description
eventHubs

La lista de puntos de conexión de Event Hubs a los que IoT Hub enruta los mensajes, en función de las reglas de enrutamiento. Esta lista no incluye el punto de conexión integrado de Event Hubs.

serviceBusQueues

Lista de Service Bus puntos de conexión de cola a los que IoT Hub enruta los mensajes en función de las reglas de enrutamiento.

serviceBusTopics

La lista de puntos de conexión de Service Bus tema a los que ioT Hub enruta los mensajes, en función de las reglas de enrutamiento.

storageContainers

La lista de puntos de conexión de contenedor de almacenamiento a los que IoT Hub enruta los mensajes, en función de las reglas de enrutamiento.

RoutingEventHubProperties

Propiedades relacionadas con un punto de conexión del centro de eventos.

Name Type Description
connectionString
  • string

El cadena de conexión del punto de conexión del centro de eventos.

name
  • string

Nombre que identifica este punto de conexión. El nombre solo puede incluir caracteres alfanuméricos, puntos, caracteres de subrayado, guiones y tiene una longitud máxima de 64 caracteres. Los nombres siguientes son reservados: eventos, operacionesMonitoringEvents, fileNotifications, $default. Los nombres de los puntos de conexión deben ser únicos en los tipos de punto de conexión.

resourceGroup
  • string

Nombre del grupo de recursos del punto de conexión del centro de eventos.

subscriptionId
  • string

Identificador de suscripción del punto de conexión del centro de eventos.

RoutingProperties

Las propiedades relacionadas con el enrutamiento del centro de IoT. Consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Name Type Description
endpoints

Las propiedades relacionadas con los puntos de conexión personalizados a los que ioT Hub enruta los mensajes en función de las reglas de enrutamiento. Se permiten un máximo de 10 puntos de conexión personalizados en todos los tipos de puntos de conexión para centros de pago y solo se permite 1 punto de conexión personalizado en todos los tipos de puntos de conexión para centros gratuitos.

fallbackRoute

Las propiedades de la ruta que se usa como ruta de reserva cuando no se cumple ninguna de las condiciones especificadas en la sección "rutas". Se trata de un parámetro opcional. Cuando no se establece esta propiedad, los mensajes que no cumplen ninguna de las condiciones especificadas en la sección "routes" se enrutan al punto de conexión del centro de eventos integrado.

routes

Lista de reglas de enrutamiento proporcionadas por el usuario que el centro de IoT usa para enrutar mensajes a puntos de conexión integrados y personalizados. Se permiten un máximo de 100 reglas de enrutamiento para centros de pago y se permiten un máximo de 5 reglas de enrutamiento para centros gratuitos.

RoutingServiceBusQueueEndpointProperties

Las propiedades relacionadas con los tipos de punto de conexión de cola de Service Bus.

Name Type Description
connectionString
  • string

El cadena de conexión del punto de conexión de cola de Service Bus.

name
  • string

Nombre que identifica este punto de conexión. El nombre solo puede incluir caracteres alfanuméricos, puntos, caracteres de subrayado, guiones y tiene una longitud máxima de 64 caracteres. Los nombres siguientes son reservados: eventos, operacionesMonitoringEvents, fileNotifications, $default. Los nombres de los puntos de conexión deben ser únicos en los tipos de punto de conexión. El nombre no debe ser el mismo que el nombre real de la cola.

resourceGroup
  • string

Nombre del grupo de recursos del punto de conexión de cola de Service Bus.

subscriptionId
  • string

Identificador de suscripción del punto de conexión de la cola de Service Bus.

RoutingServiceBusTopicEndpointProperties

Las propiedades relacionadas con los tipos de punto de conexión del tema de Service Bus.

Name Type Description
connectionString
  • string

El cadena de conexión del punto de conexión del tema de Service Bus.

name
  • string

Nombre que identifica este punto de conexión. El nombre solo puede incluir caracteres alfanuméricos, puntos, caracteres de subrayado, guiones y tiene una longitud máxima de 64 caracteres. Los nombres siguientes son reservados: eventos, operacionesMonitoringEvents, fileNotifications, $default. Los nombres de los puntos de conexión deben ser únicos en los tipos de punto de conexión. El nombre no debe ser el mismo que el nombre real del tema.

resourceGroup
  • string

Nombre del grupo de recursos del punto de conexión del tema de Service Bus.

subscriptionId
  • string

Identificador de suscripción del punto de conexión del tema de Service Bus.

RoutingSource

Origen al que se va a aplicar la regla de enrutamiento, como DeviceMessages.

Name Type Description
DeviceJobLifecycleEvents
  • string
DeviceLifecycleEvents
  • string
DeviceMessages
  • string
Invalid
  • string
TwinChangeEvents
  • string

RoutingStorageContainerProperties

Propiedades relacionadas con un punto de conexión de contenedor de almacenamiento.

Name Type Description
batchFrequencyInSeconds
  • integer

Intervalo de tiempo en el que se escriben blobs en el almacenamiento. El valor debe estar entre 60 y 720 segundos. El valor predeterminado es 300 segundos.

connectionString
  • string

El cadena de conexión de la cuenta de almacenamiento.

containerName
  • string

Nombre del contenedor de almacenamiento en la cuenta de almacenamiento.

encoding
  • string

Codificación que se usa para serializar mensajes en blobs. Los valores admitidos son "avro" y "avroDeflate". El valor predeterminado es "avro".

fileNameFormat
  • string

Formato de nombre de archivo para el blob. El formato predeterminado es {iothub}/{partition}/{AAAA}/{MM}/{DD}/{HH}/{mm}. Todos los parámetros son obligatorios, pero se pueden reordenar.

maxChunkSizeInBytes
  • integer

Número máximo de bytes para cada blob escrito en el almacenamiento. El valor debe estar entre 10485760(10 MB) y 524288000(500 MB). El valor predeterminado es 314572800(300 MB).

name
  • string

Nombre que identifica este punto de conexión. El nombre solo puede incluir caracteres alfanuméricos, puntos, caracteres de subrayado, guiones y tiene una longitud máxima de 64 caracteres. Los nombres siguientes son reservados: eventos, operacionesMonitoringEvents, fileNotifications, $default. Los nombres de los puntos de conexión deben ser únicos en los tipos de punto de conexión.

resourceGroup
  • string

Nombre del grupo de recursos de la cuenta de almacenamiento.

subscriptionId
  • string

Identificador de suscripción de la cuenta de almacenamiento.

SharedAccessSignatureAuthorizationRule

Las propiedades de una directiva de acceso compartido de IoT Hub.

Name Type Description
keyName
  • string

Nombre de la directiva de acceso compartido.

primaryKey
  • string

Clave principal.

rights

Permisos asignados a la directiva de acceso compartido.

secondaryKey
  • string

Clave secundaria.

StorageEndpointProperties

Las propiedades del punto de conexión de Azure Storage para la carga de archivos.

Name Type Description
connectionString
  • string

El cadena de conexión de la cuenta de Azure Storage en la que se cargan los archivos.

containerName
  • string

Nombre del contenedor raíz donde se cargan los archivos. El contenedor no necesita existir, pero debe ser creable mediante connectionString especificado.

sasTtlAsIso8601
  • string

El período de tiempo durante el que el URI de SAS generado por IoT Hub para la carga de archivos es válido. Consulta: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.