Iot Hub Resource - Update

Tjänst:: IoT Hub

API-version:: 2026-11-01

Uppdatera en befintlig IoT Hubs taggar.
Uppdatera en befintlig IoT Hub taggar. Om du vill uppdatera andra fält använder du metoden CreateOrUpdate

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
resourceName	path	True	string	Namnet på IoT-hubben.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
tags	object	Taggar för resurser

Svar

Name	Typ	Description
200 OK	IotHubDescription	Begäran har slutförts. Sidhuvuden Azure-AsyncOperation: string Location: string Retry-After: integer

Name

Typ

Description

200 OK

IotHubDescription

Begäran har slutförts.

Sidhuvuden

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

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

IotHubResource_Update

Exempelbegäran

HTTP

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"
  }
}

Exempelsvar

Statuskod:: 200

{
  "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"
  }
}

Definitioner

Name	Description
AccessRights	De behörigheter som tilldelats principen för delad åtkomst.
ArmIdentity
ArmUserIdentity
AuthenticationType	Anger autentiseringstyp som används för att ansluta till lagringskontot.
Capabilities	Funktionerna och funktionerna som är aktiverade för IoT-hubben.
CloudToDeviceProperties	Meddelandeegenskaperna för IoT Hub från moln till enhet.
createdByType	Den typ av identitet som skapade resursen.
DefaultAction	Standardåtgärd för nätverksregeluppsättning
DeviceRegistry	Representerar egenskaper som är relaterade till Azure Device Registry (ADR).
DeviceRegistryIdentity	Identiteten som används för att hantera ADR-namnområdet från dataplanet.
DeviceRegistryIdentityType	Identitetens typ.
DeviceRegistryLinkingProperties	Egenskaperna relaterade till att koppla IoT Hub till Azure Device Registry.
DeviceRegistryLinkingState	Anger om IoT Hub är kopplad till ett Azure Device Registry.
EnrichmentProperties	Egenskaperna för en berikning som din IoT-hubb gäller för meddelanden som levereras till slutpunkter.
ErrorDetails	Felinformation.
EventHubProperties	Egenskaperna för den etablerade Event Hub-kompatibla slutpunkten som används av IoT-hubben.
EventStreamAuthenticationType	Specificerar autentiseringstyp som används för att ansluta till händelseströmskontot.
FallbackRouteProperties	Egenskaperna för reservvägen. IoT Hub använder dessa egenskaper när den dirigerar meddelanden till återställningsslutpunkten.
FallbackRouteSource	Källan som reservvägen tillämpas på.
FeedbackProperties	Egenskaperna för feedbackkön för meddelanden från moln till enhet.
GatewayVersion	IoT-hubben Gateway-versionen.
IotHubDescription	Beskrivningen av IoT-hubben.
IotHubDetails	Uppsättning av ytterligare skrivskyddade egenskaper för IoT-hubben.
IotHubLocationDescription	Offentlig representation av en av de platser där en resurs etableras.
IotHubProperties	Egenskaperna för en IoT-hubb.
IotHubReplicaRoleType	Regionens roll kan vara antingen primär eller sekundär. Den primära regionen är den plats där IoT-hubben för närvarande etableras. Den sekundära regionen är den parkopplade Azure-haveriberedskapsregionen (DR) och även den region där IoT-hubben kan redundansväxla till.
IotHubSku	Namnet på SKU:n.
IotHubSkuInfo	Information om SKU:n för IoT-hubben.
IotHubSkuTier	Faktureringsnivån för IoT-hubben.
IpFilterActionType	Önskad åtgärd för begäranden som samlas in av den här regeln.
IpFilterRule	IP-filterreglerna för IoT-hubben.
ManagedIdentity	Egenskaperna för den hanterade identiteten.
MessagingEndpointProperties	Egenskaperna för de meddelandeslutpunkter som används av den här IoT-hubben.
NetworkRuleIPAction	IP-filteråtgärd
NetworkRuleSetIpRule	IP-regel som ska tillämpas som en del av nätverksregeluppsättningen
NetworkRuleSetProperties	Egenskaper för nätverksregeluppsättning för IotHub
PrivateEndpoint	Egenskapen privat slutpunkt för en privat slutpunktsanslutning
PrivateEndpointConnection	Den privata slutpunktsanslutningen för en IotHub
PrivateEndpointConnectionProperties	Egenskaperna för en privat slutpunktsanslutning
PrivateLinkServiceConnectionState	Det aktuella tillståndet för en privat slutpunktsanslutning
PrivateLinkServiceConnectionStatus	Status för en privat slutpunktsanslutning
PublicNetworkAccess	Om begäranden från offentliga nätverk tillåts
ResourceIdentityType	Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.
RouteProperties	Egenskaperna för en routningsregel som din IoT-hubb använder för att dirigera meddelanden till slutpunkter.
RoutingCosmosDBSqlApiProperties	Egenskaperna som är relaterade till en Cosmos DB sql-containerslutpunkt.
RoutingEndpoints	Egenskaperna som är relaterade till de anpassade slutpunkter som din IoT Hub dirigerar meddelanden baserat på routningsreglerna. Högst 10 anpassade slutpunkter tillåts för alla slutpunktstyper för betalda hubbar och endast 1 anpassad slutpunkt tillåts för alla slutpunktstyper för kostnadsfria hubbar.
RoutingEventHubProperties	Egenskaperna som är relaterade till en slutpunkt för händelsehubben.
RoutingEventStreamProperties	Egenskaperna relaterade till en händelseströmsändpunkt.
RoutingProperties	Routningsrelaterade egenskaper för IoT-hubben. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties	Egenskaperna som är relaterade till slutpunktstyper för Service Bus-köer.
RoutingServiceBusTopicEndpointProperties	Egenskaperna som är relaterade till slutpunktstyper för Service Bus-ämne.
RoutingSource	Den källa som routningsregeln ska tillämpas på, till exempel DeviceMessages.
RoutingStorageContainerProperties	Egenskaperna som är relaterade till en slutpunkt för en lagringscontainer.
RoutingStorageContainerPropertiesEncoding	Kodning som används för att serialisera meddelanden till blobar. Värden som stöds är "avro", "avrodeflate" och "JSON". Standardvärdet är "avro".
SharedAccessSignatureAuthorizationRule	Egenskaperna för en IoT Hub princip för delad åtkomst.
StorageEndpointProperties	Egenskaperna för Azure Storage-slutpunkten för filuppladdning.
systemData	Metadata som rör skapande och senaste ändring av resursen.
TagsResource	En container som endast innehåller taggar för en resurs, så att användaren kan uppdatera taggarna på en IoT Hub instans.

AccessRights

Uppräkning

De behörigheter som tilldelats principen för delad åtkomst.

Värde	Description
RegistryRead	RegisterLäs
RegistryWrite	RegistryWrite
ServiceConnect	ServiceConnect
DeviceConnect	DeviceConnect
RegistryRead, RegistryWrite	RegisterLäs, RegistrySkriv
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

Objekt

Name	Typ	Description
principalId	string	Huvudnamns-ID
tenantId	string	Tenant-ID
type	ResourceIdentityType	Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.
userAssignedIdentities	<string, ArmUserIdentity>	Ordlista för <ArmUserIdentity>

ArmUserIdentity

Objekt

Name	Typ	Description
clientId	string
principalId	string

AuthenticationType

Uppräkning

Anger autentiseringstyp som används för att ansluta till lagringskontot.

Värde	Description
keyBased	keyBased
identityBased	identitetsbaserad

Capabilities

Uppräkning

Funktionerna och funktionerna som är aktiverade för IoT-hubben.

Värde	Description
None	None
DeviceManagement	Hantering av enheter

CloudToDeviceProperties

Objekt

Meddelandeegenskaperna för IoT Hub från moln till enhet.

Name	Typ	Description
defaultTtlAsIso8601	string (duration)	Standardtiden för att leva för meddelanden från moln till enhet i enhetskön. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
feedback	FeedbackProperties	Egenskaperna för feedbackkön för meddelanden från moln till enhet.
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	Det maximala leveransantalet för meddelanden från moln till enhet i enhetskön. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

DefaultAction

Uppräkning

Standardåtgärd för nätverksregeluppsättning

Värde	Description
Deny	Avvisa
Allow	Allow

DeviceRegistry

Objekt

Representerar egenskaper som är relaterade till Azure Device Registry (ADR).

Name	Typ	Description
dataPlaneHostName	string	Värdnamnet för dataplansändpunkten i det associerade Azure Device Registry.
identity	DeviceRegistryIdentity	Identiteten som används för att hantera ADR-namnområdet från dataplanet.
linkingProperties	DeviceRegistryLinkingProperties	Egenskaperna relaterade till att koppla IoT Hub till Azure Device Registry.
namespaceResourceId	string (arm-id)	Identifieraren för Azure Device Registry-namnrymden
namespaceUuid	string	UUID för det tillhörande Azure Device Registry-namnrymden.

DeviceRegistryIdentity

Objekt

Identiteten som används för att hantera ADR-namnområdet från dataplanet.

Name	Typ	Description
type	DeviceRegistryIdentityType	Identitetens typ.
userAssignedIdentity	string (arm-id)	Den användar-tilldelade identiteten om identitetstypen är 'UserAssigned'.

DeviceRegistryIdentityType

Uppräkning

Identitetens typ.

Värde	Description
SystemAssigned	Använd en systemtilldelad hanterad identitet för att hantera ADR-namnrymden.
UserAssigned	Använd en användartilldelad hanterad identitet för att hantera ADR-namnrymden.

DeviceRegistryLinkingProperties

Objekt

Egenskaperna relaterade till att koppla IoT Hub till Azure Device Registry.

Name	Typ	Description
error	ErrorDetails	Det sista felet uppstod när IoT Hub kopplades till ett Azure Device Registry.
state	DeviceRegistryLinkingState	Anger om IoT Hub är kopplad till ett Azure Device Registry.

DeviceRegistryLinkingState

Uppräkning

Anger om IoT Hub är kopplad till ett Azure Device Registry.

Värde	Description
InProgress	Kopplingen till IoT Hub med ett Azure Device Registry är under utveckling.
Success	IoT Hub är framgångsrikt kopplad till ett Azure Device Registry.
Orphaned	Det länkade Azure Device Registry är inte längre kopplat till IoT Hub.
Failed	IoT Hub misslyckades med att koppla till ett Azure Device Registry.

EnrichmentProperties

Objekt

Egenskaperna för en berikning som din IoT-hubb gäller för meddelanden som levereras till slutpunkter.

Name	Typ	Description
endpointNames	string[]	Listan över slutpunkter för vilka berikningen tillämpas på meddelandet.
key	string	Nyckeln eller namnet på berikningsegenskapen.
value	string	Värdet för berikningsegenskapen.

ErrorDetails

Objekt

Felinformation.

Name	Typ	Description
code	string	Felkoden.
details	string	Felinformationen.
httpStatusCode	string	HTTP-statuskoden.
message	string	Felmeddelandet.

EventHubProperties

Objekt

Egenskaperna för den etablerade Event Hub-kompatibla slutpunkten som används av IoT-hubben.

Name	Typ	Description
endpoint	string	Den Event Hub-kompatibla slutpunkten.
partitionCount	integer (int32)	Antalet partitioner för att ta emot meddelanden från enhet till moln i den Event Hub-kompatibla slutpunkten. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.
partitionIds	string[]	Partitions-ID:t i den Event Hub-kompatibla slutpunkten.
path	string	Det Event Hub-kompatibla namnet.
retentionTimeInDays	integer (int64)	Kvarhållningstiden för meddelanden från enhet till moln i dagar. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

EventStreamAuthenticationType

Uppräkning

Specificerar autentiseringstyp som används för att ansluta till händelseströmskontot.

Värde	Description
identityBased	identitetsbaserad autentisering

FallbackRouteProperties

Objekt

Egenskaperna för reservvägen. IoT Hub använder dessa egenskaper när den dirigerar meddelanden till återställningsslutpunkten.

Name	Typ	Description
condition	string	Villkoret som utvärderas för att tillämpa återställningsvägen. Om villkoret inte anges utvärderas det som sant som standard. För grammatik, se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	Listan över slutpunkter som meddelandena som uppfyller villkoret dirigeras till. För närvarande tillåts endast en slutpunkt.
isEnabled	boolean	Används för att ange om återställningsvägen är aktiverad.
name	string	Namnet på rutten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck, har en maximal längd på 64 tecken och måste vara unikt.
source	FallbackRouteSource	Den källa som routningsregeln ska tillämpas på. Till exempel DeviceMessages

FallbackRouteSource

Uppräkning

Källan som reservvägen tillämpas på.

Värde	Description
DeviceMessages	Enhets-till-moln-meddelanden skickade av enheter.

FeedbackProperties

Objekt

Egenskaperna för feedbackkön för meddelanden från moln till enhet.

Name	Typ	Description
lockDurationAsIso8601	string (duration)	Låsvaraktigheten för feedbackkön. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	Antalet gånger som IoT-hubben försöker leverera ett meddelande i feedbackkön. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
ttlAsIso8601	string (duration)	Den tidsperiod för vilken ett meddelande är tillgängligt för användning innan det har upphört att gälla av IoT-hubben. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

GatewayVersion

Uppräkning

IoT-hubben Gateway-versionen.

Värde	Description
V1	V1
V2	V2

IotHubDescription

Objekt

Beskrivningen av IoT-hubben.

Name	Typ	Description
etag	string	Fältet Etag är inte krävs. Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen.
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ArmIdentity	Hanterade identiteter för IotHub.
location	string	Den geo-plats där resursen finns
name	string	Namnet på resursen
properties	IotHubProperties	IotHub-egenskaper
sku	IotHubSkuInfo	IotHub SKU-information
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
tags	object	Resursetiketter.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

IotHubDetails

Objekt

Uppsättning av ytterligare skrivskyddade egenskaper för IoT-hubben.

Name	Typ	Description
gatewayVersion	GatewayVersion	IoT-hubben Gateway-versionen.

IotHubLocationDescription

Objekt

Offentlig representation av en av de platser där en resurs etableras.

Name	Typ	Description
location	string	Namnet på Azure-regionen
role	IotHubReplicaRoleType	Regionens roll kan vara antingen primär eller sekundär. Den primära regionen är den plats där IoT-hubben för närvarande etableras. Den sekundära regionen är den parkopplade Azure-haveriberedskapsregionen (DR) och även den region där IoT-hubben kan redundansväxla till.

IotHubProperties

Objekt

Egenskaperna för en IoT-hubb.

Name	Typ	Description
allowedFqdnList	string[]	Lista över tillåtna FQDN(fullständigt domännamn) för utgående från Iot Hub.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[]	De principer för delad åtkomst som du kan använda för att skydda en anslutning till IoT-hubben.
cloudToDevice	CloudToDeviceProperties	Meddelandeegenskaperna för IoT Hub från moln till enhet.
comments	string	IoT Hub-kommentarer.
deviceHostName	string	Namnet på enhetens värd. Stöder säkra anslutningar över TLS 1.3.
deviceRegistry	DeviceRegistry	Representerar egenskaper som är relaterade till Azure Device Registry (ADR).
disableDeviceSAS	boolean	Om det är sant kan inte alla enheter (inklusive Edge-enheter men exklusive moduler) begränsade SAS-nycklar användas för autentisering.
disableLocalAuth	boolean	Om det är sant kan SAS-token med SAS-nycklar med Iot Hub-omfång inte användas för autentisering.
disableModuleSAS	boolean	Om det är sant kan inte alla SAS-nycklar med modulomfattning användas för autentisering.
enableDataResidency	boolean	Den här egenskapen när den är inställd på true aktiverar datahemvist, vilket inaktiverar haveriberedskap.
enableFileUploadNotifications	boolean	Om Sant aktiveras meddelanden om filuppladdning.
eventHubEndpoints	<string, EventHubProperties>	De Event Hub-kompatibla slutpunktsegenskaperna. De enda möjliga nycklarna till den här ordlistan är händelser. Den här nyckeln måste finnas i ordlistan när du skapar eller uppdaterar anrop för IoT-hubben.
features	Capabilities	Funktionerna och funktionerna som är aktiverade för IoT-hubben.
hostName	string	Namnet på värden.
iotHubDetails	IotHubDetails	Uppsättning av ytterligare skrivskyddade egenskaper för IoT-hubben.
ipFilterRules	IpFilterRule[]	IP-filterreglerna.
locations	IotHubLocationDescription[]	Primär och sekundär plats för iot Hub
messagingEndpoints	<string, MessagingEndpointProperties>	Egenskaperna för meddelandeslutpunkten för meddelandekön för filuppladdning.
minTlsVersion	string	Anger den lägsta TLS-version som ska stödjas för den här hubben. Kan anges till "1.2" så att klienter som använder en TLS-version under 1.2 avvisas.
networkRuleSets	NetworkRuleSetProperties	Egenskaper för nätverksregeluppsättning för IotHub
privateEndpointConnections	PrivateEndpointConnection[]	Privata slutpunktsanslutningar som skapats på denna IotHub
provisioningState	string	Etableringstillståndet.
publicNetworkAccess	PublicNetworkAccess	Om begäranden från offentliga nätverk tillåts
restrictOutboundNetworkAccess	boolean	Om det är sant begränsas utgående från IotHub endast till de tillåtna FQDN:er som konfigureras via allowedFqdnList.
routing	RoutingProperties	Routningsrelaterade egenskaper för IoT-hubben. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
serviceHostName	string	Namnet på servicevärden. Stöder säkra anslutningar över TLS 1.3.
state	string	Hubbens tillstånd.
storageEndpoints	<string, StorageEndpointProperties>	Listan över Azure Storage-slutpunkter där du kan ladda upp filer. För närvarande kan du bara konfigurera ett Azure Storage-konto och som MÅSTE ha dess nyckel som $default. Om du anger fler än ett lagringskonto genereras ett fel. Om du inte anger något värde för den här egenskapen när egenskapen enableFileUploadNotifications har angetts till True utlöses ett fel.

IotHubReplicaRoleType

Uppräkning

Regionens roll kan vara antingen primär eller sekundär. Den primära regionen är den plats där IoT-hubben för närvarande etableras. Den sekundära regionen är den parkopplade Azure-haveriberedskapsregionen (DR) och även den region där IoT-hubben kan redundansväxla till.

Värde	Description
primary	primär
secondary	sekundär

IotHubSku

Uppräkning

Namnet på SKU:n.

Värde	Description
F1	F1
S1	S1
S2	S2
S3	S3
B1	B1
B2	B2
B3	B3

IotHubSkuInfo

Objekt

Information om SKU:n för IoT-hubben.

Name	Typ	Description
capacity	integer (int64)	Antalet etablerade IoT Hub-enheter. Se: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
name	IotHubSku	Namnet på SKU:n.
tier	IotHubSkuTier	Faktureringsnivån för IoT-hubben.

IotHubSkuTier

Uppräkning

Faktureringsnivån för IoT-hubben.

Värde	Description
Free	Free
Standard	Standard
Basic	Grundläggande

IpFilterActionType

Uppräkning

Önskad åtgärd för begäranden som samlas in av den här regeln.

Värde	Description
Accept	Godkänn
Reject	Avvisa

IpFilterRule

Objekt

IP-filterreglerna för IoT-hubben.

Name	Typ	Description
action	IpFilterActionType	Önskad åtgärd för begäranden som samlas in av den här regeln.
filterName	string	Namnet på IP-filterregeln.
ipMask	string	En sträng som innehåller IP-adressintervallet i CIDR-notationen för regeln.

ManagedIdentity

Objekt

Egenskaperna för den hanterade identiteten.

Name	Typ	Description
userAssignedIdentity	string	Den användartilldelade identiteten.

MessagingEndpointProperties

Objekt

Egenskaperna för de meddelandeslutpunkter som används av den här IoT-hubben.

Name	Typ	Description
lockDurationAsIso8601	string (duration)	Låsets varaktighet. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	Antalet gånger som IoT-hubben försöker leverera ett meddelande. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
ttlAsIso8601	string (duration)	Den tidsperiod för vilken ett meddelande är tillgängligt för användning innan det har upphört att gälla av IoT-hubben. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

NetworkRuleIPAction

Uppräkning

IP-filteråtgärd

Värde	Description
Allow	Allow

NetworkRuleSetIpRule

Objekt

IP-regel som ska tillämpas som en del av nätverksregeluppsättningen

Name	Typ	Standardvärde	Description
action	NetworkRuleIPAction	Allow	IP-filteråtgärd
filterName	string		Namnet på IP-filterregeln.
ipMask	string		En sträng som innehåller IP-adressintervallet i CIDR-notationen för regeln.

NetworkRuleSetProperties

Objekt

Egenskaper för nätverksregeluppsättning för IotHub

Name	Typ	Standardvärde	Description
applyToBuiltInEventHubEndpoint	boolean		Om sant tillämpas nätverksregeluppsättningen också på BuiltIn EventHub EndPoint för IotHub
defaultAction	DefaultAction	Deny	Standardåtgärd för nätverksregeluppsättning
ipRules	NetworkRuleSetIpRule[]		Lista över IP-regler

PrivateEndpoint

Objekt

Egenskapen privat slutpunkt för en privat slutpunktsanslutning

Name	Typ	Description
id	string	Resursidentifieraren.

PrivateEndpointConnection

Objekt

Den privata slutpunktsanslutningen för en IotHub

Name	Typ	Description
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Namnet på resursen
properties	PrivateEndpointConnectionProperties	Egenskaperna för en privat slutpunktsanslutning
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Objekt

Egenskaperna för en privat slutpunktsanslutning

Name	Typ	Description
privateEndpoint	PrivateEndpoint	Egenskapen privat slutpunkt för en privat slutpunktsanslutning
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Det aktuella tillståndet för en privat slutpunktsanslutning

PrivateLinkServiceConnectionState

Objekt

Det aktuella tillståndet för en privat slutpunktsanslutning

Name	Typ	Description
actionsRequired	string	Åtgärder som krävs för en privat slutpunktsanslutning
description	string	Beskrivningen av det aktuella tillståndet för en privat slutpunktsanslutning
status	PrivateLinkServiceConnectionStatus	Status för en privat slutpunktsanslutning

PrivateLinkServiceConnectionStatus

Uppräkning

Status för en privat slutpunktsanslutning

Värde	Description
Pending	Avvaktan
Approved	Approved
Rejected	Avvisad
Disconnected	Disconnected

PublicNetworkAccess

Uppräkning

Om begäranden från offentliga nätverk tillåts

Värde	Description
Enabled	Enabled
Disabled	Disabled

ResourceIdentityType

Uppräkning

Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.

Värde	Description
SystemAssigned	SystemAssigned
UserAssigned	UserAssigned
SystemAssigned, UserAssigned	SystemTilldelad, Användartilldelad
None	None

RouteProperties

Objekt

Egenskaperna för en routningsregel som din IoT-hubb använder för att dirigera meddelanden till slutpunkter.

Name	Typ	Description
condition	string	Villkoret som utvärderas för att tillämpa routningsregeln. Om inget villkor anges utvärderas det som sant som standard. För grammatik, se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	Listan över slutpunkter till vilka meddelanden som uppfyller villkoret dirigeras. För närvarande tillåts endast en slutpunkt.
isEnabled	boolean	Används för att ange om en väg är aktiverad.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Namnet på rutten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck, har en maximal längd på 64 tecken och måste vara unikt.
source	RoutingSource	Den källa som routningsregeln ska tillämpas på, till exempel DeviceMessages.

RoutingCosmosDBSqlApiProperties

Objekt

Egenskaperna som är relaterade till en Cosmos DB sql-containerslutpunkt.

Name	Typ	Description
authenticationType	AuthenticationType	Metod som används för att autentisera mot cosmos DB sql-containerslutpunkten
containerName	string	Namnet på cosmos DB sql-containern i Cosmos DB-databasen.
databaseName	string	Namnet på cosmos DB-databasen i cosmos DB-kontot.
endpointUri	string (uri)	URL:en för cosmos DB-kontot. Det måste innehålla protokollet https://
id	string	ID för cosmos DB sql-containerslutpunkten
identity	ManagedIdentity	Hanterade identitetsegenskaper för routning av cosmos DB-containerslutpunkten.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Namnet som identifierar den här slutpunkten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, fileNotifications $default. Slutpunktsnamn måste vara unika mellan slutpunktstyper.
partitionKeyName	string	Namnet på partitionsnyckeln som är associerad med den här cosmos DB sql-containern om det finns en sådan. Det här är en valfri parameter.
partitionKeyTemplate	string	Mallen för att generera ett syntetiskt partitionsnyckelvärde för användning med den här cosmos DB sql-containern. Mallen måste innehålla minst en av följande platshållare: {iothub}, {deviceid}, {DD}, {MM} och {ÅÅÅÅ}. En platshållare kan anges högst en gång, men ordnings- och icke-platshållarkomponenter är godtyckliga. Den här parametern krävs bara om PartitionKeyName har angetts.
primaryKey	string (password)	Den primära nyckeln för Cosmos DB-kontot.
resourceGroup	string	Namnet på resursgruppen för Cosmos DB-kontot.
secondaryKey	string (password)	Den sekundära nyckeln för Cosmos DB-kontot.
subscriptionId	string	Prenumerationsidentifieraren för Cosmos DB-kontot.

RoutingEndpoints

Objekt

Egenskaperna som är relaterade till de anpassade slutpunkter som din IoT Hub dirigerar meddelanden baserat på routningsreglerna. Högst 10 anpassade slutpunkter tillåts för alla slutpunktstyper för betalda hubbar och endast 1 anpassad slutpunkt tillåts för alla slutpunktstyper för kostnadsfria hubbar.

Name	Typ	Description
cosmosDBSqlContainers	RoutingCosmosDBSqlApiProperties[]	Listan över Cosmos DB-containerslutpunkter som IoT Hub dirigerar meddelanden till, baserat på routningsreglerna.
eventHubs	RoutingEventHubProperties[]	Listan över Event Hubs-slutpunkter som IoT Hub dirigerar meddelanden till, baserat på routningsreglerna. Den här listan innehåller inte den inbyggda Event Hubs-slutpunkten.
eventStreams	RoutingEventStreamProperties[]	Listan över händelseströmsändpunkter som IoT-hubben dirigerar meddelanden till, baserat på routningsreglerna.
serviceBusQueues	RoutingServiceBusQueueEndpointProperties[]	Listan över Service Bus-köslutpunkter som IoT Hub dirigerar meddelandena till, baserat på routningsreglerna.
serviceBusTopics	RoutingServiceBusTopicEndpointProperties[]	Listan över Service Bus-ämnesslutpunkter som IoT-hubben dirigerar meddelandena till, baserat på routningsreglerna.
storageContainers	RoutingStorageContainerProperties[]	Listan över lagringscontainerslutpunkter som IoT Hub dirigerar meddelanden till, baserat på routningsreglerna.

RoutingEventHubProperties

Objekt

Egenskaperna som är relaterade till en slutpunkt för händelsehubben.

Name	Typ	Description
authenticationType	AuthenticationType	Metod som används för att autentisera mot händelsehubbens slutpunkt
connectionString	string (password)	Anslutningssträngen för händelsehubbens slutpunkt.
endpointUri	string	URL:en för händelsehubbens slutpunkt. Det måste innehålla protokollet sb://
entityPath	string	Namn på händelsehubb på händelsehubbens namnområde
id	string	ID för händelsehubbens slutpunkt
identity	ManagedIdentity	Hanterade identitetsegenskaper för routning av händelsehubbens slutpunkt.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Namnet som identifierar den här slutpunkten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, fileNotifications $default. Slutpunktsnamn måste vara unika mellan slutpunktstyper.
resourceGroup	string	Namnet på resursgruppen för händelsehubbens slutpunkt.
subscriptionId	string	Prenumerationsidentifieraren för händelsehubbens slutpunkt.

RoutingEventStreamProperties

Objekt

Egenskaperna relaterade till en händelseströmsändpunkt.

Name	Typ	Description
authenticationType	EventStreamAuthenticationType	Metod som används för att autentisera mot händelseströmsändpunkten
endpointUri	string	URL:en till det underliggande händelsehubbens namnrymd för händelseströmmens slutpunkt. Det måste innehålla protokollet sb://
entityPath	string	Namn på händelsehubb på händelsehubbens namnområde
eventStreamId	string	Den unika GUID:n för målhändelseströmmen under arbetsytan.
id	string	ID för händelseströmmens slutpunkt
identity	ManagedIdentity	Hanterade identitetsegenskaper för routningshändelseströmsändpunkten.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Namnet som identifierar den här slutpunkten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, fileNotifications $default. Slutpunktsnamn måste vara unika mellan slutpunktstyper.
sourceId	string	Den unika GUID:n för den anpassade källan för händelseströmmen.
workspaceId	string	Den unika GUID:n för målarbetsytan Microsoft Fabric för händelseströmsändpunkten.

RoutingProperties

Objekt

Routningsrelaterade egenskaper för IoT-hubben. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Name	Typ	Description
endpoints	RoutingEndpoints	Egenskaperna som är relaterade till de anpassade slutpunkter som din IoT Hub dirigerar meddelanden baserat på routningsreglerna. Högst 10 anpassade slutpunkter tillåts för alla slutpunktstyper för betalda hubbar och endast 1 anpassad slutpunkt tillåts för alla slutpunktstyper för kostnadsfria hubbar.
enrichments	EnrichmentProperties[]	Listan över berikanden från användare som IoT-hubben gäller för meddelanden som ska levereras till inbyggda och anpassade slutpunkter. Se: https://aka.ms/telemetryoneventgrid
fallbackRoute	FallbackRouteProperties	Egenskaperna för den väg som används som en återställningsväg när inget av de villkor som anges i avsnittet "vägar" uppfylls. Det här är en valfri parameter. När den här egenskapen inte har angetts dirigeras de meddelanden som inte uppfyller något av de villkor som anges i avsnittet "vägar" till den inbyggda eventhub-slutpunkten.
routes	RouteProperties[]	Listan över användardefinierade routningsregler som IoT-hubben använder för att dirigera meddelanden till inbyggda och anpassade slutpunkter. Högst 100 routningsregler tillåts för betalda hubbar och högst 5 routningsregler tillåts för kostnadsfria hubbar.

RoutingServiceBusQueueEndpointProperties

Objekt

Egenskaperna som är relaterade till slutpunktstyper för Service Bus-köer.

Name	Typ	Description
authenticationType	AuthenticationType	Metod som används för att autentisera mot service bus-köslutpunkten
connectionString	string (password)	Anslutningssträngen för service bus-köslutpunkten.
endpointUri	string	URL:en för service bus-köslutpunkten. Det måste innehålla protokollet sb://
entityPath	string	Könamn på Service Bus-namnområdet
id	string	ID för service bus-köslutpunkten
identity	ManagedIdentity	Hanterade identitetsegenskaper för routning av service bus-köslutpunkten.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Namnet som identifierar den här slutpunkten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, fileNotifications $default. Slutpunktsnamn måste vara unika mellan slutpunktstyper. Namnet behöver inte vara samma som det faktiska könamnet.
resourceGroup	string	Namnet på resursgruppen för service bus-köslutpunkten.
subscriptionId	string	Prenumerationsidentifieraren för service bus-köslutpunkten.

RoutingServiceBusTopicEndpointProperties

Objekt

Egenskaperna som är relaterade till slutpunktstyper för Service Bus-ämne.

Name	Typ	Description
authenticationType	AuthenticationType	Metod som används för att autentisera mot service bus-ämnesslutpunkten
connectionString	string (password)	Anslutningssträngen för service bus-ämnesslutpunkten.
endpointUri	string	URL:en för service bus-ämnesslutpunkten. Det måste innehålla protokollet sb://
entityPath	string	Könamn för service bus-ämnet
id	string	ID för service bus-ämnesslutpunkten
identity	ManagedIdentity	Hanterade identitetsegenskaper för routning av service bus-ämnesslutpunkten.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Namnet som identifierar den här slutpunkten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, fileNotifications $default. Slutpunktsnamn måste vara unika mellan slutpunktstyper. Namnet behöver inte vara samma som det faktiska ämnesnamnet.
resourceGroup	string	Namnet på resursgruppen för service bus-ämnesslutpunkten.
subscriptionId	string	Prenumerationsidentifieraren för service bus-ämnesslutpunkten.

RoutingSource

Uppräkning

Den källa som routningsregeln ska tillämpas på, till exempel DeviceMessages.

Värde	Description
Invalid	Ogiltig
DeviceMessages	DeviceMessages (på engelska)
TwinChangeEvents	TwinChangeEvents (på engelska)
DeviceLifecycleEvents	DeviceLifecycleEvents (Händelser för DeviceLifecycle)
DeviceJobLifecycleEvents	DeviceJobLifecycleEvents (på engelska)
DeviceConnectionStateEvents	DeviceConnectionStateEvents (på engelska)

RoutingStorageContainerProperties

Objekt

Egenskaperna som är relaterade till en slutpunkt för en lagringscontainer.

Name	Typ	Description
authenticationType	AuthenticationType	Metod som används för att autentisera mot lagringsslutpunkten
batchFrequencyInSeconds	integer (int32) minimum: 60 maximum: 720	Tidsintervall med vilket blobar skrivs till lagring. Värdet ska vara mellan 60 och 720 sekunder. Standardvärdet är 300 sekunder.
connectionString	string (password)	Anslutningssträngen för lagringskontot.
containerName	string	Namnet på lagringscontainern i lagringskontot.
encoding	RoutingStorageContainerPropertiesEncoding	Kodning som används för att serialisera meddelanden till blobar. Värden som stöds är "avro", "avrodeflate" och "JSON". Standardvärdet är "avro".
endpointUri	string	Url:en för lagringsslutpunkten. Det måste innehålla protokollet https://
fileNameFormat	string	Filnamnsformat för bloben. Standardformatet är {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. Alla parametrar är obligatoriska men kan ordnas om.
id	string	ID för lagringscontainerns slutpunkt
identity	ManagedIdentity	Egenskaper för hanterad identitet för routning av lagringsslutpunkt.
maxChunkSizeInBytes	integer (int32) minimum: 10485760 maximum: 524288000	Maximalt antal byte för varje blob som skrivs till lagring. Värdet ska vara mellan 10485760(10 MB) och 524288000(500 MB). Standardvärdet är 314572800(300 MB).
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Namnet som identifierar den här slutpunkten. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och har en maximal längd på 64 tecken. Följande namn är reserverade: händelser, fileNotifications $default. Slutpunktsnamn måste vara unika mellan slutpunktstyper.
resourceGroup	string	Namnet på resursgruppen för lagringskontot.
subscriptionId	string	Prenumerationsidentifieraren för lagringskontot.

RoutingStorageContainerPropertiesEncoding

Uppräkning

Kodning som används för att serialisera meddelanden till blobar. Värden som stöds är "avro", "avrodeflate" och "JSON". Standardvärdet är "avro".

Värde	Description
Avro	Avro
AvroDeflate	AvroDeflate
JSON	JSON

SharedAccessSignatureAuthorizationRule

Objekt

Egenskaperna för en IoT Hub princip för delad åtkomst.

Name	Typ	Description
keyName	string	Namnet på principen för delad åtkomst.
primaryKey	string	Primärnyckeln.
rights	AccessRights	De behörigheter som tilldelats principen för delad åtkomst.
secondaryKey	string	Den sekundära nyckeln.

StorageEndpointProperties

Objekt

Egenskaperna för Azure Storage-slutpunkten för filuppladdning.

Name	Typ	Description
authenticationType	AuthenticationType	Anger autentiseringstyp som används för att ansluta till lagringskontot.
connectionString	string	Anslutningssträngen för Det Azure Storage-konto som filerna laddas upp till.
containerName	string	Namnet på rotcontainern där du laddar upp filer. Containern behöver inte finnas men bör vara kreatabell med hjälp av den angivna connectionString.the container need not exist but should be creatable using the connectionString specified.
identity	ManagedIdentity	Egenskaper för hanterad identitet för lagringsslutpunkten för filuppladdning.
sasTtlAsIso8601	string (duration)	Den tidsperiod för vilken SAS-URI:n som genererats av IoT Hub för filuppladdning är giltig. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

TagsResource

Objekt

En container som endast innehåller taggar för en resurs, så att användaren kan uppdatera taggarna på en IoT Hub instans.

Name	Typ	Description
tags	object	Taggar för resurser