Iot Hub Resource - List By Subscription
Mendapatkan semua hub IoT dalam langganan.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Devices/IotHubs?api-version=2023-06-30
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
subscription
|
path | True |
string |
Pengidentifikasi langganan. |
api-version
|
query | True |
string |
Versi API. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
Ini adalah operasi sinkron. Isi berisi array metadata yang diserialisasikan JSON dari semua hub IoT dalam langganan. |
|
Other Status Codes |
DefaultErrorResponse |
Keamanan
azure_auth
Alur OAuth2 Azure Active Directory
Jenis:
oauth2
Alur:
implicit
URL Otorisasi:
https://login.microsoftonline.com/common/oauth2/authorize
Cakupan
Nama | Deskripsi |
---|---|
user_impersonation | meniru akun pengguna Anda |
Contoh
IotHubResource_ListBySubscription
Permintaan sampel
Respon sampel
{
"value": [
{
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
"name": "testHub",
"type": "Microsoft.Devices/IotHubs",
"location": "centraluseuap",
"tags": {},
"etag": "AAAAAAFD6M4=",
"properties": {
"state": "Active",
"provisioningState": "Succeeded",
"ipFilterRules": [
{
"filterName": "rule1",
"action": "Accept",
"ipMask": "131.117.159.53"
},
{
"filterName": "rule2",
"action": "Accept",
"ipMask": "157.55.59.128/25"
}
],
"networkRuleSets": {
"defaultAction": "Deny",
"applyToBuiltInEventHubEndpoint": true,
"ipRules": [
{
"filterName": "rule1",
"action": "Allow",
"ipMask": "131.117.159.53"
},
{
"filterName": "rule2",
"action": "Allow",
"ipMask": "157.55.59.128/25"
}
]
},
"hostName": "iot-dps-cit-hub-1.azure-devices.net",
"eventHubEndpoints": {
"events": {
"retentionTimeInDays": 1,
"partitionCount": 2,
"partitionIds": [
"0",
"1"
],
"path": "iot-dps-cit-hub-1",
"endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
}
},
"routing": {
"endpoints": {
"serviceBusQueues": [],
"serviceBusTopics": [],
"eventHubs": [],
"storageContainers": []
},
"routes": [],
"fallbackRoute": {
"name": "$fallback",
"source": "DeviceMessages",
"condition": "true",
"endpointNames": [
"events"
],
"isEnabled": true
}
},
"storageEndpoints": {
"$default": {
"sasTtlAsIso8601": "PT1H",
"connectionString": "",
"containerName": ""
}
},
"messagingEndpoints": {
"fileNotifications": {
"lockDurationAsIso8601": "PT1M",
"ttlAsIso8601": "PT1H",
"maxDeliveryCount": 10
}
},
"enableFileUploadNotifications": false,
"cloudToDevice": {
"maxDeliveryCount": 10,
"defaultTtlAsIso8601": "PT1H",
"feedback": {
"lockDurationAsIso8601": "PT1M",
"ttlAsIso8601": "PT1H",
"maxDeliveryCount": 10
}
},
"features": "None"
},
"sku": {
"name": "S1",
"tier": "Standard",
"capacity": 1
},
"systemData": {
"createdAt": "2021-01-30T00:28:38.963Z"
}
}
]
}
Definisi
Nama | Deskripsi |
---|---|
Access |
Izin yang ditetapkan ke kebijakan akses bersama. |
Arm |
|
Arm |
|
Authentication |
Menentukan jenis autentikasi yang digunakan untuk menyambungkan ke akun penyimpanan. |
authentication |
Metode yang digunakan untuk mengautentikasi terhadap titik akhir antrean bus layanan |
Capabilities |
Kemampuan dan fitur yang diaktifkan untuk hub IoT. |
Cloud |
Properti olahpesan cloud-ke-perangkat hub IoT. |
created |
Jenis identitas yang membuat sumber daya. |
Default |
Tindakan Default untuk Seperangkat Aturan Jaringan |
Enrichment |
Properti pengayaan yang diterapkan hub IoT Anda ke pesan yang dikirimkan ke titik akhir. |
Error |
Detail kesalahan. |
Event |
Properti titik akhir yang kompatibel dengan Event Hub yang disediakan yang digunakan oleh hub IoT. |
Fallback |
Properti rute fallback. IoT Hub menggunakan properti ini saat merutekan pesan ke titik akhir fallback. |
Feedback |
Properti antrean umpan balik untuk pesan cloud-ke-perangkat. |
Iot |
Penjabaran dari hub IoT. |
Iot |
Array objek IotHubDescription yang diserialisasikan JSON dengan tautan berikutnya. |
Iot |
Representasi publik dari salah satu lokasi tempat sumber daya disediakan. |
Iot |
Properti hub IoT. |
Iot |
Peran wilayah, dapat berupa primer atau sekunder. Wilayah utama adalah tempat hub IoT saat ini disediakan. Wilayah sekunder adalah wilayah berpasangan pemulihan bencana Azure (DR) dan juga wilayah tempat hub IoT dapat melakukan failover. |
Iot |
Nama SKUnya. |
Iot |
Informasi tentang SKU hub IoT. |
Iot |
Tingkat penagihan untuk hub IoT. |
Ip |
Tindakan yang diinginkan untuk permintaan yang diambil oleh aturan ini. |
Ip |
Aturan filter IP untuk hub IoT. |
Managed |
Properti identitas Terkelola. |
Messaging |
Properti titik akhir olahpesan yang digunakan oleh hub IoT ini. |
Network |
Tindakan Filter IP |
Network |
Aturan IP yang akan diterapkan sebagai bagian dari Seperangkat Aturan Jaringan |
Network |
Properti Seperangkat Aturan Jaringan IotHub |
Private |
Properti titik akhir privat dari koneksi titik akhir privat |
Private |
Koneksi titik akhir privat dari IotHub |
Private |
Properti koneksi titik akhir privat |
Private |
Status koneksi titik akhir privat saat ini |
Private |
Status koneksi titik akhir privat |
Public |
Apakah permintaan dari Jaringan Publik diizinkan |
Resource |
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. |
Route |
Properti aturan perutean yang digunakan hub IoT Anda untuk merutekan pesan ke titik akhir. |
Routing |
Properti yang terkait dengan titik akhir kontainer sql cosmos DB. |
Routing |
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. |
Routing |
Properti yang terkait dengan titik akhir pusat aktivitas. |
Routing |
Properti terkait perutean hub IoT. Melihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging |
Routing |
Properti yang terkait dengan jenis titik akhir antrean bus layanan. |
Routing |
Properti yang terkait dengan jenis titik akhir topik bus layanan. |
Routing |
Sumber tempat aturan perutean akan diterapkan, seperti DeviceMessages. |
Routing |
Properti yang terkait dengan titik akhir kontainer penyimpanan. |
Shared |
Properti kebijakan akses bersama hub IoT. |
Storage |
Properti titik akhir Azure Storage untuk pengunggahan file. |
system |
Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya. |
AccessRights
Izin yang ditetapkan ke kebijakan akses bersama.
Nama | Jenis | Deskripsi |
---|---|---|
DeviceConnect |
string |
|
RegistryRead |
string |
|
RegistryRead, DeviceConnect |
string |
|
RegistryRead, RegistryWrite |
string |
|
RegistryRead, RegistryWrite, DeviceConnect |
string |
|
RegistryRead, RegistryWrite, ServiceConnect |
string |
|
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect |
string |
|
RegistryRead, ServiceConnect |
string |
|
RegistryRead, ServiceConnect, DeviceConnect |
string |
|
RegistryWrite |
string |
|
RegistryWrite, DeviceConnect |
string |
|
RegistryWrite, ServiceConnect |
string |
|
RegistryWrite, ServiceConnect, DeviceConnect |
string |
|
ServiceConnect |
string |
|
ServiceConnect, DeviceConnect |
string |
ArmIdentity
Nama | Jenis | Deskripsi |
---|---|---|
principalId |
string |
Id Utama |
tenantId |
string |
Id Penyewa |
type |
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. |
|
userAssignedIdentities |
<string,
Arm |
ArmUserIdentity
Nama | Jenis | Deskripsi |
---|---|---|
clientId |
string |
|
principalId |
string |
AuthenticationType
Menentukan jenis autentikasi yang digunakan untuk menyambungkan ke akun penyimpanan.
Nama | Jenis | Deskripsi |
---|---|---|
identityBased |
string |
|
keyBased |
string |
authenticationType
Metode yang digunakan untuk mengautentikasi terhadap titik akhir antrean bus layanan
Nama | Jenis | Deskripsi |
---|---|---|
identityBased |
string |
|
keyBased |
string |
Capabilities
Kemampuan dan fitur yang diaktifkan untuk hub IoT.
Nama | Jenis | Deskripsi |
---|---|---|
DeviceManagement |
string |
|
None |
string |
CloudToDeviceProperties
Properti olahpesan cloud-ke-perangkat hub IoT.
Nama | Jenis | Deskripsi |
---|---|---|
defaultTtlAsIso8601 |
string |
Waktu default untuk hidup untuk pesan cloud-ke-perangkat dalam antrean perangkat. Lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
feedback |
Properti antrean umpan balik untuk pesan cloud-ke-perangkat. |
|
maxDeliveryCount |
integer |
Jumlah pengiriman maksimum untuk pesan cloud-ke-perangkat dalam antrean perangkat. Lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
createdByType
Jenis identitas yang membuat sumber daya.
Nama | Jenis | Deskripsi |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DefaultAction
Tindakan Default untuk Seperangkat Aturan Jaringan
Nama | Jenis | Deskripsi |
---|---|---|
Allow |
string |
|
Deny |
string |
EnrichmentProperties
Properti pengayaan yang diterapkan hub IoT Anda ke pesan yang dikirimkan ke titik akhir.
Nama | Jenis | Deskripsi |
---|---|---|
endpointNames |
string[] |
Daftar titik akhir tempat pengayaan diterapkan ke pesan. |
key |
string |
Kunci atau nama untuk properti pengayaan. |
value |
string |
Nilai untuk properti pengayaan. |
ErrorDetails
Detail kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
code |
string |
Kode kesalahan. |
details |
string |
Detail kesalahan. |
httpStatusCode |
string |
Kode status HTTP. |
message |
string |
Pesan kesalahan. |
EventHubProperties
Properti titik akhir yang kompatibel dengan Event Hub yang disediakan yang digunakan oleh hub IoT.
Nama | Jenis | Deskripsi |
---|---|---|
endpoint |
string |
Titik akhir yang kompatibel dengan Pusat Aktivitas. |
partitionCount |
integer |
Jumlah partisi untuk menerima pesan perangkat ke cloud di titik akhir yang kompatibel dengan Pusat Aktivitas. Lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. |
partitionIds |
string[] |
Id partisi di titik akhir yang kompatibel dengan Pusat Aktivitas. |
path |
string |
Nama yang kompatibel dengan Pusat Aktivitas. |
retentionTimeInDays |
integer |
Waktu retensi untuk pesan perangkat ke cloud dalam beberapa hari. Melihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages |
FallbackRouteProperties
Properti rute fallback. IoT Hub menggunakan properti ini saat merutekan pesan ke titik akhir fallback.
Nama | Jenis | Deskripsi |
---|---|---|
condition |
string |
Kondisi yang dievaluasi untuk menerapkan rute fallback. Jika kondisi tidak disediakan, kondisi akan dievaluasi ke true secara default. Untuk tata bahasa, lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language |
endpointNames |
string[] |
Daftar titik akhir tempat pesan yang memenuhi kondisi dirutekan. Saat ini hanya 1 titik akhir yang diizinkan. |
isEnabled |
boolean |
Digunakan untuk menentukan apakah rute fallback diaktifkan. |
name |
string |
Nama rute. Nama hanya dapat mencakup karakter alfanumerik, titik, garis bawah, tanda hubung, memiliki panjang maksimum 64 karakter, dan harus unik. |
source |
Sumber tempat aturan perutean akan diterapkan. Misalnya, DeviceMessages |
FeedbackProperties
Properti antrean umpan balik untuk pesan cloud-ke-perangkat.
Nama | Jenis | Deskripsi |
---|---|---|
lockDurationAsIso8601 |
string |
Durasi kunci untuk antrean umpan balik. Lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
maxDeliveryCount |
integer |
Berapa kali hub IoT mencoba mengirimkan pesan pada antrean umpan balik. Lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
ttlAsIso8601 |
string |
Periode waktu saat pesan tersedia untuk digunakan sebelum kedaluwarsa oleh hub IoT. Lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
IotHubDescription
Penjabaran dari hub IoT.
Nama | Jenis | Deskripsi |
---|---|---|
etag |
string |
Bidang Etag tidak diperlukan. Jika disediakan dalam isi respons, itu juga harus disediakan sebagai header sesuai konvensi ETag normal. |
id |
string |
Pengidentifikasi sumber daya. |
identity |
Identitas terkelola untuk IotHub. |
|
location |
string |
Lokasi sumber daya. |
name |
string |
Nama sumber daya. |
properties |
Properti IotHub |
|
sku |
Info SKU IotHub |
|
systemData |
Data meta sistem yang berkaitan dengan sumber daya ini. |
|
tags |
object |
Tag sumber daya. |
type |
string |
Jenis sumber daya. |
IotHubDescriptionListResult
Array objek IotHubDescription yang diserialisasikan JSON dengan tautan berikutnya.
Nama | Jenis | Deskripsi |
---|---|---|
nextLink |
string |
Tautan berikutnya. |
value |
Array objek IotHubDescription. |
IotHubLocationDescription
Representasi publik dari salah satu lokasi tempat sumber daya disediakan.
Nama | Jenis | Deskripsi |
---|---|---|
location |
string |
Nama wilayah Azure |
role |
Peran wilayah, dapat berupa primer atau sekunder. Wilayah utama adalah tempat hub IoT saat ini disediakan. Wilayah sekunder adalah wilayah berpasangan pemulihan bencana Azure (DR) dan juga wilayah tempat hub IoT dapat melakukan failover. |
IotHubProperties
Properti hub IoT.
Nama | Jenis | Deskripsi |
---|---|---|
allowedFqdnList |
string[] |
Daftar FQDN yang diizinkan (Nama Domain yang Sepenuhnya Memenuhi Syarat) untuk keluar dari Iot Hub. |
authorizationPolicies |
Kebijakan akses bersama yang dapat Anda gunakan untuk mengamankan koneksi ke hub IoT. |
|
cloudToDevice |
Properti olahpesan cloud-ke-perangkat hub IoT. |
|
comments |
string |
Komentar hub IoT. |
disableDeviceSAS |
boolean |
Jika true, semua perangkat (termasuk perangkat Edge tetapi tidak termasuk modul) kunci SAS terlingkup tidak dapat digunakan untuk autentikasi. |
disableLocalAuth |
boolean |
Jika true, token SAS dengan kunci SAS terlingkup Iot hub tidak dapat digunakan untuk autentikasi. |
disableModuleSAS |
boolean |
Jika true, semua kunci SAS terlingkup modul tidak dapat digunakan untuk autentikasi. |
enableDataResidency |
boolean |
Properti ini ketika diatur ke true, akan mengaktifkan residensi data, sehingga menonaktifkan pemulihan bencana. |
enableFileUploadNotifications |
boolean |
Jika True, pemberitahuan unggahan file diaktifkan. |
eventHubEndpoints |
<string,
Event |
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. |
features |
Kemampuan dan fitur yang diaktifkan untuk hub IoT. |
|
hostName |
string |
Nama host. |
ipFilterRules |
Aturan filter IP. |
|
locations |
Lokasi primer dan sekunder untuk iot hub |
|
messagingEndpoints |
<string,
Messaging |
Properti titik akhir olahpesan untuk antrean pemberitahuan unggahan file. |
minTlsVersion |
string |
Menentukan versi TLS minimum yang akan didukung untuk hub ini. Dapat diatur ke "1.2" untuk memiliki klien yang menggunakan versi TLS di bawah 1.2 untuk ditolak. |
networkRuleSets |
Properti Seperangkat Aturan Jaringan IotHub |
|
privateEndpointConnections |
Koneksi titik akhir privat yang dibuat pada IotHub ini |
|
provisioningState |
string |
Status penyediaan. |
publicNetworkAccess |
Apakah permintaan dari Jaringan Publik diizinkan |
|
restrictOutboundNetworkAccess |
boolean |
Jika true, egress dari IotHub hanya akan dibatasi untuk FQDN yang diizinkan yang dikonfigurasi melalui allowedFqdnList. |
routing |
Properti terkait perutean hub IoT. Melihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging |
|
state |
string |
Status hub. |
storageEndpoints |
<string,
Storage |
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. |
IotHubReplicaRoleType
Peran wilayah, dapat berupa primer atau sekunder. Wilayah utama adalah tempat hub IoT saat ini disediakan. Wilayah sekunder adalah wilayah berpasangan pemulihan bencana Azure (DR) dan juga wilayah tempat hub IoT dapat melakukan failover.
Nama | Jenis | Deskripsi |
---|---|---|
primary |
string |
|
secondary |
string |
IotHubSku
Nama SKUnya.
Nama | Jenis | Deskripsi |
---|---|---|
B1 |
string |
|
B2 |
string |
|
B3 |
string |
|
F1 |
string |
|
S1 |
string |
|
S2 |
string |
|
S3 |
string |
IotHubSkuInfo
Informasi tentang SKU hub IoT.
Nama | Jenis | Deskripsi |
---|---|---|
capacity |
integer |
Jumlah unit IoT Hub yang disediakan. Lihat: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. |
name |
Nama SKUnya. |
|
tier |
Tingkat penagihan untuk hub IoT. |
IotHubSkuTier
Tingkat penagihan untuk hub IoT.
Nama | Jenis | Deskripsi |
---|---|---|
Basic |
string |
|
Free |
string |
|
Standard |
string |
IpFilterActionType
Tindakan yang diinginkan untuk permintaan yang diambil oleh aturan ini.
Nama | Jenis | Deskripsi |
---|---|---|
Accept |
string |
|
Reject |
string |
IpFilterRule
Aturan filter IP untuk hub IoT.
Nama | Jenis | Deskripsi |
---|---|---|
action |
Tindakan yang diinginkan untuk permintaan yang diambil oleh aturan ini. |
|
filterName |
string |
Nama aturan filter IP. |
ipMask |
string |
String yang berisi rentang alamat IP dalam notasi CIDR untuk aturan. |
ManagedIdentity
Properti identitas Terkelola.
Nama | Jenis | Deskripsi |
---|---|---|
userAssignedIdentity |
string |
Identitas yang ditetapkan pengguna. |
MessagingEndpointProperties
Properti titik akhir olahpesan yang digunakan oleh hub IoT ini.
Nama | Jenis | Deskripsi |
---|---|---|
lockDurationAsIso8601 |
string |
Durasi kunci. Lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
maxDeliveryCount |
integer |
Berapa kali hub IoT mencoba mengirimkan pesan. Lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
ttlAsIso8601 |
string |
Periode waktu saat pesan tersedia untuk digunakan sebelum kedaluwarsa oleh hub IoT. Lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
NetworkRuleIPAction
Tindakan Filter IP
Nama | Jenis | Deskripsi |
---|---|---|
Allow |
string |
NetworkRuleSetIpRule
Aturan IP yang akan diterapkan sebagai bagian dari Seperangkat Aturan Jaringan
Nama | Jenis | Nilai default | Deskripsi |
---|---|---|---|
action | Allow |
Tindakan Filter IP |
|
filterName |
string |
Nama aturan filter IP. |
|
ipMask |
string |
String yang berisi rentang alamat IP dalam notasi CIDR untuk aturan. |
NetworkRuleSetProperties
Properti Seperangkat Aturan Jaringan IotHub
Nama | Jenis | Nilai default | Deskripsi |
---|---|---|---|
applyToBuiltInEventHubEndpoint |
boolean |
Jika True, maka Seperangkat Aturan Jaringan juga diterapkan ke Titik Akhir BuiltIn EventHub dari IotHub |
|
defaultAction | Deny |
Tindakan Default untuk Seperangkat Aturan Jaringan |
|
ipRules |
Daftar Aturan IP |
PrivateEndpoint
Properti titik akhir privat dari koneksi titik akhir privat
Nama | Jenis | Deskripsi |
---|---|---|
id |
string |
Pengidentifikasi sumber daya. |
PrivateEndpointConnection
Koneksi titik akhir privat dari IotHub
Nama | Jenis | Deskripsi |
---|---|---|
id |
string |
Pengidentifikasi sumber daya. |
name |
string |
Nama sumber daya. |
properties |
Properti koneksi titik akhir privat |
|
type |
string |
Jenis sumber daya. |
PrivateEndpointConnectionProperties
Properti koneksi titik akhir privat
Nama | Jenis | Deskripsi |
---|---|---|
privateEndpoint |
Properti titik akhir privat dari koneksi titik akhir privat |
|
privateLinkServiceConnectionState |
Status koneksi titik akhir privat saat ini |
PrivateLinkServiceConnectionState
Status koneksi titik akhir privat saat ini
Nama | Jenis | Deskripsi |
---|---|---|
actionsRequired |
string |
Tindakan yang diperlukan untuk koneksi titik akhir privat |
description |
string |
Deskripsi untuk status koneksi titik akhir privat saat ini |
status |
Status koneksi titik akhir privat |
PrivateLinkServiceConnectionStatus
Status koneksi titik akhir privat
Nama | Jenis | Deskripsi |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PublicNetworkAccess
Apakah permintaan dari Jaringan Publik diizinkan
Nama | Jenis | Deskripsi |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ResourceIdentityType
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.
Nama | Jenis | Deskripsi |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
RouteProperties
Properti aturan perutean yang digunakan hub IoT Anda untuk merutekan pesan ke titik akhir.
Nama | Jenis | Deskripsi |
---|---|---|
condition |
string |
Kondisi yang dievaluasi untuk menerapkan aturan perutean. Jika tidak ada kondisi yang disediakan, kondisi akan mengevaluasi ke true secara default. Untuk tata bahasa, lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language |
endpointNames |
string[] |
Daftar titik akhir tempat pesan yang memenuhi kondisi dirutekan. Saat ini hanya satu titik akhir yang diizinkan. |
isEnabled |
boolean |
Digunakan untuk menentukan apakah rute diaktifkan. |
name |
string |
Nama rute. Nama hanya dapat mencakup karakter alfanumerik, titik, garis bawah, tanda hubung, memiliki panjang maksimum 64 karakter, dan harus unik. |
source |
Sumber tempat aturan perutean akan diterapkan, seperti DeviceMessages. |
RoutingCosmosDBSqlApiProperties
Properti yang terkait dengan titik akhir kontainer sql cosmos DB.
Nama | Jenis | Deskripsi |
---|---|---|
authenticationType |
Metode yang digunakan untuk mengautentikasi terhadap titik akhir kontainer sql cosmos DB |
|
containerName |
string |
Nama kontainer sql cosmos DB dalam database cosmos DB. |
databaseName |
string |
Nama database cosmos DB di akun cosmos DB. |
endpointUri |
string |
Url akun cosmos DB. Ini harus mencakup protokol https:// |
id |
string |
Id titik akhir kontainer sql cosmos DB |
identity |
Properti identitas terkelola dari perutean titik akhir kontainer cosmos DB. |
|
name |
string |
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. |
partitionKeyName |
string |
Nama kunci partisi yang terkait dengan kontainer sql cosmos DB ini jika ada. Ini adalah parameter opsional. |
partitionKeyTemplate |
string |
Templat untuk menghasilkan nilai kunci partisi sintetis untuk digunakan dengan kontainer sql cosmos DB ini. Templat harus menyertakan setidaknya salah satu tempat penampung berikut: {iothub}, {deviceid}, {DD}, {MM}, dan {YYYY}. Setiap tempat penampung dapat ditentukan paling banyak sekali, tetapi komponen pesanan dan non-tempat penampung bersifat arbitrer. Parameter ini hanya diperlukan jika PartitionKeyName ditentukan. |
primaryKey |
string |
Kunci utama akun cosmos DB. |
resourceGroup |
string |
Nama grup sumber daya akun cosmos DB. |
secondaryKey |
string |
Kunci sekunder akun cosmos DB. |
subscriptionId |
string |
Pengidentifikasi langganan akun cosmos DB. |
RoutingEndpoints
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.
Nama | Jenis | Deskripsi |
---|---|---|
cosmosDBSqlContainers |
Daftar titik akhir kontainer Cosmos DB tempat hub IoT merutekan pesan, berdasarkan aturan perutean. |
|
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. |
|
serviceBusQueues |
Daftar titik akhir antrean Azure Service Bus tempat hub IoT merutekan pesan, berdasarkan aturan perutean. |
|
serviceBusTopics |
Daftar titik akhir topik Bus Layanan tempat hub IoT merutekan pesan, berdasarkan aturan perutean. |
|
storageContainers |
Daftar titik akhir kontainer penyimpanan tempat hub IoT merutekan pesan, berdasarkan aturan perutean. |
RoutingEventHubProperties
Properti yang terkait dengan titik akhir pusat aktivitas.
Nama | Jenis | Deskripsi |
---|---|---|
authenticationType |
Metode yang digunakan untuk mengautentikasi terhadap titik akhir pusat aktivitas |
|
connectionString |
string |
String koneksi titik akhir pusat aktivitas. |
endpointUri |
string |
Url titik akhir pusat aktivitas. Ini harus mencakup protokol sb:// |
entityPath |
string |
Nama hub peristiwa pada namespace pusat aktivitas |
id |
string |
Id titik akhir pusat aktivitas |
identity |
Properti identitas terkelola dari titik akhir hub peristiwa perutean. |
|
name |
string |
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. |
resourceGroup |
string |
Nama grup sumber daya titik akhir pusat aktivitas. |
subscriptionId |
string |
Pengidentifikasi langganan titik akhir hub peristiwa. |
RoutingProperties
Properti terkait perutean hub IoT. Melihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
Nama | Jenis | Deskripsi |
---|---|---|
endpoints |
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. |
|
enrichments |
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 |
|
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 ada dalam templat, rute fallback dinonaktifkan secara default. |
|
routes |
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. |
RoutingServiceBusQueueEndpointProperties
Properti yang terkait dengan jenis titik akhir antrean bus layanan.
Nama | Jenis | Deskripsi |
---|---|---|
authenticationType |
Metode yang digunakan untuk mengautentikasi terhadap titik akhir antrean bus layanan |
|
connectionString |
string |
String koneksi titik akhir antrean bus layanan. |
endpointUri |
string |
Url titik akhir antrean bus layanan. Ini harus mencakup protokol sb:// |
entityPath |
string |
Nama antrean pada namespace bus layanan |
id |
string |
Id titik akhir antrean bus layanan |
identity |
Properti identitas terkelola dari titik akhir antrean bus layanan perutean. |
|
name |
string |
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. |
resourceGroup |
string |
Nama grup sumber daya titik akhir antrean bus layanan. |
subscriptionId |
string |
Pengidentifikasi langganan titik akhir antrean bus layanan. |
RoutingServiceBusTopicEndpointProperties
Properti yang terkait dengan jenis titik akhir topik bus layanan.
Nama | Jenis | Deskripsi |
---|---|---|
authenticationType |
Metode yang digunakan untuk mengautentikasi terhadap titik akhir topik bus layanan |
|
connectionString |
string |
String koneksi titik akhir topik bus layanan. |
endpointUri |
string |
Url titik akhir topik bus layanan. Ini harus mencakup protokol sb:// |
entityPath |
string |
Nama antrean pada topik bus layanan |
id |
string |
Id titik akhir topik bus layanan |
identity |
Properti identitas terkelola dari titik akhir topik bus layanan perutean. |
|
name |
string |
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. |
resourceGroup |
string |
Nama grup sumber daya titik akhir topik bus layanan. |
subscriptionId |
string |
Pengidentifikasi langganan titik akhir topik bus layanan. |
RoutingSource
Sumber tempat aturan perutean akan diterapkan, seperti DeviceMessages.
Nama | Jenis | Deskripsi |
---|---|---|
DeviceConnectionStateEvents |
string |
|
DeviceJobLifecycleEvents |
string |
|
DeviceLifecycleEvents |
string |
|
DeviceMessages |
string |
|
Invalid |
string |
|
TwinChangeEvents |
string |
RoutingStorageContainerProperties
Properti yang terkait dengan titik akhir kontainer penyimpanan.
Nama | Jenis | Deskripsi |
---|---|---|
authenticationType |
Metode yang digunakan untuk mengautentikasi terhadap titik akhir penyimpanan |
|
batchFrequencyInSeconds |
integer |
Interval waktu di mana blob ditulis ke penyimpanan. Nilai harus antara 60 dan 720 detik. Nilai defaultnya adalah 300 detik. |
connectionString |
string |
String koneksi akun penyimpanan. |
containerName |
string |
Nama kontainer penyimpanan di akun penyimpanan. |
encoding |
enum:
|
Pengodean yang digunakan untuk menserialisasikan pesan ke blob. Nilai yang didukung adalah 'avro', 'avrodeflate', dan 'JSON'. Nilai defaultnya adalah 'avro'. |
endpointUri |
string |
Url titik akhir penyimpanan. Ini harus mencakup protokol https:// |
fileNameFormat |
string |
Format nama file untuk blob. Format default adalah {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. Semua parameter wajib tetapi dapat diurutkan ulang. |
id |
string |
Id titik akhir kontainer penyimpanan |
identity |
Properti identitas terkelola dari titik akhir penyimpanan perutean. |
|
maxChunkSizeInBytes |
integer |
Jumlah maksimum byte untuk setiap blob yang ditulis ke penyimpanan. Nilai harus antara 10485760(10MB) dan 524288000(500MB). Nilai defaultnya adalah 314572800(300MB). |
name |
string |
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. |
resourceGroup |
string |
Nama grup sumber daya akun penyimpanan. |
subscriptionId |
string |
Pengidentifikasi langganan akun penyimpanan. |
SharedAccessSignatureAuthorizationRule
Properti kebijakan akses bersama hub IoT.
Nama | Jenis | Deskripsi |
---|---|---|
keyName |
string |
Nama kebijakan akses bersama. |
primaryKey |
string |
Kunci primer. |
rights |
Izin yang ditetapkan ke kebijakan akses bersama. |
|
secondaryKey |
string |
Kunci sekunder. |
StorageEndpointProperties
Properti titik akhir Azure Storage untuk pengunggahan file.
Nama | Jenis | Deskripsi |
---|---|---|
authenticationType |
Menentukan jenis autentikasi yang digunakan untuk menyambungkan ke akun penyimpanan. |
|
connectionString |
string |
string koneksi untuk akun Azure Storage tempat file diunggah. |
containerName |
string |
Nama kontainer akar tempat Anda mengunggah file. Kontainer tidak perlu ada tetapi harus dapat dikremasi menggunakan connectionString yang ditentukan. |
identity |
Properti identitas terkelola dari titik akhir penyimpanan untuk pengunggahan file. |
|
sasTtlAsIso8601 |
string |
Periode waktu di mana URI SAS yang dihasilkan oleh IoT Hub untuk pengunggahan file valid. Lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. |
systemData
Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
Nama | Jenis | Deskripsi |
---|---|---|
createdAt |
string |
Tanda waktu pembuatan sumber daya (UTC). |
createdBy |
string |
Identitas yang membuat sumber daya. |
createdByType |
Jenis identitas yang membuat sumber daya. |
|
lastModifiedAt |
string |
Tanda waktu modifikasi terakhir sumber daya (UTC) |
lastModifiedBy |
string |
Identitas yang terakhir memodifikasi sumber daya. |
lastModifiedByType |
Jenis identitas yang terakhir mengubah sumber daya. |