Microsoft.Devices IotHubs 2021-03-03-preview
- 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@2021-03-03-preview' = {
etag: 'string'
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
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'
deviceStreams: {
streamingEndpoints: [
'string'
]
}
enableFileUploadNotifications: bool
encryption: {
keySource: 'string'
keyVaultProperties: [
{
identity: {
userAssignedIdentity: 'string'
}
keyIdentifier: 'string'
}
]
}
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'
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'
}
}
Eigenschaftswerte
ArmIdentity
Name | Beschreibung | Wert |
---|---|---|
Art | Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Gruppe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. | 'None' 'SystemAssigned' "SystemAssigned, UserAssigned" "UserAssigned" |
userAssignedIdentities | Wörterbuch <ArmUserIdentity-> | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
Name | Beschreibung | Wert |
---|
ArmUserIdentity
Name | Beschreibung | Wert |
---|
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 |
EncryptionPropertiesDescription
Name | Beschreibung | Wert |
---|---|---|
keySource | Die Quelle des Schlüssels. | Schnur |
keyVaultProperties | Die Eigenschaften des KeyVault-Schlüssels. | KeyVaultKeyProperties[] |
EnrichmentProperties
Name | Beschreibung | Wert |
---|---|---|
endpointNames | Die Liste der Endpunkte, für die die Anreicherung auf die Nachricht angewendet wird. | string[] (erforderlich) |
Schlüssel | Der Schlüssel oder Name für die Anreicherungseigenschaft. | Zeichenfolge (erforderlich) |
Wert | Der Wert für die Anreicherungseigenschaft. | Zeichenfolge (erforderlich) |
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 |
FallbackRouteProperties
Name | Beschreibung | Wert |
---|---|---|
Zustand | Die Bedingung, die ausgewertet wird, um die Fallbackroute anzuwenden. Wenn die Bedingung nicht angegeben wird, wird sie standardmäßig als "true" ausgewertet. Grammatik: /azure/iot-hub/iot-hub-devguide-query-language | Schnur |
endpointNames | Die Liste der Endpunkte, an die die Nachrichten, die die Bedingung erfüllen, weitergeleitet werden. Derzeit ist nur 1 Endpunkt zulässig. | string[] (erforderlich) |
isEnabled | Wird verwendet, um anzugeben, ob die Fallbackroute aktiviert ist. | bool (erforderlich) |
Name | Der Name der Route. Der Name kann nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche, maximal 64 Zeichen enthalten und muss eindeutig sein. | Schnur |
Quelle | Die Quelle, auf die die Routingregel angewendet werden soll. Beispiel: DeviceMessages | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "DigitalTwinChangeEvents" 'Ungültig' "TwinChangeEvents" (erforderlich) |
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 | IoT-Hubkommentare. | Schnur |
deviceStreams | Das Gerät streamt Die Eigenschaften von iothub. | IotHubPropertiesDeviceStreams |
enableFileUploadNotifications | Bei "True" sind Dateiuploadbenachrichtigungen aktiviert. | Bool |
Verschlüsselung | Die Verschlüsselungseigenschaften für den IoT-Hub. | EncryptionPropertiesDescription- |
eventHubEndpoints | Die Ereignishub-kompatiblen Endpunkteigenschaften. Die einzigen möglichen Schlüssel für dieses Wörterbuch sind Ereignisse. Dieser Schlüssel muss im Wörterbuch vorhanden sein, während Aufrufe für den IoT-Hub erstellt oder aktualisiert werden. | 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 |
minTlsVersion | Gibt die mindeste TLS-Version an, die für diesen Hub unterstützt werden soll. Kann auf "1.2" festgelegt werden, damit Clients, die eine TLS-Version unter 1.2 verwenden, abgelehnt werden. | Schnur |
networkRuleSets | Netzwerkregelsatzeigenschaften von IotHub | NetworkRuleSetProperties- |
privateEndpointConnections | Private Endpunktverbindungen, die auf diesem IotHub erstellt wurden | PrivateEndpointConnection[] |
publicNetworkAccess | Gibt an, ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind. | "Deaktiviert" "Aktiviert" |
Routing | Die routingbezogenen Eigenschaften des IoT-Hubs. Siehe: /azure/iot-hub/iot-hub-devguide-messaging | RoutingProperties- |
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 |
IotHubPropertiesDeviceStreams
Name | Beschreibung | Wert |
---|---|---|
streamingEndpoints | Liste der Gerätestream-Endpunkte. | string[] |
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 |
Name | Der Name der SKU. | 'B1' 'B2' "B3" '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) |
KeyVaultKeyProperties
Name | Beschreibung | Wert |
---|---|---|
Identität | Verwaltete Identitätseigenschaften von KeyVault Key. | ManagedIdentity- |
keyIdentifier | Der Bezeichner des Schlüssels. | Schnur |
ManagedIdentity
Name | Beschreibung | Wert |
---|---|---|
userAssignedIdentity | Die vom Benutzer zugewiesene Identität. | Schnur |
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 |
Identität | Die verwalteten Identitäten für IotHub. | ArmIdentity- |
Ort | Der Ressourcenspeicherort. | Zeichenfolge (erforderlich) |
Name | Der Ressourcenname | Zeichenfolge (erforderlich) |
Eigenschaften | IotHub-Eigenschaften | IotHubProperties- |
Sku | IotHub-SKU-Informationen | IotHubSkuInfo- (erforderlich) |
Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
NetworkRuleSetIpRule
Name | Beschreibung | Wert |
---|---|---|
Aktion | IP-Filteraktion | "Zulassen" |
filterName | 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) |
NetworkRuleSetProperties
Name | Beschreibung | Wert |
---|---|---|
applyToBuiltInEventHubEndpoint | Wenn True, wird der Netzwerkregelsatz auch auf BuiltIn EventHub EndPoint von IotHub angewendet. | bool (erforderlich) |
defaultAction | Standardaktion für netzwerkregelsatz | "Zulassen" "Ablehnen" |
ipRules | Liste der IP-Regeln | NetworkRuleSetIpRule[] (erforderlich) |
PrivateEndpoint
Name | Beschreibung | Wert |
---|
PrivateEndpointConnection
Name | Beschreibung | Wert |
---|---|---|
Eigenschaften | Die Eigenschaften einer privaten Endpunktverbindung | PrivateEndpointConnectionProperties (erforderlich) |
PrivateEndpointConnectionProperties
Name | Beschreibung | Wert |
---|---|---|
privateEndpoint | Die private Endpunkteigenschaft einer privaten Endpunktverbindung | PrivateEndpoint- |
privateLinkServiceConnectionState | Der aktuelle Status einer privaten Endpunktverbindung | PrivateLinkServiceConnectionState (erforderlich) |
PrivateLinkServiceConnectionState
Name | Beschreibung | Wert |
---|---|---|
actionsRequired | Aktionen, die für eine private Endpunktverbindung erforderlich sind | Schnur |
Beschreibung | Die Beschreibung für den aktuellen Status einer privaten Endpunktverbindung | Zeichenfolge (erforderlich) |
Status | Der Status einer privaten Endpunktverbindung | "Genehmigt" "Getrennt" "Ausstehend" "Abgelehnt" (erforderlich) |
ResourceTags
Name | Beschreibung | Wert |
---|
RouteProperties
Name | Beschreibung | Wert |
---|---|---|
Zustand | Die Bedingung, die ausgewertet wird, um die Routingregel anzuwenden. Wenn keine Bedingung angegeben wird, wird sie standardmäßig als "true" ausgewertet. Grammatik finden Sie unter : /azure/iot-hub/iot-hub-devguide-query-language | Schnur |
endpointNames | Die Liste der Endpunkte, an die Nachrichten weitergeleitet werden, die die Bedingung erfüllen. Derzeit ist nur ein Endpunkt zulässig. | string[] (erforderlich) |
isEnabled | Wird verwendet, um anzugeben, ob eine Route aktiviert ist. | bool (erforderlich) |
Name | Der Name der Route. Der Name kann nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche, maximal 64 Zeichen enthalten und muss eindeutig sein. | Schnur Zwänge: Pattern = ^[A-Za-z0-9-._]{1,64}$ (erforderlich) |
Quelle | Die Quelle, auf die die Routingregel angewendet werden soll, z. B. DeviceMessages. | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "DigitalTwinChangeEvents" 'Ungültig' "TwinChangeEvents" (erforderlich) |
RoutingEndpoints
Name | Beschreibung | Wert |
---|---|---|
eventHubs | Die Liste der Event Hubs-Endpunkte, an die IoT Hub Nachrichten basierend auf den Routingregeln weiterleitet. Diese Liste enthält nicht den integrierten Event Hubs-Endpunkt. | RoutingEventHubProperties[] |
serviceBusQueues | Die Liste der Endpunkte der Servicebus-Warteschlange, an die IoT Hub die Nachrichten basierend auf den Routingregeln weiterleitet. | RoutingServiceBusQueueEndpointProperties[] |
serviceBusTopics | Die Liste der ServiceBus-Themenendpunkte, an die der IoT-Hub die Nachrichten basierend auf den Routingregeln weiterleitet. | RoutingServiceBusTopicEndpointProperties[] |
storageContainers | Die Liste der Speichercontainerendpunkte, an die IoT Hub Nachrichten basierend auf den Routingregeln weiterleitet. | RoutingStorageContainerProperties[] |
RoutingEventHubProperties
Name | Beschreibung | Wert |
---|---|---|
authenticationType | Methode zur Authentifizierung beim Event Hub-Endpunkt | 'identityBased' "keyBased" |
connectionString | Die Verbindungszeichenfolge des Event Hub-Endpunkts. | Schnur |
endpointUri | Die URL des Event Hub-Endpunkts. Es muss das Protokoll sb:// | Schnur |
entityPath | Event Hub-Name im Event Hub-Namespace | Schnur |
id | ID des Event Hub-Endpunkts | Schnur |
Identität | Verwaltete Identitätseigenschaften des Routingereignishub-Endpunkts. | ManagedIdentity- |
Name | Der Name, der diesen Endpunkt identifiziert. Der Name kann nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche und eine maximale Länge von 64 Zeichen enthalten. Die folgenden Namen sind reserviert: Ereignisse, FileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. | Schnur Zwänge: Pattern = ^[A-Za-z0-9-._]{1,64}$ (erforderlich) |
resourceGroup | Der Name der Ressourcengruppe des Event Hub-Endpunkts. | Schnur |
subscriptionId | Der Abonnementbezeichner des Event Hub-Endpunkts. | Schnur |
RoutingProperties
Name | Beschreibung | Wert |
---|---|---|
Endpunkte | Die Eigenschaften im Zusammenhang mit den benutzerdefinierten Endpunkten, an die Ihr IoT-Hub Nachrichten basierend auf den Routingregeln weiterleitet. Maximal 10 benutzerdefinierte Endpunkte sind für alle Endpunkttypen für kostenpflichtige Hubs zulässig, und nur 1 benutzerdefinierter Endpunkt ist für alle Endpunkttypen für kostenlose Hubs zulässig. | RoutingEndpoints- |
Anreicherungen | Die Liste der vom Benutzer bereitgestellten Anreicherungen, die der IoT-Hub auf Nachrichten an integrierte und benutzerdefinierte Endpunkte zugestellt werden soll. Siehe: https://aka.ms/telemetryoneventgrid | EnrichmentProperties[] |
fallbackRoute | Die Eigenschaften der Route, die als Fallbackroute verwendet wird, wenn keine der im Abschnitt "Routen" angegebenen Bedingungen erfüllt ist. Dies ist ein optionaler Parameter. Wenn diese Eigenschaft nicht festgelegt ist, werden die Nachrichten, die keine der im Abschnitt "Routen" angegebenen Bedingungen erfüllen, an den integrierten EventHub-Endpunkt weitergeleitet. | FallbackRouteProperties |
Routen | Die Liste der vom Benutzer bereitgestellten Routingregeln, die der IoT-Hub zum Weiterleiten von Nachrichten an integrierte und benutzerdefinierte Endpunkte verwendet. Maximal 100 Routingregeln sind für kostenpflichtige Hubs zulässig, und maximal 5 Routingregeln sind für kostenlose Hubs zulässig. | RouteProperties[] |
RoutingServiceBusQueueEndpointProperties
Name | Beschreibung | Wert |
---|---|---|
authenticationType | Methode zur Authentifizierung beim Endpunkt der Servicebuswarteschlange | 'identityBased' "keyBased" |
connectionString | Die Verbindungszeichenfolge des Dienstenbus-Warteschlangenendpunkts. | Schnur |
endpointUri | Die URL des Dienstenbus-Warteschlangenendpunkts. Es muss das Protokoll sb:// | Schnur |
entityPath | Warteschlangenname im Servicebusnamespace | Schnur |
id | ID des Dienstenbus-Warteschlangenendpunkts | Schnur |
Identität | Verwaltete Identitätseigenschaften des Routingdienstbus-Warteschlangenendpunkts. | ManagedIdentity- |
Name | Der Name, der diesen Endpunkt identifiziert. Der Name kann nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche und eine maximale Länge von 64 Zeichen enthalten. Die folgenden Namen sind reserviert: Ereignisse, FileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. Der Name muss nicht mit dem tatsächlichen Warteschlangennamen übereinstimmen. | Schnur Zwänge: Pattern = ^[A-Za-z0-9-._]{1,64}$ (erforderlich) |
resourceGroup | Der Name der Ressourcengruppe des Dienstenbus-Warteschlangenendpunkts. | Schnur |
subscriptionId | Der Abonnementbezeichner des Dienstenbus-Warteschlangenendpunkts. | Schnur |
RoutingServiceBusTopicEndpointProperties
Name | Beschreibung | Wert |
---|---|---|
authenticationType | Methode zur Authentifizierung beim Endpunkt des Servicebusthemas | 'identityBased' "keyBased" |
connectionString | Die Verbindungszeichenfolge des Servicebus-Themenendpunkts. | Schnur |
endpointUri | Die URL des Endpunkts des Servicebusthemas. Es muss das Protokoll sb:// | Schnur |
entityPath | Warteschlangenname im Thema "Servicebus" | Schnur |
id | ID des Endpunkts des Servicebusthemas | Schnur |
Identität | Verwaltete Identitätseigenschaften des Endpunkts des Routingdienstbus. | ManagedIdentity- |
Name | Der Name, der diesen Endpunkt identifiziert. Der Name kann nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche und eine maximale Länge von 64 Zeichen enthalten. Die folgenden Namen sind reserviert: Ereignisse, FileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. Der Name muss nicht mit dem tatsächlichen Themanamen identisch sein. | Schnur Zwänge: Pattern = ^[A-Za-z0-9-._]{1,64}$ (erforderlich) |
resourceGroup | Der Name der Ressourcengruppe des Servicebus-Themenendpunkts. | Schnur |
subscriptionId | Der Abonnementbezeichner des Servicebus-Themenendpunkts. | Schnur |
RoutingStorageContainerProperties
Name | Beschreibung | Wert |
---|---|---|
authenticationType | Methode zur Authentifizierung beim Speicherendpunkt | 'identityBased' "keyBased" |
batchFrequencyInSeconds | Zeitintervall, in das Blobs in den Speicher geschrieben werden. Der Wert sollte zwischen 60 und 720 Sekunden betragen. Der Standardwert beträgt 300 Sekunden. | Int Zwänge: Min.-Wert = 60 Max. Wert = 720 |
connectionString | Die Verbindungszeichenfolge des Speicherkontos. | Schnur |
containerName | Der Name des Speichercontainers im Speicherkonto. | Zeichenfolge (erforderlich) |
Codierung | Codierung, die zum Serialisieren von Nachrichten in Blobs verwendet wird. Unterstützte Werte sind "avro", "avrodeflate" und "JSON". Der Standardwert ist "avro". | 'Avro' 'AvroDeflate' "JSON" |
endpointUri | Die URL des Speicherendpunkts. Es muss das Protokoll https:// | Schnur |
fileNameFormat | Dateinamenformat für das Blob. Das Standardformat ist {iothub}/{partition}/{JJJJ}/{MM}/{DD}/{HH}/{mm}. Alle Parameter sind obligatorisch, können aber neu angeordnet werden. | Schnur |
id | ID des Speichercontainerendpunkts | Schnur |
Identität | Verwaltete Identitätseigenschaften des Routingspeicherendpunkts. | ManagedIdentity- |
maxChunkSizeInBytes | Maximale Anzahl von Bytes für jedes blob, das in den Speicher geschrieben wurde. Der Wert sollte zwischen 10485760(10 MB) und 524288000(500 MB) sein. Der Standardwert ist 314572800(300 MB). | Int Zwänge: Min-Wert = 10485760 Max. Wert = 524288000 |
Name | Der Name, der diesen Endpunkt identifiziert. Der Name kann nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche und eine maximale Länge von 64 Zeichen enthalten. Die folgenden Namen sind reserviert: Ereignisse, FileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. | Schnur Zwänge: Pattern = ^[A-Za-z0-9-._]{1,64}$ (erforderlich) |
resourceGroup | Der Name der Ressourcengruppe des Speicherkontos. | Schnur |
subscriptionId | Der Abonnementbezeichner des Speicherkontos. | Schnur |
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 |
---|---|---|
authenticationType | Gibt den Authentifizierungstyp an, der für die Verbindung mit dem Speicherkonto verwendet wird. | 'identityBased' "keyBased" |
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) |
Identität | Verwaltete Identitätseigenschaften des Speicherendpunkts für den Dateiupload. | ManagedIdentity- |
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": "2021-03-03-preview",
"name": "string",
"etag": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"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",
"deviceStreams": {
"streamingEndpoints": [ "string" ]
},
"enableFileUploadNotifications": "bool",
"encryption": {
"keySource": "string",
"keyVaultProperties": [
{
"identity": {
"userAssignedIdentity": "string"
},
"keyIdentifier": "string"
}
]
},
"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",
"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"
}
}
Eigenschaftswerte
ArmIdentity
Name | Beschreibung | Wert |
---|---|---|
Art | Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Gruppe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. | 'None' 'SystemAssigned' "SystemAssigned, UserAssigned" "UserAssigned" |
userAssignedIdentities | Wörterbuch <ArmUserIdentity-> | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
Name | Beschreibung | Wert |
---|
ArmUserIdentity
Name | Beschreibung | Wert |
---|
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 |
EncryptionPropertiesDescription
Name | Beschreibung | Wert |
---|---|---|
keySource | Die Quelle des Schlüssels. | Schnur |
keyVaultProperties | Die Eigenschaften des KeyVault-Schlüssels. | KeyVaultKeyProperties[] |
EnrichmentProperties
Name | Beschreibung | Wert |
---|---|---|
endpointNames | Die Liste der Endpunkte, für die die Anreicherung auf die Nachricht angewendet wird. | string[] (erforderlich) |
Schlüssel | Der Schlüssel oder Name für die Anreicherungseigenschaft. | Zeichenfolge (erforderlich) |
Wert | Der Wert für die Anreicherungseigenschaft. | Zeichenfolge (erforderlich) |
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 |
FallbackRouteProperties
Name | Beschreibung | Wert |
---|---|---|
Zustand | Die Bedingung, die ausgewertet wird, um die Fallbackroute anzuwenden. Wenn die Bedingung nicht angegeben wird, wird sie standardmäßig als "true" ausgewertet. Grammatik: /azure/iot-hub/iot-hub-devguide-query-language | Schnur |
endpointNames | Die Liste der Endpunkte, an die die Nachrichten, die die Bedingung erfüllen, weitergeleitet werden. Derzeit ist nur 1 Endpunkt zulässig. | string[] (erforderlich) |
isEnabled | Wird verwendet, um anzugeben, ob die Fallbackroute aktiviert ist. | bool (erforderlich) |
Name | Der Name der Route. Der Name kann nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche, maximal 64 Zeichen enthalten und muss eindeutig sein. | Schnur |
Quelle | Die Quelle, auf die die Routingregel angewendet werden soll. Beispiel: DeviceMessages | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "DigitalTwinChangeEvents" 'Ungültig' "TwinChangeEvents" (erforderlich) |
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 | IoT-Hubkommentare. | Schnur |
deviceStreams | Das Gerät streamt Die Eigenschaften von iothub. | IotHubPropertiesDeviceStreams |
enableFileUploadNotifications | Bei "True" sind Dateiuploadbenachrichtigungen aktiviert. | Bool |
Verschlüsselung | Die Verschlüsselungseigenschaften für den IoT-Hub. | EncryptionPropertiesDescription- |
eventHubEndpoints | Die Ereignishub-kompatiblen Endpunkteigenschaften. Die einzigen möglichen Schlüssel für dieses Wörterbuch sind Ereignisse. Dieser Schlüssel muss im Wörterbuch vorhanden sein, während Aufrufe für den IoT-Hub erstellt oder aktualisiert werden. | 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 |
minTlsVersion | Gibt die mindeste TLS-Version an, die für diesen Hub unterstützt werden soll. Kann auf "1.2" festgelegt werden, damit Clients, die eine TLS-Version unter 1.2 verwenden, abgelehnt werden. | Schnur |
networkRuleSets | Netzwerkregelsatzeigenschaften von IotHub | NetworkRuleSetProperties- |
privateEndpointConnections | Private Endpunktverbindungen, die auf diesem IotHub erstellt wurden | PrivateEndpointConnection[] |
publicNetworkAccess | Gibt an, ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind. | "Deaktiviert" "Aktiviert" |
Routing | Die routingbezogenen Eigenschaften des IoT-Hubs. Siehe: /azure/iot-hub/iot-hub-devguide-messaging | RoutingProperties- |
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 |
IotHubPropertiesDeviceStreams
Name | Beschreibung | Wert |
---|---|---|
streamingEndpoints | Liste der Gerätestream-Endpunkte. | string[] |
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 |
Name | Der Name der SKU. | 'B1' 'B2' "B3" '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) |
KeyVaultKeyProperties
Name | Beschreibung | Wert |
---|---|---|
Identität | Verwaltete Identitätseigenschaften von KeyVault Key. | ManagedIdentity- |
keyIdentifier | Der Bezeichner des Schlüssels. | Schnur |
ManagedIdentity
Name | Beschreibung | Wert |
---|---|---|
userAssignedIdentity | Die vom Benutzer zugewiesene Identität. | Schnur |
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 | '2021-03-03-preview' |
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 |
Identität | Die verwalteten Identitäten für IotHub. | ArmIdentity- |
Ort | Der Ressourcenspeicherort. | Zeichenfolge (erforderlich) |
Name | Der Ressourcenname | Zeichenfolge (erforderlich) |
Eigenschaften | IotHub-Eigenschaften | IotHubProperties- |
Sku | IotHub-SKU-Informationen | IotHubSkuInfo- (erforderlich) |
Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
Art | Der Ressourcentyp | "Microsoft.Devices/IotHubs" |
NetworkRuleSetIpRule
Name | Beschreibung | Wert |
---|---|---|
Aktion | IP-Filteraktion | "Zulassen" |
filterName | 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) |
NetworkRuleSetProperties
Name | Beschreibung | Wert |
---|---|---|
applyToBuiltInEventHubEndpoint | Wenn True, wird der Netzwerkregelsatz auch auf BuiltIn EventHub EndPoint von IotHub angewendet. | bool (erforderlich) |
defaultAction | Standardaktion für netzwerkregelsatz | "Zulassen" "Ablehnen" |
ipRules | Liste der IP-Regeln | NetworkRuleSetIpRule[] (erforderlich) |
PrivateEndpoint
Name | Beschreibung | Wert |
---|
PrivateEndpointConnection
Name | Beschreibung | Wert |
---|---|---|
Eigenschaften | Die Eigenschaften einer privaten Endpunktverbindung | PrivateEndpointConnectionProperties (erforderlich) |
PrivateEndpointConnectionProperties
Name | Beschreibung | Wert |
---|---|---|
privateEndpoint | Die private Endpunkteigenschaft einer privaten Endpunktverbindung | PrivateEndpoint- |
privateLinkServiceConnectionState | Der aktuelle Status einer privaten Endpunktverbindung | PrivateLinkServiceConnectionState (erforderlich) |
PrivateLinkServiceConnectionState
Name | Beschreibung | Wert |
---|---|---|
actionsRequired | Aktionen, die für eine private Endpunktverbindung erforderlich sind | Schnur |
Beschreibung | Die Beschreibung für den aktuellen Status einer privaten Endpunktverbindung | Zeichenfolge (erforderlich) |
Status | Der Status einer privaten Endpunktverbindung | "Genehmigt" "Getrennt" "Ausstehend" "Abgelehnt" (erforderlich) |
ResourceTags
Name | Beschreibung | Wert |
---|
RouteProperties
Name | Beschreibung | Wert |
---|---|---|
Zustand | Die Bedingung, die ausgewertet wird, um die Routingregel anzuwenden. Wenn keine Bedingung angegeben wird, wird sie standardmäßig als "true" ausgewertet. Grammatik finden Sie unter : /azure/iot-hub/iot-hub-devguide-query-language | Schnur |
endpointNames | Die Liste der Endpunkte, an die Nachrichten weitergeleitet werden, die die Bedingung erfüllen. Derzeit ist nur ein Endpunkt zulässig. | string[] (erforderlich) |
isEnabled | Wird verwendet, um anzugeben, ob eine Route aktiviert ist. | bool (erforderlich) |
Name | Der Name der Route. Der Name kann nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche, maximal 64 Zeichen enthalten und muss eindeutig sein. | Schnur Zwänge: Pattern = ^[A-Za-z0-9-._]{1,64}$ (erforderlich) |
Quelle | Die Quelle, auf die die Routingregel angewendet werden soll, z. B. DeviceMessages. | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "DigitalTwinChangeEvents" 'Ungültig' "TwinChangeEvents" (erforderlich) |
RoutingEndpoints
Name | Beschreibung | Wert |
---|---|---|
eventHubs | Die Liste der Event Hubs-Endpunkte, an die IoT Hub Nachrichten basierend auf den Routingregeln weiterleitet. Diese Liste enthält nicht den integrierten Event Hubs-Endpunkt. | RoutingEventHubProperties[] |
serviceBusQueues | Die Liste der Endpunkte der Servicebus-Warteschlange, an die IoT Hub die Nachrichten basierend auf den Routingregeln weiterleitet. | RoutingServiceBusQueueEndpointProperties[] |
serviceBusTopics | Die Liste der ServiceBus-Themenendpunkte, an die der IoT-Hub die Nachrichten basierend auf den Routingregeln weiterleitet. | RoutingServiceBusTopicEndpointProperties[] |
storageContainers | Die Liste der Speichercontainerendpunkte, an die IoT Hub Nachrichten basierend auf den Routingregeln weiterleitet. | RoutingStorageContainerProperties[] |
RoutingEventHubProperties
Name | Beschreibung | Wert |
---|---|---|
authenticationType | Methode zur Authentifizierung beim Event Hub-Endpunkt | 'identityBased' "keyBased" |
connectionString | Die Verbindungszeichenfolge des Event Hub-Endpunkts. | Schnur |
endpointUri | Die URL des Event Hub-Endpunkts. Es muss das Protokoll sb:// | Schnur |
entityPath | Event Hub-Name im Event Hub-Namespace | Schnur |
id | ID des Event Hub-Endpunkts | Schnur |
Identität | Verwaltete Identitätseigenschaften des Routingereignishub-Endpunkts. | ManagedIdentity- |
Name | Der Name, der diesen Endpunkt identifiziert. Der Name kann nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche und eine maximale Länge von 64 Zeichen enthalten. Die folgenden Namen sind reserviert: Ereignisse, FileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. | Schnur Zwänge: Pattern = ^[A-Za-z0-9-._]{1,64}$ (erforderlich) |
resourceGroup | Der Name der Ressourcengruppe des Event Hub-Endpunkts. | Schnur |
subscriptionId | Der Abonnementbezeichner des Event Hub-Endpunkts. | Schnur |
RoutingProperties
Name | Beschreibung | Wert |
---|---|---|
Endpunkte | Die Eigenschaften im Zusammenhang mit den benutzerdefinierten Endpunkten, an die Ihr IoT-Hub Nachrichten basierend auf den Routingregeln weiterleitet. Maximal 10 benutzerdefinierte Endpunkte sind für alle Endpunkttypen für kostenpflichtige Hubs zulässig, und nur 1 benutzerdefinierter Endpunkt ist für alle Endpunkttypen für kostenlose Hubs zulässig. | RoutingEndpoints- |
Anreicherungen | Die Liste der vom Benutzer bereitgestellten Anreicherungen, die der IoT-Hub auf Nachrichten an integrierte und benutzerdefinierte Endpunkte zugestellt werden soll. Siehe: https://aka.ms/telemetryoneventgrid | EnrichmentProperties[] |
fallbackRoute | Die Eigenschaften der Route, die als Fallbackroute verwendet wird, wenn keine der im Abschnitt "Routen" angegebenen Bedingungen erfüllt ist. Dies ist ein optionaler Parameter. Wenn diese Eigenschaft nicht festgelegt ist, werden die Nachrichten, die keine der im Abschnitt "Routen" angegebenen Bedingungen erfüllen, an den integrierten EventHub-Endpunkt weitergeleitet. | FallbackRouteProperties |
Routen | Die Liste der vom Benutzer bereitgestellten Routingregeln, die der IoT-Hub zum Weiterleiten von Nachrichten an integrierte und benutzerdefinierte Endpunkte verwendet. Maximal 100 Routingregeln sind für kostenpflichtige Hubs zulässig, und maximal 5 Routingregeln sind für kostenlose Hubs zulässig. | RouteProperties[] |
RoutingServiceBusQueueEndpointProperties
Name | Beschreibung | Wert |
---|---|---|
authenticationType | Methode zur Authentifizierung beim Endpunkt der Servicebuswarteschlange | 'identityBased' "keyBased" |
connectionString | Die Verbindungszeichenfolge des Dienstenbus-Warteschlangenendpunkts. | Schnur |
endpointUri | Die URL des Dienstenbus-Warteschlangenendpunkts. Es muss das Protokoll sb:// | Schnur |
entityPath | Warteschlangenname im Servicebusnamespace | Schnur |
id | ID des Dienstenbus-Warteschlangenendpunkts | Schnur |
Identität | Verwaltete Identitätseigenschaften des Routingdienstbus-Warteschlangenendpunkts. | ManagedIdentity- |
Name | Der Name, der diesen Endpunkt identifiziert. Der Name kann nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche und eine maximale Länge von 64 Zeichen enthalten. Die folgenden Namen sind reserviert: Ereignisse, FileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. Der Name muss nicht mit dem tatsächlichen Warteschlangennamen übereinstimmen. | Schnur Zwänge: Pattern = ^[A-Za-z0-9-._]{1,64}$ (erforderlich) |
resourceGroup | Der Name der Ressourcengruppe des Dienstenbus-Warteschlangenendpunkts. | Schnur |
subscriptionId | Der Abonnementbezeichner des Dienstenbus-Warteschlangenendpunkts. | Schnur |
RoutingServiceBusTopicEndpointProperties
Name | Beschreibung | Wert |
---|---|---|
authenticationType | Methode zur Authentifizierung beim Endpunkt des Servicebusthemas | 'identityBased' "keyBased" |
connectionString | Die Verbindungszeichenfolge des Servicebus-Themenendpunkts. | Schnur |
endpointUri | Die URL des Endpunkts des Servicebusthemas. Es muss das Protokoll sb:// | Schnur |
entityPath | Warteschlangenname im Thema "Servicebus" | Schnur |
id | ID des Endpunkts des Servicebusthemas | Schnur |
Identität | Verwaltete Identitätseigenschaften des Endpunkts des Routingdienstbus. | ManagedIdentity- |
Name | Der Name, der diesen Endpunkt identifiziert. Der Name kann nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche und eine maximale Länge von 64 Zeichen enthalten. Die folgenden Namen sind reserviert: Ereignisse, FileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. Der Name muss nicht mit dem tatsächlichen Themanamen identisch sein. | Schnur Zwänge: Pattern = ^[A-Za-z0-9-._]{1,64}$ (erforderlich) |
resourceGroup | Der Name der Ressourcengruppe des Servicebus-Themenendpunkts. | Schnur |
subscriptionId | Der Abonnementbezeichner des Servicebus-Themenendpunkts. | Schnur |
RoutingStorageContainerProperties
Name | Beschreibung | Wert |
---|---|---|
authenticationType | Methode zur Authentifizierung beim Speicherendpunkt | 'identityBased' "keyBased" |
batchFrequencyInSeconds | Zeitintervall, in das Blobs in den Speicher geschrieben werden. Der Wert sollte zwischen 60 und 720 Sekunden betragen. Der Standardwert beträgt 300 Sekunden. | Int Zwänge: Min.-Wert = 60 Max. Wert = 720 |
connectionString | Die Verbindungszeichenfolge des Speicherkontos. | Schnur |
containerName | Der Name des Speichercontainers im Speicherkonto. | Zeichenfolge (erforderlich) |
Codierung | Codierung, die zum Serialisieren von Nachrichten in Blobs verwendet wird. Unterstützte Werte sind "avro", "avrodeflate" und "JSON". Der Standardwert ist "avro". | 'Avro' 'AvroDeflate' "JSON" |
endpointUri | Die URL des Speicherendpunkts. Es muss das Protokoll https:// | Schnur |
fileNameFormat | Dateinamenformat für das Blob. Das Standardformat ist {iothub}/{partition}/{JJJJ}/{MM}/{DD}/{HH}/{mm}. Alle Parameter sind obligatorisch, können aber neu angeordnet werden. | Schnur |
id | ID des Speichercontainerendpunkts | Schnur |
Identität | Verwaltete Identitätseigenschaften des Routingspeicherendpunkts. | ManagedIdentity- |
maxChunkSizeInBytes | Maximale Anzahl von Bytes für jedes blob, das in den Speicher geschrieben wurde. Der Wert sollte zwischen 10485760(10 MB) und 524288000(500 MB) sein. Der Standardwert ist 314572800(300 MB). | Int Zwänge: Min-Wert = 10485760 Max. Wert = 524288000 |
Name | Der Name, der diesen Endpunkt identifiziert. Der Name kann nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche und eine maximale Länge von 64 Zeichen enthalten. Die folgenden Namen sind reserviert: Ereignisse, FileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. | Schnur Zwänge: Pattern = ^[A-Za-z0-9-._]{1,64}$ (erforderlich) |
resourceGroup | Der Name der Ressourcengruppe des Speicherkontos. | Schnur |
subscriptionId | Der Abonnementbezeichner des Speicherkontos. | Schnur |
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 |
---|---|---|
authenticationType | Gibt den Authentifizierungstyp an, der für die Verbindung mit dem Speicherkonto verwendet wird. | 'identityBased' "keyBased" |
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) |
Identität | Verwaltete Identitätseigenschaften des Speicherendpunkts für den Dateiupload. | ManagedIdentity- |
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@2021-03-03-preview"
name = "string"
etag = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
body = jsonencode({
properties = {
authorizationPolicies = [
{
keyName = "string"
primaryKey = "string"
rights = "string"
secondaryKey = "string"
}
]
cloudToDevice = {
defaultTtlAsIso8601 = "string"
feedback = {
lockDurationAsIso8601 = "string"
maxDeliveryCount = int
ttlAsIso8601 = "string"
}
maxDeliveryCount = int
}
comments = "string"
deviceStreams = {
streamingEndpoints = [
"string"
]
}
enableFileUploadNotifications = bool
encryption = {
keySource = "string"
keyVaultProperties = [
{
identity = {
userAssignedIdentity = "string"
}
keyIdentifier = "string"
}
]
}
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"
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"
}
}
Eigenschaftswerte
ArmIdentity
Name | Beschreibung | Wert |
---|---|---|
Art | Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Gruppe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. | 'None' 'SystemAssigned' "SystemAssigned, UserAssigned" "UserAssigned" |
userAssignedIdentities | Wörterbuch <ArmUserIdentity-> | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
Name | Beschreibung | Wert |
---|
ArmUserIdentity
Name | Beschreibung | Wert |
---|
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 |
EncryptionPropertiesDescription
Name | Beschreibung | Wert |
---|---|---|
keySource | Die Quelle des Schlüssels. | Schnur |
keyVaultProperties | Die Eigenschaften des KeyVault-Schlüssels. | KeyVaultKeyProperties[] |
EnrichmentProperties
Name | Beschreibung | Wert |
---|---|---|
endpointNames | Die Liste der Endpunkte, für die die Anreicherung auf die Nachricht angewendet wird. | string[] (erforderlich) |
Schlüssel | Der Schlüssel oder Name für die Anreicherungseigenschaft. | Zeichenfolge (erforderlich) |
Wert | Der Wert für die Anreicherungseigenschaft. | Zeichenfolge (erforderlich) |
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 |
FallbackRouteProperties
Name | Beschreibung | Wert |
---|---|---|
Zustand | Die Bedingung, die ausgewertet wird, um die Fallbackroute anzuwenden. Wenn die Bedingung nicht angegeben wird, wird sie standardmäßig als "true" ausgewertet. Grammatik: /azure/iot-hub/iot-hub-devguide-query-language | Schnur |
endpointNames | Die Liste der Endpunkte, an die die Nachrichten, die die Bedingung erfüllen, weitergeleitet werden. Derzeit ist nur 1 Endpunkt zulässig. | string[] (erforderlich) |
isEnabled | Wird verwendet, um anzugeben, ob die Fallbackroute aktiviert ist. | bool (erforderlich) |
Name | Der Name der Route. Der Name kann nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche, maximal 64 Zeichen enthalten und muss eindeutig sein. | Schnur |
Quelle | Die Quelle, auf die die Routingregel angewendet werden soll. Beispiel: DeviceMessages | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "DigitalTwinChangeEvents" 'Ungültig' "TwinChangeEvents" (erforderlich) |
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 | IoT-Hubkommentare. | Schnur |
deviceStreams | Das Gerät streamt Die Eigenschaften von iothub. | IotHubPropertiesDeviceStreams |
enableFileUploadNotifications | Bei "True" sind Dateiuploadbenachrichtigungen aktiviert. | Bool |
Verschlüsselung | Die Verschlüsselungseigenschaften für den IoT-Hub. | EncryptionPropertiesDescription- |
eventHubEndpoints | Die Ereignishub-kompatiblen Endpunkteigenschaften. Die einzigen möglichen Schlüssel für dieses Wörterbuch sind Ereignisse. Dieser Schlüssel muss im Wörterbuch vorhanden sein, während Aufrufe für den IoT-Hub erstellt oder aktualisiert werden. | 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 |
minTlsVersion | Gibt die mindeste TLS-Version an, die für diesen Hub unterstützt werden soll. Kann auf "1.2" festgelegt werden, damit Clients, die eine TLS-Version unter 1.2 verwenden, abgelehnt werden. | Schnur |
networkRuleSets | Netzwerkregelsatzeigenschaften von IotHub | NetworkRuleSetProperties- |
privateEndpointConnections | Private Endpunktverbindungen, die auf diesem IotHub erstellt wurden | PrivateEndpointConnection[] |
publicNetworkAccess | Gibt an, ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind. | "Deaktiviert" "Aktiviert" |
Routing | Die routingbezogenen Eigenschaften des IoT-Hubs. Siehe: /azure/iot-hub/iot-hub-devguide-messaging | RoutingProperties- |
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 |
IotHubPropertiesDeviceStreams
Name | Beschreibung | Wert |
---|---|---|
streamingEndpoints | Liste der Gerätestream-Endpunkte. | string[] |
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 |
Name | Der Name der SKU. | 'B1' 'B2' "B3" '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) |
KeyVaultKeyProperties
Name | Beschreibung | Wert |
---|---|---|
Identität | Verwaltete Identitätseigenschaften von KeyVault Key. | ManagedIdentity- |
keyIdentifier | Der Bezeichner des Schlüssels. | Schnur |
ManagedIdentity
Name | Beschreibung | Wert |
---|---|---|
userAssignedIdentity | Die vom Benutzer zugewiesene Identität. | Schnur |
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 |
Identität | Die verwalteten Identitäten für IotHub. | ArmIdentity- |
Ort | Der Ressourcenspeicherort. | Zeichenfolge (erforderlich) |
Name | Der Ressourcenname | Zeichenfolge (erforderlich) |
Eigenschaften | IotHub-Eigenschaften | IotHubProperties- |
Sku | IotHub-SKU-Informationen | IotHubSkuInfo- (erforderlich) |
Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. |
Art | Der Ressourcentyp | "Microsoft.Devices/IotHubs@2021-03-03-preview" |
NetworkRuleSetIpRule
Name | Beschreibung | Wert |
---|---|---|
Aktion | IP-Filteraktion | "Zulassen" |
filterName | 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) |
NetworkRuleSetProperties
Name | Beschreibung | Wert |
---|---|---|
applyToBuiltInEventHubEndpoint | Wenn True, wird der Netzwerkregelsatz auch auf BuiltIn EventHub EndPoint von IotHub angewendet. | bool (erforderlich) |
defaultAction | Standardaktion für netzwerkregelsatz | "Zulassen" "Ablehnen" |
ipRules | Liste der IP-Regeln | NetworkRuleSetIpRule[] (erforderlich) |
PrivateEndpoint
Name | Beschreibung | Wert |
---|
PrivateEndpointConnection
Name | Beschreibung | Wert |
---|---|---|
Eigenschaften | Die Eigenschaften einer privaten Endpunktverbindung | PrivateEndpointConnectionProperties (erforderlich) |
PrivateEndpointConnectionProperties
Name | Beschreibung | Wert |
---|---|---|
privateEndpoint | Die private Endpunkteigenschaft einer privaten Endpunktverbindung | PrivateEndpoint- |
privateLinkServiceConnectionState | Der aktuelle Status einer privaten Endpunktverbindung | PrivateLinkServiceConnectionState (erforderlich) |
PrivateLinkServiceConnectionState
Name | Beschreibung | Wert |
---|---|---|
actionsRequired | Aktionen, die für eine private Endpunktverbindung erforderlich sind | Schnur |
Beschreibung | Die Beschreibung für den aktuellen Status einer privaten Endpunktverbindung | Zeichenfolge (erforderlich) |
Status | Der Status einer privaten Endpunktverbindung | "Genehmigt" "Getrennt" "Ausstehend" "Abgelehnt" (erforderlich) |
ResourceTags
Name | Beschreibung | Wert |
---|
RouteProperties
Name | Beschreibung | Wert |
---|---|---|
Zustand | Die Bedingung, die ausgewertet wird, um die Routingregel anzuwenden. Wenn keine Bedingung angegeben wird, wird sie standardmäßig als "true" ausgewertet. Grammatik finden Sie unter : /azure/iot-hub/iot-hub-devguide-query-language | Schnur |
endpointNames | Die Liste der Endpunkte, an die Nachrichten weitergeleitet werden, die die Bedingung erfüllen. Derzeit ist nur ein Endpunkt zulässig. | string[] (erforderlich) |
isEnabled | Wird verwendet, um anzugeben, ob eine Route aktiviert ist. | bool (erforderlich) |
Name | Der Name der Route. Der Name kann nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche, maximal 64 Zeichen enthalten und muss eindeutig sein. | Schnur Zwänge: Pattern = ^[A-Za-z0-9-._]{1,64}$ (erforderlich) |
Quelle | Die Quelle, auf die die Routingregel angewendet werden soll, z. B. DeviceMessages. | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "DigitalTwinChangeEvents" 'Ungültig' "TwinChangeEvents" (erforderlich) |
RoutingEndpoints
Name | Beschreibung | Wert |
---|---|---|
eventHubs | Die Liste der Event Hubs-Endpunkte, an die IoT Hub Nachrichten basierend auf den Routingregeln weiterleitet. Diese Liste enthält nicht den integrierten Event Hubs-Endpunkt. | RoutingEventHubProperties[] |
serviceBusQueues | Die Liste der Endpunkte der Servicebus-Warteschlange, an die IoT Hub die Nachrichten basierend auf den Routingregeln weiterleitet. | RoutingServiceBusQueueEndpointProperties[] |
serviceBusTopics | Die Liste der ServiceBus-Themenendpunkte, an die der IoT-Hub die Nachrichten basierend auf den Routingregeln weiterleitet. | RoutingServiceBusTopicEndpointProperties[] |
storageContainers | Die Liste der Speichercontainerendpunkte, an die IoT Hub Nachrichten basierend auf den Routingregeln weiterleitet. | RoutingStorageContainerProperties[] |
RoutingEventHubProperties
Name | Beschreibung | Wert |
---|---|---|
authenticationType | Methode zur Authentifizierung beim Event Hub-Endpunkt | 'identityBased' "keyBased" |
connectionString | Die Verbindungszeichenfolge des Event Hub-Endpunkts. | Schnur |
endpointUri | Die URL des Event Hub-Endpunkts. Es muss das Protokoll sb:// | Schnur |
entityPath | Event Hub-Name im Event Hub-Namespace | Schnur |
id | ID des Event Hub-Endpunkts | Schnur |
Identität | Verwaltete Identitätseigenschaften des Routingereignishub-Endpunkts. | ManagedIdentity- |
Name | Der Name, der diesen Endpunkt identifiziert. Der Name kann nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche und eine maximale Länge von 64 Zeichen enthalten. Die folgenden Namen sind reserviert: Ereignisse, FileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. | Schnur Zwänge: Pattern = ^[A-Za-z0-9-._]{1,64}$ (erforderlich) |
resourceGroup | Der Name der Ressourcengruppe des Event Hub-Endpunkts. | Schnur |
subscriptionId | Der Abonnementbezeichner des Event Hub-Endpunkts. | Schnur |
RoutingProperties
Name | Beschreibung | Wert |
---|---|---|
Endpunkte | Die Eigenschaften im Zusammenhang mit den benutzerdefinierten Endpunkten, an die Ihr IoT-Hub Nachrichten basierend auf den Routingregeln weiterleitet. Maximal 10 benutzerdefinierte Endpunkte sind für alle Endpunkttypen für kostenpflichtige Hubs zulässig, und nur 1 benutzerdefinierter Endpunkt ist für alle Endpunkttypen für kostenlose Hubs zulässig. | RoutingEndpoints- |
Anreicherungen | Die Liste der vom Benutzer bereitgestellten Anreicherungen, die der IoT-Hub auf Nachrichten an integrierte und benutzerdefinierte Endpunkte zugestellt werden soll. Siehe: https://aka.ms/telemetryoneventgrid | EnrichmentProperties[] |
fallbackRoute | Die Eigenschaften der Route, die als Fallbackroute verwendet wird, wenn keine der im Abschnitt "Routen" angegebenen Bedingungen erfüllt ist. Dies ist ein optionaler Parameter. Wenn diese Eigenschaft nicht festgelegt ist, werden die Nachrichten, die keine der im Abschnitt "Routen" angegebenen Bedingungen erfüllen, an den integrierten EventHub-Endpunkt weitergeleitet. | FallbackRouteProperties |
Routen | Die Liste der vom Benutzer bereitgestellten Routingregeln, die der IoT-Hub zum Weiterleiten von Nachrichten an integrierte und benutzerdefinierte Endpunkte verwendet. Maximal 100 Routingregeln sind für kostenpflichtige Hubs zulässig, und maximal 5 Routingregeln sind für kostenlose Hubs zulässig. | RouteProperties[] |
RoutingServiceBusQueueEndpointProperties
Name | Beschreibung | Wert |
---|---|---|
authenticationType | Methode zur Authentifizierung beim Endpunkt der Servicebuswarteschlange | 'identityBased' "keyBased" |
connectionString | Die Verbindungszeichenfolge des Dienstenbus-Warteschlangenendpunkts. | Schnur |
endpointUri | Die URL des Dienstenbus-Warteschlangenendpunkts. Es muss das Protokoll sb:// | Schnur |
entityPath | Warteschlangenname im Servicebusnamespace | Schnur |
id | ID des Dienstenbus-Warteschlangenendpunkts | Schnur |
Identität | Verwaltete Identitätseigenschaften des Routingdienstbus-Warteschlangenendpunkts. | ManagedIdentity- |
Name | Der Name, der diesen Endpunkt identifiziert. Der Name kann nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche und eine maximale Länge von 64 Zeichen enthalten. Die folgenden Namen sind reserviert: Ereignisse, FileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. Der Name muss nicht mit dem tatsächlichen Warteschlangennamen übereinstimmen. | Schnur Zwänge: Pattern = ^[A-Za-z0-9-._]{1,64}$ (erforderlich) |
resourceGroup | Der Name der Ressourcengruppe des Dienstenbus-Warteschlangenendpunkts. | Schnur |
subscriptionId | Der Abonnementbezeichner des Dienstenbus-Warteschlangenendpunkts. | Schnur |
RoutingServiceBusTopicEndpointProperties
Name | Beschreibung | Wert |
---|---|---|
authenticationType | Methode zur Authentifizierung beim Endpunkt des Servicebusthemas | 'identityBased' "keyBased" |
connectionString | Die Verbindungszeichenfolge des Servicebus-Themenendpunkts. | Schnur |
endpointUri | Die URL des Endpunkts des Servicebusthemas. Es muss das Protokoll sb:// | Schnur |
entityPath | Warteschlangenname im Thema "Servicebus" | Schnur |
id | ID des Endpunkts des Servicebusthemas | Schnur |
Identität | Verwaltete Identitätseigenschaften des Endpunkts des Routingdienstbus. | ManagedIdentity- |
Name | Der Name, der diesen Endpunkt identifiziert. Der Name kann nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche und eine maximale Länge von 64 Zeichen enthalten. Die folgenden Namen sind reserviert: Ereignisse, FileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. Der Name muss nicht mit dem tatsächlichen Themanamen identisch sein. | Schnur Zwänge: Pattern = ^[A-Za-z0-9-._]{1,64}$ (erforderlich) |
resourceGroup | Der Name der Ressourcengruppe des Servicebus-Themenendpunkts. | Schnur |
subscriptionId | Der Abonnementbezeichner des Servicebus-Themenendpunkts. | Schnur |
RoutingStorageContainerProperties
Name | Beschreibung | Wert |
---|---|---|
authenticationType | Methode zur Authentifizierung beim Speicherendpunkt | 'identityBased' "keyBased" |
batchFrequencyInSeconds | Zeitintervall, in das Blobs in den Speicher geschrieben werden. Der Wert sollte zwischen 60 und 720 Sekunden betragen. Der Standardwert beträgt 300 Sekunden. | Int Zwänge: Min.-Wert = 60 Max. Wert = 720 |
connectionString | Die Verbindungszeichenfolge des Speicherkontos. | Schnur |
containerName | Der Name des Speichercontainers im Speicherkonto. | Zeichenfolge (erforderlich) |
Codierung | Codierung, die zum Serialisieren von Nachrichten in Blobs verwendet wird. Unterstützte Werte sind "avro", "avrodeflate" und "JSON". Der Standardwert ist "avro". | 'Avro' 'AvroDeflate' "JSON" |
endpointUri | Die URL des Speicherendpunkts. Es muss das Protokoll https:// | Schnur |
fileNameFormat | Dateinamenformat für das Blob. Das Standardformat ist {iothub}/{partition}/{JJJJ}/{MM}/{DD}/{HH}/{mm}. Alle Parameter sind obligatorisch, können aber neu angeordnet werden. | Schnur |
id | ID des Speichercontainerendpunkts | Schnur |
Identität | Verwaltete Identitätseigenschaften des Routingspeicherendpunkts. | ManagedIdentity- |
maxChunkSizeInBytes | Maximale Anzahl von Bytes für jedes blob, das in den Speicher geschrieben wurde. Der Wert sollte zwischen 10485760(10 MB) und 524288000(500 MB) sein. Der Standardwert ist 314572800(300 MB). | Int Zwänge: Min-Wert = 10485760 Max. Wert = 524288000 |
Name | Der Name, der diesen Endpunkt identifiziert. Der Name kann nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche und eine maximale Länge von 64 Zeichen enthalten. Die folgenden Namen sind reserviert: Ereignisse, FileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. | Schnur Zwänge: Pattern = ^[A-Za-z0-9-._]{1,64}$ (erforderlich) |
resourceGroup | Der Name der Ressourcengruppe des Speicherkontos. | Schnur |
subscriptionId | Der Abonnementbezeichner des Speicherkontos. | Schnur |
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 |
---|---|---|
authenticationType | Gibt den Authentifizierungstyp an, der für die Verbindung mit dem Speicherkonto verwendet wird. | 'identityBased' "keyBased" |
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) |
Identität | Verwaltete Identitätseigenschaften des Speicherendpunkts für den Dateiupload. | ManagedIdentity- |
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 |