Iot Hub Resource - Get
Haal de niet-beveiligingsgerelateerde metagegevens van een IoT-hub op.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2023-06-30
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
De naam van de resourcegroep die de IoT-hub bevat. |
resource
|
path | True |
string |
De naam van de IoT-hub. |
subscription
|
path | True |
string |
De abonnements-id. |
api-version
|
query | True |
string |
De versie van de API. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
De hoofdtekst bevat alle niet-beveiligingseigenschappen van de IoT-hub. Beveiligingsgerelateerde eigenschappen worden ingesteld op null. |
|
Other Status Codes |
DefaultErrorResponse |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
user_impersonation | uw gebruikersaccount imiteren |
Voorbeelden
IotHubResource_Get
Voorbeeldaanvraag
Voorbeeldrespons
{
"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"
}
}
Definities
Name | Description |
---|---|
Access |
De machtigingen die zijn toegewezen aan het beleid voor gedeelde toegang. |
Arm |
|
Arm |
|
Authentication |
Hiermee geeft u het verificatietype op dat wordt gebruikt om verbinding te maken met het opslagaccount. |
authentication |
Methode die wordt gebruikt voor verificatie op het service bus-wachtrijeindpunt |
Capabilities |
De mogelijkheden en functies die zijn ingeschakeld voor de IoT-hub. |
Cloud |
De eigenschappen van cloud-naar-apparaat-berichten van IoT Hub. |
created |
Het type identiteit waarmee de resource is gemaakt. |
Default |
Standaardactie voor netwerkregelset |
Enrichment |
De eigenschappen van een verrijking die uw IoT-hub toepast op berichten die aan eindpunten worden bezorgd. |
Error |
Foutdetails. |
Event |
De eigenschappen van het ingerichte Event Hub-compatibele eindpunt dat wordt gebruikt door de IoT-hub. |
Fallback |
De eigenschappen van de terugvalroute. IoT Hub gebruikt deze eigenschappen wanneer berichten worden gerouteerd naar het terugvaleindpunt. |
Feedback |
De eigenschappen van de feedbackwachtrij voor cloud-naar-apparaat-berichten. |
Iot |
De beschrijving van de IoT-hub. |
Iot |
Openbare weergave van een van de locaties waar een resource is ingericht. |
Iot |
De eigenschappen van een IoT-hub. |
Iot |
De rol van de regio kan primair of secundair zijn. De primaire regio is waar de IoT-hub momenteel is ingericht. De secundaire regio is de gekoppelde regio voor herstel na noodgevallen (DR) van Azure en ook de regio waarnaar de IoT-hub een failover kan uitvoeren. |
Iot |
De naam van de SKU. |
Iot |
Informatie over de SKU van de IoT-hub. |
Iot |
De factureringslaag voor de IoT-hub. |
Ip |
De gewenste actie voor aanvragen die met deze regel zijn vastgelegd. |
Ip |
De IP-filterregels voor de IoT-hub. |
Managed |
De eigenschappen van de beheerde identiteit. |
Messaging |
De eigenschappen van de berichteneindpunten die door deze IoT-hub worden gebruikt. |
Network |
IP-filteractie |
Network |
IP-regel die moet worden toegepast als onderdeel van netwerkregelset |
Network |
Eigenschappen van netwerkregelset van IotHub |
Private |
De privé-eindpunteigenschap van een privé-eindpuntverbinding |
Private |
De privé-eindpuntverbinding van een IotHub |
Private |
De eigenschappen van een privé-eindpuntverbinding |
Private |
De huidige status van een privé-eindpuntverbinding |
Private |
De status van een privé-eindpuntverbinding |
Public |
Of aanvragen van het openbare netwerk zijn toegestaan |
Resource |
Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned, UserAssigned' bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd. |
Route |
De eigenschappen van een regel voor doorsturen die uw IoT-hub gebruikt om berichten naar eindpunten te routeren. |
Routing |
De eigenschappen met betrekking tot een cosmos DB SQL-containereindpunt. |
Routing |
De eigenschappen met betrekking tot de aangepaste eindpunten waarnaar uw IoT-hub berichten routeert op basis van de routeringsregels. Er zijn maximaal 10 aangepaste eindpunten toegestaan voor alle eindpunttypen voor betaalde hubs en er is slechts 1 aangepast eindpunt toegestaan voor alle eindpunttypen voor gratis hubs. |
Routing |
De eigenschappen met betrekking tot een Event Hub-eindpunt. |
Routing |
De routeringsgerelateerde eigenschappen van de IoT-hub. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging |
Routing |
De eigenschappen met betrekking tot service bus-wachtrijeindpunten. |
Routing |
De eigenschappen met betrekking tot eindpunttypen van service bus-onderwerpen. |
Routing |
De bron waarop de routeringsregel moet worden toegepast, zoals DeviceMessages. |
Routing |
De eigenschappen met betrekking tot een eindpunt van een opslagcontainer. |
Shared |
De eigenschappen van een beleid voor gedeelde toegang van IoT Hub. |
Storage |
De eigenschappen van het Azure Storage-eindpunt voor het uploaden van bestanden. |
system |
Metagegevens met betrekking tot het maken en laatste wijzigen van de resource. |
AccessRights
De machtigingen die zijn toegewezen aan het beleid voor gedeelde toegang.
Name | Type | 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 | Type | Description |
---|---|---|
principalId |
string |
Principal-id |
tenantId |
string |
Tenant-id |
type |
Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned, UserAssigned' bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd. |
|
userAssignedIdentities |
<string,
Arm |
ArmUserIdentity
Name | Type | Description |
---|---|---|
clientId |
string |
|
principalId |
string |
AuthenticationType
Hiermee geeft u het verificatietype op dat wordt gebruikt om verbinding te maken met het opslagaccount.
Name | Type | Description |
---|---|---|
identityBased |
string |
|
keyBased |
string |
authenticationType
Methode die wordt gebruikt voor verificatie op het service bus-wachtrijeindpunt
Name | Type | Description |
---|---|---|
identityBased |
string |
|
keyBased |
string |
Capabilities
De mogelijkheden en functies die zijn ingeschakeld voor de IoT-hub.
Name | Type | Description |
---|---|---|
DeviceManagement |
string |
|
None |
string |
CloudToDeviceProperties
De eigenschappen van cloud-naar-apparaat-berichten van IoT Hub.
Name | Type | Description |
---|---|---|
defaultTtlAsIso8601 |
string |
De standaardtijd voor cloud-naar-apparaat-berichten in de apparaatwachtrij. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
feedback |
De eigenschappen van de feedbackwachtrij voor cloud-naar-apparaat-berichten. |
|
maxDeliveryCount |
integer |
Het maximale aantal bezorgingen voor cloud-naar-apparaat-berichten in de apparaatwachtrij. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
createdByType
Het type identiteit waarmee de resource is gemaakt.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DefaultAction
Standaardactie voor netwerkregelset
Name | Type | Description |
---|---|---|
Allow |
string |
|
Deny |
string |
EnrichmentProperties
De eigenschappen van een verrijking die uw IoT-hub toepast op berichten die aan eindpunten worden bezorgd.
Name | Type | Description |
---|---|---|
endpointNames |
string[] |
De lijst met eindpunten waarvoor de verrijking wordt toegepast op het bericht. |
key |
string |
De sleutel of naam voor de verrijkingseigenschap. |
value |
string |
De waarde voor de verrijkingseigenschap. |
ErrorDetails
Foutdetails.
Name | Type | Description |
---|---|---|
code |
string |
De foutcode. |
details |
string |
De foutdetails. |
httpStatusCode |
string |
De HTTP-statuscode. |
message |
string |
Het foutbericht. |
EventHubProperties
De eigenschappen van het ingerichte Event Hub-compatibele eindpunt dat wordt gebruikt door de IoT-hub.
Name | Type | Description |
---|---|---|
endpoint |
string |
Het event hub-compatibele eindpunt. |
partitionCount |
integer |
Het aantal partities voor het ontvangen van apparaat-naar-cloud-berichten in het event hub-compatibele eindpunt. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. |
partitionIds |
string[] |
De partitie-id's in het event hub-compatibele eindpunt. |
path |
string |
De naam die compatibel is met Event Hub. |
retentionTimeInDays |
integer |
De bewaartijd voor apparaat-naar-cloud-berichten in dagen. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages |
FallbackRouteProperties
De eigenschappen van de terugvalroute. IoT Hub gebruikt deze eigenschappen wanneer berichten worden gerouteerd naar het terugvaleindpunt.
Name | Type | Description |
---|---|---|
condition |
string |
De voorwaarde die wordt geëvalueerd om de terugvalroute toe te passen. Als de voorwaarde niet is opgegeven, wordt standaard als true geëvalueerd. Zie voor grammatica: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language |
endpointNames |
string[] |
De lijst met eindpunten waarnaar de berichten die aan de voorwaarde voldoen, worden doorgestuurd. Momenteel is slechts één eindpunt toegestaan. |
isEnabled |
boolean |
Wordt gebruikt om op te geven of de terugvalroute is ingeschakeld. |
name |
string |
De naam van de route. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten, heeft een maximale lengte van 64 tekens en moet uniek zijn. |
source |
De bron waarop de routeringsregel moet worden toegepast. Bijvoorbeeld DeviceMessages |
FeedbackProperties
De eigenschappen van de feedbackwachtrij voor cloud-naar-apparaat-berichten.
Name | Type | Description |
---|---|---|
lockDurationAsIso8601 |
string |
De vergrendelingsduur voor de feedbackwachtrij. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
maxDeliveryCount |
integer |
Het aantal keren dat de IoT-hub een bericht probeert af te leveren in de feedbackwachtrij. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
ttlAsIso8601 |
string |
De periode waarin een bericht beschikbaar is om te gebruiken voordat het is verlopen door de IoT-hub. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
IotHubDescription
De beschrijving van de IoT-hub.
Name | Type | Description |
---|---|---|
etag |
string |
Het veld Etag is niet vereist. Als deze is opgegeven in de hoofdtekst van het antwoord, moet deze ook worden opgegeven als een header volgens de normale ETag-conventie. |
id |
string |
De resource-id. |
identity |
De beheerde identiteiten voor de IotHub. |
|
location |
string |
De resourcelocatie. |
name |
string |
De resourcenaam. |
properties |
IotHub-eigenschappen |
|
sku |
IotHub SKU-informatie |
|
systemData |
De systeemmetagegevens met betrekking tot deze resource. |
|
tags |
object |
De resourcetags. |
type |
string |
Het resourcetype. |
IotHubLocationDescription
Openbare weergave van een van de locaties waar een resource is ingericht.
Name | Type | Description |
---|---|---|
location |
string |
De naam van de Azure-regio |
role |
De rol van de regio kan primair of secundair zijn. De primaire regio is waar de IoT-hub momenteel is ingericht. De secundaire regio is de gekoppelde regio voor herstel na noodgevallen (DR) van Azure en ook de regio waarnaar de IoT-hub een failover kan uitvoeren. |
IotHubProperties
De eigenschappen van een IoT-hub.
Name | Type | Description |
---|---|---|
allowedFqdnList |
string[] |
Lijst met toegestane FQDN's (Fully Qualified Domain Name) voor uitgaand verkeer van IoT Hub. |
authorizationPolicies |
Het beleid voor gedeelde toegang dat u kunt gebruiken om een verbinding met de IoT-hub te beveiligen. |
|
cloudToDevice |
De eigenschappen van cloud-naar-apparaat-berichten van IoT Hub. |
|
comments |
string |
Opmerkingen bij IoT Hub. |
disableDeviceSAS |
boolean |
Als dit waar is, kunnen alle SAS-sleutels met een bereik van het apparaat (inclusief Edge-apparaten, maar met uitzondering van modules) niet worden gebruikt voor verificatie. |
disableLocalAuth |
boolean |
Als dit waar is, kunnen SAS-tokens met SAS-sleutels met ioT-hubbereik niet worden gebruikt voor verificatie. |
disableModuleSAS |
boolean |
Als dit waar is, kunnen niet alle SAS-sleutels met modulebereik worden gebruikt voor verificatie. |
enableDataResidency |
boolean |
Als deze eigenschap is ingesteld op true, wordt gegevenslocatie ingeschakeld, waardoor herstel na noodgevallen wordt uitgeschakeld. |
enableFileUploadNotifications |
boolean |
Als waar is, zijn meldingen voor het uploaden van bestanden ingeschakeld. |
eventHubEndpoints |
<string,
Event |
De eigenschappen van het Event Hub-compatibele eindpunt. De enige mogelijke sleutels voor deze woordenlijst zijn gebeurtenissen. Deze sleutel moet aanwezig zijn in de woordenlijst tijdens het maken of bijwerken van aanroepen voor de IoT-hub. |
features |
De mogelijkheden en functies die zijn ingeschakeld voor de IoT-hub. |
|
hostName |
string |
De naam van de host. |
ipFilterRules |
De IP-filterregels. |
|
locations |
Primaire en secundaire locatie voor IoT-hub |
|
messagingEndpoints |
<string,
Messaging |
De berichteindpunteigenschappen voor de meldingswachtrij voor het uploaden van bestanden. |
minTlsVersion |
string |
Hiermee geeft u de minimale TLS-versie te ondersteunen voor deze hub. Kan worden ingesteld op '1.2', zodat clients die een TLS-versie lager dan 1.2 gebruiken, worden geweigerd. |
networkRuleSets |
Eigenschappen van netwerkregelset van IotHub |
|
privateEndpointConnections |
Privé-eindpuntverbindingen die zijn gemaakt op deze IotHub |
|
provisioningState |
string |
De inrichtingsstatus. |
publicNetworkAccess |
Of aanvragen van het openbare netwerk zijn toegestaan |
|
restrictOutboundNetworkAccess |
boolean |
Als dit waar is, wordt uitgaand verkeer van IotHub beperkt tot alleen de toegestane FQDN's die zijn geconfigureerd via allowedFqdnList. |
routing |
De routeringsgerelateerde eigenschappen van de IoT-hub. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging |
|
state |
string |
De hubstatus. |
storageEndpoints |
<string,
Storage |
De lijst met Azure Storage-eindpunten waar u bestanden kunt uploaden. Momenteel kunt u slechts één Azure Storage-account configureren en dat moet de bijbehorende sleutel hebben als $default. Als u meer dan één opslagaccount opgeeft, wordt er een fout gegenereerd. Als u geen waarde voor deze eigenschap opgeeft wanneer de eigenschap enableFileUploadNotifications is ingesteld op True, wordt er een fout gegenereerd. |
IotHubReplicaRoleType
De rol van de regio kan primair of secundair zijn. De primaire regio is waar de IoT-hub momenteel is ingericht. De secundaire regio is de gekoppelde regio voor herstel na noodgevallen (DR) van Azure en ook de regio waarnaar de IoT-hub een failover kan uitvoeren.
Name | Type | Description |
---|---|---|
primary |
string |
|
secondary |
string |
IotHubSku
De naam van de SKU.
Name | Type | Description |
---|---|---|
B1 |
string |
|
B2 |
string |
|
B3 |
string |
|
F1 |
string |
|
S1 |
string |
|
S2 |
string |
|
S3 |
string |
IotHubSkuInfo
Informatie over de SKU van de IoT-hub.
Name | Type | Description |
---|---|---|
capacity |
integer |
Het aantal ingerichte IoT Hub eenheden. Zie: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. |
name |
De naam van de SKU. |
|
tier |
De factureringslaag voor de IoT-hub. |
IotHubSkuTier
De factureringslaag voor de IoT-hub.
Name | Type | Description |
---|---|---|
Basic |
string |
|
Free |
string |
|
Standard |
string |
IpFilterActionType
De gewenste actie voor aanvragen die met deze regel zijn vastgelegd.
Name | Type | Description |
---|---|---|
Accept |
string |
|
Reject |
string |
IpFilterRule
De IP-filterregels voor de IoT-hub.
Name | Type | Description |
---|---|---|
action |
De gewenste actie voor aanvragen die met deze regel zijn vastgelegd. |
|
filterName |
string |
De naam van de IP-filterregel. |
ipMask |
string |
Een tekenreeks die het IP-adresbereik in CIDR-notatie voor de regel bevat. |
ManagedIdentity
De eigenschappen van de beheerde identiteit.
Name | Type | Description |
---|---|---|
userAssignedIdentity |
string |
De door de gebruiker toegewezen identiteit. |
MessagingEndpointProperties
De eigenschappen van de berichteneindpunten die door deze IoT-hub worden gebruikt.
Name | Type | Description |
---|---|---|
lockDurationAsIso8601 |
string |
De vergrendelingsduur. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
maxDeliveryCount |
integer |
Het aantal keren dat de IoT-hub een bericht probeert af te leveren. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
ttlAsIso8601 |
string |
De periode waarin een bericht beschikbaar is om te gebruiken voordat het is verlopen door de IoT-hub. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
NetworkRuleIPAction
IP-filteractie
Name | Type | Description |
---|---|---|
Allow |
string |
NetworkRuleSetIpRule
IP-regel die moet worden toegepast als onderdeel van netwerkregelset
Name | Type | Default value | Description |
---|---|---|---|
action | Allow |
IP-filteractie |
|
filterName |
string |
Naam van de IP-filterregel. |
|
ipMask |
string |
Een tekenreeks die het IP-adresbereik in CIDR-notatie voor de regel bevat. |
NetworkRuleSetProperties
Eigenschappen van netwerkregelset van IotHub
Name | Type | Default value | Description |
---|---|---|---|
applyToBuiltInEventHubEndpoint |
boolean |
Indien waar, wordt netwerkregelset ook toegepast op BuiltIn EventHub EndPoint van IotHub |
|
defaultAction | Deny |
Standaardactie voor netwerkregelset |
|
ipRules |
Lijst met IP-regels |
PrivateEndpoint
De privé-eindpunteigenschap van een privé-eindpuntverbinding
Name | Type | Description |
---|---|---|
id |
string |
De resource-id. |
PrivateEndpointConnection
De privé-eindpuntverbinding van een IotHub
Name | Type | Description |
---|---|---|
id |
string |
De resource-id. |
name |
string |
De resourcenaam. |
properties |
De eigenschappen van een privé-eindpuntverbinding |
|
type |
string |
Het resourcetype. |
PrivateEndpointConnectionProperties
De eigenschappen van een privé-eindpuntverbinding
Name | Type | Description |
---|---|---|
privateEndpoint |
De privé-eindpunteigenschap van een privé-eindpuntverbinding |
|
privateLinkServiceConnectionState |
De huidige status van een privé-eindpuntverbinding |
PrivateLinkServiceConnectionState
De huidige status van een privé-eindpuntverbinding
Name | Type | Description |
---|---|---|
actionsRequired |
string |
Vereiste acties voor een privé-eindpuntverbinding |
description |
string |
De beschrijving voor de huidige status van een privé-eindpuntverbinding |
status |
De status van een privé-eindpuntverbinding |
PrivateLinkServiceConnectionStatus
De status van een privé-eindpuntverbinding
Name | Type | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PublicNetworkAccess
Of aanvragen van het openbare netwerk zijn toegestaan
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ResourceIdentityType
Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned, UserAssigned' bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd.
Name | Type | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
RouteProperties
De eigenschappen van een regel voor doorsturen die uw IoT-hub gebruikt om berichten naar eindpunten te routeren.
Name | Type | Description |
---|---|---|
condition |
string |
De voorwaarde die wordt geëvalueerd om de regel voor doorsturen toe te passen. Als er geen voorwaarde is opgegeven, wordt standaard waar geëvalueerd. Zie voor grammatica: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language |
endpointNames |
string[] |
De lijst met eindpunten waarnaar berichten worden doorgestuurd die voldoen aan de voorwaarde. Momenteel is slechts één eindpunt toegestaan. |
isEnabled |
boolean |
Wordt gebruikt om op te geven of een route is ingeschakeld. |
name |
string |
De naam van de route. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten, heeft een maximale lengte van 64 tekens en moet uniek zijn. |
source |
De bron waarop de routeringsregel moet worden toegepast, zoals DeviceMessages. |
RoutingCosmosDBSqlApiProperties
De eigenschappen met betrekking tot een cosmos DB SQL-containereindpunt.
Name | Type | Description |
---|---|---|
authenticationType |
Methode die wordt gebruikt voor verificatie op het sql-containereindpunt van Cosmos DB |
|
containerName |
string |
De naam van de sql-container cosmos DB in de cosmos DB-database. |
databaseName |
string |
De naam van de cosmos DB-database in het cosmos DB-account. |
endpointUri |
string |
De URL van het cosmos DB-account. Deze moet het protocol bevatten https:// |
id |
string |
Id van het sql-containereindpunt van Cosmos DB |
identity |
Eigenschappen van beheerde identiteit van routering cosmos DB-containereindpunt. |
|
name |
string |
De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten en heeft een maximale lengte van 64 tekens. De volgende namen zijn gereserveerd: events, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor verschillende eindpunttypen. |
partitionKeyName |
string |
De naam van de partitiesleutel die is gekoppeld aan deze cosmos DB SQL-container, indien aanwezig. Dit is een optionele parameter. |
partitionKeyTemplate |
string |
De sjabloon voor het genereren van een synthetische partitiesleutelwaarde voor gebruik met deze cosmos DB SQL-container. De sjabloon moet ten minste een van de volgende tijdelijke aanduidingen bevatten: {iothub}, {deviceid}, {DD}, {MM} en {JJJJ}. Een tijdelijke aanduiding kan maximaal één keer worden opgegeven, maar volgorde en niet-tijdelijke aanduidingen zijn willekeurig. Deze parameter is alleen vereist als PartitionKeyName is opgegeven. |
primaryKey |
string |
De primaire sleutel van het cosmos DB-account. |
resourceGroup |
string |
De naam van de resourcegroep van het cosmos DB-account. |
secondaryKey |
string |
De secundaire sleutel van het cosmos DB-account. |
subscriptionId |
string |
De abonnements-id van het cosmos DB-account. |
RoutingEndpoints
De eigenschappen met betrekking tot de aangepaste eindpunten waarnaar uw IoT-hub berichten routeert op basis van de routeringsregels. Er zijn maximaal 10 aangepaste eindpunten toegestaan voor alle eindpunttypen voor betaalde hubs en er is slechts 1 aangepast eindpunt toegestaan voor alle eindpunttypen voor gratis hubs.
Name | Type | Description |
---|---|---|
cosmosDBSqlContainers |
De lijst met Cosmos DB-containereindpunten waarnaar IoT Hub berichten routeert op basis van de routeringsregels. |
|
eventHubs |
De lijst met Event Hubs-eindpunten waarnaar IoT Hub berichten routeert op basis van de routeringsregels. Deze lijst bevat niet het ingebouwde Event Hubs-eindpunt. |
|
serviceBusQueues |
De lijst met Service Bus-wachtrijeindpunten waarnaar IoT Hub de berichten routeert, op basis van de routeringsregels. |
|
serviceBusTopics |
De lijst met Service Bus-onderwerpeindpunten waarnaar de IoT-hub de berichten routeert op basis van de routeringsregels. |
|
storageContainers |
De lijst met opslagcontainereindpunten waarnaar IoT Hub berichten routeert op basis van de routeringsregels. |
RoutingEventHubProperties
De eigenschappen met betrekking tot een Event Hub-eindpunt.
Name | Type | Description |
---|---|---|
authenticationType |
Methode die wordt gebruikt voor verificatie bij het Event Hub-eindpunt |
|
connectionString |
string |
De verbindingsreeks van het Event Hub-eindpunt. |
endpointUri |
string |
De URL van het Event Hub-eindpunt. Deze moet het protocol bevatten sb:// |
entityPath |
string |
Event Hub-naam in de Event Hub-naamruimte |
id |
string |
Id van het Event Hub-eindpunt |
identity |
Beheerde identiteitseigenschappen van routering event hub-eindpunt. |
|
name |
string |
De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten en heeft een maximale lengte van 64 tekens. De volgende namen zijn gereserveerd: events, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor verschillende eindpunttypen. |
resourceGroup |
string |
De naam van de resourcegroep van het Event Hub-eindpunt. |
subscriptionId |
string |
De abonnements-id van het Event Hub-eindpunt. |
RoutingProperties
De routeringsgerelateerde eigenschappen van de IoT-hub. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
Name | Type | Description |
---|---|---|
endpoints |
De eigenschappen met betrekking tot de aangepaste eindpunten waarnaar uw IoT-hub berichten routeert op basis van de routeringsregels. Er zijn maximaal 10 aangepaste eindpunten toegestaan voor alle eindpunttypen voor betaalde hubs en er is slechts 1 aangepast eindpunt toegestaan voor alle eindpunttypen voor gratis hubs. |
|
enrichments |
De lijst met door de gebruiker geleverde verrijkingen die de IoT-hub toepast op berichten die moeten worden bezorgd bij ingebouwde en aangepaste eindpunten. Zie: https://aka.ms/telemetryoneventgrid |
|
fallbackRoute |
De eigenschappen van de route die wordt gebruikt als een terugvalroute wanneer aan geen van de voorwaarden in de sectie 'routes' wordt voldaan. Dit is een optionele parameter. Wanneer deze eigenschap niet aanwezig is in de sjabloon, wordt de terugvalroute standaard uitgeschakeld. |
|
routes |
De lijst met door de gebruiker verstrekte routeringsregels die door de IoT-hub worden gebruikt om berichten te routeren naar ingebouwde en aangepaste eindpunten. Er zijn maximaal 100 regels voor doorsturen toegestaan voor betaalde hubs en maximaal 5 routeringsregels voor gratis hubs. |
RoutingServiceBusQueueEndpointProperties
De eigenschappen met betrekking tot service bus-wachtrijeindpunten.
Name | Type | Description |
---|---|---|
authenticationType |
Methode die wordt gebruikt voor verificatie op het service bus-wachtrijeindpunt |
|
connectionString |
string |
De verbindingsreeks van het service bus-wachtrijeindpunt. |
endpointUri |
string |
De URL van het service bus-wachtrijeindpunt. Deze moet het protocol bevatten sb:// |
entityPath |
string |
Wachtrijnaam in de Service Bus-naamruimte |
id |
string |
Id van het service bus-wachtrijeindpunt |
identity |
Eigenschappen van beheerde identiteit van het service bus-wachtrijeindpunt voor routering. |
|
name |
string |
De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten en heeft een maximale lengte van 64 tekens. De volgende namen zijn gereserveerd: events, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor verschillende eindpunttypen. De naam hoeft niet hetzelfde te zijn als de werkelijke wachtrijnaam. |
resourceGroup |
string |
De naam van de resourcegroep van het service bus-wachtrijeindpunt. |
subscriptionId |
string |
De abonnements-id van het service bus-wachtrijeindpunt. |
RoutingServiceBusTopicEndpointProperties
De eigenschappen met betrekking tot eindpunttypen van service bus-onderwerpen.
Name | Type | Description |
---|---|---|
authenticationType |
Methode die wordt gebruikt voor verificatie op het eindpunt van het Service Bus-onderwerp |
|
connectionString |
string |
De verbindingsreeks van het eindpunt van het service bus-onderwerp. |
endpointUri |
string |
De URL van het service bus-onderwerpeindpunt. Deze moet het protocol bevatten sb:// |
entityPath |
string |
Wachtrijnaam in het Service Bus-onderwerp |
id |
string |
Id van het eindpunt van het Service Bus-onderwerp |
identity |
Eigenschappen van beheerde identiteit van het eindpunt van het routeringsservicebusonderwerp. |
|
name |
string |
De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten en heeft een maximale lengte van 64 tekens. De volgende namen zijn gereserveerd: events, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor verschillende eindpunttypen. De naam hoeft niet hetzelfde te zijn als de werkelijke onderwerpnaam. |
resourceGroup |
string |
De naam van de resourcegroep van het service bus-onderwerpeindpunt. |
subscriptionId |
string |
De abonnements-id van het eindpunt van het service bus-onderwerp. |
RoutingSource
De bron waarop de routeringsregel moet worden toegepast, zoals DeviceMessages.
Name | Type | Description |
---|---|---|
DeviceConnectionStateEvents |
string |
|
DeviceJobLifecycleEvents |
string |
|
DeviceLifecycleEvents |
string |
|
DeviceMessages |
string |
|
Invalid |
string |
|
TwinChangeEvents |
string |
RoutingStorageContainerProperties
De eigenschappen met betrekking tot een eindpunt van een opslagcontainer.
Name | Type | Description |
---|---|---|
authenticationType |
Methode die wordt gebruikt voor verificatie op het opslageindpunt |
|
batchFrequencyInSeconds |
integer |
Tijdsinterval waarmee blobs naar de opslag worden geschreven. De waarde moet tussen 60 en 720 seconden zijn. De standaardwaarde is 300 seconden. |
connectionString |
string |
De verbindingsreeks van het opslagaccount. |
containerName |
string |
De naam van de opslagcontainer in het opslagaccount. |
encoding |
enum:
|
Codering die wordt gebruikt voor het serialiseren van berichten naar blobs. Ondersteunde waarden zijn 'avro', 'avrodeflate' en 'JSON'. De standaardwaarde is avro. |
endpointUri |
string |
De URL van het opslageindpunt. Deze moet het protocol bevatten https:// |
fileNameFormat |
string |
Bestandsnaamindeling voor de blob. De standaardindeling is {iothub}/{partition}/{JJJJ}/{MM}/{DD}/{HH}/{mm}. Alle parameters zijn verplicht, maar kunnen opnieuw worden gerangschikt. |
id |
string |
Id van het eindpunt van de opslagcontainer |
identity |
Eigenschappen van beheerde identiteit van het eindpunt van de routeringsopslag. |
|
maxChunkSizeInBytes |
integer |
Maximum aantal bytes voor elke blob die naar de opslag wordt geschreven. De waarde moet tussen 10485760 (10 MB) en 524288000 (500 MB) zijn. De standaardwaarde is 314572800(300 MB). |
name |
string |
De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten en heeft een maximale lengte van 64 tekens. De volgende namen zijn gereserveerd: events, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor verschillende eindpunttypen. |
resourceGroup |
string |
De naam van de resourcegroep van het opslagaccount. |
subscriptionId |
string |
De abonnements-id van het opslagaccount. |
SharedAccessSignatureAuthorizationRule
De eigenschappen van een beleid voor gedeelde toegang van IoT Hub.
Name | Type | Description |
---|---|---|
keyName |
string |
De naam van het beleid voor gedeelde toegang. |
primaryKey |
string |
De primaire sleutel. |
rights |
De machtigingen die zijn toegewezen aan het beleid voor gedeelde toegang. |
|
secondaryKey |
string |
De secundaire sleutel. |
StorageEndpointProperties
De eigenschappen van het Azure Storage-eindpunt voor het uploaden van bestanden.
Name | Type | Description |
---|---|---|
authenticationType |
Hiermee geeft u het verificatietype op dat wordt gebruikt om verbinding te maken met het opslagaccount. |
|
connectionString |
string |
De verbindingsreeks voor het Azure Storage-account waarnaar bestanden worden geüpload. |
containerName |
string |
De naam van de hoofdcontainer waarin u bestanden uploadt. De container hoeft niet te bestaan, maar moet wel kunnen worden gemaakt met behulp van de opgegeven connectionString. |
identity |
Eigenschappen van beheerde identiteit van opslageindpunt voor het uploaden van bestanden. |
|
sasTtlAsIso8601 |
string |
De periode waarin de SAS-URI die is gegenereerd door IoT Hub voor het uploaden van bestanden geldig is. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. |
systemData
Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
De tijdstempel van het maken van resources (UTC). |
createdBy |
string |
De identiteit die de resource heeft gemaakt. |
createdByType |
Het type identiteit waarmee de resource is gemaakt. |
|
lastModifiedAt |
string |
Het tijdstempel van de laatste wijziging van de resource (UTC) |
lastModifiedBy |
string |
De identiteit die de resource het laatst heeft gewijzigd. |
lastModifiedByType |
Het type identiteit dat de resource het laatst heeft gewijzigd. |