Iot Hub Resource - Update

Werk bestaande IoT Hubs-tags bij.
Werk een bestaande IoT Hub-tags bij. als u andere velden wilt bijwerken, gebruikt u de methode CreateOrUpdate

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2026-11-01

URI-parameters

Naam In Vereist Type Description
resourceGroupName
path True

string

minLength: 1
maxLength: 90

De naam van de resource group. De naam is hoofdletterongevoelig.

resourceName
path True

string

De naam van de IoT-hub.

subscriptionId
path True

string (uuid)

De ID van het doelabonnement. De waarde moet een UUID zijn.

api-version
query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Naam Type Description
tags

object

Resourcetags

Antwoorden

Naam Type Description
200 OK

IotHubDescription

De aanvraag is voltooid.

Kopteksten

  • Azure-AsyncOperation: string
  • Location: string
  • Retry-After: integer

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Naam Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

IotHubResource_Update

Voorbeeldaanvraag

PATCH https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/myHub?api-version=2026-11-01

{
  "tags": {
    "foo": "bar"
  }
}

Voorbeeldrespons

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

Definities

Naam Description
AccessRights

De machtigingen die zijn toegewezen aan het beleid voor gedeelde toegang.

ArmIdentity
ArmUserIdentity
AuthenticationType

Hiermee geeft u het verificatietype op dat wordt gebruikt voor het maken van verbinding met het opslagaccount.

Capabilities

De mogelijkheden en functies die zijn ingeschakeld voor de IoT-hub.

CloudToDeviceProperties

De eigenschappen voor cloud-naar-apparaat-berichten van IoT Hub.

createdByType

Het identiteitstype dat de resource heeft gemaakt.

DefaultAction

Standaardactie voor netwerkregelset

DeviceRegistry

Vertegenwoordigt eigenschappen die betrekking hebben op de Azure Device Registry (ADR).

DeviceRegistryIdentity

De identiteit die wordt gebruikt om de ADR-naamruimte vanuit het gegevensvlak te beheren.

DeviceRegistryIdentityType

Het type identiteit.

DeviceRegistryLinkingProperties

De eigenschappen met betrekking tot het koppelen van de IoT Hub aan het Azure Device Registry.

DeviceRegistryLinkingState

Geeft aan of de IoT Hub gekoppeld is aan een Azure Device Registry.

EnrichmentProperties

De eigenschappen van een verrijking die uw IoT-hub toepast op berichten die worden bezorgd bij eindpunten.

ErrorDetails

Foutdetails.

EventHubProperties

De eigenschappen van het ingerichte Event Hub-compatibele eindpunt dat wordt gebruikt door de IoT-hub.

EventStreamAuthenticationType

Specificeert het authenticatietype dat wordt gebruikt om verbinding te maken met het event stream-account.

FallbackRouteProperties

De eigenschappen van de uitwijkroute. IoT Hub gebruikt deze eigenschappen wanneer berichten naar het terugvaleindpunt worden gerouteerd.

FallbackRouteSource

De bron waarop de terugvalroute wordt toegepast.

FeedbackProperties

De eigenschappen van de feedbackwachtrij voor cloud-naar-apparaat-berichten.

GatewayVersion

De IoT hub Gateway-versie.

IotHubDescription

De beschrijving van de IoT-hub.

IotHubDetails

Set met extra alleen-lezen eigenschappen voor de IoT-hub.

IotHubLocationDescription

Publieke vertegenwoordiging van een van de locaties waar een resource wordt geleverd.

IotHubProperties

De eigenschappen van een IoT-hub.

IotHubReplicaRoleType

De rol van de regio kan zowel primair als secundair zijn. De primaire regio is waar de IoT-hub momenteel is ingericht. De secundaire regio is de gekoppelde regio voor Azure Disaster Recovery (DR) en ook de regio waar de IoT-hub een failover naar kan uitvoeren.

IotHubSku

De naam van de SKU.

IotHubSkuInfo

Informatie over de SKU van de IoT-hub.

IotHubSkuTier

De factureringslaag voor de IoT-hub.

IpFilterActionType

De gewenste actie voor aanvragen die door deze regel zijn vastgelegd.

IpFilterRule

De IP-filterregels voor de IoT-hub.

ManagedIdentity

De eigenschappen van de beheerde identiteit.

MessagingEndpointProperties

De eigenschappen van de berichteneindpunten die door deze IoT-hub worden gebruikt.

NetworkRuleIPAction

IP-filteractie

NetworkRuleSetIpRule

IP-regel die moet worden toegepast als onderdeel van de netwerkregelset

NetworkRuleSetProperties

Eigenschappen van set netwerkregels van IotHub

PrivateEndpoint

De eigenschap privé-eindpunt van een privé-eindpuntverbinding

PrivateEndpointConnection

De privé-eindpuntverbinding van een IotHub

PrivateEndpointConnectionProperties

De eigenschappen van een privé-eindpuntverbinding

PrivateLinkServiceConnectionState

De huidige status van een privé-eindpuntverbinding

PrivateLinkServiceConnectionStatus

De status van een privé-eindpuntverbinding

PublicNetworkAccess

Of aanvragen van openbaar netwerk zijn toegestaan

ResourceIdentityType

Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.

RouteProperties

De eigenschappen van een routeringsregel die uw IoT-hub gebruikt om berichten naar eindpunten te routeren.

RoutingCosmosDBSqlApiProperties

De eigenschappen die betrekking hebben op een cosmos DB sql-containereindpunt.

RoutingEndpoints

De eigenschappen met betrekking tot de aangepaste eindpunten waarnaar uw IoT-hub berichten routeert op basis van de routeringsregels. Er zijn maximaal 10 aangepaste eindpunten toegestaan voor alle eindpunttypen voor betaalde hubs en slechts 1 aangepast eindpunt is toegestaan voor alle eindpunttypen voor gratis hubs.

RoutingEventHubProperties

De eigenschappen die betrekking hebben op een eindpunt van een Event Hub.

RoutingEventStreamProperties

De eigenschappen die betrekking hebben op een eventstream-eindpunt.

RoutingProperties

De routeringsgerelateerde eigenschappen van de IoT-hub. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

RoutingServiceBusQueueEndpointProperties

De eigenschappen die betrekking hebben op de typen eindpunten van de servicebuswachtrij.

RoutingServiceBusTopicEndpointProperties

De eigenschappen die betrekking hebben op de eindpunttypen van de servicebus.

RoutingSource

De bron waarop de regel voor doorsturen moet worden toegepast, zoals DeviceMessages.

RoutingStorageContainerProperties

De eigenschappen die betrekking hebben op het eindpunt van een opslagcontainer.

RoutingStorageContainerPropertiesEncoding

Codering die wordt gebruikt voor het serialiseren van berichten naar blobs. Ondersteunde waarden zijn 'avro', 'avrodeflate' en 'JSON'. De standaardwaarde is 'avro'.

SharedAccessSignatureAuthorizationRule

De eigenschappen van een beleid voor gedeelde toegang tot een IoT-hub.

StorageEndpointProperties

De eigenschappen van het Azure Storage-eindpunt voor het uploaden van bestanden.

systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

TagsResource

Een container die alleen de tags voor een resource bevat, waardoor de gebruiker de tags op een IoT Hub-exemplaar kan bijwerken.

AccessRights

De machtigingen die zijn toegewezen aan het beleid voor gedeelde toegang.

Waarde Description
RegistryRead

RegisteryLees

RegistryWrite

RegistryWrite

ServiceConnect

ServiceConnect

DeviceConnect

DeviceConnect

RegistryRead, RegistryWrite

RegistryLezen, RegistrySchrijven

RegistryRead, ServiceConnect

RegistryRead, ServiceConnect

RegistryRead, DeviceConnect

RegistryRead, DeviceConnect

RegistryWrite, ServiceConnect

RegistryWrite, ServiceConnect

RegistryWrite, DeviceConnect

RegistryWrite, DeviceConnect

ServiceConnect, DeviceConnect

ServiceConnect, DeviceConnect

RegistryRead, RegistryWrite, ServiceConnect

RegistryRead, RegistryWrite, ServiceConnect

RegistryRead, RegistryWrite, DeviceConnect

RegistryRead, RegistryWrite, DeviceConnect

RegistryRead, ServiceConnect, DeviceConnect

RegistryRead, ServiceConnect, DeviceConnect

RegistryWrite, ServiceConnect, DeviceConnect

RegistryWrite, ServiceConnect, DeviceConnect

RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect

RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect

ArmIdentity

Naam Type Description
principalId

string

Principal-id

tenantId

string

Tenant-id

type

ResourceIdentityType

Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.

userAssignedIdentities

<string,  ArmUserIdentity>

Woordenlijst van <ArmUserIdentity->

ArmUserIdentity

Naam Type Description
clientId

string

principalId

string

AuthenticationType

Hiermee geeft u het verificatietype op dat wordt gebruikt voor het maken van verbinding met het opslagaccount.

Waarde Description
keyBased

keyBased

identityBased

identityBased

Capabilities

De mogelijkheden en functies die zijn ingeschakeld voor de IoT-hub.

Waarde Description
None

None

DeviceManagement

Apparaatbeheer

CloudToDeviceProperties

De eigenschappen voor cloud-naar-apparaat-berichten van IoT Hub.

Naam Type Description
defaultTtlAsIso8601

string (duration)

De standaardtijd voor live voor cloud-naar-apparaat-berichten in de apparaatwachtrij. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

feedback

FeedbackProperties

De eigenschappen van de feedbackwachtrij voor cloud-naar-apparaat-berichten.

maxDeliveryCount

integer (int32)

minimum: 1
maximum: 100

Het maximale aantal bezorgingen voor cloud-naar-apparaat-berichten in de apparaatwachtrij. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

createdByType

Het identiteitstype dat de resource heeft gemaakt.

Waarde Description
User
Application
ManagedIdentity
Key

DefaultAction

Standaardactie voor netwerkregelset

Waarde Description
Deny

Weigeren

Allow

Toestaan

DeviceRegistry

Vertegenwoordigt eigenschappen die betrekking hebben op de Azure Device Registry (ADR).

Naam Type Description
dataPlaneHostName

string

De hostnaam voor het dataplane-eindpunt van het bijbehorende Azure Device Registry.

identity

DeviceRegistryIdentity

De identiteit die wordt gebruikt om de ADR-naamruimte vanuit het gegevensvlak te beheren.

linkingProperties

DeviceRegistryLinkingProperties

De eigenschappen met betrekking tot het koppelen van de IoT Hub aan het Azure Device Registry.

namespaceResourceId

string (arm-id)

De identificatie van de naamruimte van het Azure Device Registry

namespaceUuid

string

De UUID van de bijbehorende Azure Device Registry-naamruimte.

DeviceRegistryIdentity

De identiteit die wordt gebruikt om de ADR-naamruimte vanuit het gegevensvlak te beheren.

Naam Type Description
type

DeviceRegistryIdentityType

Het type identiteit.

userAssignedIdentity

string (arm-id)

De door de gebruiker toegewezen identiteit als het identiteitstype 'UserAssigned' is.

DeviceRegistryIdentityType

Het type identiteit.

Waarde Description
SystemAssigned

Gebruik een door het systeem toegewezen beheerde identiteit om de ADR-naamruimte te beheren.

UserAssigned

Gebruik een door de gebruiker toegewezen beheerde identiteit om de ADR-naamruimte te beheren.

DeviceRegistryLinkingProperties

De eigenschappen met betrekking tot het koppelen van de IoT Hub aan het Azure Device Registry.

Naam Type Description
error

ErrorDetails

De laatste fout die werd voorgedaan bij het koppelen van de IoT Hub aan een Azure Device Registry.

state

DeviceRegistryLinkingState

Geeft aan of de IoT Hub gekoppeld is aan een Azure Device Registry.

DeviceRegistryLinkingState

Geeft aan of de IoT Hub gekoppeld is aan een Azure Device Registry.

Waarde Description
InProgress

De koppeling van de IoT Hub aan een Azure Device Registry is in ontwikkeling.

Success

De IoT Hub is succesvol gekoppeld aan een Azure Device Registry.

Orphaned

Het gekoppelde Azure Device Registry is niet langer gekoppeld aan de IoT Hub.

Failed

De IoT Hub slaagde er niet in om verbinding te maken met een Azure Device Registry.

EnrichmentProperties

De eigenschappen van een verrijking die uw IoT-hub toepast op berichten die worden bezorgd bij eindpunten.

Naam Type Description
endpointNames

string[]

De lijst met eindpunten waarvoor de verrijking wordt toegepast op het bericht.

key

string

De sleutel of naam voor de verrijkingseigenschap.

value

string

De waarde voor de verrijkingseigenschap.

ErrorDetails

Foutdetails.

Naam Type Description
code

string

De foutcode.

details

string

De foutgegevens.

httpStatusCode

string

De HTTP-statuscode.

message

string

Het foutbericht.

EventHubProperties

De eigenschappen van het ingerichte Event Hub-compatibele eindpunt dat wordt gebruikt door de IoT-hub.

Naam Type Description
endpoint

string

Het Event Hub-compatibele eindpunt.

partitionCount

integer (int32)

Het aantal partities voor het ontvangen van apparaat-naar-cloud-berichten in het event hub-compatibele eindpunt. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.

partitionIds

string[]

De partitie-id's in het Event Hub-compatibele eindpunt.

path

string

De Event Hub-compatibele naam.

retentionTimeInDays

integer (int64)

De bewaartijd voor apparaat-naar-cloud-berichten in dagen. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

EventStreamAuthenticationType

Specificeert het authenticatietype dat wordt gebruikt om verbinding te maken met het event stream-account.

Waarde Description
identityBased

identiteitsgebaseerde authenticatie

FallbackRouteProperties

De eigenschappen van de uitwijkroute. IoT Hub gebruikt deze eigenschappen wanneer berichten naar het terugvaleindpunt worden gerouteerd.

Naam Type Description
condition

string

De voorwaarde die wordt geëvalueerd om de terugvalroute toe te passen. Als de voorwaarde niet is opgegeven, wordt standaard geëvalueerd of waar is. Voor grammatica, zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpointNames

string[]

De lijst met eindpunten waarnaar de berichten waaraan de voorwaarde voldoet, worden doorgestuurd. Momenteel is slechts één eindpunt toegestaan.

isEnabled

boolean

Wordt gebruikt om op te geven of de terugvalroute is ingeschakeld.

name

string

De naam van de route. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten, mag maximaal 64 tekens lang zijn en moet uniek zijn.

source

FallbackRouteSource

De bron waarop de regel voor doorsturen moet worden toegepast. Bijvoorbeeld DeviceMessages

FallbackRouteSource

De bron waarop de terugvalroute wordt toegepast.

Waarde Description
DeviceMessages

Apparaat-naar-cloud berichten verzonden door apparaten.

FeedbackProperties

De eigenschappen van de feedbackwachtrij voor cloud-naar-apparaat-berichten.

Naam Type Description
lockDurationAsIso8601

string (duration)

De vergrendelingsduur voor de feedbackwachtrij. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

maxDeliveryCount

integer (int32)

minimum: 1
maximum: 100

Het aantal keren dat de IoT-hub een bericht probeert te bezorgen in de feedbackwachtrij. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

ttlAsIso8601

string (duration)

De periode waarvoor een bericht beschikbaar is om te gebruiken voordat het is verlopen door de IoT-hub. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

GatewayVersion

De IoT hub Gateway-versie.

Waarde Description
V1

V1

V2

V2

IotHubDescription

De beschrijving van de IoT-hub.

Naam Type Description
etag

string

Het veld Etag is niet vereist. Als deze is opgegeven in de hoofdtekst van het antwoord, moet deze ook worden opgegeven als een header volgens de normale ETag-conventie.

id

string (arm-id)

Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"

identity

ArmIdentity

De beheerde identiteiten voor de IotHub.

location

string

De geografische locatie waar de resource zich bevindt

name

string

De naam van de resource

properties

IotHubProperties

IotHub-eigenschappen

sku

IotHubSkuInfo

IotHub-SKU-gegevens

systemData

systemData

Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.

tags

object

Resourcetags.

type

string

Het type bron. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

IotHubDetails

Set met extra alleen-lezen eigenschappen voor de IoT-hub.

Naam Type Description
gatewayVersion

GatewayVersion

De IoT hub Gateway-versie.

IotHubLocationDescription

Publieke vertegenwoordiging van een van de locaties waar een resource wordt geleverd.

Naam Type Description
location

string

De naam van de Azure-regio

role

IotHubReplicaRoleType

De rol van de regio kan zowel primair als secundair zijn. De primaire regio is waar de IoT-hub momenteel is ingericht. De secundaire regio is de gekoppelde regio voor Azure Disaster Recovery (DR) en ook de regio waar de IoT-hub een failover naar kan uitvoeren.

IotHubProperties

De eigenschappen van een IoT-hub.

Naam Type Description
allowedFqdnList

string[]

Lijst met toegestane FQDN's (Fully Qualified Domain Name) voor uitgaand verkeer van IoT Hub.

authorizationPolicies

SharedAccessSignatureAuthorizationRule[]

Het beleid voor gedeelde toegang dat u kunt gebruiken om een verbinding met de IoT-hub te beveiligen.

cloudToDevice

CloudToDeviceProperties

De eigenschappen voor cloud-naar-apparaat-berichten van IoT Hub.

comments

string

Opmerkingen bij IoT Hub.

deviceHostName

string

De naam van de apparaathost. Ondersteunt beveiligde verbindingen via TLS 1.3.

deviceRegistry

DeviceRegistry

Vertegenwoordigt eigenschappen die betrekking hebben op de Azure Device Registry (ADR).

disableDeviceSAS

boolean

Indien waar, kunnen alle apparaten (inclusief Edge-apparaten, maar met uitzondering van modules) sas-sleutels binnen het bereik niet worden gebruikt voor verificatie.

disableLocalAuth

boolean

Indien waar, kunnen SAS-tokens met sas-sleutels met ioT-bereik niet worden gebruikt voor verificatie.

disableModuleSAS

boolean

Indien waar, kunnen alle SAS-sleutels met modulebereik niet worden gebruikt voor verificatie.

enableDataResidency

boolean

Met deze eigenschap wanneer deze is ingesteld op true, wordt gegevenslocatie ingeschakeld, waardoor herstel na noodgevallen wordt uitgeschakeld.

enableFileUploadNotifications

boolean

Indien waar, worden meldingen voor het uploaden van bestanden ingeschakeld.

eventHubEndpoints

<string,  EventHubProperties>

De eigenschappen van het Event Hub-compatibele eindpunt. De enige mogelijke sleutels voor deze woordenlijst zijn gebeurtenissen. Deze sleutel moet aanwezig zijn in de woordenlijst tijdens het maken of bijwerken van aanroepen voor de IoT-hub.

features

Capabilities

De mogelijkheden en functies die zijn ingeschakeld voor de IoT-hub.

hostName

string

De naam van de host.

iotHubDetails

IotHubDetails

Set met extra alleen-lezen eigenschappen voor de IoT-hub.

ipFilterRules

IpFilterRule[]

De IP-filterregels.

locations

IotHubLocationDescription[]

Primaire en secundaire locatie voor ioT-hub

messagingEndpoints

<string,  MessagingEndpointProperties>

De eigenschappen van het berichteindpunt voor de meldingswachtrij voor het uploaden van bestanden.

minTlsVersion

string

Hiermee geeft u de minimale TLS-versie op die moet worden ondersteund voor deze hub. Kan worden ingesteld op '1.2' om clients te hebben die een TLS-versie lager dan 1.2 gebruiken om te worden geweigerd.

networkRuleSets

NetworkRuleSetProperties

Eigenschappen van set netwerkregels van IotHub

privateEndpointConnections

PrivateEndpointConnection[]

Privé-eindpuntverbindingen die zijn gemaakt op deze IotHub

provisioningState

string

De inrichtingsstatus.

publicNetworkAccess

PublicNetworkAccess

Of aanvragen van openbaar netwerk zijn toegestaan

restrictOutboundNetworkAccess

boolean

Indien waar, worden uitgaand verkeer van IotHub beperkt tot alleen de toegestane FQDN's die zijn geconfigureerd via allowedFqdnList.

routing

RoutingProperties

De routeringsgerelateerde eigenschappen van de IoT-hub. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

serviceHostName

string

De naam van de servicehost. Ondersteunt beveiligde verbindingen via TLS 1.3.

state

string

De hub-staat.

storageEndpoints

<string,  StorageEndpointProperties>

De lijst met Azure Storage-eindpunten waar u bestanden kunt uploaden. Op dit moment kunt u slechts één Azure Storage-account configureren en dat moet de sleutel hebben als $default. Als u meer dan één opslagaccount opgeeft, wordt er een fout gegenereerd. Als de eigenschap enableFileUploadNotifications is ingesteld op True, wordt er geen waarde opgegeven voor deze eigenschap. Er wordt een fout gegenereerd.

IotHubReplicaRoleType

De rol van de regio kan zowel primair als secundair zijn. De primaire regio is waar de IoT-hub momenteel is ingericht. De secundaire regio is de gekoppelde regio voor Azure Disaster Recovery (DR) en ook de regio waar de IoT-hub een failover naar kan uitvoeren.

Waarde Description
primary

primair

secondary

tweede

IotHubSku

De naam van de SKU.

Waarde Description
F1

F1

S1

S1

S2

S2

S3

S3

B1

B1

B2

B2

B3

B3

IotHubSkuInfo

Informatie over de SKU van de IoT-hub.

Naam Type Description
capacity

integer (int64)

Het aantal ingerichte IoT Hub-eenheden. Zie: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.

name

IotHubSku

De naam van de SKU.

tier

IotHubSkuTier

De factureringslaag voor de IoT-hub.

IotHubSkuTier

De factureringslaag voor de IoT-hub.

Waarde Description
Free

Gratis

Standard

Standard

Basic

Basic

IpFilterActionType

De gewenste actie voor aanvragen die door deze regel zijn vastgelegd.

Waarde Description
Accept

Accepteren

Reject

Verwerpen

IpFilterRule

De IP-filterregels voor de IoT-hub.

Naam Type Description
action

IpFilterActionType

De gewenste actie voor aanvragen die door deze regel zijn vastgelegd.

filterName

string

De naam van de IP-filterregel.

ipMask

string

Een tekenreeks die het IP-adresbereik in CIDR-notatie voor de regel bevat.

ManagedIdentity

De eigenschappen van de beheerde identiteit.

Naam Type Description
userAssignedIdentity

string

De door de gebruiker toegewezen identiteit.

MessagingEndpointProperties

De eigenschappen van de berichteneindpunten die door deze IoT-hub worden gebruikt.

Naam Type Description
lockDurationAsIso8601

string (duration)

De duur van de vergrendeling. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

maxDeliveryCount

integer (int32)

minimum: 1
maximum: 100

Het aantal keren dat de IoT-hub een bericht probeert te bezorgen. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

ttlAsIso8601

string (duration)

De periode waarvoor een bericht beschikbaar is om te gebruiken voordat het is verlopen door de IoT-hub. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

NetworkRuleIPAction

IP-filteractie

Waarde Description
Allow

Toestaan

NetworkRuleSetIpRule

IP-regel die moet worden toegepast als onderdeel van de netwerkregelset

Naam Type Default value Description
action

NetworkRuleIPAction

Allow

IP-filteractie

filterName

string

Naam van de IP-filterregel.

ipMask

string

Een tekenreeks die het IP-adresbereik in CIDR-notatie voor de regel bevat.

NetworkRuleSetProperties

Eigenschappen van set netwerkregels van IotHub

Naam Type Default value Description
applyToBuiltInEventHubEndpoint

boolean

Indien waar, wordt de netwerkregelset ook toegepast op builtIn EventHub EndPoint van IotHub

defaultAction

DefaultAction

Deny

Standaardactie voor netwerkregelset

ipRules

NetworkRuleSetIpRule[]

Lijst met IP-regels

PrivateEndpoint

De eigenschap privé-eindpunt van een privé-eindpuntverbinding

Naam Type Description
id

string

De resource-id.

PrivateEndpointConnection

De privé-eindpuntverbinding van een IotHub

Naam Type Description
id

string (arm-id)

Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"

name

string

De naam van de resource

properties

PrivateEndpointConnectionProperties

De eigenschappen van een privé-eindpuntverbinding

systemData

systemData

Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.

type

string

Het type bron. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

PrivateEndpointConnectionProperties

De eigenschappen van een privé-eindpuntverbinding

Naam Type Description
privateEndpoint

PrivateEndpoint

De eigenschap privé-eindpunt van een privé-eindpuntverbinding

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

De huidige status van een privé-eindpuntverbinding

PrivateLinkServiceConnectionState

De huidige status van een privé-eindpuntverbinding

Naam Type Description
actionsRequired

string

Acties die vereist zijn voor een privé-eindpuntverbinding

description

string

De beschrijving voor de huidige status van een privé-eindpuntverbinding

status

PrivateLinkServiceConnectionStatus

De status van een privé-eindpuntverbinding

PrivateLinkServiceConnectionStatus

De status van een privé-eindpuntverbinding

Waarde Description
Pending

In afwachting

Approved

Approved

Rejected

Afgewezen

Disconnected

Disconnected

PublicNetworkAccess

Of aanvragen van openbaar netwerk zijn toegestaan

Waarde Description
Enabled

Enabled

Disabled

Disabled

ResourceIdentityType

Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.

Waarde Description
SystemAssigned

SystemAssigned

UserAssigned

UserAssigned

SystemAssigned, UserAssigned

SystemToegewezen, UserAssigned

None

None

RouteProperties

De eigenschappen van een routeringsregel die uw IoT-hub gebruikt om berichten naar eindpunten te routeren.

Naam Type Description
condition

string

De voorwaarde die wordt geëvalueerd om de routeringsregel toe te passen. Als er geen voorwaarde is opgegeven, wordt standaard geëvalueerd of waar is. Voor grammatica, zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpointNames

string[]

De lijst met eindpunten waarnaar berichten die voldoen aan de voorwaarde, worden gerouteerd. Op dit moment is slechts één eindpunt toegestaan.

isEnabled

boolean

Wordt gebruikt om op te geven of een route is ingeschakeld.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

De naam van de route. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten, mag maximaal 64 tekens lang zijn en moet uniek zijn.

source

RoutingSource

De bron waarop de regel voor doorsturen moet worden toegepast, zoals DeviceMessages.

RoutingCosmosDBSqlApiProperties

De eigenschappen die betrekking hebben op een cosmos DB sql-containereindpunt.

Naam Type Description
authenticationType

AuthenticationType

Methode die wordt gebruikt voor verificatie op basis van het cosmos DB SQL-containereindpunt

containerName

string

De naam van de cosmos DB SQL-container in de cosmos DB-database.

databaseName

string

De naam van de cosmos DB-database in het cosmos DB-account.

endpointUri

string (uri)

De URL van het Cosmos DB-account. Het moet het protocol bevatten https://

id

string

Id van het cosmos DB SQL-containereindpunt

identity

ManagedIdentity

Eigenschappen van beheerde identiteit van het routeren van cosmos DB-containereindpunt.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en maximaal 64 tekens bevatten. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor eindpunttypen.

partitionKeyName

string

De naam van de partitiesleutel die is gekoppeld aan deze cosmos DB SQL-container als deze bestaat. Dit is een optionele parameter.

partitionKeyTemplate

string

De sjabloon voor het genereren van een synthetische partitiesleutelwaarde voor gebruik met deze cosmos DB SQL-container. De sjabloon moet ten minste een van de volgende tijdelijke aanduidingen bevatten: {iothub}, {deviceid}, {DD}, {MM} en {JJJJ}. Elke tijdelijke aanduiding kan maximaal één keer worden opgegeven, maar volgorde en niet-tijdelijke aanduidingen zijn willekeurig. Deze parameter is alleen vereist als PartitionKeyName is opgegeven.

primaryKey

string (password)

De primaire sleutel van het Cosmos DB-account.

resourceGroup

string

De naam van de resourcegroep van het Cosmos DB-account.

secondaryKey

string (password)

De secundaire sleutel van het cosmos DB-account.

subscriptionId

string

De abonnements-id van het cosmos DB-account.

RoutingEndpoints

De eigenschappen met betrekking tot de aangepaste eindpunten waarnaar uw IoT-hub berichten routeert op basis van de routeringsregels. Er zijn maximaal 10 aangepaste eindpunten toegestaan voor alle eindpunttypen voor betaalde hubs en slechts 1 aangepast eindpunt is toegestaan voor alle eindpunttypen voor gratis hubs.

Naam Type Description
cosmosDBSqlContainers

RoutingCosmosDBSqlApiProperties[]

De lijst met Cosmos DB-containereindpunten waarnaar IoT Hub berichten routeert op basis van de routeringsregels.

eventHubs

RoutingEventHubProperties[]

De lijst met Event Hubs-eindpunten waarnaar IoT Hub berichten routeert op basis van de routeringsregels. Deze lijst bevat niet het ingebouwde Event Hubs-eindpunt.

eventStreams

RoutingEventStreamProperties[]

De lijst van event stream-eindpunten waar de IoT-hub berichten naartoe stuurt, gebaseerd op de routeringsregels.

serviceBusQueues

RoutingServiceBusQueueEndpointProperties[]

De lijst met Service Bus-wachtrijeindpunten waarnaar ioT Hub de berichten routeert op basis van de routeringsregels.

serviceBusTopics

RoutingServiceBusTopicEndpointProperties[]

De lijst met Service Bus-onderwerpeindpunten waarnaar de IoT-hub de berichten routeert, op basis van de routeringsregels.

storageContainers

RoutingStorageContainerProperties[]

De lijst met opslagcontainereindpunten waarnaar IoT Hub berichten routeert op basis van de routeringsregels.

RoutingEventHubProperties

De eigenschappen die betrekking hebben op een eindpunt van een Event Hub.

Naam Type Description
authenticationType

AuthenticationType

Methode die wordt gebruikt voor verificatie op basis van het Event Hub-eindpunt

connectionString

string (password)

De verbindingsreeks van het Event Hub-eindpunt.

endpointUri

string

De URL van het Event Hub-eindpunt. Het moet het protocol sb:// bevatten

entityPath

string

Event Hub-naam in de Event Hub-naamruimte

id

string

Id van het Event Hub-eindpunt

identity

ManagedIdentity

Eigenschappen van beheerde identiteit van het eindpunt van de Event Hub routeren.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en maximaal 64 tekens bevatten. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor eindpunttypen.

resourceGroup

string

De naam van de resourcegroep van het Event Hub-eindpunt.

subscriptionId

string

De abonnements-id van het Event Hub-eindpunt.

RoutingEventStreamProperties

De eigenschappen die betrekking hebben op een eventstream-eindpunt.

Naam Type Description
authenticationType

EventStreamAuthenticationType

Methode gebruikt om te authenticeren tegen het eventstream-eindpunt

endpointUri

string

De url van de onderliggende event hub-naamruimte van het event stream-eindpunt. Het moet het protocol sb:// bevatten

entityPath

string

Event Hub-naam in de Event Hub-naamruimte

eventStreamId

string

De unieke GUID van de doelgebeurtenisstroom onder de werkruimte.

id

string

ID van het eventstream-eindpunt

identity

ManagedIdentity

Beheerde identiteitseigenschappen van het routerings-eventstroomeindpunt.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en maximaal 64 tekens bevatten. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor eindpunttypen.

sourceId

string

De unieke GUID van de aangepaste bron voor de gebeurtenisstroom.

workspaceId

string

De unieke GUID van de doel-Microsoft Fabric-werkruimte voor het eventstream-eindpunt.

RoutingProperties

De routeringsgerelateerde eigenschappen van de IoT-hub. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Naam Type Description
endpoints

RoutingEndpoints

De eigenschappen met betrekking tot de aangepaste eindpunten waarnaar uw IoT-hub berichten routeert op basis van de routeringsregels. Er zijn maximaal 10 aangepaste eindpunten toegestaan voor alle eindpunttypen voor betaalde hubs en slechts 1 aangepast eindpunt is toegestaan voor alle eindpunttypen voor gratis hubs.

enrichments

EnrichmentProperties[]

De lijst met door de gebruiker geleverde verrijkingen die de IoT-hub toepast op berichten die moeten worden geleverd aan ingebouwde en aangepaste eindpunten. Zie: https://aka.ms/telemetryoneventgrid

fallbackRoute

FallbackRouteProperties

De eigenschappen van de route die wordt gebruikt als een terugvalroute wanneer aan geen van de voorwaarden in de sectie Routes wordt voldaan. Dit is een optionele parameter. Wanneer deze eigenschap niet is ingesteld, worden de berichten die niet voldoen aan een van de voorwaarden die zijn opgegeven in de sectie Routes, doorgestuurd naar het ingebouwde EventHub-eindpunt.

routes

RouteProperties[]

De lijst met door de gebruiker verstrekte routeringsregels die door de IoT-hub worden gebruikt om berichten te routeren naar ingebouwde en aangepaste eindpunten. Er zijn maximaal 100 routeringsregels toegestaan voor betaalde hubs en er zijn maximaal 5 routeringsregels toegestaan voor gratis hubs.

RoutingServiceBusQueueEndpointProperties

De eigenschappen die betrekking hebben op de typen eindpunten van de servicebuswachtrij.

Naam Type Description
authenticationType

AuthenticationType

Methode die wordt gebruikt voor verificatie op basis van het eindpunt van de Service Bus-wachtrij

connectionString

string (password)

De verbindingsreeks van het service bus-wachtrijeindpunt.

endpointUri

string

De URL van het service bus-wachtrijeindpunt. Het moet het protocol sb:// bevatten

entityPath

string

Wachtrijnaam in de Service Bus-naamruimte

id

string

Id van het service bus-wachtrijeindpunt

identity

ManagedIdentity

Eigenschappen van beheerde identiteit van het eindpunt van de service bus-wachtrij.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en maximaal 64 tekens bevatten. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor eindpunttypen. De naam hoeft niet hetzelfde te zijn als de werkelijke wachtrijnaam.

resourceGroup

string

De naam van de resourcegroep van het service bus-wachtrijeindpunt.

subscriptionId

string

De abonnements-id van het service bus-wachtrijeindpunt.

RoutingServiceBusTopicEndpointProperties

De eigenschappen die betrekking hebben op de eindpunttypen van de servicebus.

Naam Type Description
authenticationType

AuthenticationType

Methode die wordt gebruikt voor verificatie op basis van het service bus-onderwerpeindpunt

connectionString

string (password)

De verbindingsreeks van het service bus-onderwerpeindpunt.

endpointUri

string

De URL van het service bus-onderwerpeindpunt. Het moet het protocol sb:// bevatten

entityPath

string

Wachtrijnaam in het Service Bus-onderwerp

id

string

Id van het service bus-onderwerpeindpunt

identity

ManagedIdentity

Beheerde identiteiteigenschappen van het eindpunt van het routeren van Service Bus-onderwerp.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en maximaal 64 tekens bevatten. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor eindpunttypen. De naam hoeft niet hetzelfde te zijn als de werkelijke onderwerpnaam.

resourceGroup

string

De naam van de resourcegroep van het service bus-onderwerpeindpunt.

subscriptionId

string

De abonnements-id van het service bus-onderwerpeindpunt.

RoutingSource

De bron waarop de regel voor doorsturen moet worden toegepast, zoals DeviceMessages.

Waarde Description
Invalid

Ongeldig

DeviceMessages

ApparaatBerichten

TwinChangeEvents

TwinChange-evenementen

DeviceLifecycleEvents

DeviceLifecycleGebeurtenissen

DeviceJobLifecycleEvents

ApparaatJobLifecycleEvenementen

DeviceConnectionStateEvents

DeviceConnectionStateEvents

RoutingStorageContainerProperties

De eigenschappen die betrekking hebben op het eindpunt van een opslagcontainer.

Naam Type Description
authenticationType

AuthenticationType

Methode die wordt gebruikt voor verificatie op basis van het opslageindpunt

batchFrequencyInSeconds

integer (int32)

minimum: 60
maximum: 720

Tijdsinterval waarmee blobs naar de opslag worden geschreven. De waarde moet tussen 60 en 720 seconden zijn. De standaardwaarde is 300 seconden.

connectionString

string (password)

De verbindingsreeks van het opslagaccount.

containerName

string

De naam van de opslagcontainer in het opslagaccount.

encoding

RoutingStorageContainerPropertiesEncoding

Codering die wordt gebruikt voor het serialiseren van berichten naar blobs. Ondersteunde waarden zijn 'avro', 'avrodeflate' en 'JSON'. De standaardwaarde is 'avro'.

endpointUri

string

De URL van het opslageindpunt. Het moet het protocol bevatten https://

fileNameFormat

string

Bestandsnaamindeling voor de blob. De standaardindeling is {iothub}/{partition}/{JJJJ}/{MM}/{DD}/{HH}/{mm}. Alle parameters zijn verplicht, maar kunnen opnieuw worden gerangschikt.

id

string

Id van het eindpunt van de opslagcontainer

identity

ManagedIdentity

Eigenschappen van beheerde identiteit van eindpunt voor routeringsopslag.

maxChunkSizeInBytes

integer (int32)

minimum: 10485760
maximum: 524288000

Maximum aantal bytes voor elke blob die naar de opslag is geschreven. De waarde moet tussen 10485760(10 MB) en 524288000 (500 MB) zijn. De standaardwaarde is 314572800(300 MB).

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en maximaal 64 tekens bevatten. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor eindpunttypen.

resourceGroup

string

De naam van de resourcegroep van het opslagaccount.

subscriptionId

string

De abonnements-id van het opslagaccount.

RoutingStorageContainerPropertiesEncoding

Codering die wordt gebruikt voor het serialiseren van berichten naar blobs. Ondersteunde waarden zijn 'avro', 'avrodeflate' en 'JSON'. De standaardwaarde is 'avro'.

Waarde Description
Avro

Avro

AvroDeflate

AvroDeflate

JSON

JSON

SharedAccessSignatureAuthorizationRule

De eigenschappen van een beleid voor gedeelde toegang tot een IoT-hub.

Naam Type Description
keyName

string

De naam van het beleid voor gedeelde toegang.

primaryKey

string

De primaire sleutel.

rights

AccessRights

De machtigingen die zijn toegewezen aan het beleid voor gedeelde toegang.

secondaryKey

string

De secundaire sleutel.

StorageEndpointProperties

De eigenschappen van het Azure Storage-eindpunt voor het uploaden van bestanden.

Naam Type Description
authenticationType

AuthenticationType

Hiermee geeft u het verificatietype op dat wordt gebruikt voor het maken van verbinding met het opslagaccount.

connectionString

string

De verbindingsreeks voor het Azure Storage-account waarnaar bestanden worden geüpload.

containerName

string

De naam van de hoofdcontainer waar u bestanden uploadt. De container hoeft niet te bestaan, maar moet worden gemaakt met behulp van de connectionString opgegeven.

identity

ManagedIdentity

Eigenschappen van beheerde identiteit van opslageindpunt voor het uploaden van bestanden.

sasTtlAsIso8601

string (duration)

De periode waarvoor de SAS-URI die is gegenereerd door IoT Hub voor het uploaden van bestanden, is geldig. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Naam Type Description
createdAt

string (date-time)

De tijdstempel van het aanmaken van resources (UTC).

createdBy

string

De identiteit die de resource heeft gemaakt.

createdByType

createdByType

Het identiteitstype dat de resource heeft gemaakt.

lastModifiedAt

string (date-time)

De tijdstempel van de laatste wijziging van de resource (UTC)

lastModifiedBy

string

De identiteit die de resource voor het laatst heeft gewijzigd.

lastModifiedByType

createdByType

Het type identiteit dat de resource voor het laatst heeft gewijzigd.

TagsResource

Een container die alleen de tags voor een resource bevat, waardoor de gebruiker de tags op een IoT Hub-exemplaar kan bijwerken.

Naam Type Description
tags

object

Resourcetags