Megosztás a következőn keresztül:


Iot Hub Resource - Get

Lekérheti egy IoT Hub nem biztonsággal kapcsolatos metaadatait.

GET 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
resourceGroupName
path True

string

Az IoT Hubot tartalmazó erőforráscsoport neve.

resourceName
path True

string

Az IoT Hub neve.

subscriptionId
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

IotHubDescription

A törzs tartalmazza az IoT Hub összes nem biztonsági tulajdonságát. A biztonsággal kapcsolatos tulajdonságok értéke null.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation felhasználói fiók megszemélyesítése

Példák

IotHubResource_Get

Mintakérelem

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

Mintaválasz

{
  "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"
  }
}

Definíciók

Name Description
AccessRights

A megosztott hozzáférési szabályzathoz rendelt engedélyek.

ArmIdentity
ArmUserIdentity
AuthenticationType

Megadja a tárfiókhoz való csatlakozáshoz használt hitelesítési típust.

authenticationType

A service bus-üzenetsorvégponton való hitelesítéshez használt módszer

Capabilities

Az IoT Hubhoz engedélyezett képességek és funkciók.

CloudToDeviceProperties

Az IoT Hub felhőalapú üzenetküldési tulajdonságai.

createdByType

Az erőforrást létrehozó identitás típusa.

DefaultAction

Hálózati szabálykészlet alapértelmezett művelete

EnrichmentProperties

Az IoT Hub által a végpontokra küldött üzenetekre vonatkozó bővítés tulajdonságai.

ErrorDetails

Hiba részletei.

EventHubProperties

Az IoT Hub által használt kiépített Event Hub-kompatibilis végpont tulajdonságai.

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.

FeedbackProperties

A visszajelzési üzenetsor tulajdonságai a felhőből az eszközre irányuló üzenetekhez.

IotHubDescription

Az IoT Hub leírása.

IotHubLocationDescription

Az egyik olyan hely nyilvános képviselete, ahol egy erőforrás ki van építve.

IotHubProperties

Az IoT Hub tulajdonságai.

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.

IotHubSku

A termékváltozat neve.

IotHubSkuInfo

Az IoT Hub termékváltozatával kapcsolatos információk.

IotHubSkuTier

Az IoT Hub számlázási szintje.

IpFilterActionType

A szabály által rögzített kérések kívánt művelete.

IpFilterRule

Az IoT Hub IP-szűrési szabályai.

ManagedIdentity

A felügyelt identitás tulajdonságai.

MessagingEndpointProperties

Az IoT Hub által használt üzenetkezelési végpontok tulajdonságai.

NetworkRuleIPAction

IP-szűrőművelet

NetworkRuleSetIpRule

A hálózati szabálykészlet részeként alkalmazandó IP-szabály

NetworkRuleSetProperties

Az IotHub hálózati szabálykészletének tulajdonságai

PrivateEndpoint

Magánvégpont-kapcsolat privát végponttulajdonsága

PrivateEndpointConnection

Egy IotHub privát végponti kapcsolata

PrivateEndpointConnectionProperties

Privát végpontkapcsolat tulajdonságai

PrivateLinkServiceConnectionState

Privát végpontkapcsolat aktuális állapota

PrivateLinkServiceConnectionStatus

Privát végpontkapcsolat állapota

PublicNetworkAccess

Engedélyezve vannak-e a nyilvános hálózatról érkező kérések

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.

RouteProperties

Egy útválasztási szabály tulajdonságai, amelyeket az IoT Hub az üzenetek végpontokhoz való átirányítására használ.

RoutingCosmosDBSqlApiProperties

A cosmos DB sql-tárolóvégponthoz kapcsolódó tulajdonságok.

RoutingEndpoints

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.

RoutingEventHubProperties

Az eseményközpont-végponthoz kapcsolódó tulajdonságok.

RoutingProperties

Az IoT Hub útválasztással kapcsolatos tulajdonságai. Lásd: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

RoutingServiceBusQueueEndpointProperties

A Service Bus-üzenetsor végponttípusaihoz kapcsolódó tulajdonságok.

RoutingServiceBusTopicEndpointProperties

A Service Bus-témakör végponttípusaihoz kapcsolódó tulajdonságok.

RoutingSource

A forrás, amelyre az útválasztási szabályt alkalmazni kell, például DeviceMessages.

RoutingStorageContainerProperties

A tárolóvégponthoz kapcsolódó tulajdonságok.

SharedAccessSignatureAuthorizationRule

Az IoT Hub megosztott hozzáférési szabályzatának tulajdonságai.

StorageEndpointProperties

Az Azure Storage-végpont tulajdonságai a fájlfeltöltéshez.

systemData

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

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.

userAssignedIdentities

<string,  ArmUserIdentity>

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-üzenetsorvégponton való 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ú üzenetküldé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

FeedbackProperties

A visszajelzési üzenetsor tulajdonságai a felhőből az eszközre irányuló üzenetekhez.

maxDeliveryCount

integer

A felhőből 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[]

Azoknak a végpontoknak a 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ához használt 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, akkor alapértelmezés szerint igaz értékre lesz kiértékelve. 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 és kötőjeleket tartalmazhat, legfeljebb 64 karakter hosszúságú lehet, és egyedinek kell lennie.

source

RoutingSource

Az a forrás, amelyre az útválasztási szabályt alkalmazni kell. Például: DeviceMessages

FeedbackProperties

A visszajelzési üzenetsor tulajdonságai a felhőből az eszközre irányuló üzenetekhez.

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ónak megfelelően.

id

string

Az erőforrás azonosítója.

identity

ArmIdentity

Az IotHub felügyelt identitásai.

location

string

Az erőforrás helye.

name

string

Az erőforrás neve.

properties

IotHubProperties

Az IotHub tulajdonságai

sku

IotHubSkuInfo

Az IotHub termékváltozatának adatai

systemData

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 egyik olyan hely nyilvános képviselete, ahol egy erőforrás ki van építve.

Name Típus Description
location

string

Az Azure-régió neve

role

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.

IotHubProperties

Az IoT Hub tulajdonságai.

Name Típus Description
allowedFqdnList

string[]

Az Iot Hubról kimenő forgalomhoz engedélyezett teljes tartománynevek (teljes tartománynév) listája.

authorizationPolicies

SharedAccessSignatureAuthorizationRule[]

Az IoT Hubhoz való csatlakozás biztonságossá tételéhez használható közös hozzáférési szabályzatok.

cloudToDevice

CloudToDeviceProperties

Az IoT Hub felhőalapú üzenetkezelési tulajdonságai.

comments

string

IoT Hub-megjegyzések.

disableDeviceSAS

boolean

Ha igaz, a hitelesítéshez nem használható az összes eszközre (beleértve az Edge-eszközöket, de a modulok kivételével), a hatókörön belüli SAS-kulcsok.

disableLocalAuth

boolean

Ha igaz, az Iot Hub hatókörű SAS-kulcsokkal rendelkező SAS-jogkivonatok nem használhatók a hitelesítéshez.

disableModuleSAS

boolean

Ha igaz, a modul hatókörébe tartozó SAS-kulcsok nem használhatók a hitelesítéshez.

enableDataResidency

boolean

Ez a tulajdonság igaz értékre á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,  EventHubProperties>

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ásainak indításakor.

features

Capabilities

Az IoT Hubhoz engedélyezett képességek és funkciók.

hostName

string

A gazdagép neve.

ipFilterRules

IpFilterRule[]

Az IP-szűrési szabályok.

locations

IotHubLocationDescription[]

Az iot hub elsődleges és másodlagos helye

messagingEndpoints

<string,  MessagingEndpointProperties>

A fájlfeltöltési értesítési üzenetsor üzenetkezelési végpontjának tulajdonságai.

minTlsVersion

string

Meghatározza a központ számára támogatni kívánt minimális TLS-verziót. Az "1.2" értékre állítható, hogy az 1.2-esnél régebbi TLS-verziót használó ügyfeleket elutasítsuk.

networkRuleSets

NetworkRuleSetProperties

Az IotHub hálózati szabálykészletének tulajdonságai

privateEndpointConnections

PrivateEndpointConnection[]

Ezen az IotHubon létrehozott privát végponti kapcsolatok

provisioningState

string

A kiépítési állapot.

publicNetworkAccess

PublicNetworkAccess

Engedélyezve vannak-e a nyilvános hálózatról érkező kérések

restrictOutboundNetworkAccess

boolean

Ha igaz, az IotHubról való kimenő forgalom csak az engedélyezett teljes tartománynevekre lesz korlátozva, amelyek az allowedFqdnList használatával vannak konfigurálva.

routing

RoutingProperties

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

Az Azure Storage-végpontok listája, ahol fájlokat tölthet fel. Jelenleg csak egy Azure Storage-fiókot konfigurálhat, és a kulcsának $default kell lennie. Ha egynél több tárfiókot ad meg, a rendszer hibát jelez. Ha nem ad meg értéket ehhez a tulajdonsághoz, ha az enableFileUploadNotifications tulajdonság értéke Igaz, 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

IotHubSku

A termékváltozat neve.

tier

IotHubSkuTier

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

IpFilterActionType

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

Egy sztring, amely a szabály CIDR-jelölésében szereplő IP-címtartományt tartalmazza.

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 által az üzenetek kézbesítésére tett kísérletek száma. 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ő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

NetworkRuleIPAction

Allow

IP-szűrőművelet

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.

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

DefaultAction

Deny

Hálózati szabálykészlet alapértelmezett művelete

ipRules

NetworkRuleSetIpRule[]

IP-szabályok listája

PrivateEndpoint

Magánvégpont-kapcsolat privát végponttulajdonsága

Name Típus Description
id

string

Az erőforrás azonosítója.

PrivateEndpointConnection

Egy IotHub privát végponti kapcsolata

Name Típus Description
id

string

Az erőforrás azonosítója.

name

string

Az erőforrás neve.

properties

PrivateEndpointConnectionProperties

A privát végponti kapcsolat tulajdonságai

type

string

Az erőforrás típusa.

PrivateEndpointConnectionProperties

Privát végpontkapcsolat tulajdonságai

Name Típus Description
privateEndpoint

PrivateEndpoint

Magánvégpont-kapcsolat privát végponttulajdonsága

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Privát végpontkapcsolat aktuális állapota

PrivateLinkServiceConnectionState

Privát végpontkapcsolat aktuális állapota

Name Típus Description
actionsRequired

string

Privát végpontkapcsolathoz szükséges műveletek

description

string

A privát végpontkapcsolat aktuális állapotának leírása

status

PrivateLinkServiceConnectionStatus

Privát végpontkapcsolat állapota

PrivateLinkServiceConnectionStatus

Privát végpontkapcsolat állapota

Name Típus Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

PublicNetworkAccess

Engedélyezve vannak-e a nyilvános hálózatról érkező kérések

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égpontokhoz való átirányítására 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 igaz értéket ad ki. 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 lesznek á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 és kötőjeleket tartalmazhat, legfeljebb 64 karakter hosszúságú lehet, és egyedinek kell lennie.

source

RoutingSource

A forrás, amelyre 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

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

ManagedIdentity

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

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.

Name Típus Description
cosmosDBSqlContainers

RoutingCosmosDBSqlApiProperties[]

Azoknak a Cosmos DB-tárolóvégpontoknak a listája, amelyekbe az IoT Hub átirányítja az üzeneteket az útválasztási szabályok alapján.

eventHubs

RoutingEventHubProperties[]

Azon Event Hubs-végpontok listája, amelyekre 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

RoutingServiceBusQueueEndpointProperties[]

Azoknak a Service Bus-üzenetsorvégpontoknak a listája, amelyekre az IoT Hub átirányítja az üzeneteket az útválasztási szabályok alapján.

serviceBusTopics

RoutingServiceBusTopicEndpointProperties[]

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

RoutingStorageContainerProperties[]

Az IoT Hub által az üzeneteket az útválasztási szabályok alapján átirányító tárolóvégpontok listája.

RoutingEventHubProperties

Az eseményközpont-végponthoz kapcsolódó tulajdonságok.

Name Típus Description
authenticationType

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

id

string

Az eseményközpont végpontjának azonosítója

identity

ManagedIdentity

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

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.

enrichments

EnrichmentProperties[]

Az IoT Hub által a beépített és egyéni végpontokra kézbesítendő üzenetekre vonatkozó, felhasználó által biztosított bővítések listája. Lásd: https://aka.ms/telemetryoneventgrid

fallbackRoute

FallbackRouteProperties

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

RouteProperties[]

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ához használ. 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

authenticationType

A service bus-üzenetsorvégponton való hitelesítéshez használt módszer

connectionString

string

A service bus-üzenetsorvégpont 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

ManagedIdentity

A service bus-üzenetsorvé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. A névnek nem kell megegyeznie a tényleges üzenetsor nevével.

resourceGroup

string

A service bus-üzenetsorvégpont erőforráscsoportjának neve.

subscriptionId

string

A service bus-üzenetsorvégpont 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

authenticationType

A service bus-témakör végpontjának hitelesítéséhez 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

ManagedIdentity

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ényleges témakör nevével.

resourceGroup

string

A service bus-témakörvégpont 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, amelyre 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

authenticationType

A tárvégponton történő hitelesítéshez használt módszer

batchFrequencyInSeconds

integer

Az az időintervallum, amikor a blobok tárolóba vannak írva. 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:
  • Avro
  • AvroDeflate
  • JSON

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árvégpont URL-címe. Tartalmaznia kell a protokoll https://

fileNameFormat

string

A blob fájlnévformátuma. Az alapértelmezett formátum a következő: {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

ManagedIdentity

Az útválasztási tárvégpont felügyelt identitástulajdonságai.

maxChunkSizeInBytes

integer

A tárolóba írt blobok maximális száma. Az értéknek 10485760(10 MB) és 524288000(500 MB) között kell lennie. Az alapértelmezett érték 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

AccessRights

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 a fájlfeltöltéshez.

Name Típus Description
authenticationType

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, amelyre a fájlok fel vannak töltve.

containerName

string

Annak a gyökértárolónak a neve, amelyben fájlokat tölt fel. A tárolónak nem kell léteznie, de a megadott connectionString használatával creatable-nek kell lennie.

identity

ManagedIdentity

A fájlfeltöltéshez használt tárvégpont felügyelt identitástulajdonságai.

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

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 erőforrást utoljára módosító identitás.

lastModifiedByType

createdByType

Az erőforrást legutóbb módosító identitás típusa.