Iot Hub Resource - Update
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=2023-06-30
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Resursgruppsidentifierare. |
resource
|
path | True |
string |
Namnet på den iot-hubb som ska uppdateras. |
subscription
|
path | True |
string |
Prenumerationsidentifieraren. |
api-version
|
query | True |
string |
Versionen av API:et. |
Begärandetext
Name | Typ | Description |
---|---|---|
tags |
object |
Resurstaggar |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Iot Hub har uppdaterats |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow
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
Exempelsvar
{
"id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
"name": "testHub",
"type": "Microsoft.Devices/IotHubs",
"location": "centraluseuap",
"tags": {
"foo": "bar"
},
"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"
}
}
Definitioner
Name | Description |
---|---|
Access |
De behörigheter som tilldelats principen för delad åtkomst. |
Arm |
|
Arm |
|
Authentication |
Anger autentiseringstyp som används för att ansluta till lagringskontot. |
authentication |
Metod som används för att autentisera mot service bus-köslutpunkten |
Capabilities |
Funktionerna och funktionerna som är aktiverade för IoT-hubben. |
Cloud |
Meddelandeegenskaperna för IoT Hub från moln till enhet. |
created |
Den typ av identitet som skapade resursen. |
Default |
Standardåtgärd för nätverksregeluppsättning |
Enrichment |
Egenskaperna för en berikning som din IoT-hubb gäller för meddelanden som levereras till slutpunkter. |
Event |
Egenskaperna för den etablerade Event Hub-kompatibla slutpunkten som används av IoT-hubben. |
Fallback |
Egenskaperna för återställningsvägen. IoT Hub använder dessa egenskaper när meddelanden dirigeras till återställningsslutpunkten. |
Feedback |
Egenskaperna för feedbackkön för meddelanden från moln till enhet. |
Iot |
Beskrivningen av IoT-hubben. |
Iot |
Offentlig representation av en av de platser där en resurs etableras. |
Iot |
Egenskaperna för en IoT-hubb. |
Iot |
Regionens roll kan vara antingen primär eller sekundär. Den primära regionen är den region där IoT-hubben för närvarande etableras. Den sekundära regionen är den länkade Azure-haveriberedskapsregionen (DR) och även den region där IoT-hubben kan redundansväxlar till. |
Iot |
Namnet på SKU:n. |
Iot |
Information om SKU:n för IoT-hubben. |
Iot |
Faktureringsnivån för IoT-hubben. |
Ip |
Önskad åtgärd för begäranden som samlas in av den här regeln. |
Ip |
IP-filterreglerna för IoT-hubben. |
Managed |
Egenskaperna för den hanterade identiteten. |
Messaging |
Egenskaperna för de meddelandeslutpunkter som används av den här IoT-hubben. |
Network |
IP-filteråtgärd |
Network |
IP-regel som ska tillämpas som en del av nätverksregeluppsättningen |
Network |
Egenskaper för nätverksregeluppsättning för IotHub |
Private |
Egenskapen privat slutpunkt för en privat slutpunktsanslutning |
Private |
Den privata slutpunktsanslutningen för en IotHub |
Private |
Egenskaperna för en privat slutpunktsanslutning |
Private |
Det aktuella tillståndet för en privat slutpunktsanslutning |
Private |
Status för en privat slutpunktsanslutning |
Public |
Om begäranden från offentliga nätverk tillåts |
Resource |
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. |
Route |
Egenskaperna för en routningsregel som din IoT-hubb använder för att dirigera meddelanden till slutpunkter. |
Routing |
Egenskaperna som är relaterade till en cosmos DB sql-containerslutpunkt. |
Routing |
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. |
Routing |
Egenskaperna som är relaterade till en händelsehubbslutpunkt. |
Routing |
Routningsrelaterade egenskaper för IoT-hubben. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging |
Routing |
Egenskaper som är relaterade till service bus-köslutpunktstyper. |
Routing |
Egenskaper som är relaterade till service bus-ämnesslutpunktstyper. |
Routing |
Den källa som routningsregeln ska tillämpas på, till exempel DeviceMessages. |
Routing |
Egenskaperna som är relaterade till en slutpunkt för lagringscontainer. |
Shared |
Egenskaperna för en princip för delad åtkomst i IoT Hub. |
Storage |
Egenskaperna för Azure Storage-slutpunkten för filuppladdning. |
system |
Metadata som rör skapande och senaste ändring av resursen. |
Tags |
En container som endast innehåller taggarna för en resurs, så att användaren kan uppdatera taggarna på en IoT Hub-instans. |
AccessRights
De behörigheter som tilldelats principen för delad åtkomst.
Värde | Description |
---|---|
DeviceConnect | |
RegistryRead | |
RegistryRead, DeviceConnect | |
RegistryRead, RegistryWrite | |
RegistryRead, RegistryWrite, DeviceConnect | |
RegistryRead, RegistryWrite, ServiceConnect | |
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect | |
RegistryRead, ServiceConnect | |
RegistryRead, ServiceConnect, DeviceConnect | |
RegistryWrite | |
RegistryWrite, DeviceConnect | |
RegistryWrite, ServiceConnect | |
RegistryWrite, ServiceConnect, DeviceConnect | |
ServiceConnect | |
ServiceConnect, DeviceConnect |
ArmIdentity
Name | Typ | Description |
---|---|---|
principalId |
string |
Huvudnamns-ID |
tenantId |
string |
Klientorganisations-ID |
type |
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,
Arm |
ArmUserIdentity
Name | Typ | Description |
---|---|---|
clientId |
string |
|
principalId |
string |
AuthenticationType
Anger autentiseringstyp som används för att ansluta till lagringskontot.
Värde | Description |
---|---|
identityBased | |
keyBased |
authenticationType
Metod som används för att autentisera mot service bus-köslutpunkten
Värde | Description |
---|---|
identityBased | |
keyBased |
Capabilities
Funktionerna och funktionerna som är aktiverade för IoT-hubben.
Värde | Description |
---|---|
DeviceManagement | |
None |
CloudToDeviceProperties
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 |
Egenskaperna för feedbackkön för meddelanden från moln till enhet. |
|
maxDeliveryCount |
integer (int32) minimum: 1maximum: 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
Den typ av identitet som skapade resursen.
Värde | Description |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
DefaultAction
Standardåtgärd för nätverksregeluppsättning
Värde | Description |
---|---|
Allow | |
Deny |
EnrichmentProperties
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. |
EventHubProperties
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 |
Event Hub-kompatibelt namn. |
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 |
FallbackRouteProperties
Egenskaperna för återställningsvägen. IoT Hub använder dessa egenskaper när meddelanden dirigeras 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å vägen. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck, har en maximal längd på 64 tecken och måste vara unikt. |
source |
Den källa som routningsregeln ska tillämpas på. Till exempel DeviceMessages |
FeedbackProperties
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: 1maximum: 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. |
IotHubDescription
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 |
Resursidentifieraren. |
identity |
Hanterade identiteter för IotHub. |
|
location |
string |
Resursplatsen. |
name |
string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$ |
Resursnamnet. |
properties |
IotHub-egenskaper |
|
sku |
IotHub SKU-information |
|
systemData |
Systemmetadata som är relaterade till den här resursen. |
|
tags |
object |
Resurstaggar. |
type |
string |
Resurstypen. |
IotHubLocationDescription
Offentlig representation av en av de platser där en resurs etableras.
Name | Typ | Description |
---|---|---|
location |
string |
Namnet på Azure-regionen |
role |
Regionens roll kan vara antingen primär eller sekundär. Den primära regionen är den region där IoT-hubben för närvarande etableras. Den sekundära regionen är den länkade Azure-haveriberedskapsregionen (DR) och även den region där IoT-hubben kan redundansväxlar till. |
IotHubProperties
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 |
De principer för delad åtkomst som du kan använda för att skydda en anslutning till IoT-hubben. |
|
cloudToDevice |
Meddelandeegenskaperna för IoT Hub från moln till enhet. |
|
comments |
string |
IoT Hub-kommentarer. |
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,
Event |
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 |
Funktionerna och funktionerna som är aktiverade för IoT-hubben. |
|
hostName |
string |
Namnet på värden. |
ipFilterRules |
IP-filterreglerna. |
|
locations |
Primär och sekundär plats för iot Hub |
|
messagingEndpoints |
<string,
Messaging |
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 |
Egenskaper för nätverksregeluppsättning för IotHub |
|
privateEndpointConnections |
Privata slutpunktsanslutningar som skapats på denna IotHub |
|
provisioningState |
string |
Etableringstillståndet. |
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 |
Routningsrelaterade egenskaper för IoT-hubben. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging |
|
state |
string |
Hubbtillståndet. |
storageEndpoints |
<string,
Storage |
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
Regionens roll kan vara antingen primär eller sekundär. Den primära regionen är den region där IoT-hubben för närvarande etableras. Den sekundära regionen är den länkade Azure-haveriberedskapsregionen (DR) och även den region där IoT-hubben kan redundansväxlar till.
Värde | Description |
---|---|
primary | |
secondary |
IotHubSku
Namnet på SKU:n.
Värde | Description |
---|---|
B1 | |
B2 | |
B3 | |
F1 | |
S1 | |
S2 | |
S3 |
IotHubSkuInfo
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 |
Namnet på SKU:n. |
|
tier |
Faktureringsnivån för IoT-hubben. |
IotHubSkuTier
Faktureringsnivån för IoT-hubben.
Värde | Description |
---|---|
Basic | |
Free | |
Standard |
IpFilterActionType
Önskad åtgärd för begäranden som samlas in av den här regeln.
Värde | Description |
---|---|
Accept | |
Reject |
IpFilterRule
IP-filterreglerna för IoT-hubben.
Name | Typ | Description |
---|---|---|
action |
Ö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
Egenskaperna för den hanterade identiteten.
Name | Typ | Description |
---|---|---|
userAssignedIdentity |
string |
Den användartilldelade identiteten. |
MessagingEndpointProperties
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: 1maximum: 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
IP-filteråtgärd
Värde | Description |
---|---|
Allow |
NetworkRuleSetIpRule
IP-regel som ska tillämpas som en del av nätverksregeluppsättningen
Name | Typ | Standardvärde | Description |
---|---|---|---|
action | 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
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 | Deny |
Standardåtgärd för nätverksregeluppsättning |
|
ipRules |
Lista över IP-regler |
PrivateEndpoint
Egenskapen privat slutpunkt för en privat slutpunktsanslutning
Name | Typ | Description |
---|---|---|
id |
string |
Resursidentifieraren. |
PrivateEndpointConnection
Den privata slutpunktsanslutningen för en IotHub
Name | Typ | Description |
---|---|---|
id |
string |
Resursidentifieraren. |
name |
string |
Resursnamnet. |
properties |
Egenskaperna för en privat slutpunktsanslutning |
|
type |
string |
Resurstypen. |
PrivateEndpointConnectionProperties
Egenskaperna för en privat slutpunktsanslutning
Name | Typ | Description |
---|---|---|
privateEndpoint |
Egenskapen privat slutpunkt för en privat slutpunktsanslutning |
|
privateLinkServiceConnectionState |
Det aktuella tillståndet för en privat slutpunktsanslutning |
PrivateLinkServiceConnectionState
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 |
Status för en privat slutpunktsanslutning |
PrivateLinkServiceConnectionStatus
Status för en privat slutpunktsanslutning
Värde | Description |
---|---|
Approved | |
Disconnected | |
Pending | |
Rejected |
PublicNetworkAccess
Om begäranden från offentliga nätverk tillåts
Värde | Description |
---|---|
Disabled | |
Enabled |
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.
Värde | Description |
---|---|
None | |
SystemAssigned | |
SystemAssigned, UserAssigned | |
UserAssigned |
RouteProperties
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. Grammatik finns i: 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å vägen. Namnet kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck, har en maximal längd på 64 tecken och måste vara unikt. |
source |
Den källa som routningsregeln ska tillämpas på, till exempel DeviceMessages. |
RoutingCosmosDBSqlApiProperties
Egenskaperna som är relaterade till en cosmos DB sql-containerslutpunkt.
Name | Typ | Description |
---|---|---|
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 |
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 |
Den primära nyckeln för Cosmos DB-kontot. |
resourceGroup |
string |
Namnet på resursgruppen för Cosmos DB-kontot. |
secondaryKey |
string |
Den sekundära nyckeln för Cosmos DB-kontot. |
subscriptionId |
string |
Prenumerationsidentifieraren för Cosmos DB-kontot. |
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.
Name | Typ | Description |
---|---|---|
cosmosDBSqlContainers |
Listan över Cosmos DB-containerslutpunkter som IoT Hub dirigerar meddelanden till, baserat på routningsreglerna. |
|
eventHubs |
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. |
|
serviceBusQueues |
Listan över Service Bus-köslutpunkter som IoT Hub dirigerar meddelandena till, baserat på routningsreglerna. |
|
serviceBusTopics |
Listan över Service Bus-ämnesslutpunkter som IoT-hubben dirigerar meddelandena till, baserat på routningsreglerna. |
|
storageContainers |
Listan över lagringscontainerslutpunkter som IoT Hub dirigerar meddelanden till, baserat på routningsreglerna. |
RoutingEventHubProperties
Egenskaperna som är relaterade till en händelsehubbslutpunkt.
Name | Typ | Description |
---|---|---|
authenticationType |
Metod som används för att autentisera mot händelsehubbens slutpunkt |
|
connectionString |
string |
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 |
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. |
RoutingProperties
Routningsrelaterade egenskaper för IoT-hubben. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
Name | Typ | Description |
---|---|---|
endpoints |
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 |
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 |
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. Om den här egenskapen inte finns i mallen inaktiveras återställningsvägen som standard. |
|
routes |
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
Egenskaper som är relaterade till service bus-köslutpunktstyper.
Name | Typ | Description |
---|---|---|
authenticationType |
Metod som används för att autentisera mot service bus-köslutpunkten |
|
connectionString |
string |
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 |
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
Egenskaper som är relaterade till service bus-ämnesslutpunktstyper.
Name | Typ | Description |
---|---|---|
authenticationType |
Metod som används för att autentisera mot service bus-ämnesslutpunkten |
|
connectionString |
string |
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 |
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
Den källa som routningsregeln ska tillämpas på, till exempel DeviceMessages.
Värde | Description |
---|---|
DeviceConnectionStateEvents | |
DeviceJobLifecycleEvents | |
DeviceLifecycleEvents | |
DeviceMessages | |
Invalid | |
TwinChangeEvents |
RoutingStorageContainerProperties
Egenskaperna som är relaterade till en slutpunkt för lagringscontainer.
Name | Typ | Description |
---|---|---|
authenticationType |
Metod som används för att autentisera mot lagringsslutpunkten |
|
batchFrequencyInSeconds |
integer (int32) minimum: 60maximum: 720 |
Tidsintervall med vilket blobar skrivs till lagring. Värdet ska vara mellan 60 och 720 sekunder. Standardvärdet är 300 sekunder. |
connectionString |
string |
Anslutningssträngen för lagringskontot. |
containerName |
string |
Namnet på lagringscontainern i lagringskontot. |
encoding |
enum:
|
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 |
Egenskaper för hanterad identitet för routning av lagringsslutpunkt. |
|
maxChunkSizeInBytes |
integer (int32) minimum: 10485760maximum: 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. |
SharedAccessSignatureAuthorizationRule
Egenskaperna för en princip för delad åtkomst i IoT Hub.
Name | Typ | Description |
---|---|---|
keyName |
string |
Namnet på principen för delad åtkomst. |
primaryKey |
string |
Primärnyckeln. |
rights |
De behörigheter som tilldelats principen för delad åtkomst. |
|
secondaryKey |
string |
Den sekundära nyckeln. |
StorageEndpointProperties
Egenskaperna för Azure Storage-slutpunkten för filuppladdning.
Name | Typ | Description |
---|---|---|
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 |
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
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 |
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 |
Den typ av identitet som senast ändrade resursen. |
TagsResource
En container som endast innehåller taggarna för en resurs, så att användaren kan uppdatera taggarna på en IoT Hub-instans.
Name | Typ | Description |
---|---|---|
tags |
object |
Resurstaggar |