Microsoft.Devices IotHubs 2016-02-03
- neueste
- 2023-06-30
- 2023-06-30-Preview-
- 2022-11-15-Vorschau-
- 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-Vorschau-
- 2018-12-01-Preview-
- 2018-04-01
- 2018-01-22
- 2017-07-01
- 2017-01-19
- 2016-02-03
Bicep-Ressourcendefinition
Der IotHubs-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.Devices/IotHubs-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Bicep hinzu.
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'
}
}
Eigenschaftswerte
CloudToDeviceProperties
Name | Beschreibung | Wert |
---|---|---|
defaultTtlAsIso8601 | Die Standardzeit für Cloud-zu-Gerät-Nachrichten in der Gerätewarteschlange. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Schnur |
Feedback | Die Eigenschaften der Feedbackwarteschlange für Cloud-to-Device-Nachrichten. | FeedbackProperties- |
maxDeliveryCount | Die maximale Anzahl der Zustellungen für Nachrichten in der Cloud-zu-Gerät in der Gerätewarteschlange. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Zwänge: Min.-Wert = 1 Max. Wert = 100 |
EventHubProperties
Name | Beschreibung | Wert |
---|---|---|
partitionCount | Die Anzahl der Partitionen für den Empfang von Geräte-zu-Cloud-Nachrichten im Event Hub-kompatiblen Endpunkt. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | Int |
retentionTimeInDays | Die Aufbewahrungszeit für Geräte-zu-Cloud-Nachrichten in Tagen. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | Int |
FeedbackProperties
Name | Beschreibung | Wert |
---|---|---|
lockDurationAsIso8601 | Die Sperrdauer für die Feedbackwarteschlange. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Schnur |
maxDeliveryCount | Die Häufigkeit, mit der der IoT-Hub versucht, eine Nachricht in der Feedbackwarteschlange zu übermitteln. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Zwänge: Min.-Wert = 1 Max. Wert = 100 |
ttlAsIso8601 | Der Zeitraum, für den eine Nachricht verwendet werden kann, bevor sie vom IoT-Hub abgelaufen ist. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Schnur |
IotHubProperties
Name | Beschreibung | Wert |
---|---|---|
authorizationPolicies | Die Richtlinien für den freigegebenen Zugriff, die Sie verwenden können, um eine Verbindung mit dem IoT-Hub zu sichern. | SharedAccessSignatureAuthorizationRule[] |
cloudToDevice | Die IoT-Hub-Cloud-to-Device-Messaging-Eigenschaften. | CloudToDeviceProperties |
Kommentare | Kommentare. | Schnur |
enableFileUploadNotifications | Bei "True" sind Dateiuploadbenachrichtigungen aktiviert. | Bool |
eventHubEndpoints | Die Ereignishub-kompatiblen Endpunkteigenschaften. Die möglichen Schlüssel für dieses Wörterbuch sind Ereignisse und OperationsMonitoringEvents. Beide Schlüssel müssen im Wörterbuch vorhanden sein, während Sie Aufrufe für den IoT-Hub erstellen oder aktualisieren. | IotHubPropertiesEventHubEndpoints |
Funktionen | Die Funktionen und Features, die für den IoT-Hub aktiviert sind. | "DeviceManagement" 'None' |
ipFilterRules | Die IP-Filterregeln. | IpFilterRule-[] |
messagingEndpoints | Die Messaging-Endpunkteigenschaften für die Benachrichtigungswarteschlange für den Dateiupload. | IotHubPropertiesMessagingEndpoints |
operationsMonitoringProperties | Die Betriebsüberwachungseigenschaften für den IoT-Hub. Mögliche Schlüssel für das Wörterbuch sind Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. | OperationsMonitoringProperties- |
storageEndpoints | Die Liste der Azure Storage-Endpunkte, in die Sie Dateien hochladen können. Derzeit können Sie nur ein Azure Storage-Konto konfigurieren und den Schlüssel als $default haben. Wenn Sie mehrere Speicherkonten angeben, wird ein Fehler ausgelöst. Wenn die Eigenschaft "enableFileUploadNotifications" nicht auf "True" festgelegt ist, wird ein Fehler ausgelöst. | IotHubPropertiesStorageEndpoints |
IotHubPropertiesEventHubEndpoints
Name | Beschreibung | Wert |
---|
IotHubPropertiesMessagingEndpoints
Name | Beschreibung | Wert |
---|
IotHubPropertiesStorageEndpoints
Name | Beschreibung | Wert |
---|
IotHubSkuInfo
Name | Beschreibung | Wert |
---|---|---|
Fassungsvermögen | Die Anzahl der bereitgestellten IoT Hub-Einheiten. Siehe: /azure/azure-subscription-service-limits#iot-hub-limits. | int (erforderlich) |
Name | Der Name der SKU. | 'F1' 'S1' 'S2' 'S3' (erforderlich) |
IpFilterRule
Name | Beschreibung | Wert |
---|---|---|
Aktion | Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden. | "Annehmen" "Ablehnen" (erforderlich) |
filterName | Der Name der IP-Filterregel. | Zeichenfolge (erforderlich) |
ipMask | Eine Zeichenfolge, die den IP-Adressbereich in der CIDR-Notation für die Regel enthält. | Zeichenfolge (erforderlich) |
MessagingEndpointProperties
Name | Beschreibung | Wert |
---|---|---|
lockDurationAsIso8601 | Die Sperrdauer. Siehe: /azure/iot-hub/iot-hub-devguide-file-upload. | Schnur |
maxDeliveryCount | Die Häufigkeit, mit der der IoT-Hub versucht, eine Nachricht zu übermitteln. Siehe: /azure/iot-hub/iot-hub-devguide-file-upload. | Int Zwänge: Min.-Wert = 1 Max. Wert = 100 |
ttlAsIso8601 | Der Zeitraum, für den eine Nachricht verwendet werden kann, bevor sie vom IoT-Hub abgelaufen ist. Siehe: /azure/iot-hub/iot-hub-devguide-file-upload. | Schnur |
Microsoft.Devices/IotHubs
Name | Beschreibung | Wert |
---|---|---|
etag | Das Feld "Etag" ist nicht erforderlich. Wenn sie im Antworttext bereitgestellt wird, muss sie auch als Kopfzeile gemäß der normalen ETag-Konvention bereitgestellt werden. | Schnur |
Ort | Der Ressourcenspeicherort. | Zeichenfolge (erforderlich) |
Name | Der Ressourcenname | Zeichenfolge (erforderlich) |
Eigenschaften | Die Eigenschaften eines IoT-Hubs. | IotHubProperties- |
resourcegroup | Der Name der Ressourcengruppe, die den IoT-Hub enthält. Eine Ressourcengruppe identifiziert die Ressourcengruppe innerhalb des Abonnements eindeutig. | Zeichenfolge (erforderlich) |
Sku | Informationen zur SKU des IoT-Hubs. | IotHubSkuInfo- (erforderlich) |
subscriptionid | Der Abonnementbezeichner. | Zeichenfolge (erforderlich) |
Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
OperationsMonitoringProperties
Name | Beschreibung | Wert |
---|---|---|
Ereignisse | Wörterbuch der <OperationMonitoringLevel-> | OperationsMonitoringPropertiesEvents |
OperationsMonitoringPropertiesEvents
Name | Beschreibung | Wert |
---|
ResourceTags
Name | Beschreibung | Wert |
---|
SharedAccessSignatureAuthorizationRule
Name | Beschreibung | Wert |
---|---|---|
keyName | Der Name der Richtlinie für den freigegebenen Zugriff. | Zeichenfolge (erforderlich) |
primaryKey | Der Primärschlüssel. | Schnur |
Rechte | Die Berechtigungen, die der Richtlinie für den freigegebenen Zugriff zugewiesen sind. | "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" (erforderlich) |
secondaryKey | Der sekundäre Schlüssel. | Schnur |
StorageEndpointProperties
Name | Beschreibung | Wert |
---|---|---|
connectionString | Die Verbindungszeichenfolge für das Azure Storage-Konto, in das Dateien hochgeladen werden. | Zeichenfolge (erforderlich) |
containerName | Der Name des Stammcontainers, in den Sie Dateien hochladen. Der Container muss nicht vorhanden sein, sollte jedoch mithilfe der angegebenen connectionString erstellt werden. | Zeichenfolge (erforderlich) |
sasTtlAsIso8601 | Der Zeitraum, für den der SAS-URI, der vom IoT Hub für den Dateiupload generiert wurde, gültig ist. Siehe: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | Schnur |
Schnellstartbeispiele
Die folgenden Schnellstartbeispiele stellen diesen Ressourcentyp bereit.
Bicep-Datei | Beschreibung |
---|---|
Erstellen eines IoT Hub und eines Geräts für Cloud Consumer Group | Mit dieser Vorlage können Sie eine IoT Hub-Instanz mit Gerät in der Cloud und der Cloud für Gerätenachrichtenkonfigurationen und ein Gerät in der Cloud-Consumergruppe bereitstellen. |
Erstellen eines IoT Hub-Gerätebereitstellungsdiensts | Mit dieser Vorlage können Sie einen IoT-Hub und einen IoT Hub-Gerätebereitstellungsdienst erstellen und die beiden Dienste miteinander verknüpfen. |
Erstellen des Geräteupdates für IoT Hub-Konto, Instanz, IoT Hub- | Diese Vorlage erstellt ein Konto und eine Instanz und einen Hub, mit dem die Instanz verknüpft werden soll. Er konfiguriert den Hub mit den erforderlichen Zugriffsrichtlinien, Routen und Verbrauchergruppen. |
Bereitstellen des MedTech-Diensts einschließlich eines Azure IoT Hub- | Der MedTech-Dienst ist einer der Azure Health Data Services, der zum Aufnehmen von Gerätedaten von mehreren Geräten entwickelt wurde, transformieren sie die Gerätedaten in FHIR-Beobachtungen, die dann im Azure Health Data Services-FHIR-Dienst gespeichert werden. |
Verwenden der ARM-Vorlage zum Erstellen von IoT Hub- und Routen- und Anzeigen von Nachrichten | Verwenden Sie diese Vorlage, um einen IoT Hub und ein Speicherkonto bereitzustellen. Führen Sie eine App aus, um Nachrichten an den Hub zu senden, die an den Speicher weitergeleitet werden, und zeigen Sie dann die Ergebnisse an. |
ARM-Vorlagenressourcendefinition
Der IotHubs-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.Devices/IotHubs-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"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"
}
}
Eigenschaftswerte
CloudToDeviceProperties
Name | Beschreibung | Wert |
---|---|---|
defaultTtlAsIso8601 | Die Standardzeit für Cloud-zu-Gerät-Nachrichten in der Gerätewarteschlange. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Schnur |
Feedback | Die Eigenschaften der Feedbackwarteschlange für Cloud-to-Device-Nachrichten. | FeedbackProperties- |
maxDeliveryCount | Die maximale Anzahl der Zustellungen für Nachrichten in der Cloud-zu-Gerät in der Gerätewarteschlange. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Zwänge: Min.-Wert = 1 Max. Wert = 100 |
EventHubProperties
Name | Beschreibung | Wert |
---|---|---|
partitionCount | Die Anzahl der Partitionen für den Empfang von Geräte-zu-Cloud-Nachrichten im Event Hub-kompatiblen Endpunkt. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | Int |
retentionTimeInDays | Die Aufbewahrungszeit für Geräte-zu-Cloud-Nachrichten in Tagen. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | Int |
FeedbackProperties
Name | Beschreibung | Wert |
---|---|---|
lockDurationAsIso8601 | Die Sperrdauer für die Feedbackwarteschlange. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Schnur |
maxDeliveryCount | Die Häufigkeit, mit der der IoT-Hub versucht, eine Nachricht in der Feedbackwarteschlange zu übermitteln. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Zwänge: Min.-Wert = 1 Max. Wert = 100 |
ttlAsIso8601 | Der Zeitraum, für den eine Nachricht verwendet werden kann, bevor sie vom IoT-Hub abgelaufen ist. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Schnur |
IotHubProperties
Name | Beschreibung | Wert |
---|---|---|
authorizationPolicies | Die Richtlinien für den freigegebenen Zugriff, die Sie verwenden können, um eine Verbindung mit dem IoT-Hub zu sichern. | SharedAccessSignatureAuthorizationRule[] |
cloudToDevice | Die IoT-Hub-Cloud-to-Device-Messaging-Eigenschaften. | CloudToDeviceProperties |
Kommentare | Kommentare. | Schnur |
enableFileUploadNotifications | Bei "True" sind Dateiuploadbenachrichtigungen aktiviert. | Bool |
eventHubEndpoints | Die Ereignishub-kompatiblen Endpunkteigenschaften. Die möglichen Schlüssel für dieses Wörterbuch sind Ereignisse und OperationsMonitoringEvents. Beide Schlüssel müssen im Wörterbuch vorhanden sein, während Sie Aufrufe für den IoT-Hub erstellen oder aktualisieren. | IotHubPropertiesEventHubEndpoints |
Funktionen | Die Funktionen und Features, die für den IoT-Hub aktiviert sind. | "DeviceManagement" 'None' |
ipFilterRules | Die IP-Filterregeln. | IpFilterRule-[] |
messagingEndpoints | Die Messaging-Endpunkteigenschaften für die Benachrichtigungswarteschlange für den Dateiupload. | IotHubPropertiesMessagingEndpoints |
operationsMonitoringProperties | Die Betriebsüberwachungseigenschaften für den IoT-Hub. Mögliche Schlüssel für das Wörterbuch sind Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. | OperationsMonitoringProperties- |
storageEndpoints | Die Liste der Azure Storage-Endpunkte, in die Sie Dateien hochladen können. Derzeit können Sie nur ein Azure Storage-Konto konfigurieren und den Schlüssel als $default haben. Wenn Sie mehrere Speicherkonten angeben, wird ein Fehler ausgelöst. Wenn die Eigenschaft "enableFileUploadNotifications" nicht auf "True" festgelegt ist, wird ein Fehler ausgelöst. | IotHubPropertiesStorageEndpoints |
IotHubPropertiesEventHubEndpoints
Name | Beschreibung | Wert |
---|
IotHubPropertiesMessagingEndpoints
Name | Beschreibung | Wert |
---|
IotHubPropertiesStorageEndpoints
Name | Beschreibung | Wert |
---|
IotHubSkuInfo
Name | Beschreibung | Wert |
---|---|---|
Fassungsvermögen | Die Anzahl der bereitgestellten IoT Hub-Einheiten. Siehe: /azure/azure-subscription-service-limits#iot-hub-limits. | int (erforderlich) |
Name | Der Name der SKU. | 'F1' 'S1' 'S2' 'S3' (erforderlich) |
IpFilterRule
Name | Beschreibung | Wert |
---|---|---|
Aktion | Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden. | "Annehmen" "Ablehnen" (erforderlich) |
filterName | Der Name der IP-Filterregel. | Zeichenfolge (erforderlich) |
ipMask | Eine Zeichenfolge, die den IP-Adressbereich in der CIDR-Notation für die Regel enthält. | Zeichenfolge (erforderlich) |
MessagingEndpointProperties
Name | Beschreibung | Wert |
---|---|---|
lockDurationAsIso8601 | Die Sperrdauer. Siehe: /azure/iot-hub/iot-hub-devguide-file-upload. | Schnur |
maxDeliveryCount | Die Häufigkeit, mit der der IoT-Hub versucht, eine Nachricht zu übermitteln. Siehe: /azure/iot-hub/iot-hub-devguide-file-upload. | Int Zwänge: Min.-Wert = 1 Max. Wert = 100 |
ttlAsIso8601 | Der Zeitraum, für den eine Nachricht verwendet werden kann, bevor sie vom IoT-Hub abgelaufen ist. Siehe: /azure/iot-hub/iot-hub-devguide-file-upload. | Schnur |
Microsoft.Devices/IotHubs
Name | Beschreibung | Wert |
---|---|---|
apiVersion | Die API-Version | '2016-02-03' |
etag | Das Feld "Etag" ist nicht erforderlich. Wenn sie im Antworttext bereitgestellt wird, muss sie auch als Kopfzeile gemäß der normalen ETag-Konvention bereitgestellt werden. | Schnur |
Ort | Der Ressourcenspeicherort. | Zeichenfolge (erforderlich) |
Name | Der Ressourcenname | Zeichenfolge (erforderlich) |
Eigenschaften | Die Eigenschaften eines IoT-Hubs. | IotHubProperties- |
resourcegroup | Der Name der Ressourcengruppe, die den IoT-Hub enthält. Eine Ressourcengruppe identifiziert die Ressourcengruppe innerhalb des Abonnements eindeutig. | Zeichenfolge (erforderlich) |
Sku | Informationen zur SKU des IoT-Hubs. | IotHubSkuInfo- (erforderlich) |
subscriptionid | Der Abonnementbezeichner. | Zeichenfolge (erforderlich) |
Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
Art | Der Ressourcentyp | "Microsoft.Devices/IotHubs" |
OperationsMonitoringProperties
Name | Beschreibung | Wert |
---|---|---|
Ereignisse | Wörterbuch der <OperationMonitoringLevel-> | OperationsMonitoringPropertiesEvents |
OperationsMonitoringPropertiesEvents
Name | Beschreibung | Wert |
---|
ResourceTags
Name | Beschreibung | Wert |
---|
SharedAccessSignatureAuthorizationRule
Name | Beschreibung | Wert |
---|---|---|
keyName | Der Name der Richtlinie für den freigegebenen Zugriff. | Zeichenfolge (erforderlich) |
primaryKey | Der Primärschlüssel. | Schnur |
Rechte | Die Berechtigungen, die der Richtlinie für den freigegebenen Zugriff zugewiesen sind. | "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" (erforderlich) |
secondaryKey | Der sekundäre Schlüssel. | Schnur |
StorageEndpointProperties
Name | Beschreibung | Wert |
---|---|---|
connectionString | Die Verbindungszeichenfolge für das Azure Storage-Konto, in das Dateien hochgeladen werden. | Zeichenfolge (erforderlich) |
containerName | Der Name des Stammcontainers, in den Sie Dateien hochladen. Der Container muss nicht vorhanden sein, sollte jedoch mithilfe der angegebenen connectionString erstellt werden. | Zeichenfolge (erforderlich) |
sasTtlAsIso8601 | Der Zeitraum, für den der SAS-URI, der vom IoT Hub für den Dateiupload generiert wurde, gültig ist. Siehe: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | Schnur |
Schnellstartvorlagen
Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.
Schablone | Beschreibung |
---|---|
Erstellen einer Pay As You Go (PAYG)-Umgebung mit einem IoT Hub- |
Mit dieser Vorlage können Sie eine Pay As You Go (PAYG) Time Series Insights-Umgebung bereitstellen, die für die Nutzung von Ereignissen von einem IoT Hub konfiguriert ist. |
Erstellen eines IoT Hub und eines Geräts für Cloud Consumer Group |
Mit dieser Vorlage können Sie eine IoT Hub-Instanz mit Gerät in der Cloud und der Cloud für Gerätenachrichtenkonfigurationen und ein Gerät in der Cloud-Consumergruppe bereitstellen. |
Erstellen eines IOT Hub- und Ubuntu-Edgesimulators |
Diese Vorlage erstellt einen IOT Hub und einen Virtuellen Computer Ubuntu Edge Simulator. |
Erstellen eines IoT Hub-Gerätebereitstellungsdiensts |
Mit dieser Vorlage können Sie einen IoT-Hub und einen IoT Hub-Gerätebereitstellungsdienst erstellen und die beiden Dienste miteinander verknüpfen. |
Erstellen des Geräteupdates für IoT Hub-Konto, Instanz, IoT Hub- |
Diese Vorlage erstellt ein Konto und eine Instanz und einen Hub, mit dem die Instanz verknüpft werden soll. Er konfiguriert den Hub mit den erforderlichen Zugriffsrichtlinien, Routen und Verbrauchergruppen. |
Bereitstellen des MedTech-Diensts einschließlich eines Azure IoT Hub- |
Der MedTech-Dienst ist einer der Azure Health Data Services, der zum Aufnehmen von Gerätedaten von mehreren Geräten entwickelt wurde, transformieren sie die Gerätedaten in FHIR-Beobachtungen, die dann im Azure Health Data Services-FHIR-Dienst gespeichert werden. |
Verwenden der ARM-Vorlage zum Erstellen von IoT Hub- und Routen- und Anzeigen von Nachrichten |
Verwenden Sie diese Vorlage, um einen IoT Hub und ein Speicherkonto bereitzustellen. Führen Sie eine App aus, um Nachrichten an den Hub zu senden, die an den Speicher weitergeleitet werden, und zeigen Sie dann die Ergebnisse an. |
Terraform -Ressourcendefinition (AzAPI-Anbieter)
Der IotHubs-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.Devices/IotHubs-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Devices/IotHubs@2016-02-03"
name = "string"
etag = "string"
location = "string"
resourcegroup = "string"
sku = {
capacity = int
name = "string"
}
subscriptionid = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
authorizationPolicies = [
{
keyName = "string"
primaryKey = "string"
rights = "string"
secondaryKey = "string"
}
]
cloudToDevice = {
defaultTtlAsIso8601 = "string"
feedback = {
lockDurationAsIso8601 = "string"
maxDeliveryCount = int
ttlAsIso8601 = "string"
}
maxDeliveryCount = int
}
comments = "string"
enableFileUploadNotifications = bool
eventHubEndpoints = {
{customized property} = {
partitionCount = int
retentionTimeInDays = int
}
}
features = "string"
ipFilterRules = [
{
action = "string"
filterName = "string"
ipMask = "string"
}
]
messagingEndpoints = {
{customized property} = {
lockDurationAsIso8601 = "string"
maxDeliveryCount = int
ttlAsIso8601 = "string"
}
}
operationsMonitoringProperties = {
events = {
{customized property} = "string"
}
}
storageEndpoints = {
{customized property} = {
connectionString = "string"
containerName = "string"
sasTtlAsIso8601 = "string"
}
}
}
})
}
Eigenschaftswerte
CloudToDeviceProperties
Name | Beschreibung | Wert |
---|---|---|
defaultTtlAsIso8601 | Die Standardzeit für Cloud-zu-Gerät-Nachrichten in der Gerätewarteschlange. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Schnur |
Feedback | Die Eigenschaften der Feedbackwarteschlange für Cloud-to-Device-Nachrichten. | FeedbackProperties- |
maxDeliveryCount | Die maximale Anzahl der Zustellungen für Nachrichten in der Cloud-zu-Gerät in der Gerätewarteschlange. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Zwänge: Min.-Wert = 1 Max. Wert = 100 |
EventHubProperties
Name | Beschreibung | Wert |
---|---|---|
partitionCount | Die Anzahl der Partitionen für den Empfang von Geräte-zu-Cloud-Nachrichten im Event Hub-kompatiblen Endpunkt. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | Int |
retentionTimeInDays | Die Aufbewahrungszeit für Geräte-zu-Cloud-Nachrichten in Tagen. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | Int |
FeedbackProperties
Name | Beschreibung | Wert |
---|---|---|
lockDurationAsIso8601 | Die Sperrdauer für die Feedbackwarteschlange. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Schnur |
maxDeliveryCount | Die Häufigkeit, mit der der IoT-Hub versucht, eine Nachricht in der Feedbackwarteschlange zu übermitteln. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Zwänge: Min.-Wert = 1 Max. Wert = 100 |
ttlAsIso8601 | Der Zeitraum, für den eine Nachricht verwendet werden kann, bevor sie vom IoT-Hub abgelaufen ist. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Schnur |
IotHubProperties
Name | Beschreibung | Wert |
---|---|---|
authorizationPolicies | Die Richtlinien für den freigegebenen Zugriff, die Sie verwenden können, um eine Verbindung mit dem IoT-Hub zu sichern. | SharedAccessSignatureAuthorizationRule[] |
cloudToDevice | Die IoT-Hub-Cloud-to-Device-Messaging-Eigenschaften. | CloudToDeviceProperties |
Kommentare | Kommentare. | Schnur |
enableFileUploadNotifications | Bei "True" sind Dateiuploadbenachrichtigungen aktiviert. | Bool |
eventHubEndpoints | Die Ereignishub-kompatiblen Endpunkteigenschaften. Die möglichen Schlüssel für dieses Wörterbuch sind Ereignisse und OperationsMonitoringEvents. Beide Schlüssel müssen im Wörterbuch vorhanden sein, während Sie Aufrufe für den IoT-Hub erstellen oder aktualisieren. | IotHubPropertiesEventHubEndpoints |
Funktionen | Die Funktionen und Features, die für den IoT-Hub aktiviert sind. | "DeviceManagement" 'None' |
ipFilterRules | Die IP-Filterregeln. | IpFilterRule-[] |
messagingEndpoints | Die Messaging-Endpunkteigenschaften für die Benachrichtigungswarteschlange für den Dateiupload. | IotHubPropertiesMessagingEndpoints |
operationsMonitoringProperties | Die Betriebsüberwachungseigenschaften für den IoT-Hub. Mögliche Schlüssel für das Wörterbuch sind Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. | OperationsMonitoringProperties- |
storageEndpoints | Die Liste der Azure Storage-Endpunkte, in die Sie Dateien hochladen können. Derzeit können Sie nur ein Azure Storage-Konto konfigurieren und den Schlüssel als $default haben. Wenn Sie mehrere Speicherkonten angeben, wird ein Fehler ausgelöst. Wenn die Eigenschaft "enableFileUploadNotifications" nicht auf "True" festgelegt ist, wird ein Fehler ausgelöst. | IotHubPropertiesStorageEndpoints |
IotHubPropertiesEventHubEndpoints
Name | Beschreibung | Wert |
---|
IotHubPropertiesMessagingEndpoints
Name | Beschreibung | Wert |
---|
IotHubPropertiesStorageEndpoints
Name | Beschreibung | Wert |
---|
IotHubSkuInfo
Name | Beschreibung | Wert |
---|---|---|
Fassungsvermögen | Die Anzahl der bereitgestellten IoT Hub-Einheiten. Siehe: /azure/azure-subscription-service-limits#iot-hub-limits. | int (erforderlich) |
Name | Der Name der SKU. | 'F1' 'S1' 'S2' 'S3' (erforderlich) |
IpFilterRule
Name | Beschreibung | Wert |
---|---|---|
Aktion | Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden. | "Annehmen" "Ablehnen" (erforderlich) |
filterName | Der Name der IP-Filterregel. | Zeichenfolge (erforderlich) |
ipMask | Eine Zeichenfolge, die den IP-Adressbereich in der CIDR-Notation für die Regel enthält. | Zeichenfolge (erforderlich) |
MessagingEndpointProperties
Name | Beschreibung | Wert |
---|---|---|
lockDurationAsIso8601 | Die Sperrdauer. Siehe: /azure/iot-hub/iot-hub-devguide-file-upload. | Schnur |
maxDeliveryCount | Die Häufigkeit, mit der der IoT-Hub versucht, eine Nachricht zu übermitteln. Siehe: /azure/iot-hub/iot-hub-devguide-file-upload. | Int Zwänge: Min.-Wert = 1 Max. Wert = 100 |
ttlAsIso8601 | Der Zeitraum, für den eine Nachricht verwendet werden kann, bevor sie vom IoT-Hub abgelaufen ist. Siehe: /azure/iot-hub/iot-hub-devguide-file-upload. | Schnur |
Microsoft.Devices/IotHubs
Name | Beschreibung | Wert |
---|---|---|
etag | Das Feld "Etag" ist nicht erforderlich. Wenn sie im Antworttext bereitgestellt wird, muss sie auch als Kopfzeile gemäß der normalen ETag-Konvention bereitgestellt werden. | Schnur |
Ort | Der Ressourcenspeicherort. | Zeichenfolge (erforderlich) |
Name | Der Ressourcenname | Zeichenfolge (erforderlich) |
Eigenschaften | Die Eigenschaften eines IoT-Hubs. | IotHubProperties- |
resourcegroup | Der Name der Ressourcengruppe, die den IoT-Hub enthält. Eine Ressourcengruppe identifiziert die Ressourcengruppe innerhalb des Abonnements eindeutig. | Zeichenfolge (erforderlich) |
Sku | Informationen zur SKU des IoT-Hubs. | IotHubSkuInfo- (erforderlich) |
subscriptionid | Der Abonnementbezeichner. | Zeichenfolge (erforderlich) |
Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. |
Art | Der Ressourcentyp | "Microsoft.Devices/IotHubs@2016-02-03" |
OperationsMonitoringProperties
Name | Beschreibung | Wert |
---|---|---|
Ereignisse | Wörterbuch der <OperationMonitoringLevel-> | OperationsMonitoringPropertiesEvents |
OperationsMonitoringPropertiesEvents
Name | Beschreibung | Wert |
---|
ResourceTags
Name | Beschreibung | Wert |
---|
SharedAccessSignatureAuthorizationRule
Name | Beschreibung | Wert |
---|---|---|
keyName | Der Name der Richtlinie für den freigegebenen Zugriff. | Zeichenfolge (erforderlich) |
primaryKey | Der Primärschlüssel. | Schnur |
Rechte | Die Berechtigungen, die der Richtlinie für den freigegebenen Zugriff zugewiesen sind. | "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" (erforderlich) |
secondaryKey | Der sekundäre Schlüssel. | Schnur |
StorageEndpointProperties
Name | Beschreibung | Wert |
---|---|---|
connectionString | Die Verbindungszeichenfolge für das Azure Storage-Konto, in das Dateien hochgeladen werden. | Zeichenfolge (erforderlich) |
containerName | Der Name des Stammcontainers, in den Sie Dateien hochladen. Der Container muss nicht vorhanden sein, sollte jedoch mithilfe der angegebenen connectionString erstellt werden. | Zeichenfolge (erforderlich) |
sasTtlAsIso8601 | Der Zeitraum, für den der SAS-URI, der vom IoT Hub für den Dateiupload generiert wurde, gültig ist. Siehe: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | Schnur |