Iot Hub Resource - Create Or Update

Cree o actualice los metadatos de un centro de IoT. El patrón habitual para modificar una propiedad es recuperar los metadatos de IoT Hub y los metadatos de seguridad y, a continuación, combinarlos con los valores modificados en un nuevo cuerpo para actualizar IoT Hub.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nombre del grupo de recursos. El nombre no distingue entre mayúsculas y minúsculas.

resourceName
path True

string

Nombre del centro de IoT.

subscriptionId
path True

string (uuid)

Identificador de la suscripción de destino. El valor debe ser un UUID.

api-version
query True

string

minLength: 1

Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre Requerido Tipo Description
If-Match

string

ETag del IoT Hub. No especifique la creación de un nuevo centro de IoT. Necesario para actualizar un centro de IoT existente.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
location True

string

Ubicación geográfica donde reside el recurso

sku True

IotHubSkuInfo

Información de SKU de IotHub

etag

string

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

identity

ArmIdentity

Identidades administradas para IotHub.

properties

IotHubProperties

Propiedades de IotHub

tags

object

Etiquetas de recursos.

Respuestas

Nombre Tipo Description
200 OK

IotHubDescription

Operación de actualización del recurso 'IotHubDescription' exitosa

201 Created

IotHubDescription

Recurso 'IotHubDescription' crear operación exitosa

Encabezados

  • Azure-AsyncOperation: string
  • Retry-After: integer
Other Status Codes

ErrorDetails

Una respuesta de error inesperada.

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 suplantar su cuenta de usuario

Ejemplos

CreateOrReplace_IotHub
IotHubResource_CreateOrUpdate

CreateOrReplace_IotHub

Solicitud de ejemplo

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

{
  "location": "centraluseuap",
  "tags": {},
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "ipFilterRules": [],
    "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"
        }
      ]
    },
    "eventHubEndpoints": {
      "events": {
        "retentionTimeInDays": 1,
        "partitionCount": 2
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": []
      },
      "routes": [
        {
          "name": "Routeid",
          "source": "DeviceMessages",
          "condition": "true",
          "endpointNames": [
            "events"
          ],
          "isEnabled": true
        }
      ],
      "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",
    "minTlsVersion": "1.2",
    "enableDataResidency": true
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  }
}

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": {},
  "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",
    "deviceHostName": "iot-dps-cit-hub-1.device.azure-devices.net",
    "serviceHostName": "iot-dps-cit-hub-1.service.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": [
        {
          "name": "Routeid",
          "source": "DeviceMessages",
          "condition": "true",
          "endpointNames": [
            "events"
          ],
          "isEnabled": true
        }
      ],
      "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",
    "minTlsVersion": "1.2",
    "enableDataResidency": true,
    "iotHubDetails": {
      "gatewayVersion": "V2"
    }
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}
{
  "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
  "name": "testHub",
  "type": "Microsoft.Devices/IotHubs",
  "location": "centraluseuap",
  "tags": {},
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "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",
    "deviceHostName": "iot-dps-cit-hub-1.device.azure-devices.net",
    "serviceHostName": "iot-dps-cit-hub-1.service.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": [
        {
          "name": "Routeid",
          "source": "DeviceMessages",
          "condition": "true",
          "endpointNames": [
            "events"
          ],
          "isEnabled": true
        }
      ],
      "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",
    "minTlsVersion": "1.2",
    "enableDataResidency": true,
    "iotHubDetails": {
      "gatewayVersion": "V2"
    }
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}

IotHubResource_CreateOrUpdate

Solicitud de ejemplo

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

{
  "etag": "AAAAAAFD6M4=",
  "location": "centraluseuap",
  "identity": {
    "type": "SystemAssigned"
  },
  "properties": {
    "cloudToDevice": {
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "maxDeliveryCount": 10,
        "ttlAsIso8601": "PT1H"
      },
      "maxDeliveryCount": 10
    },
    "enableDataResidency": true,
    "enableFileUploadNotifications": false,
    "eventHubEndpoints": {
      "events": {
        "partitionCount": 2,
        "retentionTimeInDays": 1
      }
    },
    "features": "None",
    "ipFilterRules": [],
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "maxDeliveryCount": 10,
        "ttlAsIso8601": "PT1H"
      }
    },
    "minTlsVersion": "1.2",
    "networkRuleSets": {
      "applyToBuiltInEventHubEndpoint": true,
      "defaultAction": "Deny",
      "ipRules": [
        {
          "action": "Allow",
          "filterName": "rule1",
          "ipMask": "131.117.159.53"
        },
        {
          "action": "Allow",
          "filterName": "rule2",
          "ipMask": "157.55.59.128/25"
        }
      ]
    },
    "routing": {
      "endpoints": {
        "eventHubs": [],
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "storageContainers": [],
        "eventStreams": [
          {
            "name": "eventstreamendpoint1",
            "endpointUri": "sb://eventstreamcustomsourceehns.azure.servicebus.net",
            "entityPath": "eventstreamcustomsourceeh",
            "authenticationType": "identityBased",
            "workspaceId": "11111111-1111-1111-1111-111111111111",
            "eventStreamId": "22222222-2222-2222-2222-222222222222",
            "sourceId": "33333333-3333-3333-3333-333333333333"
          }
        ]
      },
      "fallbackRoute": {
        "name": "$fallback",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true,
        "source": "DeviceMessages"
      },
      "routes": []
    },
    "storageEndpoints": {
      "$default": {
        "connectionString": "",
        "containerName": "",
        "sasTtlAsIso8601": "PT1H"
      }
    }
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  },
  "tags": {}
}

Respuesta de muestra

{
  "name": "testHub",
  "type": "Microsoft.Devices/IotHubs",
  "etag": "AAAAAAFD6M4=",
  "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
  "location": "centraluseuap",
  "identity": {
    "tenantId": "11111111-2222-3333-4444-555555555555",
    "type": "SystemAssigned",
    "principalId": "66666666-7777-8888-9999-aaaaaaaaaaaa"
  },
  "properties": {
    "cloudToDevice": {
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "maxDeliveryCount": 10,
        "ttlAsIso8601": "PT1H"
      },
      "maxDeliveryCount": 10
    },
    "enableDataResidency": true,
    "enableFileUploadNotifications": false,
    "eventHubEndpoints": {
      "events": {
        "path": "iot-dps-cit-hub-1",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/",
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "retentionTimeInDays": 1
      }
    },
    "features": "None",
    "hostName": "iot-dps-cit-hub-1.azure-devices.net",
    "ipFilterRules": [
      {
        "action": "Accept",
        "filterName": "rule1",
        "ipMask": "131.117.159.53"
      },
      {
        "action": "Accept",
        "filterName": "rule2",
        "ipMask": "157.55.59.128/25"
      }
    ],
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "maxDeliveryCount": 10,
        "ttlAsIso8601": "PT1H"
      }
    },
    "minTlsVersion": "1.2",
    "networkRuleSets": {
      "applyToBuiltInEventHubEndpoint": true,
      "defaultAction": "Deny",
      "ipRules": [
        {
          "action": "Allow",
          "filterName": "rule1",
          "ipMask": "131.117.159.53"
        },
        {
          "action": "Allow",
          "filterName": "rule2",
          "ipMask": "157.55.59.128/25"
        }
      ]
    },
    "provisioningState": "Succeeded",
    "routing": {
      "endpoints": {
        "eventHubs": [],
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "storageContainers": [],
        "eventStreams": [
          {
            "name": "eventstreamendpoint1",
            "id": "00000000-1111-2222-3333-0123456789ab",
            "endpointUri": "sb://eventstreamcustomsourceehns.azure.servicebus.net",
            "entityPath": "eventstreamcustomsourceeh",
            "authenticationType": "identityBased",
            "workspaceId": "11111111-1111-1111-1111-111111111111",
            "eventStreamId": "22222222-2222-2222-2222-222222222222",
            "sourceId": "33333333-3333-3333-3333-333333333333"
          }
        ]
      },
      "fallbackRoute": {
        "name": "$fallback",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true,
        "source": "DeviceMessages"
      },
      "routes": []
    },
    "state": "Active",
    "storageEndpoints": {
      "$default": {
        "connectionString": "",
        "containerName": "",
        "sasTtlAsIso8601": "PT1H"
      }
    }
  },
  "sku": {
    "name": "S1",
    "capacity": 1,
    "tier": "Standard"
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  },
  "tags": {}
}
{
  "name": "testHub",
  "type": "Microsoft.Devices/IotHubs",
  "etag": "AAAAAAFD6M4=",
  "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
  "location": "centraluseuap",
  "identity": {
    "tenantId": "11111111-2222-3333-4444-555555555555",
    "type": "SystemAssigned",
    "principalId": "66666666-7777-8888-9999-aaaaaaaaaaaa"
  },
  "properties": {
    "cloudToDevice": {
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "maxDeliveryCount": 10,
        "ttlAsIso8601": "PT1H"
      },
      "maxDeliveryCount": 10
    },
    "enableDataResidency": true,
    "enableFileUploadNotifications": false,
    "eventHubEndpoints": {
      "events": {
        "path": "iot-dps-cit-hub-1",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/",
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "retentionTimeInDays": 1
      }
    },
    "features": "None",
    "hostName": "iot-dps-cit-hub-1.azure-devices.net",
    "ipFilterRules": [
      {
        "action": "Accept",
        "filterName": "rule1",
        "ipMask": "131.117.159.53"
      },
      {
        "action": "Accept",
        "filterName": "rule2",
        "ipMask": "157.55.59.128/25"
      }
    ],
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "maxDeliveryCount": 10,
        "ttlAsIso8601": "PT1H"
      }
    },
    "minTlsVersion": "1.2",
    "networkRuleSets": {
      "applyToBuiltInEventHubEndpoint": true,
      "defaultAction": "Deny",
      "ipRules": [
        {
          "action": "Allow",
          "filterName": "rule1",
          "ipMask": "131.117.159.53"
        },
        {
          "action": "Allow",
          "filterName": "rule2",
          "ipMask": "157.55.59.128/25"
        }
      ]
    },
    "provisioningState": "Succeeded",
    "routing": {
      "endpoints": {
        "eventHubs": [],
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "storageContainers": [],
        "eventStreams": [
          {
            "name": "eventstreamendpoint1",
            "id": "00000000-1111-2222-3333-0123456789ab",
            "endpointUri": "sb://eventstreamcustomsourceehns.azure.servicebus.net",
            "entityPath": "eventstreamcustomsourceeh",
            "authenticationType": "identityBased",
            "workspaceId": "11111111-1111-1111-1111-111111111111",
            "eventStreamId": "22222222-2222-2222-2222-222222222222",
            "sourceId": "33333333-3333-3333-3333-333333333333"
          }
        ]
      },
      "fallbackRoute": {
        "name": "$fallback",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true,
        "source": "DeviceMessages"
      },
      "routes": []
    },
    "state": "Active",
    "storageEndpoints": {
      "$default": {
        "connectionString": "",
        "containerName": "",
        "sasTtlAsIso8601": "PT1H"
      }
    }
  },
  "sku": {
    "name": "S1",
    "capacity": 1,
    "tier": "Standard"
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  },
  "tags": {}
}

Definiciones

Nombre Description
AccessRights

Permisos asignados a la directiva de acceso compartido.

ArmIdentity
ArmUserIdentity
AuthenticationType

Especifica el tipo de autenticación que se usa para conectarse a la cuenta de almacenamiento.

Capabilities

Las funcionalidades y características habilitadas para ioT Hub.

CloudToDeviceProperties

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

createdByType

Tipo de identidad que creó el recurso.

DefaultAction

Acción predeterminada para el conjunto de reglas de red

DeviceRegistry

Representa propiedades relacionadas con Azure Device Registry (ADR).

DeviceRegistryIdentity

La identidad utilizada para administrar el espacio de nombres ADR desde el plano de datos.

DeviceRegistryIdentityType

Tipo de la identidad.

DeviceRegistryLinkingProperties

Las propiedades relacionadas con vincular el IoT Hub con el Registro de Dispositivos de Azure.

DeviceRegistryLinkingState

Indica si el IoT Hub está vinculado a un Registro de Dispositivos de Azure.

EnrichmentProperties

Las propiedades de un enriquecimiento que el centro de IoT aplica a los mensajes entregados a los puntos de conexión.

ErrorDetails

Detalles del error.

EventHubProperties

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

EventStreamAuthenticationType

Especifica el tipo de autenticación que se usa para conectarse a la cuenta del flujo de eventos.

FallbackRouteProperties

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

FallbackRouteSource

La fuente a la que se aplica la ruta de respaldo.

FeedbackProperties

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

GatewayVersion

La versión IoT hub Gateway.

IotHubDescription

Descripción del centro de IoT.

IotHubDetails

Conjunto de propiedades adicionales de solo lectura para el hub IoT.

IotHubLocationDescription

Representación pública de una de las ubicaciones donde se aprovisiona un recurso.

IotHubProperties

Las propiedades de un centro de IoT.

IotHubReplicaRoleType

El papel de la región puede ser primario 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 a la que IoT Hub puede conmutar por error.

IotHubSku

Nombre de la SKU.

IotHubSkuInfo

Información sobre la SKU del centro de IoT.

IotHubSkuTier

Nivel de facturación del centro de IoT.

IpFilterActionType

Acción deseada para las solicitudes capturadas por esta regla.

IpFilterRule

Las reglas de filtro IP para el centro de IoT.

ManagedIdentity

Las propiedades de la identidad administrada.

MessagingEndpointProperties

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

NetworkRuleIPAction

Acción de filtro IP

NetworkRuleSetIpRule

Regla IP que se aplicará como parte del conjunto de reglas de red

NetworkRuleSetProperties

Propiedades del conjunto de reglas de red de IotHub

PrivateEndpoint

La propiedad de punto de conexión privado de una conexión de punto de conexión privado

PrivateEndpointConnection

La conexión de punto de conexión privado de un IotHub

PrivateEndpointConnectionProperties

Propiedades de una conexión de punto de conexión privado

PrivateLinkServiceConnectionState

Estado actual de una conexión de punto de conexión privado

PrivateLinkServiceConnectionStatus

Estado de una conexión de punto de conexión privado

PublicNetworkAccess

Indica si se permiten solicitudes de la red pública

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.

RouteProperties

Las propiedades de una regla de enrutamiento que el centro de IoT usa para enrutar mensajes a los puntos de conexión.

RoutingCosmosDBSqlApiProperties

Las propiedades relacionadas con un punto de conexión de contenedor sql 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 permite un máximo de 10 puntos de conexión personalizados en todos los tipos de punto de conexión para centros de pago y solo se permite un punto de conexión personalizado en todos los tipos de puntos de conexión para centros gratuitos.

RoutingEventHubProperties

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

RoutingEventStreamProperties

Las propiedades relacionadas con un punto final de flujo de eventos.

RoutingProperties

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

RoutingServiceBusQueueEndpointProperties

Las propiedades relacionadas con los tipos de extremo de cola de Service Bus.

RoutingServiceBusTopicEndpointProperties

Las propiedades relacionadas con los tipos de extremo de tema de Service Bus.

RoutingSource

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

RoutingStorageContainerProperties

Las propiedades relacionadas con un punto de conexión de contenedor de almacenamiento.

RoutingStorageContainerPropertiesEncoding

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

SharedAccessSignatureAuthorizationRule

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

StorageEndpointProperties

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

systemData

Metadatos relativos a la creación y última modificación del recurso.

AccessRights

Permisos asignados a la directiva de acceso compartido.

Valor Description
RegistryRead

RegistryRead

RegistryWrite

RegistryWrite

ServiceConnect

ServiceConnect

DeviceConnect

DeviceConnect

RegistryRead, RegistryWrite

RegistryRead, RegistryWrite

RegistryRead, ServiceConnect

RegistryRead, ServiceConnect

RegistryRead, DeviceConnect

RegistryRead, DeviceConnect

RegistryWrite, ServiceConnect

RegistryWrite, ServiceConnect

RegistryWrite, DeviceConnect

RegistryWrite, DeviceConnect

ServiceConnect, DeviceConnect

ServiceConnect, DeviceConnect

RegistryRead, RegistryWrite, ServiceConnect

RegistryRead, RegistryWrite, ServiceConnect

RegistryRead, RegistryWrite, DeviceConnect

RegistryRead, RegistryWrite, DeviceConnect

RegistryRead, ServiceConnect, DeviceConnect

RegistryRead, ServiceConnect, DeviceConnect

RegistryWrite, ServiceConnect, DeviceConnect

RegistryWrite, ServiceConnect, DeviceConnect

RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect

RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect

ArmIdentity

Nombre Tipo Description
principalId

string

Identificador de entidad de seguridad

tenantId

string

Identificador de inquilino

type

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.

userAssignedIdentities

<string,  ArmUserIdentity>

Diccionario de <> ArmUserIdentity

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.

Valor Description
keyBased

Basado en teclas

identityBased

IdentidadBased

Capabilities

Las funcionalidades y características habilitadas para ioT Hub.

Valor Description
None

None

DeviceManagement

DeviceManagement

CloudToDeviceProperties

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

Nombre Tipo Description
defaultTtlAsIso8601

string (duration)

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

feedback

FeedbackProperties

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

maxDeliveryCount

integer (int32)

minimum: 1
maximum: 100

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

createdByType

Tipo de identidad que creó el recurso.

Valor Description
User
Application
ManagedIdentity
Key

DefaultAction

Acción predeterminada para el conjunto de reglas de red

Valor Description
Deny

Denegar

Allow

Permitir

DeviceRegistry

Representa propiedades relacionadas con Azure Device Registry (ADR).

Nombre Tipo Description
dataPlaneHostName

string

El nombre del host para el extremo del plano de datos del Registro de Dispositivos de Azure asociado.

identity

DeviceRegistryIdentity

La identidad utilizada para administrar el espacio de nombres ADR desde el plano de datos.

linkingProperties

DeviceRegistryLinkingProperties

Las propiedades relacionadas con vincular el IoT Hub con el Registro de Dispositivos de Azure.

namespaceResourceId

string (arm-id)

El identificador del espacio de nombres del Registro de Dispositivos de Azure

namespaceUuid

string

El UUID del espacio de nombres asociado del Registro de Dispositivos de Azure.

DeviceRegistryIdentity

La identidad utilizada para administrar el espacio de nombres ADR desde el plano de datos.

Nombre Tipo Description
type

DeviceRegistryIdentityType

Tipo de la identidad.

userAssignedIdentity

string (arm-id)

La identidad asignada por el usuario si el tipo de identidad es 'UserAssigned'.

DeviceRegistryIdentityType

Tipo de la identidad.

Valor Description
SystemAssigned

Utiliza una identidad gestionada asignada por el sistema para gestionar el espacio de nombres ADR.

UserAssigned

Utiliza una identidad gestionada asignada por el usuario para gestionar el espacio de nombres ADR.

DeviceRegistryLinkingProperties

Las propiedades relacionadas con vincular el IoT Hub con el Registro de Dispositivos de Azure.

Nombre Tipo Description
error

ErrorDetails

El último error se encontró al vincular el IoT Hub con un Registro de Dispositivos de Azure.

state

DeviceRegistryLinkingState

Indica si el IoT Hub está vinculado a un Registro de Dispositivos de Azure.

DeviceRegistryLinkingState

Indica si el IoT Hub está vinculado a un Registro de Dispositivos de Azure.

Valor Description
InProgress

La vinculación de IoT Hub con un Registro de Dispositivos de Azure está en proceso.

Success

El IoT Hub está vinculado con éxito con un Registro de Dispositivos de Azure.

Orphaned

El Registro de Dispositivos de Azure vinculado ya no está asociado con el IoT Hub.

Failed

El IoT Hub no logró vincularse con un Registro de Dispositivos de Azure.

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.

ErrorDetails

Detalles del error.

Nombre Tipo Description
code

string

Código de error.

details

string

Detalles del error.

httpStatusCode

string

El código de estado HTTP.

message

string

El mensaje de error.

EventHubProperties

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

Nombre Tipo Description
endpoint

string

El punto de conexión compatible con Event Hub.

partitionCount

integer (int32)

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

partitionIds

string[]

Los identificadores de partición en el punto de conexión compatible con Event Hub.

path

string

El nombre compatible con Event Hub.

retentionTimeInDays

integer (int64)

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

EventStreamAuthenticationType

Especifica el tipo de autenticación que se usa para conectarse a la cuenta del flujo de eventos.

Valor Description
identityBased

Autenticación basada en identidad

FallbackRouteProperties

Las 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

FallbackRouteSource

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

FallbackRouteSource

La fuente a la que se aplica la ruta de respaldo.

Valor Description
DeviceMessages

Mensajes de dispositivo a nube enviados por dispositivos.

FeedbackProperties

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

Nombre Tipo Description
lockDurationAsIso8601

string (duration)

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

maxDeliveryCount

integer (int32)

minimum: 1
maximum: 100

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

ttlAsIso8601

string (duration)

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

GatewayVersion

La versión IoT hub Gateway.

Valor Description
V1

V1

V2

V2

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 debe proporcionarse como encabezado según la convención ETag normal.

id

string (arm-id)

Identificador completamente cualificado del recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

ArmIdentity

Identidades administradas para IotHub.

location

string

Ubicación geográfica donde reside el recurso

name

string

Nombre del recurso.

properties

IotHubProperties

Propiedades de IotHub

sku

IotHubSkuInfo

Información de SKU de IotHub

systemData

systemData

Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.

tags

object

Etiquetas de recursos.

type

string

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

IotHubDetails

Conjunto de propiedades adicionales de solo lectura para el hub IoT.

Nombre Tipo Description
gatewayVersion

GatewayVersion

La versión IoT hub Gateway.

IotHubLocationDescription

Representación pública de una de las ubicaciones donde se aprovisiona un recurso.

Nombre Tipo Description
location

string

El nombre de la región de Azure

role

IotHubReplicaRoleType

El papel de la región puede ser primario 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 a la que IoT Hub puede conmutar por error.

IotHubProperties

Las 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

SharedAccessSignatureAuthorizationRule[]

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

cloudToDevice

CloudToDeviceProperties

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

comments

string

Comentarios de IoT Hub.

deviceHostName

string

El nombre del host del dispositivo. Soporta conexiones seguras a través de TLS 1.3.

deviceRegistry

DeviceRegistry

Representa propiedades relacionadas con Azure Device Registry (ADR).

disableDeviceSAS

boolean

Si es true, no se pueden usar todas las claves SAS con ámbito de dispositivo (incluidos los dispositivos perimetrales, excepto los módulos) para la autenticación.

disableLocalAuth

boolean

Si es true, los tokens de SAS con claves SAS con ámbito de centro de IoT no se pueden usar para la autenticación.

disableModuleSAS

boolean

Si es true, no se pueden usar todas las claves SAS con ámbito del módulo para la autenticación.

enableDataResidency

boolean

Esta propiedad cuando se establece en true, habilitará la residencia de datos, por lo que deshabilitará la recuperación ante desastres.

enableFileUploadNotifications

boolean

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

eventHubEndpoints

<string,  EventHubProperties>

Propiedades del punto de conexión compatible con Event Hubs. Las únicas claves posibles para este diccionario son los eventos. Esta clave debe estar presente en el diccionario al realizar llamadas de creación o actualización para IoT Hub.

features

Capabilities

Las funcionalidades y características habilitadas para ioT Hub.

hostName

string

El nombre del host.

iotHubDetails

IotHubDetails

Conjunto de propiedades adicionales de solo lectura para el hub IoT.

ipFilterRules

IpFilterRule[]

Reglas de filtro IP.

locations

IotHubLocationDescription[]

Ubicación principal y secundaria para iot hub

messagingEndpoints

<string,  MessagingEndpointProperties>

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 tls inferior a la 1.2 se rechacen.

networkRuleSets

NetworkRuleSetProperties

Propiedades del conjunto de reglas de red de IotHub

privateEndpointConnections

PrivateEndpointConnection[]

Conexiones de punto de conexión privado creadas en este IotHub

provisioningState

string

Estado de aprovisionamiento.

publicNetworkAccess

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

RoutingProperties

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

serviceHostName

string

El nombre del anfitrión del servicio. Soporta conexiones seguras a través de TLS 1.3.

state

string

El estado central.

storageEndpoints

<string,  StorageEndpointProperties>

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

IotHubReplicaRoleType

El papel de la región puede ser primario 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 a la que IoT Hub puede conmutar por error.

Valor Description
primary

principal

secondary

secondary

IotHubSku

Nombre de la SKU.

Valor Description
F1

F1

S1

S1

S2

S2

S3

S3

B1

B1

B2

B2

B3

B3

IotHubSkuInfo

Información sobre la SKU del centro de IoT.

Nombre Tipo Description
capacity

integer (int64)

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

name

IotHubSku

Nombre de la SKU.

tier

IotHubSkuTier

Nivel de facturación del centro de IoT.

IotHubSkuTier

Nivel de facturación del centro de IoT.

Valor Description
Free

Gratis

Standard

Standard

Basic

Basic

IpFilterActionType

Acción deseada para las solicitudes capturadas por esta regla.

Valor Description
Accept

Aceptar

Reject

Rechazar

IpFilterRule

Las reglas de filtro IP para el centro de IoT.

Nombre Tipo Description
action

IpFilterActionType

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

Las 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 (duration)

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

maxDeliveryCount

integer (int32)

minimum: 1
maximum: 100

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

ttlAsIso8601

string (duration)

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

NetworkRuleIPAction

Acción de filtro IP

Valor Description
Allow

Permitir

NetworkRuleSetIpRule

Regla IP que se aplicará como parte del conjunto de reglas de red

Nombre Tipo Valor predeterminado Description
action

NetworkRuleIPAction

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

DefaultAction

Deny

Acción predeterminada para el conjunto de reglas de red

ipRules

NetworkRuleSetIpRule[]

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 de recurso.

PrivateEndpointConnection

La conexión de punto de conexión privado de un IotHub

Nombre Tipo Description
id

string (arm-id)

Identificador completamente cualificado del recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

Nombre del recurso.

properties

PrivateEndpointConnectionProperties

Propiedades de una conexión de punto de conexión privado

systemData

systemData

Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.

type

string

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Propiedades de una conexión de punto de conexión privado

Nombre Tipo Description
privateEndpoint

PrivateEndpoint

La propiedad de punto de conexión privado de una conexión de punto de conexión privado

privateLinkServiceConnectionState

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

PrivateLinkServiceConnectionStatus

Estado de una conexión de punto de conexión privado

PrivateLinkServiceConnectionStatus

Estado de una conexión de punto de conexión privado

Valor Description
Pending

Pending

Approved

Aprobado

Rejected

Rejected

Disconnected

Desconectado

PublicNetworkAccess

Indica si se permiten solicitudes de la red pública

Valor Description
Enabled

Enabled

Disabled

Disabled

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.

Valor Description
SystemAssigned

AsignadoPorElSistema

UserAssigned

UserAssigned

SystemAssigned, UserAssigned

SystemAssigned, UserAssigned

None

None

RouteProperties

Las propiedades de una regla de enrutamiento que el centro de IoT usa para enrutar 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

pattern: ^[A-Za-z0-9-._]{1,64}$

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

RoutingSource

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

RoutingCosmosDBSqlApiProperties

Las propiedades relacionadas con un punto de conexión de contenedor sql de Cosmos DB.

Nombre Tipo Description
authenticationType

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 (uri)

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

ManagedIdentity

Propiedades de identidad administrada del punto de conexión de contenedor de Cosmos DB de enrutamiento.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

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 order y non-placeholder son arbitrarios. Este parámetro solo es necesario si se especifica PartitionKeyName.

primaryKey

string (password)

Clave principal de la cuenta de Cosmos DB.

resourceGroup

string

Nombre del grupo de recursos de la cuenta de Cosmos DB.

secondaryKey

string (password)

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 permite un máximo de 10 puntos de conexión personalizados en todos los tipos de punto de conexión para centros de pago y solo se permite un punto de conexión personalizado en todos los tipos de puntos de conexión para centros gratuitos.

Nombre Tipo Description
cosmosDBSqlContainers

RoutingCosmosDBSqlApiProperties[]

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

eventHubs

RoutingEventHubProperties[]

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.

eventStreams

RoutingEventStreamProperties[]

La lista de puntos finales de flujo de eventos a los que el hub IoT enruta mensajes, basada en las reglas de enrutamiento.

serviceBusQueues

RoutingServiceBusQueueEndpointProperties[]

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

serviceBusTopics

RoutingServiceBusTopicEndpointProperties[]

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

storageContainers

RoutingStorageContainerProperties[]

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

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

Nombre Tipo Description
authenticationType

AuthenticationType

Método usado para autenticarse en el punto de conexión del centro de eventos

connectionString

string (password)

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

ManagedIdentity

Propiedades de identidad administrada del punto de conexión del centro de eventos de enrutamiento.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

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.

RoutingEventStreamProperties

Las propiedades relacionadas con un punto final de flujo de eventos.

Nombre Tipo Description
authenticationType

EventStreamAuthenticationType

Método utilizado para autenticar contra el extremo del flujo de eventos

endpointUri

string

La URL del espacio de nombres del hub de eventos subyacente del punto final del flujo de eventos. Debe incluir el protocolo sb://

entityPath

string

Nombre del centro de eventos en el espacio de nombres del centro de eventos

eventStreamId

string

El GUID único del flujo de eventos objetivo bajo el espacio de trabajo.

id

string

Id del punto final del flujo de eventos

identity

ManagedIdentity

Propiedades de identidad gestionadas del endpoint del flujo de eventos de enrutamiento.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

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.

sourceId

string

El GUID único de la fuente personalizada para el flujo de eventos.

workspaceId

string

El GUID único del espacio de trabajo objetivo de Microsoft Fabric para el extremo del flujo 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

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 permite un máximo de 10 puntos de conexión personalizados en todos los tipos de punto de conexión para centros de pago y solo se permite un punto de conexión personalizado en todos los tipos de puntos de conexión para centros gratuitos.

enrichments

EnrichmentProperties[]

Lista de enriquecimientos proporcionados por el usuario que el centro de IoT aplica a los mensajes que se van a entregar a puntos de conexión integrados y personalizados. Consulte: https://aka.ms/telemetryoneventgrid

fallbackRoute

FallbackRouteProperties

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

routes

RouteProperties[]

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 extremo de cola de Service Bus.

Nombre Tipo Description
authenticationType

AuthenticationType

Método usado para autenticarse en el punto de conexión de cola de Service Bus

connectionString

string (password)

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

ManagedIdentity

Propiedades de identidad administrada del punto de conexión de cola de Service Bus de enrutamiento.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

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

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 extremo de tema de Service Bus.

Nombre Tipo Description
authenticationType

AuthenticationType

Método usado para autenticarse en el punto de conexión del tema de Service Bus

connectionString

string (password)

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 cola en el tema de Service Bus

id

string

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

identity

ManagedIdentity

Propiedades de identidad administrada del punto de conexión del tema de Service Bus de enrutamiento.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

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

resourceGroup

string

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

subscriptionId

string

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

RoutingSource

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

Valor Description
Invalid

No válido

DeviceMessages

Mensajes de dispositivo

TwinChangeEvents

TwinChangeEvents

DeviceLifecycleEvents

EventosDelCicloDeVidaDelDispositivo

DeviceJobLifecycleEvents

DeviceJobLifecycleEvents

DeviceConnectionStateEvents

DeviceConnectionStateEvents

RoutingStorageContainerProperties

Las propiedades relacionadas con un punto de conexión de contenedor de almacenamiento.

Nombre Tipo Description
authenticationType

AuthenticationType

Método usado para autenticarse en el punto de conexión de almacenamiento

batchFrequencyInSeconds

integer (int32)

minimum: 60
maximum: 720

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

connectionString

string (password)

Cadena de conexión de la cuenta de almacenamiento.

containerName

string

Nombre del contenedor de almacenamiento en la cuenta de almacenamiento.

encoding

RoutingStorageContainerPropertiesEncoding

Codificación que se usa para serializar mensajes en blobs. Los valores admitidos son "avro", "avrodeflate" 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

ManagedIdentity

Propiedades de identidad administrada del punto de conexión de almacenamiento de enrutamiento.

maxChunkSizeInBytes

integer (int32)

minimum: 10485760
maximum: 524288000

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

pattern: ^[A-Za-z0-9-._]{1,64}$

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.

RoutingStorageContainerPropertiesEncoding

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

Valor Description
Avro

Avro

AvroDeflate

AvroDeflate

JSON

JSON

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

AccessRights

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

AuthenticationType

Especifica el tipo de autenticación que se usa para conectarse a la cuenta de almacenamiento.

connectionString

string

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 debe existir, pero debe ser creatable mediante el parámetro connectionString especificado.

identity

ManagedIdentity

Propiedades de identidad administrada del punto de conexión de almacenamiento para la carga de archivos.

sasTtlAsIso8601

string (duration)

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 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

systemData

Metadatos relativos a la creación y última modificación del recurso.

Nombre Tipo Description
createdAt

string (date-time)

Marca de tiempo de creación de recursos (UTC).

createdBy

string

La identidad que creó el recurso.

createdByType

createdByType

Tipo de identidad que creó el recurso.

lastModifiedAt

string (date-time)

Marca de tiempo de la última modificación del recurso (UTC)

lastModifiedBy

string

La identidad que modificó el recurso por última vez.

lastModifiedByType

createdByType

Tipo de identidad que modificó por última vez el recurso.