Microsoft.Devices IotHubs 2021-07-01
- nejnovější
- 30. 6. 2023
- 30. 6. 2023 ve verzi Preview
- 11. 11. 2022 ve verzi Preview
- 2022-04-30-preview
- 2021-07-02
- 2021-07-02-preview
- 2021-07-01
- 2021-07-01-preview
- 31. 31. 2021
- 2021-03-03-preview
- 2021-021-01-Preview
- 2020-08-31
- 2020-08-31-preview
- 2020-08-01
- 2020-07-10-preview
- 1 5. 6. 2020
- 04.04.2020
- 2020-03-01
- 11. 11. 2019
- 2019-07-01-Preview
- 2019-03-22
- 22. 3. 2019 ve verzi Preview
- 12. 12. 2018 ve verzi Preview
- 04.04.2018
- 2 2. 1. 2018
- 07.2017
- 19. 10. 2017
- 2016-02-03
Definice prostředku Bicep
Typ prostředku IotHubs je možné nasadit s operacemi, které cílí:
- skupiny prostředků – viz příkazy nasazení skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.Devices/IotHubs, přidejte do šablony následující bicep.
resource symbolicname 'Microsoft.Devices/IotHubs@2021-07-01' = {
etag: 'string'
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
allowedFqdnList: [
'string'
]
authorizationPolicies: [
{
keyName: 'string'
primaryKey: 'string'
rights: 'string'
secondaryKey: 'string'
}
]
cloudToDevice: {
defaultTtlAsIso8601: 'string'
feedback: {
lockDurationAsIso8601: 'string'
maxDeliveryCount: int
ttlAsIso8601: 'string'
}
maxDeliveryCount: int
}
comments: 'string'
disableDeviceSAS: bool
disableLocalAuth: bool
disableModuleSAS: bool
enableFileUploadNotifications: bool
eventHubEndpoints: {
{customized property}: {
partitionCount: int
retentionTimeInDays: int
}
}
features: 'string'
ipFilterRules: [
{
action: 'string'
filterName: 'string'
ipMask: 'string'
}
]
messagingEndpoints: {
{customized property}: {
lockDurationAsIso8601: 'string'
maxDeliveryCount: int
ttlAsIso8601: 'string'
}
}
minTlsVersion: 'string'
networkRuleSets: {
applyToBuiltInEventHubEndpoint: bool
defaultAction: 'string'
ipRules: [
{
action: 'string'
filterName: 'string'
ipMask: 'string'
}
]
}
privateEndpointConnections: [
{
properties: {
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
]
publicNetworkAccess: 'string'
restrictOutboundNetworkAccess: bool
routing: {
endpoints: {
eventHubs: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
serviceBusQueues: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
serviceBusTopics: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
storageContainers: [
{
authenticationType: 'string'
batchFrequencyInSeconds: int
connectionString: 'string'
containerName: 'string'
encoding: 'string'
endpointUri: 'string'
fileNameFormat: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
maxChunkSizeInBytes: int
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
}
enrichments: [
{
endpointNames: [
'string'
]
key: 'string'
value: 'string'
}
]
fallbackRoute: {
condition: 'string'
endpointNames: [
'string'
]
isEnabled: bool
name: 'string'
source: 'string'
}
routes: [
{
condition: 'string'
endpointNames: [
'string'
]
isEnabled: bool
name: 'string'
source: 'string'
}
]
}
storageEndpoints: {
{customized property}: {
authenticationType: 'string'
connectionString: 'string'
containerName: 'string'
identity: {
userAssignedIdentity: 'string'
}
sasTtlAsIso8601: 'string'
}
}
}
sku: {
capacity: int
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Hodnoty vlastností
ArmIdentity
| Jméno | Popis | Hodnota |
|---|---|---|
| typ | Typ identity používané 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. | None (Žádný) SystemAssigned SystemAssigned, UserAssigned UserAssigned |
| userAssignedIdentities | Slovník <ArmUserIdentity> | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
| Jméno | Popis | Hodnota |
|---|
ArmUserIdentity
| Jméno | Popis | Hodnota |
|---|
CloudToDeviceProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| defaultTtlAsIso8601 | Výchozí doba pro živé zprávy typu cloud-zařízení ve frontě zařízení. Viz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | řetězec |
| zpětná vazba | Vlastnosti fronty zpětné vazby pro zprávy typu cloud-zařízení | FeedbackProperties |
| maxDeliveryCount | Maximální počet doručení zpráv typu cloud-zařízení ve frontě zařízení. Viz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Omezení: Minimální hodnota = 1 Maximální hodnota = 100 |
EnrichmentProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| endpointNames | Seznamkoncovýchch | string[] (povinné) |
| klíč | Klíč nebo název vlastnosti rozšiřování. | string (povinné) |
| hodnota | Hodnota vlastnosti rozšiřování. | string (povinné) |
EventHubProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| partitionCount | Počet oddílů pro příjem zpráv typu zařízení-cloud v koncovém bodu kompatibilním s centrem událostí. Viz: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | Int |
| retentionTimeInDays | Doba uchovávání zpráv typu zařízení-cloud ve dnech. Viz: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | Int |
Náhradní objektyRouteProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| podmínka | Podmínka, která se vyhodnocuje, aby se použila náhradní trasa. Pokud podmínka není za předpokladu, že se ve výchozím nastavení vyhodnotí jako true. Gramatika: /azure/iot-hub/iot-hub-devguide-query-language | řetězec |
| endpointNames | Seznam koncových bodů, do kterých jsou směrovány zprávy, které splňují podmínku. Aktuálně je povolený jenom 1 koncový bod. | string[] (povinné) |
| isEnabled | Slouží k určení, jestli je povolená náhradní trasa. | bool (povinné) |
| Jméno | Název trasy. Název může obsahovat pouze alfanumerické znaky, tečky, podtržítka, pomlčky, maximální délku 64 znaků a musí být jedinečný. | řetězec |
| zdroj | Zdroj, na který se má pravidlo směrování použít. Například DeviceMessages | DeviceConnectionStateEvents DeviceJobLifecycleEvents 'DeviceLifecycleEvents' DeviceMessages Neplatné TwinChangeEvents (povinné) |
FeedbackProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| lockDurationAsIso8601 | Doba trvání uzamčení fronty zpětné vazby. Viz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | řetězec |
| maxDeliveryCount | Počet pokusů centra IoT o doručení zprávy do fronty zpětné vazby Viz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Omezení: Minimální hodnota = 1 Maximální hodnota = 100 |
| ttlAsIso8601 | Doba, po kterou je zpráva k dispozici, než jí vyprší platnost centra IoT. Viz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | řetězec |
IotHubProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| allowedFqdnList | 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 | string[] |
| authorizationPolicies | Zásady sdíleného přístupu, které můžete použít k zabezpečení připojení k centru IoT. | SharedAccessSignatureAuthorizationRule[] |
| cloudToDevice | Vlastnosti zasílání zpráv typu cloud-zařízení ve službě IoT Hub | CloudToDeviceProperties |
| komentáře | Komentáře ke službě IoT Hub | řetězec |
| disableDeviceSAS | Pokud je hodnota true, všechna zařízení (včetně zařízení Edge, ale s výjimkou modulů) s vymezeným oborem SAS se nedají použít k ověřování. | Bool |
| disableLocalAuth | Pokud je pravda, tokeny SAS s klíči SAS s vymezeným oborem služby Iot Hub se nedají použít k ověřování. | Bool |
| disableModuleSAS | Pokud je pravda, nelze pro ověřování použít všechny klíče SAS s vymezeným oborem modulu. | Bool |
| enableFileUploadNotifications | Pokud je true, oznámení o nahrání souboru jsou povolená. | Bool |
| eventHubEndpoints | Vlastnosti koncového bodu kompatibilního s centrem událostí. Jediným možnými klíči tohoto slovníku jsou události. Tento klíč musí být ve slovníku k dispozici při vytváření nebo aktualizaci volání ioT Hubu. | IotHubPropertiesEventHubEndpoints |
| rysy | Možnosti a funkce povolené pro Centrum IoT. | DeviceManagement None (Žádný) |
| ipFilterRules | Pravidla filtru IP adres. | IpFilterRule[] |
| messagingEndpoints | Vlastnosti koncového bodu zasílání zpráv pro frontu oznámení pro nahrání souboru. | IotHubPropertiesMessagingEndpoints |
| minTlsVersion | 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 odmítnout. | řetězec |
| networkRuleSets | Vlastnosti sady pravidel sítě iotHubu | NetworkRuleSetProperties |
| privateEndpointConnections | Připojení privátního koncového bodu vytvořená na tomto IotHubu | PrivateEndpointConnection[] |
| publicNetworkAccess | Jestli jsou povolené požadavky z veřejné sítě | Zakázáno Povoleno |
| restrictOutboundNetworkAccess | Pokud ano, výchozí přenos dat z IotHubu se omezí jenom na povolené plně kvalifikované názvy domén nakonfigurované přes allowedFqdnList. | Bool |
| směrování | Vlastnosti související se směrováním centra IoT. Viz: /azure/iot-hub/iot-hub-devguide-messaging | routingProperties |
| storageEndpoints | Seznam koncových bodů služby Azure Storage, kde můžete nahrávat soubory. V současné době můžete nakonfigurovat jenom jeden účet Azure Storage a tento klíč musí mít jako $default. Zadání více než jednoho účtu úložiště způsobí vyvolání chyby. Nezadávejte hodnotu pro tuto vlastnost, pokud je vlastnost enableFileUploadNotifications nastavena na Hodnotu True, způsobí vyvolání chyby. | IotHubPropertiesStorageEndpoints |
IotHubPropertiesEventHubEndpoints
| Jméno | Popis | Hodnota |
|---|
IotHubPropertiesMessagingEndpoints
| Jméno | Popis | Hodnota |
|---|
IotHubPropertiesStorageEndpoints
| Jméno | Popis | Hodnota |
|---|
IotHubSkuInfo
| Jméno | Popis | Hodnota |
|---|---|---|
| kapacita | Počet zřízených jednotek IoT Hubu. Viz: /azure/azure-subscription-service-limits#iot-hub-limits. | Int |
| Jméno | Název skladové položky. | "B1" "B2" "B3" "F1" S1 S2 S3 (povinné) |
IpFilterRule
| Jméno | Popis | Hodnota |
|---|---|---|
| akce | Požadovaná akce pro požadavky zachycené tímto pravidlem. | Přijmout Odmítnout (povinné) |
| filterName | Název pravidla filtru IP adres. | string (povinné) |
| ipMask | Řetězec, který obsahuje rozsah IP adres v zápisu CIDR pravidla. | string (povinné) |
ManagedIdentity
| Jméno | Popis | Hodnota |
|---|---|---|
| userAssignedIdentity | Identita přiřazená uživatelem. | řetězec |
MessagingEndpointProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| lockDurationAsIso8601 | Doba trvání zámku. Viz: /azure/iot-hub/iot-hub-devguide-file-upload. | řetězec |
| maxDeliveryCount | Počet pokusů o doručení zprávy službou IoT Hub Viz: /azure/iot-hub/iot-hub-devguide-file-upload. | Int Omezení: Minimální hodnota = 1 Maximální hodnota = 100 |
| ttlAsIso8601 | Doba, po kterou je zpráva k dispozici, než jí vyprší platnost centra IoT. Viz: /azure/iot-hub/iot-hub-devguide-file-upload. | řetězec |
Microsoft.Devices/IotHubs
| Jméno | Popis | Hodnota |
|---|---|---|
| etag | Pole Etag není povinné. Pokud je uvedený v textu odpovědi, musí se také poskytnout jako hlavička podle normální konvence značky ETag. | řetězec |
| identita | Spravované identity pro IotHub. | ArmIdentity |
| umístění | Umístění prostředku. | string (povinné) |
| Jméno | Název prostředku | string (povinné) |
| vlastnosti | Vlastnosti IotHubu | IotHubProperties |
| sku | Informace o skladové posílce IotHubu | IotHubSkuInfo (povinné) |
| visačky | Značky prostředků | Slovník názvů a hodnot značek Viz Značky v šablonách |
NetworkRuleSetIpRule
| Jméno | Popis | Hodnota |
|---|---|---|
| akce | Akce filtru IP adres | Povolit |
| filterName | Název pravidla filtru IP adres. | string (povinné) |
| ipMask | Řetězec, který obsahuje rozsah IP adres v zápisu CIDR pravidla. | string (povinné) |
NetworkRuleSetProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| applyToBuiltInEventHubEndpoint | Pokud je hodnota True, použije se sada pravidel sítě také u koncového bodu BuiltIn EventHubu iotHubu. | bool (povinné) |
| defaultAction | Výchozí akce pro sadu pravidel sítě | Povolit "Odepřít" |
| IpRules | Seznam pravidel PROTOKOLU IP | NetworkRuleSetIpRule[] (povinné) |
PrivateEndpoint
| Jméno | Popis | Hodnota |
|---|
PrivateEndpointConnection
| Jméno | Popis | Hodnota |
|---|---|---|
| vlastnosti | Vlastnosti připojení privátního koncového bodu | privateEndpointConnectionProperties (povinné) |
PrivateEndpointConnectionProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| privateEndpoint | Vlastnost privátního koncového bodu připojení privátního koncového bodu | PrivateEndpoint |
| privateLinkServiceConnectionState | Aktuální stav připojení privátního koncového bodu | PrivateLinkServiceConnectionState (povinné) |
PrivateLinkServiceConnectionState
| Jméno | Popis | Hodnota |
|---|---|---|
| ActionsRequired | Akce vyžadované pro připojení privátního koncového bodu | řetězec |
| popis | Popis aktuálního stavu připojení privátního koncového bodu | string (povinné) |
| stav | Stav připojení privátního koncového bodu | "Schváleno" Odpojeno Čeká na vyřízení Odmítnuto (povinné) |
Značky prostředků
| Jméno | Popis | Hodnota |
|---|
RouteProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| podmínka | Podmínka, která se vyhodnotí jako použití pravidla směrování. Pokud není zadanou podmínkou, vyhodnotí se ve výchozím nastavení jako true. Gramatiku najdete v tématu: /azure/iot-hub/iot-hub-devguide-query-language | řetězec |
| endpointNames | Seznam koncových bodů, do kterých se směrují zprávy, které splňují podmínku. Aktuálně je povolený jenom jeden koncový bod. | string[] (povinné) |
| isEnabled | Slouží k určení, jestli je povolená trasa. | bool (povinné) |
| Jméno | Název trasy. Název může obsahovat pouze alfanumerické znaky, tečky, podtržítka, pomlčky, maximální délku 64 znaků a musí být jedinečný. | řetězec Omezení: Model = ^[A-Za-z0-9-._]{1,64}$ (povinné) |
| zdroj | Zdroj, na který se má pravidlo směrování použít, například DeviceMessages. | DeviceConnectionStateEvents DeviceJobLifecycleEvents 'DeviceLifecycleEvents' DeviceMessages Neplatné TwinChangeEvents (povinné) |
RoutingEndpoints
| Jméno | Popis | Hodnota |
|---|---|---|
| eventHubs | Seznam koncových bodů služby Event Hubs, do které Služba IoT Hub směruje zprávy na základě pravidel směrování. Tento seznam neobsahuje integrovaný koncový bod služby Event Hubs. | RoutingEventHubProperties[] |
| serviceBusQueues | Seznam koncových bodů fronty služby Service Bus, do které Služba IoT Hub směruje zprávy na základě pravidel směrování. | RoutingServiceBusQueueEndpointProperties[] |
| serviceBusTopics | Seznam koncových bodů tématu služby Service Bus, do které centrum IoT směruje zprávy na základě pravidel směrování. | RoutingServiceBusTopicEndpointProperties[] |
| storageContainers | Seznam koncovýchbodůch | RoutingStorageContainerProperties[] |
RoutingEventHubProperties
RoutingProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| Koncové body | 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é rozbočovače je povolených maximálně 10 vlastních koncových bodů a pro bezplatná centra je povolený pouze 1 vlastní koncový bod. | RoutingEndpoints |
| obohacení | Seznam rozšíření poskytovaných uživatelem, které centrum IoT používá pro zprávy, které se mají doručovat do integrovaných a vlastních koncových bodů. Viz: https://aka.ms/telemetryoneventgrid | EnrichmentProperties[] |
| náhradníroute | Vlastnosti trasy, která se používá jako náhradní trasa, pokud nejsou splněny žádné podmínky zadané v části trasy. Jedná se o volitelný parametr. Pokud tato vlastnost není nastavená, zprávy, které nesplňují žádné podmínky zadané v části trasy, se směrují do integrovaného koncového bodu centra událostí. | fallbackRouteProperties |
| trasy | Seznam pravidel směrování poskytovaných uživatelem, která ioT Hub používá ke směrování zpráv do předdefinovaných a vlastních koncových bodů. Pro placené rozbočovače je povoleno maximálně 100 pravidel směrování a pro bezplatná centra jsou povolená maximálně 5 pravidel směrování. | RouteProperties[] |
RoutingServiceBusQueueEndpointProperties
RoutingServiceBusTopicEndpointProperties
RoutingStorageContainerProperties
SharedAccessSignatureAuthorizationRule
| Jméno | Popis | Hodnota |
|---|---|---|
| keyName | Název zásady sdíleného přístupu. | string (povinné) |
| primaryKey | Primární klíč. | řetězec |
| práva | Oprávnění přiřazená k zásadám sdíleného přístupu. | DeviceConnect RegistrRead 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 (povinné) |
| secondaryKey | Sekundární klíč. | řetězec |
StorageEndpointProperties
Příklady použití
Ukázky rychlého startu Azure
Následující šablony Azure pro rychlý start obsahují ukázky Bicep pro nasazení tohoto typu prostředku.
| Soubor Bicep | Popis |
|---|---|
| vytvoření ioT Hubu a zařízení do skupiny cloudových příjemců | Tato šablona umožňuje nasadit instanci ioT Hubu se zařízením do cloudu a cloudu do konfigurací zasílání zpráv zařízení a zařízení do skupiny příjemců cloudu. |
| vytvoření služby IoT Hub Device Provisioning | Tato šablona umožňuje vytvořit centrum IoT a službu IoT Hub Device Provisioning a propojit obě služby. |
| vytvoření účtu služby Device Update pro ioT Hub, instanci, službu IoT Hub | Tato šablona vytvoří účet a instanci a centrum pro propojení instance s touto instancí. Nakonfiguruje centrum s potřebnými zásadami přístupu, trasami a skupinou příjemců. |
| nasazení služby MedTech, včetně služby Azure IoT Hub | Služba MedTech je jednou ze služeb Azure Health Data Services navržená tak, aby ingestovala data zařízení z více zařízení, transformovala data zařízení na pozorování FHIR, která se pak uchovávají ve službě FHIR služby Azure Health Data Services. |
| Vytvoření služby IoT Hub, směrování a zobrazení zpráv pomocí šablony ARM | Pomocí této šablony můžete nasadit IoT Hub a účet úložiště. Spuštěním aplikace odešlete zprávy do centra, které je směrováno do úložiště, a zobrazte výsledky. |
Definice prostředku šablony ARM
Typ prostředku IotHubs je možné nasadit s operacemi, které cílí:
- skupiny prostředků – viz příkazy nasazení skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.Devices/IotHubs, přidejte do šablony následující JSON.
{
"type": "Microsoft.Devices/IotHubs",
"apiVersion": "2021-07-01",
"name": "string",
"etag": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"allowedFqdnList": [ "string" ],
"authorizationPolicies": [
{
"keyName": "string",
"primaryKey": "string",
"rights": "string",
"secondaryKey": "string"
}
],
"cloudToDevice": {
"defaultTtlAsIso8601": "string",
"feedback": {
"lockDurationAsIso8601": "string",
"maxDeliveryCount": "int",
"ttlAsIso8601": "string"
},
"maxDeliveryCount": "int"
},
"comments": "string",
"disableDeviceSAS": "bool",
"disableLocalAuth": "bool",
"disableModuleSAS": "bool",
"enableFileUploadNotifications": "bool",
"eventHubEndpoints": {
"{customized property}": {
"partitionCount": "int",
"retentionTimeInDays": "int"
}
},
"features": "string",
"ipFilterRules": [
{
"action": "string",
"filterName": "string",
"ipMask": "string"
}
],
"messagingEndpoints": {
"{customized property}": {
"lockDurationAsIso8601": "string",
"maxDeliveryCount": "int",
"ttlAsIso8601": "string"
}
},
"minTlsVersion": "string",
"networkRuleSets": {
"applyToBuiltInEventHubEndpoint": "bool",
"defaultAction": "string",
"ipRules": [
{
"action": "string",
"filterName": "string",
"ipMask": "string"
}
]
},
"privateEndpointConnections": [
{
"properties": {
"privateEndpoint": {
},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
],
"publicNetworkAccess": "string",
"restrictOutboundNetworkAccess": "bool",
"routing": {
"endpoints": {
"eventHubs": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"serviceBusQueues": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"serviceBusTopics": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"storageContainers": [
{
"authenticationType": "string",
"batchFrequencyInSeconds": "int",
"connectionString": "string",
"containerName": "string",
"encoding": "string",
"endpointUri": "string",
"fileNameFormat": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"maxChunkSizeInBytes": "int",
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
]
},
"enrichments": [
{
"endpointNames": [ "string" ],
"key": "string",
"value": "string"
}
],
"fallbackRoute": {
"condition": "string",
"endpointNames": [ "string" ],
"isEnabled": "bool",
"name": "string",
"source": "string"
},
"routes": [
{
"condition": "string",
"endpointNames": [ "string" ],
"isEnabled": "bool",
"name": "string",
"source": "string"
}
]
},
"storageEndpoints": {
"{customized property}": {
"authenticationType": "string",
"connectionString": "string",
"containerName": "string",
"identity": {
"userAssignedIdentity": "string"
},
"sasTtlAsIso8601": "string"
}
}
},
"sku": {
"capacity": "int",
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Hodnoty vlastností
ArmIdentity
| Jméno | Popis | Hodnota |
|---|---|---|
| typ | Typ identity používané 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. | None (Žádný) SystemAssigned SystemAssigned, UserAssigned UserAssigned |
| userAssignedIdentities | Slovník <ArmUserIdentity> | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
| Jméno | Popis | Hodnota |
|---|
ArmUserIdentity
| Jméno | Popis | Hodnota |
|---|
CloudToDeviceProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| defaultTtlAsIso8601 | Výchozí doba pro živé zprávy typu cloud-zařízení ve frontě zařízení. Viz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | řetězec |
| zpětná vazba | Vlastnosti fronty zpětné vazby pro zprávy typu cloud-zařízení | FeedbackProperties |
| maxDeliveryCount | Maximální počet doručení zpráv typu cloud-zařízení ve frontě zařízení. Viz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Omezení: Minimální hodnota = 1 Maximální hodnota = 100 |
EnrichmentProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| endpointNames | Seznamkoncovýchch | string[] (povinné) |
| klíč | Klíč nebo název vlastnosti rozšiřování. | string (povinné) |
| hodnota | Hodnota vlastnosti rozšiřování. | string (povinné) |
EventHubProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| partitionCount | Počet oddílů pro příjem zpráv typu zařízení-cloud v koncovém bodu kompatibilním s centrem událostí. Viz: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | Int |
| retentionTimeInDays | Doba uchovávání zpráv typu zařízení-cloud ve dnech. Viz: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | Int |
Náhradní objektyRouteProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| podmínka | Podmínka, která se vyhodnocuje, aby se použila náhradní trasa. Pokud podmínka není za předpokladu, že se ve výchozím nastavení vyhodnotí jako true. Gramatika: /azure/iot-hub/iot-hub-devguide-query-language | řetězec |
| endpointNames | Seznam koncových bodů, do kterých jsou směrovány zprávy, které splňují podmínku. Aktuálně je povolený jenom 1 koncový bod. | string[] (povinné) |
| isEnabled | Slouží k určení, jestli je povolená náhradní trasa. | bool (povinné) |
| Jméno | Název trasy. Název může obsahovat pouze alfanumerické znaky, tečky, podtržítka, pomlčky, maximální délku 64 znaků a musí být jedinečný. | řetězec |
| zdroj | Zdroj, na který se má pravidlo směrování použít. Například DeviceMessages | DeviceConnectionStateEvents DeviceJobLifecycleEvents 'DeviceLifecycleEvents' DeviceMessages Neplatné TwinChangeEvents (povinné) |
FeedbackProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| lockDurationAsIso8601 | Doba trvání uzamčení fronty zpětné vazby. Viz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | řetězec |
| maxDeliveryCount | Počet pokusů centra IoT o doručení zprávy do fronty zpětné vazby Viz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Omezení: Minimální hodnota = 1 Maximální hodnota = 100 |
| ttlAsIso8601 | Doba, po kterou je zpráva k dispozici, než jí vyprší platnost centra IoT. Viz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | řetězec |
IotHubProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| allowedFqdnList | 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 | string[] |
| authorizationPolicies | Zásady sdíleného přístupu, které můžete použít k zabezpečení připojení k centru IoT. | SharedAccessSignatureAuthorizationRule[] |
| cloudToDevice | Vlastnosti zasílání zpráv typu cloud-zařízení ve službě IoT Hub | CloudToDeviceProperties |
| komentáře | Komentáře ke službě IoT Hub | řetězec |
| disableDeviceSAS | Pokud je hodnota true, všechna zařízení (včetně zařízení Edge, ale s výjimkou modulů) s vymezeným oborem SAS se nedají použít k ověřování. | Bool |
| disableLocalAuth | Pokud je pravda, tokeny SAS s klíči SAS s vymezeným oborem služby Iot Hub se nedají použít k ověřování. | Bool |
| disableModuleSAS | Pokud je pravda, nelze pro ověřování použít všechny klíče SAS s vymezeným oborem modulu. | Bool |
| enableFileUploadNotifications | Pokud je true, oznámení o nahrání souboru jsou povolená. | Bool |
| eventHubEndpoints | Vlastnosti koncového bodu kompatibilního s centrem událostí. Jediným možnými klíči tohoto slovníku jsou události. Tento klíč musí být ve slovníku k dispozici při vytváření nebo aktualizaci volání ioT Hubu. | IotHubPropertiesEventHubEndpoints |
| rysy | Možnosti a funkce povolené pro Centrum IoT. | DeviceManagement None (Žádný) |
| ipFilterRules | Pravidla filtru IP adres. | IpFilterRule[] |
| messagingEndpoints | Vlastnosti koncového bodu zasílání zpráv pro frontu oznámení pro nahrání souboru. | IotHubPropertiesMessagingEndpoints |
| minTlsVersion | 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 odmítnout. | řetězec |
| networkRuleSets | Vlastnosti sady pravidel sítě iotHubu | NetworkRuleSetProperties |
| privateEndpointConnections | Připojení privátního koncového bodu vytvořená na tomto IotHubu | PrivateEndpointConnection[] |
| publicNetworkAccess | Jestli jsou povolené požadavky z veřejné sítě | Zakázáno Povoleno |
| restrictOutboundNetworkAccess | Pokud ano, výchozí přenos dat z IotHubu se omezí jenom na povolené plně kvalifikované názvy domén nakonfigurované přes allowedFqdnList. | Bool |
| směrování | Vlastnosti související se směrováním centra IoT. Viz: /azure/iot-hub/iot-hub-devguide-messaging | routingProperties |
| storageEndpoints | Seznam koncových bodů služby Azure Storage, kde můžete nahrávat soubory. V současné době můžete nakonfigurovat jenom jeden účet Azure Storage a tento klíč musí mít jako $default. Zadání více než jednoho účtu úložiště způsobí vyvolání chyby. Nezadávejte hodnotu pro tuto vlastnost, pokud je vlastnost enableFileUploadNotifications nastavena na Hodnotu True, způsobí vyvolání chyby. | IotHubPropertiesStorageEndpoints |
IotHubPropertiesEventHubEndpoints
| Jméno | Popis | Hodnota |
|---|
IotHubPropertiesMessagingEndpoints
| Jméno | Popis | Hodnota |
|---|
IotHubPropertiesStorageEndpoints
| Jméno | Popis | Hodnota |
|---|
IotHubSkuInfo
| Jméno | Popis | Hodnota |
|---|---|---|
| kapacita | Počet zřízených jednotek IoT Hubu. Viz: /azure/azure-subscription-service-limits#iot-hub-limits. | Int |
| Jméno | Název skladové položky. | "B1" "B2" "B3" "F1" S1 S2 S3 (povinné) |
IpFilterRule
| Jméno | Popis | Hodnota |
|---|---|---|
| akce | Požadovaná akce pro požadavky zachycené tímto pravidlem. | Přijmout Odmítnout (povinné) |
| filterName | Název pravidla filtru IP adres. | string (povinné) |
| ipMask | Řetězec, který obsahuje rozsah IP adres v zápisu CIDR pravidla. | string (povinné) |
ManagedIdentity
| Jméno | Popis | Hodnota |
|---|---|---|
| userAssignedIdentity | Identita přiřazená uživatelem. | řetězec |
MessagingEndpointProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| lockDurationAsIso8601 | Doba trvání zámku. Viz: /azure/iot-hub/iot-hub-devguide-file-upload. | řetězec |
| maxDeliveryCount | Počet pokusů o doručení zprávy službou IoT Hub Viz: /azure/iot-hub/iot-hub-devguide-file-upload. | Int Omezení: Minimální hodnota = 1 Maximální hodnota = 100 |
| ttlAsIso8601 | Doba, po kterou je zpráva k dispozici, než jí vyprší platnost centra IoT. Viz: /azure/iot-hub/iot-hub-devguide-file-upload. | řetězec |
Microsoft.Devices/IotHubs
| Jméno | Popis | Hodnota |
|---|---|---|
| apiVersion | Verze rozhraní API | '2021-07-01' |
| etag | Pole Etag není povinné. Pokud je uvedený v textu odpovědi, musí se také poskytnout jako hlavička podle normální konvence značky ETag. | řetězec |
| identita | Spravované identity pro IotHub. | ArmIdentity |
| umístění | Umístění prostředku. | string (povinné) |
| Jméno | Název prostředku | string (povinné) |
| vlastnosti | Vlastnosti IotHubu | IotHubProperties |
| sku | Informace o skladové posílce IotHubu | IotHubSkuInfo (povinné) |
| visačky | Značky prostředků | Slovník názvů a hodnot značek Viz Značky v šablonách |
| typ | Typ prostředku | Microsoft.Devices/IotHubs |
NetworkRuleSetIpRule
| Jméno | Popis | Hodnota |
|---|---|---|
| akce | Akce filtru IP adres | Povolit |
| filterName | Název pravidla filtru IP adres. | string (povinné) |
| ipMask | Řetězec, který obsahuje rozsah IP adres v zápisu CIDR pravidla. | string (povinné) |
NetworkRuleSetProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| applyToBuiltInEventHubEndpoint | Pokud je hodnota True, použije se sada pravidel sítě také u koncového bodu BuiltIn EventHubu iotHubu. | bool (povinné) |
| defaultAction | Výchozí akce pro sadu pravidel sítě | Povolit "Odepřít" |
| IpRules | Seznam pravidel PROTOKOLU IP | NetworkRuleSetIpRule[] (povinné) |
PrivateEndpoint
| Jméno | Popis | Hodnota |
|---|
PrivateEndpointConnection
| Jméno | Popis | Hodnota |
|---|---|---|
| vlastnosti | Vlastnosti připojení privátního koncového bodu | privateEndpointConnectionProperties (povinné) |
PrivateEndpointConnectionProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| privateEndpoint | Vlastnost privátního koncového bodu připojení privátního koncového bodu | PrivateEndpoint |
| privateLinkServiceConnectionState | Aktuální stav připojení privátního koncového bodu | PrivateLinkServiceConnectionState (povinné) |
PrivateLinkServiceConnectionState
| Jméno | Popis | Hodnota |
|---|---|---|
| ActionsRequired | Akce vyžadované pro připojení privátního koncového bodu | řetězec |
| popis | Popis aktuálního stavu připojení privátního koncového bodu | string (povinné) |
| stav | Stav připojení privátního koncového bodu | "Schváleno" Odpojeno Čeká na vyřízení Odmítnuto (povinné) |
Značky prostředků
| Jméno | Popis | Hodnota |
|---|
RouteProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| podmínka | Podmínka, která se vyhodnotí jako použití pravidla směrování. Pokud není zadanou podmínkou, vyhodnotí se ve výchozím nastavení jako true. Gramatiku najdete v tématu: /azure/iot-hub/iot-hub-devguide-query-language | řetězec |
| endpointNames | Seznam koncových bodů, do kterých se směrují zprávy, které splňují podmínku. Aktuálně je povolený jenom jeden koncový bod. | string[] (povinné) |
| isEnabled | Slouží k určení, jestli je povolená trasa. | bool (povinné) |
| Jméno | Název trasy. Název může obsahovat pouze alfanumerické znaky, tečky, podtržítka, pomlčky, maximální délku 64 znaků a musí být jedinečný. | řetězec Omezení: Model = ^[A-Za-z0-9-._]{1,64}$ (povinné) |
| zdroj | Zdroj, na který se má pravidlo směrování použít, například DeviceMessages. | DeviceConnectionStateEvents DeviceJobLifecycleEvents 'DeviceLifecycleEvents' DeviceMessages Neplatné TwinChangeEvents (povinné) |
RoutingEndpoints
| Jméno | Popis | Hodnota |
|---|---|---|
| eventHubs | Seznam koncových bodů služby Event Hubs, do které Služba IoT Hub směruje zprávy na základě pravidel směrování. Tento seznam neobsahuje integrovaný koncový bod služby Event Hubs. | RoutingEventHubProperties[] |
| serviceBusQueues | Seznam koncových bodů fronty služby Service Bus, do které Služba IoT Hub směruje zprávy na základě pravidel směrování. | RoutingServiceBusQueueEndpointProperties[] |
| serviceBusTopics | Seznam koncových bodů tématu služby Service Bus, do které centrum IoT směruje zprávy na základě pravidel směrování. | RoutingServiceBusTopicEndpointProperties[] |
| storageContainers | Seznam koncovýchbodůch | RoutingStorageContainerProperties[] |
RoutingEventHubProperties
RoutingProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| Koncové body | 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é rozbočovače je povolených maximálně 10 vlastních koncových bodů a pro bezplatná centra je povolený pouze 1 vlastní koncový bod. | RoutingEndpoints |
| obohacení | Seznam rozšíření poskytovaných uživatelem, které centrum IoT používá pro zprávy, které se mají doručovat do integrovaných a vlastních koncových bodů. Viz: https://aka.ms/telemetryoneventgrid | EnrichmentProperties[] |
| náhradníroute | Vlastnosti trasy, která se používá jako náhradní trasa, pokud nejsou splněny žádné podmínky zadané v části trasy. Jedná se o volitelný parametr. Pokud tato vlastnost není nastavená, zprávy, které nesplňují žádné podmínky zadané v části trasy, se směrují do integrovaného koncového bodu centra událostí. | fallbackRouteProperties |
| trasy | Seznam pravidel směrování poskytovaných uživatelem, která ioT Hub používá ke směrování zpráv do předdefinovaných a vlastních koncových bodů. Pro placené rozbočovače je povoleno maximálně 100 pravidel směrování a pro bezplatná centra jsou povolená maximálně 5 pravidel směrování. | RouteProperties[] |
RoutingServiceBusQueueEndpointProperties
RoutingServiceBusTopicEndpointProperties
RoutingStorageContainerProperties
SharedAccessSignatureAuthorizationRule
| Jméno | Popis | Hodnota |
|---|---|---|
| keyName | Název zásady sdíleného přístupu. | string (povinné) |
| primaryKey | Primární klíč. | řetězec |
| práva | Oprávnění přiřazená k zásadám sdíleného přístupu. | DeviceConnect RegistrRead 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 (povinné) |
| secondaryKey | Sekundární klíč. | řetězec |
StorageEndpointProperties
Příklady použití
Šablony azure pro rychlý start
Následující šablony Azure Pro rychlý start nasadit tento typ prostředku.
| Šablona | Popis |
|---|---|
|
vytvoření prostředí s průběžnými platbami (PAYG) pomocí IoT Hubu nasazení  |
Tato šablona umožňuje nasadit prostředí Time Series Insights s průběžnou platbou (Pay As You Go), které je nakonfigurované pro využívání událostí ze služby IoT Hub. |
|
vytvoření ioT Hubu a zařízení do skupiny cloudových příjemců nasazení |
Tato šablona umožňuje nasadit instanci ioT Hubu se zařízením do cloudu a cloudu do konfigurací zasílání zpráv zařízení a zařízení do skupiny příjemců cloudu. |
|
vytvoření simulátoru IOT Hub a Ubuntu Edge nasazení |
Tato šablona vytvoří simulátor ioT Hubu a hraničního simulátoru Ubuntu virtuálního počítače. |
|
vytvoření služby IoT Hub Device Provisioning nasazení |
Tato šablona umožňuje vytvořit centrum IoT a službu IoT Hub Device Provisioning a propojit obě služby. |
|
vytvoření účtu služby Device Update pro ioT Hub, instanci, službu IoT Hub nasazení |
Tato šablona vytvoří účet a instanci a centrum pro propojení instance s touto instancí. Nakonfiguruje centrum s potřebnými zásadami přístupu, trasami a skupinou příjemců. |
|
nasazení služby MedTech, včetně služby Azure IoT Hub nasazení |
Služba MedTech je jednou ze služeb Azure Health Data Services navržená tak, aby ingestovala data zařízení z více zařízení, transformovala data zařízení na pozorování FHIR, která se pak uchovávají ve službě FHIR služby Azure Health Data Services. |
|
Vytvoření služby IoT Hub, směrování a zobrazení zpráv pomocí šablony ARM nasazení |
Pomocí této šablony můžete nasadit IoT Hub a účet úložiště. Spuštěním aplikace odešlete zprávy do centra, které je směrováno do úložiště, a zobrazte výsledky. |
Definice prostředku Terraformu (poskytovatel AzAPI)
Typ prostředku IotHubs je možné nasadit s operacemi, které cílí:
- skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.Devices/IotHubs, přidejte do šablony následující Terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Devices/IotHubs@2021-07-01"
name = "string"
etag = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
sku = {
capacity = int
name = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
allowedFqdnList = [
"string"
]
authorizationPolicies = [
{
keyName = "string"
primaryKey = "string"
rights = "string"
secondaryKey = "string"
}
]
cloudToDevice = {
defaultTtlAsIso8601 = "string"
feedback = {
lockDurationAsIso8601 = "string"
maxDeliveryCount = int
ttlAsIso8601 = "string"
}
maxDeliveryCount = int
}
comments = "string"
disableDeviceSAS = bool
disableLocalAuth = bool
disableModuleSAS = bool
enableFileUploadNotifications = bool
eventHubEndpoints = {
{customized property} = {
partitionCount = int
retentionTimeInDays = int
}
}
features = "string"
ipFilterRules = [
{
action = "string"
filterName = "string"
ipMask = "string"
}
]
messagingEndpoints = {
{customized property} = {
lockDurationAsIso8601 = "string"
maxDeliveryCount = int
ttlAsIso8601 = "string"
}
}
minTlsVersion = "string"
networkRuleSets = {
applyToBuiltInEventHubEndpoint = bool
defaultAction = "string"
ipRules = [
{
action = "string"
filterName = "string"
ipMask = "string"
}
]
}
privateEndpointConnections = [
{
properties = {
privateEndpoint = {
}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
}
]
publicNetworkAccess = "string"
restrictOutboundNetworkAccess = bool
routing = {
endpoints = {
eventHubs = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
serviceBusQueues = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
serviceBusTopics = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
storageContainers = [
{
authenticationType = "string"
batchFrequencyInSeconds = int
connectionString = "string"
containerName = "string"
encoding = "string"
endpointUri = "string"
fileNameFormat = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
maxChunkSizeInBytes = int
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
}
enrichments = [
{
endpointNames = [
"string"
]
key = "string"
value = "string"
}
]
fallbackRoute = {
condition = "string"
endpointNames = [
"string"
]
isEnabled = bool
name = "string"
source = "string"
}
routes = [
{
condition = "string"
endpointNames = [
"string"
]
isEnabled = bool
name = "string"
source = "string"
}
]
}
storageEndpoints = {
{customized property} = {
authenticationType = "string"
connectionString = "string"
containerName = "string"
identity = {
userAssignedIdentity = "string"
}
sasTtlAsIso8601 = "string"
}
}
}
})
}
Hodnoty vlastností
ArmIdentity
| Jméno | Popis | Hodnota |
|---|---|---|
| typ | Typ identity používané 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. | None (Žádný) SystemAssigned SystemAssigned, UserAssigned UserAssigned |
| userAssignedIdentities | Slovník <ArmUserIdentity> | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
| Jméno | Popis | Hodnota |
|---|
ArmUserIdentity
| Jméno | Popis | Hodnota |
|---|
CloudToDeviceProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| defaultTtlAsIso8601 | Výchozí doba pro živé zprávy typu cloud-zařízení ve frontě zařízení. Viz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | řetězec |
| zpětná vazba | Vlastnosti fronty zpětné vazby pro zprávy typu cloud-zařízení | FeedbackProperties |
| maxDeliveryCount | Maximální počet doručení zpráv typu cloud-zařízení ve frontě zařízení. Viz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Omezení: Minimální hodnota = 1 Maximální hodnota = 100 |
EnrichmentProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| endpointNames | Seznamkoncovýchch | string[] (povinné) |
| klíč | Klíč nebo název vlastnosti rozšiřování. | string (povinné) |
| hodnota | Hodnota vlastnosti rozšiřování. | string (povinné) |
EventHubProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| partitionCount | Počet oddílů pro příjem zpráv typu zařízení-cloud v koncovém bodu kompatibilním s centrem událostí. Viz: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | Int |
| retentionTimeInDays | Doba uchovávání zpráv typu zařízení-cloud ve dnech. Viz: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | Int |
Náhradní objektyRouteProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| podmínka | Podmínka, která se vyhodnocuje, aby se použila náhradní trasa. Pokud podmínka není za předpokladu, že se ve výchozím nastavení vyhodnotí jako true. Gramatika: /azure/iot-hub/iot-hub-devguide-query-language | řetězec |
| endpointNames | Seznam koncových bodů, do kterých jsou směrovány zprávy, které splňují podmínku. Aktuálně je povolený jenom 1 koncový bod. | string[] (povinné) |
| isEnabled | Slouží k určení, jestli je povolená náhradní trasa. | bool (povinné) |
| Jméno | Název trasy. Název může obsahovat pouze alfanumerické znaky, tečky, podtržítka, pomlčky, maximální délku 64 znaků a musí být jedinečný. | řetězec |
| zdroj | Zdroj, na který se má pravidlo směrování použít. Například DeviceMessages | DeviceConnectionStateEvents DeviceJobLifecycleEvents 'DeviceLifecycleEvents' DeviceMessages Neplatné TwinChangeEvents (povinné) |
FeedbackProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| lockDurationAsIso8601 | Doba trvání uzamčení fronty zpětné vazby. Viz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | řetězec |
| maxDeliveryCount | Počet pokusů centra IoT o doručení zprávy do fronty zpětné vazby Viz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Omezení: Minimální hodnota = 1 Maximální hodnota = 100 |
| ttlAsIso8601 | Doba, po kterou je zpráva k dispozici, než jí vyprší platnost centra IoT. Viz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | řetězec |
IotHubProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| allowedFqdnList | 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 | string[] |
| authorizationPolicies | Zásady sdíleného přístupu, které můžete použít k zabezpečení připojení k centru IoT. | SharedAccessSignatureAuthorizationRule[] |
| cloudToDevice | Vlastnosti zasílání zpráv typu cloud-zařízení ve službě IoT Hub | CloudToDeviceProperties |
| komentáře | Komentáře ke službě IoT Hub | řetězec |
| disableDeviceSAS | Pokud je hodnota true, všechna zařízení (včetně zařízení Edge, ale s výjimkou modulů) s vymezeným oborem SAS se nedají použít k ověřování. | Bool |
| disableLocalAuth | Pokud je pravda, tokeny SAS s klíči SAS s vymezeným oborem služby Iot Hub se nedají použít k ověřování. | Bool |
| disableModuleSAS | Pokud je pravda, nelze pro ověřování použít všechny klíče SAS s vymezeným oborem modulu. | Bool |
| enableFileUploadNotifications | Pokud je true, oznámení o nahrání souboru jsou povolená. | Bool |
| eventHubEndpoints | Vlastnosti koncového bodu kompatibilního s centrem událostí. Jediným možnými klíči tohoto slovníku jsou události. Tento klíč musí být ve slovníku k dispozici při vytváření nebo aktualizaci volání ioT Hubu. | IotHubPropertiesEventHubEndpoints |
| rysy | Možnosti a funkce povolené pro Centrum IoT. | DeviceManagement None (Žádný) |
| ipFilterRules | Pravidla filtru IP adres. | IpFilterRule[] |
| messagingEndpoints | Vlastnosti koncového bodu zasílání zpráv pro frontu oznámení pro nahrání souboru. | IotHubPropertiesMessagingEndpoints |
| minTlsVersion | 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 odmítnout. | řetězec |
| networkRuleSets | Vlastnosti sady pravidel sítě iotHubu | NetworkRuleSetProperties |
| privateEndpointConnections | Připojení privátního koncového bodu vytvořená na tomto IotHubu | PrivateEndpointConnection[] |
| publicNetworkAccess | Jestli jsou povolené požadavky z veřejné sítě | Zakázáno Povoleno |
| restrictOutboundNetworkAccess | Pokud ano, výchozí přenos dat z IotHubu se omezí jenom na povolené plně kvalifikované názvy domén nakonfigurované přes allowedFqdnList. | Bool |
| směrování | Vlastnosti související se směrováním centra IoT. Viz: /azure/iot-hub/iot-hub-devguide-messaging | routingProperties |
| storageEndpoints | Seznam koncových bodů služby Azure Storage, kde můžete nahrávat soubory. V současné době můžete nakonfigurovat jenom jeden účet Azure Storage a tento klíč musí mít jako $default. Zadání více než jednoho účtu úložiště způsobí vyvolání chyby. Nezadávejte hodnotu pro tuto vlastnost, pokud je vlastnost enableFileUploadNotifications nastavena na Hodnotu True, způsobí vyvolání chyby. | IotHubPropertiesStorageEndpoints |
IotHubPropertiesEventHubEndpoints
| Jméno | Popis | Hodnota |
|---|
IotHubPropertiesMessagingEndpoints
| Jméno | Popis | Hodnota |
|---|
IotHubPropertiesStorageEndpoints
| Jméno | Popis | Hodnota |
|---|
IotHubSkuInfo
| Jméno | Popis | Hodnota |
|---|---|---|
| kapacita | Počet zřízených jednotek IoT Hubu. Viz: /azure/azure-subscription-service-limits#iot-hub-limits. | Int |
| Jméno | Název skladové položky. | "B1" "B2" "B3" "F1" S1 S2 S3 (povinné) |
IpFilterRule
| Jméno | Popis | Hodnota |
|---|---|---|
| akce | Požadovaná akce pro požadavky zachycené tímto pravidlem. | Přijmout Odmítnout (povinné) |
| filterName | Název pravidla filtru IP adres. | string (povinné) |
| ipMask | Řetězec, který obsahuje rozsah IP adres v zápisu CIDR pravidla. | string (povinné) |
ManagedIdentity
| Jméno | Popis | Hodnota |
|---|---|---|
| userAssignedIdentity | Identita přiřazená uživatelem. | řetězec |
MessagingEndpointProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| lockDurationAsIso8601 | Doba trvání zámku. Viz: /azure/iot-hub/iot-hub-devguide-file-upload. | řetězec |
| maxDeliveryCount | Počet pokusů o doručení zprávy službou IoT Hub Viz: /azure/iot-hub/iot-hub-devguide-file-upload. | Int Omezení: Minimální hodnota = 1 Maximální hodnota = 100 |
| ttlAsIso8601 | Doba, po kterou je zpráva k dispozici, než jí vyprší platnost centra IoT. Viz: /azure/iot-hub/iot-hub-devguide-file-upload. | řetězec |
Microsoft.Devices/IotHubs
| Jméno | Popis | Hodnota |
|---|---|---|
| etag | Pole Etag není povinné. Pokud je uvedený v textu odpovědi, musí se také poskytnout jako hlavička podle normální konvence značky ETag. | řetězec |
| identita | Spravované identity pro IotHub. | ArmIdentity |
| umístění | Umístění prostředku. | string (povinné) |
| Jméno | Název prostředku | string (povinné) |
| vlastnosti | Vlastnosti IotHubu | IotHubProperties |
| sku | Informace o skladové posílce IotHubu | IotHubSkuInfo (povinné) |
| visačky | Značky prostředků | Slovník názvů a hodnot značek |
| typ | Typ prostředku | "Microsoft.Devices/IotHubs@2021-07-01" |
NetworkRuleSetIpRule
| Jméno | Popis | Hodnota |
|---|---|---|
| akce | Akce filtru IP adres | Povolit |
| filterName | Název pravidla filtru IP adres. | string (povinné) |
| ipMask | Řetězec, který obsahuje rozsah IP adres v zápisu CIDR pravidla. | string (povinné) |
NetworkRuleSetProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| applyToBuiltInEventHubEndpoint | Pokud je hodnota True, použije se sada pravidel sítě také u koncového bodu BuiltIn EventHubu iotHubu. | bool (povinné) |
| defaultAction | Výchozí akce pro sadu pravidel sítě | Povolit "Odepřít" |
| IpRules | Seznam pravidel PROTOKOLU IP | NetworkRuleSetIpRule[] (povinné) |
PrivateEndpoint
| Jméno | Popis | Hodnota |
|---|
PrivateEndpointConnection
| Jméno | Popis | Hodnota |
|---|---|---|
| vlastnosti | Vlastnosti připojení privátního koncového bodu | privateEndpointConnectionProperties (povinné) |
PrivateEndpointConnectionProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| privateEndpoint | Vlastnost privátního koncového bodu připojení privátního koncového bodu | PrivateEndpoint |
| privateLinkServiceConnectionState | Aktuální stav připojení privátního koncového bodu | PrivateLinkServiceConnectionState (povinné) |
PrivateLinkServiceConnectionState
| Jméno | Popis | Hodnota |
|---|---|---|
| ActionsRequired | Akce vyžadované pro připojení privátního koncového bodu | řetězec |
| popis | Popis aktuálního stavu připojení privátního koncového bodu | string (povinné) |
| stav | Stav připojení privátního koncového bodu | "Schváleno" Odpojeno Čeká na vyřízení Odmítnuto (povinné) |
Značky prostředků
| Jméno | Popis | Hodnota |
|---|
RouteProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| podmínka | Podmínka, která se vyhodnotí jako použití pravidla směrování. Pokud není zadanou podmínkou, vyhodnotí se ve výchozím nastavení jako true. Gramatiku najdete v tématu: /azure/iot-hub/iot-hub-devguide-query-language | řetězec |
| endpointNames | Seznam koncových bodů, do kterých se směrují zprávy, které splňují podmínku. Aktuálně je povolený jenom jeden koncový bod. | string[] (povinné) |
| isEnabled | Slouží k určení, jestli je povolená trasa. | bool (povinné) |
| Jméno | Název trasy. Název může obsahovat pouze alfanumerické znaky, tečky, podtržítka, pomlčky, maximální délku 64 znaků a musí být jedinečný. | řetězec Omezení: Model = ^[A-Za-z0-9-._]{1,64}$ (povinné) |
| zdroj | Zdroj, na který se má pravidlo směrování použít, například DeviceMessages. | DeviceConnectionStateEvents DeviceJobLifecycleEvents 'DeviceLifecycleEvents' DeviceMessages Neplatné TwinChangeEvents (povinné) |
RoutingEndpoints
| Jméno | Popis | Hodnota |
|---|---|---|
| eventHubs | Seznam koncových bodů služby Event Hubs, do které Služba IoT Hub směruje zprávy na základě pravidel směrování. Tento seznam neobsahuje integrovaný koncový bod služby Event Hubs. | RoutingEventHubProperties[] |
| serviceBusQueues | Seznam koncových bodů fronty služby Service Bus, do které Služba IoT Hub směruje zprávy na základě pravidel směrování. | RoutingServiceBusQueueEndpointProperties[] |
| serviceBusTopics | Seznam koncových bodů tématu služby Service Bus, do které centrum IoT směruje zprávy na základě pravidel směrování. | RoutingServiceBusTopicEndpointProperties[] |
| storageContainers | Seznam koncovýchbodůch | RoutingStorageContainerProperties[] |
RoutingEventHubProperties
RoutingProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| Koncové body | 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é rozbočovače je povolených maximálně 10 vlastních koncových bodů a pro bezplatná centra je povolený pouze 1 vlastní koncový bod. | RoutingEndpoints |
| obohacení | Seznam rozšíření poskytovaných uživatelem, které centrum IoT používá pro zprávy, které se mají doručovat do integrovaných a vlastních koncových bodů. Viz: https://aka.ms/telemetryoneventgrid | EnrichmentProperties[] |
| náhradníroute | Vlastnosti trasy, která se používá jako náhradní trasa, pokud nejsou splněny žádné podmínky zadané v části trasy. Jedná se o volitelný parametr. Pokud tato vlastnost není nastavená, zprávy, které nesplňují žádné podmínky zadané v části trasy, se směrují do integrovaného koncového bodu centra událostí. | fallbackRouteProperties |
| trasy | Seznam pravidel směrování poskytovaných uživatelem, která ioT Hub používá ke směrování zpráv do předdefinovaných a vlastních koncových bodů. Pro placené rozbočovače je povoleno maximálně 100 pravidel směrování a pro bezplatná centra jsou povolená maximálně 5 pravidel směrování. | RouteProperties[] |
RoutingServiceBusQueueEndpointProperties
RoutingServiceBusTopicEndpointProperties
RoutingStorageContainerProperties
SharedAccessSignatureAuthorizationRule
| Jméno | Popis | Hodnota |
|---|---|---|
| keyName | Název zásady sdíleného přístupu. | string (povinné) |
| primaryKey | Primární klíč. | řetězec |
| práva | Oprávnění přiřazená k zásadám sdíleného přístupu. | DeviceConnect RegistrRead 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 (povinné) |
| secondaryKey | Sekundární klíč. | řetězec |