Iot Hub Resource - Create Or Update

Skapa eller uppdatera metadata för en Iot-hubb. Det vanliga mönstret för att ändra en egenskap är att hämta IoT Hub-metadata och säkerhetsmetadata och sedan kombinera dem med de ändrade värdena i en ny brödtext för att uppdatera IoT-hubben. Om vissa egenskaper saknas i JSON kan uppdatering av IoT Hub göra att dessa värden återgår till standard, vilket kan leda till oväntat beteende.

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

URI-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
path True

string

Namnet på resursgruppen som innehåller IoT-hubben.

resourceName
path True

string

Namnet på IoT-hubben.

subscriptionId
path True

string

Prenumerationsidentifieraren.

api-version
query True

string

Versionen av API:et.

Begärandehuvud

Name Obligatorisk Typ Description
If-Match

string

ETag för IoT Hub. Ange inte för att skapa en helt ny IoT Hub. Krävs för att uppdatera en befintlig IoT Hub.

Begärandetext

Name Obligatorisk Typ Description
location True

string

Resursplatsen.

sku True

IotHubSkuInfo

IotHub SKU-information

etag

string

Fältet Etag krävs inte . Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen.

properties

IotHubProperties

IotHub-egenskaper

tags

object

Resurstaggar.

Svar

Name Typ Description
200 OK

IotHubDescription

Detta returneras som ett svar på begäran om statussökning för skapande- eller uppdateringsåtgärden. Brödtexten innehåller resursrepresentationen som anger ett övergångsetableringstillstånd.

201 Created

IotHubDescription

Det här är en tidskrävande åtgärd. Åtgärden returnerar ett 201 om verifieringen är klar. Svaret innehåller ett Azure-AsyncOperation-huvud som innehåller en status-URL. Klienter förväntas avsöka status-URL:en för åtgärdens status. Om åtgärden lyckas returneras HTTP-statuskoden 201 (OK).

Other Status Codes

ErrorDetails

DefaultErrorResponse

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

IotHubResource_CreateOrUpdate

Sample Request

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

{
  "name": "iot-dps-cit-hub-1",
  "type": "Microsoft.Devices/IotHubs",
  "location": "centraluseuap",
  "tags": {},
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "operationsMonitoringProperties": {
      "events": {
        "None": "None",
        "Connections": "None",
        "DeviceTelemetry": "None",
        "C2DCommands": "None",
        "DeviceIdentityOperations": "None",
        "FileUploadOperations": "None",
        "Routes": "None"
      }
    },
    "state": "Active",
    "provisioningState": "Succeeded",
    "ipFilterRules": [],
    "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/"
      },
      "operationsMonitoringEvents": {
        "retentionTimeInDays": 1,
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "path": "iot-dps-cit-hub-1-operationmonitoring",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": []
      },
      "routes": [],
      "fallbackRoute": {
        "name": "$fallback",
        "source": "DeviceMessages",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true
      }
    },
    "storageEndpoints": {
      "$default": {
        "sasTtlAsIso8601": "PT1H",
        "connectionString": "",
        "containerName": ""
      }
    },
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "enableFileUploadNotifications": false,
    "cloudToDevice": {
      "maxDeliveryCount": 10,
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "features": "None"
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}

Sample Response

{
  "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": {
    "operationsMonitoringProperties": {
      "events": {
        "None": "None",
        "Connections": "None",
        "DeviceTelemetry": "None",
        "C2DCommands": "None",
        "DeviceIdentityOperations": "None",
        "FileUploadOperations": "None",
        "Routes": "None"
      }
    },
    "state": "Active",
    "provisioningState": "Succeeded",
    "ipFilterRules": [],
    "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/"
      },
      "operationsMonitoringEvents": {
        "retentionTimeInDays": 1,
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "path": "iot-dps-cit-hub-1-operationmonitoring",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": []
      },
      "routes": [],
      "fallbackRoute": {
        "name": "$fallback",
        "source": "DeviceMessages",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true
      }
    },
    "storageEndpoints": {
      "$default": {
        "sasTtlAsIso8601": "PT1H",
        "connectionString": "",
        "containerName": ""
      }
    },
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "enableFileUploadNotifications": false,
    "cloudToDevice": {
      "maxDeliveryCount": 10,
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "features": "None"
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}
{
  "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": {
    "operationsMonitoringProperties": {
      "events": {
        "None": "None",
        "Connections": "None",
        "DeviceTelemetry": "None",
        "C2DCommands": "None",
        "DeviceIdentityOperations": "None",
        "FileUploadOperations": "None",
        "Routes": "None"
      }
    },
    "state": "Active",
    "provisioningState": "Succeeded",
    "ipFilterRules": [],
    "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/"
      },
      "operationsMonitoringEvents": {
        "retentionTimeInDays": 1,
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "path": "iot-dps-cit-hub-1-operationmonitoring",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": []
      },
      "routes": [],
      "fallbackRoute": {
        "name": "$fallback",
        "source": "DeviceMessages",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true
      }
    },
    "storageEndpoints": {
      "$default": {
        "sasTtlAsIso8601": "PT1H",
        "connectionString": "",
        "containerName": ""
      }
    },
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "enableFileUploadNotifications": false,
    "cloudToDevice": {
      "maxDeliveryCount": 10,
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "features": "None"
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}

Definitioner

Name Description
AccessRights

De behörigheter som tilldelats till principen för delad åtkomst.

Capabilities

Funktionerna och funktionerna som är aktiverade för IoT-hubben.

CloudToDeviceProperties

Meddelandeegenskaperna för IoT Hub från moln till enhet.

ErrorDetails

Felinformation.

EventHubProperties

Egenskaperna för den etablerade Event Hub-kompatibla slutpunkten som används av IoT-hubben.

FallbackRouteProperties

Egenskaperna för återställningsvägen. IoT Hub använder dessa egenskaper när meddelanden dirigeras till återställningsslutpunkten.

FeedbackProperties

Egenskaperna för feedbackkön för meddelanden från molnet till enheten.

IotHubDescription

Beskrivningen av IoT-hubben.

IotHubProperties

Egenskaperna för en IoT-hubb.

IotHubSku

Namnet på SKU:n.

IotHubSkuInfo

Information om SKU:n för IoT-hubben.

IotHubSkuTier

Faktureringsnivån för IoT-hubben.

IpFilterActionType

Önskad åtgärd för begäranden som samlas in av den här regeln.

IpFilterRule

IP-filterreglerna för IoT-hubben.

MessagingEndpointProperties

Egenskaperna för de meddelandeslutpunkter som används av den här IoT-hubben.

OperationsMonitoringProperties

Egenskaperna för driftövervakning för IoT-hubben. Möjliga nycklar till ordlistan är Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations, Routes, D2CTwinOperations, C2DTwinOperations, TwinQueries, JobsOperations, DirectMethods.

RouteProperties

Egenskaperna för en routningsregel som IoT-hubben använder för att dirigera meddelanden till slutpunkter.

RoutingEndpoints

Egenskaperna som är relaterade till de anpassade slutpunkter som din IoT-hubb dirigerar meddelanden till baserat på routningsreglerna. Högst 10 anpassade slutpunkter tillåts för alla slutpunktstyper för betalda hubbar och endast 1 anpassad slutpunkt tillåts för alla slutpunktstyper för kostnadsfria hubbar.

RoutingEventHubProperties

Egenskaperna som är relaterade till en händelsehubbslutpunkt.

RoutingProperties

De routningsrelaterade egenskaperna för IoT-hubben. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

RoutingServiceBusQueueEndpointProperties

Egenskaper relaterade till service bus-köslutpunktstyper.

RoutingServiceBusTopicEndpointProperties

Egenskaper relaterade till service bus-ämnesslutpunktstyper.

RoutingSource

Den källa som routningsregeln ska tillämpas på, till exempel DeviceMessages.

RoutingStorageContainerProperties

Egenskaperna som är relaterade till en slutpunkt för lagringscontainer.

SharedAccessSignatureAuthorizationRule

Egenskaperna för en princip för delad åtkomst i IoT Hub.

StorageEndpointProperties

Egenskaperna för Azure Storage-slutpunkten för filuppladdning.

AccessRights

De behörigheter som tilldelats till principen för delad åtkomst.

Name Typ Description
DeviceConnect

string

RegistryRead

string

RegistryRead, DeviceConnect

string

RegistryRead, RegistryWrite

string

RegistryRead, RegistryWrite, DeviceConnect

string

RegistryRead, RegistryWrite, ServiceConnect

string

RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect

string

RegistryRead, ServiceConnect

string

RegistryRead, ServiceConnect, DeviceConnect

string

RegistryWrite

string

RegistryWrite, DeviceConnect

string

RegistryWrite, ServiceConnect

string

RegistryWrite, ServiceConnect, DeviceConnect

string

ServiceConnect

string

ServiceConnect, DeviceConnect

string

Capabilities

Funktionerna och funktionerna som är aktiverade för IoT-hubben.

Name Typ Description
DeviceManagement

string

None

string

CloudToDeviceProperties

Meddelandeegenskaperna för IoT Hub från moln till enhet.

Name Typ Description
defaultTtlAsIso8601

string

Standardtiden för att leva för meddelanden från moln till enhet i enhetskön. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

feedback

FeedbackProperties

Egenskaperna för feedbackkön för moln-till-enhet-meddelanden.

maxDeliveryCount

integer

Det maximala leveransantalet för moln-till-enhet-meddelanden i enhetskön. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

ErrorDetails

Felinformation.

Name Typ Description
code

string

Felkoden.

details

string

Felinformationen.

httpStatusCode

string

HTTP-statuskoden.

message

string

Felmeddelandet.

EventHubProperties

Egenskaperna för den etablerade Event Hub-kompatibla slutpunkten som används av IoT-hubben.

Name Typ Description
endpoint

string

Den Event Hub-kompatibla slutpunkten.

partitionCount

integer

Antalet partitioner för att ta emot meddelanden från enhet till moln i den Event Hub-kompatibla slutpunkten. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.

partitionIds

string[]

Partitions-ID:t i den Event Hub-kompatibla slutpunkten.

path

string

Event Hub-kompatibelt namn.

retentionTimeInDays

integer

Kvarhållningstiden för meddelanden från enhet till moln i dagar. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

FallbackRouteProperties

Egenskaperna för återställningsvägen. IoT Hub använder dessa egenskaper när meddelanden dirigeras till återställningsslutpunkten.

Name Typ Description
condition

string

Villkoret som utvärderas för att tillämpa återställningsvägen. Om villkoret inte anges utvärderas det till sant som standard. För grammatik, se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpointNames

string[]

Listan över slutpunkter som meddelandena som uppfyller villkoret dirigeras till. För närvarande tillåts endast 1 slutpunkt.

isEnabled

boolean

Används för att ange om återställningsvägen är aktiverad.

name

string

Namnet på vägen. Namnet får bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck, har en maximal längd på 64 tecken och måste vara unikt.

source

RoutingSource

Den källa som routningsregeln ska tillämpas på. Till exempel DeviceMessages

FeedbackProperties

Egenskaperna för feedbackkön för meddelanden från molnet till enheten.

Name Typ Description
lockDurationAsIso8601

string

Låsets varaktighet för feedbackkön. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

maxDeliveryCount

integer

Antalet gånger som IoT-hubben försöker leverera ett meddelande i feedbackkön. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

ttlAsIso8601

string

Den tidsperiod då ett meddelande är tillgängligt för användning innan det har upphört att gälla av IoT-hubben. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

IotHubDescription

Beskrivningen av IoT-hubben.

Name Typ Description
etag

string

Fältet Etag krävs inte . Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen.

id

string

Resursidentifieraren.

location

string

Resursplatsen.

name

string

Resursnamnet.

properties

IotHubProperties

IotHub-egenskaper

sku

IotHubSkuInfo

IotHub SKU-information

tags

object

Resurstaggar.

type

string

Resurstypen.

IotHubProperties

Egenskaperna för en IoT-hubb.

Name Typ Description
authorizationPolicies

SharedAccessSignatureAuthorizationRule[]

De principer för delad åtkomst som du kan använda för att skydda en anslutning till IoT-hubben.

cloudToDevice

CloudToDeviceProperties

Meddelandeegenskaperna för IoT Hub från moln till enhet.

comments

string

IoT Hub-kommentarer.

enableFileUploadNotifications

boolean

Om sant är meddelanden om filuppladdning aktiverade.

eventHubEndpoints

<string,  EventHubProperties>

De Event Hub-kompatibla slutpunktsegenskaperna. Möjliga nycklar till den här ordlistan är händelser och åtgärderÖvervakaHändelser. Båda dessa nycklar måste finnas i ordlistan när du skapar eller uppdaterar anrop för IoT-hubben.

features

Capabilities

Funktionerna och funktionerna som är aktiverade för IoT-hubben.

hostName

string

Namnet på värden.

ipFilterRules

IpFilterRule[]

IP-filterreglerna.

messagingEndpoints

<string,  MessagingEndpointProperties>

Egenskaperna för meddelandeslutpunkten för meddelandekön för filuppladdning.

operationsMonitoringProperties

OperationsMonitoringProperties

Egenskaperna för driftövervakning för IoT-hubben. Möjliga nycklar till ordlistan är Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations, Routes, D2CTwinOperations, C2DTwinOperations, TwinQueries, JobsOperations, DirectMethods.

provisioningState

string

Etableringstillståndet.

routing

RoutingProperties

De routningsrelaterade egenskaperna för IoT-hubben. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

state

string

Hubbens tillstånd.

storageEndpoints

<string,  StorageEndpointProperties>

Listan över Azure Storage-slutpunkter där du kan ladda upp filer. För närvarande kan du bara konfigurera ett Azure Storage-konto och måste ha dess nyckel som $default. Om du anger fler än ett lagringskonto genereras ett fel. Om du inte anger något värde för den här egenskapen när egenskapen enableFileUploadNotifications har angetts till Sant utlöses ett fel.

IotHubSku

Namnet på SKU:n.

Name Typ Description
B1

string

B2

string

B3

string

F1

string

S1

string

S2

string

S3

string

IotHubSkuInfo

Information om SKU:n för IoT-hubben.

Name Typ Description
capacity

integer

Antalet etablerade IoT Hub enheter. Se: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.

name

IotHubSku

Namnet på SKU:n.

tier

IotHubSkuTier

Faktureringsnivån för IoT-hubben.

IotHubSkuTier

Faktureringsnivån för IoT-hubben.

Name Typ Description
Basic

string

Free

string

Standard

string

IpFilterActionType

Önskad åtgärd för begäranden som samlas in av den här regeln.

Name Typ Description
Accept

string

Reject

string

IpFilterRule

IP-filterreglerna för IoT-hubben.

Name Typ Description
action

IpFilterActionType

Önskad åtgärd för begäranden som samlas in av den här regeln.

filterName

string

Namnet på IP-filterregeln.

ipMask

string

En sträng som innehåller IP-adressintervallet i CIDR-notation för regeln.

MessagingEndpointProperties

Egenskaperna för de meddelandeslutpunkter som används av den här IoT-hubben.

Name Typ Description
lockDurationAsIso8601

string

Låsets varaktighet. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

maxDeliveryCount

integer

Antalet gånger som IoT-hubben försöker leverera ett meddelande. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

ttlAsIso8601

string

Den tidsperiod för vilken ett meddelande är tillgängligt att använda innan det upphör att gälla av IoT-hubben. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

OperationsMonitoringProperties

Egenskaperna för driftövervakning för IoT-hubben. Möjliga nycklar till ordlistan är Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations, Routes, D2CTwinOperations, C2DTwinOperations, TwinQueries, JobsOperations, DirectMethods.

Name Typ Description
events

object

RouteProperties

Egenskaperna för en routningsregel som IoT-hubben använder för att dirigera meddelanden till slutpunkter.

Name Typ Description
condition

string

Villkoret som utvärderas för att tillämpa routningsregeln. Om inget villkor anges utvärderas det till sant som standard. Grammatik finns i: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpointNames

string[]

Listan över slutpunkter till vilka meddelanden som uppfyller villkoret dirigeras. För närvarande tillåts endast en slutpunkt.

isEnabled

boolean

Används för att ange om en väg är aktiverad.

name

string

Namnet på vägen. Namnet får bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck, har en maximal längd på 64 tecken och måste vara unikt.

source

RoutingSource

Den källa som routningsregeln ska tillämpas på, till exempel DeviceMessages.

RoutingEndpoints

Egenskaperna som är relaterade till de anpassade slutpunkter som din IoT-hubb dirigerar meddelanden till baserat på routningsreglerna. Högst 10 anpassade slutpunkter tillåts för alla slutpunktstyper för betalda hubbar och endast 1 anpassad slutpunkt tillåts för alla slutpunktstyper för kostnadsfria hubbar.

Name Typ Description
eventHubs

RoutingEventHubProperties[]

Listan över Event Hubs-slutpunkter som IoT Hub dirigerar meddelanden till, baserat på routningsreglerna. Den här listan innehåller inte den inbyggda Event Hubs-slutpunkten.

serviceBusQueues

RoutingServiceBusQueueEndpointProperties[]

Listan över Service Bus-köslutpunkter som IoT Hub dirigerar meddelandena till, baserat på routningsreglerna.

serviceBusTopics

RoutingServiceBusTopicEndpointProperties[]

Listan över Service Bus-ämnesslutpunkter som IoT-hubben dirigerar meddelandena till, baserat på routningsreglerna.

storageContainers

RoutingStorageContainerProperties[]

Listan över slutpunkter för lagringscontainer som IoT Hub dirigerar meddelanden till, baserat på routningsreglerna.

RoutingEventHubProperties

Egenskaperna som är relaterade till en händelsehubbslutpunkt.

Name Typ Description
connectionString

string

Anslutningssträng för händelsehubbens slutpunkt.

name

string

Namnet som identifierar den här slutpunkten. Namnet får bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, operationsMonitoringEvents, fileNotifications $default. Slutpunktsnamn måste vara unika för olika slutpunktstyper.

resourceGroup

string

Namnet på resursgruppen för händelsehubbens slutpunkt.

subscriptionId

string

Prenumerationsidentifieraren för händelsehubbens slutpunkt.

RoutingProperties

De routningsrelaterade egenskaperna för IoT-hubben. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Name Typ Description
endpoints

RoutingEndpoints

Egenskaperna som är relaterade till de anpassade slutpunkter som din IoT-hubb dirigerar meddelanden till baserat på routningsreglerna. Högst 10 anpassade slutpunkter tillåts för alla slutpunktstyper för betalda hubbar och endast 1 anpassad slutpunkt tillåts för alla slutpunktstyper för kostnadsfria hubbar.

fallbackRoute

FallbackRouteProperties

Egenskaperna för den väg som används som en återställningsväg när inget av de villkor som anges i avsnittet "vägar" är uppfyllda. Det här är en valfri parameter. När den här egenskapen inte har angetts dirigeras de meddelanden som inte uppfyller något av de villkor som anges i avsnittet "vägar" till den inbyggda eventhub-slutpunkten.

routes

RouteProperties[]

Listan över användardefinierade routningsregler som IoT-hubben använder för att dirigera meddelanden till inbyggda och anpassade slutpunkter. Högst 100 routningsregler tillåts för betalda hubbar och högst 5 routningsregler tillåts för kostnadsfria hubbar.

RoutingServiceBusQueueEndpointProperties

Egenskaper relaterade till service bus-köslutpunktstyper.

Name Typ Description
connectionString

string

Anslutningssträng för service bus-köslutpunkten.

name

string

Namnet som identifierar den här slutpunkten. Namnet får bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, operationsMonitoringEvents, fileNotifications $default. Slutpunktsnamn måste vara unika för olika slutpunktstyper. Namnet behöver inte vara samma som det faktiska könamnet.

resourceGroup

string

Namnet på resursgruppen för service bus-köslutpunkten.

subscriptionId

string

Prenumerationsidentifieraren för service bus-köslutpunkten.

RoutingServiceBusTopicEndpointProperties

Egenskaper relaterade till service bus-ämnesslutpunktstyper.

Name Typ Description
connectionString

string

Anslutningssträng för service bus-ämnesslutpunkten.

name

string

Namnet som identifierar den här slutpunkten. Namnet får bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, operationsMonitoringEvents, fileNotifications $default. Slutpunktsnamn måste vara unika för olika slutpunktstyper. Namnet behöver inte vara samma som det faktiska ämnesnamnet.

resourceGroup

string

Namnet på resursgruppen för service bus-ämnesslutpunkten.

subscriptionId

string

Prenumerationsidentifieraren för service bus-ämnesslutpunkten.

RoutingSource

Den källa som routningsregeln ska tillämpas på, till exempel DeviceMessages.

Name Typ Description
DeviceJobLifecycleEvents

string

DeviceLifecycleEvents

string

DeviceMessages

string

Invalid

string

TwinChangeEvents

string

RoutingStorageContainerProperties

Egenskaperna som är relaterade till en slutpunkt för lagringscontainer.

Name Typ Description
batchFrequencyInSeconds

integer

Tidsintervall då blobar skrivs till lagring. Värdet ska vara mellan 60 och 720 sekunder. Standardvärdet är 300 sekunder.

connectionString

string

Lagringskontots anslutningssträng.

containerName

string

Namnet på lagringscontainern i lagringskontot.

encoding

string

Kodning som används för att serialisera meddelanden till blobar. Värden som stöds är "avro" och "avroDeflate". Standardvärdet är "avro".

fileNameFormat

string

Filnamnsformat för bloben. Standardformatet är {iothub}/{partition}/{ÅÅÅÅ}/{MM}/{DD}/{HH}/{mm}. Alla parametrar är obligatoriska men kan ordnas om.

maxChunkSizeInBytes

integer

Maximalt antal byte för varje blob som skrivs till lagring. Värdet ska vara mellan 10485760(10 MB) och 524288000(500 MB). Standardvärdet är 314572800(300 MB).

name

string

Namnet som identifierar den här slutpunkten. Namnet får bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, operationsMonitoringEvents, fileNotifications $default. Slutpunktsnamn måste vara unika för olika slutpunktstyper.

resourceGroup

string

Namnet på lagringskontots resursgrupp.

subscriptionId

string

Prenumerationsidentifieraren för lagringskontot.

SharedAccessSignatureAuthorizationRule

Egenskaperna för en princip för delad åtkomst i IoT Hub.

Name Typ Description
keyName

string

Namnet på principen för delad åtkomst.

primaryKey

string

Primärnyckeln.

rights

AccessRights

De behörigheter som tilldelats till principen för delad åtkomst.

secondaryKey

string

Den sekundära nyckeln.

StorageEndpointProperties

Egenskaperna för Azure Storage-slutpunkten för filuppladdning.

Name Typ Description
connectionString

string

Anslutningssträng för Det Azure Storage-konto som filer laddas upp till.

containerName

string

Namnet på rotcontainern där du laddar upp filer. Containern behöver inte finnas, men den bör skapas med den angivna connectionString.

sasTtlAsIso8601

string

Den tidsperiod för vilken SAS-URI:n som genereras av IoT Hub för filuppladdning är giltig. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.