Iot Hub Resource - Update
Actualice las etiquetas de IoT Hubs existentes.
Actualice una etiqueta de IoT Hub existente. para actualizar otros campos, use el método CreateOrUpdate.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2023-06-30
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Identificador del grupo de recursos. |
resource
|
path | True |
string |
Nombre de iot Hub que se va a actualizar. |
subscription
|
path | True |
string |
Identificador de la suscripción. |
api-version
|
query | True |
string |
La versión de la API. |
Cuerpo de la solicitud
Nombre | Tipo | Description |
---|---|---|
tags |
object |
Etiquetas del recurso |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Iot Hub se actualizó correctamente |
Seguridad
azure_auth
Flujo OAuth2 de Azure Active Directory
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
Nombre | Description |
---|---|
user_impersonation | suplantación de su cuenta de usuario |
Ejemplos
IotHubResource_Update
Solicitud de ejemplo
Respuesta de muestra
{
"id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
"name": "testHub",
"type": "Microsoft.Devices/IotHubs",
"location": "centraluseuap",
"tags": {
"foo": "bar"
},
"etag": "AAAAAAFD6M4=",
"properties": {
"state": "Active",
"provisioningState": "Succeeded",
"ipFilterRules": [
{
"filterName": "rule1",
"action": "Accept",
"ipMask": "131.117.159.53"
},
{
"filterName": "rule2",
"action": "Accept",
"ipMask": "157.55.59.128/25"
}
],
"networkRuleSets": {
"defaultAction": "Deny",
"applyToBuiltInEventHubEndpoint": true,
"ipRules": [
{
"filterName": "rule1",
"action": "Allow",
"ipMask": "131.117.159.53"
},
{
"filterName": "rule2",
"action": "Allow",
"ipMask": "157.55.59.128/25"
}
]
},
"hostName": "iot-dps-cit-hub-1.azure-devices.net",
"eventHubEndpoints": {
"events": {
"retentionTimeInDays": 1,
"partitionCount": 2,
"partitionIds": [
"0",
"1"
],
"path": "iot-dps-cit-hub-1",
"endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
}
},
"routing": {
"endpoints": {
"serviceBusQueues": [],
"serviceBusTopics": [],
"eventHubs": [],
"storageContainers": []
},
"routes": [],
"fallbackRoute": {
"name": "$fallback",
"source": "DeviceMessages",
"condition": "true",
"endpointNames": [
"events"
],
"isEnabled": true
}
},
"storageEndpoints": {
"$default": {
"sasTtlAsIso8601": "PT1H",
"connectionString": "",
"containerName": ""
}
},
"messagingEndpoints": {
"fileNotifications": {
"lockDurationAsIso8601": "PT1M",
"ttlAsIso8601": "PT1H",
"maxDeliveryCount": 10
}
},
"enableFileUploadNotifications": false,
"cloudToDevice": {
"maxDeliveryCount": 10,
"defaultTtlAsIso8601": "PT1H",
"feedback": {
"lockDurationAsIso8601": "PT1M",
"ttlAsIso8601": "PT1H",
"maxDeliveryCount": 10
}
},
"features": "None"
},
"sku": {
"name": "S1",
"tier": "Standard",
"capacity": 1
},
"systemData": {
"createdAt": "2021-01-30T00:28:38.963Z"
}
}
Definiciones
Nombre | Description |
---|---|
Access |
Permisos asignados a la directiva de acceso compartido. |
Arm |
|
Arm |
|
Authentication |
Especifica el tipo de autenticación que se usa para conectarse a la cuenta de almacenamiento. |
authentication |
Método usado para autenticarse en el punto de conexión de cola de Service Bus |
Capabilities |
Las funcionalidades y características habilitadas para el centro de IoT. |
Cloud |
Las propiedades de mensajería de nube a dispositivo de IoT Hub. |
created |
Tipo de identidad que creó el recurso. |
Default |
Acción predeterminada para el conjunto de reglas de red |
Enrichment |
Las propiedades de un enriquecimiento que el centro de IoT aplica a los mensajes entregados a los puntos de conexión. |
Event |
Las propiedades del punto de conexión compatible con Event Hubs aprovisionado que usa el centro de IoT. |
Fallback |
Propiedades de la ruta de reserva. IoT Hub usa estas propiedades cuando enruta mensajes al punto de conexión de reserva. |
Feedback |
Las propiedades de la cola de comentarios para los mensajes de nube a dispositivo. |
Iot |
Descripción del centro de IoT. |
Iot |
Representación pública de una de las ubicaciones donde se aprovisiona un recurso. |
Iot |
Propiedades de un centro de IoT. |
Iot |
El rol de la región puede ser principal o secundario. La región primaria es donde se aprovisiona actualmente el centro de IoT. La región secundaria es la región emparejada de recuperación ante desastres (DR) de Azure y también la región en la que el centro de IoT puede conmutar por error. |
Iot |
El nombre de la SKU. |
Iot |
Información sobre la SKU del centro de IoT. |
Iot |
Nivel de facturación del centro de IoT. |
Ip |
La acción deseada para las solicitudes capturadas por esta regla. |
Ip |
Reglas de filtro IP del centro de IoT. |
Managed |
Propiedades de la identidad administrada. |
Messaging |
Las propiedades de los puntos de conexión de mensajería usados por este centro de IoT. |
Network |
Acción de filtro IP |
Network |
Regla de IP que se va a aplicar como parte del conjunto de reglas de red |
Network |
Propiedades del conjunto de reglas de red de IotHub |
Private |
La propiedad de punto de conexión privado de una conexión de punto de conexión privado |
Private |
Conexión de punto de conexión privado de un IotHub |
Private |
Propiedades de una conexión de punto de conexión privado |
Private |
Estado actual de una conexión de punto de conexión privado |
Private |
Estado de una conexión de punto de conexión privado |
Public |
Indica si se permiten solicitudes de la red pública |
Resource |
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. |
Route |
Las propiedades de una regla de enrutamiento que el centro de IoT usa para enrutar los mensajes a los puntos de conexión. |
Routing |
Propiedades relacionadas con un punto de conexión de contenedor sql de Cosmos DB. |
Routing |
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. |
Routing |
Propiedades relacionadas con un punto de conexión del centro de eventos. |
Routing |
Las propiedades relacionadas con el enrutamiento del centro de IoT. Consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging |
Routing |
Las propiedades relacionadas con los tipos de punto de conexión de cola de Service Bus. |
Routing |
Las propiedades relacionadas con los tipos de punto de conexión del tema de Service Bus. |
Routing |
Origen al que se aplicará la regla de enrutamiento, como DeviceMessages. |
Routing |
Propiedades relacionadas con un punto de conexión de contenedor de almacenamiento. |
Shared |
Las propiedades de una directiva de acceso compartido de IoT Hub. |
Storage |
Las propiedades del punto de conexión de Azure Storage para la carga de archivos. |
system |
Metadatos relacionados con la creación y la última modificación del recurso. |
Tags |
Un contenedor que contiene solo las etiquetas de un recurso, lo que permite al usuario actualizar las etiquetas en una instancia de IoT Hub. |
AccessRights
Permisos asignados a la directiva de acceso compartido.
Nombre | Tipo | Description |
---|---|---|
DeviceConnect |
string |
|
RegistryRead |
string |
|
RegistryRead, DeviceConnect |
string |
|
RegistryRead, RegistryWrite |
string |
|
RegistryRead, RegistryWrite, DeviceConnect |
string |
|
RegistryRead, RegistryWrite, ServiceConnect |
string |
|
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect |
string |
|
RegistryRead, ServiceConnect |
string |
|
RegistryRead, ServiceConnect, DeviceConnect |
string |
|
RegistryWrite |
string |
|
RegistryWrite, DeviceConnect |
string |
|
RegistryWrite, ServiceConnect |
string |
|
RegistryWrite, ServiceConnect, DeviceConnect |
string |
|
ServiceConnect |
string |
|
ServiceConnect, DeviceConnect |
string |
ArmIdentity
Nombre | Tipo | Description |
---|---|---|
principalId |
string |
Id. de entidad de seguridad |
tenantId |
string |
Identificador de inquilino |
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. |
|
userAssignedIdentities |
<string,
Arm |
ArmUserIdentity
Nombre | Tipo | Description |
---|---|---|
clientId |
string |
|
principalId |
string |
AuthenticationType
Especifica el tipo de autenticación que se usa para conectarse a la cuenta de almacenamiento.
Nombre | Tipo | Description |
---|---|---|
identityBased |
string |
|
keyBased |
string |
authenticationType
Método usado para autenticarse en el punto de conexión de cola de Service Bus
Nombre | Tipo | Description |
---|---|---|
identityBased |
string |
|
keyBased |
string |
Capabilities
Las funcionalidades y características habilitadas para el centro de IoT.
Nombre | Tipo | Description |
---|---|---|
DeviceManagement |
string |
|
None |
string |
CloudToDeviceProperties
Las propiedades de mensajería de nube a dispositivo de IoT Hub.
Nombre | Tipo | Description |
---|---|---|
defaultTtlAsIso8601 |
string |
El período de vida predeterminado para los mensajes de nube a dispositivo en la cola de dispositivos. Consulta: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
feedback |
Las propiedades de la cola de comentarios para los mensajes de nube a dispositivo. |
|
maxDeliveryCount |
integer |
Recuento máximo de entregas para los mensajes de nube a dispositivo en la cola de dispositivos. Consulta: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
createdByType
Tipo de identidad que creó el recurso.
Nombre | Tipo | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DefaultAction
Acción predeterminada para el conjunto de reglas de red
Nombre | Tipo | Description |
---|---|---|
Allow |
string |
|
Deny |
string |
EnrichmentProperties
Las propiedades de un enriquecimiento que el centro de IoT aplica a los mensajes entregados a los puntos de conexión.
Nombre | Tipo | Description |
---|---|---|
endpointNames |
string[] |
Lista de puntos de conexión para los que se aplica el enriquecimiento al mensaje. |
key |
string |
Clave o nombre de la propiedad de enriquecimiento. |
value |
string |
Valor de la propiedad de enriquecimiento. |
EventHubProperties
Las propiedades del punto de conexión compatible con Event Hubs aprovisionado que usa el centro de IoT.
Nombre | Tipo | Description |
---|---|---|
endpoint |
string |
Punto de conexión compatible con Event Hubs. |
partitionCount |
integer |
Número de particiones para recibir mensajes de dispositivo a nube en el punto de conexión compatible con Event Hubs. Consulta: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. |
partitionIds |
string[] |
Identificadores de partición en el punto de conexión compatible con Event Hubs. |
path |
string |
Nombre compatible con el centro de eventos. |
retentionTimeInDays |
integer |
El tiempo de retención de los mensajes de dispositivo a nube en días. Consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages |
FallbackRouteProperties
Propiedades de la ruta de reserva. IoT Hub usa estas propiedades cuando enruta mensajes al punto de conexión de reserva.
Nombre | Tipo | Description |
---|---|---|
condition |
string |
Condición que se evalúa para aplicar la ruta de reserva. Si la condición no se proporciona, se evaluará como true de forma predeterminada. Para la gramática, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language |
endpointNames |
string[] |
Lista de puntos de conexión a los que se enrutan los mensajes que cumplen la condición. Actualmente solo se permite 1 punto de conexión. |
isEnabled |
boolean |
Se usa para especificar si la ruta de reserva está habilitada. |
name |
string |
Nombre de la ruta. El nombre solo puede incluir caracteres alfanuméricos, puntos, caracteres de subrayado, guiones, tiene una longitud máxima de 64 caracteres y debe ser único. |
source |
Origen al que se va a aplicar la regla de enrutamiento. Por ejemplo, DeviceMessages |
FeedbackProperties
Las propiedades de la cola de comentarios para los mensajes de nube a dispositivo.
Nombre | Tipo | Description |
---|---|---|
lockDurationAsIso8601 |
string |
Duración del bloqueo de la cola de comentarios. Consulta: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
maxDeliveryCount |
integer |
Número de veces que el centro de IoT intenta entregar un mensaje en la cola de comentarios. Consulta: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
ttlAsIso8601 |
string |
Período de tiempo durante el que un mensaje está disponible para consumir antes de que el centro de IoT expire. Consulta: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
IotHubDescription
Descripción del centro de IoT.
Nombre | Tipo | Description |
---|---|---|
etag |
string |
El campo Etag no es obligatorio. Si se proporciona en el cuerpo de la respuesta, también se debe proporcionar como un encabezado según la convención ETag normal. |
id |
string |
Identificador del recurso. |
identity |
Identidades administradas para IotHub. |
|
location |
string |
Ubicación del recurso. |
name |
string |
Nombre del recurso. |
properties |
Propiedades de IotHub |
|
sku |
Información de SKU de IotHub |
|
systemData |
Metadatos del sistema relacionados con este recurso. |
|
tags |
object |
Etiquetas del recurso. |
type |
string |
El tipo de recurso. |
IotHubLocationDescription
Representación pública de una de las ubicaciones donde se aprovisiona un recurso.
Nombre | Tipo | Description |
---|---|---|
location |
string |
Nombre de la región de Azure |
role |
El rol de la región puede ser principal o secundario. La región primaria es donde se aprovisiona actualmente el centro de IoT. La región secundaria es la región emparejada de recuperación ante desastres (DR) de Azure y también la región en la que el centro de IoT puede conmutar por error. |
IotHubProperties
Propiedades de un centro de IoT.
Nombre | Tipo | Description |
---|---|---|
allowedFqdnList |
string[] |
Lista de FQDN permitidos (nombre de dominio completo) para la salida de IoT Hub. |
authorizationPolicies |
Las directivas de acceso compartido que puede usar para proteger una conexión al centro de IoT. |
|
cloudToDevice |
Las propiedades de mensajería de nube a dispositivo de IoT Hub. |
|
comments |
string |
Comentarios de IoT Hub. |
disableDeviceSAS |
boolean |
Si es true, no se pueden usar todas las claves SAS con ámbito de todos los dispositivos (incluidos los dispositivos perimetrales, pero sin incluir módulos) para la autenticación. |
disableLocalAuth |
boolean |
Si es true, los tokens de SAS con claves SAS con ámbito de IoT Hub no se pueden usar para la autenticación. |
disableModuleSAS |
boolean |
Si es true, no se pueden usar todas las claves SAS con ámbito de módulo para la autenticación. |
enableDataResidency |
boolean |
Esta propiedad cuando se establece en true, habilitará la residencia de datos, por lo tanto, deshabilitando la recuperación ante desastres. |
enableFileUploadNotifications |
boolean |
Si es True, las notificaciones de carga de archivos están habilitadas. |
eventHubEndpoints |
<string,
Event |
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. |
features |
Las funcionalidades y características habilitadas para el centro de IoT. |
|
hostName |
string |
El nombre del host. |
ipFilterRules |
Reglas de filtro IP. |
|
locations |
Ubicación principal y secundaria de IoT Hub |
|
messagingEndpoints |
<string,
Messaging |
Las propiedades del punto de conexión de mensajería para la cola de notificaciones de carga de archivos. |
minTlsVersion |
string |
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. |
networkRuleSets |
Propiedades del conjunto de reglas de red de IotHub |
|
privateEndpointConnections |
Conexiones de punto de conexión privado creadas en este IotHub |
|
provisioningState |
string |
Estado de aprovisionamiento. |
publicNetworkAccess |
Indica si se permiten solicitudes de la red pública |
|
restrictOutboundNetworkAccess |
boolean |
Si es true, la salida de IotHub se restringirá solo a los FQDN permitidos configurados a través de allowedFqdnList. |
routing |
Las propiedades relacionadas con el enrutamiento del centro de IoT. Consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging |
|
state |
string |
Estado del concentrador. |
storageEndpoints |
<string,
Storage |
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. |
IotHubReplicaRoleType
El rol de la región puede ser principal o secundario. La región primaria es donde se aprovisiona actualmente el centro de IoT. La región secundaria es la región emparejada de recuperación ante desastres (DR) de Azure y también la región en la que el centro de IoT puede conmutar por error.
Nombre | Tipo | Description |
---|---|---|
primary |
string |
|
secondary |
string |
IotHubSku
El nombre de la SKU.
Nombre | Tipo | Description |
---|---|---|
B1 |
string |
|
B2 |
string |
|
B3 |
string |
|
F1 |
string |
|
S1 |
string |
|
S2 |
string |
|
S3 |
string |
IotHubSkuInfo
Información sobre la SKU del centro de IoT.
Nombre | Tipo | Description |
---|---|---|
capacity |
integer |
Número de unidades de IoT Hub aprovisionadas. Consulta: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. |
name |
El nombre de la SKU. |
|
tier |
Nivel de facturación del centro de IoT. |
IotHubSkuTier
Nivel de facturación del centro de IoT.
Nombre | Tipo | Description |
---|---|---|
Basic |
string |
|
Free |
string |
|
Standard |
string |
IpFilterActionType
La acción deseada para las solicitudes capturadas por esta regla.
Nombre | Tipo | Description |
---|---|---|
Accept |
string |
|
Reject |
string |
IpFilterRule
Reglas de filtro IP del centro de IoT.
Nombre | Tipo | Description |
---|---|---|
action |
La acción deseada para las solicitudes capturadas por esta regla. |
|
filterName |
string |
Nombre de la regla de filtro IP. |
ipMask |
string |
Cadena que contiene el intervalo de direcciones IP en notación CIDR para la regla. |
ManagedIdentity
Propiedades de la identidad administrada.
Nombre | Tipo | Description |
---|---|---|
userAssignedIdentity |
string |
Identidad asignada por el usuario. |
MessagingEndpointProperties
Las propiedades de los puntos de conexión de mensajería usados por este centro de IoT.
Nombre | Tipo | Description |
---|---|---|
lockDurationAsIso8601 |
string |
Duración del bloqueo. Consulta: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
maxDeliveryCount |
integer |
Número de veces que el centro de IoT intenta entregar un mensaje. Consulta: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
ttlAsIso8601 |
string |
Período de tiempo durante el que un mensaje está disponible para consumir antes de que el centro de IoT expire. Consulta: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
NetworkRuleIPAction
Acción de filtro IP
Nombre | Tipo | Description |
---|---|---|
Allow |
string |
NetworkRuleSetIpRule
Regla de IP que se va a aplicar como parte del conjunto de reglas de red
Nombre | Tipo | Valor predeterminado | Description |
---|---|---|---|
action | Allow |
Acción de filtro IP |
|
filterName |
string |
Nombre de la regla de filtro IP. |
|
ipMask |
string |
Cadena que contiene el intervalo de direcciones IP en notación CIDR para la regla. |
NetworkRuleSetProperties
Propiedades del conjunto de reglas de red de IotHub
Nombre | Tipo | Valor predeterminado | Description |
---|---|---|---|
applyToBuiltInEventHubEndpoint |
boolean |
Si es True, el conjunto de reglas de red también se aplica a BuiltIn EventHub EndPoint de IotHub. |
|
defaultAction | Deny |
Acción predeterminada para el conjunto de reglas de red |
|
ipRules |
Lista de reglas de IP |
PrivateEndpoint
La propiedad de punto de conexión privado de una conexión de punto de conexión privado
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador del recurso. |
PrivateEndpointConnection
Conexión de punto de conexión privado de un IotHub
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador del recurso. |
name |
string |
Nombre del recurso. |
properties |
Propiedades de una conexión de punto de conexión privado |
|
type |
string |
El tipo de recurso. |
PrivateEndpointConnectionProperties
Propiedades de una conexión de punto de conexión privado
Nombre | Tipo | Description |
---|---|---|
privateEndpoint |
La propiedad de punto de conexión privado de una conexión de punto de conexión privado |
|
privateLinkServiceConnectionState |
Estado actual de una conexión de punto de conexión privado |
PrivateLinkServiceConnectionState
Estado actual de una conexión de punto de conexión privado
Nombre | Tipo | Description |
---|---|---|
actionsRequired |
string |
Acciones necesarias para una conexión de punto de conexión privado |
description |
string |
Descripción del estado actual de una conexión de punto de conexión privado |
status |
Estado de una conexión de punto de conexión privado |
PrivateLinkServiceConnectionStatus
Estado de una conexión de punto de conexión privado
Nombre | Tipo | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PublicNetworkAccess
Indica si se permiten solicitudes de la red pública
Nombre | Tipo | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ResourceIdentityType
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.
Nombre | Tipo | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
RouteProperties
Las propiedades de una regla de enrutamiento que el centro de IoT usa para enrutar los mensajes a los puntos de conexión.
Nombre | Tipo | Description |
---|---|---|
condition |
string |
Condición que se evalúa para aplicar la regla de enrutamiento. Si no se proporciona ninguna condición, se evalúa como true de forma predeterminada. Para la gramática, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language |
endpointNames |
string[] |
Lista de puntos de conexión a los que se enrutan los mensajes que cumplen la condición. Actualmente solo se permite un punto de conexión. |
isEnabled |
boolean |
Se usa para especificar si una ruta está habilitada. |
name |
string |
Nombre de la ruta. El nombre solo puede incluir caracteres alfanuméricos, puntos, caracteres de subrayado, guiones, tiene una longitud máxima de 64 caracteres y debe ser único. |
source |
Origen al que se aplicará la regla de enrutamiento, como DeviceMessages. |
RoutingCosmosDBSqlApiProperties
Propiedades relacionadas con un punto de conexión de contenedor sql de Cosmos DB.
Nombre | Tipo | Description |
---|---|---|
authenticationType |
Método que se usa para autenticarse en el punto de conexión del contenedor sql de Cosmos DB |
|
containerName |
string |
Nombre del contenedor sql de Cosmos DB en la base de datos de Cosmos DB. |
databaseName |
string |
Nombre de la base de datos de Cosmos DB en la cuenta de cosmos DB. |
endpointUri |
string |
Dirección URL de la cuenta de Cosmos DB. Debe incluir el protocolo https:// |
id |
string |
Identificador del punto de conexión del contenedor sql de Cosmos DB |
identity |
Propiedades de identidad administrada del punto de conexión de contenedor de Cosmos DB de enrutamiento. |
|
name |
string |
Nombre que identifica este punto de conexión. El nombre solo puede incluir caracteres alfanuméricos, puntos, caracteres de subrayado, guiones y tiene una longitud máxima de 64 caracteres. Los nombres siguientes son reservados: eventos, fileNotifications, $default. Los nombres de punto de conexión deben ser únicos en los tipos de punto de conexión. |
partitionKeyName |
string |
Nombre de la clave de partición asociada a este contenedor sql de Cosmos DB si existe. Se trata de un parámetro opcional. |
partitionKeyTemplate |
string |
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 de orden y no marcador de posición son arbitrarios. Este parámetro solo es necesario si se especifica PartitionKeyName. |
primaryKey |
string |
Clave principal de la cuenta de cosmos DB. |
resourceGroup |
string |
Nombre del grupo de recursos de la cuenta de cosmos DB. |
secondaryKey |
string |
Clave secundaria de la cuenta de cosmos DB. |
subscriptionId |
string |
Identificador de suscripción de la cuenta de Cosmos DB. |
RoutingEndpoints
Las propiedades relacionadas con los puntos de conexión personalizados a los que ioT Hub enruta los mensajes en función de las reglas de enrutamiento. Se permiten un máximo de 10 puntos de conexión personalizados en todos los tipos de puntos de conexión para centros de pago y solo se permite 1 punto de conexión personalizado en todos los tipos de puntos de conexión para centros gratuitos.
Nombre | Tipo | Description |
---|---|---|
cosmosDBSqlContainers |
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. |
|
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. |
|
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. |
|
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. |
|
storageContainers |
La lista de puntos de conexión de contenedor de almacenamiento a los que IoT Hub enruta los mensajes, en función de las reglas de enrutamiento. |
RoutingEventHubProperties
Propiedades relacionadas con un punto de conexión del centro de eventos.
Nombre | Tipo | Description |
---|---|---|
authenticationType |
Método usado para autenticarse en el punto de conexión del centro de eventos |
|
connectionString |
string |
El cadena de conexión del punto de conexión del centro de eventos. |
endpointUri |
string |
Dirección URL del punto de conexión del centro de eventos. Debe incluir el protocolo sb:// |
entityPath |
string |
Nombre del centro de eventos en el espacio de nombres del centro de eventos |
id |
string |
Identificador del punto de conexión del centro de eventos |
identity |
Propiedades de identidad administrada del punto de conexión del centro de eventos de enrutamiento. |
|
name |
string |
Nombre que identifica este punto de conexión. El nombre solo puede incluir caracteres alfanuméricos, puntos, caracteres de subrayado, guiones y tiene una longitud máxima de 64 caracteres. Los nombres siguientes son reservados: eventos, fileNotifications, $default. Los nombres de punto de conexión deben ser únicos en los tipos de punto de conexión. |
resourceGroup |
string |
Nombre del grupo de recursos del punto de conexión del centro de eventos. |
subscriptionId |
string |
Identificador de suscripción del punto de conexión del centro de eventos. |
RoutingProperties
Las propiedades relacionadas con el enrutamiento del centro de IoT. Consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
Nombre | Tipo | Description |
---|---|---|
endpoints |
Las propiedades relacionadas con los puntos de conexión personalizados a los que ioT Hub enruta los mensajes en función de las reglas de enrutamiento. Se permiten un máximo de 10 puntos de conexión personalizados en todos los tipos de puntos de conexión para centros de pago y solo se permite 1 punto de conexión personalizado en todos los tipos de puntos de conexión para centros gratuitos. |
|
enrichments |
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 |
|
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. |
|
routes |
Lista de reglas de enrutamiento proporcionadas por el usuario que el centro de IoT usa para enrutar mensajes a puntos de conexión integrados y personalizados. Se permiten un máximo de 100 reglas de enrutamiento para centros de pago y se permiten un máximo de 5 reglas de enrutamiento para centros gratuitos. |
RoutingServiceBusQueueEndpointProperties
Las propiedades relacionadas con los tipos de punto de conexión de cola de Service Bus.
Nombre | Tipo | Description |
---|---|---|
authenticationType |
Método usado para autenticarse en el punto de conexión de cola de Service Bus |
|
connectionString |
string |
El cadena de conexión del punto de conexión de cola de Service Bus. |
endpointUri |
string |
Dirección URL del punto de conexión de cola de Service Bus. Debe incluir el protocolo sb:// |
entityPath |
string |
Nombre de cola en el espacio de nombres de Service Bus |
id |
string |
Identificador del punto de conexión de cola de Service Bus |
identity |
Propiedades de identidad administrada del punto de conexión de cola de Service Bus de enrutamiento. |
|
name |
string |
Nombre que identifica este punto de conexión. El nombre solo puede incluir caracteres alfanuméricos, puntos, caracteres de subrayado, guiones y tiene una longitud máxima de 64 caracteres. Los nombres siguientes son reservados: eventos, 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. |
resourceGroup |
string |
Nombre del grupo de recursos del punto de conexión de cola de Service Bus. |
subscriptionId |
string |
Identificador de suscripción del punto de conexión de cola de Service Bus. |
RoutingServiceBusTopicEndpointProperties
Las propiedades relacionadas con los tipos de punto de conexión del tema de Service Bus.
Nombre | Tipo | Description |
---|---|---|
authenticationType |
Método usado para autenticarse en el punto de conexión del tema de Service Bus |
|
connectionString |
string |
El cadena de conexión del punto de conexión del tema de Service Bus. |
endpointUri |
string |
Dirección URL del punto de conexión del tema de Service Bus. Debe incluir el protocolo sb:// |
entityPath |
string |
Nombre de la cola en el tema de Service Bus |
id |
string |
Identificador del punto de conexión del tema de Service Bus |
identity |
Propiedades de identidad administrada del punto de conexión del tema de Service Bus de enrutamiento. |
|
name |
string |
Nombre que identifica este punto de conexión. El nombre solo puede incluir caracteres alfanuméricos, puntos, caracteres de subrayado, guiones y tiene una longitud máxima de 64 caracteres. Los nombres siguientes son reservados: eventos, 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. |
resourceGroup |
string |
Nombre del grupo de recursos del punto de conexión del tema de Service Bus. |
subscriptionId |
string |
Identificador de suscripción del punto de conexión del tema de Service Bus. |
RoutingSource
Origen al que se aplicará la regla de enrutamiento, como DeviceMessages.
Nombre | Tipo | Description |
---|---|---|
DeviceConnectionStateEvents |
string |
|
DeviceJobLifecycleEvents |
string |
|
DeviceLifecycleEvents |
string |
|
DeviceMessages |
string |
|
Invalid |
string |
|
TwinChangeEvents |
string |
RoutingStorageContainerProperties
Propiedades relacionadas con un punto de conexión de contenedor de almacenamiento.
Nombre | Tipo | Description |
---|---|---|
authenticationType |
Método usado para autenticarse en el punto de conexión de almacenamiento |
|
batchFrequencyInSeconds |
integer |
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. |
connectionString |
string |
El cadena de conexión de la cuenta de almacenamiento. |
containerName |
string |
Nombre del contenedor de almacenamiento en la cuenta de almacenamiento. |
encoding |
enum:
|
Codificación que se usa para serializar mensajes en blobs. Los valores admitidos son "avro", "avrodbtate" y "JSON". El valor predeterminado es "avro". |
endpointUri |
string |
Dirección URL del punto de conexión de almacenamiento. Debe incluir el protocolo https:// |
fileNameFormat |
string |
Formato de nombre de archivo para el blob. El formato predeterminado es {iothub}/{partition}/{AAAA}/{MM}/{DD}/{HH}/{mm}. Todos los parámetros son obligatorios, pero se pueden reordenar. |
id |
string |
Identificador del punto de conexión del contenedor de almacenamiento |
identity |
Propiedades de identidad administrada del punto de conexión de almacenamiento de enrutamiento. |
|
maxChunkSizeInBytes |
integer |
Número máximo de bytes para cada blob escrito en el almacenamiento. El valor debe estar entre 10485760(10 MB) y 524288000(500 MB). El valor predeterminado es 314572800(300 MB). |
name |
string |
Nombre que identifica este punto de conexión. El nombre solo puede incluir caracteres alfanuméricos, puntos, caracteres de subrayado, guiones y tiene una longitud máxima de 64 caracteres. Los nombres siguientes son reservados: eventos, fileNotifications, $default. Los nombres de punto de conexión deben ser únicos en los tipos de punto de conexión. |
resourceGroup |
string |
Nombre del grupo de recursos de la cuenta de almacenamiento. |
subscriptionId |
string |
Identificador de suscripción de la cuenta de almacenamiento. |
SharedAccessSignatureAuthorizationRule
Las propiedades de una directiva de acceso compartido de IoT Hub.
Nombre | Tipo | Description |
---|---|---|
keyName |
string |
Nombre de la directiva de acceso compartido. |
primaryKey |
string |
Clave principal. |
rights |
Permisos asignados a la directiva de acceso compartido. |
|
secondaryKey |
string |
Clave secundaria. |
StorageEndpointProperties
Las propiedades del punto de conexión de Azure Storage para la carga de archivos.
Nombre | Tipo | Description |
---|---|---|
authenticationType |
Especifica el tipo de autenticación que se usa para conectarse a la cuenta de almacenamiento. |
|
connectionString |
string |
El cadena de conexión de la cuenta de Azure Storage a la que se cargan los archivos. |
containerName |
string |
Nombre del contenedor raíz donde se cargan los archivos. El contenedor no necesita existir, pero debe ser creable mediante connectionString especificado. |
identity |
Propiedades de identidad administrada del punto de conexión de almacenamiento para la carga de archivos. |
|
sasTtlAsIso8601 |
string |
El período de tiempo durante el que el URI de SAS generado por IoT Hub para la carga de archivos es válido. Consulta: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. |
systemData
Metadatos relacionados con la creación y la última modificación del recurso.
Nombre | Tipo | Description |
---|---|---|
createdAt |
string |
Marca de tiempo de creación de recursos (UTC). |
createdBy |
string |
Identidad que creó el recurso. |
createdByType |
Tipo de identidad que creó el recurso. |
|
lastModifiedAt |
string |
Marca de tiempo de la última modificación del recurso (UTC) |
lastModifiedBy |
string |
Identidad que modificó por última vez el recurso. |
lastModifiedByType |
Tipo de identidad que modificó por última vez el recurso. |
TagsResource
Un contenedor que contiene solo las etiquetas de un recurso, lo que permite al usuario actualizar las etiquetas en una instancia de IoT Hub.
Nombre | Tipo | Description |
---|---|---|
tags |
object |
Etiquetas del recurso |