Freigeben über


Iot Hub Resource - List By Resource Group

Rufen Sie alle IoT Hubs in einer Ressourcengruppe ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs?api-version=2023-06-30

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
path True

string

Der Name der Ressourcengruppe, die den IoT Hub enthält.

subscriptionId
path True

string

Die Abonnement-ID.

api-version
query True

string

Die Version der API.

Antworten

Name Typ Beschreibung
200 OK

IotHubDescriptionListResult

Dies ist ein synchroner Vorgang. Der Text enthält ein JSON-serialisiertes Array der Metadaten aller IoT Hubs in der Ressourcengruppe.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

IotHubResource_ListByResourceGroup

Beispielanforderung

GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs?api-version=2023-06-30

Beispiel für eine Antwort

{
  "value": [
    {
      "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
      "name": "testHub",
      "type": "Microsoft.Devices/IotHubs",
      "location": "centraluseuap",
      "tags": {},
      "etag": "AAAAAAFD6M4=",
      "properties": {
        "state": "Active",
        "provisioningState": "Succeeded",
        "ipFilterRules": [
          {
            "filterName": "rule1",
            "action": "Accept",
            "ipMask": "131.117.159.53"
          },
          {
            "filterName": "rule2",
            "action": "Accept",
            "ipMask": "157.55.59.128/25"
          }
        ],
        "networkRuleSets": {
          "defaultAction": "Deny",
          "applyToBuiltInEventHubEndpoint": true,
          "ipRules": [
            {
              "filterName": "rule1",
              "action": "Allow",
              "ipMask": "131.117.159.53"
            },
            {
              "filterName": "rule2",
              "action": "Allow",
              "ipMask": "157.55.59.128/25"
            }
          ]
        },
        "hostName": "iot-dps-cit-hub-1.azure-devices.net",
        "eventHubEndpoints": {
          "events": {
            "retentionTimeInDays": 1,
            "partitionCount": 2,
            "partitionIds": [
              "0",
              "1"
            ],
            "path": "iot-dps-cit-hub-1",
            "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
          }
        },
        "routing": {
          "endpoints": {
            "serviceBusQueues": [],
            "serviceBusTopics": [],
            "eventHubs": [],
            "storageContainers": []
          },
          "routes": [],
          "fallbackRoute": {
            "name": "$fallback",
            "source": "DeviceMessages",
            "condition": "true",
            "endpointNames": [
              "events"
            ],
            "isEnabled": true
          }
        },
        "storageEndpoints": {
          "$default": {
            "sasTtlAsIso8601": "PT1H",
            "connectionString": "",
            "containerName": ""
          }
        },
        "messagingEndpoints": {
          "fileNotifications": {
            "lockDurationAsIso8601": "PT1M",
            "ttlAsIso8601": "PT1H",
            "maxDeliveryCount": 10
          }
        },
        "enableFileUploadNotifications": false,
        "cloudToDevice": {
          "maxDeliveryCount": 10,
          "defaultTtlAsIso8601": "PT1H",
          "feedback": {
            "lockDurationAsIso8601": "PT1M",
            "ttlAsIso8601": "PT1H",
            "maxDeliveryCount": 10
          }
        },
        "features": "None"
      },
      "sku": {
        "name": "S1",
        "tier": "Standard",
        "capacity": 1
      },
      "systemData": {
        "createdAt": "2021-01-30T00:28:38.963Z"
      }
    }
  ]
}

Definitionen

Name Beschreibung
AccessRights

Die Berechtigungen, die der Shared Access-Richtlinie zugewiesen sind.

ArmIdentity
ArmUserIdentity
AuthenticationType

Gibt den Authentifizierungstyp an, der zum Herstellen einer Verbindung mit dem Speicherkonto verwendet wird.

authenticationType

Methode zur Authentifizierung beim Service Bus-Warteschlangenendpunkt

Capabilities

Die funktionen und features, die für ioT hub aktiviert sind.

CloudToDeviceProperties

Die Cloud-zu-Gerät-Messagingeigenschaften von IoT Hub.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

DefaultAction

Standardaktion für Den Netzwerkregelsatz

EnrichmentProperties

Die Eigenschaften einer Anreicherung, die Ihr IoT Hub auf nachrichten an Endpunkte anwendet.

ErrorDetails

Fehlerdetails.

EventHubProperties

Die Eigenschaften des bereitgestellten Event Hub-kompatiblen Endpunkts, der vom IoT Hub verwendet wird.

FallbackRouteProperties

Die Eigenschaften der Fallbackroute. IoT Hub verwendet diese Eigenschaften, wenn Nachrichten an den Fallbackendpunkt weitergeleitet werden.

FeedbackProperties

Die Eigenschaften der Feedbackwarteschlange für Cloud-zu-Gerät-Nachrichten.

IotHubDescription

Die Beschreibung des IoT-Hubs.

IotHubDescriptionListResult

Das JSON-serialisierte Array von IotHubDescription-Objekten mit einem nächsten Link.

IotHubLocationDescription

Öffentliche Darstellung eines der Standorte, an denen eine Ressource bereitgestellt wird.

IotHubProperties

Die Eigenschaften eines IoT-Hubs.

IotHubReplicaRoleType

Die Rolle der Region kann entweder primär oder sekundär sein. In der primären Region wird derzeit der IoT Hub bereitgestellt. Die sekundäre Region ist die gekoppelte Azure-Notfallwiederherstellung (DR) und auch die Region, in die der IoT Hub ein Failover durchführen kann.

IotHubSku

Der Name der SKU.

IotHubSkuInfo

Informationen zur SKU des IoT Hubs.

IotHubSkuTier

Der Abrechnungstarif für den IoT Hub.

IpFilterActionType

Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden.

IpFilterRule

Die IP-Filterregeln für den IoT Hub.

ManagedIdentity

Die Eigenschaften der verwalteten Identität.

MessagingEndpointProperties

Die Eigenschaften der Messagingendpunkte, die von diesem IoT Hub verwendet werden.

NetworkRuleIPAction

IP-Filteraktion

NetworkRuleSetIpRule

IP-Regel, die als Teil des Netzwerkregelsatzes angewendet werden soll

NetworkRuleSetProperties

Eigenschaften des Netzwerkregelsatzes von IotHub

PrivateEndpoint

Die Eigenschaft des privaten Endpunkts einer privaten Endpunktverbindung

PrivateEndpointConnection

Die Private Endpunktverbindung einer IotHub-Instanz

PrivateEndpointConnectionProperties

Die Eigenschaften einer privaten Endpunktverbindung

PrivateLinkServiceConnectionState

Der aktuelle Zustand einer Verbindung mit einem privaten Endpunkt

PrivateLinkServiceConnectionStatus

Die status einer privaten Endpunktverbindung

PublicNetworkAccess

Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind

ResourceIdentityType

Der Identitätstyp, der für die Ressource verwendet wird. Der Typ „SystemAssigned, UserAssigned“ umfasst sowohl eine implizit erstellte Identität als auch einen Satz von Benutzern zugewiesener Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.

RouteProperties

Die Eigenschaften einer Routingregel, die Ihr IoT Hub verwendet, um Nachrichten an Endpunkte weiterzuleiten.

RoutingCosmosDBSqlApiProperties

Die Eigenschaften im Zusammenhang mit einem Cosmos DB-SQL-Containerendpunkt.

RoutingEndpoints

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.

RoutingEventHubProperties

Die Eigenschaften im Zusammenhang mit einem Event Hub-Endpunkt.

RoutingProperties

Die routingbezogenen Eigenschaften des IoT-Hubs. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

RoutingServiceBusQueueEndpointProperties

Die Eigenschaften im Zusammenhang mit Service Bus-Warteschlangenendpunkttypen.

RoutingServiceBusTopicEndpointProperties

Die Eigenschaften im Zusammenhang mit Service Bus-Themenendpunkttypen.

RoutingSource

Die Quelle, auf die die Routingregel angewendet werden soll, z. B. DeviceMessages.

RoutingStorageContainerProperties

Die Eigenschaften im Zusammenhang mit einem Speichercontainerendpunkt.

SharedAccessSignatureAuthorizationRule

Die Eigenschaften einer IoT Hub-Richtlinie für freigegebenen Zugriff.

StorageEndpointProperties

Die Eigenschaften des Azure Storage-Endpunkts für den Dateiupload.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

AccessRights

Die Berechtigungen, die der Shared Access-Richtlinie zugewiesen sind.

Name Typ Beschreibung
DeviceConnect

string

RegistryRead

string

RegistryRead, DeviceConnect

string

RegistryRead, RegistryWrite

string

RegistryRead, RegistryWrite, DeviceConnect

string

RegistryRead, RegistryWrite, ServiceConnect

string

RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect

string

RegistryRead, ServiceConnect

string

RegistryRead, ServiceConnect, DeviceConnect

string

RegistryWrite

string

RegistryWrite, DeviceConnect

string

RegistryWrite, ServiceConnect

string

RegistryWrite, ServiceConnect, DeviceConnect

string

ServiceConnect

string

ServiceConnect, DeviceConnect

string

ArmIdentity

Name Typ Beschreibung
principalId

string

Prinzipal-ID

tenantId

string

Mandanten-ID

type

ResourceIdentityType

Der Identitätstyp, der für die Ressource verwendet wird. Der Typ „SystemAssigned, UserAssigned“ umfasst sowohl eine implizit erstellte Identität als auch einen Satz von Benutzern zugewiesener Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.

userAssignedIdentities

<string,  ArmUserIdentity>

ArmUserIdentity

Name Typ Beschreibung
clientId

string

principalId

string

AuthenticationType

Gibt den Authentifizierungstyp an, der zum Herstellen einer Verbindung mit dem Speicherkonto verwendet wird.

Name Typ Beschreibung
identityBased

string

keyBased

string

authenticationType

Methode zur Authentifizierung beim Service Bus-Warteschlangenendpunkt

Name Typ Beschreibung
identityBased

string

keyBased

string

Capabilities

Die funktionen und features, die für ioT hub aktiviert sind.

Name Typ Beschreibung
DeviceManagement

string

None

string

CloudToDeviceProperties

Die Cloud-zu-Gerät-Messagingeigenschaften von IoT Hub.

Name Typ Beschreibung
defaultTtlAsIso8601

string

Die Standardzeit für Cloud-zu-Gerät-Nachrichten in der Gerätewarteschlange. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

feedback

FeedbackProperties

Die Eigenschaften der Feedbackwarteschlange für Cloud-zu-Gerät-Nachrichten.

maxDeliveryCount

integer

Die maximale Übermittlungsanzahl für Cloud-zu-Gerät-Nachrichten in der Gerätewarteschlange. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

DefaultAction

Standardaktion für Den Netzwerkregelsatz

Name Typ Beschreibung
Allow

string

Deny

string

EnrichmentProperties

Die Eigenschaften einer Anreicherung, die Ihr IoT Hub auf nachrichten an Endpunkte anwendet.

Name Typ Beschreibung
endpointNames

string[]

Die Liste der Endpunkte, für die die Anreicherung auf die Nachricht angewendet wird.

key

string

Der Schlüssel oder Name für die Anreicherungseigenschaft.

value

string

Der Wert für die Anreicherungseigenschaft.

ErrorDetails

Fehlerdetails.

Name Typ Beschreibung
code

string

Der Fehlercode.

details

string

Die Fehlerdetails.

httpStatusCode

string

Der HTTP-Statuscode.

message

string

Die Fehlermeldung.

EventHubProperties

Die Eigenschaften des bereitgestellten Event Hub-kompatiblen Endpunkts, der vom IoT Hub verwendet wird.

Name Typ Beschreibung
endpoint

string

Der Event Hub-kompatible Endpunkt.

partitionCount

integer

Die Anzahl der Partitionen zum Empfangen von Device-to-Cloud-Nachrichten im Event Hub-kompatiblen Endpunkt. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.

partitionIds

string[]

Die Partitions-IDs im Event Hub-kompatiblen Endpunkt.

path

string

Der Event Hub-kompatible Name.

retentionTimeInDays

integer

Die Aufbewahrungszeit für Geräte-zu-Cloud-Nachrichten in Tagen. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

FallbackRouteProperties

Die Eigenschaften der Fallbackroute. IoT Hub verwendet diese Eigenschaften, wenn Nachrichten an den Fallbackendpunkt weitergeleitet werden.

Name Typ Beschreibung
condition

string

Die Bedingung, die ausgewertet wird, um die Fallbackroute anzuwenden. Wenn die Bedingung nicht bereitgestellt wird, wird sie standardmäßig auf true ausgewertet. Informationen zur Grammatik finden Sie unter: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpointNames

string[]

Die Liste der Endpunkte, an die die Nachrichten weitergeleitet werden, die die Bedingung erfüllen. Derzeit ist nur 1 Endpunkt zulässig.

isEnabled

boolean

Wird verwendet, um anzugeben, ob die Fallbackroute aktiviert ist.

name

string

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.

source

RoutingSource

Die Quelle, auf die die Routingregel angewendet werden soll. Beispiel: DeviceMessages

FeedbackProperties

Die Eigenschaften der Feedbackwarteschlange für Cloud-zu-Gerät-Nachrichten.

Name Typ Beschreibung
lockDurationAsIso8601

string

Die Sperrdauer für die Feedbackwarteschlange. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

maxDeliveryCount

integer

Die Anzahl der Versuche des IoT Hubs, eine Nachricht in der Feedbackwarteschlange zu übermitteln. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

ttlAsIso8601

string

Der Zeitraum, für den eine Nachricht verwendet werden kann, bevor sie vom IoT Hub abgelaufen ist. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

IotHubDescription

Die Beschreibung des IoT-Hubs.

Name Typ Beschreibung
etag

string

Das Etag-Feld ist nicht erforderlich. Wenn es im Antworttext angegeben wird, muss er gemäß der normalen ETag-Konvention auch als Header bereitgestellt werden.

id

string

Der Ressourcenbezeichner.

identity

ArmIdentity

Die verwalteten Identitäten für IotHub.

location

string

Der Ressourcenspeicherort.

name

string

Der Name der Ressource.

properties

IotHubProperties

IotHub-Eigenschaften

sku

IotHubSkuInfo

Informationen zur IotHub-SKU

systemData

systemData

Die Systemmetadaten zu dieser Ressource.

tags

object

Die Ressourcentags.

type

string

Der Ressourcentyp.

IotHubDescriptionListResult

Das JSON-serialisierte Array von IotHubDescription-Objekten mit einem nächsten Link.

Name Typ Beschreibung
nextLink

string

Der nächste Link.

value

IotHubDescription[]

Das Array von IotHubDescription-Objekten.

IotHubLocationDescription

Öffentliche Darstellung eines der Standorte, an denen eine Ressource bereitgestellt wird.

Name Typ Beschreibung
location

string

Der Name der Azure-Region

role

IotHubReplicaRoleType

Die Rolle der Region kann entweder primär oder sekundär sein. In der primären Region wird derzeit der IoT Hub bereitgestellt. Die sekundäre Region ist die gekoppelte Azure-Notfallwiederherstellung (DR) und auch die Region, in die der IoT Hub ein Failover durchführen kann.

IotHubProperties

Die Eigenschaften eines IoT-Hubs.

Name Typ Beschreibung
allowedFqdnList

string[]

Liste der zulässigen FQDNs (vollqualifizierter Domänenname) für ausgehenden Datenverkehr von Iot Hub.

authorizationPolicies

SharedAccessSignatureAuthorizationRule[]

Die Shared Access-Richtlinien, die Sie verwenden können, um eine Verbindung mit dem IoT Hub zu sichern.

cloudToDevice

CloudToDeviceProperties

Die IoT Hub-Cloud-zu-Gerät-Messagingeigenschaften.

comments

string

IoT Hub-Kommentare.

disableDeviceSAS

boolean

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.

disableLocalAuth

boolean

Wenn true, können SAS-Token mit iot hub-bereichsbezogenen SAS-Schlüsseln nicht für die Authentifizierung verwendet werden.

disableModuleSAS

boolean

Wenn true, können nicht alle modulbezogenen SAS-Schlüssel für die Authentifizierung verwendet werden.

enableDataResidency

boolean

Wenn diese Eigenschaft auf TRUE festgelegt ist, wird die Datenresidenz aktiviert, wodurch die Notfallwiederherstellung deaktiviert wird.

enableFileUploadNotifications

boolean

True gibt an, dass Benachrichtigungen zum Hochladen von Dateien aktiviert sind.

eventHubEndpoints

<string,  EventHubProperties>

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.

features

Capabilities

Die Funktionen und Features, die für den IoT Hub aktiviert sind.

hostName

string

Der Name des Hosts.

ipFilterRules

IpFilterRule[]

Die IP-Filterregeln.

locations

IotHubLocationDescription[]

Primärer und sekundärer Standort für iot Hub

messagingEndpoints

<string,  MessagingEndpointProperties>

Die Messagingendpunkteigenschaften für die Dateiuploadbenachrichtigungswarteschlange.

minTlsVersion

string

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.

networkRuleSets

NetworkRuleSetProperties

Eigenschaften des Netzwerkregelsatzes von IotHub

privateEndpointConnections

PrivateEndpointConnection[]

Private Endpunktverbindungen, die auf diesem IotHub erstellt wurden

provisioningState

string

Der Bereitstellungsstatus.

publicNetworkAccess

PublicNetworkAccess

Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind

restrictOutboundNetworkAccess

boolean

Wenn true, wird der ausgehende Datenverkehr von IotHub nur auf die zulässigen FQDNs beschränkt, die über allowedFqdnList konfiguriert sind.

routing

RoutingProperties

Die routingbezogenen Eigenschaften des IoT-Hubs. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

state

string

Der Hubstatus.

storageEndpoints

<string,  StorageEndpointProperties>

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.

IotHubReplicaRoleType

Die Rolle der Region kann entweder primär oder sekundär sein. In der primären Region wird derzeit der IoT Hub bereitgestellt. Die sekundäre Region ist die gekoppelte Azure-Notfallwiederherstellung (DR) und auch die Region, in die der IoT Hub ein Failover durchführen kann.

Name Typ Beschreibung
primary

string

secondary

string

IotHubSku

Der Name der SKU.

Name Typ Beschreibung
B1

string

B2

string

B3

string

F1

string

S1

string

S2

string

S3

string

IotHubSkuInfo

Informationen zur SKU des IoT Hubs.

Name Typ Beschreibung
capacity

integer

Die Anzahl der bereitgestellten IoT Hub Einheiten. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.

name

IotHubSku

Der Name der SKU.

tier

IotHubSkuTier

Die Abrechnungsebene für den IoT Hub.

IotHubSkuTier

Der Abrechnungstarif für den IoT Hub.

Name Typ Beschreibung
Basic

string

Free

string

Standard

string

IpFilterActionType

Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden.

Name Typ Beschreibung
Accept

string

Reject

string

IpFilterRule

Die IP-Filterregeln für den IoT Hub.

Name Typ Beschreibung
action

IpFilterActionType

Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden.

filterName

string

Der Name der IP-Filterregel.

ipMask

string

Eine Zeichenfolge, die den IP-Adressbereich in der CIDR-Notation für die Regel enthält.

ManagedIdentity

Die Eigenschaften der verwalteten Identität.

Name Typ Beschreibung
userAssignedIdentity

string

Die vom Benutzer zugewiesene Identität.

MessagingEndpointProperties

Die Eigenschaften der Messagingendpunkte, die von diesem IoT Hub verwendet werden.

Name Typ Beschreibung
lockDurationAsIso8601

string

Die Sperrdauer. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

maxDeliveryCount

integer

Die Anzahl der Versuche des IoT Hubs, eine Nachricht zu übermitteln. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

ttlAsIso8601

string

Der Zeitraum, für den eine Nachricht verwendet werden kann, bevor sie vom IoT Hub abgelaufen ist. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

NetworkRuleIPAction

IP-Filteraktion

Name Typ Beschreibung
Allow

string

NetworkRuleSetIpRule

IP-Regel, die als Teil des Netzwerkregelsatzes angewendet werden soll

Name Typ Standardwert Beschreibung
action

NetworkRuleIPAction

Allow

IP-Filteraktion

filterName

string

Name der IP-Filterregel.

ipMask

string

Eine Zeichenfolge, die den IP-Adressbereich in der CIDR-Notation für die Regel enthält.

NetworkRuleSetProperties

Eigenschaften des Netzwerkregelsatzes von IotHub

Name Typ Standardwert Beschreibung
applyToBuiltInEventHubEndpoint

boolean

Bei True wird der Netzwerkregelsatz auch auf BuiltIn EventHub EndPoint von IotHub angewendet.

defaultAction

DefaultAction

Deny

Standardaktion für Den Netzwerkregelsatz

ipRules

NetworkRuleSetIpRule[]

Liste der IP-Regeln

PrivateEndpoint

Die Eigenschaft des privaten Endpunkts einer privaten Endpunktverbindung

Name Typ Beschreibung
id

string

Der Ressourcenbezeichner.

PrivateEndpointConnection

Die Private Endpunktverbindung einer IotHub-Instanz

Name Typ Beschreibung
id

string

Der Ressourcenbezeichner.

name

string

Der Name der Ressource.

properties

PrivateEndpointConnectionProperties

Die Eigenschaften einer Verbindung mit einem privaten Endpunkt

type

string

Der Ressourcentyp.

PrivateEndpointConnectionProperties

Die Eigenschaften einer privaten Endpunktverbindung

Name Typ Beschreibung
privateEndpoint

PrivateEndpoint

Die Eigenschaft des privaten Endpunkts einer privaten Endpunktverbindung

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Der aktuelle Zustand einer Verbindung mit einem privaten Endpunkt

PrivateLinkServiceConnectionState

Der aktuelle Zustand einer Verbindung mit einem privaten Endpunkt

Name Typ Beschreibung
actionsRequired

string

Für eine Verbindung mit einem privaten Endpunkt erforderliche Aktionen

description

string

Die Beschreibung für den aktuellen Zustand einer Verbindung mit einem privaten Endpunkt

status

PrivateLinkServiceConnectionStatus

Die status einer privaten Endpunktverbindung

PrivateLinkServiceConnectionStatus

Die status einer privaten Endpunktverbindung

Name Typ Beschreibung
Approved

string

Disconnected

string

Pending

string

Rejected

string

PublicNetworkAccess

Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind

Name Typ Beschreibung
Disabled

string

Enabled

string

ResourceIdentityType

Der Identitätstyp, der für die Ressource verwendet wird. Der Typ „SystemAssigned, UserAssigned“ umfasst sowohl eine implizit erstellte Identität als auch einen Satz von Benutzern zugewiesener Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.

Name Typ Beschreibung
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

RouteProperties

Die Eigenschaften einer Routingregel, die Ihr IoT Hub verwendet, um Nachrichten an Endpunkte weiterzuleiten.

Name Typ Beschreibung
condition

string

Die Bedingung, die ausgewertet wird, um die Routingregel anzuwenden. Wenn keine Bedingung angegeben wird, wird sie standardmäßig auf true ausgewertet. Informationen zur Grammatik finden Sie unter: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpointNames

string[]

Die Liste der Endpunkte, an die Nachrichten weitergeleitet werden, die die Bedingung erfüllen. Derzeit ist nur ein Endpunkt zulässig.

isEnabled

boolean

Wird verwendet, um anzugeben, ob eine Route aktiviert ist.

name

string

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.

source

RoutingSource

Die Quelle, auf die die Routingregel angewendet werden soll, z. B. DeviceMessages.

RoutingCosmosDBSqlApiProperties

Die Eigenschaften im Zusammenhang mit einem Cosmos DB-SQL-Containerendpunkt.

Name Typ Beschreibung
authenticationType

authenticationType

Methode zur Authentifizierung beim Sql-Containerendpunkt cosmos DB

containerName

string

Der Name des cosmos DB-SQL-Containers in der cosmos DB-Datenbank.

databaseName

string

Der Name der cosmos DB-Datenbank im cosmos DB-Konto.

endpointUri

string

Die URL des cosmos DB-Kontos. Es muss das Protokoll enthalten, das https://

id

string

ID des Sql-Containerendpunkts von Cosmos DB

identity

ManagedIdentity

Eigenschaften der verwalteten Identität des Routing-Cosmos DB-Containerendpunkts.

name

string

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.

partitionKeyName

string

Der Name des Partitionsschlüssels, der diesem Cosmos DB-SQL-Container zugeordnet ist, sofern vorhanden. Dies ist ein optionaler Parameter.

partitionKeyTemplate

string

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.

primaryKey

string

Der Primärschlüssel des cosmos DB-Kontos.

resourceGroup

string

Der Name der Ressourcengruppe des cosmos DB-Kontos.

secondaryKey

string

Der sekundäre Schlüssel des cosmos DB-Kontos.

subscriptionId

string

Der Abonnementbezeichner des cosmos DB-Kontos.

RoutingEndpoints

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.

Name Typ Beschreibung
cosmosDBSqlContainers

RoutingCosmosDBSqlApiProperties[]

Die Liste der Cosmos DB-Containerendpunkte, an die IoT Hub Nachrichten basierend auf den Routingregeln weiterleitet.

eventHubs

RoutingEventHubProperties[]

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.

serviceBusQueues

RoutingServiceBusQueueEndpointProperties[]

Die Liste der Service Bus-Warteschlangenendpunkte, an die IoT Hub die Nachrichten basierend auf den Routingregeln weiterleitet.

serviceBusTopics

RoutingServiceBusTopicEndpointProperties[]

Die Liste der Service Bus-Themenendpunkte, an die der IoT Hub die Nachrichten basierend auf den Routingregeln weiterleitet.

storageContainers

RoutingStorageContainerProperties[]

Die Liste der Speichercontainerendpunkte, an die IoT Hub Nachrichten basierend auf den Routingregeln weiterleitet.

RoutingEventHubProperties

Die Eigenschaften im Zusammenhang mit einem Event Hub-Endpunkt.

Name Typ Beschreibung
authenticationType

authenticationType

Methode zur Authentifizierung beim Event Hub-Endpunkt

connectionString

string

Die Verbindungszeichenfolge des Event Hub-Endpunkts.

endpointUri

string

Die URL des Event Hub-Endpunkts. Es muss das Protokoll enthalten, das sb://

entityPath

string

Event Hubname im Event Hub-Namespace

id

string

ID des Event Hub-Endpunkts

identity

ManagedIdentity

Eigenschaften der verwalteten Identität des Routing-Event Hub-Endpunkts.

name

string

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.

resourceGroup

string

Der Name der Ressourcengruppe des Event Hub-Endpunkts.

subscriptionId

string

Der Abonnementbezeichner des Event Hub-Endpunkts.

RoutingProperties

Die routingbezogenen Eigenschaften des IoT-Hubs. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Name Typ Beschreibung
endpoints

RoutingEndpoints

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.

enrichments

EnrichmentProperties[]

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

fallbackRoute

FallbackRouteProperties

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 in der Vorlage nicht vorhanden ist, ist die Fallbackroute standardmäßig deaktiviert.

routes

RouteProperties[]

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.

RoutingServiceBusQueueEndpointProperties

Die Eigenschaften im Zusammenhang mit Service Bus-Warteschlangenendpunkttypen.

Name Typ Beschreibung
authenticationType

authenticationType

Methode zur Authentifizierung beim Service Bus-Warteschlangenendpunkt

connectionString

string

Die Verbindungszeichenfolge des Service Bus-Warteschlangenendpunkts.

endpointUri

string

Die URL des Service Bus-Warteschlangenendpunkts. Es muss das Protokoll enthalten, das sb://

entityPath

string

Warteschlangenname im Service Bus-Namespace

id

string

ID des Service Bus-Warteschlangenendpunkts

identity

ManagedIdentity

Eigenschaften der verwalteten Identität des Routingdienstbus-Warteschlangenendpunkts.

name

string

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.

resourceGroup

string

Der Name der Ressourcengruppe des Service Bus-Warteschlangenendpunkts.

subscriptionId

string

Der Abonnementbezeichner des Service Bus-Warteschlangenendpunkts.

RoutingServiceBusTopicEndpointProperties

Die Eigenschaften im Zusammenhang mit Service Bus-Themenendpunkttypen.

Name Typ Beschreibung
authenticationType

authenticationType

Methode zur Authentifizierung beim Service Bus-Themenendpunkt

connectionString

string

Die Verbindungszeichenfolge des Service Bus-Themenendpunkts.

endpointUri

string

Die URL des Service Bus-Themenendpunkts. Es muss das Protokoll enthalten, das sb://

entityPath

string

Warteschlangenname im Service Bus-Thema

id

string

ID des Service Bus-Themenendpunkts

identity

ManagedIdentity

Eigenschaften der verwalteten Identität des Routing-Service Bus-Themenendpunkts.

name

string

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.

resourceGroup

string

Der Name der Ressourcengruppe des Service Bus-Themenendpunkts.

subscriptionId

string

Der Abonnementbezeichner des Service Bus-Themenendpunkts.

RoutingSource

Die Quelle, auf die die Routingregel angewendet werden soll, z. B. DeviceMessages.

Name Typ Beschreibung
DeviceConnectionStateEvents

string

DeviceJobLifecycleEvents

string

DeviceLifecycleEvents

string

DeviceMessages

string

Invalid

string

TwinChangeEvents

string

RoutingStorageContainerProperties

Die Eigenschaften im Zusammenhang mit einem Speichercontainerendpunkt.

Name Typ Beschreibung
authenticationType

authenticationType

Methode zur Authentifizierung beim Speicherendpunkt

batchFrequencyInSeconds

integer

Zeitintervall, in dem Blobs in den Speicher geschrieben werden. Der Wert sollte zwischen 60 und 720 Sekunden betragen. Der Standardwert ist 300 Sekunden.

connectionString

string

Der Verbindungszeichenfolge des Speicherkontos.

containerName

string

Der Name des Speichercontainers im Speicherkonto.

encoding enum:
  • Avro
  • AvroDeflate
  • JSON

Codierung, die zum Serialisieren von Nachrichten in Blobs verwendet wird. Unterstützte Werte sind "avro", "avrodeflate" und "JSON". Der Standardwert ist "avro".

endpointUri

string

Die URL des Speicherendpunkts. Es muss das Protokoll enthalten, das https://

fileNameFormat

string

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.

id

string

ID des Speichercontainerendpunkts

identity

ManagedIdentity

Eigenschaften der verwalteten Identität des Routingspeicherendpunkts.

maxChunkSizeInBytes

integer

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).

name

string

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.

resourceGroup

string

Der Name der Ressourcengruppe des Speicherkontos.

subscriptionId

string

Der Abonnementbezeichner des Speicherkontos.

SharedAccessSignatureAuthorizationRule

Die Eigenschaften einer IoT Hub-Richtlinie für freigegebenen Zugriff.

Name Typ Beschreibung
keyName

string

Der Name der SAS-Richtlinie.

primaryKey

string

Der primäre Schlüssel.

rights

AccessRights

Die berechtigungen, die der SAS-Richtlinie zugewiesen sind.

secondaryKey

string

Der sekundäre Schlüssel.

StorageEndpointProperties

Die Eigenschaften des Azure Storage-Endpunkts für den Dateiupload.

Name Typ Beschreibung
authenticationType

AuthenticationType

Gibt den Authentifizierungstyp an, der zum Herstellen einer Verbindung mit dem Speicherkonto verwendet wird.

connectionString

string

Die Verbindungszeichenfolge für das Azure Storage-Konto, in das Dateien hochgeladen werden.

containerName

string

Der Name des Stammcontainers, in den Sie Dateien hochladen. Der Container muss nicht vorhanden sein, sollte aber mit dem angegebenen connectionString bestellbar sein.

identity

ManagedIdentity

Eigenschaften der verwalteten Identität des Speicherendpunkts für den Dateiupload.

sasTtlAsIso8601

string

Der Zeitraum, für den der von IoT Hub für den Dateiupload generierte SAS-URI gültig ist. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name Typ Beschreibung
createdAt

string

Der Zeitstempel der Ressourcenerstellung (UTC).

createdBy

string

Die Identität, die die Ressource erstellt hat.

createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

lastModifiedAt

string

Der Zeitstempel der letzten Änderung der Ressource (UTC)

lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.

lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.