Iot Hub Resource - Get

Dapatkan metadata terkait non-keamanan dari hub IoT.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2023-06-30

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
resourceGroupName
path True

string

Nama grup sumber daya yang berisi hub IoT.

resourceName
path True

string

Nama hub IoT.

subscriptionId
path True

string

Pengidentifikasi langganan.

api-version
query True

string

Versi API.

Respons

Nama Jenis Deskripsi
200 OK

IotHubDescription

Isi berisi semua properti non-keamanan hub IoT. Properti terkait keamanan diatur ke null.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama Deskripsi
user_impersonation meniru akun pengguna Anda

Contoh

IotHubResource_Get

Sample Request

GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub?api-version=2023-06-30

Sample Response

{
  "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": {
        "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",
    "locations": [
      {
        "location": "West US",
        "role": "primary"
      },
      {
        "location": "East US",
        "role": "secondary"
      }
    ],
    "minTlsVersion": "1.2"
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}

Definisi

Nama Deskripsi
AccessRights

Izin yang ditetapkan ke kebijakan akses bersama.

ArmIdentity
ArmUserIdentity
AuthenticationType

Menentukan jenis autentikasi yang digunakan untuk menyambungkan ke akun penyimpanan.

authenticationType

Metode yang digunakan untuk mengautentikasi terhadap titik akhir antrean bus layanan

Capabilities

Kemampuan dan fitur yang diaktifkan untuk hub IoT.

CloudToDeviceProperties

Properti olahpesan cloud-ke-perangkat hub IoT.

createdByType

Jenis identitas yang membuat sumber daya.

DefaultAction

Tindakan Default untuk Seperangkat Aturan Jaringan

EnrichmentProperties

Properti pengayaan yang diterapkan hub IoT Anda untuk pesan yang dikirimkan ke titik akhir.

ErrorDetails

Detail kesalahan.

EventHubProperties

Properti titik akhir yang kompatibel dengan Event Hub yang disediakan yang digunakan oleh hub IoT.

FallbackRouteProperties

Properti rute fallback. IoT Hub menggunakan properti ini saat merutekan pesan ke titik akhir fallback.

FeedbackProperties

Properti antrean umpan balik untuk pesan cloud-ke-perangkat.

IotHubDescription

Penjabaran dari hub IoT.

IotHubLocationDescription

Representasi publik dari salah satu lokasi tempat sumber daya disediakan.

IotHubProperties

Properti hub IoT.

IotHubReplicaRoleType

Peran wilayah, dapat berupa primer atau sekunder. Wilayah utama adalah tempat hub IoT saat ini disediakan. Wilayah sekunder adalah wilayah berpasangan pemulihan bencana (DR) Azure dan juga wilayah tempat hub IoT dapat melakukan failover.

IotHubSku

Nama SKUnya.

IotHubSkuInfo

Informasi tentang SKU hub IoT.

IotHubSkuTier

Tingkat penagihan untuk hub IoT.

IpFilterActionType

Tindakan yang diinginkan untuk permintaan yang diambil oleh aturan ini.

IpFilterRule

Aturan filter IP untuk hub IoT.

ManagedIdentity

Properti identitas Terkelola.

MessagingEndpointProperties

Properti titik akhir olahpesan yang digunakan oleh hub IoT ini.

NetworkRuleIPAction

Tindakan Filter IP

NetworkRuleSetIpRule

Aturan IP yang akan diterapkan sebagai bagian dari Seperangkat Aturan Jaringan

NetworkRuleSetProperties

Properti Seperangkat Aturan Jaringan IotHub

PrivateEndpoint

Properti titik akhir privat dari koneksi titik akhir privat

PrivateEndpointConnection

Koneksi titik akhir privat dari IotHub

PrivateEndpointConnectionProperties

Properti koneksi titik akhir privat

PrivateLinkServiceConnectionState

Status koneksi titik akhir privat saat ini

PrivateLinkServiceConnectionStatus

Status koneksi titik akhir privat

PublicNetworkAccess

Apakah permintaan dari Jaringan Publik diizinkan

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.

RouteProperties

Properti aturan perutean yang digunakan hub IoT Anda untuk merutekan pesan ke titik akhir.

RoutingCosmosDBSqlApiProperties

Properti yang terkait dengan titik akhir kontainer sql 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.

RoutingEventHubProperties

Properti yang terkait dengan titik akhir pusat aktivitas.

RoutingProperties

Properti terkait perutean hub IoT. Melihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

RoutingServiceBusQueueEndpointProperties

Properti yang terkait dengan jenis titik akhir antrean bus layanan.

RoutingServiceBusTopicEndpointProperties

Properti yang terkait dengan jenis titik akhir topik bus layanan.

RoutingSource

Sumber tempat aturan perutean akan diterapkan, seperti DeviceMessages.

RoutingStorageContainerProperties

Properti yang terkait dengan titik akhir kontainer penyimpanan.

SharedAccessSignatureAuthorizationRule

Properti kebijakan akses bersama hub IoT.

StorageEndpointProperties

Properti titik akhir Azure Storage untuk pengunggahan file.

systemData

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

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.

userAssignedIdentities

<string,  ArmUserIdentity>

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 hidup default 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

FeedbackProperties

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 untuk 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

RoutingSource

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

Frekuensi 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

ArmIdentity

Identitas terkelola untuk IotHub.

location

string

Lokasi sumber daya.

name

string

Nama sumber daya.

properties

IotHubProperties

Properti IotHub

sku

IotHubSkuInfo

Info SKU IotHub

systemData

systemData

Data meta sistem yang berkaitan dengan sumber daya ini.

tags

object

Tag sumber daya.

type

string

Jenis sumber daya.

IotHubLocationDescription

Representasi publik dari salah satu lokasi tempat sumber daya disediakan.

Nama Jenis Deskripsi
location

string

Nama wilayah Azure

role

IotHubReplicaRoleType

Peran wilayah, dapat berupa primer atau sekunder. Wilayah utama adalah tempat hub IoT saat ini disediakan. Wilayah sekunder adalah wilayah berpasangan pemulihan bencana (DR) Azure 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

SharedAccessSignatureAuthorizationRule[]

Kebijakan akses bersama yang dapat Anda gunakan untuk mengamankan koneksi ke hub IoT.

cloudToDevice

CloudToDeviceProperties

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,  EventHubProperties>

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

Capabilities

Kemampuan dan fitur yang diaktifkan untuk hub IoT.

hostName

string

Nama host.

ipFilterRules

IpFilterRule[]

Aturan filter IP.

locations

IotHubLocationDescription[]

Lokasi primer dan sekunder untuk iot hub

messagingEndpoints

<string,  MessagingEndpointProperties>

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

NetworkRuleSetProperties

Properti Seperangkat Aturan Jaringan IotHub

privateEndpointConnections

PrivateEndpointConnection[]

Koneksi titik akhir privat yang dibuat pada IotHub ini

provisioningState

string

Status penyediaan.

publicNetworkAccess

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

RoutingProperties

Properti terkait perutean hub IoT. Melihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

state

string

Status hub.

storageEndpoints

<string,  StorageEndpointProperties>

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 (DR) Azure 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

IotHubSku

Nama SKUnya.

tier

IotHubSkuTier

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

IpFilterActionType

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

Frekuensi 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

NetworkRuleIPAction

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

DefaultAction

Deny

Tindakan Default untuk Seperangkat Aturan Jaringan

ipRules

NetworkRuleSetIpRule[]

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

PrivateEndpointConnectionProperties

Properti koneksi titik akhir privat

type

string

Jenis sumber daya.

PrivateEndpointConnectionProperties

Properti koneksi titik akhir privat

Nama Jenis Deskripsi
privateEndpoint

PrivateEndpoint

Properti titik akhir privat dari koneksi titik akhir privat

privateLinkServiceConnectionState

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

PrivateLinkServiceConnectionStatus

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 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 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

RoutingSource

Sumber tempat aturan perutean akan diterapkan, seperti DeviceMessages.

RoutingCosmosDBSqlApiProperties

Properti yang terkait dengan titik akhir kontainer sql cosmos DB.

Nama Jenis Deskripsi
authenticationType

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

ManagedIdentity

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

RoutingCosmosDBSqlApiProperties[]

Daftar titik akhir kontainer Cosmos DB tempat hub IoT merutekan pesan, berdasarkan aturan perutean.

eventHubs

RoutingEventHubProperties[]

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

RoutingServiceBusQueueEndpointProperties[]

Daftar titik akhir antrean Azure Service Bus tempat hub IoT merutekan pesan, berdasarkan aturan perutean.

serviceBusTopics

RoutingServiceBusTopicEndpointProperties[]

Daftar titik akhir topik Bus Layanan tempat hub IoT merutekan pesan, berdasarkan aturan perutean.

storageContainers

RoutingStorageContainerProperties[]

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

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

ManagedIdentity

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

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.

enrichments

EnrichmentProperties[]

Daftar pengayaan yang disediakan pengguna yang berlaku untuk pesan yang akan dikirimkan ke titik akhir bawaan dan kustom. Melihat: https://aka.ms/telemetryoneventgrid

fallbackRoute

FallbackRouteProperties

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

RouteProperties[]

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.

RoutingServiceBusQueueEndpointProperties

Properti yang terkait dengan jenis titik akhir antrean bus layanan.

Nama Jenis Deskripsi
authenticationType

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

ManagedIdentity

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

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

ManagedIdentity

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

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:
  • Avro
  • AvroDeflate
  • JSON

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

ManagedIdentity

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

AccessRights

Izin yang ditetapkan ke kebijakan akses bersama.

secondaryKey

string

Kunci sekunder.

StorageEndpointProperties

Properti titik akhir Azure Storage untuk pengunggahan file.

Nama Jenis Deskripsi
authenticationType

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

ManagedIdentity

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

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

createdByType

Jenis identitas yang terakhir mengubah sumber daya.