Microsoft.Devices IotHubs

Artículo
12/09/2024

Definición de recursos de Bicep

El tipo de recurso IotHubs se puede implementar con operaciones destinadas a:

grupos de recursos: consulte comandos de implementación de grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.Devices/IotHubs, agregue lo siguiente a la plantilla de Bicep.

resource symbolicname 'Microsoft.Devices/IotHubs@2023-06-30' = {
  etag: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    allowedFqdnList: [
      'string'
    ]
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
      }
    ]
    cloudToDevice: {
      defaultTtlAsIso8601: 'string'
      feedback: {
        lockDurationAsIso8601: 'string'
        maxDeliveryCount: int
        ttlAsIso8601: 'string'
      }
      maxDeliveryCount: int
    }
    comments: 'string'
    disableDeviceSAS: bool
    disableLocalAuth: bool
    disableModuleSAS: bool
    enableDataResidency: bool
    enableFileUploadNotifications: bool
    eventHubEndpoints: {
      {customized property}: {
        partitionCount: int
        retentionTimeInDays: int
      }
    }
    features: 'string'
    ipFilterRules: [
      {
        action: 'string'
        filterName: 'string'
        ipMask: 'string'
      }
    ]
    messagingEndpoints: {
      {customized property}: {
        lockDurationAsIso8601: 'string'
        maxDeliveryCount: int
        ttlAsIso8601: 'string'
      }
    }
    minTlsVersion: 'string'
    networkRuleSets: {
      applyToBuiltInEventHubEndpoint: bool
      defaultAction: 'string'
      ipRules: [
        {
          action: 'string'
          filterName: 'string'
          ipMask: 'string'
        }
      ]
    }
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    publicNetworkAccess: 'string'
    restrictOutboundNetworkAccess: bool
    routing: {
      endpoints: {
        cosmosDBSqlContainers: [
          {
            authenticationType: 'string'
            containerName: 'string'
            databaseName: 'string'
            endpointUri: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            name: 'string'
            partitionKeyName: 'string'
            partitionKeyTemplate: 'string'
            primaryKey: 'string'
            resourceGroup: 'string'
            secondaryKey: 'string'
            subscriptionId: 'string'
          }
        ]
        eventHubs: [
          {
            authenticationType: 'string'
            connectionString: 'string'
            endpointUri: 'string'
            entityPath: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        serviceBusQueues: [
          {
            authenticationType: 'string'
            connectionString: 'string'
            endpointUri: 'string'
            entityPath: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        serviceBusTopics: [
          {
            authenticationType: 'string'
            connectionString: 'string'
            endpointUri: 'string'
            entityPath: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        storageContainers: [
          {
            authenticationType: 'string'
            batchFrequencyInSeconds: int
            connectionString: 'string'
            containerName: 'string'
            encoding: 'string'
            endpointUri: 'string'
            fileNameFormat: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            maxChunkSizeInBytes: int
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
      }
      enrichments: [
        {
          endpointNames: [
            'string'
          ]
          key: 'string'
          value: 'string'
        }
      ]
      fallbackRoute: {
        condition: 'string'
        endpointNames: [
          'string'
        ]
        isEnabled: bool
        name: 'string'
        source: 'string'
      }
      routes: [
        {
          condition: 'string'
          endpointNames: [
            'string'
          ]
          isEnabled: bool
          name: 'string'
          source: 'string'
        }
      ]
    }
    storageEndpoints: {
      {customized property}: {
        authenticationType: 'string'
        connectionString: 'string'
        containerName: 'string'
        identity: {
          userAssignedIdentity: 'string'
        }
        sasTtlAsIso8601: 'string'
      }
    }
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propiedad

ArmIdentity

Nombre	Descripción	Valor
tipo	Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio.	'Ninguno' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned'
userAssignedIdentities	Diccionario de <> ArmUserIdentity	ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

Nombre	Descripción	Valor

ArmUserIdentity

Nombre	Descripción	Valor

CloudToDeviceProperties

Nombre	Descripción	Valor
defaultTtlAsIso8601	El período de vida predeterminado para los mensajes de nube a dispositivo en la cola de dispositivos. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	cuerda
retroalimentación	Las propiedades de la cola de comentarios para los mensajes de nube a dispositivo.	FeedbackProperties
maxDeliveryCount	Recuento máximo de entregas para mensajes de nube a dispositivo en la cola de dispositivos. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Restricciones: Valor mínimo = 1 Valor máximo = 100

EnrichmentProperties

Nombre	Descripción	Valor
endpointNames	Lista de puntos de conexión para los que se aplica el enriquecimiento al mensaje.	string[] (obligatorio)
llave	Clave o nombre de la propiedad de enriquecimiento.	string (obligatorio)
valor	Valor de la propiedad de enriquecimiento.	string (obligatorio)

EventHubProperties

Nombre	Descripción	Valor
partitionCount	Número de particiones para recibir mensajes de dispositivo a nube en el punto de conexión compatible con Event Hubs. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.	Int
retentionTimeInDays	Tiempo de retención de mensajes de dispositivo a nube en días. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	Int

FallbackRouteProperties

Nombre	Descripción	Valor
condición	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 : /azure/iot-hub/iot-hub-devguide-query-language	cuerda
endpointNames	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.	string[] (obligatorio)
isEnabled	Se usa para especificar si la ruta de reserva está habilitada.	bool (obligatorio)
nombre	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.	cuerda
fuente	Origen al que se va a aplicar la regla de enrutamiento. Por ejemplo, DeviceMessages	'DeviceConnectionStateEvents' "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" 'No válido' 'TwinChangeEvents' (obligatorio)

FeedbackProperties

Nombre	Descripción	Valor
lockDurationAsIso8601	Duración del bloqueo de la cola de comentarios. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	cuerda
maxDeliveryCount	Número de veces que el centro de IoT intenta entregar un mensaje en la cola de comentarios. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Restricciones: Valor mínimo = 1 Valor máximo = 100
ttlAsIso8601	Período de tiempo durante el que un mensaje está disponible para consumir antes de que el centro de IoT expire. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	cuerda

IotHubProperties

Nombre	Descripción	Valor
allowedFqdnList	Lista de FQDN permitidos (nombre de dominio completo) para la salida de Iot Hub.	string[]
authorizationPolicies	Las directivas de acceso compartido que puede usar para proteger una conexión al centro de IoT.	SharedAccessSignatureAuthorizationRule[]
cloudToDevice	Las propiedades de mensajería de nube a dispositivo de IoT Hub.	CloudToDeviceProperties
Comentarios	Comentarios de IoT Hub.	cuerda
disableDeviceSAS	Si es true, no se pueden usar todas las claves SAS con ámbito de dispositivo (incluidos los dispositivos perimetrales, excepto los módulos) para la autenticación.	Bool
disableLocalAuth	Si es true, los tokens de SAS con claves SAS con ámbito de centro de IoT no se pueden usar para la autenticación.	Bool
disableModuleSAS	Si es true, no se pueden usar todas las claves SAS con ámbito del módulo para la autenticación.	Bool
enableDataResidency	Esta propiedad cuando se establece en true, habilitará la residencia de datos, por lo que deshabilitará la recuperación ante desastres.	Bool
enableFileUploadNotifications	Si es True, las notificaciones de carga de archivos están habilitadas.	Bool
eventHubEndpoints	Propiedades del punto de conexión compatible con Event Hubs. Las únicas claves posibles para este diccionario son los eventos. Esta clave debe estar presente en el diccionario al realizar llamadas de creación o actualización para IoT Hub.	IotHubPropertiesEventHubEndpoints
Funciones	Las funcionalidades y características habilitadas para ioT Hub.	"DeviceManagement" 'Ninguno'
ipFilterRules	Reglas de filtro IP.	ipFilterRule[]
messagingEndpoints	Propiedades del punto de conexión de mensajería para la cola de notificaciones de carga de archivos.	IotHubPropertiesMessagingEndpoints
minTlsVersion	Especifica la versión mínima de TLS que se va a admitir para este centro. Se puede establecer en "1.2" para que los clientes que usen una versión tls inferior a la 1.2 se rechacen.	cuerda
networkRuleSets	Propiedades del conjunto de reglas de red de IotHub	NetworkRuleSetProperties
privateEndpointConnections	Conexiones de punto de conexión privado creadas en este IotHub	privateEndpointConnection[]
publicNetworkAccess	Indica si se permiten solicitudes de la red pública	'Deshabilitado' 'Habilitado'
restrictOutboundNetworkAccess	Si es true, la salida de IotHub se restringirá solo a los FQDN permitidos configurados a través de allowedFqdnList.	Bool
enrutamiento	Las propiedades relacionadas con el enrutamiento del centro de IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging	RoutingProperties
storageEndpoints	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. Al especificar más de una cuenta de almacenamiento, se produce un error. Si no se especifica un valor para esta propiedad cuando la propiedad enableFileUploadNotifications está establecida en True, se produce un error.	IotHubPropertiesStorageEndpoints

IotHubPropertiesEventHubEndpoints

Nombre	Descripción	Valor

IotHubPropertiesMessagingEndpoints

Nombre	Descripción	Valor

IotHubPropertiesStorageEndpoints

Nombre	Descripción	Valor

IotHubSkuInfo

Nombre	Descripción	Valor
capacidad	Número de unidades de IoT Hub aprovisionadas. Consulte: /azure/azure-subscription-service-limits#iot-hub-limits.	Int
nombre	Nombre de la SKU.	'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' (obligatorio)

IpFilterRule

Nombre	Descripción	Valor
acción	Acción deseada para las solicitudes capturadas por esta regla.	'Aceptar' 'Reject' (obligatorio)
filterName	Nombre de la regla de filtro IP.	string (obligatorio)
ipMask	Cadena que contiene el intervalo de direcciones IP en notación CIDR para la regla.	string (obligatorio)

ManagedIdentity

Nombre	Descripción	Valor
userAssignedIdentity	Identidad asignada por el usuario.	cuerda

MessagingEndpointProperties

Nombre	Descripción	Valor
lockDurationAsIso8601	Duración del bloqueo. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload.	cuerda
maxDeliveryCount	Número de veces que el centro de IoT intenta entregar un mensaje. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload.	Int Restricciones: Valor mínimo = 1 Valor máximo = 100
ttlAsIso8601	Período de tiempo durante el que un mensaje está disponible para consumir antes de que el centro de IoT expire. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload.	cuerda

Microsoft.Devices/IotHubs

Nombre	Descripción	Valor
etag	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 ETag normal.	cuerda
identidad	Identidades administradas para IotHub.	ArmIdentity
ubicación	Ubicación del recurso.	string (obligatorio)
nombre	El nombre del recurso	string (obligatorio)
Propiedades	Propiedades de IotHub	IotHubProperties
Sku	Información de SKU de IotHub	IotHubSkuInfo (obligatorio)
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas

NetworkRuleSetIpRule

Nombre	Descripción	Valor
acción	Acción de filtro IP	'Permitir'
filterName	Nombre de la regla de filtro IP.	string (obligatorio)
ipMask	Cadena que contiene el intervalo de direcciones IP en notación CIDR para la regla.	string (obligatorio)

NetworkRuleSetProperties

Nombre	Descripción	Valor
applyToBuiltInEventHubEndpoint	Si es True, el conjunto de reglas de red también se aplica a BuiltIn EventHub EndPoint de IotHub.	bool (obligatorio)
defaultAction	Acción predeterminada para el conjunto de reglas de red	'Permitir' 'Denegar'
ipRules	Lista de reglas de IP	NetworkRuleSetIpRule[] (obligatorio)

PrivateEndpoint

Nombre	Descripción	Valor

PrivateEndpointConnection

Nombre	Descripción	Valor
Propiedades	Propiedades de una conexión de punto de conexión privado	privateEndpointConnectionProperties (obligatorio)

PrivateEndpointConnectionProperties

Nombre	Descripción	Valor
privateEndpoint	La propiedad de punto de conexión privado de una conexión de punto de conexión privado	PrivateEndpoint
privateLinkServiceConnectionState	Estado actual de una conexión de punto de conexión privado	privateLinkServiceConnectionState (obligatorio)

PrivateLinkServiceConnectionState

Nombre	Descripción	Valor
actionsRequired	Acciones necesarias para una conexión de punto de conexión privado	cuerda
descripción	Descripción del estado actual de una conexión de punto de conexión privado	string (obligatorio)
estado	Estado de una conexión de punto de conexión privado	'Aprobado' 'Desconectado' 'Pendiente' 'Rechazado' (obligatorio)

ResourceTags

Nombre	Descripción	Valor

RouteProperties

Nombre	Descripción	Valor
condición	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: /azure/iot-hub/iot-hub-devguide-query-language	cuerda
endpointNames	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.	string[] (obligatorio)
isEnabled	Se usa para especificar si una ruta está habilitada.	bool (obligatorio)
nombre	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.	cuerda Restricciones: Patrón = `^[A-Za-z0-9-._]{1,64}$` (obligatorio)
fuente	Origen al que se va a aplicar la regla de enrutamiento, como DeviceMessages.	'DeviceConnectionStateEvents' "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" 'No válido' 'TwinChangeEvents' (obligatorio)

RoutingCosmosDBSqlApiProperties

Nombre	Descripción	Valor
authenticationType	Método que se usa para autenticarse en el punto de conexión del contenedor sql de Cosmos DB	'identityBased' 'keyBased'
containerName	Nombre del contenedor sql de Cosmos DB en la base de datos de Cosmos DB.	string (obligatorio)
databaseName	Nombre de la base de datos de Cosmos DB en la cuenta de cosmos DB.	string (obligatorio)
endpointUri	Dirección URL de la cuenta de Cosmos DB. Debe incluir el protocolo https://	string (obligatorio)
identidad	Propiedades de identidad administrada del punto de conexión de contenedor de Cosmos DB de enrutamiento.	managedIdentity
nombre	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, fileNotifications, $default. Los nombres de punto de conexión deben ser únicos en los tipos de punto de conexión.	cuerda Restricciones: Patrón = `^[A-Za-z0-9-._]{1,64}$` (obligatorio)
partitionKeyName	Nombre de la clave de partición asociada a este contenedor sql de Cosmos DB si existe. Se trata de un parámetro opcional.	cuerda
partitionKeyTemplate	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. Este parámetro solo es necesario si se especifica PartitionKeyName.	cuerda
primaryKey	Clave principal de la cuenta de Cosmos DB.	cuerda Restricciones: Valor confidencial. Pase como parámetro seguro.
resourceGroup	Nombre del grupo de recursos de la cuenta de Cosmos DB.	cuerda
secondaryKey	Clave secundaria de la cuenta de Cosmos DB.	cuerda Restricciones: Valor confidencial. Pase como parámetro seguro.
subscriptionId	Identificador de suscripción de la cuenta de Cosmos DB.	cuerda

RoutingEndpoints

Nombre	Descripción	Valor
cosmosDBSqlContainers	La lista de puntos de conexión de contenedor de Cosmos DB a los que IoT Hub enruta los mensajes, en función de las reglas de enrutamiento.	RoutingCosmosDBSqlApiProperties[]
eventHubs	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.	RoutingEventHubProperties[]
serviceBusQueues	La lista de puntos de conexión de cola de Service Bus a los que IoT Hub enruta los mensajes, en función de las reglas de enrutamiento.	RoutingServiceBusQueueEndpointProperties[]
serviceBusTopics	La lista de puntos de conexión del tema de Service Bus a los que ioT Hub enruta los mensajes, en función de las reglas de enrutamiento.	RoutingServiceBusTopicEndpointProperties[]
storageContainers	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.	RoutingStorageContainerProperties[]

RoutingEventHubProperties

Nombre	Descripción	Valor
authenticationType	Método usado para autenticarse en el punto de conexión del centro de eventos	'identityBased' 'keyBased'
connectionString	Cadena de conexión del punto de conexión del centro de eventos.	cuerda
endpointUri	Dirección URL del punto de conexión del centro de eventos. Debe incluir el protocolo sb://	cuerda
entityPath	Nombre del centro de eventos en el espacio de nombres del centro de eventos	cuerda
identificación	Identificador del punto de conexión del centro de eventos	cuerda
identidad	Propiedades de identidad administrada del punto de conexión del centro de eventos de enrutamiento.	managedIdentity
nombre	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, fileNotifications, $default. Los nombres de punto de conexión deben ser únicos en los tipos de punto de conexión.	cuerda Restricciones: Patrón = `^[A-Za-z0-9-._]{1,64}$` (obligatorio)
resourceGroup	Nombre del grupo de recursos del punto de conexión del centro de eventos.	cuerda
subscriptionId	Identificador de suscripción del punto de conexión del centro de eventos.	cuerda

RoutingProperties

Nombre	Descripción	Valor
Extremos	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 permite un máximo de 10 puntos de conexión personalizados en todos los tipos de punto de conexión para centros de pago y solo se permite un punto de conexión personalizado en todos los tipos de puntos de conexión para centros gratuitos.	RoutingEndpoints de
Enriquecimientos	Lista de enriquecimientos proporcionados por el usuario que el centro de IoT aplica a los mensajes que se van a entregar a puntos de conexión integrados y personalizados. Consulte: https://aka.ms/telemetryoneventgrid	EnriquecimientoPropiedades[]
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 "routes". Se trata de un parámetro opcional. Cuando esta propiedad no está presente en la plantilla, la ruta de reserva está deshabilitada de forma predeterminada.	fallbackRouteProperties
Rutas	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.	RouteProperties[]

RoutingServiceBusQueueEndpointProperties

Nombre	Descripción	Valor
authenticationType	Método usado para autenticarse en el punto de conexión de cola de Service Bus	'identityBased' 'keyBased'
connectionString	Cadena de conexión del punto de conexión de cola de Service Bus.	cuerda
endpointUri	Dirección URL del punto de conexión de cola de Service Bus. Debe incluir el protocolo sb://	cuerda
entityPath	Nombre de cola en el espacio de nombres de Service Bus	cuerda
identificación	Identificador del punto de conexión de cola de Service Bus	cuerda
identidad	Propiedades de identidad administrada del punto de conexión de cola de Service Bus de enrutamiento.	managedIdentity
nombre	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, fileNotifications, $default. Los nombres de punto de conexión deben ser únicos en los tipos de punto de conexión. El nombre no debe ser el mismo que el nombre de la cola real.	cuerda Restricciones: Patrón = `^[A-Za-z0-9-._]{1,64}$` (obligatorio)
resourceGroup	Nombre del grupo de recursos del punto de conexión de cola de Service Bus.	cuerda
subscriptionId	Identificador de suscripción del punto de conexión de cola de Service Bus.	cuerda

RoutingServiceBusTopicEndpointProperties

Nombre	Descripción	Valor
authenticationType	Método usado para autenticarse en el punto de conexión del tema de Service Bus	'identityBased' 'keyBased'
connectionString	Cadena de conexión del punto de conexión del tema de Service Bus.	cuerda
endpointUri	Dirección URL del punto de conexión del tema de Service Bus. Debe incluir el protocolo sb://	cuerda
entityPath	Nombre de cola en el tema de Service Bus	cuerda
identificación	Identificador del punto de conexión del tema de Service Bus	cuerda
identidad	Propiedades de identidad administrada del punto de conexión del tema de Service Bus de enrutamiento.	managedIdentity
nombre	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, fileNotifications, $default. Los nombres de punto de conexión deben ser únicos en los tipos de punto de conexión. El nombre no debe ser el mismo que el nombre del tema real.	cuerda Restricciones: Patrón = `^[A-Za-z0-9-._]{1,64}$` (obligatorio)
resourceGroup	Nombre del grupo de recursos del punto de conexión del tema de Service Bus.	cuerda
subscriptionId	Identificador de suscripción del punto de conexión del tema de Service Bus.	cuerda

RoutingStorageContainerProperties

Nombre	Descripción	Valor
authenticationType	Método usado para autenticarse en el punto de conexión de almacenamiento	'identityBased' 'keyBased'
batchFrequencyInSeconds	Intervalo de tiempo en el que los blobs se escriben en el almacenamiento. El valor debe estar comprendido entre 60 y 720 segundos. El valor predeterminado es de 300 segundos.	Int Restricciones: Valor mínimo = 60 Valor máximo = 720
connectionString	Cadena de conexión de la cuenta de almacenamiento.	cuerda
containerName	Nombre del contenedor de almacenamiento en la cuenta de almacenamiento.	string (obligatorio)
codificación	Codificación que se usa para serializar mensajes en blobs. Los valores admitidos son "avro", "avrodeflate" y "JSON". El valor predeterminado es "avro".	'Avro' 'AvroDeflate' 'JSON'
endpointUri	Dirección URL del punto de conexión de almacenamiento. Debe incluir el protocolo https://	cuerda
fileNameFormat	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.	cuerda
identificación	Identificador del punto de conexión del contenedor de almacenamiento	cuerda
identidad	Propiedades de identidad administrada del punto de conexión de almacenamiento de enrutamiento.	managedIdentity
maxChunkSizeInBytes	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).	Int Restricciones: Valor mínimo = 10485760 Valor máximo = 524288000
nombre	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, fileNotifications, $default. Los nombres de punto de conexión deben ser únicos en los tipos de punto de conexión.	cuerda Restricciones: Patrón = `^[A-Za-z0-9-._]{1,64}$` (obligatorio)
resourceGroup	Nombre del grupo de recursos de la cuenta de almacenamiento.	cuerda
subscriptionId	Identificador de suscripción de la cuenta de almacenamiento.	cuerda

SharedAccessSignatureAuthorizationRule

Nombre	Descripción	Valor
keyName	Nombre de la directiva de acceso compartido.	string (obligatorio)
primaryKey	Clave principal.	cuerda
derechos	Permisos asignados a la directiva de acceso compartido.	"DeviceConnect" 'RegistryRead' "RegistryRead, DeviceConnect" "RegistryRead, RegistryWrite" "RegistryRead, RegistryWrite, DeviceConnect" "RegistryRead, RegistryWrite, ServiceConnect" 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' "RegistryRead, ServiceConnect" "RegistryRead, ServiceConnect, DeviceConnect" 'RegistryWrite' "RegistryWrite, DeviceConnect" "RegistryWrite, ServiceConnect" "RegistryWrite, ServiceConnect, DeviceConnect" "ServiceConnect" "ServiceConnect, DeviceConnect" (obligatorio)
secondaryKey	Clave secundaria.	cuerda

StorageEndpointProperties

Nombre	Descripción	Valor
authenticationType	Especifica el tipo de autenticación que se usa para conectarse a la cuenta de almacenamiento.	'identityBased' 'keyBased'
connectionString	Cadena de conexión de la cuenta de Azure Storage a la que se cargan los archivos.	string (obligatorio)
containerName	Nombre del contenedor raíz donde se cargan los archivos. El contenedor no debe existir, pero debe ser creatable mediante el parámetro connectionString especificado.	string (obligatorio)
identidad	Propiedades de identidad administrada del punto de conexión de almacenamiento para la carga de archivos.	managedIdentity
sasTtlAsIso8601	El período de tiempo durante el que el URI de SAS generado por IoT Hub para la carga de archivos es válido. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.	cuerda

Ejemplos de inicio rápido

En los ejemplos de inicio rápido siguientes se implementa este tipo de recurso.

Archivo de Bicep	Descripción
Crear una instancia de IoT Hub y un grupo de consumidores en la nube	Esta plantilla le permite implementar una instancia de IoT Hub con el dispositivo en la nube y la nube en configuraciones de mensajería de dispositivos y un dispositivo en un grupo de consumidores en la nube.
Creación de una instancia de IoT Hub Device Provisioning Service	Esta plantilla le permite crear un centro de IoT y un servicio IoT Hub Device Provisioning y vincular los dos servicios juntos.
crear una cuenta de Device Update para IoT Hub, una instancia de IoT Hub	Esta plantilla crea una cuenta y una instancia y un centro con el que vincular la instancia. Configura el centro con las directivas de acceso, las rutas y el grupo de consumidores necesarios.
Implementación del servicio MedTech, incluido un de Azure IoT Hub	El servicio MedTech es uno de los servicios de datos de Azure Health diseñados para ingerir datos de dispositivo de varios dispositivos, transformar los datos del dispositivo en observaciones de FHIR, que luego se conservan en el servicio FHIR de Azure Health Data Services.
Uso de la plantilla de ARM para crear IoT Hub, enrutar y ver mensajes	Use esta plantilla para implementar una instancia de IoT Hub y una cuenta de almacenamiento. Ejecute una aplicación para enviar mensajes al centro que se enrutan al almacenamiento y, a continuación, vea los resultados.

Definición de recursos de plantilla de ARM

El tipo de recurso IotHubs se puede implementar con operaciones destinadas a:

grupos de recursos: consulte comandos de implementación de grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.Devices/IotHubs, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.Devices/IotHubs",
  "apiVersion": "2023-06-30",
  "name": "string",
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "allowedFqdnList": [ "string" ],
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string"
      }
    ],
    "cloudToDevice": {
      "defaultTtlAsIso8601": "string",
      "feedback": {
        "lockDurationAsIso8601": "string",
        "maxDeliveryCount": "int",
        "ttlAsIso8601": "string"
      },
      "maxDeliveryCount": "int"
    },
    "comments": "string",
    "disableDeviceSAS": "bool",
    "disableLocalAuth": "bool",
    "disableModuleSAS": "bool",
    "enableDataResidency": "bool",
    "enableFileUploadNotifications": "bool",
    "eventHubEndpoints": {
      "{customized property}": {
        "partitionCount": "int",
        "retentionTimeInDays": "int"
      }
    },
    "features": "string",
    "ipFilterRules": [
      {
        "action": "string",
        "filterName": "string",
        "ipMask": "string"
      }
    ],
    "messagingEndpoints": {
      "{customized property}": {
        "lockDurationAsIso8601": "string",
        "maxDeliveryCount": "int",
        "ttlAsIso8601": "string"
      }
    },
    "minTlsVersion": "string",
    "networkRuleSets": {
      "applyToBuiltInEventHubEndpoint": "bool",
      "defaultAction": "string",
      "ipRules": [
        {
          "action": "string",
          "filterName": "string",
          "ipMask": "string"
        }
      ]
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
          },
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "publicNetworkAccess": "string",
    "restrictOutboundNetworkAccess": "bool",
    "routing": {
      "endpoints": {
        "cosmosDBSqlContainers": [
          {
            "authenticationType": "string",
            "containerName": "string",
            "databaseName": "string",
            "endpointUri": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "name": "string",
            "partitionKeyName": "string",
            "partitionKeyTemplate": "string",
            "primaryKey": "string",
            "resourceGroup": "string",
            "secondaryKey": "string",
            "subscriptionId": "string"
          }
        ],
        "eventHubs": [
          {
            "authenticationType": "string",
            "connectionString": "string",
            "endpointUri": "string",
            "entityPath": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "serviceBusQueues": [
          {
            "authenticationType": "string",
            "connectionString": "string",
            "endpointUri": "string",
            "entityPath": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "serviceBusTopics": [
          {
            "authenticationType": "string",
            "connectionString": "string",
            "endpointUri": "string",
            "entityPath": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "storageContainers": [
          {
            "authenticationType": "string",
            "batchFrequencyInSeconds": "int",
            "connectionString": "string",
            "containerName": "string",
            "encoding": "string",
            "endpointUri": "string",
            "fileNameFormat": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "maxChunkSizeInBytes": "int",
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ]
      },
      "enrichments": [
        {
          "endpointNames": [ "string" ],
          "key": "string",
          "value": "string"
        }
      ],
      "fallbackRoute": {
        "condition": "string",
        "endpointNames": [ "string" ],
        "isEnabled": "bool",
        "name": "string",
        "source": "string"
      },
      "routes": [
        {
          "condition": "string",
          "endpointNames": [ "string" ],
          "isEnabled": "bool",
          "name": "string",
          "source": "string"
        }
      ]
    },
    "storageEndpoints": {
      "{customized property}": {
        "authenticationType": "string",
        "connectionString": "string",
        "containerName": "string",
        "identity": {
          "userAssignedIdentity": "string"
        },
        "sasTtlAsIso8601": "string"
      }
    }
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propiedad

ArmIdentity

Nombre	Descripción	Valor
tipo	Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio.	'Ninguno' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned'
userAssignedIdentities	Diccionario de <> ArmUserIdentity	ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

Nombre	Descripción	Valor

ArmUserIdentity

Nombre	Descripción	Valor

CloudToDeviceProperties

Nombre	Descripción	Valor
defaultTtlAsIso8601	El período de vida predeterminado para los mensajes de nube a dispositivo en la cola de dispositivos. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	cuerda
retroalimentación	Las propiedades de la cola de comentarios para los mensajes de nube a dispositivo.	FeedbackProperties
maxDeliveryCount	Recuento máximo de entregas para mensajes de nube a dispositivo en la cola de dispositivos. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Restricciones: Valor mínimo = 1 Valor máximo = 100

EnrichmentProperties

Nombre	Descripción	Valor
endpointNames	Lista de puntos de conexión para los que se aplica el enriquecimiento al mensaje.	string[] (obligatorio)
llave	Clave o nombre de la propiedad de enriquecimiento.	string (obligatorio)
valor	Valor de la propiedad de enriquecimiento.	string (obligatorio)

EventHubProperties

Nombre	Descripción	Valor
partitionCount	Número de particiones para recibir mensajes de dispositivo a nube en el punto de conexión compatible con Event Hubs. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.	Int
retentionTimeInDays	Tiempo de retención de mensajes de dispositivo a nube en días. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	Int

FallbackRouteProperties

Nombre	Descripción	Valor
condición	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 : /azure/iot-hub/iot-hub-devguide-query-language	cuerda
endpointNames	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.	string[] (obligatorio)
isEnabled	Se usa para especificar si la ruta de reserva está habilitada.	bool (obligatorio)
nombre	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.	cuerda
fuente	Origen al que se va a aplicar la regla de enrutamiento. Por ejemplo, DeviceMessages	'DeviceConnectionStateEvents' "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" 'No válido' 'TwinChangeEvents' (obligatorio)

FeedbackProperties

Nombre	Descripción	Valor
lockDurationAsIso8601	Duración del bloqueo de la cola de comentarios. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	cuerda
maxDeliveryCount	Número de veces que el centro de IoT intenta entregar un mensaje en la cola de comentarios. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Restricciones: Valor mínimo = 1 Valor máximo = 100
ttlAsIso8601	Período de tiempo durante el que un mensaje está disponible para consumir antes de que el centro de IoT expire. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	cuerda

IotHubProperties

Nombre	Descripción	Valor
allowedFqdnList	Lista de FQDN permitidos (nombre de dominio completo) para la salida de Iot Hub.	string[]
authorizationPolicies	Las directivas de acceso compartido que puede usar para proteger una conexión al centro de IoT.	SharedAccessSignatureAuthorizationRule[]
cloudToDevice	Las propiedades de mensajería de nube a dispositivo de IoT Hub.	CloudToDeviceProperties
Comentarios	Comentarios de IoT Hub.	cuerda
disableDeviceSAS	Si es true, no se pueden usar todas las claves SAS con ámbito de dispositivo (incluidos los dispositivos perimetrales, excepto los módulos) para la autenticación.	Bool
disableLocalAuth	Si es true, los tokens de SAS con claves SAS con ámbito de centro de IoT no se pueden usar para la autenticación.	Bool
disableModuleSAS	Si es true, no se pueden usar todas las claves SAS con ámbito del módulo para la autenticación.	Bool
enableDataResidency	Esta propiedad cuando se establece en true, habilitará la residencia de datos, por lo que deshabilitará la recuperación ante desastres.	Bool
enableFileUploadNotifications	Si es True, las notificaciones de carga de archivos están habilitadas.	Bool
eventHubEndpoints	Propiedades del punto de conexión compatible con Event Hubs. Las únicas claves posibles para este diccionario son los eventos. Esta clave debe estar presente en el diccionario al realizar llamadas de creación o actualización para IoT Hub.	IotHubPropertiesEventHubEndpoints
Funciones	Las funcionalidades y características habilitadas para ioT Hub.	"DeviceManagement" 'Ninguno'
ipFilterRules	Reglas de filtro IP.	ipFilterRule[]
messagingEndpoints	Propiedades del punto de conexión de mensajería para la cola de notificaciones de carga de archivos.	IotHubPropertiesMessagingEndpoints
minTlsVersion	Especifica la versión mínima de TLS que se va a admitir para este centro. Se puede establecer en "1.2" para que los clientes que usen una versión tls inferior a la 1.2 se rechacen.	cuerda
networkRuleSets	Propiedades del conjunto de reglas de red de IotHub	NetworkRuleSetProperties
privateEndpointConnections	Conexiones de punto de conexión privado creadas en este IotHub	privateEndpointConnection[]
publicNetworkAccess	Indica si se permiten solicitudes de la red pública	'Deshabilitado' 'Habilitado'
restrictOutboundNetworkAccess	Si es true, la salida de IotHub se restringirá solo a los FQDN permitidos configurados a través de allowedFqdnList.	Bool
enrutamiento	Las propiedades relacionadas con el enrutamiento del centro de IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging	RoutingProperties
storageEndpoints	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. Al especificar más de una cuenta de almacenamiento, se produce un error. Si no se especifica un valor para esta propiedad cuando la propiedad enableFileUploadNotifications está establecida en True, se produce un error.	IotHubPropertiesStorageEndpoints

IotHubPropertiesEventHubEndpoints

Nombre	Descripción	Valor

IotHubPropertiesMessagingEndpoints

Nombre	Descripción	Valor

IotHubPropertiesStorageEndpoints

Nombre	Descripción	Valor

IotHubSkuInfo

Nombre	Descripción	Valor
capacidad	Número de unidades de IoT Hub aprovisionadas. Consulte: /azure/azure-subscription-service-limits#iot-hub-limits.	Int
nombre	Nombre de la SKU.	'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' (obligatorio)

IpFilterRule

Nombre	Descripción	Valor
acción	Acción deseada para las solicitudes capturadas por esta regla.	'Aceptar' 'Reject' (obligatorio)
filterName	Nombre de la regla de filtro IP.	string (obligatorio)
ipMask	Cadena que contiene el intervalo de direcciones IP en notación CIDR para la regla.	string (obligatorio)

ManagedIdentity

Nombre	Descripción	Valor
userAssignedIdentity	Identidad asignada por el usuario.	cuerda

MessagingEndpointProperties

Nombre	Descripción	Valor
lockDurationAsIso8601	Duración del bloqueo. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload.	cuerda
maxDeliveryCount	Número de veces que el centro de IoT intenta entregar un mensaje. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload.	Int Restricciones: Valor mínimo = 1 Valor máximo = 100
ttlAsIso8601	Período de tiempo durante el que un mensaje está disponible para consumir antes de que el centro de IoT expire. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload.	cuerda

Microsoft.Devices/IotHubs

Nombre	Descripción	Valor
apiVersion	La versión de api	'2023-06-30'
etag	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 ETag normal.	cuerda
identidad	Identidades administradas para IotHub.	ArmIdentity
ubicación	Ubicación del recurso.	string (obligatorio)
nombre	El nombre del recurso	string (obligatorio)
Propiedades	Propiedades de IotHub	IotHubProperties
Sku	Información de SKU de IotHub	IotHubSkuInfo (obligatorio)
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
tipo	El tipo de recurso	"Microsoft.Devices/IotHubs"

NetworkRuleSetIpRule

Nombre	Descripción	Valor
acción	Acción de filtro IP	'Permitir'
filterName	Nombre de la regla de filtro IP.	string (obligatorio)
ipMask	Cadena que contiene el intervalo de direcciones IP en notación CIDR para la regla.	string (obligatorio)

NetworkRuleSetProperties

Nombre	Descripción	Valor
applyToBuiltInEventHubEndpoint	Si es True, el conjunto de reglas de red también se aplica a BuiltIn EventHub EndPoint de IotHub.	bool (obligatorio)
defaultAction	Acción predeterminada para el conjunto de reglas de red	'Permitir' 'Denegar'
ipRules	Lista de reglas de IP	NetworkRuleSetIpRule[] (obligatorio)

PrivateEndpoint

Nombre	Descripción	Valor

PrivateEndpointConnection

Nombre	Descripción	Valor
Propiedades	Propiedades de una conexión de punto de conexión privado	privateEndpointConnectionProperties (obligatorio)

PrivateEndpointConnectionProperties

Nombre	Descripción	Valor
privateEndpoint	La propiedad de punto de conexión privado de una conexión de punto de conexión privado	PrivateEndpoint
privateLinkServiceConnectionState	Estado actual de una conexión de punto de conexión privado	privateLinkServiceConnectionState (obligatorio)

PrivateLinkServiceConnectionState

Nombre	Descripción	Valor
actionsRequired	Acciones necesarias para una conexión de punto de conexión privado	cuerda
descripción	Descripción del estado actual de una conexión de punto de conexión privado	string (obligatorio)
estado	Estado de una conexión de punto de conexión privado	'Aprobado' 'Desconectado' 'Pendiente' 'Rechazado' (obligatorio)

ResourceTags

Nombre	Descripción	Valor

RouteProperties

Nombre	Descripción	Valor
condición	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: /azure/iot-hub/iot-hub-devguide-query-language	cuerda
endpointNames	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.	string[] (obligatorio)
isEnabled	Se usa para especificar si una ruta está habilitada.	bool (obligatorio)
nombre	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.	cuerda Restricciones: Patrón = `^[A-Za-z0-9-._]{1,64}$` (obligatorio)
fuente	Origen al que se va a aplicar la regla de enrutamiento, como DeviceMessages.	'DeviceConnectionStateEvents' "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" 'No válido' 'TwinChangeEvents' (obligatorio)

RoutingCosmosDBSqlApiProperties

Nombre	Descripción	Valor
authenticationType	Método que se usa para autenticarse en el punto de conexión del contenedor sql de Cosmos DB	'identityBased' 'keyBased'
containerName	Nombre del contenedor sql de Cosmos DB en la base de datos de Cosmos DB.	string (obligatorio)
databaseName	Nombre de la base de datos de Cosmos DB en la cuenta de cosmos DB.	string (obligatorio)
endpointUri	Dirección URL de la cuenta de Cosmos DB. Debe incluir el protocolo https://	string (obligatorio)
identidad	Propiedades de identidad administrada del punto de conexión de contenedor de Cosmos DB de enrutamiento.	managedIdentity
nombre	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, fileNotifications, $default. Los nombres de punto de conexión deben ser únicos en los tipos de punto de conexión.	cuerda Restricciones: Patrón = `^[A-Za-z0-9-._]{1,64}$` (obligatorio)
partitionKeyName	Nombre de la clave de partición asociada a este contenedor sql de Cosmos DB si existe. Se trata de un parámetro opcional.	cuerda
partitionKeyTemplate	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. Este parámetro solo es necesario si se especifica PartitionKeyName.	cuerda
primaryKey	Clave principal de la cuenta de Cosmos DB.	cuerda Restricciones: Valor confidencial. Pase como parámetro seguro.
resourceGroup	Nombre del grupo de recursos de la cuenta de Cosmos DB.	cuerda
secondaryKey	Clave secundaria de la cuenta de Cosmos DB.	cuerda Restricciones: Valor confidencial. Pase como parámetro seguro.
subscriptionId	Identificador de suscripción de la cuenta de Cosmos DB.	cuerda

RoutingEndpoints

Nombre	Descripción	Valor
cosmosDBSqlContainers	La lista de puntos de conexión de contenedor de Cosmos DB a los que IoT Hub enruta los mensajes, en función de las reglas de enrutamiento.	RoutingCosmosDBSqlApiProperties[]
eventHubs	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.	RoutingEventHubProperties[]
serviceBusQueues	La lista de puntos de conexión de cola de Service Bus a los que IoT Hub enruta los mensajes, en función de las reglas de enrutamiento.	RoutingServiceBusQueueEndpointProperties[]
serviceBusTopics	La lista de puntos de conexión del tema de Service Bus a los que ioT Hub enruta los mensajes, en función de las reglas de enrutamiento.	RoutingServiceBusTopicEndpointProperties[]
storageContainers	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.	RoutingStorageContainerProperties[]

RoutingEventHubProperties

Nombre	Descripción	Valor
authenticationType	Método usado para autenticarse en el punto de conexión del centro de eventos	'identityBased' 'keyBased'
connectionString	Cadena de conexión del punto de conexión del centro de eventos.	cuerda
endpointUri	Dirección URL del punto de conexión del centro de eventos. Debe incluir el protocolo sb://	cuerda
entityPath	Nombre del centro de eventos en el espacio de nombres del centro de eventos	cuerda
identificación	Identificador del punto de conexión del centro de eventos	cuerda
identidad	Propiedades de identidad administrada del punto de conexión del centro de eventos de enrutamiento.	managedIdentity
nombre	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, fileNotifications, $default. Los nombres de punto de conexión deben ser únicos en los tipos de punto de conexión.	cuerda Restricciones: Patrón = `^[A-Za-z0-9-._]{1,64}$` (obligatorio)
resourceGroup	Nombre del grupo de recursos del punto de conexión del centro de eventos.	cuerda
subscriptionId	Identificador de suscripción del punto de conexión del centro de eventos.	cuerda

RoutingProperties

Nombre	Descripción	Valor
Extremos	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 permite un máximo de 10 puntos de conexión personalizados en todos los tipos de punto de conexión para centros de pago y solo se permite un punto de conexión personalizado en todos los tipos de puntos de conexión para centros gratuitos.	RoutingEndpoints de
Enriquecimientos	Lista de enriquecimientos proporcionados por el usuario que el centro de IoT aplica a los mensajes que se van a entregar a puntos de conexión integrados y personalizados. Consulte: https://aka.ms/telemetryoneventgrid	EnriquecimientoPropiedades[]
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 "routes". Se trata de un parámetro opcional. Cuando esta propiedad no está presente en la plantilla, la ruta de reserva está deshabilitada de forma predeterminada.	fallbackRouteProperties
Rutas	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.	RouteProperties[]

RoutingServiceBusQueueEndpointProperties

Nombre	Descripción	Valor
authenticationType	Método usado para autenticarse en el punto de conexión de cola de Service Bus	'identityBased' 'keyBased'
connectionString	Cadena de conexión del punto de conexión de cola de Service Bus.	cuerda
endpointUri	Dirección URL del punto de conexión de cola de Service Bus. Debe incluir el protocolo sb://	cuerda
entityPath	Nombre de cola en el espacio de nombres de Service Bus	cuerda
identificación	Identificador del punto de conexión de cola de Service Bus	cuerda
identidad	Propiedades de identidad administrada del punto de conexión de cola de Service Bus de enrutamiento.	managedIdentity
nombre	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, fileNotifications, $default. Los nombres de punto de conexión deben ser únicos en los tipos de punto de conexión. El nombre no debe ser el mismo que el nombre de la cola real.	cuerda Restricciones: Patrón = `^[A-Za-z0-9-._]{1,64}$` (obligatorio)
resourceGroup	Nombre del grupo de recursos del punto de conexión de cola de Service Bus.	cuerda
subscriptionId	Identificador de suscripción del punto de conexión de cola de Service Bus.	cuerda

RoutingServiceBusTopicEndpointProperties

Nombre	Descripción	Valor
authenticationType	Método usado para autenticarse en el punto de conexión del tema de Service Bus	'identityBased' 'keyBased'
connectionString	Cadena de conexión del punto de conexión del tema de Service Bus.	cuerda
endpointUri	Dirección URL del punto de conexión del tema de Service Bus. Debe incluir el protocolo sb://	cuerda
entityPath	Nombre de cola en el tema de Service Bus	cuerda
identificación	Identificador del punto de conexión del tema de Service Bus	cuerda
identidad	Propiedades de identidad administrada del punto de conexión del tema de Service Bus de enrutamiento.	managedIdentity
nombre	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, fileNotifications, $default. Los nombres de punto de conexión deben ser únicos en los tipos de punto de conexión. El nombre no debe ser el mismo que el nombre del tema real.	cuerda Restricciones: Patrón = `^[A-Za-z0-9-._]{1,64}$` (obligatorio)
resourceGroup	Nombre del grupo de recursos del punto de conexión del tema de Service Bus.	cuerda
subscriptionId	Identificador de suscripción del punto de conexión del tema de Service Bus.	cuerda

RoutingStorageContainerProperties

Nombre	Descripción	Valor
authenticationType	Método usado para autenticarse en el punto de conexión de almacenamiento	'identityBased' 'keyBased'
batchFrequencyInSeconds	Intervalo de tiempo en el que los blobs se escriben en el almacenamiento. El valor debe estar comprendido entre 60 y 720 segundos. El valor predeterminado es de 300 segundos.	Int Restricciones: Valor mínimo = 60 Valor máximo = 720
connectionString	Cadena de conexión de la cuenta de almacenamiento.	cuerda
containerName	Nombre del contenedor de almacenamiento en la cuenta de almacenamiento.	string (obligatorio)
codificación	Codificación que se usa para serializar mensajes en blobs. Los valores admitidos son "avro", "avrodeflate" y "JSON". El valor predeterminado es "avro".	'Avro' 'AvroDeflate' 'JSON'
endpointUri	Dirección URL del punto de conexión de almacenamiento. Debe incluir el protocolo https://	cuerda
fileNameFormat	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.	cuerda
identificación	Identificador del punto de conexión del contenedor de almacenamiento	cuerda
identidad	Propiedades de identidad administrada del punto de conexión de almacenamiento de enrutamiento.	managedIdentity
maxChunkSizeInBytes	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).	Int Restricciones: Valor mínimo = 10485760 Valor máximo = 524288000
nombre	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, fileNotifications, $default. Los nombres de punto de conexión deben ser únicos en los tipos de punto de conexión.	cuerda Restricciones: Patrón = `^[A-Za-z0-9-._]{1,64}$` (obligatorio)
resourceGroup	Nombre del grupo de recursos de la cuenta de almacenamiento.	cuerda
subscriptionId	Identificador de suscripción de la cuenta de almacenamiento.	cuerda

SharedAccessSignatureAuthorizationRule

Nombre	Descripción	Valor
keyName	Nombre de la directiva de acceso compartido.	string (obligatorio)
primaryKey	Clave principal.	cuerda
derechos	Permisos asignados a la directiva de acceso compartido.	"DeviceConnect" 'RegistryRead' "RegistryRead, DeviceConnect" "RegistryRead, RegistryWrite" "RegistryRead, RegistryWrite, DeviceConnect" "RegistryRead, RegistryWrite, ServiceConnect" 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' "RegistryRead, ServiceConnect" "RegistryRead, ServiceConnect, DeviceConnect" 'RegistryWrite' "RegistryWrite, DeviceConnect" "RegistryWrite, ServiceConnect" "RegistryWrite, ServiceConnect, DeviceConnect" "ServiceConnect" "ServiceConnect, DeviceConnect" (obligatorio)
secondaryKey	Clave secundaria.	cuerda

StorageEndpointProperties

Nombre	Descripción	Valor
authenticationType	Especifica el tipo de autenticación que se usa para conectarse a la cuenta de almacenamiento.	'identityBased' 'keyBased'
connectionString	Cadena de conexión de la cuenta de Azure Storage a la que se cargan los archivos.	string (obligatorio)
containerName	Nombre del contenedor raíz donde se cargan los archivos. El contenedor no debe existir, pero debe ser creatable mediante el parámetro connectionString especificado.	string (obligatorio)
identidad	Propiedades de identidad administrada del punto de conexión de almacenamiento para la carga de archivos.	managedIdentity
sasTtlAsIso8601	El período de tiempo durante el que el URI de SAS generado por IoT Hub para la carga de archivos es válido. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.	cuerda

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla	Descripción
Crear un entorno de pago por uso (PAYG) con un de IoT Hub	Esta plantilla le permite implementar un entorno de Time Series Insights de pago por uso (PAYG) que esté configurado para consumir eventos de una instancia de IoT Hub.
Crear una instancia de IoT Hub y un grupo de consumidores en la nube	Esta plantilla le permite implementar una instancia de IoT Hub con el dispositivo en la nube y la nube en configuraciones de mensajería de dispositivos y un dispositivo en un grupo de consumidores en la nube.
Crear un simulador perimetral de Ubuntu y un centro de IOT	Esta plantilla crea un simulador perimetral de Ubuntu de IOT Hub y máquina virtual.
Creación de una instancia de IoT Hub Device Provisioning Service	Esta plantilla le permite crear un centro de IoT y un servicio IoT Hub Device Provisioning y vincular los dos servicios juntos.
crear una cuenta de Device Update para IoT Hub, una instancia de IoT Hub	Esta plantilla crea una cuenta y una instancia y un centro con el que vincular la instancia. Configura el centro con las directivas de acceso, las rutas y el grupo de consumidores necesarios.
Implementación del servicio MedTech, incluido un de Azure IoT Hub	El servicio MedTech es uno de los servicios de datos de Azure Health diseñados para ingerir datos de dispositivo de varios dispositivos, transformar los datos del dispositivo en observaciones de FHIR, que luego se conservan en el servicio FHIR de Azure Health Data Services.
Uso de la plantilla de ARM para crear IoT Hub, enrutar y ver mensajes	Use esta plantilla para implementar una instancia de IoT Hub y una cuenta de almacenamiento. Ejecute una aplicación para enviar mensajes al centro que se enrutan al almacenamiento y, a continuación, vea los resultados.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso IotHubs se puede implementar con operaciones destinadas a:

grupos de recursos de

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.Devices/IotHubs, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/IotHubs@2023-06-30"
  name = "string"
  etag = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      allowedFqdnList = [
        "string"
      ]
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
        }
      ]
      cloudToDevice = {
        defaultTtlAsIso8601 = "string"
        feedback = {
          lockDurationAsIso8601 = "string"
          maxDeliveryCount = int
          ttlAsIso8601 = "string"
        }
        maxDeliveryCount = int
      }
      comments = "string"
      disableDeviceSAS = bool
      disableLocalAuth = bool
      disableModuleSAS = bool
      enableDataResidency = bool
      enableFileUploadNotifications = bool
      eventHubEndpoints = {
        {customized property} = {
          partitionCount = int
          retentionTimeInDays = int
        }
      }
      features = "string"
      ipFilterRules = [
        {
          action = "string"
          filterName = "string"
          ipMask = "string"
        }
      ]
      messagingEndpoints = {
        {customized property} = {
          lockDurationAsIso8601 = "string"
          maxDeliveryCount = int
          ttlAsIso8601 = "string"
        }
      }
      minTlsVersion = "string"
      networkRuleSets = {
        applyToBuiltInEventHubEndpoint = bool
        defaultAction = "string"
        ipRules = [
          {
            action = "string"
            filterName = "string"
            ipMask = "string"
          }
        ]
      }
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {
            }
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      publicNetworkAccess = "string"
      restrictOutboundNetworkAccess = bool
      routing = {
        endpoints = {
          cosmosDBSqlContainers = [
            {
              authenticationType = "string"
              containerName = "string"
              databaseName = "string"
              endpointUri = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              name = "string"
              partitionKeyName = "string"
              partitionKeyTemplate = "string"
              primaryKey = "string"
              resourceGroup = "string"
              secondaryKey = "string"
              subscriptionId = "string"
            }
          ]
          eventHubs = [
            {
              authenticationType = "string"
              connectionString = "string"
              endpointUri = "string"
              entityPath = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          serviceBusQueues = [
            {
              authenticationType = "string"
              connectionString = "string"
              endpointUri = "string"
              entityPath = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          serviceBusTopics = [
            {
              authenticationType = "string"
              connectionString = "string"
              endpointUri = "string"
              entityPath = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          storageContainers = [
            {
              authenticationType = "string"
              batchFrequencyInSeconds = int
              connectionString = "string"
              containerName = "string"
              encoding = "string"
              endpointUri = "string"
              fileNameFormat = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              maxChunkSizeInBytes = int
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
        }
        enrichments = [
          {
            endpointNames = [
              "string"
            ]
            key = "string"
            value = "string"
          }
        ]
        fallbackRoute = {
          condition = "string"
          endpointNames = [
            "string"
          ]
          isEnabled = bool
          name = "string"
          source = "string"
        }
        routes = [
          {
            condition = "string"
            endpointNames = [
              "string"
            ]
            isEnabled = bool
            name = "string"
            source = "string"
          }
        ]
      }
      storageEndpoints = {
        {customized property} = {
          authenticationType = "string"
          connectionString = "string"
          containerName = "string"
          identity = {
            userAssignedIdentity = "string"
          }
          sasTtlAsIso8601 = "string"
        }
      }
    }
  })
}

Valores de propiedad

ArmIdentity

Nombre	Descripción	Valor
tipo	Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio.	'Ninguno' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned'
userAssignedIdentities	Diccionario de <> ArmUserIdentity	ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

Nombre	Descripción	Valor

ArmUserIdentity

Nombre	Descripción	Valor

CloudToDeviceProperties

Nombre	Descripción	Valor
defaultTtlAsIso8601	El período de vida predeterminado para los mensajes de nube a dispositivo en la cola de dispositivos. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	cuerda
retroalimentación	Las propiedades de la cola de comentarios para los mensajes de nube a dispositivo.	FeedbackProperties
maxDeliveryCount	Recuento máximo de entregas para mensajes de nube a dispositivo en la cola de dispositivos. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Restricciones: Valor mínimo = 1 Valor máximo = 100

EnrichmentProperties

Nombre	Descripción	Valor
endpointNames	Lista de puntos de conexión para los que se aplica el enriquecimiento al mensaje.	string[] (obligatorio)
llave	Clave o nombre de la propiedad de enriquecimiento.	string (obligatorio)
valor	Valor de la propiedad de enriquecimiento.	string (obligatorio)

EventHubProperties

Nombre	Descripción	Valor
partitionCount	Número de particiones para recibir mensajes de dispositivo a nube en el punto de conexión compatible con Event Hubs. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.	Int
retentionTimeInDays	Tiempo de retención de mensajes de dispositivo a nube en días. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	Int

FallbackRouteProperties

Nombre	Descripción	Valor
condición	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 : /azure/iot-hub/iot-hub-devguide-query-language	cuerda
endpointNames	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.	string[] (obligatorio)
isEnabled	Se usa para especificar si la ruta de reserva está habilitada.	bool (obligatorio)
nombre	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.	cuerda
fuente	Origen al que se va a aplicar la regla de enrutamiento. Por ejemplo, DeviceMessages	'DeviceConnectionStateEvents' "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" 'No válido' 'TwinChangeEvents' (obligatorio)

FeedbackProperties

Nombre	Descripción	Valor
lockDurationAsIso8601	Duración del bloqueo de la cola de comentarios. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	cuerda
maxDeliveryCount	Número de veces que el centro de IoT intenta entregar un mensaje en la cola de comentarios. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Restricciones: Valor mínimo = 1 Valor máximo = 100
ttlAsIso8601	Período de tiempo durante el que un mensaje está disponible para consumir antes de que el centro de IoT expire. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	cuerda

IotHubProperties

Nombre	Descripción	Valor
allowedFqdnList	Lista de FQDN permitidos (nombre de dominio completo) para la salida de Iot Hub.	string[]
authorizationPolicies	Las directivas de acceso compartido que puede usar para proteger una conexión al centro de IoT.	SharedAccessSignatureAuthorizationRule[]
cloudToDevice	Las propiedades de mensajería de nube a dispositivo de IoT Hub.	CloudToDeviceProperties
Comentarios	Comentarios de IoT Hub.	cuerda
disableDeviceSAS	Si es true, no se pueden usar todas las claves SAS con ámbito de dispositivo (incluidos los dispositivos perimetrales, excepto los módulos) para la autenticación.	Bool
disableLocalAuth	Si es true, los tokens de SAS con claves SAS con ámbito de centro de IoT no se pueden usar para la autenticación.	Bool
disableModuleSAS	Si es true, no se pueden usar todas las claves SAS con ámbito del módulo para la autenticación.	Bool
enableDataResidency	Esta propiedad cuando se establece en true, habilitará la residencia de datos, por lo que deshabilitará la recuperación ante desastres.	Bool
enableFileUploadNotifications	Si es True, las notificaciones de carga de archivos están habilitadas.	Bool
eventHubEndpoints	Propiedades del punto de conexión compatible con Event Hubs. Las únicas claves posibles para este diccionario son los eventos. Esta clave debe estar presente en el diccionario al realizar llamadas de creación o actualización para IoT Hub.	IotHubPropertiesEventHubEndpoints
Funciones	Las funcionalidades y características habilitadas para ioT Hub.	"DeviceManagement" 'Ninguno'
ipFilterRules	Reglas de filtro IP.	ipFilterRule[]
messagingEndpoints	Propiedades del punto de conexión de mensajería para la cola de notificaciones de carga de archivos.	IotHubPropertiesMessagingEndpoints
minTlsVersion	Especifica la versión mínima de TLS que se va a admitir para este centro. Se puede establecer en "1.2" para que los clientes que usen una versión tls inferior a la 1.2 se rechacen.	cuerda
networkRuleSets	Propiedades del conjunto de reglas de red de IotHub	NetworkRuleSetProperties
privateEndpointConnections	Conexiones de punto de conexión privado creadas en este IotHub	privateEndpointConnection[]
publicNetworkAccess	Indica si se permiten solicitudes de la red pública	'Deshabilitado' 'Habilitado'
restrictOutboundNetworkAccess	Si es true, la salida de IotHub se restringirá solo a los FQDN permitidos configurados a través de allowedFqdnList.	Bool
enrutamiento	Las propiedades relacionadas con el enrutamiento del centro de IoT. Consulte: /azure/iot-hub/iot-hub-devguide-messaging	RoutingProperties
storageEndpoints	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. Al especificar más de una cuenta de almacenamiento, se produce un error. Si no se especifica un valor para esta propiedad cuando la propiedad enableFileUploadNotifications está establecida en True, se produce un error.	IotHubPropertiesStorageEndpoints

IotHubPropertiesEventHubEndpoints

Nombre	Descripción	Valor

IotHubPropertiesMessagingEndpoints

Nombre	Descripción	Valor

IotHubPropertiesStorageEndpoints

Nombre	Descripción	Valor

IotHubSkuInfo

Nombre	Descripción	Valor
capacidad	Número de unidades de IoT Hub aprovisionadas. Consulte: /azure/azure-subscription-service-limits#iot-hub-limits.	Int
nombre	Nombre de la SKU.	'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' (obligatorio)

IpFilterRule

Nombre	Descripción	Valor
acción	Acción deseada para las solicitudes capturadas por esta regla.	'Aceptar' 'Reject' (obligatorio)
filterName	Nombre de la regla de filtro IP.	string (obligatorio)
ipMask	Cadena que contiene el intervalo de direcciones IP en notación CIDR para la regla.	string (obligatorio)

ManagedIdentity

Nombre	Descripción	Valor
userAssignedIdentity	Identidad asignada por el usuario.	cuerda

MessagingEndpointProperties

Nombre	Descripción	Valor
lockDurationAsIso8601	Duración del bloqueo. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload.	cuerda
maxDeliveryCount	Número de veces que el centro de IoT intenta entregar un mensaje. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload.	Int Restricciones: Valor mínimo = 1 Valor máximo = 100
ttlAsIso8601	Período de tiempo durante el que un mensaje está disponible para consumir antes de que el centro de IoT expire. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload.	cuerda

Microsoft.Devices/IotHubs

Nombre	Descripción	Valor
etag	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 ETag normal.	cuerda
identidad	Identidades administradas para IotHub.	ArmIdentity
ubicación	Ubicación del recurso.	string (obligatorio)
nombre	El nombre del recurso	string (obligatorio)
Propiedades	Propiedades de IotHub	IotHubProperties
Sku	Información de SKU de IotHub	IotHubSkuInfo (obligatorio)
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta.
tipo	El tipo de recurso	"Microsoft.Devices/IotHubs@2023-06-30"

NetworkRuleSetIpRule

Nombre	Descripción	Valor
acción	Acción de filtro IP	'Permitir'
filterName	Nombre de la regla de filtro IP.	string (obligatorio)
ipMask	Cadena que contiene el intervalo de direcciones IP en notación CIDR para la regla.	string (obligatorio)

NetworkRuleSetProperties

Nombre	Descripción	Valor
applyToBuiltInEventHubEndpoint	Si es True, el conjunto de reglas de red también se aplica a BuiltIn EventHub EndPoint de IotHub.	bool (obligatorio)
defaultAction	Acción predeterminada para el conjunto de reglas de red	'Permitir' 'Denegar'
ipRules	Lista de reglas de IP	NetworkRuleSetIpRule[] (obligatorio)

PrivateEndpoint

Nombre	Descripción	Valor

PrivateEndpointConnection

Nombre	Descripción	Valor
Propiedades	Propiedades de una conexión de punto de conexión privado	privateEndpointConnectionProperties (obligatorio)

PrivateEndpointConnectionProperties

Nombre	Descripción	Valor
privateEndpoint	La propiedad de punto de conexión privado de una conexión de punto de conexión privado	PrivateEndpoint
privateLinkServiceConnectionState	Estado actual de una conexión de punto de conexión privado	privateLinkServiceConnectionState (obligatorio)

PrivateLinkServiceConnectionState

Nombre	Descripción	Valor
actionsRequired	Acciones necesarias para una conexión de punto de conexión privado	cuerda
descripción	Descripción del estado actual de una conexión de punto de conexión privado	string (obligatorio)
estado	Estado de una conexión de punto de conexión privado	'Aprobado' 'Desconectado' 'Pendiente' 'Rechazado' (obligatorio)

ResourceTags

Nombre	Descripción	Valor

RouteProperties

Nombre	Descripción	Valor
condición	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: /azure/iot-hub/iot-hub-devguide-query-language	cuerda
endpointNames	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.	string[] (obligatorio)
isEnabled	Se usa para especificar si una ruta está habilitada.	bool (obligatorio)
nombre	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.	cuerda Restricciones: Patrón = `^[A-Za-z0-9-._]{1,64}$` (obligatorio)
fuente	Origen al que se va a aplicar la regla de enrutamiento, como DeviceMessages.	'DeviceConnectionStateEvents' "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" 'No válido' 'TwinChangeEvents' (obligatorio)

RoutingCosmosDBSqlApiProperties

Nombre	Descripción	Valor
authenticationType	Método que se usa para autenticarse en el punto de conexión del contenedor sql de Cosmos DB	'identityBased' 'keyBased'
containerName	Nombre del contenedor sql de Cosmos DB en la base de datos de Cosmos DB.	string (obligatorio)
databaseName	Nombre de la base de datos de Cosmos DB en la cuenta de cosmos DB.	string (obligatorio)
endpointUri	Dirección URL de la cuenta de Cosmos DB. Debe incluir el protocolo https://	string (obligatorio)
identidad	Propiedades de identidad administrada del punto de conexión de contenedor de Cosmos DB de enrutamiento.	managedIdentity
nombre	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, fileNotifications, $default. Los nombres de punto de conexión deben ser únicos en los tipos de punto de conexión.	cuerda Restricciones: Patrón = `^[A-Za-z0-9-._]{1,64}$` (obligatorio)
partitionKeyName	Nombre de la clave de partición asociada a este contenedor sql de Cosmos DB si existe. Se trata de un parámetro opcional.	cuerda
partitionKeyTemplate	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. Este parámetro solo es necesario si se especifica PartitionKeyName.	cuerda
primaryKey	Clave principal de la cuenta de Cosmos DB.	cuerda Restricciones: Valor confidencial. Pase como parámetro seguro.
resourceGroup	Nombre del grupo de recursos de la cuenta de Cosmos DB.	cuerda
secondaryKey	Clave secundaria de la cuenta de Cosmos DB.	cuerda Restricciones: Valor confidencial. Pase como parámetro seguro.
subscriptionId	Identificador de suscripción de la cuenta de Cosmos DB.	cuerda

RoutingEndpoints

Nombre	Descripción	Valor
cosmosDBSqlContainers	La lista de puntos de conexión de contenedor de Cosmos DB a los que IoT Hub enruta los mensajes, en función de las reglas de enrutamiento.	RoutingCosmosDBSqlApiProperties[]
eventHubs	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.	RoutingEventHubProperties[]
serviceBusQueues	La lista de puntos de conexión de cola de Service Bus a los que IoT Hub enruta los mensajes, en función de las reglas de enrutamiento.	RoutingServiceBusQueueEndpointProperties[]
serviceBusTopics	La lista de puntos de conexión del tema de Service Bus a los que ioT Hub enruta los mensajes, en función de las reglas de enrutamiento.	RoutingServiceBusTopicEndpointProperties[]
storageContainers	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.	RoutingStorageContainerProperties[]

RoutingEventHubProperties

Nombre	Descripción	Valor
authenticationType	Método usado para autenticarse en el punto de conexión del centro de eventos	'identityBased' 'keyBased'
connectionString	Cadena de conexión del punto de conexión del centro de eventos.	cuerda
endpointUri	Dirección URL del punto de conexión del centro de eventos. Debe incluir el protocolo sb://	cuerda
entityPath	Nombre del centro de eventos en el espacio de nombres del centro de eventos	cuerda
identificación	Identificador del punto de conexión del centro de eventos	cuerda
identidad	Propiedades de identidad administrada del punto de conexión del centro de eventos de enrutamiento.	managedIdentity
nombre	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, fileNotifications, $default. Los nombres de punto de conexión deben ser únicos en los tipos de punto de conexión.	cuerda Restricciones: Patrón = `^[A-Za-z0-9-._]{1,64}$` (obligatorio)
resourceGroup	Nombre del grupo de recursos del punto de conexión del centro de eventos.	cuerda
subscriptionId	Identificador de suscripción del punto de conexión del centro de eventos.	cuerda

RoutingProperties

Nombre	Descripción	Valor
Extremos	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 permite un máximo de 10 puntos de conexión personalizados en todos los tipos de punto de conexión para centros de pago y solo se permite un punto de conexión personalizado en todos los tipos de puntos de conexión para centros gratuitos.	RoutingEndpoints de
Enriquecimientos	Lista de enriquecimientos proporcionados por el usuario que el centro de IoT aplica a los mensajes que se van a entregar a puntos de conexión integrados y personalizados. Consulte: https://aka.ms/telemetryoneventgrid	EnriquecimientoPropiedades[]
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 "routes". Se trata de un parámetro opcional. Cuando esta propiedad no está presente en la plantilla, la ruta de reserva está deshabilitada de forma predeterminada.	fallbackRouteProperties
Rutas	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.	RouteProperties[]

RoutingServiceBusQueueEndpointProperties

Nombre	Descripción	Valor
authenticationType	Método usado para autenticarse en el punto de conexión de cola de Service Bus	'identityBased' 'keyBased'
connectionString	Cadena de conexión del punto de conexión de cola de Service Bus.	cuerda
endpointUri	Dirección URL del punto de conexión de cola de Service Bus. Debe incluir el protocolo sb://	cuerda
entityPath	Nombre de cola en el espacio de nombres de Service Bus	cuerda
identificación	Identificador del punto de conexión de cola de Service Bus	cuerda
identidad	Propiedades de identidad administrada del punto de conexión de cola de Service Bus de enrutamiento.	managedIdentity
nombre	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, fileNotifications, $default. Los nombres de punto de conexión deben ser únicos en los tipos de punto de conexión. El nombre no debe ser el mismo que el nombre de la cola real.	cuerda Restricciones: Patrón = `^[A-Za-z0-9-._]{1,64}$` (obligatorio)
resourceGroup	Nombre del grupo de recursos del punto de conexión de cola de Service Bus.	cuerda
subscriptionId	Identificador de suscripción del punto de conexión de cola de Service Bus.	cuerda

RoutingServiceBusTopicEndpointProperties

Nombre	Descripción	Valor
authenticationType	Método usado para autenticarse en el punto de conexión del tema de Service Bus	'identityBased' 'keyBased'
connectionString	Cadena de conexión del punto de conexión del tema de Service Bus.	cuerda
endpointUri	Dirección URL del punto de conexión del tema de Service Bus. Debe incluir el protocolo sb://	cuerda
entityPath	Nombre de cola en el tema de Service Bus	cuerda
identificación	Identificador del punto de conexión del tema de Service Bus	cuerda
identidad	Propiedades de identidad administrada del punto de conexión del tema de Service Bus de enrutamiento.	managedIdentity
nombre	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, fileNotifications, $default. Los nombres de punto de conexión deben ser únicos en los tipos de punto de conexión. El nombre no debe ser el mismo que el nombre del tema real.	cuerda Restricciones: Patrón = `^[A-Za-z0-9-._]{1,64}$` (obligatorio)
resourceGroup	Nombre del grupo de recursos del punto de conexión del tema de Service Bus.	cuerda
subscriptionId	Identificador de suscripción del punto de conexión del tema de Service Bus.	cuerda

RoutingStorageContainerProperties

Nombre	Descripción	Valor
authenticationType	Método usado para autenticarse en el punto de conexión de almacenamiento	'identityBased' 'keyBased'
batchFrequencyInSeconds	Intervalo de tiempo en el que los blobs se escriben en el almacenamiento. El valor debe estar comprendido entre 60 y 720 segundos. El valor predeterminado es de 300 segundos.	Int Restricciones: Valor mínimo = 60 Valor máximo = 720
connectionString	Cadena de conexión de la cuenta de almacenamiento.	cuerda
containerName	Nombre del contenedor de almacenamiento en la cuenta de almacenamiento.	string (obligatorio)
codificación	Codificación que se usa para serializar mensajes en blobs. Los valores admitidos son "avro", "avrodeflate" y "JSON". El valor predeterminado es "avro".	'Avro' 'AvroDeflate' 'JSON'
endpointUri	Dirección URL del punto de conexión de almacenamiento. Debe incluir el protocolo https://	cuerda
fileNameFormat	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.	cuerda
identificación	Identificador del punto de conexión del contenedor de almacenamiento	cuerda
identidad	Propiedades de identidad administrada del punto de conexión de almacenamiento de enrutamiento.	managedIdentity
maxChunkSizeInBytes	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).	Int Restricciones: Valor mínimo = 10485760 Valor máximo = 524288000
nombre	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, fileNotifications, $default. Los nombres de punto de conexión deben ser únicos en los tipos de punto de conexión.	cuerda Restricciones: Patrón = `^[A-Za-z0-9-._]{1,64}$` (obligatorio)
resourceGroup	Nombre del grupo de recursos de la cuenta de almacenamiento.	cuerda
subscriptionId	Identificador de suscripción de la cuenta de almacenamiento.	cuerda

SharedAccessSignatureAuthorizationRule

Nombre	Descripción	Valor
keyName	Nombre de la directiva de acceso compartido.	string (obligatorio)
primaryKey	Clave principal.	cuerda
derechos	Permisos asignados a la directiva de acceso compartido.	"DeviceConnect" 'RegistryRead' "RegistryRead, DeviceConnect" "RegistryRead, RegistryWrite" "RegistryRead, RegistryWrite, DeviceConnect" "RegistryRead, RegistryWrite, ServiceConnect" 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' "RegistryRead, ServiceConnect" "RegistryRead, ServiceConnect, DeviceConnect" 'RegistryWrite' "RegistryWrite, DeviceConnect" "RegistryWrite, ServiceConnect" "RegistryWrite, ServiceConnect, DeviceConnect" "ServiceConnect" "ServiceConnect, DeviceConnect" (obligatorio)
secondaryKey	Clave secundaria.	cuerda

StorageEndpointProperties

Nombre	Descripción	Valor
authenticationType	Especifica el tipo de autenticación que se usa para conectarse a la cuenta de almacenamiento.	'identityBased' 'keyBased'
connectionString	Cadena de conexión de la cuenta de Azure Storage a la que se cargan los archivos.	string (obligatorio)
containerName	Nombre del contenedor raíz donde se cargan los archivos. El contenedor no debe existir, pero debe ser creatable mediante el parámetro connectionString especificado.	string (obligatorio)
identidad	Propiedades de identidad administrada del punto de conexión de almacenamiento para la carga de archivos.	managedIdentity
sasTtlAsIso8601	El período de tiempo durante el que el URI de SAS generado por IoT Hub para la carga de archivos es válido. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.	cuerda

Compartir a través de

Microsoft.Devices IotHubs

Definición de recursos de Bicep

Formato de recurso

Valores de propiedad

ArmIdentity

ArmIdentityUserAssignedIdentities

ArmUserIdentity

CloudToDeviceProperties

EnrichmentProperties

EventHubProperties

FallbackRouteProperties

FeedbackProperties

IotHubProperties

IotHubPropertiesEventHubEndpoints

IotHubPropertiesMessagingEndpoints

IotHubPropertiesStorageEndpoints

IotHubSkuInfo

IpFilterRule

ManagedIdentity

MessagingEndpointProperties

Microsoft.Devices/IotHubs

NetworkRuleSetIpRule

NetworkRuleSetProperties

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

ResourceTags

RouteProperties

RoutingCosmosDBSqlApiProperties

RoutingEndpoints

RoutingEventHubProperties

RoutingProperties

RoutingServiceBusQueueEndpointProperties

RoutingServiceBusTopicEndpointProperties

RoutingStorageContainerProperties

SharedAccessSignatureAuthorizationRule

StorageEndpointProperties

Ejemplos de inicio rápido

Definición de recursos de plantilla de ARM

Formato de recurso

Valores de propiedad

ArmIdentity

ArmIdentityUserAssignedIdentities

ArmUserIdentity

CloudToDeviceProperties

EnrichmentProperties

EventHubProperties

FallbackRouteProperties

FeedbackProperties

IotHubProperties

IotHubPropertiesEventHubEndpoints

IotHubPropertiesMessagingEndpoints

IotHubPropertiesStorageEndpoints

IotHubSkuInfo

IpFilterRule

ManagedIdentity

MessagingEndpointProperties

Microsoft.Devices/IotHubs

NetworkRuleSetIpRule

NetworkRuleSetProperties

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

ResourceTags

RouteProperties

RoutingCosmosDBSqlApiProperties

RoutingEndpoints

RoutingEventHubProperties

RoutingProperties

RoutingServiceBusQueueEndpointProperties

RoutingServiceBusTopicEndpointProperties

RoutingStorageContainerProperties

SharedAccessSignatureAuthorizationRule

StorageEndpointProperties

Plantillas de inicio rápido

Definición de recursos de Terraform (proveedor AzAPI)

Formato de recurso