Microsoft.Devices IotHubs 2021-07-02

Artikel
10/26/2024

Bicep-resourcedefinitie

Het resourcetype IotHubs kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.Devices/IotHubs-resource wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.Devices/IotHubs@2021-07-02' = {
  etag: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    allowedFqdnList: [
      'string'
    ]
    authorizationPolicies: [
      {
        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: 'string'
          filterName: 'string'
          ipMask: 'string'
        }
      ]
    }
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    publicNetworkAccess: 'string'
    restrictOutboundNetworkAccess: bool
    routing: {
      endpoints: {
        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'
  }
  tags: {
    {customized property}: 'string'
  }
}

Eigenschapswaarden

ArmIdentity

Naam	Beschrijving	Waarde
type	Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.	'Geen' 'SystemAssigned' 'SystemAssigned, UserAssigned' UserAssigned
userAssignedIdentities	Woordenlijst van <ArmUserIdentity->	ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

Naam	Beschrijving	Waarde

ArmUserIdentity

Naam	Beschrijving	Waarde

CloudToDeviceProperties

Naam	Beschrijving	Waarde
defaultTtlAsIso8601	De standaardtijd voor live voor cloud-naar-apparaat-berichten in de apparaatwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	snaar
terugkoppeling	De eigenschappen van de feedbackwachtrij voor cloud-naar-apparaat-berichten.	FeedbackProperties-
maxDeliveryCount	Het maximale aantal bezorgingen voor cloud-naar-apparaat-berichten in de apparaatwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 100

EnrichmentProperties

Naam	Beschrijving	Waarde
endpointNames	De lijst met eindpunten waarvoor de verrijking wordt toegepast op het bericht.	tekenreeks[] (vereist)
sleutel	De sleutel of naam voor de verrijkingseigenschap.	tekenreeks (vereist)
waarde	De waarde voor de verrijkingseigenschap.	tekenreeks (vereist)

EventHubProperties

Naam	Beschrijving	Waarde
partitionCount	Het aantal partities voor het ontvangen van apparaat-naar-cloud-berichten in het event hub-compatibele eindpunt. Zie: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.	Int
retentionTimeInDays	De bewaartijd voor apparaat-naar-cloud-berichten in dagen. Zie: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	Int

FallbackRouteProperties

Naam	Beschrijving	Waarde
conditie	De voorwaarde die wordt geëvalueerd om de terugvalroute toe te passen. Als de voorwaarde niet is opgegeven, wordt standaard geëvalueerd of waar is. Zie voor grammatica: /azure/iot-hub/iot-hub-devguide-query-language	snaar
endpointNames	De lijst met eindpunten waarnaar de berichten waaraan de voorwaarde voldoet, worden doorgestuurd. Momenteel is slechts één eindpunt toegestaan.	tekenreeks[] (vereist)
isEnabled	Wordt gebruikt om op te geven of de terugvalroute is ingeschakeld.	bool (vereist)
naam	De naam van de route. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten, mag maximaal 64 tekens lang zijn en moet uniek zijn.	snaar
bron	De bron waarop de regel voor doorsturen moet worden toegepast. Bijvoorbeeld DeviceMessages	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Ongeldig' TwinChangeEvents (vereist)

FeedbackProperties

Naam	Beschrijving	Waarde
lockDurationAsIso8601	De vergrendelingsduur voor de feedbackwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	snaar
maxDeliveryCount	Het aantal keren dat de IoT-hub een bericht probeert te bezorgen in de feedbackwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 100
ttlAsIso8601	De periode waarvoor een bericht beschikbaar is om te gebruiken voordat het is verlopen door de IoT-hub. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	snaar

IotHubProperties

Naam	Beschrijving	Waarde
allowedFqdnList	Lijst met toegestane FQDN's (Fully Qualified Domain Name) voor uitgaand verkeer van IoT Hub.	tekenreeks[]
authorizationPolicies	Het beleid voor gedeelde toegang dat u kunt gebruiken om een verbinding met de IoT-hub te beveiligen.	SharedAccessSignatureAuthorizationRule[]
cloudToDevice	De eigenschappen voor cloud-naar-apparaat-berichten van IoT Hub.	CloudToDeviceProperties-
Opmerkingen	Opmerkingen bij IoT Hub.	snaar
disableDeviceSAS	Indien waar, kunnen alle apparaten (inclusief Edge-apparaten, maar met uitzondering van modules) sas-sleutels binnen het bereik niet worden gebruikt voor verificatie.	Bool
disableLocalAuth	Indien waar, kunnen SAS-tokens met sas-sleutels met ioT-bereik niet worden gebruikt voor verificatie.	Bool
disableModuleSAS	Indien waar, kunnen alle SAS-sleutels met modulebereik niet worden gebruikt voor verificatie.	Bool
enableDataResidency	Met deze eigenschap wanneer deze is ingesteld op true, wordt gegevenslocatie ingeschakeld, waardoor herstel na noodgevallen wordt uitgeschakeld.	Bool
enableFileUploadNotifications	Indien waar, worden meldingen voor het uploaden van bestanden ingeschakeld.	Bool
eventHubEndpoints	De eigenschappen van het Event Hub-compatibele eindpunt. De enige mogelijke sleutels voor deze woordenlijst zijn gebeurtenissen. Deze sleutel moet aanwezig zijn in de woordenlijst tijdens het maken of bijwerken van aanroepen voor de IoT-hub.	IotHubPropertiesEventHubEndpoints
Functies	De mogelijkheden en functies die zijn ingeschakeld voor de IoT-hub.	'DeviceManagement' 'Geen'
ipFilterRules	De IP-filterregels.	IpFilterRule[]
messagingEndpoints	De eigenschappen van het berichteindpunt voor de meldingswachtrij voor het uploaden van bestanden.	IotHubPropertiesMessagingEndpoints
minTlsVersion	Hiermee geeft u de minimale TLS-versie op die moet worden ondersteund voor deze hub. Kan worden ingesteld op '1.2' om clients te hebben die een TLS-versie lager dan 1.2 gebruiken om te worden geweigerd.	snaar
networkRuleSets	Eigenschappen van set netwerkregels van IotHub	NetworkRuleSetProperties-
privateEndpointConnections	Privé-eindpuntverbindingen die zijn gemaakt op deze IotHub	PrivateEndpointConnection[]
publicNetworkAccess	Of aanvragen van openbaar netwerk zijn toegestaan	'Uitgeschakeld' 'Ingeschakeld'
restrictOutboundNetworkAccess	Indien waar, worden uitgaand verkeer van IotHub beperkt tot alleen de toegestane FQDN's die zijn geconfigureerd via allowedFqdnList.	Bool
routering	De routeringsgerelateerde eigenschappen van de IoT-hub. Zie: /azure/iot-hub/iot-hub-devguide-messaging	RoutingProperties-
storageEndpoints	De lijst met Azure Storage-eindpunten waar u bestanden kunt uploaden. Op dit moment kunt u slechts één Azure Storage-account configureren en dat moet de sleutel hebben als $default. Als u meer dan één opslagaccount opgeeft, wordt er een fout gegenereerd. Als de eigenschap enableFileUploadNotifications is ingesteld op True, wordt er geen waarde opgegeven voor deze eigenschap. Er wordt een fout gegenereerd.	IotHubPropertiesStorageEndpoints

IotHubPropertiesEventHubEndpoints

Naam	Beschrijving	Waarde

IotHubPropertiesMessagingEndpoints

Naam	Beschrijving	Waarde

IotHubPropertiesStorageEndpoints

Naam	Beschrijving	Waarde

IotHubSkuInfo

Naam	Beschrijving	Waarde
capaciteit	Het aantal ingerichte IoT Hub-eenheden. Zie: /azure/azure-subscription-service-limits#iot-hub-limits.	Int
naam	De naam van de SKU.	'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' (vereist)

IpFilterRule

Naam	Beschrijving	Waarde
actie	De gewenste actie voor aanvragen die door deze regel zijn vastgelegd.	'Accepteren' 'Weigeren' (vereist)
filterName	De naam van de IP-filterregel.	tekenreeks (vereist)
ipMask	Een tekenreeks die het IP-adresbereik in CIDR-notatie voor de regel bevat.	tekenreeks (vereist)

ManagedIdentity

Naam	Beschrijving	Waarde
userAssignedIdentity	De door de gebruiker toegewezen identiteit.	snaar

MessagingEndpointProperties

Naam	Beschrijving	Waarde
lockDurationAsIso8601	De duur van de vergrendeling. Zie: /azure/iot-hub/iot-hub-devguide-file-upload.	snaar
maxDeliveryCount	Het aantal keren dat de IoT-hub een bericht probeert te bezorgen. Zie: /azure/iot-hub/iot-hub-devguide-file-upload.	Int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 100
ttlAsIso8601	De periode waarvoor een bericht beschikbaar is om te gebruiken voordat het is verlopen door de IoT-hub. Zie: /azure/iot-hub/iot-hub-devguide-file-upload.	snaar

Microsoft.Devices/IotHubs

Naam	Beschrijving	Waarde
etag	Het veld Etag is niet vereist. Als deze is opgegeven in de hoofdtekst van het antwoord, moet deze ook worden opgegeven als een header volgens de normale ETag-conventie.	snaar
identiteit	De beheerde identiteiten voor de IotHub.	ArmIdentity-
plaats	De resourcelocatie.	tekenreeks (vereist)
naam	De resourcenaam	tekenreeks (vereist)
Eigenschappen	IotHub-eigenschappen	IotHubProperties-
Sku	IotHub-SKU-gegevens	IotHubSkuInfo (vereist)
Tags	Resourcetags	Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen

NetworkRuleSetIpRule

Naam	Beschrijving	Waarde
actie	IP-filteractie	'Toestaan'
filterName	Naam van de IP-filterregel.	tekenreeks (vereist)
ipMask	Een tekenreeks die het IP-adresbereik in CIDR-notatie voor de regel bevat.	tekenreeks (vereist)

NetworkRuleSetProperties

Naam	Beschrijving	Waarde
applyToBuiltInEventHubEndpoint	Indien waar, wordt de netwerkregelset ook toegepast op builtIn EventHub EndPoint van IotHub	bool (vereist)
defaultAction	Standaardactie voor netwerkregelset	'Toestaan' 'Weigeren'
ipRules	Lijst met IP-regels	NetworkRuleSetIpRule[] (vereist)

PrivateEndpoint

Naam	Beschrijving	Waarde

PrivateEndpointConnection

Naam	Beschrijving	Waarde
Eigenschappen	De eigenschappen van een privé-eindpuntverbinding	PrivateEndpointConnectionProperties (vereist)

PrivateEndpointConnectionProperties

Naam	Beschrijving	Waarde
privateEndpoint	De eigenschap privé-eindpunt van een privé-eindpuntverbinding	PrivateEndpoint-
privateLinkServiceConnectionState	De huidige status van een privé-eindpuntverbinding	PrivateLinkServiceConnectionState (vereist)

PrivateLinkServiceConnectionState

Naam	Beschrijving	Waarde
actionsRequired	Acties die vereist zijn voor een privé-eindpuntverbinding	snaar
beschrijving	De beschrijving voor de huidige status van een privé-eindpuntverbinding	tekenreeks (vereist)
status	De status van een privé-eindpuntverbinding	'Goedgekeurd' 'Verbinding verbroken' 'In behandeling' 'Geweigerd' (vereist)

ResourceTags

Naam	Beschrijving	Waarde

RouteProperties

Naam	Beschrijving	Waarde
conditie	De voorwaarde die wordt geëvalueerd om de routeringsregel toe te passen. Als er geen voorwaarde is opgegeven, wordt standaard geëvalueerd of waar is. Zie voor grammatica: /azure/iot-hub/iot-hub-devguide-query-language	snaar
endpointNames	De lijst met eindpunten waarnaar berichten die voldoen aan de voorwaarde, worden gerouteerd. Op dit moment is slechts één eindpunt toegestaan.	tekenreeks[] (vereist)
isEnabled	Wordt gebruikt om op te geven of een route is ingeschakeld.	bool (vereist)
naam	De naam van de route. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten, mag maximaal 64 tekens lang zijn en moet uniek zijn.	snaar Beperkingen: Patroon = `^[A-Za-z0-9-._]{1,64}$` (vereist)
bron	De bron waarop de regel voor doorsturen moet worden toegepast, zoals DeviceMessages.	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Ongeldig' TwinChangeEvents (vereist)

RoutingEndpoints

Naam	Beschrijving	Waarde
eventHubs	De lijst met Event Hubs-eindpunten waarnaar IoT Hub berichten routeert op basis van de routeringsregels. Deze lijst bevat niet het ingebouwde Event Hubs-eindpunt.	RoutingEventHubProperties[]
serviceBusQueues	De lijst met Service Bus-wachtrijeindpunten waarnaar ioT Hub de berichten routeert op basis van de routeringsregels.	RoutingServiceBusQueueEndpointProperties[]
serviceBusTopics	De lijst met Service Bus-onderwerpeindpunten waarnaar de IoT-hub de berichten routeert, op basis van de routeringsregels.	RoutingServiceBusTopicEndpointProperties[]
storageContainers	De lijst met opslagcontainereindpunten waarnaar IoT Hub berichten routeert op basis van de routeringsregels.	RoutingStorageContainerProperties[]

RoutingEventHubProperties

Naam	Beschrijving	Waarde
authenticationType	Methode die wordt gebruikt voor verificatie op basis van het Event Hub-eindpunt	'identityBased' 'keyBased'
connectionString	De verbindingsreeks van het Event Hub-eindpunt.	snaar
endpointUri	De URL van het Event Hub-eindpunt. Het moet het protocol sb:// bevatten	snaar
entityPath	Event Hub-naam in de Event Hub-naamruimte	snaar
legitimatiebewijs	Id van het Event Hub-eindpunt	snaar
identiteit	Eigenschappen van beheerde identiteit van het eindpunt van de Event Hub routeren.	ManagedIdentity-
naam	De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en maximaal 64 tekens bevatten. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor eindpunttypen.	snaar Beperkingen: Patroon = `^[A-Za-z0-9-._]{1,64}$` (vereist)
resourceGroup	De naam van de resourcegroep van het Event Hub-eindpunt.	snaar
subscriptionId	De abonnements-id van het Event Hub-eindpunt.	snaar

RoutingProperties

Naam	Beschrijving	Waarde
Eindpunten	De eigenschappen met betrekking tot de aangepaste eindpunten waarnaar uw IoT-hub berichten routeert op basis van de routeringsregels. Er zijn maximaal 10 aangepaste eindpunten toegestaan voor alle eindpunttypen voor betaalde hubs en slechts 1 aangepast eindpunt is toegestaan voor alle eindpunttypen voor gratis hubs.	RoutingEndpoints
verrijkingen	De lijst met door de gebruiker geleverde verrijkingen die de IoT-hub toepast op berichten die moeten worden geleverd aan ingebouwde en aangepaste eindpunten. Zie: https://aka.ms/telemetryoneventgrid	EnrichmentProperties[]
fallbackRoute	De eigenschappen van de route die wordt gebruikt als een terugvalroute wanneer aan geen van de voorwaarden in de sectie Routes wordt voldaan. Dit is een optionele parameter. Wanneer deze eigenschap niet aanwezig is in de sjabloon, is de terugvalroute standaard uitgeschakeld.	FallbackRouteProperties-
Routes	De lijst met door de gebruiker verstrekte routeringsregels die door de IoT-hub worden gebruikt om berichten te routeren naar ingebouwde en aangepaste eindpunten. Er zijn maximaal 100 routeringsregels toegestaan voor betaalde hubs en er zijn maximaal 5 routeringsregels toegestaan voor gratis hubs.	RouteProperties[]

RoutingServiceBusQueueEndpointProperties

Naam	Beschrijving	Waarde
authenticationType	Methode die wordt gebruikt voor verificatie op basis van het eindpunt van de Service Bus-wachtrij	'identityBased' 'keyBased'
connectionString	De verbindingsreeks van het service bus-wachtrijeindpunt.	snaar
endpointUri	De URL van het service bus-wachtrijeindpunt. Het moet het protocol sb:// bevatten	snaar
entityPath	Wachtrijnaam in de Service Bus-naamruimte	snaar
legitimatiebewijs	Id van het service bus-wachtrijeindpunt	snaar
identiteit	Eigenschappen van beheerde identiteit van het eindpunt van de service bus-wachtrij.	ManagedIdentity-
naam	De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en maximaal 64 tekens bevatten. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor eindpunttypen. De naam hoeft niet hetzelfde te zijn als de werkelijke wachtrijnaam.	snaar Beperkingen: Patroon = `^[A-Za-z0-9-._]{1,64}$` (vereist)
resourceGroup	De naam van de resourcegroep van het service bus-wachtrijeindpunt.	snaar
subscriptionId	De abonnements-id van het service bus-wachtrijeindpunt.	snaar

RoutingServiceBusTopicEndpointProperties

Naam	Beschrijving	Waarde
authenticationType	Methode die wordt gebruikt voor verificatie op basis van het service bus-onderwerpeindpunt	'identityBased' 'keyBased'
connectionString	De verbindingsreeks van het service bus-onderwerpeindpunt.	snaar
endpointUri	De URL van het service bus-onderwerpeindpunt. Het moet het protocol sb:// bevatten	snaar
entityPath	Wachtrijnaam in het Service Bus-onderwerp	snaar
legitimatiebewijs	Id van het service bus-onderwerpeindpunt	snaar
identiteit	Beheerde identiteiteigenschappen van het eindpunt van het routeren van Service Bus-onderwerp.	ManagedIdentity-
naam	De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en maximaal 64 tekens bevatten. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor eindpunttypen. De naam hoeft niet hetzelfde te zijn als de werkelijke onderwerpnaam.	snaar Beperkingen: Patroon = `^[A-Za-z0-9-._]{1,64}$` (vereist)
resourceGroup	De naam van de resourcegroep van het service bus-onderwerpeindpunt.	snaar
subscriptionId	De abonnements-id van het service bus-onderwerpeindpunt.	snaar

RoutingStorageContainerProperties

Naam	Beschrijving	Waarde
authenticationType	Methode die wordt gebruikt voor verificatie op basis van het opslageindpunt	'identityBased' 'keyBased'
batchFrequencyInSeconds	Tijdsinterval waarmee blobs naar de opslag worden geschreven. De waarde moet tussen 60 en 720 seconden zijn. De standaardwaarde is 300 seconden.	Int Beperkingen: Minimumwaarde = 60 Maximumwaarde = 720
connectionString	De verbindingsreeks van het opslagaccount.	snaar
containerName	De naam van de opslagcontainer in het opslagaccount.	tekenreeks (vereist)
codering	Codering die wordt gebruikt voor het serialiseren van berichten naar blobs. Ondersteunde waarden zijn 'avro', 'avrodeflate' en 'JSON'. De standaardwaarde is 'avro'.	'Avro' 'AvroDeflate' JSON
endpointUri	De URL van het opslageindpunt. Het moet het protocol bevatten https://	snaar
fileNameFormat	Bestandsnaamindeling voor de blob. De standaardindeling is {iothub}/{partition}/{JJJJ}/{MM}/{DD}/{HH}/{mm}. Alle parameters zijn verplicht, maar kunnen opnieuw worden gerangschikt.	snaar
legitimatiebewijs	Id van het eindpunt van de opslagcontainer	snaar
identiteit	Eigenschappen van beheerde identiteit van eindpunt voor routeringsopslag.	ManagedIdentity-
maxChunkSizeInBytes	Maximum aantal bytes voor elke blob die naar de opslag is geschreven. De waarde moet tussen 10485760(10 MB) en 524288000 (500 MB) zijn. De standaardwaarde is 314572800(300 MB).	Int Beperkingen: Minimumwaarde = 10485760 Maximumwaarde = 524288000
naam	De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en maximaal 64 tekens bevatten. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor eindpunttypen.	snaar Beperkingen: Patroon = `^[A-Za-z0-9-._]{1,64}$` (vereist)
resourceGroup	De naam van de resourcegroep van het opslagaccount.	snaar
subscriptionId	De abonnements-id van het opslagaccount.	snaar

SharedAccessSignatureAuthorizationRule

Naam	Beschrijving	Waarde
keyName	De naam van het beleid voor gedeelde toegang.	tekenreeks (vereist)
primaryKey	De primaire sleutel.	snaar
rechten	De machtigingen die zijn toegewezen aan het beleid voor gedeelde toegang.	'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' (vereist)
secondaryKey	De secundaire sleutel.	snaar

StorageEndpointProperties

Naam	Beschrijving	Waarde
authenticationType	Hiermee geeft u het verificatietype op dat wordt gebruikt voor het maken van verbinding met het opslagaccount.	'identityBased' 'keyBased'
connectionString	De verbindingsreeks voor het Azure Storage-account waarnaar bestanden worden geüpload.	tekenreeks (vereist)
containerName	De naam van de hoofdcontainer waar u bestanden uploadt. De container hoeft niet te bestaan, maar moet worden gemaakt met behulp van de connectionString opgegeven.	tekenreeks (vereist)
identiteit	Eigenschappen van beheerde identiteit van opslageindpunt voor het uploaden van bestanden.	ManagedIdentity-
sasTtlAsIso8601	De periode waarvoor de SAS-URI die is gegenereerd door IoT Hub voor het uploaden van bestanden, is geldig. Zie: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.	snaar

Quickstart-voorbeelden

In de volgende quickstartvoorbeelden wordt dit resourcetype geïmplementeerd.

Bicep-bestand	Beschrijving
Een IoT Hub en een apparaat maken naar de cloudconsumentengroep	Met deze sjabloon kunt u een IoT Hub-exemplaar implementeren met een apparaat in de cloud en in de cloud naar configuraties voor apparaatberichten en een apparaat naar de cloudconsumentengroep.
Een IoT Hub Device Provisioning Service- maken	Met deze sjabloon kunt u een IoT-hub en een IoT Hub Device Provisioning Service maken en de twee services aan elkaar koppelen.
Apparaatupdate maken voor Een IoT Hub-account, exemplaar, IoT Hub-	Met deze sjabloon maakt u een account en een exemplaar en een hub waarmee het exemplaar kan worden gekoppeld. De hub wordt geconfigureerd met het benodigde toegangsbeleid, de routes en de consumentengroep.
De MedTech-service implementeren, inclusief een Azure IoT Hub-	De MedTech-service is een van de Azure Health Data Services die is ontworpen voor het opnemen van apparaatgegevens van meerdere apparaten, het transformeren van de apparaatgegevens naar FHIR Observations, die vervolgens worden bewaard in de Azure Health Data Services FHIR-service.
ARM-sjabloon gebruiken om IoT Hub te maken, berichten te routeren en weer te geven	Gebruik deze sjabloon om een IoT Hub en een opslagaccount te implementeren. Voer een app uit om berichten te verzenden naar de hub die naar de opslag worden doorgestuurd en bekijk vervolgens de resultaten.

Resourcedefinitie van ARM-sjabloon

Het resourcetype IotHubs kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.Devices/IotHubs-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.Devices/IotHubs",
  "apiVersion": "2021-07-02",
  "name": "string",
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "allowedFqdnList": [ "string" ],
    "authorizationPolicies": [
      {
        "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": "string",
          "filterName": "string",
          "ipMask": "string"
        }
      ]
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
          },
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "publicNetworkAccess": "string",
    "restrictOutboundNetworkAccess": "bool",
    "routing": {
      "endpoints": {
        "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Eigenschapswaarden

ArmIdentity

Naam	Beschrijving	Waarde
type	Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.	'Geen' 'SystemAssigned' 'SystemAssigned, UserAssigned' UserAssigned
userAssignedIdentities	Woordenlijst van <ArmUserIdentity->	ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

Naam	Beschrijving	Waarde

ArmUserIdentity

Naam	Beschrijving	Waarde

CloudToDeviceProperties

Naam	Beschrijving	Waarde
defaultTtlAsIso8601	De standaardtijd voor live voor cloud-naar-apparaat-berichten in de apparaatwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	snaar
terugkoppeling	De eigenschappen van de feedbackwachtrij voor cloud-naar-apparaat-berichten.	FeedbackProperties-
maxDeliveryCount	Het maximale aantal bezorgingen voor cloud-naar-apparaat-berichten in de apparaatwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 100

EnrichmentProperties

Naam	Beschrijving	Waarde
endpointNames	De lijst met eindpunten waarvoor de verrijking wordt toegepast op het bericht.	tekenreeks[] (vereist)
sleutel	De sleutel of naam voor de verrijkingseigenschap.	tekenreeks (vereist)
waarde	De waarde voor de verrijkingseigenschap.	tekenreeks (vereist)

EventHubProperties

Naam	Beschrijving	Waarde
partitionCount	Het aantal partities voor het ontvangen van apparaat-naar-cloud-berichten in het event hub-compatibele eindpunt. Zie: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.	Int
retentionTimeInDays	De bewaartijd voor apparaat-naar-cloud-berichten in dagen. Zie: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	Int

FallbackRouteProperties

Naam	Beschrijving	Waarde
conditie	De voorwaarde die wordt geëvalueerd om de terugvalroute toe te passen. Als de voorwaarde niet is opgegeven, wordt standaard geëvalueerd of waar is. Zie voor grammatica: /azure/iot-hub/iot-hub-devguide-query-language	snaar
endpointNames	De lijst met eindpunten waarnaar de berichten waaraan de voorwaarde voldoet, worden doorgestuurd. Momenteel is slechts één eindpunt toegestaan.	tekenreeks[] (vereist)
isEnabled	Wordt gebruikt om op te geven of de terugvalroute is ingeschakeld.	bool (vereist)
naam	De naam van de route. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten, mag maximaal 64 tekens lang zijn en moet uniek zijn.	snaar
bron	De bron waarop de regel voor doorsturen moet worden toegepast. Bijvoorbeeld DeviceMessages	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Ongeldig' TwinChangeEvents (vereist)

FeedbackProperties

Naam	Beschrijving	Waarde
lockDurationAsIso8601	De vergrendelingsduur voor de feedbackwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	snaar
maxDeliveryCount	Het aantal keren dat de IoT-hub een bericht probeert te bezorgen in de feedbackwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 100
ttlAsIso8601	De periode waarvoor een bericht beschikbaar is om te gebruiken voordat het is verlopen door de IoT-hub. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	snaar

IotHubProperties

Naam	Beschrijving	Waarde
allowedFqdnList	Lijst met toegestane FQDN's (Fully Qualified Domain Name) voor uitgaand verkeer van IoT Hub.	tekenreeks[]
authorizationPolicies	Het beleid voor gedeelde toegang dat u kunt gebruiken om een verbinding met de IoT-hub te beveiligen.	SharedAccessSignatureAuthorizationRule[]
cloudToDevice	De eigenschappen voor cloud-naar-apparaat-berichten van IoT Hub.	CloudToDeviceProperties-
Opmerkingen	Opmerkingen bij IoT Hub.	snaar
disableDeviceSAS	Indien waar, kunnen alle apparaten (inclusief Edge-apparaten, maar met uitzondering van modules) sas-sleutels binnen het bereik niet worden gebruikt voor verificatie.	Bool
disableLocalAuth	Indien waar, kunnen SAS-tokens met sas-sleutels met ioT-bereik niet worden gebruikt voor verificatie.	Bool
disableModuleSAS	Indien waar, kunnen alle SAS-sleutels met modulebereik niet worden gebruikt voor verificatie.	Bool
enableDataResidency	Met deze eigenschap wanneer deze is ingesteld op true, wordt gegevenslocatie ingeschakeld, waardoor herstel na noodgevallen wordt uitgeschakeld.	Bool
enableFileUploadNotifications	Indien waar, worden meldingen voor het uploaden van bestanden ingeschakeld.	Bool
eventHubEndpoints	De eigenschappen van het Event Hub-compatibele eindpunt. De enige mogelijke sleutels voor deze woordenlijst zijn gebeurtenissen. Deze sleutel moet aanwezig zijn in de woordenlijst tijdens het maken of bijwerken van aanroepen voor de IoT-hub.	IotHubPropertiesEventHubEndpoints
Functies	De mogelijkheden en functies die zijn ingeschakeld voor de IoT-hub.	'DeviceManagement' 'Geen'
ipFilterRules	De IP-filterregels.	IpFilterRule[]
messagingEndpoints	De eigenschappen van het berichteindpunt voor de meldingswachtrij voor het uploaden van bestanden.	IotHubPropertiesMessagingEndpoints
minTlsVersion	Hiermee geeft u de minimale TLS-versie op die moet worden ondersteund voor deze hub. Kan worden ingesteld op '1.2' om clients te hebben die een TLS-versie lager dan 1.2 gebruiken om te worden geweigerd.	snaar
networkRuleSets	Eigenschappen van set netwerkregels van IotHub	NetworkRuleSetProperties-
privateEndpointConnections	Privé-eindpuntverbindingen die zijn gemaakt op deze IotHub	PrivateEndpointConnection[]
publicNetworkAccess	Of aanvragen van openbaar netwerk zijn toegestaan	'Uitgeschakeld' 'Ingeschakeld'
restrictOutboundNetworkAccess	Indien waar, worden uitgaand verkeer van IotHub beperkt tot alleen de toegestane FQDN's die zijn geconfigureerd via allowedFqdnList.	Bool
routering	De routeringsgerelateerde eigenschappen van de IoT-hub. Zie: /azure/iot-hub/iot-hub-devguide-messaging	RoutingProperties-
storageEndpoints	De lijst met Azure Storage-eindpunten waar u bestanden kunt uploaden. Op dit moment kunt u slechts één Azure Storage-account configureren en dat moet de sleutel hebben als $default. Als u meer dan één opslagaccount opgeeft, wordt er een fout gegenereerd. Als de eigenschap enableFileUploadNotifications is ingesteld op True, wordt er geen waarde opgegeven voor deze eigenschap. Er wordt een fout gegenereerd.	IotHubPropertiesStorageEndpoints

IotHubPropertiesEventHubEndpoints

Naam	Beschrijving	Waarde

IotHubPropertiesMessagingEndpoints

Naam	Beschrijving	Waarde

IotHubPropertiesStorageEndpoints

Naam	Beschrijving	Waarde

IotHubSkuInfo

Naam	Beschrijving	Waarde
capaciteit	Het aantal ingerichte IoT Hub-eenheden. Zie: /azure/azure-subscription-service-limits#iot-hub-limits.	Int
naam	De naam van de SKU.	'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' (vereist)

IpFilterRule

Naam	Beschrijving	Waarde
actie	De gewenste actie voor aanvragen die door deze regel zijn vastgelegd.	'Accepteren' 'Weigeren' (vereist)
filterName	De naam van de IP-filterregel.	tekenreeks (vereist)
ipMask	Een tekenreeks die het IP-adresbereik in CIDR-notatie voor de regel bevat.	tekenreeks (vereist)

ManagedIdentity

Naam	Beschrijving	Waarde
userAssignedIdentity	De door de gebruiker toegewezen identiteit.	snaar

MessagingEndpointProperties

Naam	Beschrijving	Waarde
lockDurationAsIso8601	De duur van de vergrendeling. Zie: /azure/iot-hub/iot-hub-devguide-file-upload.	snaar
maxDeliveryCount	Het aantal keren dat de IoT-hub een bericht probeert te bezorgen. Zie: /azure/iot-hub/iot-hub-devguide-file-upload.	Int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 100
ttlAsIso8601	De periode waarvoor een bericht beschikbaar is om te gebruiken voordat het is verlopen door de IoT-hub. Zie: /azure/iot-hub/iot-hub-devguide-file-upload.	snaar

Microsoft.Devices/IotHubs

Naam	Beschrijving	Waarde
apiVersion	De API-versie	'2021-07-02'
etag	Het veld Etag is niet vereist. Als deze is opgegeven in de hoofdtekst van het antwoord, moet deze ook worden opgegeven als een header volgens de normale ETag-conventie.	snaar
identiteit	De beheerde identiteiten voor de IotHub.	ArmIdentity-
plaats	De resourcelocatie.	tekenreeks (vereist)
naam	De resourcenaam	tekenreeks (vereist)
Eigenschappen	IotHub-eigenschappen	IotHubProperties-
Sku	IotHub-SKU-gegevens	IotHubSkuInfo (vereist)
Tags	Resourcetags	Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen
type	Het resourcetype	'Microsoft.Devices/IotHubs'

NetworkRuleSetIpRule

Naam	Beschrijving	Waarde
actie	IP-filteractie	'Toestaan'
filterName	Naam van de IP-filterregel.	tekenreeks (vereist)
ipMask	Een tekenreeks die het IP-adresbereik in CIDR-notatie voor de regel bevat.	tekenreeks (vereist)

NetworkRuleSetProperties

Naam	Beschrijving	Waarde
applyToBuiltInEventHubEndpoint	Indien waar, wordt de netwerkregelset ook toegepast op builtIn EventHub EndPoint van IotHub	bool (vereist)
defaultAction	Standaardactie voor netwerkregelset	'Toestaan' 'Weigeren'
ipRules	Lijst met IP-regels	NetworkRuleSetIpRule[] (vereist)

PrivateEndpoint

Naam	Beschrijving	Waarde

PrivateEndpointConnection

Naam	Beschrijving	Waarde
Eigenschappen	De eigenschappen van een privé-eindpuntverbinding	PrivateEndpointConnectionProperties (vereist)

PrivateEndpointConnectionProperties

Naam	Beschrijving	Waarde
privateEndpoint	De eigenschap privé-eindpunt van een privé-eindpuntverbinding	PrivateEndpoint-
privateLinkServiceConnectionState	De huidige status van een privé-eindpuntverbinding	PrivateLinkServiceConnectionState (vereist)

PrivateLinkServiceConnectionState

Naam	Beschrijving	Waarde
actionsRequired	Acties die vereist zijn voor een privé-eindpuntverbinding	snaar
beschrijving	De beschrijving voor de huidige status van een privé-eindpuntverbinding	tekenreeks (vereist)
status	De status van een privé-eindpuntverbinding	'Goedgekeurd' 'Verbinding verbroken' 'In behandeling' 'Geweigerd' (vereist)

ResourceTags

Naam	Beschrijving	Waarde

RouteProperties

Naam	Beschrijving	Waarde
conditie	De voorwaarde die wordt geëvalueerd om de routeringsregel toe te passen. Als er geen voorwaarde is opgegeven, wordt standaard geëvalueerd of waar is. Zie voor grammatica: /azure/iot-hub/iot-hub-devguide-query-language	snaar
endpointNames	De lijst met eindpunten waarnaar berichten die voldoen aan de voorwaarde, worden gerouteerd. Op dit moment is slechts één eindpunt toegestaan.	tekenreeks[] (vereist)
isEnabled	Wordt gebruikt om op te geven of een route is ingeschakeld.	bool (vereist)
naam	De naam van de route. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten, mag maximaal 64 tekens lang zijn en moet uniek zijn.	snaar Beperkingen: Patroon = `^[A-Za-z0-9-._]{1,64}$` (vereist)
bron	De bron waarop de regel voor doorsturen moet worden toegepast, zoals DeviceMessages.	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Ongeldig' TwinChangeEvents (vereist)

RoutingEndpoints

Naam	Beschrijving	Waarde
eventHubs	De lijst met Event Hubs-eindpunten waarnaar IoT Hub berichten routeert op basis van de routeringsregels. Deze lijst bevat niet het ingebouwde Event Hubs-eindpunt.	RoutingEventHubProperties[]
serviceBusQueues	De lijst met Service Bus-wachtrijeindpunten waarnaar ioT Hub de berichten routeert op basis van de routeringsregels.	RoutingServiceBusQueueEndpointProperties[]
serviceBusTopics	De lijst met Service Bus-onderwerpeindpunten waarnaar de IoT-hub de berichten routeert, op basis van de routeringsregels.	RoutingServiceBusTopicEndpointProperties[]
storageContainers	De lijst met opslagcontainereindpunten waarnaar IoT Hub berichten routeert op basis van de routeringsregels.	RoutingStorageContainerProperties[]

RoutingEventHubProperties

Naam	Beschrijving	Waarde
authenticationType	Methode die wordt gebruikt voor verificatie op basis van het Event Hub-eindpunt	'identityBased' 'keyBased'
connectionString	De verbindingsreeks van het Event Hub-eindpunt.	snaar
endpointUri	De URL van het Event Hub-eindpunt. Het moet het protocol sb:// bevatten	snaar
entityPath	Event Hub-naam in de Event Hub-naamruimte	snaar
legitimatiebewijs	Id van het Event Hub-eindpunt	snaar
identiteit	Eigenschappen van beheerde identiteit van het eindpunt van de Event Hub routeren.	ManagedIdentity-
naam	De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en maximaal 64 tekens bevatten. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor eindpunttypen.	snaar Beperkingen: Patroon = `^[A-Za-z0-9-._]{1,64}$` (vereist)
resourceGroup	De naam van de resourcegroep van het Event Hub-eindpunt.	snaar
subscriptionId	De abonnements-id van het Event Hub-eindpunt.	snaar

RoutingProperties

Naam	Beschrijving	Waarde
Eindpunten	De eigenschappen met betrekking tot de aangepaste eindpunten waarnaar uw IoT-hub berichten routeert op basis van de routeringsregels. Er zijn maximaal 10 aangepaste eindpunten toegestaan voor alle eindpunttypen voor betaalde hubs en slechts 1 aangepast eindpunt is toegestaan voor alle eindpunttypen voor gratis hubs.	RoutingEndpoints
verrijkingen	De lijst met door de gebruiker geleverde verrijkingen die de IoT-hub toepast op berichten die moeten worden geleverd aan ingebouwde en aangepaste eindpunten. Zie: https://aka.ms/telemetryoneventgrid	EnrichmentProperties[]
fallbackRoute	De eigenschappen van de route die wordt gebruikt als een terugvalroute wanneer aan geen van de voorwaarden in de sectie Routes wordt voldaan. Dit is een optionele parameter. Wanneer deze eigenschap niet aanwezig is in de sjabloon, is de terugvalroute standaard uitgeschakeld.	FallbackRouteProperties-
Routes	De lijst met door de gebruiker verstrekte routeringsregels die door de IoT-hub worden gebruikt om berichten te routeren naar ingebouwde en aangepaste eindpunten. Er zijn maximaal 100 routeringsregels toegestaan voor betaalde hubs en er zijn maximaal 5 routeringsregels toegestaan voor gratis hubs.	RouteProperties[]

RoutingServiceBusQueueEndpointProperties

Naam	Beschrijving	Waarde
authenticationType	Methode die wordt gebruikt voor verificatie op basis van het eindpunt van de Service Bus-wachtrij	'identityBased' 'keyBased'
connectionString	De verbindingsreeks van het service bus-wachtrijeindpunt.	snaar
endpointUri	De URL van het service bus-wachtrijeindpunt. Het moet het protocol sb:// bevatten	snaar
entityPath	Wachtrijnaam in de Service Bus-naamruimte	snaar
legitimatiebewijs	Id van het service bus-wachtrijeindpunt	snaar
identiteit	Eigenschappen van beheerde identiteit van het eindpunt van de service bus-wachtrij.	ManagedIdentity-
naam	De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en maximaal 64 tekens bevatten. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor eindpunttypen. De naam hoeft niet hetzelfde te zijn als de werkelijke wachtrijnaam.	snaar Beperkingen: Patroon = `^[A-Za-z0-9-._]{1,64}$` (vereist)
resourceGroup	De naam van de resourcegroep van het service bus-wachtrijeindpunt.	snaar
subscriptionId	De abonnements-id van het service bus-wachtrijeindpunt.	snaar

RoutingServiceBusTopicEndpointProperties

Naam	Beschrijving	Waarde
authenticationType	Methode die wordt gebruikt voor verificatie op basis van het service bus-onderwerpeindpunt	'identityBased' 'keyBased'
connectionString	De verbindingsreeks van het service bus-onderwerpeindpunt.	snaar
endpointUri	De URL van het service bus-onderwerpeindpunt. Het moet het protocol sb:// bevatten	snaar
entityPath	Wachtrijnaam in het Service Bus-onderwerp	snaar
legitimatiebewijs	Id van het service bus-onderwerpeindpunt	snaar
identiteit	Beheerde identiteiteigenschappen van het eindpunt van het routeren van Service Bus-onderwerp.	ManagedIdentity-
naam	De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en maximaal 64 tekens bevatten. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor eindpunttypen. De naam hoeft niet hetzelfde te zijn als de werkelijke onderwerpnaam.	snaar Beperkingen: Patroon = `^[A-Za-z0-9-._]{1,64}$` (vereist)
resourceGroup	De naam van de resourcegroep van het service bus-onderwerpeindpunt.	snaar
subscriptionId	De abonnements-id van het service bus-onderwerpeindpunt.	snaar

RoutingStorageContainerProperties

Naam	Beschrijving	Waarde
authenticationType	Methode die wordt gebruikt voor verificatie op basis van het opslageindpunt	'identityBased' 'keyBased'
batchFrequencyInSeconds	Tijdsinterval waarmee blobs naar de opslag worden geschreven. De waarde moet tussen 60 en 720 seconden zijn. De standaardwaarde is 300 seconden.	Int Beperkingen: Minimumwaarde = 60 Maximumwaarde = 720
connectionString	De verbindingsreeks van het opslagaccount.	snaar
containerName	De naam van de opslagcontainer in het opslagaccount.	tekenreeks (vereist)
codering	Codering die wordt gebruikt voor het serialiseren van berichten naar blobs. Ondersteunde waarden zijn 'avro', 'avrodeflate' en 'JSON'. De standaardwaarde is 'avro'.	'Avro' 'AvroDeflate' JSON
endpointUri	De URL van het opslageindpunt. Het moet het protocol bevatten https://	snaar
fileNameFormat	Bestandsnaamindeling voor de blob. De standaardindeling is {iothub}/{partition}/{JJJJ}/{MM}/{DD}/{HH}/{mm}. Alle parameters zijn verplicht, maar kunnen opnieuw worden gerangschikt.	snaar
legitimatiebewijs	Id van het eindpunt van de opslagcontainer	snaar
identiteit	Eigenschappen van beheerde identiteit van eindpunt voor routeringsopslag.	ManagedIdentity-
maxChunkSizeInBytes	Maximum aantal bytes voor elke blob die naar de opslag is geschreven. De waarde moet tussen 10485760(10 MB) en 524288000 (500 MB) zijn. De standaardwaarde is 314572800(300 MB).	Int Beperkingen: Minimumwaarde = 10485760 Maximumwaarde = 524288000
naam	De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en maximaal 64 tekens bevatten. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor eindpunttypen.	snaar Beperkingen: Patroon = `^[A-Za-z0-9-._]{1,64}$` (vereist)
resourceGroup	De naam van de resourcegroep van het opslagaccount.	snaar
subscriptionId	De abonnements-id van het opslagaccount.	snaar

SharedAccessSignatureAuthorizationRule

Naam	Beschrijving	Waarde
keyName	De naam van het beleid voor gedeelde toegang.	tekenreeks (vereist)
primaryKey	De primaire sleutel.	snaar
rechten	De machtigingen die zijn toegewezen aan het beleid voor gedeelde toegang.	'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' (vereist)
secondaryKey	De secundaire sleutel.	snaar

StorageEndpointProperties

Naam	Beschrijving	Waarde
authenticationType	Hiermee geeft u het verificatietype op dat wordt gebruikt voor het maken van verbinding met het opslagaccount.	'identityBased' 'keyBased'
connectionString	De verbindingsreeks voor het Azure Storage-account waarnaar bestanden worden geüpload.	tekenreeks (vereist)
containerName	De naam van de hoofdcontainer waar u bestanden uploadt. De container hoeft niet te bestaan, maar moet worden gemaakt met behulp van de connectionString opgegeven.	tekenreeks (vereist)
identiteit	Eigenschappen van beheerde identiteit van opslageindpunt voor het uploaden van bestanden.	ManagedIdentity-
sasTtlAsIso8601	De periode waarvoor de SAS-URI die is gegenereerd door IoT Hub voor het uploaden van bestanden, is geldig. Zie: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.	snaar

Quickstart-sjablonen

Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.

Sjabloon	Beschrijving
Een Pay As You Go-omgeving (PAYG) maken met een IoT Hub-	Met deze sjabloon kunt u een Pay As You Go-omgeving (PAYG) Time Series Insights implementeren die is geconfigureerd om gebeurtenissen van een IoT Hub te gebruiken.
Een IoT Hub en een apparaat maken naar de cloudconsumentengroep	Met deze sjabloon kunt u een IoT Hub-exemplaar implementeren met een apparaat in de cloud en in de cloud naar configuraties voor apparaatberichten en een apparaat naar de cloudconsumentengroep.
een IOT Hub- en Ubuntu Edge-simulator maken	Met deze sjabloon maakt u een IOT Hub- en Virtual Machine Ubuntu Edge-simulator.
Een IoT Hub Device Provisioning Service- maken	Met deze sjabloon kunt u een IoT-hub en een IoT Hub Device Provisioning Service maken en de twee services aan elkaar koppelen.
Apparaatupdate maken voor Een IoT Hub-account, exemplaar, IoT Hub-	Met deze sjabloon maakt u een account en een exemplaar en een hub waarmee het exemplaar kan worden gekoppeld. De hub wordt geconfigureerd met het benodigde toegangsbeleid, de routes en de consumentengroep.
De MedTech-service implementeren, inclusief een Azure IoT Hub-	De MedTech-service is een van de Azure Health Data Services die is ontworpen voor het opnemen van apparaatgegevens van meerdere apparaten, het transformeren van de apparaatgegevens naar FHIR Observations, die vervolgens worden bewaard in de Azure Health Data Services FHIR-service.
ARM-sjabloon gebruiken om IoT Hub te maken, berichten te routeren en weer te geven	Gebruik deze sjabloon om een IoT Hub en een opslagaccount te implementeren. Voer een app uit om berichten te verzenden naar de hub die naar de opslag worden doorgestuurd en bekijk vervolgens de resultaten.

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype IotHubs kan worden geïmplementeerd met bewerkingen die zijn gericht op:

resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.Devices/IotHubs-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/IotHubs@2021-07-02"
  name = "string"
  etag = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  body = jsonencode({
    properties = {
      allowedFqdnList = [
        "string"
      ]
      authorizationPolicies = [
        {
          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 = "string"
            filterName = "string"
            ipMask = "string"
          }
        ]
      }
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {
            }
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      publicNetworkAccess = "string"
      restrictOutboundNetworkAccess = bool
      routing = {
        endpoints = {
          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"
  }
  tags = {
    {customized property} = "string"
  }
}

Eigenschapswaarden

ArmIdentity

Naam	Beschrijving	Waarde
type	Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.	'Geen' 'SystemAssigned' 'SystemAssigned, UserAssigned' UserAssigned
userAssignedIdentities	Woordenlijst van <ArmUserIdentity->	ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

Naam	Beschrijving	Waarde

ArmUserIdentity

Naam	Beschrijving	Waarde

CloudToDeviceProperties

Naam	Beschrijving	Waarde
defaultTtlAsIso8601	De standaardtijd voor live voor cloud-naar-apparaat-berichten in de apparaatwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	snaar
terugkoppeling	De eigenschappen van de feedbackwachtrij voor cloud-naar-apparaat-berichten.	FeedbackProperties-
maxDeliveryCount	Het maximale aantal bezorgingen voor cloud-naar-apparaat-berichten in de apparaatwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 100

EnrichmentProperties

Naam	Beschrijving	Waarde
endpointNames	De lijst met eindpunten waarvoor de verrijking wordt toegepast op het bericht.	tekenreeks[] (vereist)
sleutel	De sleutel of naam voor de verrijkingseigenschap.	tekenreeks (vereist)
waarde	De waarde voor de verrijkingseigenschap.	tekenreeks (vereist)

EventHubProperties

Naam	Beschrijving	Waarde
partitionCount	Het aantal partities voor het ontvangen van apparaat-naar-cloud-berichten in het event hub-compatibele eindpunt. Zie: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.	Int
retentionTimeInDays	De bewaartijd voor apparaat-naar-cloud-berichten in dagen. Zie: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	Int

FallbackRouteProperties

Naam	Beschrijving	Waarde
conditie	De voorwaarde die wordt geëvalueerd om de terugvalroute toe te passen. Als de voorwaarde niet is opgegeven, wordt standaard geëvalueerd of waar is. Zie voor grammatica: /azure/iot-hub/iot-hub-devguide-query-language	snaar
endpointNames	De lijst met eindpunten waarnaar de berichten waaraan de voorwaarde voldoet, worden doorgestuurd. Momenteel is slechts één eindpunt toegestaan.	tekenreeks[] (vereist)
isEnabled	Wordt gebruikt om op te geven of de terugvalroute is ingeschakeld.	bool (vereist)
naam	De naam van de route. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten, mag maximaal 64 tekens lang zijn en moet uniek zijn.	snaar
bron	De bron waarop de regel voor doorsturen moet worden toegepast. Bijvoorbeeld DeviceMessages	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Ongeldig' TwinChangeEvents (vereist)

FeedbackProperties

Naam	Beschrijving	Waarde
lockDurationAsIso8601	De vergrendelingsduur voor de feedbackwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	snaar
maxDeliveryCount	Het aantal keren dat de IoT-hub een bericht probeert te bezorgen in de feedbackwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 100
ttlAsIso8601	De periode waarvoor een bericht beschikbaar is om te gebruiken voordat het is verlopen door de IoT-hub. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	snaar

IotHubProperties

Naam	Beschrijving	Waarde
allowedFqdnList	Lijst met toegestane FQDN's (Fully Qualified Domain Name) voor uitgaand verkeer van IoT Hub.	tekenreeks[]
authorizationPolicies	Het beleid voor gedeelde toegang dat u kunt gebruiken om een verbinding met de IoT-hub te beveiligen.	SharedAccessSignatureAuthorizationRule[]
cloudToDevice	De eigenschappen voor cloud-naar-apparaat-berichten van IoT Hub.	CloudToDeviceProperties-
Opmerkingen	Opmerkingen bij IoT Hub.	snaar
disableDeviceSAS	Indien waar, kunnen alle apparaten (inclusief Edge-apparaten, maar met uitzondering van modules) sas-sleutels binnen het bereik niet worden gebruikt voor verificatie.	Bool
disableLocalAuth	Indien waar, kunnen SAS-tokens met sas-sleutels met ioT-bereik niet worden gebruikt voor verificatie.	Bool
disableModuleSAS	Indien waar, kunnen alle SAS-sleutels met modulebereik niet worden gebruikt voor verificatie.	Bool
enableDataResidency	Met deze eigenschap wanneer deze is ingesteld op true, wordt gegevenslocatie ingeschakeld, waardoor herstel na noodgevallen wordt uitgeschakeld.	Bool
enableFileUploadNotifications	Indien waar, worden meldingen voor het uploaden van bestanden ingeschakeld.	Bool
eventHubEndpoints	De eigenschappen van het Event Hub-compatibele eindpunt. De enige mogelijke sleutels voor deze woordenlijst zijn gebeurtenissen. Deze sleutel moet aanwezig zijn in de woordenlijst tijdens het maken of bijwerken van aanroepen voor de IoT-hub.	IotHubPropertiesEventHubEndpoints
Functies	De mogelijkheden en functies die zijn ingeschakeld voor de IoT-hub.	'DeviceManagement' 'Geen'
ipFilterRules	De IP-filterregels.	IpFilterRule[]
messagingEndpoints	De eigenschappen van het berichteindpunt voor de meldingswachtrij voor het uploaden van bestanden.	IotHubPropertiesMessagingEndpoints
minTlsVersion	Hiermee geeft u de minimale TLS-versie op die moet worden ondersteund voor deze hub. Kan worden ingesteld op '1.2' om clients te hebben die een TLS-versie lager dan 1.2 gebruiken om te worden geweigerd.	snaar
networkRuleSets	Eigenschappen van set netwerkregels van IotHub	NetworkRuleSetProperties-
privateEndpointConnections	Privé-eindpuntverbindingen die zijn gemaakt op deze IotHub	PrivateEndpointConnection[]
publicNetworkAccess	Of aanvragen van openbaar netwerk zijn toegestaan	'Uitgeschakeld' 'Ingeschakeld'
restrictOutboundNetworkAccess	Indien waar, worden uitgaand verkeer van IotHub beperkt tot alleen de toegestane FQDN's die zijn geconfigureerd via allowedFqdnList.	Bool
routering	De routeringsgerelateerde eigenschappen van de IoT-hub. Zie: /azure/iot-hub/iot-hub-devguide-messaging	RoutingProperties-
storageEndpoints	De lijst met Azure Storage-eindpunten waar u bestanden kunt uploaden. Op dit moment kunt u slechts één Azure Storage-account configureren en dat moet de sleutel hebben als $default. Als u meer dan één opslagaccount opgeeft, wordt er een fout gegenereerd. Als de eigenschap enableFileUploadNotifications is ingesteld op True, wordt er geen waarde opgegeven voor deze eigenschap. Er wordt een fout gegenereerd.	IotHubPropertiesStorageEndpoints

IotHubPropertiesEventHubEndpoints

Naam	Beschrijving	Waarde

IotHubPropertiesMessagingEndpoints

Naam	Beschrijving	Waarde

IotHubPropertiesStorageEndpoints

Naam	Beschrijving	Waarde

IotHubSkuInfo

Naam	Beschrijving	Waarde
capaciteit	Het aantal ingerichte IoT Hub-eenheden. Zie: /azure/azure-subscription-service-limits#iot-hub-limits.	Int
naam	De naam van de SKU.	'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' (vereist)

IpFilterRule

Naam	Beschrijving	Waarde
actie	De gewenste actie voor aanvragen die door deze regel zijn vastgelegd.	'Accepteren' 'Weigeren' (vereist)
filterName	De naam van de IP-filterregel.	tekenreeks (vereist)
ipMask	Een tekenreeks die het IP-adresbereik in CIDR-notatie voor de regel bevat.	tekenreeks (vereist)

ManagedIdentity

Naam	Beschrijving	Waarde
userAssignedIdentity	De door de gebruiker toegewezen identiteit.	snaar

MessagingEndpointProperties

Naam	Beschrijving	Waarde
lockDurationAsIso8601	De duur van de vergrendeling. Zie: /azure/iot-hub/iot-hub-devguide-file-upload.	snaar
maxDeliveryCount	Het aantal keren dat de IoT-hub een bericht probeert te bezorgen. Zie: /azure/iot-hub/iot-hub-devguide-file-upload.	Int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 100
ttlAsIso8601	De periode waarvoor een bericht beschikbaar is om te gebruiken voordat het is verlopen door de IoT-hub. Zie: /azure/iot-hub/iot-hub-devguide-file-upload.	snaar

Microsoft.Devices/IotHubs

Naam	Beschrijving	Waarde
etag	Het veld Etag is niet vereist. Als deze is opgegeven in de hoofdtekst van het antwoord, moet deze ook worden opgegeven als een header volgens de normale ETag-conventie.	snaar
identiteit	De beheerde identiteiten voor de IotHub.	ArmIdentity-
plaats	De resourcelocatie.	tekenreeks (vereist)
naam	De resourcenaam	tekenreeks (vereist)
Eigenschappen	IotHub-eigenschappen	IotHubProperties-
Sku	IotHub-SKU-gegevens	IotHubSkuInfo (vereist)
Tags	Resourcetags	Woordenlijst met tagnamen en -waarden.
type	Het resourcetype	"Microsoft.Devices/IotHubs@2021-07-02"

NetworkRuleSetIpRule

Naam	Beschrijving	Waarde
actie	IP-filteractie	'Toestaan'
filterName	Naam van de IP-filterregel.	tekenreeks (vereist)
ipMask	Een tekenreeks die het IP-adresbereik in CIDR-notatie voor de regel bevat.	tekenreeks (vereist)

NetworkRuleSetProperties

Naam	Beschrijving	Waarde
applyToBuiltInEventHubEndpoint	Indien waar, wordt de netwerkregelset ook toegepast op builtIn EventHub EndPoint van IotHub	bool (vereist)
defaultAction	Standaardactie voor netwerkregelset	'Toestaan' 'Weigeren'
ipRules	Lijst met IP-regels	NetworkRuleSetIpRule[] (vereist)

PrivateEndpoint

Naam	Beschrijving	Waarde

PrivateEndpointConnection

Naam	Beschrijving	Waarde
Eigenschappen	De eigenschappen van een privé-eindpuntverbinding	PrivateEndpointConnectionProperties (vereist)

PrivateEndpointConnectionProperties

Naam	Beschrijving	Waarde
privateEndpoint	De eigenschap privé-eindpunt van een privé-eindpuntverbinding	PrivateEndpoint-
privateLinkServiceConnectionState	De huidige status van een privé-eindpuntverbinding	PrivateLinkServiceConnectionState (vereist)

PrivateLinkServiceConnectionState

Naam	Beschrijving	Waarde
actionsRequired	Acties die vereist zijn voor een privé-eindpuntverbinding	snaar
beschrijving	De beschrijving voor de huidige status van een privé-eindpuntverbinding	tekenreeks (vereist)
status	De status van een privé-eindpuntverbinding	'Goedgekeurd' 'Verbinding verbroken' 'In behandeling' 'Geweigerd' (vereist)

ResourceTags

Naam	Beschrijving	Waarde

RouteProperties

Naam	Beschrijving	Waarde
conditie	De voorwaarde die wordt geëvalueerd om de routeringsregel toe te passen. Als er geen voorwaarde is opgegeven, wordt standaard geëvalueerd of waar is. Zie voor grammatica: /azure/iot-hub/iot-hub-devguide-query-language	snaar
endpointNames	De lijst met eindpunten waarnaar berichten die voldoen aan de voorwaarde, worden gerouteerd. Op dit moment is slechts één eindpunt toegestaan.	tekenreeks[] (vereist)
isEnabled	Wordt gebruikt om op te geven of een route is ingeschakeld.	bool (vereist)
naam	De naam van de route. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten, mag maximaal 64 tekens lang zijn en moet uniek zijn.	snaar Beperkingen: Patroon = `^[A-Za-z0-9-._]{1,64}$` (vereist)
bron	De bron waarop de regel voor doorsturen moet worden toegepast, zoals DeviceMessages.	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Ongeldig' TwinChangeEvents (vereist)

RoutingEndpoints

Naam	Beschrijving	Waarde
eventHubs	De lijst met Event Hubs-eindpunten waarnaar IoT Hub berichten routeert op basis van de routeringsregels. Deze lijst bevat niet het ingebouwde Event Hubs-eindpunt.	RoutingEventHubProperties[]
serviceBusQueues	De lijst met Service Bus-wachtrijeindpunten waarnaar ioT Hub de berichten routeert op basis van de routeringsregels.	RoutingServiceBusQueueEndpointProperties[]
serviceBusTopics	De lijst met Service Bus-onderwerpeindpunten waarnaar de IoT-hub de berichten routeert, op basis van de routeringsregels.	RoutingServiceBusTopicEndpointProperties[]
storageContainers	De lijst met opslagcontainereindpunten waarnaar IoT Hub berichten routeert op basis van de routeringsregels.	RoutingStorageContainerProperties[]

RoutingEventHubProperties

Naam	Beschrijving	Waarde
authenticationType	Methode die wordt gebruikt voor verificatie op basis van het Event Hub-eindpunt	'identityBased' 'keyBased'
connectionString	De verbindingsreeks van het Event Hub-eindpunt.	snaar
endpointUri	De URL van het Event Hub-eindpunt. Het moet het protocol sb:// bevatten	snaar
entityPath	Event Hub-naam in de Event Hub-naamruimte	snaar
legitimatiebewijs	Id van het Event Hub-eindpunt	snaar
identiteit	Eigenschappen van beheerde identiteit van het eindpunt van de Event Hub routeren.	ManagedIdentity-
naam	De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en maximaal 64 tekens bevatten. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor eindpunttypen.	snaar Beperkingen: Patroon = `^[A-Za-z0-9-._]{1,64}$` (vereist)
resourceGroup	De naam van de resourcegroep van het Event Hub-eindpunt.	snaar
subscriptionId	De abonnements-id van het Event Hub-eindpunt.	snaar

RoutingProperties

Naam	Beschrijving	Waarde
Eindpunten	De eigenschappen met betrekking tot de aangepaste eindpunten waarnaar uw IoT-hub berichten routeert op basis van de routeringsregels. Er zijn maximaal 10 aangepaste eindpunten toegestaan voor alle eindpunttypen voor betaalde hubs en slechts 1 aangepast eindpunt is toegestaan voor alle eindpunttypen voor gratis hubs.	RoutingEndpoints
verrijkingen	De lijst met door de gebruiker geleverde verrijkingen die de IoT-hub toepast op berichten die moeten worden geleverd aan ingebouwde en aangepaste eindpunten. Zie: https://aka.ms/telemetryoneventgrid	EnrichmentProperties[]
fallbackRoute	De eigenschappen van de route die wordt gebruikt als een terugvalroute wanneer aan geen van de voorwaarden in de sectie Routes wordt voldaan. Dit is een optionele parameter. Wanneer deze eigenschap niet aanwezig is in de sjabloon, is de terugvalroute standaard uitgeschakeld.	FallbackRouteProperties-
Routes	De lijst met door de gebruiker verstrekte routeringsregels die door de IoT-hub worden gebruikt om berichten te routeren naar ingebouwde en aangepaste eindpunten. Er zijn maximaal 100 routeringsregels toegestaan voor betaalde hubs en er zijn maximaal 5 routeringsregels toegestaan voor gratis hubs.	RouteProperties[]

RoutingServiceBusQueueEndpointProperties

Naam	Beschrijving	Waarde
authenticationType	Methode die wordt gebruikt voor verificatie op basis van het eindpunt van de Service Bus-wachtrij	'identityBased' 'keyBased'
connectionString	De verbindingsreeks van het service bus-wachtrijeindpunt.	snaar
endpointUri	De URL van het service bus-wachtrijeindpunt. Het moet het protocol sb:// bevatten	snaar
entityPath	Wachtrijnaam in de Service Bus-naamruimte	snaar
legitimatiebewijs	Id van het service bus-wachtrijeindpunt	snaar
identiteit	Eigenschappen van beheerde identiteit van het eindpunt van de service bus-wachtrij.	ManagedIdentity-
naam	De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en maximaal 64 tekens bevatten. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor eindpunttypen. De naam hoeft niet hetzelfde te zijn als de werkelijke wachtrijnaam.	snaar Beperkingen: Patroon = `^[A-Za-z0-9-._]{1,64}$` (vereist)
resourceGroup	De naam van de resourcegroep van het service bus-wachtrijeindpunt.	snaar
subscriptionId	De abonnements-id van het service bus-wachtrijeindpunt.	snaar

RoutingServiceBusTopicEndpointProperties

Naam	Beschrijving	Waarde
authenticationType	Methode die wordt gebruikt voor verificatie op basis van het service bus-onderwerpeindpunt	'identityBased' 'keyBased'
connectionString	De verbindingsreeks van het service bus-onderwerpeindpunt.	snaar
endpointUri	De URL van het service bus-onderwerpeindpunt. Het moet het protocol sb:// bevatten	snaar
entityPath	Wachtrijnaam in het Service Bus-onderwerp	snaar
legitimatiebewijs	Id van het service bus-onderwerpeindpunt	snaar
identiteit	Beheerde identiteiteigenschappen van het eindpunt van het routeren van Service Bus-onderwerp.	ManagedIdentity-
naam	De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en maximaal 64 tekens bevatten. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor eindpunttypen. De naam hoeft niet hetzelfde te zijn als de werkelijke onderwerpnaam.	snaar Beperkingen: Patroon = `^[A-Za-z0-9-._]{1,64}$` (vereist)
resourceGroup	De naam van de resourcegroep van het service bus-onderwerpeindpunt.	snaar
subscriptionId	De abonnements-id van het service bus-onderwerpeindpunt.	snaar

RoutingStorageContainerProperties

Naam	Beschrijving	Waarde
authenticationType	Methode die wordt gebruikt voor verificatie op basis van het opslageindpunt	'identityBased' 'keyBased'
batchFrequencyInSeconds	Tijdsinterval waarmee blobs naar de opslag worden geschreven. De waarde moet tussen 60 en 720 seconden zijn. De standaardwaarde is 300 seconden.	Int Beperkingen: Minimumwaarde = 60 Maximumwaarde = 720
connectionString	De verbindingsreeks van het opslagaccount.	snaar
containerName	De naam van de opslagcontainer in het opslagaccount.	tekenreeks (vereist)
codering	Codering die wordt gebruikt voor het serialiseren van berichten naar blobs. Ondersteunde waarden zijn 'avro', 'avrodeflate' en 'JSON'. De standaardwaarde is 'avro'.	'Avro' 'AvroDeflate' JSON
endpointUri	De URL van het opslageindpunt. Het moet het protocol bevatten https://	snaar
fileNameFormat	Bestandsnaamindeling voor de blob. De standaardindeling is {iothub}/{partition}/{JJJJ}/{MM}/{DD}/{HH}/{mm}. Alle parameters zijn verplicht, maar kunnen opnieuw worden gerangschikt.	snaar
legitimatiebewijs	Id van het eindpunt van de opslagcontainer	snaar
identiteit	Eigenschappen van beheerde identiteit van eindpunt voor routeringsopslag.	ManagedIdentity-
maxChunkSizeInBytes	Maximum aantal bytes voor elke blob die naar de opslag is geschreven. De waarde moet tussen 10485760(10 MB) en 524288000 (500 MB) zijn. De standaardwaarde is 314572800(300 MB).	Int Beperkingen: Minimumwaarde = 10485760 Maximumwaarde = 524288000
naam	De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en maximaal 64 tekens bevatten. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor eindpunttypen.	snaar Beperkingen: Patroon = `^[A-Za-z0-9-._]{1,64}$` (vereist)
resourceGroup	De naam van de resourcegroep van het opslagaccount.	snaar
subscriptionId	De abonnements-id van het opslagaccount.	snaar

SharedAccessSignatureAuthorizationRule

Naam	Beschrijving	Waarde
keyName	De naam van het beleid voor gedeelde toegang.	tekenreeks (vereist)
primaryKey	De primaire sleutel.	snaar
rechten	De machtigingen die zijn toegewezen aan het beleid voor gedeelde toegang.	'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' (vereist)
secondaryKey	De secundaire sleutel.	snaar

StorageEndpointProperties

Naam	Beschrijving	Waarde
authenticationType	Hiermee geeft u het verificatietype op dat wordt gebruikt voor het maken van verbinding met het opslagaccount.	'identityBased' 'keyBased'
connectionString	De verbindingsreeks voor het Azure Storage-account waarnaar bestanden worden geüpload.	tekenreeks (vereist)
containerName	De naam van de hoofdcontainer waar u bestanden uploadt. De container hoeft niet te bestaan, maar moet worden gemaakt met behulp van de connectionString opgegeven.	tekenreeks (vereist)
identiteit	Eigenschappen van beheerde identiteit van opslageindpunt voor het uploaden van bestanden.	ManagedIdentity-
sasTtlAsIso8601	De periode waarvoor de SAS-URI die is gegenereerd door IoT Hub voor het uploaden van bestanden, is geldig. Zie: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.	snaar

Delen via

Microsoft.Devices IotHubs 2021-07-02

Bicep-resourcedefinitie

Resource-indeling

Eigenschapswaarden

ArmIdentity

ArmIdentityUserAssignedIdentities

ArmUserIdentity

CloudToDeviceProperties

EnrichmentProperties

EventHubProperties

FallbackRouteProperties

FeedbackProperties

IotHubProperties

IotHubPropertiesEventHubEndpoints

IotHubPropertiesMessagingEndpoints

IotHubPropertiesStorageEndpoints

IotHubSkuInfo

IpFilterRule

ManagedIdentity

MessagingEndpointProperties

Microsoft.Devices/IotHubs

NetworkRuleSetIpRule

NetworkRuleSetProperties

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

ResourceTags

RouteProperties

RoutingEndpoints

RoutingEventHubProperties

RoutingProperties

RoutingServiceBusQueueEndpointProperties

RoutingServiceBusTopicEndpointProperties

RoutingStorageContainerProperties

SharedAccessSignatureAuthorizationRule

StorageEndpointProperties

Quickstart-voorbeelden

Resourcedefinitie van ARM-sjabloon

Resource-indeling

Eigenschapswaarden

ArmIdentity

ArmIdentityUserAssignedIdentities

ArmUserIdentity

CloudToDeviceProperties

EnrichmentProperties

EventHubProperties

FallbackRouteProperties

FeedbackProperties

IotHubProperties

IotHubPropertiesEventHubEndpoints

IotHubPropertiesMessagingEndpoints

IotHubPropertiesStorageEndpoints

IotHubSkuInfo

IpFilterRule

ManagedIdentity

MessagingEndpointProperties

Microsoft.Devices/IotHubs

NetworkRuleSetIpRule

NetworkRuleSetProperties

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

ResourceTags

RouteProperties

RoutingEndpoints

RoutingEventHubProperties

RoutingProperties

RoutingServiceBusQueueEndpointProperties

RoutingServiceBusTopicEndpointProperties

RoutingStorageContainerProperties

SharedAccessSignatureAuthorizationRule

StorageEndpointProperties

Quickstart-sjablonen

Resourcedefinitie van Terraform (AzAPI-provider)

Resource-indeling

Eigenschapswaarden

ArmIdentity