Microsoft.Devices IotHubs 2023-06-30-preview
Bicep-Ressourcendefinition
Der IotHubs-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- 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 Bicep hinzu.
resource symbolicname 'Microsoft.Devices/IotHubs@2023-06-30-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
name: 'string'
}
etag: 'string'
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
allowedFqdnList: [
'string'
]
authorizationPolicies: [
{
keyName: 'string'
primaryKey: 'string'
rights: 'string'
secondaryKey: 'string'
keyName: 'string'
primaryKey: 'string'
rights: 'string'
secondaryKey: 'string'
}
]
cloudToDevice: {
defaultTtlAsIso8601: 'string'
feedback: {
lockDurationAsIso8601: 'string'
maxDeliveryCount: int
ttlAsIso8601: 'string'
}
maxDeliveryCount: int
}
comments: 'string'
deviceStreams: {
streamingEndpoints: [
'string'
]
}
disableDeviceSAS: bool
disableLocalAuth: bool
disableModuleSAS: bool
enableDataResidency: bool
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'
}
]
ipVersion: 'string'
messagingEndpoints: {
{customized property}: {
lockDurationAsIso8601: 'string'
maxDeliveryCount: int
ttlAsIso8601: 'string'
}
}
minTlsVersion: 'string'
networkRuleSets: {
applyToBuiltInEventHubEndpoint: bool
defaultAction: 'string'
ipRules: [
{
action: 'Allow'
filterName: 'string'
ipMask: 'string'
}
]
}
privateEndpointConnections: [
{
properties: {
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
]
publicNetworkAccess: 'string'
restrictOutboundNetworkAccess: bool
rootCertificate: {
enableRootCertificateV2: bool
}
routing: {
endpoints: {
cosmosDBSqlContainers: [
{
authenticationType: 'string'
containerName: 'string'
databaseName: 'string'
endpointUri: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
partitionKeyName: 'string'
partitionKeyTemplate: 'string'
primaryKey: 'string'
resourceGroup: 'string'
secondaryKey: 'string'
subscriptionId: 'string'
}
]
eventHubs: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
serviceBusQueues: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
serviceBusTopics: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
storageContainers: [
{
authenticationType: 'string'
batchFrequencyInSeconds: int
connectionString: 'string'
containerName: 'string'
encoding: 'string'
endpointUri: 'string'
fileNameFormat: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
maxChunkSizeInBytes: int
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
}
enrichments: [
{
endpointNames: [
'string'
]
key: 'string'
value: 'string'
}
]
fallbackRoute: {
condition: 'string'
endpointNames: [
'string'
]
isEnabled: bool
name: 'string'
source: 'string'
}
routes: [
{
condition: 'string'
endpointNames: [
'string'
]
isEnabled: bool
name: 'string'
source: 'string'
}
]
}
storageEndpoints: {
{customized property}: {
authenticationType: 'string'
connectionString: 'string'
containerName: 'string'
identity: {
userAssignedIdentity: 'string'
}
sasTtlAsIso8601: 'string'
}
}
}
}
Eigenschaftswerte
IotHubs
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Der Ressourcenname | Zeichenfolge (erforderlich) Zeichenlimit: 3-50 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. Darf nicht mit einem Bindestrich enden. Der Ressourcenname muss in Azure eindeutig sein. |
| location | Der Ressourcenspeicherort. | Zeichenfolge (erforderlich) |
| tags | Die Ressourcentags. | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
| sku | Informationen zur IotHub-SKU | IotHubSkuInfo (erforderlich) |
| etag | Das Feld Etag ist nicht erforderlich. Wenn es im Antworttext angegeben wird, muss es auch als Header gemäß der normalen ETag-Konvention bereitgestellt werden. | Zeichenfolge |
| Identität | Die verwalteten Identitäten für IotHub. | ArmIdentity |
| properties | IotHub-Eigenschaften | IotHubProperties |
ArmIdentity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | 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 Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. | "Keine" "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" |
| userAssignedIdentities | Wörterbuch von {ArmUserIdentity} | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | ArmUserIdentity |
ArmUserIdentity
Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.
IotHubProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| allowedFqdnList | Liste der zulässigen FQDNs (vollqualifizierter Domänenname) für ausgehenden Datenverkehr aus Iot Hub. | string[] |
| 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 Cloud-zu-Gerät-Messagingeigenschaften von IoT Hub. | CloudToDeviceProperties |
| comments | IoT Hub-Kommentare. | Zeichenfolge |
| deviceStreams | Das Gerät streamt die Eigenschaften von iothub. | IotHubPropertiesDeviceStreams |
| disableDeviceSAS | Wenn true, können alle sas-Bereichsschlüssel für alle Geräte (einschließlich Edgegeräte, aber mit Ausnahme von Modulen) nicht für die Authentifizierung verwendet werden. | bool |
| disableLocalAuth | Wenn true, können SAS-Token mit iot hub-bereichsbezogenen SAS-Schlüsseln nicht für die Authentifizierung verwendet werden. | bool |
| disableModuleSAS | Wenn true, können nicht alle modulbezogenen SAS-Schlüssel für die Authentifizierung verwendet werden. | bool |
| enableDataResidency | Wenn diese Eigenschaft auf TRUE festgelegt ist, wird die Datenresidenz aktiviert, wodurch die Notfallwiederherstellung deaktiviert wird. | bool |
| enableFileUploadNotifications | True gibt an, dass Benachrichtigungen zum Hochladen von Dateien aktiviert sind. | bool |
| Verschlüsselung | Die Verschlüsselungseigenschaften für den IoT Hub. | EncryptionPropertiesDescription |
| eventHubEndpoints | Die Event Hub-kompatiblen Endpunkteigenschaften. Der einzige mögliche Schlüssel für dieses Wörterbuch sind Ereignisse. Dieser Schlüssel muss im Wörterbuch vorhanden sein, während Erstellungs- oder Aktualisierungsaufrufe für den IoT Hub ausgeführt werden. | IotHubPropertiesEventHubEndpoints |
| Features | Die Funktionen und Features, die für den IoT Hub aktiviert sind. | "DeviceManagement" "Keine" |
| ipFilterRules | Die IP-Filterregeln. | IpFilterRule[] |
| ipVersion | Diese Eigenschaft gibt die IP-Version an, die der Hub derzeit verwendet. | "ipv4" "ipv4ipv6" "ipv6" |
| messagingEndpoints | Die Messagingendpunkteigenschaften für die Dateiuploadbenachrichtigungswarteschlange. | IotHubPropertiesMessagingEndpoints |
| minTlsVersion | Gibt die TLS-Mindestversion 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. | Zeichenfolge |
| networkRuleSets | Eigenschaften des Netzwerkregelsatzes von IotHub | NetworkRuleSetProperties |
| privateEndpointConnections. | Private Endpunktverbindungen, die auf diesem IotHub erstellt wurden | PrivateEndpointConnection[] |
| publicNetworkAccess | Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind | "Deaktiviert" "Aktiviert" |
| restrictOutboundNetworkAccess | Wenn true, wird der ausgehende Datenverkehr von IotHub nur auf die zulässigen FQDNs beschränkt, die über allowedFqdnList konfiguriert sind. | bool |
| rootCertificate | Diese Eigenschaft speichert Informationen zu Stammzertifikaten. | RootCertificateProperties |
| Weiterleiten | Die routingbezogenen Eigenschaften des IoT-Hubs. Siehe: /azure/iot-hub/iot-hub-devguide-messaging | RoutingEigenschaften |
| storageEndpoints | Die Liste der Azure Storage-Endpunkte, an die Sie Dateien hochladen können. Derzeit können Sie nur ein Azure Storage-Konto konfigurieren, dessen Schlüssel als $default muss. Wenn Sie mehrere Speicherkonten angeben, wird ein Fehler ausgelöst. Wenn sie keinen Wert für diese Eigenschaft angeben, wenn die enableFileUploadNotifications-Eigenschaft auf True festgelegt ist, wird ein Fehler ausgelöst. | IotHubPropertiesStorageEndpoints |
SharedAccessSignatureAuthorizationRule
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| keyName | Der Name der SAS-Richtlinie. | Zeichenfolge (erforderlich) |
| primaryKey | Der primäre Schlüssel. | Zeichenfolge |
| Rechte | Die berechtigungen, die der SAS-Richtlinie 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. | Zeichenfolge |
| keyName | Der Name der SAS-Richtlinie. | Zeichenfolge (erforderlich) |
| primaryKey | Der primäre Schlüssel. | Zeichenfolge |
| Rechte | Die berechtigungen, die der SAS-Richtlinie 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. | Zeichenfolge |
CloudToDeviceProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| defaultTtlAsIso8601 | Die Standardlaufzeit für Cloud-zu-Gerät-Nachrichten in der Gerätewarteschlange. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Zeichenfolge |
| feedback | Die Eigenschaften der Feedbackwarteschlange für Cloud-zu-Gerät-Nachrichten. | FeedbackEigenschaften |
| maxDeliveryCount | Die maximale Übermittlungsanzahl für Cloud-zu-Gerät-Nachrichten in der Gerätewarteschlange. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | INT Einschränkungen: Minimaler Wert = 1 Maximaler Wert = 100 |
FeedbackEigenschaften
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| lockDurationAsIso8601 | Die Sperrdauer für die Feedbackwarteschlange. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Zeichenfolge |
| maxDeliveryCount | Gibt an, wie oft der IoT Hub versucht, eine Nachricht in der Feedbackwarteschlange zu übermitteln. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | INT Einschränkungen: Minimaler Wert = 1 Maximaler 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. | Zeichenfolge |
IotHubPropertiesDeviceStreams
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| streamingEndpoints | Liste der Gerätestream-Endpunkte. | string[] |
EncryptionPropertiesDescription
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| keySource | Die Quelle des Schlüssels. | Zeichenfolge |
| keyVaultProperties | Die Eigenschaften des Schlüssels KeyVault. | KeyVaultKeyProperties[] |
KeyVaultKeyProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Identität | Verwaltete Identitätseigenschaften von KeyVault Key. | ManagedIdentity |
| keyIdentifier | Der Bezeichner des Schlüssels. | Zeichenfolge |
ManagedIdentity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| userAssignedIdentity | Die vom Benutzer zugewiesene Identität. | Zeichenfolge |
IotHubPropertiesEventHubEndpoints
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | EventHubProperties |
EventHubProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| partitionCount | Die Anzahl der Partitionen zum Empfangen von Device-to-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 |
IpFilterRule
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| action | 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) |
IotHubPropertiesMessagingEndpoints
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | MessagingEndpointProperties |
MessagingEndpointProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| lockDurationAsIso8601 | Die Sperrdauer. Siehe: /azure/iot-hub/iot-hub-devguide-file-upload. | Zeichenfolge |
| maxDeliveryCount | Gibt an, wie oft der IoT Hub versucht, eine Nachricht zu übermitteln. Siehe: /azure/iot-hub/iot-hub-devguide-file-upload. | INT Einschränkungen: Minimaler Wert = 1 Maximaler 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. | Zeichenfolge |
NetworkRuleSetProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| applyToBuiltInEventHubEndpoint | Bei True wird der Netzwerkregelsatz auch auf BuiltIn EventHub EndPoint von IotHub angewendet. | bool (erforderlich) |
| Defaultaction | Standardaktion für Den Netzwerkregelsatz | "Zulassen" "Verweigern" |
| ipRules | Liste der IP-Regeln | NetworkRuleSetIpRule[] (erforderlich) |
NetworkRuleSetIpRule
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| action | 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) |
PrivateEndpointConnection
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| properties | Die Eigenschaften einer Verbindung mit einem privaten Endpunkt | PrivateEndpointConnectionProperties (erforderlich) |
PrivateEndpointConnectionProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| privateEndpoint | Die Eigenschaft des privaten Endpunkts einer Verbindung mit einem privaten Endpunkt | PrivateEndpoint |
| privateLinkServiceConnectionState | Der aktuelle Status einer Verbindung mit einem privaten Endpunkt | PrivateLinkServiceConnectionState (erforderlich) |
PrivateEndpoint
Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.
PrivateLinkServiceConnectionState
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| actionsRequired | Für eine Verbindung mit einem privaten Endpunkt erforderliche Aktionen | Zeichenfolge |
| description | Die Beschreibung für den aktuellen Status einer Verbindung mit einem privaten Endpunkt | Zeichenfolge (erforderlich) |
| status | Die status einer Verbindung mit einem privaten Endpunkt | "Genehmigt" "Getrennt" "Ausstehend" "Abgelehnt" (erforderlich) |
RootCertificateProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| enableRootCertificateV2 | Wenn diese Eigenschaft auf TRUE festgelegt ist, verwendet der Hub das G2-Zertifikat. Während die Einstellung auf false festgelegt ist, verwendet der Hub Baltimore Cert. | bool |
RoutingEigenschaften
| 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 ein 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 anwendet, die an integrierte und benutzerdefinierte Endpunkte übermittelt werden sollen. 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 verwendet, um Nachrichten an integrierte und benutzerdefinierte Endpunkte weiterzuleiten. Für kostenpflichtige Hubs sind maximal 100 Routingregeln und für kostenlose Hubs maximal 5 Routingregeln zulässig. | RouteProperties[] |
RoutingEndpoints
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| cosmosDBSqlContainers | Die Liste der Cosmos DB-Containerendpunkte, an die IoT Hub Nachrichten basierend auf den Routingregeln weiterleitet. | RoutingCosmosDBSqlApiProperties[] |
| 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 Service Bus-Warteschlangenendpunkte, an die IoT Hub die Nachrichten basierend auf den Routingregeln weiterleitet. | RoutingServiceBusQueueEndpointProperties[] |
| serviceBusTopics | Die Liste der Service Bus-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[] |
RoutingCosmosDBSqlApiProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| authenticationType | Methode zur Authentifizierung beim sql-Containerendpunkt von Cosmos DB | "identityBased" "keyBased" |
| containerName | Der Name des cosmos DB-SQL-Containers in der cosmos DB-Datenbank. | Zeichenfolge (erforderlich) |
| databaseName | Der Name der cosmos DB-Datenbank im cosmos DB-Konto. | Zeichenfolge (erforderlich) |
| endpointUri | Die URL des cosmos DB-Kontos. Es muss das Protokoll enthalten. https:// |
Zeichenfolge (erforderlich) |
| id | ID des sql-Containerendpunkts von Cosmos DB | Zeichenfolge |
| Identität | Eigenschaften der verwalteten Identität des Routings des Cosmos DB-Containerendpunkts. | ManagedIdentity |
| name | Der Name, der diesen Endpunkt identifiziert. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten und hat eine maximale Länge von 64 Zeichen. Die folgenden Namen sind reserviert: events, fileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. | Zeichenfolge (erforderlich) Einschränkungen: Muster = ^[A-Za-z0-9-._]{1,64}$ |
| partitionKeyName | Der Name des Partitionsschlüssels, der diesem Cosmos DB-SQL-Container zugeordnet ist, sofern vorhanden. Dies ist ein optionaler Parameter. | Zeichenfolge |
| partitionKeyTemplate | Die Vorlage zum Generieren eines synthetischen Partitionsschlüsselwerts für die Verwendung mit diesem cosmos DB-SQL-Container. Die Vorlage muss mindestens einen der folgenden Platzhalter enthalten: {iothub}, {deviceid}, {DD}, {MM} und {YYYY}. Jeder Platzhalter kann höchstens einmal angegeben werden, aber Die Komponenten der Reihenfolge und nicht des Platzhalters sind beliebig. Dieser Parameter ist nur erforderlich, wenn PartitionKeyName angegeben ist. | Zeichenfolge |
| primaryKey | Der Primärschlüssel des cosmos DB-Kontos. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
| resourceGroup | Der Name der Ressourcengruppe des cosmos DB-Kontos. | Zeichenfolge |
| secondaryKey | Der sekundäre Schlüssel des cosmos DB-Kontos. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
| subscriptionId | Der Abonnementbezeichner des cosmos DB-Kontos. | Zeichenfolge |
RoutingEventHubProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| authenticationType | Methode zur Authentifizierung beim Event Hub-Endpunkt | "identityBased" "keyBased" |
| connectionString | Die Verbindungszeichenfolge des Event Hub-Endpunkts. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
| endpointUri | Die URL des Event Hub-Endpunkts. Es muss das Protokoll enthalten sb:// | Zeichenfolge |
| entityPath | Event Hub-Name im Event Hub-Namespace | Zeichenfolge |
| id | ID des Event Hub-Endpunkts | Zeichenfolge |
| Identität | Eigenschaften der verwalteten Identität des Routing-Event Hub-Endpunkts. | ManagedIdentity |
| name | Der Name, der diesen Endpunkt identifiziert. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten und hat eine maximale Länge von 64 Zeichen. Die folgenden Namen sind reserviert: events, fileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. | Zeichenfolge (erforderlich) Einschränkungen: Muster = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Der Name der Ressourcengruppe des Event Hub-Endpunkts. | Zeichenfolge |
| subscriptionId | Der Abonnementbezeichner des Event Hub-Endpunkts. | Zeichenfolge |
RoutingServiceBusQueueEndpointProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| authenticationType | Methode zur Authentifizierung beim Service Bus-Warteschlangenendpunkt | "identityBased" "keyBased" |
| connectionString | Die Verbindungszeichenfolge des Service Bus-Warteschlangenendpunkts. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
| endpointUri | Die URL des Service Bus-Warteschlangenendpunkts. Es muss das Protokoll enthalten sb:// | Zeichenfolge |
| entityPath | Warteschlangenname im Service Bus-Namespace | Zeichenfolge |
| id | ID des Service Bus-Warteschlangenendpunkts | Zeichenfolge |
| Identität | Verwaltete Identitätseigenschaften des Routingdienstbus-Warteschlangenendpunkts. | ManagedIdentity |
| name | Der Name, der diesen Endpunkt identifiziert. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten und hat eine maximale Länge von 64 Zeichen. Die folgenden Namen sind reserviert: events, fileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. Der Name muss nicht mit dem tatsächlichen Warteschlangennamen identisch sein. | Zeichenfolge (erforderlich) Einschränkungen: Muster = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Der Name der Ressourcengruppe des Service Bus-Warteschlangenendpunkts. | Zeichenfolge |
| subscriptionId | Der Abonnementbezeichner des Service Bus-Warteschlangenendpunkts. | Zeichenfolge |
RoutingServiceBusTopicEndpointProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| authenticationType | Methode zur Authentifizierung beim Service Bus-Themenendpunkt | "identityBased" "keyBased" |
| connectionString | Die Verbindungszeichenfolge des Service Bus-Themenendpunkts. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
| endpointUri | Die URL des Service Bus-Themenendpunkts. Es muss das Protokoll enthalten sb:// | Zeichenfolge |
| entityPath | Warteschlangenname im Service Bus-Thema | Zeichenfolge |
| id | ID des Service Bus-Themenendpunkts | Zeichenfolge |
| Identität | Verwaltete Identitätseigenschaften des Routing-Service Bus-Themenendpunkts. | ManagedIdentity |
| name | Der Name, der diesen Endpunkt identifiziert. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten und hat eine maximale Länge von 64 Zeichen. Die folgenden Namen sind reserviert: events, fileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. Der Name muss nicht mit dem tatsächlichen Themennamen identisch sein. | Zeichenfolge (erforderlich) Einschränkungen: Muster = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Der Name der Ressourcengruppe des Service Bus-Themenendpunkts. | Zeichenfolge |
| subscriptionId | Der Abonnementbezeichner des Service Bus-Themenendpunkts. | Zeichenfolge |
RoutingStorageContainerProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| authenticationType | Methode zur Authentifizierung beim Speicherendpunkt | "identityBased" "keyBased" |
| batchFrequencyInSeconds | Zeitintervall, in dem Blobs in den Speicher geschrieben werden. Der Wert sollte zwischen 60 und 720 Sekunden betragen. Der Standardwert ist 300 Sekunden. | INT Einschränkungen: Minimaler Wert = 60 Maximaler Wert = 720 |
| connectionString | Die Verbindungszeichenfolge des Speicherkontos. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
| containerName | Der Name des Speichercontainers im Speicherkonto. | Zeichenfolge (erforderlich) |
| encoding | 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 enthalten. https:// |
Zeichenfolge |
| 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. | Zeichenfolge |
| id | ID des Speichercontainerendpunkts | Zeichenfolge |
| Identität | Verwaltete Identitätseigenschaften des Routingspeicherendpunkts. | ManagedIdentity |
| maxChunkSizeInBytes | Maximale Anzahl von Bytes für jedes in den Speicher geschriebene Blob. Der Wert sollte zwischen 10485760(10MB) und 524288000(500MB) liegen. Der Standardwert ist 314572800(300MB). | INT Einschränkungen: Minimaler Wert = 10485760 Maximaler Wert = 524288000 |
| name | Der Name, der diesen Endpunkt identifiziert. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten und hat eine maximale Länge von 64 Zeichen. Die folgenden Namen sind reserviert: ereignisse, fileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. | Zeichenfolge (erforderlich) Einschränkungen: Muster = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Der Name der Ressourcengruppe des Speicherkontos. | Zeichenfolge |
| subscriptionId | Der Abonnementbezeichner des Speicherkontos. | Zeichenfolge |
EnrichmentProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| endpointNames | Die Liste der Endpunkte, für die die Anreicherung auf die Nachricht angewendet wird. | string[] (erforderlich) Einschränkungen: Min. Länge = 1 |
| Schlüssel | Der Schlüssel oder Name für die Anreicherungseigenschaft. | Zeichenfolge (erforderlich) |
| value | Der Wert für die Anreicherungseigenschaft. | Zeichenfolge (erforderlich) |
FallbackRouteProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| condition | Die Bedingung, die ausgewertet wird, um die Fallbackroute anzuwenden. Wenn die Bedingung nicht bereitgestellt wird, wird sie standardmäßig auf true ausgewertet. Grammatik finden Sie unter /azure/iot-hub/iot-hub-devguide-query-language. | Zeichenfolge |
| endpointNames | Die Liste der Endpunkte, an die die Nachrichten weitergeleitet werden, die die Bedingung erfüllen. Derzeit ist nur 1 Endpunkt zulässig. | string[] (erforderlich) Einschränkungen: Min. Länge = 1 Maximale Länge = 1 |
| isEnabled | Wird verwendet, um anzugeben, ob die Fallbackroute aktiviert ist. | bool (erforderlich) |
| name | Der Name der Route. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten, hat eine maximale Länge von 64 Zeichen und muss eindeutig sein. | Zeichenfolge |
| source | Die Quelle, auf die die Routingregel angewendet werden soll. Beispiel: DeviceMessages | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "DigitalTwinChangeEvents" "Ungültig" 'MqttBrokerMessages' "TwinChangeEvents" (erforderlich) |
RouteProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| condition | Die Bedingung, die ausgewertet wird, um die Routingregel anzuwenden. Wenn keine Bedingung angegeben wird, wird sie standardmäßig auf true ausgewertet. Grammatik finden Sie unter /azure/iot-hub/iot-hub-devguide-query-language | Zeichenfolge |
| endpointNames | Die Liste der Endpunkte, an die Nachrichten weitergeleitet werden, die die Bedingung erfüllen. Derzeit ist nur ein Endpunkt zulässig. | string[] (erforderlich) Einschränkungen: Min. Länge = 1 Maximale Länge = 1 |
| isEnabled | Wird verwendet, um anzugeben, ob eine Route aktiviert ist. | bool (erforderlich) |
| name | Der Name der Route. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten, hat eine maximale Länge von 64 Zeichen und muss eindeutig sein. | Zeichenfolge (erforderlich) Einschränkungen: Muster = ^[A-Za-z0-9-._]{1,64}$ |
| source | Die Quelle, auf die die Routingregel angewendet werden soll, z. B. DeviceMessages. | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "DigitalTwinChangeEvents" "Ungültig" 'MqttBrokerMessages' "TwinChangeEvents" (erforderlich) |
IotHubPropertiesStorageEndpoints
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | StorageEndpointProperties |
StorageEndpointProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| authenticationType | Gibt den Authentifizierungstyp an, der zum Herstellen einer 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 aber mit dem angegebenen connectionString bestellbar sein. | Zeichenfolge (erforderlich) |
| Identität | Eigenschaften der verwalteten Identität des Speicherendpunkts für den Dateiupload. | ManagedIdentity |
| sasTtlAsIso8601 | Der Zeitraum, für den der von IoT Hub für den Dateiupload generierte SAS-URI gültig ist. Weitere Informationen finden Sie unter /azure/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | Zeichenfolge |
IotHubSkuInfo
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Kapazität | Die Anzahl der bereitgestellten IoT Hub Einheiten. Weitere Informationen finden Sie unter /azure/azure-subscription-service-limits#iot-hub-limits. | INT |
| name | Der Name der SKU. | "B1" "B2" "B3" "F1" 'S1' "S2" "S3" (erforderlich) |
Schnellstartvorlagen
Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.
| Vorlage | BESCHREIBUNG |
|---|---|
Erstellen eines IOT Hub- und Ubuntu-Edgesimulators |
Mit dieser Vorlage wird ein IOT Hub und ein Ubuntu-Edgesimulator für virtuelle Computer erstellt. |
| Verwenden der ARM-Vorlage zum Erstellen von IoT Hub, Weiterleiten und Anzeigen von Nachrichten |
Verwenden Sie diese Vorlage, um ein 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. |
| Erstellen eines IoT Hub Device Provisioning Service |
Mit dieser Vorlage können Sie einen IoT Hub und einen IoT Hub Device Provisioning Service erstellen und die beiden Dienste miteinander verknüpfen. |
| Erstellen einer IoT Hub und einer Geräte-zu-Cloud-Consumergruppe |
Mit dieser Vorlage können Sie eine IoT Hub instance mit Geräte-zu-Cloud- und Cloud-zu-Gerät-Zu-Gerät-Messagingkonfigurationen und einer Geräte-zu-Cloud-Consumergruppe bereitstellen. |
| Erstellen eines Geräteupdates für IoT Hub Konto, instance, IoT Hub |
Diese Vorlage erstellt ein Konto sowie ein instance und einen Hub zum Verknüpfen des instance. Er konfiguriert den Hub mit den erforderlichen Zugriffsrichtlinien, Routen und Consumergruppen. |
| Bereitstellen des MedTech-Diensts einschließlich einer Azure IoT Hub |
Der MedTech-Dienst ist einer der Azure Health Data Services, der zum Erfassen von Gerätedaten von mehreren Geräten entwickelt wurde und die Gerätedaten in FHIR-Beobachtungen transformiert werden, die dann im Azure Health Data Services FHIR-Dienst beibehalten werden. |
| Erstellen einer Pay-As-You-Go-Umgebung (PAYG) mit einem IoT Hub |
Mit dieser Vorlage können Sie eine Time Series Insights-Umgebung bereitstellen, die für die Nutzung von Ereignissen aus einem IoT Hub konfiguriert ist. |
Ressourcendefinition mit einer ARM-Vorlage
Der IotHubs-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- 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": "2023-06-30-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"name": "string"
},
"etag": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"allowedFqdnList": [ "string" ],
"authorizationPolicies": [
{
"keyName": "string",
"primaryKey": "string",
"rights": "string",
"secondaryKey": "string",
"keyName": "string",
"primaryKey": "string",
"rights": "string",
"secondaryKey": "string"
}
],
"cloudToDevice": {
"defaultTtlAsIso8601": "string",
"feedback": {
"lockDurationAsIso8601": "string",
"maxDeliveryCount": "int",
"ttlAsIso8601": "string"
},
"maxDeliveryCount": "int"
},
"comments": "string",
"deviceStreams": {
"streamingEndpoints": [ "string" ]
},
"disableDeviceSAS": "bool",
"disableLocalAuth": "bool",
"disableModuleSAS": "bool",
"enableDataResidency": "bool",
"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"
}
],
"ipVersion": "string",
"messagingEndpoints": {
"{customized property}": {
"lockDurationAsIso8601": "string",
"maxDeliveryCount": "int",
"ttlAsIso8601": "string"
}
},
"minTlsVersion": "string",
"networkRuleSets": {
"applyToBuiltInEventHubEndpoint": "bool",
"defaultAction": "string",
"ipRules": [
{
"action": "Allow",
"filterName": "string",
"ipMask": "string"
}
]
},
"privateEndpointConnections": [
{
"properties": {
"privateEndpoint": {},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
],
"publicNetworkAccess": "string",
"restrictOutboundNetworkAccess": "bool",
"rootCertificate": {
"enableRootCertificateV2": "bool"
},
"routing": {
"endpoints": {
"cosmosDBSqlContainers": [
{
"authenticationType": "string",
"containerName": "string",
"databaseName": "string",
"endpointUri": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"partitionKeyName": "string",
"partitionKeyTemplate": "string",
"primaryKey": "string",
"resourceGroup": "string",
"secondaryKey": "string",
"subscriptionId": "string"
}
],
"eventHubs": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"serviceBusQueues": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"serviceBusTopics": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"storageContainers": [
{
"authenticationType": "string",
"batchFrequencyInSeconds": "int",
"connectionString": "string",
"containerName": "string",
"encoding": "string",
"endpointUri": "string",
"fileNameFormat": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"maxChunkSizeInBytes": "int",
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
]
},
"enrichments": [
{
"endpointNames": [ "string" ],
"key": "string",
"value": "string"
}
],
"fallbackRoute": {
"condition": "string",
"endpointNames": [ "string" ],
"isEnabled": "bool",
"name": "string",
"source": "string"
},
"routes": [
{
"condition": "string",
"endpointNames": [ "string" ],
"isEnabled": "bool",
"name": "string",
"source": "string"
}
]
},
"storageEndpoints": {
"{customized property}": {
"authenticationType": "string",
"connectionString": "string",
"containerName": "string",
"identity": {
"userAssignedIdentity": "string"
},
"sasTtlAsIso8601": "string"
}
}
}
}
Eigenschaftswerte
IotHubs
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Ressourcentyp | "Microsoft.Devices/IotHubs" |
| apiVersion | Die Ressourcen-API-Version | '2023-06-30-preview' |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) Zeichenlimit: 3-50 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. Darf nicht mit einem Bindestrich enden. Der Ressourcenname muss in Azure eindeutig sein. |
| location | Der Ressourcenspeicherort. | Zeichenfolge (erforderlich) |
| tags | Die Ressourcentags. | Wörterbuch der Tagnamen und -werte. Weitere Informationen finden Sie unter Tags in Vorlagen. |
| sku | Informationen zur IotHub-SKU | IotHubSkuInfo (erforderlich) |
| etag | Das Etag-Feld ist nicht erforderlich. Wenn es im Antworttext angegeben wird, muss er gemäß der normalen ETag-Konvention auch als Header bereitgestellt werden. | Zeichenfolge |
| Identität | Die verwalteten Identitäten für IotHub. | ArmIdentity |
| properties | IotHub-Eigenschaften | IotHubProperties |
ArmIdentity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" umfasst sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. | "Keine" "SystemAssigned" 'SystemAssigned, UserAssigned' "UserAssigned" |
| userAssignedIdentities | Wörterbuch von {ArmUserIdentity} | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | ArmUserIdentity |
ArmUserIdentity
Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.
IotHubProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| allowedFqdnList | Liste der zulässigen FQDNs (vollqualifizierter Domänenname) für ausgehenden Datenverkehr von Iot Hub. | string[] |
| authorizationPolicies | Die Shared Access-Richtlinien, die Sie verwenden können, um eine Verbindung mit dem IoT Hub zu sichern. | SharedAccessSignatureAuthorizationRule[] |
| cloudToDevice | Die IoT Hub-Cloud-zu-Gerät-Messagingeigenschaften. | CloudToDeviceProperties |
| comments | IoT Hub-Kommentare. | Zeichenfolge |
| deviceStreams | Das Gerät streamt eigenschaften von iothub. | IotHubPropertiesDeviceStreams |
| disableDeviceSAS | Wenn true, können nicht alle SAS-Bereichsschlüssel für Geräte (einschließlich Edgegeräte, aber mit Ausnahme von Modulen) für die Authentifizierung verwendet werden. | bool |
| disableLocalAuth | Wenn true, können SAS-Token mit iot hub-bereichsbezogenen SAS-Schlüsseln nicht für die Authentifizierung verwendet werden. | bool |
| disableModuleSAS | Wenn true, können nicht alle modulbezogenen SAS-Schlüssel für die Authentifizierung verwendet werden. | bool |
| enableDataResidency | Wenn diese Eigenschaft auf TRUE festgelegt ist, wird die Datenresidenz aktiviert, wodurch die Notfallwiederherstellung deaktiviert wird. | bool |
| enableFileUploadNotifications | True gibt an, dass Benachrichtigungen zum Hochladen von Dateien aktiviert sind. | bool |
| Verschlüsselung | Die Verschlüsselungseigenschaften für den IoT Hub. | EncryptionPropertiesDescription |
| eventHubEndpoints | Die Event Hub-kompatiblen Endpunkteigenschaften. Der einzige mögliche Schlüssel für dieses Wörterbuch sind Ereignisse. Dieser Schlüssel muss im Wörterbuch vorhanden sein, während Erstellungs- oder Aktualisierungsaufrufe für den IoT Hub ausgeführt werden. | IotHubPropertiesEventHubEndpoints |
| Features | Die Funktionen und Features, die für den IoT Hub aktiviert sind. | "DeviceManagement" "Keine" |
| ipFilterRules | Die IP-Filterregeln. | IpFilterRule[] |
| ipVersion | Diese Eigenschaft gibt die IP-Version an, die der Hub derzeit verwendet. | "ipv4" "ipv4ipv6" "ipv6" |
| messagingEndpoints | Die Messagingendpunkteigenschaften für die Dateiuploadbenachrichtigungswarteschlange. | IotHubPropertiesMessagingEndpoints |
| minTlsVersion | Gibt die TLS-Mindestversion 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. | Zeichenfolge |
| networkRuleSets | Eigenschaften des Netzwerkregelsatzes von IotHub | NetworkRuleSetProperties |
| privateEndpointConnections. | Private Endpunktverbindungen, die auf diesem IotHub erstellt wurden | PrivateEndpointConnection[] |
| publicNetworkAccess | Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind | "Deaktiviert" "Aktiviert" |
| restrictOutboundNetworkAccess | Wenn true, wird der ausgehende Datenverkehr von IotHub nur auf die zulässigen FQDNs beschränkt, die über allowedFqdnList konfiguriert sind. | bool |
| rootCertificate | Diese Eigenschaft speichert Informationen zu Stammzertifikaten. | RootCertificateProperties |
| Weiterleiten | Die routingbezogenen Eigenschaften des IoT-Hubs. Siehe: /azure/iot-hub/iot-hub-devguide-messaging | RoutingEigenschaften |
| storageEndpoints | Die Liste der Azure Storage-Endpunkte, an die Sie Dateien hochladen können. Derzeit können Sie nur ein Azure Storage-Konto konfigurieren, dessen Schlüssel als $default muss. Wenn Sie mehrere Speicherkonten angeben, wird ein Fehler ausgelöst. Wenn sie keinen Wert für diese Eigenschaft angeben, wenn die enableFileUploadNotifications-Eigenschaft auf True festgelegt ist, wird ein Fehler ausgelöst. | IotHubPropertiesStorageEndpoints |
SharedAccessSignatureAuthorizationRule
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| keyName | Der Name der SAS-Richtlinie. | Zeichenfolge (erforderlich) |
| primaryKey | Der primäre Schlüssel. | Zeichenfolge |
| Rechte | Die berechtigungen, die der SAS-Richtlinie 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. | Zeichenfolge |
| keyName | Der Name der SAS-Richtlinie. | Zeichenfolge (erforderlich) |
| primaryKey | Der primäre Schlüssel. | Zeichenfolge |
| Rechte | Die berechtigungen, die der SAS-Richtlinie 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. | Zeichenfolge |
CloudToDeviceProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| defaultTtlAsIso8601 | Die Standardlaufzeit für Cloud-zu-Gerät-Nachrichten in der Gerätewarteschlange. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Zeichenfolge |
| feedback | Die Eigenschaften der Feedbackwarteschlange für Cloud-zu-Gerät-Nachrichten. | FeedbackEigenschaften |
| maxDeliveryCount | Die maximale Übermittlungsanzahl für Cloud-zu-Gerät-Nachrichten in der Gerätewarteschlange. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | INT Einschränkungen: Minimaler Wert = 1 Maximaler Wert = 100 |
FeedbackEigenschaften
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| lockDurationAsIso8601 | Die Sperrdauer für die Feedbackwarteschlange. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Zeichenfolge |
| maxDeliveryCount | Gibt an, wie oft der IoT Hub versucht, eine Nachricht in der Feedbackwarteschlange zu übermitteln. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | INT Einschränkungen: Minimaler Wert = 1 Maximaler 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. | Zeichenfolge |
IotHubPropertiesDeviceStreams
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| streamingEndpoints | Liste der Gerätestream-Endpunkte. | string[] |
EncryptionPropertiesDescription
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| keySource | Die Quelle des Schlüssels. | Zeichenfolge |
| keyVaultProperties | Die Eigenschaften des Schlüssels KeyVault. | KeyVaultKeyProperties[] |
KeyVaultKeyProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Identität | Verwaltete Identitätseigenschaften von KeyVault Key. | ManagedIdentity |
| keyIdentifier | Der Bezeichner des Schlüssels. | Zeichenfolge |
ManagedIdentity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| userAssignedIdentity | Die vom Benutzer zugewiesene Identität. | Zeichenfolge |
IotHubPropertiesEventHubEndpoints
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | EventHubProperties |
EventHubProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| partitionCount | Die Anzahl der Partitionen zum Empfangen von Device-to-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 |
IpFilterRule
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| action | 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) |
IotHubPropertiesMessagingEndpoints
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | MessagingEndpointProperties |
MessagingEndpointProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| lockDurationAsIso8601 | Die Sperrdauer. Siehe: /azure/iot-hub/iot-hub-devguide-file-upload. | Zeichenfolge |
| maxDeliveryCount | Die Anzahl der Versuche des IoT Hubs, eine Nachricht zu übermitteln. Weitere Informationen finden Sie unter /azure/iot-hub-devguide-file-upload. | INT Einschränkungen: Min-Wert = 1 Maximaler Wert = 100 |
| ttlAsIso8601 | Der Zeitraum, für den eine Nachricht verwendet werden kann, bevor sie vom IoT Hub abgelaufen ist. Weitere Informationen finden Sie unter /azure/iot-hub-devguide-file-upload. | Zeichenfolge |
NetworkRuleSetProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| applyToBuiltInEventHubEndpoint | Bei True wird der Netzwerkregelsatz auch auf BuiltIn EventHub EndPoint von IotHub angewendet. | bool (erforderlich) |
| Defaultaction | Standardaktion für Den Netzwerkregelsatz | "Zulassen" "Verweigern" |
| ipRules | Liste der IP-Regeln | NetworkRuleSetIpRule[] (erforderlich) |
NetworkRuleSetIpRule
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| action | 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) |
PrivateEndpointConnection
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| properties | Die Eigenschaften einer privaten Endpunktverbindung | PrivateEndpointConnectionProperties (erforderlich) |
PrivateEndpointConnectionProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| privateEndpoint | Die Eigenschaft des privaten Endpunkts einer privaten Endpunktverbindung | PrivateEndpoint |
| privateLinkServiceConnectionState | Der aktuelle Zustand einer Verbindung mit einem privaten Endpunkt | PrivateLinkServiceConnectionState (erforderlich) |
PrivateEndpoint
Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.
PrivateLinkServiceConnectionState
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| actionsRequired | Für eine Verbindung mit einem privaten Endpunkt erforderliche Aktionen | Zeichenfolge |
| description | Die Beschreibung für den aktuellen Zustand einer Verbindung mit einem privaten Endpunkt | Zeichenfolge (erforderlich) |
| status | Die status einer privaten Endpunktverbindung | "Genehmigt" "Getrennt" "Ausstehend" "Abgelehnt" (erforderlich) |
RootCertificateProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| enableRootCertificateV2 | Wenn diese Eigenschaft auf true festgelegt ist, verwendet der Hub das G2-Zertifikat. während es auf false festgelegt ist, verwendet der Hub Baltimore Cert. | bool |
RoutingEigenschaften
| 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 ein 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 anwendet, die an integrierte und benutzerdefinierte Endpunkte übermittelt werden sollen. 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 verwendet, um Nachrichten an integrierte und benutzerdefinierte Endpunkte weiterzuleiten. Für kostenpflichtige Hubs sind maximal 100 Routingregeln zulässig, für kostenlose Hubs sind maximal 5 Routingregeln zulässig. | RouteProperties[] |
RoutingEndpoints
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| cosmosDBSqlContainers | Die Liste der Cosmos DB-Containerendpunkte, an die IoT Hub Nachrichten basierend auf den Routingregeln weiterleitet. | RoutingCosmosDBSqlApiProperties[] |
| 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 Service Bus-Warteschlangenendpunkte, an die IoT Hub die Nachrichten basierend auf den Routingregeln weiterleitet. | RoutingServiceBusQueueEndpointProperties[] |
| serviceBusTopics | Die Liste der Service Bus-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[] |
RoutingCosmosDBSqlApiProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| authenticationType | Methode zur Authentifizierung beim Sql-Containerendpunkt cosmos DB | "identityBased" "keyBased" |
| containerName | Der Name des cosmos DB-SQL-Containers in der cosmos DB-Datenbank. | Zeichenfolge (erforderlich) |
| databaseName | Der Name der cosmos DB-Datenbank im cosmos DB-Konto. | Zeichenfolge (erforderlich) |
| endpointUri | Die URL des cosmos DB-Kontos. Es muss das Protokoll enthalten. https:// |
Zeichenfolge (erforderlich) |
| id | ID des Sql-Containerendpunkts von Cosmos DB | Zeichenfolge |
| Identität | Eigenschaften der verwalteten Identität des Routing-Cosmos DB-Containerendpunkts. | ManagedIdentity |
| name | Der Name, der diesen Endpunkt identifiziert. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten und hat eine maximale Länge von 64 Zeichen. Die folgenden Namen sind reserviert: ereignisse, fileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. | Zeichenfolge (erforderlich) Einschränkungen: Muster = ^[A-Za-z0-9-._]{1,64}$ |
| partitionKeyName | Der Name des Partitionsschlüssels, der diesem Cosmos DB-SQL-Container zugeordnet ist, sofern vorhanden. Dies ist ein optionaler Parameter. | Zeichenfolge |
| partitionKeyTemplate | Die Vorlage zum Generieren eines synthetischen Partitionsschlüsselwerts für die Verwendung mit diesem Cosmos DB-SQL-Container. Die Vorlage muss mindestens einen der folgenden Platzhalter enthalten: {iothub}, {deviceid}, {DD}, {MM} und {JJJJ}. Ein beliebiger Platzhalter kann höchstens einmal angegeben werden, aber Reihenfolge und Nichtplatzhalterkomponenten sind willkürlich. Dieser Parameter ist nur erforderlich, wenn PartitionKeyName angegeben ist. | Zeichenfolge |
| primaryKey | Der Primärschlüssel des cosmos DB-Kontos. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
| resourceGroup | Der Name der Ressourcengruppe des cosmos DB-Kontos. | Zeichenfolge |
| secondaryKey | Der sekundäre Schlüssel des cosmos DB-Kontos. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
| subscriptionId | Der Abonnementbezeichner des cosmos DB-Kontos. | Zeichenfolge |
RoutingEventHubProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| authenticationType | Methode zur Authentifizierung beim Event Hub-Endpunkt | "identityBased" "keyBased" |
| connectionString | Die Verbindungszeichenfolge des Event Hub-Endpunkts. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
| endpointUri | Die URL des Event Hub-Endpunkts. Es muss das Protokoll enthalten, das sb:// | Zeichenfolge |
| entityPath | Event Hubname im Event Hub-Namespace | Zeichenfolge |
| id | ID des Event Hub-Endpunkts | Zeichenfolge |
| Identität | Eigenschaften der verwalteten Identität des Routing-Event Hub-Endpunkts. | ManagedIdentity |
| name | Der Name, der diesen Endpunkt identifiziert. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten und hat eine maximale Länge von 64 Zeichen. Die folgenden Namen sind reserviert: ereignisse, fileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. | Zeichenfolge (erforderlich) Einschränkungen: Muster = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Der Name der Ressourcengruppe des Event Hub-Endpunkts. | Zeichenfolge |
| subscriptionId | Der Abonnementbezeichner des Event Hub-Endpunkts. | Zeichenfolge |
RoutingServiceBusQueueEndpointProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| authenticationType | Methode zur Authentifizierung beim Service Bus-Warteschlangenendpunkt | "identityBased" "keyBased" |
| connectionString | Die Verbindungszeichenfolge des Service Bus-Warteschlangenendpunkts. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
| endpointUri | Die URL des Service Bus-Warteschlangenendpunkts. Es muss das Protokoll enthalten, das sb:// | Zeichenfolge |
| entityPath | Warteschlangenname im Service Bus-Namespace | Zeichenfolge |
| id | ID des Service Bus-Warteschlangenendpunkts | Zeichenfolge |
| Identität | Eigenschaften der verwalteten Identität des Routingdienstbus-Warteschlangenendpunkts. | ManagedIdentity |
| name | Der Name, der diesen Endpunkt identifiziert. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten und hat eine maximale Länge von 64 Zeichen. 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 identisch sein. | Zeichenfolge (erforderlich) Einschränkungen: Muster = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Der Name der Ressourcengruppe des Service Bus-Warteschlangenendpunkts. | Zeichenfolge |
| subscriptionId | Der Abonnementbezeichner des Service Bus-Warteschlangenendpunkts. | Zeichenfolge |
RoutingServiceBusTopicEndpointProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| authenticationType | Methode zur Authentifizierung beim Service Bus-Themenendpunkt | "identityBased" "keyBased" |
| connectionString | Die Verbindungszeichenfolge des Service Bus-Themenendpunkts. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
| endpointUri | Die URL des Service Bus-Themenendpunkts. Es muss das Protokoll enthalten, das sb:// | Zeichenfolge |
| entityPath | Warteschlangenname im Service Bus-Thema | Zeichenfolge |
| id | ID des Service Bus-Themenendpunkts | Zeichenfolge |
| Identität | Eigenschaften der verwalteten Identität des Routing-Service Bus-Themenendpunkts. | ManagedIdentity |
| name | Der Name, der diesen Endpunkt identifiziert. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten und hat eine maximale Länge von 64 Zeichen. 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 Themennamen identisch sein. | Zeichenfolge (erforderlich) Einschränkungen: Muster = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Der Name der Ressourcengruppe des Service Bus-Themenendpunkts. | Zeichenfolge |
| subscriptionId | Der Abonnementbezeichner des Service Bus-Themenendpunkts. | Zeichenfolge |
RoutingStorageContainerProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| authenticationType | Methode zur Authentifizierung beim Speicherendpunkt | "identityBased" "keyBased" |
| batchFrequencyInSeconds | Zeitintervall, in dem Blobs in den Speicher geschrieben werden. Der Wert sollte zwischen 60 und 720 Sekunden betragen. Der Standardwert ist 300 Sekunden. | INT Einschränkungen: Min-Wert = 60 Maximaler Wert = 720 |
| connectionString | Der Verbindungszeichenfolge des Speicherkontos. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
| containerName | Der Name des Speichercontainers im Speicherkonto. | Zeichenfolge (erforderlich) |
| encoding | 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 enthalten. https:// |
Zeichenfolge |
| fileNameFormat | Dateinamenformat für das Blob. Das Standardformat ist {iothub}/{partition}/{JJJJ}/{MM}/{DD}/{HH}/{mm}. Alle Parameter sind obligatorisch, können aber neu sortiert werden. | Zeichenfolge |
| id | ID des Speichercontainerendpunkts | Zeichenfolge |
| Identität | Eigenschaften der verwalteten Identität 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) liegen. Der Standardwert ist 314572800(300 MB). | INT Einschränkungen: Min-Wert = 10485760 Maximaler Wert = 524288000 |
| name | Der Name, der diesen Endpunkt identifiziert. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten und hat eine maximale Länge von 64 Zeichen. Die folgenden Namen sind reserviert: ereignisse, fileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. | Zeichenfolge (erforderlich) Einschränkungen: Muster = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Der Name der Ressourcengruppe des Speicherkontos. | Zeichenfolge |
| subscriptionId | Der Abonnementbezeichner des Speicherkontos. | Zeichenfolge |
EnrichmentProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| endpointNames | Die Liste der Endpunkte, für die die Anreicherung auf die Nachricht angewendet wird. | string[] (erforderlich) Einschränkungen: Min. Länge = 1 |
| Schlüssel | Der Schlüssel oder Name für die Anreicherungseigenschaft. | Zeichenfolge (erforderlich) |
| value | Der Wert für die Anreicherungseigenschaft. | Zeichenfolge (erforderlich) |
FallbackRouteProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| condition | Die Bedingung, die ausgewertet wird, um die Fallbackroute anzuwenden. Wenn die Bedingung nicht bereitgestellt wird, wird sie standardmäßig auf true ausgewertet. Grammatik finden Sie unter /azure/iot-hub/iot-hub-devguide-query-language. | Zeichenfolge |
| endpointNames | Die Liste der Endpunkte, an die die Nachrichten weitergeleitet werden, die die Bedingung erfüllen. Derzeit ist nur 1 Endpunkt zulässig. | string[] (erforderlich) Einschränkungen: Min. Länge = 1 Maximale Länge = 1 |
| isEnabled | Wird verwendet, um anzugeben, ob die Fallbackroute aktiviert ist. | bool (erforderlich) |
| name | Der Name der Route. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten, hat eine maximale Länge von 64 Zeichen und muss eindeutig sein. | Zeichenfolge |
| source | Die Quelle, auf die die Routingregel angewendet werden soll. Beispiel: DeviceMessages | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "DigitalTwinChangeEvents" "Ungültig" 'MqttBrokerMessages' "TwinChangeEvents" (erforderlich) |
RouteProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| condition | Die Bedingung, die ausgewertet wird, um die Routingregel anzuwenden. Wenn keine Bedingung angegeben wird, wird sie standardmäßig auf true ausgewertet. Grammatik finden Sie unter /azure/iot-hub/iot-hub-devguide-query-language | Zeichenfolge |
| endpointNames | Die Liste der Endpunkte, an die Nachrichten weitergeleitet werden, die die Bedingung erfüllen. Derzeit ist nur ein Endpunkt zulässig. | string[] (erforderlich) Einschränkungen: Min. Länge = 1 Maximale Länge = 1 |
| isEnabled | Wird verwendet, um anzugeben, ob eine Route aktiviert ist. | bool (erforderlich) |
| name | Der Name der Route. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten, hat eine maximale Länge von 64 Zeichen und muss eindeutig sein. | Zeichenfolge (erforderlich) Einschränkungen: Muster = ^[A-Za-z0-9-._]{1,64}$ |
| source | Die Quelle, auf die die Routingregel angewendet werden soll, z. B. DeviceMessages. | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "DigitalTwinChangeEvents" "Ungültig" 'MqttBrokerMessages' "TwinChangeEvents" (erforderlich) |
IotHubPropertiesStorageEndpoints
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | StorageEndpointProperties |
StorageEndpointProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| authenticationType | Gibt den Authentifizierungstyp an, der zum Herstellen einer 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 aber mit dem angegebenen connectionString bestellbar sein. | Zeichenfolge (erforderlich) |
| Identität | Eigenschaften der verwalteten Identität des Speicherendpunkts für den Dateiupload. | ManagedIdentity |
| sasTtlAsIso8601 | Der Zeitraum, für den der von IoT Hub für den Dateiupload generierte SAS-URI gültig ist. Weitere Informationen finden Sie unter /azure/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | Zeichenfolge |
IotHubSkuInfo
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Kapazität | Die Anzahl der bereitgestellten IoT Hub Einheiten. Weitere Informationen finden Sie unter /azure/azure-subscription-service-limits#iot-hub-limits. | INT |
| name | Der Name der SKU. | "B1" "B2" "B3" "F1" 'S1' "S2" "S3" (erforderlich) |
Schnellstartvorlagen
Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.
| Vorlage | BESCHREIBUNG |
|---|---|
| Erstellen eines IOT Hub- und Ubuntu-Edgesimulators |
Mit dieser Vorlage wird ein IOT Hub und ein Ubuntu-Edgesimulator für virtuelle Computer erstellt. |
| Verwenden der ARM-Vorlage zum Erstellen von IoT Hub, Weiterleiten und Anzeigen von Nachrichten |
Verwenden Sie diese Vorlage, um ein 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. |
| Erstellen eines IoT Hub Device Provisioning Service |
Mit dieser Vorlage können Sie einen IoT Hub und einen IoT Hub Device Provisioning Service erstellen und die beiden Dienste miteinander verknüpfen. |
| Erstellen einer IoT Hub und einer Geräte-zu-Cloud-Consumergruppe |
Mit dieser Vorlage können Sie eine IoT Hub instance mit Geräte-zu-Cloud- und Cloud-zu-Gerät-Zu-Gerät-Messagingkonfigurationen und einer Geräte-zu-Cloud-Consumergruppe bereitstellen. |
| Erstellen eines Geräteupdates für IoT Hub Konto, instance, IoT Hub |
Diese Vorlage erstellt ein Konto sowie ein instance und einen Hub zum Verknüpfen des instance. Er konfiguriert den Hub mit den erforderlichen Zugriffsrichtlinien, Routen und Consumergruppen. |
| Bereitstellen des MedTech-Diensts einschließlich einer Azure IoT Hub |
Der MedTech-Dienst ist einer der Azure Health Data Services, der zum Erfassen von Gerätedaten von mehreren Geräten entwickelt wurde und die Gerätedaten in FHIR-Beobachtungen transformiert werden, die dann im Azure Health Data Services FHIR-Dienst beibehalten werden. |
| Erstellen einer Pay-As-You-Go-Umgebung (PAYG) mit einem IoT Hub |
Mit dieser Vorlage können Sie eine Time Series Insights-Umgebung bereitstellen, die für die Nutzung von Ereignissen aus einem IoT Hub konfiguriert ist. |
Terraform (AzAPI-Anbieter) Ressourcendefinition
Der IotHubs-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- 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 Der Vorlage die folgende Terraform-Ressource hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Devices/IotHubs@2023-06-30-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
allowedFqdnList = [
"string"
]
authorizationPolicies = [
{
keyName = "string"
primaryKey = "string"
rights = "string"
secondaryKey = "string"
keyName = "string"
primaryKey = "string"
rights = "string"
secondaryKey = "string"
}
]
cloudToDevice = {
defaultTtlAsIso8601 = "string"
feedback = {
lockDurationAsIso8601 = "string"
maxDeliveryCount = int
ttlAsIso8601 = "string"
}
maxDeliveryCount = int
}
comments = "string"
deviceStreams = {
streamingEndpoints = [
"string"
]
}
disableDeviceSAS = bool
disableLocalAuth = bool
disableModuleSAS = bool
enableDataResidency = bool
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"
}
]
ipVersion = "string"
messagingEndpoints = {
{customized property} = {
lockDurationAsIso8601 = "string"
maxDeliveryCount = int
ttlAsIso8601 = "string"
}
}
minTlsVersion = "string"
networkRuleSets = {
applyToBuiltInEventHubEndpoint = bool
defaultAction = "string"
ipRules = [
{
action = "Allow"
filterName = "string"
ipMask = "string"
}
]
}
privateEndpointConnections = [
{
properties = {
privateEndpoint = {}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
}
]
publicNetworkAccess = "string"
restrictOutboundNetworkAccess = bool
rootCertificate = {
enableRootCertificateV2 = bool
}
routing = {
endpoints = {
cosmosDBSqlContainers = [
{
authenticationType = "string"
containerName = "string"
databaseName = "string"
endpointUri = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
partitionKeyName = "string"
partitionKeyTemplate = "string"
primaryKey = "string"
resourceGroup = "string"
secondaryKey = "string"
subscriptionId = "string"
}
]
eventHubs = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
serviceBusQueues = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
serviceBusTopics = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
storageContainers = [
{
authenticationType = "string"
batchFrequencyInSeconds = int
connectionString = "string"
containerName = "string"
encoding = "string"
endpointUri = "string"
fileNameFormat = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
maxChunkSizeInBytes = int
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
}
enrichments = [
{
endpointNames = [
"string"
]
key = "string"
value = "string"
}
]
fallbackRoute = {
condition = "string"
endpointNames = [
"string"
]
isEnabled = bool
name = "string"
source = "string"
}
routes = [
{
condition = "string"
endpointNames = [
"string"
]
isEnabled = bool
name = "string"
source = "string"
}
]
}
storageEndpoints = {
{customized property} = {
authenticationType = "string"
connectionString = "string"
containerName = "string"
identity = {
userAssignedIdentity = "string"
}
sasTtlAsIso8601 = "string"
}
}
}
sku = {
capacity = int
name = "string"
}
etag = "string"
})
}
Eigenschaftswerte
IotHubs
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Ressourcentyp | "Microsoft.Devices/IotHubs@2023-06-30-preview" |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) Zeichenlimit: 3-50 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. Darf nicht mit einem Bindestrich enden. Der Ressourcenname muss in Azure eindeutig sein. |
| location | Der Ressourcenspeicherort. | Zeichenfolge (erforderlich) |
| parent_id | Verwenden Sie zum Bereitstellen in einer Ressourcengruppe die ID dieser Ressourcengruppe. | Zeichenfolge (erforderlich) |
| tags | Die Ressourcentags. | Wörterbuch der Tagnamen und -werte. |
| sku | Informationen zur IotHub-SKU | IotHubSkuInfo (erforderlich) |
| etag | Das Feld Etag ist nicht erforderlich. Wenn es im Antworttext angegeben wird, muss es auch als Header gemäß der normalen ETag-Konvention bereitgestellt werden. | Zeichenfolge |
| Identität | Die verwalteten Identitäten für IotHub. | ArmIdentity |
| properties | IotHub-Eigenschaften | IotHubProperties |
ArmIdentity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | 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 Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. | "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" |
| identity_ids | Wörterbuch von {ArmUserIdentity} | Array von Benutzeridentitäts-IDs. |
ArmIdentityUserAssignedIdentities
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | ArmUserIdentity |
ArmUserIdentity
Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.
IotHubProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| allowedFqdnList | Liste der zulässigen FQDNs (vollqualifizierter Domänenname) für ausgehenden Datenverkehr aus Iot Hub. | string[] |
| 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 Cloud-zu-Gerät-Messagingeigenschaften von IoT Hub. | CloudToDeviceProperties |
| comments | IoT Hub-Kommentare. | Zeichenfolge |
| deviceStreams | Das Gerät streamt die Eigenschaften von iothub. | IotHubPropertiesDeviceStreams |
| disableDeviceSAS | Wenn true, können alle sas-Bereichsschlüssel für alle Geräte (einschließlich Edgegeräte, aber mit Ausnahme von Modulen) nicht für die Authentifizierung verwendet werden. | bool |
| disableLocalAuth | Wenn true, können SAS-Token mit iot hub-bereichsbezogenen SAS-Schlüsseln nicht für die Authentifizierung verwendet werden. | bool |
| disableModuleSAS | Wenn true, können alle modulbezogenen SAS-Schlüssel nicht für die Authentifizierung verwendet werden. | bool |
| enableDataResidency | Wenn diese Eigenschaft auf TRUE festgelegt ist, aktiviert sie die Datenresidenz, wodurch die Notfallwiederherstellung deaktiviert wird. | bool |
| enableFileUploadNotifications | Bei True sind Dateiuploadbenachrichtigungen aktiviert. | bool |
| Verschlüsselung | Die Verschlüsselungseigenschaften für den IoT Hub. | EncryptionPropertiesDescription |
| eventHubEndpoints | Die Event Hub-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 Erstellungs- oder Aktualisierungsaufrufe für den IoT Hub ausgeführt werden. | IotHubPropertiesEventHubEndpoints |
| Features | Die funktionen und features, die für ioT hub aktiviert sind. | "DeviceManagement" "None" |
| ipFilterRules | Die IP-Filterregeln. | IpFilterRule[] |
| ipVersion | Diese Eigenschaft gibt die IP-Version an, die der Hub derzeit verwendet. | "ipv4" "ipv4ipv6" "ipv6" |
| messagingEndpoints | Die Messagingendpunkteigenschaften für die Dateiuploadbenachrichtigungswarteschlange. | IotHubPropertiesMessagingEndpoints |
| minTlsVersion | Gibt die TLS-Mindestversion 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. | Zeichenfolge |
| networkRuleSets | Netzwerkregelsatzeigenschaften von IotHub | NetworkRuleSetProperties |
| privateEndpointConnections. | Private Endpunktverbindungen, die auf diesem IotHub erstellt wurden | PrivateEndpointConnection[] |
| publicNetworkAccess | Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind | "Deaktiviert" "Aktiviert" |
| restrictOutboundNetworkAccess | Wenn true, ist der Ausgehende von IotHub nur auf die zulässigen FQDNs beschränkt, die über allowedFqdnList konfiguriert werden. | bool |
| rootCertificate | Diese Eigenschaft speichert Informationen zu Stammzertifikaten. | RootCertificateProperties |
| Weiterleiten | Die Routingeigenschaften des IoT Hubs. Siehe: /azure/iot-hub/iot-hub-devguide-messaging | RoutingEigenschaften |
| storageEndpoints | Die Liste der Azure Storage-Endpunkte, an denen Sie Dateien hochladen können. Derzeit können Sie nur ein Azure Storage-Konto konfigurieren, dessen Schlüssel als $default muss. Wenn Sie mehrere Speicherkonten angeben, wird ein Fehler ausgelöst. Wenn sie keinen Wert für diese Eigenschaft angeben, wenn die enableFileUploadNotifications-Eigenschaft auf True festgelegt ist, wird ein Fehler ausgelöst. | IotHubPropertiesStorageEndpoints |
SharedAccessSignatureAuthorizationRule
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| keyName | Der Name der SAS-Richtlinie. | Zeichenfolge (erforderlich) |
| primaryKey | Der primäre Schlüssel. | Zeichenfolge |
| Rechte | Die Berechtigungen, die der Shared Access-Richtlinie 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. | Zeichenfolge |
| keyName | Der Name der SAS-Richtlinie. | Zeichenfolge (erforderlich) |
| primaryKey | Der primäre Schlüssel. | Zeichenfolge |
| Rechte | Die berechtigungen, die der SAS-Richtlinie 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. | Zeichenfolge |
CloudToDeviceProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| defaultTtlAsIso8601 | Die Standardlaufzeit für Cloud-zu-Gerät-Nachrichten in der Gerätewarteschlange. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Zeichenfolge |
| feedback | Die Eigenschaften der Feedbackwarteschlange für Cloud-zu-Gerät-Nachrichten. | FeedbackEigenschaften |
| maxDeliveryCount | Die maximale Übermittlungsanzahl für Cloud-zu-Gerät-Nachrichten in der Gerätewarteschlange. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | INT Einschränkungen: Minimaler Wert = 1 Maximaler Wert = 100 |
FeedbackEigenschaften
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| lockDurationAsIso8601 | Die Sperrdauer für die Feedbackwarteschlange. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Zeichenfolge |
| maxDeliveryCount | Gibt an, wie oft der IoT Hub versucht, eine Nachricht in der Feedbackwarteschlange zu übermitteln. Siehe: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | INT Einschränkungen: Minimaler Wert = 1 Maximaler 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. | Zeichenfolge |
IotHubPropertiesDeviceStreams
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| streamingEndpoints | Liste der Gerätestream-Endpunkte. | string[] |
EncryptionPropertiesDescription
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| keySource | Die Quelle des Schlüssels. | Zeichenfolge |
| keyVaultProperties | Die Eigenschaften des Schlüssels KeyVault. | KeyVaultKeyProperties[] |
KeyVaultKeyProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Identität | Verwaltete Identitätseigenschaften von KeyVault Key. | ManagedIdentity |
| keyIdentifier | Der Bezeichner des Schlüssels. | Zeichenfolge |
ManagedIdentity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| userAssignedIdentity | Die vom Benutzer zugewiesene Identität. | Zeichenfolge |
IotHubPropertiesEventHubEndpoints
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | EventHubProperties |
EventHubProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| partitionCount | Die Anzahl der Partitionen zum Empfangen von Device-to-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 |
IpFilterRule
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| action | 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) |
IotHubPropertiesMessagingEndpoints
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | MessagingEndpointProperties |
MessagingEndpointProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| lockDurationAsIso8601 | Die Sperrdauer. Siehe: /azure/iot-hub/iot-hub-devguide-file-upload. | Zeichenfolge |
| maxDeliveryCount | Gibt an, wie oft der IoT Hub versucht, eine Nachricht zu übermitteln. Siehe: /azure/iot-hub/iot-hub-devguide-file-upload. | INT Einschränkungen: Minimaler Wert = 1 Maximaler 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. | Zeichenfolge |
NetworkRuleSetProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| applyToBuiltInEventHubEndpoint | Bei True wird der Netzwerkregelsatz auch auf BuiltIn EventHub EndPoint von IotHub angewendet. | bool (erforderlich) |
| Defaultaction | Standardaktion für Den Netzwerkregelsatz | "Zulassen" "Verweigern" |
| ipRules | Liste der IP-Regeln | NetworkRuleSetIpRule[] (erforderlich) |
NetworkRuleSetIpRule
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| action | 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) |
PrivateEndpointConnection
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| properties | Die Eigenschaften einer Verbindung mit einem privaten Endpunkt | PrivateEndpointConnectionProperties (erforderlich) |
PrivateEndpointConnectionProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| privateEndpoint | Die Eigenschaft des privaten Endpunkts einer Verbindung mit einem privaten Endpunkt | PrivateEndpoint |
| privateLinkServiceConnectionState | Der aktuelle Status einer Verbindung mit einem privaten Endpunkt | PrivateLinkServiceConnectionState (erforderlich) |
PrivateEndpoint
Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.
PrivateLinkServiceConnectionState
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| actionsRequired | Für eine Verbindung mit einem privaten Endpunkt erforderliche Aktionen | Zeichenfolge |
| description | Die Beschreibung für den aktuellen Status einer Verbindung mit einem privaten Endpunkt | Zeichenfolge (erforderlich) |
| status | Die status einer Verbindung mit einem privaten Endpunkt | "Genehmigt" "Getrennt" "Ausstehend" "Abgelehnt" (erforderlich) |
RootCertificateProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| enableRootCertificateV2 | Wenn diese Eigenschaft auf TRUE festgelegt ist, verwendet der Hub das G2-Zertifikat. Während die Einstellung auf false festgelegt ist, verwendet der Hub Baltimore Cert. | bool |
RoutingEigenschaften
| 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 ein 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 anwendet, die an integrierte und benutzerdefinierte Endpunkte übermittelt werden sollen. 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 verwendet, um Nachrichten an integrierte und benutzerdefinierte Endpunkte weiterzuleiten. Für kostenpflichtige Hubs sind maximal 100 Routingregeln und für kostenlose Hubs maximal 5 Routingregeln zulässig. | RouteProperties[] |
RoutingEndpoints
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| cosmosDBSqlContainers | Die Liste der Cosmos DB-Containerendpunkte, an die IoT Hub Nachrichten basierend auf den Routingregeln weiterleitet. | RoutingCosmosDBSqlApiProperties[] |
| 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 Service Bus-Warteschlangenendpunkte, an die IoT Hub die Nachrichten basierend auf den Routingregeln weiterleitet. | RoutingServiceBusQueueEndpointProperties[] |
| serviceBusTopics | Die Liste der Service Bus-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[] |
RoutingCosmosDBSqlApiProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| authenticationType | Methode zur Authentifizierung beim sql-Containerendpunkt von Cosmos DB | "identityBased" "keyBased" |
| containerName | Der Name des cosmos DB-SQL-Containers in der cosmos DB-Datenbank. | Zeichenfolge (erforderlich) |
| databaseName | Der Name der cosmos DB-Datenbank im cosmos DB-Konto. | Zeichenfolge (erforderlich) |
| endpointUri | Die URL des cosmos DB-Kontos. Es muss das Protokoll enthalten. https:// |
Zeichenfolge (erforderlich) |
| id | ID des sql-Containerendpunkts von Cosmos DB | Zeichenfolge |
| Identität | Eigenschaften der verwalteten Identität des Routings des Cosmos DB-Containerendpunkts. | ManagedIdentity |
| name | Der Name, der diesen Endpunkt identifiziert. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten und hat eine maximale Länge von 64 Zeichen. Die folgenden Namen sind reserviert: events, fileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. | Zeichenfolge (erforderlich) Einschränkungen: Muster = ^[A-Za-z0-9-._]{1,64}$ |
| partitionKeyName | Der Name des Partitionsschlüssels, der diesem Cosmos DB-SQL-Container zugeordnet ist, sofern vorhanden. Dies ist ein optionaler Parameter. | Zeichenfolge |
| partitionKeyTemplate | Die Vorlage zum Generieren eines synthetischen Partitionsschlüsselwerts für die Verwendung mit diesem cosmos DB-SQL-Container. Die Vorlage muss mindestens einen der folgenden Platzhalter enthalten: {iothub}, {deviceid}, {DD}, {MM} und {YYYY}. Jeder Platzhalter kann höchstens einmal angegeben werden, aber Die Komponenten der Reihenfolge und nicht des Platzhalters sind beliebig. Dieser Parameter ist nur erforderlich, wenn PartitionKeyName angegeben ist. | Zeichenfolge |
| primaryKey | Der Primärschlüssel des cosmos DB-Kontos. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
| resourceGroup | Der Name der Ressourcengruppe des cosmos DB-Kontos. | Zeichenfolge |
| secondaryKey | Der sekundäre Schlüssel des cosmos DB-Kontos. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
| subscriptionId | Der Abonnementbezeichner des cosmos DB-Kontos. | Zeichenfolge |
RoutingEventHubProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| authenticationType | Methode zur Authentifizierung beim Event Hub-Endpunkt | "identityBased" "keyBased" |
| connectionString | Die Verbindungszeichenfolge des Event Hub-Endpunkts. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
| endpointUri | Die URL des Event Hub-Endpunkts. Es muss das Protokoll enthalten sb:// | Zeichenfolge |
| entityPath | Event Hub-Name im Event Hub-Namespace | Zeichenfolge |
| id | ID des Event Hub-Endpunkts | Zeichenfolge |
| Identität | Eigenschaften der verwalteten Identität des Routing-Event Hub-Endpunkts. | ManagedIdentity |
| name | Der Name, der diesen Endpunkt identifiziert. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten und hat eine maximale Länge von 64 Zeichen. Die folgenden Namen sind reserviert: events, fileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. | Zeichenfolge (erforderlich) Einschränkungen: Muster = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Der Name der Ressourcengruppe des Event Hub-Endpunkts. | Zeichenfolge |
| subscriptionId | Der Abonnementbezeichner des Event Hub-Endpunkts. | Zeichenfolge |
RoutingServiceBusQueueEndpointProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| authenticationType | Methode zur Authentifizierung beim Service Bus-Warteschlangenendpunkt | "identityBased" "keyBased" |
| connectionString | Die Verbindungszeichenfolge des Service Bus-Warteschlangenendpunkts. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
| endpointUri | Die URL des Service Bus-Warteschlangenendpunkts. Es muss das Protokoll enthalten sb:// | Zeichenfolge |
| entityPath | Warteschlangenname im Service Bus-Namespace | Zeichenfolge |
| id | ID des Service Bus-Warteschlangenendpunkts | Zeichenfolge |
| Identität | Eigenschaften der verwalteten Identität des Routingdienstbus-Warteschlangenendpunkts. | ManagedIdentity |
| name | Der Name, der diesen Endpunkt identifiziert. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten und hat eine maximale Länge von 64 Zeichen. 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 identisch sein. | Zeichenfolge (erforderlich) Einschränkungen: Muster = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Der Name der Ressourcengruppe des Service Bus-Warteschlangenendpunkts. | Zeichenfolge |
| subscriptionId | Der Abonnementbezeichner des Service Bus-Warteschlangenendpunkts. | Zeichenfolge |
RoutingServiceBusTopicEndpointProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| authenticationType | Methode zur Authentifizierung beim Service Bus-Themenendpunkt | "identityBased" "keyBased" |
| connectionString | Die Verbindungszeichenfolge des Service Bus-Themenendpunkts. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
| endpointUri | Die URL des Service Bus-Themenendpunkts. Es muss das Protokoll enthalten, das sb:// | Zeichenfolge |
| entityPath | Warteschlangenname im Service Bus-Thema | Zeichenfolge |
| id | ID des Service Bus-Themenendpunkts | Zeichenfolge |
| Identität | Eigenschaften der verwalteten Identität des Routing-Service Bus-Themenendpunkts. | ManagedIdentity |
| name | Der Name, der diesen Endpunkt identifiziert. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten und hat eine maximale Länge von 64 Zeichen. 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 Themennamen identisch sein. | Zeichenfolge (erforderlich) Einschränkungen: Muster = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Der Name der Ressourcengruppe des Service Bus-Themenendpunkts. | Zeichenfolge |
| subscriptionId | Der Abonnementbezeichner des Service Bus-Themenendpunkts. | Zeichenfolge |
RoutingStorageContainerProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| authenticationType | Methode zur Authentifizierung beim Speicherendpunkt | "identityBased" "keyBased" |
| batchFrequencyInSeconds | Zeitintervall, in dem Blobs in den Speicher geschrieben werden. Der Wert sollte zwischen 60 und 720 Sekunden betragen. Der Standardwert ist 300 Sekunden. | INT Einschränkungen: Min-Wert = 60 Maximaler Wert = 720 |
| connectionString | Der Verbindungszeichenfolge des Speicherkontos. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
| containerName | Der Name des Speichercontainers im Speicherkonto. | Zeichenfolge (erforderlich) |
| encoding | 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 enthalten. https:// |
Zeichenfolge |
| fileNameFormat | Dateinamenformat für das Blob. Das Standardformat ist {iothub}/{partition}/{JJJJ}/{MM}/{DD}/{HH}/{mm}. Alle Parameter sind obligatorisch, können aber neu sortiert werden. | Zeichenfolge |
| id | ID des Speichercontainerendpunkts | Zeichenfolge |
| Identität | Eigenschaften der verwalteten Identität 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) liegen. Der Standardwert ist 314572800(300 MB). | INT Einschränkungen: Min-Wert = 10485760 Maximaler Wert = 524288000 |
| name | Der Name, der diesen Endpunkt identifiziert. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten und hat eine maximale Länge von 64 Zeichen. Die folgenden Namen sind reserviert: ereignisse, fileNotifications, $default. Endpunktnamen müssen für alle Endpunkttypen eindeutig sein. | Zeichenfolge (erforderlich) Einschränkungen: Muster = ^[A-Za-z0-9-._]{1,64}$ |
| resourceGroup | Der Name der Ressourcengruppe des Speicherkontos. | Zeichenfolge |
| subscriptionId | Der Abonnementbezeichner des Speicherkontos. | Zeichenfolge |
EnrichmentProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| endpointNames | Die Liste der Endpunkte, für die die Anreicherung auf die Nachricht angewendet wird. | string[] (erforderlich) Einschränkungen: Min. Länge = 1 |
| Schlüssel | Der Schlüssel oder Name für die Anreicherungseigenschaft. | Zeichenfolge (erforderlich) |
| value | Der Wert für die Anreicherungseigenschaft. | Zeichenfolge (erforderlich) |
FallbackRouteProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| condition | Die Bedingung, die ausgewertet wird, um die Fallbackroute anzuwenden. Wenn die Bedingung nicht bereitgestellt wird, wird sie standardmäßig auf true ausgewertet. Grammatik finden Sie unter /azure/iot-hub/iot-hub-devguide-query-language. | Zeichenfolge |
| endpointNames | Die Liste der Endpunkte, an die die Nachrichten weitergeleitet werden, die die Bedingung erfüllen. Derzeit ist nur 1 Endpunkt zulässig. | string[] (erforderlich) Einschränkungen: Min. Länge = 1 Maximale Länge = 1 |
| isEnabled | Wird verwendet, um anzugeben, ob die Fallbackroute aktiviert ist. | bool (erforderlich) |
| name | Der Name der Route. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten, hat eine maximale Länge von 64 Zeichen und muss eindeutig sein. | Zeichenfolge |
| source | Die Quelle, auf die die Routingregel angewendet werden soll. Beispiel: DeviceMessages | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "DigitalTwinChangeEvents" "Ungültig" "MqttBrokerMessages" "TwinChangeEvents" (erforderlich) |
RouteProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| condition | Die Bedingung, die ausgewertet wird, um die Routingregel anzuwenden. Wenn keine Bedingung angegeben wird, wird sie standardmäßig auf true ausgewertet. Grammatik finden Sie unter /azure/iot-hub/iot-hub-devguide-query-language | Zeichenfolge |
| endpointNames | Die Liste der Endpunkte, an die Nachrichten weitergeleitet werden, die die Bedingung erfüllen. Derzeit ist nur ein Endpunkt zulässig. | string[] (erforderlich) Einschränkungen: Min. Länge = 1 Maximale Länge = 1 |
| isEnabled | Wird verwendet, um anzugeben, ob eine Route aktiviert ist. | bool (erforderlich) |
| name | Der Name der Route. Der Name darf nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche enthalten, hat eine maximale Länge von 64 Zeichen und muss eindeutig sein. | Zeichenfolge (erforderlich) Einschränkungen: Muster = ^[A-Za-z0-9-._]{1,64}$ |
| source | Die Quelle, auf die die Routingregel angewendet werden soll, z. B. DeviceMessages. | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "DigitalTwinChangeEvents" "Ungültig" "MqttBrokerMessages" "TwinChangeEvents" (erforderlich) |
IotHubPropertiesStorageEndpoints
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | StorageEndpointProperties |
StorageEndpointProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| authenticationType | Gibt den Authentifizierungstyp an, der zum Herstellen einer 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 aber mithilfe der angegebenen connectionString-Instanz erstellbar sein. | Zeichenfolge (erforderlich) |
| Identität | Eigenschaften der verwalteten Identität des Speicherendpunkts für den Dateiupload. | ManagedIdentity |
| sasTtlAsIso8601 | Der Zeitraum, für den der von IoT Hub für den Dateiupload generierte SAS-URI gültig ist. Siehe: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | Zeichenfolge |
IotHubSkuInfo
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Kapazität | Die Anzahl der bereitgestellten IoT Hub Einheiten. Weitere Informationen finden Sie unter /azure/azure-subscription-service-limits#iot-hub-limits. | INT |
| name | Der Name der SKU. | "B1" "B2" "B3" "F1" "S1" "S2" "S3" (erforderlich) |