Iot Hub Resource - List By Subscription
Ottenere tutti gli hub IoT in una sottoscrizione.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Devices/IotHubs?api-version=2023-06-30
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
subscription
|
path | True |
string |
L'identificatore della sottoscrizione. |
api-version
|
query | True |
string |
Versione dell'API. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Si tratta di un'operazione sincrona. Il corpo contiene una matrice serializzata JSON dei metadati da tutti gli hub IoT nella sottoscrizione. |
|
Other Status Codes |
DefaultErrorResponse |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
Nome | Descrizione |
---|---|
user_impersonation | rappresentare l'account utente |
Esempio
IotHubResource_ListBySubscription
Esempio di richiesta
Risposta di esempio
{
"value": [
{
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
"name": "testHub",
"type": "Microsoft.Devices/IotHubs",
"location": "centraluseuap",
"tags": {},
"etag": "AAAAAAFD6M4=",
"properties": {
"state": "Active",
"provisioningState": "Succeeded",
"ipFilterRules": [
{
"filterName": "rule1",
"action": "Accept",
"ipMask": "131.117.159.53"
},
{
"filterName": "rule2",
"action": "Accept",
"ipMask": "157.55.59.128/25"
}
],
"networkRuleSets": {
"defaultAction": "Deny",
"applyToBuiltInEventHubEndpoint": true,
"ipRules": [
{
"filterName": "rule1",
"action": "Allow",
"ipMask": "131.117.159.53"
},
{
"filterName": "rule2",
"action": "Allow",
"ipMask": "157.55.59.128/25"
}
]
},
"hostName": "iot-dps-cit-hub-1.azure-devices.net",
"eventHubEndpoints": {
"events": {
"retentionTimeInDays": 1,
"partitionCount": 2,
"partitionIds": [
"0",
"1"
],
"path": "iot-dps-cit-hub-1",
"endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
}
},
"routing": {
"endpoints": {
"serviceBusQueues": [],
"serviceBusTopics": [],
"eventHubs": [],
"storageContainers": []
},
"routes": [],
"fallbackRoute": {
"name": "$fallback",
"source": "DeviceMessages",
"condition": "true",
"endpointNames": [
"events"
],
"isEnabled": true
}
},
"storageEndpoints": {
"$default": {
"sasTtlAsIso8601": "PT1H",
"connectionString": "",
"containerName": ""
}
},
"messagingEndpoints": {
"fileNotifications": {
"lockDurationAsIso8601": "PT1M",
"ttlAsIso8601": "PT1H",
"maxDeliveryCount": 10
}
},
"enableFileUploadNotifications": false,
"cloudToDevice": {
"maxDeliveryCount": 10,
"defaultTtlAsIso8601": "PT1H",
"feedback": {
"lockDurationAsIso8601": "PT1M",
"ttlAsIso8601": "PT1H",
"maxDeliveryCount": 10
}
},
"features": "None"
},
"sku": {
"name": "S1",
"tier": "Standard",
"capacity": 1
},
"systemData": {
"createdAt": "2021-01-30T00:28:38.963Z"
}
}
]
}
Definizioni
Nome | Descrizione |
---|---|
Access |
Autorizzazioni assegnate ai criteri di accesso condiviso. |
Arm |
|
Arm |
|
Authentication |
Specifica il tipo di autenticazione utilizzato per la connessione all'account di archiviazione. |
authentication |
Metodo usato per eseguire l'autenticazione nell'endpoint della coda del bus di servizio |
Capabilities |
Funzionalità e funzionalità abilitate per l'hub IoT. |
Cloud |
Proprietà di messaggistica da cloud a dispositivo dell'hub IoT. |
created |
Tipo di identità che ha creato la risorsa. |
Default |
Azione predefinita per il set di regole di rete |
Enrichment |
Le proprietà di un arricchimento applicato all'hub IoT ai messaggi recapitati agli endpoint. |
Error |
Dettagli degli errori. |
Event |
Proprietà dell'endpoint compatibile con l'hub eventi di cui è stato effettuato il provisioning usato dall'hub IoT. |
Fallback |
Proprietà della route di fallback. hub IoT usa queste proprietà quando instrada i messaggi all'endpoint di fallback. |
Feedback |
Proprietà della coda di feedback per i messaggi da cloud a dispositivo. |
Iot |
Descrizione dell'hub IoT. |
Iot |
Matrice serializzata JSON di oggetti IotHubDescription con un collegamento successivo. |
Iot |
Rappresentazione pubblica di una delle posizioni in cui viene effettuato il provisioning di una risorsa. |
Iot |
Proprietà di un hub IoT. |
Iot |
Il ruolo dell'area può essere primario o secondario. L'area primaria è la posizione in cui è attualmente stato effettuato il provisioning dell'hub IoT. L'area secondaria è l'area associata del ripristino di emergenza di Azure e anche l'area in cui l'hub IoT può eseguire il failover. |
Iot |
Il nome della SKU. |
Iot |
Informazioni sullo SKU dell'hub IoT. |
Iot |
Livello di fatturazione per l'hub IoT. |
Ip |
Azione desiderata per le richieste acquisite da questa regola. |
Ip |
Regole di filtro IP per l'hub IoT. |
Managed |
Proprietà dell'identità gestita. |
Messaging |
Proprietà degli endpoint di messaggistica usati da questo hub IoT. |
Network |
Azione filtro IP |
Network |
Regola IP da applicare come parte del set di regole di rete |
Network |
Proprietà del set di regole di rete di IotHub |
Private |
Proprietà dell'endpoint privato di una connessione all'endpoint privato |
Private |
Connessione endpoint privato di un IotHub |
Private |
Proprietà di una connessione endpoint privato |
Private |
Stato corrente di una connessione endpoint privato |
Private |
Stato di una connessione endpoint privato |
Public |
Indica se le richieste dalla rete pubblica sono consentite |
Resource |
Tipo di identità usata per la risorsa. Il tipo "SystemAssigned, UserAssigned" include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo "Nessuno" rimuoverà le identità dal servizio. |
Route |
Le proprietà di una regola di routing usata dall'hub IoT per instradare i messaggi agli endpoint. |
Routing |
Proprietà correlate a un endpoint del contenitore SQL di Cosmos DB. |
Routing |
Le proprietà correlate agli endpoint personalizzati a cui l'hub IoT instrada i messaggi in base alle regole di routing. È consentito un massimo di 10 endpoint personalizzati in tutti i tipi di endpoint per gli hub a pagamento e solo 1 endpoint personalizzato è consentito in tutti i tipi di endpoint per gli hub gratuiti. |
Routing |
Proprietà correlate a un endpoint dell'hub eventi. |
Routing |
Proprietà correlate al routing dell'hub IoT. Vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging |
Routing |
Proprietà correlate ai tipi di endpoint della coda del bus di servizio. |
Routing |
Proprietà correlate ai tipi di endpoint dell'argomento del bus di servizio. |
Routing |
Origine a cui deve essere applicata la regola di routing, ad esempio DeviceMessages. |
Routing |
Proprietà correlate a un endpoint del contenitore di archiviazione. |
Shared |
Proprietà di un criterio di accesso condiviso dell'hub IoT. |
Storage |
Proprietà dell'endpoint di Archiviazione di Azure per il caricamento di file. |
system |
Metadati relativi alla creazione e all'ultima modifica della risorsa. |
AccessRights
Autorizzazioni assegnate ai criteri di accesso condiviso.
Nome | Tipo | Descrizione |
---|---|---|
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
Nome | Tipo | Descrizione |
---|---|---|
principalId |
string |
ID entità |
tenantId |
string |
ID tenant |
type |
Tipo di identità utilizzata per la risorsa. Il tipo 'SystemAssigned, UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'Nessuno' rimuoverà le identità dal servizio. |
|
userAssignedIdentities |
<string,
Arm |
ArmUserIdentity
Nome | Tipo | Descrizione |
---|---|---|
clientId |
string |
|
principalId |
string |
AuthenticationType
Specifica il tipo di autenticazione utilizzato per la connessione all'account di archiviazione.
Nome | Tipo | Descrizione |
---|---|---|
identityBased |
string |
|
keyBased |
string |
authenticationType
Metodo usato per eseguire l'autenticazione nell'endpoint della coda del bus di servizio
Nome | Tipo | Descrizione |
---|---|---|
identityBased |
string |
|
keyBased |
string |
Capabilities
Funzionalità e funzionalità abilitate per l'hub IoT.
Nome | Tipo | Descrizione |
---|---|---|
DeviceManagement |
string |
|
None |
string |
CloudToDeviceProperties
Proprietà di messaggistica da cloud a dispositivo dell'hub IoT.
Nome | Tipo | Descrizione |
---|---|---|
defaultTtlAsIso8601 |
string |
Durata predefinita per i messaggi da cloud a dispositivo nella coda del dispositivo. Vedi https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
feedback |
Proprietà della coda di feedback per i messaggi da cloud a dispositivo. |
|
maxDeliveryCount |
integer |
Numero massimo di recapito per i messaggi da cloud a dispositivo nella coda del dispositivo. Vedi https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
createdByType
Tipo di identità che ha creato la risorsa.
Nome | Tipo | Descrizione |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DefaultAction
Azione predefinita per il set di regole di rete
Nome | Tipo | Descrizione |
---|---|---|
Allow |
string |
|
Deny |
string |
EnrichmentProperties
Le proprietà di un arricchimento applicato all'hub IoT ai messaggi recapitati agli endpoint.
Nome | Tipo | Descrizione |
---|---|---|
endpointNames |
string[] |
Elenco di endpoint per cui viene applicato l'arricchimento al messaggio. |
key |
string |
Chiave o nome per la proprietà di arricchimento. |
value |
string |
Valore della proprietà di arricchimento. |
ErrorDetails
Dettagli degli errori.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di errore. |
details |
string |
Dettagli dell'errore. |
httpStatusCode |
string |
Codice di stato HTTP. |
message |
string |
Messaggio di errore. |
EventHubProperties
Proprietà dell'endpoint compatibile con l'hub eventi di cui è stato effettuato il provisioning usato dall'hub IoT.
Nome | Tipo | Descrizione |
---|---|---|
endpoint |
string |
Endpoint compatibile con Hub eventi. |
partitionCount |
integer |
Numero di partizioni per la ricezione di messaggi da dispositivo a cloud nell'endpoint compatibile con Hub eventi. Vedi https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. |
partitionIds |
string[] |
ID di partizione nell'endpoint compatibile con Hub eventi. |
path |
string |
Nome compatibile con Hub eventi. |
retentionTimeInDays |
integer |
Tempo di conservazione per i messaggi da dispositivo a cloud in giorni. Vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages |
FallbackRouteProperties
Proprietà della route di fallback. hub IoT usa queste proprietà quando instrada i messaggi all'endpoint di fallback.
Nome | Tipo | Descrizione |
---|---|---|
condition |
string |
Condizione valutata per applicare la route di fallback. Se la condizione non viene fornita, restituisce true per impostazione predefinita. Per la grammatica, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language |
endpointNames |
string[] |
Elenco di endpoint a cui vengono indirizzati i messaggi che soddisfano la condizione. Attualmente è consentito solo 1 endpoint. |
isEnabled |
boolean |
Consente di specificare se la route di fallback è abilitata. |
name |
string |
Nome della route. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini, lunghezza massima di 64 caratteri e deve essere univoco. |
source |
Origine a cui applicare la regola di routing. Ad esempio, DeviceMessages |
FeedbackProperties
Proprietà della coda di feedback per i messaggi da cloud a dispositivo.
Nome | Tipo | Descrizione |
---|---|---|
lockDurationAsIso8601 |
string |
Durata del blocco per la coda dei commenti e suggerimenti. Vedi https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
maxDeliveryCount |
integer |
Numero di tentativi di recapitare un messaggio nella coda dei commenti e suggerimenti dell'hub IoT. Vedi https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
ttlAsIso8601 |
string |
Periodo di tempo per il quale un messaggio è disponibile per l'utilizzo prima della scadenza dell'hub IoT. Vedi https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. |
IotHubDescription
Descrizione dell'hub IoT.
Nome | Tipo | Descrizione |
---|---|---|
etag |
string |
Il campo Etag non è obbligatorio. Se viene fornito nel corpo della risposta, deve essere fornito anche come intestazione per la normale convenzione ETag. |
id |
string |
Identificatore di risorsa. |
identity |
Identità gestite per IotHub. |
|
location |
string |
Percorso della risorsa. |
name |
string |
Nome della risorsa. |
properties |
Proprietà IotHub |
|
sku |
Informazioni sullo SKU IotHub |
|
systemData |
Metadati di sistema relativi a questa risorsa. |
|
tags |
object |
Tag di risorsa. |
type |
string |
Tipo di risorsa. |
IotHubDescriptionListResult
Matrice serializzata JSON di oggetti IotHubDescription con un collegamento successivo.
Nome | Tipo | Descrizione |
---|---|---|
nextLink |
string |
Collegamento successivo. |
value |
Matrice di oggetti IotHubDescription. |
IotHubLocationDescription
Rappresentazione pubblica di una delle posizioni in cui viene effettuato il provisioning di una risorsa.
Nome | Tipo | Descrizione |
---|---|---|
location |
string |
Nome dell'area di Azure |
role |
Il ruolo dell'area può essere primario o secondario. L'area primaria è la posizione in cui è attualmente stato effettuato il provisioning dell'hub IoT. L'area secondaria è l'area associata del ripristino di emergenza di Azure e anche l'area in cui l'hub IoT può eseguire il failover. |
IotHubProperties
Proprietà di un hub IoT.
Nome | Tipo | Descrizione |
---|---|---|
allowedFqdnList |
string[] |
Elenco di FQDNs consentiti(Nome di dominio completo) per l'uscita dall'hub Iot. |
authorizationPolicies |
I criteri di accesso condiviso che è possibile usare per proteggere una connessione all'hub IoT. |
|
cloudToDevice |
Proprietà di messaggistica da cloud a dispositivo dell'hub IoT. |
|
comments |
string |
Commenti dell'hub IoT. |
disableDeviceSAS |
boolean |
Se true, non è possibile usare tutte le chiavi SAS con ambito dispositivo (inclusi i dispositivi Edge ma esclusi i moduli) per l'autenticazione. |
disableLocalAuth |
boolean |
Se true, non è possibile usare i token di firma di accesso condiviso con ambito dell'hub Iot per l'autenticazione. |
disableModuleSAS |
boolean |
Se true, non è possibile usare tutte le chiavi sas con ambito modulo per l'autenticazione. |
enableDataResidency |
boolean |
Questa proprietà, se impostata su true, consentirà la residenza dei dati, disabilitando quindi il ripristino di emergenza. |
enableFileUploadNotifications |
boolean |
Se True, le notifiche di caricamento dei file sono abilitate. |
eventHubEndpoints |
<string,
Event |
Proprietà dell'endpoint compatibili con Hub eventi. Le uniche chiavi possibili per questo dizionario sono eventi. Questa chiave deve essere presente nel dizionario durante l'esecuzione di chiamate di creazione o aggiornamento per l'hub IoT. |
features |
Funzionalità e funzionalità abilitate per l'hub IoT. |
|
hostName |
string |
Nome dell'host. |
ipFilterRules |
Regole di filtro IP. |
|
locations |
Posizione primaria e secondaria per l'hub iot |
|
messagingEndpoints |
<string,
Messaging |
Proprietà dell'endpoint di messaggistica per la coda di notifica di caricamento file. |
minTlsVersion |
string |
Specifica la versione minima TLS da supportare per questo hub. Può essere impostato su "1.2" per avere client che usano una versione TLS inferiore alla versione 1.2 da rifiutare. |
networkRuleSets |
Proprietà del set di regole di rete di IotHub |
|
privateEndpointConnections |
Connessioni endpoint private create in questo IotHub |
|
provisioningState |
string |
Stato di provisioning. |
publicNetworkAccess |
Indica se le richieste dalla rete pubblica sono consentite |
|
restrictOutboundNetworkAccess |
boolean |
Se true, l'uscita da IotHub sarà limitata solo agli FQDN consentiti configurati tramite allowedFqdnList. |
routing |
Proprietà correlate al routing dell'hub IoT. Vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging |
|
state |
string |
Stato dell'hub. |
storageEndpoints |
<string,
Storage |
Elenco degli endpoint di Archiviazione di Azure in cui è possibile caricare file. Attualmente è possibile configurare un solo account di archiviazione di Azure e che deve avere la chiave come $default. Se si specificano più account di archiviazione, viene generato un errore. Non specificando un valore per questa proprietà quando la proprietà enableFileUploadNotifications è impostata su True, genera un errore. |
IotHubReplicaRoleType
Il ruolo dell'area può essere primario o secondario. L'area primaria è la posizione in cui è attualmente stato effettuato il provisioning dell'hub IoT. L'area secondaria è l'area associata del ripristino di emergenza di Azure e anche l'area in cui l'hub IoT può eseguire il failover.
Nome | Tipo | Descrizione |
---|---|---|
primary |
string |
|
secondary |
string |
IotHubSku
Il nome della SKU.
Nome | Tipo | Descrizione |
---|---|---|
B1 |
string |
|
B2 |
string |
|
B3 |
string |
|
F1 |
string |
|
S1 |
string |
|
S2 |
string |
|
S3 |
string |
IotHubSkuInfo
Informazioni sullo SKU dell'hub IoT.
Nome | Tipo | Descrizione |
---|---|---|
capacity |
integer |
Numero di unità di hub IoT di cui è stato effettuato il provisioning. Vedi https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. |
name |
Il nome della SKU. |
|
tier |
Livello di fatturazione per l'hub IoT. |
IotHubSkuTier
Livello di fatturazione per l'hub IoT.
Nome | Tipo | Descrizione |
---|---|---|
Basic |
string |
|
Free |
string |
|
Standard |
string |
IpFilterActionType
Azione desiderata per le richieste acquisite da questa regola.
Nome | Tipo | Descrizione |
---|---|---|
Accept |
string |
|
Reject |
string |
IpFilterRule
Regole di filtro IP per l'hub IoT.
Nome | Tipo | Descrizione |
---|---|---|
action |
Azione desiderata per le richieste acquisite da questa regola. |
|
filterName |
string |
Nome della regola di filtro IP. |
ipMask |
string |
Stringa contenente l'intervallo di indirizzi IP nella notazione CIDR per la regola. |
ManagedIdentity
Proprietà dell'identità gestita.
Nome | Tipo | Descrizione |
---|---|---|
userAssignedIdentity |
string |
Identità assegnata dall'utente. |
MessagingEndpointProperties
Proprietà degli endpoint di messaggistica usati da questo hub IoT.
Nome | Tipo | Descrizione |
---|---|---|
lockDurationAsIso8601 |
string |
Durata del blocco. Vedi https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
maxDeliveryCount |
integer |
Numero di tentativi di recapitare un messaggio nell'hub IoT. Vedi https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
ttlAsIso8601 |
string |
Periodo di tempo per il quale un messaggio è disponibile per l'utilizzo prima della scadenza dell'hub IoT. Vedi https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. |
NetworkRuleIPAction
Azione filtro IP
Nome | Tipo | Descrizione |
---|---|---|
Allow |
string |
NetworkRuleSetIpRule
Regola IP da applicare come parte del set di regole di rete
Nome | Tipo | Valore predefinito | Descrizione |
---|---|---|---|
action | Allow |
Azione filtro IP |
|
filterName |
string |
Nome della regola di filtro IP. |
|
ipMask |
string |
Stringa contenente l'intervallo di indirizzi IP nella notazione CIDR per la regola. |
NetworkRuleSetProperties
Proprietà del set di regole di rete di IotHub
Nome | Tipo | Valore predefinito | Descrizione |
---|---|---|---|
applyToBuiltInEventHubEndpoint |
boolean |
Se True, il set di regole di rete viene applicato anche a BuiltIn EventHub EndPoint di IotHub |
|
defaultAction | Deny |
Azione predefinita per il set di regole di rete |
|
ipRules |
Elenco delle regole IP |
PrivateEndpoint
Proprietà dell'endpoint privato di una connessione all'endpoint privato
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
Identificatore della risorsa. |
PrivateEndpointConnection
Connessione endpoint privato di un IotHub
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
Identificatore di risorsa. |
name |
string |
Nome della risorsa. |
properties |
Proprietà di una connessione endpoint privato |
|
type |
string |
Tipo di risorsa. |
PrivateEndpointConnectionProperties
Proprietà di una connessione endpoint privato
Nome | Tipo | Descrizione |
---|---|---|
privateEndpoint |
Proprietà dell'endpoint privato di una connessione all'endpoint privato |
|
privateLinkServiceConnectionState |
Stato corrente di una connessione endpoint privato |
PrivateLinkServiceConnectionState
Stato corrente di una connessione endpoint privato
Nome | Tipo | Descrizione |
---|---|---|
actionsRequired |
string |
Azioni necessarie per una connessione endpoint privato |
description |
string |
Descrizione dello stato corrente di una connessione all'endpoint privato |
status |
Stato di una connessione endpoint privato |
PrivateLinkServiceConnectionStatus
Stato di una connessione endpoint privato
Nome | Tipo | Descrizione |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PublicNetworkAccess
Indica se le richieste dalla rete pubblica sono consentite
Nome | Tipo | Descrizione |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ResourceIdentityType
Tipo di identità usata per la risorsa. Il tipo "SystemAssigned, UserAssigned" include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo "Nessuno" rimuoverà le identità dal servizio.
Nome | Tipo | Descrizione |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
RouteProperties
Le proprietà di una regola di routing usata dall'hub IoT per instradare i messaggi agli endpoint.
Nome | Tipo | Descrizione |
---|---|---|
condition |
string |
Condizione valutata per applicare la regola di routing. Se non viene fornita alcuna condizione, restituisce true per impostazione predefinita. Per la grammatica, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language |
endpointNames |
string[] |
Elenco di endpoint a cui vengono indirizzati i messaggi che soddisfano la condizione. Attualmente è consentito un solo endpoint. |
isEnabled |
boolean |
Consente di specificare se una route è abilitata. |
name |
string |
Nome della route. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini, lunghezza massima di 64 caratteri e deve essere univoco. |
source |
Origine a cui deve essere applicata la regola di routing, ad esempio DeviceMessages. |
RoutingCosmosDBSqlApiProperties
Proprietà correlate a un endpoint del contenitore SQL di Cosmos DB.
Nome | Tipo | Descrizione |
---|---|---|
authenticationType |
Metodo usato per eseguire l'autenticazione nell'endpoint del contenitore SQL di Cosmos DB |
|
containerName |
string |
Nome del contenitore sql cosmos DB nel database cosmos DB. |
databaseName |
string |
Nome del database cosmos DB nell'account cosmos DB. |
endpointUri |
string |
URL dell'account cosmos DB. Deve includere il protocollo https:// |
id |
string |
ID dell'endpoint del contenitore SQL di Cosmos DB |
identity |
Proprietà dell'identità gestita dell'endpoint del contenitore cosmos DB. |
|
name |
string |
Nome che identifica questo endpoint. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini e ha una lunghezza massima di 64 caratteri. I nomi seguenti sono riservati: eventi, fileNotifications, $default. I nomi degli endpoint devono essere univoci tra i tipi di endpoint. |
partitionKeyName |
string |
Nome della chiave di partizione associata a questo contenitore SQL di Cosmos DB, se presente. Questo parametro è facoltativo. |
partitionKeyTemplate |
string |
Modello per la generazione di un valore di chiave di partizione sintetica da usare con questo contenitore SQL di Cosmos DB. Il modello deve includere almeno uno dei segnaposto seguenti: {iothub}, {deviceid}, {DD}, {MM}e {AAAA}. Qualsiasi segnaposto può essere specificato al massimo una volta, ma i componenti order e non segnaposto sono arbitrari. Questo parametro è obbligatorio solo se partitionKeyName è specificato. |
primaryKey |
string |
Chiave primaria dell'account cosmos DB. |
resourceGroup |
string |
Nome del gruppo di risorse dell'account cosmos DB. |
secondaryKey |
string |
Chiave secondaria dell'account cosmos DB. |
subscriptionId |
string |
Identificatore della sottoscrizione dell'account cosmos DB. |
RoutingEndpoints
Le proprietà correlate agli endpoint personalizzati a cui l'hub IoT instrada i messaggi in base alle regole di routing. È consentito un massimo di 10 endpoint personalizzati in tutti i tipi di endpoint per gli hub a pagamento e solo 1 endpoint personalizzato è consentito in tutti i tipi di endpoint per gli hub gratuiti.
Nome | Tipo | Descrizione |
---|---|---|
cosmosDBSqlContainers |
Elenco di endpoint del contenitore Cosmos DB a cui l'hub IoT indirizza i messaggi in base alle regole di routing. |
|
eventHubs |
Elenco di endpoint di Hub eventi a cui l'hub IoT indirizza i messaggi in base alle regole di routing. Questo elenco non include l'endpoint predefinito di Hub eventi. |
|
serviceBusQueues |
Elenco di endpoint della coda del bus di servizio a cui l'hub IoT indirizza i messaggi in base alle regole di routing. |
|
serviceBusTopics |
Elenco di endpoint dell'argomento del bus di servizio a cui l'hub IoT instrada i messaggi in base alle regole di routing. |
|
storageContainers |
L'elenco degli endpoint del contenitore di archiviazione a cui l'hub IoT indirizza i messaggi in base alle regole di routing. |
RoutingEventHubProperties
Proprietà correlate a un endpoint dell'hub eventi.
Nome | Tipo | Descrizione |
---|---|---|
authenticationType |
Metodo usato per eseguire l'autenticazione nell'endpoint dell'hub eventi |
|
connectionString |
string |
Il stringa di connessione dell'endpoint dell'hub eventi. |
endpointUri |
string |
URL dell'endpoint dell'hub eventi. Deve includere il protocollo sb:// |
entityPath |
string |
Nome dell'hub eventi nello spazio dei nomi dell'hub eventi |
id |
string |
ID dell'endpoint dell'hub eventi |
identity |
Proprietà dell'identità gestita dell'endpoint dell'hub eventi di routing. |
|
name |
string |
Nome che identifica questo endpoint. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini e ha una lunghezza massima di 64 caratteri. I nomi seguenti sono riservati: eventi, fileNotifications, $default. I nomi degli endpoint devono essere univoci tra i tipi di endpoint. |
resourceGroup |
string |
Nome del gruppo di risorse dell'endpoint dell'hub eventi. |
subscriptionId |
string |
Identificatore della sottoscrizione dell'endpoint dell'hub eventi. |
RoutingProperties
Proprietà correlate al routing dell'hub IoT. Vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
Nome | Tipo | Descrizione |
---|---|---|
endpoints |
Le proprietà correlate agli endpoint personalizzati a cui l'hub IoT indirizza i messaggi in base alle regole di routing. È consentito un massimo di 10 endpoint personalizzati in tutti i tipi di endpoint per gli hub a pagamento e solo 1 endpoint personalizzato è consentito in tutti i tipi di endpoint per gli hub gratuiti. |
|
enrichments |
Elenco di arricchimenti forniti dall'utente che l'hub IoT si applica ai messaggi da recapitare agli endpoint predefiniti e personalizzati. Vedere: https://aka.ms/telemetryoneventgrid |
|
fallbackRoute |
Le proprietà della route utilizzate come route di fallback quando non vengono soddisfatte le condizioni specificate nella sezione "route". Questo parametro è facoltativo. Quando questa proprietà non è presente nel modello, la route di fallback è disabilitata per impostazione predefinita. |
|
routes |
Elenco di regole di routing fornite dall'utente usate dall'hub IoT per instradare i messaggi agli endpoint predefiniti e personalizzati. Sono consentite al massimo 100 regole di routing per gli hub a pagamento e sono consentite al massimo 5 regole di routing per gli hub gratuiti. |
RoutingServiceBusQueueEndpointProperties
Proprietà correlate ai tipi di endpoint della coda del bus di servizio.
Nome | Tipo | Descrizione |
---|---|---|
authenticationType |
Metodo usato per eseguire l'autenticazione nell'endpoint della coda del bus di servizio |
|
connectionString |
string |
Il stringa di connessione dell'endpoint della coda del bus di servizio. |
endpointUri |
string |
URL dell'endpoint della coda del bus di servizio. Deve includere il protocollo sb:// |
entityPath |
string |
Nome della coda nello spazio dei nomi del bus di servizio |
id |
string |
ID dell'endpoint della coda del bus di servizio |
identity |
Proprietà dell'identità gestita dell'endpoint della coda del bus di servizio di routing. |
|
name |
string |
Nome che identifica questo endpoint. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini e ha una lunghezza massima di 64 caratteri. I nomi seguenti sono riservati: eventi, fileNotifications, $default. I nomi degli endpoint devono essere univoci tra i tipi di endpoint. Il nome non deve corrispondere al nome effettivo della coda. |
resourceGroup |
string |
Nome del gruppo di risorse dell'endpoint della coda del bus di servizio. |
subscriptionId |
string |
Identificatore della sottoscrizione dell'endpoint della coda del bus di servizio. |
RoutingServiceBusTopicEndpointProperties
Proprietà correlate ai tipi di endpoint dell'argomento del bus di servizio.
Nome | Tipo | Descrizione |
---|---|---|
authenticationType |
Metodo usato per eseguire l'autenticazione nell'endpoint dell'argomento del bus di servizio |
|
connectionString |
string |
Il stringa di connessione dell'endpoint dell'argomento del bus di servizio. |
endpointUri |
string |
URL dell'endpoint dell'argomento del bus di servizio. Deve includere il protocollo sb:// |
entityPath |
string |
Nome della coda nell'argomento del bus di servizio |
id |
string |
ID dell'endpoint dell'argomento del bus di servizio |
identity |
Proprietà dell'identità gestita dell'endpoint dell'argomento del bus di servizio di routing. |
|
name |
string |
Nome che identifica questo endpoint. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini e ha una lunghezza massima di 64 caratteri. I nomi seguenti sono riservati: eventi, fileNotifications, $default. I nomi degli endpoint devono essere univoci tra i tipi di endpoint. Il nome non deve corrispondere al nome effettivo dell'argomento. |
resourceGroup |
string |
Nome del gruppo di risorse dell'endpoint dell'argomento del bus di servizio. |
subscriptionId |
string |
Identificatore della sottoscrizione dell'endpoint dell'argomento del bus di servizio. |
RoutingSource
Origine a cui deve essere applicata la regola di routing, ad esempio DeviceMessages.
Nome | Tipo | Descrizione |
---|---|---|
DeviceConnectionStateEvents |
string |
|
DeviceJobLifecycleEvents |
string |
|
DeviceLifecycleEvents |
string |
|
DeviceMessages |
string |
|
Invalid |
string |
|
TwinChangeEvents |
string |
RoutingStorageContainerProperties
Proprietà correlate a un endpoint del contenitore di archiviazione.
Nome | Tipo | Descrizione |
---|---|---|
authenticationType |
Metodo usato per l'autenticazione nell'endpoint di archiviazione |
|
batchFrequencyInSeconds |
integer |
Intervallo di tempo in cui i BLOB vengono scritti nell'archiviazione. Il valore deve essere compreso tra 60 e 720 secondi. Il valore predefinito è 300 secondi. |
connectionString |
string |
Il stringa di connessione dell'account di archiviazione. |
containerName |
string |
Nome del contenitore di archiviazione nell'account di archiviazione. |
encoding |
enum:
|
Codifica utilizzata per serializzare i messaggi nei BLOB. I valori supportati sono 'avro', 'avrodeflate' e 'JSON'. Il valore predefinito è 'avro'. |
endpointUri |
string |
URL dell'endpoint di archiviazione. Deve includere il protocollo https:// |
fileNameFormat |
string |
Formato del nome file per il BLOB. Il formato predefinito è {iothub}/{partition}/{AAAA}/{MM}/{DD}/{HH}/{mm}. Tutti i parametri sono obbligatori, ma possono essere riordinati. |
id |
string |
ID dell'endpoint del contenitore di archiviazione |
identity |
Proprietà dell'identità gestita dell'endpoint di archiviazione di routing. |
|
maxChunkSizeInBytes |
integer |
Numero massimo di byte per ogni BLOB scritto nell'archiviazione. Il valore deve essere compreso tra 10485760(10 MB) e 524288000(500 MB). Il valore predefinito è 314572800(300 MB). |
name |
string |
Nome che identifica questo endpoint. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini e ha una lunghezza massima di 64 caratteri. I nomi seguenti sono riservati: eventi, fileNotifications, $default. I nomi degli endpoint devono essere univoci tra i tipi di endpoint. |
resourceGroup |
string |
Nome del gruppo di risorse dell'account di archiviazione. |
subscriptionId |
string |
Identificatore della sottoscrizione dell'account di archiviazione. |
SharedAccessSignatureAuthorizationRule
Proprietà di un criterio di accesso condiviso dell'hub IoT.
Nome | Tipo | Descrizione |
---|---|---|
keyName |
string |
Nome dei criteri di accesso condiviso. |
primaryKey |
string |
Chiave primaria. |
rights |
Autorizzazioni assegnate ai criteri di accesso condiviso. |
|
secondaryKey |
string |
Chiave secondaria. |
StorageEndpointProperties
Proprietà dell'endpoint di Archiviazione di Azure per il caricamento di file.
Nome | Tipo | Descrizione |
---|---|---|
authenticationType |
Specifica il tipo di autenticazione utilizzato per la connessione all'account di archiviazione. |
|
connectionString |
string |
Il stringa di connessione per l'account di archiviazione di Azure in cui vengono caricati i file. |
containerName |
string |
Nome del contenitore radice in cui si caricano i file. Il contenitore non deve esistere, ma deve essere creato usando connectionString specificato. |
identity |
Proprietà dell'identità gestita dell'endpoint di archiviazione per il caricamento di file. |
|
sasTtlAsIso8601 |
string |
Periodo di tempo per il quale l'URI di firma di accesso condiviso generato da hub IoT per il caricamento di file è valido. Vedi https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. |
systemData
Metadati relativi alla creazione e all'ultima modifica della risorsa.
Nome | Tipo | Descrizione |
---|---|---|
createdAt |
string |
Timestamp della creazione di risorse (UTC). |
createdBy |
string |
Identità che ha creato la risorsa. |
createdByType |
Tipo di identità che ha creato la risorsa. |
|
lastModifiedAt |
string |
Timestamp dell'ultima modifica della risorsa (UTC) |
lastModifiedBy |
string |
Identità che ha modificato l'ultima risorsa. |
lastModifiedByType |
Tipo di identità che ha modificato l'ultima risorsa. |