Microsoft.Devices IotHubs 2021-03-03-preview
Definice prostředku Bicep
Typ prostředku IotHubs je možné nasadit s operacemi, které cílí na:
- 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-03-03-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
name: 'string'
}
etag: 'string'
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
authorizationPolicies: [
{
keyName: 'string'
primaryKey: 'string'
rights: 'string'
secondaryKey: 'string'
keyName: 'string'
primaryKey: 'string'
rights: 'string'
secondaryKey: 'string'
}
]
cloudToDevice: {
defaultTtlAsIso8601: 'string'
feedback: {
lockDurationAsIso8601: 'string'
maxDeliveryCount: int
ttlAsIso8601: 'string'
}
maxDeliveryCount: int
}
comments: 'string'
deviceStreams: {
streamingEndpoints: [
'string'
]
}
enableFileUploadNotifications: bool
encryption: {
keySource: 'string'
keyVaultProperties: [
{
identity: {
userAssignedIdentity: 'string'
}
keyIdentifier: 'string'
}
]
}
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: 'Allow'
filterName: 'string'
ipMask: 'string'
}
]
}
privateEndpointConnections: [
{
properties: {
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
]
publicNetworkAccess: 'string'
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í
IotHubs
Název | Description | Hodnota |
---|---|---|
name | Název prostředku | string (povinné) Omezení počtu znaků: 3–50 Platné znaky: Alfanumerické znaky a spojovníky. Nemůže končit spojovníkem. Název prostředku musí být v rámci Azure jedinečný. |
location | Umístění prostředku. | string (povinné) |
tags | Značky prostředků. | Slovník názvů značek a hodnot. Viz Značky v šablonách |
Sku | Informace o skladové pouce IotHubu | IotHubSkuInfo (povinné) |
Etag | Pole Etag není povinné. Pokud je uveden v textu odpovědi, musí být také uveden jako hlavička podle normální konvence ETag. | řetězec |
identity | Spravované identity pro IotHub. | ArmIdentity |
properties | Vlastnosti IotHubu | IotHubProperties |
ArmIdentity
Název | Description | Hodnota |
---|---|---|
typ | 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. | 'Žádný' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
userAssignedIdentity | Slovník uživatele {ArmUserIdentity} | ArmIdentityUserAssignedIdentity |
ArmIdentityUserAssignedIdentity
Název | Description | Hodnota |
---|---|---|
{přizpůsobená vlastnost} | ArmUserIdentity |
ArmUserIdentity
Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou Jen pro čtení.
IotHubProperties
Název | Description | Hodnota |
---|---|---|
authorizationPolicies | Zásady sdíleného přístupu, které můžete použít k zabezpečení připojení ke službě IoT Hub. | SharedAccessSignatureAuthorizationRule[] |
cloudToDevice | Vlastnosti zasílání zpráv z cloudu do zařízení ve službě IoT Hub | CloudToDeviceProperties |
komentáře | Komentáře ke službě IoT Hub | řetězec |
deviceStreams | Zařízení streamuje vlastnosti iothubu. | IotHubPropertiesDeviceStreams |
enableFileUploadNotifications | Pokud je true, oznámení o nahrání souboru jsou povolená. | bool |
šifrování | Vlastnosti šifrování pro centrum IoT. | Popis vlastností šifrování |
eventHubEndpoints | 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. | IotHubPropertiesEventHubEndpoints |
funkce | Možnosti a funkce povolené pro službu IoT Hub. | DeviceManagement 'Žádný' |
ipFilterRules | Pravidla filtru IP adres. | IpFilterRule[] |
messagingEndpoints | Vlastnosti koncového bodu zasílání zpráv pro frontu oznámení o 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 být odmítnuti. | řetězec |
networkRuleSets | Vlastnosti sady pravidel sítě iotHubu | NetworkRuleSetProperties |
privateEndpointConnections | Připojení privátních koncových bodů vytvořená na tomto IotHubu | PrivateEndpointConnection[] |
publicNetworkAccess | Jestli jsou povolené požadavky z veřejné sítě | Zakázáno Povoleno |
Směrování | Vlastnosti ioT Hubu související se směrováním Viz: /azure/iot-hub/iot-hub-devguide-messaging. | Vlastnosti směrování |
koncové body úložiště | 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. | IotHubPropertiesStorageEndpoints |
SharedAccessSignatureAuthorizationRule
Název | Description | Hodnota |
---|---|---|
Název_klíče | 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' '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 (povinné) |
sekundární klíč | Sekundární klíč. | řetězec |
Název_klíče | 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' '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 (povinné) |
sekundární klíč | Sekundární klíč. | řetězec |
CloudToDeviceProperties
Název | Description | Hodnota |
---|---|---|
defaultTtlAsIso8601 | Výchozí hodnota časového limitu pro zprávy 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í. | Zpětná vazbaVlastnosti |
maxDeliveryCount | Maximální počet doručení zpráv z cloudu do 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 |
Zpětná vazbaVlastnosti
Název | Description | Hodnota |
---|---|---|
lockDurationAsIso8601 | Doba uzamčení fronty zpětné vazby. Viz/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | řetězec |
maxDeliveryCount | Kolikrát se IoT Hub pokusí doručit zprávu ve frontě 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, aby ji služba IoT Hub využila, než jí vyprší platnost. Viz/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | řetězec |
IotHubPropertiesDeviceStreams
Název | Description | Hodnota |
---|---|---|
streamingEndpoints | Seznam koncových bodů datových proudů zařízení | string[] |
Popis vlastností šifrování
Název | Description | Hodnota |
---|---|---|
zdroj klíčů | Zdroj klíče. | řetězec |
keyVaultVlastnosti | Vlastnosti klíče KeyVault. | Vlastnosti klíče KeyVault[] |
Vlastnosti klíče služby KeyVault
Název | Description | Hodnota |
---|---|---|
identity | Vlastnosti spravované identity klíče služby KeyVault | Spravovaná identita |
keyIdentifier | Identifikátor klíče. | řetězec |
Spravovaná identita
Název | Description | Hodnota |
---|---|---|
userAssignedIdentity | Identita přiřazená uživatelem. | řetězec |
IotHubPropertiesEventHubEndpoints
Název | Description | Hodnota |
---|---|---|
{přizpůsobená vlastnost} | EventHubVlastnosti |
EventHubVlastnosti
Název | Description | 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 zařízení-cloud ve dnech. Viz: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | int |
IpFilterRule
Název | Description | Hodnota |
---|---|---|
action | Požadovaná akce pro požadavky zachycené tímto pravidlem | 'Přijmout' Odmítnout (povinné) |
název_filtru | Název pravidla filtru IP adres. | string (povinné) |
ipMask | Řetězec, který obsahuje rozsah IP adres v zápisu CIDR pro pravidlo. | string (povinné) |
IotHubPropertiesMessagingEndpoints
Název | Description | Hodnota |
---|---|---|
{přizpůsobená vlastnost} | MessagingEndpointVlastnosti |
MessagingEndpointVlastnosti
Název | Description | Hodnota |
---|---|---|
lockDurationAsIso8601 | Doba trvání zámku. Viz /azure/iot-hub/iot-hub-devguide-file-upload. | řetězec |
maxDeliveryCount | Kolikrát se Centrum IoT pokusí doručit zprávu. 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ž vyprší platnost služby IoT Hub. Viz /azure/iot-hub/iot-hub-devguide-file-upload. | řetězec |
NetworkRuleSetProperties
Název | Description | Hodnota |
---|---|---|
applyToBuiltInEventHubEndpoint | Pokud je true, pak se sada pravidel sítě použije také na builtin EventHub EndPoint iotHubu. | bool (povinné) |
defaultAction | Výchozí akce pro sadu pravidel sítě | 'Povolit' "Odepřít" |
ipRules | Seznam pravidel IP adres | NetworkRuleSetIpRule[] (povinné) |
NetworkRuleSetIpRule
Název | Description | Hodnota |
---|---|---|
action | 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 pro pravidlo. | string (povinné) |
PrivateEndpointConnection
Název | Description | Hodnota |
---|---|---|
properties | Vlastnosti připojení privátního koncového bodu | PrivateEndpointConnectionProperties (povinné) |
PrivateEndpointConnectionProperties
Název | Description | Hodnota |
---|---|---|
privátní koncový bod | Vlastnost privátního koncového bodu připojení privátního koncového bodu | Privátní koncový bod |
privateLinkServiceConnectionState | Aktuální stav připojení privátního koncového bodu | PrivateLinkServiceConnectionState (povinné) |
Privátní koncový bod
Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou Jen pro čtení.
PrivateLinkServiceConnectionState
Název | Description | Hodnota |
---|---|---|
actionsRequired | Akce vyžadované pro připojení privátního koncového bodu | řetězec |
description | Popis aktuálního stavu připojení privátního koncového bodu | string (povinné) |
status | Stav připojení privátního koncového bodu | "Schváleno" Odpojeno Čeká na vyřízení Zamítnuto (povinné) |
Vlastnosti směrování
Název | Description | 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á 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. | Koncové body směrování |
rozšiřování | 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 |
EnrichmentProperties[] |
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í nastavená, zprávy, které nesplňují žádnou z podmínek zadaných v části "routes", se přesměrují do integrovaného koncového bodu eventhubu. | 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á centra je povoleno maximálně 100 pravidel směrování a pro bezplatná centra je povoleno maximálně 5 pravidel směrování. | RouteProperties[] |
Koncové body směrování
Název | Description | Hodnota |
---|---|---|
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. | RoutingEventHubProperties[] |
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í. | RoutingServiceBusQueueEndpointProperties[] |
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í. | RoutingServiceBusTopicEndpointProperties[] |
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í. | RoutingStorageContainerProperties[] |
RoutingEventHubVlastnosti
Název | Description | Hodnota |
---|---|---|
authenticationType | Metoda použitá k ověření v koncovém bodu centra událostí | 'identityBased' 'keyBased' |
připojovací řetězec | Připojovací řetězec koncového bodu centra událostí. | řetězec |
identifikátor endpointUri | Adresa URL koncového bodu centra událostí. Musí obsahovat protokol sb:// | řetězec |
entityPath | Název centra událostí v oboru názvů centra událostí | řetězec |
id | ID koncového bodu centra událostí | řetězec |
identity | Vlastnosti spravované identity koncového bodu centra událostí směrování | Spravovaná identita |
name | 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ů. | string (povinné) Omezení: Pattern = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Název skupiny prostředků koncového bodu centra událostí. | řetězec |
subscriptionId | Identifikátor předplatného koncového bodu centra událostí. | řetězec |
RoutingServiceBusQueueEndpointProperties
Název | Description | Hodnota |
---|---|---|
authenticationType | Metoda použitá k ověření koncového bodu fronty služby Service Bus | 'identityBased' 'keyBased' |
připojovací řetězec | Připojovací řetězec koncového bodu fronty služby Service Bus. | řetězec |
identifikátor endpointUri | Adresa URL koncového bodu fronty služby Service Bus Musí obsahovat protokol sb:// | řetězec |
entityPath | Název fronty v oboru názvů služby Service Bus | řetězec |
id | ID koncového bodu fronty služby Service Bus | řetězec |
identity | Vlastnosti spravované identity koncového bodu fronty služby Service Bus. | Spravovaná identita |
name | 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. | string (povinné) Omezení: Pattern = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Název skupiny prostředků koncového bodu fronty služby Service Bus. | řetězec |
subscriptionId | Identifikátor předplatného koncového bodu fronty služby Service Bus. | řetězec |
RoutingServiceBusTopicEndpointProperties
Název | Description | Hodnota |
---|---|---|
authenticationType | Metoda použitá k ověření v koncovém bodu tématu služby Service Bus | 'identityBased' 'keyBased' |
připojovací řetězec | Připojovací řetězec koncového bodu tématu služby Service Bus. | řetězec |
identifikátor endpointUri | Adresa URL koncového bodu tématu služby Service Bus. Musí obsahovat protokol sb:// | řetězec |
entityPath | Název fronty v tématu služby Service Bus | řetězec |
id | ID koncového bodu tématu služby Service Bus | řetězec |
identity | Vlastnosti spravované identity koncového bodu tématu služby Service Bus. | Spravovaná identita |
name | 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. | string (povinné) Omezení: Pattern = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Název skupiny prostředků koncového bodu tématu služby Service Bus. | řetězec |
subscriptionId | Identifikátor předplatného koncového bodu tématu služby Service Bus. | řetězec |
RoutingStorageContainerProperties
Název | Description | Hodnota |
---|---|---|
authenticationType | Metoda použitá k ověření vůči koncovému bodu úložiště | 'identityBased' 'keyBased' |
batchFrequencyInSeconds | Č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. | int Omezení: Minimální hodnota = 60 Maximální hodnota = 720 |
připojovací řetězec | Připojovací řetězec účtu úložiště. | řetězec |
název_kontejneru | Název kontejneru úložiště v účtu úložiště. | string (povinné) |
encoding | 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. | 'Avro' 'AvroDeflate' 'JSON' |
identifikátor endpointUri | Adresa URL koncového bodu úložiště. Musí obsahovat protokol https:// |
řetězec |
fileNameFormat | 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. | řetězec |
id | ID koncového bodu kontejneru úložiště | řetězec |
identity | Vlastnosti spravované identity koncového bodu úložiště směrování | Spravovaná identita |
maxChunkSizeInBytes | 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). | int Omezení: Minimální hodnota = 10485760 Maximální hodnota = 524288000 |
name | 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ů. | string (povinné) Omezení: Pattern = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Název skupiny prostředků účtu úložiště. | řetězec |
subscriptionId | Identifikátor předplatného účtu úložiště. | řetězec |
EnrichmentProperties
Název | Description | Hodnota |
---|---|---|
endpointNames | Seznam koncových bodů, pro které je obohacení použito na zprávu. | string[] (povinné) Omezení: Minimální délka = 1 |
key | Klíč nebo název vlastnosti enrichment. | string (povinné) |
hodnota | Hodnota vlastnosti enrichment. | string (povinné) |
FallbackRouteProperties
Název | Description | Hodnota |
---|---|---|
Podmínka | 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: /azure/iot-hub/iot-hub-devguide-query-language. | řetězec |
endpointNames | 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. | string[] (povinné) Omezení: Minimální délka = 1 Maximální délka = 1 |
Isenabled | Slouží k určení, jestli je povolená záložní trasa. | bool (povinné) |
name | 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ý. | řetězec |
source | Zdroj, na který se má pravidlo směrování použít. Například DeviceMessages | DeviceConnectionStateEvents 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' DigitalTwinChangeEvents "Neplatné" TwinChangeEvents (povinné) |
Vlastnosti routeProperties
Název | Description | Hodnota |
---|---|---|
Podmínka | 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: /azure/iot-hub/iot-hub-devguide-query-language. | řetězec |
endpointNames | 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. | string[] (povinné) Omezení: Minimální délka = 1 Maximální délka = 1 |
Isenabled | Slouží k určení, jestli je povolená trasa. | bool (povinné) |
name | 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ý. | string (povinné) Omezení: Pattern = ^[A-Za-z0-9-._]{1,64}$ |
source | Zdroj, na který se má pravidlo směrování použít, například DeviceMessages. | DeviceConnectionStateEvents 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' DigitalTwinChangeEvents "Neplatné" TwinChangeEvents (povinné) |
IotHubPropertiesStorageEndpoints
Název | Description | Hodnota |
---|---|---|
{přizpůsobená vlastnost} | StorageEndpointProperties |
StorageEndpointProperties
Název | Description | Hodnota |
---|---|---|
authenticationType | Určuje typ ověřování, který se používá pro připojení k účtu úložiště. | 'identityBased' 'keyBased' |
připojovací řetězec | Připojovací řetězec pro účet Služby Azure Storage, do kterého se soubory nahrávají. | string (povinné) |
název_kontejneru | 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. | string (povinné) |
identity | Vlastnosti spravované identity koncového bodu úložiště pro nahrání souboru | Spravovaná identita |
sasTtlAsIso8601 | Doba, po kterou identifikátor URI SAS vygenerovaný IoT Hub pro nahrání souboru, je platná. Viz /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | řetězec |
IotHubSkuInfo
Název | Description | Hodnota |
---|---|---|
capacity | Počet zřízených jednotek IoT Hub. Viz /azure/azure-subscription-service-limits#iot-hub-limits. | int |
name | Název skladové položky. | "B1" "B2" "B3" F1 'S1' 'S2' 'S3' (povinné) |
Šablony pro rychlý start
Následující šablony rychlého startu nasadí tento typ prostředku.
Template (Šablona) | Description |
---|---|
Vytvoření iot Hubu a hraničního simulátoru Ubuntu |
Tato šablona vytvoří simulátor hraničních zařízení IOT Hub a Ubuntu virtuálního počítače. |
Použití šablony ARM k vytváření IoT Hub, směrování a zobrazení zpráv |
Pomocí této šablony nasadíte IoT Hub a účet úložiště. Spusťte aplikaci pro odesílání zpráv do centra, které jsou směrovány do úložiště, a pak zobrazte výsledky. |
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 tyto dvě služby. |
Vytvoření IoT Hub a skupiny uživatelů zařízení do cloudu |
Tato šablona umožňuje nasadit instanci IoT Hub se zařízením do cloudu a cloudových konfigurací zasílání zpráv a zařízení do skupiny příjemců cloudu. |
Vytvoření aktualizace zařízení pro účet IoT Hub, instanci IoT Hub |
Tato šablona vytvoří účet a instanci a centrum pro propojení instance. Nakonfiguruje centrum s potřebnými zásadami přístupu, trasami a skupinami příjemců. |
Nasazení služby MedTech včetně Azure IoT Hub |
Služba MedTech je jednou ze služeb Azure Health Data Services, jejichž účelem je ingestovat data zařízení z více zařízení a transformovat data zařízení na FHIR Observations, které se pak uchovávají ve službě Azure Health Data Services FHIR. |
Vytvoření prostředí průběžných plateb pomocí IoT Hub |
Tato šablona umožňuje nasadit prostředí Time Series Insights s průběžnou platbou (PAYG), které je nakonfigurované tak, aby využívalo události z IoT Hub. |
Definice prostředku šablony ARM
Typ prostředku IotHubs je možné nasadit s operacemi, které cílí na:
- 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í kód JSON.
{
"type": "Microsoft.Devices/IotHubs",
"apiVersion": "2021-03-03-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"name": "string"
},
"etag": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"authorizationPolicies": [
{
"keyName": "string",
"primaryKey": "string",
"rights": "string",
"secondaryKey": "string",
"keyName": "string",
"primaryKey": "string",
"rights": "string",
"secondaryKey": "string"
}
],
"cloudToDevice": {
"defaultTtlAsIso8601": "string",
"feedback": {
"lockDurationAsIso8601": "string",
"maxDeliveryCount": "int",
"ttlAsIso8601": "string"
},
"maxDeliveryCount": "int"
},
"comments": "string",
"deviceStreams": {
"streamingEndpoints": [ "string" ]
},
"enableFileUploadNotifications": "bool",
"encryption": {
"keySource": "string",
"keyVaultProperties": [
{
"identity": {
"userAssignedIdentity": "string"
},
"keyIdentifier": "string"
}
]
},
"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": "Allow",
"filterName": "string",
"ipMask": "string"
}
]
},
"privateEndpointConnections": [
{
"properties": {
"privateEndpoint": {},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
],
"publicNetworkAccess": "string",
"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í
IotHubs
Název | Description | Hodnota |
---|---|---|
typ | Typ prostředku | Microsoft.Devices/IotHubs |
apiVersion | Verze rozhraní API prostředků | '2021-03-preview' |
name | Název prostředku | string (povinné) Omezení počtu znaků: 3–50 Platné znaky: Alfanumerické znaky a spojovníky. Nemůže končit spojovníkem. Název prostředku musí být v rámci Azure jedinečný. |
location | Umístění prostředku. | string (povinné) |
tags | Značky prostředků. | Slovník názvů značek a hodnot. Viz Značky v šablonách |
Sku | Informace o skladové pouce IotHubu | IotHubSkuInfo (povinné) |
Etag | Pole Etag není povinné. Pokud je uveden v textu odpovědi, musí být také uveden jako hlavička podle normální konvence ETag. | řetězec |
identity | Spravované identity pro IotHub | ArmIdentity |
properties | Vlastnosti IotHubu | IotHubVlastnosti |
ArmIdentity
Název | Description | Hodnota |
---|---|---|
typ | 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. | 'Žádný' 'SystemAssigned' SystemAssigned, UserAssigned UserAssigned |
userAssignedIdentity | Slovník uživatele {ArmUserIdentity} | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
Název | Description | Hodnota |
---|---|---|
{přizpůsobená vlastnost} | ArmUserIdentity |
ArmUserIdentity
Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou jen pro čtení.
IotHubVlastnosti
Název | Description | Hodnota |
---|---|---|
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 cloud-zařízení ve službě IoT Hub | CloudToDeviceProperties |
komentáře | Komentáře služby IoT Hub. | řetězec |
streamy zařízení | Zařízení streamuje vlastnosti iothubu. | IotHubPropertiesDeviceStreams |
enableFileUploadNotifications | Pokud má hodnotu True, oznámení o nahrání souboru jsou povolená. | bool |
šifrování | Vlastnosti šifrování pro centrum IoT. | Popis vlastností šifrování |
eventHubEndpoints | 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. | IotHubPropertiesEventHubEndpoints |
funkce | Možnosti a funkce povolené pro službu IoT Hub. | DeviceManagement 'Žádný' |
ipFilterRules | Pravidla filtru IP adres. | IpFilterRule[] |
messagingEndpoints | Vlastnosti koncového bodu zasílání zpráv pro frontu oznámení o 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 být odmítnuti. | řetězec |
networkRuleSets | Vlastnosti sady pravidel sítě iotHubu | NetworkRuleSetProperties |
privateEndpointConnections | Připojení privátních koncových bodů vytvořená na tomto IotHubu | PrivateEndpointConnection[] |
publicNetworkAccess | Jestli jsou povolené požadavky z veřejné sítě | Zakázáno Povoleno |
Směrování | Vlastnosti ioT Hubu související se směrováním Viz: /azure/iot-hub/iot-hub-devguide-messaging. | Vlastnosti směrování |
koncové body úložiště | 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. | IotHubPropertiesStorageEndpoints |
SharedAccessSignatureAuthorizationRule
Název | Description | Hodnota |
---|---|---|
Název_klíče | 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' '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 (povinné) |
sekundární klíč | Sekundární klíč. | řetězec |
Název_klíče | 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' '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 (povinné) |
sekundární klíč | Sekundární klíč. | řetězec |
CloudToDeviceProperties
Název | Description | Hodnota |
---|---|---|
defaultTtlAsIso8601 | Výchozí hodnota časového limitu pro zprávy 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í. | Zpětná vazbaVlastnosti |
maxDeliveryCount | Maximální počet doručení zpráv z cloudu do 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 |
Zpětná vazbaVlastnosti
Název | Description | Hodnota |
---|---|---|
lockDurationAsIso8601 | Doba uzamčení fronty zpětné vazby. Viz/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | řetězec |
maxDeliveryCount | Kolikrát se IoT Hub pokusí doručit zprávu ve frontě 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, aby ji služba IoT Hub využila, než jí vyprší platnost. Viz/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | řetězec |
IotHubPropertiesDeviceStreams
Název | Description | Hodnota |
---|---|---|
streamingEndpoints | Seznam koncových bodů datových proudů zařízení | string[] |
Popis vlastností šifrování
Název | Description | Hodnota |
---|---|---|
zdroj klíčů | Zdroj klíče. | řetězec |
keyVaultVlastnosti | Vlastnosti klíče KeyVault. | Vlastnosti klíče KeyVault[] |
Vlastnosti klíče služby KeyVault
Název | Description | Hodnota |
---|---|---|
identity | Vlastnosti spravované identity klíče služby KeyVault | Spravovaná identita |
keyIdentifier | Identifikátor klíče. | řetězec |
Spravovaná identita
Název | Description | Hodnota |
---|---|---|
userAssignedIdentity | Identita přiřazená uživatelem. | řetězec |
IotHubPropertiesEventHubEndpoints
Název | Description | Hodnota |
---|---|---|
{přizpůsobená vlastnost} | EventHubVlastnosti |
EventHubVlastnosti
Název | Description | 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 zařízení-cloud ve dnech. Viz: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | int |
IpFilterRule
Název | Description | Hodnota |
---|---|---|
action | Požadovaná akce pro požadavky zachycené tímto pravidlem | 'Přijmout' Odmítnout (povinné) |
název_filtru | Název pravidla filtru IP adres. | string (povinné) |
ipMask | Řetězec, který obsahuje rozsah IP adres v zápisu CIDR pro pravidlo. | string (povinné) |
IotHubPropertiesMessagingEndpoints
Název | Description | Hodnota |
---|---|---|
{přizpůsobená vlastnost} | Koncový bod zasílání zpráv – vlastnosti |
Koncový bod zasílání zpráv – vlastnosti
Název | Description | Hodnota |
---|---|---|
lockDurationAsIso8601 | Doba trvání zámku. Viz/azure/iot-hub/iot-hub-devguide-file-upload. | řetězec |
maxDeliveryCount | Kolikrát se IoT Hub pokusí doručit zprávu. 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, aby ji služba IoT Hub využila, než jí vyprší platnost. Viz/azure/iot-hub/iot-hub-devguide-file-upload. | řetězec |
NetworkRuleSetProperties
Název | Description | Hodnota |
---|---|---|
applyToBuiltInEventHubEndpoint | Pokud je true, pak se sada pravidel sítě použije také na builtIn EventHub EndPoint iotHubu. | bool (povinné) |
výchozí akce | Výchozí akce pro sadu pravidel sítě | 'Povolit' 'Odepřít' |
pravidla ipRules | Seznam pravidel IP adres | NetworkRuleSetIpRule[] (povinné) |
NetworkRuleSetIpRule
Název | Description | Hodnota |
---|---|---|
action | Akce filtru IP adres | 'Povolit' |
název_filtru | Název pravidla filtru IP adres. | string (povinné) |
ipMask | Řetězec, který obsahuje rozsah IP adres v zápisu CIDR pro pravidlo. | string (povinné) |
PrivateEndpointConnection
Název | Description | Hodnota |
---|---|---|
properties | Vlastnosti připojení privátního koncového bodu | PrivateEndpointConnectionProperties (povinné) |
PrivateEndpointConnectionProperties
Název | Description | Hodnota |
---|---|---|
privátní koncový bod | Vlastnost privátního koncového bodu připojení privátního koncového bodu | Privátní koncový bod |
privateLinkServiceConnectionState | Aktuální stav připojení privátního koncového bodu | PrivateLinkServiceConnectionState (povinné) |
Privátní koncový bod
Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou Jen pro čtení.
PrivateLinkServiceConnectionState
Název | Description | Hodnota |
---|---|---|
actionsRequired | Akce vyžadované pro připojení privátního koncového bodu | řetězec |
description | Popis aktuálního stavu připojení privátního koncového bodu | string (povinné) |
status | Stav připojení privátního koncového bodu | "Schváleno" Odpojeno Čeká na vyřízení Zamítnuto (povinné) |
Vlastnosti směrování
Název | Description | 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á 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. | Koncové body směrování |
rozšiřování | 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 |
EnrichmentProperties[] |
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í nastavená, zprávy, které nesplňují žádnou z podmínek zadaných v části "routes", se přesměrují do integrovaného koncového bodu eventhubu. | 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á centra je povoleno maximálně 100 pravidel směrování a pro bezplatná centra je povoleno maximálně 5 pravidel směrování. | RouteProperties[] |
Koncové body směrování
Název | Description | Hodnota |
---|---|---|
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. | RoutingEventHubProperties[] |
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í. | RoutingServiceBusQueueEndpointProperties[] |
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í. | RoutingServiceBusTopicEndpointProperties[] |
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í. | RoutingStorageContainerProperties[] |
RoutingEventHubVlastnosti
Název | Description | Hodnota |
---|---|---|
authenticationType | Metoda použitá k ověření v koncovém bodu centra událostí | 'identityBased' 'keyBased' |
připojovací řetězec | Připojovací řetězec koncového bodu centra událostí. | řetězec |
identifikátor endpointUri | Adresa URL koncového bodu centra událostí. Musí obsahovat protokol sb:// | řetězec |
entityPath | Název centra událostí v oboru názvů centra událostí | řetězec |
id | ID koncového bodu centra událostí | řetězec |
identity | Vlastnosti spravované identity koncového bodu centra událostí směrování | Spravovaná identita |
name | 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ů. | string (povinné) Omezení: Pattern = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Název skupiny prostředků koncového bodu centra událostí. | řetězec |
subscriptionId | Identifikátor předplatného koncového bodu centra událostí. | řetězec |
RoutingServiceBusQueueEndpointProperties
Název | Description | Hodnota |
---|---|---|
authenticationType | Metoda použitá k ověření koncového bodu fronty služby Service Bus | 'identityBased' 'keyBased' |
připojovací řetězec | Připojovací řetězec koncového bodu fronty služby Service Bus. | řetězec |
identifikátor endpointUri | Adresa URL koncového bodu fronty služby Service Bus Musí obsahovat protokol sb:// | řetězec |
entityPath | Název fronty v oboru názvů služby Service Bus | řetězec |
id | ID koncového bodu fronty služby Service Bus | řetězec |
identity | Vlastnosti spravované identity koncového bodu fronty služby Service Bus. | Spravovaná identita |
name | 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. | string (povinné) Omezení: Pattern = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Název skupiny prostředků koncového bodu fronty služby Service Bus. | řetězec |
subscriptionId | Identifikátor předplatného koncového bodu fronty služby Service Bus. | řetězec |
RoutingServiceBusTopicEndpointProperties
Název | Description | Hodnota |
---|---|---|
authenticationType | Metoda použitá k ověření v koncovém bodu tématu služby Service Bus | 'identityBased' 'keyBased' |
připojovací řetězec | Připojovací řetězec koncového bodu tématu služby Service Bus. | řetězec |
identifikátor endpointUri | Adresa URL koncového bodu tématu služby Service Bus. Musí obsahovat protokol sb:// | řetězec |
entityPath | Název fronty v tématu služby Service Bus | řetězec |
id | ID koncového bodu tématu služby Service Bus | řetězec |
identity | Vlastnosti spravované identity koncového bodu tématu služby Service Bus. | Spravovaná identita |
name | 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. | string (povinné) Omezení: Pattern = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Název skupiny prostředků koncového bodu tématu služby Service Bus. | řetězec |
subscriptionId | Identifikátor předplatného koncového bodu tématu služby Service Bus. | řetězec |
RoutingStorageContainerProperties
Název | Description | Hodnota |
---|---|---|
authenticationType | Metoda použitá k ověření vůči koncovému bodu úložiště | 'identityBased' 'keyBased' |
batchFrequencyInSeconds | Č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. | int Omezení: Minimální hodnota = 60 Maximální hodnota = 720 |
připojovací řetězec | připojovací řetězec účtu úložiště. | řetězec |
název_kontejneru | Název kontejneru úložiště v účtu úložiště. | string (povinné) |
encoding | 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. | 'Avro' 'AvroDeflate' JSON |
identifikátor URI koncového bodu | Adresa URL koncového bodu úložiště. Musí obsahovat protokol. https:// |
řetězec |
formát názvu souboru | Formát názvu souboru objektu blob. Výchozí formát je {iothub}/{partition}/{RRRR}/{MM}/{DD}/{HH}/{mm}. Všechny parametry jsou povinné, ale jejich pořadí je možné změnit. | řetězec |
id | ID koncového bodu kontejneru úložiště | řetězec |
identity | Vlastnosti spravované identity koncového bodu úložiště směrování | Spravovaná identita |
maxChunkSizeInBytes | Maximální počet bajtů pro každý objekt blob zapsaný do úložiště Hodnota by měla být v rozsahu 10485760(10 MB) až 524288000(500 MB). Výchozí hodnota je 314572800(300 MB). | int Omezení: Minimální hodnota = 10485760 Maximální hodnota = 524288000 |
name | Název, který identifikuje tento koncový bod. Název může obsahovat pouze alfanumerické znaky, tečky, podtržítka, pomlčky a jeho délka je maximálně 64 znaků. Následující názvy jsou vyhrazené: events, fileNotifications $default. Názvy koncových bodů musí být v různých typech koncových bodů jedinečné. | string (povinné) Omezení: Vzor = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Název skupiny prostředků účtu úložiště. | řetězec |
subscriptionId | Identifikátor předplatného účtu úložiště. | řetězec |
EnrichmentProperties
Název | Description | Hodnota |
---|---|---|
názvy koncových bodů | Seznam koncových bodů, pro které se rozšíření použije u zprávy. | string[] (povinné) Omezení: Minimální délka = 1 |
key | Klíč nebo název vlastnosti rozšiřování. | string (povinné) |
hodnota | Hodnota vlastnosti rozšiřování. | string (povinné) |
FallbackRouteVlastnosti
Název | Description | Hodnota |
---|---|---|
Podmínka | Podmínka, která se vyhodnocuje, aby se použila náhradní trasa. Pokud podmínka není zadá, ve výchozím nastavení se vyhodnotí jako pravda. Informace o gramatice najdete tady: /azure/iot-hub/iot-hub-devguide-query-language. | řetězec |
názvy koncových bodů | Seznam koncových bodů, na které jsou směrovány zprávy, které splňují podmínku. Aktuálně je povolený jenom 1 koncový bod. | string[] (povinné) Omezení: Minimální délka = 1 Maximální délka = 1 |
Isenabled | Slouží k určení, jestli je povolená náhradní trasa. | bool (povinné) |
name | 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 |
source | Zdroj, na který se má pravidlo směrování použít. Například DeviceMessages | DeviceConnectionStateEvents 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' DigitalTwinChangeEvents "Neplatné" TwinChangeEvents (povinné) |
Vlastnosti routeProperties
Název | Description | Hodnota |
---|---|---|
Podmínka | 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: /azure/iot-hub/iot-hub-devguide-query-language. | řetězec |
endpointNames | 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. | string[] (povinné) Omezení: Minimální délka = 1 Maximální délka = 1 |
Isenabled | Slouží k určení, jestli je povolená trasa. | bool (povinné) |
name | 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ý. | string (povinné) Omezení: Pattern = ^[A-Za-z0-9-._]{1,64}$ |
source | Zdroj, na který se má pravidlo směrování použít, například DeviceMessages. | DeviceConnectionStateEvents 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' DigitalTwinChangeEvents "Neplatné" TwinChangeEvents (povinné) |
IotHubPropertiesStorageEndpoints
Název | Description | Hodnota |
---|---|---|
{přizpůsobená vlastnost} | StorageEndpointProperties |
StorageEndpointProperties
Název | Description | Hodnota |
---|---|---|
authenticationType | Určuje typ ověřování, který se používá pro připojení k účtu úložiště. | 'identityBased' 'keyBased' |
připojovací řetězec | Připojovací řetězec pro účet Služby Azure Storage, do kterého se soubory nahrávají. | string (povinné) |
název_kontejneru | 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. | string (povinné) |
identity | Vlastnosti spravované identity koncového bodu úložiště pro nahrání souboru | Spravovaná identita |
sasTtlAsIso8601 | Doba, po kterou identifikátor URI SAS vygenerovaný IoT Hub pro nahrání souboru, je platná. Viz /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | řetězec |
IotHubSkuInfo
Název | Description | Hodnota |
---|---|---|
capacity | Počet zřízených jednotek IoT Hub. Viz /azure/azure-subscription-service-limits#iot-hub-limits. | int |
name | Název skladové položky. | "B1" "B2" "B3" F1 'S1' 'S2' 'S3' (povinné) |
Šablony pro rychlý start
Následující šablony rychlého startu nasadí tento typ prostředku.
Template (Šablona) | Description |
---|---|
Vytvoření iot Hubu a hraničního simulátoru Ubuntu |
Tato šablona vytvoří simulátor hraničních zařízení IOT Hub a Ubuntu virtuálního počítače. |
Použití šablony ARM k vytváření IoT Hub, směrování a zobrazení zpráv |
Pomocí této šablony nasadíte IoT Hub a účet úložiště. Spusťte aplikaci pro odesílání zpráv do centra, které jsou směrovány do úložiště, a pak zobrazte výsledky. |
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 tyto dvě služby. |
Vytvoření IoT Hub a skupiny uživatelů zařízení do cloudu |
Tato šablona umožňuje nasadit instanci IoT Hub se zařízením do cloudu a cloudem do konfigurace zasílání zpráv zařízení a zařízení do skupiny cloudových příjemců. |
Vytvoření služby Device Update pro účet IoT Hub, instanci nebo IoT Hub |
Tato šablona vytvoří účet a instanci a centrum pro propojení instance. Nakonfiguruje centrum s potřebnými zásadami přístupu, trasami a skupinami uživatelů. |
Nasazení služby MedTech včetně 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 je na pozorování FHIR, která se pak uchovávají ve službě FHIR Azure Health Data Services. |
Vytvoření prostředí s průběžnými platbami pomocí IoT Hub |
Tato šablona umožňuje nasadit prostředí Time Series Insights s průběžnými platbami (PAYG), které je nakonfigurované tak, aby využívalo události z IoT Hub. |
Definice prostředku Terraform (poskytovatel AzAPI)
Typ prostředku IotHubs je možné nasadit s operacemi, které cílí na:
- 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-03-03-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
authorizationPolicies = [
{
keyName = "string"
primaryKey = "string"
rights = "string"
secondaryKey = "string"
keyName = "string"
primaryKey = "string"
rights = "string"
secondaryKey = "string"
}
]
cloudToDevice = {
defaultTtlAsIso8601 = "string"
feedback = {
lockDurationAsIso8601 = "string"
maxDeliveryCount = int
ttlAsIso8601 = "string"
}
maxDeliveryCount = int
}
comments = "string"
deviceStreams = {
streamingEndpoints = [
"string"
]
}
enableFileUploadNotifications = bool
encryption = {
keySource = "string"
keyVaultProperties = [
{
identity = {
userAssignedIdentity = "string"
}
keyIdentifier = "string"
}
]
}
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 = "Allow"
filterName = "string"
ipMask = "string"
}
]
}
privateEndpointConnections = [
{
properties = {
privateEndpoint = {}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
}
]
publicNetworkAccess = "string"
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"
}
etag = "string"
})
}
Hodnoty vlastností
IotHubs
Název | Description | Hodnota |
---|---|---|
typ | Typ prostředku | Microsoft.Devices/IotHubs@2021-03-03-preview |
name | Název prostředku | string (povinné) Omezení počtu znaků: 3–50 Platné znaky: Alfanumerické znaky a pomlčky. Nemůže končit pomlčkam. Název prostředku musí být v rámci Azure jedinečný. |
location | Umístění prostředku. | string (povinné) |
parent_id | K nasazení do skupiny prostředků použijte ID této skupiny prostředků. | string (povinné) |
tags | Značky prostředků. | Slovník názvů a hodnot značek. |
Sku | Informace o skladové pou sadě IotHub | IotHubSkuInfo (povinné) |
Etag | Pole Etag není povinné. Pokud je uvedený v textu odpovědi, musí být také uvedený jako hlavička podle normální konvence ETag. | řetězec |
identity | Spravované identity pro IotHub | ArmIdentity |
properties | Vlastnosti IotHubu | IotHubVlastnosti |
ArmIdentity
Název | Description | Hodnota |
---|---|---|
typ | 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. | "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" |
identity_ids | Slovník uživatele {ArmUserIdentity} | Pole ID identit uživatelů |
ArmIdentityUserAssignedIdentities
Název | Description | Hodnota |
---|---|---|
{přizpůsobená vlastnost} | ArmUserIdentity |
ArmUserIdentity
Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou jen pro čtení.
IotHubVlastnosti
Název | Description | Hodnota |
---|---|---|
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 cloud-zařízení ve službě IoT Hub | CloudToDeviceProperties |
komentáře | Komentáře služby IoT Hub. | řetězec |
streamy zařízení | Zařízení streamuje vlastnosti iothubu. | IotHubPropertiesDeviceStreams |
enableFileUploadNotifications | Pokud má hodnotu True, oznámení o nahrání souboru jsou povolená. | bool |
šifrování | Vlastnosti šifrování pro centrum IoT. | Popis vlastností šifrování |
eventHubEndpoints | 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. | IotHubPropertiesEventHubEndpoints |
funkce | Možnosti a funkce povolené pro službu IoT Hub. | "DeviceManagement" "Žádné" |
ipFilterRules | Pravidla filtru IP adres. | IpFilterRule[] |
messagingEndpoints | Vlastnosti koncového bodu zasílání zpráv pro frontu oznámení o 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 být odmítnuti. | řetězec |
networkRuleSets | Vlastnosti sady pravidel sítě iotHubu | NetworkRuleSetProperties |
privateEndpointConnections | Připojení privátních koncových bodů vytvořená na tomto IotHubu | PrivateEndpointConnection[] |
publicNetworkAccess | Jestli jsou povolené požadavky z veřejné sítě | "Zakázáno" "Povoleno" |
Směrování | Vlastnosti ioT Hubu související se směrováním Viz: /azure/iot-hub/iot-hub-devguide-messaging. | Vlastnosti směrování |
koncové body úložiště | 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. | IotHubPropertiesStorageEndpoints |
SharedAccessSignatureAuthorizationRule
Název | Description | Hodnota |
---|---|---|
Název_klíče | 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" "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 (povinné) |
sekundární klíč | Sekundární klíč. | řetězec |
Název_klíče | 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" "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 (povinné) |
sekundární klíč | Sekundární klíč. | řetězec |
CloudToDeviceProperties
Název | Description | Hodnota |
---|---|---|
defaultTtlAsIso8601 | Výchozí doba života pro zprávy 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í | Zpětná vazbaVlastnosti |
maxDeliveryCount | Maximální počet doručení zpráv 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 |
Zpětná vazbaVlastnosti
Název | Description | Hodnota |
---|---|---|
lockDurationAsIso8601 | Doba trvání zámku pro frontu zpětné vazby Viz /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | řetězec |
maxDeliveryCount | Kolikrát se Centrum IoT pokusí doručit zprávu ve frontě 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ž vyprší platnost služby IoT Hub. Viz /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | řetězec |
IotHubPropertiesDeviceStreams
Název | Description | Hodnota |
---|---|---|
streamingEndpoints | Seznam koncových bodů streamů zařízení | string[] |
Popis encryptionPropertiesDescription
Název | Description | Hodnota |
---|---|---|
keySource | Zdroj klíče. | řetězec |
keyVaultProperties | Vlastnosti klíče KeyVault. | KeyVaultKeyProperties[] |
KeyVaultKeyProperties
Název | Description | Hodnota |
---|---|---|
identity | Vlastnosti spravované identity klíče KeyVault. | Spravovaná identita |
keyIdentifier | Identifikátor klíče. | řetězec |
Spravovaná identita
Název | Description | Hodnota |
---|---|---|
userAssignedIdentity | Identita přiřazená uživatelem. | řetězec |
IotHubPropertiesEventHubEndpoints
Název | Description | Hodnota |
---|---|---|
{přizpůsobená vlastnost} | EventHubProperties |
EventHubProperties
Název | Description | 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 zařízení-cloud ve dnech. Viz /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | int |
IpFilterRule
Název | Description | Hodnota |
---|---|---|
action | 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 pro pravidlo. | string (povinné) |
IotHubPropertiesMessagingEndpoints
Název | Description | Hodnota |
---|---|---|
{přizpůsobená vlastnost} | MessagingEndpointVlastnosti |
MessagingEndpointVlastnosti
Název | Description | Hodnota |
---|---|---|
lockDurationAsIso8601 | Doba trvání zámku. Viz /azure/iot-hub/iot-hub-devguide-file-upload. | řetězec |
maxDeliveryCount | Kolikrát se Centrum IoT pokusí doručit zprávu. 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ž vyprší platnost služby IoT Hub. Viz /azure/iot-hub/iot-hub-devguide-file-upload. | řetězec |
NetworkRuleSetProperties
Název | Description | Hodnota |
---|---|---|
applyToBuiltInEventHubEndpoint | Pokud je true, pak se sada pravidel sítě použije také na builtin EventHub EndPoint iotHubu. | bool (povinné) |
defaultAction | Výchozí akce pro sadu pravidel sítě | "Povolit" "Odepřít" |
ipRules | Seznam pravidel IP adres | NetworkRuleSetIpRule[] (povinné) |
NetworkRuleSetIpRule
Název | Description | Hodnota |
---|---|---|
action | 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 pro pravidlo. | string (povinné) |
PrivateEndpointConnection
Název | Description | Hodnota |
---|---|---|
properties | Vlastnosti připojení privátního koncového bodu | PrivateEndpointConnectionProperties (povinné) |
PrivateEndpointConnectionProperties
Název | Description | Hodnota |
---|---|---|
privátní koncový bod | Vlastnost privátního koncového bodu připojení privátního koncového bodu | Privátní koncový bod |
privateLinkServiceConnectionState | Aktuální stav připojení privátního koncového bodu | PrivateLinkServiceConnectionState (povinné) |
Privátní koncový bod
Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou Jen pro čtení.
PrivateLinkServiceConnectionState
Název | Description | Hodnota |
---|---|---|
actionsRequired | Akce vyžadované pro připojení privátního koncového bodu | řetězec |
description | Popis aktuálního stavu připojení privátního koncového bodu | string (povinné) |
status | Stav připojení privátního koncového bodu | "Schváleno" "Odpojeno" "Čeká na vyřízení" "Odmítnuto" (povinné) |
Vlastnosti směrování
Název | Description | 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á 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. | Koncové body směrování |
rozšiřování | 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 |
EnrichmentProperties[] |
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í nastavená, zprávy, které nesplňují žádnou z podmínek zadaných v části "routes", se přesměrují do integrovaného koncového bodu eventhubu. | 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á centra je povoleno maximálně 100 pravidel směrování a pro bezplatná centra je povoleno maximálně 5 pravidel směrování. | RouteProperties[] |
Koncové body směrování
Název | Description | Hodnota |
---|---|---|
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. | RoutingEventHubProperties[] |
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í. | RoutingServiceBusQueueEndpointProperties[] |
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í. | RoutingServiceBusTopicEndpointProperties[] |
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í. | RoutingStorageContainerProperties[] |
RoutingEventHubVlastnosti
Název | Description | Hodnota |
---|---|---|
authenticationType | Metoda použitá k ověření v koncovém bodu centra událostí | "identityBased" "keyBased" |
připojovací řetězec | Připojovací řetězec koncového bodu centra událostí. | řetězec |
identifikátor endpointUri | Adresa URL koncového bodu centra událostí. Musí obsahovat protokol sb:// | řetězec |
entityPath | Název centra událostí v oboru názvů centra událostí | řetězec |
id | ID koncového bodu centra událostí | řetězec |
identity | Vlastnosti spravované identity koncového bodu centra událostí směrování | Spravovaná identita |
name | 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ů. | string (povinné) Omezení: Pattern = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Název skupiny prostředků koncového bodu centra událostí. | řetězec |
subscriptionId | Identifikátor předplatného koncového bodu centra událostí. | řetězec |
RoutingServiceBusQueueEndpointProperties
Název | Description | Hodnota |
---|---|---|
authenticationType | Metoda použitá k ověření koncového bodu fronty služby Service Bus | "identityBased" "keyBased" |
připojovací řetězec | Připojovací řetězec koncového bodu fronty služby Service Bus. | řetězec |
identifikátor endpointUri | Adresa URL koncového bodu fronty služby Service Bus Musí obsahovat protokol sb:// | řetězec |
entityPath | Název fronty v oboru názvů služby Service Bus | řetězec |
id | ID koncového bodu fronty služby Service Bus | řetězec |
identity | Vlastnosti spravované identity koncového bodu fronty služby Service Bus. | Spravovaná identita |
name | 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. | string (povinné) Omezení: Pattern = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Název skupiny prostředků koncového bodu fronty služby Service Bus. | řetězec |
subscriptionId | Identifikátor předplatného koncového bodu fronty služby Service Bus. | řetězec |
RoutingServiceBusTopicEndpointProperties
Název | Description | Hodnota |
---|---|---|
authenticationType | Metoda použitá k ověření v koncovém bodu tématu služby Service Bus | "identityBased" "keyBased" |
připojovací řetězec | Připojovací řetězec koncového bodu tématu služby Service Bus. | řetězec |
identifikátor endpointUri | Adresa URL koncového bodu tématu služby Service Bus. Musí obsahovat protokol sb:// | řetězec |
entityPath | Název fronty v tématu služby Service Bus | řetězec |
id | ID koncového bodu tématu služby Service Bus | řetězec |
identity | Vlastnosti spravované identity koncového bodu tématu služby Service Bus. | Spravovaná identita |
name | 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. | string (povinné) Omezení: Pattern = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Název skupiny prostředků koncového bodu tématu služby Service Bus. | řetězec |
subscriptionId | Identifikátor předplatného koncového bodu tématu služby Service Bus. | řetězec |
RoutingStorageContainerProperties
Název | Description | Hodnota |
---|---|---|
authenticationType | Metoda použitá k ověření vůči koncovému bodu úložiště | "identityBased" "keyBased" |
batchFrequencyInSeconds | Č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. | int Omezení: Minimální hodnota = 60 Maximální hodnota = 720 |
připojovací řetězec | Připojovací řetězec účtu úložiště. | řetězec |
název_kontejneru | Název kontejneru úložiště v účtu úložiště. | string (povinné) |
encoding | 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. | "Avro" "AvroDeflate" "JSON" |
identifikátor endpointUri | Adresa URL koncového bodu úložiště. Musí obsahovat protokol https:// |
řetězec |
fileNameFormat | 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. | řetězec |
id | ID koncového bodu kontejneru úložiště | řetězec |
identity | Vlastnosti spravované identity koncového bodu úložiště směrování | Spravovaná identita |
maxChunkSizeInBytes | 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). | int Omezení: Minimální hodnota = 10485760 Maximální hodnota = 524288000 |
name | 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ů. | string (povinné) Omezení: Vzor = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Název skupiny prostředků účtu úložiště. | řetězec |
subscriptionId | Identifikátor předplatného účtu úložiště. | řetězec |
EnrichmentProperties
Název | Description | Hodnota |
---|---|---|
názvy koncových bodů | Seznam koncových bodů, pro které se rozšíření použije u zprávy. | string[] (povinné) Omezení: Minimální délka = 1 |
key | Klíč nebo název vlastnosti rozšiřování. | string (povinné) |
hodnota | Hodnota vlastnosti rozšiřování. | string (povinné) |
FallbackRouteVlastnosti
Název | Description | Hodnota |
---|---|---|
Podmínka | Podmínka, která se vyhodnocuje, aby se použila náhradní trasa. Pokud podmínka není zadá, ve výchozím nastavení se vyhodnotí jako pravda. Informace o gramatice najdete tady: /azure/iot-hub/iot-hub-devguide-query-language. | řetězec |
názvy koncových bodů | Seznam koncových bodů, na které jsou směrovány zprávy, které splňují podmínku. Aktuálně je povolený jenom 1 koncový bod. | string[] (povinné) Omezení: Minimální délka = 1 Maximální délka = 1 |
Isenabled | Slouží k určení, jestli je povolená náhradní trasa. | bool (povinné) |
name | 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 |
source | Zdroj, na který se má pravidlo směrování použít. Například DeviceMessages | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "DigitalTwinChangeEvents" "Neplatné" "TwinChangeEvents" (povinné) |
Vlastnosti trasy
Název | Description | Hodnota |
---|---|---|
Podmínka | Podmínka, která se vyhodnotí pro použití pravidla směrování. Pokud se nezadá žádná podmínka, ve výchozím nastavení se vyhodnotí jako pravda. Informace o gramatice najdete tady: /azure/iot-hub/iot-hub-devguide-query-language. | řetězec |
názvy koncových bodů | Seznam koncových bodů, na které jsou směrovány zprávy, které splňují podmínku. Aktuálně je povolený jenom jeden koncový bod. | string[] (povinné) Omezení: Minimální délka = 1 Maximální délka = 1 |
Isenabled | Používá se k určení, jestli je povolená trasa. | bool (povinné) |
name | 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ý. | string (povinné) Omezení: Vzor = ^[A-Za-z0-9-._]{1,64}$ |
source | Zdroj, na který se má pravidlo směrování použít, například DeviceMessages. | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "DigitalTwinChangeEvents" "Neplatné" "TwinChangeEvents" (povinné) |
IotHubPropertiesStorageEndpoints
Název | Description | Hodnota |
---|---|---|
{přizpůsobená vlastnost} | Vlastnosti koncového bodu úložiště |
Vlastnosti koncového bodu úložiště
Název | Description | Hodnota |
---|---|---|
authenticationType | Určuje typ ověřování, který se používá pro připojení k účtu úložiště. | "identityBased" "keyBased" |
připojovací řetězec | Připojovací řetězec pro účet Služby Azure Storage, do kterého se soubory nahrávají. | string (povinné) |
název_kontejneru | 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. | string (povinné) |
identity | Vlastnosti spravované identity koncového bodu úložiště pro nahrání souboru | Spravovaná identita |
sasTtlAsIso8601 | Doba, po kterou identifikátor URI SAS vygenerovaný IoT Hub pro nahrání souboru, je platná. Viz /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | řetězec |
IotHubSkuInfo
Název | Description | Hodnota |
---|---|---|
capacity | Počet zřízených jednotek IoT Hub. Viz /azure/azure-subscription-service-limits#iot-hub-limits. | int |
name | Název skladové položky. | "B1" "B2" "B3" "F1" "S1" "S2" "S3" (povinné) |