Iot Hub Resource - Update
Aktualizace existujících značek IoT Hubs
Aktualizujte existující značky IoT Hub. Pokud chcete aktualizovat další pole, použijte metodu CreateOrUpdate.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2023-06-30
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Identifikátor skupiny prostředků. |
resource
|
path | True |
string |
Název iot Hubu, který se má aktualizovat. |
subscription
|
path | True |
string |
Identifikátor předplatného. |
api-version
|
query | True |
string |
Verze rozhraní API |
Text požadavku
Name | Typ | Description |
---|---|---|
tags |
object |
Značky prostředků |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Služba Iot Hub se úspěšně aktualizovala. |
Zabezpečení
azure_auth
Tok Azure Active Directory OAuth2
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
Name | Description |
---|---|
user_impersonation | zosobnění uživatelského účtu |
Příklady
IotHubResource_Update
Ukázkový požadavek
Ukázková odpověď
{
"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"
}
}
Definice
Name | Description |
---|---|
Access |
Oprávnění přiřazená k zásadám sdíleného přístupu. |
Arm |
|
Arm |
|
Authentication |
Určuje typ ověřování, který se používá pro připojení k účtu úložiště. |
authentication |
Metoda použitá k ověření koncového bodu fronty služby Service Bus |
Capabilities |
Možnosti a funkce povolené pro centrum IoT. |
Cloud |
Vlastnosti zasílání zpráv z cloudu do zařízení ve službě IoT Hub |
created |
Typ identity, která vytvořila prostředek. |
Default |
Výchozí akce pro sadu pravidel sítě |
Enrichment |
Vlastnosti rozšíření, které vaše centrum IoT používá pro zprávy doručované do koncových bodů. |
Event |
Vlastnosti zřízeného koncového bodu kompatibilního se službou Event Hub, který používá centrum IoT. |
Fallback |
Vlastnosti záložní trasy. IoT Hub tyto vlastnosti používá při směrování zpráv do záložního koncového bodu. |
Feedback |
Vlastnosti fronty zpětné vazby pro zprávy typu cloud-zařízení |
Iot |
Popis centra IoT. |
Iot |
Veřejná reprezentace jednoho z umístění, kde je prostředek zřízený. |
Iot |
Vlastnosti centra IoT. |
Iot |
Role oblasti může být primární nebo sekundární. Primární oblast je místo, kde je centrum IoT aktuálně zřízené. Sekundární oblastí je spárovaná oblast zotavení po havárii (DR) Azure a také oblast, do které může centrum IoT při selhání provést. |
Iot |
Název skladové položky. |
Iot |
Informace o skladové pou uzlu IoT Hubu |
Iot |
Fakturační úroveň služby IoT Hub. |
Ip |
Požadovaná akce pro požadavky zachycené tímto pravidlem |
Ip |
Pravidla filtru IP adres pro centrum IoT. |
Managed |
Vlastnosti spravované identity. |
Messaging |
Vlastnosti koncových bodů zasílání zpráv používaných tímto centrem IoT. |
Network |
Akce filtru IP adres |
Network |
Pravidlo PROTOKOLU IP, které se má použít jako součást sady pravidel sítě |
Network |
Vlastnosti sady pravidel sítě iotHubu |
Private |
Vlastnost privátního koncového bodu připojení privátního koncového bodu |
Private |
Připojení privátního koncového bodu IotHubu |
Private |
Vlastnosti připojení privátního koncového bodu |
Private |
Aktuální stav připojení privátního koncového bodu |
Private |
Stav připojení privátního koncového bodu |
Public |
Jestli jsou povolené požadavky z veřejné sítě |
Resource |
Typ identity použité pro prostředek Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity. |
Route |
Vlastnosti pravidla směrování, které vaše centrum IoT používá ke směrování zpráv do koncových bodů. |
Routing |
Vlastnosti související s koncovým bodem kontejneru SQL služby Cosmos DB |
Routing |
Vlastnosti související s vlastními koncovými body, do kterých vaše centrum IoT směruje zprávy na základě pravidel směrování. Pro placená centra je povolených maximálně 10 vlastních koncových bodů napříč všemi typy koncových bodů a pro bezplatná centra je povolený pouze 1 vlastní koncový bod. |
Routing |
Vlastnosti související s koncovým bodem centra událostí |
Routing |
Vlastnosti ioT Hubu související se směrováním Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging |
Routing |
Vlastnosti související s typy koncových bodů fronty služby Service Bus |
Routing |
Vlastnosti související s typy koncových bodů tématu služby Service Bus |
Routing |
Zdroj, na který se má pravidlo směrování použít, například DeviceMessages. |
Routing |
Vlastnosti související s koncovým bodem kontejneru úložiště |
Shared |
Vlastnosti zásad sdíleného přístupu služby IoT Hub. |
Storage |
Vlastnosti koncového bodu služby Azure Storage pro nahrání souboru. |
system |
Metadata týkající se vytvoření a poslední změny prostředku. |
Tags |
Kontejner, který obsahuje pouze značky pro prostředek, což uživateli umožňuje aktualizovat značky v instanci IoT Hub. |
AccessRights
Oprávnění přiřazená k zásadám sdíleného přístupu.
Name | Typ | Description |
---|---|---|
DeviceConnect |
string |
|
RegistryRead |
string |
|
RegistryRead, DeviceConnect |
string |
|
RegistryRead, RegistryWrite |
string |
|
RegistryRead, RegistryWrite, DeviceConnect |
string |
|
RegistryRead, RegistryWrite, ServiceConnect |
string |
|
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect |
string |
|
RegistryRead, ServiceConnect |
string |
|
RegistryRead, ServiceConnect, DeviceConnect |
string |
|
RegistryWrite |
string |
|
RegistryWrite, DeviceConnect |
string |
|
RegistryWrite, ServiceConnect |
string |
|
RegistryWrite, ServiceConnect, DeviceConnect |
string |
|
ServiceConnect |
string |
|
ServiceConnect, DeviceConnect |
string |
ArmIdentity
Name | Typ | Description |
---|---|---|
principalId |
string |
ID objektu zabezpečení |
tenantId |
string |
ID tenanta |
type |
Typ identity použitý pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity. |
|
userAssignedIdentities |
<string,
Arm |
ArmUserIdentity
Name | Typ | Description |
---|---|---|
clientId |
string |
|
principalId |
string |
AuthenticationType
Určuje typ ověřování, který se používá pro připojení k účtu úložiště.
Name | Typ | Description |
---|---|---|
identityBased |
string |
|
keyBased |
string |
authenticationType
Metoda použitá k ověření koncového bodu fronty služby Service Bus
Name | Typ | Description |
---|---|---|
identityBased |
string |
|
keyBased |
string |
Capabilities
Možnosti a funkce povolené pro centrum IoT.
Name | Typ | Description |
---|---|---|
DeviceManagement |
string |
|
None |
string |
CloudToDeviceProperties
Vlastnosti zasílání zpráv z cloudu do zařízení ve službě IoT Hub
Name | Typ | Description |
---|---|---|
defaultTtlAsIso8601 |
string |
Výchozí doba života pro zprávy cloud-zařízení ve frontě zařízení. Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
feedback |
Vlastnosti fronty zpětné vazby pro zprávy typu cloud-zařízení |
|
maxDeliveryCount |
integer |
Maximální počet doručení zpráv cloud-zařízení ve frontě zařízení Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
createdByType
Typ identity, která vytvořila prostředek.
Name | Typ | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DefaultAction
Výchozí akce pro sadu pravidel sítě
Name | Typ | Description |
---|---|---|
Allow |
string |
|
Deny |
string |
EnrichmentProperties
Vlastnosti rozšíření, které vaše centrum IoT používá pro zprávy doručované do koncových bodů.
Name | Typ | Description |
---|---|---|
endpointNames |
string[] |
Seznam koncových bodů, pro které je obohacení použito na zprávu. |
key |
string |
Klíč nebo název vlastnosti enrichment. |
value |
string |
Hodnota vlastnosti enrichment. |
EventHubProperties
Vlastnosti zřízeného koncového bodu kompatibilního se službou Event Hub, který používá centrum IoT.
Name | Typ | Description |
---|---|---|
endpoint |
string |
Koncový bod kompatibilní s centrem událostí. |
partitionCount |
integer |
Počet oddílů pro příjem zpráv typu zařízení-cloud v koncovém bodu kompatibilním s centrem událostí. Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. |
partitionIds |
string[] |
ID oddílů v koncovém bodu kompatibilním s centrem událostí. |
path |
string |
Název kompatibilní s centrem událostí. |
retentionTimeInDays |
integer |
Doba uchovávání zpráv zařízení-cloud ve dnech. Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages |
FallbackRouteProperties
Vlastnosti záložní trasy. IoT Hub tyto vlastnosti používá při směrování zpráv do záložního koncového bodu.
Name | Typ | Description |
---|---|---|
condition |
string |
Podmínka, která se vyhodnocuje, aby se použila záložní trasa. Pokud podmínka není zadá, bude ve výchozím nastavení vyhodnocena jako true. Informace o gramatice najdete tady: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language |
endpointNames |
string[] |
Seznam koncových bodů, na které jsou směrovány zprávy, které splňují podmínku. V současné době je povolený jenom 1 koncový bod. |
isEnabled |
boolean |
Slouží k určení, jestli je povolená záložní trasa. |
name |
string |
Název trasy. Název může obsahovat pouze alfanumerické znaky, tečky, podtržítka, spojovníky, maximální délku 64 znaků a musí být jedinečný. |
source |
Zdroj, na který se má pravidlo směrování použít. Například DeviceMessages |
FeedbackProperties
Vlastnosti fronty zpětné vazby pro zprávy typu cloud-zařízení
Name | Typ | Description |
---|---|---|
lockDurationAsIso8601 |
string |
Doba trvání zámku pro frontu zpětné vazby Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
maxDeliveryCount |
integer |
Kolikrát se Centrum IoT pokusí doručit zprávu ve frontě zpětné vazby. Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
ttlAsIso8601 |
string |
Doba, po kterou je zpráva k dispozici, než vyprší platnost služby IoT Hub. Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
IotHubDescription
Popis centra IoT.
Name | Typ | Description |
---|---|---|
etag |
string |
Pole Etag není povinné. Pokud je uvedený v textu odpovědi, musí být také uvedený jako hlavička podle normální konvence ETag. |
id |
string |
Identifikátor prostředku. |
identity |
Spravované identity pro IotHub |
|
location |
string |
Umístění prostředku. |
name |
string |
Název prostředku. |
properties |
Vlastnosti IotHubu |
|
sku |
Informace o skladové pou sadě IotHub |
|
systemData |
Metadata systému vztahující se k tomuto prostředku. |
|
tags |
object |
Značky prostředků. |
type |
string |
Typ prostředku. |
IotHubLocationDescription
Veřejná reprezentace jednoho z umístění, kde je prostředek zřízený.
Name | Typ | Description |
---|---|---|
location |
string |
Název oblasti Azure |
role |
Role oblasti může být primární nebo sekundární. Primární oblast je místo, kde je centrum IoT aktuálně zřízené. Sekundární oblastí je spárovaná oblast zotavení po havárii (DR) Azure a také oblast, do které může centrum IoT při selhání provést. |
IotHubProperties
Vlastnosti centra IoT.
Name | Typ | Description |
---|---|---|
allowedFqdnList |
string[] |
Seznam povolených plně kvalifikovaných názvů domén (plně kvalifikovaný název domény) pro výchozí přenos dat ze služby Iot Hub |
authorizationPolicies |
Zásady sdíleného přístupu, které můžete použít k zabezpečení připojení k centru IoT. |
|
cloudToDevice |
Vlastnosti zasílání zpráv cloud-zařízení ve službě IoT Hub |
|
comments |
string |
Komentáře služby IoT Hub. |
disableDeviceSAS |
boolean |
Pokud je hodnota true, všechna zařízení (včetně hraničních zařízení, ale s výjimkou modulů) klíče SAS s vymezeným oborem se nedají použít k ověřování. |
disableLocalAuth |
boolean |
Pokud je hodnota true, tokeny SAS s klíči SAS v oboru služby IoT Hub není možné k ověřování použít. |
disableModuleSAS |
boolean |
Pokud je hodnota true, nedají se k ověřování použít všechny klíče SAS s oborem modulu. |
enableDataResidency |
boolean |
Pokud je tato vlastnost nastavená na hodnotu true, povolí rezidenci dat, a tím zakáže zotavení po havárii. |
enableFileUploadNotifications |
boolean |
Pokud má hodnotu True, oznámení o nahrání souboru jsou povolená. |
eventHubEndpoints |
<string,
Event |
Vlastnosti koncového bodu kompatibilního s centrem událostí Jediným možným klíčem k tomuto slovníku jsou události. Tento klíč musí být ve slovníku při vytváření nebo aktualizačních voláních centra IoT. |
features |
Možnosti a funkce povolené pro službu IoT Hub. |
|
hostName |
string |
Název hostitele |
ipFilterRules |
Pravidla filtru IP adres. |
|
locations |
Primární a sekundární umístění pro ioT Hub |
|
messagingEndpoints |
<string,
Messaging |
Vlastnosti koncového bodu zasílání zpráv pro frontu oznámení o nahrání souboru. |
minTlsVersion |
string |
Určuje minimální verzi protokolu TLS, která se má pro toto centrum podporovat. Můžete nastavit na 1.2, aby klienti, kteří používají protokol TLS verze nižší než 1.2, mohli být odmítnuti. |
networkRuleSets |
Vlastnosti sady pravidel sítě iotHubu |
|
privateEndpointConnections |
Připojení privátních koncových bodů vytvořená na tomto IotHubu |
|
provisioningState |
string |
Stav zřizování. |
publicNetworkAccess |
Jestli jsou povolené požadavky z veřejné sítě |
|
restrictOutboundNetworkAccess |
boolean |
Pokud je hodnota true, bude výchozí přenos dat z IotHubu omezený jenom na povolené plně kvalifikované názvy domén nakonfigurované prostřednictvím seznamu allowedFqdnList. |
routing |
Vlastnosti ioT Hubu související se směrováním Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging |
|
state |
string |
Stav centra. |
storageEndpoints |
<string,
Storage |
Seznam koncových bodů služby Azure Storage, do kterých můžete nahrávat soubory. V současné době můžete nakonfigurovat pouze jeden účet služby Azure Storage, který musí mít svůj klíč jako $default. Zadání více než jednoho účtu úložiště způsobí chybu. Nezadání hodnoty pro tuto vlastnost, pokud je vlastnost enableFileUploadNotifications nastavena na hodnotu True, způsobí vyvolání chyby. |
IotHubReplicaRoleType
Role oblasti může být primární nebo sekundární. Primární oblast je místo, kde je centrum IoT aktuálně zřízené. Sekundární oblastí je spárovaná oblast zotavení po havárii (DR) Azure a také oblast, do které může centrum IoT při selhání provést.
Name | Typ | Description |
---|---|---|
primary |
string |
|
secondary |
string |
IotHubSku
Název skladové položky.
Name | Typ | Description |
---|---|---|
B1 |
string |
|
B2 |
string |
|
B3 |
string |
|
F1 |
string |
|
S1 |
string |
|
S2 |
string |
|
S3 |
string |
IotHubSkuInfo
Informace o skladové pou uzlu IoT Hubu
Name | Typ | Description |
---|---|---|
capacity |
integer |
Počet zřízených jednotek IoT Hub. Viz: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. |
name |
Název skladové položky. |
|
tier |
Fakturační úroveň pro centrum IoT. |
IotHubSkuTier
Fakturační úroveň služby IoT Hub.
Name | Typ | Description |
---|---|---|
Basic |
string |
|
Free |
string |
|
Standard |
string |
IpFilterActionType
Požadovaná akce pro požadavky zachycené tímto pravidlem
Name | Typ | Description |
---|---|---|
Accept |
string |
|
Reject |
string |
IpFilterRule
Pravidla filtru IP adres pro centrum IoT.
Name | Typ | Description |
---|---|---|
action |
Požadovaná akce pro požadavky zachycené tímto pravidlem |
|
filterName |
string |
Název pravidla filtru IP adres. |
ipMask |
string |
Řetězec, který obsahuje rozsah IP adres v zápisu CIDR pro pravidlo. |
ManagedIdentity
Vlastnosti spravované identity.
Name | Typ | Description |
---|---|---|
userAssignedIdentity |
string |
Identita přiřazená uživatelem. |
MessagingEndpointProperties
Vlastnosti koncových bodů zasílání zpráv používaných tímto centrem IoT.
Name | Typ | Description |
---|---|---|
lockDurationAsIso8601 |
string |
Doba trvání zámku. Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
maxDeliveryCount |
integer |
Kolikrát se Centrum IoT pokusí doručit zprávu. Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
ttlAsIso8601 |
string |
Doba, po kterou je zpráva k dispozici, než vyprší platnost služby IoT Hub. Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
NetworkRuleIPAction
Akce filtru IP adres
Name | Typ | Description |
---|---|---|
Allow |
string |
NetworkRuleSetIpRule
Pravidlo PROTOKOLU IP, které se má použít jako součást sady pravidel sítě
Name | Typ | Default value | Description |
---|---|---|---|
action | Allow |
Akce filtru IP adres |
|
filterName |
string |
Název pravidla filtru IP adres. |
|
ipMask |
string |
Řetězec, který obsahuje rozsah IP adres v zápisu CIDR pro pravidlo. |
NetworkRuleSetProperties
Vlastnosti sady pravidel sítě iotHubu
Name | Typ | Default value | Description |
---|---|---|---|
applyToBuiltInEventHubEndpoint |
boolean |
Pokud je true, pak se sada pravidel sítě použije také na builtIn EventHub EndPoint iotHubu. |
|
defaultAction | Deny |
Výchozí akce pro sadu pravidel sítě |
|
ipRules |
Seznam pravidel IP adres |
PrivateEndpoint
Vlastnost privátního koncového bodu připojení privátního koncového bodu
Name | Typ | Description |
---|---|---|
id |
string |
Identifikátor prostředku. |
PrivateEndpointConnection
Připojení privátního koncového bodu IotHubu
Name | Typ | Description |
---|---|---|
id |
string |
Identifikátor prostředku. |
name |
string |
Název prostředku. |
properties |
Vlastnosti připojení privátního koncového bodu |
|
type |
string |
Typ prostředku. |
PrivateEndpointConnectionProperties
Vlastnosti připojení privátního koncového bodu
Name | Typ | Description |
---|---|---|
privateEndpoint |
Vlastnost privátního koncového bodu připojení privátního koncového bodu |
|
privateLinkServiceConnectionState |
Aktuální stav připojení privátního koncového bodu |
PrivateLinkServiceConnectionState
Aktuální stav připojení privátního koncového bodu
Name | Typ | Description |
---|---|---|
actionsRequired |
string |
Akce vyžadované pro připojení privátního koncového bodu |
description |
string |
Popis aktuálního stavu připojení privátního koncového bodu |
status |
Stav připojení privátního koncového bodu |
PrivateLinkServiceConnectionStatus
Stav připojení privátního koncového bodu
Name | Typ | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PublicNetworkAccess
Jestli jsou povolené požadavky z veřejné sítě
Name | Typ | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ResourceIdentityType
Typ identity použité pro prostředek Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity.
Name | Typ | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
RouteProperties
Vlastnosti pravidla směrování, které vaše centrum IoT používá ke směrování zpráv do koncových bodů.
Name | Typ | Description |
---|---|---|
condition |
string |
Podmínka, která je vyhodnocena pro použití pravidla směrování. Pokud není zadá žádná podmínka, ve výchozím nastavení se vyhodnotí jako true. Informace o gramatice najdete tady: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language |
endpointNames |
string[] |
Seznam koncových bodů, na které jsou směrovány zprávy, které splňují podmínku. V současné době je povolený jenom jeden koncový bod. |
isEnabled |
boolean |
Slouží k určení, jestli je povolená trasa. |
name |
string |
Název trasy. Název může obsahovat pouze alfanumerické znaky, tečky, podtržítka, spojovníky, maximální délku 64 znaků a musí být jedinečný. |
source |
Zdroj, na který se má pravidlo směrování použít, například DeviceMessages. |
RoutingCosmosDBSqlApiProperties
Vlastnosti související s koncovým bodem kontejneru SQL služby Cosmos DB
Name | Typ | Description |
---|---|---|
authenticationType |
Metoda použitá k ověření ve koncovém bodu kontejneru SQL služby Cosmos DB |
|
containerName |
string |
Název kontejneru SQL cosmos DB v databázi cosmos DB. |
databaseName |
string |
Název databáze cosmos DB v účtu služby Cosmos DB. |
endpointUri |
string |
Adresa URL účtu služby Cosmos DB. Musí obsahovat protokol https:// |
id |
string |
ID koncového bodu kontejneru SQL služby Cosmos DB |
identity |
Vlastnosti spravované identity směrování koncového bodu kontejneru cosmos DB |
|
name |
string |
Název, který identifikuje tento koncový bod. Název může obsahovat pouze alfanumerické znaky, tečky, podtržítka, spojovníky a má maximální délku 64 znaků. Tyto názvy jsou vyhrazené: events, fileNotifications $default. Názvy koncových bodů musí být jedinečné napříč typy koncových bodů. |
partitionKeyName |
string |
Název klíče oddílu přidruženého k tomuto kontejneru SQL cosmos DB, pokud existuje. Jedná se o volitelný parametr. |
partitionKeyTemplate |
string |
Šablona pro vygenerování hodnoty syntetického klíče oddílu pro použití s tímto kontejnerem SQL cosmos DB. Šablona musí obsahovat alespoň jeden z následujících zástupných symbolů: {iothub}, {deviceid}, {DD}, {MM} a {YYYY}. Libovolný zástupný symbol může být zadán maximálně najednou, ale komponenty pořadí a jiné než zástupné symboly jsou libovolné. Tento parametr je povinný pouze v případě, že je zadán Název_oddílu. |
primaryKey |
string |
Primární klíč účtu služby Cosmos DB. |
resourceGroup |
string |
Název skupiny prostředků účtu služby Cosmos DB. |
secondaryKey |
string |
Sekundární klíč účtu služby Cosmos DB. |
subscriptionId |
string |
Identifikátor předplatného účtu služby Cosmos DB. |
RoutingEndpoints
Vlastnosti související s vlastními koncovými body, do kterých vaše centrum IoT směruje zprávy na základě pravidel směrování. Pro placená centra je povolených maximálně 10 vlastních koncových bodů napříč všemi typy koncových bodů a pro bezplatná centra je povolený pouze 1 vlastní koncový bod.
Name | Typ | Description |
---|---|---|
cosmosDBSqlContainers |
Seznam koncových bodů kontejneru Cosmos DB, do kterého IoT Hub směruje zprávy na základě pravidel směrování. |
|
eventHubs |
Seznam koncových bodů služby Event Hubs, do kterého IoT Hub směruje zprávy na základě pravidel směrování. Tento seznam neobsahuje integrovaný koncový bod služby Event Hubs. |
|
serviceBusQueues |
Seznam koncových bodů fronty služby Service Bus, do kterého IoT Hub směruje zprávy na základě pravidel směrování. |
|
serviceBusTopics |
Seznam koncových bodů témat služby Service Bus, do kterého ioT Hub směruje zprávy na základě pravidel směrování. |
|
storageContainers |
Seznam koncových bodů kontejneru úložiště, do kterého IoT Hub směruje zprávy na základě pravidel směrování. |
RoutingEventHubProperties
Vlastnosti související s koncovým bodem centra událostí
Name | Typ | Description |
---|---|---|
authenticationType |
Metoda použitá k ověření v koncovém bodu centra událostí |
|
connectionString |
string |
Připojovací řetězec koncového bodu centra událostí. |
endpointUri |
string |
Adresa URL koncového bodu centra událostí. Musí obsahovat protokol sb:// |
entityPath |
string |
Název centra událostí v oboru názvů centra událostí |
id |
string |
ID koncového bodu centra událostí |
identity |
Vlastnosti spravované identity koncového bodu centra událostí směrování |
|
name |
string |
Název, který identifikuje tento koncový bod. Název může obsahovat pouze alfanumerické znaky, tečky, podtržítka, spojovníky a má maximální délku 64 znaků. Tyto názvy jsou vyhrazené: events, fileNotifications $default. Názvy koncových bodů musí být jedinečné napříč typy koncových bodů. |
resourceGroup |
string |
Název skupiny prostředků koncového bodu centra událostí. |
subscriptionId |
string |
Identifikátor předplatného koncového bodu centra událostí. |
RoutingProperties
Vlastnosti ioT Hubu související se směrováním Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
Name | Typ | Description |
---|---|---|
endpoints |
Vlastnosti související s vlastními koncovými body, do kterých vaše centrum IoT směruje zprávy na základě pravidel směrování. Pro placená centra je povolených maximálně 10 vlastních koncových bodů napříč všemi typy koncových bodů a pro bezplatná centra je povolen pouze 1 vlastní koncový bod. |
|
enrichments |
Seznam rozšíření poskytovaných uživatelem, který ioT Hub aplikuje na zprávy, které se mají doručovat do předdefinovaných a vlastních koncových bodů. Viz: https://aka.ms/telemetryoneventgrid |
|
fallbackRoute |
Vlastnosti trasy, která se používá jako náhradní trasa, pokud není splněna žádná z podmínek zadaných v oddílu "trasy". Jedná se o volitelný parametr. Pokud tato vlastnost není v šabloně k dispozici, je záložní trasa ve výchozím nastavení zakázaná. |
|
routes |
Seznam uživatelsky zadaných pravidel směrování, která služba IoT Hub používá ke směrování zpráv do předdefinovaných a vlastních koncových bodů. Pro placená centra je povoleno maximálně 100 pravidel směrování a pro bezplatná centra maximálně 5 pravidel směrování. |
RoutingServiceBusQueueEndpointProperties
Vlastnosti související s typy koncových bodů fronty služby Service Bus
Name | Typ | Description |
---|---|---|
authenticationType |
Metoda použitá k ověření koncového bodu fronty služby Service Bus |
|
connectionString |
string |
Připojovací řetězec koncového bodu fronty služby Service Bus. |
endpointUri |
string |
Adresa URL koncového bodu fronty služby Service Bus Musí obsahovat protokol sb:// |
entityPath |
string |
Název fronty v oboru názvů služby Service Bus |
id |
string |
ID koncového bodu fronty služby Service Bus |
identity |
Vlastnosti spravované identity koncového bodu fronty služby Service Bus. |
|
name |
string |
Název, který identifikuje tento koncový bod. Název může obsahovat pouze alfanumerické znaky, tečky, podtržítka, spojovníky a má maximální délku 64 znaků. Tyto názvy jsou vyhrazené: events, fileNotifications $default. Názvy koncových bodů musí být jedinečné napříč typy koncových bodů. Název nemusí být stejný jako skutečný název fronty. |
resourceGroup |
string |
Název skupiny prostředků koncového bodu fronty služby Service Bus. |
subscriptionId |
string |
Identifikátor předplatného koncového bodu fronty služby Service Bus. |
RoutingServiceBusTopicEndpointProperties
Vlastnosti související s typy koncových bodů tématu služby Service Bus
Name | Typ | Description |
---|---|---|
authenticationType |
Metoda použitá k ověření v koncovém bodu tématu služby Service Bus |
|
connectionString |
string |
Připojovací řetězec koncového bodu tématu služby Service Bus. |
endpointUri |
string |
Adresa URL koncového bodu tématu služby Service Bus. Musí obsahovat protokol sb:// |
entityPath |
string |
Název fronty v tématu služby Service Bus |
id |
string |
ID koncového bodu tématu služby Service Bus |
identity |
Vlastnosti spravované identity koncového bodu tématu služby Service Bus. |
|
name |
string |
Název, který identifikuje tento koncový bod. Název může obsahovat pouze alfanumerické znaky, tečky, podtržítka, spojovníky a má maximální délku 64 znaků. Tyto názvy jsou vyhrazené: events, fileNotifications $default. Názvy koncových bodů musí být jedinečné napříč typy koncových bodů. Název nemusí být stejný jako skutečný název tématu. |
resourceGroup |
string |
Název skupiny prostředků koncového bodu tématu služby Service Bus. |
subscriptionId |
string |
Identifikátor předplatného koncového bodu tématu služby Service Bus. |
RoutingSource
Zdroj, na který se má pravidlo směrování použít, například DeviceMessages.
Name | Typ | Description |
---|---|---|
DeviceConnectionStateEvents |
string |
|
DeviceJobLifecycleEvents |
string |
|
DeviceLifecycleEvents |
string |
|
DeviceMessages |
string |
|
Invalid |
string |
|
TwinChangeEvents |
string |
RoutingStorageContainerProperties
Vlastnosti související s koncovým bodem kontejneru úložiště
Name | Typ | Description |
---|---|---|
authenticationType |
Metoda použitá k ověření vůči koncovému bodu úložiště |
|
batchFrequencyInSeconds |
integer |
Časový interval, ve kterém se objekty blob zapisují do úložiště. Hodnota by měla být mezi 60 a 720 sekund. Výchozí hodnota je 300 sekund. |
connectionString |
string |
Připojovací řetězec účtu úložiště. |
containerName |
string |
Název kontejneru úložiště v účtu úložiště. |
encoding |
enum:
|
Kódování, které se používá k serializaci zpráv do objektů blob. Podporované hodnoty jsou avro, avrodeflate a JSON. Výchozí hodnota je avro. |
endpointUri |
string |
Adresa URL koncového bodu úložiště. Musí obsahovat protokol https:// |
fileNameFormat |
string |
Formát názvu souboru pro objekt blob Výchozí formát je {iothub}/{partition}/{RRRR}/{MM}/{DD}/{HH}/{mm}. Všechny parametry jsou povinné, ale je možné je změnit. |
id |
string |
ID koncového bodu kontejneru úložiště |
identity |
Vlastnosti spravované identity koncového bodu úložiště směrování |
|
maxChunkSizeInBytes |
integer |
Maximální počet bajtů pro každý objekt blob zapsaný do úložiště Hodnota by měla být mezi 10485760(10 MB) a 524288000(500 MB). Výchozí hodnota je 314572800(300 MB). |
name |
string |
Název, který identifikuje tento koncový bod. Název může obsahovat pouze alfanumerické znaky, tečky, podtržítka, spojovníky a má maximální délku 64 znaků. Tyto názvy jsou vyhrazené: events, fileNotifications $default. Názvy koncových bodů musí být jedinečné napříč typy koncových bodů. |
resourceGroup |
string |
Název skupiny prostředků účtu úložiště. |
subscriptionId |
string |
Identifikátor předplatného účtu úložiště. |
SharedAccessSignatureAuthorizationRule
Vlastnosti zásad sdíleného přístupu služby IoT Hub.
Name | Typ | Description |
---|---|---|
keyName |
string |
Název zásady sdíleného přístupu. |
primaryKey |
string |
Primární klíč. |
rights |
Oprávnění přiřazená k zásadám sdíleného přístupu. |
|
secondaryKey |
string |
Sekundární klíč. |
StorageEndpointProperties
Vlastnosti koncového bodu služby Azure Storage pro nahrání souboru.
Name | Typ | Description |
---|---|---|
authenticationType |
Určuje typ ověřování, který se používá pro připojení k účtu úložiště. |
|
connectionString |
string |
Připojovací řetězec pro účet Služby Azure Storage, do kterého se soubory nahrávají. |
containerName |
string |
Název kořenového kontejneru, do kterého nahráváte soubory. Kontejner nemusí existovat, ale měl by být vytvořitelný pomocí zadaného připojovacího řetězce. |
identity |
Vlastnosti spravované identity koncového bodu úložiště pro nahrání souboru |
|
sasTtlAsIso8601 |
string |
Doba, po kterou identifikátor URI SAS vygenerovaný IoT Hub pro nahrání souboru, je platná. Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. |
systemData
Metadata týkající se vytvoření a poslední změny prostředku.
Name | Typ | Description |
---|---|---|
createdAt |
string |
Časové razítko vytvoření prostředku (UTC) |
createdBy |
string |
Identita, která vytvořila prostředek. |
createdByType |
Typ identity, která prostředek vytvořila. |
|
lastModifiedAt |
string |
Časové razítko poslední změny prostředku (UTC) |
lastModifiedBy |
string |
Identita, která naposledy změnila prostředek. |
lastModifiedByType |
Typ identity, která naposledy změnila prostředek. |
TagsResource
Kontejner, který obsahuje pouze značky pro prostředek, což uživateli umožňuje aktualizovat značky v instanci IoT Hub.
Name | Typ | Description |
---|---|---|
tags |
object |
Značky prostředků |