Microsoft.Devices IotHubs 2021-03-31
Definisi sumber daya Bicep
Jenis sumber daya IotHubs dapat disebarkan dengan operasi yang menargetkan:
- Grup sumber daya - Lihat perintah penyebaran 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 Bicep berikut ke templat Anda.
resource symbolicname 'Microsoft.Devices/IotHubs@2021-03-31' = {
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'
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: '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'
}
}
}
}
Nilai properti
IotHubs
Nama | Deskripsi | Nilai |
---|---|---|
nama | Nama sumber daya | string (diperlukan) Batas karakter: 3-50 Karakter yang valid: Alfanumerik dan tanda hubung. Tidak dapat diakhiri dengan tanda hubung. Nama sumber daya harus unik di seluruh Azure. |
lokasi | Lokasi sumber daya. | string (diperlukan) |
tag | Tag sumber daya. | Kamus nama dan nilai tag. Lihat Tag dalam templat |
sku | Info SKU IotHub | IotHubSkuInfo (diperlukan) |
etag | Bidang Etag tidak diperlukan. Jika disediakan dalam isi respons, itu juga harus disediakan sebagai header sesuai konvensi ETag normal. | string |
identity | Identitas terkelola untuk IotHub. | Armidentity |
properti | Properti IotHub | IotHubProperties |
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 'Tidak Ada' akan menghapus identitas apa pun dari layanan. | 'Tidak Ada' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
userAssignedIdentities | Kamus {ArmUserIdentity} | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
Nama | Deskripsi | Nilai |
---|---|---|
{properti yang disesuaikan} | ArmUserIdentity |
ArmUserIdentity
Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.
IotHubProperties
Nama | Deskripsi | Nilai |
---|---|---|
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. | string |
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 dalam kamus saat membuat atau memperbarui panggilan untuk hub IoT. | IotHubPropertiesEventHubEndpoints |
features | 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. | string |
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' |
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 |
SharedAccessSignatureAuthorizationRule
Nama | Deskripsi | Nilai |
---|---|---|
keyName | Nama kebijakan akses bersama. | string (diperlukan) |
primaryKey | Kunci primer. | string |
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. | string |
keyName | Nama kebijakan akses bersama. | string (diperlukan) |
primaryKey | Kunci primer. | string |
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. | string |
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. | string |
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 Batasan: Nilai min = 1 Nilai maks = 100 |
FeedbackProperties
Nama | Deskripsi | Nilai |
---|---|---|
lockDurationAsIso8601 | Durasi kunci untuk antrean umpan balik. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string |
maxDeliveryCount | Frekuensi hub IoT mencoba mengirimkan pesan pada antrean umpan balik. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | int Batasan: Nilai min = 1 Nilai maks = 100 |
ttlAsIso8601 | Periode waktu saat pesan tersedia untuk digunakan sebelum kedaluwarsa oleh hub IoT. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string |
IotHubPropertiesEventHubEndpoints
Nama | Deskripsi | Nilai |
---|---|---|
{properti yang disesuaikan} | EventHubProperties |
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 |
IpFilterRule
Nama | Deskripsi | Nilai |
---|---|---|
tindakan | 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. | string (diperlukan) |
IotHubPropertiesMessagingEndpoints
Nama | Deskripsi | Nilai |
---|---|---|
{properti yang disesuaikan} | MessagingEndpointProperties |
MessagingEndpointProperties
Nama | Deskripsi | Nilai |
---|---|---|
lockDurationAsIso8601 | Durasi kunci. Lihat: /azure/iot-hub/iot-hub-devguide-file-upload. | string |
maxDeliveryCount | Frekuensi hub IoT mencoba mengirimkan pesan. Lihat: /azure/iot-hub/iot-hub-devguide-file-upload. | int Batasan: Nilai min = 1 Nilai maks = 100 |
ttlAsIso8601 | Periode waktu saat pesan tersedia untuk digunakan sebelum kedaluwarsa oleh hub IoT. Lihat: /azure/iot-hub/iot-hub-devguide-file-upload. | string |
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) |
NetworkRuleSetIpRule
Nama | Deskripsi | Nilai |
---|---|---|
tindakan | Tindakan Filter IP | 'Izinkan' |
filterName | Nama aturan filter IP. | string (diperlukan) |
ipMask | String yang berisi rentang alamat IP dalam notasi CIDR untuk aturan. | string (diperlukan) |
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) |
PrivateEndpoint
Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.
PrivateLinkServiceConnectionState
Nama | Deskripsi | Nilai |
---|---|---|
actionsRequired | Tindakan yang diperlukan untuk koneksi titik akhir privat | string |
deskripsi | Deskripsi untuk status koneksi titik akhir privat saat ini | string (diperlukan) |
status | Status koneksi titik akhir privat | 'Disetujui' 'Terputus' 'Tertunda' 'Ditolak' (diperlukan) |
RoutingProperties
Nama | Deskripsi | Nilai |
---|---|---|
titik akhir | 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 berlaku untuk pesan yang akan dikirimkan ke titik akhir bawaan dan kustom. Melihat: https://aka.ms/telemetryoneventgrid |
EnrichmentProperties[] |
fallbackRoute | Properti rute yang digunakan sebagai rute fall-back ketika tidak ada kondisi yang ditentukan di bagian 'rute' terpenuhi. Ini adalah parameter opsional. Ketika properti ini tidak diatur, pesan yang tidak memenuhi salah satu kondisi yang ditentukan di bagian 'rute' dirutekan ke titik akhir eventhub bawaan. | 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 maksimal 5 aturan perutean diizinkan untuk hub gratis. | RouteProperties[] |
RoutingEndpoints
Nama | Deskripsi | Nilai |
---|---|---|
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 Azure Service Bus 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
Nama | Deskripsi | Nilai |
---|---|---|
authenticationType | Metode yang digunakan untuk mengautentikasi terhadap titik akhir pusat aktivitas | 'identityBased' 'keyBased' |
connectionString | String koneksi titik akhir pusat aktivitas. | string |
endpointUri | Url titik akhir pusat aktivitas. Ini harus mencakup protokol sb:// | string |
entityPath | Nama hub peristiwa pada namespace pusat aktivitas | string |
id | Id titik akhir pusat aktivitas | string |
identitas | Properti identitas terkelola dari titik akhir hub peristiwa perutean. | ManagedIdentity |
nama | Nama yang mengidentifikasi titik akhir ini. Nama hanya dapat mencakup karakter alfanumerik, titik, garis bawah, tanda hubung dan memiliki panjang maksimum 64 karakter. Nama-nama berikut dicadangkan: peristiwa, fileNotifications, $default. Nama titik akhir harus unik di seluruh jenis titik akhir. | string (diperlukan) Batasan: Pola = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nama grup sumber daya titik akhir pusat aktivitas. | string |
subscriptionId | Pengidentifikasi langganan titik akhir hub peristiwa. | string |
ManagedIdentity
Nama | Deskripsi | Nilai |
---|---|---|
userAssignedIdentity | Identitas yang ditetapkan pengguna. | string |
RoutingServiceBusQueueEndpointProperties
Nama | Deskripsi | Nilai |
---|---|---|
authenticationType | Metode yang digunakan untuk mengautentikasi terhadap titik akhir antrean bus layanan | 'identityBased' 'keyBased' |
connectionString | String koneksi titik akhir antrean bus layanan. | string |
endpointUri | Url titik akhir antrean bus layanan. Ini harus mencakup protokol sb:// | string |
entityPath | Nama antrean pada namespace bus layanan | string |
id | Id titik akhir antrean bus layanan | string |
identitas | Properti identitas terkelola dari titik akhir antrean bus layanan perutean. | ManagedIdentity |
nama | Nama yang mengidentifikasi titik akhir ini. Nama hanya dapat mencakup karakter alfanumerik, titik, garis bawah, tanda hubung dan memiliki panjang maksimum 64 karakter. Nama-nama berikut dicadangkan: peristiwa, fileNotifications, $default. Nama titik akhir harus unik di seluruh jenis titik akhir. Nama tidak boleh sama dengan nama antrean aktual. | string (diperlukan) Batasan: Pola = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nama grup sumber daya titik akhir antrean bus layanan. | string |
subscriptionId | Pengidentifikasi langganan titik akhir antrean bus layanan. | string |
RoutingServiceBusTopicEndpointProperties
Nama | Deskripsi | Nilai |
---|---|---|
authenticationType | Metode yang digunakan untuk mengautentikasi terhadap titik akhir topik bus layanan | 'identityBased' 'keyBased' |
connectionString | String koneksi titik akhir topik bus layanan. | string |
endpointUri | Url titik akhir topik bus layanan. Ini harus mencakup protokol sb:// | string |
entityPath | Nama antrean pada topik bus layanan | string |
id | Id titik akhir topik bus layanan | string |
identitas | Properti identitas terkelola dari titik akhir topik bus layanan perutean. | ManagedIdentity |
nama | Nama yang mengidentifikasi titik akhir ini. Nama hanya dapat mencakup karakter alfanumerik, titik, garis bawah, tanda hubung dan memiliki panjang maksimum 64 karakter. Nama-nama berikut dicadangkan: peristiwa, fileNotifications, $default. Nama titik akhir harus unik di seluruh jenis titik akhir. Nama tidak boleh sama dengan nama topik aktual. | string (diperlukan) Batasan: Pola = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nama grup sumber daya titik akhir topik bus layanan. | string |
subscriptionId | Pengidentifikasi langganan titik akhir topik bus layanan. | string |
RoutingStorageContainerProperties
Nama | Deskripsi | Nilai |
---|---|---|
authenticationType | Metode yang digunakan untuk mengautentikasi terhadap titik akhir penyimpanan | 'identityBased' 'keyBased' |
batchFrequencyInSeconds | Interval waktu di mana blob ditulis ke penyimpanan. Nilai harus antara 60 dan 720 detik. Nilai defaultnya adalah 300 detik. | int Batasan: Nilai min = 60 Nilai maks = 720 |
connectionString | String koneksi akun penyimpanan. | string |
containerName | Nama kontainer penyimpanan di akun penyimpanan. | string (diperlukan) |
pengodean | Pengodean yang digunakan untuk menserialisasikan pesan ke blob. Nilai yang didukung adalah 'avro', 'avrodeflate', dan 'JSON'. Nilai defaultnya adalah 'avro'. | 'Avro' 'AvroDeflate' 'JSON' |
endpointUri | Url titik akhir penyimpanan. Ini harus menyertakan protokol https:// |
string |
fileNameFormat | Format nama file untuk blob. Format defaultnya adalah {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. Semua parameter bersifat wajib tetapi dapat diurutkan ulang. | string |
id | Id titik akhir kontainer penyimpanan | string |
identitas | Properti identitas terkelola dari titik akhir penyimpanan perutean. | ManagedIdentity |
maxChunkSizeInBytes | Jumlah maksimum byte untuk setiap blob yang ditulis ke penyimpanan. Nilai harus antara 10485760(10MB) dan 524288000(500MB). Nilai defaultnya adalah 314572800(300MB). | int Batasan: Nilai minimum = 10485760 Nilai maks = 524288000 |
nama | Nama yang mengidentifikasi titik akhir ini. Nama hanya dapat mencakup karakter alfanumerik, titik, garis bawah, tanda hubung, dan memiliki panjang maksimum 64 karakter. Nama-nama berikut dicadangkan: peristiwa, fileNotifications, $default. Nama titik akhir harus unik di seluruh jenis titik akhir. | string (diperlukan) Batasan: Pola = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nama grup sumber daya akun penyimpanan. | string |
subscriptionId | Pengidentifikasi langganan akun penyimpanan. | string |
EnrichmentProperties
Nama | Deskripsi | Nilai |
---|---|---|
endpointNames | Daftar titik akhir tempat pengayaan diterapkan ke pesan. | string[] (diperlukan) Batasan: Panjang min = 1 |
kunci | Kunci atau nama untuk properti pengayaan. | string (diperlukan) |
nilai | Nilai untuk properti pengayaan. | string (diperlukan) |
FallbackRouteProperties
Nama | Deskripsi | Nilai |
---|---|---|
kondisi | Kondisi yang dievaluasi untuk menerapkan rute fallback. Jika kondisi tidak disediakan, kondisi akan dievaluasi ke true secara default. Untuk tata bahasa, Lihat: /azure/iot-hub/iot-hub-devguide-query-language | string |
endpointNames | Daftar titik akhir tempat pesan yang memenuhi kondisi dirutekan. Saat ini hanya 1 titik akhir yang diizinkan. | string[] (diperlukan) Batasan: Panjang min = 1 Panjang maksimum = 1 |
Diaktifkan | 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. | string |
sumber | Sumber tempat aturan perutean akan diterapkan. Misalnya, DeviceMessages | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Tidak valid' 'TwinChangeEvents' (diperlukan) |
RouteProperties
Nama | Deskripsi | Nilai |
---|---|---|
kondisi | Kondisi yang dievaluasi untuk menerapkan aturan perutean. Jika tidak ada kondisi yang disediakan, kondisi akan dievaluasi ke true secara default. Untuk tata bahasa, lihat: /azure/iot-hub/iot-hub-devguide-query-language | string |
endpointNames | Daftar titik akhir tempat pesan yang memenuhi kondisi dirutekan. Saat ini hanya satu titik akhir yang diizinkan. | string[] (diperlukan) Batasan: Panjang min = 1 Panjang maksimum = 1 |
Diaktifkan | 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. | string (diperlukan) Batasan: Pola = ^[A-Za-z0-9-._]{1,64}$ |
sumber | Sumber tempat aturan perutean akan diterapkan, seperti DeviceMessages. | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Tidak valid' 'TwinChangeEvents' (diperlukan) |
IotHubPropertiesStorageEndpoints
Nama | Deskripsi | Nilai |
---|---|---|
{properti yang disesuaikan} | StorageEndpointProperties |
StorageEndpointProperties
Nama | Deskripsi | Nilai |
---|---|---|
authenticationType | Menentukan jenis autentikasi yang digunakan untuk menyambungkan ke akun penyimpanan. | 'identityBased' 'keyBased' |
connectionString | string koneksi untuk akun Azure Storage tempat file diunggah. | string (diperlukan) |
containerName | Nama kontainer akar tempat Anda mengunggah file. Kontainer tidak perlu ada tetapi harus dapat dikremasi menggunakan connectionString yang ditentukan. | string (diperlukan) |
identity | Properti identitas terkelola dari titik akhir penyimpanan untuk pengunggahan file. | ManagedIdentity |
sasTtlAsIso8601 | Periode waktu di mana URI SAS yang dihasilkan oleh IoT Hub untuk pengunggahan file valid. Lihat: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | string |
IotHubSkuInfo
Nama | Deskripsi | Nilai |
---|---|---|
kapasitas | Jumlah unit IoT Hub yang disediakan. Lihat: /azure/azure-subscription-service-limits#iot-hub-limits. | int |
nama | Nama SKUnya. | 'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' (diperlukan) |
Templat Mulai Cepat
Templat mulai cepat berikut menyebarkan jenis sumber daya ini.
Templat | Deskripsi |
---|---|
Membuat IOT Hub dan simulator tepi Ubuntu |
Templat ini membuat simulator tepi IOT Hub dan Virtual Machine Ubuntu. |
Menggunakan templat ARM untuk membuat IoT Hub, merutekan, dan menampilkan 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. |
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 IoT Hub dan Perangkat ke Grup Konsumen Cloud |
Templat ini memungkinkan Anda menyebarkan instans IoT Hub dengan konfigurasi olahpesan perangkat ke cloud dan cloud ke perangkat dan perangkat ke grup konsumen cloud. |
Membuat Pembaruan Perangkat untuk akun IoT Hub, instans, IoT Hub |
Templat ini membuat akun, serta instans dan hub untuk menautkan instans. Ini mengonfigurasi hub dengan kebijakan 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 bertahan dalam layanan FHIR Azure Health Data Services. |
Membuat Lingkungan Pay As You Go (PAYG) dengan IoT Hub |
Templat ini memungkinkan Anda menyebarkan lingkungan Time Series Insights Pay As You Go (PAYG) yang dikonfigurasi untuk menggunakan peristiwa dari IoT Hub. |
Definisi sumber daya templat ARM
Jenis sumber daya IotHubs dapat disebarkan dengan operasi yang menargetkan:
- Grup sumber daya - Lihat perintah penyebaran grup sumber daya
Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.
Format sumber daya
Untuk membuat sumber daya Microsoft.Devices/IotHubs, tambahkan JSON berikut ke templat Anda.
{
"type": "Microsoft.Devices/IotHubs",
"apiVersion": "2021-03-31",
"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",
"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": "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"
}
}
}
}
Nilai properti
IotHubs
Nama | Deskripsi | Nilai |
---|---|---|
jenis | Jenis sumber daya | 'Microsoft.Devices/IotHubs' |
apiVersion | Versi api sumber daya | '2021-03-31' |
nama | Nama sumber daya | string (diperlukan) Batas karakter: 3-50 Karakter yang valid: Alfanumerik dan tanda hubung. Tidak dapat diakhiri dengan tanda hubung. Nama sumber daya harus unik di seluruh Azure. |
lokasi | Lokasi sumber daya. | string (diperlukan) |
tag | Tag sumber daya. | Kamus nama dan nilai tag. Lihat Tag dalam templat |
sku | Info SKU IotHub | IotHubSkuInfo (diperlukan) |
etag | Bidang Etag tidak diperlukan. Jika disediakan dalam isi respons, itu juga harus disediakan sebagai header per konvensi ETag normal. | string |
identitas | Identitas terkelola untuk IotHub. | ArmIdentity |
properti | Properti IotHub | IotHubProperties |
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 'Tidak Ada' akan menghapus identitas apa pun dari layanan. | 'Tidak Ada' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
userAssignedIdentities | Kamus {ArmUserIdentity} | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
Nama | Deskripsi | Nilai |
---|---|---|
{customized property} | ArmUserIdentity |
ArmUserIdentity
Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.
IotHubProperties
Nama | Deskripsi | Nilai |
---|---|---|
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. | string |
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 |
features | 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. | string |
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' |
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 |
SharedAccessSignatureAuthorizationRule
Nama | Deskripsi | Nilai |
---|---|---|
keyName | Nama kebijakan akses bersama. | string (diperlukan) |
primaryKey | Kunci primer. | string |
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. | string |
keyName | Nama kebijakan akses bersama. | string (diperlukan) |
primaryKey | Kunci primer. | string |
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. | string |
CloudToDeviceProperties
Nama | Deskripsi | Nilai |
---|---|---|
defaultTtlAsIso8601 | Waktu hidup default untuk pesan cloud-ke-perangkat dalam antrean perangkat. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string |
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 Batasan: Nilai min = 1 Nilai maks = 100 |
FeedbackProperties
Nama | Deskripsi | Nilai |
---|---|---|
lockDurationAsIso8601 | Durasi kunci untuk antrean umpan balik. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string |
maxDeliveryCount | Frekuensi hub IoT mencoba mengirimkan pesan pada antrean umpan balik. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | int Batasan: Nilai min = 1 Nilai maks = 100 |
ttlAsIso8601 | Periode waktu saat pesan tersedia untuk digunakan sebelum kedaluwarsa oleh hub IoT. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string |
IotHubPropertiesEventHubEndpoints
Nama | Deskripsi | Nilai |
---|---|---|
{properti yang disesuaikan} | EventHubProperties |
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 |
IpFilterRule
Nama | Deskripsi | Nilai |
---|---|---|
tindakan | 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. | string (diperlukan) |
IotHubPropertiesMessagingEndpoints
Nama | Deskripsi | Nilai |
---|---|---|
{properti yang disesuaikan} | MessagingEndpointProperties |
MessagingEndpointProperties
Nama | Deskripsi | Nilai |
---|---|---|
lockDurationAsIso8601 | Durasi kunci. Lihat: /azure/iot-hub/iot-hub-devguide-file-upload. | string |
maxDeliveryCount | Frekuensi hub IoT mencoba mengirimkan pesan. Lihat: /azure/iot-hub/iot-hub-devguide-file-upload. | int Batasan: Nilai min = 1 Nilai maks = 100 |
ttlAsIso8601 | Periode waktu saat pesan tersedia untuk digunakan sebelum kedaluwarsa oleh hub IoT. Lihat: /azure/iot-hub/iot-hub-devguide-file-upload. | string |
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) |
NetworkRuleSetIpRule
Nama | Deskripsi | Nilai |
---|---|---|
tindakan | Tindakan Filter IP | 'Izinkan' |
filterName | Nama aturan filter IP. | string (diperlukan) |
ipMask | String yang berisi rentang alamat IP dalam notasi CIDR untuk aturan. | string (diperlukan) |
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) |
PrivateEndpoint
Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.
PrivateLinkServiceConnectionState
Nama | Deskripsi | Nilai |
---|---|---|
actionsRequired | Tindakan yang diperlukan untuk koneksi titik akhir privat | string |
deskripsi | Deskripsi untuk status koneksi titik akhir privat saat ini | string (diperlukan) |
status | Status koneksi titik akhir privat | 'Disetujui' 'Terputus' 'Tertunda' 'Ditolak' (diperlukan) |
RoutingProperties
Nama | Deskripsi | Nilai |
---|---|---|
titik akhir | 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. Melihat: https://aka.ms/telemetryoneventgrid |
EnrichmentProperties[] |
fallbackRoute | Properti rute yang digunakan sebagai rute fall-back ketika tidak ada kondisi yang ditentukan di bagian 'rute' terpenuhi. Ini adalah parameter opsional. Ketika properti ini tidak diatur, pesan yang tidak memenuhi salah satu kondisi yang ditentukan di bagian 'rute' dirutekan ke titik akhir eventhub bawaan. | FallbackRouteProperties |
rute | Daftar aturan perutean yang disediakan pengguna yang digunakan hub IoT untuk merutekan pesan ke titik akhir bawaan dan kustom. Maksimum 100 aturan perutean diizinkan untuk hub berbayar dan maksimum 5 aturan perutean diizinkan untuk hub gratis. | RouteProperties[] |
RoutingEndpoints
Nama | Deskripsi | Nilai |
---|---|---|
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 Azure Service Bus 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
Nama | Deskripsi | Nilai |
---|---|---|
authenticationType | Metode yang digunakan untuk mengautentikasi terhadap titik akhir pusat aktivitas | 'identityBased' 'keyBased' |
connectionString | String koneksi titik akhir pusat aktivitas. | string |
endpointUri | Url titik akhir pusat aktivitas. Ini harus mencakup protokol sb:// | string |
entityPath | Nama hub peristiwa pada namespace pusat aktivitas | string |
id | Id titik akhir pusat aktivitas | string |
identity | Properti identitas terkelola dari titik akhir hub peristiwa perutean. | ManagedIdentity |
nama | Nama yang mengidentifikasi titik akhir ini. Nama hanya dapat mencakup karakter alfanumerik, titik, garis bawah, tanda hubung dan memiliki panjang maksimum 64 karakter. Nama-nama berikut dicadangkan: peristiwa, fileNotifications, $default. Nama titik akhir harus unik di seluruh jenis titik akhir. | string (diperlukan) Batasan: Pola = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nama grup sumber daya titik akhir pusat aktivitas. | string |
subscriptionId | Pengidentifikasi langganan titik akhir hub peristiwa. | string |
ManagedIdentity
Nama | Deskripsi | Nilai |
---|---|---|
userAssignedIdentity | Identitas yang ditetapkan pengguna. | string |
RoutingServiceBusQueueEndpointProperties
Nama | Deskripsi | Nilai |
---|---|---|
authenticationType | Metode yang digunakan untuk mengautentikasi terhadap titik akhir antrean bus layanan | 'identityBased' 'keyBased' |
connectionString | String koneksi titik akhir antrean bus layanan. | string |
endpointUri | Url titik akhir antrean bus layanan. Ini harus mencakup protokol sb:// | string |
entityPath | Nama antrean pada namespace bus layanan | string |
id | Id titik akhir antrean bus layanan | string |
identity | Properti identitas terkelola dari titik akhir antrean bus layanan perutean. | ManagedIdentity |
nama | Nama yang mengidentifikasi titik akhir ini. Nama hanya dapat mencakup karakter alfanumerik, titik, garis bawah, tanda hubung dan memiliki panjang maksimum 64 karakter. Nama-nama berikut dicadangkan: peristiwa, fileNotifications, $default. Nama titik akhir harus unik di seluruh jenis titik akhir. Nama tidak boleh sama dengan nama antrean aktual. | string (diperlukan) Batasan: Pola = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nama grup sumber daya titik akhir antrean bus layanan. | string |
subscriptionId | Pengidentifikasi langganan titik akhir antrean bus layanan. | string |
RoutingServiceBusTopicEndpointProperties
Nama | Deskripsi | Nilai |
---|---|---|
authenticationType | Metode yang digunakan untuk mengautentikasi terhadap titik akhir topik bus layanan | 'identityBased' 'keyBased' |
connectionString | String koneksi titik akhir topik bus layanan. | string |
endpointUri | Url titik akhir topik bus layanan. Ini harus mencakup protokol sb:// | string |
entityPath | Nama antrean pada topik bus layanan | string |
id | Id titik akhir topik bus layanan | string |
identitas | Properti identitas terkelola dari titik akhir topik bus layanan perutean. | ManagedIdentity |
nama | Nama yang mengidentifikasi titik akhir ini. Nama hanya dapat mencakup karakter alfanumerik, titik, garis bawah, tanda hubung, dan memiliki panjang maksimum 64 karakter. Nama-nama berikut dicadangkan: peristiwa, fileNotifications, $default. Nama titik akhir harus unik di seluruh jenis titik akhir. Nama tidak boleh sama dengan nama topik yang sebenarnya. | string (diperlukan) Batasan: Pola = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nama grup sumber daya titik akhir topik bus layanan. | string |
subscriptionId | Pengidentifikasi langganan titik akhir topik bus layanan. | string |
RoutingStorageContainerProperties
Nama | Deskripsi | Nilai |
---|---|---|
authenticationType | Metode yang digunakan untuk mengautentikasi terhadap titik akhir penyimpanan | 'identityBased' 'keyBased' |
batchFrequencyInSeconds | Interval waktu di mana blob ditulis ke penyimpanan. Nilai harus antara 60 dan 720 detik. Nilai defaultnya adalah 300 detik. | int Batasan: Nilai min = 60 Nilai maks = 720 |
connectionString | String koneksi akun penyimpanan. | string |
containerName | Nama kontainer penyimpanan di akun penyimpanan. | string (diperlukan) |
pengodean | Pengodean yang digunakan untuk menserialisasikan pesan ke blob. Nilai yang didukung adalah 'avro', 'avrodeflate', dan 'JSON'. Nilai defaultnya adalah 'avro'. | 'Avro' 'AvroDeflate' 'JSON' |
endpointUri | Url titik akhir penyimpanan. Ini harus menyertakan protokol https:// |
string |
fileNameFormat | Format nama file untuk blob. Format defaultnya adalah {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. Semua parameter bersifat wajib tetapi dapat diurutkan ulang. | string |
id | Id titik akhir kontainer penyimpanan | string |
identitas | Properti identitas terkelola dari titik akhir penyimpanan perutean. | ManagedIdentity |
maxChunkSizeInBytes | Jumlah maksimum byte untuk setiap blob yang ditulis ke penyimpanan. Nilai harus antara 10485760(10MB) dan 524288000(500MB). Nilai defaultnya adalah 314572800(300MB). | int Batasan: Nilai minimum = 10485760 Nilai maks = 524288000 |
nama | Nama yang mengidentifikasi titik akhir ini. Nama hanya dapat mencakup karakter alfanumerik, titik, garis bawah, tanda hubung, dan memiliki panjang maksimum 64 karakter. Nama-nama berikut dicadangkan: peristiwa, fileNotifications, $default. Nama titik akhir harus unik di seluruh jenis titik akhir. | string (diperlukan) Batasan: Pola = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nama grup sumber daya akun penyimpanan. | string |
subscriptionId | Pengidentifikasi langganan akun penyimpanan. | string |
EnrichmentProperties
Nama | Deskripsi | Nilai |
---|---|---|
endpointNames | Daftar titik akhir tempat pengayaan diterapkan ke pesan. | string[] (diperlukan) Batasan: Panjang min = 1 |
kunci | Kunci atau nama untuk properti pengayaan. | string (diperlukan) |
nilai | Nilai untuk properti pengayaan. | string (diperlukan) |
FallbackRouteProperties
Nama | Deskripsi | Nilai |
---|---|---|
kondisi | Kondisi yang dievaluasi untuk menerapkan rute fallback. Jika kondisi tidak disediakan, kondisi akan dievaluasi ke true secara default. Untuk tata bahasa, Lihat: /azure/iot-hub/iot-hub-devguide-query-language | string |
endpointNames | Daftar titik akhir tempat pesan yang memenuhi kondisi dirutekan. Saat ini hanya 1 titik akhir yang diizinkan. | string[] (diperlukan) Batasan: Panjang min = 1 Panjang maksimum = 1 |
Diaktifkan | 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. | string |
sumber | Sumber tempat aturan perutean akan diterapkan. Misalnya, DeviceMessages | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Tidak Valid' 'TwinChangeEvents' (diperlukan) |
RouteProperties
Nama | Deskripsi | Nilai |
---|---|---|
kondisi | 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 | string |
endpointNames | Daftar titik akhir tempat pesan yang memenuhi kondisi dirutekan. Saat ini hanya satu titik akhir yang diizinkan. | string[] (diperlukan) Batasan: Panjang min = 1 Panjang maksimum = 1 |
Diaktifkan | 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. | string (diperlukan) Batasan: Pola = ^[A-Za-z0-9-._]{1,64}$ |
sumber | Sumber tempat aturan perutean akan diterapkan, seperti DeviceMessages. | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Tidak Valid' 'TwinChangeEvents' (diperlukan) |
IotHubPropertiesStorageEndpoints
Nama | Deskripsi | Nilai |
---|---|---|
{customized property} | StorageEndpointProperties |
StorageEndpointProperties
Nama | Deskripsi | Nilai |
---|---|---|
authenticationType | Menentukan jenis autentikasi yang digunakan untuk menyambungkan ke akun penyimpanan. | 'identityBased' 'keyBased' |
connectionString | string koneksi untuk akun Azure Storage tempat file diunggah. | string (diperlukan) |
containerName | Nama kontainer akar tempat Anda mengunggah file. Kontainer tidak perlu ada tetapi harus dapat dikremasi menggunakan connectionString yang ditentukan. | string (diperlukan) |
identity | Properti identitas terkelola dari titik akhir penyimpanan untuk pengunggahan file. | ManagedIdentity |
sasTtlAsIso8601 | Periode waktu di mana URI SAS yang dihasilkan oleh IoT Hub untuk pengunggahan file valid. Lihat: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | string |
IotHubSkuInfo
Nama | Deskripsi | Nilai |
---|---|---|
kapasitas | Jumlah unit IoT Hub yang disediakan. Lihat: /azure/azure-subscription-service-limits#iot-hub-limits. | int |
nama | Nama SKUnya. | 'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' (diperlukan) |
Templat Mulai Cepat
Templat mulai cepat berikut menyebarkan jenis sumber daya ini.
Templat | Deskripsi |
---|---|
Membuat IOT Hub dan simulator tepi Ubuntu |
Templat ini membuat simulator tepi IOT Hub dan Virtual Machine Ubuntu. |
Menggunakan templat ARM untuk membuat IoT Hub, merutekan, dan menampilkan 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. |
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 IoT Hub dan Perangkat ke Grup Konsumen Cloud |
Templat ini memungkinkan Anda menyebarkan instans IoT Hub dengan konfigurasi olahpesan perangkat ke cloud dan cloud ke perangkat dan perangkat ke grup konsumen cloud. |
Membuat Pembaruan Perangkat untuk akun IoT Hub, instans, IoT Hub |
Templat ini membuat akun, serta instans dan hub untuk menautkan instans. Ini mengonfigurasi hub dengan kebijakan 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 bertahan dalam layanan FHIR Azure Health Data Services. |
Membuat Lingkungan Pay As You Go (PAYG) dengan IoT Hub |
Templat ini memungkinkan Anda menyebarkan lingkungan Time Series Insights Pay As You Go (PAYG) yang dikonfigurasi untuk menggunakan peristiwa dari IoT Hub. |
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 log perubahan.
Format sumber daya
Untuk membuat sumber daya Microsoft.Devices/IotHubs, tambahkan Terraform berikut ke templat Anda.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Devices/IotHubs@2021-03-31"
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"
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 = "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"
})
}
Nilai properti
IotHubs
Nama | Deskripsi | Nilai |
---|---|---|
jenis | Jenis sumber daya | "Microsoft.Devices/IotHubs@2021-03-31" |
nama | Nama sumber daya | string (diperlukan) Batas karakter: 3-50 Karakter yang valid: Alfanumerik dan tanda hubung. Tidak dapat diakhiri dengan tanda hubung. Nama sumber daya harus unik di seluruh Azure. |
lokasi | Lokasi sumber daya. | string (diperlukan) |
parent_id | Untuk menyebarkan ke grup sumber daya, gunakan ID grup sumber daya tersebut. | string (diperlukan) |
tag | Tag sumber daya. | Kamus nama dan nilai tag. |
sku | Info SKU IotHub | IotHubSkuInfo (diperlukan) |
etag | Bidang Etag tidak diperlukan. Jika disediakan dalam isi respons, itu juga harus disediakan sebagai header per konvensi ETag normal. | string |
identity | Identitas terkelola untuk IotHub. | ArmIdentity |
properti | Properti IotHub | IotHubProperties |
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 'Tidak Ada' akan menghapus identitas apa pun dari layanan. | "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" |
identity_ids | Kamus {ArmUserIdentity} | Array ID identitas pengguna. |
ArmIdentityUserAssignedIdentities
Nama | Deskripsi | Nilai |
---|---|---|
{customized property} | ArmUserIdentity |
ArmUserIdentity
Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.
IotHubProperties
Nama | Deskripsi | Nilai |
---|---|---|
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. | string |
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 |
features | 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. | string |
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" |
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 |
SharedAccessSignatureAuthorizationRule
Nama | Deskripsi | Nilai |
---|---|---|
keyName | Nama kebijakan akses bersama. | string (diperlukan) |
primaryKey | Kunci primer. | string |
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. | string |
keyName | Nama kebijakan akses bersama. | string (diperlukan) |
primaryKey | Kunci primer. | string |
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. | string |
CloudToDeviceProperties
Nama | Deskripsi | Nilai |
---|---|---|
defaultTtlAsIso8601 | Waktu hidup default untuk pesan cloud-ke-perangkat dalam antrean perangkat. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string |
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 Batasan: Nilai min = 1 Nilai maks = 100 |
FeedbackProperties
Nama | Deskripsi | Nilai |
---|---|---|
lockDurationAsIso8601 | Durasi kunci untuk antrean umpan balik. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string |
maxDeliveryCount | Frekuensi hub IoT mencoba mengirimkan pesan pada antrean umpan balik. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | int Batasan: Nilai min = 1 Nilai maks = 100 |
ttlAsIso8601 | Periode waktu saat pesan tersedia untuk digunakan sebelum kedaluwarsa oleh hub IoT. Lihat: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string |
IotHubPropertiesEventHubEndpoints
Nama | Deskripsi | Nilai |
---|---|---|
{properti yang disesuaikan} | EventHubProperties |
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 |
IpFilterRule
Nama | Deskripsi | Nilai |
---|---|---|
tindakan | 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. | string (diperlukan) |
IotHubPropertiesMessagingEndpoints
Nama | Deskripsi | Nilai |
---|---|---|
{properti yang disesuaikan} | MessagingEndpointProperties |
MessagingEndpointProperties
Nama | Deskripsi | Nilai |
---|---|---|
lockDurationAsIso8601 | Durasi kunci. Lihat: /azure/iot-hub/iot-hub-devguide-file-upload. | string |
maxDeliveryCount | Frekuensi hub IoT mencoba mengirimkan pesan. Lihat: /azure/iot-hub/iot-hub-devguide-file-upload. | int Batasan: Nilai min = 1 Nilai maks = 100 |
ttlAsIso8601 | Periode waktu saat pesan tersedia untuk digunakan sebelum kedaluwarsa oleh hub IoT. Lihat: /azure/iot-hub/iot-hub-devguide-file-upload. | string |
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) |
NetworkRuleSetIpRule
Nama | Deskripsi | Nilai |
---|---|---|
tindakan | Tindakan Filter IP | "Izinkan" |
filterName | Nama aturan filter IP. | string (diperlukan) |
ipMask | String yang berisi rentang alamat IP dalam notasi CIDR untuk aturan. | string (diperlukan) |
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) |
PrivateEndpoint
Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.
PrivateLinkServiceConnectionState
Nama | Deskripsi | Nilai |
---|---|---|
actionsRequired | Tindakan yang diperlukan untuk koneksi titik akhir privat | string |
deskripsi | Deskripsi untuk status koneksi titik akhir privat saat ini | string (diperlukan) |
status | Status koneksi titik akhir privat | "Disetujui" "Terputus" "Tertunda" "Ditolak" (diperlukan) |
RoutingProperties
Nama | Deskripsi | Nilai |
---|---|---|
titik akhir | 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 berlaku untuk pesan yang akan dikirimkan ke titik akhir bawaan dan kustom. Melihat: https://aka.ms/telemetryoneventgrid |
EnrichmentProperties[] |
fallbackRoute | Properti rute yang digunakan sebagai rute fall-back ketika tidak ada kondisi yang ditentukan di bagian 'rute' terpenuhi. Ini adalah parameter opsional. Ketika properti ini tidak diatur, pesan yang tidak memenuhi salah satu kondisi yang ditentukan di bagian 'rute' dirutekan ke titik akhir eventhub bawaan. | 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 maksimal 5 aturan perutean diizinkan untuk hub gratis. | RouteProperties[] |
RoutingEndpoints
Nama | Deskripsi | Nilai |
---|---|---|
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 Azure Service Bus 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
Nama | Deskripsi | Nilai |
---|---|---|
authenticationType | Metode yang digunakan untuk mengautentikasi terhadap titik akhir pusat aktivitas | "identityBased" "keyBased" |
connectionString | String koneksi titik akhir pusat aktivitas. | string |
endpointUri | Url titik akhir pusat aktivitas. Ini harus mencakup protokol sb:// | string |
entityPath | Nama hub peristiwa pada namespace pusat aktivitas | string |
id | Id titik akhir pusat aktivitas | string |
identitas | Properti identitas terkelola dari titik akhir hub peristiwa perutean. | ManagedIdentity |
nama | Nama yang mengidentifikasi titik akhir ini. Nama hanya dapat mencakup karakter alfanumerik, titik, garis bawah, tanda hubung dan memiliki panjang maksimum 64 karakter. Nama-nama berikut dicadangkan: peristiwa, fileNotifications, $default. Nama titik akhir harus unik di seluruh jenis titik akhir. | string (diperlukan) Batasan: Pola = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nama grup sumber daya titik akhir pusat aktivitas. | string |
subscriptionId | Pengidentifikasi langganan titik akhir hub peristiwa. | string |
ManagedIdentity
Nama | Deskripsi | Nilai |
---|---|---|
userAssignedIdentity | Identitas yang ditetapkan pengguna. | string |
RoutingServiceBusQueueEndpointProperties
Nama | Deskripsi | Nilai |
---|---|---|
authenticationType | Metode yang digunakan untuk mengautentikasi terhadap titik akhir antrean bus layanan | "identityBased" "keyBased" |
connectionString | String koneksi titik akhir antrean bus layanan. | string |
endpointUri | Url titik akhir antrean bus layanan. Ini harus mencakup protokol sb:// | string |
entityPath | Nama antrean pada namespace bus layanan | string |
id | Id titik akhir antrean bus layanan | string |
identitas | Properti identitas terkelola dari titik akhir antrean bus layanan perutean. | ManagedIdentity |
nama | Nama yang mengidentifikasi titik akhir ini. Nama hanya dapat mencakup karakter alfanumerik, titik, garis bawah, tanda hubung dan memiliki panjang maksimum 64 karakter. Nama-nama berikut dicadangkan: peristiwa, fileNotifications, $default. Nama titik akhir harus unik di seluruh jenis titik akhir. Nama tidak boleh sama dengan nama antrean aktual. | string (diperlukan) Batasan: Pola = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nama grup sumber daya titik akhir antrean bus layanan. | string |
subscriptionId | Pengidentifikasi langganan titik akhir antrean bus layanan. | string |
RoutingServiceBusTopicEndpointProperties
Nama | Deskripsi | Nilai |
---|---|---|
authenticationType | Metode yang digunakan untuk mengautentikasi terhadap titik akhir topik bus layanan | "identityBased" "keyBased" |
connectionString | String koneksi titik akhir topik bus layanan. | string |
endpointUri | Url titik akhir topik bus layanan. Ini harus mencakup protokol sb:// | string |
entityPath | Nama antrean pada topik bus layanan | string |
id | Id titik akhir topik bus layanan | string |
identitas | Properti identitas terkelola dari titik akhir topik bus layanan perutean. | ManagedIdentity |
nama | Nama yang mengidentifikasi titik akhir ini. Nama hanya dapat mencakup karakter alfanumerik, titik, garis bawah, tanda hubung, dan memiliki panjang maksimum 64 karakter. Nama-nama berikut dicadangkan: peristiwa, fileNotifications, $default. Nama titik akhir harus unik di seluruh jenis titik akhir. Nama tidak boleh sama dengan nama topik yang sebenarnya. | string (diperlukan) Batasan: Pola = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nama grup sumber daya titik akhir topik bus layanan. | string |
subscriptionId | Pengidentifikasi langganan titik akhir topik bus layanan. | string |
RoutingStorageContainerProperties
Nama | Deskripsi | Nilai |
---|---|---|
authenticationType | Metode yang digunakan untuk mengautentikasi terhadap titik akhir penyimpanan | "identityBased" "keyBased" |
batchFrequencyInSeconds | Interval waktu di mana blob ditulis ke penyimpanan. Nilai harus antara 60 dan 720 detik. Nilai defaultnya adalah 300 detik. | int Batasan: Nilai min = 60 Nilai maks = 720 |
connectionString | String koneksi akun penyimpanan. | string |
containerName | Nama kontainer penyimpanan di akun penyimpanan. | string (diperlukan) |
pengodean | Pengodean yang digunakan untuk menserialisasikan pesan ke blob. Nilai yang didukung adalah 'avro', 'avrodeflate', dan 'JSON'. Nilai defaultnya adalah 'avro'. | "Avro" "AvroDeflate" "JSON" |
endpointUri | Url titik akhir penyimpanan. Ini harus menyertakan protokol https:// |
string |
fileNameFormat | Format nama file untuk blob. Format defaultnya adalah {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. Semua parameter bersifat wajib tetapi dapat diurutkan ulang. | string |
id | Id titik akhir kontainer penyimpanan | string |
identitas | Properti identitas terkelola dari titik akhir penyimpanan perutean. | ManagedIdentity |
maxChunkSizeInBytes | Jumlah maksimum byte untuk setiap blob yang ditulis ke penyimpanan. Nilai harus antara 10485760(10MB) dan 524288000(500MB). Nilai defaultnya adalah 314572800(300MB). | int Batasan: Nilai minimum = 10485760 Nilai maks = 524288000 |
nama | Nama yang mengidentifikasi titik akhir ini. Nama hanya dapat mencakup karakter alfanumerik, titik, garis bawah, tanda hubung, dan memiliki panjang maksimum 64 karakter. Nama-nama berikut dicadangkan: peristiwa, fileNotifications, $default. Nama titik akhir harus unik di seluruh jenis titik akhir. | string (diperlukan) Batasan: Pola = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nama grup sumber daya akun penyimpanan. | string |
subscriptionId | Pengidentifikasi langganan akun penyimpanan. | string |
EnrichmentProperties
Nama | Deskripsi | Nilai |
---|---|---|
endpointNames | Daftar titik akhir tempat pengayaan diterapkan ke pesan. | string[] (diperlukan) Batasan: Panjang min = 1 |
kunci | Kunci atau nama untuk properti pengayaan. | string (diperlukan) |
nilai | Nilai untuk properti pengayaan. | string (diperlukan) |
FallbackRouteProperties
Nama | Deskripsi | Nilai |
---|---|---|
kondisi | Kondisi yang dievaluasi untuk menerapkan rute fallback. Jika kondisi tidak disediakan, kondisi akan dievaluasi ke true secara default. Untuk tata bahasa, Lihat: /azure/iot-hub/iot-hub-devguide-query-language | string |
endpointNames | Daftar titik akhir tempat pesan yang memenuhi kondisi dirutekan. Saat ini hanya 1 titik akhir yang diizinkan. | string[] (diperlukan) Batasan: Panjang min = 1 Panjang maksimum = 1 |
Diaktifkan | 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. | string |
sumber | Sumber tempat aturan perutean akan diterapkan. Misalnya, DeviceMessages | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "Tidak valid" "TwinChangeEvents" (diperlukan) |
RouteProperties
Nama | Deskripsi | Nilai |
---|---|---|
kondisi | Kondisi yang dievaluasi untuk menerapkan aturan perutean. Jika tidak ada kondisi yang disediakan, kondisi akan dievaluasi ke true secara default. Untuk tata bahasa, lihat: /azure/iot-hub/iot-hub-devguide-query-language | string |
endpointNames | Daftar titik akhir tempat pesan yang memenuhi kondisi dirutekan. Saat ini hanya satu titik akhir yang diizinkan. | string[] (diperlukan) Batasan: Panjang min = 1 Panjang maksimum = 1 |
Diaktifkan | 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. | string (diperlukan) Batasan: Pola = ^[A-Za-z0-9-._]{1,64}$ |
sumber | Sumber tempat aturan perutean akan diterapkan, seperti DeviceMessages. | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "Tidak valid" "TwinChangeEvents" (diperlukan) |
IotHubPropertiesStorageEndpoints
Nama | Deskripsi | Nilai |
---|---|---|
{properti yang disesuaikan} | StorageEndpointProperties |
StorageEndpointProperties
Nama | Deskripsi | Nilai |
---|---|---|
authenticationType | Menentukan jenis autentikasi yang digunakan untuk menyambungkan ke akun penyimpanan. | "identityBased" "keyBased" |
connectionString | string koneksi untuk akun Azure Storage tempat file diunggah. | string (diperlukan) |
containerName | Nama kontainer akar tempat Anda mengunggah file. Kontainer tidak perlu ada tetapi harus dapat dikremasi menggunakan connectionString yang ditentukan. | string (diperlukan) |
identity | Properti identitas terkelola dari titik akhir penyimpanan untuk pengunggahan file. | ManagedIdentity |
sasTtlAsIso8601 | Periode waktu di mana URI SAS yang dihasilkan oleh IoT Hub untuk pengunggahan file valid. Lihat: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | string |
IotHubSkuInfo
Nama | Deskripsi | Nilai |
---|---|---|
kapasitas | Jumlah unit IoT Hub yang disediakan. Lihat: /azure/azure-subscription-service-limits#iot-hub-limits. | int |
nama | Nama SKUnya. | "B1" "B2" "B3" "F1" "S1" "S2" "S3" (diperlukan) |