Microsoft.Devices IotHubs 2016-02-03
- senaste
- 2023-06-30
- 2023-06-30-preview
- 2022-11-15-preview
- 2022-04-30-preview
- 2021-07-02
- 2021-07-02-preview
- 2021-07-01
- 2021-07-01-preview
- 2021-03-31
- 2021-03-03-preview
- 2021-02-01-preview
- 2020-08-31
- 2020-08-31-preview
- 2020-08-01
- 2020-07-10-preview
- 2020-06-15
- 2020-04-01
- 2020-03-01
- 2019-11-04
- 2019-07-01-preview
- 2019-03-22
- 2019-03-22-preview
- 2018-12-01-preview
- 2018-04-01
- 2018-01-22
- 2017-07-01
- 2017-01-19
- 2016-02-03
Bicep-resursdefinition
Resurstypen IotHubs kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.Devices/IotHubs-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.Devices/IotHubs@2016-02-03' = {
etag: 'string'
location: 'string'
name: 'string'
properties: {
authorizationPolicies: [
{
keyName: 'string'
primaryKey: 'string'
rights: 'string'
secondaryKey: 'string'
}
]
cloudToDevice: {
defaultTtlAsIso8601: 'string'
feedback: {
lockDurationAsIso8601: 'string'
maxDeliveryCount: int
ttlAsIso8601: 'string'
}
maxDeliveryCount: int
}
comments: 'string'
enableFileUploadNotifications: bool
eventHubEndpoints: {
{customized property}: {
partitionCount: int
retentionTimeInDays: int
}
}
features: 'string'
ipFilterRules: [
{
action: 'string'
filterName: 'string'
ipMask: 'string'
}
]
messagingEndpoints: {
{customized property}: {
lockDurationAsIso8601: 'string'
maxDeliveryCount: int
ttlAsIso8601: 'string'
}
}
operationsMonitoringProperties: {
events: {
{customized property}: 'string'
}
}
storageEndpoints: {
{customized property}: {
connectionString: 'string'
containerName: 'string'
sasTtlAsIso8601: 'string'
}
}
}
resourcegroup: 'string'
sku: {
capacity: int
name: 'string'
}
subscriptionid: 'string'
tags: {
{customized property}: 'string'
}
}
Egenskapsvärden
CloudToDeviceProperties
Namn | Beskrivning | Värde |
---|---|---|
defaultTtlAsIso8601 | Standardtiden för att leva för meddelanden från moln till enhet i enhetskön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | sträng |
feedback | Egenskaperna för feedbackkön för meddelanden från moln till enhet. | FeedbackEgenskaper |
maxDeliveryCount | Det maximala leveransantalet för meddelanden från moln till enhet i enhetskön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Begränsningar: Minsta värde = 1 Maxvärde = 100 |
EventHubProperties
Namn | Beskrivning | Värde |
---|---|---|
partitionCount | Antalet partitioner för att ta emot meddelanden från enhet till moln i den Event Hub-kompatibla slutpunkten. Se: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | Int |
retentionTimeInDays | Kvarhållningstiden för meddelanden från enhet till moln i dagar. Se: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | Int |
FeedbackEgenskaper
Namn | Beskrivning | Värde |
---|---|---|
lockDurationAsIso8601 | Låsvaraktigheten för feedbackkön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | sträng |
maxDeliveryCount | Antalet gånger som IoT-hubben försöker leverera ett meddelande i feedbackkön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Begränsningar: Minsta värde = 1 Maxvärde = 100 |
ttlAsIso8601 | Den tidsperiod för vilken ett meddelande är tillgängligt för användning innan det har upphört att gälla av IoT-hubben. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | sträng |
IotHubProperties
Namn | Beskrivning | Värde |
---|---|---|
authorizationPolicies | De principer för delad åtkomst som du kan använda för att skydda en anslutning till IoT-hubben. | SharedAccessSignatureAuthorizationRule[] |
cloudToDevice | Meddelandeegenskaperna för IoT Hub från moln till enhet. | CloudToDeviceProperties |
Kommentarer | Kommentarer. | sträng |
enableFileUploadNotifications | Om Sant aktiveras meddelanden om filuppladdning. | Bool |
eventHubEndpoints | De Event Hub-kompatibla slutpunktsegenskaperna. De möjliga nycklarna till den här ordlistan är händelser och åtgärderÖvervakaHändelser. Båda dessa nycklar måste finnas i ordlistan när du skapar eller uppdaterar anrop för IoT-hubben. | 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 |
operationsMonitoringEgenskaper | Egenskaperna för driftövervakning för IoT-hubben. Möjliga nycklar till ordlistan är Anslutningar, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. | OperationsMonitoringEgenskaper |
storageEndpoints | Listan över Azure Storage-slutpunkter där du kan ladda upp filer. För närvarande kan du bara konfigurera ett Azure Storage-konto och som MÅSTE ha dess nyckel som $default. Om du anger fler än ett lagringskonto genereras ett fel. Om du inte anger något värde för den här egenskapen när egenskapen enableFileUploadNotifications har angetts till True utlöses ett fel. | IotHubPropertiesStorageEndpoints |
IotHubPropertiesEventHubEndpoints
Namn | Beskrivning | Värde |
---|
IotHubPropertiesMessagingEndpoints
Namn | Beskrivning | Värde |
---|
IotHubPropertiesStorageEndpoints
Namn | Beskrivning | Värde |
---|
IotHubSkuInfo
Namn | Beskrivning | Värde |
---|---|---|
kapacitet | Antalet etablerade IoT Hub-enheter. Se: /azure/azure-subscription-service-limits#iot-hub-limits. | int (krävs) |
Namn | Namnet på SKU:n. | "F1" "S1" "S2" "S3" (krävs) |
IpFilterRule
Namn | Beskrivning | Värde |
---|---|---|
handling | Önskad åtgärd för begäranden som samlas in av den här regeln. | "Acceptera" "Avvisa" (krävs) |
filterName | Namnet på IP-filterregeln. | sträng (krävs) |
ipMask | En sträng som innehåller IP-adressintervallet i CIDR-notationen för regeln. | sträng (krävs) |
MessagingEndpointProperties
Namn | Beskrivning | Värde |
---|---|---|
lockDurationAsIso8601 | Låsets varaktighet. Se: /azure/iot-hub/iot-hub-devguide-file-upload. | sträng |
maxDeliveryCount | Antalet gånger som IoT-hubben försöker leverera ett meddelande. Se: /azure/iot-hub/iot-hub-devguide-file-upload. | Int Begränsningar: Minsta värde = 1 Maxvärde = 100 |
ttlAsIso8601 | Den tidsperiod för vilken ett meddelande är tillgängligt för användning innan det har upphört att gälla av IoT-hubben. Se: /azure/iot-hub/iot-hub-devguide-file-upload. | sträng |
Microsoft.Devices/IotHubs
Namn | Beskrivning | Värde |
---|---|---|
etag | Fältet Etag är inte krävs. Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen. | sträng |
plats | Resursplatsen. | sträng (krävs) |
Namn | Resursnamnet | sträng (krävs) |
Egenskaper | Egenskaperna för en IoT-hubb. | IotHubProperties |
resourcegroup | Namnet på resursgruppen som innehåller IoT-hubben. Ett resursgruppsnamn identifierar resursgruppen unikt i prenumerationen. | sträng (krävs) |
Sku | Information om SKU:n för IoT-hubben. | IotHubSkuInfo (krävs) |
subscriptionid | Prenumerationsidentifieraren. | sträng (krävs) |
Taggar | Resurstaggar | Ordlista med taggnamn och värden. Se taggar i mallar |
OperationsMonitoringEgenskaper
Namn | Beskrivning | Värde |
---|---|---|
evenemang | Ordlista för <OperationMonitoringLevel> | OperationsMonitoringPropertiesEvents |
OperationsMonitoringPropertiesEvents
Namn | Beskrivning | Värde |
---|
ResourceTags
Namn | Beskrivning | Värde |
---|
SharedAccessSignatureAuthorizationRule
Namn | Beskrivning | Värde |
---|---|---|
keyName | Namnet på principen för delad åtkomst. | sträng (krävs) |
primaryKey | Primärnyckeln. | sträng |
rättigheter | De behörigheter som tilldelats principen för delad åtkomst. | "DeviceConnect" "RegistryRead" "RegistryRead, DeviceConnect" "RegistryRead, RegistryWrite" "RegistryRead, RegistryWrite, DeviceConnect" "RegistryRead, RegistryWrite, ServiceConnect" "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect" "RegistryRead, ServiceConnect" "RegistryRead, ServiceConnect, DeviceConnect" "RegistryWrite" "RegistryWrite, DeviceConnect" "RegistryWrite, ServiceConnect" "RegistryWrite, ServiceConnect, DeviceConnect" "ServiceConnect" "ServiceConnect, DeviceConnect" (krävs) |
secondaryKey | Den sekundära nyckeln. | sträng |
StorageEndpointProperties
Namn | Beskrivning | Värde |
---|---|---|
connectionString | Anslutningssträngen för Det Azure Storage-konto som filerna laddas upp till. | sträng (krävs) |
containerName | Namnet på rotcontainern där du laddar upp filer. Containern behöver inte finnas men bör vara kreatabell med hjälp av den angivna connectionString.the container need not exist but should be creatable using the connectionString specified. | sträng (krävs) |
sasTtlAsIso8601 | Den tidsperiod för vilken SAS-URI:n som genererats av IoT Hub för filuppladdning är giltig. Se: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | sträng |
Användningsexempel
Azure-snabbstartsexempel
Följande Azure-snabbstartsmallar innehålla Bicep-exempel för distribution av den här resurstypen.
Bicep-fil | Beskrivning |
---|---|
Skapa en IoT Hub och en enhet till molnkonsumentgrupp | Med den här mallen kan du distribuera en IoT Hub-instans med enheten till molnet och molnet till enhetsmeddelandekonfigurationer och en enhet till molnkonsumentgruppen. |
Skapa en IoT Hub Device Provisioning-tjänst | Med den här mallen kan du skapa en IoT-hubb och en IoT Hub Device Provisioning-tjänst och länka ihop de två tjänsterna. |
Skapa enhetsuppdatering för IoT Hub-konto, instans, IoT Hub- | Den här mallen skapar ett konto, en instans och en hubb att länka instansen med. Den konfigurerar hubben med nödvändiga åtkomstprinciper, vägar och konsumentgrupper. |
Distribuera MedTech-tjänsten, inklusive en Azure IoT Hub- | MedTech-tjänsten är en av Azure Health Data Services som är utformad för att mata in enhetsdata från flera enheter, omvandla enhetsdata till FHIR-observationer, som sedan sparas i Azure Health Data Services FHIR-tjänsten. |
Använd ARM-mall för att skapa IoT Hub, dirigera och visa meddelanden | Använd den här mallen för att distribuera en IoT Hub och ett lagringskonto. Kör en app för att skicka meddelanden till den hubb som dirigeras till lagringen och visa sedan resultatet. |
Resursdefinition för ARM-mall
Resurstypen IotHubs kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.Devices/IotHubs-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.Devices/IotHubs",
"apiVersion": "2016-02-03",
"name": "string",
"etag": "string",
"location": "string",
"properties": {
"authorizationPolicies": [
{
"keyName": "string",
"primaryKey": "string",
"rights": "string",
"secondaryKey": "string"
}
],
"cloudToDevice": {
"defaultTtlAsIso8601": "string",
"feedback": {
"lockDurationAsIso8601": "string",
"maxDeliveryCount": "int",
"ttlAsIso8601": "string"
},
"maxDeliveryCount": "int"
},
"comments": "string",
"enableFileUploadNotifications": "bool",
"eventHubEndpoints": {
"{customized property}": {
"partitionCount": "int",
"retentionTimeInDays": "int"
}
},
"features": "string",
"ipFilterRules": [
{
"action": "string",
"filterName": "string",
"ipMask": "string"
}
],
"messagingEndpoints": {
"{customized property}": {
"lockDurationAsIso8601": "string",
"maxDeliveryCount": "int",
"ttlAsIso8601": "string"
}
},
"operationsMonitoringProperties": {
"events": {
"{customized property}": "string"
}
},
"storageEndpoints": {
"{customized property}": {
"connectionString": "string",
"containerName": "string",
"sasTtlAsIso8601": "string"
}
}
},
"resourcegroup": "string",
"sku": {
"capacity": "int",
"name": "string"
},
"subscriptionid": "string",
"tags": {
"{customized property}": "string"
}
}
Egenskapsvärden
CloudToDeviceProperties
Namn | Beskrivning | Värde |
---|---|---|
defaultTtlAsIso8601 | Standardtiden för att leva för meddelanden från moln till enhet i enhetskön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | sträng |
feedback | Egenskaperna för feedbackkön för meddelanden från moln till enhet. | FeedbackEgenskaper |
maxDeliveryCount | Det maximala leveransantalet för meddelanden från moln till enhet i enhetskön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Begränsningar: Minsta värde = 1 Maxvärde = 100 |
EventHubProperties
Namn | Beskrivning | Värde |
---|---|---|
partitionCount | Antalet partitioner för att ta emot meddelanden från enhet till moln i den Event Hub-kompatibla slutpunkten. Se: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | Int |
retentionTimeInDays | Kvarhållningstiden för meddelanden från enhet till moln i dagar. Se: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | Int |
FeedbackEgenskaper
Namn | Beskrivning | Värde |
---|---|---|
lockDurationAsIso8601 | Låsvaraktigheten för feedbackkön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | sträng |
maxDeliveryCount | Antalet gånger som IoT-hubben försöker leverera ett meddelande i feedbackkön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Begränsningar: Minsta värde = 1 Maxvärde = 100 |
ttlAsIso8601 | Den tidsperiod för vilken ett meddelande är tillgängligt för användning innan det har upphört att gälla av IoT-hubben. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | sträng |
IotHubProperties
Namn | Beskrivning | Värde |
---|---|---|
authorizationPolicies | De principer för delad åtkomst som du kan använda för att skydda en anslutning till IoT-hubben. | SharedAccessSignatureAuthorizationRule[] |
cloudToDevice | Meddelandeegenskaperna för IoT Hub från moln till enhet. | CloudToDeviceProperties |
Kommentarer | Kommentarer. | sträng |
enableFileUploadNotifications | Om Sant aktiveras meddelanden om filuppladdning. | Bool |
eventHubEndpoints | De Event Hub-kompatibla slutpunktsegenskaperna. De möjliga nycklarna till den här ordlistan är händelser och åtgärderÖvervakaHändelser. Båda dessa nycklar måste finnas i ordlistan när du skapar eller uppdaterar anrop för IoT-hubben. | 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 |
operationsMonitoringEgenskaper | Egenskaperna för driftövervakning för IoT-hubben. Möjliga nycklar till ordlistan är Anslutningar, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. | OperationsMonitoringEgenskaper |
storageEndpoints | Listan över Azure Storage-slutpunkter där du kan ladda upp filer. För närvarande kan du bara konfigurera ett Azure Storage-konto och som MÅSTE ha dess nyckel som $default. Om du anger fler än ett lagringskonto genereras ett fel. Om du inte anger något värde för den här egenskapen när egenskapen enableFileUploadNotifications har angetts till True utlöses ett fel. | IotHubPropertiesStorageEndpoints |
IotHubPropertiesEventHubEndpoints
Namn | Beskrivning | Värde |
---|
IotHubPropertiesMessagingEndpoints
Namn | Beskrivning | Värde |
---|
IotHubPropertiesStorageEndpoints
Namn | Beskrivning | Värde |
---|
IotHubSkuInfo
Namn | Beskrivning | Värde |
---|---|---|
kapacitet | Antalet etablerade IoT Hub-enheter. Se: /azure/azure-subscription-service-limits#iot-hub-limits. | int (krävs) |
Namn | Namnet på SKU:n. | "F1" "S1" "S2" "S3" (krävs) |
IpFilterRule
Namn | Beskrivning | Värde |
---|---|---|
handling | Önskad åtgärd för begäranden som samlas in av den här regeln. | "Acceptera" "Avvisa" (krävs) |
filterName | Namnet på IP-filterregeln. | sträng (krävs) |
ipMask | En sträng som innehåller IP-adressintervallet i CIDR-notationen för regeln. | sträng (krävs) |
MessagingEndpointProperties
Namn | Beskrivning | Värde |
---|---|---|
lockDurationAsIso8601 | Låsets varaktighet. Se: /azure/iot-hub/iot-hub-devguide-file-upload. | sträng |
maxDeliveryCount | Antalet gånger som IoT-hubben försöker leverera ett meddelande. Se: /azure/iot-hub/iot-hub-devguide-file-upload. | Int Begränsningar: Minsta värde = 1 Maxvärde = 100 |
ttlAsIso8601 | Den tidsperiod för vilken ett meddelande är tillgängligt för användning innan det har upphört att gälla av IoT-hubben. Se: /azure/iot-hub/iot-hub-devguide-file-upload. | sträng |
Microsoft.Devices/IotHubs
Namn | Beskrivning | Värde |
---|---|---|
apiVersion | API-versionen | '2016-02-03' |
etag | Fältet Etag är inte krävs. Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen. | sträng |
plats | Resursplatsen. | sträng (krävs) |
Namn | Resursnamnet | sträng (krävs) |
Egenskaper | Egenskaperna för en IoT-hubb. | IotHubProperties |
resourcegroup | Namnet på resursgruppen som innehåller IoT-hubben. Ett resursgruppsnamn identifierar resursgruppen unikt i prenumerationen. | sträng (krävs) |
Sku | Information om SKU:n för IoT-hubben. | IotHubSkuInfo (krävs) |
subscriptionid | Prenumerationsidentifieraren. | sträng (krävs) |
Taggar | Resurstaggar | Ordlista med taggnamn och värden. Se taggar i mallar |
typ | Resurstypen | "Microsoft.Devices/IotHubs" |
OperationsMonitoringEgenskaper
Namn | Beskrivning | Värde |
---|---|---|
evenemang | Ordlista för <OperationMonitoringLevel> | OperationsMonitoringPropertiesEvents |
OperationsMonitoringPropertiesEvents
Namn | Beskrivning | Värde |
---|
ResourceTags
Namn | Beskrivning | Värde |
---|
SharedAccessSignatureAuthorizationRule
Namn | Beskrivning | Värde |
---|---|---|
keyName | Namnet på principen för delad åtkomst. | sträng (krävs) |
primaryKey | Primärnyckeln. | sträng |
rättigheter | De behörigheter som tilldelats principen för delad åtkomst. | "DeviceConnect" "RegistryRead" "RegistryRead, DeviceConnect" "RegistryRead, RegistryWrite" "RegistryRead, RegistryWrite, DeviceConnect" "RegistryRead, RegistryWrite, ServiceConnect" "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect" "RegistryRead, ServiceConnect" "RegistryRead, ServiceConnect, DeviceConnect" "RegistryWrite" "RegistryWrite, DeviceConnect" "RegistryWrite, ServiceConnect" "RegistryWrite, ServiceConnect, DeviceConnect" "ServiceConnect" "ServiceConnect, DeviceConnect" (krävs) |
secondaryKey | Den sekundära nyckeln. | sträng |
StorageEndpointProperties
Namn | Beskrivning | Värde |
---|---|---|
connectionString | Anslutningssträngen för Det Azure Storage-konto som filerna laddas upp till. | sträng (krävs) |
containerName | Namnet på rotcontainern där du laddar upp filer. Containern behöver inte finnas men bör vara kreatabell med hjälp av den angivna connectionString.the container need not exist but should be creatable using the connectionString specified. | sträng (krävs) |
sasTtlAsIso8601 | Den tidsperiod för vilken SAS-URI:n som genererats av IoT Hub för filuppladdning är giltig. Se: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | sträng |
Användningsexempel
Azure-snabbstartsmallar
Följande Azure-snabbstartsmallar distribuera den här resurstypen.
Mall | Beskrivning |
---|---|
Skapa en PAYG-miljö (Betala per användning) med en IoT Hub- |
Med den här mallen kan du distribuera en Pay As You Go-miljö (PAYG) Time Series Insights som är konfigurerad för att använda händelser från en IoT Hub. |
Skapa en IoT Hub och en enhet till molnkonsumentgrupp |
Med den här mallen kan du distribuera en IoT Hub-instans med enheten till molnet och molnet till enhetsmeddelandekonfigurationer och en enhet till molnkonsumentgruppen. |
Skapa en IOT Hub- och Ubuntu-kantsimulator |
Den här mallen skapar en IOT Hub- och Virtual Machine Ubuntu edge-simulator. |
Skapa en IoT Hub Device Provisioning-tjänst |
Med den här mallen kan du skapa en IoT-hubb och en IoT Hub Device Provisioning-tjänst och länka ihop de två tjänsterna. |
Skapa enhetsuppdatering för IoT Hub-konto, instans, IoT Hub- |
Den här mallen skapar ett konto, en instans och en hubb att länka instansen med. Den konfigurerar hubben med nödvändiga åtkomstprinciper, vägar och konsumentgrupper. |
Distribuera MedTech-tjänsten, inklusive en Azure IoT Hub- |
MedTech-tjänsten är en av Azure Health Data Services som är utformad för att mata in enhetsdata från flera enheter, omvandla enhetsdata till FHIR-observationer, som sedan sparas i Azure Health Data Services FHIR-tjänsten. |
Använd ARM-mall för att skapa IoT Hub, dirigera och visa meddelanden |
Använd den här mallen för att distribuera en IoT Hub och ett lagringskonto. Kör en app för att skicka meddelanden till den hubb som dirigeras till lagringen och visa sedan resultatet. |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen IotHubs kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.Devices/IotHubs-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Devices/IotHubs@2016-02-03"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
etag = "string"
properties = {
authorizationPolicies = [
{
keyName = "string"
primaryKey = "string"
rights = "string"
secondaryKey = "string"
}
]
cloudToDevice = {
defaultTtlAsIso8601 = "string"
feedback = {
lockDurationAsIso8601 = "string"
maxDeliveryCount = int
ttlAsIso8601 = "string"
}
maxDeliveryCount = int
}
comments = "string"
enableFileUploadNotifications = bool
eventHubEndpoints = {
{customized property} = {
partitionCount = int
retentionTimeInDays = int
}
}
features = "string"
ipFilterRules = [
{
action = "string"
filterName = "string"
ipMask = "string"
}
]
messagingEndpoints = {
{customized property} = {
lockDurationAsIso8601 = "string"
maxDeliveryCount = int
ttlAsIso8601 = "string"
}
}
operationsMonitoringProperties = {
events = {
{customized property} = "string"
}
}
storageEndpoints = {
{customized property} = {
connectionString = "string"
containerName = "string"
sasTtlAsIso8601 = "string"
}
}
}
resourcegroup = "string"
sku = {
capacity = int
name = "string"
}
subscriptionid = "string"
}
}
Egenskapsvärden
CloudToDeviceProperties
Namn | Beskrivning | Värde |
---|---|---|
defaultTtlAsIso8601 | Standardtiden för att leva för meddelanden från moln till enhet i enhetskön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | sträng |
feedback | Egenskaperna för feedbackkön för meddelanden från moln till enhet. | FeedbackEgenskaper |
maxDeliveryCount | Det maximala leveransantalet för meddelanden från moln till enhet i enhetskön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Begränsningar: Minsta värde = 1 Maxvärde = 100 |
EventHubProperties
Namn | Beskrivning | Värde |
---|---|---|
partitionCount | Antalet partitioner för att ta emot meddelanden från enhet till moln i den Event Hub-kompatibla slutpunkten. Se: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | Int |
retentionTimeInDays | Kvarhållningstiden för meddelanden från enhet till moln i dagar. Se: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | Int |
FeedbackEgenskaper
Namn | Beskrivning | Värde |
---|---|---|
lockDurationAsIso8601 | Låsvaraktigheten för feedbackkön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | sträng |
maxDeliveryCount | Antalet gånger som IoT-hubben försöker leverera ett meddelande i feedbackkön. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Begränsningar: Minsta värde = 1 Maxvärde = 100 |
ttlAsIso8601 | Den tidsperiod för vilken ett meddelande är tillgängligt för användning innan det har upphört att gälla av IoT-hubben. Se: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | sträng |
IotHubProperties
Namn | Beskrivning | Värde |
---|---|---|
authorizationPolicies | De principer för delad åtkomst som du kan använda för att skydda en anslutning till IoT-hubben. | SharedAccessSignatureAuthorizationRule[] |
cloudToDevice | Meddelandeegenskaperna för IoT Hub från moln till enhet. | CloudToDeviceProperties |
Kommentarer | Kommentarer. | sträng |
enableFileUploadNotifications | Om Sant aktiveras meddelanden om filuppladdning. | Bool |
eventHubEndpoints | De Event Hub-kompatibla slutpunktsegenskaperna. De möjliga nycklarna till den här ordlistan är händelser och åtgärderÖvervakaHändelser. Båda dessa nycklar måste finnas i ordlistan när du skapar eller uppdaterar anrop för IoT-hubben. | 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 |
operationsMonitoringEgenskaper | Egenskaperna för driftövervakning för IoT-hubben. Möjliga nycklar till ordlistan är Anslutningar, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. | OperationsMonitoringEgenskaper |
storageEndpoints | Listan över Azure Storage-slutpunkter där du kan ladda upp filer. För närvarande kan du bara konfigurera ett Azure Storage-konto och som MÅSTE ha dess nyckel som $default. Om du anger fler än ett lagringskonto genereras ett fel. Om du inte anger något värde för den här egenskapen när egenskapen enableFileUploadNotifications har angetts till True utlöses ett fel. | IotHubPropertiesStorageEndpoints |
IotHubPropertiesEventHubEndpoints
Namn | Beskrivning | Värde |
---|
IotHubPropertiesMessagingEndpoints
Namn | Beskrivning | Värde |
---|
IotHubPropertiesStorageEndpoints
Namn | Beskrivning | Värde |
---|
IotHubSkuInfo
Namn | Beskrivning | Värde |
---|---|---|
kapacitet | Antalet etablerade IoT Hub-enheter. Se: /azure/azure-subscription-service-limits#iot-hub-limits. | int (krävs) |
Namn | Namnet på SKU:n. | "F1" "S1" "S2" "S3" (krävs) |
IpFilterRule
Namn | Beskrivning | Värde |
---|---|---|
handling | Önskad åtgärd för begäranden som samlas in av den här regeln. | "Acceptera" "Avvisa" (krävs) |
filterName | Namnet på IP-filterregeln. | sträng (krävs) |
ipMask | En sträng som innehåller IP-adressintervallet i CIDR-notationen för regeln. | sträng (krävs) |
MessagingEndpointProperties
Namn | Beskrivning | Värde |
---|---|---|
lockDurationAsIso8601 | Låsets varaktighet. Se: /azure/iot-hub/iot-hub-devguide-file-upload. | sträng |
maxDeliveryCount | Antalet gånger som IoT-hubben försöker leverera ett meddelande. Se: /azure/iot-hub/iot-hub-devguide-file-upload. | Int Begränsningar: Minsta värde = 1 Maxvärde = 100 |
ttlAsIso8601 | Den tidsperiod för vilken ett meddelande är tillgängligt för användning innan det har upphört att gälla av IoT-hubben. Se: /azure/iot-hub/iot-hub-devguide-file-upload. | sträng |
Microsoft.Devices/IotHubs
Namn | Beskrivning | Värde |
---|---|---|
etag | Fältet Etag är inte krävs. Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen. | sträng |
plats | Resursplatsen. | sträng (krävs) |
Namn | Resursnamnet | sträng (krävs) |
Egenskaper | Egenskaperna för en IoT-hubb. | IotHubProperties |
resourcegroup | Namnet på resursgruppen som innehåller IoT-hubben. Ett resursgruppsnamn identifierar resursgruppen unikt i prenumerationen. | sträng (krävs) |
Sku | Information om SKU:n för IoT-hubben. | IotHubSkuInfo (krävs) |
subscriptionid | Prenumerationsidentifieraren. | sträng (krävs) |
Taggar | Resurstaggar | Ordlista med taggnamn och värden. |
typ | Resurstypen | "Microsoft.Devices/IotHubs@2016-02-03" |
OperationsMonitoringEgenskaper
Namn | Beskrivning | Värde |
---|---|---|
evenemang | Ordlista för <OperationMonitoringLevel> | OperationsMonitoringPropertiesEvents |
OperationsMonitoringPropertiesEvents
Namn | Beskrivning | Värde |
---|
ResourceTags
Namn | Beskrivning | Värde |
---|
SharedAccessSignatureAuthorizationRule
Namn | Beskrivning | Värde |
---|---|---|
keyName | Namnet på principen för delad åtkomst. | sträng (krävs) |
primaryKey | Primärnyckeln. | sträng |
rättigheter | De behörigheter som tilldelats principen för delad åtkomst. | "DeviceConnect" "RegistryRead" "RegistryRead, DeviceConnect" "RegistryRead, RegistryWrite" "RegistryRead, RegistryWrite, DeviceConnect" "RegistryRead, RegistryWrite, ServiceConnect" "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect" "RegistryRead, ServiceConnect" "RegistryRead, ServiceConnect, DeviceConnect" "RegistryWrite" "RegistryWrite, DeviceConnect" "RegistryWrite, ServiceConnect" "RegistryWrite, ServiceConnect, DeviceConnect" "ServiceConnect" "ServiceConnect, DeviceConnect" (krävs) |
secondaryKey | Den sekundära nyckeln. | sträng |
StorageEndpointProperties
Namn | Beskrivning | Värde |
---|---|---|
connectionString | Anslutningssträngen för Det Azure Storage-konto som filerna laddas upp till. | sträng (krävs) |
containerName | Namnet på rotcontainern där du laddar upp filer. Containern behöver inte finnas men bör vara kreatabell med hjälp av den angivna connectionString.the container need not exist but should be creatable using the connectionString specified. | sträng (krävs) |
sasTtlAsIso8601 | Den tidsperiod för vilken SAS-URI:n som genererats av IoT Hub för filuppladdning är giltig. Se: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | sträng |