Microsoft.Devices IotHubs 2021-07-02

• Más reciente
• 2023-06-30
• 2023-06-30-preview
• 2022-11-15-preview
• 2022-04-30-preview
• 2021-07-02
• 2021-07-02-preview
• 01-07-2021
• 2021-07-01-preview
• 31-03-2021
• 2021-03-03-preview
• 2021-02-01-preview

Definición de recursos de Bicep

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

• Grupos de recursos: consulte los comandos de implementación del grupo de recursos.

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

Formato de los recursos

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

resource symbolicname 'Microsoft.Devices/IotHubs@2021-07-02' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  etag: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    allowedFqdnList: [
      'string'
    ]
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
        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: 'Allow'
          filterName: 'string'
          ipMask: 'string'
        }
      ]
    }
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    publicNetworkAccess: 'string'
    restrictOutboundNetworkAccess: bool
    routing: {
      endpoints: {
        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

IotHubs

Nombre	Descripción	Value
name	El nombre del recurso	string (obligatorio) Límite de caracteres: 3-50 Caracteres válidos: Caracteres alfanuméricos y guiones. No puede terminar con un guion. El nombre del recurso debe ser único en Azure.
ubicación	Ubicación del recurso.	string (obligatorio)
etiquetas	Etiquetas del recurso.	Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
sku	Información de SKU de IotHub	IotHubSkuInfo (obligatorio)
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 de ETag normal.	string
identidad	Identidades administradas para IotHub.	ArmIdentity
properties	Propiedades de IotHub	IotHubProperties

ArmIdentity

Nombre	Descripción	Value
type	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
{propiedad personalizada}		ArmUserIdentity

ArmUserIdentity

Este objeto no contiene ninguna propiedad que se va a establecer durante la implementación. Todas las propiedades son ReadOnly.

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
comments	Comentarios de IoT Hub.	string
disableDeviceSAS	Si es true, no se pueden usar todas las claves SAS con ámbito de todos los dispositivos (incluidos los dispositivos perimetrales, pero 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 de módulo para la autenticación.	bool
enableDataResidency	Esta propiedad cuando se establece en true, habilitará la residencia de datos, por lo tanto, deshabilitando 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 mientras se realizan llamadas de creación o actualización para ioT Hub.	IotHubPropertiesEventHubEndpoints
features	Las funcionalidades y características habilitadas para el centro de IoT.	"DeviceManagement" 'Ninguno'
ipFilterRules	Reglas de filtro IP.	IpFilterRule[]
messagingEndpoints	Las 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 de TLS inferior a la 1.2 se rechacen.	string
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	La lista de puntos de conexión de Azure Storage donde puede cargar archivos. Actualmente solo puede configurar una cuenta de Azure Storage y que DEBE tener su clave como $default. Si se especifica más de una cuenta de almacenamiento, se producirá un error. Si no se especifica un valor para esta propiedad cuando la propiedad enableFileUploadNotifications está establecida en True, se produce un error.	IotHubPropertiesStorageEndpoints

SharedAccessSignatureAuthorizationRule

Nombre	Descripción	Valor
keyName	Nombre de la directiva de acceso compartido.	string (obligatorio)
primaryKey	Clave principal.	string
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.	string
keyName	Nombre de la directiva de acceso compartido.	string (obligatorio)
primaryKey	Clave principal.	string
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.	string

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.	string
feedback	Las propiedades de la cola de comentarios para los mensajes de nube a dispositivo.	FeedbackProperties
maxDeliveryCount	Recuento máximo de entregas para los 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

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.	string
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.	string

IotHubPropertiesEventHubEndpoints

Nombre	Descripción	Valor
{propiedad personalizada}		EventHubProperties

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	El tiempo de retención de los mensajes de dispositivo a nube en días. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	int

IpFilterRule

Nombre	Descripción	Valor
action	La acción deseada para las solicitudes capturadas por esta regla.	'Accept' 'Rechazar' (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)

IotHubPropertiesMessagingEndpoints

Nombre	Descripción	Valor
{propiedad personalizada}		MessagingEndpointProperties

MessagingEndpointProperties

Nombre	Descripción	Valor
lockDurationAsIso8601	Duración del bloqueo. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload.	string
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.	string

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)

NetworkRuleSetIpRule

Nombre	Descripción	Valor
action	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)

PrivateEndpointConnection

Nombre	Descripción	Valor
properties	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)

PrivateEndpoint

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

PrivateLinkServiceConnectionState

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

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 permiten un máximo de 10 puntos de conexión personalizados en todos los tipos de puntos de conexión para centros de pago y solo se permite 1 punto de conexión personalizado en todos los tipos de puntos de conexión para centros gratuitos.	RoutingEndpoints
Enriquecimientos	Lista de enriquecimientos proporcionados por el usuario que el centro de IoT aplica a los mensajes que se van a entregar a los puntos de conexión integrados y personalizados. Consulte: https://aka.ms/telemetryoneventgrid	EnrichmentProperties[]
fallbackRoute	Las propiedades de la ruta que se usa como ruta de reserva cuando no se cumple ninguna de las condiciones especificadas en la sección "rutas". Se trata de un parámetro opcional. Cuando 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[]

RoutingEndpoints

Nombre	Descripción	Valor
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	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	Lista de puntos de conexión de tema de Service Bus a los que el centro de IoT enruta los mensajes en función de las reglas de enrutamiento.	RoutingServiceBusTopicEndpointProperties[]
storageContainers	La lista de puntos de conexión de contenedor de almacenamiento a los que IoT Hub enruta los mensajes, en función de las reglas de enrutamiento.	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	El cadena de conexión del punto de conexión del centro de eventos.	string
endpointUri	Dirección URL del punto de conexión del centro de eventos. Debe incluir el protocolo sb://	string
entityPath	Nombre del centro de eventos en el espacio de nombres del centro de eventos	string
id	Identificador del punto de conexión del centro de eventos	string
identidad	Propiedades de identidad administrada del punto de conexión del centro de eventos de enrutamiento.	ManagedIdentity
name	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.	string (obligatorio) Restricciones: Patrón = ^[A-Za-z0-9-._]{1,64}$
resourceGroup	Nombre del grupo de recursos del punto de conexión del centro de eventos.	string
subscriptionId	Identificador de suscripción del punto de conexión del centro de eventos.	string

ManagedIdentity

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

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	El cadena de conexión del punto de conexión de cola de Service Bus.	string
endpointUri	Dirección URL del punto de conexión de cola de Service Bus. Debe incluir el protocolo sb://	string
entityPath	Nombre de cola en el espacio de nombres de Service Bus	string
id	Identificador del punto de conexión de cola de Service Bus	string
identidad	Propiedades de identidad administrada del punto de conexión de cola de Service Bus de enrutamiento.	ManagedIdentity
name	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 real de la cola.	string (obligatorio) Restricciones: Patrón = ^[A-Za-z0-9-._]{1,64}$
resourceGroup	Nombre del grupo de recursos del punto de conexión de cola de Service Bus.	string
subscriptionId	Identificador de suscripción del punto de conexión de cola de Service Bus.	string

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	El cadena de conexión del punto de conexión del tema de Service Bus.	string
endpointUri	Dirección URL del punto de conexión del tema de Service Bus. Debe incluir el protocolo sb://	string
entityPath	Nombre de cola en el tema de Service Bus	string
id	Identificador del punto de conexión del tema de Service Bus	string
identidad	Propiedades de identidad administrada del punto de conexión del tema de Service Bus de enrutamiento.	ManagedIdentity
name	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 los puntos de conexión deben ser únicos en los tipos de punto de conexión. El nombre no debe ser el mismo que el nombre real del tema.	string (obligatorio) Restricciones: Patrón = ^[A-Za-z0-9-._]{1,64}$
resourceGroup	Nombre del grupo de recursos del punto de conexión del tema de Service Bus.	string
subscriptionId	Identificador de suscripción del punto de conexión del tema de Service Bus.	string

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 se escriben blobs en el almacenamiento. El valor debe estar entre 60 y 720 segundos. El valor predeterminado es 300 segundos.	int Restricciones: Valor mínimo = 60 Valor máximo = 720
connectionString	El cadena de conexión de la cuenta de almacenamiento.	string
containerName	Nombre del contenedor de almacenamiento en la cuenta de almacenamiento.	string (obligatorio)
encoding	Codificación que se usa para serializar mensajes en blobs. Los valores admitidos son "avro", "avrodobjectate" 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://	string
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.	string
id	Identificador del punto de conexión del contenedor de almacenamiento	string
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
name	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 los puntos de conexión deben ser únicos en los tipos de punto de conexión.	string (obligatorio) Restricciones: Patrón = ^[A-Za-z0-9-._]{1,64}$
resourceGroup	Nombre del grupo de recursos de la cuenta de almacenamiento.	string
subscriptionId	Identificador de suscripción de la cuenta de almacenamiento.	string

EnrichmentProperties

Nombre	Descripción	Valor
endpointNames	Lista de puntos de conexión para los que se aplica el enriquecimiento al mensaje.	string[] (obligatorio) Restricciones: Longitud mínima = 1
key	Clave o nombre de la propiedad de enriquecimiento.	string (obligatorio)
value	Valor de la propiedad de enriquecimiento.	string (obligatorio)

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	string
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) Restricciones: Longitud mínima = 1 Longitud máxima = 1
isEnabled	Se usa para especificar si la ruta de reserva está habilitada.	bool (obligatorio)
name	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.	string
source	Origen al que se va a aplicar la regla de enrutamiento. Por ejemplo, DeviceMessages	"DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" 'No válido' 'TwinChangeEvents' (obligatorio)

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	string
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) Restricciones: Longitud mínima = 1 Longitud máxima = 1
isEnabled	Se usa para especificar si una ruta está habilitada.	bool (obligatorio)
name	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.	string (obligatorio) Restricciones: Patrón = ^[A-Za-z0-9-._]{1,64}$
source	Origen al que se va a aplicar la regla de enrutamiento, como DeviceMessages.	"DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" 'No válido' 'TwinChangeEvents' (obligatorio)

IotHubPropertiesStorageEndpoints

Nombre	Descripción	Valor
{propiedad personalizada}		StorageEndpointProperties

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	El cadena de conexión de la cuenta de Azure Storage en 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 creable mediante 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.	string

IotHubSkuInfo

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

Plantillas de inicio rápido

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

Plantilla	Descripción
Creación de un simulador perimetral de IOT Hub y Ubuntu	Esta plantilla crea un simulador perimetral de Ubuntu de IOT Hub y máquina virtual.
Uso de una plantilla de ARM para crear IoT Hub, enrutar y ver mensajes	Use esta plantilla para implementar un IoT Hub y una cuenta de almacenamiento. Ejecute una aplicación para enviar mensajes al centro que se enruta al almacenamiento y, a continuación, vea los resultados.
Creación de un servicio IoT Hub Device Provisioning	Esta plantilla le permite crear un centro de IoT y un servicio de IoT Hub Device Provisioning y vincular los dos servicios juntos.
Creación de una IoT Hub y un grupo de consumidores en la nube	Esta plantilla le permite implementar una instancia de IoT Hub con configuraciones de mensajería de dispositivo en la nube y en la nube en dispositivos y un dispositivo en un grupo de consumidores en la nube.
Creación de Device Update para IoT Hub cuenta, instancia IoT Hub	Esta plantilla crea una cuenta y una instancia de 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 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.
Crear un entorno de pago por uso (PAYG) con una IoT Hub	Esta plantilla le permite implementar un entorno de Time Series Insights de pago por uso (PAYG) configurado para consumir eventos de una IoT Hub.

Definición de recursos de plantilla de ARM

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

• Grupos de recursos: consulte los comandos de implementación del grupo de recursos.

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

Formato de los recursos

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

{
  "type": "Microsoft.Devices/IotHubs",
  "apiVersion": "2021-07-02",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "allowedFqdnList": [ "string" ],
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string",
        "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": "Allow",
          "filterName": "string",
          "ipMask": "string"
        }
      ]
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {},
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "publicNetworkAccess": "string",
    "restrictOutboundNetworkAccess": "bool",
    "routing": {
      "endpoints": {
        "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

IotHubs

Nombre	Descripción	Value
type	Tipo de recurso	"Microsoft.Devices/IotHubs"
apiVersion	La versión de la API de recursos	'2021-07-02'
name	El nombre del recurso	string (obligatorio) Límite de caracteres: 3-50 Caracteres válidos: Caracteres alfanuméricos y guiones. No puede terminar con un guion. El nombre del recurso debe ser único en Azure.
ubicación	Ubicación del recurso.	string (obligatorio)
etiquetas	Etiquetas del recurso.	Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
sku	Información de SKU de IotHub	IotHubSkuInfo (obligatorio)
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 de ETag normal.	string
identidad	Identidades administradas para IotHub.	ArmIdentity
properties	Propiedades de IotHub	IotHubProperties

ArmIdentity

Nombre	Descripción	Value
type	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
{propiedad personalizada}		ArmUserIdentity

ArmUserIdentity

Este objeto no contiene ninguna propiedad que se va a establecer durante la implementación. Todas las propiedades son ReadOnly.

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
comments	Comentarios de IoT Hub.	string
disableDeviceSAS	Si es true, no se pueden usar todas las claves SAS con ámbito de todos los dispositivos (incluidos los dispositivos perimetrales, pero 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 de módulo para la autenticación.	bool
enableDataResidency	Esta propiedad, cuando se establece en true, habilitará la residencia de datos, lo que deshabilitará la recuperación ante desastres.	bool
enableFileUploadNotifications	Si es True, se habilitan las notificaciones de carga de archivos.	bool
eventHubEndpoints	Propiedades del punto de conexión compatible con Event Hubs. Las únicas claves posibles para este diccionario son eventos. Esta clave debe estar presente en el diccionario mientras se realizan llamadas de creación o actualización para el centro de IoT.	IotHubPropertiesEventHubEndpoints
features	Las funcionalidades y características habilitadas para el centro de IoT.	"DeviceManagement" 'Ninguno'
ipFilterRules	Las reglas de filtro IP.	IpFilterRule[]
messagingEndpoints	Las 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 de TLS inferior a la 1.2 se rechacen.	string
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 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	La lista de puntos de conexión de Azure Storage donde puede cargar archivos. Actualmente, solo puede configurar una cuenta de Azure Storage y que DEBE tener su clave como $default. Si se especifica más de una cuenta de almacenamiento, se 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

SharedAccessSignatureAuthorizationRule

Nombre	Descripción	Valor
keyName	Nombre de la directiva de acceso compartido.	string (obligatorio)
primaryKey	Clave principal.	string
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.	string
keyName	Nombre de la directiva de acceso compartido.	string (obligatorio)
primaryKey	Clave principal.	string
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.	string

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.	string
feedback	Las propiedades de la cola de comentarios para los mensajes de nube a dispositivo.	FeedbackProperties
maxDeliveryCount	Recuento máximo de entregas para los 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

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.	string
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.	string

IotHubPropertiesEventHubEndpoints

Nombre	Descripción	Valor
{propiedad personalizada}		EventHubProperties

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	El tiempo de retención de los mensajes de dispositivo a nube en días. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	int

IpFilterRule

Nombre	Descripción	Valor
action	La acción deseada para las solicitudes capturadas por esta regla.	'Accept' 'Rechazar' (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)

IotHubPropertiesMessagingEndpoints

Nombre	Descripción	Valor
{propiedad personalizada}		MessagingEndpointProperties

MessagingEndpointProperties

Nombre	Descripción	Valor
lockDurationAsIso8601	Duración del bloqueo. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload.	string
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.	string

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)

NetworkRuleSetIpRule

Nombre	Descripción	Valor
action	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)

PrivateEndpointConnection

Nombre	Descripción	Valor
properties	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)

PrivateEndpoint

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

PrivateLinkServiceConnectionState

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

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 permiten un máximo de 10 puntos de conexión personalizados en todos los tipos de puntos de conexión para centros de pago y solo se permite 1 punto de conexión personalizado en todos los tipos de puntos de conexión para centros gratuitos.	RoutingEndpoints
Enriquecimientos	Lista de enriquecimientos proporcionados por el usuario que el centro de IoT aplica a los mensajes que se van a entregar a los puntos de conexión integrados y personalizados. Consulte: https://aka.ms/telemetryoneventgrid	EnrichmentProperties[]
fallbackRoute	Las propiedades de la ruta que se usa como ruta de reserva cuando no se cumple ninguna de las condiciones especificadas en la sección "rutas". Se trata de un parámetro opcional. Cuando 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[]

RoutingEndpoints

Nombre	Descripción	Valor
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	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	Lista de puntos de conexión de tema de Service Bus a los que el centro de IoT enruta los mensajes en función de las reglas de enrutamiento.	RoutingServiceBusTopicEndpointProperties[]
storageContainers	La lista de puntos de conexión de contenedor de almacenamiento a los que IoT Hub enruta los mensajes, en función de las reglas de enrutamiento.	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	El cadena de conexión del punto de conexión del centro de eventos.	string
endpointUri	Dirección URL del punto de conexión del centro de eventos. Debe incluir el protocolo sb://	string
entityPath	Nombre del centro de eventos en el espacio de nombres del centro de eventos	string
id	Identificador del punto de conexión del centro de eventos	string
identidad	Propiedades de identidad administrada del punto de conexión del centro de eventos de enrutamiento.	ManagedIdentity
name	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.	string (obligatorio) Restricciones: Patrón = ^[A-Za-z0-9-._]{1,64}$
resourceGroup	Nombre del grupo de recursos del punto de conexión del centro de eventos.	string
subscriptionId	Identificador de suscripción del punto de conexión del centro de eventos.	string

ManagedIdentity

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

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	El cadena de conexión del punto de conexión de cola de Service Bus.	string
endpointUri	Dirección URL del punto de conexión de cola de Service Bus. Debe incluir el protocolo sb://	string
entityPath	Nombre de cola en el espacio de nombres de Service Bus	string
id	Identificador del punto de conexión de cola de Service Bus	string
identidad	Propiedades de identidad administrada del punto de conexión de cola de Service Bus de enrutamiento.	ManagedIdentity
name	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 real de la cola.	string (obligatorio) Restricciones: Patrón = ^[A-Za-z0-9-._]{1,64}$
resourceGroup	Nombre del grupo de recursos del punto de conexión de cola de Service Bus.	string
subscriptionId	Identificador de suscripción del punto de conexión de cola de Service Bus.	string

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	El cadena de conexión del punto de conexión del tema de Service Bus.	string
endpointUri	Dirección URL del punto de conexión del tema de Service Bus. Debe incluir el protocolo sb://	string
entityPath	Nombre de la cola en el tema de Service Bus	string
id	Identificador del punto de conexión del tema de Service Bus	string
identidad	Propiedades de identidad administrada del punto de conexión del tema de Service Bus de enrutamiento.	ManagedIdentity
name	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 real del tema.	string (obligatorio) Restricciones: Patrón = ^[A-Za-z0-9-._]{1,64}$
resourceGroup	Nombre del grupo de recursos del punto de conexión del tema de Service Bus.	string
subscriptionId	Identificador de suscripción del punto de conexión del tema de Service Bus.	string

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 se escriben blobs 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	El cadena de conexión de la cuenta de almacenamiento.	string
containerName	Nombre del contenedor de almacenamiento en la cuenta de almacenamiento.	string (obligatorio)
encoding	Codificación que se usa para serializar mensajes en blobs. Los valores admitidos son "avro", "avrodbtate" 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://	string
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.	string
id	Identificador del punto de conexión del contenedor de almacenamiento	string
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
name	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 los puntos de conexión deben ser únicos en los tipos de punto de conexión.	string (obligatorio) Restricciones: Patrón = ^[A-Za-z0-9-._]{1,64}$
resourceGroup	Nombre del grupo de recursos de la cuenta de almacenamiento.	string
subscriptionId	Identificador de suscripción de la cuenta de almacenamiento.	string

EnrichmentProperties

Nombre	Descripción	Valor
endpointNames	Lista de puntos de conexión para los que se aplica el enriquecimiento al mensaje.	string[] (obligatorio) Restricciones: Longitud mínima = 1
key	Clave o nombre de la propiedad de enriquecimiento.	string (obligatorio)
value	Valor de la propiedad de enriquecimiento.	string (obligatorio)

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	string
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) Restricciones: Longitud mínima = 1 Longitud máxima = 1
isEnabled	Se usa para especificar si la ruta de reserva está habilitada.	bool (obligatorio)
name	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.	string
source	Origen al que se va a aplicar la regla de enrutamiento. Por ejemplo, DeviceMessages	"DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" 'No válido' 'TwinChangeEvents' (obligatorio)

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	string
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) Restricciones: Longitud mínima = 1 Longitud máxima = 1
isEnabled	Se usa para especificar si una ruta está habilitada.	bool (obligatorio)
name	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.	string (obligatorio) Restricciones: Patrón = ^[A-Za-z0-9-._]{1,64}$
source	Origen al que se va a aplicar la regla de enrutamiento, como DeviceMessages.	"DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" 'No válido' 'TwinChangeEvents' (obligatorio)

IotHubPropertiesStorageEndpoints

Nombre	Descripción	Valor
{propiedad personalizada}		StorageEndpointProperties

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	El 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 necesita existir, pero debe ser creable mediante 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.	string

IotHubSkuInfo

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

Plantillas de inicio rápido

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

Plantilla	Descripción
Creación de un simulador perimetral de IOT Hub y Ubuntu	Esta plantilla crea un simulador perimetral de Ubuntu de IOT Hub y máquina virtual.
Uso de la plantilla de ARM para crear IoT Hub, enrutar y ver mensajes	Use esta plantilla para implementar un IoT Hub y una cuenta de almacenamiento. Ejecute una aplicación para enviar mensajes al centro que se enruta al almacenamiento y, a continuación, vea los resultados.
Creación de un servicio de aprovisionamiento de dispositivos IoT Hub	Esta plantilla le permite crear un centro de IoT y un servicio de aprovisionamiento de dispositivos IoT Hub y vincular los dos servicios juntos.
Creación de una IoT Hub y un grupo de consumidores en la nube	Esta plantilla le permite implementar una instancia de IoT Hub con configuraciones de mensajería de dispositivos en la nube y en la nube y un dispositivo en un grupo de consumidores en la nube.
Creación de Device Update para IoT Hub cuenta, instancia 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 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.
Crear un entorno de pago por uso (PAYG) con un 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 IoT Hub.

Definición de recursos de Terraform (proveedor AzAPI)

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

• Grupos de recursos

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

Formato de los recursos

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/IotHubs@2021-07-02"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      allowedFqdnList = [
        "string"
      ]
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
          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 = "Allow"
            filterName = "string"
            ipMask = "string"
          }
        ]
      }
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {}
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      publicNetworkAccess = "string"
      restrictOutboundNetworkAccess = bool
      routing = {
        endpoints = {
          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"
    }
    etag = "string"
  })
}

Valores de propiedad

IotHubs

Nombre	Descripción	Value
type	Tipo de recurso	"Microsoft.Devices/IotHubs@2021-07-02"
name	El nombre del recurso	string (obligatorio) Límite de caracteres: 3-50 Caracteres válidos: Caracteres alfanuméricos y guiones. No puede terminar con un guion. El nombre del recurso debe ser único en Azure.
ubicación	Ubicación del recurso.	string (obligatorio)
parent_id	Para realizar la implementación en un grupo de recursos, use el identificador de ese grupo de recursos.	string (obligatorio)
etiquetas	Etiquetas del recurso.	Diccionario de nombres y valores de etiqueta.
sku	Información de SKU de IotHub	IotHubSkuInfo (obligatorio)
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 de ETag normal.	string
identidad	Identidades administradas para IotHub.	ArmIdentity
properties	Propiedades de IotHub	IotHubProperties

ArmIdentity

Nombre	Descripción	Value
type	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.	"SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned"
identity_ids	Diccionario de {ArmUserIdentity}	Matriz de identificadores de identidad de usuario.

ArmIdentityUserAssignedIdentities

Nombre	Descripción	Valor
{propiedad personalizada}		ArmUserIdentity

ArmUserIdentity

Este objeto no contiene ninguna propiedad que se va a establecer durante la implementación. Todas las propiedades son ReadOnly.

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
comments	Comentarios de IoT Hub.	string
disableDeviceSAS	Si es true, no se pueden usar todas las claves SAS con ámbito de todos los dispositivos (incluidos los dispositivos perimetrales, pero 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 de módulo para la autenticación.	bool
enableDataResidency	Esta propiedad, cuando se establece en true, habilitará la residencia de datos, lo que deshabilitará la recuperación ante desastres.	bool
enableFileUploadNotifications	Si es True, se habilitan las notificaciones de carga de archivos.	bool
eventHubEndpoints	Propiedades del punto de conexión compatible con Event Hubs. Las únicas claves posibles para este diccionario son eventos. Esta clave debe estar presente en el diccionario mientras se realizan llamadas de creación o actualización para el centro de IoT.	IotHubPropertiesEventHubEndpoints
features	Las funcionalidades y características habilitadas para el centro de IoT.	"DeviceManagement" "None"
ipFilterRules	Las reglas de filtro IP.	IpFilterRule[]
messagingEndpoints	Las 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 de TLS inferior a la 1.2 se rechacen.	string
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	La lista de puntos de conexión de Azure Storage donde puede cargar archivos. Actualmente solo puede configurar una cuenta de Azure Storage y que DEBE tener su clave como $default. Si se especifica más de una cuenta de almacenamiento, se producirá un error. Si no se especifica un valor para esta propiedad cuando la propiedad enableFileUploadNotifications está establecida en True, se produce un error.	IotHubPropertiesStorageEndpoints

SharedAccessSignatureAuthorizationRule

Nombre	Descripción	Valor
keyName	Nombre de la directiva de acceso compartido.	string (obligatorio)
primaryKey	Clave principal.	string
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.	string
keyName	Nombre de la directiva de acceso compartido.	string (obligatorio)
primaryKey	Clave principal.	string
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.	string

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.	string
feedback	Las propiedades de la cola de comentarios para los mensajes de nube a dispositivo.	FeedbackProperties
maxDeliveryCount	Recuento máximo de entregas para los 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

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.	string
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.	string

IotHubPropertiesEventHubEndpoints

Nombre	Descripción	Valor
{propiedad personalizada}		EventHubProperties

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	El tiempo de retención de los mensajes de dispositivo a nube en días. Consulte: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	int

IpFilterRule

Nombre	Descripción	Valor
action	La acción deseada para las solicitudes capturadas por esta regla.	"Aceptar" "Rechazar" (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)

IotHubPropertiesMessagingEndpoints

Nombre	Descripción	Valor
{propiedad personalizada}		MessagingEndpointProperties

MessagingEndpointProperties

Nombre	Descripción	Valor
lockDurationAsIso8601	Duración del bloqueo. Consulte: /azure/iot-hub/iot-hub-devguide-file-upload.	string
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.	string

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)

NetworkRuleSetIpRule

Nombre	Descripción	Valor
action	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)

PrivateEndpointConnection

Nombre	Descripción	Valor
properties	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)

PrivateEndpoint

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

PrivateLinkServiceConnectionState

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

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 permiten un máximo de 10 puntos de conexión personalizados en todos los tipos de puntos de conexión para centros de pago y solo se permite 1 punto de conexión personalizado en todos los tipos de puntos de conexión para centros gratuitos.	RoutingEndpoints
Enriquecimientos	Lista de enriquecimientos proporcionados por el usuario que el centro de IoT aplica a los mensajes que se van a entregar a los puntos de conexión integrados y personalizados. Consulte: https://aka.ms/telemetryoneventgrid	EnrichmentProperties[]
fallbackRoute	Las propiedades de la ruta que se usa como ruta de reserva cuando no se cumple ninguna de las condiciones especificadas en la sección "rutas". Se trata de un parámetro opcional. Cuando 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[]

RoutingEndpoints

Nombre	Descripción	Valor
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	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	Lista de puntos de conexión de tema de Service Bus a los que el centro de IoT enruta los mensajes en función de las reglas de enrutamiento.	RoutingServiceBusTopicEndpointProperties[]
storageContainers	La lista de puntos de conexión de contenedor de almacenamiento a los que IoT Hub enruta los mensajes, en función de las reglas de enrutamiento.	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	El cadena de conexión del punto de conexión del centro de eventos.	string
endpointUri	Dirección URL del punto de conexión del centro de eventos. Debe incluir el protocolo sb://	string
entityPath	Nombre del centro de eventos en el espacio de nombres del centro de eventos	string
id	Identificador del punto de conexión del centro de eventos	string
identidad	Propiedades de identidad administrada del punto de conexión del centro de eventos de enrutamiento.	ManagedIdentity
name	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.	string (obligatorio) Restricciones: Patrón = ^[A-Za-z0-9-._]{1,64}$
resourceGroup	Nombre del grupo de recursos del punto de conexión del centro de eventos.	string
subscriptionId	Identificador de suscripción del punto de conexión del centro de eventos.	string

ManagedIdentity

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

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	El cadena de conexión del punto de conexión de cola de Service Bus.	string
endpointUri	Dirección URL del punto de conexión de cola de Service Bus. Debe incluir el protocolo sb://	string
entityPath	Nombre de cola en el espacio de nombres de Service Bus	string
id	Identificador del punto de conexión de cola de Service Bus	string
identidad	Propiedades de identidad administrada del punto de conexión de cola de Service Bus de enrutamiento.	ManagedIdentity
name	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 real de la cola.	string (obligatorio) Restricciones: Patrón = ^[A-Za-z0-9-._]{1,64}$
resourceGroup	Nombre del grupo de recursos del punto de conexión de cola de Service Bus.	string
subscriptionId	Identificador de suscripción del punto de conexión de cola de Service Bus.	string

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	El cadena de conexión del punto de conexión del tema de Service Bus.	string
endpointUri	Dirección URL del punto de conexión del tema de Service Bus. Debe incluir el protocolo sb://	string
entityPath	Nombre de la cola en el tema de Service Bus	string
id	Identificador del punto de conexión del tema de Service Bus	string
identidad	Propiedades de identidad administrada del punto de conexión del tema de Service Bus de enrutamiento.	ManagedIdentity
name	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 real del tema.	string (obligatorio) Restricciones: Patrón = ^[A-Za-z0-9-._]{1,64}$
resourceGroup	Nombre del grupo de recursos del punto de conexión del tema de Service Bus.	string
subscriptionId	Identificador de suscripción del punto de conexión del tema de Service Bus.	string

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 se escriben blobs 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	El cadena de conexión de la cuenta de almacenamiento.	string
containerName	Nombre del contenedor de almacenamiento en la cuenta de almacenamiento.	string (obligatorio)
encoding	Codificación que se usa para serializar mensajes en blobs. Los valores admitidos son "avro", "avrodbtate" 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://	string
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.	string
id	Identificador del punto de conexión del contenedor de almacenamiento	string
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
name	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.	string (obligatorio) Restricciones: Patrón = ^[A-Za-z0-9-._]{1,64}$
resourceGroup	Nombre del grupo de recursos de la cuenta de almacenamiento.	string
subscriptionId	Identificador de suscripción de la cuenta de almacenamiento.	string

EnriquecimientoPropiedades

Nombre	Descripción	Valor
endpointNames	Lista de puntos de conexión para los que se aplica el enriquecimiento al mensaje.	string[] (obligatorio) Restricciones: Longitud mínima = 1
key	Clave o nombre de la propiedad de enriquecimiento.	string (obligatorio)
value	Valor de la propiedad de enriquecimiento.	string (obligatorio)

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	string
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) Restricciones: Longitud mínima = 1 Longitud máxima = 1
isEnabled	Se usa para especificar si la ruta de reserva está habilitada.	bool (obligatorio)
name	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.	string
source	Origen al que se va a aplicar la regla de enrutamiento. Por ejemplo, DeviceMessages	"DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "No válido" "TwinChangeEvents" (obligatorio)

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	string
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) Restricciones: Longitud mínima = 1 Longitud máxima = 1
isEnabled	Se usa para especificar si una ruta está habilitada.	bool (obligatorio)
name	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.	string (obligatorio) Restricciones: Patrón = ^[A-Za-z0-9-._]{1,64}$
source	Origen al que se va a aplicar la regla de enrutamiento, como DeviceMessages.	"DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "No válido" "TwinChangeEvents" (obligatorio)

IotHubPropertiesStorageEndpoints

Nombre	Descripción	Valor
{propiedad personalizada}		StorageEndpointProperties

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	El cadena de conexión de la cuenta de Azure Storage en 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 creable mediante 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.	string

IotHubSkuInfo

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