Microsoft.Devices IotHubs 2020-08-01

Artikel
10/26/2024

Bicep-resursdefinition

Resurstypen IotHubs kan distribueras med åtgärder som mål:

Resursgrupper – Se resursgruppsdistributionskommandon

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Devices/IotHubs-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.Devices/IotHubs@2020-08-01' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
      }
    ]
    cloudToDevice: {
      defaultTtlAsIso8601: 'string'
      feedback: {
        lockDurationAsIso8601: 'string'
        maxDeliveryCount: int
        ttlAsIso8601: 'string'
      }
      maxDeliveryCount: int
    }
    comments: 'string'
    enableFileUploadNotifications: bool
    eventHubEndpoints: {
      {customized property}: {
        partitionCount: int
        retentionTimeInDays: int
      }
    }
    features: 'string'
    ipFilterRules: [
      {
        action: 'string'
        filterName: 'string'
        ipMask: 'string'
      }
    ]
    messagingEndpoints: {
      {customized property}: {
        lockDurationAsIso8601: 'string'
        maxDeliveryCount: int
        ttlAsIso8601: 'string'
      }
    }
    minTlsVersion: 'string'
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    publicNetworkAccess: 'string'
    routing: {
      endpoints: {
        eventHubs: [
          {
            authenticationType: 'string'
            connectionString: 'string'
            endpointUri: 'string'
            entityPath: 'string'
            id: 'string'
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        serviceBusQueues: [
          {
            authenticationType: 'string'
            connectionString: 'string'
            endpointUri: 'string'
            entityPath: 'string'
            id: 'string'
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        serviceBusTopics: [
          {
            authenticationType: 'string'
            connectionString: 'string'
            endpointUri: 'string'
            entityPath: 'string'
            id: 'string'
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        storageContainers: [
          {
            authenticationType: 'string'
            batchFrequencyInSeconds: int
            connectionString: 'string'
            containerName: 'string'
            encoding: 'string'
            endpointUri: 'string'
            fileNameFormat: 'string'
            id: 'string'
            maxChunkSizeInBytes: int
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
      }
      enrichments: [
        {
          endpointNames: [
            'string'
          ]
          key: 'string'
          value: 'string'
        }
      ]
      fallbackRoute: {
        condition: 'string'
        endpointNames: [
          'string'
        ]
        isEnabled: bool
        name: 'string'
        source: 'string'
      }
      routes: [
        {
          condition: 'string'
          endpointNames: [
            'string'
          ]
          isEnabled: bool
          name: 'string'
          source: 'string'
        }
      ]
    }
    storageEndpoints: {
      {customized property}: {
        authenticationType: 'string'
        connectionString: 'string'
        containerName: 'string'
        sasTtlAsIso8601: 'string'
      }
    }
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Egenskapsvärden

CloudToDeviceProperties

Namn	Beskrivning	Värde
defaultTtlAsIso8601	Standardtiden för att leva för meddelanden från moln till enhet i enhetskön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	sträng
feedback	Egenskaperna för feedbackkön för meddelanden från moln till enhet.	FeedbackEgenskaper
maxDeliveryCount	Det maximala leveransantalet för meddelanden från moln till enhet i enhetskön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Begränsningar: Minsta värde = 1 Maxvärde = 100

EnrichmentProperties

Namn	Beskrivning	Värde
endpointNames	Listan över slutpunkter för vilka berikningen tillämpas på meddelandet.	string[] (krävs)
nyckel	Nyckeln eller namnet på berikningsegenskapen.	sträng (krävs)
värde	Värdet för berikningsegenskapen.	sträng (krävs)

EventHubProperties

Namn	Beskrivning	Värde
partitionCount	Antalet partitioner för att ta emot meddelanden från enhet till moln i den Event Hub-kompatibla slutpunkten. Se: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.	Int
retentionTimeInDays	Kvarhållningstiden för meddelanden från enhet till moln i dagar. Se: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	Int

FallbackRouteProperties

Namn	Beskrivning	Värde
tillstånd	Villkoret som utvärderas för att tillämpa återställningsvägen. Om villkoret inte anges utvärderas det som sant som standard. För grammatik, se: /azure/iot-hub/iot-hub-devguide-query-language	sträng
endpointNames	Listan över slutpunkter som meddelandena som uppfyller villkoret dirigeras till. För närvarande tillåts endast en slutpunkt.	string[] (krävs)
isEnabled	Används för att ange om återställningsvägen är aktiverad.	bool (krävs)
Namn	Namnet på vägen. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck, har en maximal längd på 64 tecken och måste vara unikt.	sträng
källa	Den källa som routningsregeln ska tillämpas på. Till exempel DeviceMessages	"DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "Ogiltigt" "TwinChangeEvents" (krävs)

FeedbackEgenskaper

Namn	Beskrivning	Värde
lockDurationAsIso8601	Låsvaraktigheten för feedbackkön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	sträng
maxDeliveryCount	Antalet gånger som IoT-hubben försöker leverera ett meddelande i feedbackkön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Begränsningar: Minsta värde = 1 Maxvärde = 100
ttlAsIso8601	Den tidsperiod för vilken ett meddelande är tillgängligt för användning innan det har upphört att gälla av IoT-hubben. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	sträng

IotHubProperties

Namn	Beskrivning	Värde
authorizationPolicies	De principer för delad åtkomst som du kan använda för att skydda en anslutning till IoT-hubben.	SharedAccessSignatureAuthorizationRule[]
cloudToDevice	Meddelandeegenskaperna för IoT Hub från moln till enhet.	CloudToDeviceProperties
Kommentarer	IoT Hub-kommentarer.	sträng
enableFileUploadNotifications	Om Sant aktiveras meddelanden om filuppladdning.	Bool
eventHubEndpoints	De Event Hub-kompatibla slutpunktsegenskaperna. De enda möjliga nycklarna till den här ordlistan är händelser. Den här nyckeln måste finnas i ordlistan när du skapar eller uppdaterar anrop för IoT-hubben.	IotHubPropertiesEventHubEndpoints
Funktioner	Funktionerna och funktionerna som är aktiverade för IoT-hubben.	"DeviceManagement" "Ingen"
ipFilterRules	IP-filterreglerna.	IpFilterRule[]
messagingEndpoints	Egenskaperna för meddelandeslutpunkten för meddelandekön för filuppladdning.	IotHubPropertiesMessagingEndpoints
minTlsVersion	Anger den lägsta TLS-version som ska stödjas för den här hubben. Kan anges till "1.2" så att klienter som använder en TLS-version under 1.2 avvisas.	sträng
privateEndpointConnections	Privata slutpunktsanslutningar som skapats på denna IotHub	PrivateEndpointConnection[]
publicNetworkAccess	Om begäranden från offentliga nätverk tillåts	"Inaktiverad" "Aktiverad"
Routning	Routningsrelaterade egenskaper för IoT-hubben. Se: /azure/iot-hub/iot-hub-devguide-messaging	RoutingEgenskaper
storageEndpoints	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 som 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 True utlöses ett fel.	IotHubPropertiesStorageEndpoints

IotHubPropertiesEventHubEndpoints

Namn	Beskrivning	Värde

IotHubPropertiesMessagingEndpoints

Namn	Beskrivning	Värde

IotHubPropertiesStorageEndpoints

Namn	Beskrivning	Värde

IotHubSkuInfo

Namn	Beskrivning	Värde
kapacitet	Antalet etablerade IoT Hub-enheter. Se: /azure/azure-subscription-service-limits#iot-hub-limits.	Int
Namn	Namnet på SKU:n.	"B1" "B2" "B3" "F1" "S1" "S2" "S3" (krävs)

IpFilterRule

Namn	Beskrivning	Värde
handling	Önskad åtgärd för begäranden som samlas in av den här regeln.	"Acceptera" "Avvisa" (krävs)
filterName	Namnet på IP-filterregeln.	sträng (krävs)
ipMask	En sträng som innehåller IP-adressintervallet i CIDR-notationen för regeln.	sträng (krävs)

MessagingEndpointProperties

Namn	Beskrivning	Värde
lockDurationAsIso8601	Låsets varaktighet. Se: /azure/iot-hub/iot-hub-devguide-file-upload.	sträng
maxDeliveryCount	Antalet gånger som IoT-hubben försöker leverera ett meddelande. Se: /azure/iot-hub/iot-hub-devguide-file-upload.	Int Begränsningar: Minsta värde = 1 Maxvärde = 100
ttlAsIso8601	Den tidsperiod för vilken ett meddelande är tillgängligt för användning innan det har upphört att gälla av IoT-hubben. Se: /azure/iot-hub/iot-hub-devguide-file-upload.	sträng

Microsoft.Devices/IotHubs

Namn	Beskrivning	Värde
etag	Fältet Etag är inte krävs. Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen.	sträng
plats	Resursplatsen.	sträng (krävs)
Namn	Resursnamnet	sträng (krävs)
Egenskaper	IotHub-egenskaper	IotHubProperties
Sku	IotHub SKU-information	IotHubSkuInfo (krävs)
Taggar	Resurstaggar	Ordlista med taggnamn och värden. Se taggar i mallar

PrivateEndpoint

Namn	Beskrivning	Värde

PrivateEndpointConnection

Namn	Beskrivning	Värde
Egenskaper	Egenskaperna för en privat slutpunktsanslutning	PrivateEndpointConnectionProperties (krävs)

PrivateEndpointConnectionProperties

Namn	Beskrivning	Värde
privateEndpoint	Egenskapen privat slutpunkt för en privat slutpunktsanslutning	PrivateEndpoint
privateLinkServiceConnectionState	Det aktuella tillståndet för en privat slutpunktsanslutning	PrivateLinkServiceConnectionState (krävs)

PrivateLinkServiceConnectionState

Namn	Beskrivning	Värde
actionsRequired	Åtgärder som krävs för en privat slutpunktsanslutning	sträng
beskrivning	Beskrivningen av det aktuella tillståndet för en privat slutpunktsanslutning	sträng (krävs)
status	Status för en privat slutpunktsanslutning	"Godkänd" "Frånkopplad" "Väntar" "Avvisad" (krävs)

ResourceTags

Namn	Beskrivning	Värde

RouteProperties

Namn	Beskrivning	Värde
tillstånd	Villkoret som utvärderas för att tillämpa routningsregeln. Om inget villkor anges utvärderas det som sant som standard. Grammatik finns i: /azure/iot-hub/iot-hub-devguide-query-language	sträng
endpointNames	Listan över slutpunkter till vilka meddelanden som uppfyller villkoret dirigeras. För närvarande tillåts endast en slutpunkt.	string[] (krävs)
isEnabled	Används för att ange om en väg är aktiverad.	bool (krävs)
Namn	Namnet på vägen. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck, har en maximal längd på 64 tecken och måste vara unikt.	sträng Begränsningar: Mönster = `^[A-Za-z0-9-._]{1,64}$` (krävs)
källa	Den källa som routningsregeln ska tillämpas på, till exempel DeviceMessages.	"DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "Ogiltigt" "TwinChangeEvents" (krävs)

RoutingEndpoints

Namn	Beskrivning	Värde
eventHubs	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.	RoutingEventHubProperties[]
serviceBusQueues	Listan över Service Bus-köslutpunkter som IoT Hub dirigerar meddelandena till, baserat på routningsreglerna.	RoutingServiceBusQueueEndpointProperties[]
serviceBusTopics	Listan över Service Bus-ämnesslutpunkter som IoT-hubben dirigerar meddelandena till, baserat på routningsreglerna.	RoutingServiceBusTopicEndpointProperties[]
storageContainers	Listan över lagringscontainerslutpunkter som IoT Hub dirigerar meddelanden till, baserat på routningsreglerna.	RoutingStorageContainerProperties[]

RoutingEventHubProperties

Namn	Beskrivning	Värde
authenticationType	Metod som används för att autentisera mot händelsehubbens slutpunkt	"IdentityBased" "keyBased"
connectionString	Anslutningssträngen för händelsehubbens slutpunkt.	sträng
endpointUri	URL:en för händelsehubbens slutpunkt. Det måste innehålla protokollet sb://	sträng
entityPath	Namn på händelsehubb på händelsehubbens namnområde	sträng
Id	ID för händelsehubbens slutpunkt	sträng
Namn	Namnet som identifierar den här slutpunkten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, fileNotifications $default. Slutpunktsnamn måste vara unika mellan slutpunktstyper.	sträng Begränsningar: Mönster = `^[A-Za-z0-9-._]{1,64}$` (krävs)
resourceGroup	Namnet på resursgruppen för händelsehubbens slutpunkt.	sträng
subscriptionId	Prenumerationsidentifieraren för händelsehubbens slutpunkt.	sträng

RoutningEgenskaper

Namn	Beskrivning	Värde
Slutpunkter	Egenskaperna som är relaterade till de anpassade slutpunkter som din IoT Hub dirigerar meddelanden 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.	RoutingEndpoints
berikningar	Listan över berikanden från användare som IoT-hubben gäller för meddelanden som ska levereras till inbyggda och anpassade slutpunkter. Se: https://aka.ms/telemetryoneventgrid	EnrichmentProperties[]
fallbackRoute	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" uppfylls. 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.	FallbackRouteProperties
Vägar	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.	RouteProperties[]

RoutingServiceBusQueueEndpointProperties

Namn	Beskrivning	Värde
authenticationType	Metod som används för att autentisera mot service bus-köslutpunkten	"IdentityBased" "keyBased"
connectionString	Anslutningssträngen för service bus-köslutpunkten.	sträng
endpointUri	URL:en för service bus-köslutpunkten. Det måste innehålla protokollet sb://	sträng
entityPath	Könamn på Service Bus-namnområdet	sträng
Id	ID för service bus-köslutpunkten	sträng
Namn	Namnet som identifierar den här slutpunkten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, fileNotifications $default. Slutpunktsnamn måste vara unika mellan slutpunktstyper. Namnet behöver inte vara samma som det faktiska könamnet.	sträng Begränsningar: Mönster = `^[A-Za-z0-9-._]{1,64}$` (krävs)
resourceGroup	Namnet på resursgruppen för service bus-köslutpunkten.	sträng
subscriptionId	Prenumerationsidentifieraren för service bus-köslutpunkten.	sträng

RoutingServiceBusTopicEndpointProperties

Namn	Beskrivning	Värde
authenticationType	Metod som används för att autentisera mot service bus-ämnesslutpunkten	"IdentityBased" "keyBased"
connectionString	Anslutningssträngen för service bus-ämnesslutpunkten.	sträng
endpointUri	URL:en för service bus-ämnesslutpunkten. Det måste innehålla protokollet sb://	sträng
entityPath	Könamn för service bus-ämnet	sträng
Id	ID för service bus-ämnesslutpunkten	sträng
Namn	Namnet som identifierar den här slutpunkten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, fileNotifications $default. Slutpunktsnamn måste vara unika mellan slutpunktstyper. Namnet behöver inte vara samma som det faktiska ämnesnamnet.	sträng Begränsningar: Mönster = `^[A-Za-z0-9-._]{1,64}$` (krävs)
resourceGroup	Namnet på resursgruppen för service bus-ämnesslutpunkten.	sträng
subscriptionId	Prenumerationsidentifieraren för service bus-ämnesslutpunkten.	sträng

RoutingStorageContainerProperties

Namn	Beskrivning	Värde
authenticationType	Metod som används för att autentisera mot lagringsslutpunkten	"IdentityBased" "keyBased"
batchFrequencyInSeconds	Tidsintervall med vilket blobar skrivs till lagring. Värdet ska vara mellan 60 och 720 sekunder. Standardvärdet är 300 sekunder.	Int Begränsningar: Minsta värde = 60 Maxvärde = 720
connectionString	Anslutningssträngen för lagringskontot.	sträng
containerName	Namnet på lagringscontainern i lagringskontot.	sträng (krävs)
kodning	Kodning som används för att serialisera meddelanden till blobar. Värden som stöds är "avro", "avrodeflate" och "JSON". Standardvärdet är "avro".	"Avro" "AvroDeflate" "JSON"
endpointUri	Url:en för lagringsslutpunkten. Det måste innehålla protokollet https://	sträng
fileNameFormat	Filnamnsformat för bloben. Standardformatet är {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. Alla parametrar är obligatoriska men kan ordnas om.	sträng
Id	ID för lagringscontainerns slutpunkt	sträng
maxChunkSizeInBytes	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).	Int Begränsningar: Minsta värde = 10485760 Maxvärde = 524288000
Namn	Namnet som identifierar den här slutpunkten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, fileNotifications $default. Slutpunktsnamn måste vara unika mellan slutpunktstyper.	sträng Begränsningar: Mönster = `^[A-Za-z0-9-._]{1,64}$` (krävs)
resourceGroup	Namnet på resursgruppen för lagringskontot.	sträng
subscriptionId	Prenumerationsidentifieraren för lagringskontot.	sträng

SharedAccessSignatureAuthorizationRule

Namn	Beskrivning	Värde
keyName	Namnet på principen för delad åtkomst.	sträng (krävs)
primaryKey	Primärnyckeln.	sträng
rättigheter	De behörigheter som tilldelats principen för delad åtkomst.	"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" (krävs)
secondaryKey	Den sekundära nyckeln.	sträng

StorageEndpointProperties

Namn	Beskrivning	Värde
authenticationType	Anger autentiseringstyp som används för att ansluta till lagringskontot.	"IdentityBased" "keyBased"
connectionString	Anslutningssträngen för Det Azure Storage-konto som filerna laddas upp till.	sträng (krävs)
containerName	Namnet på rotcontainern där du laddar upp filer. Containern behöver inte finnas men bör vara kreatabell med hjälp av den angivna connectionString.the container need not exist but should be creatable using the connectionString specified.	sträng (krävs)
sasTtlAsIso8601	Den tidsperiod för vilken SAS-URI:n som genererats av IoT Hub för filuppladdning är giltig. Se: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.	sträng

Snabbstartsexempel

Följande snabbstartsexempel distribuerar den här resurstypen.

Bicep-fil	Beskrivning
Skapa en IoT Hub och en enhet till molnkonsumentgrupp	Med den här mallen kan du distribuera en IoT Hub-instans med enheten till molnet och molnet till enhetsmeddelandekonfigurationer och en enhet till molnkonsumentgruppen.
Skapa en IoT Hub Device Provisioning-tjänst	Med den här mallen kan du skapa en IoT-hubb och en IoT Hub Device Provisioning-tjänst och länka ihop de två tjänsterna.
Skapa enhetsuppdatering för IoT Hub-konto, instans, IoT Hub-	Den här mallen skapar ett konto, en instans och en hubb att länka instansen med. Den konfigurerar hubben med nödvändiga åtkomstprinciper, vägar och konsumentgrupper.
Distribuera MedTech-tjänsten, inklusive en Azure IoT Hub-	MedTech-tjänsten är en av Azure Health Data Services som är utformad för att mata in enhetsdata från flera enheter, omvandla enhetsdata till FHIR-observationer, som sedan sparas i Azure Health Data Services FHIR-tjänsten.
Använd ARM-mall för att skapa IoT Hub, dirigera och visa meddelanden	Använd den här mallen för att distribuera en IoT Hub och ett lagringskonto. Kör en app för att skicka meddelanden till den hubb som dirigeras till lagringen och visa sedan resultatet.

Resursdefinition för ARM-mall

Resurstypen IotHubs kan distribueras med åtgärder som mål:

Resursgrupper – Se resursgruppsdistributionskommandon

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Devices/IotHubs-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.Devices/IotHubs",
  "apiVersion": "2020-08-01",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string"
      }
    ],
    "cloudToDevice": {
      "defaultTtlAsIso8601": "string",
      "feedback": {
        "lockDurationAsIso8601": "string",
        "maxDeliveryCount": "int",
        "ttlAsIso8601": "string"
      },
      "maxDeliveryCount": "int"
    },
    "comments": "string",
    "enableFileUploadNotifications": "bool",
    "eventHubEndpoints": {
      "{customized property}": {
        "partitionCount": "int",
        "retentionTimeInDays": "int"
      }
    },
    "features": "string",
    "ipFilterRules": [
      {
        "action": "string",
        "filterName": "string",
        "ipMask": "string"
      }
    ],
    "messagingEndpoints": {
      "{customized property}": {
        "lockDurationAsIso8601": "string",
        "maxDeliveryCount": "int",
        "ttlAsIso8601": "string"
      }
    },
    "minTlsVersion": "string",
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
          },
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "publicNetworkAccess": "string",
    "routing": {
      "endpoints": {
        "eventHubs": [
          {
            "authenticationType": "string",
            "connectionString": "string",
            "endpointUri": "string",
            "entityPath": "string",
            "id": "string",
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "serviceBusQueues": [
          {
            "authenticationType": "string",
            "connectionString": "string",
            "endpointUri": "string",
            "entityPath": "string",
            "id": "string",
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "serviceBusTopics": [
          {
            "authenticationType": "string",
            "connectionString": "string",
            "endpointUri": "string",
            "entityPath": "string",
            "id": "string",
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "storageContainers": [
          {
            "authenticationType": "string",
            "batchFrequencyInSeconds": "int",
            "connectionString": "string",
            "containerName": "string",
            "encoding": "string",
            "endpointUri": "string",
            "fileNameFormat": "string",
            "id": "string",
            "maxChunkSizeInBytes": "int",
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ]
      },
      "enrichments": [
        {
          "endpointNames": [ "string" ],
          "key": "string",
          "value": "string"
        }
      ],
      "fallbackRoute": {
        "condition": "string",
        "endpointNames": [ "string" ],
        "isEnabled": "bool",
        "name": "string",
        "source": "string"
      },
      "routes": [
        {
          "condition": "string",
          "endpointNames": [ "string" ],
          "isEnabled": "bool",
          "name": "string",
          "source": "string"
        }
      ]
    },
    "storageEndpoints": {
      "{customized property}": {
        "authenticationType": "string",
        "connectionString": "string",
        "containerName": "string",
        "sasTtlAsIso8601": "string"
      }
    }
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Egenskapsvärden

CloudToDeviceProperties

Namn	Beskrivning	Värde
defaultTtlAsIso8601	Standardtiden för att leva för meddelanden från moln till enhet i enhetskön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	sträng
feedback	Egenskaperna för feedbackkön för meddelanden från moln till enhet.	FeedbackEgenskaper
maxDeliveryCount	Det maximala leveransantalet för meddelanden från moln till enhet i enhetskön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Begränsningar: Minsta värde = 1 Maxvärde = 100

EnrichmentProperties

Namn	Beskrivning	Värde
endpointNames	Listan över slutpunkter för vilka berikningen tillämpas på meddelandet.	string[] (krävs)
nyckel	Nyckeln eller namnet på berikningsegenskapen.	sträng (krävs)
värde	Värdet för berikningsegenskapen.	sträng (krävs)

EventHubProperties

Namn	Beskrivning	Värde
partitionCount	Antalet partitioner för att ta emot meddelanden från enhet till moln i den Event Hub-kompatibla slutpunkten. Se: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.	Int
retentionTimeInDays	Kvarhållningstiden för meddelanden från enhet till moln i dagar. Se: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	Int

FallbackRouteProperties

Namn	Beskrivning	Värde
tillstånd	Villkoret som utvärderas för att tillämpa återställningsvägen. Om villkoret inte anges utvärderas det som sant som standard. För grammatik, se: /azure/iot-hub/iot-hub-devguide-query-language	sträng
endpointNames	Listan över slutpunkter som meddelandena som uppfyller villkoret dirigeras till. För närvarande tillåts endast en slutpunkt.	string[] (krävs)
isEnabled	Används för att ange om återställningsvägen är aktiverad.	bool (krävs)
Namn	Namnet på vägen. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck, har en maximal längd på 64 tecken och måste vara unikt.	sträng
källa	Den källa som routningsregeln ska tillämpas på. Till exempel DeviceMessages	"DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "Ogiltigt" "TwinChangeEvents" (krävs)

FeedbackEgenskaper

Namn	Beskrivning	Värde
lockDurationAsIso8601	Låsvaraktigheten för feedbackkön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	sträng
maxDeliveryCount	Antalet gånger som IoT-hubben försöker leverera ett meddelande i feedbackkön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Begränsningar: Minsta värde = 1 Maxvärde = 100
ttlAsIso8601	Den tidsperiod för vilken ett meddelande är tillgängligt för användning innan det har upphört att gälla av IoT-hubben. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	sträng

IotHubProperties

Namn	Beskrivning	Värde
authorizationPolicies	De principer för delad åtkomst som du kan använda för att skydda en anslutning till IoT-hubben.	SharedAccessSignatureAuthorizationRule[]
cloudToDevice	Meddelandeegenskaperna för IoT Hub från moln till enhet.	CloudToDeviceProperties
Kommentarer	IoT Hub-kommentarer.	sträng
enableFileUploadNotifications	Om Sant aktiveras meddelanden om filuppladdning.	Bool
eventHubEndpoints	De Event Hub-kompatibla slutpunktsegenskaperna. De enda möjliga nycklarna till den här ordlistan är händelser. Den här nyckeln måste finnas i ordlistan när du skapar eller uppdaterar anrop för IoT-hubben.	IotHubPropertiesEventHubEndpoints
Funktioner	Funktionerna och funktionerna som är aktiverade för IoT-hubben.	"DeviceManagement" "Ingen"
ipFilterRules	IP-filterreglerna.	IpFilterRule[]
messagingEndpoints	Egenskaperna för meddelandeslutpunkten för meddelandekön för filuppladdning.	IotHubPropertiesMessagingEndpoints
minTlsVersion	Anger den lägsta TLS-version som ska stödjas för den här hubben. Kan anges till "1.2" så att klienter som använder en TLS-version under 1.2 avvisas.	sträng
privateEndpointConnections	Privata slutpunktsanslutningar som skapats på denna IotHub	PrivateEndpointConnection[]
publicNetworkAccess	Om begäranden från offentliga nätverk tillåts	"Inaktiverad" "Aktiverad"
Routning	Routningsrelaterade egenskaper för IoT-hubben. Se: /azure/iot-hub/iot-hub-devguide-messaging	RoutingEgenskaper
storageEndpoints	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 som 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 True utlöses ett fel.	IotHubPropertiesStorageEndpoints

IotHubPropertiesEventHubEndpoints

Namn	Beskrivning	Värde

IotHubPropertiesMessagingEndpoints

Namn	Beskrivning	Värde

IotHubPropertiesStorageEndpoints

Namn	Beskrivning	Värde

IotHubSkuInfo

Namn	Beskrivning	Värde
kapacitet	Antalet etablerade IoT Hub-enheter. Se: /azure/azure-subscription-service-limits#iot-hub-limits.	Int
Namn	Namnet på SKU:n.	"B1" "B2" "B3" "F1" "S1" "S2" "S3" (krävs)

IpFilterRule

Namn	Beskrivning	Värde
handling	Önskad åtgärd för begäranden som samlas in av den här regeln.	"Acceptera" "Avvisa" (krävs)
filterName	Namnet på IP-filterregeln.	sträng (krävs)
ipMask	En sträng som innehåller IP-adressintervallet i CIDR-notationen för regeln.	sträng (krävs)

MessagingEndpointProperties

Namn	Beskrivning	Värde
lockDurationAsIso8601	Låsets varaktighet. Se: /azure/iot-hub/iot-hub-devguide-file-upload.	sträng
maxDeliveryCount	Antalet gånger som IoT-hubben försöker leverera ett meddelande. Se: /azure/iot-hub/iot-hub-devguide-file-upload.	Int Begränsningar: Minsta värde = 1 Maxvärde = 100
ttlAsIso8601	Den tidsperiod för vilken ett meddelande är tillgängligt för användning innan det har upphört att gälla av IoT-hubben. Se: /azure/iot-hub/iot-hub-devguide-file-upload.	sträng

Microsoft.Devices/IotHubs

Namn	Beskrivning	Värde
apiVersion	API-versionen	'2020-08-01'
etag	Fältet Etag är inte krävs. Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen.	sträng
plats	Resursplatsen.	sträng (krävs)
Namn	Resursnamnet	sträng (krävs)
Egenskaper	IotHub-egenskaper	IotHubProperties
Sku	IotHub SKU-information	IotHubSkuInfo (krävs)
Taggar	Resurstaggar	Ordlista med taggnamn och värden. Se taggar i mallar
typ	Resurstypen	"Microsoft.Devices/IotHubs"

PrivateEndpoint

Namn	Beskrivning	Värde

PrivateEndpointConnection

Namn	Beskrivning	Värde
Egenskaper	Egenskaperna för en privat slutpunktsanslutning	PrivateEndpointConnectionProperties (krävs)

PrivateEndpointConnectionProperties

Namn	Beskrivning	Värde
privateEndpoint	Egenskapen privat slutpunkt för en privat slutpunktsanslutning	PrivateEndpoint
privateLinkServiceConnectionState	Det aktuella tillståndet för en privat slutpunktsanslutning	PrivateLinkServiceConnectionState (krävs)

PrivateLinkServiceConnectionState

Namn	Beskrivning	Värde
actionsRequired	Åtgärder som krävs för en privat slutpunktsanslutning	sträng
beskrivning	Beskrivningen av det aktuella tillståndet för en privat slutpunktsanslutning	sträng (krävs)
status	Status för en privat slutpunktsanslutning	"Godkänd" "Frånkopplad" "Väntar" "Avvisad" (krävs)

ResourceTags

Namn	Beskrivning	Värde

RouteProperties

Namn	Beskrivning	Värde
tillstånd	Villkoret som utvärderas för att tillämpa routningsregeln. Om inget villkor anges utvärderas det som sant som standard. Grammatik finns i: /azure/iot-hub/iot-hub-devguide-query-language	sträng
endpointNames	Listan över slutpunkter till vilka meddelanden som uppfyller villkoret dirigeras. För närvarande tillåts endast en slutpunkt.	string[] (krävs)
isEnabled	Används för att ange om en väg är aktiverad.	bool (krävs)
Namn	Namnet på vägen. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck, har en maximal längd på 64 tecken och måste vara unikt.	sträng Begränsningar: Mönster = `^[A-Za-z0-9-._]{1,64}$` (krävs)
källa	Den källa som routningsregeln ska tillämpas på, till exempel DeviceMessages.	"DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "Ogiltigt" "TwinChangeEvents" (krävs)

RoutingEndpoints

Namn	Beskrivning	Värde
eventHubs	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.	RoutingEventHubProperties[]
serviceBusQueues	Listan över Service Bus-köslutpunkter som IoT Hub dirigerar meddelandena till, baserat på routningsreglerna.	RoutingServiceBusQueueEndpointProperties[]
serviceBusTopics	Listan över Service Bus-ämnesslutpunkter som IoT-hubben dirigerar meddelandena till, baserat på routningsreglerna.	RoutingServiceBusTopicEndpointProperties[]
storageContainers	Listan över lagringscontainerslutpunkter som IoT Hub dirigerar meddelanden till, baserat på routningsreglerna.	RoutingStorageContainerProperties[]

RoutingEventHubProperties

Namn	Beskrivning	Värde
authenticationType	Metod som används för att autentisera mot händelsehubbens slutpunkt	"IdentityBased" "keyBased"
connectionString	Anslutningssträngen för händelsehubbens slutpunkt.	sträng
endpointUri	URL:en för händelsehubbens slutpunkt. Det måste innehålla protokollet sb://	sträng
entityPath	Namn på händelsehubb på händelsehubbens namnområde	sträng
Id	ID för händelsehubbens slutpunkt	sträng
Namn	Namnet som identifierar den här slutpunkten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, fileNotifications $default. Slutpunktsnamn måste vara unika mellan slutpunktstyper.	sträng Begränsningar: Mönster = `^[A-Za-z0-9-._]{1,64}$` (krävs)
resourceGroup	Namnet på resursgruppen för händelsehubbens slutpunkt.	sträng
subscriptionId	Prenumerationsidentifieraren för händelsehubbens slutpunkt.	sträng

RoutningEgenskaper

Namn	Beskrivning	Värde
Slutpunkter	Egenskaperna som är relaterade till de anpassade slutpunkter som din IoT Hub dirigerar meddelanden 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.	RoutingEndpoints
berikningar	Listan över berikanden från användare som IoT-hubben gäller för meddelanden som ska levereras till inbyggda och anpassade slutpunkter. Se: https://aka.ms/telemetryoneventgrid	EnrichmentProperties[]
fallbackRoute	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" uppfylls. 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.	FallbackRouteProperties
Vägar	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.	RouteProperties[]

RoutingServiceBusQueueEndpointProperties

Namn	Beskrivning	Värde
authenticationType	Metod som används för att autentisera mot service bus-köslutpunkten	"IdentityBased" "keyBased"
connectionString	Anslutningssträngen för service bus-köslutpunkten.	sträng
endpointUri	URL:en för service bus-köslutpunkten. Det måste innehålla protokollet sb://	sträng
entityPath	Könamn på Service Bus-namnområdet	sträng
Id	ID för service bus-köslutpunkten	sträng
Namn	Namnet som identifierar den här slutpunkten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, fileNotifications $default. Slutpunktsnamn måste vara unika mellan slutpunktstyper. Namnet behöver inte vara samma som det faktiska könamnet.	sträng Begränsningar: Mönster = `^[A-Za-z0-9-._]{1,64}$` (krävs)
resourceGroup	Namnet på resursgruppen för service bus-köslutpunkten.	sträng
subscriptionId	Prenumerationsidentifieraren för service bus-köslutpunkten.	sträng

RoutingServiceBusTopicEndpointProperties

Namn	Beskrivning	Värde
authenticationType	Metod som används för att autentisera mot service bus-ämnesslutpunkten	"IdentityBased" "keyBased"
connectionString	Anslutningssträngen för service bus-ämnesslutpunkten.	sträng
endpointUri	URL:en för service bus-ämnesslutpunkten. Det måste innehålla protokollet sb://	sträng
entityPath	Könamn för service bus-ämnet	sträng
Id	ID för service bus-ämnesslutpunkten	sträng
Namn	Namnet som identifierar den här slutpunkten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, fileNotifications $default. Slutpunktsnamn måste vara unika mellan slutpunktstyper. Namnet behöver inte vara samma som det faktiska ämnesnamnet.	sträng Begränsningar: Mönster = `^[A-Za-z0-9-._]{1,64}$` (krävs)
resourceGroup	Namnet på resursgruppen för service bus-ämnesslutpunkten.	sträng
subscriptionId	Prenumerationsidentifieraren för service bus-ämnesslutpunkten.	sträng

RoutingStorageContainerProperties

Namn	Beskrivning	Värde
authenticationType	Metod som används för att autentisera mot lagringsslutpunkten	"IdentityBased" "keyBased"
batchFrequencyInSeconds	Tidsintervall med vilket blobar skrivs till lagring. Värdet ska vara mellan 60 och 720 sekunder. Standardvärdet är 300 sekunder.	Int Begränsningar: Minsta värde = 60 Maxvärde = 720
connectionString	Anslutningssträngen för lagringskontot.	sträng
containerName	Namnet på lagringscontainern i lagringskontot.	sträng (krävs)
kodning	Kodning som används för att serialisera meddelanden till blobar. Värden som stöds är "avro", "avrodeflate" och "JSON". Standardvärdet är "avro".	"Avro" "AvroDeflate" "JSON"
endpointUri	Url:en för lagringsslutpunkten. Det måste innehålla protokollet https://	sträng
fileNameFormat	Filnamnsformat för bloben. Standardformatet är {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. Alla parametrar är obligatoriska men kan ordnas om.	sträng
Id	ID för lagringscontainerns slutpunkt	sträng
maxChunkSizeInBytes	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).	Int Begränsningar: Minsta värde = 10485760 Maxvärde = 524288000
Namn	Namnet som identifierar den här slutpunkten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, fileNotifications $default. Slutpunktsnamn måste vara unika mellan slutpunktstyper.	sträng Begränsningar: Mönster = `^[A-Za-z0-9-._]{1,64}$` (krävs)
resourceGroup	Namnet på resursgruppen för lagringskontot.	sträng
subscriptionId	Prenumerationsidentifieraren för lagringskontot.	sträng

SharedAccessSignatureAuthorizationRule

Namn	Beskrivning	Värde
keyName	Namnet på principen för delad åtkomst.	sträng (krävs)
primaryKey	Primärnyckeln.	sträng
rättigheter	De behörigheter som tilldelats principen för delad åtkomst.	"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" (krävs)
secondaryKey	Den sekundära nyckeln.	sträng

StorageEndpointProperties

Namn	Beskrivning	Värde
authenticationType	Anger autentiseringstyp som används för att ansluta till lagringskontot.	"IdentityBased" "keyBased"
connectionString	Anslutningssträngen för Det Azure Storage-konto som filerna laddas upp till.	sträng (krävs)
containerName	Namnet på rotcontainern där du laddar upp filer. Containern behöver inte finnas men bör vara kreatabell med hjälp av den angivna connectionString.the container need not exist but should be creatable using the connectionString specified.	sträng (krävs)
sasTtlAsIso8601	Den tidsperiod för vilken SAS-URI:n som genererats av IoT Hub för filuppladdning är giltig. Se: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.	sträng

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall	Beskrivning
Skapa en PAYG-miljö (Betala per användning) med en IoT Hub-	Med den här mallen kan du distribuera en Pay As You Go-miljö (PAYG) Time Series Insights som är konfigurerad för att använda händelser från en IoT Hub.
Skapa en IoT Hub och en enhet till molnkonsumentgrupp	Med den här mallen kan du distribuera en IoT Hub-instans med enheten till molnet och molnet till enhetsmeddelandekonfigurationer och en enhet till molnkonsumentgruppen.
Skapa en IOT Hub- och Ubuntu-kantsimulator	Den här mallen skapar en IOT Hub- och Virtual Machine Ubuntu edge-simulator.
Skapa en IoT Hub Device Provisioning-tjänst	Med den här mallen kan du skapa en IoT-hubb och en IoT Hub Device Provisioning-tjänst och länka ihop de två tjänsterna.
Skapa enhetsuppdatering för IoT Hub-konto, instans, IoT Hub-	Den här mallen skapar ett konto, en instans och en hubb att länka instansen med. Den konfigurerar hubben med nödvändiga åtkomstprinciper, vägar och konsumentgrupper.
Distribuera MedTech-tjänsten, inklusive en Azure IoT Hub-	MedTech-tjänsten är en av Azure Health Data Services som är utformad för att mata in enhetsdata från flera enheter, omvandla enhetsdata till FHIR-observationer, som sedan sparas i Azure Health Data Services FHIR-tjänsten.
Använd ARM-mall för att skapa IoT Hub, dirigera och visa meddelanden	Använd den här mallen för att distribuera en IoT Hub och ett lagringskonto. Kör en app för att skicka meddelanden till den hubb som dirigeras till lagringen och visa sedan resultatet.

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen IotHubs kan distribueras med åtgärder som mål:

Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Devices/IotHubs-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/IotHubs@2020-08-01"
  name = "string"
  etag = "string"
  location = "string"
  body = jsonencode({
    properties = {
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
        }
      ]
      cloudToDevice = {
        defaultTtlAsIso8601 = "string"
        feedback = {
          lockDurationAsIso8601 = "string"
          maxDeliveryCount = int
          ttlAsIso8601 = "string"
        }
        maxDeliveryCount = int
      }
      comments = "string"
      enableFileUploadNotifications = bool
      eventHubEndpoints = {
        {customized property} = {
          partitionCount = int
          retentionTimeInDays = int
        }
      }
      features = "string"
      ipFilterRules = [
        {
          action = "string"
          filterName = "string"
          ipMask = "string"
        }
      ]
      messagingEndpoints = {
        {customized property} = {
          lockDurationAsIso8601 = "string"
          maxDeliveryCount = int
          ttlAsIso8601 = "string"
        }
      }
      minTlsVersion = "string"
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {
            }
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      publicNetworkAccess = "string"
      routing = {
        endpoints = {
          eventHubs = [
            {
              authenticationType = "string"
              connectionString = "string"
              endpointUri = "string"
              entityPath = "string"
              id = "string"
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          serviceBusQueues = [
            {
              authenticationType = "string"
              connectionString = "string"
              endpointUri = "string"
              entityPath = "string"
              id = "string"
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          serviceBusTopics = [
            {
              authenticationType = "string"
              connectionString = "string"
              endpointUri = "string"
              entityPath = "string"
              id = "string"
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          storageContainers = [
            {
              authenticationType = "string"
              batchFrequencyInSeconds = int
              connectionString = "string"
              containerName = "string"
              encoding = "string"
              endpointUri = "string"
              fileNameFormat = "string"
              id = "string"
              maxChunkSizeInBytes = int
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
        }
        enrichments = [
          {
            endpointNames = [
              "string"
            ]
            key = "string"
            value = "string"
          }
        ]
        fallbackRoute = {
          condition = "string"
          endpointNames = [
            "string"
          ]
          isEnabled = bool
          name = "string"
          source = "string"
        }
        routes = [
          {
            condition = "string"
            endpointNames = [
              "string"
            ]
            isEnabled = bool
            name = "string"
            source = "string"
          }
        ]
      }
      storageEndpoints = {
        {customized property} = {
          authenticationType = "string"
          connectionString = "string"
          containerName = "string"
          sasTtlAsIso8601 = "string"
        }
      }
    }
  })
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
}

Egenskapsvärden

CloudToDeviceProperties

Namn	Beskrivning	Värde
defaultTtlAsIso8601	Standardtiden för att leva för meddelanden från moln till enhet i enhetskön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	sträng
feedback	Egenskaperna för feedbackkön för meddelanden från moln till enhet.	FeedbackEgenskaper
maxDeliveryCount	Det maximala leveransantalet för meddelanden från moln till enhet i enhetskön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Begränsningar: Minsta värde = 1 Maxvärde = 100

EnrichmentProperties

Namn	Beskrivning	Värde
endpointNames	Listan över slutpunkter för vilka berikningen tillämpas på meddelandet.	string[] (krävs)
nyckel	Nyckeln eller namnet på berikningsegenskapen.	sträng (krävs)
värde	Värdet för berikningsegenskapen.	sträng (krävs)

EventHubProperties

Namn	Beskrivning	Värde
partitionCount	Antalet partitioner för att ta emot meddelanden från enhet till moln i den Event Hub-kompatibla slutpunkten. Se: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.	Int
retentionTimeInDays	Kvarhållningstiden för meddelanden från enhet till moln i dagar. Se: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	Int

FallbackRouteProperties

Namn	Beskrivning	Värde
tillstånd	Villkoret som utvärderas för att tillämpa återställningsvägen. Om villkoret inte anges utvärderas det som sant som standard. För grammatik, se: /azure/iot-hub/iot-hub-devguide-query-language	sträng
endpointNames	Listan över slutpunkter som meddelandena som uppfyller villkoret dirigeras till. För närvarande tillåts endast en slutpunkt.	string[] (krävs)
isEnabled	Används för att ange om återställningsvägen är aktiverad.	bool (krävs)
Namn	Namnet på vägen. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck, har en maximal längd på 64 tecken och måste vara unikt.	sträng
källa	Den källa som routningsregeln ska tillämpas på. Till exempel DeviceMessages	"DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "Ogiltigt" "TwinChangeEvents" (krävs)

FeedbackEgenskaper

Namn	Beskrivning	Värde
lockDurationAsIso8601	Låsvaraktigheten för feedbackkön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	sträng
maxDeliveryCount	Antalet gånger som IoT-hubben försöker leverera ett meddelande i feedbackkön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Begränsningar: Minsta värde = 1 Maxvärde = 100
ttlAsIso8601	Den tidsperiod för vilken ett meddelande är tillgängligt för användning innan det har upphört att gälla av IoT-hubben. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	sträng

IotHubProperties

Namn	Beskrivning	Värde
authorizationPolicies	De principer för delad åtkomst som du kan använda för att skydda en anslutning till IoT-hubben.	SharedAccessSignatureAuthorizationRule[]
cloudToDevice	Meddelandeegenskaperna för IoT Hub från moln till enhet.	CloudToDeviceProperties
Kommentarer	IoT Hub-kommentarer.	sträng
enableFileUploadNotifications	Om Sant aktiveras meddelanden om filuppladdning.	Bool
eventHubEndpoints	De Event Hub-kompatibla slutpunktsegenskaperna. De enda möjliga nycklarna till den här ordlistan är händelser. Den här nyckeln måste finnas i ordlistan när du skapar eller uppdaterar anrop för IoT-hubben.	IotHubPropertiesEventHubEndpoints
Funktioner	Funktionerna och funktionerna som är aktiverade för IoT-hubben.	"DeviceManagement" "Ingen"
ipFilterRules	IP-filterreglerna.	IpFilterRule[]
messagingEndpoints	Egenskaperna för meddelandeslutpunkten för meddelandekön för filuppladdning.	IotHubPropertiesMessagingEndpoints
minTlsVersion	Anger den lägsta TLS-version som ska stödjas för den här hubben. Kan anges till "1.2" så att klienter som använder en TLS-version under 1.2 avvisas.	sträng
privateEndpointConnections	Privata slutpunktsanslutningar som skapats på denna IotHub	PrivateEndpointConnection[]
publicNetworkAccess	Om begäranden från offentliga nätverk tillåts	"Inaktiverad" "Aktiverad"
Routning	Routningsrelaterade egenskaper för IoT-hubben. Se: /azure/iot-hub/iot-hub-devguide-messaging	RoutingEgenskaper
storageEndpoints	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 som 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 True utlöses ett fel.	IotHubPropertiesStorageEndpoints

IotHubPropertiesEventHubEndpoints

Namn	Beskrivning	Värde

IotHubPropertiesMessagingEndpoints

Namn	Beskrivning	Värde

IotHubPropertiesStorageEndpoints

Namn	Beskrivning	Värde

IotHubSkuInfo

Namn	Beskrivning	Värde
kapacitet	Antalet etablerade IoT Hub-enheter. Se: /azure/azure-subscription-service-limits#iot-hub-limits.	Int
Namn	Namnet på SKU:n.	"B1" "B2" "B3" "F1" "S1" "S2" "S3" (krävs)

IpFilterRule

Namn	Beskrivning	Värde
handling	Önskad åtgärd för begäranden som samlas in av den här regeln.	"Acceptera" "Avvisa" (krävs)
filterName	Namnet på IP-filterregeln.	sträng (krävs)
ipMask	En sträng som innehåller IP-adressintervallet i CIDR-notationen för regeln.	sträng (krävs)

MessagingEndpointProperties

Namn	Beskrivning	Värde
lockDurationAsIso8601	Låsets varaktighet. Se: /azure/iot-hub/iot-hub-devguide-file-upload.	sträng
maxDeliveryCount	Antalet gånger som IoT-hubben försöker leverera ett meddelande. Se: /azure/iot-hub/iot-hub-devguide-file-upload.	Int Begränsningar: Minsta värde = 1 Maxvärde = 100
ttlAsIso8601	Den tidsperiod för vilken ett meddelande är tillgängligt för användning innan det har upphört att gälla av IoT-hubben. Se: /azure/iot-hub/iot-hub-devguide-file-upload.	sträng

Microsoft.Devices/IotHubs

Namn	Beskrivning	Värde
etag	Fältet Etag är inte krävs. Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen.	sträng
plats	Resursplatsen.	sträng (krävs)
Namn	Resursnamnet	sträng (krävs)
Egenskaper	IotHub-egenskaper	IotHubProperties
Sku	IotHub SKU-information	IotHubSkuInfo (krävs)
Taggar	Resurstaggar	Ordlista med taggnamn och värden.
typ	Resurstypen	"Microsoft.Devices/IotHubs@2020-08-01"

PrivateEndpoint

Namn	Beskrivning	Värde

PrivateEndpointConnection

Namn	Beskrivning	Värde
Egenskaper	Egenskaperna för en privat slutpunktsanslutning	PrivateEndpointConnectionProperties (krävs)

PrivateEndpointConnectionProperties

Namn	Beskrivning	Värde
privateEndpoint	Egenskapen privat slutpunkt för en privat slutpunktsanslutning	PrivateEndpoint
privateLinkServiceConnectionState	Det aktuella tillståndet för en privat slutpunktsanslutning	PrivateLinkServiceConnectionState (krävs)

PrivateLinkServiceConnectionState

Namn	Beskrivning	Värde
actionsRequired	Åtgärder som krävs för en privat slutpunktsanslutning	sträng
beskrivning	Beskrivningen av det aktuella tillståndet för en privat slutpunktsanslutning	sträng (krävs)
status	Status för en privat slutpunktsanslutning	"Godkänd" "Frånkopplad" "Väntar" "Avvisad" (krävs)

ResourceTags

Namn	Beskrivning	Värde

RouteProperties

Namn	Beskrivning	Värde
tillstånd	Villkoret som utvärderas för att tillämpa routningsregeln. Om inget villkor anges utvärderas det som sant som standard. Grammatik finns i: /azure/iot-hub/iot-hub-devguide-query-language	sträng
endpointNames	Listan över slutpunkter till vilka meddelanden som uppfyller villkoret dirigeras. För närvarande tillåts endast en slutpunkt.	string[] (krävs)
isEnabled	Används för att ange om en väg är aktiverad.	bool (krävs)
Namn	Namnet på vägen. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck, har en maximal längd på 64 tecken och måste vara unikt.	sträng Begränsningar: Mönster = `^[A-Za-z0-9-._]{1,64}$` (krävs)
källa	Den källa som routningsregeln ska tillämpas på, till exempel DeviceMessages.	"DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "Ogiltigt" "TwinChangeEvents" (krävs)

RoutingEndpoints

Namn	Beskrivning	Värde
eventHubs	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.	RoutingEventHubProperties[]
serviceBusQueues	Listan över Service Bus-köslutpunkter som IoT Hub dirigerar meddelandena till, baserat på routningsreglerna.	RoutingServiceBusQueueEndpointProperties[]
serviceBusTopics	Listan över Service Bus-ämnesslutpunkter som IoT-hubben dirigerar meddelandena till, baserat på routningsreglerna.	RoutingServiceBusTopicEndpointProperties[]
storageContainers	Listan över lagringscontainerslutpunkter som IoT Hub dirigerar meddelanden till, baserat på routningsreglerna.	RoutingStorageContainerProperties[]

RoutingEventHubProperties

Namn	Beskrivning	Värde
authenticationType	Metod som används för att autentisera mot händelsehubbens slutpunkt	"IdentityBased" "keyBased"
connectionString	Anslutningssträngen för händelsehubbens slutpunkt.	sträng
endpointUri	URL:en för händelsehubbens slutpunkt. Det måste innehålla protokollet sb://	sträng
entityPath	Namn på händelsehubb på händelsehubbens namnområde	sträng
Id	ID för händelsehubbens slutpunkt	sträng
Namn	Namnet som identifierar den här slutpunkten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, fileNotifications $default. Slutpunktsnamn måste vara unika mellan slutpunktstyper.	sträng Begränsningar: Mönster = `^[A-Za-z0-9-._]{1,64}$` (krävs)
resourceGroup	Namnet på resursgruppen för händelsehubbens slutpunkt.	sträng
subscriptionId	Prenumerationsidentifieraren för händelsehubbens slutpunkt.	sträng

RoutningEgenskaper

Namn	Beskrivning	Värde
Slutpunkter	Egenskaperna som är relaterade till de anpassade slutpunkter som din IoT Hub dirigerar meddelanden 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.	RoutingEndpoints
berikningar	Listan över berikanden från användare som IoT-hubben gäller för meddelanden som ska levereras till inbyggda och anpassade slutpunkter. Se: https://aka.ms/telemetryoneventgrid	EnrichmentProperties[]
fallbackRoute	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" uppfylls. 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.	FallbackRouteProperties
Vägar	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.	RouteProperties[]

RoutingServiceBusQueueEndpointProperties

Namn	Beskrivning	Värde
authenticationType	Metod som används för att autentisera mot service bus-köslutpunkten	"IdentityBased" "keyBased"
connectionString	Anslutningssträngen för service bus-köslutpunkten.	sträng
endpointUri	URL:en för service bus-köslutpunkten. Det måste innehålla protokollet sb://	sträng
entityPath	Könamn på Service Bus-namnområdet	sträng
Id	ID för service bus-köslutpunkten	sträng
Namn	Namnet som identifierar den här slutpunkten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, fileNotifications $default. Slutpunktsnamn måste vara unika mellan slutpunktstyper. Namnet behöver inte vara samma som det faktiska könamnet.	sträng Begränsningar: Mönster = `^[A-Za-z0-9-._]{1,64}$` (krävs)
resourceGroup	Namnet på resursgruppen för service bus-köslutpunkten.	sträng
subscriptionId	Prenumerationsidentifieraren för service bus-köslutpunkten.	sträng

RoutingServiceBusTopicEndpointProperties

Namn	Beskrivning	Värde
authenticationType	Metod som används för att autentisera mot service bus-ämnesslutpunkten	"IdentityBased" "keyBased"
connectionString	Anslutningssträngen för service bus-ämnesslutpunkten.	sträng
endpointUri	URL:en för service bus-ämnesslutpunkten. Det måste innehålla protokollet sb://	sträng
entityPath	Könamn för service bus-ämnet	sträng
Id	ID för service bus-ämnesslutpunkten	sträng
Namn	Namnet som identifierar den här slutpunkten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, fileNotifications $default. Slutpunktsnamn måste vara unika mellan slutpunktstyper. Namnet behöver inte vara samma som det faktiska ämnesnamnet.	sträng Begränsningar: Mönster = `^[A-Za-z0-9-._]{1,64}$` (krävs)
resourceGroup	Namnet på resursgruppen för service bus-ämnesslutpunkten.	sträng
subscriptionId	Prenumerationsidentifieraren för service bus-ämnesslutpunkten.	sträng

RoutingStorageContainerProperties

Namn	Beskrivning	Värde
authenticationType	Metod som används för att autentisera mot lagringsslutpunkten	"IdentityBased" "keyBased"
batchFrequencyInSeconds	Tidsintervall med vilket blobar skrivs till lagring. Värdet ska vara mellan 60 och 720 sekunder. Standardvärdet är 300 sekunder.	Int Begränsningar: Minsta värde = 60 Maxvärde = 720
connectionString	Anslutningssträngen för lagringskontot.	sträng
containerName	Namnet på lagringscontainern i lagringskontot.	sträng (krävs)
kodning	Kodning som används för att serialisera meddelanden till blobar. Värden som stöds är "avro", "avrodeflate" och "JSON". Standardvärdet är "avro".	"Avro" "AvroDeflate" "JSON"
endpointUri	Url:en för lagringsslutpunkten. Det måste innehålla protokollet https://	sträng
fileNameFormat	Filnamnsformat för bloben. Standardformatet är {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. Alla parametrar är obligatoriska men kan ordnas om.	sträng
Id	ID för lagringscontainerns slutpunkt	sträng
maxChunkSizeInBytes	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).	Int Begränsningar: Minsta värde = 10485760 Maxvärde = 524288000
Namn	Namnet som identifierar den här slutpunkten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, fileNotifications $default. Slutpunktsnamn måste vara unika mellan slutpunktstyper.	sträng Begränsningar: Mönster = `^[A-Za-z0-9-._]{1,64}$` (krävs)
resourceGroup	Namnet på resursgruppen för lagringskontot.	sträng
subscriptionId	Prenumerationsidentifieraren för lagringskontot.	sträng

SharedAccessSignatureAuthorizationRule

Namn	Beskrivning	Värde
keyName	Namnet på principen för delad åtkomst.	sträng (krävs)
primaryKey	Primärnyckeln.	sträng
rättigheter	De behörigheter som tilldelats principen för delad åtkomst.	"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" (krävs)
secondaryKey	Den sekundära nyckeln.	sträng

StorageEndpointProperties

Namn	Beskrivning	Värde
authenticationType	Anger autentiseringstyp som används för att ansluta till lagringskontot.	"IdentityBased" "keyBased"
connectionString	Anslutningssträngen för Det Azure Storage-konto som filerna laddas upp till.	sträng (krävs)
containerName	Namnet på rotcontainern där du laddar upp filer. Containern behöver inte finnas men bör vara kreatabell med hjälp av den angivna connectionString.the container need not exist but should be creatable using the connectionString specified.	sträng (krävs)
sasTtlAsIso8601	Den tidsperiod för vilken SAS-URI:n som genererats av IoT Hub för filuppladdning är giltig. Se: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.	sträng

Dela via

Microsoft.Devices IotHubs 2020-08-01

Bicep-resursdefinition

Resursformat

Egenskapsvärden

CloudToDeviceProperties

EnrichmentProperties

EventHubProperties

FallbackRouteProperties

FeedbackEgenskaper

IotHubProperties

IotHubPropertiesEventHubEndpoints

IotHubPropertiesMessagingEndpoints

IotHubPropertiesStorageEndpoints

IotHubSkuInfo

IpFilterRule

MessagingEndpointProperties

Microsoft.Devices/IotHubs

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

ResourceTags

RouteProperties

RoutingEndpoints

RoutingEventHubProperties

RoutningEgenskaper

RoutingServiceBusQueueEndpointProperties

RoutingServiceBusTopicEndpointProperties

RoutingStorageContainerProperties

SharedAccessSignatureAuthorizationRule

StorageEndpointProperties

Snabbstartsexempel

Resursdefinition för ARM-mall

Resursformat

Egenskapsvärden

CloudToDeviceProperties

EnrichmentProperties

EventHubProperties

FallbackRouteProperties

FeedbackEgenskaper

IotHubProperties

IotHubPropertiesEventHubEndpoints

IotHubPropertiesMessagingEndpoints

IotHubPropertiesStorageEndpoints

IotHubSkuInfo

IpFilterRule

MessagingEndpointProperties

Microsoft.Devices/IotHubs

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

ResourceTags

RouteProperties

RoutingEndpoints

RoutingEventHubProperties

RoutningEgenskaper

RoutingServiceBusQueueEndpointProperties

RoutingServiceBusTopicEndpointProperties

RoutingStorageContainerProperties

SharedAccessSignatureAuthorizationRule

StorageEndpointProperties

Snabbstartsmallar

Resursdefinition för Terraform (AzAPI-provider)

Resursformat

Egenskapsvärden

CloudToDeviceProperties

EnrichmentProperties

EventHubProperties

FallbackRouteProperties

FeedbackEgenskaper

IotHubProperties

IotHubPropertiesEventHubEndpoints

IotHubPropertiesMessagingEndpoints

IotHubPropertiesStorageEndpoints

IotHubSkuInfo

IpFilterRule

MessagingEndpointProperties

Microsoft.Devices/IotHubs