Compartir a través de

Iot Hub Resource - Delete

  • Referencia
Servicio:
IoT Hub
Versión de la API:
2023-06-30

Elimine un centro de IoT.

DELETE 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
resourceGroupName
 path True

string

Nombre del grupo de recursos que contiene el centro de IoT.
resourceName
 path True

string

Nombre del centro de IoT.
subscriptionId
 path True

string

Identificador de la suscripción.
api-version
 query True

string

Versión de la API.

Respuestas

Nombre Tipo Description
200 OK

IotHubDescription

Esto se devuelve como respuesta a la solicitud de sondeo de estado para la operación de eliminación. El cuerpo contiene la representación del recurso que indica un estado de aprovisionamiento transitorio.
202 Accepted

IotHubDescription

El proveedor de recursos de Iot Hub siempre devuelve un código de estado aceptado 202 con encabezados de ubicación y Retry-After válidos. El proveedor de recursos también establece el encabezado Azure-AsyncOperation con una dirección URL que apunta al recurso de operación para esta operación. Los intentos GET posteriores en el recurso después de una operación DELETE devuelven una representación de recursos que indica un estado de aprovisionamiento transitorio (por ejemplo, Terminación). Para recuperar el estado de la operación, un cliente puede sondear la dirección URL devuelta en el encabezado Location después del intervalo de Retry-After, obtener el estado del servicio IoT Hub directamente o consultar el recurso de operación.

Encabezados

  • Azure-AsyncOperation: string
  • Location: string
204 No Content

Una vez que la operación de eliminación de larga duración se completa correctamente, se devuelve un código de estado 204 Sin contenido cuando la solicitud de sondeo de estado encuentra los metadatos del centro de IoT en el servicio y el estado de la operación de eliminación se establece en un estado completado.
404 Not Found

ErrorDetails

Una vez completada correctamente la operación de eliminación de larga duración, se devuelve un 404 No encontrado cuando la solicitud de sondeo de estado ya no encuentra los metadatos del centro de IoT en el servicio.
Other Status Codes

ErrorDetails

DefaultErrorResponse

Seguridad

azure_auth

Flujo de 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 la cuenta de usuario

Ejemplos

IotHubResource_Delete

Solicitud de ejemplo

DELETE https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub?api-version=2023-06-30

Respuesta de muestra

status code:
200 
{
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/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",
    "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": {
        "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"
  }
}
status code:
204
status code:
202 
Azure-AsyncOperation: https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/operationResults/b3NfaWhfYmJhZmM4OWItNzQ3My00OWExLTg0NWUtNzQ3NWU2ODBkNDA3?api-version=2023-06-30-preview&operationSource=os_ih&asyncinfo
Location: https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/operationResults/b3NfaWhfYmJhZmM4OWItNzQ3My00OWExLTg0NWUtNzQ3NWU2ODBkNDA3?api-version=2022-11-01-preview&operationSource=os_ih
{
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/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",
    "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": {
        "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
  }
}
status code:
404 
{}

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

Método usado para autenticarse en el punto de conexión de cola de Service Bus
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
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 Event Hubs aprovisionado que usa IoT Hub.
FallbackRouteProperties

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

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

Descripción del centro de 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 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 ioT Hub puede conmutar por error.
IotHubSku

Nombre de la SKU.
IotHubSkuInfo

Información sobre la SKU del centro de IoT.
IotHubSkuTier

El 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 del centro de IoT.
ManagedIdentity

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 de IP que se va a 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

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 los mensajes a los puntos de conexión.
RoutingCosmosDBSqlApiProperties

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

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

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

Propiedades relacionadas con los tipos de punto de conexión de cola de Service Bus.
RoutingServiceBusTopicEndpointProperties

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

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

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

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

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

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

AccessRights

Enumeración

Permisos asignados a la directiva de acceso compartido.

Valor Description
DeviceConnect
RegistryRead
RegistryRead, DeviceConnect
RegistryRead, RegistryWrite
RegistryRead, RegistryWrite, DeviceConnect
RegistryRead, RegistryWrite, ServiceConnect
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect
RegistryRead, ServiceConnect
RegistryRead, ServiceConnect, DeviceConnect
RegistryWrite
RegistryWrite, DeviceConnect
RegistryWrite, ServiceConnect
RegistryWrite, ServiceConnect, DeviceConnect
ServiceConnect
ServiceConnect, DeviceConnect

ArmIdentity

Object
Nombre Tipo Description
principalId

string

Identificador de entidad de seguridad
tenantId

string

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

ArmUserIdentity

Object
Nombre Tipo Description
clientId

string

principalId

string

AuthenticationType

Enumeración

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

Valor Description
identityBased
keyBased

authenticationType

Enumeración

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

Valor Description
identityBased
keyBased

Capabilities

Enumeración

Las funcionalidades y características habilitadas para ioT Hub.

Valor Description
DeviceManagement
None

CloudToDeviceProperties

Object

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

Enumeración

Tipo de identidad que creó el recurso.

Valor Description
Application
Key
ManagedIdentity
User

DefaultAction

Enumeración

Acción predeterminada para el conjunto de reglas de red

Valor Description
Allow
Deny

EnrichmentProperties

Object

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

Object

Detalles del error.

Nombre Tipo Description
code

string

Código de error.
details

string

Detalles del error.
httpStatusCode

string

Código de estado HTTP.
message

string

Mensaje de error.

EventHubProperties

Object

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

Nombre Tipo Description
endpoint

string

Punto de conexión compatible con Event Hubs.
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[]

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

string

Nombre compatible con Event Hubs.
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

FallbackRouteProperties

Object

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

RoutingSource

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

FeedbackProperties

Object

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.

IotHubDescription

Object

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

Identificador de recurso.
identity

ArmIdentity

Identidades administradas para IotHub.
location

string

Ubicación del recurso.
name

string

pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

Nombre del recurso.
properties

IotHubProperties

Propiedades de IotHub
sku

IotHubSkuInfo

Información de SKU de IotHub
systemData

systemData

Metadatos del sistema relacionados con este recurso.
tags

object

Etiquetas de recursos.
type

string

Tipo de recurso.

IotHubLocationDescription

Object

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

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 ioT Hub puede conmutar por error.

IotHubProperties

Object

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

Nombre del host.
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
state

string

Estado del concentrador.
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

Enumeración

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 ioT Hub puede conmutar por error.

Valor Description
primary
secondary

IotHubSku

Enumeración

Nombre de la SKU.

Valor Description
B1
B2
B3
F1
S1
S2
S3

IotHubSkuInfo

Object

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

El nivel de facturación del centro de IoT.

IotHubSkuTier

Enumeración

El nivel de facturación del centro de IoT.

Valor Description
Basic
Free
Standard

IpFilterActionType

Enumeración

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

Valor Description
Accept
Reject

IpFilterRule

Object

Las reglas de filtro IP del 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

Object

Propiedades de la identidad administrada.

Nombre Tipo Description
userAssignedIdentity

string

Identidad asignada por el usuario.

MessagingEndpointProperties

Object

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

Enumeración

Acción de filtro IP

Valor Description
Allow

NetworkRuleSetIpRule

Object

Regla de IP que se va a 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

Object

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

Object

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

Object

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

Nombre Tipo Description
id

string

Identificador de recurso.
name

string

Nombre del recurso.
properties

PrivateEndpointConnectionProperties

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

string

Tipo de recurso.

PrivateEndpointConnectionProperties

Object

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

Object

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

Enumeración

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

Valor Description
Approved
Disconnected
Pending
Rejected

PublicNetworkAccess

Enumeración

Indica si se permiten solicitudes de la red pública

Valor Description
Disabled
Enabled

ResourceIdentityType

Enumeración

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
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

RouteProperties

Object

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 obtener 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

Object

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

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

Object

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

Object

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

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.

RoutingProperties

Object

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 esta propiedad no está presente en la plantilla, la ruta de reserva está deshabilitada de forma predeterminada.
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

Object

Propiedades relacionadas con los tipos de punto de conexión 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

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

Object

Las propiedades relacionadas con los tipos de punto de conexión del 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

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

Enumeración

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

Valor Description
DeviceConnectionStateEvents
DeviceJobLifecycleEvents
DeviceLifecycleEvents
DeviceMessages
Invalid
TwinChangeEvents

RoutingStorageContainerProperties

Object

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

Cadena de conexión de la cuenta de almacenamiento.
containerName

string

Nombre del contenedor de almacenamiento en la cuenta de almacenamiento.
encoding enum:
  • Avro
  • AvroDeflate
  • JSON

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.

SharedAccessSignatureAuthorizationRule

Object

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

Object

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

Object

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

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

Identidad que modificó por última vez el recurso.
lastModifiedByType

createdByType

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