Iot Hub Resource - Delete
IoT Hub törlése.
DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2023-06-30
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Az IoT Hubot tartalmazó erőforráscsoport neve. |
resource
|
path | True |
string |
Az IoT Hub neve. |
subscription
|
path | True |
string |
Az előfizetés azonosítója. |
api-version
|
query | True |
string |
Az API verziója. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
Ezt a rendszer a törlési művelet állapot-lekérdezési kérésére adott válaszként adja vissza. A törzs tartalmazza az átmeneti kiépítési állapotot jelző erőforrás-ábrázolást. |
|
202 Accepted |
Az Iot Hub erőforrás-szolgáltató mindig 202 Elfogadva állapotkódot ad vissza érvényes Hely és Retry-After fejlécekkel. Az erőforrás-szolgáltató a Azure-AsyncOperation fejlécet is beállítja egy URL-címmel, amely a művelet műveleti erőforrására mutat. A DELETE művelet után az erőforrásra irányuló későbbi GET-kísérletek egy átmeneti kiépítési állapotot jelző erőforrás-reprezentációt ad vissza (például Leépítés). A művelet állapotának lekéréséhez az ügyfél lekérdezheti a Hely fejlécben visszaadott URL-címet a Retry-After intervallum után, közvetlenül lekérheti a IoT Hub szolgáltatás állapotát, vagy lekérdezheti a műveleti erőforrást. Headers
|
|
204 No Content |
Ha a hosszú ideig futó törlési művelet sikeresen befejeződött, a rendszer egy 204 No Content állapotkódot ad vissza, amikor az állapot-lekérdezési kérelem megkeresi az Iot Hub metaadatait a szolgáltatásban, és a törlési művelet állapota befejezett állapotra van állítva. |
|
404 Not Found |
Miután a hosszú ideig futó törlési művelet sikeresen befejeződött, a rendszer 404 Nem található értéket ad vissza, ha az állapot-lekérdezési kérelem már nem találja az Iot Hub metaadatait a szolgáltatásban. |
|
Other Status Codes |
DefaultErrorResponse |
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | felhasználói fiók megszemélyesítése |
Példák
IotHubResource_Delete
Sample Request
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"
},
"sku": {
"name": "S1",
"tier": "Standard",
"capacity": 1
},
"systemData": {
"createdAt": "2021-01-30T00:28:38.963Z"
}
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/operationResults/b3NfaWhfYmJhZmM4OWItNzQ3My00OWExLTg0NWUtNzQ3NWU2ODBkNDA3?api-version=2023-06-30-preview&operationSource=os_ih&asyncinfo
Location: https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/operationResults/b3NfaWhfYmJhZmM4OWItNzQ3My00OWExLTg0NWUtNzQ3NWU2ODBkNDA3?api-version=2022-11-01-preview&operationSource=os_ih
{
"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"
},
"sku": {
"name": "S1",
"tier": "Standard",
"capacity": 1
}
}
{}
Definíciók
Name | Description |
---|---|
Access |
A megosztott hozzáférési szabályzathoz rendelt engedélyek. |
Arm |
|
Arm |
|
Authentication |
Megadja a tárfiókhoz való csatlakozáshoz használt hitelesítési típust. |
authentication |
A Service Bus-üzenetsor végpontja alapján történő hitelesítéshez használt módszer |
Capabilities |
Az IoT Hubhoz engedélyezett képességek és funkciók. |
Cloud |
Az IoT Hub felhőalapú üzenetkezelési tulajdonságai. |
created |
Az erőforrást létrehozó identitás típusa. |
Default |
Hálózati szabálykészlet alapértelmezett művelete |
Enrichment |
Az IoT Hub által a végpontokra küldött üzenetekre vonatkozó bővítés tulajdonságai. |
Error |
Hiba részletei. |
Event |
Az IoT Hub által használt kiépített Event Hub-kompatibilis végpont tulajdonságai. |
Fallback |
A tartalék útvonal tulajdonságai. IoT Hub ezeket a tulajdonságokat használja, amikor az üzeneteket a tartalék végpontra irányítja. |
Feedback |
A felhőből az eszközre irányuló üzenetek visszajelzési üzenetsorának tulajdonságai. |
Iot |
Az IoT Hub leírása. |
Iot |
Az erőforrások kiépítésére szolgáló helyek egyikének nyilvános képviselete. |
Iot |
Egy IoT Hub tulajdonságai. |
Iot |
A régió szerepköre lehet elsődleges vagy másodlagos. Az elsődleges régió az, ahol az IoT Hub jelenleg ki van építve. A másodlagos régió az Azure vészhelyreállítási (DR) párosított régiója, valamint az a régió, ahová az IoT Hub feladatátvételt végezhet. |
Iot |
A termékváltozat neve. |
Iot |
Az IoT Hub termékváltozatával kapcsolatos információk. |
Iot |
Az IoT Hub számlázási szintje. |
Ip |
A szabály által rögzített kérések kívánt művelete. |
Ip |
Az IoT Hub IP-szűrési szabályai. |
Managed |
A felügyelt identitás tulajdonságai. |
Messaging |
Az IoT Hub által használt üzenetkezelési végpontok tulajdonságai. |
Network |
IP-szűrési művelet |
Network |
A hálózati szabálykészlet részeként alkalmazandó IP-szabály |
Network |
Az IotHub hálózati szabálykészletének tulajdonságai |
Private |
A privát végponti kapcsolat privát végpont tulajdonsága |
Private |
Egy IotHub privát végpontkapcsolata |
Private |
A privát végponti kapcsolat tulajdonságai |
Private |
A privát végponti kapcsolat aktuális állapota |
Private |
Privát végponti kapcsolat állapota |
Public |
A nyilvános hálózatról érkező kérések engedélyezése |
Resource |
Az erőforráshoz használt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolítja az identitásokat a szolgáltatásból. |
Route |
Egy útválasztási szabály tulajdonságai, amelyeket az IoT Hub az üzenetek végpontokra irányításához használ. |
Routing |
A cosmos DB SQL-tárolóvégponthoz kapcsolódó tulajdonságok. |
Routing |
Azokhoz az egyéni végpontokhoz kapcsolódó tulajdonságok, amelyekhez az IoT Hub az útválasztási szabályok alapján irányítja az üzeneteket. A fizetős központok végponttípusai között legfeljebb 10 egyéni végpont engedélyezett, az ingyenes központokhoz pedig csak 1 egyéni végpont engedélyezett az összes végponttípuson. |
Routing |
Az eseményközpont-végponthoz kapcsolódó tulajdonságok. |
Routing |
Az IoT Hub útválasztással kapcsolatos tulajdonságai. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging |
Routing |
A Service Bus-üzenetsor végponttípusaihoz kapcsolódó tulajdonságok. |
Routing |
A Service Bus-témakör végponttípusaihoz kapcsolódó tulajdonságok. |
Routing |
A forrás, amellyel az útválasztási szabályt alkalmazni kell, például DeviceMessages. |
Routing |
A tárolóvégponthoz kapcsolódó tulajdonságok. |
Shared |
Az IoT Hub megosztott hozzáférési szabályzatának tulajdonságai. |
Storage |
Az Azure Storage-végpont tulajdonságai fájlfeltöltéshez. |
system |
Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok. |
AccessRights
A megosztott hozzáférési szabályzathoz rendelt engedélyek.
Name | Típus | Description |
---|---|---|
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
Name | Típus | Description |
---|---|---|
principalId |
string |
Egyszerű azonosító |
tenantId |
string |
Bérlőazonosító |
type |
Az erőforráshoz használt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolítja az identitásokat a szolgáltatásból. |
|
userAssignedIdentities |
<string,
Arm |
ArmUserIdentity
Name | Típus | Description |
---|---|---|
clientId |
string |
|
principalId |
string |
AuthenticationType
Megadja a tárfiókhoz való csatlakozáshoz használt hitelesítési típust.
Name | Típus | Description |
---|---|---|
identityBased |
string |
|
keyBased |
string |
authenticationType
A Service Bus-üzenetsor végpontja alapján történő hitelesítéshez használt módszer
Name | Típus | Description |
---|---|---|
identityBased |
string |
|
keyBased |
string |
Capabilities
Az IoT Hubhoz engedélyezett képességek és funkciók.
Name | Típus | Description |
---|---|---|
DeviceManagement |
string |
|
None |
string |
CloudToDeviceProperties
Az IoT Hub felhőalapú üzenetkezelési tulajdonságai.
Name | Típus | Description |
---|---|---|
defaultTtlAsIso8601 |
string |
Az alapértelmezett élettartam a felhőből az eszközre irányuló üzenetekhez az eszközsoron. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
feedback |
A felhőből az eszközre irányuló üzenetek visszajelzési üzenetsorának tulajdonságai. |
|
maxDeliveryCount |
integer |
A felhőből az eszközre irányuló üzenetek maximális kézbesítési száma az eszközsoron. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
createdByType
Az erőforrást létrehozó identitás típusa.
Name | Típus | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DefaultAction
Hálózati szabálykészlet alapértelmezett művelete
Name | Típus | Description |
---|---|---|
Allow |
string |
|
Deny |
string |
EnrichmentProperties
Az IoT Hub által a végpontokra küldött üzenetekre vonatkozó bővítés tulajdonságai.
Name | Típus | Description |
---|---|---|
endpointNames |
string[] |
Azon végpontok listája, amelyekre a bővítés vonatkozik az üzenetre. |
key |
string |
A bővítési tulajdonság kulcsa vagy neve. |
value |
string |
A bővítési tulajdonság értéke. |
ErrorDetails
Hiba részletei.
Name | Típus | Description |
---|---|---|
code |
string |
A hibakód. |
details |
string |
A hiba részletei. |
httpStatusCode |
string |
A HTTP-állapotkód. |
message |
string |
A hibaüzenet. |
EventHubProperties
Az IoT Hub által használt kiépített Event Hub-kompatibilis végpont tulajdonságai.
Name | Típus | Description |
---|---|---|
endpoint |
string |
Az Event Hub-kompatibilis végpont. |
partitionCount |
integer |
Az eszközről a felhőbe irányuló üzenetek fogadására szolgáló partíciók száma az Event Hub-kompatibilis végponton. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. |
partitionIds |
string[] |
Az Event Hub-kompatibilis végpont partícióazonosítói. |
path |
string |
Az Event Hub-kompatibilis név. |
retentionTimeInDays |
integer |
Az eszközről a felhőbe irányuló üzenetek megőrzési ideje napokban. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages |
FallbackRouteProperties
A tartalék útvonal tulajdonságai. IoT Hub ezeket a tulajdonságokat használja, amikor az üzeneteket a tartalék végpontra irányítja.
Name | Típus | Description |
---|---|---|
condition |
string |
A tartalék útvonal alkalmazásához kiértékelt feltétel. Ha a feltétel nincs megadva, alapértelmezés szerint true (igaz) értéket ad vissza. A nyelvhelyességről lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language |
endpointNames |
string[] |
Azon végpontok listája, amelyekhez a feltételnek megfelelő üzeneteket a rendszer átirányítja. Jelenleg csak 1 végpont engedélyezett. |
isEnabled |
boolean |
Annak megadására szolgál, hogy a tartalék útvonal engedélyezve van-e. |
name |
string |
Az útvonal neve. A név csak alfanumerikus karaktereket, pontokat, aláhúzásjeleket, kötőjeleket tartalmazhat, legfeljebb 64 karakter hosszúságú lehet, és egyedinek kell lennie. |
source |
Az a forrás, amelyre az útválasztási szabályt alkalmazni kell. Például: DeviceMessages |
FeedbackProperties
A felhőből az eszközre irányuló üzenetek visszajelzési üzenetsorának tulajdonságai.
Name | Típus | Description |
---|---|---|
lockDurationAsIso8601 |
string |
A visszajelzési üzenetsor zárolási időtartama. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
maxDeliveryCount |
integer |
Az IoT Hub hányszor kísérel meg üzenetet küldeni a visszajelzési üzenetsoron. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
ttlAsIso8601 |
string |
Az az időtartam, amelyre egy üzenet felhasználható, mielőtt az IoT Hub lejárt volna. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
IotHubDescription
Az IoT Hub leírása.
Name | Típus | Description |
---|---|---|
etag |
string |
Az Etag mezőre nincs szükség. Ha a válasz törzsében szerepel, akkor fejlécként is meg kell adni a normál ETag-konvenciók szerint. |
id |
string |
Az erőforrás azonosítója. |
identity |
Az IotHub felügyelt identitásai. |
|
location |
string |
Az erőforrás helye. |
name |
string |
Az erőforrás neve. |
properties |
IotHub-tulajdonságok |
|
sku |
Az IotHub termékváltozatának adatai |
|
systemData |
Az erőforráshoz kapcsolódó rendszer metaadatai. |
|
tags |
object |
Az erőforráscímkék. |
type |
string |
Az erőforrás típusa. |
IotHubLocationDescription
Az erőforrások kiépítésére szolgáló helyek egyikének nyilvános képviselete.
Name | Típus | Description |
---|---|---|
location |
string |
Az Azure-régió neve |
role |
A régió szerepköre lehet elsődleges vagy másodlagos. Az elsődleges régió az, ahol az IoT Hub jelenleg ki van építve. A másodlagos régió az Azure vészhelyreállítási (DR) párosított régiója, valamint az a régió, ahová az IoT Hub feladatátvételt végezhet. |
IotHubProperties
Egy IoT Hub tulajdonságai.
Name | Típus | Description |
---|---|---|
allowedFqdnList |
string[] |
Az Iot Hubról történő kimenő forgalomhoz engedélyezett teljes tartománynév (teljes tartománynév) listája. |
authorizationPolicies |
Az IoT Hubhoz való csatlakozás biztonságossá tételéhez használható megosztott hozzáférési szabályzatok. |
|
cloudToDevice |
Az IoT Hub felhőalapú üzenetküldési tulajdonságai. |
|
comments |
string |
IoT Hub-megjegyzések. |
disableDeviceSAS |
boolean |
Ha igaz, a hitelesítéshez nem használható minden eszköz (beleértve az Edge-eszközöket, de a modulok kivételével) hatókörű SAS-kulcsokat. |
disableLocalAuth |
boolean |
Ha igaz, az Iot Hub hatókörű SAS-kulcsokkal rendelkező SAS-jogkivonatok nem használhatók hitelesítéshez. |
disableModuleSAS |
boolean |
Ha igaz, a modul hatókörébe tartozó SAS-kulcsok nem használhatók hitelesítéshez. |
enableDataResidency |
boolean |
Ha ez a tulajdonság igaz értékre van állítva, engedélyezi az adattárolást, így letiltja a vészhelyreállítást. |
enableFileUploadNotifications |
boolean |
Ha igaz, a fájlfeltöltési értesítések engedélyezve vannak. |
eventHubEndpoints |
<string,
Event |
Az Event Hub-kompatibilis végpont tulajdonságai. A szótár egyetlen lehetséges kulcsa az események. Ennek a kulcsnak szerepelnie kell a szótárban az IoT Hub létrehozási vagy frissítési hívásai során. |
features |
Az IoT Hubhoz engedélyezett képességek és funkciók. |
|
hostName |
string |
A gazdagép neve. |
ipFilterRules |
Az IP-szűrési szabályok. |
|
locations |
Az iot hub elsődleges és másodlagos helye |
|
messagingEndpoints |
<string,
Messaging |
A fájlfeltöltési értesítési üzenetsor üzenetkezelési végpontjának tulajdonságai. |
minTlsVersion |
string |
Meghatározza az ehhez a központhoz támogatott minimális TLS-verziót. Az "1.2" értékre állítható be, hogy az 1.2-esnél kisebb TLS-verziót használó ügyfelek elutasíthatók legyenek. |
networkRuleSets |
Az IotHub hálózati szabálykészletének tulajdonságai |
|
privateEndpointConnections |
Ezen az IotHubon létrehozott privát végpontkapcsolatok |
|
provisioningState |
string |
A kiépítés állapota. |
publicNetworkAccess |
A nyilvános hálózatról érkező kérések engedélyezése |
|
restrictOutboundNetworkAccess |
boolean |
Ha igaz, az IotHubról érkező kimenő forgalom csak az engedélyezett teljes tartománynevekre lesz korlátozva, amelyek az allowedFqdnList használatával vannak konfigurálva. |
routing |
Az IoT Hub útválasztással kapcsolatos tulajdonságai. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging |
|
state |
string |
A központ állapota. |
storageEndpoints |
<string,
Storage |
Az Azure Storage-végpontok listája, ahol fájlokat tölthet fel. Jelenleg csak egy Azure Storage-fiókot konfigurálhat, amelynek kulcsával $default kell rendelkeznie. Ha egynél több tárfiókot ad meg, a rendszer hibát jelez. Ha nem ad meg értéket ennek a tulajdonságnak, ha az enableFileUploadNotifications tulajdonság értéke True , a rendszer hibát jelez. |
IotHubReplicaRoleType
A régió szerepköre lehet elsődleges vagy másodlagos. Az elsődleges régió az, ahol az IoT Hub jelenleg ki van építve. A másodlagos régió az Azure vészhelyreállítási (DR) párosított régiója, valamint az a régió, ahová az IoT Hub feladatátvételt végezhet.
Name | Típus | Description |
---|---|---|
primary |
string |
|
secondary |
string |
IotHubSku
A termékváltozat neve.
Name | Típus | Description |
---|---|---|
B1 |
string |
|
B2 |
string |
|
B3 |
string |
|
F1 |
string |
|
S1 |
string |
|
S2 |
string |
|
S3 |
string |
IotHubSkuInfo
Az IoT Hub termékváltozatával kapcsolatos információk.
Name | Típus | Description |
---|---|---|
capacity |
integer |
A kiépített IoT Hub egységek száma. Lásd: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. |
name |
A termékváltozat neve. |
|
tier |
Az IoT Hub számlázási szintje. |
IotHubSkuTier
Az IoT Hub számlázási szintje.
Name | Típus | Description |
---|---|---|
Basic |
string |
|
Free |
string |
|
Standard |
string |
IpFilterActionType
A szabály által rögzített kérések kívánt művelete.
Name | Típus | Description |
---|---|---|
Accept |
string |
|
Reject |
string |
IpFilterRule
Az IoT Hub IP-szűrési szabályai.
Name | Típus | Description |
---|---|---|
action |
A szabály által rögzített kérések kívánt művelete. |
|
filterName |
string |
Az IP-szűrőszabály neve. |
ipMask |
string |
A szabály CIDR-jelölésében szereplő IP-címtartományt tartalmazó sztring. |
ManagedIdentity
A felügyelt identitás tulajdonságai.
Name | Típus | Description |
---|---|---|
userAssignedIdentity |
string |
A felhasználó által hozzárendelt identitás. |
MessagingEndpointProperties
Az IoT Hub által használt üzenetkezelési végpontok tulajdonságai.
Name | Típus | Description |
---|---|---|
lockDurationAsIso8601 |
string |
A zárolás időtartama. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
maxDeliveryCount |
integer |
Az IoT Hub hányszor kísérel meg üzenetet kézbesíteni. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
ttlAsIso8601 |
string |
Az az időtartam, amelyre egy üzenet felhasználható, mielőtt az IoT Hub lejárt volna. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
NetworkRuleIPAction
IP-szűrési művelet
Name | Típus | Description |
---|---|---|
Allow |
string |
NetworkRuleSetIpRule
A hálózati szabálykészlet részeként alkalmazandó IP-szabály
Name | Típus | Alapértelmezett érték | Description |
---|---|---|---|
action | Allow |
IP-szűrési művelet |
|
filterName |
string |
Az IP-szűrőszabály neve. |
|
ipMask |
string |
Egy sztring, amely a szabály CIDR-jelölésében szereplő IP-címtartományt tartalmazza. |
NetworkRuleSetProperties
Az IotHub hálózati szabálykészletének tulajdonságai
Name | Típus | Alapértelmezett érték | Description |
---|---|---|---|
applyToBuiltInEventHubEndpoint |
boolean |
Ha igaz, akkor a rendszer a hálózati szabálykészletet is alkalmazza az IotHub BuiltIn EventHub EndPointjára |
|
defaultAction | Deny |
Hálózati szabálykészlet alapértelmezett művelete |
|
ipRules |
IP-szabályok listája |
PrivateEndpoint
A privát végponti kapcsolat privát végpont tulajdonsága
Name | Típus | Description |
---|---|---|
id |
string |
Az erőforrás azonosítója. |
PrivateEndpointConnection
Egy IotHub privát végpontkapcsolata
Name | Típus | Description |
---|---|---|
id |
string |
Az erőforrás azonosítója. |
name |
string |
Az erőforrás neve. |
properties |
Privát végpontkapcsolat tulajdonságai |
|
type |
string |
Az erőforrás típusa. |
PrivateEndpointConnectionProperties
A privát végponti kapcsolat tulajdonságai
Name | Típus | Description |
---|---|---|
privateEndpoint |
A privát végponti kapcsolat privát végpont tulajdonsága |
|
privateLinkServiceConnectionState |
A privát végponti kapcsolat aktuális állapota |
PrivateLinkServiceConnectionState
A privát végponti kapcsolat aktuális állapota
Name | Típus | Description |
---|---|---|
actionsRequired |
string |
Privát végponti kapcsolathoz szükséges műveletek |
description |
string |
A privát végponti kapcsolat aktuális állapotának leírása |
status |
Privát végponti kapcsolat állapota |
PrivateLinkServiceConnectionStatus
Privát végponti kapcsolat állapota
Name | Típus | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PublicNetworkAccess
A nyilvános hálózatról érkező kérések engedélyezése
Name | Típus | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ResourceIdentityType
Az erőforráshoz használt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolítja az identitásokat a szolgáltatásból.
Name | Típus | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
RouteProperties
Egy útválasztási szabály tulajdonságai, amelyeket az IoT Hub az üzenetek végpontokra irányításához használ.
Name | Típus | Description |
---|---|---|
condition |
string |
Az útválasztási szabály alkalmazásához kiértékelt feltétel. Ha nincs megadva feltétel, alapértelmezés szerint true (igaz) értéket ad vissza. A nyelvhelyességről a következő témakörben olvashat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language |
endpointNames |
string[] |
Azon végpontok listája, amelyekhez a feltételnek megfelelő üzenetek vannak átirányítva. Jelenleg csak egy végpont engedélyezett. |
isEnabled |
boolean |
Annak megadására szolgál, hogy engedélyezve van-e egy útvonal. |
name |
string |
Az útvonal neve. A név csak alfanumerikus karaktereket, pontokat, aláhúzásjeleket, kötőjeleket tartalmazhat, legfeljebb 64 karakter hosszúságú lehet, és egyedinek kell lennie. |
source |
A forrás, amellyel az útválasztási szabályt alkalmazni kell, például DeviceMessages. |
RoutingCosmosDBSqlApiProperties
A cosmos DB SQL-tárolóvégponthoz kapcsolódó tulajdonságok.
Name | Típus | Description |
---|---|---|
authenticationType |
A cosmos DB SQL-tárolóvégponton történő hitelesítéshez használt módszer |
|
containerName |
string |
A cosmos DB SQL-tároló neve a cosmos DB-adatbázisban. |
databaseName |
string |
A cosmos DB-adatbázis neve a cosmos DB-fiókban. |
endpointUri |
string |
A cosmos DB-fiók URL-címe. Tartalmaznia kell a protokoll https:// |
id |
string |
A cosmos DB SQL-tárolóvégpont azonosítója |
identity |
A Cosmos DB-tárolóvégpont útválasztásának felügyelt identitástulajdonságai. |
|
name |
string |
A végpontot azonosító név. A név csak alfanumerikus karaktereket, pontokat, aláhúzásjeleket, kötőjeleket tartalmazhat, és legfeljebb 64 karakter hosszúságú lehet. A következő nevek vannak fenntartva: események, fileNotifications, $default. A végpontneveknek egyedinek kell lenniük a végponttípusok között. |
partitionKeyName |
string |
A cosmos DB SQL-tárolóhoz társított partíciókulcs neve, ha van ilyen. Ez egy nem kötelező paraméter. |
partitionKeyTemplate |
string |
A cosmos DB SQL-tárolóhoz használható szintetikus partíciókulcs-érték létrehozására szolgáló sablon. A sablonnak tartalmaznia kell legalább az alábbi helyőrzők egyikét: {iothub}, {deviceid}, {DD}, {MM} és {YYYY}. Egy helyőrző legfeljebb egyszer adható meg, de a sorrend és a nem helyőrző összetevők tetszőlegesek. Ez a paraméter csak akkor szükséges, ha a PartitionKeyName meg van adva. |
primaryKey |
string |
A cosmos DB-fiók elsődleges kulcsa. |
resourceGroup |
string |
A cosmos DB-fiók erőforráscsoportjának neve. |
secondaryKey |
string |
A cosmos DB-fiók másodlagos kulcsa. |
subscriptionId |
string |
A cosmos DB-fiók előfizetés-azonosítója. |
RoutingEndpoints
Azokhoz az egyéni végpontokhoz kapcsolódó tulajdonságok, amelyekhez az IoT Hub az útválasztási szabályok alapján irányítja az üzeneteket. A fizetős központok végponttípusai között legfeljebb 10 egyéni végpont engedélyezett, az ingyenes központokhoz pedig csak 1 egyéni végpont engedélyezett az összes végponttípuson.
Name | Típus | Description |
---|---|---|
cosmosDBSqlContainers |
Azoknak a Cosmos DB-tárolóvégpontoknak a listája, amelyekhez az IoT Hub átirányítja az üzeneteket az útválasztási szabályok alapján. |
|
eventHubs |
Azon Event Hubs-végpontok listája, amelyekhez az IoT Hub átirányítja az üzeneteket az útválasztási szabályok alapján. Ez a lista nem tartalmazza a beépített Event Hubs-végpontot. |
|
serviceBusQueues |
Azoknak a Service Bus-üzenetsorvégpontoknak a listája, amelyekhez az IoT Hub átirányítja az üzeneteket az útválasztási szabályok alapján. |
|
serviceBusTopics |
Azoknak a Service Bus-témakörvégpontoknak a listája, amelyekhez az IoT Hub átirányítja az üzeneteket az útválasztási szabályok alapján. |
|
storageContainers |
Azon tárolóvégpontok listája, amelyekhez az IoT Hub átirányítja az üzeneteket az útválasztási szabályok alapján. |
RoutingEventHubProperties
Az eseményközpont-végponthoz kapcsolódó tulajdonságok.
Name | Típus | Description |
---|---|---|
authenticationType |
Az eseményközpont végpontja felé történő hitelesítéshez használt módszer |
|
connectionString |
string |
Az eseményközpont végpontjának kapcsolati karakterlánc. |
endpointUri |
string |
Az eseményközpont végpontjának URL-címe. Tartalmaznia kell a protokoll sb:// |
entityPath |
string |
Eseményközpont neve az eseményközpont névterében |
id |
string |
Az eseményközpont végpontjának azonosítója |
identity |
Az útválasztási eseményközpont végpontjának felügyelt identitástulajdonságai. |
|
name |
string |
A végpontot azonosító név. A név csak alfanumerikus karaktereket, pontokat, aláhúzásjeleket, kötőjeleket tartalmazhat, és legfeljebb 64 karakter hosszúságú lehet. A következő nevek vannak fenntartva: események, fileNotifications, $default. A végpontneveknek egyedinek kell lenniük a végponttípusok között. |
resourceGroup |
string |
Az eseményközpont-végpont erőforráscsoportjának neve. |
subscriptionId |
string |
Az eseményközpont végpontjának előfizetés-azonosítója. |
RoutingProperties
Az IoT Hub útválasztással kapcsolatos tulajdonságai. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
Name | Típus | Description |
---|---|---|
endpoints |
Azoknak az egyéni végpontoknak a tulajdonságai, amelyekre az IoT Hub az útválasztási szabályok alapján irányítja az üzeneteket. A fizetős központok esetében az összes végponttípusban legfeljebb 10 egyéni végpont engedélyezett, az ingyenes központokhoz pedig csak 1 egyéni végpont engedélyezett az összes végponttípusban. |
|
enrichments |
A felhasználó által biztosított bővítések listája, amelyeket az IoT Hub a beépített és egyéni végpontokra kézbesítendő üzenetekre alkalmaz. Lásd: https://aka.ms/telemetryoneventgrid |
|
fallbackRoute |
A visszaeső útvonalként használt útvonal tulajdonságai, ha az "útvonalak" szakaszban megadott feltételek egyike sem teljesül. Ez egy nem kötelező paraméter. Ha ez a tulajdonság nincs jelen a sablonban, a tartalék útvonal alapértelmezés szerint le van tiltva. |
|
routes |
A felhasználó által megadott útválasztási szabályok listája, amelyeket az IoT Hub az üzenetek beépített és egyéni végpontokra való átirányítására használ. A fizetős központok esetében legfeljebb 100 útválasztási szabály engedélyezett, az ingyenes központok esetében pedig legfeljebb 5 útválasztási szabály engedélyezett. |
RoutingServiceBusQueueEndpointProperties
A Service Bus-üzenetsor végponttípusaihoz kapcsolódó tulajdonságok.
Name | Típus | Description |
---|---|---|
authenticationType |
A Service Bus-üzenetsor végpontja alapján történő hitelesítéshez használt módszer |
|
connectionString |
string |
A Service Bus-üzenetsor végpontjának kapcsolati karakterlánc. |
endpointUri |
string |
A Service Bus-üzenetsor végpontjának URL-címe. Tartalmaznia kell a protokoll sb:// |
entityPath |
string |
Üzenetsor neve a Service Bus-névtérben |
id |
string |
A Service Bus-üzenetsor végpontjának azonosítója |
identity |
A Service Bus-üzenetsor végpontjának felügyelt identitástulajdonságai. |
|
name |
string |
A végpontot azonosító név. A név csak alfanumerikus karaktereket, pontokat, aláhúzásjeleket, kötőjeleket tartalmazhat, és legfeljebb 64 karakter hosszúságú lehet. A következő nevek vannak fenntartva: események, fileNotifications, $default. A végpontneveknek egyedinek kell lenniük a végponttípusok között. A névnek nem kell megegyeznie az üzenetsor tényleges nevével. |
resourceGroup |
string |
A Service Bus-üzenetsor végpontjának erőforráscsoportjának neve. |
subscriptionId |
string |
A Service Bus-üzenetsor végpontjának előfizetés-azonosítója. |
RoutingServiceBusTopicEndpointProperties
A Service Bus-témakör végponttípusaihoz kapcsolódó tulajdonságok.
Name | Típus | Description |
---|---|---|
authenticationType |
A Service Bus-témakör végpontja alapján történő hitelesítéshez használt módszer |
|
connectionString |
string |
A Service Bus-témakör végpontjának kapcsolati karakterlánc. |
endpointUri |
string |
A Service Bus-témakör végpontjának URL-címe. Tartalmaznia kell a protokoll sb:// |
entityPath |
string |
Üzenetsor neve a Service Bus-témakörben |
id |
string |
A Service Bus-témakör végpontjának azonosítója |
identity |
Az útválasztási Service Bus-témakör végpontjának felügyelt identitástulajdonságai. |
|
name |
string |
A végpontot azonosító név. A név csak alfanumerikus karaktereket, pontokat, aláhúzásjeleket, kötőjeleket tartalmazhat, és legfeljebb 64 karakter hosszúságú lehet. A következő nevek vannak fenntartva: események, fileNotifications, $default. A végpontneveknek egyedinek kell lenniük a végponttípusok között. A névnek nem kell megegyeznie a témakör tényleges nevével. |
resourceGroup |
string |
A Service Bus-témakör végpontjának erőforráscsoportjának neve. |
subscriptionId |
string |
A Service Bus-témakör végpontjának előfizetés-azonosítója. |
RoutingSource
A forrás, amellyel az útválasztási szabályt alkalmazni kell, például DeviceMessages.
Name | Típus | Description |
---|---|---|
DeviceConnectionStateEvents |
string |
|
DeviceJobLifecycleEvents |
string |
|
DeviceLifecycleEvents |
string |
|
DeviceMessages |
string |
|
Invalid |
string |
|
TwinChangeEvents |
string |
RoutingStorageContainerProperties
A tárolóvégponthoz kapcsolódó tulajdonságok.
Name | Típus | Description |
---|---|---|
authenticationType |
A tárvégponton történő hitelesítéshez használt módszer |
|
batchFrequencyInSeconds |
integer |
A blobok tárolóba való írásának időintervalluma. Az értéknek 60 és 720 másodperc között kell lennie. Az alapértelmezett érték 300 másodperc. |
connectionString |
string |
A tárfiók kapcsolati karakterlánc. |
containerName |
string |
A tárfiókban található tároló neve. |
encoding |
enum:
|
Kódolás, amely az üzenetek blobokra való szerializálására szolgál. A támogatott értékek a következők: "avro", "avrodeflate" és "JSON". Az alapértelmezett érték az "avro". |
endpointUri |
string |
A tárolási végpont URL-címe. Tartalmaznia kell a protokoll https:// |
fileNameFormat |
string |
A blob fájlnévformátuma. Alapértelmezett formátum: {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. Minden paraméter kötelező, de átrendezhető. |
id |
string |
A tárolóvégpont azonosítója |
identity |
Az útválasztási tárvégpont felügyelt identitástulajdonságai. |
|
maxChunkSizeInBytes |
integer |
A tárolóba írt blobok maximális száma bájtban. Az értéknek 10485760(10 MB) és 524288000(500 MB) között kell lennie. Az alapértelmezett érték a 314572800 (300 MB). |
name |
string |
A végpontot azonosító név. A név csak alfanumerikus karaktereket, pontokat, aláhúzásjeleket, kötőjeleket tartalmazhat, és legfeljebb 64 karakter hosszúságú lehet. A következő nevek vannak fenntartva: események, fileNotifications, $default. A végpontneveknek egyedinek kell lenniük a végponttípusok között. |
resourceGroup |
string |
A tárfiók erőforráscsoportjának neve. |
subscriptionId |
string |
A tárfiók előfizetés-azonosítója. |
SharedAccessSignatureAuthorizationRule
Az IoT Hub megosztott hozzáférési szabályzatának tulajdonságai.
Name | Típus | Description |
---|---|---|
keyName |
string |
A megosztott hozzáférési szabályzat neve. |
primaryKey |
string |
Az elsődleges kulcs. |
rights |
A megosztott hozzáférési szabályzathoz rendelt engedélyek. |
|
secondaryKey |
string |
A másodlagos kulcs. |
StorageEndpointProperties
Az Azure Storage-végpont tulajdonságai fájlfeltöltéshez.
Name | Típus | Description |
---|---|---|
authenticationType |
Megadja a tárfiókhoz való csatlakozáshoz használt hitelesítési típust. |
|
connectionString |
string |
Annak az Azure Storage-fióknak a kapcsolati karakterlánc, ahová a fájlokat feltölti. |
containerName |
string |
Annak a gyökértárolónak a neve, ahová fájlokat tölt fel. A tárolónak nem kell léteznie, de a megadott connectionString használatával kreatálhatónak kell lennie. |
identity |
A tárvégpont felügyelt identitástulajdonságai fájlfeltöltéshez. |
|
sasTtlAsIso8601 |
string |
Az az időtartam, amelyre a IoT Hub által a fájlfeltöltéshez létrehozott SAS URI érvényes. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. |
systemData
Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
Name | Típus | Description |
---|---|---|
createdAt |
string |
Az erőforrás-létrehozás időbélyege (UTC). |
createdBy |
string |
Az erőforrást létrehozó identitás. |
createdByType |
Az erőforrást létrehozó identitás típusa. |
|
lastModifiedAt |
string |
Az erőforrás utolsó módosításának időbélyege (UTC) |
lastModifiedBy |
string |
Az az identitás, amely legutóbb módosította az erőforrást. |
lastModifiedByType |
Az erőforrást legutóbb módosító identitás típusa. |