Microsoft.Devices IotHubs

Bicep-resursdefinition

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

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@2023-06-30' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  etag: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    allowedFqdnList: [
      'string'
    ]
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
      }
    ]
    cloudToDevice: {
      defaultTtlAsIso8601: 'string'
      feedback: {
        lockDurationAsIso8601: 'string'
        maxDeliveryCount: int
        ttlAsIso8601: 'string'
      }
      maxDeliveryCount: int
    }
    comments: 'string'
    disableDeviceSAS: bool
    disableLocalAuth: bool
    disableModuleSAS: bool
    enableDataResidency: bool
    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'
    networkRuleSets: {
      applyToBuiltInEventHubEndpoint: bool
      defaultAction: 'string'
      ipRules: [
        {
          action: 'Allow'
          filterName: 'string'
          ipMask: 'string'
        }
      ]
    }
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    publicNetworkAccess: 'string'
    restrictOutboundNetworkAccess: bool
    routing: {
      endpoints: {
        cosmosDBSqlContainers: [
          {
            authenticationType: 'string'
            containerName: 'string'
            databaseName: 'string'
            endpointUri: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            name: 'string'
            partitionKeyName: 'string'
            partitionKeyTemplate: 'string'
            primaryKey: 'string'
            resourceGroup: 'string'
            secondaryKey: 'string'
            subscriptionId: 'string'
          }
        ]
        eventHubs: [
          {
            authenticationType: 'string'
            connectionString: 'string'
            endpointUri: 'string'
            entityPath: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        serviceBusQueues: [
          {
            authenticationType: 'string'
            connectionString: 'string'
            endpointUri: 'string'
            entityPath: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        serviceBusTopics: [
          {
            authenticationType: 'string'
            connectionString: 'string'
            endpointUri: 'string'
            entityPath: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        storageContainers: [
          {
            authenticationType: 'string'
            batchFrequencyInSeconds: int
            connectionString: 'string'
            containerName: 'string'
            encoding: 'string'
            endpointUri: 'string'
            fileNameFormat: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: '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'
        identity: {
          userAssignedIdentity: 'string'
        }
        sasTtlAsIso8601: 'string'
      }
    }
  }
}

Egenskapsvärden

IotHubs

Name Beskrivning Värde
name Resursnamnet sträng (krävs)

Teckengräns: 3–50

Giltiga tecken:
Alfanumeriska tecken och bindestreck.

Det går inte att avsluta med bindestreck.

Resursnamnet måste vara unikt i Hela Azure.
location Resursplatsen. sträng (krävs)
tags Resurstaggar. Ordlista med taggnamn och värden. Se Taggar i mallar
sku IotHub SKU-information IotHubSkuInfo (krävs)
Etag Fältet Etag krävs inte . Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen. sträng
identity Hanterade identiteter för IotHub. ArmIdentity
properties IotHub-egenskaper IotHubProperties

ArmIdentity

Name Beskrivning Värde
typ Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten. "Ingen"
"SystemAssigned"
"SystemAssigned, UserAssigned"
"Användartilldelade"
userAssignedIdentities Ordlista för {ArmUserIdentity} ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

Name Beskrivning Värde
{anpassad egenskap} ArmUserIdentity

ArmUserIdentity

Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.

IotHubProperties

Name Beskrivning Värde
allowedFqdnList Lista över tillåtna FQDN(fullständigt kvalificerat domännamn) för utgående trafik från Iot Hub. string[]
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
disableDeviceSAS Om det är sant kan inte alla SAS-nycklar med omfång (inklusive Edge-enheter men exklusive moduler) användas för autentisering. boolesk
disableLocalAuth Om det är sant kan SAS-token med SAS-nycklar med Iot Hub-omfång inte användas för autentisering. boolesk
disableModuleSAS Om det är sant kan inte alla SAS-nycklar med modulomfattning användas för autentisering. boolesk
enableDataResidency Den här egenskapen när den är inställd på true aktiverar datahemvist, vilket inaktiverar haveriberedskap. boolesk
enableFileUploadNotifications Om sant är meddelanden om filuppladdning aktiverade. boolesk
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 stöd för den här hubben. Kan anges till "1.2" för att klienter som använder en TLS-version under 1.2 ska avvisas. sträng
networkRuleSets Egenskaper för nätverksregeluppsättning för IotHub NetworkRuleSetProperties
privateEndpointConnections Privata slutpunktsanslutningar som skapats på denna IotHub PrivateEndpointConnection[]
publicNetworkAccess Om begäranden från offentligt nätverk tillåts "Inaktiverad"
"Aktiverad"
restrictOutboundNetworkAccess Om det är sant begränsas utgående från IotHub till endast de tillåtna FQDN:er som konfigureras via allowedFqdnList. boolesk
Routning De routningsrelaterade egenskaperna för IoT-hubben. Se: /azure/iot-hub/iot-hub-devguide-messaging RoutningEgenskaper
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 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. IotHubPropertiesStorageEndpoints

SharedAccessSignatureAuthorizationRule

Name Beskrivning Värde
Nyckelnamn Namnet på principen för delad åtkomst. sträng (krävs)
primaryKey Primärnyckeln. sträng
Rättigheter De behörigheter som tilldelats till 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
Nyckelnamn Namnet på principen för delad åtkomst. sträng (krävs)
primaryKey Primärnyckeln. sträng
Rättigheter De behörigheter som tilldelats till 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

CloudToDeviceEgenskaper

Name 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 moln-till-enhet-meddelanden. FeedbackEgenskaper
maxDeliveryCount Det maximala leveransantalet för moln-till-enhet-meddelanden 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

FeedbackEgenskaper

Name 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 att använda innan det upphör att gälla av IoT-hubben. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. sträng

IotHubPropertiesEventHubEndpoints

Name Beskrivning Värde
{anpassad egenskap} EventHubProperties

EventHubProperties

Name 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

IpFilterRule

Name Beskrivning Värde
åtgärd Ö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-notation för regeln. sträng (krävs)

IotHubPropertiesMessagingEndpoints

Name Beskrivning Värde
{anpassad egenskap} MessagingEndpointEgenskaper

MessagingEndpointEgenskaper

Name 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 att använda innan det upphör att gälla av IoT-hubben. Se: /azure/iot-hub/iot-hub-devguide-file-upload. sträng

NetworkRuleSetProperties

Name Beskrivning Värde
applyToBuiltInEventHubEndpoint Om det är sant tillämpas även nätverksregeluppsättningen på BuiltIn EventHub EndPoint för IotHub bool (krävs)
defaultAction Standardåtgärd för nätverksregeluppsättning "Tillåt"
"Neka"
ipRules Lista över IP-regler NetworkRuleSetIpRule[] (krävs)

NetworkRuleSetIpRule

Name Beskrivning Värde
åtgärd IP-filteråtgärd "Tillåt"
filterName Namnet på IP-filterregeln. sträng (krävs)
ipMask En sträng som innehåller IP-adressintervallet i CIDR-notation för regeln. sträng (krävs)

PrivateEndpointConnection

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

PrivateEndpointConnectionProperties

Name 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)

PrivateEndpoint

Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.

PrivateLinkServiceConnectionState

Name Beskrivning Värde
actionsRequired Åtgärder som krävs för en privat slutpunktsanslutning sträng
beskrivning Beskrivning 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" (obligatoriskt)

RoutningEgenskaper

Name Beskrivning Värde
Slutpunkter Egenskaperna som är relaterade till de anpassade slutpunkter som din IoT Hub 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. RoutingEndpoints
berikanden Listan över berikanden från användaren 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 reservväg när inget av de villkor som anges i avsnittet "vägar" är uppfyllda. Det här är en valfri parameter. Om den här egenskapen inte finns i mallen är återställningsvägen inaktiverad som standard. 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[]

RoutingEndpoints

Name Beskrivning Värde
cosmosDBSqlContainers Listan över Cosmos DB-containerslutpunkter som IoT Hub dirigerar meddelanden till, baserat på routningsreglerna. RoutingCosmosDBSqlApiProperties[]
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 slutpunkter för lagringscontainer som IoT Hub dirigerar meddelanden till, baserat på routningsreglerna. RoutingStorageContainerProperties[]

RoutingCosmosDBSqlApiEgenskaper

Name Beskrivning Värde
authenticationType Metod som används för att autentisera mot cosmos DB sql-containerslutpunkten "IdentityBased"
"keyBased"
containerName Namnet på cosmos DB sql-containern i Cosmos DB-databasen. sträng (krävs)
databaseName Namnet på Cosmos DB-databasen i Cosmos DB-kontot. sträng (krävs)
endpointUri URL:en för Cosmos DB-kontot. Det måste innehålla protokollet https:// sträng (krävs)
identity Egenskaper för hanterad identitet för routning av cosmos DB-containerslutpunkten. ManagedIdentity
name 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, fileNotifications $default. Slutpunktsnamn måste vara unika för olika slutpunktstyper. sträng (krävs)

Begränsningar:
Mönster = ^[A-Za-z0-9-._]{1,64}$
partitionKeyName Namnet på partitionsnyckeln som är associerad med den här Cosmos DB SQL-containern om det finns en sådan. Det här är en valfri parameter. sträng
partitionKeyTemplate Mallen för att generera ett nyckelvärde för syntetisk partition för användning med den här Cosmos DB SQL-containern. Mallen måste innehålla minst en av följande platshållare: {iothub}, {deviceid}, {DD}, {MM} och {ÅÅÅÅ}. En platshållare kan anges högst en gång, men ordnings- och icke-platshållarkomponenter är godtyckliga. Den här parametern krävs bara om PartitionKeyName har angetts. sträng
primaryKey Primärnyckeln för Cosmos DB-kontot. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
resourceGroup Namnet på resursgruppen för Cosmos DB-kontot. sträng
secondaryKey Den sekundära nyckeln för Cosmos DB-kontot. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
subscriptionId Prenumerationsidentifieraren för Cosmos DB-kontot. sträng

ManagedIdentity

Name Beskrivning Värde
userAssignedIdentity Den användartilldelade identiteten. sträng

RoutingEventHubProperties

Name Beskrivning Värde
authenticationType Metod som används för att autentisera mot händelsehubbens slutpunkt "IdentityBased"
"keyBased"
Connectionstring Anslutningssträng 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 Händelsehubbens namn på händelsehubbens namnområde sträng
id ID för händelsehubbens slutpunkt sträng
identity Egenskaper för hanterad identitet för händelsehubbens slutpunkt för routning. ManagedIdentity
name 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, fileNotifications $default. Slutpunktsnamn måste vara unika för olika slutpunktstyper. sträng (krävs)

Begränsningar:
Mönster = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Namnet på resursgruppen för händelsehubbens slutpunkt. sträng
subscriptionId Prenumerationsidentifieraren för händelsehubbens slutpunkt. sträng

RoutingServiceBusQueueEndpointProperties

Name Beskrivning Värde
authenticationType Metod som används för att autentisera mot Service Bus-köslutpunkten "IdentityBased"
"keyBased"
Connectionstring Anslutningssträng 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
identity Egenskaper för hanterad identitet för routning av service bus-köslutpunkten. ManagedIdentity
name 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, fileNotifications $default. Slutpunktsnamn måste vara unika för olika slutpunktstyper. Namnet behöver inte vara samma som det faktiska könamnet. sträng (krävs)

Begränsningar:
Mönster = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Namnet på resursgruppen för service bus-köslutpunkten. sträng
subscriptionId Prenumerationsidentifieraren för service bus-köslutpunkten. sträng

RoutingServiceBusTopicEndpointProperties

Name Beskrivning Värde
authenticationType Metod som används för att autentisera mot service bus-ämnesslutpunkten "IdentityBased"
"keyBased"
Connectionstring Anslutningssträng 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 i Service Bus-ämnet sträng
id ID för service bus-ämnesslutpunkten sträng
identity Egenskaper för hanterad identitet för service bus-ämnesslutpunkt för routning. ManagedIdentity
name 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, fileNotifications $default. Slutpunktsnamn måste vara unika för olika slutpunktstyper. Namnet behöver inte vara samma som det faktiska ämnesnamnet. sträng (krävs)

Begränsningar:
Mönster = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Namnet på resursgruppen för service bus-ämnesslutpunkten. sträng
subscriptionId Prenumerationsidentifieraren för service bus-ämnesslutpunkten. sträng

RoutingStorageContainerEgenskaper

Name Beskrivning Värde
authenticationType Metod som används för att autentisera mot lagringsslutpunkten "IdentityBased"
"keyBased"
batchFrequencyInSeconds Tidsintervall då 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 Lagringskontots anslutningssträng. 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
identity Egenskaper för hanterad identitet för routning av lagringsslutpunkt. ManagedIdentity
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
name 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 för slutpunktstyper. sträng (krävs)

Begränsningar:
Mönster = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Namnet på resursgruppen för lagringskontot. sträng
subscriptionId Prenumerationsidentifieraren för lagringskontot. sträng

EnrichmentProperties

Name Beskrivning Värde
endpointNames Listan över slutpunkter för vilka berikningen tillämpas på meddelandet. string[] (krävs)

Begränsningar:
Minsta längd = 1
key Nyckeln eller namnet på berikningsegenskapen. sträng (krävs)
värde Värdet för berikningsegenskapen. sträng (krävs)

FallbackRouteEgenskaper

Name Beskrivning Värde
Villkor Villkoret som utvärderas för att tillämpa återställningsvägen. Om villkoret inte 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 som meddelanden som uppfyller villkoret dirigeras till. För närvarande tillåts endast en slutpunkt. string[] (krävs)

Begränsningar:
Minsta längd = 1
Maximal längd = 1
isEnabled Används för att ange om återställningsvägen är aktiverad. bool (krävs)
name 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 "DeviceConnectionStateEvents"
"DeviceJobLifecycleEvents"
"DeviceLifecycleEvents"
"DeviceMessages"
"Ogiltigt"
"TwinChangeEvents" (krävs)

RouteProperties

Name Beskrivning Värde
Villkor 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 som meddelanden som uppfyller villkoret dirigeras till. För närvarande tillåts endast en slutpunkt. string[] (krävs)

Begränsningar:
Minsta längd = 1
Maximal längd = 1
isEnabled Används för att ange om en väg är aktiverad. bool (krävs)
name 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 (krävs)

Begränsningar:
Mönster = ^[A-Za-z0-9-._]{1,64}$
källa Den källa som routningsregeln ska tillämpas på, till exempel DeviceMessages. "DeviceConnectionStateEvents"
"DeviceJobLifecycleEvents"
"DeviceLifecycleEvents"
"DeviceMessages"
"Ogiltigt"
"TwinChangeEvents" (krävs)

IotHubPropertiesStorageEndpoints

Name Beskrivning Värde
{anpassad egenskap} StorageEndpointEgenskaper

StorageEndpointEgenskaper

Name Beskrivning Värde
authenticationType Anger vilken autentiseringstyp som används för att ansluta till lagringskontot. "IdentityBased"
"keyBased"
Connectionstring Anslutningssträng för Det Azure Storage-konto som filer laddas upp till. sträng (krävs)
containerName Namnet på rotcontainern där du laddar upp filer. Containern behöver inte finnas, men den bör skapas med den angivna connectionString. sträng (krävs)
identity Egenskaper för hanterad identitet för lagringsslutpunkten för filuppladdning. ManagedIdentity
sasTtlAsIso8601 Den tidsperiod för vilken SAS-URI:n som genereras av IoT Hub för filuppladdning är giltig. Se: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. sträng

IotHubSkuInfo

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

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Description
Skapa en IOT Hub- och Ubuntu-kantsimulator

Distribuera till Azure
Den här mallen skapar en IOT Hub- och Virtual Machine Ubuntu-gränssimulator.
Använd ARM-mall för att skapa IoT Hub, dirigera och visa meddelanden

Distribuera till Azure
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 hubben som dirigeras till lagringen och visa sedan resultatet.
Skapa en IoT Hub Device Provisioning Service

Distribuera till Azure
Med den här mallen kan du skapa en IoT-hubb och en IoT Hub Device Provisioning Service och länka ihop de två tjänsterna.
Skapa en IoT Hub och en enhet till molnkonsumentgrupp

Distribuera till Azure
Med den här mallen kan du distribuera en IoT Hub-instans med enheten till molnet och molnet till konfigurationer för enhetsmeddelanden och en enhet till en molnkonsumentgrupp.
Skapa enhetsuppdatering för IoT Hub konto, instans, IoT Hub

Distribuera till Azure
Den här mallen skapar ett konto och 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

Distribuera till Azure
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.
Skapa en PAYG-miljö (Betala per användning) med en IoT Hub

Distribuera till Azure
Med den här mallen kan du distribuera en Pay As You Go(PAYG) Time Series Insights-miljö som är konfigurerad för att använda händelser från en IoT Hub.

Resursdefinition för ARM-mall

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

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": "2023-06-30",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "allowedFqdnList": [ "string" ],
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string",
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string"
      }
    ],
    "cloudToDevice": {
      "defaultTtlAsIso8601": "string",
      "feedback": {
        "lockDurationAsIso8601": "string",
        "maxDeliveryCount": "int",
        "ttlAsIso8601": "string"
      },
      "maxDeliveryCount": "int"
    },
    "comments": "string",
    "disableDeviceSAS": "bool",
    "disableLocalAuth": "bool",
    "disableModuleSAS": "bool",
    "enableDataResidency": "bool",
    "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",
    "networkRuleSets": {
      "applyToBuiltInEventHubEndpoint": "bool",
      "defaultAction": "string",
      "ipRules": [
        {
          "action": "Allow",
          "filterName": "string",
          "ipMask": "string"
        }
      ]
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {},
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "publicNetworkAccess": "string",
    "restrictOutboundNetworkAccess": "bool",
    "routing": {
      "endpoints": {
        "cosmosDBSqlContainers": [
          {
            "authenticationType": "string",
            "containerName": "string",
            "databaseName": "string",
            "endpointUri": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "name": "string",
            "partitionKeyName": "string",
            "partitionKeyTemplate": "string",
            "primaryKey": "string",
            "resourceGroup": "string",
            "secondaryKey": "string",
            "subscriptionId": "string"
          }
        ],
        "eventHubs": [
          {
            "authenticationType": "string",
            "connectionString": "string",
            "endpointUri": "string",
            "entityPath": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "serviceBusQueues": [
          {
            "authenticationType": "string",
            "connectionString": "string",
            "endpointUri": "string",
            "entityPath": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "serviceBusTopics": [
          {
            "authenticationType": "string",
            "connectionString": "string",
            "endpointUri": "string",
            "entityPath": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "storageContainers": [
          {
            "authenticationType": "string",
            "batchFrequencyInSeconds": "int",
            "connectionString": "string",
            "containerName": "string",
            "encoding": "string",
            "endpointUri": "string",
            "fileNameFormat": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "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",
        "identity": {
          "userAssignedIdentity": "string"
        },
        "sasTtlAsIso8601": "string"
      }
    }
  }
}

Egenskapsvärden

IotHubs

Name Beskrivning Värde
typ Resurstypen "Microsoft.Devices/IotHubs"
apiVersion Resurs-API-versionen '2023-06-30'
name Resursnamnet sträng (krävs)

Teckengräns: 3–50

Giltiga tecken:
Alfanumeriska tecken och bindestreck.

Det går inte att avsluta med bindestreck.

Resursnamnet måste vara unikt i Hela Azure.
location Resursplatsen. sträng (krävs)
tags Resurstaggar. Ordlista med taggnamn och värden. Se Taggar i mallar
sku IotHub SKU-information IotHubSkuInfo (krävs)
Etag Fältet Etag krävs inte . Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen. sträng
identity Hanterade identiteter för IotHub. ArmIdentity
properties IotHub-egenskaper IotHubProperties

ArmIdentity

Name Beskrivning Värde
typ Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten. "Ingen"
"SystemAssigned"
"SystemAssigned, UserAssigned"
"Användartilldelade"
userAssignedIdentities Ordlista för {ArmUserIdentity} ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

Name Beskrivning Värde
{anpassad egenskap} ArmUserIdentity

ArmUserIdentity

Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.

IotHubProperties

Name Beskrivning Värde
allowedFqdnList Lista över tillåtna FQDN(fullständigt kvalificerat domännamn) för utgående trafik från Iot Hub. string[]
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
disableDeviceSAS Om det är sant kan inte alla SAS-nycklar med omfång (inklusive Edge-enheter men exklusive moduler) användas för autentisering. boolesk
disableLocalAuth Om det är sant kan SAS-token med SAS-nycklar med Iot Hub-omfång inte användas för autentisering. boolesk
disableModuleSAS Om det är sant kan inte alla SAS-nycklar med modulomfång användas för autentisering. boolesk
enableDataResidency När den här egenskapen är inställd på true aktiveras datahemvist, vilket inaktiverar haveriberedskap. boolesk
enableFileUploadNotifications Om värdet är Sant aktiveras meddelanden om filuppladdning. boolesk
eventHubEndpoints Egenskaper för Event Hub-kompatibla slutpunkter. 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" för att klienter som använder en TLS-version under 1.2 ska avvisas. sträng
networkRuleSets Egenskaper för nätverksregeluppsättning för IotHub NetworkRuleSetProperties
privateEndpointConnections Privata slutpunktsanslutningar som skapats på denna IotHub PrivateEndpointConnection[]
publicNetworkAccess Om begäranden från offentligt nätverk tillåts "Inaktiverad"
"Aktiverad"
restrictOutboundNetworkAccess Om det är sant begränsas utgående från IotHub till endast de tillåtna FQDN:er som konfigureras via allowedFqdnList. boolesk
Routning Routningsrelaterade egenskaper för IoT-hubben. Se: /azure/iot-hub/iot-hub-devguide-messaging RoutningEgenskaper
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 sin nyckel som $default. Om du anger fler än ett lagringskonto genereras ett fel. Om du inte anger ett värde för den här egenskapen när egenskapen enableFileUploadNotifications är inställd på True genereras ett fel. IotHubPropertiesStorageEndpoints

SharedAccessSignatureAuthorizationRule

Name Beskrivning Värde
Nyckelnamn Namnet på principen för delad åtkomst. sträng (krävs)
primaryKey Primärnyckeln. sträng
Rättigheter Behörigheterna som tilldelats till 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
Nyckelnamn Namnet på principen för delad åtkomst. sträng (krävs)
primaryKey Primärnyckeln. sträng
Rättigheter Behörigheterna som tilldelats till 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

CloudToDeviceEgenskaper

Name 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 moln-till-enhet-meddelanden. FeedbackEgenskaper
maxDeliveryCount Det maximala leveransantalet för moln-till-enhet-meddelanden 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

FeedbackEgenskaper

Name 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 att använda innan det upphör att gälla av IoT-hubben. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. sträng

IotHubPropertiesEventHubEndpoints

Name Beskrivning Värde
{anpassad egenskap} EventHubProperties

EventHubProperties

Name 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

IpFilterRule

Name Beskrivning Värde
åtgärd Ö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-notation för regeln. sträng (krävs)

IotHubPropertiesMessagingEndpoints

Name Beskrivning Värde
{anpassad egenskap} MessagingEndpointEgenskaper

MessagingEndpointEgenskaper

Name 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 att använda innan det upphör att gälla av IoT-hubben. Se: /azure/iot-hub/iot-hub-devguide-file-upload. sträng

NetworkRuleSetProperties

Name Beskrivning Värde
applyToBuiltInEventHubEndpoint Om det är sant tillämpas även nätverksregeluppsättningen på BuiltIn EventHub EndPoint för IotHub bool (krävs)
defaultAction Standardåtgärd för nätverksregeluppsättning "Tillåt"
"Neka"
ipRules Lista över IP-regler NetworkRuleSetIpRule[] (krävs)

NetworkRuleSetIpRule

Name Beskrivning Värde
åtgärd IP-filteråtgärd "Tillåt"
filterName Namnet på IP-filterregeln. sträng (krävs)
ipMask En sträng som innehåller IP-adressintervallet i CIDR-notation för regeln. sträng (krävs)

PrivateEndpointConnection

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

PrivateEndpointConnectionProperties

Name 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)

PrivateEndpoint

Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.

PrivateLinkServiceConnectionState

Name Beskrivning Värde
actionsRequired Åtgärder som krävs för en privat slutpunktsanslutning sträng
beskrivning Beskrivning 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" (obligatoriskt)

RoutningEgenskaper

Name Beskrivning Värde
Slutpunkter Egenskaperna som är relaterade till de anpassade slutpunkter som din IoT Hub 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. RoutingEndpoints
berikanden Listan över berikanden från användaren 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 reservväg när inget av de villkor som anges i avsnittet "vägar" är uppfyllda. Det här är en valfri parameter. Om den här egenskapen inte finns i mallen är återställningsvägen inaktiverad som standard. 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[]

RoutingEndpoints

Name Beskrivning Värde
cosmosDBSqlContainers Listan över Cosmos DB-containerslutpunkter som IoT Hub dirigerar meddelanden till, baserat på routningsreglerna. RoutingCosmosDBSqlApiProperties[]
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 slutpunkter för lagringscontainer som IoT Hub dirigerar meddelanden till, baserat på routningsreglerna. RoutingStorageContainerProperties[]

RoutingCosmosDBSqlApiEgenskaper

Name Beskrivning Värde
authenticationType Metod som används för att autentisera mot cosmos DB sql-containerslutpunkten "IdentityBased"
"keyBased"
containerName Namnet på cosmos DB sql-containern i Cosmos DB-databasen. sträng (krävs)
databaseName Namnet på Cosmos DB-databasen i Cosmos DB-kontot. sträng (krävs)
endpointUri URL:en för Cosmos DB-kontot. Det måste innehålla protokollet https:// sträng (krävs)
identity Egenskaper för hanterad identitet för routning av cosmos DB-containerslutpunkten. ManagedIdentity
name 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, fileNotifications $default. Slutpunktsnamn måste vara unika för olika slutpunktstyper. sträng (krävs)

Begränsningar:
Mönster = ^[A-Za-z0-9-._]{1,64}$
partitionKeyName Namnet på partitionsnyckeln som är associerad med den här Cosmos DB SQL-containern om det finns en sådan. Det här är en valfri parameter. sträng
partitionKeyTemplate Mallen för att generera ett nyckelvärde för syntetisk partition för användning med den här Cosmos DB SQL-containern. Mallen måste innehålla minst en av följande platshållare: {iothub}, {deviceid}, {DD}, {MM} och {ÅÅÅÅ}. En platshållare kan anges högst en gång, men ordnings- och icke-platshållarkomponenter är godtyckliga. Den här parametern krävs bara om PartitionKeyName har angetts. sträng
primaryKey Primärnyckeln för Cosmos DB-kontot. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
resourceGroup Namnet på resursgruppen för Cosmos DB-kontot. sträng
secondaryKey Den sekundära nyckeln för Cosmos DB-kontot. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
subscriptionId Prenumerationsidentifieraren för Cosmos DB-kontot. sträng

ManagedIdentity

Name Beskrivning Värde
userAssignedIdentity Den användartilldelade identiteten. sträng

RoutingEventHubProperties

Name Beskrivning Värde
authenticationType Metod som används för att autentisera mot händelsehubbens slutpunkt "IdentityBased"
"keyBased"
Connectionstring Anslutningssträng 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 Händelsehubbens namn på händelsehubbens namnområde sträng
id ID för händelsehubbens slutpunkt sträng
identity Egenskaper för hanterad identitet för händelsehubbens slutpunkt för routning. ManagedIdentity
name 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, fileNotifications $default. Slutpunktsnamn måste vara unika för olika slutpunktstyper. sträng (krävs)

Begränsningar:
Mönster = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Namnet på resursgruppen för händelsehubbens slutpunkt. sträng
subscriptionId Prenumerationsidentifieraren för händelsehubbens slutpunkt. sträng

RoutingServiceBusQueueEndpointProperties

Name Beskrivning Värde
authenticationType Metod som används för att autentisera mot service bus-köslutpunkten "IdentityBased"
"keyBased"
Connectionstring Anslutningssträng 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
identity Hanterade identitetsegenskaper för routning av service bus-köslutpunkten. ManagedIdentity
name 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 för slutpunktstyper. Namnet behöver inte vara samma som det faktiska könamnet. sträng (krävs)

Begränsningar:
Mönster = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Namnet på resursgruppen för service bus-köslutpunkten. sträng
subscriptionId Prenumerationsidentifieraren för service bus-köslutpunkten. sträng

RoutingServiceBusTopicEndpointEgenskaper

Name Beskrivning Värde
authenticationType Metod som används för att autentisera mot service bus-ämnesslutpunkten "IdentityBased"
"keyBased"
Connectionstring Anslutningssträng 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 i service bus-ämnet sträng
id ID för service bus-ämnesslutpunkten sträng
identity Hanterade identitetsegenskaper för routning av service bus-ämnesslutpunkt. ManagedIdentity
name 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 för slutpunktstyper. Namnet behöver inte vara samma som det faktiska ämnesnamnet. sträng (krävs)

Begränsningar:
Mönster = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Namnet på resursgruppen för service bus-ämnesslutpunkten. sträng
subscriptionId Prenumerationsidentifieraren för service bus-ämnesslutpunkten. sträng

RoutingStorageContainerEgenskaper

Name Beskrivning Värde
authenticationType Metod som används för att autentisera mot lagringsslutpunkten "IdentityBased"
"keyBased"
batchFrequencyInSeconds Tidsintervall där 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 Lagringskontots anslutningssträng. 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
identity Egenskaper för hanterad identitet för routning av lagringsslutpunkt. ManagedIdentity
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
name 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 för slutpunktstyper. sträng (krävs)

Begränsningar:
Mönster = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Namnet på resursgruppen för lagringskontot. sträng
subscriptionId Prenumerationsidentifieraren för lagringskontot. sträng

EnrichmentProperties

Name Beskrivning Värde
endpointNames Listan över slutpunkter för vilka berikningen tillämpas på meddelandet. string[] (krävs)

Begränsningar:
Minsta längd = 1
key Nyckeln eller namnet på berikningsegenskapen. sträng (krävs)
värde Värdet för berikningsegenskapen. sträng (krävs)

FallbackRouteEgenskaper

Name Beskrivning Värde
Villkor Villkoret som utvärderas för att tillämpa återställningsvägen. Om villkoret inte 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 som meddelanden som uppfyller villkoret dirigeras till. För närvarande tillåts endast en slutpunkt. string[] (krävs)

Begränsningar:
Minsta längd = 1
Maximal längd = 1
isEnabled Används för att ange om återställningsvägen är aktiverad. bool (krävs)
name 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 "DeviceConnectionStateEvents"
"DeviceJobLifecycleEvents"
"DeviceLifecycleEvents"
"DeviceMessages"
"Ogiltigt"
"TwinChangeEvents" (krävs)

RouteProperties

Name Beskrivning Värde
Villkor 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)

Begränsningar:
Minsta längd = 1
Maxlängd = 1
isEnabled Används för att ange om en väg är aktiverad. bool (krävs)
name 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. sträng (krävs)

Begränsningar:
Mönster = ^[A-Za-z0-9-._]{1,64}$
källa Den källa som routningsregeln ska tillämpas på, till exempel DeviceMessages. "DeviceConnectionStateEvents"
"DeviceJobLifecycleEvents"
"DeviceLifecycleEvents"
"DeviceMessages"
"Ogiltigt"
"TwinChangeEvents" (krävs)

IotHubPropertiesStorageEndpoints

Name Beskrivning Värde
{anpassad egenskap} StorageEndpointProperties

StorageEndpointProperties

Name Beskrivning Värde
authenticationType Anger vilken autentiseringstyp som används för att ansluta till lagringskontot. "IdentityBased"
"keyBased"
Connectionstring Anslutningssträng för Det Azure Storage-konto som filer laddas upp till. sträng (krävs)
containerName Namnet på rotcontainern där du laddar upp filer. Containern behöver inte finnas, men den bör vara kan skapas med hjälp av den angivna connectionString. sträng (krävs)
identity Egenskaper för hanterad identitet för lagringsslutpunkten för filuppladdning. ManagedIdentity
sasTtlAsIso8601 Den tidsperiod som 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

IotHubSkuInfo

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

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Description
Skapa en IOT Hub- och Ubuntu Edge-simulator

Distribuera till Azure
Den här mallen skapar en Ubuntu-gränssimulator för IOT Hub och virtuell dator.
Använd ARM-mall för att skapa IoT Hub, dirigera och visa meddelanden

Distribuera till Azure
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.
Skapa en IoT Hub Enhetsetableringstjänst

Distribuera till Azure
Med den här mallen kan du skapa en IoT-hubb och en IoT Hub Device Provisioning Service och länka ihop de två tjänsterna.
Skapa en IoT Hub och en enhet till molnkonsumentgrupp

Distribuera till Azure
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 enhetsuppdatering för IoT Hub konto, instans IoT Hub

Distribuera till Azure
Den här mallen skapar ett konto, en instans och en hubb som instansen ska länkas till. Den konfigurerar hubben med nödvändiga åtkomstprinciper, vägar och konsumentgrupper.
Distribuera MedTech-tjänsten, inklusive en Azure IoT Hub

Distribuera till Azure
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.
Skapa en PAYG-miljö (Betala per användning) med en IoT Hub

Distribuera till Azure
Med den här mallen kan du distribuera en Pay As You Go(PAYG) Time Series Insights-miljö som är konfigurerad för att använda händelser från en IoT Hub.

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@2023-06-30"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      allowedFqdnList = [
        "string"
      ]
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
        }
      ]
      cloudToDevice = {
        defaultTtlAsIso8601 = "string"
        feedback = {
          lockDurationAsIso8601 = "string"
          maxDeliveryCount = int
          ttlAsIso8601 = "string"
        }
        maxDeliveryCount = int
      }
      comments = "string"
      disableDeviceSAS = bool
      disableLocalAuth = bool
      disableModuleSAS = bool
      enableDataResidency = bool
      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"
      networkRuleSets = {
        applyToBuiltInEventHubEndpoint = bool
        defaultAction = "string"
        ipRules = [
          {
            action = "Allow"
            filterName = "string"
            ipMask = "string"
          }
        ]
      }
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {}
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      publicNetworkAccess = "string"
      restrictOutboundNetworkAccess = bool
      routing = {
        endpoints = {
          cosmosDBSqlContainers = [
            {
              authenticationType = "string"
              containerName = "string"
              databaseName = "string"
              endpointUri = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              name = "string"
              partitionKeyName = "string"
              partitionKeyTemplate = "string"
              primaryKey = "string"
              resourceGroup = "string"
              secondaryKey = "string"
              subscriptionId = "string"
            }
          ]
          eventHubs = [
            {
              authenticationType = "string"
              connectionString = "string"
              endpointUri = "string"
              entityPath = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          serviceBusQueues = [
            {
              authenticationType = "string"
              connectionString = "string"
              endpointUri = "string"
              entityPath = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          serviceBusTopics = [
            {
              authenticationType = "string"
              connectionString = "string"
              endpointUri = "string"
              entityPath = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          storageContainers = [
            {
              authenticationType = "string"
              batchFrequencyInSeconds = int
              connectionString = "string"
              containerName = "string"
              encoding = "string"
              endpointUri = "string"
              fileNameFormat = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "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"
          identity = {
            userAssignedIdentity = "string"
          }
          sasTtlAsIso8601 = "string"
        }
      }
    }
    sku = {
      capacity = int
      name = "string"
    }
    etag = "string"
  })
}

Egenskapsvärden

IotHubs

Name Beskrivning Värde
typ Resurstypen "Microsoft.Devices/IotHubs@2023-06-30"
name Resursnamnet sträng (krävs)

Teckengräns: 3–50

Giltiga tecken:
Alfanumeriska tecken och bindestreck.

Det går inte att sluta med bindestreck.

Resursnamnet måste vara unikt i Hela Azure.
location Resursplatsen. sträng (krävs)
parent_id Om du vill distribuera till en resursgrupp använder du ID:t för den resursgruppen. sträng (krävs)
tags Resurstaggar. Ordlista med taggnamn och värden.
sku IotHub SKU-information IotHubSkuInfo (krävs)
Etag Fältet Etag krävs inte . Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen. sträng
identity Hanterade identiteter för IotHub. ArmIdentity
properties IotHub-egenskaper IotHubProperties

ArmIdentity

Name Beskrivning Värde
typ Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort eventuella identiteter från tjänsten. "SystemTilldelade"
"SystemAssigned, UserAssigned"
"Användartilldelade"
identity_ids Ordlista för {ArmUserIdentity} Matris med användaridentitets-ID:t.

ArmIdentityUserAssignedIdentities

Name Beskrivning Värde
{anpassad egenskap} ArmUserIdentity

ArmUserIdentity

Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.

IotHubProperties

Name Beskrivning Värde
allowedFqdnList Lista över tillåtna FQDN(fullständigt kvalificerat domännamn) för utgående trafik från Iot Hub. string[]
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. CloudToDeviceEgenskaper
kommentarer IoT Hub-kommentarer. sträng
disableDeviceSAS Om det är sant kan inte alla SAS-nycklar (inklusive Edge-enheter men exklusive moduler) användas för autentisering. boolesk
disableLocalAuth Om det är sant kan SAS-token med SAS-nycklar med Iot Hub-omfång inte användas för autentisering. boolesk
disableModuleSAS Om det är sant kan inte alla SAS-nycklar med modulomfattning användas för autentisering. boolesk
enableDataResidency Den här egenskapen när den är inställd på true aktiverar datahemvist, vilket inaktiverar haveriberedskap. boolesk
enableFileUploadNotifications Om sant är meddelanden om filuppladdning aktiverade. boolesk
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 stöd för den här hubben. Kan anges till "1.2" för att klienter som använder en TLS-version under 1.2 ska avvisas. sträng
networkRuleSets Egenskaper för nätverksregeluppsättning för IotHub NetworkRuleSetProperties
privateEndpointConnections Privata slutpunktsanslutningar som skapats på denna IotHub PrivateEndpointConnection[]
publicNetworkAccess Om begäranden från offentligt nätverk tillåts "Inaktiverad"
"Aktiverad"
restrictOutboundNetworkAccess Om det är sant begränsas utgående från IotHub till endast de tillåtna FQDN:er som konfigureras via allowedFqdnList. boolesk
Routning De routningsrelaterade egenskaperna för IoT-hubben. Se: /azure/iot-hub/iot-hub-devguide-messaging RoutningEgenskaper
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 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. IotHubPropertiesStorageEndpoints

SharedAccessSignatureAuthorizationRule

Name Beskrivning Värde
Nyckelnamn Namnet på principen för delad åtkomst. sträng (krävs)
primaryKey Primärnyckeln. sträng
Rättigheter De behörigheter som tilldelats till 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
Nyckelnamn Namnet på principen för delad åtkomst. sträng (krävs)
primaryKey Primärnyckeln. sträng
Rättigheter De behörigheter som tilldelats till 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

CloudToDeviceEgenskaper

Name 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 molnet till enheten. 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

FeedbackEgenskaper

Name Beskrivning Värde
lockDurationAsIso8601 Låsets varaktighet 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 då 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

IotHubPropertiesEventHubEndpoints

Name Beskrivning Värde
{anpassad egenskap} EventHubProperties

EventHubProperties

Name Beskrivning Värde
partitionCount Antalet partitioner för att ta emot meddelanden från enheten till molnet 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

IpFilterRule

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

IotHubPropertiesMessagingEndpoints

Name Beskrivning Värde
{anpassad egenskap} MessagingEndpointProperties

MessagingEndpointProperties

Name 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 då 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

NetworkRuleSetProperties

Name Beskrivning Värde
applyToBuiltInEventHubEndpoint Om det är sant tillämpas även nätverksregeluppsättningen på BuiltIn EventHub EndPoint för IotHub bool (krävs)
defaultAction Standardåtgärd för nätverksregeluppsättning "Tillåt"
"Neka"
ipRules Lista över IP-regler NetworkRuleSetIpRule[] (krävs)

NetworkRuleSetIpRule

Name Beskrivning Värde
åtgärd IP-filteråtgärd "Tillåt"
filterName Namn på IP-filterregeln. sträng (krävs)
ipMask En sträng som innehåller IP-adressintervallet i CIDR-notation för regeln. sträng (krävs)

PrivateEndpointConnection

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

PrivateEndpointConnectionProperties

Name 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)

PrivateEndpoint

Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.

PrivateLinkServiceConnectionState

Name 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)

RoutningEgenskaper

Name Beskrivning Värde
Slutpunkter 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. RoutingEndpoints
berikningar Listan över berikningar som tillhandahålls av användaren som IoT-hubben använder 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" är uppfyllda. Det här är en valfri parameter. Om den här egenskapen inte finns i mallen inaktiveras återställningsvägen som standard. FallbackRouteEgenskaper
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[]

RoutingEndpoints

Name Beskrivning Värde
cosmosDBSqlContainers Listan över Cosmos DB-containerslutpunkter som IoT Hub dirigerar meddelanden till, baserat på routningsreglerna. RoutingCosmosDBSqlApiEgenskaper[]
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[]

RoutingCosmosDBSqlApiEgenskaper

Name Beskrivning Värde
authenticationType Metod som används för att autentisera mot cosmos DB sql-containerslutpunkten "IdentityBased"
"keyBased"
containerName Namnet på cosmos DB sql-containern i Cosmos DB-databasen. sträng (krävs)
databaseName Namnet på Cosmos DB-databasen i Cosmos DB-kontot. sträng (krävs)
endpointUri URL:en för Cosmos DB-kontot. Det måste innehålla protokollet https:// sträng (krävs)
identity Egenskaper för hanterad identitet för routning av cosmos DB-containerslutpunkten. ManagedIdentity
name 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, fileNotifications $default. Slutpunktsnamn måste vara unika för olika slutpunktstyper. sträng (krävs)

Begränsningar:
Mönster = ^[A-Za-z0-9-._]{1,64}$
partitionKeyName Namnet på partitionsnyckeln som är associerad med den här Cosmos DB SQL-containern om det finns en sådan. Det här är en valfri parameter. sträng
partitionKeyTemplate Mallen för att generera ett nyckelvärde för syntetisk partition för användning med den här Cosmos DB SQL-containern. Mallen måste innehålla minst en av följande platshållare: {iothub}, {deviceid}, {DD}, {MM} och {ÅÅÅÅ}. En platshållare kan anges högst en gång, men ordnings- och icke-platshållarkomponenter är godtyckliga. Den här parametern krävs bara om PartitionKeyName har angetts. sträng
primaryKey Primärnyckeln för Cosmos DB-kontot. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
resourceGroup Namnet på resursgruppen för Cosmos DB-kontot. sträng
secondaryKey Den sekundära nyckeln för Cosmos DB-kontot. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
subscriptionId Prenumerationsidentifieraren för Cosmos DB-kontot. sträng

ManagedIdentity

Name Beskrivning Värde
userAssignedIdentity Den användartilldelade identiteten. sträng

RoutingEventHubProperties

Name Beskrivning Värde
authenticationType Metod som används för att autentisera mot händelsehubbens slutpunkt "IdentityBased"
"keyBased"
Connectionstring Anslutningssträng 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 Händelsehubbens namn på händelsehubbens namnområde sträng
id ID för händelsehubbens slutpunkt sträng
identity Egenskaper för hanterad identitet för händelsehubbens slutpunkt för routning. ManagedIdentity
name 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, fileNotifications $default. Slutpunktsnamn måste vara unika för olika slutpunktstyper. sträng (krävs)

Begränsningar:
Mönster = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Namnet på resursgruppen för händelsehubbens slutpunkt. sträng
subscriptionId Prenumerationsidentifieraren för händelsehubbens slutpunkt. sträng

RoutingServiceBusQueueEndpointProperties

Name Beskrivning Värde
authenticationType Metod som används för att autentisera mot Service Bus-köslutpunkten "IdentityBased"
"keyBased"
Connectionstring Anslutningssträng 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
identity Egenskaper för hanterad identitet för routning av service bus-köslutpunkten. ManagedIdentity
name 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, fileNotifications $default. Slutpunktsnamn måste vara unika för olika slutpunktstyper. Namnet behöver inte vara samma som det faktiska könamnet. sträng (krävs)

Begränsningar:
Mönster = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Namnet på resursgruppen för service bus-köslutpunkten. sträng
subscriptionId Prenumerationsidentifieraren för service bus-köslutpunkten. sträng

RoutingServiceBusTopicEndpointProperties

Name Beskrivning Värde
authenticationType Metod som används för att autentisera mot service bus-ämnesslutpunkten "IdentityBased"
"keyBased"
Connectionstring Anslutningssträng 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 i Service Bus-ämnet sträng
id ID för service bus-ämnesslutpunkten sträng
identity Egenskaper för hanterad identitet för service bus-ämnesslutpunkt för routning. ManagedIdentity
name 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, fileNotifications $default. Slutpunktsnamn måste vara unika för olika slutpunktstyper. Namnet behöver inte vara samma som det faktiska ämnesnamnet. sträng (krävs)

Begränsningar:
Mönster = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Namnet på resursgruppen för service bus-ämnesslutpunkten. sträng
subscriptionId Prenumerationsidentifieraren för service bus-ämnesslutpunkten. sträng

RoutingStorageContainerEgenskaper

Name Beskrivning Värde
authenticationType Metod som används för att autentisera mot lagringsslutpunkten "IdentityBased"
"keyBased"
batchFrequencyInSeconds Tidsintervall då 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 Lagringskontots anslutningssträng. 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}/{ÅÅÅÅ}/{MM}/{DD}/{HH}/{mm}. Alla parametrar är obligatoriska men kan ordnas om. sträng
id ID för slutpunkten för lagringscontainern sträng
identity Egenskaper för hanterad identitet för routning av lagringsslutpunkt. ManagedIdentity
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
name 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, fileNotifications $default. Slutpunktsnamn måste vara unika för olika slutpunktstyper. sträng (krävs)

Begränsningar:
Mönster = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Namnet på lagringskontots resursgrupp. sträng
subscriptionId Prenumerationsidentifieraren för lagringskontot. sträng

EnrichmentProperties

Name Beskrivning Värde
endpointNames Listan över slutpunkter för vilka berikandet tillämpas på meddelandet. string[] (krävs)

Begränsningar:
Minsta längd = 1
key Nyckeln eller namnet på berikningsegenskapen. sträng (krävs)
värde Värdet för berikningsegenskapen. sträng (krävs)

FallbackRouteProperties

Name Beskrivning Värde
Villkor Villkoret som utvärderas för att tillämpa återställningsvägen. Om villkoret inte anges utvärderas det till sant som standard. Grammatik finns i: /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 1 slutpunkt. string[] (krävs)

Begränsningar:
Minsta längd = 1
Maxlängd = 1
isEnabled Används för att ange om återställningsvägen är aktiverad. bool (krävs)
name 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. sträng
källa Den källa som routningsregeln ska tillämpas på. Till exempel DeviceMessages "DeviceConnectionStateEvents"
"DeviceJobLifecycleEvents"
"DeviceLifecycleEvents"
"DeviceMessages"
"Ogiltigt"
"TwinChangeEvents" (krävs)

RouteProperties

Name Beskrivning Värde
Villkor Villkoret som utvärderas för att tillämpa routningsregeln. Om inget villkor anges utvärderas det till 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)

Begränsningar:
Minsta längd = 1
Maxlängd = 1
isEnabled Används för att ange om en väg är aktiverad. bool (krävs)
name 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. sträng (krävs)

Begränsningar:
Mönster = ^[A-Za-z0-9-._]{1,64}$
källa Den källa som routningsregeln ska tillämpas på, till exempel DeviceMessages. "DeviceConnectionStateEvents"
"DeviceJobLifecycleEvents"
"DeviceLifecycleEvents"
"DeviceMessages"
"Ogiltigt"
"TwinChangeEvents" (krävs)

IotHubPropertiesStorageEndpoints

Name Beskrivning Värde
{anpassad egenskap} StorageEndpointProperties

StorageEndpointProperties

Name Beskrivning Värde
authenticationType Anger vilken autentiseringstyp som används för att ansluta till lagringskontot. "IdentityBased"
"keyBased"
Connectionstring Anslutningssträng för Det Azure Storage-konto som filer laddas upp till. sträng (krävs)
containerName Namnet på rotcontainern där du laddar upp filer. Containern behöver inte finnas, men den bör vara kan skapas med hjälp av den angivna connectionString. sträng (krävs)
identity Egenskaper för hanterad identitet för lagringsslutpunkten för filuppladdning. ManagedIdentity
sasTtlAsIso8601 Den tidsperiod som 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

IotHubSkuInfo

Name Beskrivning Värde
capacity Antalet etablerade IoT Hub enheter. Se: /azure/azure-subscription-service-limits#iot-hub-limits. int
name Namnet på SKU:n. "B1"
"B2"
"B3"
"F1"
"S1"
"S2"
"S3" (obligatoriskt)