Microsoft.Devices IotHubs
- Terbaru
- 2023-06-30
- 2023-06-30-preview
- 2022-11-15-preview
- pratinjau 2022-04-30
- 2021-07-02
- pratinjau 2021-07-02
- 2021-07-01
- 2021-07-01-preview
- 2021-03-31
- pratinjau 2021-03-03
- pratinjau 2021-02-01
- 2020-08-31
- pratinjau 2020-08-31
- 2020-08-01
- pratinjau 2020-07-10
- 2020-06-15
- 2020-04-01
- 2020-03-01
- 2019-11-04
- pratinjau 2019-07-01
- 2019-03-22
- pratinjau 2019-03-22
- pratinjau 2018-12-01
- 2018-04-01
- 2018-01-22
- 2017-07-01
- 2017-01-19
- 2016-02-03
Definisi sumber daya Bicep
Jenis sumber daya IotHubs dapat disebarkan dengan operasi yang menargetkan:
Untuk daftar properti yang diubah di setiap versi API, lihat mengubah log.
Format sumber daya
Untuk membuat sumber daya Microsoft.Devices/IotHubs, tambahkan Bicep berikut ke templat Anda.
resource symbolicname 'Microsoft.Devices/IotHubs@2023-06-30' = {
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
enableDataResidency: 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: {
cosmosDBSqlContainers: [
{
authenticationType: 'string'
containerName: 'string'
databaseName: 'string'
endpointUri: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
partitionKeyName: 'string'
partitionKeyTemplate: 'string'
primaryKey: 'string'
resourceGroup: 'string'
secondaryKey: 'string'
subscriptionId: 'string'
}
]
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'
}
}
Nilai Properti
ArmIdentity
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned, UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'None' akan menghapus identitas apa pun dari layanan. | 'Tidak Ada' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | Kamus> ArmUserIdentity < | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
| Nama | Deskripsi | Nilai |
|---|
ArmUserIdentity
| Nama | Deskripsi | Nilai |
|---|
CloudToDeviceProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| defaultTtlAsIso8601 | Waktu default untuk hidup untuk pesan cloud-ke-perangkat dalam antrean perangkat. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | tali |
| umpan balik | Properti antrean umpan balik untuk pesan cloud-ke-perangkat. | FeedbackProperties |
| maxDeliveryCount | Jumlah pengiriman maksimum untuk pesan cloud-ke-perangkat dalam antrean perangkat. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Kendala: Nilai min = 1 Nilai maks = 100 |
EnrichmentProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| endpointNames | Daftar titik akhir yang pengayaannya diterapkan ke pesan. | string[] (diperlukan) |
| kunci | Kunci atau nama untuk properti pengayaan. | string (diperlukan) |
| nilai | Nilai untuk properti pengayaan. | string (diperlukan) |
EventHubProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| partitionCount | Jumlah partisi untuk menerima pesan perangkat ke cloud di titik akhir yang kompatibel dengan Pusat Aktivitas. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | Int |
| retentionTimeInDays | Waktu retensi untuk pesan perangkat-ke-cloud dalam beberapa hari. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | Int |
FallbackRouteProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| keadaan | Kondisi yang dievaluasi untuk menerapkan rute fallback. Jika kondisi tidak disediakan, kondisi akan mengevaluasi ke true secara default. Untuk tata bahasa, Lihat: /azure/iot-hub/iot-hub-devguide-query-language | tali |
| endpointNames | Daftar titik akhir tempat pesan yang memenuhi kondisi dirutekan. Saat ini hanya 1 titik akhir yang diizinkan. | string[] (diperlukan) |
| isEnabled | Digunakan untuk menentukan apakah rute fallback diaktifkan. | bool (diperlukan) |
| Nama | Nama rute. Nama hanya dapat mencakup karakter alfanumerik, titik, garis bawah, tanda hubung, memiliki panjang maksimum 64 karakter, dan harus unik. | tali |
| sumber | Sumber tempat aturan perutean akan diterapkan. Misalnya, DeviceMessages | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Tidak Valid' 'TwinChangeEvents' (diperlukan) |
FeedbackProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| lockDurationAsIso8601 | Durasi kunci untuk antrean umpan balik. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | tali |
| maxDeliveryCount | Frekuensi hub IoT mencoba mengirimkan pesan pada antrean umpan balik. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Kendala: Nilai min = 1 Nilai maks = 100 |
| ttlAsIso8601 | Periode waktu saat pesan tersedia untuk dikonsumsi sebelum kedaluwarsa oleh hub IoT. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | tali |
IotHubProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| allowedFqdnList | Daftar FQDN yang diizinkan (Nama Domain yang Sepenuhnya Memenuhi Syarat) untuk keluar dari Iot Hub. | string[] |
| authorizationPolicies | Kebijakan akses bersama yang dapat Anda gunakan untuk mengamankan koneksi ke hub IoT. | SharedAccessSignatureAuthorizationRule[] |
| cloudToDevice | Properti olahpesan cloud-ke-perangkat hub IoT. | CloudToDeviceProperties |
| Komentar | Komentar hub IoT. | tali |
| disableDeviceSAS | Jika true, semua perangkat (termasuk perangkat Edge tetapi tidak termasuk modul) kunci SAS terlingkup tidak dapat digunakan untuk autentikasi. | bool |
| disableLocalAuth | Jika true, token SAS dengan kunci SAS cakupan hub Iot tidak dapat digunakan untuk autentikasi. | bool |
| disableModuleSAS | Jika true, semua kunci SAS terlingkup modul tidak dapat digunakan untuk autentikasi. | bool |
| enableDataResidency | Properti ini ketika diatur ke true, akan mengaktifkan residensi data, dengan demikian, menonaktifkan pemulihan bencana. | bool |
| enableFileUploadNotifications | Jika True, pemberitahuan unggahan file diaktifkan. | bool |
| eventHubEndpoints | Properti titik akhir yang kompatibel dengan Pusat Aktivitas. Satu-satunya kunci yang mungkin untuk kamus ini adalah peristiwa. Kunci ini harus ada di kamus saat membuat atau memperbarui panggilan untuk hub IoT. | IotHubPropertiesEventHubEndpoints |
| Fitur | Kemampuan dan fitur yang diaktifkan untuk hub IoT. | 'DeviceManagement' 'Tidak Ada' |
| ipFilterRules | Aturan filter IP. | IpFilterRule [] |
| messagingEndpoints | Properti titik akhir olahpesan untuk antrean pemberitahuan unggahan file. | IotHubPropertiesMessagingEndpoints |
| minTlsVersion | Menentukan versi TLS minimum yang akan didukung untuk hub ini. Dapat diatur ke "1.2" agar klien yang menggunakan versi TLS di bawah 1.2 untuk ditolak. | tali |
| networkRuleSets | Properti Seperangkat Aturan Jaringan IotHub | networkRuleSetProperties |
| privateEndpointConnections | Koneksi titik akhir privat yang dibuat pada IotHub ini | privateEndpointConnection[] |
| publicNetworkAccess | Apakah permintaan dari Jaringan Publik diizinkan | 'Dinonaktifkan' 'Diaktifkan' |
| restrictOutboundNetworkAccess | Jika true, egress dari IotHub hanya akan dibatasi untuk FQDN yang diizinkan yang dikonfigurasi melalui allowedFqdnList. | bool |
| Routing | Properti terkait perutean hub IoT. Lihat: /azure/iot-hub/iot-hub-devguide-messaging | RoutingProperties |
| storageEndpoints | Daftar titik akhir Azure Storage tempat Anda dapat mengunggah file. Saat ini Anda hanya dapat mengonfigurasi satu akun Azure Storage dan harus memiliki kuncinya sebagai $default. Menentukan lebih dari satu akun penyimpanan menyebabkan kesalahan dilemparkan. Tidak menentukan nilai untuk properti ini ketika properti enableFileUploadNotifications diatur ke True, menyebabkan kesalahan dilemparkan. | IotHubPropertiesStorageEndpoints |
IotHubPropertiesEventHubEndpoints
| Nama | Deskripsi | Nilai |
|---|
IotHubPropertiesMessagingEndpoints
| Nama | Deskripsi | Nilai |
|---|
IotHubPropertiesStorageEndpoints
| Nama | Deskripsi | Nilai |
|---|
IotHubSkuInfo
| Nama | Deskripsi | Nilai |
|---|---|---|
| kapasitas | Jumlah unit IoT Hub yang disediakan. Lihat: /azure/azure-subscription-service-limits#iot-hub-limits. | Int |
| Nama | Nama SKU. | 'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' (diperlukan) |
IpFilterRule
| Nama | Deskripsi | Nilai |
|---|---|---|
| perbuatan | Tindakan yang diinginkan untuk permintaan yang diambil oleh aturan ini. | 'Terima' 'Tolak' (diperlukan) |
| filterName | Nama aturan filter IP. | string (diperlukan) |
| ipMask | String yang berisi rentang alamat IP dalam notasi CIDR untuk aturan tersebut. | string (diperlukan) |
ManagedIdentity
| Nama | Deskripsi | Nilai |
|---|---|---|
| userAssignedIdentity | Identitas yang ditetapkan pengguna. | tali |
MessagingEndpointProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| lockDurationAsIso8601 | Durasi kunci. Lihat: /azure/iot-hub/iot-hub-devguide-file-upload. | tali |
| maxDeliveryCount | Frekuensi hub IoT mencoba mengirimkan pesan. Lihat: /azure/iot-hub/iot-hub-devguide-file-upload. | Int Kendala: Nilai min = 1 Nilai maks = 100 |
| ttlAsIso8601 | Periode waktu saat pesan tersedia untuk dikonsumsi sebelum kedaluwarsa oleh hub IoT. Lihat: /azure/iot-hub/iot-hub-devguide-file-upload. | tali |
Microsoft.Devices/IotHubs
| Nama | Deskripsi | Nilai |
|---|---|---|
| etag | Bidang Etag tidak diperlukan. Jika disediakan dalam isi respons, itu juga harus disediakan sebagai header per konvensi ETag normal. | tali |
| identitas | Identitas terkelola untuk IotHub. | armidentitas |
| tempat | Lokasi sumber daya. | string (diperlukan) |
| Nama | Nama sumber daya | string (diperlukan) |
| Properti | Properti IotHub | IotHubProperties |
| Sku | Info SKU IotHub | IotHubSkuInfo (diperlukan) |
| Tags | Tag sumber daya | Kamus nama dan nilai tag. Lihat Tag dalam templat |
NetworkRuleSetIpRule
| Nama | Deskripsi | Nilai |
|---|---|---|
| perbuatan | Tindakan Filter IP | 'Izinkan' |
| filterName | Nama aturan filter IP. | string (diperlukan) |
| ipMask | String yang berisi rentang alamat IP dalam notasi CIDR untuk aturan tersebut. | string (diperlukan) |
NetworkRuleSetProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| applyToBuiltInEventHubEndpoint | Jika True, maka Seperangkat Aturan Jaringan juga diterapkan ke Titik Akhir BuiltIn EventHub dari IotHub | bool (diperlukan) |
| defaultAction | Tindakan Default untuk Seperangkat Aturan Jaringan | 'Izinkan' 'Tolak' |
| ipRules | Daftar Aturan IP | NetworkRuleSetIpRule[] (diperlukan) |
PrivateEndpoint
| Nama | Deskripsi | Nilai |
|---|
PrivateEndpointConnection
| Nama | Deskripsi | Nilai |
|---|---|---|
| Properti | Properti koneksi titik akhir privat | privateEndpointConnectionProperties (diperlukan) |
PrivateEndpointConnectionProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| privateEndpoint | Properti titik akhir privat dari koneksi titik akhir privat | PrivateEndpoint |
| privateLinkServiceConnectionState | Status koneksi titik akhir privat saat ini | privateLinkServiceConnectionState (diperlukan) |
PrivateLinkServiceConnectionState
| Nama | Deskripsi | Nilai |
|---|---|---|
| actionsRequired | Tindakan yang diperlukan untuk koneksi titik akhir privat | tali |
| deskripsi | Deskripsi untuk status koneksi titik akhir privat saat ini | string (diperlukan) |
| keadaan | Status koneksi titik akhir privat | 'Disetujui' 'Terputus' 'Tertunda' 'Ditolak' (diperlukan) |
ResourceTags
| Nama | Deskripsi | Nilai |
|---|
RouteProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| keadaan | Kondisi yang dievaluasi untuk menerapkan aturan perutean. Jika tidak ada kondisi yang disediakan, kondisi akan mengevaluasi ke true secara default. Untuk tata bahasa, lihat: /azure/iot-hub/iot-hub-devguide-query-language | tali |
| endpointNames | Daftar titik akhir tempat pesan yang memenuhi kondisi dirutekan. Saat ini hanya satu titik akhir yang diizinkan. | string[] (diperlukan) |
| isEnabled | Digunakan untuk menentukan apakah rute diaktifkan. | bool (diperlukan) |
| Nama | Nama rute. Nama hanya dapat mencakup karakter alfanumerik, titik, garis bawah, tanda hubung, memiliki panjang maksimum 64 karakter, dan harus unik. | tali Kendala: Pola = ^[A-Za-z0-9-._]{1,64}$ (diperlukan) |
| sumber | Sumber tempat aturan perutean akan diterapkan, seperti DeviceMessages. | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Tidak Valid' 'TwinChangeEvents' (diperlukan) |
RoutingCosmosDBSqlApiProperties
RoutingEndpoints
| Nama | Deskripsi | Nilai |
|---|---|---|
| cosmosDBSqlContainers | Daftar titik akhir kontainer Cosmos DB tempat hub IoT merutekan pesan, berdasarkan aturan perutean. | RoutingCosmosDBSqlApiProperties[] |
| eventHubs | Daftar titik akhir Azure Event Hubs tempat hub IoT merutekan pesan, berdasarkan aturan perutean. Daftar ini tidak menyertakan titik akhir Azure Event Hubs bawaan. | RoutingEventHubProperties[] |
| serviceBusQueues | Daftar titik akhir antrean Bus Layanan tempat hub IoT merutekan pesan, berdasarkan aturan perutean. | RoutingServiceBusQueueEndpointProperties[] |
| serviceBusTopics | Daftar titik akhir topik Bus Layanan tempat hub IoT merutekan pesan, berdasarkan aturan perutean. | RoutingServiceBusTopicEndpointProperties[] |
| storageContainers | Daftar titik akhir kontainer penyimpanan tempat hub IoT merutekan pesan, berdasarkan aturan perutean. | RoutingStorageContainerProperties[] |
RoutingEventHubProperties
RoutingProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| Endpoint | Properti yang terkait dengan titik akhir kustom tempat hub IoT Anda merutekan pesan berdasarkan aturan perutean. Maksimal 10 titik akhir kustom diizinkan di semua jenis titik akhir untuk hub berbayar dan hanya 1 titik akhir kustom yang diizinkan di semua jenis titik akhir untuk hub gratis. | RoutingEndpoints |
| pengayaan | Daftar pengayaan yang disediakan pengguna yang diterapkan hub IoT ke pesan yang akan dikirimkan ke titik akhir bawaan dan kustom. Lihat: https://aka.ms/telemetryoneventgrid | EnrichmentProperties[] |
| fallbackRoute | Properti rute yang digunakan sebagai rute fall-back ketika tidak ada kondisi yang ditentukan di bagian 'rute' yang terpenuhi. Ini adalah parameter opsional. Ketika properti ini tidak ada dalam templat, rute fallback dinonaktifkan secara default. | FallbackRouteProperties |
| Rute | Daftar aturan perutean yang disediakan pengguna yang digunakan hub IoT untuk merutekan pesan ke titik akhir bawaan dan kustom. Maksimal 100 aturan perutean diizinkan untuk hub berbayar dan maksimum 5 aturan perutean diizinkan untuk hub gratis. | RouteProperties[] |
RoutingServiceBusQueueEndpointProperties
RoutingServiceBusTopicEndpointProperties
RoutingStorageContainerProperties
SharedAccessSignatureAuthorizationRule
| Nama | Deskripsi | Nilai |
|---|---|---|
| keyName | Nama kebijakan akses bersama. | string (diperlukan) |
| primaryKey | Kunci utama. | tali |
| hak | Izin yang ditetapkan ke kebijakan akses bersama. | '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' (diperlukan) |
| secondaryKey | Kunci sekunder. | tali |
StorageEndpointProperties
Contoh Penggunaan
Sampel Mulai Cepat Azure
Templat Mulai Cepat Azure berikut ini berisi sampel Bicep untuk menyebarkan jenis sumber daya ini.
| Bicep File | Deskripsi |
|---|---|
| Membuat IoT Hub dan Grup Konsumen Perangkat ke Cloud | Templat ini memungkinkan Anda menyebarkan instans IoT Hub dengan konfigurasi olahpesan perangkat ke cloud dan cloud ke perangkat dan grup konsumen perangkat ke cloud. |
| Membuat IoT Hub Device Provisioning Service | Templat ini memungkinkan Anda membuat hub IoT dan IoT Hub Device Provisioning Service, dan menautkan kedua layanan bersama-sama. |
| Membuat Pembaruan Perangkat untuk akun IoT Hub, instans, IoT Hub | Templat ini membuat akun, dan instans dan hub untuk menautkan instans. Ini mengonfigurasi hub dengan polisi akses, rute, dan grup konsumen yang diperlukan. |
| Menyebarkan layanan MedTech termasuk azure IoT Hub | Layanan MedTech adalah salah satu Azure Health Data Services yang dirancang untuk menyerap data perangkat dari beberapa perangkat, mengubah data perangkat menjadi Pengamatan FHIR, yang kemudian disimpan dalam layanan Azure Health Data Services FHIR. |
| Menggunakan templat ARM untuk membuat IoT Hub, merutekan, dan melihat pesan | Gunakan templat ini untuk menyebarkan IoT Hub dan akun penyimpanan. Jalankan aplikasi untuk mengirim pesan ke hub yang dirutekan ke penyimpanan, lalu lihat hasilnya. |
Definisi sumber daya templat ARM
Jenis sumber daya IotHubs dapat disebarkan dengan operasi yang menargetkan:
Untuk daftar properti yang diubah di setiap versi API, lihat mengubah log.
Format sumber daya
Untuk membuat sumber daya Microsoft.Devices/IotHubs, tambahkan JSON berikut ke templat Anda.
{
"type": "Microsoft.Devices/IotHubs",
"apiVersion": "2023-06-30",
"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",
"enableDataResidency": "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": {
"cosmosDBSqlContainers": [
{
"authenticationType": "string",
"containerName": "string",
"databaseName": "string",
"endpointUri": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"partitionKeyName": "string",
"partitionKeyTemplate": "string",
"primaryKey": "string",
"resourceGroup": "string",
"secondaryKey": "string",
"subscriptionId": "string"
}
],
"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"
}
}
Nilai Properti
ArmIdentity
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned, UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'None' akan menghapus identitas apa pun dari layanan. | 'Tidak Ada' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | Kamus> ArmUserIdentity < | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
| Nama | Deskripsi | Nilai |
|---|
ArmUserIdentity
| Nama | Deskripsi | Nilai |
|---|
CloudToDeviceProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| defaultTtlAsIso8601 | Waktu default untuk hidup untuk pesan cloud-ke-perangkat dalam antrean perangkat. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | tali |
| umpan balik | Properti antrean umpan balik untuk pesan cloud-ke-perangkat. | FeedbackProperties |
| maxDeliveryCount | Jumlah pengiriman maksimum untuk pesan cloud-ke-perangkat dalam antrean perangkat. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Kendala: Nilai min = 1 Nilai maks = 100 |
EnrichmentProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| endpointNames | Daftar titik akhir yang pengayaannya diterapkan ke pesan. | string[] (diperlukan) |
| kunci | Kunci atau nama untuk properti pengayaan. | string (diperlukan) |
| nilai | Nilai untuk properti pengayaan. | string (diperlukan) |
EventHubProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| partitionCount | Jumlah partisi untuk menerima pesan perangkat ke cloud di titik akhir yang kompatibel dengan Pusat Aktivitas. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | Int |
| retentionTimeInDays | Waktu retensi untuk pesan perangkat-ke-cloud dalam beberapa hari. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | Int |
FallbackRouteProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| keadaan | Kondisi yang dievaluasi untuk menerapkan rute fallback. Jika kondisi tidak disediakan, kondisi akan mengevaluasi ke true secara default. Untuk tata bahasa, Lihat: /azure/iot-hub/iot-hub-devguide-query-language | tali |
| endpointNames | Daftar titik akhir tempat pesan yang memenuhi kondisi dirutekan. Saat ini hanya 1 titik akhir yang diizinkan. | string[] (diperlukan) |
| isEnabled | Digunakan untuk menentukan apakah rute fallback diaktifkan. | bool (diperlukan) |
| Nama | Nama rute. Nama hanya dapat mencakup karakter alfanumerik, titik, garis bawah, tanda hubung, memiliki panjang maksimum 64 karakter, dan harus unik. | tali |
| sumber | Sumber tempat aturan perutean akan diterapkan. Misalnya, DeviceMessages | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Tidak Valid' 'TwinChangeEvents' (diperlukan) |
FeedbackProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| lockDurationAsIso8601 | Durasi kunci untuk antrean umpan balik. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | tali |
| maxDeliveryCount | Frekuensi hub IoT mencoba mengirimkan pesan pada antrean umpan balik. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Kendala: Nilai min = 1 Nilai maks = 100 |
| ttlAsIso8601 | Periode waktu saat pesan tersedia untuk dikonsumsi sebelum kedaluwarsa oleh hub IoT. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | tali |
IotHubProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| allowedFqdnList | Daftar FQDN yang diizinkan (Nama Domain yang Sepenuhnya Memenuhi Syarat) untuk keluar dari Iot Hub. | string[] |
| authorizationPolicies | Kebijakan akses bersama yang dapat Anda gunakan untuk mengamankan koneksi ke hub IoT. | SharedAccessSignatureAuthorizationRule[] |
| cloudToDevice | Properti olahpesan cloud-ke-perangkat hub IoT. | CloudToDeviceProperties |
| Komentar | Komentar hub IoT. | tali |
| disableDeviceSAS | Jika true, semua perangkat (termasuk perangkat Edge tetapi tidak termasuk modul) kunci SAS terlingkup tidak dapat digunakan untuk autentikasi. | bool |
| disableLocalAuth | Jika true, token SAS dengan kunci SAS cakupan hub Iot tidak dapat digunakan untuk autentikasi. | bool |
| disableModuleSAS | Jika true, semua kunci SAS terlingkup modul tidak dapat digunakan untuk autentikasi. | bool |
| enableDataResidency | Properti ini ketika diatur ke true, akan mengaktifkan residensi data, dengan demikian, menonaktifkan pemulihan bencana. | bool |
| enableFileUploadNotifications | Jika True, pemberitahuan unggahan file diaktifkan. | bool |
| eventHubEndpoints | Properti titik akhir yang kompatibel dengan Pusat Aktivitas. Satu-satunya kunci yang mungkin untuk kamus ini adalah peristiwa. Kunci ini harus ada di kamus saat membuat atau memperbarui panggilan untuk hub IoT. | IotHubPropertiesEventHubEndpoints |
| Fitur | Kemampuan dan fitur yang diaktifkan untuk hub IoT. | 'DeviceManagement' 'Tidak Ada' |
| ipFilterRules | Aturan filter IP. | IpFilterRule [] |
| messagingEndpoints | Properti titik akhir olahpesan untuk antrean pemberitahuan unggahan file. | IotHubPropertiesMessagingEndpoints |
| minTlsVersion | Menentukan versi TLS minimum yang akan didukung untuk hub ini. Dapat diatur ke "1.2" agar klien yang menggunakan versi TLS di bawah 1.2 untuk ditolak. | tali |
| networkRuleSets | Properti Seperangkat Aturan Jaringan IotHub | networkRuleSetProperties |
| privateEndpointConnections | Koneksi titik akhir privat yang dibuat pada IotHub ini | privateEndpointConnection[] |
| publicNetworkAccess | Apakah permintaan dari Jaringan Publik diizinkan | 'Dinonaktifkan' 'Diaktifkan' |
| restrictOutboundNetworkAccess | Jika true, egress dari IotHub hanya akan dibatasi untuk FQDN yang diizinkan yang dikonfigurasi melalui allowedFqdnList. | bool |
| Routing | Properti terkait perutean hub IoT. Lihat: /azure/iot-hub/iot-hub-devguide-messaging | RoutingProperties |
| storageEndpoints | Daftar titik akhir Azure Storage tempat Anda dapat mengunggah file. Saat ini Anda hanya dapat mengonfigurasi satu akun Azure Storage dan harus memiliki kuncinya sebagai $default. Menentukan lebih dari satu akun penyimpanan menyebabkan kesalahan dilemparkan. Tidak menentukan nilai untuk properti ini ketika properti enableFileUploadNotifications diatur ke True, menyebabkan kesalahan dilemparkan. | IotHubPropertiesStorageEndpoints |
IotHubPropertiesEventHubEndpoints
| Nama | Deskripsi | Nilai |
|---|
IotHubPropertiesMessagingEndpoints
| Nama | Deskripsi | Nilai |
|---|
IotHubPropertiesStorageEndpoints
| Nama | Deskripsi | Nilai |
|---|
IotHubSkuInfo
| Nama | Deskripsi | Nilai |
|---|---|---|
| kapasitas | Jumlah unit IoT Hub yang disediakan. Lihat: /azure/azure-subscription-service-limits#iot-hub-limits. | Int |
| Nama | Nama SKU. | 'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' (diperlukan) |
IpFilterRule
| Nama | Deskripsi | Nilai |
|---|---|---|
| perbuatan | Tindakan yang diinginkan untuk permintaan yang diambil oleh aturan ini. | 'Terima' 'Tolak' (diperlukan) |
| filterName | Nama aturan filter IP. | string (diperlukan) |
| ipMask | String yang berisi rentang alamat IP dalam notasi CIDR untuk aturan tersebut. | string (diperlukan) |
ManagedIdentity
| Nama | Deskripsi | Nilai |
|---|---|---|
| userAssignedIdentity | Identitas yang ditetapkan pengguna. | tali |
MessagingEndpointProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| lockDurationAsIso8601 | Durasi kunci. Lihat: /azure/iot-hub/iot-hub-devguide-file-upload. | tali |
| maxDeliveryCount | Frekuensi hub IoT mencoba mengirimkan pesan. Lihat: /azure/iot-hub/iot-hub-devguide-file-upload. | Int Kendala: Nilai min = 1 Nilai maks = 100 |
| ttlAsIso8601 | Periode waktu saat pesan tersedia untuk dikonsumsi sebelum kedaluwarsa oleh hub IoT. Lihat: /azure/iot-hub/iot-hub-devguide-file-upload. | tali |
Microsoft.Devices/IotHubs
| Nama | Deskripsi | Nilai |
|---|---|---|
| apiVersion | Versi api | '2023-06-30' |
| etag | Bidang Etag tidak diperlukan. Jika disediakan dalam isi respons, itu juga harus disediakan sebagai header per konvensi ETag normal. | tali |
| identitas | Identitas terkelola untuk IotHub. | armidentitas |
| tempat | Lokasi sumber daya. | string (diperlukan) |
| Nama | Nama sumber daya | string (diperlukan) |
| Properti | Properti IotHub | IotHubProperties |
| Sku | Info SKU IotHub | IotHubSkuInfo (diperlukan) |
| Tags | Tag sumber daya | Kamus nama dan nilai tag. Lihat Tag dalam templat |
| jenis | Jenis sumber daya | 'Microsoft.Devices/IotHubs' |
NetworkRuleSetIpRule
| Nama | Deskripsi | Nilai |
|---|---|---|
| perbuatan | Tindakan Filter IP | 'Izinkan' |
| filterName | Nama aturan filter IP. | string (diperlukan) |
| ipMask | String yang berisi rentang alamat IP dalam notasi CIDR untuk aturan tersebut. | string (diperlukan) |
NetworkRuleSetProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| applyToBuiltInEventHubEndpoint | Jika True, maka Seperangkat Aturan Jaringan juga diterapkan ke Titik Akhir BuiltIn EventHub dari IotHub | bool (diperlukan) |
| defaultAction | Tindakan Default untuk Seperangkat Aturan Jaringan | 'Izinkan' 'Tolak' |
| ipRules | Daftar Aturan IP | NetworkRuleSetIpRule[] (diperlukan) |
PrivateEndpoint
| Nama | Deskripsi | Nilai |
|---|
PrivateEndpointConnection
| Nama | Deskripsi | Nilai |
|---|---|---|
| Properti | Properti koneksi titik akhir privat | privateEndpointConnectionProperties (diperlukan) |
PrivateEndpointConnectionProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| privateEndpoint | Properti titik akhir privat dari koneksi titik akhir privat | PrivateEndpoint |
| privateLinkServiceConnectionState | Status koneksi titik akhir privat saat ini | privateLinkServiceConnectionState (diperlukan) |
PrivateLinkServiceConnectionState
| Nama | Deskripsi | Nilai |
|---|---|---|
| actionsRequired | Tindakan yang diperlukan untuk koneksi titik akhir privat | tali |
| deskripsi | Deskripsi untuk status koneksi titik akhir privat saat ini | string (diperlukan) |
| keadaan | Status koneksi titik akhir privat | 'Disetujui' 'Terputus' 'Tertunda' 'Ditolak' (diperlukan) |
ResourceTags
| Nama | Deskripsi | Nilai |
|---|
RouteProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| keadaan | Kondisi yang dievaluasi untuk menerapkan aturan perutean. Jika tidak ada kondisi yang disediakan, kondisi akan mengevaluasi ke true secara default. Untuk tata bahasa, lihat: /azure/iot-hub/iot-hub-devguide-query-language | tali |
| endpointNames | Daftar titik akhir tempat pesan yang memenuhi kondisi dirutekan. Saat ini hanya satu titik akhir yang diizinkan. | string[] (diperlukan) |
| isEnabled | Digunakan untuk menentukan apakah rute diaktifkan. | bool (diperlukan) |
| Nama | Nama rute. Nama hanya dapat mencakup karakter alfanumerik, titik, garis bawah, tanda hubung, memiliki panjang maksimum 64 karakter, dan harus unik. | tali Kendala: Pola = ^[A-Za-z0-9-._]{1,64}$ (diperlukan) |
| sumber | Sumber tempat aturan perutean akan diterapkan, seperti DeviceMessages. | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Tidak Valid' 'TwinChangeEvents' (diperlukan) |
RoutingCosmosDBSqlApiProperties
RoutingEndpoints
| Nama | Deskripsi | Nilai |
|---|---|---|
| cosmosDBSqlContainers | Daftar titik akhir kontainer Cosmos DB tempat hub IoT merutekan pesan, berdasarkan aturan perutean. | RoutingCosmosDBSqlApiProperties[] |
| eventHubs | Daftar titik akhir Azure Event Hubs tempat hub IoT merutekan pesan, berdasarkan aturan perutean. Daftar ini tidak menyertakan titik akhir Azure Event Hubs bawaan. | RoutingEventHubProperties[] |
| serviceBusQueues | Daftar titik akhir antrean Bus Layanan tempat hub IoT merutekan pesan, berdasarkan aturan perutean. | RoutingServiceBusQueueEndpointProperties[] |
| serviceBusTopics | Daftar titik akhir topik Bus Layanan tempat hub IoT merutekan pesan, berdasarkan aturan perutean. | RoutingServiceBusTopicEndpointProperties[] |
| storageContainers | Daftar titik akhir kontainer penyimpanan tempat hub IoT merutekan pesan, berdasarkan aturan perutean. | RoutingStorageContainerProperties[] |
RoutingEventHubProperties
RoutingProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| Endpoint | Properti yang terkait dengan titik akhir kustom tempat hub IoT Anda merutekan pesan berdasarkan aturan perutean. Maksimal 10 titik akhir kustom diizinkan di semua jenis titik akhir untuk hub berbayar dan hanya 1 titik akhir kustom yang diizinkan di semua jenis titik akhir untuk hub gratis. | RoutingEndpoints |
| pengayaan | Daftar pengayaan yang disediakan pengguna yang diterapkan hub IoT ke pesan yang akan dikirimkan ke titik akhir bawaan dan kustom. Lihat: https://aka.ms/telemetryoneventgrid | EnrichmentProperties[] |
| fallbackRoute | Properti rute yang digunakan sebagai rute fall-back ketika tidak ada kondisi yang ditentukan di bagian 'rute' yang terpenuhi. Ini adalah parameter opsional. Ketika properti ini tidak ada dalam templat, rute fallback dinonaktifkan secara default. | FallbackRouteProperties |
| Rute | Daftar aturan perutean yang disediakan pengguna yang digunakan hub IoT untuk merutekan pesan ke titik akhir bawaan dan kustom. Maksimal 100 aturan perutean diizinkan untuk hub berbayar dan maksimum 5 aturan perutean diizinkan untuk hub gratis. | RouteProperties[] |
RoutingServiceBusQueueEndpointProperties
RoutingServiceBusTopicEndpointProperties
RoutingStorageContainerProperties
SharedAccessSignatureAuthorizationRule
| Nama | Deskripsi | Nilai |
|---|---|---|
| keyName | Nama kebijakan akses bersama. | string (diperlukan) |
| primaryKey | Kunci utama. | tali |
| hak | Izin yang ditetapkan ke kebijakan akses bersama. | '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' (diperlukan) |
| secondaryKey | Kunci sekunder. | tali |
StorageEndpointProperties
Contoh Penggunaan
Templat Mulai Cepat Azure
Templat Mulai Cepat Azure berikut ini menyebarkan jenis sumber daya ini.
| Templat | Deskripsi |
|---|---|
Membuat Lingkungan Bayar Sesuai Penggunaan (PAYG) dengan IoT Hub
|
Templat ini memungkinkan Anda untuk menyebarkan lingkungan Pay As You Go (PAYG) Time Series Insights yang dikonfigurasi untuk menggunakan peristiwa dari IoT Hub. |
|
Membuat IoT Hub dan Grup Konsumen Perangkat ke Cloud
|
Templat ini memungkinkan Anda menyebarkan instans IoT Hub dengan konfigurasi olahpesan perangkat ke cloud dan cloud ke perangkat dan grup konsumen perangkat ke cloud. |
|
Membuat IOT Hub dan simulator tepi Ubuntu
|
Templat ini membuat simulator tepi IOT Hub dan Virtual Machine Ubuntu. |
|
Membuat IoT Hub Device Provisioning Service
|
Templat ini memungkinkan Anda membuat hub IoT dan IoT Hub Device Provisioning Service, dan menautkan kedua layanan bersama-sama. |
|
Membuat Pembaruan Perangkat untuk akun IoT Hub, instans, IoT Hub
|
Templat ini membuat akun, dan instans dan hub untuk menautkan instans. Ini mengonfigurasi hub dengan polisi akses, rute, dan grup konsumen yang diperlukan. |
|
Menyebarkan layanan MedTech termasuk azure IoT Hub
|
Layanan MedTech adalah salah satu Azure Health Data Services yang dirancang untuk menyerap data perangkat dari beberapa perangkat, mengubah data perangkat menjadi Pengamatan FHIR, yang kemudian disimpan dalam layanan Azure Health Data Services FHIR. |
|
Menggunakan templat ARM untuk membuat IoT Hub, merutekan, dan melihat pesan
|
Gunakan templat ini untuk menyebarkan IoT Hub dan akun penyimpanan. Jalankan aplikasi untuk mengirim pesan ke hub yang dirutekan ke penyimpanan, lalu lihat hasilnya. |
Definisi sumber daya Terraform (penyedia AzAPI)
Jenis sumber daya IotHubs dapat disebarkan dengan operasi yang menargetkan:
- grup Sumber Daya
Untuk daftar properti yang diubah di setiap versi API, lihat mengubah log.
Format sumber daya
Untuk membuat sumber daya Microsoft.Devices/IotHubs, tambahkan Terraform berikut ke templat Anda.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Devices/IotHubs@2023-06-30"
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
enableDataResidency = 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 = {
cosmosDBSqlContainers = [
{
authenticationType = "string"
containerName = "string"
databaseName = "string"
endpointUri = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
partitionKeyName = "string"
partitionKeyTemplate = "string"
primaryKey = "string"
resourceGroup = "string"
secondaryKey = "string"
subscriptionId = "string"
}
]
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"
}
}
}
})
}
Nilai Properti
ArmIdentity
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned, UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'None' akan menghapus identitas apa pun dari layanan. | 'Tidak Ada' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | Kamus> ArmUserIdentity < | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
| Nama | Deskripsi | Nilai |
|---|
ArmUserIdentity
| Nama | Deskripsi | Nilai |
|---|
CloudToDeviceProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| defaultTtlAsIso8601 | Waktu default untuk hidup untuk pesan cloud-ke-perangkat dalam antrean perangkat. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | tali |
| umpan balik | Properti antrean umpan balik untuk pesan cloud-ke-perangkat. | FeedbackProperties |
| maxDeliveryCount | Jumlah pengiriman maksimum untuk pesan cloud-ke-perangkat dalam antrean perangkat. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Kendala: Nilai min = 1 Nilai maks = 100 |
EnrichmentProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| endpointNames | Daftar titik akhir yang pengayaannya diterapkan ke pesan. | string[] (diperlukan) |
| kunci | Kunci atau nama untuk properti pengayaan. | string (diperlukan) |
| nilai | Nilai untuk properti pengayaan. | string (diperlukan) |
EventHubProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| partitionCount | Jumlah partisi untuk menerima pesan perangkat ke cloud di titik akhir yang kompatibel dengan Pusat Aktivitas. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | Int |
| retentionTimeInDays | Waktu retensi untuk pesan perangkat-ke-cloud dalam beberapa hari. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | Int |
FallbackRouteProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| keadaan | Kondisi yang dievaluasi untuk menerapkan rute fallback. Jika kondisi tidak disediakan, kondisi akan mengevaluasi ke true secara default. Untuk tata bahasa, Lihat: /azure/iot-hub/iot-hub-devguide-query-language | tali |
| endpointNames | Daftar titik akhir tempat pesan yang memenuhi kondisi dirutekan. Saat ini hanya 1 titik akhir yang diizinkan. | string[] (diperlukan) |
| isEnabled | Digunakan untuk menentukan apakah rute fallback diaktifkan. | bool (diperlukan) |
| Nama | Nama rute. Nama hanya dapat mencakup karakter alfanumerik, titik, garis bawah, tanda hubung, memiliki panjang maksimum 64 karakter, dan harus unik. | tali |
| sumber | Sumber tempat aturan perutean akan diterapkan. Misalnya, DeviceMessages | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Tidak Valid' 'TwinChangeEvents' (diperlukan) |
FeedbackProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| lockDurationAsIso8601 | Durasi kunci untuk antrean umpan balik. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | tali |
| maxDeliveryCount | Frekuensi hub IoT mencoba mengirimkan pesan pada antrean umpan balik. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Kendala: Nilai min = 1 Nilai maks = 100 |
| ttlAsIso8601 | Periode waktu saat pesan tersedia untuk dikonsumsi sebelum kedaluwarsa oleh hub IoT. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | tali |
IotHubProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| allowedFqdnList | Daftar FQDN yang diizinkan (Nama Domain yang Sepenuhnya Memenuhi Syarat) untuk keluar dari Iot Hub. | string[] |
| authorizationPolicies | Kebijakan akses bersama yang dapat Anda gunakan untuk mengamankan koneksi ke hub IoT. | SharedAccessSignatureAuthorizationRule[] |
| cloudToDevice | Properti olahpesan cloud-ke-perangkat hub IoT. | CloudToDeviceProperties |
| Komentar | Komentar hub IoT. | tali |
| disableDeviceSAS | Jika true, semua perangkat (termasuk perangkat Edge tetapi tidak termasuk modul) kunci SAS terlingkup tidak dapat digunakan untuk autentikasi. | bool |
| disableLocalAuth | Jika true, token SAS dengan kunci SAS cakupan hub Iot tidak dapat digunakan untuk autentikasi. | bool |
| disableModuleSAS | Jika true, semua kunci SAS terlingkup modul tidak dapat digunakan untuk autentikasi. | bool |
| enableDataResidency | Properti ini ketika diatur ke true, akan mengaktifkan residensi data, dengan demikian, menonaktifkan pemulihan bencana. | bool |
| enableFileUploadNotifications | Jika True, pemberitahuan unggahan file diaktifkan. | bool |
| eventHubEndpoints | Properti titik akhir yang kompatibel dengan Pusat Aktivitas. Satu-satunya kunci yang mungkin untuk kamus ini adalah peristiwa. Kunci ini harus ada di kamus saat membuat atau memperbarui panggilan untuk hub IoT. | IotHubPropertiesEventHubEndpoints |
| Fitur | Kemampuan dan fitur yang diaktifkan untuk hub IoT. | 'DeviceManagement' 'Tidak Ada' |
| ipFilterRules | Aturan filter IP. | IpFilterRule [] |
| messagingEndpoints | Properti titik akhir olahpesan untuk antrean pemberitahuan unggahan file. | IotHubPropertiesMessagingEndpoints |
| minTlsVersion | Menentukan versi TLS minimum yang akan didukung untuk hub ini. Dapat diatur ke "1.2" agar klien yang menggunakan versi TLS di bawah 1.2 untuk ditolak. | tali |
| networkRuleSets | Properti Seperangkat Aturan Jaringan IotHub | networkRuleSetProperties |
| privateEndpointConnections | Koneksi titik akhir privat yang dibuat pada IotHub ini | privateEndpointConnection[] |
| publicNetworkAccess | Apakah permintaan dari Jaringan Publik diizinkan | 'Dinonaktifkan' 'Diaktifkan' |
| restrictOutboundNetworkAccess | Jika true, egress dari IotHub hanya akan dibatasi untuk FQDN yang diizinkan yang dikonfigurasi melalui allowedFqdnList. | bool |
| Routing | Properti terkait perutean hub IoT. Lihat: /azure/iot-hub/iot-hub-devguide-messaging | RoutingProperties |
| storageEndpoints | Daftar titik akhir Azure Storage tempat Anda dapat mengunggah file. Saat ini Anda hanya dapat mengonfigurasi satu akun Azure Storage dan harus memiliki kuncinya sebagai $default. Menentukan lebih dari satu akun penyimpanan menyebabkan kesalahan dilemparkan. Tidak menentukan nilai untuk properti ini ketika properti enableFileUploadNotifications diatur ke True, menyebabkan kesalahan dilemparkan. | IotHubPropertiesStorageEndpoints |
IotHubPropertiesEventHubEndpoints
| Nama | Deskripsi | Nilai |
|---|
IotHubPropertiesMessagingEndpoints
| Nama | Deskripsi | Nilai |
|---|
IotHubPropertiesStorageEndpoints
| Nama | Deskripsi | Nilai |
|---|
IotHubSkuInfo
| Nama | Deskripsi | Nilai |
|---|---|---|
| kapasitas | Jumlah unit IoT Hub yang disediakan. Lihat: /azure/azure-subscription-service-limits#iot-hub-limits. | Int |
| Nama | Nama SKU. | 'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' (diperlukan) |
IpFilterRule
| Nama | Deskripsi | Nilai |
|---|---|---|
| perbuatan | Tindakan yang diinginkan untuk permintaan yang diambil oleh aturan ini. | 'Terima' 'Tolak' (diperlukan) |
| filterName | Nama aturan filter IP. | string (diperlukan) |
| ipMask | String yang berisi rentang alamat IP dalam notasi CIDR untuk aturan tersebut. | string (diperlukan) |
ManagedIdentity
| Nama | Deskripsi | Nilai |
|---|---|---|
| userAssignedIdentity | Identitas yang ditetapkan pengguna. | tali |
MessagingEndpointProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| lockDurationAsIso8601 | Durasi kunci. Lihat: /azure/iot-hub/iot-hub-devguide-file-upload. | tali |
| maxDeliveryCount | Frekuensi hub IoT mencoba mengirimkan pesan. Lihat: /azure/iot-hub/iot-hub-devguide-file-upload. | Int Kendala: Nilai min = 1 Nilai maks = 100 |
| ttlAsIso8601 | Periode waktu saat pesan tersedia untuk dikonsumsi sebelum kedaluwarsa oleh hub IoT. Lihat: /azure/iot-hub/iot-hub-devguide-file-upload. | tali |
Microsoft.Devices/IotHubs
| Nama | Deskripsi | Nilai |
|---|---|---|
| etag | Bidang Etag tidak diperlukan. Jika disediakan dalam isi respons, itu juga harus disediakan sebagai header per konvensi ETag normal. | tali |
| identitas | Identitas terkelola untuk IotHub. | armidentitas |
| tempat | Lokasi sumber daya. | string (diperlukan) |
| Nama | Nama sumber daya | string (diperlukan) |
| Properti | Properti IotHub | IotHubProperties |
| Sku | Info SKU IotHub | IotHubSkuInfo (diperlukan) |
| Tags | Tag sumber daya | Kamus nama dan nilai tag. |
| jenis | Jenis sumber daya | "Microsoft.Devices/IotHubs@2023-06-30" |
NetworkRuleSetIpRule
| Nama | Deskripsi | Nilai |
|---|---|---|
| perbuatan | Tindakan Filter IP | 'Izinkan' |
| filterName | Nama aturan filter IP. | string (diperlukan) |
| ipMask | String yang berisi rentang alamat IP dalam notasi CIDR untuk aturan tersebut. | string (diperlukan) |
NetworkRuleSetProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| applyToBuiltInEventHubEndpoint | Jika True, maka Seperangkat Aturan Jaringan juga diterapkan ke Titik Akhir BuiltIn EventHub dari IotHub | bool (diperlukan) |
| defaultAction | Tindakan Default untuk Seperangkat Aturan Jaringan | 'Izinkan' 'Tolak' |
| ipRules | Daftar Aturan IP | NetworkRuleSetIpRule[] (diperlukan) |
PrivateEndpoint
| Nama | Deskripsi | Nilai |
|---|
PrivateEndpointConnection
| Nama | Deskripsi | Nilai |
|---|---|---|
| Properti | Properti koneksi titik akhir privat | privateEndpointConnectionProperties (diperlukan) |
PrivateEndpointConnectionProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| privateEndpoint | Properti titik akhir privat dari koneksi titik akhir privat | PrivateEndpoint |
| privateLinkServiceConnectionState | Status koneksi titik akhir privat saat ini | privateLinkServiceConnectionState (diperlukan) |
PrivateLinkServiceConnectionState
| Nama | Deskripsi | Nilai |
|---|---|---|
| actionsRequired | Tindakan yang diperlukan untuk koneksi titik akhir privat | tali |
| deskripsi | Deskripsi untuk status koneksi titik akhir privat saat ini | string (diperlukan) |
| keadaan | Status koneksi titik akhir privat | 'Disetujui' 'Terputus' 'Tertunda' 'Ditolak' (diperlukan) |
ResourceTags
| Nama | Deskripsi | Nilai |
|---|
RouteProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| keadaan | Kondisi yang dievaluasi untuk menerapkan aturan perutean. Jika tidak ada kondisi yang disediakan, kondisi akan mengevaluasi ke true secara default. Untuk tata bahasa, lihat: /azure/iot-hub/iot-hub-devguide-query-language | tali |
| endpointNames | Daftar titik akhir tempat pesan yang memenuhi kondisi dirutekan. Saat ini hanya satu titik akhir yang diizinkan. | string[] (diperlukan) |
| isEnabled | Digunakan untuk menentukan apakah rute diaktifkan. | bool (diperlukan) |
| Nama | Nama rute. Nama hanya dapat mencakup karakter alfanumerik, titik, garis bawah, tanda hubung, memiliki panjang maksimum 64 karakter, dan harus unik. | tali Kendala: Pola = ^[A-Za-z0-9-._]{1,64}$ (diperlukan) |
| sumber | Sumber tempat aturan perutean akan diterapkan, seperti DeviceMessages. | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Tidak Valid' 'TwinChangeEvents' (diperlukan) |
RoutingCosmosDBSqlApiProperties
RoutingEndpoints
| Nama | Deskripsi | Nilai |
|---|---|---|
| cosmosDBSqlContainers | Daftar titik akhir kontainer Cosmos DB tempat hub IoT merutekan pesan, berdasarkan aturan perutean. | RoutingCosmosDBSqlApiProperties[] |
| eventHubs | Daftar titik akhir Azure Event Hubs tempat hub IoT merutekan pesan, berdasarkan aturan perutean. Daftar ini tidak menyertakan titik akhir Azure Event Hubs bawaan. | RoutingEventHubProperties[] |
| serviceBusQueues | Daftar titik akhir antrean Bus Layanan tempat hub IoT merutekan pesan, berdasarkan aturan perutean. | RoutingServiceBusQueueEndpointProperties[] |
| serviceBusTopics | Daftar titik akhir topik Bus Layanan tempat hub IoT merutekan pesan, berdasarkan aturan perutean. | RoutingServiceBusTopicEndpointProperties[] |
| storageContainers | Daftar titik akhir kontainer penyimpanan tempat hub IoT merutekan pesan, berdasarkan aturan perutean. | RoutingStorageContainerProperties[] |
RoutingEventHubProperties
RoutingProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| Endpoint | Properti yang terkait dengan titik akhir kustom tempat hub IoT Anda merutekan pesan berdasarkan aturan perutean. Maksimal 10 titik akhir kustom diizinkan di semua jenis titik akhir untuk hub berbayar dan hanya 1 titik akhir kustom yang diizinkan di semua jenis titik akhir untuk hub gratis. | RoutingEndpoints |
| pengayaan | Daftar pengayaan yang disediakan pengguna yang diterapkan hub IoT ke pesan yang akan dikirimkan ke titik akhir bawaan dan kustom. Lihat: https://aka.ms/telemetryoneventgrid | EnrichmentProperties[] |
| fallbackRoute | Properti rute yang digunakan sebagai rute fall-back ketika tidak ada kondisi yang ditentukan di bagian 'rute' yang terpenuhi. Ini adalah parameter opsional. Ketika properti ini tidak ada dalam templat, rute fallback dinonaktifkan secara default. | FallbackRouteProperties |
| Rute | Daftar aturan perutean yang disediakan pengguna yang digunakan hub IoT untuk merutekan pesan ke titik akhir bawaan dan kustom. Maksimal 100 aturan perutean diizinkan untuk hub berbayar dan maksimum 5 aturan perutean diizinkan untuk hub gratis. | RouteProperties[] |
RoutingServiceBusQueueEndpointProperties
RoutingServiceBusTopicEndpointProperties
RoutingStorageContainerProperties
SharedAccessSignatureAuthorizationRule
| Nama | Deskripsi | Nilai |
|---|---|---|
| keyName | Nama kebijakan akses bersama. | string (diperlukan) |
| primaryKey | Kunci utama. | tali |
| hak | Izin yang ditetapkan ke kebijakan akses bersama. | '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' (diperlukan) |
| secondaryKey | Kunci sekunder. | tali |